Inheritance diagram for tgui::Button:

Public Types
Public Types inherited from tgui::ClickableWidget
Public Types inherited from tgui::Widget

Public Member Functions
	Button ()
	Default constructor. More...

	Button (const Button &copy)
	Copy constructor. More...

virtual	~Button ()
	Destructor. More...

Button &	operator= (const Button &right)
	Overload of assignment operator. More...

bool	load (const std::string &configFileFilename, const std::string &sectionName="Button")
	Loads the widget. More...

const std::string &	getLoadedConfigFile () const
	Returns the filename of the config file that was used to load the widget. More...

virtual void	setPosition (float x, float y)
	Set the position of the widget. More...

virtual void	setSize (float width, float height)
	Changes the size of the button. More...

void	setText (const sf::String &text)
	Changes the caption of the button. More...

sf::String	getText () const
	Returns the caption of the button. More...

void	setTextFont (const sf::Font &font)
	Changes the font of the text. More...

const sf::Font *	getTextFont () const
	Returns the font of the text. More...

void	setTextColor (const sf::Color &color)
	Changes the color of the text. More...

const sf::Color &	getTextColor () const
	Returns the color of the text. 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...

virtual void	setTransparency (unsigned char transparency)
	Changes the transparency of the widget. More...

Public Member Functions inherited from tgui::ClickableWidget
	ClickableWidget ()
	Default constructor. More...

	ClickableWidget (const ClickableWidget &copy)
	Copy constructor. More...

virtual	~ClickableWidget ()
	Destructor. More...

ClickableWidget &	operator= (const ClickableWidget &right)
	Overload of assignment operator. More...

virtual sf::Vector2f	getSize () const
	Returns the size of the widget. More...

Public Member Functions inherited from tgui::Widget
	Widget ()
	Default constructor. More...

	Widget (const Widget &copy)
	Copy constructor. More...

virtual	~Widget ()
	Destructor. More...

Widget &	operator= (const Widget &right)
	Overload of assignment operator. More...

virtual sf::Vector2f	getAbsolutePosition () const
	Get the absolute position of the widget on the screen. More...

virtual void	show ()
	Shows the widget. More...

virtual void	hide ()
	Hides the widget. More...

bool	isVisible () const
	Returns true when the widget is visible. More...

virtual void	enable ()
	Enables the widget. More...

virtual void	disable ()
	Disables the widget. More...

bool	isEnabled () const
	Returns true when the widget is enabled. More...

bool	isDisabled () const
	Returns true when the widget is disabled. More...

bool	isLoaded () const
	Returns true when the widget is loaded successfully. 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...

WidgetTypes	getWidgetType () const
	Returns the type of the widget. More...

Container *	getParent () const
	Returns a pointer to the parent widget. More...

unsigned char	getTransparency () const
	Returns the transparency of the widget. More...

virtual void	moveToFront ()
	Places the widget before all other widgets. More...

virtual void	moveToBack ()
	Places the widget behind all other widgets. More...

void	setCallbackId (unsigned int callbackId)
	Changes the callback id of the widget. More...

unsigned int	getCallbackId ()
	Returns the callback id of the widget. More...

Public Member Functions inherited from tgui::Transformable
	Transformable ()
	Default constructor. More...

virtual	~Transformable ()
	Destructor. More...

void	setPosition (const sf::Vector2f &position)
	set the position of the widget More...

const sf::Vector2f &	getPosition () const
	get the position of the widget More...

void	move (float offsetX, float offsetY)
	Move the widget by a given offset. More...

void	move (const sf::Vector2f &offset)
	Move the widget by a given offset. More...

virtual sf::Vector2f	getFullSize () const
	Returns the entire size that the widget is using. More...

void	scale (float factorX, float factorY)
	Scale the widget. More...

void	scale (const sf::Vector2f &factors)
	Scale the widget. More...

Public Member Functions inherited from tgui::CallbackManager
void	bindCallback (std::function< void()> func, unsigned int trigger)
	Bind a function to one or more specific callback trigger(s). More...

template<typename T >
void	bindCallback (void(T::func)(), T const classPtr, unsigned int trigger)
	Bind a function to one or more specific callback trigger(s). More...

void	bindCallbackEx (std::function< void(const Callback &)> func, unsigned int trigger)
	Bind a function to one or more specific callback trigger(s). More...

template<typename T >
void	bindCallbackEx (void(T::func)(const Callback &), T const classPtr, unsigned int trigger)
	Bind a function to one or more specific callback trigger(s). More...

void	bindCallback (unsigned int trigger)
	Bind one or more specific callback trigger(s) to the parent widget. More...

void	unbindCallback (unsigned int trigger)
	Unbind all callback function bound to the given trigger. More...

void	unbindAllCallback ()
	Unbind all callback functions bound to any callback. More...

Member Enumeration Documentation

enum tgui::Button::ButtonCallbacks

Defines specific triggers to Button.

Enumerator
SpaceKeyPressed	Space key was pressed.
ReturnKeyPressed	Return key was pressed.
AllButtonCallbacks	All triggers defined in Button and its base classes.

Constructor & Destructor Documentation

tgui::Button::Button ( )

Default constructor.

tgui::Button::Button ( const Button & copy )

Copy constructor.

Parameters

copy	Instance to copy

virtual tgui::Button::~Button ( )

virtual

Destructor.

Member Function Documentation

const std::string& tgui::Button::getLoadedConfigFile ( ) const

Returns the filename of the config file that was used to load the widget.

Returns: Filename of loaded config file. Empty string when no config file was loaded yet.

sf::String tgui::Button::getText ( ) const

Returns the caption of the button.

Returns: Text that is drawn on top of the button.

const sf::Color& tgui::Button::getTextColor ( ) const

Returns the color of the text.

Returns: The current text color

const sf::Font* tgui::Button::getTextFont ( ) const

Returns the font of the text.

Returns: Pointer to the font that is currently being used

unsigned int tgui::Button::getTextSize ( ) const

Returns the character size of the text.

Returns: The current text size.

bool tgui::Button::load	(	const std::string &	configFileFilename,
		const std::string &	sectionName = `"Button"`
	)

Loads the widget.

Parameters

configFileFilename	Filename of the config file.
sectionName	Name of the section in the file to load

The config file must contain a Button section with the needed information.

Button& tgui::Button::operator= ( const Button & right )

Overload of assignment operator.

Parameters

right Instance to assign

Returns: Reference to itself

virtual void tgui::Button::setPosition	(	float	x,
		float	y
	)

virtual

Set the position of the widget.

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

x	X coordinate of the new position
y	Y coordinate of the new position

See also: move, getPosition

Reimplemented from tgui::Transformable.

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

virtual

Changes the size of the button.

Parameters

width	The new width of the button
height	The new height of the button

Reimplemented from tgui::ClickableWidget.

void tgui::Button::setText ( const sf::String & text )

Changes the caption of the button.

Parameters

text	New text to draw on top of the button.

void tgui::Button::setTextColor ( const sf::Color & color )

Changes the color of the text.

Parameters

color New text color

void tgui::Button::setTextFont ( const sf::Font & font )

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 with the setGlobalFont function from the parent.

Parameters

font	The new font

void tgui::Button::setTextSize ( unsigned int size )

Changes the character size of the text.

Parameters

size	The new text size. If the size is set to 0 then the text will be auto-sized to fit inside the button.

virtual void tgui::Button::setTransparency ( unsigned char transparency )

virtual

Changes the transparency of the widget.

Parameters

transparency The transparency of the widget. 0 is completely transparent, while 255 (default) means fully opaque.

Note that this will only change the transparency of the images. The parts of the widgets that use a color will not be changed. You must change them yourself by setting the alpha channel of the color.

Reimplemented from tgui::Widget.

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

include/TGUI/Button.hpp

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation