Inheritance diagram for tgui::SpinButton:

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

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

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

virtual	~SpinButton ()
	Destructor. More...

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

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

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

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

void	setMinimum (unsigned int minimum)
	Sets a minimum value. More...

void	setMaximum (unsigned int maximum)
	Sets a maximum value. More...

void	setValue (unsigned int value)
	Changes the current value. More...

unsigned int	getMinimum () const
	Returns the minimum value. More...

unsigned int	getMaximum () const
	Returns the maximum value. More...

unsigned int	getValue () const
	Returns the current value. More...

void	setVerticalScroll (bool verticallScroll)
	Changes whether the spin button lies vertical or horizontal (arrows above or next to each other). More...

bool	getVerticalScroll () const
	Returns whether the spin button lies vertical or horizontal (arrows above or next to each other). 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...

virtual void	setPosition (float x, float y)
	Set the position of the widget. 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::SpinButton::SpinButtonCallbacks

Defines specific triggers to SpinButton.

Enumerator
ValueChanged	Value has changed.
AllSpinButtonCallbacks	All triggers defined in SpinButton and its base classes.

Constructor & Destructor Documentation

tgui::SpinButton::SpinButton ( )

Default constructor.

tgui::SpinButton::SpinButton ( const SpinButton & copy )

Copy constructor.

Parameters

copy	Instance to copy

virtual tgui::SpinButton::~SpinButton ( )

virtual

Destructor.

Member Function Documentation

const std::string& tgui::SpinButton::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.

unsigned int tgui::SpinButton::getMaximum ( ) const

Returns the maximum value.

Returns: The current maximum value

The default maximum value 10.

unsigned int tgui::SpinButton::getMinimum ( ) const

Returns the minimum value.

Returns: The current minimum value

The default minimum value 0.

unsigned int tgui::SpinButton::getValue ( ) const

Returns the current value.

Returns: The current value

The default value is 0.

bool tgui::SpinButton::getVerticalScroll ( ) const

Returns whether the spin button lies vertical or horizontal (arrows above or next to each other).

Returns: Does the spin button lie vertically?

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

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 SpinButton section with the needed information.

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

Overload of assignment operator.

Parameters

right Instance to assign

Returns: Reference to itself

void tgui::SpinButton::setMaximum ( unsigned int maximum )

Sets a maximum value.

Parameters

maximum The new maximum value

When the value is too big then it will be changed to this maximum. The default maximum value is 10.

void tgui::SpinButton::setMinimum ( unsigned int minimum )

Sets a minimum value.

Parameters

minimum The new minimum value

When the value is too small then it will be changed to this minimum. The default minimum value is 0.

void tgui::SpinButton::setSize	(	float	width,
		float	height
	)

virtual

Changes the size of the spin button.

Parameters

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

Reimplemented from tgui::ClickableWidget.

virtual void tgui::SpinButton::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.

void tgui::SpinButton::setValue ( unsigned int value )

Changes the current value.

Parameters

value The new value

The value can't be smaller than the minimum or bigger than the maximum. The default value is 0.

void tgui::SpinButton::setVerticalScroll ( bool verticallScroll )

Changes whether the spin button lies vertical or horizontal (arrows above or next to each other).

Parameters

verticallScroll Does the spin button lie vertically?

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

include/TGUI/SpinButton.hpp

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation