TGUI  0.10-dev
tgui::ButtonRenderer Class Reference
Inheritance diagram for tgui::ButtonRenderer:
tgui::WidgetRenderer

Public Member Functions

void setBorders (const Borders &borders)
 Changes the size of the borders. More...
 
Borders getBorders () const
 Returns the size of the borders. More...
 
void setTextColor (Color color)
 Changes the color of the text. More...
 
Color getTextColor () const
 Returns the text color. More...
 
void setTextColorDown (Color color)
 Changes the color of the text in the down state (mouse on button and left mouse button being held down) More...
 
Color getTextColorDown () const
 Returns the text color in the down state (mouse on button and left mouse button being held down) More...
 
void setTextColorHover (Color color)
 Changes the color of the text in the hover state (mouse on button, but not pressed) More...
 
Color getTextColorHover () const
 Returns the text color in the hover state (mouse on button, but not pressed) More...
 
void setTextColorDownHover (Color color)
 Changes the text color when in both down and hover state (mouse on button while button pressed) More...
 
Color getTextColorDownHover () const
 Returns the text color when in both down and hover state (mouse on button while button pressed) More...
 
void setTextColorDisabled (Color color)
 Changes the color of the text that is used when the button is disabled. More...
 
Color getTextColorDisabled () const
 Returns the text color that is used when the button is disabled. More...
 
void setTextColorDownDisabled (Color color)
 Changes the color of the text that is used when the button is disabled while in pressed state. More...
 
Color getTextColorDownDisabled () const
 Returns the text color that is used when the button is disabled while in pressed state. More...
 
void setTextColorFocused (Color color)
 Changes the color of the text that is used when the button is focused. More...
 
Color getTextColorFocused () const
 Returns the text color that is used when the button is focused. More...
 
void setTextColorDownFocused (Color color)
 Changes the color of the text that is used when the button is focused while in pressed state. More...
 
Color getTextColorDownFocused () const
 Returns the text color that is used when the button is focused while in pressed state. More...
 
void setBackgroundColor (Color color)
 Changes the color of the background. More...
 
Color getBackgroundColor () const
 Returns the background color. More...
 
void setBackgroundColorDown (Color color)
 Changes the color of the background in the down state (mouse on button and left mouse button being held down) More...
 
Color getBackgroundColorDown () const
 Returns the background color in the down state (mouse on button and left mouse button being held down) More...
 
void setBackgroundColorHover (Color color)
 Changes the color of the background in the hover state (mouse on button, but not pressed) More...
 
Color getBackgroundColorHover () const
 Returns the background color in the hover state (mouse on button, but not pressed) More...
 
void setBackgroundColorDownHover (Color color)
 Changes the color of the background when in both down and hover state (mouse on button while button pressed) More...
 
Color getBackgroundColorDownHover () const
 Returns the background color when in both down and hover state (mouse on button while button pressed) More...
 
void setBackgroundColorDisabled (Color color)
 Changes the color of the background that is used when the button is disabled. More...
 
Color getBackgroundColorDisabled () const
 Returns the background color that is used when the button is disabled. More...
 
void setBackgroundColorDownDisabled (Color color)
 Changes the color of the background that is used when the button is disabled while in pressed state. More...
 
Color getBackgroundColorDownDisabled () const
 Returns the background color that is used when the button is disabled while in pressed state. More...
 
void setBackgroundColorFocused (Color color)
 Changes the color of the background that is used when the button is focused. More...
 
Color getBackgroundColorFocused () const
 Returns the background color that is used when the button is focused. More...
 
void setBackgroundColorDownFocused (Color color)
 Changes the color of the background used when the button is focused while in pressed state. More...
 
Color getBackgroundColorDownFocused () const
 Returns the background color that is used when the button is focused while in pressed state. More...
 
void setBorderColor (Color color)
 Changes the color of the borders. More...
 
Color getBorderColor () const
 Returns the color of the borders. More...
 
void setBorderColorDown (Color color)
 Changes the color of the borders in the down state (mouse on button and left mouse button being held down) More...
 
Color getBorderColorDown () const
 Returns the color of the borders in the down state (mouse on button and left mouse button being held down) More...
 
void setBorderColorHover (Color color)
 Changes the color of the borders in the hover state (mouse on button, but not pressed) More...
 
Color getBorderColorHover () const
 Returns the color of the borders in the hover state (mouse on button, but not pressed) More...
 
void setBorderColorDownHover (Color color)
 Changes the color of the borders when in both down and hover state (mouse on button while button pressed) More...
 
Color getBorderColorDownHover () const
 Returns the color of the borders when in both down and hover state (mouse on button while button pressed) More...
 
void setBorderColorDisabled (Color color)
 Changes the color of the borders that is used when the button is disabled. More...
 
Color getBorderColorDisabled () const
 Returns the color of the borders that is used when the button is disabled. More...
 
void setBorderColorDownDisabled (Color color)
 Changes the color of the borders that is used when the button is disabled while in pressed state. More...
 
Color getBorderColorDownDisabled () const
 Returns the color of the borders that is used when the button is disabled while in pressed state. More...
 
void setBorderColorFocused (Color color)
 Changes the color of the borders that is used when the button is focused. More...
 
Color getBorderColorFocused () const
 Returns the color of the borders that is used when the button is focused. More...
 
void setBorderColorDownFocused (Color color)
 Changes the color of the borders that is used when the button is focused while in pressed state. More...
 
Color getBorderColorDownFocused () const
 Returns the color of the borders that is used when the button is focused while in pressed state. More...
 
void setTexture (const Texture &texture)
 Change the image that is displayed. More...
 
const TexturegetTexture () const
 Returns the image that is displayed. More...
 
void setTextureDown (const Texture &texture)
 Changes the image that is displayed when the mouse is held down on top of the button. More...
 
const TexturegetTextureDown () const
 Returns the image that is displayed when the mouse is held down on top of the button. More...
 
void setTextureHover (const Texture &texture)
 Changes the image that is displayed when the mouse is located on top of the button. More...
 
const TexturegetTextureHover () const
 Returns the image that is displayed when the mouse is located on top of the button. More...
 
void setTextureDownHover (const Texture &texture)
 Changes the image that is displayed when in both down and hover state (mouse on button while button pressed) More...
 
const TexturegetTextureDownHover () const
 Returns the image that is displayed when in both down and hover state (mouse on button while button pressed) More...
 
void setTextureDisabled (const Texture &texture)
 Changes the image that is displayed when the button is disabled. More...
 
const TexturegetTextureDisabled () const
 Returns the image that is displayed when the button is disabled. More...
 
void setTextureDownDisabled (const Texture &texture)
 Changes the image that is displayed when the button is disabled while in pressed state. More...
 
const TexturegetTextureDownDisabled () const
 Returns the image that is displayed when the button is disabled while in pressed state. More...
 
void setTextureFocused (const Texture &texture)
 Change the image that is drawn on top of the button image when the button is focused. More...
 
const TexturegetTextureFocused () const
 Returns the image that is drawn on top of the button image when the button is focused. More...
 
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. More...
 
const TexturegetTextureDownFocused () const
 Returns the image that is drawn on top of the button image when the button is focused while in pressed state. More...
 
void setTextStyle (TextStyles style)
 Changes the text style. More...
 
TextStyles getTextStyle () const
 Returns text style. More...
 
void setTextStyleDown (TextStyles style)
 Changes the text style in the down state (mouse on button and left mouse button being held down) More...
 
TextStyles getTextStyleDown () const
 Returns text style in the down state (mouse on button and left mouse button being held down) More...
 
void setTextStyleHover (TextStyles style)
 Changes the text style in the hover state (mouse on button, but not pressed) More...
 
TextStyles getTextStyleHover () const
 Returns text style in the hover state (mouse on button, but not pressed) More...
 
void setTextStyleDownHover (TextStyles style)
 Changes the text style when in both down and hover state (mouse on button while button pressed) More...
 
TextStyles getTextStyleDownHover () const
 Returns text style when in both down and hover state (mouse on button while button pressed) More...
 
void setTextStyleDisabled (TextStyles style)
 Changes the text style that is used when the button is disabled. More...
 
TextStyles getTextStyleDisabled () const
 Returns text style used when the button is disabled. More...
 
void setTextStyleDownDisabled (TextStyles style)
 Changes the text style that is used when the button is disabled while in pressed state. More...
 
TextStyles getTextStyleDownDisabled () const
 Returns text style used when the button is disabled while in pressed state. More...
 
void setTextStyleFocused (TextStyles style)
 Changes the text style that is used when the button is focused. More...
 
TextStyles getTextStyleFocused () const
 Returns text style used when the button is focused. More...
 
void setTextStyleDownFocused (TextStyles style)
 Changes the text style that is used when the button is focused while in pressed state. More...
 
TextStyles getTextStyleDownFocused () const
 Returns text style used when the button is focused while in pressed state. More...
 
void setTextOutlineColor (Color outlineColor)
 Changes the outline color of the text (used when TextOutlineThickness > 0) More...
 
Color getTextOutlineColor () const
 Returns the outline color of the text (used when TextOutlineThickness > 0) More...
 
void setTextOutlineThickness (float outlineThickness)
 Changes the thickness of the text outline (0 by default, which means there is no outline). More...
 
float getTextOutlineThickness () const
 Returns the thickness of the text outline. More...
 
void setRoundedBorderRadius (float radius)
 Changes the radius for the rounded corners if you want to draw a rounded rectangle as background. More...
 
float getRoundedBorderRadius () const
 Returns the radius for the rounded corners if you want to draw a rounded rectangle as background. More...
 
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. 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 setOpacityDisabled (float opacity)
 Changes the opacity of the widget when it is disabled. More...
 
float getOpacityDisabled () const
 Returns the opacity of the widget when it is disabled. 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 setTransparentTexture (bool ignoreTransparentParts)
 Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state. More...
 
bool getTransparentTexture () const
 Returns whether mouse events should be ignored on transparent parts of the texture of the widget. More...
 
void setProperty (const String &property, ObjectConverter &&value)
 Changes a property of the renderer. More...
 
ObjectConverter getProperty (const String &property) const
 Retrieves the value of a certain property. More...
 
const std::map< String, ObjectConverter > & getPropertyValuePairs () const
 Gets a map with all properties and their values. More...
 
void subscribe (const void *id, const std::function< void(const 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::ButtonRenderer::getBackgroundColor ( ) const

Returns the background color.

Returns
background color

◆ getBackgroundColorDisabled()

Color tgui::ButtonRenderer::getBackgroundColorDisabled ( ) const

Returns the background color that is used when the button is disabled.

Returns
background color

◆ getBackgroundColorDown()

Color tgui::ButtonRenderer::getBackgroundColorDown ( ) const

Returns the background color in the down state (mouse on button and left mouse button being held down)

Returns
background color

◆ getBackgroundColorDownDisabled()

Color tgui::ButtonRenderer::getBackgroundColorDownDisabled ( ) const

Returns the background color that is used when the button is disabled while in pressed state.

Returns
background color

◆ getBackgroundColorDownFocused()

Color tgui::ButtonRenderer::getBackgroundColorDownFocused ( ) const

Returns the background color that is used when the button is focused while in pressed state.

Returns
background color

◆ getBackgroundColorDownHover()

Color tgui::ButtonRenderer::getBackgroundColorDownHover ( ) const

Returns the background color when in both down and hover state (mouse on button while button pressed)

Returns
background color

◆ getBackgroundColorFocused()

Color tgui::ButtonRenderer::getBackgroundColorFocused ( ) const

Returns the background color that is used when the button is focused.

Returns
background color

◆ getBackgroundColorHover()

Color tgui::ButtonRenderer::getBackgroundColorHover ( ) const

Returns the background color in the hover state (mouse on button, but not pressed)

Returns
background color

◆ getBorderColor()

Color tgui::ButtonRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

◆ getBorderColorDisabled()

Color tgui::ButtonRenderer::getBorderColorDisabled ( ) const

Returns the color of the borders that is used when the button is disabled.

Returns
Border color

◆ getBorderColorDown()

Color tgui::ButtonRenderer::getBorderColorDown ( ) const

Returns the color of the borders in the down state (mouse on button and left mouse button being held down)

Returns
Border color

◆ getBorderColorDownDisabled()

Color tgui::ButtonRenderer::getBorderColorDownDisabled ( ) const

Returns the color of the borders that is used when the button is disabled while in pressed state.

Returns
Border color

◆ getBorderColorDownFocused()

Color tgui::ButtonRenderer::getBorderColorDownFocused ( ) const

Returns the color of the borders that is used when the button is focused while in pressed state.

Returns
Border color

◆ getBorderColorDownHover()

Color tgui::ButtonRenderer::getBorderColorDownHover ( ) const

Returns the color of the borders when in both down and hover state (mouse on button while button pressed)

Returns
Border color

◆ getBorderColorFocused()

Color tgui::ButtonRenderer::getBorderColorFocused ( ) const

Returns the color of the borders that is used when the button is focused.

Returns
Border color

◆ getBorderColorHover()

Color tgui::ButtonRenderer::getBorderColorHover ( ) const

Returns the color of the borders in the hover state (mouse on button, but not pressed)

Returns
Border color

◆ getBorders()

Borders tgui::ButtonRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getRoundedBorderRadius()

float tgui::ButtonRenderer::getRoundedBorderRadius ( ) const

Returns the radius for the rounded corners if you want to draw a rounded rectangle as background.

Returns
Radius of the corners

◆ getTextColor()

Color tgui::ButtonRenderer::getTextColor ( ) const

Returns the text color.

Returns
text color

◆ getTextColorDisabled()

Color tgui::ButtonRenderer::getTextColorDisabled ( ) const

Returns the text color that is used when the button is disabled.

Returns
text color

◆ getTextColorDown()

Color tgui::ButtonRenderer::getTextColorDown ( ) const

Returns the text color in the down state (mouse on button and left mouse button being held down)

Returns
text color

◆ getTextColorDownDisabled()

Color tgui::ButtonRenderer::getTextColorDownDisabled ( ) const

Returns the text color that is used when the button is disabled while in pressed state.

Returns
text color

◆ getTextColorDownFocused()

Color tgui::ButtonRenderer::getTextColorDownFocused ( ) const

Returns the text color that is used when the button is focused while in pressed state.

Returns
text color

◆ getTextColorDownHover()

Color tgui::ButtonRenderer::getTextColorDownHover ( ) const

Returns the text color when in both down and hover state (mouse on button while button pressed)

Returns
text color

◆ getTextColorFocused()

Color tgui::ButtonRenderer::getTextColorFocused ( ) const

Returns the text color that is used when the button is focused.

Returns
text color

◆ getTextColorHover()

Color tgui::ButtonRenderer::getTextColorHover ( ) const

Returns the text color in the hover state (mouse on button, but not pressed)

Returns
text color

◆ getTextOutlineColor()

Color tgui::ButtonRenderer::getTextOutlineColor ( ) const

Returns the outline color of the text (used when TextOutlineThickness > 0)

Returns
Text outline color

◆ getTextOutlineThickness()

float tgui::ButtonRenderer::getTextOutlineThickness ( ) const

Returns the thickness of the text outline.

Returns
Text outline thickness

◆ getTextStyle()

TextStyles tgui::ButtonRenderer::getTextStyle ( ) const

Returns text style.

Returns
Style of the text

◆ getTextStyleDisabled()

TextStyles tgui::ButtonRenderer::getTextStyleDisabled ( ) const

Returns text style used when the button is disabled.

Returns
Style of the text

◆ getTextStyleDown()

TextStyles tgui::ButtonRenderer::getTextStyleDown ( ) const

Returns text style in the down state (mouse on button and left mouse button being held down)

Returns
Style of the text

◆ getTextStyleDownDisabled()

TextStyles tgui::ButtonRenderer::getTextStyleDownDisabled ( ) const

Returns text style used when the button is disabled while in pressed state.

Returns
Style of the text

◆ getTextStyleDownFocused()

TextStyles tgui::ButtonRenderer::getTextStyleDownFocused ( ) const

Returns text style used when the button is focused while in pressed state.

Returns
Style of the text

◆ getTextStyleDownHover()

TextStyles tgui::ButtonRenderer::getTextStyleDownHover ( ) const

Returns text style when in both down and hover state (mouse on button while button pressed)

Returns
Style of the text

◆ getTextStyleFocused()

TextStyles tgui::ButtonRenderer::getTextStyleFocused ( ) const

Returns text style used when the button is focused.

Returns
Style of the text

◆ getTextStyleHover()

TextStyles tgui::ButtonRenderer::getTextStyleHover ( ) const

Returns text style in the hover state (mouse on button, but not pressed)

Returns
Style of the text

◆ getTexture()

const Texture & tgui::ButtonRenderer::getTexture ( ) const

Returns the image that is displayed.

Returns
texture of the button

◆ getTextureDisabled()

const Texture & tgui::ButtonRenderer::getTextureDisabled ( ) const

Returns the image that is displayed when the button is disabled.

Returns
disabled texture

◆ getTextureDown()

const Texture & tgui::ButtonRenderer::getTextureDown ( ) const

Returns the image that is displayed when the mouse is held down on top of the button.

Returns
down texture

◆ getTextureDownDisabled()

const Texture & tgui::ButtonRenderer::getTextureDownDisabled ( ) const

Returns the image that is displayed when the button is disabled while in pressed state.

Returns
disabled texture

◆ getTextureDownFocused()

const Texture & tgui::ButtonRenderer::getTextureDownFocused ( ) const

Returns the image that is drawn on top of the button image when the button is focused while in pressed state.

Returns
focused texture

◆ getTextureDownHover()

const Texture & tgui::ButtonRenderer::getTextureDownHover ( ) const

Returns the image that is displayed when in both down and hover state (mouse on button while button pressed)

Returns
hover texture

◆ getTextureFocused()

const Texture & tgui::ButtonRenderer::getTextureFocused ( ) const

Returns the image that is drawn on top of the button image when the button is focused.

Returns
focused texture

◆ getTextureHover()

const Texture & tgui::ButtonRenderer::getTextureHover ( ) const

Returns the image that is displayed when the mouse is located on top of the button.

Returns
hover texture

◆ setBackgroundColor()

void tgui::ButtonRenderer::setBackgroundColor ( Color  color)

Changes the color of the background.

Parameters
colorNew background color

Note that this color is ignored when you set an image as background.

◆ setBackgroundColorDisabled()

void tgui::ButtonRenderer::setBackgroundColorDisabled ( Color  color)

Changes the color of the background that is used when the button is disabled.

Parameters
colorNew background color

Note that this color is ignored when you set an image as background.

◆ setBackgroundColorDown()

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)

Parameters
colorNew background color

Note that this color is ignored when you set an image as background.

◆ setBackgroundColorDownDisabled()

void tgui::ButtonRenderer::setBackgroundColorDownDisabled ( Color  color)

Changes the color of the background that is used when the button is disabled while in pressed state.

Parameters
colorNew background color

Note that this color is ignored when you set an image as background.

◆ setBackgroundColorDownFocused()

void tgui::ButtonRenderer::setBackgroundColorDownFocused ( Color  color)

Changes the color of the background used when the button is focused while in pressed state.

Parameters
colorNew background color

Note that this color is ignored when you set an image as background.

◆ setBackgroundColorDownHover()

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)

Parameters
colorNew background color

Note that this color is ignored when you set an image as background.

◆ setBackgroundColorFocused()

void tgui::ButtonRenderer::setBackgroundColorFocused ( Color  color)

Changes the color of the background that is used when the button is focused.

Parameters
colorNew background color

Note that this color is ignored when you set an image as background.

◆ setBackgroundColorHover()

void tgui::ButtonRenderer::setBackgroundColorHover ( Color  color)

Changes the color of the background in the hover state (mouse on button, but not pressed)

Parameters
colorNew background color

Note that this color is ignored when you set an image as background.

◆ setBorderColor()

void tgui::ButtonRenderer::setBorderColor ( Color  color)

Changes the color of the borders.

Parameters
colorNew border color

◆ setBorderColorDisabled()

void tgui::ButtonRenderer::setBorderColorDisabled ( Color  color)

Changes the color of the borders that is used when the button is disabled.

Parameters
colorNew border color

◆ setBorderColorDown()

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)

Parameters
colorNew border color

◆ setBorderColorDownDisabled()

void tgui::ButtonRenderer::setBorderColorDownDisabled ( Color  color)

Changes the color of the borders that is used when the button is disabled while in pressed state.

Parameters
colorNew border color

◆ setBorderColorDownFocused()

void tgui::ButtonRenderer::setBorderColorDownFocused ( Color  color)

Changes the color of the borders that is used when the button is focused while in pressed state.

Parameters
colorNew border color

◆ setBorderColorDownHover()

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)

Parameters
colorNew border color

◆ setBorderColorFocused()

void tgui::ButtonRenderer::setBorderColorFocused ( Color  color)

Changes the color of the borders that is used when the button is focused.

Parameters
colorNew border color

◆ setBorderColorHover()

void tgui::ButtonRenderer::setBorderColorHover ( Color  color)

Changes the color of the borders in the hover state (mouse on button, but not pressed)

Parameters
colorNew border color

◆ setBorders()

void tgui::ButtonRenderer::setBorders ( const Borders borders)

Changes the size of the borders.

Parameters
bordersSize of the borders

◆ setRoundedBorderRadius()

void tgui::ButtonRenderer::setRoundedBorderRadius ( float  radius)

Changes the radius for the rounded corners if you want to draw a rounded rectangle as background.

Parameters
radiusRadius of the corners
Warning
This property is ignored when textures are used as background

◆ setTextColor()

void tgui::ButtonRenderer::setTextColor ( Color  color)

Changes the color of the text.

Parameters
colorNew text color

◆ setTextColorDisabled()

void tgui::ButtonRenderer::setTextColorDisabled ( Color  color)

Changes the color of the text that is used when the button is disabled.

Parameters
colorNew text color

◆ setTextColorDown()

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)

Parameters
colorNew text color

◆ setTextColorDownDisabled()

void tgui::ButtonRenderer::setTextColorDownDisabled ( Color  color)

Changes the color of the text that is used when the button is disabled while in pressed state.

Parameters
colorNew text color

◆ setTextColorDownFocused()

void tgui::ButtonRenderer::setTextColorDownFocused ( Color  color)

Changes the color of the text that is used when the button is focused while in pressed state.

Parameters
colorNew text color

◆ setTextColorDownHover()

void tgui::ButtonRenderer::setTextColorDownHover ( Color  color)

Changes the text color when in both down and hover state (mouse on button while button pressed)

Parameters
colorNew text color

◆ setTextColorFocused()

void tgui::ButtonRenderer::setTextColorFocused ( Color  color)

Changes the color of the text that is used when the button is focused.

Parameters
colorNew text color

◆ setTextColorHover()

void tgui::ButtonRenderer::setTextColorHover ( Color  color)

Changes the color of the text in the hover state (mouse on button, but not pressed)

Parameters
colorNew text color

◆ setTextOutlineColor()

void tgui::ButtonRenderer::setTextOutlineColor ( Color  outlineColor)

Changes the outline color of the text (used when TextOutlineThickness > 0)

Parameters
outlineColorNew text outline color

◆ setTextOutlineThickness()

void tgui::ButtonRenderer::setTextOutlineThickness ( float  outlineThickness)

Changes the thickness of the text outline (0 by default, which means there is no outline).

Parameters
outlineThicknessNew text outline thickness

◆ setTextStyle()

void tgui::ButtonRenderer::setTextStyle ( TextStyles  style)

Changes the text style.

Parameters
styleNew text style

◆ setTextStyleDisabled()

void tgui::ButtonRenderer::setTextStyleDisabled ( TextStyles  style)

Changes the text style that is used when the button is disabled.

Parameters
styleNew text style

◆ setTextStyleDown()

void tgui::ButtonRenderer::setTextStyleDown ( TextStyles  style)

Changes the text style in the down state (mouse on button and left mouse button being held down)

Parameters
styleNew text style

◆ setTextStyleDownDisabled()

void tgui::ButtonRenderer::setTextStyleDownDisabled ( TextStyles  style)

Changes the text style that is used when the button is disabled while in pressed state.

Parameters
styleNew text style

◆ setTextStyleDownFocused()

void tgui::ButtonRenderer::setTextStyleDownFocused ( TextStyles  style)

Changes the text style that is used when the button is focused while in pressed state.

Parameters
styleNew text style

◆ setTextStyleDownHover()

void tgui::ButtonRenderer::setTextStyleDownHover ( TextStyles  style)

Changes the text style when in both down and hover state (mouse on button while button pressed)

Parameters
styleNew text style

◆ setTextStyleFocused()

void tgui::ButtonRenderer::setTextStyleFocused ( TextStyles  style)

Changes the text style that is used when the button is focused.

Parameters
styleNew text style

◆ setTextStyleHover()

void tgui::ButtonRenderer::setTextStyleHover ( TextStyles  style)

Changes the text style in the hover state (mouse on button, but not pressed)

Parameters
styleNew text style

◆ setTexture()

void tgui::ButtonRenderer::setTexture ( const Texture texture)

Change the image that is displayed.

Parameters
textureThe new texture

When this image is set, the background color property will be ignored.

◆ setTextureDisabled()

void tgui::ButtonRenderer::setTextureDisabled ( const Texture texture)

Changes the image that is displayed when the button is disabled.

Parameters
textureThe new disabled texture

◆ setTextureDown()

void tgui::ButtonRenderer::setTextureDown ( const Texture texture)

Changes the image that is displayed when the mouse is held down on top of the button.

Parameters
textureThe new down texture

◆ setTextureDownDisabled()

void tgui::ButtonRenderer::setTextureDownDisabled ( const Texture texture)

Changes the image that is displayed when the button is disabled while in pressed state.

Parameters
textureThe new disabled texture

◆ setTextureDownFocused()

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.

Parameters
textureThe new focus texture

◆ setTextureDownHover()

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)

Parameters
textureThe new hover texture

◆ setTextureFocused()

void tgui::ButtonRenderer::setTextureFocused ( const Texture texture)

Change the image that is drawn on top of the button image when the button is focused.

Parameters
textureThe new focus texture

◆ setTextureHover()

void tgui::ButtonRenderer::setTextureHover ( const Texture texture)

Changes the image that is displayed when the mouse is located on top of the button.

Parameters
textureThe new hover 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: