TGUI  0.7.4

CheckBox widget. More...

#include <CheckBox.hpp>

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

Public Types

typedef std::shared_ptr< CheckBoxPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const CheckBoxConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::RadioButton
typedef std::shared_ptr< RadioButtonPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const RadioButtonConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::ClickableWidget
typedef std::shared_ptr< ClickableWidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ClickableWidgetConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

std::shared_ptr< CheckBoxRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void check () override
 Checks the checkbox.
 
void uncheck () override
 Unchecks the checkbox.
 
- Public Member Functions inherited from tgui::RadioButton
std::shared_ptr< RadioButtonRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position) override
 Set the position of the widget. More...
 
virtual void setSize (const Layout2d &size) override
 Changes the size of the radio button. More...
 
virtual sf::Vector2f getFullSize () const override
 Returns the full size of the radio button. More...
 
virtual void setFont (const Font &font) override
 Changes the font of the text in the widget. More...
 
bool isChecked () const
 Returns whether the radio button is checked or not. More...
 
void setText (const sf::String &text)
 Changes the text of the radio button. More...
 
sf::String getText () const
 Returns the text of the radio button. More...
 
void setTextSize (unsigned int size)
 Changes the character size of the text. More...
 
unsigned int getTextSize () const
 Returns the character size of the text. More...
 
void allowTextClick (bool acceptTextClick=true)
 Allow (or disallow) the radio button to be checked/unchecked by clicking on the text next to the radio button. More...
 
virtual void setOpacity (float opacity) override
 Changes the opacity of the widget. More...
 
- Public Member Functions inherited from tgui::ClickableWidget
 ClickableWidget (const Layout2d &size={100, 100})
 Default constructor. More...
 
 ClickableWidget (const Layout &width, const Layout &height)
 Constructor. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &copy)
 Copy constructor. More...
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &right)
 Overload of assignment operator. More...
 
std::shared_ptr< WidgetRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hide ()
 Hides the widget. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void enable ()
 Enables the widget. More...
 
virtual void disable (bool blockMouseEvents=true)
 Disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void focus ()
 Focus the widget. More...
 
virtual void unfocus ()
 Unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const std::string & getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets.
 
virtual void moveToBack ()
 Places the widget behind all other widgets.
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip ()
 Returns the tool tip that is displayed when hovering over the widget. More...
 
std::shared_ptr< sf::Font > getFont () const
 Returns the font associated with the widget (if any) More...
 
void detachTheme ()
 Detach the theme from the widget. More...
 
std::shared_ptr< BaseThemegetTheme () const
 Returns the theme to which the widget is currently connected. More...
 
std::string getPrimaryLoadingParameter () const
 Returns the primary parameter that was passed to the loader to load this widget. More...
 
std::string getSecondaryLoadingParameter () const
 Returns the secondary parameter that was passed to the loader to load this widget. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 set the position of the widget More...
 
sf::Vector2f getPosition () const
 get the position of the widget More...
 
void move (const Layout2d &offset)
 Move the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Move the widget by a given offset. More...
 
void setSize (const Layout &width, const Layout &height)
 Changes the size of the widget. More...
 
virtual sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
void scale (const Layout2d &factors)
 Scale the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scale the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
 SignalWidgetBase ()=default
 Default constructor.
 
 SignalWidgetBase (const SignalWidgetBase &copy)
 Copy constructor. More...
 
SignalWidgetBaseoperator= (const SignalWidgetBase &right)
 Overload of assignment operator. More...
 
template<typename Func , typename... Args>
unsigned int connect (const std::string &signalNames, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
template<typename Func , typename... Args>
unsigned int connectEx (const std::string &signalName, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
void disconnect (unsigned int id)
 Disconnects a connection. More...
 
void disconnectAll (const std::string &signalName)
 Disconnect all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnect all connections from a all signals.
 

Static Public Member Functions

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

Protected Member Functions

virtual Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- Protected Member Functions inherited from tgui::RadioButton
virtual void reload (const std::string &primary="", const std::string &secondary="", bool force=false) override
 Reload the widget. More...
 
- Protected Member Functions inherited from tgui::Widget
void attachTheme (std::shared_ptr< BaseTheme > theme)
 Attach a theme to the widget. More...
 

Detailed Description

CheckBox widget.

Signals

Member Function Documentation

◆ clone()

virtual 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

Reimplemented from tgui::RadioButton.

◆ copy()

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

Makes a copy of another checkbox.

Parameters
checkboxThe other checkbox
Returns
The new checkbox

◆ create()

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

Creates a new check box widget.

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

◆ getRenderer()

std::shared_ptr<CheckBoxRenderer> tgui::CheckBox::getRenderer ( ) const
inline

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

Returns
Reference to the renderer

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