tgui::ScrollbarChildWidget Class Reference

Wrapper around scrollbar to be used inside widgets that need a scrollbar. More...

#include <TGUI/Widgets/Scrollbar.hpp>

Inheritance diagram for tgui::ScrollbarChildWidget:

Public Member Functions
bool	isMouseDown () const
	Returns whether the mouse is on top of the scrollbar.
bool	isMouseDownOnThumb () const
	Returns whether the mouse is on top of the thumb of the scrollbar.
bool	isShown () const
	Returns whether the scrollbar is currently visible. More...
Public Member Functions inherited from tgui::Scrollbar
ScrollbarRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
ScrollbarRenderer *	getRenderer ()
	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...
void	setVerticalScroll (bool vertical)
	Changes whether the scrollbar lies horizontally or vertically. More...
bool	getVerticalScroll () const
	Returns whether the scrollbar lies horizontally or vertically. 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.
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. More...
WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
WidgetRenderer *	getRenderer ()
	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...
Container *	getParent () const
	Returns a pointer to the parent widget. More...
bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect) 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 (std::any userData)
	Stores some data into the widget. More...
template<typename T >
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 Font &	getInheritedFont () 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...
virtual void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text. More...
virtual unsigned int	getTextSize () const
	Returns the character size of text in this widget. 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...
void	setWidgetName (const sf::String &name)
	Changes the name of a widget. More...
sf::String	getWidgetName () const
	Returns the name of a widget. More...
void	setFocusable (bool focusable)
	Changes whether a widget could be focused. More...
bool	isFocusable () const
	Returns whether a widget could be focused. More...
virtual bool	canGainFocus () const
	Returns whether the widget can currently 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 &...)> >::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, 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.

Additional Inherited Members
Public Types inherited from tgui::Scrollbar
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.
Static Public Member Functions inherited from tgui::Scrollbar
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 inherited from tgui::Scrollbar
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 inherited from tgui::Scrollbar
Signal &	getSignal (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

Wrapper around scrollbar to be used inside widgets that need a scrollbar.

Member Function Documentation

isShown()

bool tgui::ScrollbarChildWidget::isShown

(

)

const

Returns whether the scrollbar is currently visible.

Returns

Is the scrollbar visible?

The scrollbar is visible when auto hide is disabled or when the maximum is higher than the viewport size

---

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

• include/TGUI/Widgets/Scrollbar.hpp