TGUI  1.1
Loading...
Searching...
No Matches

Scrollbar widget. More...

#include <TGUI/Widgets/Scrollbar.hpp>

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

Public Types

enum class  Policy { Automatic , Always , Never }
 Defines when the scrollbar shows up. More...
 
using Ptr = std::shared_ptr< Scrollbar >
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr< const Scrollbar >
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
using Ptr = std::shared_ptr< Widget >
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr< const Widget >
 Shared constant widget pointer.
 

Public Member Functions

 Scrollbar (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
TGUI_NODISCARD ScrollbarRenderergetSharedRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
TGUI_NODISCARD const ScrollbarRenderergetSharedRenderer () const override
 
TGUI_NODISCARD ScrollbarRenderergetRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
void setSize (const Layout2d &size) override
 Changes the size of the scrollbar.
 
void setMaximum (unsigned int maximum)
 Sets a maximum value.
 
TGUI_NODISCARD unsigned int getMaximum () const
 Returns the maximum value.
 
void setValue (unsigned int value)
 Changes the current value.
 
TGUI_NODISCARD unsigned int getValue () const
 Returns the current value.
 
void setViewportSize (unsigned int viewport)
 Changes the viewport size.
 
TGUI_NODISCARD unsigned int getViewportSize () const
 Returns the viewport size.
 
void setScrollAmount (unsigned int scrollAmount)
 Changes how much the value changes when scrolling or pressing one of the arrows of the scrollbar.
 
TGUI_NODISCARD unsigned int getScrollAmount () const
 Returns how much the value changes when scrolling or pressing one of the arrows of the scrollbar.
 
void setAutoHide (bool autoHide)
 Changes whether the scrollbar should hide automatically or not.
 
TGUI_NODISCARD bool getAutoHide () const
 Returns whether the scrollbar is hiding automatically or not.
 
void setVerticalScroll (bool vertical)
 Changes whether the scrollbar lies horizontally or vertically.
 
TGUI_NODISCARD bool getVerticalScroll () const
 Returns whether the scrollbar lies horizontally or vertically.
 
TGUI_NODISCARD float getDefaultWidth ()
 Returns the default width of the scrollbar.
 
TGUI_NODISCARD bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
 
bool leftMousePressed (Vector2f pos) override
 Called by the parent when the left mouse button goes down on top of the widget.
 
void leftMouseReleased (Vector2f pos) override
 
void mouseMoved (Vector2f pos) override
 
bool scrolled (float delta, Vector2f pos, bool touch) override
 Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)
 
void leftMouseButtonNoLongerDown () override
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the widget to a render target.
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget.
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
- Public Member Functions inherited from tgui::Widget
 Widget (const char *typeName, bool initRenderer)
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&) noexcept
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&) noexcept
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks.
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget.
 
TGUI_NODISCARD Vector2f getPosition () const
 Gets the position of the widget.
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
void setWidth (Layout width)
 Changes the width of the widget.
 
void setHeight (Layout height)
 Changes the height of the widget.
 
TGUI_NODISCARD Vector2f getSize () const
 Returns the size of the widget.
 
virtual TGUI_NODISCARD Vector2f getFullSize () const
 Returns the entire size that the widget is using.
 
virtual TGUI_NODISCARD Vector2f getAbsolutePosition (Vector2f offset={}) const
 Get the absolute position of the widget instead of the relative position to its parent.
 
virtual TGUI_NODISCARD Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed.
 
void setAutoLayout (AutoLayout layout)
 
TGUI_NODISCARD AutoLayout getAutoLayout () const
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based.
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based.
 
TGUI_NODISCARD Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based.
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget.
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget.
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget.
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget.
 
TGUI_NODISCARD Vector2f getScale () const
 Returns the scaling to be applied to the widget.
 
TGUI_NODISCARD Vector2f getScaleOrigin () const
 Returns the origin used for scaling.
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget.
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget.
 
TGUI_NODISCARD float getRotation () const
 Returns the rotation to be applied to the widget.
 
TGUI_NODISCARD Vector2f getRotationOrigin () const
 Returns the origin used for rotations.
 
void showWithEffect (ShowEffectType type, Duration duration)
 Shows the widget by introducing it with an animation.
 
void hideWithEffect (ShowEffectType type, Duration duration)
 Hides the widget by making it leave with an animation.
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration.
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration.
 
virtual void setVisible (bool visible)
 Shows or hides a widget.
 
TGUI_NODISCARD bool isVisible () const
 Returns true when the widget is visible.
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget.
 
TGUI_NODISCARD bool isEnabled () const
 Returns true when the widget is enabled.
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget.
 
TGUI_NODISCARD bool isFocused () const
 Returns true when the widget is focused and false otherwise.
 
TGUI_NODISCARD const StringgetWidgetType () const
 Returns the type of the widget.
 
TGUI_NODISCARD ContainergetParent () const
 Returns a pointer to the parent widget.
 
TGUI_NODISCARD BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs.
 
TGUI_NODISCARD bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect)
 
void moveToFront ()
 Places the widget before all other widgets.
 
void moveToBack ()
 Places the widget behind all other widgets.
 
void setUserData (Any userData)
 Stores some data into the widget.
 
template<typename DataType >
TGUI_NODISCARD DataType getUserData () const
 Returns data stored in the widget.
 
TGUI_NODISCARD bool hasUserData () const
 Returns whether data stored in the widget.
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer.
 
TGUI_NODISCARD const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer.
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.
 
TGUI_NODISCARD float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer.
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text.
 
TGUI_NODISCARD unsigned int getTextSize () const
 Returns the character size of text in this widget.
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget.
 
TGUI_NODISCARD Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget.
 
void setWidgetName (const String &name)
 Changes the name of a widget.
 
TGUI_NODISCARD String getWidgetName () const
 Returns the name of a widget.
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget.
 
TGUI_NODISCARD Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget.
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused.
 
TGUI_NODISCARD bool isFocusable () const
 Returns whether a widget could be focused.
 
void setNavigationUp (const Widget::Ptr &widgetAbove)
 Changes which widget should become focused when navigating upwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationUp () const
 Returns which widget would become focused when navigating upwards from this widget.
 
void setNavigationDown (const Widget::Ptr &widgetBelow)
 Changes which widget should become focused when navigating downwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationDown () const
 Returns which widget would become focused when navigating downwards from this widget.
 
void setNavigationLeft (const Widget::Ptr &widgetLeft)
 Changes which widget should become focused when navigating to the left from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationLeft () const
 Returns which widget would become focused when navigating to the left from this widget.
 
void setNavigationRight (const Widget::Ptr &widgetRight)
 Changes which widget should become focused when navigating to the right from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationRight () const
 Returns which widget would become focused when navigating to the right from this widget.
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
virtual TGUI_NODISCARD bool canGainFocus () const
 Returns whether the widget can currently gain focus.
 
TGUI_NODISCARD bool isContainer () const
 Returns whether the widget is a container widget or not.
 
TGUI_NODISCARD bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)
 
TGUI_NODISCARD bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget.
 
virtual void setParent (Container *parent)
 
virtual bool updateTime (Duration elapsedTime)
 
void setAutoLayoutUpdateEnabled (bool enabled)
 
virtual void rightMousePressed (Vector2f pos)
 
virtual void rightMouseReleased (Vector2f pos)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual void keyPressed (const Event::KeyEvent &event)
 
virtual bool canHandleKeyPress (const Event::KeyEvent &event)
 Called by the parent of the widget to check if keyPressed would process the event.
 
virtual void textEntered (char32_t key)
 
virtual void mouseNoLongerOnWidget ()
 
virtual void rightMouseButtonNoLongerDown ()
 
virtual TGUI_NODISCARD Widget::Ptr askToolTip (Vector2f mousePos)
 
TGUI_NODISCARD const Layout2dgetPositionLayout () const
 
TGUI_NODISCARD const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
void rendererChangedCallback (const String &property)
 
virtual void updateTextSize ()
 

Static Public Member Functions

static TGUI_NODISCARD Scrollbar::Ptr create ()
 Creates a new scrollbar widget.
 
static TGUI_NODISCARD Scrollbar::Ptr copy (const Scrollbar::ConstPtr &scrollbar)
 Makes a copy of another scrollbar.
 

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.
 
SignalShowEffect onShowEffectFinish = {"ShowEffectFinished"}
 A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.
 
SignalAnimationType onAnimationFinish = {"AnimationFinished"}
 An animation has finished.
 

Static Public Attributes

static constexpr const char StaticWidgetType [] = "Scrollbar"
 Type name of the widget.
 

Protected Types

enum class  Part { Track , Thumb , ArrowUp , ArrowDown }
 
- Protected Types inherited from tgui::Widget
using SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > >
 
using LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > >
 

Protected Member Functions

void updateSize ()
 
TGUI_NODISCARD SignalgetSignal (String signalName) override
 Retrieves a signal based on its name.
 
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed.
 
TGUI_NODISCARD 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.
 
void updateThumbPosition ()
 
TGUI_NODISCARD Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type.
 
- 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.
 
void recalculateBoundPositionLayouts ()
 Calls recalculateValue() on each layout in m_boundPositionLayouts.
 
void recalculateBoundSizeLayouts ()
 Calls recalculateValue() on each layout in m_boundSizeLayouts.
 

Protected Attributes

Part m_mouseHoverOverPart = Part::Thumb
 
bool m_mouseDownOnThumb = false
 
Vector2f m_mouseDownOnThumbPos
 
unsigned int m_maximum = 10
 
unsigned int m_value = 0
 
unsigned int m_viewportSize = 1
 
bool m_verticalScroll = true
 
bool m_verticalImage = true
 
unsigned int m_scrollAmount = 1
 
bool m_autoHide = true
 
bool m_mouseDownOnArrow = false
 
bool m_sizeSet = false
 
std::chrono::steady_clock::time_point m_lastSuccessfulScrollTime
 
Vector2f m_lastSuccessfulScrollPos
 
FloatRect m_track
 
FloatRect m_thumb
 
FloatRect m_arrowUp
 
FloatRect m_arrowDown
 
Sprite m_spriteTrack
 
Sprite m_spriteTrackHover
 
Sprite m_spriteThumb
 
Sprite m_spriteThumbHover
 
Sprite m_spriteArrowUp
 
Sprite m_spriteArrowUpHover
 
Sprite m_spriteArrowDown
 
Sprite m_spriteArrowDownHover
 
Color m_thumbColorCached
 
Color m_thumbColorHoverCached
 
Color m_trackColorCached
 
Color m_trackColorHoverCached
 
Color m_arrowColorCached
 
Color m_arrowColorHoverCached
 
Color m_arrowBackgroundColorCached
 
Color m_arrowBackgroundColorHoverCached
 
- Protected Attributes inherited from tgui::Widget
String m_type
 
String m_name
 
Layout2d m_position
 Stores the position of this widget.
 
Layout2d m_size
 Stores the size of this widget.
 
unsigned int m_textSize = 0
 
Vector2f m_origin
 
Optional< Vector2fm_rotationOrigin
 
Optional< Vector2fm_scaleOrigin
 
Vector2f m_scaleFactors = {1, 1}
 
float m_rotationDeg = 0
 
Vector2f m_prevPosition
 
Vector2f m_prevSize
 
std::unordered_set< Layout * > m_boundPositionLayouts
 
std::unordered_set< Layout * > m_boundSizeLayouts
 
bool m_enabled = true
 Stores the flag indicating whether this widget is enabled.
 
bool m_visible = true
 Stores the flag indicating whether this widget is visible.
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
std::weak_ptr< Widgetm_navWidgetUp
 
std::weak_ptr< Widgetm_navWidgetDown
 
std::weak_ptr< Widgetm_navWidgetRight
 
std::weak_ptr< Widgetm_navWidgetLeft
 
Duration m_animationTimeElapsed
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::unique_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 
AutoLayout m_autoLayout = AutoLayout::Manual
 
bool m_autoLayoutUpdateEnabled = true
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 

Detailed Description

Scrollbar widget.

Member Enumeration Documentation

◆ Policy

enum class tgui::Scrollbar::Policy
strong

Defines when the scrollbar shows up.

Enumerator
Automatic 

Show the scrollbar only when needed (default)

Always 

Always show the scrollbar, even when the contents fits.

Never 

Never show the scrollbar, even if the contents does not fit.

Member Function Documentation

◆ clone()

TGUI_NODISCARD Widget::Ptr tgui::Scrollbar::clone ( ) const
overrideprotectedvirtual

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

Makes a copy of another scrollbar.

Parameters
scrollbarThe other scrollbar
Returns
The new scrollbar

◆ create()

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

Creates a new scrollbar widget.

Returns
The new scrollbar

◆ draw()

void tgui::Scrollbar::draw ( BackendRenderTarget target,
RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

Reimplemented in tgui::ScrollbarChildWidget.

◆ getAutoHide()

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

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

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

Returns the maximum value.

Returns
The current maximum value

The default maximum value is 10.

◆ getRenderer()

TGUI_NODISCARD ScrollbarRenderer * tgui::Scrollbar::getRenderer ( )
overridevirtual

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.

Reimplemented from tgui::Widget.

◆ getScrollAmount()

TGUI_NODISCARD 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() [1/2]

TGUI_NODISCARD const ScrollbarRenderer * tgui::Scrollbar::getSharedRenderer ( ) const
overridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

TGUI_NODISCARD ScrollbarRenderer * tgui::Scrollbar::getSharedRenderer ( )
overridevirtual

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

Reimplemented from tgui::Widget.

◆ getSignal()

TGUI_NODISCARD Signal & tgui::Scrollbar::getSignal ( 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()

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

Returns the current value.

Returns
The current value

The default value is 0.

◆ getVerticalScroll()

TGUI_NODISCARD bool tgui::Scrollbar::getVerticalScroll ( ) const

Returns whether the scrollbar lies horizontally or vertically.

Returns
Does the scrollbar lie vertically?

◆ getViewportSize()

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

Returns the viewport size.

See also
setViewportSize

◆ isMouseOnWidget()

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

◆ leftMouseButtonNoLongerDown()

void tgui::Scrollbar::leftMouseButtonNoLongerDown ( )
overridevirtual

Reimplemented from tgui::Widget.

◆ leftMousePressed()

bool tgui::Scrollbar::leftMousePressed ( Vector2f  pos)
overridevirtual

Called by the parent when the left mouse button goes down on top of the widget.

Parameters
posMouse position in view coordinates relative to the parent widget
Returns
True if the clicked part of the widget is draggable, i.e. if the widget should continue to receive mouse move events until the mouse is released, even when the mouse leaves the widget. When false is returned, the mouse move events will only be sent to the widget as long as the mouse is on top of the widget.

Reimplemented from tgui::Widget.

◆ leftMouseReleased()

void tgui::Scrollbar::leftMouseReleased ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ load()

void tgui::Scrollbar::load ( const std::unique_ptr< DataIO::Node > &  node,
const LoadingRenderersMap &  renderers 
)
overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ mouseMoved()

void tgui::Scrollbar::mouseMoved ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ rendererChanged()

void tgui::Scrollbar::rendererChanged ( const String property)
overrideprotectedvirtual

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

Parameters
propertyName of the property that was changed

Reimplemented from tgui::Widget.

◆ save()

TGUI_NODISCARD std::unique_ptr< DataIO::Node > tgui::Scrollbar::save ( SavingRenderersMap &  renderers) const
overrideprotectedvirtual

Saves the widget as a tree node in order to save it to a file.

Reimplemented from tgui::Widget.

◆ scrolled()

bool tgui::Scrollbar::scrolled ( float  delta,
Vector2f  pos,
bool  touch 
)
overridevirtual

Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

Parameters
deltaScroll offset (positive is up, negative is down). High-precision mice may use non-integral offsets.
posMouse position, or the initial position of the touch events
touchWas this a touch event or a mouse wheel scroll?
Returns
Was the scrolling was handled by the widget?

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]

virtual void tgui::Widget::setSize ( const Layout2d size)
virtual

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});

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

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

Changes the size of the scrollbar.

Parameters
sizeThe new size of the scrollbar

Note that the VerticalScroll propery is changed by this function based on the given width and height.

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

void tgui::Widget::setSize ( Layout  width,
Layout  height 
)
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

◆ setVerticalScroll()

void tgui::Scrollbar::setVerticalScroll ( bool  vertical)

Changes whether the scrollbar lies horizontally or vertically.

Parameters
verticalShould the scrollbar lie vertically?

This function will swap the width and height of the scrollbar if it didn't lie in the wanted direction.

◆ 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: