ListView.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2022 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/CopiedSharedPtr.hpp>
#include <TGUI/Widgets/Scrollbar.hpp>
#include <TGUI/Renderers/ListViewRenderer.hpp>
#include <TGUI/Text.hpp>
#include <set>
 
 
namespace tgui
{
 class TGUI_API ListView : public Widget
 {
 public:
 
 using Ptr = std::shared_ptr<ListView>; 
 using ConstPtr = std::shared_ptr<const ListView>; 
 
 static constexpr const char StaticWidgetType[] = "ListView"; 
 
 
 enum class ColumnAlignment
 {
 Left, 
 Center, 
 Right 
 };
 
 struct Item
 {
 std::vector<Text> texts;
 Any data;
 Sprite icon;
 };
 
 struct Column
 {
 float width = 0;
 float designWidth = 0;
 float maxItemWidth = 0;
 Text text;
 ColumnAlignment alignment = ColumnAlignment::Left;
 };
 
 
 ListView(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
 
 static ListView::Ptr create();
 
 
 static ListView::Ptr copy(const ListView::ConstPtr& listView);
 
 
 ListViewRenderer* getSharedRenderer();
 const ListViewRenderer* getSharedRenderer() const;
 
 ListViewRenderer* getRenderer();
 
 
 void setSize(const Layout2d& size) override;
 using Widget::setSize;
 
 
 std::size_t addColumn(const String& text, float width = 0, ColumnAlignment alignment = ColumnAlignment::Left);
 
 
 void setColumnText(std::size_t index, const String& text);
 
 
 String getColumnText(std::size_t index) const;
 
 
 void setColumnWidth(std::size_t index, float width);
 
 
 float getColumnWidth(std::size_t index) const;
 
 
 void setColumnAlignment(std::size_t columnIndex, ColumnAlignment alignment);
 
 
 ColumnAlignment getColumnAlignment(std::size_t columnIndex) const;
 
 
 void removeAllColumns();
 
 
 std::size_t getColumnCount() const;
 
 
 void setHeaderHeight(float height);
 
 
 float getHeaderHeight() const;
 
 
 float getCurrentHeaderHeight() const;
 
 
 void setHeaderVisible(bool showHeader);
 
 
 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();
 
 
 int getSelectedItemIndex() const;
 
 
 std::set<std::size_t> getSelectedItemIndices() const;
 
 
 void setMultiSelect(bool multiSelect);
 
 
 bool getMultiSelect() const;
 
 
 void setItemData(std::size_t index, Any data);
 
 
 template <typename T>
 T getItemData(std::size_t index) const
 {
 if (index < m_items.size())
 return AnyCast<T>(m_items[index].data);
 else
 throw std::bad_cast();
 }
 
 
 void setItemIcon(std::size_t index, const Texture& texture);
 
 
 Texture getItemIcon(std::size_t index) const;
 
 
 std::size_t getItemCount() const;
 
 
 String getItem(std::size_t index) const;
 
 
 std::vector<String> getItemRow(std::size_t index) const;
 
 
 String getItemCell(std::size_t rowIndex, std::size_t columnIndex) const;
 
 
 std::vector<String> getItems() const;
 
 
 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);
 
 
 unsigned int getItemHeight() const;
 
 
 void setHeaderTextSize(unsigned int textSize);
 
 
 unsigned int getHeaderTextSize() const;
 
 
 void setSeparatorWidth(unsigned int width);
 
 
 unsigned int getSeparatorWidth() const;
 
 
 void setHeaderSeparatorHeight(unsigned int height);
 
 
 unsigned int getHeaderSeparatorHeight() const;
 
 
 void setGridLinesWidth(unsigned int width);
 
 
 unsigned int getGridLinesWidth() const;
 
 
 void setAutoScroll(bool autoScroll);
 
 
 bool getAutoScroll() const;
 
 
 void setShowVerticalGridLines(bool showGridLines);
 
 
 bool getShowVerticalGridLines() const;
 
 
 void setShowHorizontalGridLines(bool showGridLines);
 
 
 bool getShowHorizontalGridLines() const;
 
 
 void setExpandLastColumn(bool expand);
 
 
 bool getExpandLastColumn() const;
 
 
 void setVerticalScrollbarPolicy(Scrollbar::Policy policy);
 
 
 Scrollbar::Policy getVerticalScrollbarPolicy() const;
 
 
 void setHorizontalScrollbarPolicy(Scrollbar::Policy policy);
 
 
 Scrollbar::Policy getHorizontalScrollbarPolicy() const;
 
 
 void setVerticalScrollbarValue(unsigned int value);
 
 
 unsigned int getVerticalScrollbarValue() const;
 
 
 void setHorizontalScrollbarValue(unsigned int value);
 
 
 unsigned int getHorizontalScrollbarValue() const;
 
 
 void setFixedIconSize(Vector2f iconSize);
 
 
 Vector2f getFixedIconSize() const;
 
 
 void setResizableColumns(bool resizable);
 
 
 bool getResizableColumns() const;
 
 
 bool isMouseOnWidget(Vector2f pos) const override;
 
