Inheritance diagram for tgui::ButtonRenderer:

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

Member Function Documentation

◆ getBackgroundColor()

Color tgui::ButtonRenderer::getBackgroundColor ( ) const

nodiscard

Returns the background color.

Returns: background color

◆ getBackgroundColorDisabled()

Color tgui::ButtonRenderer::getBackgroundColorDisabled ( ) const

nodiscard

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

Returns: background color

◆ getBackgroundColorDown()

Color tgui::ButtonRenderer::getBackgroundColorDown ( ) const

nodiscard

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

nodiscard

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

nodiscard

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

nodiscard

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

nodiscard

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

Returns: background color

◆ getBackgroundColorHover()

Color tgui::ButtonRenderer::getBackgroundColorHover ( ) const

nodiscard

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

Returns: background color

◆ getBorderColor()

Color tgui::ButtonRenderer::getBorderColor ( ) const

nodiscard

Returns the color of the borders.

Returns: Border color

◆ getBorderColorDisabled()

Color tgui::ButtonRenderer::getBorderColorDisabled ( ) const

nodiscard

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

Returns: Border color

◆ getBorderColorDown()

Color tgui::ButtonRenderer::getBorderColorDown ( ) const

nodiscard

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

nodiscard

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

nodiscard

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

nodiscard

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

nodiscard

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

Returns: Border color

◆ getBorderColorHover()

Color tgui::ButtonRenderer::getBorderColorHover ( ) const

nodiscard

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

nodiscard

Returns the size of the borders.

Returns: border size

◆ getRoundedBorderRadius()

float tgui::ButtonRenderer::getRoundedBorderRadius ( ) const

nodiscard

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

nodiscard

Returns the text color.

Returns: text color

◆ getTextColorDisabled()

Color tgui::ButtonRenderer::getTextColorDisabled ( ) const

nodiscard

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

Returns: text color

◆ getTextColorDown()

Color tgui::ButtonRenderer::getTextColorDown ( ) const

nodiscard

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

nodiscard

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

nodiscard

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

nodiscard

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

nodiscard

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

Returns: text color

◆ getTextColorHover()

Color tgui::ButtonRenderer::getTextColorHover ( ) const

nodiscard

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

Returns: text color

◆ getTextOutlineColor()

Color tgui::ButtonRenderer::getTextOutlineColor ( ) const

nodiscard

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

Returns: Text outline color

◆ getTextOutlineThickness()

float tgui::ButtonRenderer::getTextOutlineThickness ( ) const

nodiscard

Returns the thickness of the text outline.

Returns: Text outline thickness

◆ getTextStyle()

TextStyles tgui::ButtonRenderer::getTextStyle ( ) const

nodiscard

Returns text style.

Returns: Style of the text

◆ getTextStyleDisabled()

TextStyles tgui::ButtonRenderer::getTextStyleDisabled ( ) const

nodiscard

Returns text style used when the button is disabled.

Returns: Style of the text

◆ getTextStyleDown()

TextStyles tgui::ButtonRenderer::getTextStyleDown ( ) const

nodiscard

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

nodiscard

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

Returns: Style of the text

◆ getTextStyleDownFocused()

TextStyles tgui::ButtonRenderer::getTextStyleDownFocused ( ) const

nodiscard

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

Returns: Style of the text

◆ getTextStyleDownHover()

TextStyles tgui::ButtonRenderer::getTextStyleDownHover ( ) const

nodiscard

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

nodiscard

Returns text style used when the button is focused.

Returns: Style of the text

◆ getTextStyleHover()

TextStyles tgui::ButtonRenderer::getTextStyleHover ( ) const

nodiscard

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

nodiscard

Returns the image that is displayed.

Returns: texture of the button

◆ getTextureDisabled()

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

nodiscard

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

Returns: disabled texture

◆ getTextureDown()

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

nodiscard

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

nodiscard

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

nodiscard

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

nodiscard

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

nodiscard

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

nodiscard

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

color New background color