tgui::RadioButtonRenderer Class Reference

Inheritance diagram for tgui::RadioButtonRenderer:

Public Member Functions
void	setBorders (const Borders &borders)
	Changes the size of the borders.
Borders	getBorders () const
	Returns the size of the borders.
void	setTextDistanceRatio (float ratio)
	Changes the relative distance between the radio button and the text next to it.
float	getTextDistanceRatio () const
	The relative distance between the radio button and the text next to it.
void	setTextColor (Color color)
	Changes the color of the text.
Color	getTextColor () const
	Returns the text color.
void	setTextColorHover (Color color)
	Changes the color of the text in hover state (mouse is standing on top of the radio button)
Color	getTextColorHover () const
	Returns the text color in the hover state (mouse on radio button)
void	setTextColorDisabled (Color color)
	Changes the color of the text when the radio button is disabled.
Color	getTextColorDisabled () const
	Returns the text color when the radio button is disabled.
void	setTextColorChecked (Color color)
	Changes the color of the text when the radio button is checked.
Color	getTextColorChecked () const
	Returns the text color when the radio button is checked.
void	setTextColorCheckedHover (Color color)
	Changes the color of the text in hover state when the radio button is checked.
Color	getTextColorCheckedHover () const
	Returns the text color in the hover state when the radio button is checked.
void	setTextColorCheckedDisabled (Color color)
	Changes the color of the text when the radio button is checked and disabled.
Color	getTextColorCheckedDisabled () const
	Returns the text color when the radio button is checked and disabled.
void	setBackgroundColor (Color color)
	Changes the background color.
Color	getBackgroundColor () const
	Returns the background color.
void	setBackgroundColorHover (Color color)
	Changes the background color in hover state (mouse is standing on top of the radio button)
Color	getBackgroundColorHover () const
	Returns the background color in the hover state (mouse on radio button)
void	setBackgroundColorDisabled (Color color)
	Changes the background color when the radio button is disabled.
Color	getBackgroundColorDisabled () const
	Returns the background color when the radio button is disabled.
void	setBackgroundColorChecked (Color color)
	Changes the background color used when the radio button is checked.
Color	getBackgroundColorChecked () const
	Returns the background color used when the radio button is checked.
void	setBackgroundColorCheckedHover (Color color)
	Changes the background color in hover state used when the radio button is checked.
Color	getBackgroundColorCheckedHover () const
	Returns the background color in the hover state used when the radio button is checked.
void	setBackgroundColorCheckedDisabled (Color color)
	Changes the background color when the radio button is checked and disabled.
Color	getBackgroundColorCheckedDisabled () const
	Returns the background color when the radio button is checked and disabled.
void	setBorderColor (Color color)
	Changes the border color.
Color	getBorderColor () const
	Returns the border color.
void	setBorderColorHover (Color color)
	Changes the border color in hover state (mouse is standing on top of the radio button)
Color	getBorderColorHover () const
	Returns the border color in the hover state (mouse on radio button)
void	setBorderColorDisabled (Color color)
	Changes the border color when the radio button is disabled.
Color	getBorderColorDisabled () const
	Returns the border color when the radio button is disabled.
void	setBorderColorFocused (Color color)
	Changes the color of the borders that is used when the radio button is focused (while not hovered)
Color	getBorderColorFocused () const
	Returns the color of the borders that is used when the radio button is focused.
void	setBorderColorChecked (Color color)
	Changes the border color used when the radio button is checked.
Color	getBorderColorChecked () const
	Returns the border color used when the radio button is checked.
void	setBorderColorCheckedHover (Color color)
	Changes the border color in hover state used when the radio button is checked.
Color	getBorderColorCheckedHover () const
	Returns the border color in the hover state used when the radio button is checked.
void	setBorderColorCheckedDisabled (Color color)
	Changes the border color when the radio button is checked and disabled.
Color	getBorderColorCheckedDisabled () const
	Returns the border color when the radio button is checked and disabled.
void	setBorderColorCheckedFocused (Color color)
	Changes the color of the borders that is used when the radio button is checked and focused (while not hovered)
Color	getBorderColorCheckedFocused () const
	Returns the color of the borders that is used when the radio button is checked and focused.
void	setCheckColor (Color color)
	Changes the color that is used to fill the radio button when it is checked.
Color	getCheckColor () const
	Returns the check color.
void	setCheckColorHover (Color color)
	Changes the color that is used to fill the radio button when the mouse is on top of it.
