List view widget. More...

#include <TGUI/Widgets/ListView.hpp>

Inheritance diagram for tgui::ListView:

Classes
struct	Column

struct	Item

Public Types
enum class	ColumnAlignment { Left , Center , Right }
	The text alignment for all texts within a column. More...

typedef std::shared_ptr< ListView >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const ListView >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
	ListView (const char *typeName="ListView", bool initRenderer=true)

ListViewRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

const ListViewRenderer *	getSharedRenderer () const

ListViewRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

const ListViewRenderer *	getRenderer () const

void	setSize (const Layout2d &size) override
	Changes the size of the list view. More...

std::size_t	addColumn (const String &text, float width=0, ColumnAlignment alignment=ColumnAlignment::Left)
	Adds a column. More...

void	setColumnText (std::size_t index, const String &text)
	Changes the text of a column. More...

String	getColumnText (std::size_t index) const
	Returns the text of a column. More...

void	setColumnWidth (std::size_t index, float width)
	Changes the width of a column. More...

float	getColumnWidth (std::size_t index) const
	Returns the width of a column. More...

void	setColumnAlignment (std::size_t columnIndex, ColumnAlignment alignment)
	Changes the text alignment within a column. More...

ColumnAlignment	getColumnAlignment (std::size_t columnIndex) const
	Returns the current text alignment within a column. More...

void	removeAllColumns ()
	Removes all columns.

std::size_t	getColumnCount () const
	Returns the amount of columns in the list view. More...

void	setHeaderHeight (float height)
	Changes the height of the header row. More...

float	getHeaderHeight () const
	Returns the height of the header row. More...

float	getCurrentHeaderHeight () const
	Returns the height of the header or 0 if no header row is shown. More...

void	setHeaderVisible (bool showHeader)
	Changes whether the header is shown. More...

bool	getHeaderVisible () const
	Returns whether the header is shown. More...

std::size_t	addItem (const String &text)
	Adds an item to the list. More...

std::size_t	addItem (const std::vector< String > &item)
	Adds an item with values for multiple columns to the list. More...

void	addMultipleItems (const std::vector< std::vector< String > > &items)
	Adds multiple items to the list. More...

void	insertItem (std::size_t index, const String &text)
	Inserts an item into the list. More...

void	insertItem (std::size_t index, const std::vector< String > &item)
	Inserts an item into the list. More...

void	insertMultipleItems (std::size_t index, const std::vector< std::vector< String > > &items)
	Inserts multiple items into the list. More...

bool	changeItem (std::size_t index, const std::vector< String > &item)
	Changes an item with values for multiple columns to the list. More...

bool	changeSubItem (std::size_t index, std::size_t column, const String &item)
	Changes the caption of a single value in the item. More...

bool	removeItem (std::size_t index)
	Removes the item from the list view. More...

void	removeAllItems ()
	Removes all items from the list.

void	setSelectedItem (std::size_t index)
	Selects an item in the list view. More...

void	setSelectedItems (const std::set< std::size_t > &indices)
	Selects items in the list view. More...

void	deselectItems ()
	Deselects the selected items.

int	getSelectedItemIndex () const
	Gets the index of the selected item. More...

std::set< std::size_t >	getSelectedItemIndices () const
	Gets the indices of the selected items. More...

void	setMultiSelect (bool multiSelect)
	Allow multi selection of the items. More...

bool	getMultiSelect () const
	Returns multi selection of the items is allowed. More...

void	setItemData (std::size_t index, Any data)
	Store some user data with the item. More...

template<typename T >
T	getItemData (std::size_t index) const
	Returns user data stored in the item. More...

void	setItemIcon (std::size_t index, const Texture &texture)
	Sets a small icon in front of the item. More...

Texture	getItemIcon (std::size_t index) const
	Gets the icon displayed in front of the item. More...

std::size_t	getItemCount () const
	Returns the amount of items in the list view. More...

String	getItem (std::size_t index) const
	Retrieves an item in the list. More...

std::vector< String >	getItemRow (std::size_t index) const
	Retrieves the values of all columns for an item in the list. More...

String	getItemCell (std::size_t rowIndex, std::size_t columnIndex) const
	Retrieves the value for a cell in the list. More...

std::vector< String >	getItems () const
	Returns a list of the texts in the first column for all items in the list view. More...

std::vector< std::vector< String > >	getItemRows () const
	Returns a list of all column values for all items in the list view. More...

void	sort (std::size_t index, const std::function< bool(const String &, const String &)> &cmp)
	Sort items. More...

void	setItemHeight (unsigned int itemHeight)
	Changes the height of the items in the list view. More...

unsigned int	getItemHeight () const
	Returns the height of the items in the list view. More...

void	setHeaderTextSize (unsigned int textSize)
	Changes the text size of the header caption. More...

unsigned int	getHeaderTextSize () const
	Returns the text size of the header caption. More...

void	setSeparatorWidth (unsigned int width)
	Changes the width of the column separator. More...

unsigned int	getSeparatorWidth () const
	Returns the width of the column separator. More...

void	setHeaderSeparatorHeight (unsigned int height)
	Changes the height of the separator between the header and the items. More...

unsigned int	getHeaderSeparatorHeight () const
	Returns the height of the separator between the header and the items. More...

void	setGridLinesWidth (unsigned int width)
	Changes the width of the grid lines. More...

unsigned int	getGridLinesWidth () const
	Returns the width of the grid lines. More...

void	setAutoScroll (bool autoScroll)
	Changes whether the list view scrolls to the bottom when a new item is added. More...

bool	getAutoScroll () const
	Returns whether the list view scrolls to the bottom when a new item is added. More...

void	setShowVerticalGridLines (bool showGridLines)
	Changes whether lines are drawn between columns. More...

bool	getShowVerticalGridLines () const
	Returns whether lines are drawn between items. More...

void	setShowHorizontalGridLines (bool showGridLines)
	Changes whether lines are drawn between items. More...

bool	getShowHorizontalGridLines () const
	Returns whether lines are drawn between items. More...

void	setExpandLastColumn (bool expand)
	Changes whether the last column is expanded to fill the list view (if all columns fit inside the list view) More...

bool	getExpandLastColumn () const
	Returns whether the last column is expanded to fill the list view (if all columns fit inside the list view) More...

void	setVerticalScrollbarPolicy (Scrollbar::Policy policy)
	Changes when the vertical scrollbar should be displayed. More...

Scrollbar::Policy	getVerticalScrollbarPolicy () const
	Returns when the vertical scrollbar should be displayed. More...

void	setHorizontalScrollbarPolicy (Scrollbar::Policy policy)
	Changes when the horizontal scrollbar should be displayed. More...

Scrollbar::Policy	getHorizontalScrollbarPolicy () const
	Returns when the horizontal scrollbar should be displayed. More...

void	setVerticalScrollbarValue (unsigned int value)
	Changes the thumb position of the vertical scrollbar. More...

unsigned int	getVerticalScrollbarValue () const
	Returns the thumb position of the vertical scrollbar. More...

void	setHorizontalScrollbarValue (unsigned int value)
	Changes the thumb position of the horizontal scrollbar. More...

unsigned int	getHorizontalScrollbarValue () const
	Returns the thumb position of the horizontal scrollbar. More...

void	setFixedIconSize (Vector2f iconSize)
	Sets a size to which all icons should be scaled. More...

Vector2f	getFixedIconSize () const
	Returns to which size all icons should be scaled. More...

bool	isMouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...

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
	Draw the widget to a render target. More...

virtual void	setSize (const Layout2d &size)
	Changes the size of the widget. More...

void	setSize (Layout width, Layout height)
	Changes the size of the widget. More...

Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&)
	Move constructor.

virtual	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (Widget &&)
	Move assignment.

void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks. More...

WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

const WidgetRenderer *	getSharedRenderer () const

WidgetRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

const WidgetRenderer *	getRenderer () const

virtual void	setPosition (const Layout2d &position)
	sets the position of the widget More...

void	setPosition (Layout x, Layout y)
	Sets the position of the widget. More...

Vector2f	getPosition () const
	Gets the position of the widget. More...

virtual void	setSize (const Layout2d &size)
	Changes the size of the widget. More...

void	setSize (Layout width, Layout height)
	Changes the size of the widget. More...

void	setWidth (Layout width)
	Changes the width of the widget. More...

void	setHeight (Layout height)
	Changes the height of the widget. More...

Vector2f	getSize () const
	Returns the size of the widget. More...

virtual Vector2f	getFullSize () const
	Returns the entire size that the widget is using. More...

virtual Vector2f	getAbsolutePosition () const
	Get the absolute position of the top-left point of the widget instead of the relative position to its parent. More...

virtual Vector2f	getWidgetOffset () const
	Returns the distance between the position where the widget is drawn and where the widget is placed. More...

void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based. More...

void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based. More...

Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based. More...

void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget. More...

void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget. More...

void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget. More...

void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget. More...

Vector2f	getScale () const
	Returns the scaling to be applied to the widget. More...

Vector2f	getScaleOrigin () const
	Returns the origin used for scaling. More...

void	setRotation (float angle)
	Sets the rotation to be applied to the widget. More...

void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget. More...

float	getRotation () const
	Returns the rotation to be applied to the widget. More...

Vector2f	getRotationOrigin () const
	Returns the origin used for rotations. More...

void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation. More...

void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation. More...

void	moveWithAnimation (Layout2d position, Duration duration)
	Moves the widget from its current position to the given position, over a given duration. More...

void	resizeWithAnimation (Layout2d size, Duration duration)
	Resizes the widget from its current size to the given size, over a given duration. More...

virtual void	setVisible (bool visible)
	Shows or hides a widget. More...

bool	isVisible () const
	Returns true when the widget is visible. More...

virtual void	setEnabled (bool enabled)
	Enables or disables the widget. More...

bool	isEnabled () const
	Returns true when the widget is enabled. More...

virtual void	setFocused (bool focused)
	Focus or unfocus the widget. More...

bool	isFocused () const
	Returns true when the widget is focused and false otherwise. More...

const String &	getWidgetType () const
	Returns the type of the widget. More...

Container *	getParent () const
	Returns a pointer to the parent widget. More...

BackendGui *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs. More...

bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...

void	moveToFront ()
	Places the widget before all other widgets. More...

void	moveToBack ()
	Places the widget behind all other widgets. More...

void	setUserData (Any userData)
	Stores some data into the widget. More...

template<typename T >
T	getUserData () const
	Returns data stored in the widget. More...

void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer. More...

const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer. More...

void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...

float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...

void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text. More...

unsigned int	getTextSize () const
	Returns the character size of text in this widget. More...

void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget. More...

Widget::Ptr	getToolTip () const
	Returns the tool tip that is displayed when hovering over the widget. More...

void	setWidgetName (const String &name)
	Changes the name of a widget. More...

String	getWidgetName () const
	Returns the name of a widget. More...

void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget. More...

Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget. More...

void	setFocusable (bool focusable)
	Changes whether a widget could be focused. More...

bool	isFocusable () const
	Returns whether a widget could be focused. More...

void	finishAllAnimations ()
	Makes all animations of the widget finish immediately.

virtual bool	canGainFocus () const
	Returns whether the widget can currently gain focus. More...

bool	isContainer () const
	Returns whether the widget is a container widget or not. More...

bool	isDraggableWidget () const
	Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...

bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget. More...

virtual Signal &	getSignal (String signalName)
	Retrieves a signal based on its name. More...

virtual void	setParent (Container *parent)

virtual bool	updateTime (Duration elapsedTime)

virtual bool	isMouseOnWidget (Vector2f pos) const =0
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...

virtual void	leftMousePressed (Vector2f pos)

virtual void	leftMouseReleased (Vector2f pos)

virtual void	rightMousePressed (Vector2f pos)

virtual void	rightMouseReleased (Vector2f pos)

virtual void	mousePressed (Event::MouseButton button, Vector2f pos)

virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)

virtual void	mouseMoved (Vector2f pos)

virtual void	keyPressed (const Event::KeyEvent &event)

virtual void	textEntered (char32_t key)

virtual bool	mouseWheelScrolled (float delta, Vector2f pos)

virtual void	mouseNoLongerOnWidget ()

virtual void	leftMouseButtonNoLongerDown ()

virtual void	rightMouseButtonNoLongerDown ()

virtual Widget::Ptr	askToolTip (Vector2f mousePos)

const Layout2d &	getPositionLayout () const

const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

virtual void	draw (BackendRenderTarget &target, RenderStates states) const =0
	Draw the widget to a render target. More...

template<typename WidgetType >
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType >
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

virtual Widget::Ptr	clone () const =0
	Makes a copy of the widget if you don't know its exact type. More...

Static Public Member Functions
static ListView::Ptr	create ()
	Creates a new list view widget. More...

static ListView::Ptr	copy (ListView::ConstPtr listView)
	Makes a copy of another list view. More...

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. More...

Protected Member Functions
Signal &	getSignal (String signalName) override
	Retrieves a signal based on its name. More...

void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed. More...

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. More...

void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
	Loads the widget from a tree of nodes. More...

void	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer) More...

Vector2f	getInnerSize () const

Text	createText (const String &caption)

Text	createHeaderText (const String &caption)

virtual void	setItemColor (std::size_t index, const Color &color)

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	updateLastColumnMaxItemWidth ()

bool	updateLastColumnMaxItemWidthWithNewItem (const Item &item)

bool	updateLastColumnMaxItemWidthWithModifiedItem (const Item &modifiedItem, float oldDesiredWidthInLastColumn)

void	addSelectedItem (int item)

void	removeSelectedItem (std::size_t item)

void	updateHoveredItemByMousePos (Vector2f mousePos)

unsigned int	getTotalSeparatorWidth () const

float	getItemTotalWidth (const Item &item, std::size_t columnIndex) const

int	getColumnIndexBelowMouse (float mouseLeft)

void	updateScrollbars ()

void	updateVerticalScrollbarMaximum ()

void	updateHorizontalScrollbarMaximum ()

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

Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type. More...

Protected Member Functions inherited from tgui::Widget
virtual void	rendererChanged (const String &property)
	Function called when one of the properties of the renderer is changed. More...

virtual std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const
	Saves the widget as a tree node in order to save it to a file. More...

virtual void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers)
	Loads the widget from a tree of nodes. More...

virtual void	updateTextSize ()
	Called when the text size is changed (either by setTextSize or via the renderer) More...

virtual void	mouseEnteredWidget ()
	This function is called when the mouse enters the widget. More...

virtual void	mouseLeftWidget ()
	This function is called when the mouse leaves the widget. More...

Protected Attributes
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

bool	m_headerVisible = true

bool	m_showHorizontalGridLines = false

bool	m_showVerticalGridLines = true

bool	m_expandLastColumn = false

bool	m_multiSelect = false

Vector2f	m_fixedIconSize

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

int	m_possibleDoubleClick = false

bool	m_autoScroll = true

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

Layout2d	m_size

unsigned int	m_textSize = 0

Vector2f	m_origin

Optional< Vector2f >	m_rotationOrigin

Optional< Vector2f >	m_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

bool	m_visible = true

Container *	m_parent = nullptr

BackendGui *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

Duration	m_animationTimeElapsed

bool	m_draggableWidget = false

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr

std::vector< std::shared_ptr< priv::Animation > >	m_showAnimations

Font	m_inheritedFont

float	m_inheritedOpacity = 1

Font	m_fontCached = Font::getGlobalFont()

float	m_opacityCached = 1

bool	m_transparentTextureCached = false

unsigned int	m_textSizeCached = 0

Any	m_userData

Cursor::Type	m_mouseCursor = Cursor::Type::Arrow

std::function< void(const String &property)>	m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); }

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 Enumeration Documentation

◆ ColumnAlignment

enum class tgui::ListView::ColumnAlignment

strong

The text alignment for all texts within a column.

Enumerator
Left	Place the text on the left side (default)
Center	Center the text inside the column.
Right	Place the text on the right side (e.g. for numbers)

Member Function Documentation

◆ addColumn()

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

Adds a column.

Parameters

text	The caption of the new column
width	Width of the column. Set width to 0 to make it depend on the width of the column caption.
alignment	The 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

item	Texts for each column

Returns: Index of the item that was just added

◆ addItem() [2/2]

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

Adds an item to the list.

Parameters

text	The caption of the item you want to add

Returns: Index of the item that was just added

◆ addMultipleItems()

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

Adds multiple items to the list.

Parameters

items List of items that should be passed to the addItem

◆ 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

index	Index of the item to update
item	Texts 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

index	Index of the item to update
column	Index of the column to change
item	Texts for the given column for the given item

Returns: True when the item was updated, false when the index was too high

◆ clone()

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 ListView::Ptr tgui::ListView::copy ( ListView::ConstPtr listView )

static

Makes a copy of another list view.

Parameters

listView The other list view

Returns: The new list view

◆ create()

static 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

target	Render target to draw to
states	Current render states

Implements tgui::Widget.

◆ getAutoScroll()

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()

ColumnAlignment tgui::ListView::getColumnAlignment ( std::size_t columnIndex ) const

Returns the current text alignment within a column.

Parameters

columnIndex Index of the column to inspect

Returns: Text alignment for all texts in the column

◆ getColumnCount()

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

Returns the amount of columns in the list view.

Returns: Number of columns

◆ getColumnText()

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

Returns the text of a column.

Parameters

index Index of the column

Returns: Caption of the column

◆ getColumnWidth()

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

Returns the width of a column.

Parameters

index Index of the column

Returns: Width of the column

◆ getCurrentHeaderHeight()

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()

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?

◆ getFixedIconSize()

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()

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

Returns the width of the grid lines.

Returns: Width of the grid lines

◆ getHeaderHeight()

float tgui::ListView::getHeaderHeight ( ) const

Returns the height of the header row.

Returns: Configured height of the header

◆ getHeaderSeparatorHeight()

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()

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

Returns the text size of the header caption.

Returns: The header text size

◆ getHeaderVisible()

bool tgui::ListView::getHeaderVisible ( ) const

Returns whether the header is shown.

Returns: Whether the header containing the column names is visible

◆ getHorizontalScrollbarPolicy()

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

Returns when the horizontal scrollbar should be displayed.

Returns: The policy for displaying the horizontal scrollbar

◆ getHorizontalScrollbarValue()

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

Returns the thumb position of the horizontal scrollbar.

Returns: Value of the horizontal scrollbar

◆ getItem()

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

Retrieves an item in the list.

Parameters

index The index of the item

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

◆ getItemCell()

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

Retrieves the value for a cell in the list.

Parameters

rowIndex	The index of the row
columnIndex	The index of the column

Returns: Text of the cell or an empty string when the index is out of range

◆ getItemCount()

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 T >

T tgui::ListView::getItemData ( std::size_t index ) const

inline

Returns user data stored in the item.

Returns: Stored data

Exceptions

std::bad_cast if 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()

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

Returns the height of the items in the list view.

Returns: The item height

◆ getItemIcon()

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

Gets the icon displayed in front of the item.

Parameters

index Index of the item

Returns: Texture of the item icon

◆ getItemRow()

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

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

Parameters

index The 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()

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()

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()

bool tgui::ListView::getMultiSelect ( ) const

Returns multi selection of the items is allowed.

Returns: Whether several items can be selected

◆ getRenderer()

ListViewRenderer * tgui::ListView::getRenderer ( )

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.

◆ getSelectedItemIndex()

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()

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

Gets the indices of the selected items.

Returns: The indices of the selected items

◆ getSeparatorWidth()

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

Returns the width of the column separator.

Returns: Width of the line separating the columns

◆ getSharedRenderer()

ListViewRenderer * tgui::ListView::getSharedRenderer ( )

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

◆ getShowHorizontalGridLines()

bool tgui::ListView::getShowHorizontalGridLines ( ) const

Returns whether lines are drawn between items.

Returns: Is there a horizontal line to separate items?

◆ getShowVerticalGridLines()

bool tgui::ListView::getShowVerticalGridLines ( ) const

Returns whether lines are drawn between items.

Returns: Is there a horizontal line to separate items?

◆ getSignal()

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

overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters

signalName Name of the signal

Returns: Signal that corresponds to the name

Exceptions

Exception when the name does not match any signal

Reimplemented from tgui::Widget.

◆ getVerticalScrollbarPolicy()

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

Returns when the vertical scrollbar should be displayed.

Returns: The policy for displaying the vertical scrollbar

◆ getVerticalScrollbarValue()

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

index	Index to insert the item at
item	Texts for each column

◆ insertItem() [2/2]

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

Inserts an item into the list.

Parameters

index	Index to insert the item at
text	The 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

index	Index to insert the items at
items	List of items that should be passed to the insertItem

◆ isMouseOnWidget()

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()

void tgui::ListView::leftMousePressed ( Vector2f pos )

overridevirtual

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.

◆ mouseMoved()

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

overridevirtual

Reimplemented from tgui::Widget.

◆ mouseNoLongerOnWidget()

void tgui::ListView::mouseNoLongerOnWidget ( )

overridevirtual

Reimplemented from tgui::Widget.

◆ mouseWheelScrolled()

bool tgui::ListView::mouseWheelScrolled	(	float	delta,
		Vector2f	pos
	)

overridevirtual

Reimplemented from tgui::Widget.

◆ removeItem()

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

Removes the item from the list view.

Parameters

index Index 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

property Name of the property that was changed

Reimplemented from tgui::Widget.

◆ rightMousePressed()

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

overridevirtual

Reimplemented from tgui::Widget.

◆ save()

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.

◆ setAutoScroll()

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

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

Parameters

autoScroll Should 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,
		ColumnAlignment	alignment
	)

Changes the text alignment within a column.

Parameters

columnIndex	Index of the column to change
alignment	The text alignment for all texts in the column

◆ setColumnText()

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

Changes the text of a column.

Parameters

index	Index of the column to change
text	Caption of the column

◆ setColumnWidth()

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

Changes the width of a column.

Parameters

index	Index of the column to change
width	Width 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

expand Make the last column larger to make it fill the list view when it isn't full yet?

◆ setFixedIconSize()

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

Sets a size to which all icons should be scaled.

Parameters

iconSize 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. 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

width Width of the grid lines

◆ setHeaderHeight()

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

Changes the height of the header row.

Parameters

height Height 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

height Height of the line below the header

◆ setHeaderTextSize()

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

Changes the text size of the header caption.

Parameters

textSize The 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

showHeader Whether 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

policy The policy for displaying the horizontal scrollbar

◆ setHorizontalScrollbarValue()

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

Changes the thumb position of the horizontal scrollbar.

Parameters

value New value of the horizontal scrollbar

◆ setItemData()

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

Store some user data with the item.

Parameters

index	Index of the item
data	User 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

itemHeight The 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

index	Index of the item
texture	Texture of the item icon

◆ setMultiSelect()

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

Allow multi selection of the items.

Parameters

multiSelect Whether several items can be selected

◆ setSelectedItem()

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

Selects an item in the list view.

Parameters

index Index 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

indices Indices of the items in the list view

◆ setSeparatorWidth()

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

Changes the width of the column separator.

Parameters

width Width of the line separating the columns

◆ setShowHorizontalGridLines()

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

Changes whether lines are drawn between items.

Parameters

showGridLines Is 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

showGridLines Is there a vertical line to separate columns?

Vertical grid lines are shown by default.

◆ setSize() [1/3]

virtual void tgui::Widget::setSize ( const Layout2d & size )

virtual

Changes the size of the widget.

Parameters

size	Size of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
 
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

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

overridevirtual

Changes the size of the list view.

Parameters

size	The new size of the list view

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

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

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height 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

policy The policy for displaying the vertical scrollbar

◆ setVerticalScrollbarValue()

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

Changes the thumb position of the vertical scrollbar.

Parameters

value New 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

index	The index of the column for sorting
cmp	The comparator

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

include/TGUI/Widgets/ListView.hpp

TGUI

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ColumnAlignment

Member Function Documentation

◆ addColumn()

◆ addItem() [1/2]

◆ addItem() [2/2]

◆ addMultipleItems()

◆ changeItem()

◆ changeSubItem()

◆ clone()

◆ copy()

◆ create()

◆ draw()

◆ getAutoScroll()

◆ getColumnAlignment()

◆ getColumnCount()

◆ getColumnText()

◆ getColumnWidth()

◆ getCurrentHeaderHeight()

◆ getExpandLastColumn()

◆ getFixedIconSize()

◆ getGridLinesWidth()

◆ getHeaderHeight()

◆ getHeaderSeparatorHeight()

◆ getHeaderTextSize()

◆ getHeaderVisible()

◆ getHorizontalScrollbarPolicy()

◆ getHorizontalScrollbarValue()

◆ getItem()

◆ getItemCell()

◆ getItemCount()

◆ getItemData()

◆ getItemHeight()

◆ getItemIcon()

◆ getItemRow()

◆ getItemRows()

◆ getItems()

◆ getMultiSelect()

◆ getRenderer()

◆ getSelectedItemIndex()

◆ getSelectedItemIndices()

◆ getSeparatorWidth()

◆ getSharedRenderer()

◆ getShowHorizontalGridLines()

◆ getShowVerticalGridLines()

◆ getSignal()

◆ getVerticalScrollbarPolicy()

◆ getVerticalScrollbarValue()

◆ insertItem() [1/2]

◆ insertItem() [2/2]

◆ insertMultipleItems()

◆ isMouseOnWidget()

◆ keyPressed()

◆ leftMouseButtonNoLongerDown()

◆ leftMousePressed()

◆ leftMouseReleased()

◆ load()

◆ mouseMoved()

◆ mouseNoLongerOnWidget()

◆ mouseWheelScrolled()

◆ removeItem()

◆ rendererChanged()

◆ rightMousePressed()

◆ save()

◆ setAutoScroll()

◆ setColumnAlignment()

◆ setColumnText()

◆ setColumnWidth()

◆ setExpandLastColumn()

◆ setFixedIconSize()