tgui::CheckBox Class Reference

CheckBox widget. More...

#include <TGUI/Widgets/CheckBox.hpp>

Inheritance diagram for tgui::CheckBox:

Public Types
typedef std::shared_ptr< CheckBox >	Ptr
	Shared widget pointer.
typedef std::shared_ptr< const CheckBox >	ConstPtr
	Shared constant widget pointer.
Public Types inherited from tgui::RadioButton
typedef std::shared_ptr< RadioButton >	Ptr
	Shared widget pointer.
typedef std::shared_ptr< const RadioButton >	ConstPtr
	Shared constant widget pointer.
Public Types inherited from tgui::ClickableWidget
typedef std::shared_ptr< ClickableWidget >	Ptr
	Shared widget pointer.
typedef std::shared_ptr< const ClickableWidget >	ConstPtr
	Shared constant widget pointer.
Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.
typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
	CheckBox (const char *typeName="CheckBox", bool initRenderer=true)
CheckBoxRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.
const CheckBoxRenderer *	getSharedRenderer () const
CheckBoxRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.
const CheckBoxRenderer *	getRenderer () const
Vector2f	getFullSize () const override
	Returns the full size of the radio button.
Vector2f	getWidgetOffset () const override
	Returns the distance between the position where the widget is drawn and where the widget is placed.
void	setChecked (bool checked) override
	Checks or unchecks the check box.
void	leftMouseReleased (Vector2f pos) override
void	keyPressed (const Event::KeyEvent &event) override
void	draw (BackendRenderTargetBase &target, RenderStates states) const override
	Draw the widget to a render target.
Public Member Functions inherited from tgui::RadioButton
	RadioButton (const char *typeName="RadioButton", bool initRenderer=true)
RadioButtonRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.
const RadioButtonRenderer *	getSharedRenderer () const
RadioButtonRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.
const RadioButtonRenderer *	getRenderer () const
void	setSize (const Layout2d &size) override
	Changes the size of the radio button.
Vector2f	getFullSize () const override
	Returns the full size of the radio button.
Vector2f	getWidgetOffset () const override
	Returns the distance between the position where the widget is drawn and where the widget is placed.
bool	isChecked () const
	Returns whether the radio button is checked or not.
void	setText (const String &text)
	Changes the text of the radio button.
const String &	getText () const
	Returns the text of the radio button.
void	setTextSize (unsigned int size) override
	Changes the character size of the text.
unsigned int	getTextSize () const override
	Returns the character size of the text.
void	setTextClickable (bool acceptTextClick)
	Allows (or disallows) the radio button to be checked by clicking on the text next to it.
bool	isTextClickable () const
	Returns whether the radio button can be checked by clicking on the text next to it.
bool	isMouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
void	leftMouseReleased (Vector2f pos) override
void	keyPressed (const Event::KeyEvent &event) override
void	draw (BackendRenderTargetBase &target, RenderStates states) const override
	Draw the widget to a render target.
virtual void	setSize (const Layout2d &size)
	Changes the size of the widget.
void	setSize (Layout width, Layout height)
	Changes the size of the widget.
Public Member Functions inherited from tgui::ClickableWidget
	ClickableWidget (const char *typeName="ClickableWidget", bool initRenderer=true)
void	leftMousePressed (Vector2f pos) override
void	rightMousePressed (Vector2f pos) override
void	rightMouseReleased (Vector2f pos) override
void	rightMouseButtonNoLongerDown () override
Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)
	Widget (const Widget &)
	Copy constructor.
	Widget (Widget &&)
	Move constructor.
virtual	~Widget ()
	Destructor.
Widget &	operator= (const Widget &)
	Overload of copy assignment operator.
Widget &	operator= (Widget &&)
	Move assignment.
void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks.
WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.
const WidgetRenderer *	getSharedRenderer () const
WidgetRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.
const WidgetRenderer *	getRenderer () const
virtual void	setPosition (const Layout2d &position)
	sets the position of the widget
void	setPosition (Layout x, Layout y)
	Sets the position of the widget.
Vector2f	getPosition () const
	Gets the position of the widget.
void	setSize (Layout width, Layout height)
	Changes the size of the widget.
void	setWidth (Layout width)
	Changes the width of the widget.
void	setHeight (Layout height)
	Changes the height of the widget.
Vector2f	getSize () const
	Returns the size of the widget.
virtual Vector2f	getAbsolutePosition () const
	Get the absolute position of the top-left point of the widget instead of the relative position to its parent.
void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based.
void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based.
Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based.
void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget.
void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget.
void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget.
void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget.
Vector2f	getScale () const
	Returns the scaling to be applied to the widget.
Vector2f	getScaleOrigin () const
	Returns the origin used for scaling.
void	setRotation (float angle)
	Sets the rotation to be applied to the widget.
void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget.
float	getRotation () const
	Returns the rotation to be applied to the widget.
Vector2f	getRotationOrigin () const
	Returns the origin used for rotations.
void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation.
void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation.
virtual void	setVisible (bool visible)
	Shows or hides a widget.
bool	isVisible () const
	Returns true when the widget is visible.
virtual void	setEnabled (bool enabled)
	Enables or disables the widget.
bool	isEnabled () const
	Returns true when the widget is enabled.
virtual void	setFocused (bool focused)
	Focus or unfocus the widget.
bool	isFocused () const
	Returns true when the widget is focused and false otherwise.
const String &	getWidgetType () const
	Returns the type of the widget.
Container *	getParent () const
	Returns a pointer to the parent widget.
GuiBase *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.
bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect)
void	moveToFront ()
	Places the widget before all other widgets.
void	moveToBack ()
	Places the widget behind all other widgets.
void	setUserData (Any userData)
	Stores some data into the widget.
template<typename T >
T	getUserData () const
	Returns data stored in the widget.
void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer.
const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer.
void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.
float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer.
void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget.
Widget::Ptr	getToolTip () const
	Returns the tool tip that is displayed when hovering over the widget.
void	setWidgetName (const String &name)
	Changes the name of a widget.
String	getWidgetName () const
	Returns the name of a widget.
void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget.
Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget.
void	setFocusable (bool focusable)
	Changes whether a widget could be focused.
bool	isFocusable () const
	Returns whether a widget could be focused.
virtual bool	canGainFocus () const
	Returns whether the widget can currently gain focus.
bool	isContainer () const
	Returns whether the widget is a container widget or not.
bool	isDraggableWidget () const
	Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)
bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.
virtual void	setParent (Container *parent)
virtual bool	updateTime (Duration elapsedTime)
virtual void	mousePressed (Event::MouseButton button, Vector2f pos)
virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)
virtual void	mouseMoved (Vector2f pos)
virtual void	textEntered (char32_t key)
virtual bool	mouseWheelScrolled (float delta, Vector2f pos)
virtual void	mouseNoLongerOnWidget ()
virtual void	leftMouseButtonNoLongerDown ()
virtual Widget::Ptr	askToolTip (Vector2f mousePos)
const Layout2d &	getPositionLayout () const
const Layout2d &	getSizeLayout () const
void	bindPositionLayout (Layout *layout)
void	unbindPositionLayout (Layout *layout)
void	bindSizeLayout (Layout *layout)
void	unbindSizeLayout (Layout *layout)
template<typename WidgetType >
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.
template<typename WidgetType >
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

Static Public Member Functions
static CheckBox::Ptr	create (String text="")
	Creates a new check box widget.
static CheckBox::Ptr	copy (CheckBox::ConstPtr checkbox)
	Makes a copy of another checkbox.
Static Public Member Functions inherited from tgui::RadioButton
static RadioButton::Ptr	create ()
	Creates a new radio button widget.
static RadioButton::Ptr	copy (RadioButton::ConstPtr radioButton)
	Makes a copy of another radio button.
Static Public Member Functions inherited from tgui::ClickableWidget
static ClickableWidget::Ptr	create (Layout2d size={"100%", "100%"})
	Creates a new clickable widget.
static ClickableWidget::Ptr	copy (ClickableWidget::ConstPtr widget)
	Makes a copy of another clickable widget.

Protected Member Functions
void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.
void	updateTextureSizes () override
Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type.
Protected Member Functions inherited from tgui::RadioButton
Signal &	getSignal (String signalName) override
	Retrieves a signal based on its name.
void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.
std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const override
	Saves the widget as a tree node in order to save it to a file.
void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
	Loads the widget from a tree of nodes.
void	mouseEnteredWidget () override
	This function is called when the mouse enters the widget.
void	mouseLeftWidget () override
	This function is called when the mouse leaves the widget.
Vector2f	getInnerSize () const
const Color &	getCurrentCheckColor () const
const Color &	getCurrentBackgroundColor () const
const Color &	getCurrentBorderColor () const
void	updateTextColor ()
Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type.

Additional Inherited Members
Public Attributes inherited from tgui::RadioButton
SignalBool	onCheck = {"Checked"}
	Radio button was checked. Optional parameter: bool which is always true.
SignalBool	onUncheck = {"Unchecked"}
	Radio button was unchecked. Optional parameter: bool which is always false.
SignalBool	onChange = {"Changed"}
	Radio button was checked or unchecked. Optional parameter: bool indicating whether it is checked.
Public Attributes inherited from tgui::ClickableWidget
SignalVector2f	onMousePress = {"MousePressed"}
	The mouse went down on the widget. Optional parameter: mouse position relative to widget.
SignalVector2f	onMouseRelease = {"MouseReleased"}
	The mouse was released on top of the widget. Optional parameter: mouse position relative to widget.
SignalVector2f	onClick = {"Clicked"}
	The widget was clicked. Optional parameter: mouse position relative to widget.
SignalVector2f	onRightMousePress = {"RightMousePressed"}
	The right mouse button went down on the widget. Optional parameter: mouse position relative to widget.
SignalVector2f	onRightMouseRelease = {"RightMouseReleased"}
	The right mouse button was released on top of the widget. Optional parameter: mouse position relative to widget.
SignalVector2f	onRightClick = {"RightClicked"}
	The widget was right clicked. Optional parameter: mouse position relative to widget.
Public Attributes inherited from tgui::Widget
SignalVector2f	onPositionChange = {"PositionChanged"}
	The position of the widget changed. Optional parameter: new position.
SignalVector2f	onSizeChange = {"SizeChanged"}
	The size of the widget changed. Optional parameter: new size.
Signal	onFocus = {"Focused"}
	The widget was focused.
Signal	onUnfocus = {"Unfocused"}
	The widget was unfocused.
Signal	onMouseEnter = {"MouseEntered"}
	The mouse entered the widget.
Signal	onMouseLeave = {"MouseLeft"}
	The mouse left the widget.
SignalShowEffect	onAnimationFinish = {"AnimationFinished"}
SignalShowEffect	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
Protected Types inherited from tgui::Widget
using	SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > >
using	LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > >
Protected Attributes inherited from tgui::RadioButton
bool	m_checked = false
bool	m_allowTextClick = true
Text	m_text
Sprite	m_spriteUnchecked
Sprite	m_spriteChecked
Sprite	m_spriteUncheckedHover
Sprite	m_spriteCheckedHover
Sprite	m_spriteUncheckedDisabled
Sprite	m_spriteCheckedDisabled
Sprite	m_spriteUncheckedFocused
Sprite	m_spriteCheckedFocused
Borders	m_bordersCached
TextStyles	m_textStyleCached
TextStyles	m_textStyleCheckedCached
Color	m_checkColorCached
Color	m_checkColorHoverCached
Color	m_checkColorDisabledCached
Color	m_borderColorCached
Color	m_borderColorHoverCached
Color	m_borderColorDisabledCached
Color	m_borderColorFocusedCached
Color	m_borderColorCheckedCached
Color	m_borderColorCheckedHoverCached
Color	m_borderColorCheckedDisabledCached
Color	m_borderColorCheckedFocusedCached
Color	m_backgroundColorCached
Color	m_backgroundColorHoverCached
Color	m_backgroundColorDisabledCached
Color	m_backgroundColorCheckedCached
Color	m_backgroundColorCheckedHoverCached
Color	m_backgroundColorCheckedDisabledCached
float	m_textDistanceRatioCached = 0.2f
Protected Attributes inherited from tgui::Widget
String	m_type
String	m_name
Layout2d	m_position
Layout2d	m_size
unsigned int	m_textSize = 0
Vector2f	m_origin
Optional< Vector2f >	m_rotationOrigin
Optional< Vector2f >	m_scaleOrigin
Vector2f	m_scaleFactors = {1, 1}
float	m_rotationDeg = 0
Vector2f	m_prevPosition
Vector2f	m_prevSize
std::unordered_set< Layout * >	m_boundPositionLayouts
std::unordered_set< Layout * >	m_boundSizeLayouts
bool	m_enabled = true
bool	m_visible = true
Container *	m_parent = nullptr
GuiBase *	m_parentGui = nullptr
bool	m_mouseHover = false
bool	m_mouseDown = false
bool	m_focused = false
bool	m_focusable = true
Duration	m_animationTimeElapsed
bool	m_draggableWidget = false
bool	m_containerWidget = false
Widget::Ptr	m_toolTip = nullptr
aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr
std::vector< std::shared_ptr< priv::Animation > >	m_showAnimations
Font	m_inheritedFont
float	m_inheritedOpacity = 1
Font	m_fontCached = Font::getGlobalFont()
float	m_opacityCached = 1
bool	m_transparentTextureCached = false
Any	m_userData
Cursor::Type	m_mouseCursor = Cursor::Type::Arrow
std::function< void(const String &property)>	m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); }

Detailed Description

CheckBox widget.

Member Function Documentation

clone()

Widget::Ptr tgui::CheckBox::clone ( ) const

inlineoverrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns

Copy of the widget

Implements tgui::Widget.

copy()

static CheckBox::Ptr tgui::CheckBox::copy ( CheckBox::ConstPtr  checkbox )

static

Makes a copy of another checkbox.

Parameters

checkbox

The other checkbox

Returns

The new checkbox

create()

static CheckBox::Ptr tgui::CheckBox::create ( String  text = "" )

static

Creates a new check box widget.

Parameters

text	The text to display next to the check box

Returns

The new check box

draw()

void tgui::CheckBox::draw ( BackendRenderTargetBase &  target, RenderStates  states  ) const

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current render states

Implements tgui::Widget.

getFullSize()

Vector2f tgui::CheckBox::getFullSize ( ) const

overridevirtual

Returns the full size of the radio button.

Returns

Full size of the radio button

The returned size includes the text next to the radio button. When textures are loaded, the height of the checked image is used (in case the check goes outside of the box).

Reimplemented from tgui::Widget.

getRenderer()

CheckBoxRenderer * tgui::CheckBox::getRenderer

(

)

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns

Temporary pointer to the renderer

Warning

After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

getSharedRenderer()

CheckBoxRenderer * tgui::CheckBox::getSharedRenderer

(

)

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns

Temporary pointer to the renderer that may be shared with other widgets using the same renderer

getWidgetOffset()

Vector2f tgui::CheckBox::getWidgetOffset ( ) const

overridevirtual

Returns the distance between the position where the widget is drawn and where the widget is placed.

When using textures and the checked texture is larger than the unchecked one (when the check mark leaves the box) then this function will return (0, -heightDiff), otherwise (0,0) is returned.

Returns

Offset of the widget

Reimplemented from tgui::Widget.

keyPressed()

void tgui::CheckBox::keyPressed ( const Event::KeyEvent &  event )

overridevirtual

Reimplemented from tgui::Widget.

leftMouseReleased()

void tgui::CheckBox::leftMouseReleased ( Vector2f  pos )

overridevirtual

Reimplemented from tgui::Widget.

rendererChanged()

void tgui::CheckBox::rendererChanged ( const String &  property )

overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters

property

Name of the property that was changed

Reimplemented from tgui::Widget.

setChecked()

void tgui::CheckBox::setChecked ( bool  checked )

overridevirtual

Checks or unchecks the check box.

Parameters

checked

Should the check box be checked?

This function is overriden because the RadioButton implementation also unchecks neighbor radio buttons.

Reimplemented from tgui::RadioButton.

updateTextureSizes()

void tgui::CheckBox::updateTextureSizes ( )

overrideprotectedvirtual

Reimplemented from tgui::RadioButton.

---

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

• include/TGUI/Widgets/CheckBox.hpp