TGUI  0.8-dev

Combo box widget. More...

#include <ComboBox.hpp>

Inheritance diagram for tgui::ComboBox:
tgui::Widget tgui::SignalWidgetBase

Public Types

enum  ExpandDirection { ExpandDirection::Down, ExpandDirection::Up }
 The side where the list will be displayed. More...
 
typedef std::shared_ptr< ComboBoxPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ComboBoxConstPtr
 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

ComboBoxRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
ComboBoxRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the combo box. More...
 
void setItemsToDisplay (std::size_t nrOfItemsInListToDisplay)
 Changes the number of items that are displayed in the list. More...
 
std::size_t getItemsToDisplay () const
 Returns the number of items that are displayed in the list. More...
 
bool addItem (const sf::String &itemName, const sf::String &id="")
 Adds an item to the list, so that it can be selected later. More...
 
bool setSelectedItem (const sf::String &itemName)
 Selects an item from the list. More...
 
bool setSelectedItemById (const sf::String &id)
 Selects an item from the list. More...
 
bool setSelectedItemByIndex (std::size_t index)
 Selects an item in the list. More...
 
void deselectItem ()
 Deselects the selected item. More...
 
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. 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 combo box. More...
 
std::vector< sf::String > getItems ()
 Returns a copy of the items in the combo box. More...
 
const std::vector< sf::String > & getItemIds ()
 Returns a copy of the item ids in the combo box. More...
 
void setMaximumItems (std::size_t maximumItems=0)
 Changes the maximum items that the combo box can contain. More...
 
std::size_t getMaximumItems () const
 Returns the maximum items that the combo box can contain. 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 setExpandDirection (ExpandDirection direction)
 Changes the side where the list is displayed. More...
 
ExpandDirection getExpandDirection () const
 Returns the side where the list is displayed. More...
 
bool mouseOnWidget (sf::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...
 
- 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...
 
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...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual sf::Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hide ()
 Hides the widget. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void enable ()
 Enables the widget. More...
 
virtual void disable ()
 Disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void focus ()
 Focus the widget. More...
 
virtual void unfocus ()
 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 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 ()
 Returns the tool tip that is displayed when hovering over the widget. More...
 
- 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 ComboBox::Ptr create ()
 Creates a new combo box widget. More...
 
static ComboBox::Ptr copy (ComboBox::ConstPtr comboBox)
 Makes a copy of another combo box. More...
 

Public Attributes

SignalItem onItemSelect = {"ItemSelected"}
 An item was selected in the combo box. 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.
 

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

Combo box widget.

Member Enumeration Documentation

◆ ExpandDirection

The side where the list will be displayed.

Enumerator
Down 

Display the list below the combo box.

Up 

Display the list above the combo box.

Member Function Documentation

◆ addItem()

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

Adds an item to the list, so that it can be selected later.

Parameters
itemNameThe name of the item you want to add (this is the text that will be displayed inside the combo box)
idOptional unique id given to this item for the purpose to later identifying this item
Returns
  • true when the item when it was successfully added
  • false when the combo box wasn't loaded correctly
  • false when the list 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 the number of items to display
See also
setMaximumItems
setItemsToDisplay

◆ changeItem()

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

◆ copy()

static ComboBox::Ptr tgui::ComboBox::copy ( ComboBox::ConstPtr  comboBox)
static

Makes a copy of another combo box.

Parameters
comboBoxThe other combo box
Returns
The new combo box

◆ create()

static ComboBox::Ptr tgui::ComboBox::create ( )
static

Creates a new combo box widget.

Returns
The new combo box

◆ deselectItem()

void tgui::ComboBox::deselectItem ( )

Deselects the selected item.

The combo box will be empty after this function is called.

◆ draw()

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

◆ getExpandDirection()

ExpandDirection tgui::ComboBox::getExpandDirection ( ) const

Returns the side where the list is displayed.

Returns
On which side of the combo box is the list be displayed?

◆ getItemById()

sf::String tgui::ComboBox::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::ComboBox::getItemCount ( ) const

Returns the amount of items in the combo box.

Returns
Number of items inside the combo box

◆ getItemIds()

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

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

Returns
item ids

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

◆ getItems()

std::vector<sf::String> tgui::ComboBox::getItems ( )

Returns a copy of the items in the combo box.

Returns
items

◆ getItemsToDisplay()

std::size_t tgui::ComboBox::getItemsToDisplay ( ) const

Returns the number of items that are displayed in the list.

Returns
The maximum number of items to display when the list of items is shown

When there is no scrollbar then this is the maximum number of items. If there is one, then it will only become visible when there are more items than this number.

When set to zero then all items are shown (then there will never be a scrollbar).

◆ getMaximumItems()

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

Returns the maximum items that the combo box can contain.

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

◆ getRenderer()

ComboBoxRenderer* tgui::ComboBox::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::ComboBox::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::ComboBox::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 0

◆ getSelectedItemIndex()

int tgui::ComboBox::getSelectedItemIndex ( ) const

Gets the index of the selected item.

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

◆ getSharedRenderer()

ComboBoxRenderer* tgui::ComboBox::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::ComboBox::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::ComboBox::getTextSize ( ) const

Returns the text size of the items.

Returns
The text size

◆ mouseOnWidget()

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

Removes the item from the list.

Parameters
indexIndex of the item in the list
Returns
  • true when the item was removed
  • false when the index was too high
See also
removeItem
removeItemById

◆ rendererChanged()

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

◆ setExpandDirection()

void tgui::ComboBox::setExpandDirection ( ExpandDirection  direction)

Changes the side where the list is displayed.

Parameters
Onwhich side of the combo box should the list be displayed?

◆ setItemsToDisplay()

void tgui::ComboBox::setItemsToDisplay ( std::size_t  nrOfItemsInListToDisplay)

Changes the number of items that are displayed in the list.

Parameters
nrOfItemsInListToDisplayThe maximum number of items to display when the list of items is shown

When there is no scrollbar then this is the maximum number of items. If there is one, then it will only become visible when there are more items than this number.

When set to zero then all items are shown (then there will never be a scrollbar).

◆ setMaximumItems()

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

Changes the maximum items that the combo box can contain.

Parameters
maximumItemsThe maximum items inside the combo 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.

◆ setSelectedItem()

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

Selects an item from the list.

When adding items to the combo box with the addItem function, none of them will be selected. If you don't want the combo box to stay empty until the user selects something, but you want a default item instead, then you can use this function to select an item.

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::ComboBox::setSelectedItemById ( const sf::String &  id)

Selects an item from the list.

When adding items to the combo box with the addItem function, none of them will be selected. If you don't want the combo box to stay empty until the user selects something, but you want a default item instead, then you can use this function to select an item.

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::ComboBox::setSelectedItemByIndex ( std::size_t  index)

Selects an item in the list.

Parameters
indexIndex of the item in the list
Returns
  • true on success
  • false when the index was too high
See also
setSelectedItem
setSelectedItemById

◆ setSize()

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

Changes the size of the combo box.

This size does not include the borders.

Parameters
sizeThe new size of the combo box

Reimplemented from tgui::Widget.

◆ setTextSize()

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

Changes the text size of the items.

Parameters
textSizeThe size size of the text

By default (or when passing 0 to this function) the text will be auto-sized to nicely fit inside the combo box.


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