tgui::ComboBoxRenderer Class Reference

Inheritance diagram for tgui::ComboBoxRenderer:

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

Additional Inherited Members
Protected Attributes inherited from tgui::WidgetRenderer
std::shared_ptr< RendererData >	m_data = RendererData::create()

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

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

TextStyles tgui::ComboBoxRenderer::getTextStyle

(

)

const

Returns text style.

Returns

Style of the text

getTextureArrow()

const Texture & tgui::ComboBoxRenderer::getTextureArrow

(

)

const

Returns the image of the arrow.

Returns

Arrow texture

getTextureArrowDisabled()

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

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

const Texture & tgui::ComboBoxRenderer::getTextureBackground

(

)

const

Returns the background image of the combo box.

Returns

Background texture

getTextureBackgroundDisabled()

const 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

color

The 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

color

The 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

color

The new hover arrow background color

setArrowColor()

void tgui::ComboBoxRenderer::setArrowColor

(

Color

color

)

Changes the color of the arrow.

Parameters

color

The 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

color

The 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

color

The new hover arrow color

setBackgroundColor()

void tgui::ComboBoxRenderer::setBackgroundColor

(

Color

backgroundColor

)

Changes the background color of the combo box.

Parameters

backgroundColor

The 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

backgroundColor

The new disabled background color

setBorderColor()

void tgui::ComboBoxRenderer::setBorderColor

(

Color

borderColor

)

Changes the color of the borders.

Parameters

borderColor

The new border color

setBorders()

void tgui::ComboBoxRenderer::setBorders

(

const Borders &

borders

)

Changes the size of the borders.

Parameters

borders

Size 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

defaultTextColor

The new default text color

setDefaultTextStyle()

void tgui::ComboBoxRenderer::setDefaultTextStyle

(

TextStyles

style

)

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

Parameters

style

The new default text style

comboBox->getSharedRenderer()->setDefaultTextStyle(tgui::TextStyle::Italic | tgui::TextStyle::Bold);

setListBox()

void tgui::ComboBoxRenderer::setListBox

(

std::shared_ptr< RendererData >

rendererData

)

Sets the renderer data of the list box.

Parameters

rendererData

Data about how the list box should look

setPadding()

void tgui::ComboBoxRenderer::setPadding

(

const Padding &

padding

)

Changes the padding of the combo box.

Parameters

padding

The padding width and height

setTextColor()

void tgui::ComboBoxRenderer::setTextColor

(

Color

textColor

)

Changes the color of the text.

Parameters

textColor

The new text color

setTextColorDisabled()

void tgui::ComboBoxRenderer::setTextColorDisabled

(

Color

textColor

)

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

Parameters

textColor

The new disabled text color

setTextStyle()

void tgui::ComboBoxRenderer::setTextStyle

(

TextStyles

style

)

Changes the text style.

Parameters

style

New text style

setTextureArrow()

void tgui::ComboBoxRenderer::setTextureArrow

(

const Texture &

texture

)

Changes the image of the arrow.

Parameters

texture

The 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

texture

The 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

texture

The new hover arrow texture

setTextureBackground()

void tgui::ComboBoxRenderer::setTextureBackground

(

const Texture &

texture

)

Changes the background image of the combo box.

Parameters

texture

The 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

texture

The disabled background texture

WidgetRenderer()

tgui::WidgetRenderer::WidgetRenderer ( const std::shared_ptr< RendererData > &  data )

inline

Construct the renderer from renderer data.

Parameters

data	Renderer data to initialize the renderer with

---

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

• include/TGUI/Renderers/ComboBoxRenderer.hpp