List box widget. More...

#include <TGUI/Widgets/ListBox.hpp>

Inheritance diagram for tgui::ListBox:

Classes
struct	Item

Public Types
using	Ptr = std::shared_ptr<ListBox>
	Shared widget pointer.

using	ConstPtr = std::shared_ptr<const ListBox>
	Shared constant widget pointer.

using	TextAlignment = HorizontalAlignment
	The horizontal text alignment.

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
	ListBox (const char *typeName=StaticWidgetType, bool initRenderer=true)

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

const ListBoxRenderer *	getSharedRenderer () const override

ListBoxRenderer *	getRenderer () 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 box.

std::size_t	addItem (const String &itemName, const String &id="")
	Adds an item to the list.

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

bool	setSelectedItem (const String &itemName)
	Selects an item in the list box.

bool	setSelectedItemById (const String &id)
	Selects an item in the list box.

bool	setSelectedItemByIndex (std::size_t index)
	Selects an item in the list box.

void	deselectItem ()
	Deselects the selected item.

bool	removeItem (const String &itemName)
	Removes the item from the list with the given name.

bool	removeItemById (const String &id)
	Removes the item that were added with the given id.

bool	removeItemByIndex (std::size_t index)
	Removes the item from the list box.

void	removeAllItems ()
	Removes all items from the list.

String	getItemById (const String &id) const
	Returns the item name of the item with the given id.

String	getItemByIndex (std::size_t index) const
	Returns the item name of the item at the given index.

int	getIndexById (const String &id) const
	Returns the index of the item with the given id.

String	getIdByIndex (std::size_t index) const
	Returns the id of the item at the given index.

String	getSelectedItem () const
	Returns the currently selected item.

String	getSelectedItemId () const
	Gets the id of the selected item.

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

int	getHoveredItemIndex () const
	Gets the index of the item below the mouse cursor.

bool	changeItem (const String &originalValue, const String &newValue)
	Changes an item with name originalValue to newValue.

bool	changeItemById (const String &id, const String &newValue)
	Changes the name of an item with the given id to newValue.

bool	changeItemByIndex (std::size_t index, const String &newValue)
	Changes the name of an item at the given index to newValue.

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

std::vector< String >	getItems () const
	Returns a copy of the items in the list box.

std::vector< String >	getItemIds () const
	Returns a copy of the item ids in the list box.

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

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

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

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

void	setMaximumItems (std::size_t maximumItems=0)
	Changes the maximum items that the list box can contain.

std::size_t	getMaximumItems () const
	Returns the maximum items that the list box can contain.

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

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

void	setTextAlignment (HorizontalAlignment alignment)
	Changes the horizontal text alignment.

HorizontalAlignment	getTextAlignment () const
	Gets the current horizontal text alignment.

bool	contains (const String &item) const
	Returns whether the list box contains the given item.

bool	containsId (const String &id) const
	Returns whether the list box contains an item with the given id.

void	setScrollbarValue (unsigned int value)
	Changes the thumb position of the scrollbar.

unsigned int	getScrollbarValue () const
	Returns the thumb position of the scrollbar.

unsigned int	getScrollbarMaxValue () const
	Returns the maximum thumb position of the scrollbar.

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

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

Widget &	operator= (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.

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.

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

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

virtual Vector2f	getAbsolutePosition (Vector2f offset={}) const
	Get the absolute position of the widget instead of the relative position to its parent.

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

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.

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.

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

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.

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

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.

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

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

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

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

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

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

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

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

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 >
DataType	getUserData () const
	Returns data stored in the widget.

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.

const Font &	getInheritedFont () 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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 bool	canGainFocus () const
	Returns whether the widget can currently gain focus.

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

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	rightMousePressed (Vector2f pos)

virtual void	rightMouseReleased (Vector2f pos)

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

virtual void	textEntered (char32_t key)

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)

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

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

void	rendererChangedCallback (const String &property)

Public Member Functions inherited from tgui::ScrollbarChildInterface
	ScrollbarChildInterface ()
	Default constructor.

	ScrollbarChildInterface (const ScrollbarChildInterface &)
	Copy constructor.

	ScrollbarChildInterface (ScrollbarChildInterface &&) noexcept
	Move constructor.

virtual	~ScrollbarChildInterface ()=default
	Destructor.

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

ScrollbarChildInterface &	operator= (ScrollbarChildInterface &&) noexcept
	Move assignment.

ScrollbarAccessor *	getScrollbar ()
	Returns an object that provides access to the widget's scrollbar.

const ScrollbarAccessor *	getScrollbar () const
	Returns an object that provides access to the widget's scrollbar.

Static Public Member Functions
static ListBox::Ptr	create ()
	Creates a new list box widget.

static ListBox::Ptr	copy (const ListBox::ConstPtr &listBox)
	Makes a copy of another list box.

Public Attributes
SignalItem	onItemSelect = {"ItemSelected"}
	An item was selected in the list box. Optional parameter: selected item or its index.

SignalItem	onMousePress = {"MousePressed"}
	The mouse went down on an item. Optional parameter: selected item or its index.

SignalItem	onMouseRelease = {"MouseReleased"}
	The mouse was released on one of the items. Optional parameter: selected item or its index.

SignalItem	onDoubleClick = {"DoubleClicked"}
	An item was double clicked. Optional parameter: selected item or its index.

SignalUInt	onScroll = {"Scrolled"}
	The list was scrolled. Optional parameter: new value of scrollbar.

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 [] = "ListBox"
	Type name of the widget.

Protected Member Functions
Signal &	getSignal (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.

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	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer)

void	scrollbarValueChanged () override
	Called when the value of the scrollbar has been changed via getScrollbar()->setValue(...)

Vector2f	getInnerSize () const

void	updateItemPositions ()

void	updateSelectedAndHoveringItemColorsAndStyle ()

void	updateItemColorsAndStyle ()

void	updateHoveringItem (int item)

void	updateSelectedItem (int item)

void	triggerOnScroll ()

void	addItemImpl (const String &itemName, const String &id)

bool	updateTime (Duration elapsedTime) override

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
virtual void	mouseEnteredWidget ()
	This function is called when the mouse enters the widget.

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

void	recalculateBoundPositionLayouts ()
	Calls recalculateValue() on each layout in m_boundPositionLayouts.

void	recalculateBoundSizeLayouts ()
	Calls recalculateValue() on each layout in m_boundSizeLayouts.

Protected Member Functions inherited from tgui::ScrollbarChildInterface
virtual void	scrollbarPolicyChanged ()
	Called when the policy of the scrollbar has been changed via getScrollbar()->setPolicy(...)

virtual void	scrollbarScrollAmountChanged ()
	Called when the scroll amount of the scrollbar has been changed via getScrollbar()->setScrollAmount(...)

void	saveScrollbarPolicy (std::unique_ptr< DataIO::Node > &node) const
	This function should be called inside the save function in order to save the configured scrollbar policy.

void	loadScrollbarPolicy (const std::unique_ptr< DataIO::Node > &node)
	This function should be called inside the load function in order to load the wanted scrollbar policy.

Protected Attributes
std::vector< Item >	m_items

int	m_selectedItem = -1

int	m_hoveringItem = -1

unsigned int	m_itemHeight = 0

std::size_t	m_maxItems = 0

unsigned int	m_lastScrollbarValue = 0

bool	m_possibleDoubleClick = false

bool	m_autoScroll = true

HorizontalAlignment	m_textAlignment = HorizontalAlignment::Left

Sprite	m_spriteBackground

Borders	m_bordersCached

Borders	m_paddingCached

Color	m_borderColorCached

Color	m_backgroundColorCached

Color	m_backgroundColorHoverCached

Color	m_selectedBackgroundColorCached

Color	m_selectedBackgroundColorHoverCached

Color	m_textColorCached

Color	m_textColorHoverCached

Color	m_selectedTextColorCached

Color	m_selectedTextColorHoverCached

TextStyles	m_textStyleCached

TextStyles	m_selectedTextStyleCached

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< 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
	Stores the flag indicating whether this widget is enabled.

bool	m_visible = true
	Stores the flag indicating whether this widget is visible.

Container *	m_parent = nullptr

BackendGui *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

std::weak_ptr< Widget >	m_navWidgetUp

std::weak_ptr< Widget >	m_navWidgetDown

std::weak_ptr< Widget >	m_navWidgetRight

std::weak_ptr< Widget >	m_navWidgetLeft

Duration	m_animationTimeElapsed

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_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

Protected Attributes inherited from tgui::ScrollbarChildInterface
CopiedSharedPtr< ScrollbarChildWidget >	m_scrollbar

ScrollbarAccessor	m_scrollbarAccessor

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 box widget.

Member Function Documentation

◆ addItem()

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

Adds an item to the list.

Parameters

itemName	The name of the item you want to add (this is the text that will be displayed inside the list box)
id	Optional unique id given to this item for the purpose to later identifying this item

Returns

Index of inserted item if no maximum items are set or when index is still less than getMaximumItems()
Value of getMaximumItems() when adding item failed because there are too many items

◆ addMultipleItems()

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

Adds multiple items to the list.

Parameters

itemNames List of items that should be passed to the addItem function

If a maximum items was configured then this function stops adding items when the maximum is reached.

Since: TGUI 1.6

◆ canHandleKeyPress()

bool tgui::ListBox::canHandleKeyPress ( const Event::KeyEvent & event )

overridevirtual

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

Parameters

event Key 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::ListBox::changeItem	(	const String &	originalValue,
		const String &	newValue )

Changes an item with name originalValue to newValue.

Parameters

originalValue	The name of the item which you want to change
newValue	The new name for that item

In case the names are not unique, only the first item with that name will be changed.

Returns

true when the item was changed
false when none of the items had the given name

◆ changeItemById()

bool tgui::ListBox::changeItemById	(	const String &	id,
		const String &	newValue )

Changes the name of an item with the given id to newValue.

Parameters

id	The unique id of the item which you want to change
newValue	The new name for that item

In case the id is not unique, only the first item with that id will be changed.

Returns

true when the item was changed
false when none of the items had the given id

◆ changeItemByIndex()

bool tgui::ListBox::changeItemByIndex	(	std::size_t	index,
		const String &	newValue )

Changes the name of an item at the given index to newValue.

Parameters

index	The index of the item which you want to change
newValue	The new name for that item

Returns

true when the item was changed
false when the index was too high

◆ clone()

Widget::Ptr tgui::ListBox::clone ( ) const

nodiscardoverrideprotectedvirtual

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.

◆ contains()

bool tgui::ListBox::contains ( const String & item ) const

nodiscard

Returns whether the list box contains the given item.

Parameters

item	The item to search for

Returns: Does the list box contain the item?

◆ containsId()

bool tgui::ListBox::containsId ( const String & id ) const

nodiscard

Returns whether the list box contains an item with the given id.

Parameters

id	The id of the item to search for

Returns: Does the list box contain the id?

◆ copy()

static ListBox::Ptr tgui::ListBox::copy ( const ListBox::ConstPtr & listBox )

staticnodiscard

Makes a copy of another list box.

Parameters

listBox The other list box

Returns: The new list box

◆ create()

static ListBox::Ptr tgui::ListBox::create ( )

staticnodiscard

Creates a new list box widget.

Returns: The new list box

◆ draw()

void tgui::ListBox::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::ListBox::getAutoScroll ( ) const

nodiscard

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

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

◆ getHoveredItemIndex()

int tgui::ListBox::getHoveredItemIndex ( ) const

nodiscard

Gets the index of the item below the mouse cursor.

Returns: The index of the item below the mouse, or -1 when the mouse isn't on top of any item

Since: TGUI 1.5

◆ getIdByIndex()

String tgui::ListBox::getIdByIndex ( std::size_t index ) const

nodiscard

Returns the id of the item at the given index.

Parameters

index The index of the item to find

Returns: The id of the requested item, or an empty string when the index was too high

◆ getIndexById()

int tgui::ListBox::getIndexById ( const String & id ) const

nodiscard

Returns the index of the item with the given id.

Parameters

id	The id of the item that was given to it when it was added

In case the id is not unique, the index of the first item with that id will be returned.

Returns: The index of the item that matched the id, or -1 when no item matches the id

◆ getItemById()

String tgui::ListBox::getItemById ( const String & id ) const

nodiscard

Returns the item name of the item with the given id.

Parameters

id	The id of the item that was given to it when it was added

In case the id is not unique, the first item with that id will be returned.

Returns: The requested item, or an empty string when no item matches the id

◆ getItemByIndex()

String tgui::ListBox::getItemByIndex ( std::size_t index ) const

nodiscard

Returns the item name of the item at the given index.

Parameters

index The index of the item to return

Returns: The requested item, or an empty string when the index was too high

◆ getItemCount()

std::size_t tgui::ListBox::getItemCount ( ) const

nodiscard

Returns the amount of items in the list box.

Returns: Number of items inside the list box

◆ getItemData()

template<typename DataType >

DataType tgui::ListBox::getItemData ( std::size_t index ) const

inlinenodiscard

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::ListBox::getItemHeight ( ) const

nodiscard

Returns the height of the items in the list box.

Returns: The item height

◆ getItemIds()

std::vector< String > tgui::ListBox::getItemIds ( ) const

nodiscard

Returns a copy of the item ids in the list box.

Returns: item ids

Items that were not given an id simply have an empty string as id.

◆ getItems()

std::vector< String > tgui::ListBox::getItems ( ) const

nodiscard

Returns a copy of the items in the list box.

Returns: items

◆ getMaximumItems()

std::size_t tgui::ListBox::getMaximumItems ( ) const

nodiscard

Returns the maximum items that the list box can contain.

Returns: The maximum items inside the list box. If the function returns 0 then there is no limit

◆ getRenderer()

ListBoxRenderer * tgui::ListBox::getRenderer ( )

nodiscardoverridevirtual

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.

◆ getScrollbarMaxValue()

unsigned int tgui::ListBox::getScrollbarMaxValue ( ) const

nodiscard

Returns the maximum thumb position of the scrollbar.

Returns: Maximum value of the scrollbar

Since: TGUI 1.4

◆ getScrollbarValue()

unsigned int tgui::ListBox::getScrollbarValue ( ) const

nodiscard

Returns the thumb position of the scrollbar.

Returns: Value of the scrollbar

◆ getSelectedItem()

String tgui::ListBox::getSelectedItem ( ) const

nodiscard

Returns the currently selected item.

Returns: The selected item When no item was selected then this function will return an empty string.

◆ getSelectedItemId()

String tgui::ListBox::getSelectedItemId ( ) const

nodiscard

Gets the id of the selected item.

Returns: The id of the selected item, which was the optional id passed to the addItem function. When no item was selected then this function returns an empty string

◆ getSelectedItemIndex()

int tgui::ListBox::getSelectedItemIndex ( ) const

nodiscard

Gets the index of the selected item.

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

◆ getSharedRenderer() [1/2]

const ListBoxRenderer * tgui::ListBox::getSharedRenderer ( ) const

nodiscardoverridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

ListBoxRenderer * tgui::ListBox::getSharedRenderer ( )

nodiscardoverridevirtual

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.

◆ getSignal()

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

nodiscardoverrideprotectedvirtual

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.

◆ getTextAlignment()

HorizontalAlignment tgui::ListBox::getTextAlignment ( ) const

nodiscard

Gets the current horizontal text alignment.

Returns: Horizontal text alignment

◆ isMouseOnWidget()

bool tgui::ListBox::isMouseOnWidget ( Vector2f pos ) const

nodiscardoverridevirtual

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::ListBox::keyPressed ( const Event::KeyEvent & event )

overridevirtual

Reimplemented from tgui::Widget.

◆ leftMouseButtonNoLongerDown()

void tgui::ListBox::leftMouseButtonNoLongerDown ( )

overridevirtual

Reimplemented from tgui::Widget.

◆ leftMousePressed()

bool tgui::ListBox::leftMousePressed ( Vector2f pos )

overridevirtual

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

Parameters

pos	Mouse 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::ListBox::leftMouseReleased ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ load()

void tgui::ListBox::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::ListBox::mouseMoved ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ mouseNoLongerOnWidget()

void tgui::ListBox::mouseNoLongerOnWidget ( )

overridevirtual

Reimplemented from tgui::Widget.

◆ removeItem()

bool tgui::ListBox::removeItem ( const String & itemName )

Removes the item from the list with the given name.

Parameters

itemName The item to remove

In case the names are not unique, only the first item with that name will be removed.

Returns

true when the item was removed
false when the name did not match any item

◆ removeItemById()

bool tgui::ListBox::removeItemById ( const String & id )

Removes the item that were added with the given id.

Parameters

id	Id that was given to the addItem function

In case the id is not unique, only the first item with that id will be removed.

Returns

true when the item was removed
false when there was no item with the given id

◆ removeItemByIndex()

bool tgui::ListBox::removeItemByIndex ( std::size_t index )

Removes the item from the list box.

Parameters

index Index of the item in the list box

Returns

true when the item was removed
false when the index was too high

See also: removeItem; removeItemById

◆ rendererChanged()

void tgui::ListBox::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.

◆ save()

std::unique_ptr< DataIO::Node > tgui::ListBox::save ( SavingRenderersMap & renderers ) const

nodiscardoverrideprotectedvirtual

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

Reimplemented from tgui::Widget.

◆ scrollbarValueChanged()

void tgui::ListBox::scrollbarValueChanged ( )

overrideprotectedvirtual

Called when the value of the scrollbar has been changed via getScrollbar()->setValue(...)

Reimplemented from tgui::ScrollbarChildInterface.

◆ scrolled()

bool tgui::ListBox::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

