ComboBox.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 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>
 
 
TGUI_MODULE_EXPORT namespace tgui
{
 class TGUI_API ComboBox : public Widget
 {
 public:
 
 enum class ExpandDirection
 {
 Down, 
 Up, 
 Automatic 
 };
 
 public:
 
 using Ptr = std::shared_ptr<ComboBox>; 
 using ConstPtr = std::shared_ptr<const ComboBox>; 
 
 static constexpr const char StaticWidgetType[] = "ComboBox"; 
 
 
 ComboBox(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
 
 // Copy constructor
 ComboBox(const ComboBox& other);
 
 // Move constructor
 ComboBox(ComboBox&& other) noexcept;
 
 // Copy assignment operator
 ComboBox& operator= (const ComboBox& other);
 
 // Move assignment operator
 ComboBox& operator= (ComboBox&& other) noexcept;
 
 
 TGUI_NODISCARD static ComboBox::Ptr create();
 
 
 TGUI_NODISCARD static ComboBox::Ptr copy(const ComboBox::ConstPtr& comboBox);
 
 
 TGUI_NODISCARD ComboBoxRenderer* getSharedRenderer() override;
 TGUI_NODISCARD const ComboBoxRenderer* getSharedRenderer() const override;
 
 TGUI_NODISCARD TGUI_NODISCARD ComboBoxRenderer* getRenderer() override;
 
 
 void setSize(const Layout2d& size) override;
 using Widget::setSize;
 
 
 void setEnabled(bool enabled) override;
 
 
 void setItemsToDisplay(std::size_t nrOfItemsInListToDisplay);
 
 
 TGUI_NODISCARD std::size_t getItemsToDisplay() const;
 
 
 std::size_t addItem(const String& itemName, const String& id = "");
 
 
 bool setSelectedItem(const String& itemName);
 
 
 bool setSelectedItemById(const String& id);
 
 
 bool setSelectedItemByIndex(std::size_t index);
 
 
 void deselectItem();
 
 
 bool removeItem(const String& itemName);
 
 
 bool removeItemById(const String& id);
 
 
 bool removeItemByIndex(std::size_t index);
 
 
 void removeAllItems();
 
 
 TGUI_NODISCARD String getItemById(const String& id) const;
 
 
 TGUI_NODISCARD String getSelectedItem() const;
 
 
 TGUI_NODISCARD String getSelectedItemId() const;
 
 
 TGUI_NODISCARD int getSelectedItemIndex() const;
 
 
 bool changeItem(const String& originalValue, const String& newValue);
 
 
 bool changeItemById(const String& id, const String& newValue);
 
 
 bool changeItemByIndex(std::size_t index, const String& newValue);
 
 
 TGUI_NODISCARD std::size_t getItemCount() const;
 
 
 TGUI_NODISCARD std::vector<String> getItems() const;
 
 
 TGUI_NODISCARD std::vector<String> getItemIds() const;
 
 
 void setMaximumItems(std::size_t maximumItems = 0);
 
 
 TGUI_NODISCARD std::size_t getMaximumItems() const;
 
 
 void setDefaultText(const String& defaultText);
 
 
 TGUI_NODISCARD const String& getDefaultText() const;
 
 
 void setExpandDirection(ExpandDirection direction);
 
 
 TGUI_NODISCARD ExpandDirection getExpandDirection() const;
 
 
 TGUI_NODISCARD bool contains(const String& item) const;
 
 
 TGUI_NODISCARD bool containsId(const String& id) const;
 
 
 void setChangeItemOnScroll(bool changeOnScroll);
 
 
 TGUI_NODISCARD bool getChangeItemOnScroll() const;
 
 
 void setParent(Container* parent) override;
 
 
 TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
 
 bool leftMousePressed(Vector2f pos) override;
 
 bool scrolled(float delta, Vector2f pos, bool touch) override;
 
 
 void draw(BackendRenderTarget& target, RenderStates states) const override;
 
 
 protected:
 
 TGUI_NODISCARD Signal& getSignal(String signalName) override;
 
 
 void rendererChanged(const String& property) override;
 
 
 TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
 
 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
 
 void updateTextSize() override;
 
 
 // Returns the size without the borders
 TGUI_NODISCARD 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
 TGUI_NODISCARD Widget::Ptr clone() const override;
 
 
 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;
 bool m_changeItemOnScroll = false;
 
 ExpandDirection m_expandDirection = ExpandDirection::Automatic;
 
 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