TGUI  0.7.4

Combo box widget. More...

#include <ComboBox.hpp>

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

Public Types

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

 ComboBox (const ComboBox &copy)
 Copy constructor. More...
 
ComboBoxoperator= (const ComboBox &right)
 Overload of assignment operator. More...
 
std::shared_ptr< ComboBoxRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position) override
 Set the position of the widget. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the combo box. More...
 
virtual sf::Vector2f getFullSize () const override
 Returns the full size of the combo box. More...
 
virtual void setFont (const Font &font) override
 Changes the font of the text in the widget. 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
 Get the id of the selected item. More...
 
int getSelectedItemIndex () const
 Get 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 ()
 Returns the amount of items in the combo box. More...
 
std::vector< sf::String > getItems ()
 Return a copy of the items in the combo box. More...
 
const std::vector< sf::String > & getItemIds ()
 Return a copy of the item ids in the combo box. More...
 
void setScrollbar (Scrollbar::Ptr scrollbar)
 Changes the scrollbar. More...
 
Scrollbar::Ptr getScrollbar () const
 Access the scrollbar. More...
 
void setListBox (ListBox::Ptr listBox)
 Change the internal list box. More...
 
ListBox::Ptr getListBox () const
 Returns the internal list 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...
 
virtual void setOpacity (float opacity) override
 Changes the opacity of the widget. More...
 
virtual sf::Vector2f getWidgetOffset () const override
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &copy)
 Copy constructor. More...
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &right)
 Overload of assignment operator. More...
 
std::shared_ptr< WidgetRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. 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 (bool blockMouseEvents=true)
 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...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets.
 
virtual void moveToBack ()
 Places the widget behind all other widgets.
 
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...
 
std::shared_ptr< sf::Font > getFont () const
 Returns the font associated with the widget (if any) More...
 
void detachTheme ()
 Detach the theme from the widget. More...
 
std::shared_ptr< BaseThemegetTheme () const
 Returns the theme to which the widget is currently connected. More...
 
std::string getPrimaryLoadingParameter () const
 Returns the primary parameter that was passed to the loader to load this widget. More...
 
std::string getSecondaryLoadingParameter () const
 Returns the secondary parameter that was passed to the loader to load this widget. More...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 set the position of the widget More...
 
sf::Vector2f getPosition () const
 get the position of the widget More...
 
void move (const Layout2d &offset)
 Move the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Move the widget by a given offset. More...
 
void setSize (const Layout &width, const Layout &height)
 Changes the size of the widget. More...
 
virtual sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
void scale (const Layout2d &factors)
 Scale the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scale the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
 SignalWidgetBase ()=default
 Default constructor.
 
 SignalWidgetBase (const SignalWidgetBase &copy)
 Copy constructor. More...
 
SignalWidgetBaseoperator= (const SignalWidgetBase &right)
 Overload of assignment operator. More...
 
