Inheritance diagram for tgui::LabelRenderer:

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 size of the padding.

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

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

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

void	setBackgroundColor (Color color)
	Changes the background color of the label.

Color	getBackgroundColor () const
	Returns the background color of the label.

void	setBorderColor (Color color)
	Changes the color of the borders.

Color	getBorderColor () const
	Returns the color of the borders.

void	setTextStyle (TextStyles style)
	Changes the style of the text.

TextStyles	getTextStyle () const
	Returns the style of the text.

void	setTextOutlineColor (Color outlineColor)
	Changes the outline color of the text (used when TextOutlineThickness > 0)

Color	getTextOutlineColor () const
	Returns the outline color of the text (used when TextOutlineThickness > 0)

void	setTextOutlineThickness (float outlineThickness)
	Changes the thickness of the text outline (0 by default, which means there is no outline).

float	getTextOutlineThickness () const
	Returns the thickness of the text outline.

void	setTextureBackground (const Texture &texture)
	Changes the background image of the label.

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

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

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

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::LabelRenderer::getBackgroundColor ( ) const

nodiscard

Returns the background color of the label.

Returns: background color

◆ getBorderColor()

Color tgui::LabelRenderer::getBorderColor ( ) const

nodiscard

Returns the color of the borders.

Returns: Border color

◆ getBorders()

Borders tgui::LabelRenderer::getBorders ( ) const

nodiscard

Returns the size of the borders.

Returns: border size

◆ getPadding()

Padding tgui::LabelRenderer::getPadding ( ) const

nodiscard

Returns the size of the padding.

Returns: padding size

◆ getScrollbar()

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

nodiscard

Returns the renderer data of the scrollbars.

Returns: Data about how the scrollbars looks

◆ getScrollbarWidth()

float tgui::LabelRenderer::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)

◆ getTextColor()

Color tgui::LabelRenderer::getTextColor ( ) const

nodiscard

Returns the color of the text.

Returns: text color

◆ getTextOutlineColor()

Color tgui::LabelRenderer::getTextOutlineColor ( ) const

nodiscard

Returns the outline color of the text (used when TextOutlineThickness > 0)

Returns: Text outline color

◆ getTextOutlineThickness()

float tgui::LabelRenderer::getTextOutlineThickness ( ) const

nodiscard

Returns the thickness of the text outline.

Returns: Text outline thickness

◆ getTextStyle()

TextStyles tgui::LabelRenderer::getTextStyle ( ) const

nodiscard

Returns the style of the text.

Returns: The current text style

◆ getTextureBackground()

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

nodiscard

Returns the background image of the label.

Returns: Background texture

◆ setBackgroundColor()

void tgui::LabelRenderer::setBackgroundColor ( Color color )

Changes the background color of the label.

Parameters

color New background color

The background color is transparent by default.

When auto-size is enabled (default), then the background is just as big as the text. When a manual size is set, the background will fill this whole area.

◆ setBorderColor()

void tgui::LabelRenderer::setBorderColor ( Color color )

Changes the color of the borders.

Parameters

color New border color

◆ setBorders()

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

Changes the size of the borders.

Parameters

borders Size of the borders

◆ setPadding()

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

Changes the size of the padding.

Parameters

padding Size of the padding

The padding is the distance between the side of the background and the text.

◆ setScrollbar()

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

Sets the renderer data of the scrollbars.

Parameters

scrollbarRendererData Data about how the scrollbars should look

◆ setScrollbarWidth()

void tgui::LabelRenderer::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)

◆ setTextColor()

void tgui::LabelRenderer::setTextColor ( Color color )

Changes the color of the text.

Parameters

color New text color

◆ setTextOutlineColor()

void tgui::LabelRenderer::setTextOutlineColor ( Color outlineColor )

Changes the outline color of the text (used when TextOutlineThickness > 0)

Parameters

outlineColor New text outline color

◆ setTextOutlineThickness()

void tgui::LabelRenderer::setTextOutlineThickness ( float outlineThickness )

Changes the thickness of the text outline (0 by default, which means there is no outline).

Parameters

outlineThickness New text outline thickness

◆ setTextStyle()

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

Changes the style of the text.

The possible styles can be found in the tgui::TextStyles enum. You can also pass a combination of multiple styles, for example tgui::TextStyle::Bold | tgui::TextStyle::Italic. The default style is tgui::TextStyle::Regular.

Parameters

style New text style

◆ setTextureBackground()

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

Changes the background image of the label.

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/LabelRenderer.hpp

TGUI

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ getBackgroundColor()

◆ getBorderColor()

◆ getBorders()

◆ getPadding()

◆ getScrollbar()

◆ getScrollbarWidth()

◆ getTextColor()

◆ getTextOutlineColor()

◆ getTextOutlineThickness()

◆ getTextStyle()

◆ getTextureBackground()

◆ setBackgroundColor()

◆ setBorderColor()

◆ setBorders()

◆ setPadding()

◆ setScrollbar()

◆ setScrollbarWidth()

◆ setTextColor()

◆ setTextOutlineColor()

◆ setTextOutlineThickness()

◆ setTextStyle()

◆ setTextureBackground()

◆ WidgetRenderer()