#include <CheckBoxRenderer.h>

Inheritance diagram for ime::ui::CheckBoxRenderer:

Public Types
using	Ptr = std::shared_ptr< CheckBoxRenderer >
	Shared renderer pointer. More...

Public Member Functions
void	setBorders (const Borders &borders)
	Change the ize of the widget borders. More...

Borders	getBorders () const
	Get the ize of the widgets borders. More...

void	setTextDistanceRatio (float ratio)
	Set the relative distance between the checkbox and the text next to it. More...

float	getTextDistanceRatio () const
	Get the relative distance between the checkbox and the text next to it. More...

void	setTextColour (Colour textColour)
	Set the text colour that will be used inside the checkbox. More...

Colour	getTextColour () const
	Get the colour of the checkbox text. More...

void	setTextHoverColour (Colour colour)
	Set the text colour when the mouse enters the button. More...

Colour	getTextHoverColour () const
	Get the text colour when the mouse enters the button. More...

void	setDisabledTextColour (Colour textColour)
	Set the text colour when the checkbox is disabled More...

Colour	getDisabledTextColour () const
	Get the text colour when the checkbox is disabled More...

void	setCheckedTextColour (Colour colour)
	Set the colour of text when the checkbox is checked. More...

Colour	getTextColourChecked () const
	Get the colour of text when the checkbox is checked. More...

void	setCheckedTextHoverColour (Colour colour)
	Set the colour of the text when the mouse enters the checkbox and it is checked. More...

Colour	getCheckedTextHoverColour () const
	Get the colour of the text when the mouse enters the checkbox and it is checked. More...

void	setCheckedDisabledTextColour (Colour colour)
	Set the colour of the text when the checkbox is checked and disabled. More...

Colour	getCheckedDisabledTextColour () const
	Get the colour of the text when the checkbox is checked and disabled. More...

void	setBackgroundColour (Colour colour)
	Set the background colour of the checkbox. More...

Colour	getBackgroundColour () const
	Get the background colour of checkbox. More...

void	setBackgroundHoverColour (Colour colour)
	Set the background colour of the checkbox when the mouse enters it. More...

Colour	getBackgroundHoverColour () const
	Get the background colour of the checkbox when the mouse enters it. More...

void	setDisabledBackgroundColour (Colour colour)
	Set the background colour of the checkbox when it is disabled. More...

Colour	getDisabledBackgroundColour () const
	Get the background colour of the checkbox when it is disabled. More...

void	setCheckedBackgroundColour (Colour colour)
	Set the background colour used when the checkbox is checked. More...

Colour	getCheckedBackgroundColour () const
	Get the background colour used when the checkbox is checked. More...

void	setCheckedHoverBackgroundColour (Colour colour)
	Set the background colour when the mouse cursor enters the checkbox and it's checked. More...

Colour	getCheckedHoverBackgroundColour () const
	Get the background colour when the mouse cursor enters the checkbox and it's checked. More...

void	setCheckedDisabledBackgroundColour (Colour colour)
	Set the background colour when the checkbox is checked and disabled. More...

Colour	getCheckedDisabledBackgroundColour () const
	Get the background colour when the checkbox is checked and disabled. More...

void	setBorderColour (Colour colour)
	Set the border colour. More...

Colour	getBorderColour () const
	Get the border colour. More...

void	setBorderHoverColour (Colour colour)
	Set the background colour of when the mouse enters the checkbox. More...

Colour	getBorderHoverColour () const
	Get the background colour of when the mouse enters the checkbox. More...

void	setDisabledBorderColour (Colour colour)
	Set the background colour when the checkbox is disabled. More...

Colour	getDisabledBorderColour () const
	Get the background colour when the checkbox is disabled. More...

void	setFocusedBorderColour (Colour colour)
	Set the border colour when the checkbox is focused but not hovered. More...

Colour	getFocusedBorderColour () const
	Get the border colour when the checkbox is focused but not hovered. More...

void	setCheckedBorderColour (Colour colour)
	Set the border colour when the checkbox is checked. More...

Colour	getCheckedBorderColour () const
	Get the border colour when the checkbox is checked. More...

