tgui::MenuBarRenderer Class Reference

Renderer for the MenuBar widget. More...

#include <TGUI/Renderers/MenuBarRenderer.hpp>

Inheritance diagram for tgui::MenuBarRenderer:

Public Member Functions
void	setTextureBackground (const Texture &texture)
	Changes the image that is used to fill the entire menu bar.
const Texture &	getTextureBackground () const
	Returns the image that is used to fill the entire menu bar.
Public Member Functions inherited from tgui::MenuWidgetBaseRenderer
void	setBackgroundColor (Color backgroundColor)
	Changes the background color.
Color	getBackgroundColor () const
	Returns the background color.
void	setSelectedBackgroundColor (Color backgroundColor)
	Changes the background color of the selected item.
Color	getSelectedBackgroundColor () const
	Returns the background color of the selected item.
void	setTextColor (Color textColor)
	Changes the color of the text.
Color	getTextColor () const
	Returns the color of the text.
void	setSelectedTextColor (Color textColor)
	Changes the color of the text from the selected item.
Color	getSelectedTextColor () const
	Returns the color of the text from the selected item.
void	setTextColorDisabled (Color textColor)
	Changes the color of the text when disabled.
Color	getTextColorDisabled () const
	Returns the color of the text when disabled.
void	setSeparatorColor (Color separatorColor)
	Changes the color of the separators.
Color	getSeparatorColor () const
	Returns the color of the separators.
void	setTextureItemBackground (const Texture &texture)
	Changes the image that is displayed when the menu item is not selected.
const Texture &	getTextureItemBackground () const
	Returns the image that is displayed when the menu item is not selected.
void	setTextureSelectedItemBackground (const Texture &texture)
	Changes the image that is used as background of the selected menu item.
const Texture &	getTextureSelectedItemBackground () const
	Returns the image that is used as background of the selected menu item.
void	setDistanceToSide (float distanceToSide)
	Changes the distance between the text and the side of the menu item.
float	getDistanceToSide () const
	Returns the distance between the text and the side of the menu item.
void	setSeparatorThickness (float thickness)
	Changes the height of the separators.
float	getSeparatorThickness () const
	Returns the height of the separators.
void	setSeparatorVerticalPadding (float padding)
	Changes the distance between the separator and the menu items above and below it.
float	getSeparatorVerticalPadding () const
	Returns the distance between the separator and the menu items above and below it.
void	setSeparatorSidePadding (float padding)
	Changes the distance between the separator and the sides of the menu.
float	getSeparatorSidePadding () const
	Returns the distance between the separator and the sides of the menu.
	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.
float	getOpacity () const
	Returns the opacity of the widget.
void	setOpacityDisabled (float opacity)
	Changes the opacity of the widget when it is disabled.
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.
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.
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.
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.
ObjectConverter	getProperty (const String &property) const
	Retrieves the value of a certain property.
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 (std::shared_ptr< RendererData > data)
std::shared_ptr< RendererData >	getData () const
	Returns the renderer data.
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()

Detailed Description

Renderer for the MenuBar widget.

Member Function Documentation

getTextureBackground()

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

nodiscard

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

Returns

Background texture

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.

---

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

• include/TGUI/Renderers/MenuBarRenderer.hpp