Inheritance diagram for tgui::TabsRenderer:

Public Member Functions
void	setBorders (const Borders &borders)
	Changes the size of the borders.

TGUI_NODISCARD Borders	getBorders () const
	Returns the size of the borders.

void	setBackgroundColor (Color backgroundColor)
	Changes the background color of the tabs.

TGUI_NODISCARD Color	getBackgroundColor () const
	Returns the background color of the tabs.

void	setBackgroundColorHover (Color backgroundColor)
	Changes the background color of the tab below the mouse.

TGUI_NODISCARD Color	getBackgroundColorHover () const
	Returns the background color of the tab below the mouse.

void	setBackgroundColorDisabled (Color backgroundColor)
	Changes the background color of a disabled tab.

TGUI_NODISCARD Color	getBackgroundColorDisabled () const
	Returns the background color of a disabled tab.

void	setSelectedBackgroundColor (Color backgroundColor)
	Changes the background color of the selected tab.

TGUI_NODISCARD Color	getSelectedBackgroundColor () const
	Returns the background color of the selected tab.

void	setSelectedBackgroundColorHover (Color backgroundColor)
	Changes the background color of the selected tab when the mouse is on top of it.

TGUI_NODISCARD Color	getSelectedBackgroundColorHover () const
	Returns the background color of the selected tab when the mouse is on top of it.

void	setTextColor (Color textColor)
	Changes the color of the text.

TGUI_NODISCARD Color	getTextColor () const
	Returns the color of the text.

void	setTextColorHover (Color textColor)
	Changes the color of the text when the mouse is on top of the tab.

TGUI_NODISCARD Color	getTextColorHover () const
	Returns the color of the text when the mouse is on top of the tab.

void	setTextColorDisabled (Color textColor)
	Changes the color of the text of a disabled tab.

TGUI_NODISCARD Color	getTextColorDisabled () const
	Returns the color of the text of a disabled tab.

void	setSelectedTextColor (Color textColor)
	Changes the color of the text from the selected tab.

TGUI_NODISCARD Color	getSelectedTextColor () const
	Returns the color of the text from the selected tab.

void	setSelectedTextColorHover (Color textColor)
	Changes the color of the text from the selected tab when the mouse is on top of it.

TGUI_NODISCARD Color	getSelectedTextColorHover () const
	Returns the color of the text from the selected tab when the mouse is on top of it.

void	setBorderColor (Color color)
	Sets the color of the borders.

TGUI_NODISCARD Color	getBorderColor () const
	Returns the color of the borders.

void	setBorderColorHover (Color color)
	Sets the color of the borders when the mouse is on top of it.

TGUI_NODISCARD Color	getBorderColorHover () const
	Returns the color of the borders when the mouse is on top of it.

void	setSelectedBorderColor (Color color)
	Sets the color of the borders around the selected tab.

TGUI_NODISCARD Color	getSelectedBorderColor () const
	Returns the color of the borders around the selected tab.

void	setSelectedBorderColorHover (Color color)
	Sets the color of the borders around the selected tab when the mouse is on top of it.

TGUI_NODISCARD Color	getSelectedBorderColorHover () const
	Returns the color of the borders around the selected tab when the mouse is on top of it.

void	setTextureTab (const Texture &texture)
	Change the image of a tab.

TGUI_NODISCARD const Texture &	getTextureTab () const
	Returns the image of a tab.

void	setTextureTabHover (const Texture &texture)
	Change the image of a tab when the mouse is on top of it.

TGUI_NODISCARD const Texture &	getTextureTabHover () const
	Returns the image of a tab when the mouse is on top of it.

void	setTextureSelectedTab (const Texture &texture)
	Change the image of a selected tab.

TGUI_NODISCARD const Texture &	getTextureSelectedTab () const
	Returns the image of a selected tab.

void	setTextureSelectedTabHover (const Texture &texture)
	Change the image of a selected tab when the mouse is on top of it.

TGUI_NODISCARD const Texture &	getTextureSelectedTabHover () const
	Returns the image of a selected tab when the mouse is on top of it.

void	setTextureDisabledTab (const Texture &texture)
	Change the image of a disabled tab.

TGUI_NODISCARD const Texture &	getTextureDisabledTab () const
	Returns the image of a disabled tab.

void	setDistanceToSide (float distanceToSide)
	Changes the distance between the text and the side of the tab.

TGUI_NODISCARD float	getDistanceToSide () const
	Returns the distance between the text and the side of the tab.

	WidgetRenderer ()=default
	Default constructor.

	WidgetRenderer (const WidgetRenderer &)
	Copy constructor.

	WidgetRenderer (WidgetRenderer &&)=default
	Default move constructor.

	WidgetRenderer (const std::shared_ptr< RendererData > &data)
	Construct the renderer from renderer data.

Public Member Functions inherited from tgui::WidgetRenderer
	WidgetRenderer ()=default
	Default constructor.

	WidgetRenderer (const WidgetRenderer &)
	Copy constructor.

	WidgetRenderer (WidgetRenderer &&)=default
	Default move constructor.

WidgetRenderer &	operator= (const WidgetRenderer &)
	Copy assignment operator.

WidgetRenderer &	operator= (WidgetRenderer &&)=default
	Default move assignment operator.

	WidgetRenderer (const std::shared_ptr< RendererData > &data)
	Construct the renderer from renderer data.

virtual	~WidgetRenderer ()=default
	Virtual destructor.

void	setOpacity (float opacity)
	Changes the opacity of the widget.

TGUI_NODISCARD float	getOpacity () const
	Returns the opacity of the widget.

void	setOpacityDisabled (float opacity)
	Changes the opacity of the widget when it is disabled.

TGUI_NODISCARD float	getOpacityDisabled () const
	Returns the opacity of the widget when it is disabled.

void	setFont (const Font &font)
	Changes the font used for the text in the widget.

TGUI_NODISCARD Font	getFont () const
	Returns the font associated with the widget (if any)

void	setTextSize (unsigned int size)
	Changes the text size of the widget that is specified by the renderer.

TGUI_NODISCARD unsigned int	getTextSize () const
	Returns text size of the widget that is specified by the renderer.

void	setTransparentTexture (bool ignoreTransparentParts)
	Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state.

TGUI_NODISCARD bool	getTransparentTexture () const
	Returns whether mouse events should be ignored on transparent parts of the texture of the widget.

void	setProperty (const String &property, ObjectConverter &&value)
	Changes a property of the renderer.

TGUI_NODISCARD ObjectConverter	getProperty (const String &property) const
	Retrieves the value of a certain property.

TGUI_NODISCARD const std::map< String, ObjectConverter > &	getPropertyValuePairs () const
	Gets a map with all properties and their values.

void	subscribe (Widget *widget)
	Subscribes a callback function to changes in the renderer.

void	unsubscribe (Widget *widget)
	Subscribes a callback function to changes in the renderer.

void	setData (const std::shared_ptr< RendererData > &data)

TGUI_NODISCARD std::shared_ptr< RendererData >	getData () const
	Returns the renderer data.

TGUI_NODISCARD std::shared_ptr< RendererData >	clone () const
	Gets a clone of the renderer data.

Additional Inherited Members
Protected Attributes inherited from tgui::WidgetRenderer
std::shared_ptr< RendererData >	m_data = RendererData::create()

Member Function Documentation

◆ getBackgroundColor()

TGUI_NODISCARD Color tgui::TabsRenderer::getBackgroundColor ( ) const

Returns the background color of the tabs.

Returns: Background color

◆ getBackgroundColorDisabled()

TGUI_NODISCARD Color tgui::TabsRenderer::getBackgroundColorDisabled ( ) const

Returns the background color of a disabled tab.

Returns: Disabled background color

◆ getBackgroundColorHover()

TGUI_NODISCARD Color tgui::TabsRenderer::getBackgroundColorHover ( ) const

Returns the background color of the tab below the mouse.

Returns: Hover background color

◆ getBorderColor()

TGUI_NODISCARD Color tgui::TabsRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns: border color

◆ getBorderColorHover()

TGUI_NODISCARD Color tgui::TabsRenderer::getBorderColorHover ( ) const

Returns the color of the borders when the mouse is on top of it.

Returns: hover border color

◆ getBorders()

TGUI_NODISCARD Borders tgui::TabsRenderer::getBorders ( ) const

Returns the size of the borders.

Returns: border size

◆ getDistanceToSide()

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

TGUI_NODISCARD Color tgui::TabsRenderer::getSelectedBackgroundColor ( ) const

Returns the background color of the selected tab.

Returns: Selected tab background color

◆ getSelectedBackgroundColorHover()

TGUI_NODISCARD 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

◆ getSelectedBorderColor()

TGUI_NODISCARD Color tgui::TabsRenderer::getSelectedBorderColor ( ) const

Returns the color of the borders around the selected tab.

Returns: border color

◆ getSelectedBorderColorHover()

TGUI_NODISCARD Color tgui::TabsRenderer::getSelectedBorderColorHover ( ) const

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

