TGUI  0.8.6
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. More...
 
Borders getBorders () const
 Returns the size of the borders. More...
 
void setPadding (const Padding &padding)
 Changes the size of the padding. More...
 
Padding getPadding () const
 Returns the size of the padding. More...
 
void setTextColor (Color color)
 Changes the color of the text. More...
 
Color getTextColor () const
 Returns the color of the text. More...
 
void setBackgroundColor (Color color)
 Changes the background color of the label. More...
 
Color getBackgroundColor () const
 Returns the background color of the label. More...
 
void setBorderColor (Color color)
 Changes the color of the borders. More...
 
Color getBorderColor () const
 Returns the color of the borders. More...
 
void setTextStyle (TextStyle style)
 Changes the style of the text. More...
 
TextStyle getTextStyle () const
 Returns the style of the text. More...
 
void setTextOutlineColor (Color outlineColor)
 Changes the outline color of the text (used when TextOutlineThickness > 0) More...
 
Color getTextOutlineColor () const
 Returns the outline color of the text (used when TextOutlineThickness > 0) More...
 
void setTextOutlineThickness (float outlineThickness)
 Changes the thickness of the text outline (0 by default, which means there is no outline). More...
 
float getTextOutlineThickness () const
 Returns the thickness of the text outline. More...
 
void setTextureBackground (const Texture &texture)
 Changes the background image of the label. More...
 
TexturegetTextureBackground () const
 Returns the background image of the label. More...
 
void setScrollbar (std::shared_ptr< RendererData > scrollbarRendererData)
 Sets the renderer data of the scrollbars. More...
 
std::shared_ptr< RendererDatagetScrollbar () const
 Returns the renderer data of the scrollbars. More...
 
void setScrollbarWidth (float scrollbarWidth)
 Sets the wanted width of the scrollbar. More...
 
float getScrollbarWidth () const
 Returns the wanted width of the scrollbar. More...
 
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. More...
 
- Public Member Functions inherited from tgui::WidgetRenderer
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. More...
 
virtual ~WidgetRenderer ()=default
 Virtual destructor. More...
 
void setOpacity (float opacity)
 Changes the opacity of the widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
void setOpacityDisabled (float opacity)
 Changes the opacity of the widget when it is disabled. More...
 
float getOpacityDisabled () const
 Returns the opacity of the widget when it is disabled. More...
 
void setFont (Font font)
 Changes the font used for the text in the widget. More...
 
Font getFont () const
 Returns the font associated with the widget (if any) More...
 
void setTransparentTexture (bool ignoreTransparentParts)
 Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state. More...
 
bool getTransparentTexture () const
 Returns whether mouse events should be ignored on transparent parts of the texture of the widget. More...
 
void setProperty (const std::string &property, ObjectConverter &&value)
 Changes a property of the renderer. More...
 
ObjectConverter getProperty (const std::string &property) const
 Retrieves the value of a certain property. More...
 
const std::map< std::string, ObjectConverter > & getPropertyValuePairs () const
 Gets a map with all properties and their values. More...
 
void subscribe (const void *id, const std::function< void(const std::string &property)> &function)
 Subscribes a callback function to changes in the renderer. More...
 
void unsubscribe (const void *id)
 Subscribes a callback function to changes in the renderer. More...
 
std::shared_ptr< RendererDatagetData () const
 Returns the renderer data. More...
 
std::shared_ptr< RendererDataclone () const
 Gets a clone of the renderer data. More...
 

Member Function Documentation

◆ getBackgroundColor()

Color tgui::LabelRenderer::getBackgroundColor ( ) const

Returns the background color of the label.

Returns
background color

◆ getBorderColor()

Color tgui::LabelRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

◆ getBorders()

Borders tgui::LabelRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getPadding()

Padding tgui::LabelRenderer::getPadding ( ) const

Returns the size of the padding.

Returns
padding size

◆ getScrollbar()

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

Returns the renderer data of the scrollbars.

Returns
Data about how the scrollbars looks

◆ getScrollbarWidth()

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

Color tgui::LabelRenderer::getTextColor ( ) const

Returns the color of the text.

Returns
text color

◆ getTextOutlineColor()

Color tgui::LabelRenderer::getTextOutlineColor ( ) const

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

Parameters
Textoutline color

◆ getTextOutlineThickness()

float tgui::LabelRenderer::getTextOutlineThickness ( ) const

Returns the thickness of the text outline.

Parameters
Textoutline thickness

◆ getTextStyle()

TextStyle tgui::LabelRenderer::getTextStyle ( ) const

Returns the style of the text.

Returns
The current text style

◆ getTextureBackground()

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

Changes the style of the text.

The possible styles can be found in the sf::Text::Style enum. You can also pass a combination of multiple styles, for example sf::Text::Bold | sf::Text::Italic. The default style is sf::Text::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
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: