TGUI  v0.6.10
Public Types | Public Member Functions | List of all members
tgui::Slider Class Reference
Inheritance diagram for tgui::Slider:
tgui::Widget tgui::Transformable tgui::CallbackManager

Public Types

- Public Types inherited from tgui::Widget

Public Member Functions

 Slider ()
 Default constructor. More...
 
 Slider (const Slider &copy)
 Copy constructor. More...
 
virtual ~Slider ()
 Destructor. More...
 
Slideroperator= (const Slider &right)
 Overload of assignment operator. More...
 
virtual bool load (const std::string &configFileFilename, const std::string &sectionName="Slider")
 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...
 
void setSize (float width, float height)
 Changes the size of the slider. More...
 
virtual sf::Vector2f getSize () const
 Returns the size of the slider. More...
 
virtual void setMinimum (unsigned int minimum)
 Sets a minimum value. More...
 
virtual void setMaximum (unsigned int maximum)
 Sets a maximum value. More...
 
virtual void setValue (unsigned int value)
 Changes the current value. More...
 
void setVerticalScroll (bool verticallScroll)
 Changes whether the slider lies vertical or horizontal. 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...
 
bool getVerticalScroll () const
 Returns whether the slider lies vertical or horizontal. More...
 
virtual void setTransparency (unsigned char transparency)
 Changes the transparency 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...
 
Widgetoperator= (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...
 
ContainergetParent () 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

Defines specific triggers to Slider.

Enumerator
ValueChanged 

Value changed (Slider moved)

AllSliderCallbacks 

All triggers defined in Slider and its base classes.

Constructor & Destructor Documentation

tgui::Slider::Slider ( )

Default constructor.

tgui::Slider::Slider ( const Slider copy)

Copy constructor.

Parameters
copyInstance to copy
virtual tgui::Slider::~Slider ( )
virtual

Destructor.

Member Function Documentation

const std::string& tgui::Slider::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::Slider::getMaximum ( ) const

Returns the maximum value.

Returns
The current maximum value

The default maximum value is 100.

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

Returns the minimum value.

Returns
The current minimum value

The default minimum value is 0.

virtual sf::Vector2f tgui::Slider::getSize ( ) const
virtual

Returns the size of the slider.

Returns
Size of the slider

Implements tgui::Transformable.

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

Returns the current value.

Returns
The current value

The default value is 0.

bool tgui::Slider::getVerticalScroll ( ) const

Returns whether the slider lies vertical or horizontal.

Returns
Does the slider lie vertically?
virtual bool tgui::Slider::load ( const std::string &  configFileFilename,
const std::string &  sectionName = "Slider" 
)
virtual

Loads the widget.

Parameters
configFileFilenameFilename of the config file.
sectionNameName of the section in the file to load

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

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

Overload of assignment operator.

Parameters
rightInstance to assign
Returns
Reference to itself
virtual void tgui::Slider::setMaximum ( unsigned int  maximum)
virtual

Sets a maximum value.

Parameters
maximumThe new maximum value

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

virtual void tgui::Slider::setMinimum ( unsigned int  minimum)
virtual

Sets a minimum value.

Parameters
minimumThe new minimum value

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

virtual void tgui::Slider::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
xX coordinate of the new position
yY coordinate of the new position
See also
move, getPosition

Reimplemented from tgui::Transformable.

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

Changes the size of the slider.

Parameters
widthThe new width of the slider
heightThe new height of the slider

Implements tgui::Transformable.

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

Changes the transparency of the widget.

Parameters
transparencyThe 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.

virtual void tgui::Slider::setValue ( unsigned int  value)
virtual

Changes the current value.

Parameters
valueThe new value

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

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

Changes whether the slider lies vertical or horizontal.

Parameters
verticallScrollDoes the slider lie vertically?

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