ComboBox.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2020 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
// you must not claim that you wrote the original software.
// If you use this software in a product, an acknowledgment
// in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
// and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
 
#ifndef TGUI_COMBO_BOX_HPP
#define TGUI_COMBO_BOX_HPP
 
 
#include <TGUI/Widgets/ListBox.hpp>
#include <TGUI/Renderers/ComboBoxRenderer.hpp>
 
 
namespace tgui
{
 class TGUI_API ComboBox : public Widget
 {
 public:
 
 enum class ExpandDirection
 {
 Down, 
 Up, 
 Automatic 
 };
 
 public:
 
 typedef std::shared_ptr<ComboBox> Ptr; 
 typedef std::shared_ptr<const ComboBox> ConstPtr; 
 
 
 // Default constructor
 ComboBox();
 
 // Copy constructor
 ComboBox(const ComboBox& other);
 
 // Move constructor
 ComboBox(ComboBox&& other);
 
 // Copy assignment operator
 ComboBox& operator= (const ComboBox& other);
 
 // Move assignment operator
 ComboBox& operator= (ComboBox&& other);
 
 
 static ComboBox::Ptr create();
 
 
 static ComboBox::Ptr copy(ComboBox::ConstPtr comboBox);
 
 
 ComboBoxRenderer* getSharedRenderer();
 const ComboBoxRenderer* getSharedRenderer() const;
 
 ComboBoxRenderer* getRenderer();
 const ComboBoxRenderer* getRenderer() const;
 
 
 void setSize(const Layout2d& size) override;
 using Widget::setSize;
 
 
 void setEnabled(bool enabled) override;
 
 
 void setItemsToDisplay(std::size_t nrOfItemsInListToDisplay);
 
 
 std::size_t getItemsToDisplay() const;
 
 
 bool addItem(const sf::String& itemName, const sf::String& id = "");
 
 
 bool setSelectedItem(const sf::String& itemName);
 
 
 bool setSelectedItemById(const sf::String& id);
 
 
 bool setSelectedItemByIndex(std::size_t index);
 
 
 void deselectItem();
 
 
 bool removeItem(const sf::String& itemName);
 
 
 bool removeItemById(const sf::String& id);
 
 
 bool removeItemByIndex(std::size_t index);
 
 
 void removeAllItems();
 
 
 sf::String getItemById(const sf::String& id) const;
 
 
 sf::String getSelectedItem() const;
 
 
 sf::String getSelectedItemId() const;
 
 
 int getSelectedItemIndex() const;
 
 
 bool changeItem(const sf::String& originalValue, const sf::String& newValue);
 
 
 bool changeItemById(const sf::String& id, const sf::String& newValue);
 
 
 bool changeItemByIndex(std::size_t index, const sf::String& newValue);
 
 
 std::size_t getItemCount() const;
 
 
 std::vector<sf::String> getItems() const;
 
 
 const std::vector<sf::String>& getItemIds() const;
 
 
 void setMaximumItems(std::size_t maximumItems = 0);
 
 
 std::size_t getMaximumItems() const;
 
 
 void setTextSize(unsigned int textSize) override;
 
 
 unsigned int getTextSize() const override;
 
 
 void setDefaultText(const sf::String& defaultText);
 
 
 const sf::String& getDefaultText() const;
 
 
 void setExpandDirection(ExpandDirection direction);
 
 
 ExpandDirection getExpandDirection() const;
 
 
 bool contains(const sf::String& item) const;
 
 
 bool containsId(const sf::String& id) const;
 
 
 void setChangeItemOnScroll(bool changeOnScroll);
 
 
 bool getChangeItemOnScroll() const;
 
 
 void setParent(Container* parent) override;
 
 
 bool mouseOnWidget(Vector2f pos) const override;
 
 void leftMousePressed(Vector2f pos) override;
 
 bool mouseWheelScrolled(float delta, Vector2f pos) override;
 
 
 void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 Signal& getSignal(std::string signalName) override;
 
 
 void rendererChanged(const std::string& property) override;
 
 
 std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
 
 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
 
 // Returns the size without the borders
 Vector2f getInnerSize() const;
 
 
 // Update the height of the internal list box
 void updateListBoxHeight();
 
 
 // Shows the list of items.
 void showListBox();
 
 
 // Hides the list of items.
 void hideListBox();
 
 
 // Initialize the internal list box
 void initListBox();
 
 
 // Makes a copy of the widget
 Widget::Ptr clone() const override
 {
 return std::make_shared<ComboBox>(*this);
 }
 
 
 public:
 
 SignalItem onItemSelect = {"ItemSelected"}; 
 
 
 protected:
 
 // The number of items to display. If there is a scrollbar then you can scroll to see the other.
 // If there is no scrollbar then this will be the maximum amount of items.
 std::size_t m_nrOfItemsToDisplay = 0;
 
 // Internally a list box is used to store all items
 ListBox::Ptr m_listBox = ListBox::create();
 
 Text m_text;
 Text m_defaultText;
 
 int m_previousSelectedItemIndex = -1;
#ifdef TGUI_NEXT
 bool m_changeItemOnScroll = false;
#else
 bool m_changeItemOnScroll = true;
#endif
 
#ifdef TGUI_NEXT
 ExpandDirection m_expandDirection = ExpandDirection::Automatic;
#else
 ExpandDirection m_expandDirection = ExpandDirection::Down;
#endif
 
 Sprite m_spriteBackground;
 Sprite m_spriteBackgroundDisabled;
 Sprite m_spriteArrow;
 Sprite m_spriteArrowHover;
 Sprite m_spriteArrowDisabled;
 
 // Cached renderer properties
 Borders m_bordersCached;
 Padding m_paddingCached;
 Color m_borderColorCached;
 Color m_backgroundColorCached;
 Color m_backgroundColorDisabledCached;
 Color m_arrowColorCached;
 Color m_arrowColorHoverCached;
 Color m_arrowColorDisabledCached;
 Color m_arrowBackgroundColorCached;
 Color m_arrowBackgroundColorHoverCached;
 Color m_arrowBackgroundColorDisabledCached;
 Color m_textColorCached;
 Color m_textColorDisabledCached;
 
 };
 
}
 
 
#endif // TGUI_COMBO_BOX_HPP