TGUI  0.8.0

Scrollbar widget. More...

#include <TGUI/Widgets/Scrollbar.hpp>

Inheritance diagram for tgui::Scrollbar:
tgui::Widget tgui::SignalWidgetBase tgui::ScrollbarChildWidget

Public Types

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

ScrollbarRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
ScrollbarRenderergetRenderer ()
 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 scrollbar. More...
 
void setMaximum (unsigned int maximum)
 Sets a maximum value. More...
 
unsigned int getMaximum () const
 Returns the maximum value. More...
 
void setValue (unsigned int value)
 Changes the current value. More...
 
unsigned int getValue () const
 Returns the current value. More...
 
void setViewportSize (unsigned int viewport)
 Changes the viewport size. More...
 
unsigned int getViewportSize () const
 Returns the viewport size. More...
 
void setScrollAmount (unsigned int scrollAmount)
 Changes how much the value changes when scrolling or pressing one of the arrows of the scrollbar. More...
 
unsigned int getScrollAmount () const
 Returns how much the value changes when scrolling or pressing one of the arrows of the scrollbar. More...
 
void setAutoHide (bool autoHide)
 Changes whether the scrollbar should hide automatically or not. More...
 
bool getAutoHide () const
 Returns whether the scrollbar is hiding automatically or not. More...
 
float getDefaultWidth ()
 Returns the default width of the scrollbar. More...
 
bool mouseOnWidget (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...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. 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...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void setFocused (bool focused)
 Focus or 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 setUserData (tgui::Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. 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 () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
virtual bool canGainFocus () const
 Returns whether the widget can gain focus. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
- 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 Scrollbar::Ptr create ()
 Creates a new scrollbar widget. More...
 
static Scrollbar::Ptr copy (Scrollbar::ConstPtr scrollbar)
 Makes a copy of another scrollbar. More...
 

Public Attributes

SignalUInt onValueChange = {"ValueChanged"}
 Value of the scrollbar 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.
 
SignalAnimation onAnimationFinished = {"AnimationFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

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...
 
std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const override
 Saves the widget as a tree node in order to save it to a file.
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes.
 
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

Scrollbar widget.

Member Function Documentation

◆ clone()

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

Makes a copy of another scrollbar.

Parameters
scrollbarThe other scrollbar
Returns
The new scrollbar

◆ create()

static Scrollbar::Ptr tgui::Scrollbar::create ( )
static

Creates a new scrollbar widget.

Returns
The new scrollbar

◆ draw()

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

◆ getAutoHide()

bool tgui::Scrollbar::getAutoHide ( ) const

Returns whether the scrollbar is hiding automatically or not.

When true (default), the scrollbar will not be drawn when the maximum is smaller than the viewportSize.

See also
setViewportSize

◆ getDefaultWidth()

float tgui::Scrollbar::getDefaultWidth ( )

Returns the default width of the scrollbar.

Returns
Default scrollbar width

The default width is the value the scrollbar has on construction or the size of the texture once a texture is set.

◆ getMaximum()

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

Returns the maximum value.

Returns
The current maximum value

The default maximum value is 10.

◆ getRenderer()

ScrollbarRenderer* tgui::Scrollbar::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.

◆ getScrollAmount()

unsigned int tgui::Scrollbar::getScrollAmount ( ) const

Returns how much the value changes when scrolling or pressing one of the arrows of the scrollbar.

Returns
How far should the scrollbar scroll when an arrow is clicked?

◆ getSharedRenderer()

ScrollbarRenderer* tgui::Scrollbar::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::Scrollbar::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()

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

Returns the current value.

Returns
The current value

The default value is 0.

◆ getViewportSize()

unsigned int tgui::Scrollbar::getViewportSize ( ) const

Returns the viewport size.

See also
setViewportSize

◆ mouseOnWidget()

bool tgui::Scrollbar::mouseOnWidget ( 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::Scrollbar::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.

◆ setAutoHide()

void tgui::Scrollbar::setAutoHide ( bool  autoHide)

Changes whether the scrollbar should hide automatically or not.

Parameters
autoHideShould the scrollbar be invisible when you can't scroll?

When true (default), the scrollbar will not be drawn when the maximum is smaller than the viewportSize.

See also
setViewportSize

◆ setMaximum()

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

Sets a maximum value.

Parameters
maximumThe new maximum value

When the value is bigger than (maximum - viewportSize), the value is set to maximum - viewportSize. The default maximum value is 10.

See also
setViewportSize

◆ setScrollAmount()

void tgui::Scrollbar::setScrollAmount ( unsigned int  scrollAmount)

Changes how much the value changes when scrolling or pressing one of the arrows of the scrollbar.

Parameters
scrollAmountHow far should the scrollbar scroll when an arrow is clicked?

◆ setSize() [1/3]

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

Changes the size of the scrollbar.

Parameters
sizeThe new size of the scrollbar

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

virtual void tgui::Widget::setSize

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

◆ setSize() [3/3]

void tgui::Widget::setSize
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setValue()

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

Changes the current value.

Parameters
valueThe new value

The value has to be smaller than maximum - viewportSize.

See also
setViewportSize

◆ setViewportSize()

void tgui::Scrollbar::setViewportSize ( unsigned int  viewport)

Changes the viewport size.

Parameters
viewportThe new viewport size

If the contents through which the scrollbar can scroll is 600 pixels of which only 200 pixels are visible on the screen then the viewport size should be set to 200 and the maximum should be set to 600. The thumb will occupy one third of the scrollbar track in this case. The possible scrollbar values are in the range [0, 400] in this case.

Until the maximum is bigger than this value, no scrollbar will be drawn. You can however choose to always draw the scrollbar by calling setAutoHide(false).


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