Inheritance diagram for tgui::ListBoxRenderer:

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 list 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	setSelectedTextStyle (TextStyles style)
	Changes the text style of the selected item.

TextStyles	getSelectedTextStyle () const
	Returns text style of the selected item.

void	setBackgroundColor (Color backgroundColor)
	Changes the background color of the list box.

Color	getBackgroundColor () const
	Returns the background color.

void	setBackgroundColorHover (Color backgroundColor)
	Changes the background color used for the item below the mouse.

Color	getBackgroundColorHover () const
	Returns the background color used for the item below the mouse.

void	setSelectedBackgroundColor (Color backgroundColor)
	Changes the background color of the selected item.

Color	getSelectedBackgroundColor () const
	Returns the background color of the selected item.

void	setSelectedBackgroundColorHover (Color backgroundColor)
	Changes the background color used for the selected item when the mouse hovers over it.

Color	getSelectedBackgroundColorHover () const
	Returns the background color used for the selected item when the mouse hovers over it.

void	setTextColor (Color textColor)
	Changes the color of the text.

Color	getTextColor () const
	Returns the color of the text.

void	setTextColorHover (Color textColor)
	Changes the color of the text of the item below the mouse.

Color	getTextColorHover () const
	Returns the color of the text of the item below the mouse.

void	setSelectedTextColor (Color textColor)
	Changes the color of the text from the selected item.

Color	getSelectedTextColor () const
	Returns the color of the text from the selected item.

void	setSelectedTextColorHover (Color textColor)
	Changes the color of the text of the selected item when it is below the mouse.

Color	getSelectedTextColorHover () const
	Returns the color of the text of the selected item when it is below the mouse.

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 list box.

const Texture &	getTextureBackground () const
	Returns the background image of the list box.

void	setScrollbar (std::shared_ptr< RendererData > scrollbarRendererData)
	Sets the renderer data of the scrollbar.

std::shared_ptr< RendererData >	getScrollbar () const
	Returns the renderer data of the scrollbar.

void	setScrollbarWidth (float scrollbarWidth)
	Sets the wanted width of the scrollbar.

float	getScrollbarWidth () const
	Returns the wanted width of the scrollbar.

	WidgetRenderer ()=default
	Default constructor.

	WidgetRenderer (const WidgetRenderer &)
	Copy constructor.

	WidgetRenderer (WidgetRenderer &&)=default
	Default move 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 WidgetRenderer &)
	Copy constructor.

	WidgetRenderer (WidgetRenderer &&)=default
	Default move constructor.

WidgetRenderer &	operator= (const WidgetRenderer &)
	Copy assignment operator.

WidgetRenderer &	operator= (WidgetRenderer &&)=default
	Default move assignment operator.

	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 (const 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	setTextSize (unsigned int size)
	Changes the text size of the widget that is specified by the renderer.

unsigned int	getTextSize () const
	Returns text size of the widget that is specified by the renderer.

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 (Widget *widget)
	Subscribes a callback function to changes in the renderer.

void	unsubscribe (Widget *widget)
	Subscribes a callback function to changes in the renderer.

void	setData (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

◆ getBackgroundColor()

Color tgui::ListBoxRenderer::getBackgroundColor ( ) const

nodiscard

Returns the background color.

Returns: Background color

◆ getBackgroundColorHover()

Color tgui::ListBoxRenderer::getBackgroundColorHover ( ) const

nodiscard

Returns the background color used for the item below the mouse.

Returns: Background color of hovered item

◆ getBorderColor()

Color tgui::ListBoxRenderer::getBorderColor ( ) const

nodiscard

Returns the color of the borders.

Returns: Border color

◆ getBorders()

Borders tgui::ListBoxRenderer::getBorders ( ) const

nodiscard

Returns the size of the borders.

Returns: border size

◆ getPadding()

Padding tgui::ListBoxRenderer::getPadding ( ) const

nodiscard

Returns the size of the padding.

Returns: padding size

◆ getScrollbar()

std::shared_ptr< RendererData > tgui::ListBoxRenderer::getScrollbar ( ) const

nodiscard

Returns the renderer data of the scrollbar.

Returns: Data about how the scrollbar looks

◆ getScrollbarWidth()

float tgui::ListBoxRenderer::getScrollbarWidth ( ) const

nodiscard

Returns the wanted width of the scrollbar.

Returns: Requested scrollbar width or 0 if no width was set (texture width or default value will be used)

◆ getSelectedBackgroundColor()

Color tgui::ListBoxRenderer::getSelectedBackgroundColor ( ) const

nodiscard

Returns the background color of the selected item.

Returns: Selected item background color

◆ getSelectedBackgroundColorHover()

Color tgui::ListBoxRenderer::getSelectedBackgroundColorHover ( ) const

nodiscard

Returns the background color used for the selected item when the mouse hovers over it.

Returns: Background color of selected item in hover state

◆ getSelectedTextColor()

Color tgui::ListBoxRenderer::getSelectedTextColor ( ) const

nodiscard

Returns the color of the text from the selected item.

Returns: Selected text color

◆ getSelectedTextColorHover()

Color tgui::ListBoxRenderer::getSelectedTextColorHover ( ) const

nodiscard

Returns the color of the text of the selected item when it is below the mouse.

Returns: Hover text color

◆ getSelectedTextStyle()

TextStyles tgui::ListBoxRenderer::getSelectedTextStyle ( ) const

nodiscard

Returns text style of the selected item.

Returns: Style of the text

◆ getTextColor()

Color tgui::ListBoxRenderer::getTextColor ( ) const

nodiscard

Returns the color of the text.

Returns: Text color

◆ getTextColorHover()

Color tgui::ListBoxRenderer::getTextColorHover ( ) const

nodiscard

Returns the color of the text of the item below the mouse.

Returns: Hover text color

◆ getTextStyle()

TextStyles tgui::ListBoxRenderer::getTextStyle ( ) const

nodiscard

Returns text style.

Returns: Style of the text

◆ getTextureBackground()

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

nodiscard

Returns the background image of the list box.

Returns: Background texture

◆ setBackgroundColor()

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

Changes the background color of the list box.

Parameters

backgroundColor The new background color

◆ setBackgroundColorHover()

void tgui::ListBoxRenderer::setBackgroundColorHover ( Color backgroundColor )

Changes the background color used for the item below the mouse.

Parameters

backgroundColor The new hover background color

◆ setBorderColor()

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

Changes the color of the borders.

Parameters

borderColor The new border color

◆ setBorders()

void tgui::ListBoxRenderer::setBorders ( const Borders & borders )

Changes the size of the borders.

Parameters

borders Size of the borders

◆ setPadding()

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

Changes the padding of the list box.

Parameters

padding The padding width and height

◆ setScrollbar()

void tgui::ListBoxRenderer::setScrollbar ( std::shared_ptr< RendererData > scrollbarRendererData )

Sets the renderer data of the scrollbar.

Parameters

scrollbarRendererData Data about how the scrollbar should look

◆ setScrollbarWidth()

void tgui::ListBoxRenderer::setScrollbarWidth ( float scrollbarWidth )

Sets the wanted width of the scrollbar.

Parameters

scrollbarWidth Requested scrollbar width or 0 to use the default width (texture size if using textures)

◆ setSelectedBackgroundColor()

void tgui::ListBoxRenderer::setSelectedBackgroundColor ( Color backgroundColor )

Changes the background color of the selected item.

Parameters

backgroundColor The new selected item background color

◆ setSelectedBackgroundColorHover()

void tgui::ListBoxRenderer::setSelectedBackgroundColorHover ( Color backgroundColor )

Changes the background color used for the selected item when the mouse hovers over it.

Parameters

backgroundColor The new selected hover background color

◆ setSelectedTextColor()

void tgui::ListBoxRenderer::setSelectedTextColor ( Color textColor )

Changes the color of the text from the selected item.

Parameters

textColor The new selected text color

◆ setSelectedTextColorHover()

void tgui::ListBoxRenderer::setSelectedTextColorHover ( Color textColor )

Changes the color of the text of the selected item when it is below the mouse.

Parameters

textColor The new hover text color

◆ setSelectedTextStyle()

void tgui::ListBoxRenderer::setSelectedTextStyle ( TextStyles style )

Changes the text style of the selected item.

Parameters

style New text style

◆ setTextColor()

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

Changes the color of the text.

Parameters

textColor The new text color

◆ setTextColorHover()

void tgui::ListBoxRenderer::setTextColorHover ( Color textColor )

Changes the color of the text of the item below the mouse.

Parameters

textColor The new hover text color

◆ setTextStyle()

void tgui::ListBoxRenderer::setTextStyle ( TextStyles style )

Changes the text style.

Parameters

style New text style

◆ setTextureBackground()

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

Changes the background image of the list box.

Parameters

texture The background texture

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

◆ 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/ListBoxRenderer.hpp

TGUI

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ getBackgroundColor()

◆ getBackgroundColorHover()

◆ getBorderColor()

◆ getBorders()

◆ getPadding()

◆ getScrollbar()

◆ getScrollbarWidth()

◆ getSelectedBackgroundColor()

◆ getSelectedBackgroundColorHover()

◆ getSelectedTextColor()

◆ getSelectedTextColorHover()

◆ getSelectedTextStyle()

◆ getTextColor()

◆ getTextColorHover()

◆ getTextStyle()

◆ getTextureBackground()

◆ setBackgroundColor()

◆ setBackgroundColorHover()

◆ setBorderColor()

◆ setBorders()

◆ setPadding()

◆ setScrollbar()

◆ setScrollbarWidth()

◆ setSelectedBackgroundColor()

◆ setSelectedBackgroundColorHover()

◆ setSelectedTextColor()

◆ setSelectedTextColorHover()

◆ setSelectedTextStyle()

◆ setTextColor()

◆ setTextColorHover()

◆ setTextStyle()

◆ setTextureBackground()

◆ WidgetRenderer()