TGUI  1.6.1
Loading...
Searching...
No Matches

Combo box widget. More...

#include <TGUI/Widgets/ComboBox.hpp>

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

Public Types

enum class  ExpandDirection { Down , Up , Automatic }
 The side where the list will be displayed. More...
 
using Ptr = std::shared_ptr<ComboBox>
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr<const ComboBox>
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
using Ptr = std::shared_ptr<Widget>
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr<const Widget>
 Shared constant widget pointer.
 

Public Member Functions

 ComboBox (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
 ComboBox (const ComboBox &other)
 
 ComboBox (ComboBox &&other) noexcept
 
ComboBoxoperator= (const ComboBox &other)
 
ComboBoxoperator= (ComboBox &&other) noexcept
 
ComboBoxRenderergetSharedRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
const ComboBoxRenderergetSharedRenderer () const override
 
ComboBoxRenderergetRenderer () 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 combo box.
 
void setEnabled (bool enabled) override
 Enables or disables the widget.
 
void setItemsToDisplay (std::size_t nrOfItemsInListToDisplay)
 Changes the number of items that are displayed in the list.
 
std::size_t getItemsToDisplay () const
 Returns the number of items that are displayed in the list.
 
std::size_t addItem (const String &itemName, const String &id="")
 Adds an item to the list, so that it can be selected later.
 
void addMultipleItems (const std::vector< String > &itemNames)
 Adds multiple items to the list.
 
bool setSelectedItem (const String &itemName)
 Selects an item from the list.
 
bool setSelectedItemById (const String &id)
 Selects an item from the list.
 
bool setSelectedItemByIndex (std::size_t index)
 Selects an item in the list.
 
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.
 
void removeAllItems ()
 Removes all items from the list.
 
String getItemById (const String &id) const
 Returns the item name of the item with the given id.
 
String getItemByIndex (std::size_t index) const
 Returns the item name of the item at the given index.
 
int getIndexById (const String &id) const
 Returns the index of the item with the given id.
 
String getIdByIndex (std::size_t index) const
 Returns the id of the item at the given index.
 
String getSelectedItem () const
 Returns the currently selected item.
 
String getSelectedItemId () const
 Gets the id of the selected item.
 
int getSelectedItemIndex () const
 Gets the index of the selected item.
 
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.
 
std::size_t getItemCount () const
 Returns the amount of items in the combo box.
 
std::vector< StringgetItems () const
 Returns a copy of the items in the combo box.
 
std::vector< StringgetItemIds () const
 Returns a copy of the item ids in the combo box.
 
void setItemData (std::size_t index, Any data)
 Store some user data with the item.
 
template<typename DataType >
DataType getItemData (std::size_t index) const
 Returns user data stored in the item.
 
void setMaximumItems (std::size_t maximumItems=0)
 Changes the maximum items that the combo box can contain.
 
std::size_t getMaximumItems () const
 Returns the maximum items that the combo box can contain.
 
void setDefaultText (const String &defaultText)
 Changes the default text of the combo box. This is the text drawn when no item is selected.
 
const StringgetDefaultText () const
 Returns the default text of the combo box. This is the text drawn when no item is selected.
 
void setExpandDirection (ExpandDirection direction)
 Changes the side where the list is displayed.
 
ExpandDirection getExpandDirection () const
 Returns the side where the list is displayed.
 
bool contains (const String &item) const
 Returns whether the combo box contains the given item.
 
bool containsId (const String &id) const
 Returns whether the combo box contains an item with the given id.
 
void setChangeItemOnScroll (bool changeOnScroll)
 Changes whether the mouse wheel can be used to change the selected item while the list is closed.
 
bool getChangeItemOnScroll () const
 Returns whether the mouse wheel can be used to change the selected item while the list is closed.
 
void setParent (Container *parent) override
 
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.
 
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 draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the widget to a render target.
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
- Public Member Functions inherited from tgui::Widget
 Widget (const char *typeName, bool initRenderer)
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&) noexcept
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (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.
 
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.
 
Vector2f getSize () const
 Returns the size of the widget.
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using.
 
virtual Vector2f getAbsolutePosition (Vector2f offset={}) const
 Get the absolute position of the widget instead of the relative position to its parent.
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed.
 
void setAutoLayout (AutoLayout layout)
 Sets how the position is determined compared to the other widgets in the parent.
 
AutoLayout getAutoLayout () const
 Returns how the position is determined compared to the other widgets in the parent.
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based.
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based.
 
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.
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget.
 
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.
 
float getRotation () const
 Returns the rotation to be applied to the widget.
 
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.
 
bool isVisible () const
 Returns true when the widget is visible.
 
bool isEnabled () const
 Returns true when the widget is enabled.
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget.
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise.
 
const StringgetWidgetType () const
 Returns the type of the widget.
 
ContainergetParent () const
 Returns a pointer to the parent widget.
 
BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs.
 
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 >
DataType getUserData () const
 Returns data stored in the widget.
 
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.
 
const FontgetInheritedFont () 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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
Widget::Ptr getNavigationRight () const
 Returns which widget would become focused when navigating to the right from this widget.
 
void setIgnoreMouseEvents (bool ignore)
 Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.
 
bool getIgnoreMouseEvents () const
 Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
virtual bool canGainFocus () const
 Returns whether the widget can currently gain focus.
 
bool isContainer () const
 Returns whether the widget is a container widget or not.
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget.
 
virtual bool updateTime (Duration elapsedTime)
 
void setAutoLayoutUpdateEnabled (bool enabled)
 
virtual void leftMouseReleased (Vector2f pos)
 
virtual void rightMousePressed (Vector2f pos)
 
virtual void rightMouseReleased (Vector2f pos)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual void mouseMoved (Vector2f pos)
 
virtual void keyPressed (const Event::KeyEvent &event)
 
virtual bool canHandleKeyPress (const Event::KeyEvent &event)
 Called by the parent of the widget to check if keyPressed would process the event.
 
virtual void textEntered (char32_t key)
 
virtual void mouseNoLongerOnWidget ()
 
virtual void leftMouseButtonNoLongerDown ()
 
virtual void rightMouseButtonNoLongerDown ()
 
virtual Widget::Ptr askToolTip (Vector2f mousePos)
 
const Layout2dgetPositionLayout () const
 
const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
void rendererChangedCallback (const String &property)
 

Static Public Member Functions

static ComboBox::Ptr create ()
 Creates a new combo box widget.
 
static ComboBox::Ptr copy (const ComboBox::ConstPtr &comboBox)
 Makes a copy of another combo box.
 

Public Attributes

SignalItem onItemSelect = {"ItemSelected"}
 An item was selected in the combo box. Optional parameter: selected item or its index.
 
- Public Attributes inherited from tgui::Widget
SignalVector2f onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalVector2f onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
Signal onFocus = {"Focused"}
 The widget was focused.
 
Signal onUnfocus = {"Unfocused"}
 The widget was unfocused.
 
Signal onMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
Signal onMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 
SignalShowEffect onShowEffectFinish = {"ShowEffectFinished"}
 A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.
 
SignalAnimationType onAnimationFinish = {"AnimationFinished"}
 An animation has finished.
 

Static Public Attributes

static constexpr const char StaticWidgetType [] = "ComboBox"
 Type name of the widget.
 

Protected Member Functions

SignalgetSignal (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.
 
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)
 
Vector2f getInnerSize () const
 
void updateListBoxHeight ()
 
void showListBox ()
 
void hideListBox ()
 
void initListBox ()
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type.
 
- Protected Member Functions inherited from tgui::Widget
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget.
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget.
 
void recalculateBoundPositionLayouts ()
 Calls recalculateValue() on each layout in m_boundPositionLayouts.
 
void recalculateBoundSizeLayouts ()
 Calls recalculateValue() on each layout in m_boundSizeLayouts.
 

Protected Attributes

std::size_t m_nrOfItemsToDisplay = 0
 
ListBox::Ptr m_listBox = ListBox::create()
 
Text m_text
 
Text m_defaultText
 
int m_previousSelectedItemIndex = -1
 
bool m_changeItemOnScroll = false
 
ExpandDirection m_expandDirection = ExpandDirection::Automatic
 
Sprite m_spriteBackground
 
Sprite m_spriteBackgroundDisabled
 
Sprite m_spriteArrow
 
Sprite m_spriteArrowHover
 
Sprite m_spriteArrowDisabled
 
Borders m_bordersCached
 
Padding m_paddingCached
 
Color m_borderColorCached
 
Color m_backgroundColorCached
 
Color m_backgroundColorDisabledCached
 
Color m_arrowColorCached
 
Color m_arrowColorHoverCached
 
Color m_arrowColorDisabledCached
 
Color m_arrowBackgroundColorCached
 
Color m_arrowBackgroundColorHoverCached
 
Color m_arrowBackgroundColorDisabledCached
 
Color m_textColorCached
 
Color m_textColorDisabledCached
 
- Protected Attributes inherited from tgui::Widget
String m_type
 
String m_name
 
Layout2d m_position
 Stores the position of this widget.
 
Layout2d m_size
 Stores the size of this widget.
 
unsigned int m_textSize = 0
 
Vector2f m_origin
 
Optional< Vector2fm_rotationOrigin
 
Optional< Vector2fm_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.
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
std::weak_ptr< Widgetm_navWidgetUp
 
std::weak_ptr< Widgetm_navWidgetDown
 
std::weak_ptr< Widgetm_navWidgetRight
 
std::weak_ptr< Widgetm_navWidgetLeft
 
Duration m_animationTimeElapsed
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_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
 
bool m_ignoreMouseEvents = false
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 

Additional Inherited Members

- Protected Types inherited from tgui::Widget
using SavingRenderersMap = std::map<const Widget*, std::pair<std::unique_ptr<DataIO::Node>, String>>
 
using LoadingRenderersMap = std::map<String, std::shared_ptr<RendererData>>
 

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.

Automatic 

Display the list below the combo box unless it wouldn't fit on the screen.

Member Function Documentation

◆ addItem()

std::size_t tgui::ComboBox::addItem ( const String & itemName,
const 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
  • Index of inserted item if no maximum items are set or when index is still less than getMaximumItems()
  • Value of getMaximumItems() when adding item failed because there are too many items

◆ addMultipleItems()

void tgui::ComboBox::addMultipleItems ( const std::vector< String > & itemNames)

Adds multiple items to the list.

Parameters
itemNamesList of items that should be passed to the addItem function

If a maximum items was configured then this function stops adding items when the maximum is reached.

Since
TGUI 1.6

◆ changeItem()

bool tgui::ComboBox::changeItem ( const String & originalValue,
const 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 String & id,
const 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 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
nodiscardoverrideprotectedvirtual

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::ComboBox::contains ( const String & item) const
nodiscard

Returns whether the combo box contains the given item.

Returns
Does the combo box contain the item?

◆ containsId()

bool tgui::ComboBox::containsId ( const String & id) const
nodiscard

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

Returns
Does the combo box contain the id?

◆ copy()

static ComboBox::Ptr tgui::ComboBox::copy ( const ComboBox::ConstPtr & comboBox)
staticnodiscard

Makes a copy of another combo box.

Parameters
comboBoxThe other combo box
Returns
The new combo box

◆ create()

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

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 ( BackendRenderTarget & target,
RenderStates states ) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ getChangeItemOnScroll()

bool tgui::ComboBox::getChangeItemOnScroll ( ) const
nodiscard

Returns whether the mouse wheel can be used to change the selected item while the list is closed.

Returns
Should the selected item be changed when scrolling while the mouse is on top of the combo box?

◆ getDefaultText()

const String & tgui::ComboBox::getDefaultText ( ) const
nodiscard

Returns the default text of the combo box. This is the text drawn when no item is selected.

Returns
The default text of the combo box

◆ getExpandDirection()

ExpandDirection tgui::ComboBox::getExpandDirection ( ) const
nodiscard

Returns the side where the list is displayed.

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

◆ getIdByIndex()

String tgui::ComboBox::getIdByIndex ( std::size_t index) const
nodiscard

Returns the id of the item at the given index.

Parameters
indexThe index of the item to find
Returns
The id of the requested item, or an empty string when the index was too high
Since
TGUI 1.6

◆ getIndexById()

int tgui::ComboBox::getIndexById ( const String & id) const
nodiscard

Returns the index 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 index of the first item with that id will be returned.

Returns
The index of the item that matched the id, or -1 when no item matches the id
Since
TGUI 1.6

◆ getItemById()

String tgui::ComboBox::getItemById ( const String & id) const
nodiscard

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

◆ getItemByIndex()

String tgui::ComboBox::getItemByIndex ( std::size_t index) const
nodiscard

Returns the item name of the item at the given index.

Parameters
indexThe index of the item to return
Returns
The requested item, or an empty string when the index was too high
Since
TGUI 1.6

◆ getItemCount()

std::size_t tgui::ComboBox::getItemCount ( ) const
nodiscard

Returns the amount of items in the combo box.

Returns
Number of items inside the combo box

◆ getItemData()

template<typename DataType >
DataType tgui::ComboBox::getItemData ( std::size_t index) const
inlinenodiscard

Returns user data stored in the item.

Returns
Stored data
Exceptions
std::bad_castif 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).
Since
TGUI 1.3

◆ getItemIds()

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

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< String > tgui::ComboBox::getItems ( ) const
nodiscard

Returns a copy of the items in the combo box.

Returns
items

◆ getItemsToDisplay()

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

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
nodiscard

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

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

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

Reimplemented from tgui::Widget.

◆ getSelectedItem()

String tgui::ComboBox::getSelectedItem ( ) const
nodiscard

Returns the currently selected item.

Returns
The selected item. When no item was selected then this function will return an empty string

◆ getSelectedItemId()

String tgui::ComboBox::getSelectedItemId ( ) const
nodiscard

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
nodiscard

Gets the index of the selected item.

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

◆ getSharedRenderer() [1/2]

const ComboBoxRenderer * tgui::ComboBox::getSharedRenderer ( ) const
nodiscardoverridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

ComboBoxRenderer * tgui::ComboBox::getSharedRenderer ( )
nodiscardoverridevirtual

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

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

Reimplemented from tgui::Widget.

◆ getSignal()

Signal & tgui::ComboBox::getSignal ( String signalName)
nodiscardoverrideprotectedvirtual

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.

◆ isMouseOnWidget()

bool tgui::ComboBox::isMouseOnWidget ( Vector2f pos) const
nodiscardoverridevirtual

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.

◆ leftMousePressed()

bool tgui::ComboBox::leftMousePressed ( Vector2f pos)
overridevirtual

Called by the parent when the left mouse button goes down on top of the widget.

Parameters
posMouse position in view coordinates relative to the parent widget
Returns
True if the clicked part of the widget is draggable, i.e. if the widget should continue to receive mouse move events until the mouse is released, even when the mouse leaves the widget. When false is returned, the mouse move events will only be sent to the widget as long as the mouse is on top of the widget.

Reimplemented from tgui::Widget.

◆ load()

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

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ removeItem()

bool tgui::ComboBox::removeItem ( const 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 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 String & property)
overrideprotectedvirtual

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

Parameters
propertyName of the property that was changed

Reimplemented from tgui::Widget.

◆ save()

std::unique_ptr< DataIO::Node > tgui::ComboBox::save ( SavingRenderersMap & renderers) const
nodiscardoverrideprotectedvirtual

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

Reimplemented from tgui::Widget.

◆ scrolled()

bool tgui::ComboBox::scrolled ( float delta,
Vector2f pos,
bool touch )
overridevirtual

Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

Parameters
deltaScroll offset (positive is up, negative is down). High-precision mice may use non-integral offsets.
posMouse position, or the initial position of the touch events
touchWas this a touch event or a mouse wheel scroll?
Returns
Was the scrolling was handled by the widget?

Reimplemented from tgui::Widget.

◆ setChangeItemOnScroll()

void tgui::ComboBox::setChangeItemOnScroll ( bool changeOnScroll)

Changes whether the mouse wheel can be used to change the selected item while the list is closed.

Parameters
changeOnScrollShould the selected item be changed when scrolling while the mouse is on top of the combo box?

◆ setDefaultText()

void tgui::ComboBox::setDefaultText ( const String & defaultText)

Changes the default text of the combo box. This is the text drawn when no item is selected.

Parameters
defaultTextThe new default text

◆ setEnabled()

void tgui::ComboBox::setEnabled ( bool enabled)
overridevirtual

Enables or disables the widget.

Parameters
enabledIs the widget enabled?

The disabled widget will no longer receive events and thus no longer send callbacks. All widgets are enabled by default.

Reimplemented from tgui::Widget.

◆ setExpandDirection()

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

Changes the side where the list is displayed.

Parameters
directionOn which side of the combo box should the list be displayed?

◆ setItemData()

void tgui::ComboBox::setItemData ( std::size_t index,
Any data )

Store some user data with the item.

Parameters
indexIndex of the item
dataUser data to store

Examples:

comboBox->setItemData(idx, "Data"); // Note: type to retrieve with getItemData is 'const char*' here
comboBox->setItemData(idx, 5);
Since
TGUI 1.3

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

◆ setParent()

void tgui::ComboBox::setParent ( Container * parent)
overridevirtual

Reimplemented from tgui::Widget.

◆ setSelectedItem()

bool tgui::ComboBox::setSelectedItem ( const 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 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() [1/2]

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.

◆ setSize() [2/2]

void tgui::Widget::setSize ( Layout width,
Layout height )
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

◆ updateTextSize()

void tgui::ComboBox::updateTextSize ( )
overrideprotectedvirtual

Called when the text size is changed (either by setTextSize or via the renderer)

Reimplemented from tgui::Widget.


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