TGUI  1.4.0
Loading...
Searching...
No Matches

List view widget. More...

#include <TGUI/Widgets/ListView.hpp>

Inheritance diagram for tgui::ListView:
tgui::Widget

Classes

struct  Column
 
struct  Item
 

Public Types

using Ptr = std::shared_ptr<ListView>
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr<const ListView>
 Shared constant widget pointer.
 
using ColumnAlignment = HorizontalAlignment
 The text alignment for all texts within a column.
 
- Public Types inherited from tgui::Widget
using Ptr = std::shared_ptr<Widget>
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr<const Widget>
 Shared constant widget pointer.
 

Public Member Functions

 ListView (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
TGUI_NODISCARD ListViewRenderergetSharedRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
TGUI_NODISCARD const ListViewRenderergetSharedRenderer () const override
 
TGUI_NODISCARD ListViewRenderergetRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
void setSize (const Layout2d &size) override
 Changes the size of the list view.
 
std::size_t addColumn (const String &text, float width=0, HorizontalAlignment alignment=HorizontalAlignment::Left)
 Adds a column.
 
void setColumnText (std::size_t index, const String &text)
 Changes the text of a column.
 
TGUI_NODISCARD String getColumnText (std::size_t index) const
 Returns the text of a column.
 
void setColumnWidth (std::size_t index, float width)
 Changes the width of a column.
 
TGUI_NODISCARD float getColumnWidth (std::size_t index) const
 Returns the width of a column.
 
TGUI_NODISCARD float getColumnDesignWidth (std::size_t index) const
 Returns the original width of a column (the value passed to addColumn or the last setColumnWidth call)
 
void setColumnAlignment (std::size_t columnIndex, HorizontalAlignment alignment)
 Changes the text alignment within a column.
 
TGUI_NODISCARD HorizontalAlignment getColumnAlignment (std::size_t columnIndex) const
 Returns the current text alignment within a column.
 
void setColumnAutoResize (std::size_t index, bool autoResize)
 Changes whether the column width depends on the widest item added to that column.
 
TGUI_NODISCARD bool getColumnAutoResize (std::size_t index) const
 Returns whether the column width depends on the widest item added to that column.
 
void setColumnExpanded (std::size_t index, bool expand)
 Changes whether a column is expanded to fill the list view (if all columns fit inside the list view)
 
TGUI_NODISCARD bool getColumnExpanded (std::size_t index) const
 Returns whether the column is expanded to fill the list view (if all columns fit inside the list view)
 
void removeAllColumns ()
 Removes all columns.
 
TGUI_NODISCARD std::size_t getColumnCount () const
 Returns the amount of columns in the list view.
 
void setHeaderHeight (float height)
 Changes the height of the header row.
 
TGUI_NODISCARD float getHeaderHeight () const
 Returns the height of the header row.
 
TGUI_NODISCARD float getCurrentHeaderHeight () const
 Returns the height of the header or 0 if no header row is shown.
 
void setHeaderVisible (bool showHeader)
 Changes whether the header is shown.
 
TGUI_NODISCARD bool getHeaderVisible () const
 Returns whether the header is shown.
 
std::size_t addItem (const String &text)
 Adds an item to the list.
 
std::size_t addItem (const std::vector< String > &item)
 Adds an item with values for multiple columns to the list.
 
void addMultipleItems (const std::vector< std::vector< String > > &items)
 Adds multiple items to the list.
 
void insertItem (std::size_t index, const String &text)
 Inserts an item into the list.
 
void insertItem (std::size_t index, const std::vector< String > &item)
 Inserts an item into the list.
 
void insertMultipleItems (std::size_t index, const std::vector< std::vector< String > > &items)
 Inserts multiple items into the list.
 
bool changeItem (std::size_t index, const std::vector< String > &item)
 Changes an item with values for multiple columns to the list.
 
bool changeSubItem (std::size_t index, std::size_t column, const String &item)
 Changes the caption of a single value in the item.
 
bool removeItem (std::size_t index)
 Removes the item from the list view.
 
void removeAllItems ()
 Removes all items from the list.
 
void setSelectedItem (std::size_t index)
 Selects an item in the list view.
 
void setSelectedItems (const std::set< std::size_t > &indices)
 Selects items in the list view.
 
void deselectItems ()
 Deselects the selected items.
 
TGUI_NODISCARD int getSelectedItemIndex () const
 Gets the index of the selected item.
 
TGUI_NODISCARD std::set< std::size_t > getSelectedItemIndices () const
 Gets the indices of the selected items.
 
void setMultiSelect (bool multiSelect)
 Allow multi selection of the items.
 
TGUI_NODISCARD bool getMultiSelect () const
 Returns multi selection of the items is allowed.
 
void setItemData (std::size_t index, Any data)
 Store some user data with the item.
 
template<typename DataType >
TGUI_NODISCARD DataType getItemData (std::size_t index) const
 Returns user data stored in the item.
 
void setItemIcon (std::size_t index, const Texture &texture)
 Sets a small icon in front of the item.
 
TGUI_NODISCARD Texture getItemIcon (std::size_t index) const
 Gets the icon displayed in front of the item.
 
TGUI_NODISCARD std::size_t getItemCount () const
 Returns the amount of items in the list view.
 
TGUI_NODISCARD String getItem (std::size_t index) const
 Retrieves an item in the list.
 
TGUI_NODISCARD std::vector< StringgetItemRow (std::size_t index) const
 Retrieves the values of all columns for an item in the list.
 
TGUI_NODISCARD String getItemCell (std::size_t rowIndex, std::size_t columnIndex) const
 Retrieves the value for a cell in the list.
 
TGUI_NODISCARD std::vector< StringgetItems () const
 Returns a list of the texts in the first column for all items in the list view.
 
TGUI_NODISCARD std::vector< std::vector< String > > getItemRows () const
 Returns a list of all column values for all items in the list view.
 
void sort (std::size_t index, const std::function< bool(const String &, const String &)> &cmp)
 Sort items.
 
void setItemHeight (unsigned int itemHeight)
 Changes the height of the items in the list view.
 
TGUI_NODISCARD unsigned int getItemHeight () const
 Returns the height of the items in the list view.
 
void setHeaderTextSize (unsigned int textSize)
 Changes the text size of the header caption.
 
TGUI_NODISCARD unsigned int getHeaderTextSize () const
 Returns the text size of the header caption.
 
void setSeparatorWidth (unsigned int width)
 Changes the width of the column separator.
 
TGUI_NODISCARD unsigned int getSeparatorWidth () const
 Returns the width of the column separator.
 
void setHeaderSeparatorHeight (unsigned int height)
 Changes the height of the separator between the header and the items.
 
TGUI_NODISCARD unsigned int getHeaderSeparatorHeight () const
 Returns the height of the separator between the header and the items.
 
void setGridLinesWidth (unsigned int width)
 Changes the width of the grid lines.
 
TGUI_NODISCARD unsigned int getGridLinesWidth () const
 Returns the width of the grid lines.
 
void setAutoScroll (bool autoScroll)
 Changes whether the list view scrolls to the bottom when a new item is added.
 
TGUI_NODISCARD bool getAutoScroll () const
 Returns whether the list view scrolls to the bottom when a new item is added.
 
void setShowVerticalGridLines (bool showGridLines)
 Changes whether lines are drawn between columns.
 
TGUI_NODISCARD bool getShowVerticalGridLines () const
 Returns whether lines are drawn between items.
 
void setShowHorizontalGridLines (bool showGridLines)
 Changes whether lines are drawn between items.
 
TGUI_NODISCARD bool getShowHorizontalGridLines () const
 Returns whether lines are drawn between items.
 
void setExpandLastColumn (bool expand)
 Changes whether the last column is expanded to fill the list view (if all columns fit inside the list view)
 
TGUI_NODISCARD bool getExpandLastColumn () const
 Returns whether the last column is expanded to fill the list view (if all columns fit inside the list view)
 
void setVerticalScrollbarPolicy (Scrollbar::Policy policy)
 Changes when the vertical scrollbar should be displayed.
 
TGUI_NODISCARD Scrollbar::Policy getVerticalScrollbarPolicy () const
 Returns when the vertical scrollbar should be displayed.
 
void setHorizontalScrollbarPolicy (Scrollbar::Policy policy)
 Changes when the horizontal scrollbar should be displayed.
 
TGUI_NODISCARD Scrollbar::Policy getHorizontalScrollbarPolicy () const
 Returns when the horizontal scrollbar should be displayed.
 
void setVerticalScrollbarValue (unsigned int value)
 Changes the thumb position of the vertical scrollbar.
 
TGUI_NODISCARD unsigned int getVerticalScrollbarValue () const
 Returns the thumb position of the vertical scrollbar.
 
TGUI_NODISCARD unsigned int getVerticalScrollbarMaxValue () const
 Returns the maximum thumb position of the vertical scrollbar.
 
void setHorizontalScrollbarValue (unsigned int value)
 Changes the thumb position of the horizontal scrollbar.
 
TGUI_NODISCARD unsigned int getHorizontalScrollbarValue () const
 Returns the thumb position of the horizontal scrollbar.
 
TGUI_NODISCARD unsigned int getHorizontalScrollbarMaxValue () const
 Returns the maximum thumb position of the horizontal scrollbar.
 
void setFixedIconSize (Vector2f iconSize)
 Sets a size to which all icons should be scaled.
 
TGUI_NODISCARD Vector2f getFixedIconSize () const
 Returns to which size all icons should be scaled.
 
void setResizableColumns (bool resizable)
 Changes whether the user can resize the columns by dragging the border between columns.
 
TGUI_NODISCARD bool getResizableColumns () const
 Returns whether the user can resize the columns by dragging the border between columns.
 
TGUI_NODISCARD bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
 
bool leftMousePressed (Vector2f pos) override
 Called by the parent when the left mouse button goes down on top of the widget.
 
void leftMouseReleased (Vector2f pos) override
 
void rightMousePressed (Vector2f pos) override
 
void mouseMoved (Vector2f pos) override
 
bool scrolled (float delta, Vector2f pos, bool touch) override
 Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)
 
