--- ---
|
TGUI
1.x-dev
|
Renderer for the MenuBar widget. More...
#include <TGUI/Renderers/MenuBarRenderer.hpp>
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 Texture & | getTextureBackground () 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 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. | |
| TGUI_NODISCARD 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. | |
| 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. | |
| 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 (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() |
Renderer for the MenuBar widget.
| TGUI_NODISCARD Color tgui::MenuBarRenderer::getBackgroundColor | ( | ) | const |
Returns the background color.
| TGUI_NODISCARD float tgui::MenuBarRenderer::getDistanceToSide | ( | ) | const |
Returns the distance between the text and the side of the menu item.
| TGUI_NODISCARD Color tgui::MenuBarRenderer::getSelectedBackgroundColor | ( | ) | const |
Returns the background color of the selected item.
| TGUI_NODISCARD Color tgui::MenuBarRenderer::getSelectedTextColor | ( | ) | const |
Returns the color of the text from the selected item.
| TGUI_NODISCARD Color tgui::MenuBarRenderer::getSeparatorColor | ( | ) | const |
Returns the color of the separators.
| TGUI_NODISCARD float tgui::MenuBarRenderer::getSeparatorSidePadding | ( | ) | const |
Returns the distance between the separator and the sides of the menu.
| TGUI_NODISCARD float tgui::MenuBarRenderer::getSeparatorThickness | ( | ) | const |
Returns the height of the separators.
| TGUI_NODISCARD float tgui::MenuBarRenderer::getSeparatorVerticalPadding | ( | ) | const |
Returns the distance between the separator and the menu items above and below it.
| TGUI_NODISCARD Color tgui::MenuBarRenderer::getTextColor | ( | ) | const |
Returns the color of the text.
| TGUI_NODISCARD Color tgui::MenuBarRenderer::getTextColorDisabled | ( | ) | const |
Returns the color of the text when disabled.
| TGUI_NODISCARD const Texture & tgui::MenuBarRenderer::getTextureBackground | ( | ) | const |
Returns the image that is used to fill the entire menu bar.
| TGUI_NODISCARD const Texture & tgui::MenuBarRenderer::getTextureItemBackground | ( | ) | const |
Returns the image that is displayed when the menu item is not selected.
| TGUI_NODISCARD const Texture & tgui::MenuBarRenderer::getTextureSelectedItemBackground | ( | ) | const |
Returns the image that is used as background of the selected menu item.
| void tgui::MenuBarRenderer::setBackgroundColor | ( | Color | backgroundColor | ) |
Changes the background color of the menu bar.
| backgroundColor | The new background color |
| void tgui::MenuBarRenderer::setDistanceToSide | ( | float | distanceToSide | ) |
Changes the distance between the text and the side of the menu item.
| distanceToSide | distance between the text and the side of the menu item |
| void tgui::MenuBarRenderer::setSelectedBackgroundColor | ( | Color | backgroundColor | ) |
Changes the background color of the selected item.
| backgroundColor | The new selected item background color |
| void tgui::MenuBarRenderer::setSelectedTextColor | ( | Color | textColor | ) |
Changes the color of the text from the selected item.
| textColor | The new selected text color |
| void tgui::MenuBarRenderer::setSeparatorColor | ( | Color | separatorColor | ) |
Changes the color of the separators.
| separatorColor | The new separator color |
| void tgui::MenuBarRenderer::setSeparatorSidePadding | ( | float | padding | ) |
Changes the distance between the separator and the sides of the menu.
| padding | Padding next to the separator |
| void tgui::MenuBarRenderer::setSeparatorThickness | ( | float | thickness | ) |
Changes the height of the separators.
| thickness | The new separator thickness |
| void tgui::MenuBarRenderer::setSeparatorVerticalPadding | ( | float | padding | ) |
Changes the distance between the separator and the menu items above and below it.
| padding | Padding above and below the separator |
| void tgui::MenuBarRenderer::setTextColor | ( | Color | textColor | ) |
Changes the color of the text.
| textColor | The new text color |
| void tgui::MenuBarRenderer::setTextColorDisabled | ( | Color | textColor | ) |
Changes the color of the text when disabled.
| textColor | The new text color |
| void tgui::MenuBarRenderer::setTextureBackground | ( | const Texture & | texture | ) |
Changes the image that is used to fill the entire menu bar.
| texture | The background texture |
When this image is set, the background color property will be ignored.
| void tgui::MenuBarRenderer::setTextureItemBackground | ( | const Texture & | texture | ) |
Changes the image that is displayed when the menu item is not selected.
| texture | New item background texture |
| void tgui::MenuBarRenderer::setTextureSelectedItemBackground | ( | const Texture & | texture | ) |
Changes the image that is used as background of the selected menu item.
| texture | New selected item background texture |
|
inline |
Construct the renderer from renderer data.
| data | Renderer data to initialize the renderer with |