TGUI  0.8.1

List box widget. More...

#include <TGUI/Widgets/ListBox.hpp>

Inheritance diagram for tgui::ListBox:
tgui::Widget tgui::SignalWidgetBase

Public Types

typedef std::shared_ptr< ListBoxPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ListBoxConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

ListBoxRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
ListBoxRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setPosition (const Layout2d &position) override
 Sets the position of the widget. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the list box. More...
 
bool addItem (const sf::String &itemName, const sf::String &id="")
 Adds an item to the list. More...
 
bool setSelectedItem (const sf::String &itemName)
 Selects an item in the list box. More...
 
bool setSelectedItemById (const sf::String &id)
 Selects an item in the list box. More...
 
bool setSelectedItemByIndex (std::size_t index)
 Selects an item in the list box. More...
 
void deselectItem ()
 Deselects the selected item.
 
bool removeItem (const sf::String &itemName)
 Removes the item from the list with the given name. More...
 
bool removeItemById (const sf::String &id)
 Removes the item that were added with the given id. More...
 
bool removeItemByIndex (std::size_t index)
 Removes the item from the list box. More...
 
void removeAllItems ()
 Removes all items from the list.
 
sf::String getItemById (const sf::String &id) const
 Returns the item name of the item with the given id. More...
 
sf::String getSelectedItem () const
 Returns the currently selected item. More...
 
sf::String getSelectedItemId () const
 Gets the id of the selected item. More...
 
int getSelectedItemIndex () const
 Gets the index of the selected item. More...
 
bool changeItem (const sf::String &originalValue, const sf::String &newValue)
 Changes an item with name originalValue to newValue. More...
 
bool changeItemById (const sf::String &id, const sf::String &newValue)
 Changes the name of an item with the given id to newValue. More...
 
bool changeItemByIndex (std::size_t index, const sf::String &newValue)
 Changes the name of an item at the given index to newValue. More...
 
std::size_t getItemCount () const
 Returns the amount of items in the list box. More...
 
std::vector< sf::String > getItems () const
 Returns a copy of the items in the list box. More...
 
const std::vector< sf::String > & getItemIds () const
 Returns a copy of the item ids in the list box. More...
 
void setItemHeight (unsigned int itemHeight)
 Changes the height of the items in the list box. More...
 
unsigned int getItemHeight () const
 Returns the height of the items in the list box. More...
 
void setTextSize (unsigned int textSize)
 Changes the text size of the items. More...
 
unsigned int getTextSize () const
 Returns the text size of the items. More...
 
void setMaximumItems (std::size_t maximumItems=0)
 Changes the maximum items that the list box can contain. More...
 
std::size_t getMaximumItems () const
 Returns the maximum items that the list box can contain. More...
 
void setAutoScroll (bool autoScroll)
 Changes whether the list box scrolls to the bottom when a new item is added. More...
 
bool getAutoScroll () const
 Returns the maximum items that the list box can contain. More...
 
bool contains (const sf::String &item) const
 Returns whether the list box contains the given item. More...
 
bool containsId (const sf::String &id) const
 Returns whether the list box contains an item with the given id. More...
 
bool mouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const std::string & getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets. More...
 
virtual void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (tgui::Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
virtual bool canGainFocus () const
 Returns whether the widget can gain focus. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
- Public Member Functions inherited from tgui::SignalWidgetBase
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(const Args &...)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, const Args &... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if< std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)>>::value &&!std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs>
unsigned int connect (std::initializer_list< std::string > signalNames, Func &&handler, BoundArgs &&... args)
 Connect a signal handler to multiple signals. More...
 
bool disconnect (unsigned int id)
 Disconnects a signal handler. More...
 
void disconnectAll (std::string signalName)
 Disconnects all signal handler from a certain signal. More...
 
void disconnectAll ()
 Disconnects all signal handlers from signals.
 

Static Public Member Functions

static ListBox::Ptr create ()
 Creates a new list box widget. More...
 
static ListBox::Ptr copy (ListBox::ConstPtr listBox)
 Makes a copy of another list box. More...
 

Public Attributes

SignalItem onItemSelect = {"ItemSelected"}
 An item was selected in the list box. Optional parameter: selected item.
 
SignalItem onMousePress = {"MousePressed"}
 The mouse went down on an item. Optional parameter: selected item.
 
SignalItem onMouseRelease = {"MouseReleased"}
 The mouse was released on one of the items. Optional parameter: selected item.
 
SignalItem onDoubleClick = {"DoubleClicked"}
 An item was double clicked. Optional parameter: selected item.
 
- 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.
 
