TGUI  0.7.4
tgui::ProgressBarRenderer Class Reference
Inheritance diagram for tgui::ProgressBarRenderer:
tgui::WidgetRenderer tgui::WidgetBorders

Public Member Functions

 ProgressBarRenderer (ProgressBar *progressBar)
 Constructor. More...
 
virtual void setProperty (std::string property, const std::string &value) override
 Change a property of the renderer. More...
 
virtual void setProperty (std::string property, ObjectConverter &&value) override
 Change a property of the renderer. More...
 
virtual ObjectConverter getProperty (std::string property) const override
 Retrieve the value of a certain property. More...
 
virtual std::map< std::string, ObjectConvertergetPropertyValuePairs () const override
 Get a map with all properties and their values. More...
 
void setTextFont (std::shared_ptr< sf::Font > font)
 Changes the font of the text. More...
 
void setTextColor (const Color &color)
 Changes the color of the text that is optionally displayed on top of the progress bar. More...
 
void setTextColorBack (const Color &color)
 Changes the color of the text that is optionally displayed on top of the progress bar. More...
 
void setTextColorFront (const Color &color)
 Changes the color of the text that is optionally displayed on top of the progress bar. More...
 
void setBackgroundColor (const Color &color)
 Changes the background color of the progress bar. More...
 
void setForegroundColor (const Color &color)
 Changes the foreground color of the progress bar. More...
 
void setBorderColor (const Color &color)
 Changes the border color. More...
 
void setBackTexture (const Texture &texture)
 Change the background image of the progress bar. More...
 
void setFrontTexture (const Texture &texture)
 Change the foreground image of the progress bar. More...
 
- Public Member Functions inherited from tgui::WidgetRenderer
virtual ~WidgetRenderer ()
 Virtual destructor.
 
- Public Member Functions inherited from tgui::WidgetBorders
virtual void setBorders (const Borders &borders)
 Changes the size of the borders. More...
 
void setBorders (float leftBorder, float topBorder, float rightBorder, float bottomBorder)
 Changes the size of the borders. More...
 
void setBorders (float width, float height)
 Changes the size of the borders. More...
 
virtual Borders getBorders () const
 Returns the size of the borders as a tgui::Borders. More...
 

Constructor & Destructor Documentation

◆ ProgressBarRenderer()

tgui::ProgressBarRenderer::ProgressBarRenderer ( ProgressBar progressBar)
inline

Constructor.

Parameters
progressBarThe progress bar that is connected to the renderer

Member Function Documentation

◆ getProperty()

virtual ObjectConverter tgui::ProgressBarRenderer::getProperty ( std::string  property) const
overridevirtual

Retrieve the value of a certain property.

Parameters
propertyThe property that you would like to retrieve
Returns
The value inside a ObjectConverter object which you can extract with the correct get function or an ObjectConverter object with type ObjectConverter::Type::None when the property did not exist.

Reimplemented from tgui::WidgetRenderer.

◆ getPropertyValuePairs()

virtual std::map<std::string, ObjectConverter> tgui::ProgressBarRenderer::getPropertyValuePairs ( ) const
overridevirtual

Get a map with all properties and their values.

Returns
Property-value pairs of the renderer

Reimplemented from tgui::WidgetRenderer.

◆ setBackgroundColor()

void tgui::ProgressBarRenderer::setBackgroundColor ( const 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 an image as background.

◆ setBackTexture()

void tgui::ProgressBarRenderer::setBackTexture ( const Texture texture)

Change the background image of the progress bar.

Parameters
textureThe new background texture

When this image and the front image are set, the background and foreground color properties will be ignored. Pass an empty string to unset the image, in this case the color properties will be used again.

◆ setBorderColor()

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

Changes the border color.

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

◆ setForegroundColor()

void tgui::ProgressBarRenderer::setForegroundColor ( const Color color)

Changes the foreground color of the progress bar.

Parameters
colorThe new foreground 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 image as foreground.

◆ setFrontTexture()

void tgui::ProgressBarRenderer::setFrontTexture ( const Texture texture)

Change the foreground image of the progress bar.

Parameters
textureThe new foreground texture

When this image and the back image are set, the background and foreground color properties will be ignored. Pass an empty string to unset the image, in this case the color properties will be used again.

◆ setProperty() [1/2]

virtual void tgui::ProgressBarRenderer::setProperty ( std::string  property,
const std::string &  value 
)
overridevirtual

Change a property of the renderer.

Parameters
propertyThe property that you would like to change
valueThe new serialized value that you like to assign to the property
Exceptions
Exceptionwhen deserialization fails or when the widget does not have this property.

Reimplemented from tgui::WidgetRenderer.

◆ setProperty() [2/2]

virtual void tgui::ProgressBarRenderer::setProperty ( std::string  property,
ObjectConverter &&  value 
)
overridevirtual

Change a property of the renderer.

Parameters
propertyThe property that you would like to change
valueThe new value that you like to assign to the property. The ObjectConverter is implicitly constructed from the possible value types.
Exceptions
Exceptionfor unknown properties or when value was of a wrong type.

Reimplemented from tgui::WidgetRenderer.

◆ setTextColor()

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

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

Parameters
colorThe new text color

This changes both the back and front text colors.

See also
setTextColorBack
setTextColorFront

◆ setTextColorBack()

void tgui::ProgressBarRenderer::setTextColorBack ( const Color color)

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

Parameters
colorThe new text color that is displayed on top of the background color/image.

This color is displayed on top of the unfilled part. The front text color will be used on top of the filled part.

◆ setTextColorFront()

void tgui::ProgressBarRenderer::setTextColorFront ( const Color color)

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

Parameters
colorThe new text color that is displayed on top of the foreground color/image.

This color is displayed on top of the filled part. The back text color will be used on top of the unfilled part.

◆ setTextFont()

void tgui::ProgressBarRenderer::setTextFont ( std::shared_ptr< sf::Font >  font)

Changes the font of the text.

When you don't call this function then the global font will be use. This global font can be changed with the setGlobalFont function from the parent.

Parameters
fontThe new font

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