--- ---
|
TGUI
1.x-dev
|
Public Member Functions | |
| void | setBorders (const Borders &borders) |
| Changes the size of the borders. | |
| Borders | getBorders () const |
| Returns the size of the borders. | |
| void | setTextColor (Color color) |
| Changes the color of the text. | |
| Color | getTextColor () const |
| Returns the text color. | |
| void | setTextColorDown (Color color) |
| Changes the color of the text in the down state (mouse on button and left mouse button being held down) | |
| Color | getTextColorDown () const |
| Returns the text color in the down state (mouse on button and left mouse button being held down) | |
| void | setTextColorHover (Color color) |
| Changes the color of the text in the hover state (mouse on button, but not pressed) | |
| Color | getTextColorHover () const |
| Returns the text color in the hover state (mouse on button, but not pressed) | |
| void | setTextColorDownHover (Color color) |
| Changes the text color when in both down and hover state (mouse on button while button pressed) | |
| Color | getTextColorDownHover () const |
| Returns the text color when in both down and hover state (mouse on button while button pressed) | |
| void | setTextColorDisabled (Color color) |
| Changes the color of the text that is used when the button is disabled. | |
| Color | getTextColorDisabled () const |
| Returns the text color that is used when the button is disabled. | |
| void | setTextColorDownDisabled (Color color) |
| Changes the color of the text that is used when the button is disabled while in pressed state. | |
| Color | getTextColorDownDisabled () const |
| Returns the text color that is used when the button is disabled while in pressed state. | |
| void | setTextColorFocused (Color color) |
| Changes the color of the text that is used when the button is focused. | |
| Color | getTextColorFocused () const |
| Returns the text color that is used when the button is focused. | |
| void | setTextColorDownFocused (Color color) |
| Changes the color of the text that is used when the button is focused while in pressed state. | |
| Color | getTextColorDownFocused () const |
| Returns the text color that is used when the button is focused while in pressed state. | |
| void | setBackgroundColor (Color color) |
| Changes the color of the background. | |
| Color | getBackgroundColor () const |
| Returns the background color. | |
| void | setBackgroundColorDown (Color color) |
| Changes the color of the background in the down state (mouse on button and left mouse button being held down) | |
| Color | getBackgroundColorDown () const |
| Returns the background color in the down state (mouse on button and left mouse button being held down) | |
| void | setBackgroundColorHover (Color color) |
| Changes the color of the background in the hover state (mouse on button, but not pressed) | |
| Color | getBackgroundColorHover () const |
| Returns the background color in the hover state (mouse on button, but not pressed) | |
| void | setBackgroundColorDownHover (Color color) |
| Changes the color of the background when in both down and hover state (mouse on button while button pressed) | |
| Color | getBackgroundColorDownHover () const |
| Returns the background color when in both down and hover state (mouse on button while button pressed) | |
| void | setBackgroundColorDisabled (Color color) |
| Changes the color of the background that is used when the button is disabled. | |
| Color | getBackgroundColorDisabled () const |
| Returns the background color that is used when the button is disabled. | |
| void | setBackgroundColorDownDisabled (Color color) |
| Changes the color of the background that is used when the button is disabled while in pressed state. | |
| Color | getBackgroundColorDownDisabled () const |
| Returns the background color that is used when the button is disabled while in pressed state. | |
| void | setBackgroundColorFocused (Color color) |
| Changes the color of the background that is used when the button is focused. | |
| Color | getBackgroundColorFocused () const |
| Returns the background color that is used when the button is focused. | |
| void | setBackgroundColorDownFocused (Color color) |
| Changes the color of the background used when the button is focused while in pressed state. | |
| Color | getBackgroundColorDownFocused () const |
| Returns the background color that is used when the button is focused while in pressed state. | |
| void | setBorderColor (Color color) |
| Changes the color of the borders. | |
| Color | getBorderColor () const |
| Returns the color of the borders. | |
| void | setBorderColorDown (Color color) |
| Changes the color of the borders in the down state (mouse on button and left mouse button being held down) | |
| Color | getBorderColorDown () const |
| Returns the color of the borders in the down state (mouse on button and left mouse button being held down) | |
| void | setBorderColorHover (Color color) |
| Changes the color of the borders in the hover state (mouse on button, but not pressed) | |
| Color | getBorderColorHover () const |
| Returns the color of the borders in the hover state (mouse on button, but not pressed) | |
| void | setBorderColorDownHover (Color color) |
| Changes the color of the borders when in both down and hover state (mouse on button while button pressed) | |
| Color | getBorderColorDownHover () const |
| Returns the color of the borders when in both down and hover state (mouse on button while button pressed) | |
| void | setBorderColorDisabled (Color color) |
| Changes the color of the borders that is used when the button is disabled. | |
| Color | getBorderColorDisabled () const |
| Returns the color of the borders that is used when the button is disabled. | |
| void | setBorderColorDownDisabled (Color color) |
| Changes the color of the borders that is used when the button is disabled while in pressed state. | |
| Color | getBorderColorDownDisabled () const |
| Returns the color of the borders that is used when the button is disabled while in pressed state. | |
| void | setBorderColorFocused (Color color) |
| Changes the color of the borders that is used when the button is focused. | |
| Color | getBorderColorFocused () const |
| Returns the color of the borders that is used when the button is focused. | |
| void | setBorderColorDownFocused (Color color) |
| Changes the color of the borders that is used when the button is focused while in pressed state. | |
| Color | getBorderColorDownFocused () const |
| Returns the color of the borders that is used when the button is focused while in pressed state. | |
| void | setTexture (const Texture &texture) |
| Change the image that is displayed. | |
| const Texture & | getTexture () const |
| Returns the image that is displayed. | |
| void | setTextureDown (const Texture &texture) |
| Changes the image that is displayed when the mouse is held down on top of the button. | |
| const Texture & | getTextureDown () const |
| Returns the image that is displayed when the mouse is held down on top of the button. | |
| void | setTextureHover (const Texture &texture) |
| Changes the image that is displayed when the mouse is located on top of the button. | |
| const Texture & | getTextureHover () const |
| Returns the image that is displayed when the mouse is located on top of the button. | |
| void | setTextureDownHover (const Texture &texture) |
| Changes the image that is displayed when in both down and hover state (mouse on button while button pressed) | |
| const Texture & | getTextureDownHover () const |
| Returns the image that is displayed when in both down and hover state (mouse on button while button pressed) | |
| void | setTextureDisabled (const Texture &texture) |
| Changes the image that is displayed when the button is disabled. | |
| const Texture & | getTextureDisabled () const |
| Returns the image that is displayed when the button is disabled. | |
| void | setTextureDownDisabled (const Texture &texture) |
| Changes the image that is displayed when the button is disabled while in pressed state. | |
| const Texture & | getTextureDownDisabled () const |
| Returns the image that is displayed when the button is disabled while in pressed state. | |
| void | setTextureFocused (const Texture &texture) |
| Change the image that is drawn on top of the button image when the button is focused. | |
| const Texture & | getTextureFocused () const |
| Returns the image that is drawn on top of the button image when the button is focused. | |
| void | setTextureDownFocused (const Texture &texture) |
| Change the image that is drawn on top of the button image when the button is focused while in pressed state. | |
| const Texture & | getTextureDownFocused () const |
| Returns the image that is drawn on top of the button image when the button is focused while in pressed state. | |
| void | setTextStyle (TextStyles style) |
| Changes the text style. | |
| TextStyles | getTextStyle () const |
| Returns text style. | |
| void | setTextStyleDown (TextStyles style) |
| Changes the text style in the down state (mouse on button and left mouse button being held down) | |
| TextStyles | getTextStyleDown () const |
| Returns text style in the down state (mouse on button and left mouse button being held down) | |
| void | setTextStyleHover (TextStyles style) |
| Changes the text style in the hover state (mouse on button, but not pressed) | |
| TextStyles | getTextStyleHover () const |
| Returns text style in the hover state (mouse on button, but not pressed) | |
| void | setTextStyleDownHover (TextStyles style) |
| Changes the text style when in both down and hover state (mouse on button while button pressed) | |
| TextStyles | getTextStyleDownHover () const |
| Returns text style when in both down and hover state (mouse on button while button pressed) | |
| void | setTextStyleDisabled (TextStyles style) |
| Changes the text style that is used when the button is disabled. | |
| TextStyles | getTextStyleDisabled () const |
| Returns text style used when the button is disabled. | |
| void | setTextStyleDownDisabled (TextStyles style) |
| Changes the text style that is used when the button is disabled while in pressed state. | |
| TextStyles | getTextStyleDownDisabled () const |
| Returns text style used when the button is disabled while in pressed state. | |
| void | setTextStyleFocused (TextStyles style) |
| Changes the text style that is used when the button is focused. | |
| TextStyles | getTextStyleFocused () const |
| Returns text style used when the button is focused. | |
| void | setTextStyleDownFocused (TextStyles style) |
| Changes the text style that is used when the button is focused while in pressed state. | |
| TextStyles | getTextStyleDownFocused () const |
| Returns text style used when the button is focused while in pressed state. | |
| void | setTextOutlineColor (Color outlineColor) |
| Changes the outline color of the text (used when TextOutlineThickness > 0) | |
| Color | getTextOutlineColor () const |
| Returns the outline color of the text (used when TextOutlineThickness > 0) | |
| void | setTextOutlineThickness (float outlineThickness) |
| Changes the thickness of the text outline (0 by default, which means there is no outline). | |
| float | getTextOutlineThickness () const |
| Returns the thickness of the text outline. | |
| void | setRoundedBorderRadius (float radius) |
| Changes the radius for the rounded corners if you want to draw a rounded rectangle as background. | |
| float | getRoundedBorderRadius () const |
| Returns the radius for the rounded corners if you want to draw a rounded rectangle as background. | |
| 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() |
|
nodiscard |
Returns the background color.
|
nodiscard |
Returns the background color that is used when the button is disabled.
|
nodiscard |
Returns the background color in the down state (mouse on button and left mouse button being held down)
|
nodiscard |
Returns the background color that is used when the button is disabled while in pressed state.
|
nodiscard |
Returns the background color that is used when the button is focused while in pressed state.
|
nodiscard |
Returns the background color when in both down and hover state (mouse on button while button pressed)
|
nodiscard |
Returns the background color that is used when the button is focused.
|
nodiscard |
Returns the background color in the hover state (mouse on button, but not pressed)
|
nodiscard |
Returns the color of the borders.
|
nodiscard |
Returns the color of the borders that is used when the button is disabled.
|
nodiscard |
Returns the color of the borders in the down state (mouse on button and left mouse button being held down)
|
nodiscard |
Returns the color of the borders that is used when the button is disabled while in pressed state.
|
nodiscard |
Returns the color of the borders that is used when the button is focused while in pressed state.
|
nodiscard |
Returns the color of the borders when in both down and hover state (mouse on button while button pressed)
|
nodiscard |
Returns the color of the borders that is used when the button is focused.
|
nodiscard |
Returns the color of the borders in the hover state (mouse on button, but not pressed)
|
nodiscard |
Returns the size of the borders.
|
nodiscard |
Returns the radius for the rounded corners if you want to draw a rounded rectangle as background.
|
nodiscard |
Returns the text color.
|
nodiscard |
Returns the text color that is used when the button is disabled.
|
nodiscard |
Returns the text color in the down state (mouse on button and left mouse button being held down)
|
nodiscard |
Returns the text color that is used when the button is disabled while in pressed state.
|
nodiscard |
Returns the text color that is used when the button is focused while in pressed state.
|
nodiscard |
Returns the text color when in both down and hover state (mouse on button while button pressed)
|
nodiscard |
Returns the text color that is used when the button is focused.
|
nodiscard |
Returns the text color in the hover state (mouse on button, but not pressed)
|
nodiscard |
Returns the outline color of the text (used when TextOutlineThickness > 0)
|
nodiscard |
Returns the thickness of the text outline.
|
nodiscard |
Returns text style.
|
nodiscard |
Returns text style used when the button is disabled.
|
nodiscard |
Returns text style in the down state (mouse on button and left mouse button being held down)
|
nodiscard |
Returns text style used when the button is disabled while in pressed state.
|
nodiscard |
Returns text style used when the button is focused while in pressed state.
|
nodiscard |
Returns text style when in both down and hover state (mouse on button while button pressed)
|
nodiscard |
Returns text style used when the button is focused.
|
nodiscard |
Returns text style in the hover state (mouse on button, but not pressed)
|
nodiscard |
Returns the image that is displayed.
|
nodiscard |
Returns the image that is displayed when the button is disabled.
|
nodiscard |
Returns the image that is displayed when the mouse is held down on top of the button.
|
nodiscard |
Returns the image that is displayed when the button is disabled while in pressed state.
|
nodiscard |
Returns the image that is drawn on top of the button image when the button is focused while in pressed state.
|
nodiscard |
Returns the image that is displayed when in both down and hover state (mouse on button while button pressed)
|
nodiscard |
Returns the image that is drawn on top of the button image when the button is focused.
|
nodiscard |
Returns the image that is displayed when the mouse is located on top of the button.
| void tgui::ButtonRenderer::setBackgroundColor | ( | Color | color | ) |
Changes the color of the background.
| color | New background color |
Note that this color is ignored when you set an image as background.
| void tgui::ButtonRenderer::setBackgroundColorDisabled | ( | Color | color | ) |
Changes the color of the background that is used when the button is disabled.
| color | New background color |
Note that this color is ignored when you set an image as background.
| void tgui::ButtonRenderer::setBackgroundColorDown | ( | Color | color | ) |
Changes the color of the background in the down state (mouse on button and left mouse button being held down)
| color | New background color |
Note that this color is ignored when you set an image as background.
| void tgui::ButtonRenderer::setBackgroundColorDownDisabled | ( | Color | color | ) |
Changes the color of the background that is used when the button is disabled while in pressed state.
| color | New background color |
Note that this color is ignored when you set an image as background.
| void tgui::ButtonRenderer::setBackgroundColorDownFocused | ( | Color | color | ) |
Changes the color of the background used when the button is focused while in pressed state.
| color | New background color |
Note that this color is ignored when you set an image as background.
| void tgui::ButtonRenderer::setBackgroundColorDownHover | ( | Color | color | ) |
Changes the color of the background when in both down and hover state (mouse on button while button pressed)
| color | New background color |
Note that this color is ignored when you set an image as background.
| void tgui::ButtonRenderer::setBackgroundColorFocused | ( | Color | color | ) |
Changes the color of the background that is used when the button is focused.
| color | New background color |
Note that this color is ignored when you set an image as background.
| void tgui::ButtonRenderer::setBackgroundColorHover | ( | Color | color | ) |
Changes the color of the background in the hover state (mouse on button, but not pressed)
| color | New background color |
Note that this color is ignored when you set an image as background.
| void tgui::ButtonRenderer::setBorderColor | ( | Color | color | ) |
Changes the color of the borders.
| color | New border color |
| void tgui::ButtonRenderer::setBorderColorDisabled | ( | Color | color | ) |
Changes the color of the borders that is used when the button is disabled.
| color | New border color |
| void tgui::ButtonRenderer::setBorderColorDown | ( | Color | color | ) |
Changes the color of the borders in the down state (mouse on button and left mouse button being held down)
| color | New border color |
| void tgui::ButtonRenderer::setBorderColorDownDisabled | ( | Color | color | ) |
Changes the color of the borders that is used when the button is disabled while in pressed state.
| color | New border color |
| void tgui::ButtonRenderer::setBorderColorDownFocused | ( | Color | color | ) |
Changes the color of the borders that is used when the button is focused while in pressed state.
| color | New border color |
| void tgui::ButtonRenderer::setBorderColorDownHover | ( | Color | color | ) |
Changes the color of the borders when in both down and hover state (mouse on button while button pressed)
| color | New border color |
| void tgui::ButtonRenderer::setBorderColorFocused | ( | Color | color | ) |
Changes the color of the borders that is used when the button is focused.
| color | New border color |
| void tgui::ButtonRenderer::setBorderColorHover | ( | Color | color | ) |
Changes the color of the borders in the hover state (mouse on button, but not pressed)
| color | New border color |
| void tgui::ButtonRenderer::setBorders | ( | const Borders & | borders | ) |
Changes the size of the borders.
| borders | Size of the borders |
| void tgui::ButtonRenderer::setRoundedBorderRadius | ( | float | radius | ) |
Changes the radius for the rounded corners if you want to draw a rounded rectangle as background.
| radius | Radius of the corners |
| void tgui::ButtonRenderer::setTextColor | ( | Color | color | ) |
Changes the color of the text.
| color | New text color |
| void tgui::ButtonRenderer::setTextColorDisabled | ( | Color | color | ) |
Changes the color of the text that is used when the button is disabled.
| color | New text color |
| void tgui::ButtonRenderer::setTextColorDown | ( | Color | color | ) |
Changes the color of the text in the down state (mouse on button and left mouse button being held down)
| color | New text color |
| void tgui::ButtonRenderer::setTextColorDownDisabled | ( | Color | color | ) |
Changes the color of the text that is used when the button is disabled while in pressed state.
| color | New text color |
| void tgui::ButtonRenderer::setTextColorDownFocused | ( | Color | color | ) |
Changes the color of the text that is used when the button is focused while in pressed state.
| color | New text color |
| void tgui::ButtonRenderer::setTextColorDownHover | ( | Color | color | ) |
Changes the text color when in both down and hover state (mouse on button while button pressed)
| color | New text color |
| void tgui::ButtonRenderer::setTextColorFocused | ( | Color | color | ) |
Changes the color of the text that is used when the button is focused.
| color | New text color |
| void tgui::ButtonRenderer::setTextColorHover | ( | Color | color | ) |
Changes the color of the text in the hover state (mouse on button, but not pressed)
| color | New text color |
| void tgui::ButtonRenderer::setTextOutlineColor | ( | Color | outlineColor | ) |
Changes the outline color of the text (used when TextOutlineThickness > 0)
| outlineColor | New text outline color |
| void tgui::ButtonRenderer::setTextOutlineThickness | ( | float | outlineThickness | ) |
Changes the thickness of the text outline (0 by default, which means there is no outline).
| outlineThickness | New text outline thickness |
| void tgui::ButtonRenderer::setTextStyle | ( | TextStyles | style | ) |
Changes the text style.
| style | New text style |
| void tgui::ButtonRenderer::setTextStyleDisabled | ( | TextStyles | style | ) |
Changes the text style that is used when the button is disabled.
| style | New text style |
| void tgui::ButtonRenderer::setTextStyleDown | ( | TextStyles | style | ) |
Changes the text style in the down state (mouse on button and left mouse button being held down)
| style | New text style |
| void tgui::ButtonRenderer::setTextStyleDownDisabled | ( | TextStyles | style | ) |
Changes the text style that is used when the button is disabled while in pressed state.
| style | New text style |
| void tgui::ButtonRenderer::setTextStyleDownFocused | ( | TextStyles | style | ) |
Changes the text style that is used when the button is focused while in pressed state.
| style | New text style |
| void tgui::ButtonRenderer::setTextStyleDownHover | ( | TextStyles | style | ) |
Changes the text style when in both down and hover state (mouse on button while button pressed)
| style | New text style |
| void tgui::ButtonRenderer::setTextStyleFocused | ( | TextStyles | style | ) |
Changes the text style that is used when the button is focused.
| style | New text style |
| void tgui::ButtonRenderer::setTextStyleHover | ( | TextStyles | style | ) |
Changes the text style in the hover state (mouse on button, but not pressed)
| style | New text style |
| void tgui::ButtonRenderer::setTexture | ( | const Texture & | texture | ) |
Change the image that is displayed.
| texture | The new texture |
When this image is set, the background color property will be ignored.
| void tgui::ButtonRenderer::setTextureDisabled | ( | const Texture & | texture | ) |
Changes the image that is displayed when the button is disabled.
| texture | The new disabled texture |
| void tgui::ButtonRenderer::setTextureDown | ( | const Texture & | texture | ) |
Changes the image that is displayed when the mouse is held down on top of the button.
| texture | The new down texture |
| void tgui::ButtonRenderer::setTextureDownDisabled | ( | const Texture & | texture | ) |
Changes the image that is displayed when the button is disabled while in pressed state.
| texture | The new disabled texture |
| void tgui::ButtonRenderer::setTextureDownFocused | ( | const Texture & | texture | ) |
Change the image that is drawn on top of the button image when the button is focused while in pressed state.
| texture | The new focus texture |
| void tgui::ButtonRenderer::setTextureDownHover | ( | const Texture & | texture | ) |
Changes the image that is displayed when in both down and hover state (mouse on button while button pressed)
| texture | The new hover texture |
| void tgui::ButtonRenderer::setTextureFocused | ( | const Texture & | texture | ) |
Change the image that is drawn on top of the button image when the button is focused.
| texture | The new focus texture |
| void tgui::ButtonRenderer::setTextureHover | ( | const Texture & | texture | ) |
Changes the image that is displayed when the mouse is located on top of the button.
| texture | The new hover texture |
|
inline |
Construct the renderer from renderer data.
| data | Renderer data to initialize the renderer with |