TGUI  1.2.0
Loading...
Searching...
No Matches
tgui::ProgressBarRenderer Class Reference
Inheritance diagram for tgui::ProgressBarRenderer:
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 setTextColor (Color color)
 Changes the color of the text that is optionally displayed on top of the progress bar.
 
TGUI_NODISCARD Color getTextColor () const
 Returns the color of the text that is optionally displayed on top of the progress bar.
 
void setTextColorFilled (Color color)
 Changes the color of the text that is on top of the filled part of the progress bar.
 
TGUI_NODISCARD Color getTextColorFilled () const
 Returns the color of the text that is on top of the filled part of the progress bar.
 
void setBackgroundColor (Color color)
 Changes the background color of the progress bar.
 
TGUI_NODISCARD Color getBackgroundColor () const
 Returns the background color of the progress bar.
 
void setFillColor (Color color)
 Changes the fill color of the progress bar.
 
TGUI_NODISCARD Color getFillColor () const
 Returns the fill color of the progress bar.
 
void setBorderColor (Color color)
 Changes the border color.
 
TGUI_NODISCARD Color getBorderColor () const
 Returns the border color.
 
void setTextureBackground (const Texture &texture)
 Changes the background image of the progress bar.
 
TGUI_NODISCARD const TexturegetTextureBackground () const
 Returns the background image.
 
void setTextureFill (const Texture &texture)
 Changes the fill image of the progress bar.
 
TGUI_NODISCARD const TexturegetTextureFill () const
 Returns the fill image.
 
void setTextStyle (TextStyles style)
 Changes the text style.
 
TGUI_NODISCARD TextStyles getTextStyle () const
 Returns text style.
 
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.
 
 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 (const 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::ProgressBarRenderer::getBackgroundColor ( ) const

Returns the background color of the progress bar.

Returns
Background color

◆ getBorderColor()

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

Returns the border color.

Returns
Border color

◆ getBorders()

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

Returns the size of the borders.

Returns
border size

◆ getFillColor()

TGUI_NODISCARD Color tgui::ProgressBarRenderer::getFillColor ( ) const

Returns the fill color of the progress bar.

Returns
Fill color

◆ getTextColor()

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

Returns the color of the text that is optionally displayed on top of the progress bar.

Returns
Text color

◆ getTextColorFilled()

TGUI_NODISCARD Color tgui::ProgressBarRenderer::getTextColorFilled ( ) const

Returns the color of the text that is on top of the filled part of the progress bar.

Returns
Text color that is displayed on top of the filled part

◆ getTextOutlineColor()

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

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

Returns
Text outline color
Since
TGUI 1.1

◆ getTextOutlineThickness()

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

Returns the thickness of the text outline.

Returns
Text outline thickness
Since
TGUI 1.1

◆ getTextStyle()

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

Returns text style.

Returns
Style of the text

◆ getTextureBackground()

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

Returns the background image.

Returns
Background texture

◆ getTextureFill()

TGUI_NODISCARD const Texture & tgui::ProgressBarRenderer::getTextureFill ( ) const

Returns the fill image.

Returns
Fill texture

◆ setBackgroundColor()

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

Changes the background color of the progress bar.

Parameters
colorThe new background color

This is the color that you see in the part of the progress bar that is not filled.

Note that this color is ignored when you set a background image.

◆ setBorderColor()

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

Changes the border color.

Parameters
colorThe color that is used for the borders that are optionally drawn around the progress bar

◆ setBorders()

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

Changes the size of the borders.

Parameters
bordersSize of the borders

◆ setFillColor()

void tgui::ProgressBarRenderer::setFillColor ( Color color)

Changes the fill color of the progress bar.

Parameters
colorThe new fill color

This is the color that is used to fill the progress bar and is drawn on top of the background color.

Note that this color is ignored when you set an fill image.

◆ setTextColor()

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

Changes the color of the text that is optionally displayed on top of the progress bar.

Parameters
colorThe new text color

◆ setTextColorFilled()

void tgui::ProgressBarRenderer::setTextColorFilled ( Color color)

Changes the color of the text that is on top of the filled part of the progress bar.

Parameters
colorThe new text color that is displayed on top of the filled part

◆ setTextOutlineColor()

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

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

Parameters
outlineColorNew text outline color
Since
TGUI 1.1

◆ setTextOutlineThickness()

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

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

Parameters
outlineThicknessNew text outline thickness
Since
TGUI 1.1

◆ setTextStyle()

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

Changes the text style.

Parameters
styleNew text style

◆ setTextureBackground()

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

Changes the background image of the progress bar.

Parameters
textureThe new background texture

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

◆ setTextureFill()

void tgui::ProgressBarRenderer::setTextureFill ( const Texture & texture)

Changes the fill image of the progress bar.

Parameters
textureThe new fill texture

When this image is set then the fill 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: