ListView.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_VIEW_HPP
#define TGUI_LIST_VIEW_HPP
 
#include <TGUI/Widgets/Scrollbar.hpp>
#include <TGUI/Renderers/ListViewRenderer.hpp>
#include <TGUI/Text.hpp>
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
    #include <set>
    #include <limits>
#endif

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

        using ColumnAlignment TGUI_DEPRECATED("Use tgui::HorizontalAlignment instead") = HorizontalAlignment;
 
        struct Item
        {
            std::vector<Text> texts;
            Any data;
            Sprite icon;
        };
 
        struct Column
        {
            float width = 0;
            float designWidth = 0;
            float widestItemWidth = 0;
            std::size_t widestItemIndex = std::numeric_limits<std::size_t>::max();
            Text text;
            HorizontalAlignment alignment = HorizontalAlignment::Left;
            bool autoResize = false;
            bool expanded = false;
        };

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

        TGUI_NODISCARD static ListView::Ptr create();

        TGUI_NODISCARD static ListView::Ptr copy(const ListView::ConstPtr& listView);

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

        TGUI_NODISCARD ListViewRenderer* getRenderer() override;

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

        std::size_t addColumn(const String& text, float width = 0, HorizontalAlignment alignment = HorizontalAlignment::Left);

        void setColumnText(std::size_t index, const String& text);

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

        void setColumnWidth(std::size_t index, float width);

        TGUI_NODISCARD float getColumnWidth(std::size_t index) const;

        TGUI_NODISCARD float getColumnDesignWidth(std::size_t index) const;

        void setColumnAlignment(std::size_t columnIndex, HorizontalAlignment alignment);

        TGUI_NODISCARD HorizontalAlignment getColumnAlignment(std::size_t columnIndex) const;

        void setColumnAutoResize(std::size_t index, bool autoResize);

        TGUI_NODISCARD bool getColumnAutoResize(std::size_t index) const;

        void setColumnExpanded(std::size_t index, bool expand);

        TGUI_NODISCARD bool getColumnExpanded(std::size_t index) const;

        void removeAllColumns();

        TGUI_NODISCARD std::size_t getColumnCount() const;

        void setHeaderHeight(float height);

        TGUI_NODISCARD float getHeaderHeight() const;

        TGUI_NODISCARD float getCurrentHeaderHeight() const;

        void setHeaderVisible(bool showHeader);

        TGUI_NODISCARD bool getHeaderVisible() const;

        std::size_t addItem(const String& text);

        std::size_t addItem(const std::vector<String>& item);

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

        void insertItem(std::size_t index, const String& text);

        void insertItem(std::size_t index, const std::vector<String>& item);

        void insertMultipleItems(std::size_t index, const std::vector<std::vector<String>>& items);

        bool changeItem(std::size_t index, const std::vector<String>& item);

        bool changeSubItem(std::size_t index, std::size_t column, const String& item);

        bool removeItem(std::size_t index);

        void removeAllItems();

        void setSelectedItem(std::size_t index);

        void setSelectedItems(const std::set<std::size_t>& indices);

        void deselectItems();

        TGUI_NODISCARD int getSelectedItemIndex() const;

        TGUI_NODISCARD int getHoveredItemIndex() const;

        TGUI_NODISCARD std::set<std::size_t> getSelectedItemIndices() const;

        void setMultiSelect(bool multiSelect);

        TGUI_NODISCARD bool getMultiSelect() 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 setItemIcon(std::size_t index, const Texture& texture);

        TGUI_NODISCARD Texture getItemIcon(std::size_t index) const;

        TGUI_NODISCARD std::size_t getItemCount() const;

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

        TGUI_NODISCARD std::vector<String> getItemRow(std::size_t index) const;

        TGUI_NODISCARD String getItemCell(std::size_t rowIndex, std::size_t columnIndex) const;

        TGUI_NODISCARD std::vector<String> getItems() const;

        TGUI_NODISCARD std::vector<std::vector<String>> getItemRows() const;

        void sort(std::size_t index, const std::function<bool(const String&, const String&)>& cmp);

        void setItemHeight(unsigned int itemHeight);

        TGUI_NODISCARD unsigned int getItemHeight() const;

        void setHeaderTextSize(unsigned int textSize);

        TGUI_NODISCARD unsigned int getHeaderTextSize() const;

        void setSeparatorWidth(unsigned int width);

        TGUI_NODISCARD unsigned int getSeparatorWidth() const;

        void setHeaderSeparatorHeight(unsigned int height);

        TGUI_NODISCARD unsigned int getHeaderSeparatorHeight() const;

        void setGridLinesWidth(unsigned int width);

        TGUI_NODISCARD unsigned int getGridLinesWidth() const;

        void setAutoScroll(bool autoScroll);

        TGUI_NODISCARD bool getAutoScroll() const;

        void setShowVerticalGridLines(bool showGridLines);

        TGUI_NODISCARD bool getShowVerticalGridLines() const;

        void setShowHorizontalGridLines(bool showGridLines);

        TGUI_NODISCARD bool getShowHorizontalGridLines() const;

        TGUI_DEPRECATED("Use setColumnAutoExpanded and setColumnAutoResize instead") void setExpandLastColumn(bool expand);

        TGUI_DEPRECATED("Use ColumnAutoExpanded and ColumnAutoResize setters and getters instead") TGUI_NODISCARD bool getExpandLastColumn() const;

        TGUI_DEPRECATED("Use getVerticalScrollbar()->setPolicy(policy) instead") void setVerticalScrollbarPolicy(Scrollbar::Policy policy);

        TGUI_DEPRECATED("Use getVerticalScrollbar()->getPolicy() instead") TGUI_NODISCARD Scrollbar::Policy getVerticalScrollbarPolicy() const;

        TGUI_DEPRECATED("Use getHorizontalScrollbar()->setPolicy(policy) instead") void setHorizontalScrollbarPolicy(Scrollbar::Policy policy);

        TGUI_DEPRECATED("Use getHorizontalScrollbar()->getPolicy() instead") TGUI_NODISCARD Scrollbar::Policy getHorizontalScrollbarPolicy() const;

        TGUI_DEPRECATED("Use getVerticalScrollbar()->setValue(value) instead") void setVerticalScrollbarValue(unsigned int value);

        TGUI_DEPRECATED("Use getVerticalScrollbar()->getValue() instead") TGUI_NODISCARD unsigned int getVerticalScrollbarValue() const;

        TGUI_DEPRECATED("Use getVerticalScrollbar()->getMaxValue() instead") TGUI_NODISCARD unsigned int getVerticalScrollbarMaxValue() const;

        TGUI_DEPRECATED("Use getHorizontalScrollbar()->setValue(value) instead") void setHorizontalScrollbarValue(unsigned int value);

        TGUI_DEPRECATED("Use getHorizontalScrollbar()->getValue() instead") TGUI_NODISCARD unsigned int getHorizontalScrollbarValue() const;

        TGUI_DEPRECATED("Use getHorizontalScrollbar()->getMaxValue() instead") TGUI_NODISCARD unsigned int getHorizontalScrollbarMaxValue() const;

        void setFixedIconSize(Vector2f iconSize);

        TGUI_NODISCARD Vector2f getFixedIconSize() const;

        void setResizableColumns(bool resizable);

        TGUI_NODISCARD bool getResizableColumns() 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 mouseEnteredWidget() override;

        void mouseLeftWidget() override;

        void updateTextSize() override;

        void scrollbarPolicyChanged(Orientation orientation) override;

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

        // Create a Text object for an item from the given caption, using the preset color, font, text size and opacity
        TGUI_NODISCARD Text createText(const String& caption);

        // Create a Text object for a header text from the given caption, using the preset color, font, text size and opacity
        TGUI_NODISCARD Text createHeaderText(const String& caption);

        // Changes the color of all Text objects in an item
        virtual void setItemColor(std::size_t index, const Color& color);

        // Calculate the width of the column based on its caption when no column width was provided
        TGUI_NODISCARD float calculateAutoColumnWidth(const Text& text);

        // Update the colors of the selected and hovered items
        void updateSelectedAndhoveredItemColors();

        // Update the color of all the items
        void updateItemColors();

        // Changes the color of all header texts
        void updateHeaderTextsColor();

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

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

        // Selects multiple items when multi-select is on and the user selects an item while the shift key is held down
        void selectRangeFromEvent(std::size_t item);

        // Updates which item is the widest in the given column, by calculating the width of each item
        bool updateWidestItemInColumn(std::size_t columnIndex);

        // Updates which item is the widest in the given column, when only one item has changed in width
        bool updateWidestItemInColumn(std::size_t columnIndex, std::size_t itemIndex);

        // Updates which item is the widest in all columns, by calculating the width of each item
        bool updateWidestItem();

        // Updates which item is the widest in all columns, when only one item has changed in width
        bool updateWidestItem(std::size_t itemIndex);

        // This function needs to be called when items are inserted into the list. If the widest item for each column is located
        // below the inserted item then it's index needs to be updated.
        void incrementWidestItemIndices(std::size_t itemIndex);

        // Recalculates the width of each column if they don't have a fixed width. For auto-resized columns, the widest item
        // should have already been updated in each column before this function is called.
        void updateColumnWidths();

        // Returns whether at least one column potentially has its width expanded to fill the list view
        bool hasExpandedColumn() const;

        // Add item to selected set
        void addSelectedItem(int item);

        // Remove item from selected set
        void removeSelectedItem(std::size_t item);

        // Update on which item the mouse is standing, given the current mouse position
        void updateHoveredItemByMousePos(Vector2f mousePos);

        // Returns either the configured separator width or the width of vertical grid lines, whichever is larger.
        TGUI_NODISCARD unsigned int getTotalSeparatorWidth() const;

        // Returns the total width an Item takes up at some column, assuming it will not be cut off by the column.
        TGUI_NODISCARD float getItemTotalWidth(const Item& item, std::size_t columnIndex) const;

        // Found out which column is located below the mouse. The mouseLeft is relative to the widget position.
        // This function should only be called after checking that the mouse is positioned on top of the header.
        TGUI_NODISCARD int getColumnIndexBelowMouse(float mouseLeft);

        // Returns whether the mouse is standing between two columns.
        // If true then columnIndex is set to the index of border below the mouse (1 is the border between first two columns).
        // If false then columnIndex remains unchanged.
        TGUI_NODISCARD bool findBorderBelowMouse(Vector2f pos, std::size_t& columnIndex) const;

        // Recalculate the size and viewport size of the scrollbars
        void updateScrollbars();

        // Recalculate the maximum value for the vertical scrollbar
        void updateVerticalScrollbarMaximum();

        // Draw the header text for a single column
        void drawHeaderText(BackendRenderTarget& target, RenderStates states, float columnWidth, float headerHeight, std::size_t column) const;

        // Draw the texts in a single column
        void drawColumn(BackendRenderTarget& target, RenderStates states, std::size_t firstItem, std::size_t lastItem, std::size_t column, float columnWidth) const;

        // 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:

        SignalInt onItemSelect  = {"ItemSelected"};
 
        SignalInt onDoubleClick = {"DoubleClicked"};  
        SignalInt onRightClick  = {"RightClicked"};   
        SignalInt onHeaderClick = {"HeaderClicked"};  

    protected:
 
        std::vector<Column> m_columns;
        std::vector<Item>   m_items;
        std::set<std::size_t> m_selectedItems;
 
        int m_hoveredItem = -1;
        int m_firstSelectedItemIndex = -1;
        int m_focusedItemIndex = -1;
 
        float m_requestedHeaderHeight = 0;
        unsigned int m_itemHeight = 0;
        unsigned int m_headerTextSize = 0;
        unsigned int m_headerSeparatorHeight = 0;
        unsigned int m_separatorWidth = 1;
        unsigned int m_gridLinesWidth = 1;
        unsigned int m_iconCount = 0;
        float m_maxIconWidth = 0;
        float m_widestItemWidth = 0; // If there are no columns, this is the maximum width from all items
        std::size_t m_widestItemIndex = std::numeric_limits<std::size_t>::max(); // If there are no columns, this is the index of the item with the maximum width
        bool m_headerVisible = true;
        bool m_showHorizontalGridLines = false;
        bool m_showVerticalGridLines = true;
        bool m_expandLastColumn = false; // TGUI_NEXT: Remove this property
        bool m_multiSelect = false;
        bool m_resizableColumns = false;
        Vector2f m_fixedIconSize;
        Cursor::Type m_currentListViewMouseCursor = Cursor::Type::Arrow;
        std::size_t m_resizingColumn = 0;
        float m_resizingColumnLastMouseX = 0;
 
        int m_mouseOnHeaderIndex = -1; // If the left mouse is down, this contains the index of the column if the mouse went down on the header
        int m_possibleDoubleClick = false; // 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_autoScroll = true; // Should the list view scroll to the bottom when a new item is added?
 
        Sprite m_spriteHeaderBackground;
        Sprite m_spriteBackground;
 
        // Cached renderer properties
        Borders   m_bordersCached;
        Borders   m_paddingCached;
        Color     m_borderColorCached;
        Color     m_separatorColorCached;
        Color     m_gridLinesColorCached;
        Color     m_headerTextColorCached;
        Color     m_headerBackgroundColorCached;
        Color     m_backgroundColorCached;
        Color     m_backgroundColorHoverCached;
        Color     m_selectedBackgroundColorCached;
        Color     m_selectedBackgroundColorHoverCached;
        Color     m_textColorCached;
        Color     m_textColorHoverCached;
        Color     m_selectedTextColorCached;
        Color     m_selectedTextColorHoverCached;

    };

}

 
#endif // TGUI_LIST_VIEW_HPP