TGUI  1.3.0
Loading...
Searching...
No Matches
tgui::MenuBarRenderer Class Reference

Renderer for the MenuBar widget. More...

#include <TGUI/Renderers/MenuBarRenderer.hpp>

Inheritance diagram for tgui::MenuBarRenderer:
tgui::WidgetRenderer

Public Member Functions

void setBackgroundColor (Color backgroundColor)
 Changes the background color of the menu bar.
 
TGUI_NODISCARD Color getBackgroundColor () const
 Returns the background color.
 
void setSelectedBackgroundColor (Color backgroundColor)
 Changes the background color of the selected item.
 
TGUI_NODISCARD Color getSelectedBackgroundColor () const
 Returns the background color of the selected item.
 
void setTextColor (Color textColor)
 Changes the color of the text.
 
TGUI_NODISCARD Color getTextColor () const
 Returns the color of the text.
 
void setSelectedTextColor (Color textColor)
 Changes the color of the text from the selected item.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Color getTextColorDisabled () const
 Returns the color of the text when disabled.
 
void setSeparatorColor (Color separatorColor)
 Changes the color of the separators.
 
TGUI_NODISCARD Color getSeparatorColor () const
 Returns the color of the separators.
 
void setTextureBackground (const Texture &texture)
 Changes the image that is used to fill the entire menu bar.
 
TGUI_NODISCARD const TexturegetTextureBackground () const
 Returns the image that is used to fill the entire menu bar.
 
void setTextureItemBackground (const Texture &texture)
 Changes the image that is displayed when the menu item is not selected.
 
TGUI_NODISCARD const TexturegetTextureItemBackground () 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.
 
TGUI_NODISCARD const TexturegetTextureSelectedItemBackground () 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
WidgetRendereroperator= (const WidgetRenderer &)
 Copy assignment operator.
 
WidgetRendereroperator= (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 (std::shared_ptr< RendererData > data)
 
TGUI_NODISCARD std::shared_ptr< RendererDatagetData () const
 Returns the renderer data.
 
TGUI_NODISCARD std::shared_ptr< RendererDataclone () const
 Gets a clone of the renderer data.
 

Additional Inherited Members

- Protected Attributes inherited from tgui::WidgetRenderer
std::shared_ptr< RendererDatam_data = RendererData::create()
 

Detailed Description

Renderer for the MenuBar widget.

Member Function Documentation

◆ getBackgroundColor()

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

Returns the background color.

Returns
Background color

◆ getDistanceToSide()

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

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

Returns the background color of the selected item.

Returns
Selected item background color

◆ getSelectedTextColor()

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

Returns the color of the text from the selected item.

Returns
Selected text color

◆ getSeparatorColor()

TGUI_NODISCARD Color tgui::MenuBarRenderer::getSeparatorColor ( ) const

Returns the color of the separators.

Returns
Separator color

◆ getSeparatorSidePadding()

TGUI_NODISCARD float tgui::MenuBarRenderer::getSeparatorSidePadding ( ) const

Returns the distance between the separator and the sides of the menu.

Returns
Padding next to the separator

◆ getSeparatorThickness()

TGUI_NODISCARD float tgui::MenuBarRenderer::getSeparatorThickness ( ) const

Returns the height of the separators.

Returns
Separator thickness

◆ getSeparatorVerticalPadding()

TGUI_NODISCARD float tgui::MenuBarRenderer::getSeparatorVerticalPadding ( ) const

Returns the distance between the separator and the menu items above and below it.

Returns
Padding above and below the separator

◆ getTextColor()

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

Returns the color of the text.

Returns
Text color

◆ getTextColorDisabled()

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

Returns the color of the text when disabled.

Returns
Text color

◆ getTextureBackground()

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

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

Returns
Background texture

◆ getTextureItemBackground()

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

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

Returns
Item background texture

◆ getTextureSelectedItemBackground()

TGUI_NODISCARD const 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
backgroundColorThe new background color

◆ setDistanceToSide()

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

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

Parameters
distanceToSidedistance 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
backgroundColorThe new selected item background color

◆ setSelectedTextColor()

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

Changes the color of the text from the selected item.

Parameters
textColorThe new selected text color

◆ setSeparatorColor()

void tgui::MenuBarRenderer::setSeparatorColor ( Color separatorColor)

Changes the color of the separators.

Parameters
separatorColorThe new separator color

◆ setSeparatorSidePadding()

void tgui::MenuBarRenderer::setSeparatorSidePadding ( float padding)

Changes the distance between the separator and the sides of the menu.

Parameters
paddingPadding next to the separator

◆ setSeparatorThickness()

void tgui::MenuBarRenderer::setSeparatorThickness ( float thickness)

Changes the height of the separators.

Parameters
thicknessThe new separator thickness

◆ setSeparatorVerticalPadding()

void tgui::MenuBarRenderer::setSeparatorVerticalPadding ( float padding)

Changes the distance between the separator and the menu items above and below it.

Parameters
paddingPadding above and below the separator

◆ setTextColor()

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

Changes the color of the text.

Parameters
textColorThe new text color

◆ setTextColorDisabled()

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

Changes the color of the text when disabled.

Parameters
textColorThe new text color

◆ setTextureBackground()

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

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

Parameters
textureThe 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
textureNew 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
textureNew selected item background texture

◆ WidgetRenderer()

tgui::WidgetRenderer::WidgetRenderer ( const std::shared_ptr< RendererData > & data)
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: