tgui::Checkbox Struct Reference

Inheritance diagram for tgui::Checkbox:

Public Member Functions
	Checkbox ()
	Default constructor. More...
	Checkbox (const Checkbox &copy)
	Copy constructor. More...
virtual	~Checkbox ()
	Destructor. More...
Checkbox &	operator= (const Checkbox &right)
	Overload of assignment operator. More...
virtual bool	load (const std::string &pathname)
	Loads the checkbox images and optionally a matching text color. More...
virtual void	setSize (float width, float height)
	Changes the size of the checkbox. More...
virtual Vector2u	getSize () const
	Returns the size of the checkbox, unaffected by scaling. More...
virtual Vector2f	getScaledSize () const
	Returns the size of the checkbox, after the scaling transformation. More...
virtual std::string	getLoadedPathname () const
	Returns the pathname that was used to load the checkbox. More...
virtual void	check ()
	Checks the checkbox. More...
virtual void	uncheck ()
	Unchecks the checkbox. More...
virtual bool	isChecked () const
	Returns whether the checkbox is checked or not. More...
virtual void	setText (const sf::String &text)
	Changes the text of the checkbox. More...
virtual sf::String	getText () const
	Returns the text of the checkbox. More...
virtual void	setTextFont (const sf::Font &font)
	Changes the font of the text. More...
virtual const sf::Font *	getTextFont () const
	Returns the font of the text. More...
virtual void	setTextColor (const sf::Color &color)
	Changes the color of the text. More...
virtual const sf::Color &	getTextColor () const
	Returns the color of the text. More...
virtual void	setTextSize (unsigned int size)
	Changes the character size of the text. More...
virtual unsigned int	getTextSize () const
	Returns the character size of the text. More...
Public Member Functions inherited from tgui::OBJECT
	OBJECT ()
	Default constructor. More...
	OBJECT (const OBJECT &copy)
	Copy constructor. More...
virtual	~OBJECT ()
	Destructor. More...
OBJECT &	operator= (const OBJECT &right)
	Overload of assignment operator. More...
virtual void	show ()
	Shows the object. More...
virtual void	hide ()
	Hides the object. More...
virtual bool	isVisible () const
	Returns true when the object is visible. More...
virtual void	enable ()
	Enables the object. More...
virtual void	disable ()
	Disables the object. More...
virtual bool	isEnabled () const
	Returns true when the object is enabled. More...
virtual bool	isDisabled () const
	Returns true when the object is disabled. More...
virtual bool	isLoaded () const
	Returns true when the object is loaded successfully. More...
void	focus ()
	Focus the object. More...
void	unfocus ()
	Unfocus the object. More...
void	focusNextObject ()
	Focuses the next object. More...
virtual bool	isFocused () const
	Returns true when the object is focused and false otherwise. More...
virtual ObjectTypes	getObjectType () const
	Returns the type of the object. More...
virtual void	moveToFront ()
	Places the object before all other objects. More...
virtual void	moveToBack ()
	Places the object behind all other objects. More...

Public Attributes
bool	allowTextClick
	When this boolean is true (default) then the checkbox will also be checked/unchecked by clicking on the text. More...

Constructor & Destructor Documentation

tgui::Checkbox::Checkbox

(

)

Default constructor.

tgui::Checkbox::Checkbox

(

const Checkbox &

copy

)

Copy constructor.

virtual tgui::Checkbox::~Checkbox ( )

virtual

Destructor.

Member Function Documentation

virtual void tgui::Checkbox::check ( )

virtual

Checks the checkbox.

Reimplemented in tgui::RadioButton.

virtual std::string tgui::Checkbox::getLoadedPathname ( ) const

virtual

Returns the pathname that was used to load the checkbox.

When the checkbox has not been loaded yet then this function will return an empty string.

virtual Vector2f tgui::Checkbox::getScaledSize ( ) const

virtual

Returns the size of the checkbox, after the scaling transformation.

Implements tgui::OBJECT.

virtual Vector2u tgui::Checkbox::getSize ( ) const

virtual

Returns the size of the checkbox, unaffected by scaling.

Implements tgui::OBJECT.

virtual sf::String tgui::Checkbox::getText ( ) const

virtual

Returns the text of the checkbox.

virtual const sf::Color& tgui::Checkbox::getTextColor ( ) const

virtual

Returns the color of the text.

virtual const sf::Font* tgui::Checkbox::getTextFont ( ) const

virtual

Returns the font of the text.

virtual unsigned int tgui::Checkbox::getTextSize ( ) const

virtual

Returns the character size of the text.

virtual bool tgui::Checkbox::isChecked ( ) const

virtual

Returns whether the checkbox is checked or not.

virtual bool tgui::Checkbox::load ( const std::string &  pathname )

virtual

Loads the checkbox images and optionally a matching text color.

Parameters

pathname

The path to the folder that contains the images. The folder must also contain an info.txt file, which will give more information about the checkbox.

Returns

• true on success
• false when the pathname is empty
• false when the info.txt file was not found
• false when the images couldn't be loaded

Checkbox& tgui::Checkbox::operator=

(

const Checkbox &

right

)

Overload of assignment operator.

virtual void tgui::Checkbox::setSize ( float  width, float  height  )

virtual

Changes the size of the checkbox.

Parameters

width	The new width of the checkbox
height	The new height of the checkbox

Implements tgui::OBJECT.

virtual void tgui::Checkbox::setText ( const sf::String &  text )

virtual

Changes the text of the checkbox.

virtual void tgui::Checkbox::setTextColor ( const sf::Color &  color )

virtual

Changes the color of the text.

virtual void tgui::Checkbox::setTextFont ( const sf::Font &  font )

virtual

Changes the font of the text.

When you don't call this function then the global font will be use. This global font can be changed by changing gloabalFont from the parent.

virtual void tgui::Checkbox::setTextSize ( unsigned int  size )

virtual

Changes the character size of the text.

When the size is 0 then te text is automatically scaled to be as big as the image (default).

virtual void tgui::Checkbox::uncheck ( )

virtual

Unchecks the checkbox.

Reimplemented in tgui::RadioButton.

Member Data Documentation

bool tgui::Checkbox::allowTextClick

When this boolean is true (default) then the checkbox will also be checked/unchecked by clicking on the text.

---

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

• include/TGUI/Checkbox.hpp