Inheritance diagram for tgui::ListBoxRenderer:

Public Member Functions
	ListBoxRenderer (ListBox *listBox)
	Constructor. More...

virtual void	setProperty (std::string property, const std::string &value) override
	Change a property of the renderer. More...

virtual void	setProperty (std::string property, ObjectConverter &&value) override
	Change a property of the renderer. More...

virtual ObjectConverter	getProperty (std::string property) const override
	Retrieve the value of a certain property. More...

virtual std::map< std::string, ObjectConverter >	getPropertyValuePairs () const override
	Get a map with all properties and their values. More...

void	setBackgroundColor (const Color &backgroundColor)
	Set the background color that will be used inside the list box. More...

void	setTextColor (const Color &textColor)
	Set the text color that will be used inside the list box. More...

void	setTextColorNormal (const Color &color)
	Changes the color of the text in the normal state (mouse not on top of the item). More...

void	setTextColorHover (const Color &color)
	Changes the color of the text in the hover state (mouse is standing on top of the item). More...

void	setHoverBackgroundColor (const Color &hoverBackgroundColor)
	Set the background color of the unselected item on which the mouse is standing. More...

void	setSelectedBackgroundColor (const Color &selectedBackgroundColor)
	Set the background color of the selected text that will be used inside the list box. More...

void	setSelectedTextColor (const Color &selectedTextColor)
	Set the text color of the selected text that will be used inside the list box. More...

void	setBorderColor (const Color &borderColor)
	Set the border color text that will be used inside the list box. More...

void	setBackgroundTexture (const Texture &texture)
	Changes the background image. More...

virtual void	setPadding (const Padding &padding) override
	Changes the padding of the list box. More...

virtual void	setPadding (const Padding &padding)
	Changes the size of the padding. More...

void	setPadding (float leftPadding, float topPadding, float rightPadding, float bottomPadding)
	Changes the size of the padding. More...

void	setPadding (float width, float height)
	Changes the size of the padding. More...

Public Member Functions inherited from tgui::WidgetRenderer
virtual	~WidgetRenderer ()
	Virtual destructor.

Public Member Functions inherited from tgui::WidgetBorders
virtual void	setBorders (const Borders &borders)
	Changes the size of the borders. More...

void	setBorders (float leftBorder, float topBorder, float rightBorder, float bottomBorder)
	Changes the size of the borders. More...

void	setBorders (float width, float height)
	Changes the size of the borders. More...

virtual Borders	getBorders () const
	Returns the size of the borders as a tgui::Borders. More...

Public Member Functions inherited from tgui::WidgetPadding
void	setPadding (float leftPadding, float topPadding, float rightPadding, float bottomPadding)
	Changes the size of the padding. More...

void	setPadding (float width, float height)
	Changes the size of the padding. More...

virtual Padding	getPadding () const
	Returns the size of the padding. More...

Constructor & Destructor Documentation

◆ ListBoxRenderer()

tgui::ListBoxRenderer::ListBoxRenderer ( ListBox * listBox )

inline

Constructor.

Parameters

listBox The list box that is connected to the renderer

Member Function Documentation

◆ getProperty()

virtual ObjectConverter tgui::ListBoxRenderer::getProperty ( std::string property ) const

overridevirtual

Retrieve the value of a certain property.

Parameters

property The property that you would like to retrieve

Returns: The value inside a ObjectConverter object which you can extract with the correct get function or an ObjectConverter object with type ObjectConverter::Type::None when the property did not exist.

Reimplemented from tgui::WidgetRenderer.

◆ getPropertyValuePairs()

virtual std::map< std::string, ObjectConverter > tgui::ListBoxRenderer::getPropertyValuePairs ( ) const

overridevirtual

Get a map with all properties and their values.

Returns: Property-value pairs of the renderer

Reimplemented from tgui::WidgetRenderer.

◆ setBackgroundColor()

void tgui::ListBoxRenderer::setBackgroundColor ( const Color & backgroundColor )

Set the background color that will be used inside the list box.

Parameters

backgroundColor The color of the background of the list box

◆ setBackgroundTexture()

void tgui::ListBoxRenderer::setBackgroundTexture ( const Texture & texture )

Changes the background image.

Parameters

texture New background texture

When this image is set, the background color property will be ignored. Pass an empty string to unset the image, in this case the background color property will be used again.

◆ setBorderColor()

void tgui::ListBoxRenderer::setBorderColor ( const Color & borderColor )

Set the border color text that will be used inside the list box.

Parameters

borderColor The color of the borders

◆ setHoverBackgroundColor()

void tgui::ListBoxRenderer::setHoverBackgroundColor ( const Color & hoverBackgroundColor )

Set the background color of the unselected item on which the mouse is standing.

Parameters

hoverBackgroundColor The color of the background of unselected item below the mouse

◆ setPadding() [1/4]

virtual void tgui::WidgetPadding::setPadding ( const Padding & padding )

inlinevirtual

Changes the size of the padding.

Parameters

padding Size of the padding

Reimplemented from tgui::WidgetPadding.

◆ setPadding() [2/4]

virtual void tgui::ListBoxRenderer::setPadding ( const Padding & padding )

overridevirtual

Changes the padding of the list box.

This padding will be scaled together with the background image. If there is no background image, or when 9-slice scaling is used, the padding will be exactly what you pass here.

Parameters

padding The padding width and height

Reimplemented from tgui::WidgetPadding.

◆ setPadding() [3/4]

void tgui::WidgetPadding::setPadding	(	float	leftPadding,
		float	topPadding,
		float	rightPadding,
		float	bottomPadding
	)

inline

Changes the size of the padding.

Parameters

leftPadding	Width of the left padding
topPadding	Height of the top padding
rightPadding	Width of the right padding
bottomPadding	Height of the bottom padding

◆ setPadding() [4/4]

void tgui::WidgetPadding::setPadding	(	float	width,
		float	height
	)

inline

Changes the size of the padding.

Parameters

width	Width of the left and right padding
height	Height of the top and bottom padding

◆ setProperty() [1/2]

virtual void tgui::ListBoxRenderer::setProperty	(	std::string	property,
		const std::string &	value
	)

overridevirtual

Change a property of the renderer.

Parameters

property	The property that you would like to change
value	The new serialized value that you like to assign to the property

Exceptions

Exception	when deserialization fails or when the widget does not have this property.
Exception	when loading scrollbar fails with the theme connected to the list box

Reimplemented from tgui::WidgetRenderer.

◆ setProperty() [2/2]

virtual void tgui::ListBoxRenderer::setProperty	(	std::string	property,
		ObjectConverter &&	value
	)

overridevirtual

Change a property of the renderer.

Parameters

property	The property that you would like to change
value	The new value that you like to assign to the property. The ObjectConverter is implicitly constructed from the possible value types.

Exceptions

Exception	for unknown properties or when value was of a wrong type.
Exception	when loading scrollbar fails with the theme connected to the list box

Reimplemented from tgui::WidgetRenderer.

◆ setSelectedBackgroundColor()

void tgui::ListBoxRenderer::setSelectedBackgroundColor ( const Color & selectedBackgroundColor )

Set the background color of the selected text that will be used inside the list box.

Parameters

selectedBackgroundColor The color of the background of the selected item

◆ setSelectedTextColor()

void tgui::ListBoxRenderer::setSelectedTextColor ( const Color & selectedTextColor )

Set the text color of the selected text that will be used inside the list box.

Parameters

selectedTextColor The color of the text when it is selected

◆ setTextColor()

void tgui::ListBoxRenderer::setTextColor ( const Color & textColor )

Set the text color that will be used inside the list box.

Parameters

textColor The color of the text

This color will overwrite the color for both the normal and hover state.

See also: setTextColorNormal; setTextColorHover

◆ setTextColorHover()

void tgui::ListBoxRenderer::setTextColorHover ( const Color & color )

Changes the color of the text in the hover state (mouse is standing on top of the item).

Parameters

color New text color

◆ setTextColorNormal()

void tgui::ListBoxRenderer::setTextColorNormal ( const Color & color )

Changes the color of the text in the normal state (mouse not on top of the item).

Parameters

color New text color

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

include/TGUI/Widgets/ListBox.hpp

TGUI

Public Member Functions

Constructor & Destructor Documentation

◆ ListBoxRenderer()

Member Function Documentation

◆ getProperty()

◆ getPropertyValuePairs()

◆ setBackgroundColor()

◆ setBackgroundTexture()

◆ setBorderColor()

◆ setHoverBackgroundColor()

◆ setPadding() [1/4]

◆ setPadding() [2/4]

◆ setPadding() [3/4]

◆ setPadding() [4/4]

◆ setProperty() [1/2]

◆ setProperty() [2/2]

◆ setSelectedBackgroundColor()

◆ setSelectedTextColor()

◆ setTextColor()

◆ setTextColorHover()

◆ setTextColorNormal()