void mouseNoLongerOnWidget () override
 
void leftMouseButtonNoLongerDown () override
 
void keyPressed (const Event::KeyEvent &event) override
 
bool canHandleKeyPress (const Event::KeyEvent &event) override
 Called by the parent of the widget to check if keyPressed would process the event.
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the widget to a render target.
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
- Public Member Functions inherited from tgui::Widget
 Widget (const char *typeName, bool initRenderer)
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&) noexcept
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&) noexcept
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks.
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget.
 
TGUI_NODISCARD Vector2f getPosition () const
 Gets the position of the widget.
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
void setWidth (Layout width)
 Changes the width of the widget.
 
void setHeight (Layout height)
 Changes the height of the widget.
 
TGUI_NODISCARD Vector2f getSize () const
 Returns the size of the widget.
 
virtual TGUI_NODISCARD Vector2f getFullSize () const
 Returns the entire size that the widget is using.
 
virtual TGUI_NODISCARD Vector2f getAbsolutePosition (Vector2f offset={}) const
 Get the absolute position of the widget instead of the relative position to its parent.
 
virtual TGUI_NODISCARD Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed.
 
void setAutoLayout (AutoLayout layout)
 Sets how the position is determined compared to the other widgets in the parent.
 
TGUI_NODISCARD AutoLayout getAutoLayout () const
 Returns how the position is determined compared to the other widgets in the parent.
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based.
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based.
 
TGUI_NODISCARD Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based.
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget.
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget.
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget.
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget.
 
