#include <TGUI/Widgets/Scrollbar.hpp>

Inheritance diagram for tgui::Scrollbar:

Public Types
enum class	Policy { Automatic , Always , Never }
	Defines when the scrollbar shows up. More...

typedef std::shared_ptr< Scrollbar >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Scrollbar >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
	Scrollbar (const char *typeName="Scrollbar", bool initRenderer=true)

ScrollbarRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const ScrollbarRenderer *	getSharedRenderer () const

ScrollbarRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const ScrollbarRenderer *	getRenderer () const

void	setSize (const Layout2d &size) override
	Changes the size of the scrollbar.

void	setMaximum (unsigned int maximum)
	Sets a maximum value.

unsigned int	getMaximum () const
	Returns the maximum value.

void	setValue (unsigned int value)
	Changes the current value.

unsigned int	getValue () const
	Returns the current value.

void	setViewportSize (unsigned int viewport)
	Changes the viewport size.

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.

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.

bool	getAutoHide () const
	Returns whether the scrollbar is hiding automatically or not.

void	setVerticalScroll (bool vertical)
	Changes whether the scrollbar lies horizontally or vertically.

bool	getVerticalScroll () const
	Returns whether the scrollbar lies horizontally or vertically.

float	getDefaultWidth ()
	Returns the default width of the scrollbar.

bool	isMouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

void	leftMousePressed (Vector2f pos) override

void	leftMouseReleased (Vector2f pos) override

void	mouseMoved (Vector2f pos) override

bool	mouseWheelScrolled (float delta, Vector2f pos) override

void	leftMouseButtonNoLongerDown () override

void	draw (BackendRenderTargetBase &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 &&)
	Move constructor.

virtual	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (Widget &&)
	Move assignment.

void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks.

WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const WidgetRenderer *	getSharedRenderer () const

WidgetRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const WidgetRenderer *	getRenderer () const

virtual void	setPosition (const Layout2d &position)
	sets the position of the widget

void	setPosition (Layout x, Layout y)
	Sets the position of the widget.

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.

Vector2f	getSize () const
	Returns the size of the widget.

virtual Vector2f	getFullSize () const
	Returns the entire size that the widget is using.

virtual Vector2f	getAbsolutePosition () const
	Get the absolute position of the top-left point of the widget instead of the relative position to its parent.

virtual Vector2f	getWidgetOffset () const
	Returns the distance between the position where the widget is drawn and where the widget is placed.

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.

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.

Vector2f	getScale () const
	Returns the scaling to be applied to the widget.

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.

float	getRotation () const
	Returns the rotation to be applied to the widget.

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.

virtual void	setVisible (bool visible)
	Shows or hides a widget.

bool	isVisible () const
	Returns true when the widget is visible.

virtual void	setEnabled (bool enabled)
	Enables or disables the widget.

bool	isEnabled () const
	Returns true when the widget is enabled.

virtual void	setFocused (bool focused)
	Focus or unfocus the widget.

bool	isFocused () const
	Returns true when the widget is focused and false otherwise.

const String &	getWidgetType () const
	Returns the type of the widget.

Container *	getParent () const
	Returns a pointer to the parent widget.

GuiBase *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.

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 T >
T	getUserData () const
	Returns 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.

const Font &	getInheritedFont () 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.

float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer.

virtual void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text.

virtual 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.

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.

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.

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.

bool	isFocusable () const
	Returns whether a widget could be focused.

virtual bool	canGainFocus () const
	Returns whether the widget can currently gain focus.

bool	isContainer () const
	Returns whether the widget is a container widget or not.

bool	isDraggableWidget () const
	Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)

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)

virtual void	rightMousePressed (Vector2f pos)

virtual void	rightMouseReleased (Vector2f pos)

virtual void	mousePressed (Event::MouseButton button, Vector2f pos)

virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)

virtual void	keyPressed (const Event::KeyEvent &event)

virtual void	textEntered (char32_t key)

virtual void	mouseNoLongerOnWidget ()

virtual void	rightMouseButtonNoLongerDown ()

virtual Widget::Ptr	askToolTip (Vector2f mousePos)

const Layout2d &	getPositionLayout () const

const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

template<typename WidgetType >
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType >
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

Static Public Member Functions
static Scrollbar::Ptr	create ()
	Creates a new scrollbar widget.

static Scrollbar::Ptr	copy (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	onAnimationFinish = {"AnimationFinished"}

SignalShowEffect	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.

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

Signal &	getSignal (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.

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

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.

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

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

Layout2d	m_size

unsigned int	m_textSize = 0

Vector2f	m_origin

Optional< Vector2f >	m_rotationOrigin

Optional< Vector2f >	m_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

bool	m_visible = true

Container *	m_parent = nullptr

GuiBase *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

Duration	m_animationTimeElapsed

bool	m_draggableWidget = false

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr

std::vector< std::shared_ptr< priv::Animation > >	m_showAnimations

Font	m_inheritedFont

float	m_inheritedOpacity = 1

Font	m_fontCached = Font::getGlobalFont()

float	m_opacityCached = 1

bool	m_transparentTextureCached = false

Any	m_userData

Cursor::Type	m_mouseCursor = Cursor::Type::Arrow

std::function< void(const String &property)>	m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); }

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

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

scrollbar The 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	(	BackendRenderTargetBase &	target,
		RenderStates	states
	)		const

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current render states

Implements tgui::Widget.

Reimplemented in tgui::ScrollbarChildWidget.

◆ 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 ( String signalName )

overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters

signalName Name of the signal

Returns: Signal that corresponds to the name

Exceptions

Exception when 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.

◆ getVerticalScroll()

bool tgui::Scrollbar::getVerticalScroll ( ) const

Returns whether the scrollbar lies horizontally or vertically.

Returns: Does the scrollbar lie vertically?

◆ getViewportSize()

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

Returns the viewport size.

See also: setViewportSize

◆ isMouseOnWidget()

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

void tgui::Scrollbar::leftMousePressed ( Vector2f pos )

overridevirtual

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.

◆ mouseWheelScrolled()

bool tgui::Scrollbar::mouseWheelScrolled	(	float	delta,
		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

property Name of the property that was changed

Reimplemented from tgui::Widget.

◆ save()

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.

◆ setAutoHide()

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

Changes whether the scrollbar should hide automatically or not.

Parameters

autoHide Should 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

maximum The 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

scrollAmount How 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

size	Size 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

size	The 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

width	Width of the widget
height	Height 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

value The 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

vertical Should 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

viewport The 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:

include/TGUI/Widgets/Scrollbar.hpp

TGUI

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Policy

Member Function Documentation

◆ clone()

◆ copy()

◆ create()

◆ draw()

◆ getAutoHide()

◆ getDefaultWidth()

◆ getMaximum()

◆ getRenderer()

◆ getScrollAmount()

◆ getSharedRenderer()

◆ getSignal()

◆ getValue()

◆ getVerticalScroll()

◆ getViewportSize()

◆ isMouseOnWidget()

◆ leftMouseButtonNoLongerDown()

◆ leftMousePressed()

◆ leftMouseReleased()

◆ load()

◆ mouseMoved()

◆ mouseWheelScrolled()

◆ rendererChanged()

◆ save()

◆ setAutoHide()

◆ setMaximum()

◆ setScrollAmount()

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ setValue()

◆ setVerticalScroll()

◆ setViewportSize()