delta	Scroll offset (positive is up, negative is down). High-precision mice may use non-integral offsets.
pos	Mouse position, or the initial position of the touch events
touch	Was 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::ListBox::setAutoScroll ( bool autoScroll )

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

Parameters

autoScroll Should list box scroll to the bottom when new items are added?

Auto scrolling is enabled by default.

◆ setItemData()

void tgui::ListBox::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:

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

listBox->setItemData(idx, 5);

◆ setItemHeight()

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

Changes the height of the items in the list box.

Parameters

itemHeight The size of a single item in the list

Warning: When there is no scrollbar then the items will be removed when they no longer fit inside the list box

◆ setMaximumItems()

void tgui::ListBox::setMaximumItems ( std::size_t maximumItems = 0 )

Changes the maximum items that the list box can contain.

Parameters

maximumItems The maximum items inside the list box. When the maximum is set to 0 then the limit will be disabled

If no scrollbar was loaded then there is always a limitation because there will be a limited space for the items.

◆ setScrollbarValue()

void tgui::ListBox::setScrollbarValue ( unsigned int value )

Changes the thumb position of the scrollbar.

Parameters

value New value of the scrollbar

◆ setSelectedItem()

bool tgui::ListBox::setSelectedItem ( const String & itemName )

Selects an item in the list box.

Parameters

itemName The item you want to select

In case the names are not unique, the first item with that name will be selected.

Returns

true on success
false when none of the items matches the name

See also: setSelectedItemById

◆ setSelectedItemById()

bool tgui::ListBox::setSelectedItemById ( const String & id )

Selects an item in the list box.

Parameters

id	Unique id passed to addItem

In case the id would not be unique, the first item with that id will be selected.

Returns

true on success
false when none of the items has the given id

See also: setSelectedItem

◆ setSelectedItemByIndex()

bool tgui::ListBox::setSelectedItemByIndex ( std::size_t index )

Selects an item in the list box.

Parameters

index Index of the item in the list box

Returns

true on success
false when the index was too high

See also: setSelectedItem; setSelectedItemById

◆ setSize() [1/2]

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

overridevirtual

Changes the size of the list box.

Parameters

size	The new size of the list box

Reimplemented from tgui::Widget.

◆ setSize() [2/2]

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

◆ setTextAlignment()

void tgui::ListBox::setTextAlignment ( HorizontalAlignment alignment )

Changes the horizontal text alignment.

Parameters

alignment The new horizontal text alignment

By default the text is aligned to the left.

◆ updateTextSize()

void tgui::ListBox::updateTextSize ( )

overrideprotectedvirtual

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

Reimplemented from tgui::Widget.

◆ updateTime()

bool tgui::ListBox::updateTime ( Duration elapsedTime )

overrideprotectedvirtual

Reimplemented from tgui::Widget.

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

include/TGUI/Widgets/ListBox.hpp

TGUI

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addItem()

◆ addMultipleItems()

◆ canHandleKeyPress()

◆ changeItem()

◆ changeItemById()

◆ changeItemByIndex()

◆ clone()

◆ contains()

◆ containsId()

◆ copy()

◆ create()

◆ draw()

◆ getAutoScroll()

◆ getHoveredItemIndex()

◆ getIdByIndex()

◆ getIndexById()

◆ getItemById()

◆ getItemByIndex()

◆ getItemCount()

◆ getItemData()

◆ getItemHeight()

◆ getItemIds()

◆ getItems()

◆ getMaximumItems()

◆ getRenderer()

◆ getScrollbarMaxValue()

◆ getScrollbarValue()

◆ getSelectedItem()

◆ getSelectedItemId()

◆ getSelectedItemIndex()

◆ getSharedRenderer() [1/2]

◆ getSharedRenderer() [2/2]

◆ getSignal()

◆ getTextAlignment()

◆ isMouseOnWidget()

◆ keyPressed()

◆ leftMouseButtonNoLongerDown()

◆ leftMousePressed()

◆ leftMouseReleased()

◆ load()

◆ mouseMoved()

◆ mouseNoLongerOnWidget()

◆ removeItem()

◆ removeItemById()

◆ removeItemByIndex()

◆ rendererChanged()

◆ save()

◆ scrollbarValueChanged()

◆ scrolled()

◆ setAutoScroll()

◆ setItemData()

◆ setItemHeight()

◆ setMaximumItems()

◆ setScrollbarValue()

◆ setSelectedItem()

◆ setSelectedItemById()

◆ setSelectedItemByIndex()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setTextAlignment()

◆ updateTextSize()

◆ updateTime()