TGUI_NODISCARD Vector2f getScale () const
 Returns the scaling to be applied to the widget.
 
TGUI_NODISCARD Vector2f getScaleOrigin () const
 Returns the origin used for scaling.
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget.
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget.
 
TGUI_NODISCARD float getRotation () const
 Returns the rotation to be applied to the widget.
 
TGUI_NODISCARD Vector2f getRotationOrigin () const
 Returns the origin used for rotations.
 
void showWithEffect (ShowEffectType type, Duration duration)
 Shows the widget by introducing it with an animation.
 
void hideWithEffect (ShowEffectType type, Duration duration)
 Hides the widget by making it leave with an animation.
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration.
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration.
 
virtual void setVisible (bool visible)
 Shows or hides a widget.
 
TGUI_NODISCARD bool isVisible () const
 Returns true when the widget is visible.
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget.
 
TGUI_NODISCARD bool isEnabled () const
 Returns true when the widget is enabled.
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget.
 
TGUI_NODISCARD bool isFocused () const
 Returns true when the widget is focused and false otherwise.
 
TGUI_NODISCARD const StringgetWidgetType () const
 Returns the type of the widget.
 
TGUI_NODISCARD ContainergetParent () const
 Returns a pointer to the parent widget.
 
TGUI_NODISCARD BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs.
 
TGUI_NODISCARD bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect)
 
void moveToFront ()
 Places the widget before all other widgets.
 
void moveToBack ()
 Places the widget behind all other widgets.
 
void setUserData (Any userData)
 Stores some data into the widget.
 
template<typename DataType >
TGUI_NODISCARD DataType getUserData () const
 Returns data stored in the widget.
 
TGUI_NODISCARD bool hasUserData () const
 Returns whether data stored in the widget.
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer.
 
TGUI_NODISCARD const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer.
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.
 
TGUI_NODISCARD float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer.
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text.
 
TGUI_NODISCARD unsigned int getTextSize () const
 Returns the character size of text in this widget.
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget.
 
TGUI_NODISCARD Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget.
 
void setWidgetName (const String &name)
 Changes the name of a widget.
 
TGUI_NODISCARD String getWidgetName () const
 Returns the name of a widget.
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget.
 
TGUI_NODISCARD Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget.
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused.
 
TGUI_NODISCARD bool isFocusable () const
 Returns whether a widget could be focused.
 
void setNavigationUp (const Widget::Ptr &widgetAbove)
 Changes which widget should become focused when navigating upwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationUp () const
 Returns which widget would become focused when navigating upwards from this widget.
 
void setNavigationDown (const Widget::Ptr &widgetBelow)
 Changes which widget should become focused when navigating downwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationDown () const
 Returns which widget would become focused when navigating downwards from this widget.
 
void setNavigationLeft (const Widget::Ptr &widgetLeft)
 Changes which widget should become focused when navigating to the left from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationLeft () const
 Returns which widget would become focused when navigating to the left from this widget.
 
void setNavigationRight (const Widget::Ptr &widgetRight)
 Changes which widget should become focused when navigating to the right from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationRight () const
 Returns which widget would become focused when navigating to the right from this widget.
 
void setIgnoreMouseEvents (bool ignore)
 Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.
 
TGUI_NODISCARD bool getIgnoreMouseEvents () const
 Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
virtual TGUI_NODISCARD bool canGainFocus () const
 Returns whether the widget can currently gain focus.
 
TGUI_NODISCARD bool isContainer () const
 Returns whether the widget is a container widget or not.
 
TGUI_NODISCARD bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget.
 
virtual void setParent (Container *parent)
 
void setAutoLayoutUpdateEnabled (bool enabled)
 
virtual void rightMouseReleased (Vector2f pos)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual void textEntered (char32_t key)
 
virtual void rightMouseButtonNoLongerDown ()
 
virtual TGUI_NODISCARD Widget::Ptr askToolTip (Vector2f mousePos)
 
TGUI_NODISCARD const Layout2dgetPositionLayout () const
 
TGUI_NODISCARD const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
void rendererChangedCallback (const String &property)
 

Static Public Member Functions

static TGUI_NODISCARD ListView::Ptr create ()
 Creates a new list view widget.
 
static TGUI_NODISCARD ListView::Ptr copy (const ListView::ConstPtr &listView)
 Makes a copy of another list view.
 

Public Attributes

SignalInt onItemSelect = {"ItemSelected"}
 
SignalInt onDoubleClick = {"DoubleClicked"}
 An item was double clicked. Optional parameter: selected item index.
 
SignalInt onRightClick = {"RightClicked"}
 Right mouse clicked. Optional parameter: index of item below mouse (-1 when not on top of item)
 
SignalInt onHeaderClick = {"HeaderClicked"}
 The header was clicked. Optional parameter: column index.
 
- Public Attributes inherited from tgui::Widget
SignalVector2f onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalVector2f onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
Signal onFocus = {"Focused"}
 The widget was focused.
 
Signal onUnfocus = {"Unfocused"}
 The widget was unfocused.
 
Signal onMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
Signal onMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 
SignalShowEffect onShowEffectFinish = {"ShowEffectFinished"}
 A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.
 
SignalAnimationType onAnimationFinish = {"AnimationFinished"}
 An animation has finished.
 

Static Public Attributes

static constexpr const char StaticWidgetType [] = "ListView"
 Type name of the widget.
 

Protected Member Functions

TGUI_NODISCARD SignalgetSignal (String signalName) override
 Retrieves a signal based on its name.
 
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed.
 
TGUI_NODISCARD std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const override
 Saves the widget as a tree node in order to save it to a file.
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes.
 
void mouseEnteredWidget () override
 This function is called when the mouse enters the widget.
 
void mouseLeftWidget () override
 This function is called when the mouse leaves the widget.
 
void updateTextSize () override
 Called when the text size is changed (either by setTextSize or via the renderer)
 
TGUI_NODISCARD Vector2f getInnerSize () const
 
TGUI_NODISCARD Text createText (const String &caption)
 
TGUI_NODISCARD Text createHeaderText (const String &caption)
 
virtual void setItemColor (std::size_t index, const Color &color)
 
TGUI_NODISCARD float calculateAutoColumnWidth (const Text &text)
 
void updateSelectedAndhoveredItemColors ()
 
void updateItemColors ()
 
void updateHeaderTextsColor ()
 
void updateHoveredItem (int item)
 
void updateSelectedItem (int item)
 
void selectRangeFromEvent (std::size_t item)
 
bool updateWidestItemInColumn (std::size_t columnIndex)
 
bool updateWidestItemInColumn (std::size_t columnIndex, std::size_t itemIndex)
 
bool updateWidestItem ()
 
bool updateWidestItem (std::size_t itemIndex)
 
void incrementWidestItemIndices (std::size_t itemIndex)
 
void updateColumnWidths ()
 
bool hasExpandedColumn () const
 
void addSelectedItem (int item)
 
void removeSelectedItem (std::size_t item)
 
void updateHoveredItemByMousePos (Vector2f mousePos)
 
TGUI_NODISCARD unsigned int getTotalSeparatorWidth () const
 
TGUI_NODISCARD float getItemTotalWidth (const Item &item, std::size_t columnIndex) const
 
TGUI_NODISCARD int getColumnIndexBelowMouse (float mouseLeft)
 
TGUI_NODISCARD bool findBorderBelowMouse (Vector2f pos, std::size_t &columnIndex) const
 
void updateScrollbars ()
 
void updateVerticalScrollbarMaximum ()
 
void drawHeaderText (BackendRenderTarget &target, RenderStates states, float columnWidth, float headerHeight, std::size_t column) const
 
void drawColumn (BackendRenderTarget &target, RenderStates states, std::size_t firstItem, std::size_t lastItem, std::size_t column, float columnWidth) const
 
bool updateTime (Duration elapsedTime) override
 
TGUI_NODISCARD Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type.
 
- Protected Member Functions inherited from tgui::Widget
void recalculateBoundPositionLayouts ()
 Calls recalculateValue() on each layout in m_boundPositionLayouts.
 
void recalculateBoundSizeLayouts ()
 Calls recalculateValue() on each layout in m_boundSizeLayouts.
 

Protected Attributes

std::vector< Columnm_columns
 
std::vector< Itemm_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
 
std::size_t m_widestItemIndex = std::numeric_limits<std::size_t>::max()
 
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_resizingColumnLastMouseX = 0
 
CopiedSharedPtr< ScrollbarChildWidgetm_horizontalScrollbar
 
CopiedSharedPtr< ScrollbarChildWidgetm_verticalScrollbar
 
Scrollbar::Policy m_verticalScrollbarPolicy = Scrollbar::Policy::Automatic
 
Scrollbar::Policy m_horizontalScrollbarPolicy = Scrollbar::Policy::Automatic
 
int m_mouseOnHeaderIndex = -1
 
int m_possibleDoubleClick = false
 
bool m_autoScroll = true
 
Sprite m_spriteHeaderBackground
 
Sprite m_spriteBackground
 
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
 
- Protected Attributes inherited from tgui::Widget
String m_type
 
String m_name
 
Layout2d m_position
 Stores the position of this widget.
 
Layout2d m_size
 Stores the size of this widget.
 
unsigned int m_textSize = 0
 
Vector2f m_origin
 
Optional< Vector2fm_rotationOrigin
 
Optional< Vector2fm_scaleOrigin
 
Vector2f m_scaleFactors = {1, 1}
 
float m_rotationDeg = 0
 
Vector2f m_prevPosition
 
Vector2f m_prevSize
 
std::unordered_set< Layout * > m_boundPositionLayouts
 
std::unordered_set< Layout * > m_boundSizeLayouts
 
bool m_enabled = true
 Stores the flag indicating whether this widget is enabled.
 
bool m_visible = true
 Stores the flag indicating whether this widget is visible.
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
std::weak_ptr< Widgetm_navWidgetUp
 
std::weak_ptr< Widgetm_navWidgetDown
 
std::weak_ptr< Widgetm_navWidgetRight
 
std::weak_ptr< Widgetm_navWidgetLeft
 
Duration m_animationTimeElapsed
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::unique_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 
AutoLayout m_autoLayout = AutoLayout::Manual
 
bool m_autoLayoutUpdateEnabled = true
 
bool m_ignoreMouseEvents = false
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 

Additional Inherited Members

- Protected Types inherited from tgui::Widget
using SavingRenderersMap = std::map<const Widget*, std::pair<std::unique_ptr<DataIO::Node>, String>>
 
using LoadingRenderersMap = std::map<String, std::shared_ptr<RendererData>>
 

Detailed Description

List view widget.

When no columns are added, the list view acts like a ListBox with a few extra functionalities.

Member Function Documentation

◆ addColumn()

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

Adds a column.

Parameters
textThe caption of the new column
widthWidth of the column. Set width to 0 to make it depend on the width of the column caption.
alignmentThe text alignment for all texts in the column
Returns
Index of the added column

◆ addItem() [1/2]

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

Adds an item with values for multiple columns to the list.

Parameters
itemTexts for each column
Returns
Index of the item that was just added

Example usage:

listView->addItem({"DejaVuSans.ttf", "720.9 KB", "01 Jan 1970"});

◆ addItem() [2/2]

std::size_t tgui::ListView::addItem ( const String & text)

Adds an item to the list.

Parameters
textThe caption of the item you want to add
Returns
Index of the item that was just added

This function only sets a value for the first column. To add an item with values for multiple columns, see the addItem(std::vector<tgui::String>) function.

◆ addMultipleItems()

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

Adds multiple items to the list.

Parameters
itemsList of items that should be passed to the addItem

