ListBox.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 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_LIST_BOX_HPP
#define TGUI_LIST_BOX_HPP
 
#include <TGUI/Widgets/Scrollbar.hpp>
#include <TGUI/Renderers/ListBoxRenderer.hpp>
#include <TGUI/Text.hpp>

 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API ListBox : public Widget, public ScrollbarChildInterface
    {
      public:
 
        using Ptr = std::shared_ptr<ListBox>; 
        using ConstPtr = std::shared_ptr<const ListBox>; 
 
        static constexpr const char StaticWidgetType[] = "ListBox"; 

        using TextAlignment TGUI_DEPRECATED("Use tgui::HorizontalAlignment instead") = HorizontalAlignment;

        ListBox(const char* typeName = StaticWidgetType, bool initRenderer = true);

        TGUI_NODISCARD static ListBox::Ptr create();

        TGUI_NODISCARD static ListBox::Ptr copy(const ListBox::ConstPtr& listBox);

        TGUI_NODISCARD ListBoxRenderer* getSharedRenderer() override;
        TGUI_NODISCARD const ListBoxRenderer* getSharedRenderer() const override;

        TGUI_NODISCARD ListBoxRenderer* getRenderer() override;

        void setSize(const Layout2d& size) override;
        using Widget::setSize;

        std::size_t addItem(const String& itemName, const String& id = "");

        void addMultipleItems(const std::vector<String>& itemNames);

        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 getItemByIndex(std::size_t index) const;

        TGUI_NODISCARD int getIndexById(const String& id) const;

        TGUI_NODISCARD String getIdByIndex(std::size_t index) const;

        TGUI_NODISCARD String getSelectedItem() const;

        TGUI_NODISCARD String getSelectedItemId() const;

        TGUI_NODISCARD int getSelectedItemIndex() const;

        TGUI_NODISCARD int getHoveredItemIndex() 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 setItemData(std::size_t index, Any data);

        template <typename DataType>
        TGUI_NODISCARD DataType getItemData(std::size_t index) const
        {
            if (index < m_items.size())
                return AnyCast<DataType>(m_items[index].data);
            else
                throw std::bad_cast();
        }

        void setItemHeight(unsigned int itemHeight);

        TGUI_NODISCARD unsigned int getItemHeight() const;

        void setMaximumItems(std::size_t maximumItems = 0);

        TGUI_NODISCARD std::size_t getMaximumItems() const;

        void setAutoScroll(bool autoScroll);

        TGUI_NODISCARD bool getAutoScroll() const;

        void setTextAlignment(HorizontalAlignment alignment);

        TGUI_NODISCARD HorizontalAlignment getTextAlignment() const;

        TGUI_NODISCARD bool contains(const String& item) const;

        TGUI_NODISCARD bool containsId(const String& id) const;

        TGUI_DEPRECATED("Use getScrollbar()->setValue(value) instead") void setScrollbarValue(unsigned int value);

        TGUI_DEPRECATED("Use getScrollbar()->getValue() instead") TGUI_NODISCARD unsigned int getScrollbarValue() const;

        TGUI_DEPRECATED("Use getScrollbar()->getMaxValue() instead") TGUI_NODISCARD unsigned int getScrollbarMaxValue() const;

        TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;

        bool leftMousePressed(Vector2f pos) override;

        void leftMouseReleased(Vector2f pos) override;

        void rightMousePressed(Vector2f pos) override;

        void mouseMoved(Vector2f pos) override;

        bool scrolled(float delta, Vector2f pos, bool touch) override;

        void mouseNoLongerOnWidget() override;

        void leftMouseButtonNoLongerDown() override;

        void keyPressed(const Event::KeyEvent& event) override;

        bool canHandleKeyPress(const Event::KeyEvent& event) 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;

        void scrollbarValueChanged() override;

        // Returns the size without the borders
        TGUI_NODISCARD Vector2f getInnerSize() const;

        // Updates the position of the items and the scrollbar
        void updateItemPositions();

        // Update the colors and text style of the selected and hovered items
        void updateSelectedAndHoveringItemColorsAndStyle();

        // Update the color and text style of all the items
        void updateItemColorsAndStyle();

        // Update on which item the mouse is standing
        void updateHoveringItem(int item);

        // Update which item is selected
        void updateSelectedItem(int item);

        // Update the hovered item based on a mouse event. The innerPos is the mouse pos relative to the area inside the borders.
        void setHoveredItemBasedOnMousePos(Vector2f innerPos);

        // Update the selected (and hovered) item based on a mouse event. The innerPos is relative to the area inside the borders.
        void setSelectedItemBasedOnMousePos(Vector2f innerPos);

        // Checks whether the scrollbar value was changed and emit the onScroll event if it did
        void triggerOnScroll();

        // Adds an item to the list. Called from both addItem and addMultipleItems
        void addItemImpl(const String& itemName, const String& id);

        // This function is called every frame with the time passed since the last frame.
        bool updateTime(Duration elapsedTime) override;

        // Makes a copy of the widget
        TGUI_NODISCARD Widget::Ptr clone() const override;

    public:
 
        SignalItem onItemSelect   = {"ItemSelected"};   
        SignalItem onMousePress   = {"MousePressed"};   
        SignalItem onMouseRelease = {"MouseReleased"};  
        SignalItem onDoubleClick  = {"DoubleClicked"};  
        SignalItem onRightClick   = {"RightClicked"};   
        SignalUInt onScroll       = {"Scrolled"};       

    protected:
 
        struct Item
        {
            Text text;
            Any data;
            String id;
        };
 
        std::vector<Item> m_items;
 
        // What is the index of the selected item?
        // This is also used by combo box, so it can't just be changed to a pointer!
        int m_selectedItem = -1;
 
        int m_hoveringItem = -1;
 
        unsigned int m_itemHeight = 0;
 
        // This will store the maximum number of items in the list box (zero by default, meaning that there is no limit)
        std::size_t m_maxItems = 0;
 
        // When there are too many items a scrollbar will be shown
        unsigned int m_lastScrollbarValue = 0;
 
        // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
        bool m_possibleDoubleClick = false;
 
        bool m_autoScroll = true;
        HorizontalAlignment m_textAlignment = HorizontalAlignment::Left;
 
        Sprite m_spriteBackground;
 
        // Cached renderer properties
        Borders   m_bordersCached;
        Borders   m_paddingCached;
        Color     m_borderColorCached;
        Color     m_backgroundColorCached;
        Color     m_backgroundColorHoverCached;
        Color     m_selectedBackgroundColorCached;
        Color     m_selectedBackgroundColorHoverCached;
        Color     m_textColorCached;
        Color     m_textColorHoverCached;
        Color     m_selectedTextColorCached;
        Color     m_selectedTextColorHoverCached;
        TextStyles m_textStyleCached;
        TextStyles m_selectedTextStyleCached;

    };

}

 
#endif // TGUI_LIST_BOX_HPP