TGUI  0.8-dev

Slider widget. More...

#include <Slider.hpp>

Inheritance diagram for tgui::Slider:
tgui::Widget tgui::Transformable tgui::SignalWidgetBase

Public Types

typedef std::shared_ptr< SliderPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const SliderConstPtr
 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

SliderRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the slider. More...
 
virtual sf::Vector2f getFullSize () const override
 Returns the full size of the slider. More...
 
virtual sf::Vector2f getWidgetOffset () const override
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
virtual void setMinimum (int minimum)
 Sets a minimum value. More...
 
int getMinimum () const
 Returns the minimum value. More...
 
virtual void setMaximum (int maximum)
 Sets a maximum value. More...
 
int getMaximum () const
 Returns the maximum value. More...
 
virtual void setValue (int value)
 Changes the current value. More...
 
int getValue () const
 Returns the current value. More...
 
virtual bool mouseOnWidget (sf::Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
virtual void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (const std::shared_ptr< RendererData > &rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position) override
 sets the position of the widget 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 ()
 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...
 
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...
 
- Public Member Functions inherited from tgui::Transformable
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
virtual sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
unsigned int connect (std::string signalName, const Signal::Delegate &handler)
 Connects a signal handler that will be called when this signal is emitted. More...
 
unsigned int connect (std::string signalName, const Signal::DelegateEx &handler)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(Args...)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, Args &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(std::shared_ptr< Widget >, const std::string &, Args...)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, Args &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
bool disconnect (std::string signalName, unsigned int id)
 Disconnects a signal handler. More...
 

Static Public Member Functions

static Slider::Ptr create (int minimum=0, int maximum=10)
 Creates a new slider widget. More...
 
static Slider::Ptr copy (Slider::ConstPtr slider)
 Makes a copy of another slider. More...
 

Public Attributes

SignalWrapper< SignalInt > onValueChange = {"ValueChanged"}
 Value of the slider changed. Optional parameter: new value.
 
- Public Attributes inherited from tgui::Widget
SignalWrapper< SignalVector2f > onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalWrapper< SignalVector2f > onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
SignalWrapper< SignalonFocus = {"Focused"}
 The widget was focused.
 
SignalWrapper< SignalonUnfocus = {"Unfocused"}
 The widget was unfocused.
 
SignalWrapper< SignalonMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
SignalWrapper< SignalonMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 

Protected Member Functions

virtual SignalgetSignal (std::string &&signalName) override
 Retrieves a signal based on its name. More...
 
virtual void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. More...
 
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::Widget
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget.
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget.
 

Detailed Description

Slider widget.

Member Function Documentation

◆ clone()

virtual Widget::Ptr tgui::Slider::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

Implements tgui::Widget.

◆ copy()

static Slider::Ptr tgui::Slider::copy ( Slider::ConstPtr  slider)
static

Makes a copy of another slider.

Parameters
sliderThe other slider
Returns
The new slider

◆ create()

static Slider::Ptr tgui::Slider::create ( int  minimum = 0,
int  maximum = 10 
)
static

Creates a new slider widget.

Parameters
minimumThe minimum value of the slider
maximumThe maximum value of the slider
Returns
The new slider

◆ draw()

virtual void tgui::Slider::draw ( sf::RenderTarget &  target,
sf::RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ getFullSize()

virtual sf::Vector2f tgui::Slider::getFullSize ( ) const
overridevirtual

Returns the full size of the slider.

This size also takes the thumb into account as opposed to getSize which just returns the track size.

Returns
Full size of the slider

Reimplemented from tgui::Transformable.

◆ getMaximum()

int tgui::Slider::getMaximum ( ) const

Returns the maximum value.

Returns
The current maximum value

The default maximum value is 100.

◆ getMinimum()

int tgui::Slider::getMinimum ( ) const

Returns the minimum value.

Returns
The current minimum value

The default minimum value is 0.

◆ getRenderer()

SliderRenderer* tgui::Slider::getRenderer ( ) const
inline

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

Returns
Pointer to the renderer

◆ getSignal()

virtual Signal& tgui::Slider::getSignal ( std::string &&  signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::Widget.

◆ getValue()

int tgui::Slider::getValue ( ) const

Returns the current value.

Returns
The current value

The default value is 0.

◆ getWidgetOffset()

virtual sf::Vector2f tgui::Slider::getWidgetOffset ( ) const
overridevirtual

Returns the distance between the position where the widget is drawn and where the widget is placed.

This is a negative offset indicating the difference between the track and thumb position when the value equals the minimum.

Returns
Offset of the widget

Reimplemented from tgui::Widget.

◆ mouseOnWidget()

virtual bool tgui::Slider::mouseOnWidget ( sf::Vector2f  pos) const
overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns
Is the mouse on top of the widget?

Implements tgui::Widget.

◆ rendererChanged()

virtual void tgui::Slider::rendererChanged ( const std::string &  property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyLowercase name of the property that was changed

Reimplemented from tgui::Widget.

◆ setMaximum()

virtual void tgui::Slider::setMaximum ( 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.

◆ setMinimum()

virtual void tgui::Slider::setMinimum ( 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.

◆ setSize()

void tgui::Slider::setSize ( const Layout2d size)
overridevirtual

Changes the size of the slider.

Parameters
sizeThe new size of the slider

Reimplemented from tgui::Widget.

◆ setValue()

virtual void tgui::Slider::setValue ( 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.


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