SignalAnimation onAnimationFinished = {"AnimationFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

Protected Member Functions

SignalgetSignal (std::string signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. More...
 
std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const override
 Saves the widget as a tree node in order to save it to a file.
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes.
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- Protected Member Functions inherited from tgui::Widget
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget.
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget.
 

Detailed Description

List box widget.

Member Function Documentation

◆ addItem()

bool tgui::ListBox::addItem ( const sf::String &  itemName,
const sf::String &  id = "" 
)

Adds an item to the list.

Parameters
itemNameThe name of the item you want to add (this is the text that will be displayed inside the list box)
idOptional unique id given to this item for the purpose to later identifying this item
Returns
  • true when the item was successfully added
  • false when the list box is full (you have set a maximum item limit and you are trying to add more items)
  • false when there is no scrollbar and you try to have more items than fit inside the list box
See also
setMaximumItems

◆ changeItem()

bool tgui::ListBox::changeItem ( const sf::String &  originalValue,
const sf::String &  newValue 
)

Changes an item with name originalValue to newValue.

Parameters
originalValueThe name of the item which you want to change
newValueThe 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 sf::String &  id,
const sf::String &  newValue 
)

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

Parameters
idThe unique id of the item which you want to change
newValueThe 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 sf::String &  newValue 
)

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

Parameters
indexThe index of the item which you want to change
newValueThe 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
inlineoverrideprotectedvirtual

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 sf::String &  item) const

Returns whether the list box contains the given item.

Returns
Does the list box contain the item?

◆ containsId()

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

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

Returns
Does the list box contain the id?

◆ copy()

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

Makes a copy of another list box.

Parameters
listBoxThe other list box
Returns
The new list box

◆ create()

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

Creates a new list box widget.

Returns
The new list box

◆ draw()

void tgui::ListBox::draw ( sf::RenderTarget &  target,
sf::RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ getAutoScroll()

bool tgui::ListBox::getAutoScroll ( ) 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.

◆ getItemById()

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

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

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

◆ getItemCount()

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

Returns the amount of items in the list box.

Returns
Number of items inside the list box

◆ getItemHeight()

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

Returns the height of the items in the list box.

Returns
The item height

◆ getItemIds()

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

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<sf::String> tgui::ListBox::getItems ( ) const

Returns a copy of the items in the list box.

Returns
items

◆ getMaximumItems()

std::size_t tgui::ListBox::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

◆ getRenderer()

ListBoxRenderer* tgui::ListBox::getRenderer ( )

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

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

◆ getSelectedItem()

sf::String tgui::ListBox::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()

sf::String tgui::ListBox::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::ListBox::getSelectedItemIndex ( ) const

Gets the index of the selected item.

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

◆ getSharedRenderer()

ListBoxRenderer* tgui::ListBox::getSharedRenderer ( )

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

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

◆ getSignal()

Signal& tgui::ListBox::getSignal ( std::string  signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

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

Reimplemented from tgui::Widget.

◆ getTextSize()

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

Returns the text size of the items.

Returns
The text size

◆ mouseOnWidget()

bool tgui::ListBox::mouseOnWidget ( Vector2f  pos) const
overridevirtual

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

Returns
Is the mouse on top of the widget?

Implements tgui::Widget.

◆ removeItem()

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

Removes the item from the list with the given name.

Parameters
itemNameThe 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 sf::String &  id)

Removes the item that were added with the given id.

Parameters
idId 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
indexIndex 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 std::string &  property)
overrideprotectedvirtual

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

Parameters
propertyLowercase name of the property that was changed

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
autoScrollShould list box scroll to the bottom when new items are added?

Auto scrolling is enabled by default.

◆ setItemHeight()

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

Changes the height of the items in the list box.

Parameters
itemHeightThe 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
maximumItemsThe 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.

◆ setPosition() [1/3]

void tgui::ListBox::setPosition ( const Layout2d position)
overridevirtual

Sets the position of the widget.

Parameters
positionNew position

Reimplemented from tgui::Widget.

◆ setPosition() [2/3]

virtual void tgui::Widget::setPosition

sets the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters
positionNew position
See also
move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition({40, 30});
// Place the widget relative to the size of its parent
widget->setPosition({"5%", "10%"});
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition({tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50});

◆ setPosition() [3/3]

void tgui::Widget::setPosition
inline

Sets the position of the widget.

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters
xNew x coordinate
yNew y coordinate
Warning
This setPosition overload must never be used from internal TGUI code or by custom widget implementations

◆ setSelectedItem()

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

Selects an item in the list box.

Parameters
itemNameThe 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 sf::String &  id)

Selects an item in the list box.

Parameters
idUnique 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
indexIndex of the item in the list box
Returns
  • true on success
  • false when the index was too high
See also
setSelectedItem
setSelectedItemById

◆ setSize() [1/3]

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

Changes the size of the list box.

Parameters
sizeThe new size of the list box

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

virtual void tgui::Widget::setSize

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

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

◆ setSize() [3/3]

void tgui::Widget::setSize
inline

Changes the size of the widget.

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

◆ setTextSize()

void tgui::ListBox::setTextSize ( unsigned int  textSize)

Changes the text size of the items.

Parameters
textSizeThe size size of the text

This will not change the height that each item has. By default (or when passing 0 to this function) the text will be auto-sized to nicely fit inside this item height.

See also
setItemHeight

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