TGUI  0.8-dev

RangeSlider widget. More...

#include <RangeSlider.hpp>

Inheritance diagram for tgui::RangeSlider:
tgui::Widget tgui::SignalWidgetBase

Public Types

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

RangeSliderRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
RangeSliderRenderergetRenderer ()
 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...
 
sf::Vector2f getFullSize () const override
 Returns the full size of the slider. More...
 
sf::Vector2f getWidgetOffset () const override
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
void setMinimum (int minimum)
 Sets a minimum value. More...
 
int getMinimum () const
 Returns the minimum value. More...
 
void setMaximum (int maximum)
 Sets a maximum value. More...
 
int getMaximum () const
 Returns the maximum value. More...
 
void setSelectionStart (int value)
 Changes the value where the selection starts. More...
 
int getSelectionStart () const
 Returns the current value where the selection starts. More...
 
void setSelectionEnd (int value)
 Changes the value where the selection ends. More...
 
int getSelectionEnd () const
 Returns the current value where the selection ends. More...
 
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...
 
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 (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
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...
 
sf::Vector2f getSize () const
 Returns the size 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. More...
 
virtual void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
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::SignalWidgetBase
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(const Args &...)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, const Args &... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if< std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)>>::value &&!std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs>
unsigned int connect (std::initializer_list< std::string > signalNames, Func &&handler, BoundArgs &&... args)
 Connect a signal handler to multiple signals. More...
 
bool disconnect (unsigned int id)
 Disconnects a signal handler. More...
 
void disconnectAll (std::string signalName)
 Disconnects all signal handler from a certain signal. More...
 
void disconnectAll ()
 Disconnects all signal handlers from signals.
 

Static Public Member Functions

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

Public Attributes

SignalRange onRangeChange = {"RangeChanged"}
 Value of the slider changed. Optional parameter: new value.
 
- Public Attributes inherited from tgui::Widget
SignalVector2f onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalVector2f onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
Signal onFocus = {"Focused"}
 The widget was focused.
 
Signal onUnfocus = {"Unfocused"}
 The widget was unfocused.
 
Signal onMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
Signal onMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 

Protected Member Functions

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

RangeSlider widget.

Member Function Documentation

◆ clone()

Widget::Ptr tgui::RangeSlider::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 RangeSlider::Ptr tgui::RangeSlider::copy ( RangeSlider::ConstPtr  slider)
static

Makes a copy of another slider.

Parameters
sliderThe other slider
Returns
The new slider

◆ create()

static RangeSlider::Ptr tgui::RangeSlider::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()

void tgui::RangeSlider::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()

sf::Vector2f tgui::RangeSlider::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::Widget.

◆ getMaximum()

int tgui::RangeSlider::getMaximum ( ) const

Returns the maximum value.

Returns
The current maximum value

The default maximum value is 100.

◆ getMinimum()

int tgui::RangeSlider::getMinimum ( ) const

Returns the minimum value.

Returns
The current minimum value

The default minimum value is 0.

◆ getRenderer()

RangeSliderRenderer* tgui::RangeSlider::getRenderer ( )

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

Returns
Temporary pointer to the renderer
Warning
After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getSelectionEnd()

int tgui::RangeSlider::getSelectionEnd ( ) const

Returns the current value where the selection ends.

Returns
The current selection end

◆ getSelectionStart()

int tgui::RangeSlider::getSelectionStart ( ) const

Returns the current value where the selection starts.

Returns
The current selection start

◆ getSharedRenderer()

RangeSliderRenderer* tgui::RangeSlider::getSharedRenderer ( )

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

Returns
Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getSignal()

Signal& tgui::RangeSlider::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.

◆ getWidgetOffset()

sf::Vector2f tgui::RangeSlider::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()

bool tgui::RangeSlider::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()

void tgui::RangeSlider::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()

void tgui::RangeSlider::setMaximum ( int  maximum)

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()

void tgui::RangeSlider::setMinimum ( int  minimum)

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.

◆ setSelectionEnd()

void tgui::RangeSlider::setSelectionEnd ( int  value)

Changes the value where the selection ends.

Parameters
valueThe new selection end

The value can't be smaller than the minimum or bigger than the maximum. When smaller than SelectionStart, SelectionStart will be set to the value as well.

◆ setSelectionStart()

void tgui::RangeSlider::setSelectionStart ( int  value)

Changes the value where the selection starts.

Parameters
valueThe new selection start

The value can't be smaller than the minimum or bigger than the maximum. When larger than SelectionEnd, SelectionEnd will be set to the value as well.

◆ setSize()

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

Changes the size of the slider.

Parameters
sizeThe new size of the slider

Reimplemented from tgui::Widget.


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