TGUI  0.8.0
tgui::TabsRenderer Class Reference
Inheritance diagram for tgui::TabsRenderer:
tgui::WidgetRenderer

Public Member Functions

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 setBackgroundColorHover (Color backgroundColor)
 Changes the background color of the tab below the mouse. More...
 
Color getBackgroundColorHover () const
 Returns the background color of the tab below the mouse. More...
 
void setBackgroundColorDisabled (Color backgroundColor)
 Changes the background color of a disabled tab. More...
 
Color getBackgroundColorDisabled () const
 Returns the background color of a disabled tab. 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 setSelectedBackgroundColorHover (Color backgroundColor)
 Changes the background color of the selected tab when the mouse is on top of it. More...
 
Color getSelectedBackgroundColorHover () const
 Returns the background color of the selected tab when the mouse is on top of it. More...
 
void setTextColor (Color textColor)
 Changes the color of the text. More...
 
Color getTextColor () const
 Returns the color of the text. More...
 
void setTextColorHover (Color textColor)
 Changes the color of the text when the mouse is on top of the tab. More...
 
Color getTextColorHover () const
 Returns the color of the text when the mouse is on top of the tab. More...
 
void setTextColorDisabled (Color textColor)
 Changes the color of the text of a disabled tab. More...
 
Color getTextColorDisabled () const
 Returns the color of the text of a disabled tab. 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 setSelectedTextColorHover (Color textColor)
 Changes the color of the text from the selected tab when the mouse is on top of it. More...
 
Color getSelectedTextColorHover () const
 Returns the color of the text from the selected tab when the mouse is on top of it. 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 setTextureTabHover (const Texture &texture)
 Change the image of a tab when the mouse is on top of it. More...
 
TexturegetTextureTabHover () const
 Returns the image of a tab when the mouse is on top of it. 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 setTextureSelectedTabHover (const Texture &texture)
 Change the image of a selected tab when the mouse is on top of it. More...
 
TexturegetTextureSelectedTabHover () const
 Returns the image of a selected tab when the mouse is on top of it. More...
 
void setTextureDisabledTab (const Texture &texture)
 Change the image of a disabled tab. More...
 
TexturegetTextureDisabledTab () const
 Returns the image of a disabled 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...
 
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. 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 ()=default
 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 setTransparentTexture (bool ignoreTransparentParts)
 Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state. More...
 
bool getTransparentTexture () const
 Returns whether mouse events should be ignored on transparent parts of the texture of the widget. 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 (const void *id, const std::function< void(const std::string &property)> &function)
 Subscribes a callback function to changes in the renderer. More...
 
void unsubscribe (const 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...
 

Member Function Documentation

◆ getBackgroundColor()

Color tgui::TabsRenderer::getBackgroundColor ( ) const

Returns the background color of the tabs.

Returns
Background color

◆ getBackgroundColorDisabled()

Color tgui::TabsRenderer::getBackgroundColorDisabled ( ) const

Returns the background color of a disabled tab.

Returns
Disabled background color

◆ getBackgroundColorHover()

Color tgui::TabsRenderer::getBackgroundColorHover ( ) const

Returns the background color of the tab below the mouse.

Returns
Hover 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

◆ getSelectedBackgroundColorHover()

Color tgui::TabsRenderer::getSelectedBackgroundColorHover ( ) const

Returns the background color of the selected tab when the mouse is on top of it.

Returns
Selected hover tab background color

◆ getSelectedTextColor()

Color tgui::TabsRenderer::getSelectedTextColor ( ) const

Returns the color of the text from the selected tab.

Returns
Selected tab text color

◆ getSelectedTextColorHover()

Color tgui::TabsRenderer::getSelectedTextColorHover ( ) const

Returns the color of the text from the selected tab when the mouse is on top of it.

Returns
Selected hover tab text color

◆ getTextColor()

Color tgui::TabsRenderer::getTextColor ( ) const

Returns the color of the text.

Returns
Text color

◆ getTextColorDisabled()

Color tgui::TabsRenderer::getTextColorDisabled ( ) const

Returns the color of the text of a disabled tab.

Returns
Disabled text color

◆ getTextColorHover()

Color tgui::TabsRenderer::getTextColorHover ( ) const

Returns the color of the text when the mouse is on top of the tab.

Returns
Hover text color

◆ getTextureDisabledTab()

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

Returns the image of a disabled tab.

Returns
disabled tab texture

◆ getTextureSelectedTab()

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

Returns the image of a selected tab.

Returns
selected tab texture

◆ getTextureSelectedTabHover()

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

Returns the image of a selected tab when the mouse is on top of it.

Returns
selected hover tab texture

◆ getTextureTab()

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

Returns the image of a tab.

Returns
tab texture

◆ getTextureTabHover()

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

Returns the image of a tab when the mouse is on top of it.

Returns
hover 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.

◆ setBackgroundColorDisabled()

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

Changes the background color of a disabled tab.

Parameters
backgroundColorThe new disabled background color

◆ setBackgroundColorHover()

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

Changes the background color of the tab below the mouse.

Parameters
backgroundColorThe new hover background color

◆ 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

◆ setSelectedBackgroundColorHover()

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

Changes the background color of the selected tab when the mouse is on top of it.

Parameters
backgroundColorThe new selected hover 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

◆ setSelectedTextColorHover()

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

Changes the color of the text from the selected tab when the mouse is on top of it.

Parameters
textColorThe new selected hover tab text color

◆ setTextColor()

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

Changes the color of the text.

Parameters
textColorThe new text color

◆ setTextColorDisabled()

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

Changes the color of the text of a disabled tab.

Parameters
textColorThe new disabled text color

◆ setTextColorHover()

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

Changes the color of the text when the mouse is on top of the tab.

Parameters
textColorThe new hover text color

◆ setTextureDisabledTab()

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

Change the image of a disabled tab.

Parameters
textureThe new disabled tab texture

The disabled texture is only used when a normal and selected tab texture are also set.

◆ 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.

◆ setTextureSelectedTabHover()

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

Change the image of a selected tab when the mouse is on top of it.

Parameters
textureThe new selected hover tab texture

◆ 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.

◆ setTextureTabHover()

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

Change the image of a tab when the mouse is on top of it.

Parameters
textureThe new hover tab texture

◆ WidgetRenderer()

tgui::WidgetRenderer::WidgetRenderer
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: