#include <TGUI/Widgets/Scrollbar.hpp>

Inheritance diagram for tgui::Scrollbar:

Public Types
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
std::shared_ptr< ScrollbarRenderer >	getRenderer () const
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

virtual void	setPosition (const Layout2d &position) override
	Set the position of the widget. More...

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

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

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

void	setLowValue (unsigned int lowValue)
	Changes the 'low value'. More...

unsigned int	getMaximum () const
	Returns the maximum value. More...

unsigned int	getValue () const
	Returns the current value. More...

unsigned int	getLowValue () const
	Returns the low value. More...

void	setArrowScrollAmount (unsigned int scrollAmount)
	Changes how much the value changes when pressing one of the arrows of the scrollbar. More...

unsigned int	getArrowScrollAmount ()
	Returns how much the value changes when 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...

virtual void	setOpacity (float opacity) override
	Changes the opacity of the widget. More...

virtual void	setPosition (const Layout2d &position)
	set the position of the widget More...

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

virtual void	setSize (const Layout2d &size)
	Changes the size of the widget. More...

void	setSize (const Layout &width, const Layout &height)
	Changes the size of the widget. More...

Public Member Functions inherited from tgui::Widget
	Widget ()
	Default constructor.

	Widget (const Widget &copy)
	Copy constructor. More...

	~Widget ()
	Destructor.

Widget &	operator= (const Widget &right)
	Overload of assignment operator. More...

std::shared_ptr< WidgetRenderer >	getRenderer () const
	Returns the renderer, which gives access to functions that determine how the widget is displayed. 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 (bool blockMouseEvents=true)
	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...

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

float	getOpacity () const
	Returns the opacity of the 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...

virtual void	setFont (const Font &font)
	Changes the font of the text in the widget. More...

std::shared_ptr< sf::Font >	getFont () const
	Returns the font associated with the widget (if any) More...

void	detachTheme ()
	Detach the theme from the widget. More...

std::shared_ptr< BaseTheme >	getTheme () const
	Returns the theme to which the widget is currently connected. More...

std::string	getPrimaryLoadingParameter () const
	Returns the primary parameter that was passed to the loader to load this widget. More...

std::string	getSecondaryLoadingParameter () const
	Returns the secondary parameter that was passed to the loader to load this widget. More...

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

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

void	setSize (const Layout &width, const Layout &height)
	Changes the size of the widget. More...

Public Member Functions inherited from tgui::Transformable
virtual	~Transformable ()
	Virtual destructor.

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

sf::Vector2f	getPosition () const
	get the position of the widget More...

void	move (const Layout2d &offset)
	Move the widget by a given offset. More...

void	move (const Layout &x, const Layout &y)
	Move the widget by a given offset. More...

void	setSize (const Layout &width, const Layout &height)
	Changes the size of the widget. More...

virtual sf::Vector2f	getSize () const
	Returns the size of the widget. More...

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

void	scale (const Layout2d &factors)
	Scale the widget. More...

void	scale (const Layout &x, const Layout &y)
	Scale the widget. More...

Public Member Functions inherited from tgui::SignalWidgetBase
	SignalWidgetBase ()=default
	Default constructor.

	SignalWidgetBase (const SignalWidgetBase &copy)
	Copy constructor. More...

SignalWidgetBase &	operator= (const SignalWidgetBase &right)
	Overload of assignment operator. More...

template<typename Func , typename... Args>
unsigned int	connect (const std::string &signalNames, Func func, Args... args)
	Connects a signal handler function to one or more signals. More...

template<typename Func , typename... Args>
unsigned int	connectEx (const std::string &signalName, Func func, Args... args)
	Connects a signal handler function to one or more signals. More...

void	disconnect (unsigned int id)
	Disconnects a connection. More...

void	disconnectAll (const std::string &signalName)
	Disconnect all connections from a certain signal. More...

void	disconnectAll ()
	Disconnect all connections from a all 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...

Protected Member Functions
virtual void	reload (const std::string &primary="", const std::string &secondary="", bool force=false) override
	Reload the widget. 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
void	attachTheme (std::shared_ptr< BaseTheme > theme)
	Attach a theme to the widget. More...

Detailed Description

Scrollbar widget.

Signals:

ValueChanged (The value of the scrollbar has changed)
- Optional parameter int: New value
- Uses Callback member 'value'
Inherited signals from Widget

Member Function Documentation

◆ clone()

virtual 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

◆ getArrowScrollAmount()

unsigned int tgui::Scrollbar::getArrowScrollAmount ( )

inline

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

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

◆ getAutoHide()

bool tgui::Scrollbar::getAutoHide ( ) const

inline

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 low value. So when you can't scroll, the scrollbar won't be drawn.

◆ getLowValue()

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

inline

Returns the low value.

See also: setLowValue

◆ getMaximum()

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

inline

Returns the maximum value.

Returns: The current maximum value

The default maximum value is 10.

◆ getRenderer()

std::shared_ptr< ScrollbarRenderer > tgui::Scrollbar::getRenderer ( ) const

inline

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

Returns: Reference to the renderer

◆ getValue()

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

inline

Returns the current value.

Returns: The current value

The default value is 0.

◆ reload()

virtual void tgui::Scrollbar::reload	(	const std::string &	primary = `""`,
		const std::string &	secondary = `""`,
		bool	force = `false`
	)

overrideprotectedvirtual

Reload the widget.

Parameters

primary	Primary parameter for the loader
secondary	Secondary parameter for the loader
force	Try to only change the looks of the widget and not alter the widget itself when false

Exceptions

Exception when the connected theme could not create the widget

When primary is an empty string the built-in white theme will be used.

Reimplemented from tgui::Widget.

◆ setArrowScrollAmount()

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

inline

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

Parameters

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

◆ setAutoHide()

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

inline

Changes whether the scrollbar should hide automatically or not.

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

Parameters

autoHide Should the scrollbar be invisible when you can't scroll?

◆ setLowValue()

void tgui::Scrollbar::setLowValue ( unsigned int lowValue )

Changes the 'low value'.

Parameters

lowValue The new low value. In e.g. a list box, this value is the amount of items that fit inside the list box.

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 default low value is 6.

◆ 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 - low value), the value is set to maximum - low value. The default maximum value is 10.

◆ setOpacity()

virtual void tgui::Scrollbar::setOpacity ( float opacity )

overridevirtual

Changes the opacity of the widget.

Parameters

opacity The opacity of the widget. 0 means completely transparent, while 1 (default) means fully opaque.

Reimplemented from tgui::Widget.

◆ setPosition() [1/3]

void tgui::Transformable::setPosition	(	const Layout &	x,
		const Layout &	y
	)

inline

set the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

x	New x coordinate
y	New y coordinate

See also: move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition(40, 30);
 
// Place the widget 50 pixels below another widget
widget->setPosition(otherWidget->getPosition().x, otherWidget->getPosition().y + otherWidget->getSize().y + 50);
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition(tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50);

◆ setPosition() [2/3]

virtual void tgui::Transformable::setPosition ( const Layout2d & position )

virtual

set the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

position New position

See also: move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition({40, 30});
 
// Place the widget 50 pixels below another widget
widget->setPosition(otherWidget->getPosition() + sf::Vector2f{0, otherWidget->getSize().y + 50});
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition({tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setPosition() [3/3]

virtual void tgui::Scrollbar::setPosition ( const Layout2d & position )

overridevirtual

Set the position of the widget.

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

position New position

See also: move, getPosition

Reimplemented from tgui::Widget.

◆ setSize() [1/3]

void tgui::Transformable::setSize	(	const Layout &	width,
		const Layout &	height
	)

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Usage examples:

// Give the widget an exact size
widget->setSize(40, 30);
 
// Make the widget 50 pixels higher than some other widget
widget->setSize(otherWidget->getSize().x, otherWidget->getSize().y + 50);
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize(tgui::bindWidth(otherWidget), tgui::bindHeight(otherWidget) + 50);

◆ setSize() [2/3]

virtual void tgui::Transformable::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});
 
// Make the widget 50 pixels higher than some other widget
widget->setSize(otherWidget->getSize() + sf::Vector2f{0, 50});
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize(tgui::bindSize(otherWidget) + sf::Vector2f{0, 50});

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

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

overridevirtual

Changes the size of the scrollbar.

Parameters

size	The new size of the scrollbar

Reimplemented from tgui::Widget.

◆ 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 - low value.

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

Protected Member Functions

Detailed Description

Member Function Documentation

◆ clone()

◆ copy()

◆ create()

◆ getArrowScrollAmount()

◆ getAutoHide()

◆ getLowValue()

◆ getMaximum()

◆ getRenderer()

◆ getValue()

◆ reload()

◆ setArrowScrollAmount()

◆ setAutoHide()

◆ setLowValue()

◆ setMaximum()

◆ setOpacity()

◆ setPosition() [1/3]

◆ setPosition() [2/3]

◆ setPosition() [3/3]

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ setValue()