tgui::ButtonRenderer Class Reference

Inheritance diagram for tgui::ButtonRenderer:

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	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	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	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	setTextColorFocused (Color color)
	Changes the color of the text that is used when the button is focused (while not hovered) More...
Color	getTextColorFocused () const
	Returns the text color that is used when the button is focused. More...
void	setBackgroundColor (Color color)
	Changes the color of the background. More...
Color	getBackgroundColor () const
	Returns the background color. 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	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	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	setBackgroundColorFocused (Color color)
	Changes the color of the background that is used when the button is focused (while not hovered) More...
Color	getBackgroundColorFocused () const
	Returns the background color that is used when the button is focused. More...
void	setBorderColor (Color color)
	Changes the color of the borders. More...
Color	getBorderColor () const
	Returns the color of the borders. 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	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	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	setBorderColorFocused (Color color)
	Changes the color of the borders that is used when the button is focused (while not hovered) More...
Color	getBorderColorFocused () const
	Returns the color of the borders that is used when the button is focused. More...
void	setTexture (const Texture &texture)
	Change the image that is displayed. More...
Texture &	getTexture () const
	Returns the image that is displayed. More...
void	setTextureHover (const Texture &texture)
	Changes the image that is displayed when the mouse is located on top of the button. More...
Texture &	getTextureHover () const
	Returns the image that is displayed when the mouse is located on top of the button. More...
void	setTextureDown (const Texture &texture)
	Changes the image that is displayed when the mouse is held down on top of the button. More...
Texture &	getTextureDown () const
	Returns the image that is displayed when the mouse is held down on top of the button. More...
void	setTextureDisabled (const Texture &texture)
	Changes the image that is displayed when the button is disabled. More...
Texture &	getTextureDisabled () const
	Returns the image that is displayed when the button is disabled. More...
void	setTextureFocused (const Texture &texture)
	Change the image that is drawn on top of the button image when the button is focused (while not hovered) More...
Texture &	getTextureFocused () const
	Returns the image that is drawn on top of the button image when the button is focused. More...
void	setTextStyle (TextStyle style)
	Changes the text style. More...
TextStyle	getTextStyle () const
	Returns text style. More...
void	setTextStyleHover (TextStyle style)
	Changes the text style in the hover state (mouse on button, but not pressed) More...
TextStyle	getTextStyleHover () const
	Returns text style in the hover state (mouse on button, but not pressed) More...
void	setTextStyleDown (TextStyle style)
	Changes the text style in the down state (mouse on button and left mouse button being held down) More...
TextStyle	getTextStyleDown () const
	Returns text style in the down state (mouse on button and left mouse button being held down) More...
void	setTextStyleDisabled (TextStyle style)
	Changes the text style that is used when the button is disabled. More...
TextStyle	getTextStyleDisabled () const
	Returns text style used when the button is disabled. More...
void	setTextStyleFocused (TextStyle style)
	Changes the text style that is used when the button is focused (while not hovered) More...
TextStyle	getTextStyleFocused () const
	Returns text style used when the button is focused. 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...
	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 std::string &property, ObjectConverter &&value)
	Changes a property of the renderer. More...
ObjectConverter	getProperty (const std::string &property) const
	Retrieves the value of a certain property. More...
const std::map< std::string, ObjectConverter > &	getPropertyValuePairs () const
	Gets a map with all properties and their values. More...
void	subscribe (const void *id, const std::function< void(const std::string &property)> &function)
	Subscribes a callback function to changes in the renderer. More...
void	unsubscribe (const void *id)
	Subscribes a callback function to changes in the renderer. More...
std::shared_ptr< RendererData >	getData () const
	Returns the renderer data. More...
std::shared_ptr< RendererData >	clone () 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

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

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

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

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)

Parameters

Text	outline color

getTextOutlineThickness()

float tgui::ButtonRenderer::getTextOutlineThickness

(

)

const

Returns the thickness of the text outline.

Parameters

Text	outline thickness

getTextStyle()

TextStyle tgui::ButtonRenderer::getTextStyle

(

)

const

Returns text style.

Returns

Style of the text

getTextStyleDisabled()

TextStyle tgui::ButtonRenderer::getTextStyleDisabled

(

)

const

Returns text style used when the button is disabled.

Returns

Style of the text

getTextStyleDown()

TextStyle 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

getTextStyleFocused()

TextStyle tgui::ButtonRenderer::getTextStyleFocused

(

)

const

Returns text style used when the button is focused.

Returns

Style of the text

getTextStyleHover()

TextStyle tgui::ButtonRenderer::getTextStyleHover

(

)

const

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

Returns

Style of the text

getTexture()

Texture & tgui::ButtonRenderer::getTexture

(

)

const

Returns the image that is displayed.

Returns

texture of the button

getTextureDisabled()

Texture & tgui::ButtonRenderer::getTextureDisabled

(

)

const

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

Returns

disabled texture

getTextureDown()

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

getTextureFocused()

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

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

color

New 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

color

New 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

color

New 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 (while not hovered)

Parameters

color

New 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

color

New 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

color

New border color

setBorderColorDisabled()

void tgui::ButtonRenderer::setBorderColorDisabled

(

Color

color

)

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

Parameters

color

New 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

color

New border color

setBorderColorFocused()

void tgui::ButtonRenderer::setBorderColorFocused

(

Color

color

)

Changes the color of the borders that is used when the button is focused (while not hovered)

Parameters

color

New 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

color

New border color

setBorders()

void tgui::ButtonRenderer::setBorders

(

const Borders &

borders

)

Changes the size of the borders.

Parameters

borders

Size of the borders

setTextColor()

void tgui::ButtonRenderer::setTextColor

(

Color

color

)

Changes the color of the text.

Parameters

color

New text color

setTextColorDisabled()

void tgui::ButtonRenderer::setTextColorDisabled

(

Color

color

)

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

Parameters

color

New 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

color

New text color

setTextColorFocused()

void tgui::ButtonRenderer::setTextColorFocused

(

Color

color

)

Changes the color of the text that is used when the button is focused (while not hovered)

Parameters

color

New 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

color

New text color

setTextOutlineColor()

void tgui::ButtonRenderer::setTextOutlineColor

(

Color

outlineColor

)

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

Parameters

outlineColor

New 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

outlineThickness

New text outline thickness

setTextStyle()

void tgui::ButtonRenderer::setTextStyle

(

TextStyle

style

)

Changes the text style.

Parameters

style

New text style

setTextStyleDisabled()

void tgui::ButtonRenderer::setTextStyleDisabled

(

TextStyle

style

)

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

Parameters

style

New text style

setTextStyleDown()

void tgui::ButtonRenderer::setTextStyleDown

(

TextStyle

style

)

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

Parameters

style

New text style

setTextStyleFocused()

void tgui::ButtonRenderer::setTextStyleFocused

(

TextStyle

style

)

Changes the text style that is used when the button is focused (while not hovered)

Parameters

style

New text style

setTextStyleHover()

void tgui::ButtonRenderer::setTextStyleHover

(

TextStyle

style

)

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

Parameters

style

New text style

setTexture()

void tgui::ButtonRenderer::setTexture

(

const Texture &

texture

)

Change the image that is displayed.

Parameters

texture

The 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

texture

The 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

texture

The new down 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 (while not hovered)

Parameters

texture

The 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

texture

The new hover texture

WidgetRenderer()

tgui::WidgetRenderer::WidgetRenderer ( const std::shared_ptr< RendererData > &  data )

inline

Construct the renderer from renderer data.

Parameters

data	Renderer data to initialize the renderer with

---

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

• include/TGUI/Renderers/ButtonRenderer.hpp