List of panels, which can be flexible changed. More...

#include <TGUI/Widgets/PanelListBox.hpp>

Inheritance diagram for tgui::PanelListBox:

Classes
struct	Item

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

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

Public Types inherited from tgui::ScrollablePanel
using	Ptr = std::shared_ptr<ScrollablePanel>
	Shared widget pointer.

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

Public Types inherited from tgui::Panel
using	Ptr = std::shared_ptr<Panel>
	Shared widget pointer.

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

Public Types inherited from tgui::Group
using	Ptr = std::shared_ptr<Group>
	Shared widget pointer.

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

Public Types inherited from tgui::Container
using	Ptr = std::shared_ptr<Container>
	Shared widget pointer.

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

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

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

TGUI_NODISCARD const PanelListBoxRenderer *	getSharedRenderer () const override

TGUI_NODISCARD PanelListBoxRenderer *	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 panel list box.

Panel::Ptr	addItem (const String &id={}, int index=-1)
	Adds an item to the list.

TGUI_NODISCARD Panel::Ptr	getPanelTemplate ()
	Get panel template from which new elements are created.

TGUI_NODISCARD Layout	getItemsWidth () const
	Returns the width of the items in the list box.

void	setItemsHeight (const Layout &height)
	Changes the height of the items in the list box.

TGUI_NODISCARD Layout	getItemsHeight () const
	Returns the height of the items in the list box.

bool	setSelectedItem (const Panel::Ptr &panelPtr)
	Selects an item in the panel list box.

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

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

void	deselectItem ()
	Deselects the selected item.

bool	removeItem (const Panel::Ptr &panelPtr)
	Removes the item from the panel list with the given pointer.

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 panel list box.

void	removeAllItems ()
	Removes all items from the list.

TGUI_NODISCARD Panel::Ptr	getItemById (const String &id) const
	Returns the item name of the item with the given id.

TGUI_NODISCARD Panel::Ptr	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.

int	getIndexByItem (const Panel::Ptr &panelPtr) const
	Returns the index of the given item.

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

Panel::Ptr	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.

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

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

TGUI_NODISCARD std::vector< String >	getItemIds () const
	Returns a vector of stored items ids.

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

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

bool	contains (const Panel::Ptr &panelPtr) const
	Returns whether the panel list box contains the given item.

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

void	mouseMoved (Vector2f pos) override

void	mouseNoLongerOnWidget () override

bool	leftMousePressed (Vector2f pos) override
	Called by the parent when the left mouse button goes down on top of the widget.

void	setSize (const Layout2d &size) override
	Changes the size of the panel.

Public Member Functions inherited from tgui::ScrollablePanel
	ScrollablePanel (const char *typeName=StaticWidgetType, bool initRenderer=true)

	ScrollablePanel (const ScrollablePanel &other)
	Copy constructor.

	ScrollablePanel (ScrollablePanel &&other) noexcept
	Move constructor.

ScrollablePanel &	operator= (const ScrollablePanel &other)
	Overload of assignment operator.

ScrollablePanel &	operator= (ScrollablePanel &&other) noexcept
	Overload of move assignment operator.

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

TGUI_NODISCARD const ScrollablePanelRenderer *	getSharedRenderer () const override

TGUI_NODISCARD ScrollablePanelRenderer *	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 panel.

TGUI_NODISCARD Vector2f	getInnerSize () const override
	Returns the space available for widgets inside the container.

TGUI_NODISCARD Vector2f	getAbsolutePosition (Vector2f offset) const override

void	add (const Widget::Ptr &widget, const String &widgetName="") override
	Adds a widget at the end of the layout.

bool	remove (const Widget::Ptr &widget) override
	Removes a single widget that was added to the container.

void	removeAllWidgets () override
	Removes all widgets that were added to the container.

void	setContentSize (Vector2f size)
	Channges the size available for child widgets.

TGUI_NODISCARD Vector2f	getContentSize () const
	Returns the size available for child widgets.

TGUI_NODISCARD Vector2f	getContentOffset () const
	Returns the amount of pixels the child widgets have been shifted to be displayed by the scrollable panel.

TGUI_NODISCARD float	getScrollbarWidth () const
	Returns the width of the scrollbars.

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	setVerticalScrollAmount (unsigned int scrollAmount)
	Changes how much the value changes when scrolling or pressing one of the arrows of the vertical scrollbar.

TGUI_NODISCARD unsigned int	getVerticalScrollAmount () const
	Returns how much the value changes when scrolling or pressing one of the arrows of the vertical scrollbar.

void	setHorizontalScrollAmount (unsigned int scrollAmount)
	Changes how much the value changes when scrolling or pressing one of the arrows of the horizontal scrollbar.

TGUI_NODISCARD unsigned int	getHorizontalScrollAmount () const
	Returns how much the value changes when scrolling or pressing one of the arrows of the horizontal scrollbar.

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.

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 bool	isVerticalScrollbarShown () const
	Returns whether the vertical scrollbar is currently visible.

TGUI_NODISCARD bool	isHorizontalScrollbarShown () const
	Returns whether the horizontal scrollbar is currently visible.

TGUI_NODISCARD Widget::Ptr	getWidgetAtPos (Vector2f pos, bool recursive) const override
	Returns the widget that is located at the given position.

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

TGUI_NODISCARD Widget::Ptr	askToolTip (Vector2f mousePos) override

void	draw (BackendRenderTarget &target, RenderStates states) const override
	Draw the widget to a render target.

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

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

Public Member Functions inherited from tgui::Panel
	Panel (const char *typeName=StaticWidgetType, bool initRenderer=true)

TGUI_NODISCARD Vector2f	getChildWidgetsOffset () const override
	Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0)

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.

void	rightMousePressed (Vector2f pos) override

void	rightMouseReleased (Vector2f pos) override

void	rightMouseButtonNoLongerDown () override

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

Public Member Functions inherited from tgui::Group
	Group (const char *typeName=StaticWidgetType, bool initRenderer=true)

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

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

	Container (const Container &copy)
	Copy constructor.

	Container (Container &&copy) noexcept
	Move constructor.

	~Container () override
	Destructor.

Container &	operator= (const Container &right)
	Overload of copy assignment operator.

Container &	operator= (Container &&right) noexcept
	Overload of move assignment operator.

TGUI_NODISCARD const std::vector< Widget::Ptr > &	getWidgets () const
	Returns a list of all the widgets in this container.

template<typename Function >
void	sortWidgets (Function &&function)
	Sorts a list of all the widgets in this container.

TGUI_NODISCARD Widget::Ptr	get (const String &widgetName) const
	Returns a pointer to a widget that was added earlier.

template<class WidgetType >
TGUI_NODISCARD WidgetType::Ptr	get (const String &widgetName) const
	Returns a pointer to a widget that was added earlier.

void	loadWidgetsFromFile (const String &filename, bool replaceExisting=true)
	Loads the child widgets from a text file.

void	saveWidgetsToFile (const String &filename)
	Saves the child widgets to a text file.

void	loadWidgetsFromStream (std::stringstream &stream, bool replaceExisting=true)
	Loads the child widgets from a string stream.

void	loadWidgetsFromStream (std::stringstream &&stream, bool replaceExisting=true)
	Loads the child widgets from a string stream.

void	saveWidgetsToStream (std::stringstream &stream, const String &rootDirectory="") const
	Saves the child widgets to a text file.

void	loadWidgetsFromNodeTree (const std::unique_ptr< DataIO::Node > &rootNode, bool replaceExisting=true)
	Loads the child widgets from a tree of nodes that contain all information about the widgets.

TGUI_NODISCARD std::unique_ptr< DataIO::Node >	saveWidgetsToNodeTree (const String &rootDirectory="") const
	Saves the child widgets to a tree of nodes that contain all information about the widgets.

void	moveWidgetToFront (const Widget::Ptr &widget)
	Places a widget before all other widgets, to the front of the z-order.

void	moveWidgetToBack (const Widget::Ptr &widget)
	Places a widget behind all other widgets, to the back of the z-order.

std::size_t	moveWidgetForward (const Widget::Ptr &widget)
	Places a widget one step forward in the z-order.

std::size_t	moveWidgetBackward (const Widget::Ptr &widget)
	Places a widget one step backward in the z-order.

virtual bool	setWidgetIndex (const Widget::Ptr &widget, std::size_t index)
	Changes the index of a widget in this container.

TGUI_NODISCARD int	getWidgetIndex (const Widget::Ptr &widget) const
	Returns the current index of a widget in this container.

TGUI_NODISCARD Widget::Ptr	getFocusedChild () const
	Returns the child widget that is focused inside this container.

TGUI_NODISCARD Widget::Ptr	getFocusedLeaf () const
	Returns the leaf child widget that is focused inside this container.

virtual TGUI_NODISCARD Widget::Ptr	getWidgetAtPosition (Vector2f pos) const
	Returns the leaf child widget that is located at the given position.

bool	focusNextWidget (bool recursive=true)
	Focuses the next widget in this container.

bool	focusPreviousWidget (bool recursive=true)
	Focuses the previous widget in this container.

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

bool	processMouseMoveEvent (Vector2f pos)
	Inform the container about a mouse move event.

bool	processMousePressEvent (Event::MouseButton button, Vector2f pos)
	Inform the container about a mouse press event.

bool	processMouseReleaseEvent (Event::MouseButton button, Vector2f pos)
	Inform the container about a mouse release event.

bool	processScrollEvent (float delta, Vector2f pos, bool touch)
	Inform the container about a scroll event (either mouse wheel or two finger scrolling on touchscreen)

bool	processKeyPressEvent (Event::KeyEvent event)
	Inform the container about a key press event.

bool	processTextEnteredEvent (char32_t key)
	Inform the container about a key press event.

void	childWidgetFocused (const Widget::Ptr &child)

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	textEntered (char32_t key) override

void	setParent (Container *parent) override

void	setParentGui (BackendGui *gui)

void	updateChildrenWithAutoLayout ()

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.

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

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

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

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

TGUI_NODISCARD BackendGui *	getParentGui () 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 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.

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

void	setAutoLayoutUpdateEnabled (bool enabled)

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

TGUI_NODISCARD const Layout2d &	getPositionLayout () const

TGUI_NODISCARD const Layout2d &	getSizeLayout () 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 Ptr	create ()
	Creates a new panel list box widget.

static Ptr	copy (const ConstPtr &panelListBox)
	Makes a copy of another panel list box.

Static Public Member Functions inherited from tgui::ScrollablePanel
static TGUI_NODISCARD ScrollablePanel::Ptr	create (const Layout2d &size={"100%", "100%"}, Vector2f contentSize={0, 0})
	Creates a new scrollable panel widget.

static TGUI_NODISCARD ScrollablePanel::Ptr	copy (const ScrollablePanel::ConstPtr &panel)
	Makes a copy of another scrollbable panel.

Static Public Member Functions inherited from tgui::Panel
static TGUI_NODISCARD Panel::Ptr	create (const Layout2d &size={"100%", "100%"})
	Creates a new panel widget.

static TGUI_NODISCARD Panel::Ptr	copy (const Panel::ConstPtr &panel)
	Makes a copy of another panel.

static void	setEventBubbling (bool useEventBubbling)
	Changes whether event bubbling is used for the mouse events.

static bool	getEventBubbling ()
	Returns whether event bubbling is used for the mouse events.

Static Public Member Functions inherited from tgui::Group
static TGUI_NODISCARD Group::Ptr	create (const Layout2d &size={"100%", "100%"})
	Creates a new group.

static TGUI_NODISCARD Group::Ptr	copy (const Group::ConstPtr &group)
	Makes a copy of another group.

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

Public Attributes inherited from tgui::Panel
SignalVector2f	onMousePress = {"MousePressed"}
	The mouse went down on the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onMouseRelease = {"MouseReleased"}
	The mouse was released on top of the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onClick = {"Clicked"}
	The panel was clicked. Optional parameter: mouse position relative to panel.

SignalVector2f	onDoubleClick = {"DoubleClicked"}
	The panel was double clicked. Optional parameter: mouse position relative to panel.

SignalVector2f	onRightMousePress = {"RightMousePressed"}
	The right mouse button went down on the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onRightMouseRelease = {"RightMouseReleased"}
	The right mouse button was released on top of the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onRightClick = {"RightClicked"}
	The panel was right clicked. Optional parameter: mouse position relative to panel.

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

Static Public Attributes inherited from tgui::ScrollablePanel
static constexpr const char	StaticWidgetType [] = "ScrollablePanel"
	Type name of the widget.

Static Public Attributes inherited from tgui::Panel
static constexpr const char	StaticWidgetType [] = "Panel"
	Type name of the widget.

Static Public Attributes inherited from tgui::Group
static constexpr const char	StaticWidgetType [] = "Group"
	Type name of the widget.

Protected Member Functions
TGUI_NODISCARD 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.

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

void	updateItemsSize () const

TGUI_NODISCARD float	getAllItemsHeight () const

TGUI_NODISCARD float	getItemsHeightUpToIndex (std::size_t index) const

void	updateSelectedItem (int item)

void	updateHoveringItem (int item)

void	updateSelectedAndHoveringItemColorsAndStyle () const

void	clearItemStyle (int item) const

void	clearAllItemsStyle () const

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

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::Panel
bool	updateTime (Duration elapsedTime) override

Protected Member Functions inherited from tgui::Container
void	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer)

TGUI_NODISCARD Widget::Ptr	getWidgetBelowMouse (Vector2f mousePos) const

Widget::Ptr	updateWidgetBelowMouse (Vector2f mousePos)

TGUI_NODISCARD std::size_t	getFocusedWidgetIndex () const

bool	tryFocusWidget (const Widget::Ptr &widget, bool reverseWidgetOrder, bool recursive)

TGUI_NODISCARD Vector2f	transformMousePos (const Widget::Ptr &widget, Vector2f mousePos) const

void	widgetAdded (const Widget::Ptr &widgetPtr)

void	injectFormFilePath (const std::unique_ptr< DataIO::Node > &node, const String &path, std::map< String, bool > &checkedFilenames) const

void	loadWidgetsImpl (const std::unique_ptr< DataIO::Node > &rootNode, bool replaceExisting)

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 Attributes
std::vector< Item >	m_items

std::size_t	m_maxItems

Panel::Ptr	m_panelTemplate

int	m_selectedItem

int	m_hoveringItem

Color	m_itemsBackgroundColorCached

Color	m_itemsBackgroundColorHoverCached

Color	m_selectedItemsBackgroundColorCached

Color	m_selectedItemsBackgroundColorHoverCached

Protected Attributes inherited from tgui::ScrollablePanel
Vector2f	m_contentSize

Vector2f	m_mostBottomRightPosition

CopiedSharedPtr< ScrollbarChildWidget >	m_verticalScrollbar

CopiedSharedPtr< ScrollbarChildWidget >	m_horizontalScrollbar

Scrollbar::Policy	m_verticalScrollbarPolicy = Scrollbar::Policy::Automatic

Scrollbar::Policy	m_horizontalScrollbarPolicy = Scrollbar::Policy::Automatic

std::chrono::steady_clock::time_point	m_lastSuccessfulScrollTime

Vector2f	m_lastSuccessfulScrollPos

unsigned int	m_verticalScrollAmount = 0

unsigned int	m_horizontalScrollAmount = 0

std::unordered_map< Widget::Ptr, unsigned int >	m_connectedPositionCallbacks

std::unordered_map< Widget::Ptr, unsigned int >	m_connectedSizeCallbacks

Protected Attributes inherited from tgui::Panel
Borders	m_bordersCached

Color	m_borderColorCached

Color	m_backgroundColorCached

Sprite	m_spriteBackground

float	m_roundedBorderRadius = 0

bool	m_rightMouseDown = false

bool	m_possibleDoubleClick = false

Protected Attributes inherited from tgui::Group
Padding	m_paddingCached

Protected Attributes inherited from tgui::Container
std::vector< Widget::Ptr >	m_widgets

Widget::Ptr	m_widgetBelowMouse

Widget::Ptr	m_widgetWithLeftMouseDown

Widget::Ptr	m_widgetWithRightMouseDown

Widget::Ptr	m_focusedWidget

bool	m_draggingWidget = false

Vector2f	m_prevInnerSize

bool	m_isolatedFocus = false

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

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

Static Protected Attributes inherited from tgui::Panel
static bool	m_eventBubbling

Detailed Description

List of panels, which can be flexible changed.

Member Function Documentation

◆ addItem()

Panel::Ptr tgui::PanelListBox::addItem	(	const String &	id = {},
		int	index = -1 )

Adds an item to the list.

Parameters

id	Optional unique id given to this item for the purpose to later identifying this item
index	Optional index at which new item will be added. If not provided, item will be added at last position

Returns: Pointer to newly created panel

◆ clearItemStyle()

void tgui::PanelListBox::clearItemStyle ( int item ) const

protected

Parameters

item	Index of item of which style should be cleared

◆ clone()

TGUI_NODISCARD Widget::Ptr tgui::PanelListBox::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

Reimplemented from tgui::Panel.

◆ contains()

bool tgui::PanelListBox::contains ( const Panel::Ptr & panelPtr ) const

Returns whether the panel list box contains the given item.

Parameters

panelPtr The item to search for

Returns: Does the list box contain the item?

◆ containsId()

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

Returns whether the panel 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 Ptr tgui::PanelListBox::copy ( const ConstPtr & panelListBox )

static

Makes a copy of another panel list box.

Parameters

panelListBox The other list box

Returns: The new list box

◆ create()

static Ptr tgui::PanelListBox::create ( )

static

Creates a new panel list box widget.

Returns: The new panel list box

◆ getIdByIndex()

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

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::PanelListBox::getIndexById ( const String & id ) const

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

◆ getIndexByItem()

int tgui::PanelListBox::getIndexByItem ( const Panel::Ptr & panelPtr ) const

Returns the index of the given item.

Parameters

panelPtr Pointer to the item to find

Returns: The id of the requested item, or an empty string when the corresponding item was not found

◆ getItemById()

TGUI_NODISCARD Panel::Ptr tgui::PanelListBox::getItemById ( const String & id ) const

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

TGUI_NODISCARD Panel::Ptr tgui::PanelListBox::getItemByIndex ( std::size_t index ) const

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

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

Returns the amount of items in the panel list box.

Returns: Number of items inside the list box

◆ getItemIds()

TGUI_NODISCARD std::vector< String > tgui::PanelListBox::getItemIds ( ) const

Returns a vector of stored items ids.

Returns: items ids

◆ getItems()

TGUI_NODISCARD std::vector< Panel::Ptr > tgui::PanelListBox::getItems ( ) const

Returns a copy of the items in the list box.

Returns: items

◆ getItemsHeight()

TGUI_NODISCARD Layout tgui::PanelListBox::getItemsHeight ( ) const

Returns the height of the items in the list box.

Returns: The item height

◆ getItemsHeightUpToIndex()

TGUI_NODISCARD float tgui::PanelListBox::getItemsHeightUpToIndex ( std::size_t index ) const

protected

Parameters

index Index of item up to which height should be calculated

◆ getItemsWidth()

TGUI_NODISCARD Layout tgui::PanelListBox::getItemsWidth ( ) const

Returns the width of the items in the list box.

Returns: The item width

◆ getMaximumItems()

TGUI_NODISCARD std::size_t tgui::PanelListBox::getMaximumItems ( ) const

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

◆ getPanelTemplate()

TGUI_NODISCARD Panel::Ptr tgui::PanelListBox::getPanelTemplate ( )

Get panel template from which new elements are created.

Returns: Pointer to panel template

◆ getRenderer()

TGUI_NODISCARD PanelListBoxRenderer * tgui::PanelListBox::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::Panel.

◆ getSelectedItem()

Panel::Ptr tgui::PanelListBox::getSelectedItem ( ) const

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::PanelListBox::getSelectedItemId ( ) const

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::PanelListBox::getSelectedItemIndex ( ) const

Gets the index of the selected item.

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

◆ getSharedRenderer() [1/2]

TGUI_NODISCARD const PanelListBoxRenderer * tgui::PanelListBox::getSharedRenderer ( ) const

overridevirtual

Reimplemented from tgui::Panel.

◆ getSharedRenderer() [2/2]

TGUI_NODISCARD PanelListBoxRenderer * tgui::PanelListBox::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::Panel.

◆ getSignal()

TGUI_NODISCARD Signal & tgui::PanelListBox::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::Panel.

◆ leftMousePressed()

bool tgui::PanelListBox::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::Panel.

◆ load()

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

overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Container.

◆ mouseMoved()

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

overridevirtual

Reimplemented from tgui::Container.

◆ mouseNoLongerOnWidget()

void tgui::PanelListBox::mouseNoLongerOnWidget ( )

overridevirtual

Reimplemented from tgui::Container.

◆ removeItem()

bool tgui::PanelListBox::removeItem ( const Panel::Ptr & panelPtr )

Removes the item from the panel list with the given pointer.

Parameters

panelPtr The item to remove

In case of nullptr, nothing will be removed.

Returns

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

◆ removeItemById()

bool tgui::PanelListBox::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::PanelListBox::removeItemByIndex ( std::size_t index )

Removes the item from the panel list box.

Parameters

index Index of the item in the panel list box

Returns

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

See also: removeItem; removeItemById

◆ rendererChanged()

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

◆ save()

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

overrideprotectedvirtual

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

Reimplemented from tgui::Container.

◆ setItemsHeight()

void tgui::PanelListBox::setItemsHeight ( const Layout & height )

Changes the height of the items in the list box.

Parameters

height The height of a single item in the list

◆ setMaximumItems()

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

◆ setSelectedItem()

bool tgui::PanelListBox::setSelectedItem ( const Panel::Ptr & panelPtr )

Selects an item in the panel list box.

Parameters

panelPtr Pointer to the item you want select

In case of nullptr, nothing will be selected.

Returns

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

See also: setSelectedItemById

◆ setSelectedItemById()

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

Selects an item in the panel 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::PanelListBox::setSelectedItemByIndex ( std::size_t index )

Selects an item in the panel 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::PanelListBox::setSize ( const Layout2d & size )

overridevirtual

Changes the size of the panel list box.

Parameters

size	The new size of the list box

Reimplemented from tgui::Panel.

◆ setSize() [2/2]

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

overridevirtual

Changes the size of the panel.

Parameters

size	The new size of the panel

Reimplemented from tgui::Panel.

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

include/TGUI/Widgets/PanelListBox.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()

◆ clearItemStyle()

◆ clone()

◆ contains()

◆ containsId()

◆ copy()

◆ create()

◆ getIdByIndex()

◆ getIndexById()

◆ getIndexByItem()

◆ getItemById()

◆ getItemByIndex()

◆ getItemCount()

◆ getItemIds()

◆ getItems()

◆ getItemsHeight()

◆ getItemsHeightUpToIndex()

◆ getItemsWidth()

◆ getMaximumItems()

◆ getPanelTemplate()

◆ getRenderer()

◆ getSelectedItem()

◆ getSelectedItemId()

◆ getSelectedItemIndex()

◆ getSharedRenderer() [1/2]

◆ getSharedRenderer() [2/2]

◆ getSignal()

◆ leftMousePressed()

◆ load()

◆ mouseMoved()

◆ mouseNoLongerOnWidget()

◆ removeItem()

◆ removeItemById()

◆ removeItemByIndex()

◆ rendererChanged()

◆ save()

◆ setItemsHeight()

◆ setMaximumItems()

◆ setSelectedItem()

◆ setSelectedItemById()

◆ setSelectedItemByIndex()

◆ setSize() [1/2]

◆ setSize() [2/2]