template<typename Func , typename... Args>
unsigned int connect (const std::string &signalNames, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
template<typename Func , typename... Args>
unsigned int connectEx (const std::string &signalName, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
void disconnect (unsigned int id)
 Disconnects a connection. More...
 
void disconnectAll (const std::string &signalName)
 Disconnect all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnect all connections from a all 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...
 

Protected Member Functions

virtual void reload (const std::string &primary="", const std::string &secondary="", bool force=false) override
 Reload the widget. More...
 
virtual 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
void attachTheme (std::shared_ptr< BaseTheme > theme)
 Attach a theme to the widget. More...
 

Detailed Description

Combo box widget.

Signals:

  • ItemSelected (a new item was selected)
    • Optional parameter sf::String: Name of the item (the text that is visible)
    • Optional parameters sf::String and sf::String: Name and id of the item
    • Uses Callback member 'text' and 'itemId'
  • Inherited signals from Widget

Constructor & Destructor Documentation

◆ ComboBox()

tgui::ComboBox::ComboBox ( const ComboBox copy)

Copy constructor.

Parameters
copyInstance to copy

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

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

◆ getFullSize()

virtual sf::Vector2f tgui::ComboBox::getFullSize ( ) const
overridevirtual

Returns the full size of the combo box.

The size returned by this function includes the borders.

Returns
The full size of the combo box

Reimplemented from tgui::Transformable.

◆ getItemById()

sf::String tgui::ComboBox::getItemById ( const sf::String &  id) const
inline

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

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

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

Return a copy of the items in the combo box.

Returns
items

◆ getItemsToDisplay()

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

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

◆ getListBox()

ListBox::Ptr tgui::ComboBox::getListBox ( ) const

Returns the internal list box.

Returns
The list box used to display all the items

You should not change this list box yourself.

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

std::shared_ptr<ComboBoxRenderer> tgui::ComboBox::getRenderer ( ) const
inline

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

Returns
Reference to the renderer

◆ getScrollbar()

Scrollbar::Ptr tgui::ComboBox::getScrollbar ( ) const

Access the scrollbar.

Returns
scrollbar that can be displayed next to the list

You should not change the scrollbar yourself.

◆ getSelectedItem()

sf::String tgui::ComboBox::getSelectedItem ( ) const
inline

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
inline

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

Get the index of the selected item.

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

◆ getTextSize()

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

Returns the text size of the items.

Returns
The text size

◆ getWidgetOffset()

virtual sf::Vector2f tgui::ComboBox::getWidgetOffset ( ) const
overridevirtual

Returns the distance between the position where the widget is drawn and where the widget is placed.

This is basically the width and height of the optional borders drawn around widgets.

Returns
Offset of the widget

Reimplemented from tgui::Widget.

◆ operator=()

ComboBox& tgui::ComboBox::operator= ( const ComboBox right)

Overload of assignment operator.

Parameters
rightInstance to assign
Returns
Reference to itself

◆ reload()

virtual void tgui::ComboBox::reload ( const std::string &  primary = "",
const std::string &  secondary = "",
bool  force = false 
)
overrideprotectedvirtual

Reload the widget.

Parameters
primaryPrimary parameter for the loader
secondarySecondary parameter for the loader
forceTry to only change the looks of the widget and not alter the widget itself when false
Exceptions
Exceptionwhen the connected theme could not create the widget

When primary is an empty string the built-in white theme will be used.

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

◆ setFont()

virtual void tgui::ComboBox::setFont ( const Font font)
overridevirtual

Changes the font of the text in the widget.

Parameters
fontThe new font.

When you don't call this function then the font from the parent widget will be used.

Reimplemented from tgui::Widget.

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

◆ setListBox()

void tgui::ComboBox::setListBox ( ListBox::Ptr  listBox)

Change the internal list box.

Returns
listBox The new list box used to display all the items

The list box should have no parent and you should not longer change it after calling this function. The function is meant to be used like this:

comboBox->setListBox(theme->load("ListBox"));

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

◆ setOpacity()

virtual void tgui::ComboBox::setOpacity ( float  opacity)
overridevirtual

Changes the opacity of the widget.

Parameters
opacityThe opacity of the widget. 0 means completely transparent, while 1 (default) means fully opaque.

Reimplemented from tgui::Widget.

◆ setPosition()

virtual void tgui::ComboBox::setPosition ( const Layout2d position)
overridevirtual

Set 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

Reimplemented from tgui::Widget.

◆ setScrollbar()

void tgui::ComboBox::setScrollbar ( Scrollbar::Ptr  scrollbar)

Changes the scrollbar.

Parameters
scrollbarThe new scrollbar to use

Pass a nullptr to remove the scrollbar. Note that when removing the scrollbar while there are too many items to fit in the list then the excess items will be removed.

The scrollbar should have no parent and you should not change it yourself. The function is meant to be used like this:

comboBox->setScrollbar(theme->load("scrollbar"));

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