 void leftMousePressed(Vector2f pos) override;
 
 void leftMouseReleased(Vector2f pos) override;
 
 void rightMousePressed(Vector2f pos) override;
 
 void mouseMoved(Vector2f pos) override;
 
 bool mouseWheelScrolled(float delta, Vector2f pos) override;
 
 void mouseNoLongerOnWidget() override;
 
 void leftMouseButtonNoLongerDown() override;
 
 void keyPressed(const Event::KeyEvent& event) override;
 
 
 void draw(BackendRenderTarget& target, RenderStates states) const override;
 
 
 protected:
 
 Signal& getSignal(String signalName) override;
 
 
 void rendererChanged(const 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;
 
 
 void mouseEnteredWidget() override;
 
 
 void mouseLeftWidget() override;
 
 
 void updateTextSize() override;
 
 
 // Returns the size without the borders
 Vector2f getInnerSize() const;
 
 
 // Create a Text object for an item from the given caption, using the preset color, font, text size and opacity
 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
 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
 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);
 
 
 // Update the maximum item width of the last column by recalculating all items' widths.
 // Returns whether the max item width was changed.
 bool updateLastColumnMaxItemWidth();
 
 
 // Update the maximum item width of the last column based on the addition of an Item.
 // Returns true if the maximum item width was changed.
 bool updateLastColumnMaxItemWidthWithNewItem(const Item& item);
 
 
 // Update the maximum item width of the last column based on the modification of an Item.
 // Returns true if the maximum item width was changed.
 bool updateLastColumnMaxItemWidthWithModifiedItem(const Item& modifiedItem, float oldDesiredWidthInLastColumn);
 
 
 // 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.
 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.
 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.
 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 true then pixelOffset is set to the distance between the center of the border and the mouse position.
 // If false then columnIndex and pixelOffset remain unchanged.
 bool findBorderBelowMouse(Vector2f pos, std::size_t& columnIndex, float& pixelOffset) const;
 
 
 // Recalculate the size and viewport size of the scrollbars
 void updateScrollbars();
 
 // Recalculate the maximum value for the vertical scrollbar
 void updateVerticalScrollbarMaximum();
 
 // Recalculate the maximum value for the horizontal scrollbar
 void updateHorizontalScrollbarMaximum();
 
 
 // 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
 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_maxItemWidth = 0; // If there are no columns, this is the maximum width from all items
 bool m_headerVisible = true;
 bool m_showHorizontalGridLines = false;
 bool m_showVerticalGridLines = true;
 bool m_expandLastColumn = false;
 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_resizingColumnPixelOffset = 0;
 
 CopiedSharedPtr<ScrollbarChildWidget> m_horizontalScrollbar;
 CopiedSharedPtr<ScrollbarChildWidget> m_verticalScrollbar;
 Scrollbar::Policy m_verticalScrollbarPolicy = Scrollbar::Policy::Automatic;
 Scrollbar::Policy m_horizontalScrollbarPolicy = Scrollbar::Policy::Automatic;
 
 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