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

Public Member Functions

 TabsRenderer ()=default
 Default constructor.
 
 TabsRenderer (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 setBackgroundColor (Color backgroundColor)
 Changes the background color of the tabs. More...
 
Color getBackgroundColor () const
 Returns the background color of the tabs. More...
 
void setSelectedBackgroundColor (Color backgroundColor)
 Changes the background color of the selected tab. More...
 
Color getSelectedBackgroundColor () const
 Returns the background color of the selected tab. More...
 
void setTextColor (Color textColor)
 Changes the color of the text. More...
 
Color getTextColor () const
 Returns the color of the text. More...
 
void setSelectedTextColor (Color textColor)
 Changes the color of the text from the selected tab. More...
 
Color getSelectedTextColor () const
 Returns the color of the text from the selected tab. More...
 
void setBorderColor (Color color)
 Sets the color of the borders. More...
 
Color getBorderColor () const
 Returns the color of the borders. More...
 
void setTextureTab (const Texture &texture)
 Change the image of a tab. More...
 
TexturegetTextureTab () const
 Returns the image of a tab. More...
 
void setTextureSelectedTab (const Texture &texture)
 Change the image of a selected tab. More...
 
TexturegetTextureSelectedTab () const
 Returns the image of a selected tab. More...
 
void setDistanceToSide (float distanceToSide)
 Changes the distance between the text and the side of the tab. More...
 
float getDistanceToSide () const
 Returns the distance between the text and the side of the tab. More...
 
- Public Member Functions inherited from tgui::WidgetRenderer
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (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

§ TabsRenderer()

tgui::TabsRenderer::TabsRenderer ( 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::TabsRenderer::getBackgroundColor ( ) const

Returns the background color of the tabs.

Returns
Background color

§ getBorderColor()

Color tgui::TabsRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
border color

§ getBorders()

Borders tgui::TabsRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

§ getDistanceToSide()

float tgui::TabsRenderer::getDistanceToSide ( ) const

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

Returns
Distance between the text and the side of the tab

§ getSelectedBackgroundColor()

Color tgui::TabsRenderer::getSelectedBackgroundColor ( ) const

Returns the background color of the selected tab.

Returns
Selected tab background color

§ getSelectedTextColor()

Color tgui::TabsRenderer::getSelectedTextColor ( ) const

Returns the color of the text from the selected tab.

Returns
Selected tab text color

§ getTextColor()

Color tgui::TabsRenderer::getTextColor ( ) const

Returns the color of the text.

Returns
Text color

§ getTextureSelectedTab()

Texture& tgui::TabsRenderer::getTextureSelectedTab ( ) const

Returns the image of a selected tab.

Returns
selected tab texture

§ getTextureTab()

Texture& tgui::TabsRenderer::getTextureTab ( ) const

Returns the image of a tab.

Returns
tab texture

§ setBackgroundColor()

void tgui::TabsRenderer::setBackgroundColor ( Color  backgroundColor)

Changes the background color of the tabs.

Parameters
backgroundColorThe new background color

Note that this color is ignored when the tab and selected tab image were set.

§ setBorderColor()

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

Sets the color of the borders.

Parameters
colorThe new border color

§ setBorders()

void tgui::TabsRenderer::setBorders ( const Borders borders)

Changes the size of the borders.

Parameters
bordersSize of the borders

§ setDistanceToSide()

void tgui::TabsRenderer::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

§ setSelectedBackgroundColor()

void tgui::TabsRenderer::setSelectedBackgroundColor ( Color  backgroundColor)

Changes the background color of the selected tab.

Parameters
backgroundColorThe new selected tab background color

§ setSelectedTextColor()

void tgui::TabsRenderer::setSelectedTextColor ( Color  textColor)

Changes the color of the text from the selected tab.

Parameters
textColorThe new selected tab text color

§ setTextColor()

void tgui::TabsRenderer::setTextColor ( Color  textColor)

Changes the color of the text.

Parameters
textColorThe new text color

§ setTextureSelectedTab()

void tgui::TabsRenderer::setTextureSelectedTab ( const Texture texture)

Change the image of a selected tab.

Parameters
textureThe new selected tab texture

When this image and the tab image are set then the background color properties will be ignored.

§ setTextureTab()

void tgui::TabsRenderer::setTextureTab ( const Texture texture)

Change the image of a tab.

Parameters
textureThe new tab texture

When this image and the selected tab image are set then the background color properties will be ignored.


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