Renderer for the MenuBar widget. More...

#include <TGUI/Renderers/MenuBarRenderer.hpp>

Inheritance diagram for tgui::MenuBarRenderer:

Public Member Functions
void	setBackgroundColor (Color backgroundColor)
	Changes the background color of the menu bar. More...

Color	getBackgroundColor () const
	Returns the background color. More...

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

Color	getSelectedBackgroundColor () const
	Returns the background color of the selected item. 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 item. More...

Color	getSelectedTextColor () const
	Returns the color of the text from the selected item. More...

void	setTextColorDisabled (Color textColor)
	Changes the color of the text when disabled. More...

Color	getTextColorDisabled () const
	Returns the color of the text when disabled. More...

void	setTextureBackground (const Texture &texture)
	Changes the image that is used to fill the entire menu bar. More...

Texture &	getTextureBackground () const
	Returns the image that is used to fill the entire menu bar. More...

void	setTextureItemBackground (const Texture &texture)
	Changes the image that is displayed when the menu item is not selected. More...

Texture &	getTextureItemBackground () const
	Returns the image that is displayed when the menu item is not selected. More...

void	setTextureSelectedItemBackground (const Texture &texture)
	Changes the image that is used as background of the selected menu item. More...

Texture &	getTextureSelectedItemBackground () const
	Returns the image that is used as background of the selected menu item. More...

void	setDistanceToSide (float distanceToSide)
	Changes the distance between the text and the side of the menu item. More...

float	getDistanceToSide () const
	Returns the distance between the text and the side of the menu item. 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	setOpacityDisabled (float opacity)
	Changes the opacity of the widget when it is disabled. More...

float	getOpacityDisabled () const
	Returns the opacity of the widget when it is disabled. 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< RendererData >	getData () const
	Returns the renderer data. More...

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

Detailed Description

Renderer for the MenuBar widget.

Member Function Documentation

◆ getBackgroundColor()

Color tgui::MenuBarRenderer::getBackgroundColor ( ) const

Returns the background color.

Returns: Background color

◆ getDistanceToSide()

float tgui::MenuBarRenderer::getDistanceToSide ( ) const

Returns the distance between the text and the side of the menu item.

Returns: Distance between the text and the side of the menu item

◆ getSelectedBackgroundColor()

Color tgui::MenuBarRenderer::getSelectedBackgroundColor ( ) const

Returns the background color of the selected item.

Returns: Selected item background color

◆ getSelectedTextColor()

Color tgui::MenuBarRenderer::getSelectedTextColor ( ) const

Returns the color of the text from the selected item.

Returns: Selected text color

◆ getTextColor()

Color tgui::MenuBarRenderer::getTextColor ( ) const

Returns the color of the text.

Returns: Text color

◆ getTextColorDisabled()

Color tgui::MenuBarRenderer::getTextColorDisabled ( ) const

Returns the color of the text when disabled.

Returns: Text color

◆ getTextureBackground()

Texture & tgui::MenuBarRenderer::getTextureBackground ( ) const

Returns the image that is used to fill the entire menu bar.

Returns: Background texture

◆ getTextureItemBackground()

Texture & tgui::MenuBarRenderer::getTextureItemBackground ( ) const

Returns the image that is displayed when the menu item is not selected.

Returns: Item background texture

◆ getTextureSelectedItemBackground()

Texture & tgui::MenuBarRenderer::getTextureSelectedItemBackground ( ) const

Returns the image that is used as background of the selected menu item.

Returns: Selected item background texture

◆ setBackgroundColor()

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

Changes the background color of the menu bar.

Parameters

backgroundColor The new background color

◆ setDistanceToSide()

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

Changes the distance between the text and the side of the menu item.

Parameters

distanceToSide distance between the text and the side of the menu item

◆ setSelectedBackgroundColor()

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

Changes the background color of the selected item.

Parameters

backgroundColor The new selected item background color

◆ setSelectedTextColor()

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

Changes the color of the text from the selected item.

Parameters

textColor The new selected text color

◆ setTextColor()

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

Changes the color of the text.

Parameters

textColor The new text color

◆ setTextColorDisabled()

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

Changes the color of the text when disabled.

Parameters

textColor The new text color

◆ setTextureBackground()

void tgui::MenuBarRenderer::setTextureBackground ( const Texture & texture )

Changes the image that is used to fill the entire menu bar.

Parameters

texture The background texture

When this image is set, the background color property will be ignored.

◆ setTextureItemBackground()

void tgui::MenuBarRenderer::setTextureItemBackground ( const Texture & texture )

Changes the image that is displayed when the menu item is not selected.

Parameters

texture New item background texture

◆ setTextureSelectedItemBackground()

void tgui::MenuBarRenderer::setTextureSelectedItemBackground ( const Texture & texture )

Changes the image that is used as background of the selected menu item.

Parameters

texture New selected item background 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/MenuBarRenderer.hpp

TGUI

Public Member Functions

Detailed Description

Member Function Documentation

◆ getBackgroundColor()

◆ getDistanceToSide()

◆ getSelectedBackgroundColor()

◆ getSelectedTextColor()

◆ getTextColor()

◆ getTextColorDisabled()

◆ getTextureBackground()

◆ getTextureItemBackground()

◆ getTextureSelectedItemBackground()

◆ setBackgroundColor()

◆ setDistanceToSide()

◆ setSelectedBackgroundColor()

◆ setSelectedTextColor()

◆ setTextColor()

◆ setTextColorDisabled()

◆ setTextureBackground()

◆ setTextureItemBackground()

◆ setTextureSelectedItemBackground()

◆ WidgetRenderer()