TGUI
1.1
|
List box widget. More...
#include <TGUI/Widgets/ListBox.hpp>
Classes | |
struct | Item |
Public Types | |
enum class | TextAlignment { Left , Center , Right } |
The horizontal text alignment. More... | |
using | Ptr = std::shared_ptr< ListBox > |
Shared widget pointer. | |
using | ConstPtr = std::shared_ptr< const ListBox > |
Shared constant widget pointer. | |
![]() | |
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) | |
TGUI_NODISCARD ListBoxRenderer * | getSharedRenderer () override |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
TGUI_NODISCARD const ListBoxRenderer * | getSharedRenderer () const override |
TGUI_NODISCARD 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. | |
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. | |
TGUI_NODISCARD String | getItemById (const String &id) const |
Returns the item name of the item with the given id. | |
TGUI_NODISCARD String | getItemByIndex (std::size_t index) const |
Returns the item name of the item at the given index. | |
TGUI_NODISCARD int | getIndexById (const String &id) const |
Returns the index of the item with the given id. | |
TGUI_NODISCARD String | getIdByIndex (std::size_t index) const |
Returns the id of the item at the given index. | |
TGUI_NODISCARD String | getSelectedItem () const |
Returns the currently selected item. | |
TGUI_NODISCARD String | getSelectedItemId () const |
Gets the id of the selected item. | |
TGUI_NODISCARD int | getSelectedItemIndex () const |
Gets the index of the selected item. | |
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. | |
TGUI_NODISCARD std::size_t | getItemCount () const |
Returns the amount of items in the list box. | |
TGUI_NODISCARD std::vector< String > | getItems () const |
Returns a copy of the items in the list box. | |
TGUI_NODISCARD 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 > | |
TGUI_NODISCARD 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. | |
TGUI_NODISCARD 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. | |
TGUI_NODISCARD 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. | |
TGUI_NODISCARD bool | getAutoScroll () const |
Returns whether the list box scrolls to the bottom when a new item is added. | |
void | setTextAlignment (TextAlignment alignment) |
Changes the horizontal text alignment. | |
TGUI_NODISCARD TextAlignment | getTextAlignment () const |
Gets the current horizontal text alignment. | |
TGUI_NODISCARD bool | contains (const String &item) const |
Returns whether the list box contains the given item. | |
TGUI_NODISCARD 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. | |
TGUI_NODISCARD unsigned int | getScrollbarValue () const |
Returns the thumb position of the scrollbar. | |
TGUI_NODISCARD bool | isMouseOnWidget (Vector2f pos) const override |
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. | |
bool | leftMousePressed (Vector2f pos) override |
Called by the parent when the left mouse button goes down on top of the widget. | |
void | leftMouseReleased (Vector2f pos) override |
void | 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. | |
virtual void | setSize (const Layout2d &size) |
Changes the size of the widget. | |
void | setSize (Layout width, Layout height) |
Changes the size of the 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 | getAbsolutePosition (Vector2f offset={}) const |
Get the absolute position of the widget instead of the relative position to its parent. | |
virtual TGUI_NODISCARD Vector2f | getWidgetOffset () const |
Returns the distance between the position where the widget is drawn and where the widget is placed. | |
void | setAutoLayout (AutoLayout layout) |
TGUI_NODISCARD AutoLayout | getAutoLayout () const |
void | setOrigin (float x, float y) |
Sets the origin point on which the position, scale and rotation is based. | |
void | setOrigin (Vector2f origin) |
Sets the origin point on which the position, scale and rotation is based. | |
TGUI_NODISCARD Vector2f | getOrigin () const |
Returns the relative origin point on which the position, scale and rotation is based. | |
void | setScale (Vector2f scaleFactors) |
Sets the scaling to be applied to the widget. | |
void | setScale (Vector2f scaleFactors, Vector2f origin) |
Sets the scaling to be applied to the widget. | |
void | setScale (float scaleFactor) |
Sets the scaling to be applied to the widget. | |
void | setScale (float scaleFactor, Vector2f origin) |
Sets the scaling to be applied to the widget. | |
TGUI_NODISCARD Vector2f | getScale () const |
Returns the scaling to be applied to the widget. | |
TGUI_NODISCARD Vector2f | getScaleOrigin () const |
Returns the origin used for scaling. | |
void | setRotation (float angle) |
Sets the rotation to be applied to the widget. | |
void | setRotation (float angle, Vector2f origin) |
Sets the rotation to be applied to the widget. | |
TGUI_NODISCARD float | getRotation () const |
Returns the rotation to be applied to the widget. | |
TGUI_NODISCARD Vector2f | getRotationOrigin () const |
Returns the origin used for rotations. | |
void | showWithEffect (ShowEffectType type, Duration duration) |
Shows the widget by introducing it with an animation. | |
void | hideWithEffect (ShowEffectType type, Duration duration) |
Hides the widget by making it leave with an animation. | |
void | moveWithAnimation (Layout2d position, Duration duration) |
Moves the widget from its current position to the given position, over a given duration. | |
void | resizeWithAnimation (Layout2d size, Duration duration) |
Resizes the widget from its current size to the given size, over a given duration. | |
virtual void | setVisible (bool visible) |
Shows or hides a widget. | |
TGUI_NODISCARD bool | isVisible () const |
Returns true when the widget is visible. | |
virtual void | setEnabled (bool enabled) |
Enables or disables the widget. | |
TGUI_NODISCARD bool | isEnabled () const |
Returns true when the widget is enabled. | |
virtual void | setFocused (bool focused) |
Focus or unfocus the widget. | |
TGUI_NODISCARD bool | isFocused () const |
Returns true when the widget is focused and false otherwise. | |
TGUI_NODISCARD const 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 | isDraggableWidget () const |
Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) | |
TGUI_NODISCARD bool | isMouseDown () const |
Returns whether the left mouse button has been pressed on top of the widget. | |
virtual void | setParent (Container *parent) |
void | setAutoLayoutUpdateEnabled (bool enabled) |
virtual void | 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 TGUI_NODISCARD Widget::Ptr | askToolTip (Vector2f mousePos) |
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 TGUI_NODISCARD ListBox::Ptr | create () |
Creates a new list box widget. | |
static TGUI_NODISCARD 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. | |
![]() | |
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 | |
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 | updateTextSize () override |
Called when the text size is changed (either by setTextSize or via the renderer) | |
TGUI_NODISCARD Vector2f | getInnerSize () const |
void | updateItemPositions () |
void | updateSelectedAndHoveringItemColorsAndStyle () |
void | updateItemColorsAndStyle () |
void | updateHoveringItem (int item) |
void | updateSelectedItem (int item) |
void | triggerOnScroll () |
bool | updateTime (Duration elapsedTime) override |
TGUI_NODISCARD Widget::Ptr | clone () const override |
Makes a copy of the widget if you don't know its exact type. | |
![]() | |
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 |
int | m_selectedItem = -1 |
int | m_hoveringItem = -1 |
unsigned int | m_itemHeight = 0 |
std::size_t | m_maxItems = 0 |
CopiedSharedPtr< ScrollbarChildWidget > | m_scroll |
unsigned int | m_lastScrollbarValue = 0 |
bool | m_possibleDoubleClick = false |
bool | m_autoScroll = true |
ListBox::TextAlignment | m_textAlignment = ListBox::TextAlignment::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 |
![]() | |
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 | |
![]() | |
using | SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > > |
using | LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > > |
List box widget.
|
strong |
Adds an item to the list.
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 |
|
overridevirtual |
Called by the parent of the widget to check if keyPressed would process the event.
event | Key event that took place |
Reimplemented from tgui::Widget.
Changes an item with name originalValue to newValue.
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.
Changes the name of an item with the given id to newValue.
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.
bool tgui::ListBox::changeItemByIndex | ( | std::size_t | index, |
const String & | newValue | ||
) |
Changes the name of an item at the given index to newValue.
index | The index of the item which you want to change |
newValue | The new name for that item |
|
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.
Implements tgui::Widget.
TGUI_NODISCARD bool tgui::ListBox::contains | ( | const String & | item | ) | const |
Returns whether the list box contains the given item.
item | The item to search for |
TGUI_NODISCARD bool tgui::ListBox::containsId | ( | const String & | id | ) | const |
Returns whether the list box contains an item with the given id.
id | The id of the item to search for |
|
static |
Makes a copy of another list box.
listBox | The other list box |
|
static |
Creates a new list box widget.
|
overridevirtual |
Draw the widget to a render target.
target | Render target to draw to |
states | Current render states |
Implements tgui::Widget.
TGUI_NODISCARD bool tgui::ListBox::getAutoScroll | ( | ) | const |
Returns whether the list box scrolls to the bottom when a new item is added.
TGUI_NODISCARD String tgui::ListBox::getIdByIndex | ( | std::size_t | index | ) | const |
Returns the id of the item at the given index.
index | The index of the item to find |
Returns the index of the item with the given id.
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 item name of the item with the given id.
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.
TGUI_NODISCARD String tgui::ListBox::getItemByIndex | ( | std::size_t | index | ) | const |
Returns the item name of the item at the given index.
index | The index of the item to return |
TGUI_NODISCARD std::size_t tgui::ListBox::getItemCount | ( | ) | const |
Returns the amount of items in the list box.
|
inline |
Returns user data stored in the item.
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). |
TGUI_NODISCARD unsigned int tgui::ListBox::getItemHeight | ( | ) | const |
Returns the height of the items in the list box.
TGUI_NODISCARD std::vector< String > tgui::ListBox::getItemIds | ( | ) | const |
Returns a copy of the item ids in the list box.
Items that were not given an id simply have an empty string as id.
TGUI_NODISCARD std::vector< String > tgui::ListBox::getItems | ( | ) | const |
Returns a copy of the items in the list box.
TGUI_NODISCARD std::size_t tgui::ListBox::getMaximumItems | ( | ) | const |
Returns the maximum items that the list box can contain.
|
overridevirtual |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Reimplemented from tgui::Widget.
TGUI_NODISCARD unsigned int tgui::ListBox::getScrollbarValue | ( | ) | const |
Returns the thumb position of the scrollbar.
TGUI_NODISCARD String tgui::ListBox::getSelectedItem | ( | ) | const |
Returns the currently selected item.
TGUI_NODISCARD String tgui::ListBox::getSelectedItemId | ( | ) | const |
Gets the id of the selected item.
TGUI_NODISCARD int tgui::ListBox::getSelectedItemIndex | ( | ) | const |
Gets the index of the selected item.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Reimplemented from tgui::Widget.
Retrieves a signal based on its name.
signalName | Name of the signal |
Exception | when the name does not match any signal |
Reimplemented from tgui::Widget.
TGUI_NODISCARD TextAlignment tgui::ListBox::getTextAlignment | ( | ) | const |
Gets the current horizontal text alignment.
|
overridevirtual |
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
Implements tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Called by the parent when the left mouse button goes down on top of the widget.
pos | Mouse position in view coordinates relative to the parent widget |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Loads the widget from a tree of nodes.
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
bool tgui::ListBox::removeItem | ( | const String & | itemName | ) |
Removes the item from the list with the given name.
itemName | The item to remove |
In case the names are not unique, only the first item with that name will be removed.
bool tgui::ListBox::removeItemById | ( | const String & | id | ) |
Removes the item that were added with the given id.
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.
bool tgui::ListBox::removeItemByIndex | ( | std::size_t | index | ) |
Removes the item from the list box.
index | Index of the item in the list box |
|
overrideprotectedvirtual |
Function called when one of the properties of the renderer is changed.
property | Name of the property that was changed |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Saves the widget as a tree node in order to save it to a file.
Reimplemented from tgui::Widget.
|
overridevirtual |
Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)
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? |
Reimplemented from tgui::Widget.
void tgui::ListBox::setAutoScroll | ( | bool | autoScroll | ) |
Changes whether the list box scrolls to the bottom when a new item is added.
autoScroll | Should list box scroll to the bottom when new items are added? |
Auto scrolling is enabled by default.
void tgui::ListBox::setItemData | ( | std::size_t | index, |
Any | data | ||
) |
Store some user data with the item.
index | Index of the item |
data | User data to store |
Examples:
void tgui::ListBox::setItemHeight | ( | unsigned int | itemHeight | ) |
Changes the height of the items in the list box.
itemHeight | The size of a single item in the list |
void tgui::ListBox::setMaximumItems | ( | std::size_t | maximumItems = 0 | ) |
Changes the maximum items that the list box can contain.
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.
void tgui::ListBox::setScrollbarValue | ( | unsigned int | value | ) |
Changes the thumb position of the scrollbar.
value | New value of the scrollbar |
bool tgui::ListBox::setSelectedItem | ( | const String & | itemName | ) |
Selects an item in the list box.
itemName | The item you want to select |
In case the names are not unique, the first item with that name will be selected.
bool tgui::ListBox::setSelectedItemById | ( | const String & | id | ) |
Selects an item in the list box.
id | Unique id passed to addItem |
In case the id would not be unique, the first item with that id will be selected.
bool tgui::ListBox::setSelectedItemByIndex | ( | std::size_t | index | ) |
Selects an item in the list box.
index | Index of the item in the list box |
|
virtual |
Changes the size of the widget.
size | Size of the widget |
Usage examples:
Reimplemented from tgui::Widget.
|
overridevirtual |
Changes the size of the list box.
size | The new size of the list box |
Reimplemented from tgui::Widget.
Changes the size of the widget.
width | Width of the widget |
height | Height of the widget |
void tgui::ListBox::setTextAlignment | ( | TextAlignment | alignment | ) |
Changes the horizontal text alignment.
alignment | The new horizontal text alignment |
By default the text is aligned to the left.
|
overrideprotectedvirtual |
Called when the text size is changed (either by setTextSize or via the renderer)
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Reimplemented from tgui::Widget.