void	setCheckedHoverBorderColour (Colour colour)
	Set the colour of the checkbox when the mouse cursor enters it and it's checked. More...

Colour	getCheckedHoverBorderColour () const
	Get the colour of the checkbox when the mouse cursor enters it and it's checked. More...

void	setCheckedDisabledBorderColour (Colour colour)
	Set the border colour when the checkbox is checked and disabled. More...

Colour	getCheckedDisabledBorderColour () const
	Get the border colour when the checkbox is checked and disabled. More...

void	setCheckedFocusedBorderColour (Colour colour)
	Set the border colour when the checkbox is checked and focused. More...

Colour	getCheckedFocusedBorderColour () const
	Get the border colour when the checkbox is checked and focused. More...

void	setCheckColour (Colour colour)
	Set the colour that is used to fill the checkbox when it is checked. More...

Colour	getCheckColour () const
	Get the colour that is used to fill the checkbox when it is checked. More...

void	setCheckHoverColour (Colour colour)
	Set the colour that is used to fill the checkbox when the mouse is on top of it. More...

Colour	getCheckHoverColour () const
	Get the colour that is used to fill the checkbox when the mouse is on top of it. More...

void	setDisabledCheckedColour (Colour colour)
	Set the colour that is used to fill the checkbox when the checkbox is disabled. More...

Colour	getDisabledCheckColour () const
	Get the colour that is used to fill the checkbox when the checkbox is disabled. More...

void	setUncheckedTexture (const std::string &filename)
	Set the image that is displayed when the checkbox is not checked. More...

void	setCheckedTexture (const std::string &filename)
	Set the image that is displayed when the checkbox is checked. More...

void	setUncheckedHoverTexture (const std::string &filename)
	Set the image that is displayed when the checkbox is not checked and the mouse is on top of the checkbox. More...

void	setCheckedHoverTexture (const std::string &filename)
	Set the image that is displayed when the checkbox is checked and the mouse is on top of the checkbox. More...

void	setUncheckedDisabledTexture (const std::string &filename)
	Set the image that is displayed when the checkbox is not checked and it's disabled. More...

void	setCheckedDisabledTexture (const std::string &filename)
	Set the image that is displayed when the checkbox is checked and it's disabled. More...

void	setUncheckedFocusedTexture (const std::string &filename)
	Set the image that is displayed on top of the checkbox when it is unchecked and focused. More...

void	setCheckedFocusedTexture (const std::string &filename)
	Set the image that is displayed on top of the checkbox when it is checked and focused. More...

void	setTextStyle (TextStyle style)
	Set the text style. More...

TextStyle	getTextStyle () const
	Get the text style. More...

void	setCheckedTextStyle (TextStyle style)
	Set the text style when the checkbox is checked. More...

TextStyle	getCheckedTextStyle () const
	Get the text style when the checkbox is checked. More...

void	setOpacity (float opacity) override
	Set the opacity of the widget. More...

float	getOpacity () const override
	Get the opacity of the widget. More...

void	setOpacityDisabled (float opacity) override
	Set the opacity of the widget when it is disabled. More...

float	getOpacityDisabled () const override
	Get the opacity of the widget when it is disabled. More...

void	setFont (const std::string &filename) override
	Change the widgets font. More...

void	ignoreTransparentTexture (bool ignoreTransparentParts) override
	Set whether mouse events should be ignored on transparent parts of the texture of the widget in normal state. More...

bool	isTransparentTextureIgnored () const override
	Check if mouse events are ignored on transparent parts of the texture or not. More...

IWidgetRenderer::Ptr	clone () const override
	Create a copy of the render. More...

void	setInternalPtr (tgui::WidgetRenderer *renderer) override

tgui::WidgetRenderer *	getInternalPtr () override

	~CheckBoxRenderer () override
	Destructor. More...

Detailed Description

A CheckBox widget renderer.

This class allows you to manipulate the render properties of a CheckBox

Definition at line 44 of file CheckBoxRenderer.h.

Member Typedef Documentation

◆ Ptr

using ime::ui::CheckBoxRenderer::Ptr = std::shared_ptr<CheckBoxRenderer>

Shared renderer pointer.

Definition at line 46 of file CheckBoxRenderer.h.

Constructor & Destructor Documentation

◆ ~CheckBoxRenderer()

ime::ui::CheckBoxRenderer::~CheckBoxRenderer ( )

override

Destructor.

Member Function Documentation

◆ clone()

IWidgetRenderer::Ptr ime::ui::CheckBoxRenderer::clone ( ) const

overridevirtual

Create a copy of the render.

Returns: A copy of the render

Implements ime::ui::IWidgetRenderer.

◆ getBackgroundColour()

Colour ime::ui::CheckBoxRenderer::getBackgroundColour ( ) const

Get the background colour of checkbox.

Returns: The background colour of the checkbox

◆ getBackgroundHoverColour()

Colour ime::ui::CheckBoxRenderer::getBackgroundHoverColour ( ) const

Get the background colour of the checkbox when the mouse enters it.

Returns: The background colour of the checkbox when the mouse enters it

◆ getBorderColour()

Colour ime::ui::CheckBoxRenderer::getBorderColour ( ) const

Get the border colour.

Returns: The border colour

◆ getBorderHoverColour()

Colour ime::ui::CheckBoxRenderer::getBorderHoverColour ( ) const

Get the background colour of when the mouse enters the checkbox.

Returns: The background colour of when the mouse enters the checkbox

◆ getBorders()

Borders ime::ui::CheckBoxRenderer::getBorders ( ) const

Get the ize of the widgets borders.

Returns: The size of the widgets borders

◆ getCheckColour()

Colour ime::ui::CheckBoxRenderer::getCheckColour ( ) const

Get the colour that is used to fill the checkbox when it is checked.

Returns: The colour that is used to fill the checkbox when it is checked

◆ getCheckedBackgroundColour()

Colour ime::ui::CheckBoxRenderer::getCheckedBackgroundColour ( ) const

Get the background colour used when the checkbox is checked.

Returns: The background colour used when the checkbox is checked

◆ getCheckedBorderColour()

Colour ime::ui::CheckBoxRenderer::getCheckedBorderColour ( ) const

Get the border colour when the checkbox is checked.

Returns: The border colour when the checkbox is checked

◆ getCheckedDisabledBackgroundColour()

Colour ime::ui::CheckBoxRenderer::getCheckedDisabledBackgroundColour ( ) const

Get the background colour when the checkbox is checked and disabled.

Returns: The background colour when the checkbox is checked and disabled

◆ getCheckedDisabledBorderColour()

Colour ime::ui::CheckBoxRenderer::getCheckedDisabledBorderColour ( ) const

Get the border colour when the checkbox is checked and disabled.

Returns: The border colour when the checkbox is checked and disabled

◆ getCheckedDisabledTextColour()

Colour ime::ui::CheckBoxRenderer::getCheckedDisabledTextColour ( ) const

Get the colour of the text when the checkbox is checked and disabled.

Returns: The colour of the text when the checkbox is checked and disabled

◆ getCheckedFocusedBorderColour()

Colour ime::ui::CheckBoxRenderer::getCheckedFocusedBorderColour ( ) const

Get the border colour when the checkbox is checked and focused.

Returns: The border colour when the checkbox is checked and focused

◆ getCheckedHoverBackgroundColour()

Colour ime::ui::CheckBoxRenderer::getCheckedHoverBackgroundColour ( ) const

Get the background colour when the mouse cursor enters
the checkbox and it's checked.

Returns: Checked hover background colour

◆ getCheckedHoverBorderColour()

Colour ime::ui::CheckBoxRenderer::getCheckedHoverBorderColour ( ) const

Get the colour of the checkbox when the mouse cursor enters it and it's checked.

Returns: The colour of the checkbox when the mouse cursor enters it and it's checked

◆ getCheckedTextHoverColour()

Colour ime::ui::CheckBoxRenderer::getCheckedTextHoverColour ( ) const

Get the colour of the text when the mouse enters the checkbox and it is checked.

Returns: The checked hover colour

◆ getCheckedTextStyle()

TextStyle ime::ui::CheckBoxRenderer::getCheckedTextStyle ( ) const

Get the text style when the checkbox is checked.

Returns: The text style when the checkbox is checked

◆ getCheckHoverColour()

Colour ime::ui::CheckBoxRenderer::getCheckHoverColour ( ) const

Get the colour that is used to fill the checkbox when the mouse is on top of it.

Returns: The colour that is used to fill the checkbox when the mouse is on top of it

◆ getDisabledBackgroundColour()

Colour ime::ui::CheckBoxRenderer::getDisabledBackgroundColour ( ) const

Get the background colour of the checkbox when it is disabled.

Returns: The background colour of the checkbox when it is disabled

◆ getDisabledBorderColour()

Colour ime::ui::CheckBoxRenderer::getDisabledBorderColour ( ) const

Get the background colour when the checkbox is disabled.

Returns: The background colour when the checkbox is disabled

◆ getDisabledCheckColour()

Colour ime::ui::CheckBoxRenderer::getDisabledCheckColour ( ) const

Get the colour that is used to fill the checkbox when the checkbox is disabled.

Returns: The colour that is used to fill the checkbox when the checkbox is disabled

◆ getDisabledTextColour()

Colour ime::ui::CheckBoxRenderer::getDisabledTextColour ( ) const

Get the text colour when the checkbox is disabled

Returns: The text colour when the checkbox is disabled

◆ getFocusedBorderColour()

Colour ime::ui::CheckBoxRenderer::getFocusedBorderColour ( ) const

Get the border colour when the checkbox is focused but not hovered.

Returns: The border colour when the checkbox is focused but not hovered

◆ getInternalPtr()

tgui::WidgetRenderer * ime::ui::CheckBoxRenderer::getInternalPtr ( )

overridevirtual

Implements ime::ui::IWidgetRenderer.

◆ getOpacity()

float ime::ui::CheckBoxRenderer::getOpacity ( ) const

overridevirtual

Get the opacity of the widget.

Returns: The opacity of the widget

Implements ime::ui::IWidgetRenderer.

◆ getOpacityDisabled()

float ime::ui::CheckBoxRenderer::getOpacityDisabled ( ) const

overridevirtual

Get the opacity of the widget when it is disabled.

Returns: The opacity of the widget in disabled state

This function will return -1 if the widget uses the same opacity as the enabled state when it is disabled

Implements ime::ui::IWidgetRenderer.

◆ getTextColour()

Colour ime::ui::CheckBoxRenderer::getTextColour ( ) const

Get the colour of the checkbox text.

Returns: The colour of the button text

◆ getTextColourChecked()

Colour ime::ui::CheckBoxRenderer::getTextColourChecked ( ) const

Get the colour of text when the checkbox is checked.

Returns: The colour of text when the checkbox is checked

◆ getTextDistanceRatio()

float ime::ui::CheckBoxRenderer::getTextDistanceRatio ( ) const

Get the relative distance between the checkbox and the text next to it.

Returns: The relative distance between the checkbox and the text next to it

◆ getTextHoverColour()

Colour ime::ui::CheckBoxRenderer::getTextHoverColour ( ) const

Get the text colour when the mouse enters the button.

Returns: The text colour when the mouse enters the button

◆ getTextStyle()

TextStyle ime::ui::CheckBoxRenderer::getTextStyle ( ) const

Get the text style.

Returns: The text style

◆ ignoreTransparentTexture()

void ime::ui::CheckBoxRenderer::ignoreTransparentTexture ( bool ignoreTransparentParts )

overridevirtual

Set whether mouse events should be ignored on transparent parts of the texture of the widget in normal state.

Parameters

ignoreTransparentParts True to ignore mouse events on transparent parts of the texture, otherwise false

When mouse events are ignored, they are passed to a widget behind the widget. By default, mouse events are NOT ignored and the widget will receive mouse events even on transparent texture parts. This property does nothing if the widget doesn't use textures

Implements ime::ui::IWidgetRenderer.

◆ isTransparentTextureIgnored()

bool ime::ui::CheckBoxRenderer::isTransparentTextureIgnored ( ) const

overridevirtual

Check if mouse events are ignored on transparent parts of the texture or not.

Returns: True if mouse events are ignored, otherwise false

See also: ignoreTransparentTexture

Implements ime::ui::IWidgetRenderer.

◆ setBackgroundColour()

void ime::ui::CheckBoxRenderer::setBackgroundColour ( Colour colour )

Set the background colour of the checkbox.

Parameters

colour The background colour to set

Note: that this colour is ignored when you set a background image

◆ setBackgroundHoverColour()

void ime::ui::CheckBoxRenderer::setBackgroundHoverColour ( Colour colour )

Set the background colour of the checkbox when the mouse enters it.

Parameters

colour The background colour to set

Note: that this colour is ignored when you set a background image

◆ setBorderColour()

void ime::ui::CheckBoxRenderer::setBorderColour ( Colour colour )

Set the border colour.

Parameters

colour The border colour to set

◆ setBorderHoverColour()

void ime::ui::CheckBoxRenderer::setBorderHoverColour ( Colour colour )

Set the background colour of when the mouse enters the checkbox.

Parameters

colour The background colour to set

◆ setBorders()

void ime::ui::CheckBoxRenderer::setBorders ( const Borders & borders )

Change the ize of the widget borders.

Parameters

borders The size of the borders

◆ setCheckColour()

void ime::ui::CheckBoxRenderer::setCheckColour ( Colour colour )

Set the colour that is used to fill the checkbox when it is checked.

Parameters

colour Colour to set

◆ setCheckedBackgroundColour()

void ime::ui::CheckBoxRenderer::setCheckedBackgroundColour ( Colour colour )

Set the background colour used when the checkbox is checked.

Parameters

colour the new colour

◆ setCheckedBorderColour()

void ime::ui::CheckBoxRenderer::setCheckedBorderColour ( Colour colour )

Set the border colour when the checkbox is checked.

Parameters

colour The colour to set

◆ setCheckedDisabledBackgroundColour()

void ime::ui::CheckBoxRenderer::setCheckedDisabledBackgroundColour ( Colour colour )

Set the background colour when the checkbox is checked and disabled.

Parameters

colour Colour to set

◆ setCheckedDisabledBorderColour()

void ime::ui::CheckBoxRenderer::setCheckedDisabledBorderColour ( Colour colour )

Set the border colour when the checkbox is checked and disabled.

Parameters

colour The colour to set

◆ setCheckedDisabledTextColour()

void ime::ui::CheckBoxRenderer::setCheckedDisabledTextColour ( Colour colour )

Set the colour of the text when the checkbox is checked and disabled.

Parameters

colour New colour

◆ setCheckedDisabledTexture()

void ime::ui::CheckBoxRenderer::setCheckedDisabledTexture ( const std::string & filename )

Set the image that is displayed when the checkbox is checked and it's disabled.

Parameters

filename Filename of the image to be set

Exceptions

FileNotFoundException If the image cannot be found on the disk

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

◆ setCheckedFocusedBorderColour()

void ime::ui::CheckBoxRenderer::setCheckedFocusedBorderColour ( Colour colour )

Set the border colour when the checkbox is checked and focused.

Parameters

colour The colour to set

◆ setCheckedFocusedTexture()

void ime::ui::CheckBoxRenderer::setCheckedFocusedTexture ( const std::string & filename )

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

Parameters

filename Filename of the image to be set

Exceptions

FileNotFoundException If the image cannot be found on the disk

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

◆ setCheckedHoverBackgroundColour()

void ime::ui::CheckBoxRenderer::setCheckedHoverBackgroundColour ( Colour colour )

Set the background colour when the mouse cursor enters
the checkbox and it's checked.

Parameters

colour colour to set

◆ setCheckedHoverBorderColour()

void ime::ui::CheckBoxRenderer::setCheckedHoverBorderColour ( Colour colour )

Set the colour of the checkbox when the mouse cursor enters it and it's checked.

Parameters

colour Colour to set

◆ setCheckedHoverTexture()

void ime::ui::CheckBoxRenderer::setCheckedHoverTexture ( const std::string & filename )

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

Parameters

filename Filename of the image to be set

Exceptions

FileNotFoundException If the image cannot be found on the disk

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

◆ setCheckedTextColour()

void ime::ui::CheckBoxRenderer::setCheckedTextColour ( Colour colour )

Set the colour of text when the checkbox is checked.

Parameters

colour Colour to set

◆ setCheckedTextHoverColour()

void ime::ui::CheckBoxRenderer::setCheckedTextHoverColour ( Colour colour )

Set the colour of the text when the mouse enters the checkbox and it is checked.

Parameters

colour The colour to set

◆ setCheckedTextStyle()

void ime::ui::CheckBoxRenderer::setCheckedTextStyle ( TextStyle style )

Set the text style when the checkbox is checked.

Parameters

style The new style

◆ setCheckedTexture()

void ime::ui::CheckBoxRenderer::setCheckedTexture ( const std::string & filename )

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

Parameters

filename Filename of the image to be set

Exceptions

FileNotFoundException If the image cannot be found on the disk

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

◆ setCheckHoverColour()

void ime::ui::CheckBoxRenderer::setCheckHoverColour ( Colour colour )

Set the colour that is used to fill the checkbox when the mouse is on top of it.

Parameters

colour The colour to set

◆ setDisabledBackgroundColour()

void ime::ui::CheckBoxRenderer::setDisabledBackgroundColour ( Colour colour )

Set the background colour of the checkbox when it is disabled.

Parameters

colour Background colour to set

Note: This colour is ignored when you set a background image

◆ setDisabledBorderColour()

void ime::ui::CheckBoxRenderer::setDisabledBorderColour ( Colour colour )

Set the background colour when the checkbox is disabled.

Parameters

colour The background colour when the checkbox is disabled

◆ setDisabledCheckedColour()

void ime::ui::CheckBoxRenderer::setDisabledCheckedColour ( Colour colour )

Set the colour that is used to fill the checkbox when the checkbox is disabled.

Parameters

colour The new colour to set

◆ setDisabledTextColour()

void ime::ui::CheckBoxRenderer::setDisabledTextColour ( Colour textColour )

Set the text colour when the checkbox is disabled

Parameters

textColour Colour to set

◆ setFocusedBorderColour()

void ime::ui::CheckBoxRenderer::setFocusedBorderColour ( Colour colour )

Set the border colour when the checkbox is focused but not hovered.

Parameters

colour Border colour to set

◆ setFont()

void ime::ui::CheckBoxRenderer::setFont ( const std::string & filename )

overridevirtual

Change the widgets font.

Parameters

filename Filename of the new font

Exceptions

FileNotFoundException If the font cannot be found on the disk

Implements ime::ui::IWidgetRenderer.

◆ setInternalPtr()

void ime::ui::CheckBoxRenderer::setInternalPtr ( tgui::WidgetRenderer * renderer )

overridevirtual

Implements ime::ui::IWidgetRenderer.

◆ setOpacity()

void ime::ui::CheckBoxRenderer::setOpacity ( float opacity )

overridevirtual

Set the opacity of the widget.

Parameters

opacity The new opacity of the widget in between 0 and 1

0 means completely transparent, while 1 (default) means fully opaque

Implements ime::ui::IWidgetRenderer.

◆ setOpacityDisabled()

void ime::ui::CheckBoxRenderer::setOpacityDisabled ( float opacity )

overridevirtual

Set the opacity of the widget when it is disabled.

Parameters

opacity Opacity to set between 0 and 1

0 means completely transparent, while 1 (default) means fully opaque. Set to -1 (default) to use the normal opacity value even when the widget is disabled.

Implements ime::ui::IWidgetRenderer.

◆ setTextColour()

void ime::ui::CheckBoxRenderer::setTextColour ( Colour textColour )

Set the text colour that will be used inside the checkbox.

Parameters

textColour The new text colour

◆ setTextDistanceRatio()

void ime::ui::CheckBoxRenderer::setTextDistanceRatio ( float ratio )

Set the relative distance between the checkbox and the text next to it.

Parameters

ratio The ratio of the distance based on the width of the checkbox

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

◆ setTextHoverColour()

void ime::ui::CheckBoxRenderer::setTextHoverColour ( Colour colour )

Set the text colour when the mouse enters the button.

Parameters

colour The colour to be set

◆ setTextStyle()

void ime::ui::CheckBoxRenderer::setTextStyle ( TextStyle style )

Set the text style.

Parameters

style Style to set

◆ setUncheckedDisabledTexture()

void ime::ui::CheckBoxRenderer::setUncheckedDisabledTexture ( const std::string & filename )

Set the image that is displayed when the checkbox is not checked and it's disabled.

Parameters

filename Filename of the image to be set

Exceptions

FileNotFoundException If the image cannot be found on the disk

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

◆ setUncheckedFocusedTexture()

void ime::ui::CheckBoxRenderer::setUncheckedFocusedTexture ( const std::string & filename )

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

Parameters

filename Filename of the image to be set

Exceptions

FileNotFoundException If the image cannot be found on the disk

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

◆ setUncheckedHoverTexture()

void ime::ui::CheckBoxRenderer::setUncheckedHoverTexture ( const std::string & filename )

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

Parameters

filename Filename of the image to be set

Exceptions

FileNotFoundException If the image cannot be found on the disk

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

◆ setUncheckedTexture()

void ime::ui::CheckBoxRenderer::setUncheckedTexture ( const std::string & filename )

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

Parameters

filename Filename of the image to be set

Exceptions

FileNotFoundException If the image cannot be found on the disk

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

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

CheckBoxRenderer.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ ~CheckBoxRenderer()

Member Function Documentation

◆ clone()

◆ getBackgroundColour()

◆ getBackgroundHoverColour()

◆ getBorderColour()

◆ getBorderHoverColour()

◆ getBorders()

◆ getCheckColour()

◆ getCheckedBackgroundColour()

◆ getCheckedBorderColour()

◆ getCheckedDisabledBackgroundColour()

◆ getCheckedDisabledBorderColour()

◆ getCheckedDisabledTextColour()

◆ getCheckedFocusedBorderColour()

◆ getCheckedHoverBackgroundColour()

◆ getCheckedHoverBorderColour()

◆ getCheckedTextHoverColour()

◆ getCheckedTextStyle()

◆ getCheckHoverColour()

◆ getDisabledBackgroundColour()

◆ getDisabledBorderColour()

◆ getDisabledCheckColour()

◆ getDisabledTextColour()

◆ getFocusedBorderColour()

◆ getInternalPtr()

◆ getOpacity()

◆ getOpacityDisabled()

◆ getTextColour()

◆ getTextColourChecked()

◆ getTextDistanceRatio()

◆ getTextHoverColour()

◆ getTextStyle()

◆ ignoreTransparentTexture()

◆ isTransparentTextureIgnored()

◆ setBackgroundColour()

◆ setBackgroundHoverColour()

◆ setBorderColour()

◆ setBorderHoverColour()

◆ setBorders()

◆ setCheckColour()

◆ setCheckedBackgroundColour()

◆ setCheckedBorderColour()

◆ setCheckedDisabledBackgroundColour()

◆ setCheckedDisabledBorderColour()

◆ setCheckedDisabledTextColour()

◆ setCheckedDisabledTexture()

◆ setCheckedFocusedBorderColour()

◆ setCheckedFocusedTexture()

◆ setCheckedHoverBackgroundColour()

◆ setCheckedHoverBorderColour()

◆ setCheckedHoverTexture()

◆ setCheckedTextColour()

◆ setCheckedTextHoverColour()

◆ setCheckedTextStyle()

◆ setCheckedTexture()

◆ setCheckHoverColour()

◆ setDisabledBackgroundColour()

◆ setDisabledBorderColour()

◆ setDisabledCheckedColour()

◆ setDisabledTextColour()

◆ setFocusedBorderColour()

◆ setFont()

◆ setInternalPtr()

◆ setOpacity()

◆ setOpacityDisabled()

◆ setTextColour()

◆ setTextDistanceRatio()

◆ setTextHoverColour()

◆ setTextStyle()

◆ setUncheckedDisabledTexture()

◆ setUncheckedFocusedTexture()

◆ setUncheckedHoverTexture()

◆ setUncheckedTexture()