Color	getCheckColorHover () const
	Returns the check color used to fill the radio button when the mouse is on top of it.
void	setCheckColorDisabled (Color color)
	Changes the color that is used to fill the radio button when the radio button is disabled.
Color	getCheckColorDisabled () const
	Returns the check color used to fill the radio button when the radio button is disabled.
void	setTextureUnchecked (const Texture &texture)
	Changes the image that is displayed when the checkbox is not checked.
const Texture &	getTextureUnchecked () const
	Returns the image that is displayed when the checkbox is not checked.
void	setTextureChecked (const Texture &texture)
	Changes the image that is displayed when the checkbox is checked.
const Texture &	getTextureChecked () const
	Returns the image that is displayed when the checkbox is checked.
void	setTextureUncheckedHover (const Texture &texture)
	Changes the image that is displayed when the checkbox is not checked and the mouse is on top of the checkbox.
const Texture &	getTextureUncheckedHover () const
	Returns the image that is displayed when the checkbox is not checked and the mouse is on top of the checkbox.
void	setTextureCheckedHover (const Texture &texture)
	Changes the image that is displayed when the checkbox is checked and the mouse is on top of the checkbox.
const Texture &	getTextureCheckedHover () const
	Returns the image that is displayed when the checkbox is checked and the mouse is on top of the checkbox.
void	setTextureUncheckedDisabled (const Texture &texture)
	Changes the image that is displayed when the checkbox is not checked and the checkbox is disabled.
const Texture &	getTextureUncheckedDisabled () const
	Returns the image that is displayed when the checkbox is not checked and the checkbox is disabled.
void	setTextureCheckedDisabled (const Texture &texture)
	Changes the image that is displayed when the checkbox is checked and the checkbox is disabled.
const Texture &	getTextureCheckedDisabled () const
	Returns the image that is displayed when the checkbox is checked and the checkbox is disabled.
void	setTextureUncheckedFocused (const Texture &texture)
	Changes the image that is displayed on top of the checkbox when it is unchecked and focused.
const Texture &	getTextureUncheckedFocused () const
	Returns the image that is displayed on top of the checkbox when it is unchecked and focused.
void	setTextureCheckedFocused (const Texture &texture)
	Changes the image that is displayed on top of the checkbox when it is checked and focused.
const Texture &	getTextureCheckedFocused () const
	Returns the image that is displayed on top of the checkbox when it is checked and focused.
void	setTextStyle (TextStyles style)
	Changes the text style.
TextStyles	getTextStyle () const
	Returns text style.
void	setTextStyleChecked (TextStyles style)
	Changes the text style in the checked state.
TextStyles	getTextStyleChecked () const
	Returns text style in the checked state.
	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::RadioButtonRenderer::getBackgroundColor ( ) const

nodiscard

Returns the background color.

Returns

background color

getBackgroundColorChecked()

Color tgui::RadioButtonRenderer::getBackgroundColorChecked ( ) const

nodiscard

Returns the background color used when the radio button is checked.

Returns

background color

getBackgroundColorCheckedDisabled()

Color tgui::RadioButtonRenderer::getBackgroundColorCheckedDisabled ( ) const

nodiscard

Returns the background color when the radio button is checked and disabled.

Returns

background color

getBackgroundColorCheckedHover()

Color tgui::RadioButtonRenderer::getBackgroundColorCheckedHover ( ) const

nodiscard

Returns the background color in the hover state used when the radio button is checked.

Returns

background color

getBackgroundColorDisabled()

Color tgui::RadioButtonRenderer::getBackgroundColorDisabled ( ) const

nodiscard

Returns the background color when the radio button is disabled.

Returns

background color

getBackgroundColorHover()

Color tgui::RadioButtonRenderer::getBackgroundColorHover ( ) const

nodiscard

Returns the background color in the hover state (mouse on radio button)

Returns

background color

getBorderColor()

Color tgui::RadioButtonRenderer::getBorderColor ( ) const

nodiscard

Returns the border color.

Returns

border color

getBorderColorChecked()

Color tgui::RadioButtonRenderer::getBorderColorChecked ( ) const

nodiscard

Returns the border color used when the radio button is checked.

Returns

border color

getBorderColorCheckedDisabled()

Color tgui::RadioButtonRenderer::getBorderColorCheckedDisabled ( ) const

nodiscard

Returns the border color when the radio button is checked and disabled.

Returns

border color

getBorderColorCheckedFocused()

Color tgui::RadioButtonRenderer::getBorderColorCheckedFocused ( ) const

nodiscard

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

Returns

Border color

getBorderColorCheckedHover()

Color tgui::RadioButtonRenderer::getBorderColorCheckedHover ( ) const

nodiscard

Returns the border color in the hover state used when the radio button is checked.

Returns

border color

getBorderColorDisabled()

Color tgui::RadioButtonRenderer::getBorderColorDisabled ( ) const

nodiscard

Returns the border color when the radio button is disabled.

Returns

border color

getBorderColorFocused()

Color tgui::RadioButtonRenderer::getBorderColorFocused ( ) const

nodiscard

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

Returns

Border color

getBorderColorHover()

Color tgui::RadioButtonRenderer::getBorderColorHover ( ) const

nodiscard

Returns the border color in the hover state (mouse on radio button)

Returns

border color

getBorders()

Borders tgui::RadioButtonRenderer::getBorders ( ) const

nodiscard

Returns the size of the borders.

Returns

border size

getCheckColor()

Color tgui::RadioButtonRenderer::getCheckColor ( ) const

nodiscard

Returns the check color.

Returns

check color

getCheckColorDisabled()

Color tgui::RadioButtonRenderer::getCheckColorDisabled ( ) const

nodiscard

Returns the check color used to fill the radio button when the radio button is disabled.

Returns

check color

getCheckColorHover()

Color tgui::RadioButtonRenderer::getCheckColorHover ( ) const

nodiscard

Returns the check color used to fill the radio button when the mouse is on top of it.

Returns

check color

getTextColor()

Color tgui::RadioButtonRenderer::getTextColor ( ) const

nodiscard

Returns the text color.

Returns

text color

getTextColorChecked()

Color tgui::RadioButtonRenderer::getTextColorChecked ( ) const

nodiscard

Returns the text color when the radio button is checked.

Returns

text color

getTextColorCheckedDisabled()

Color tgui::RadioButtonRenderer::getTextColorCheckedDisabled ( ) const

nodiscard

Returns the text color when the radio button is checked and disabled.

Returns

text color

getTextColorCheckedHover()

Color tgui::RadioButtonRenderer::getTextColorCheckedHover ( ) const

nodiscard

Returns the text color in the hover state when the radio button is checked.

Returns

text color

getTextColorDisabled()

Color tgui::RadioButtonRenderer::getTextColorDisabled ( ) const

nodiscard

Returns the text color when the radio button is disabled.

Returns

text color

getTextColorHover()

Color tgui::RadioButtonRenderer::getTextColorHover ( ) const

nodiscard

Returns the text color in the hover state (mouse on radio button)

Returns

text color

getTextDistanceRatio()

float tgui::RadioButtonRenderer::getTextDistanceRatio ( ) const

nodiscard

The relative distance between the radio button and the text next to it.

Returns

The ratio of the distance based on the width of the radio button

See also

setTextDistanceRatio

getTextStyle()

TextStyles tgui::RadioButtonRenderer::getTextStyle ( ) const

nodiscard

Returns text style.

Returns

Style of the text

getTextStyleChecked()

TextStyles tgui::RadioButtonRenderer::getTextStyleChecked ( ) const

nodiscard

Returns text style in the checked state.

Returns

Style of the text

getTextureChecked()

const Texture & tgui::RadioButtonRenderer::getTextureChecked ( ) const

nodiscard

Returns the image that is displayed when the checkbox is checked.

Returns

checked texture

getTextureCheckedDisabled()

const Texture & tgui::RadioButtonRenderer::getTextureCheckedDisabled ( ) const

nodiscard

Returns the image that is displayed when the checkbox is checked and the checkbox is disabled.

Returns

checked disabled texture

getTextureCheckedFocused()

const Texture & tgui::RadioButtonRenderer::getTextureCheckedFocused ( ) const

nodiscard

Returns the image that is displayed on top of the checkbox when it is checked and focused.

Returns

focused texture

getTextureCheckedHover()

const Texture & tgui::RadioButtonRenderer::getTextureCheckedHover ( ) const

nodiscard

Returns the image that is displayed when the checkbox is checked and the mouse is on top of the checkbox.

Returns

checked hover texture

getTextureUnchecked()

const Texture & tgui::RadioButtonRenderer::getTextureUnchecked ( ) const

nodiscard

Returns the image that is displayed when the checkbox is not checked.

Returns

unchecked texture

getTextureUncheckedDisabled()

const Texture & tgui::RadioButtonRenderer::getTextureUncheckedDisabled ( ) const

nodiscard

Returns the image that is displayed when the checkbox is not checked and the checkbox is disabled.

Returns

unchecked disabled texture

getTextureUncheckedFocused()

const Texture & tgui::RadioButtonRenderer::getTextureUncheckedFocused ( ) const

nodiscard

Returns the image that is displayed on top of the checkbox when it is unchecked and focused.

Returns

focused texture

getTextureUncheckedHover()

const Texture & tgui::RadioButtonRenderer::getTextureUncheckedHover ( ) const

nodiscard

Returns the image that is displayed when the checkbox is not checked and the mouse is on top of the checkbox.

Returns

unchecked hover texture

setBackgroundColor()

void tgui::RadioButtonRenderer::setBackgroundColor

(

Color

color

)

Changes the background color.

Parameters

color

New background color

This color is ignored when checked and unchecked images are set.

setBackgroundColorChecked()

void tgui::RadioButtonRenderer::setBackgroundColorChecked

(

Color

color

)

Changes the background color used when the radio button is checked.

Parameters

color

New background color

setBackgroundColorCheckedDisabled()

void tgui::RadioButtonRenderer::setBackgroundColorCheckedDisabled

(

Color

color

)

Changes the background color when the radio button is checked and disabled.

Parameters

color

New background color

setBackgroundColorCheckedHover()

void tgui::RadioButtonRenderer::setBackgroundColorCheckedHover

(

Color

color

)

Changes the background color in hover state used when the radio button is checked.

Parameters

color

New background color

setBackgroundColorDisabled()

void tgui::RadioButtonRenderer::setBackgroundColorDisabled

(

Color

color

)

Changes the background color when the radio button is disabled.

Parameters

color

New background color

setBackgroundColorHover()

void tgui::RadioButtonRenderer::setBackgroundColorHover

(

Color

color

)

Changes the background color in hover state (mouse is standing on top of the radio button)

Parameters

color

New background color

setBorderColor()

void tgui::RadioButtonRenderer::setBorderColor

(

Color

color

)

Changes the border color.

Parameters

color

New border color

setBorderColorChecked()

void tgui::RadioButtonRenderer::setBorderColorChecked

(

Color

color

)

Changes the border color used when the radio button is checked.

Parameters

color

New border color

setBorderColorCheckedDisabled()

void tgui::RadioButtonRenderer::setBorderColorCheckedDisabled

(

Color

color

)

Changes the border color when the radio button is checked and disabled.

Parameters

color

New border color

setBorderColorCheckedFocused()

void tgui::RadioButtonRenderer::setBorderColorCheckedFocused

(

Color

color

)

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

Parameters

color

New border color

setBorderColorCheckedHover()

void tgui::RadioButtonRenderer::setBorderColorCheckedHover

(

Color

color

)

Changes the border color in hover state used when the radio button is checked.

Parameters

color

New border color

setBorderColorDisabled()

void tgui::RadioButtonRenderer::setBorderColorDisabled

(

Color

color

)

Changes the border color when the radio button is disabled.

Parameters

color

New border color

setBorderColorFocused()

void tgui::RadioButtonRenderer::setBorderColorFocused

(

Color

color

)

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

Parameters

color

New border color

setBorderColorHover()

void tgui::RadioButtonRenderer::setBorderColorHover

(

Color

color

)

Changes the border color in hover state (mouse is standing on top of the radio button)

Parameters

color

New border color

setBorders()

void tgui::RadioButtonRenderer::setBorders

(

const Borders &

borders

)

Changes the size of the borders.

Parameters

borders

Size of the borders

setCheckColor()

void tgui::RadioButtonRenderer::setCheckColor

(

Color

color

)

Changes the color that is used to fill the radio button when it is checked.

Parameters

color

New check color

This color is ignored when checked and unchecked images are set.

setCheckColorDisabled()

void tgui::RadioButtonRenderer::setCheckColorDisabled

(

Color

color

)

Changes the color that is used to fill the radio button when the radio button is disabled.

Parameters

color

New check color

setCheckColorHover()

void tgui::RadioButtonRenderer::setCheckColorHover

(

Color

color

)

Changes the color that is used to fill the radio button when the mouse is on top of it.

Parameters

color

New check color

setTextColor()

void tgui::RadioButtonRenderer::setTextColor

(

Color

color

)

Changes the color of the text.

Parameters

color

New text color

setTextColorChecked()

void tgui::RadioButtonRenderer::setTextColorChecked

(

Color

color

)

Changes the color of the text when the radio button is checked.

Parameters

color

New text color

setTextColorCheckedDisabled()

void tgui::RadioButtonRenderer::setTextColorCheckedDisabled

(

Color

color

)

Changes the color of the text when the radio button is checked and disabled.

Parameters

color

New text color

setTextColorCheckedHover()

void tgui::RadioButtonRenderer::setTextColorCheckedHover

(

Color

color

)

Changes the color of the text in hover state when the radio button is checked.

Parameters

color

New text color

setTextColorDisabled()

void tgui::RadioButtonRenderer::setTextColorDisabled

(

Color

color

)

Changes the color of the text when the radio button is disabled.

Parameters

color

New text color

setTextColorHover()

void tgui::RadioButtonRenderer::setTextColorHover

(

Color

color

)

Changes the color of the text in hover state (mouse is standing on top of the radio button)

Parameters

color

New text color

setTextDistanceRatio()

void tgui::RadioButtonRenderer::setTextDistanceRatio

(

float

ratio

)

Changes the relative distance between the radio button and the text next to it.

Parameters

ratio

The ratio of the distance based on the width of the radio button

The default value is 0.2 which means that if the width of the radio button would be 50 pixels then the gap between the radio button and the text will be 10 pixels.

setTextStyle()

void tgui::RadioButtonRenderer::setTextStyle

(

TextStyles

style

)

Changes the text style.

Parameters

style

New text style

setTextStyleChecked()

void tgui::RadioButtonRenderer::setTextStyleChecked

(

TextStyles

style

)

Changes the text style in the checked state.

Parameters

style

New text style

setTextureChecked()

void tgui::RadioButtonRenderer::setTextureChecked

(

const Texture &

texture

)

Changes the image that is displayed when the checkbox is checked.

Parameters

texture

The new checked texture

When checked and unchecked images are set, the background and check color properties will be ignored.

setTextureCheckedDisabled()

void tgui::RadioButtonRenderer::setTextureCheckedDisabled

(

const Texture &

texture

)

Changes the image that is displayed when the checkbox is checked and the checkbox is disabled.

Parameters

texture

The new checked disabled texture

This only has effect when the normal checked and unchecked images are also set.

setTextureCheckedFocused()

void tgui::RadioButtonRenderer::setTextureCheckedFocused

(

const Texture &

texture

)

Changes the image that is displayed on top of the checkbox when it is checked and focused.

Parameters

texture

The new focused texture

This only has effect when the normal checked and unchecked images are also set. Pass an empty texture to unset the image.

setTextureCheckedHover()

void tgui::RadioButtonRenderer::setTextureCheckedHover

(

const Texture &

texture

)

Changes the image that is displayed when the checkbox is checked and the mouse is on top of the checkbox.

Parameters

texture

The new checked hover texture

This only has effect when the normal checked and unchecked images are also set.

setTextureUnchecked()

void tgui::RadioButtonRenderer::setTextureUnchecked

(

const Texture &

texture

)

Changes the image that is displayed when the checkbox is not checked.

Parameters

texture

The new unchecked texture

When checked and unchecked images are set, the background and check color properties will be ignored.

setTextureUncheckedDisabled()

void tgui::RadioButtonRenderer::setTextureUncheckedDisabled

(

const Texture &

texture

)

Changes the image that is displayed when the checkbox is not checked and the checkbox is disabled.

Parameters

texture

The new unchecked disabled texture

This only has effect when the normal checked and unchecked images are also set.

setTextureUncheckedFocused()

void tgui::RadioButtonRenderer::setTextureUncheckedFocused

(

const Texture &

texture

)

Changes the image that is displayed on top of the checkbox when it is unchecked and focused.

Parameters

texture

The new focused texture

This only has effect when the normal checked and unchecked images are also set. Pass an empty texture to unset the image.

setTextureUncheckedHover()

void tgui::RadioButtonRenderer::setTextureUncheckedHover

(

const Texture &

texture

)

Changes the image that is displayed when the checkbox is not checked and the mouse is on top of the checkbox.

Parameters

texture

The new unchecked hover texture

This only has effect when the normal checked and unchecked images are also set.

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/RadioButtonRenderer.hpp