TGUI  1.1
Loading...
Searching...
No Matches

CheckBox widget. More...

#include <TGUI/Widgets/CheckBox.hpp>

Inheritance diagram for tgui::CheckBox:
tgui::RadioButton tgui::ClickableWidget tgui::Widget

Public Types

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

Public Member Functions

 CheckBox (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
TGUI_NODISCARD CheckBoxRenderergetSharedRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
TGUI_NODISCARD const CheckBoxRenderergetSharedRenderer () const override
 
TGUI_NODISCARD CheckBoxRenderergetRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
TGUI_NODISCARD Vector2f getFullSize () const override
 Returns the full size of the radio button.
 
TGUI_NODISCARD 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
 
bool canHandleKeyPress (const Event::KeyEvent &event) override
 Called by the parent of the widget to check if keyPressed would process the event.
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the widget to a render target.
 
- Public Member Functions inherited from tgui::RadioButton
 RadioButton (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
TGUI_NODISCARD RadioButtonRenderergetSharedRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
TGUI_NODISCARD const RadioButtonRenderergetSharedRenderer () const override
 
TGUI_NODISCARD RadioButtonRenderergetRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
void setSize (const Layout2d &size) override
 Changes the size of the radio button.
 
TGUI_NODISCARD Vector2f getFullSize () const override
 Returns the full size of the radio button.
 
TGUI_NODISCARD Vector2f getWidgetOffset () const override
 Returns the distance between the position where the widget is drawn and where the widget is placed.
 
void setEnabled (bool enabled) override
 Enables or disables the widget.
 
TGUI_NODISCARD bool isChecked () const
 Returns whether the radio button is checked or not.
 
void setText (const String &text)
 Changes the text of the radio button.
 
TGUI_NODISCARD const StringgetText () const
 Returns the text of the radio button.
 
void setTextClickable (bool acceptTextClick)
 Allows (or disallows) the radio button to be checked by clicking on the text next to it.
 
TGUI_NODISCARD bool isTextClickable () const
 Returns whether the radio button can be checked by clicking on the text next to it.
 
TGUI_NODISCARD 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
 
bool canHandleKeyPress (const Event::KeyEvent &event) override
 Called by the parent of the widget to check if keyPressed would process the event.
 
void draw (BackendRenderTarget &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=StaticWidgetType, bool initRenderer=true)
 
bool leftMousePressed (Vector2f pos) override
 Called by the parent when the left mouse button goes down on top of the widget.
 
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 &&) noexcept
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&) noexcept
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks.
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Vector2f getSize () const
 Returns the size of the widget.
 
virtual TGUI_NODISCARD Vector2f getAbsolutePosition (Vector2f offset={}) const
 Get the absolute position of the widget instead of the relative position to its parent.
 
void setAutoLayout (AutoLayout layout)
 
TGUI_NODISCARD AutoLayout getAutoLayout () const
 
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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Vector2f getScale () const
 Returns the scaling to be applied to the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD float getRotation () const
 Returns the rotation to be applied to the widget.
 
TGUI_NODISCARD 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.
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration.
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration.
 
virtual void setVisible (bool visible)
 Shows or hides a widget.
 
TGUI_NODISCARD bool isVisible () const
 Returns true when the widget is visible.
 
TGUI_NODISCARD bool isEnabled () const
 Returns true when the widget is enabled.
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget.
 
TGUI_NODISCARD bool isFocused () const
 Returns true when the widget is focused and false otherwise.
 
TGUI_NODISCARD const StringgetWidgetType () const
 Returns the type of the widget.
 
TGUI_NODISCARD ContainergetParent () const
 Returns a pointer to the parent widget.
 
TGUI_NODISCARD BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs.
 
TGUI_NODISCARD 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 DataType >
TGUI_NODISCARD DataType getUserData () const
 Returns data stored in the widget.
 
TGUI_NODISCARD bool hasUserData () const
 Returns whether 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.
 
TGUI_NODISCARD const FontgetInheritedFont () 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.
 
TGUI_NODISCARD float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer.
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text.
 
TGUI_NODISCARD unsigned int getTextSize () const
 Returns the character size of text in this widget.
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD bool isFocusable () const
 Returns whether a widget could be focused.
 
void setNavigationUp (const Widget::Ptr &widgetAbove)
 Changes which widget should become focused when navigating upwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationUp () const
 Returns which widget would become focused when navigating upwards from this widget.
 
void setNavigationDown (const Widget::Ptr &widgetBelow)
 Changes which widget should become focused when navigating downwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationDown () const
 Returns which widget would become focused when navigating downwards from this widget.
 
void setNavigationLeft (const Widget::Ptr &widgetLeft)
 Changes which widget should become focused when navigating to the left from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationLeft () const
 Returns which widget would become focused when navigating to the left from this widget.
 
void setNavigationRight (const Widget::Ptr &widgetRight)
 Changes which widget should become focused when navigating to the right from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationRight () const
 Returns which widget would become focused when navigating to the right from this widget.
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
virtual TGUI_NODISCARD bool canGainFocus () const
 Returns whether the widget can currently gain focus.
 
TGUI_NODISCARD bool isContainer () const
 Returns whether the widget is a container widget or not.
 
TGUI_NODISCARD bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)
 
TGUI_NODISCARD 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)
 
void setAutoLayoutUpdateEnabled (bool enabled)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual void mouseMoved (Vector2f pos)
 
virtual void textEntered (char32_t key)
 
virtual bool scrolled (float delta, Vector2f pos, bool touch)
 Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)
 
virtual void mouseNoLongerOnWidget ()
 
virtual void leftMouseButtonNoLongerDown ()
 
virtual TGUI_NODISCARD Widget::Ptr askToolTip (Vector2f mousePos)
 
TGUI_NODISCARD const Layout2dgetPositionLayout () const
 
TGUI_NODISCARD const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
void rendererChangedCallback (const String &property)
 

Static Public Member Functions

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

Static Public Attributes

static constexpr const char StaticWidgetType [] = "CheckBox"
 Type name of the widget.
 
- Static Public Attributes inherited from tgui::RadioButton
static constexpr const char StaticWidgetType [] = "RadioButton"
 Type name of the widget.
 
- Static Public Attributes inherited from tgui::ClickableWidget
static constexpr const char StaticWidgetType [] = "ClickableWidget"
 Type name of the 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
 
TGUI_NODISCARD 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
TGUI_NODISCARD SignalgetSignal (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.
 
TGUI_NODISCARD 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 updateTextSize () override
 Called when the text size is changed (either by setTextSize or via the renderer)
 
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.
 
TGUI_NODISCARD Vector2f getInnerSize () const
 
TGUI_NODISCARD const ColorgetCurrentCheckColor () const
 
TGUI_NODISCARD const ColorgetCurrentBackgroundColor () const
 
TGUI_NODISCARD const ColorgetCurrentBorderColor () const
 
void updateTextColor ()
 
TGUI_NODISCARD 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::Widget
void recalculateBoundPositionLayouts ()
 Calls recalculateValue() on each layout in m_boundPositionLayouts.
 
void recalculateBoundSizeLayouts ()
 Calls recalculateValue() on each layout in m_boundSizeLayouts.
 

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 onShowEffectFinish = {"ShowEffectFinished"}
 A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.
 
SignalAnimationType onAnimationFinish = {"AnimationFinished"}
 An animation has finished.
 
- 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
 Stores the position of this widget.
 
Layout2d m_size
 Stores the size of this widget.
 
unsigned int m_textSize = 0
 
Vector2f m_origin
 
Optional< Vector2fm_rotationOrigin
 
Optional< Vector2fm_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
 Stores the flag indicating whether this widget is enabled.
 
bool m_visible = true
 Stores the flag indicating whether this widget is visible.
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
std::weak_ptr< Widgetm_navWidgetUp
 
std::weak_ptr< Widgetm_navWidgetDown
 
std::weak_ptr< Widgetm_navWidgetRight
 
std::weak_ptr< Widgetm_navWidgetLeft
 
Duration m_animationTimeElapsed
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::unique_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 
AutoLayout m_autoLayout = AutoLayout::Manual
 
bool m_autoLayoutUpdateEnabled = true
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 

Detailed Description

CheckBox widget.

Member Function Documentation

◆ canHandleKeyPress()

bool tgui::CheckBox::canHandleKeyPress ( const Event::KeyEvent event)
overridevirtual

Called by the parent of the widget to check if keyPressed would process the event.

Parameters
eventKey event that took place
Returns
True if the event would be handled by the widget, false if the key event doesn't affect the widget
Since
TGUI 1.1

Reimplemented from tgui::Widget.

◆ clone()

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

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 TGUI_NODISCARD CheckBox::Ptr tgui::CheckBox::copy ( const CheckBox::ConstPtr checkbox)
static

Makes a copy of another checkbox.

Parameters
checkboxThe other checkbox
Returns
The new checkbox

◆ create()

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

Creates a new check box widget.

Parameters
textThe text to display next to the check box
Returns
The new check box

◆ draw()

void tgui::CheckBox::draw ( BackendRenderTarget target,
RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ getFullSize()

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

TGUI_NODISCARD CheckBoxRenderer * tgui::CheckBox::getRenderer ( )
overridevirtual

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.

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [1/2]

TGUI_NODISCARD const CheckBoxRenderer * tgui::CheckBox::getSharedRenderer ( ) const
overridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

TGUI_NODISCARD CheckBoxRenderer * tgui::CheckBox::getSharedRenderer ( )
overridevirtual

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

Reimplemented from tgui::Widget.

◆ getWidgetOffset()

TGUI_NODISCARD 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
propertyName 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
checkedShould 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: