TGUI  0.8.8
tgui::ComboBoxRenderer Class Reference
Inheritance diagram for tgui::ComboBoxRenderer:
tgui::WidgetRenderer

Public Member Functions

void setBorders (const Borders &borders)
 Changes the size of the borders. More...
 
Borders getBorders () const
 Returns the size of the borders. More...
 
void setPadding (const Padding &padding)
 Changes the padding of the combo box. More...
 
Padding getPadding () const
 Returns the size of the padding. More...
 
void setTextStyle (TextStyle style)
 Changes the text style. More...
 
TextStyle getTextStyle () const
 Returns text style. More...
 
void setDefaultTextStyle (TextStyle style)
 Changes the text style of the default text (the text drawn when no item is selected) More...
 
TextStyle getDefaultTextStyle () const
 Returns the text style of the default text (the text drawn when no item is selected) More...
 
void setBackgroundColor (Color backgroundColor)
 Changes the background color of the combo box. More...
 
Color getBackgroundColor () const
 Returns the background color. More...
 
void setBackgroundColorDisabled (Color backgroundColor)
 Changes the background color of the combo box when the combo box is disabled. More...
 
Color getBackgroundColorDisabled () const
 Returns the background color when the combo box is disabled. More...
 
void setTextColor (Color textColor)
 Changes the color of the text. More...
 
Color getTextColor () const
 Returns the color of the text. More...
 
void setTextColorDisabled (Color textColor)
 Changes the color of the text when the combo box is disabled. More...
 
Color getTextColorDisabled () const
 Returns the color of the text when the combo box is disabled. More...
 
void setDefaultTextColor (Color defaultTextColor)
 Sets the color of the default text that can optionally be displayed when no item is selected. More...
 
Color getDefaultTextColor () const
 Returns the color of the default text that can optionally be displayed when no item is selected. More...
 
void setArrowBackgroundColor (Color color)
 Changes the color behind the arrow. More...
 
Color getArrowBackgroundColor () const
 Returns the color behind the arrow. More...
 
void setArrowBackgroundColorHover (Color color)
 Changes the color behind the arrow in hover state (when the mouse is on top of it) More...
 
Color getArrowBackgroundColorHover () const
 Returns the color behind the arrow in hover state (when the mouse is on top of it) More...
 
void setArrowBackgroundColorDisabled (Color color)
 Changes the color behind the arrow when the combo box is disabled. More...
 
Color getArrowBackgroundColorDisabled () const
 Returns the color behind the arrow when the combo box is disabled. More...
 
void setArrowColor (Color color)
 Changes the color of the arrow. More...
 
Color getArrowColor () const
 Returns the color of the arrow. More...
 
void setArrowColorHover (Color color)
 Changes the color of the arrow in hover state (when the mouse is on top of it) More...
 
Color getArrowColorHover () const
 Returns the color of the arrow in hover state (when the mouse is on top of it) More...
 
void setArrowColorDisabled (Color color)
 Changes the color of the arrow when the combo box is disabled. More...
 
Color getArrowColorDisabled () const
 Returns the color of the arrow when the combo box is disabled. More...
 
void setBorderColor (Color borderColor)
 Changes the color of the borders. More...
 
Color getBorderColor () const
 Returns the color of the borders. More...
 
void setTextureBackground (const Texture &texture)
 Changes the background image of the combo box. More...
 
TexturegetTextureBackground () const
 Returns the background image of the combo box. More...
 
void setTextureBackgroundDisabled (const Texture &texture)
 Changes the background image of the combo box when the combo box is disabled. More...
 
TexturegetTextureBackgroundDisabled () const
 Returns the background image of the combo box when the combo box is disabled. More...
 
void setTextureArrow (const Texture &texture)
 Changes the image of the arrow. More...
 
TexturegetTextureArrow () const
 Returns the image of the arrow. More...
 
void setTextureArrowHover (const Texture &texture)
 Changes the image of the arrow that is displayed when the mouse is on top of it. More...
 
TexturegetTextureArrowHover () const
 Returns the image of the arrow that is displayed when the mouse is on top of it. More...
 
void setTextureArrowDisabled (const Texture &texture)
 Changes the image of the arrow that is displayed when the combo box is disabled. More...
 
TexturegetTextureArrowDisabled () const
 Returns the image of the arrow that is displayed when the combo box is disabled. More...
 
void setListBox (std::shared_ptr< RendererData > rendererData)
 Sets the renderer data of the list box. More...
 
std::shared_ptr< RendererDatagetListBox () const
 Returns the renderer data of the list box. More...
 
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. More...
 
- Public Member Functions inherited from tgui::WidgetRenderer
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. More...
 
virtual ~WidgetRenderer ()=default
 Virtual destructor. More...
 
void setOpacity (float opacity)
 Changes the opacity of the widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
void setOpacityDisabled (float opacity)
 Changes the opacity of the widget when it is disabled. More...
 
float getOpacityDisabled () const
 Returns the opacity of the widget when it is disabled. More...
 
void setFont (Font font)
 Changes the font used for the text in the widget. More...
 
Font getFont () const
 Returns the font associated with the widget (if any) More...
 
void setTransparentTexture (bool ignoreTransparentParts)
 Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state. More...
 
bool getTransparentTexture () const
 Returns whether mouse events should be ignored on transparent parts of the texture of the widget. More...
 
void setProperty (const std::string &property, ObjectConverter &&value)
 Changes a property of the renderer. More...
 
ObjectConverter getProperty (const std::string &property) const
 Retrieves the value of a certain property. More...
 
const std::map< std::string, ObjectConverter > & getPropertyValuePairs () const
 Gets a map with all properties and their values. More...
 
void subscribe (const void *id, const std::function< void(const std::string &property)> &function)
 Subscribes a callback function to changes in the renderer. More...
 
void unsubscribe (const void *id)
 Subscribes a callback function to changes in the renderer. More...
 
std::shared_ptr< RendererDatagetData () const
 Returns the renderer data. More...
 
std::shared_ptr< RendererDataclone () const
 Gets a clone of the renderer data. More...
 

Member Function Documentation

◆ getArrowBackgroundColor()

Color tgui::ComboBoxRenderer::getArrowBackgroundColor ( ) const

Returns the color behind the arrow.

Returns
Arrow background color

◆ getArrowBackgroundColorDisabled()

Color tgui::ComboBoxRenderer::getArrowBackgroundColorDisabled ( ) const

Returns the color behind the arrow when the combo box is disabled.

Returns
Disabled arrow background color

◆ getArrowBackgroundColorHover()

Color tgui::ComboBoxRenderer::getArrowBackgroundColorHover ( ) const

Returns the color behind the arrow in hover state (when the mouse is on top of it)

Returns
Hover arrow background color

◆ getArrowColor()

Color tgui::ComboBoxRenderer::getArrowColor ( ) const

Returns the color of the arrow.

Returns
Arrow color

◆ getArrowColorDisabled()

Color tgui::ComboBoxRenderer::getArrowColorDisabled ( ) const

Returns the color of the arrow when the combo box is disabled.

Returns
Disabled hover arrow color

◆ getArrowColorHover()

Color tgui::ComboBoxRenderer::getArrowColorHover ( ) const

Returns the color of the arrow in hover state (when the mouse is on top of it)

Returns
Hover arrow color

◆ getBackgroundColor()

Color tgui::ComboBoxRenderer::getBackgroundColor ( ) const

Returns the background color.

Returns
Background color

◆ getBackgroundColorDisabled()

Color tgui::ComboBoxRenderer::getBackgroundColorDisabled ( ) const

Returns the background color when the combo box is disabled.

Returns
Disabled background color

◆ getBorderColor()

Color tgui::ComboBoxRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

◆ getBorders()

Borders tgui::ComboBoxRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getDefaultTextColor()

Color tgui::ComboBoxRenderer::getDefaultTextColor ( ) const

Returns the color of the default text that can optionally be displayed when no item is selected.

Returns
Default text color

◆ getDefaultTextStyle()

TextStyle tgui::ComboBoxRenderer::getDefaultTextStyle ( ) const

Returns the text style of the default text (the text drawn when no item is selected)

Returns
Style of the default text

◆ getListBox()

std::shared_ptr<RendererData> tgui::ComboBoxRenderer::getListBox ( ) const

Returns the renderer data of the list box.

Returns
Data about how the list box looks

◆ getPadding()

Padding tgui::ComboBoxRenderer::getPadding ( ) const

Returns the size of the padding.

Returns
padding size

◆ getTextColor()

Color tgui::ComboBoxRenderer::getTextColor ( ) const

Returns the color of the text.

Returns
Text color

◆ getTextColorDisabled()

Color tgui::ComboBoxRenderer::getTextColorDisabled ( ) const

Returns the color of the text when the combo box is disabled.

Returns
Disabled text color

◆ getTextStyle()

TextStyle tgui::ComboBoxRenderer::getTextStyle ( ) const

Returns text style.

Returns
Style of the text

◆ getTextureArrow()

Texture& tgui::ComboBoxRenderer::getTextureArrow ( ) const

Returns the image of the arrow.

Returns
Arrow texture

◆ getTextureArrowDisabled()

Texture& tgui::ComboBoxRenderer::getTextureArrowDisabled ( ) const

Returns the image of the arrow that is displayed when the combo box is disabled.

Returns
Disabled arrow texture

◆ getTextureArrowHover()

Texture& tgui::ComboBoxRenderer::getTextureArrowHover ( ) const

Returns the image of the arrow that is displayed when the mouse is on top of it.

Returns
Hover arrow texture

◆ getTextureBackground()

Texture& tgui::ComboBoxRenderer::getTextureBackground ( ) const

Returns the background image of the combo box.

Returns
Background texture

◆ getTextureBackgroundDisabled()

Texture& tgui::ComboBoxRenderer::getTextureBackgroundDisabled ( ) const

Returns the background image of the combo box when the combo box is disabled.

Returns
Disabled background texture

◆ setArrowBackgroundColor()

void tgui::ComboBoxRenderer::setArrowBackgroundColor ( Color  color)

Changes the color behind the arrow.

Parameters
colorThe new arrow background color

This color will be ignored when a up and down arrow image were loaded.

◆ setArrowBackgroundColorDisabled()

void tgui::ComboBoxRenderer::setArrowBackgroundColorDisabled ( Color  color)

Changes the color behind the arrow when the combo box is disabled.

Parameters
colorThe new disabled arrow background color

This color will be ignored when a up and down arrow image were loaded.

◆ setArrowBackgroundColorHover()

void tgui::ComboBoxRenderer::setArrowBackgroundColorHover ( Color  color)

Changes the color behind the arrow in hover state (when the mouse is on top of it)

Parameters
colorThe new hover arrow background color

◆ setArrowColor()

void tgui::ComboBoxRenderer::setArrowColor ( Color  color)

Changes the color of the arrow.

Parameters
colorThe new arrow color

This color will be ignored when a up and down arrow image were loaded.

◆ setArrowColorDisabled()

void tgui::ComboBoxRenderer::setArrowColorDisabled ( Color  color)

Changes the color of the arrow when the combo box is disabled.

Parameters
colorThe new disabled hover arrow color

◆ setArrowColorHover()

void tgui::ComboBoxRenderer::setArrowColorHover ( Color  color)

Changes the color of the arrow in hover state (when the mouse is on top of it)

Parameters
colorThe new hover arrow color

◆ setBackgroundColor()

void tgui::ComboBoxRenderer::setBackgroundColor ( Color  backgroundColor)

Changes the background color of the combo box.

Parameters
backgroundColorThe new background color

◆ setBackgroundColorDisabled()

void tgui::ComboBoxRenderer::setBackgroundColorDisabled ( Color  backgroundColor)

Changes the background color of the combo box when the combo box is disabled.

Parameters
backgroundColorThe new disabled background color

◆ setBorderColor()

void tgui::ComboBoxRenderer::setBorderColor ( Color  borderColor)

Changes the color of the borders.

Parameters
borderColorThe new border color

◆ setBorders()

void tgui::ComboBoxRenderer::setBorders ( const Borders borders)

Changes the size of the borders.

Parameters
bordersSize of the borders

◆ setDefaultTextColor()

void tgui::ComboBoxRenderer::setDefaultTextColor ( Color  defaultTextColor)

Sets the color of the default text that can optionally be displayed when no item is selected.

Parameters
defaultTextColorThe new default text color

◆ setDefaultTextStyle()

void tgui::ComboBoxRenderer::setDefaultTextStyle ( TextStyle  style)

Changes the text style of the default text (the text drawn when no item is selected)

Parameters
styleThe new default text style
comboBox->getSharedRenderer()->setDefaultTextStyle(sf::Text::Italic | sf::Text::Bold);

◆ setListBox()

void tgui::ComboBoxRenderer::setListBox ( std::shared_ptr< RendererData rendererData)

Sets the renderer data of the list box.

Parameters
rendererDataData about how the list box should look

◆ setPadding()

void tgui::ComboBoxRenderer::setPadding ( const Padding padding)

Changes the padding of the combo box.

Parameters
paddingThe padding width and height

◆ setTextColor()

void tgui::ComboBoxRenderer::setTextColor ( Color  textColor)

Changes the color of the text.

Parameters
textColorThe new text color

◆ setTextColorDisabled()

void tgui::ComboBoxRenderer::setTextColorDisabled ( Color  textColor)

Changes the color of the text when the combo box is disabled.

Parameters
textColorThe new disabled text color

◆ setTextStyle()

void tgui::ComboBoxRenderer::setTextStyle ( TextStyle  style)

Changes the text style.

Parameters
styleNew text style

◆ setTextureArrow()

void tgui::ComboBoxRenderer::setTextureArrow ( const Texture texture)

Changes the image of the arrow.

Parameters
textureThe new arrow texture

When this image is set, the arrow color properties will be ignored.

◆ setTextureArrowDisabled()

void tgui::ComboBoxRenderer::setTextureArrowDisabled ( const Texture texture)

Changes the image of the arrow that is displayed when the combo box is disabled.

Parameters
textureThe new disabled arrow texture

◆ setTextureArrowHover()

void tgui::ComboBoxRenderer::setTextureArrowHover ( const Texture texture)

Changes the image of the arrow that is displayed when the mouse is on top of it.

Parameters
textureThe new hover arrow texture

◆ setTextureBackground()

void tgui::ComboBoxRenderer::setTextureBackground ( const Texture texture)

Changes the background image of the combo box.

Parameters
textureThe background texture

When this image is set, the background color property will be ignored.

◆ setTextureBackgroundDisabled()

void tgui::ComboBoxRenderer::setTextureBackgroundDisabled ( const Texture texture)

Changes the background image of the combo box when the combo box is disabled.

Parameters
textureThe disabled background texture

◆ WidgetRenderer()

tgui::WidgetRenderer::WidgetRenderer
inline

Construct the renderer from renderer data.

Parameters
dataRenderer data to initialize the renderer with

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