TGUI  0.8-dev
tgui::MenuBarRenderer Class Reference
Inheritance diagram for tgui::MenuBarRenderer:
tgui::WidgetRenderer

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 setTextureBackground (const Texture &texture)
 Changes the image that is used to fill the entire menu bar. More...
 
TexturegetTextureBackground () 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...
 
TexturegetTextureItemBackground () 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...
 
TexturegetTextureSelectedItemBackground () 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...
 
- 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 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::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

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

◆ setTextColor()

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

Changes the color of the text.

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

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