TGUI  v0.7.5
tgui::TabRenderer Class Reference
Inheritance diagram for tgui::TabRenderer:
tgui::WidgetRenderer tgui::WidgetBorders

Public Member Functions

 TabRenderer (Tab *tab)
 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 setTextColor (const Color &color)
 Set the text color that will be used inside the tabs. More...
 
void setSelectedTextColor (const Color &color)
 Set the text color that will be used for the selected tab. More...
 
void setDistanceToSide (float distanceToSide)
 Changes the distance between the text and the side of the tab. More...
 
void setBackgroundColor (const Color &color)
 Set the background color of the tabs. More...
 
void setSelectedBackgroundColor (const Color &color)
 Set the background color of the selected tab. More...
 
void setBorderColor (const Color &color)
 Set the color of the borders. More...
 
void setNormalTexture (const Texture &texture)
 Change the image that is displayed when the tab is not selected. More...
 
void setSelectedTexture (const Texture &texture)
 Change the image that is displayed when the tab is selected. 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

◆ TabRenderer()

tgui::TabRenderer::TabRenderer ( Tab tab)
inline

Constructor.

Parameters
tabThe tab that is connected to the renderer

Member Function Documentation

◆ getProperty()

virtual ObjectConverter tgui::TabRenderer::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::TabRenderer::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::TabRenderer::setBackgroundColor ( const Color color)

Set the background color of the tabs.

Parameters
colorThe new background color.

Note that this color is ignored when a normal and selected image were set.

◆ setBorderColor()

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

Set the color of the borders.

Parameters
colorThe new border color.

◆ setDistanceToSide()

void tgui::TabRenderer::setDistanceToSide ( float  distanceToSide)

Changes the distance between the text and the side of the tab.

Parameters
distanceToSidedistance between the text and the side of the tab

◆ setNormalTexture()

void tgui::TabRenderer::setNormalTexture ( const Texture texture)

Change the image that is displayed when the tab is not selected.

Parameters
textureNew normal tab texture

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

◆ setProperty() [1/2]

virtual void tgui::TabRenderer::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.
Exceptionwhen loading scrollbar fails with the theme connected to the list box

Reimplemented from tgui::WidgetRenderer.

◆ setProperty() [2/2]

virtual void tgui::TabRenderer::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.
Exceptionwhen loading scrollbar fails with the theme connected to the list box

Reimplemented from tgui::WidgetRenderer.

◆ setSelectedBackgroundColor()

void tgui::TabRenderer::setSelectedBackgroundColor ( const Color color)

Set the background color of the selected tab.

Parameters
colorThe new background color.

Note that this color is ignored when a normal and selected image were set.

◆ setSelectedTextColor()

void tgui::TabRenderer::setSelectedTextColor ( const Color color)

Set the text color that will be used for the selected tab.

Parameters
colorThe new text color.

◆ setSelectedTexture()

void tgui::TabRenderer::setSelectedTexture ( const Texture texture)

Change the image that is displayed when the tab is selected.

Parameters
textureNew selected tab texture

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

◆ setTextColor()

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

Set the text color that will be used inside the tabs.

Parameters
colorThe new text color.

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