Returns: selected hover border color

◆ getSelectedTextColor()

TGUI_NODISCARD Color tgui::TabsRenderer::getSelectedTextColor ( ) const

Returns the color of the text from the selected tab.

Returns: Selected tab text color

◆ getSelectedTextColorHover()

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

TGUI_NODISCARD Color tgui::TabsRenderer::getTextColor ( ) const

Returns the color of the text.

Returns: Text color

◆ getTextColorDisabled()

TGUI_NODISCARD Color tgui::TabsRenderer::getTextColorDisabled ( ) const

Returns the color of the text of a disabled tab.

Returns: Disabled text color

◆ getTextColorHover()

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

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

Returns the image of a disabled tab.

Returns: disabled tab texture

◆ getTextureSelectedTab()

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

Returns the image of a selected tab.

Returns: selected tab texture

◆ getTextureSelectedTabHover()

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

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

Returns the image of a tab.

Returns: tab texture

◆ getTextureTabHover()

TGUI_NODISCARD const 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

backgroundColor The 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

backgroundColor The new disabled background color

◆ setBackgroundColorHover()

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

Changes the background color of the tab below the mouse.

Parameters

backgroundColor The new hover background color

◆ setBorderColor()

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

Sets the color of the borders.

Parameters

color The new border color

◆ setBorderColorHover()

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

Sets the color of the borders when the mouse is on top of it.

Parameters

color The new hover border color

◆ setBorders()

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

Changes the size of the borders.

Parameters

borders Size of the borders

◆ setDistanceToSide()

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

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

Parameters

distanceToSide distance 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

backgroundColor The 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

backgroundColor The new selected hover tab background color

◆ setSelectedBorderColor()

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

Sets the color of the borders around the selected tab.

Parameters

color The new selected border color

◆ setSelectedBorderColorHover()

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

Sets the color of the borders around the selected tab when the mouse is on top of it.

Parameters

color The new selected hover border color

◆ setSelectedTextColor()

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

Changes the color of the text from the selected tab.

Parameters

textColor The 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

textColor The new selected hover tab text color

◆ setTextColor()

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

Changes the color of the text.

Parameters

textColor The new text color

◆ setTextColorDisabled()

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

Changes the color of the text of a disabled tab.

Parameters

textColor The 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

textColor The new hover text color

◆ setTextureDisabledTab()

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

Change the image of a disabled tab.

Parameters

texture The 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

texture The new selected tab texture

When this image is set then the background color properties will be ignored for selected tabs.

◆ setTextureSelectedTabHover()

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

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

Parameters

texture The new selected hover tab texture

◆ setTextureTab()

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

Change the image of a tab.

Parameters

texture The new tab texture

When this image is set then the background color properties will be ignored for non-selected tabs.

◆ setTextureTabHover()

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

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

Parameters

texture The new hover tab texture

◆ WidgetRenderer()

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

inline

Construct the renderer from renderer data.

Parameters

data	Renderer data to initialize the renderer with

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

include/TGUI/Renderers/TabsRenderer.hpp

TGUI

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ getBackgroundColor()

◆ getBackgroundColorDisabled()

◆ getBackgroundColorHover()

◆ getBorderColor()

◆ getBorderColorHover()

◆ getBorders()

◆ getDistanceToSide()

◆ getSelectedBackgroundColor()

◆ getSelectedBackgroundColorHover()

◆ getSelectedBorderColor()

◆ getSelectedBorderColorHover()

◆ getSelectedTextColor()

◆ getSelectedTextColorHover()

◆ getTextColor()

◆ getTextColorDisabled()

◆ getTextColorHover()

◆ getTextureDisabledTab()

◆ getTextureSelectedTab()

◆ getTextureSelectedTabHover()

◆ getTextureTab()

◆ getTextureTabHover()

◆ setBackgroundColor()

◆ setBackgroundColorDisabled()

◆ setBackgroundColorHover()

◆ setBorderColor()

◆ setBorderColorHover()

◆ setBorders()

◆ setDistanceToSide()

◆ setSelectedBackgroundColor()

◆ setSelectedBackgroundColorHover()

◆ setSelectedBorderColor()

◆ setSelectedBorderColorHover()

◆ setSelectedTextColor()

◆ setSelectedTextColorHover()

◆ setTextColor()

◆ setTextColorDisabled()

◆ setTextColorHover()

◆ setTextureDisabledTab()

◆ setTextureSelectedTab()

◆ setTextureSelectedTabHover()

◆ setTextureTab()

◆ setTextureTabHover()

◆ WidgetRenderer()