TGUI  1.5
Loading...
Searching...
No Matches
tgui::LabelRenderer Class Reference
Inheritance diagram for tgui::LabelRenderer:
tgui::WidgetRenderer

Public Member Functions

void setBorders (const Borders &borders)
 Changes the size of the borders.
 
TGUI_NODISCARD Borders getBorders () const
 Returns the size of the borders.
 
void setPadding (const Padding &padding)
 Changes the size of the padding.
 
TGUI_NODISCARD Padding getPadding () const
 Returns the size of the padding.
 
void setTextColor (Color color)
 Changes the color of the text.
 
TGUI_NODISCARD Color getTextColor () const
 Returns the color of the text.
 
void setBackgroundColor (Color color)
 Changes the background color of the label.
 
TGUI_NODISCARD Color getBackgroundColor () const
 Returns the background color of the label.
 
void setBorderColor (Color color)
 Changes the color of the borders.
 
TGUI_NODISCARD Color getBorderColor () const
 Returns the color of the borders.
 
void setTextStyle (TextStyles style)
 Changes the style of the text.
 
TGUI_NODISCARD TextStyles getTextStyle () const
 Returns the style of the text.
 
void setTextOutlineColor (Color outlineColor)
 Changes the outline color of the text (used when TextOutlineThickness > 0)
 
TGUI_NODISCARD 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).
 
TGUI_NODISCARD float getTextOutlineThickness () const
 Returns the thickness of the text outline.
 
void setTextureBackground (const Texture &texture)
 Changes the background image of the label.
 
TGUI_NODISCARD const TexturegetTextureBackground () const
 Returns the background image of the label.
 
void setScrollbar (std::shared_ptr< RendererData > scrollbarRendererData)
 Sets the renderer data of the scrollbars.
 
TGUI_NODISCARD std::shared_ptr< RendererDatagetScrollbar () const
 Returns the renderer data of the scrollbars.
 
void setScrollbarWidth (float scrollbarWidth)
 Sets the wanted width of the scrollbar.
 
TGUI_NODISCARD 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.
 
WidgetRendereroperator= (const WidgetRenderer &)
 Copy assignment operator.
 
WidgetRendereroperator= (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.
 
TGUI_NODISCARD float getOpacity () const
 Returns the opacity of the widget.
 
void setOpacityDisabled (float opacity)
 Changes the opacity of the widget when it is disabled.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD ObjectConverter getProperty (const String &property) const
 Retrieves the value of a certain property.
 
TGUI_NODISCARD 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)
 
TGUI_NODISCARD std::shared_ptr< RendererDatagetData () const
 Returns the renderer data.
 
TGUI_NODISCARD std::shared_ptr< RendererDataclone () const
 Gets a clone of the renderer data.
 

Additional Inherited Members

- Protected Attributes inherited from tgui::WidgetRenderer
std::shared_ptr< RendererDatam_data = RendererData::create()
 

Member Function Documentation

◆ getBackgroundColor()

TGUI_NODISCARD Color tgui::LabelRenderer::getBackgroundColor ( ) const

Returns the background color of the label.

Returns
background color

◆ getBorderColor()

TGUI_NODISCARD Color tgui::LabelRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

◆ getBorders()

TGUI_NODISCARD Borders tgui::LabelRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getPadding()

TGUI_NODISCARD Padding tgui::LabelRenderer::getPadding ( ) const

Returns the size of the padding.

Returns
padding size

◆ getScrollbar()

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

Returns the renderer data of the scrollbars.

Returns
Data about how the scrollbars looks

◆ getScrollbarWidth()

TGUI_NODISCARD float tgui::LabelRenderer::getScrollbarWidth ( ) const

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

TGUI_NODISCARD Color tgui::LabelRenderer::getTextColor ( ) const

Returns the color of the text.

Returns
text color

◆ getTextOutlineColor()

TGUI_NODISCARD Color tgui::LabelRenderer::getTextOutlineColor ( ) const

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

Returns
Text outline color

◆ getTextOutlineThickness()

TGUI_NODISCARD float tgui::LabelRenderer::getTextOutlineThickness ( ) const

Returns the thickness of the text outline.

Returns
Text outline thickness

◆ getTextStyle()

TGUI_NODISCARD TextStyles tgui::LabelRenderer::getTextStyle ( ) const

Returns the style of the text.

Returns
The current text style

◆ getTextureBackground()

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

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
colorNew 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
colorNew border color

◆ setBorders()

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

Changes the size of the borders.

Parameters
bordersSize of the borders

◆ setPadding()

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

Changes the size of the padding.

Parameters
paddingSize 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
scrollbarRendererDataData about how the scrollbars should look

◆ setScrollbarWidth()

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

Sets the wanted width of the scrollbar.

Parameters
scrollbarWidthRequested 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
colorNew text color

◆ setTextOutlineColor()

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

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

Parameters
outlineColorNew 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
outlineThicknessNew 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
styleNew text style

◆ setTextureBackground()

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

Changes the background image of the label.

Parameters
textureThe 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
dataRenderer data to initialize the renderer with

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