TGUI  0.8-dev
tgui::ProgressBarRenderer Class Reference
Inheritance diagram for tgui::ProgressBarRenderer:
tgui::WidgetRenderer

Public Member Functions

 ProgressBarRenderer ()=default
 Default constructor.
 
 ProgressBarRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. More...
 
void setBorders (const Borders &borders)
 Changes the size of the borders. More...
 
Borders getBorders () const
 Returns the size of the borders. More...
 
void setTextColor (Color color)
 Changes the color of the text that is optionally displayed on top of the progress bar. More...
 
Color getTextColor () const
 Returns the color of the text that is optionally displayed on top of the progress bar. More...
 
void setTextColorFilled (Color color)
 Changes the color of the text that is on top of the filled part of the progress bar. More...
 
Color getTextColorFilled () const
 Returns the color of the text that is on top of the filled part of the progress bar. More...
 
void setBackgroundColor (Color color)
 Changes the background color of the progress bar. More...
 
Color getBackgroundColor () const
 Returns the background color of the progress bar. More...
 
void setFillColor (Color color)
 Changes the fill color of the progress bar. More...
 
Color getFillColor () const
 Returns the fill color of the progress bar. More...
 
void setBorderColor (Color color)
 Changes the border color. More...
 
Color getBorderColor () const
 Returns the border color. More...
 
void setTextureBackground (const Texture &texture)
 Changes the background image of the progress bar. More...
 
TexturegetTextureBackground () const
 Returns the background image. More...
 
void setTextureFill (const Texture &texture)
 Changes the fill image of the progress bar. More...
 
TexturegetTextureFill () const
 Returns the fill image. More...
 
void setTextStyle (TextStyle style)
 Changes the text style. More...
 
TextStyle getTextStyle () const
 Returns text style. 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 ()
 Virtual destructor.
 
void setOpacity (float opacity)
 Changes the opacity of the widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. 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 setProperty (const std::string &property, const std::string &value)
 Changes a property of the renderer. 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 (void *id, const std::function< void(const std::string &property)> &function)
 Subscribes a callback function to changes in the renderer. More...
 
void unsubscribe (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...
 

Constructor & Destructor Documentation

◆ ProgressBarRenderer()

tgui::ProgressBarRenderer::ProgressBarRenderer ( const std::shared_ptr< RendererData > &  data)
inline

Construct the renderer from renderer data.

Parameters
dataRenderer data to initialize the renderer with

Member Function Documentation

◆ getBackgroundColor()

Color tgui::ProgressBarRenderer::getBackgroundColor ( ) const

Returns the background color of the progress bar.

Returns
Background color

◆ getBorderColor()

Color tgui::ProgressBarRenderer::getBorderColor ( ) const

Returns the border color.

Returns
Border color

◆ getBorders()

Borders tgui::ProgressBarRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getFillColor()

Color tgui::ProgressBarRenderer::getFillColor ( ) const

Returns the fill color of the progress bar.

Returns
Fill color

◆ getTextColor()

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

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

◆ getTextStyle()

TextStyle tgui::ProgressBarRenderer::getTextStyle ( ) const

Returns text style.

Returns
Style of the text

◆ getTextureBackground()

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

Returns the background image.

Returns
Background texture

◆ getTextureFill()

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

◆ setTextStyle()

void tgui::ProgressBarRenderer::setTextStyle ( TextStyle  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.


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