◆ canHandleKeyPress()

bool tgui::ListView::canHandleKeyPress ( const Event::KeyEvent & event)
overridevirtual

Called by the parent of the widget to check if keyPressed would process the event.

Parameters
eventKey event that took place
Returns
True if the event would be handled by the widget, false if the key event doesn't affect the widget
Since
TGUI 1.1

Reimplemented from tgui::Widget.

◆ changeItem()

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

Changes an item with values for multiple columns to the list.

Parameters
indexIndex of the item to update
itemTexts for each column
Returns
True when the item was updated, false when the index was too high

◆ changeSubItem()

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

Changes the caption of a single value in the item.

Parameters
indexIndex of the item to update
columnIndex of the column to change
itemTexts for the given column for the given item
Returns
True when the item was updated, false when the index was too high

◆ clone()

TGUI_NODISCARD Widget::Ptr tgui::ListView::clone ( ) const
overrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns
Copy of the widget

Implements tgui::Widget.

◆ copy()

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

Makes a copy of another list view.

Parameters
listViewThe other list view
Returns
The new list view

◆ create()

static TGUI_NODISCARD ListView::Ptr tgui::ListView::create ( )
static

Creates a new list view widget.

Returns
The new list view

◆ draw()

void tgui::ListView::draw ( BackendRenderTarget & target,
RenderStates states ) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ getAutoScroll()

TGUI_NODISCARD bool tgui::ListView::getAutoScroll ( ) const

Returns whether the list view scrolls to the bottom when a new item is added.

Returns
Does the list view scroll to the bottom when new items are added

◆ getColumnAlignment()

TGUI_NODISCARD HorizontalAlignment tgui::ListView::getColumnAlignment ( std::size_t columnIndex) const

Returns the current text alignment within a column.

Parameters
columnIndexIndex of the column to inspect
Returns
Text alignment for all texts in the column

◆ getColumnAutoResize()

TGUI_NODISCARD bool tgui::ListView::getColumnAutoResize ( std::size_t index) const

Returns whether the column width depends on the widest item added to that column.

Parameters
indexIndex of the column
Returns
Does the column's width expand and shrink when the widest item in the column changes?
Since
TGUI 1.1

◆ getColumnCount()

TGUI_NODISCARD std::size_t tgui::ListView::getColumnCount ( ) const

Returns the amount of columns in the list view.

Returns
Number of columns

◆ getColumnDesignWidth()

TGUI_NODISCARD float tgui::ListView::getColumnDesignWidth ( std::size_t index) const

Returns the original width of a column (the value passed to addColumn or the last setColumnWidth call)

Parameters
indexIndex of the column
Returns
Width of the column prior to expanding the column and prior to the user resizing it
See also
getColumnWidth
Since
TGUI 1.1

◆ getColumnExpanded()

TGUI_NODISCARD bool tgui::ListView::getColumnExpanded ( std::size_t index) const

Returns whether the column is expanded to fill the list view (if all columns fit inside the list view)

Parameters
indexIndex of the column
Returns
Is the column is expanded to make it fill the list view when the list view isn't full yet?
Since
TGUI 1.1

◆ getColumnText()

TGUI_NODISCARD String tgui::ListView::getColumnText ( std::size_t index) const

Returns the text of a column.

Parameters
indexIndex of the column
Returns
Caption of the column

◆ getColumnWidth()

TGUI_NODISCARD float tgui::ListView::getColumnWidth ( std::size_t index) const

Returns the width of a column.

Parameters
indexIndex of the column
Returns
Current width of the column
Warning
This returns the actual width of the column, which may differ from the value passed to addColumn or setColumnWidth when e.g. the width was set to 0.
See also
getColumnDesignWidth

◆ getCurrentHeaderHeight()

TGUI_NODISCARD float tgui::ListView::getCurrentHeaderHeight ( ) const

Returns the height of the header or 0 if no header row is shown.

Returns
getHeaderHeight() + getHeaderSeparatorHeight() or 0 if no header is shown

◆ getExpandLastColumn()

TGUI_NODISCARD bool tgui::ListView::getExpandLastColumn ( ) const

Returns whether the last column is expanded to fill the list view (if all columns fit inside the list view)

Returns
Is the last column larger to make it fill the list view when the list view isn't full yet?
Deprecated
Replaced by ColumnAutoExpanded and ColumnAutoResize setters and getters in TGUI 1.1

◆ getFixedIconSize()

TGUI_NODISCARD Vector2f tgui::ListView::getFixedIconSize ( ) const

Returns to which size all icons should be scaled.

Returns
Wanted size for all icons

By default the fixed icon size is set to (0,0) which doesn't scale the icons and lets each icon use the texture size.

◆ getGridLinesWidth()

TGUI_NODISCARD unsigned int tgui::ListView::getGridLinesWidth ( ) const

Returns the width of the grid lines.

Returns
Width of the grid lines

◆ getHeaderHeight()

TGUI_NODISCARD float tgui::ListView::getHeaderHeight ( ) const

Returns the height of the header row.

Returns
Configured height of the header

◆ getHeaderSeparatorHeight()

TGUI_NODISCARD unsigned int tgui::ListView::getHeaderSeparatorHeight ( ) const

Returns the height of the separator between the header and the items.

Returns
Height of the line below the header

◆ getHeaderTextSize()

TGUI_NODISCARD unsigned int tgui::ListView::getHeaderTextSize ( ) const

Returns the text size of the header caption.

Returns
The header text size

◆ getHeaderVisible()

TGUI_NODISCARD bool tgui::ListView::getHeaderVisible ( ) const

Returns whether the header is shown.

Returns
Whether the header containing the column names is visible

◆ getHorizontalScrollbarMaxValue()

TGUI_NODISCARD unsigned int tgui::ListView::getHorizontalScrollbarMaxValue ( ) const

Returns the maximum thumb position of the horizontal scrollbar.

Returns
Maximum value of the horizontal scrollbar
Since
TGUI 1.4

◆ getHorizontalScrollbarPolicy()

TGUI_NODISCARD Scrollbar::Policy tgui::ListView::getHorizontalScrollbarPolicy ( ) const

Returns when the horizontal scrollbar should be displayed.

Returns
The policy for displaying the horizontal scrollbar

◆ getHorizontalScrollbarValue()

TGUI_NODISCARD unsigned int tgui::ListView::getHorizontalScrollbarValue ( ) const

Returns the thumb position of the horizontal scrollbar.

Returns
Value of the horizontal scrollbar

◆ getItem()

TGUI_NODISCARD String tgui::ListView::getItem ( std::size_t index) const

Retrieves an item in the list.

Parameters
indexThe index of the item
Returns
Text of the item or an empty string when the index was higher than the amount of items

◆ getItemCell()

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

Retrieves the value for a cell in the list.

Parameters
rowIndexThe index of the row
columnIndexThe index of the column
Returns
Text of the cell or an empty string when the index is out of range

◆ getItemCount()

TGUI_NODISCARD std::size_t tgui::ListView::getItemCount ( ) const

Returns the amount of items in the list view.

Returns
Number of items inside the list view

◆ getItemData()

template<typename DataType >
TGUI_NODISCARD DataType tgui::ListView::getItemData ( std::size_t index) const
inline

Returns user data stored in the item.

Returns
Stored data
Exceptions
std::bad_castif the template type does not match the type inside the std::any variable passed in setItemData or when the index was too high (which acts as if you access an empty std::any variable).

◆ getItemHeight()

TGUI_NODISCARD unsigned int tgui::ListView::getItemHeight ( ) const

Returns the height of the items in the list view.

Returns
The item height

◆ getItemIcon()

TGUI_NODISCARD Texture tgui::ListView::getItemIcon ( std::size_t index) const

Gets the icon displayed in front of the item.

Parameters
indexIndex of the item
Returns
Texture of the item icon

◆ getItemRow()

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

Retrieves the values of all columns for an item in the list.

Parameters
indexThe index of the item
Returns
Texts of the item for each column or an list of empty strings when the index was too high

The returned list has the same length as the amount of columns.

◆ getItemRows()

TGUI_NODISCARD std::vector< std::vector< String > > tgui::ListView::getItemRows ( ) const

Returns a list of all column values for all items in the list view.

Returns
Texts of the items and their subitems

◆ getItems()

TGUI_NODISCARD std::vector< String > tgui::ListView::getItems ( ) const

Returns a list of the texts in the first column for all items in the list view.

Returns
Texts of the first column of items

◆ getMultiSelect()

TGUI_NODISCARD bool tgui::ListView::getMultiSelect ( ) const

Returns multi selection of the items is allowed.

Returns
Whether several items can be selected

◆ getRenderer()

TGUI_NODISCARD ListViewRenderer * tgui::ListView::getRenderer ( )
overridevirtual

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer
Warning
After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

Reimplemented from tgui::Widget.

◆ getResizableColumns()

TGUI_NODISCARD bool tgui::ListView::getResizableColumns ( ) const

Returns whether the user can resize the columns by dragging the border between columns.

Returns
Can columns be resized by dragging their border?

Columns have a fixed width and are not resizable by default.

◆ getSelectedItemIndex()

TGUI_NODISCARD int tgui::ListView::getSelectedItemIndex ( ) const

Gets the index of the selected item.

Returns
The index of the selected item, or -1 when no item was selected

◆ getSelectedItemIndices()

TGUI_NODISCARD std::set< std::size_t > tgui::ListView::getSelectedItemIndices ( ) const

Gets the indices of the selected items.

Returns
The indices of the selected items

◆ getSeparatorWidth()

TGUI_NODISCARD unsigned int tgui::ListView::getSeparatorWidth ( ) const

Returns the width of the column separator.

Returns
Width of the line separating the columns

◆ getSharedRenderer() [1/2]

TGUI_NODISCARD const ListViewRenderer * tgui::ListView::getSharedRenderer ( ) const
overridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

TGUI_NODISCARD ListViewRenderer * tgui::ListView::getSharedRenderer ( )
overridevirtual

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer that may be shared with other widgets using the same renderer

Reimplemented from tgui::Widget.

◆ getShowHorizontalGridLines()

TGUI_NODISCARD bool tgui::ListView::getShowHorizontalGridLines ( ) const

Returns whether lines are drawn between items.

Returns
Is there a horizontal line to separate items?

◆ getShowVerticalGridLines()

TGUI_NODISCARD bool tgui::ListView::getShowVerticalGridLines ( ) const

Returns whether lines are drawn between items.

Returns
Is there a horizontal line to separate items?

◆ getSignal()

TGUI_NODISCARD Signal & tgui::ListView::getSignal ( String signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::Widget.

◆ getVerticalScrollbarMaxValue()

TGUI_NODISCARD unsigned int tgui::ListView::getVerticalScrollbarMaxValue ( ) const

Returns the maximum thumb position of the vertical scrollbar.

Returns
Maximum value of the vertical scrollbar
Since
TGUI 1.4

◆ getVerticalScrollbarPolicy()

TGUI_NODISCARD Scrollbar::Policy tgui::ListView::getVerticalScrollbarPolicy ( ) const

Returns when the vertical scrollbar should be displayed.

Returns
The policy for displaying the vertical scrollbar

◆ getVerticalScrollbarValue()

TGUI_NODISCARD unsigned int tgui::ListView::getVerticalScrollbarValue ( ) const

Returns the thumb position of the vertical scrollbar.

Returns
Value of the vertical scrollbar

◆ insertItem() [1/2]

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

Inserts an item into the list.

Parameters
indexIndex to insert the item at
itemTexts for each column

◆ insertItem() [2/2]

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

Inserts an item into the list.

Parameters
indexIndex to insert the item at
textThe caption of the item you want to add

◆ insertMultipleItems()

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

Inserts multiple items into the list.

Parameters
indexIndex to insert the items at
itemsList of items that should be passed to the insertItem

◆ isMouseOnWidget()

TGUI_NODISCARD bool tgui::ListView::isMouseOnWidget ( Vector2f pos) const
overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns
Is the mouse on top of the widget?

Implements tgui::Widget.

◆ keyPressed()

void tgui::ListView::keyPressed ( const Event::KeyEvent & event)
overridevirtual

Reimplemented from tgui::Widget.

◆ leftMouseButtonNoLongerDown()

void tgui::ListView::leftMouseButtonNoLongerDown ( )
overridevirtual

Reimplemented from tgui::Widget.

◆ leftMousePressed()

bool tgui::ListView::leftMousePressed ( Vector2f pos)
overridevirtual

Called by the parent when the left mouse button goes down on top of the widget.

Parameters
posMouse position in view coordinates relative to the parent widget
Returns
True if the clicked part of the widget is draggable, i.e. if the widget should continue to receive mouse move events until the mouse is released, even when the mouse leaves the widget. When false is returned, the mouse move events will only be sent to the widget as long as the mouse is on top of the widget.

Reimplemented from tgui::Widget.

◆ leftMouseReleased()

void tgui::ListView::leftMouseReleased ( Vector2f pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ load()

void tgui::ListView::load ( const std::unique_ptr< DataIO::Node > & node,
const LoadingRenderersMap & renderers )
overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ mouseEnteredWidget()

void tgui::ListView::mouseEnteredWidget ( )
overrideprotectedvirtual

This function is called when the mouse enters the widget.

Reimplemented from tgui::Widget.

◆ mouseLeftWidget()

void tgui::ListView::mouseLeftWidget ( )
overrideprotectedvirtual

This function is called when the mouse leaves the widget.

Reimplemented from tgui::Widget.

◆ mouseMoved()

void tgui::ListView::mouseMoved ( Vector2f pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ mouseNoLongerOnWidget()

void tgui::ListView::mouseNoLongerOnWidget ( )
overridevirtual

Reimplemented from tgui::Widget.

◆ removeItem()

bool tgui::ListView::removeItem ( std::size_t index)

Removes the item from the list view.

Parameters
indexIndex of the item in the list view
Returns
True when the item was removed, false when the index was too high

◆ rendererChanged()

void tgui::ListView::rendererChanged ( const String & property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyName of the property that was changed

Reimplemented from tgui::Widget.

◆ rightMousePressed()

void tgui::ListView::rightMousePressed ( Vector2f pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ save()

TGUI_NODISCARD std::unique_ptr< DataIO::Node > tgui::ListView::save ( SavingRenderersMap & renderers) const
overrideprotectedvirtual

Saves the widget as a tree node in order to save it to a file.

Reimplemented from tgui::Widget.

◆ scrolled()

bool tgui::ListView::scrolled ( float delta,
Vector2f pos,
bool touch )
overridevirtual

Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

Parameters
deltaScroll offset (positive is up, negative is down). High-precision mice may use non-integral offsets.
posMouse position, or the initial position of the touch events
touchWas this a touch event or a mouse wheel scroll?
Returns
Was the scrolling was handled by the widget?

Reimplemented from tgui::Widget.

◆ setAutoScroll()

void tgui::ListView::setAutoScroll ( bool autoScroll)

Changes whether the list view scrolls to the bottom when a new item is added.

Parameters
autoScrollShould list view scroll to the bottom when new items are added?

Auto scrolling is enabled by default.

◆ setColumnAlignment()

void tgui::ListView::setColumnAlignment ( std::size_t columnIndex,
HorizontalAlignment alignment )

Changes the text alignment within a column.

Parameters
columnIndexIndex of the column to change
alignmentThe text alignment for all texts in the column

◆ setColumnAutoResize()

void tgui::ListView::setColumnAutoResize ( std::size_t index,
bool autoResize )

Changes whether the column width depends on the widest item added to that column.

Parameters
indexIndex of the column to change
autoResizeShould the column's width expand and shrink when the widest item in the column changes?

If auto-resize is true then the width specified in addColumn and setColumnWidth will act as the minimum width. If the width was set to 0 then the minimum width is the width of the header caption.

If the user was allowed to resize columns (with setResizableColumns) then the auto-resize will be set to false again as soon as the user manually resizes the column.

Since
TGUI 1.1

◆ setColumnExpanded()

void tgui::ListView::setColumnExpanded ( std::size_t index,
bool expand )

Changes whether a column is expanded to fill the list view (if all columns fit inside the list view)

Parameters
indexIndex of the column to change
expandShould the column's width expand to make it fill the list view when the list view isn't full yet?

If multiple columns are marked as expanded, the free remaining width will be divided between them.

If auto-resize is also set to true then the width determine by auto-resize is considered the minimum width of the column.

If the user was allowed to resize columns (with setResizableColumns) then the column will no longer be expanded after the user manually resizes the column. Note that the user can't resize the last column while at least one column is still marked as expanded.

Since
TGUI 1.1

◆ setColumnText()

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

Changes the text of a column.

Parameters
indexIndex of the column to change
textCaption of the column

◆ setColumnWidth()

void tgui::ListView::setColumnWidth ( std::size_t index,
float width )

Changes the width of a column.

Parameters
indexIndex of the column to change
widthWidth of the column. Set width to 0 to make it depend on the width of the column caption.

◆ setExpandLastColumn()

void tgui::ListView::setExpandLastColumn ( bool expand)

Changes whether the last column is expanded to fill the list view (if all columns fit inside the list view)

Parameters
expandMake the last column larger to make it fill the list view when it isn't full yet?
Deprecated
Replaced by setColumnAutoExpanded and setColumnAutoResize in TGUI 1.1

◆ setFixedIconSize()

void tgui::ListView::setFixedIconSize ( Vector2f iconSize)

Sets a size to which all icons should be scaled.

Parameters
iconSizeWanted size for all icons

By default the fixed icon size is set to (0,0) which doesn't scale the icons and lets each icon use the texture size. By setting only the x or y component of the vector to 0, that dimension will be calculated to keep the icon ratio.

◆ setGridLinesWidth()

void tgui::ListView::setGridLinesWidth ( unsigned int width)

Changes the width of the grid lines.

Parameters
widthWidth of the grid lines

◆ setHeaderHeight()

void tgui::ListView::setHeaderHeight ( float height)

Changes the height of the header row.

Parameters
heightHeight of the header or 0 to make the header size depend on the row height

◆ setHeaderSeparatorHeight()

void tgui::ListView::setHeaderSeparatorHeight ( unsigned int height)

Changes the height of the separator between the header and the items.

Parameters
heightHeight of the line below the header

◆ setHeaderTextSize()

void tgui::ListView::setHeaderTextSize ( unsigned int textSize)

Changes the text size of the header caption.

Parameters
textSizeThe character size of the header text

By default, header text size is the same as the text size of the items.

◆ setHeaderVisible()

void tgui::ListView::setHeaderVisible ( bool showHeader)

Changes whether the header is shown.

Parameters
showHeaderWhether the header containing the column names shoud be visible

◆ setHorizontalScrollbarPolicy()

void tgui::ListView::setHorizontalScrollbarPolicy ( Scrollbar::Policy policy)

Changes when the horizontal scrollbar should be displayed.

Parameters
policyThe policy for displaying the horizontal scrollbar

◆ setHorizontalScrollbarValue()

void tgui::ListView::setHorizontalScrollbarValue ( unsigned int value)

Changes the thumb position of the horizontal scrollbar.

Parameters
valueNew value of the horizontal scrollbar

◆ setItemData()

void tgui::ListView::setItemData ( std::size_t index,
Any data )

Store some user data with the item.

Parameters
indexIndex of the item
dataUser data to store

Examples:

listView->setItemData(idx, "Data"); // Note: type to retrieve with getItemData is 'const char*' here
listView->setItemData(idx, 5);

◆ setItemHeight()

void tgui::ListView::setItemHeight ( unsigned int itemHeight)

Changes the height of the items in the list view.

Parameters
itemHeightThe size of a single item in the list

◆ setItemIcon()

void tgui::ListView::setItemIcon ( std::size_t index,
const Texture & texture )

Sets a small icon in front of the item.

Parameters
indexIndex of the item
textureTexture of the item icon

◆ setMultiSelect()

void tgui::ListView::setMultiSelect ( bool multiSelect)

Allow multi selection of the items.

Parameters
multiSelectWhether several items can be selected

◆ setResizableColumns()

void tgui::ListView::setResizableColumns ( bool resizable)

Changes whether the user can resize the columns by dragging the border between columns.

Parameters
resizableCan columns be resized by dragging their border?

Columns have a fixed width and are not resizable by default.

◆ setSelectedItem()

void tgui::ListView::setSelectedItem ( std::size_t index)

Selects an item in the list view.

Parameters
indexIndex of the item in the list view

◆ setSelectedItems()

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

Selects items in the list view.

Parameters
indicesIndices of the items in the list view

◆ setSeparatorWidth()

void tgui::ListView::setSeparatorWidth ( unsigned int width)

Changes the width of the column separator.

Parameters
widthWidth of the line separating the columns

◆ setShowHorizontalGridLines()

void tgui::ListView::setShowHorizontalGridLines ( bool showGridLines)

Changes whether lines are drawn between items.

Parameters
showGridLinesIs there a horizontal line to separate items?

Horizontal grid lines are hidden by default.

◆ setShowVerticalGridLines()

void tgui::ListView::setShowVerticalGridLines ( bool showGridLines)

Changes whether lines are drawn between columns.

Parameters
showGridLinesIs there a vertical line to separate columns?

Vertical grid lines are shown by default.

◆ setSize() [1/2]

void tgui::ListView::setSize ( const Layout2d & size)
overridevirtual

Changes the size of the list view.

Parameters
sizeThe new size of the list view

Reimplemented from tgui::Widget.

◆ setSize() [2/2]

void tgui::Widget::setSize ( Layout width,
Layout height )
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setVerticalScrollbarPolicy()

void tgui::ListView::setVerticalScrollbarPolicy ( Scrollbar::Policy policy)

Changes when the vertical scrollbar should be displayed.

Parameters
policyThe policy for displaying the vertical scrollbar

◆ setVerticalScrollbarValue()

void tgui::ListView::setVerticalScrollbarValue ( unsigned int value)

Changes the thumb position of the vertical scrollbar.

Parameters
valueNew value of the vertical scrollbar

◆ sort()

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

Sort items.

Parameters
indexThe index of the column for sorting
cmpThe comparator

Example:

listView->sort(0, [](const tgui::String& a, const tgui::String& b) { return a < b; });
Wrapper class to store strings.
Definition String.hpp:96

◆ updateTextSize()

void tgui::ListView::updateTextSize ( )
overrideprotectedvirtual

Called when the text size is changed (either by setTextSize or via the renderer)

Reimplemented from tgui::Widget.

◆ updateTime()

bool tgui::ListView::updateTime ( Duration elapsedTime)
overrideprotectedvirtual

Reimplemented from tgui::Widget.

Member Data Documentation

◆ onItemSelect

SignalInt tgui::ListView::onItemSelect = {"ItemSelected"}

An item was selected in the list view Optional parameter: selected item index (-1 when deselecting)

Note that when MultiSelect is true, this signal is triggered for every change to the selected items. The optional parameter will contain the lowest index in the selected items or -1 when none of the items are selected.


The documentation for this class was generated from the following file: