Group of widgets that has a background color and optional borders. More...

#include <TGUI/Widgets/ScrollablePanel.hpp>

Inheritance diagram for tgui::ScrollablePanel:

Public Types
using	Ptr = std::shared_ptr<ScrollablePanel>
	Shared widget pointer.

using	ConstPtr = std::shared_ptr<const ScrollablePanel>
	Shared constant widget pointer.

Public Types inherited from tgui::Panel
using	Ptr = std::shared_ptr<Panel>
	Shared widget pointer.

using	ConstPtr = std::shared_ptr<const Panel>
	Shared constant widget pointer.

Public Types inherited from tgui::Group
using	Ptr = std::shared_ptr<Group>
	Shared widget pointer.

using	ConstPtr = std::shared_ptr<const Group>
	Shared constant widget pointer.

Public Types inherited from tgui::Container
using	Ptr = std::shared_ptr<Container>
	Shared widget pointer.

using	ConstPtr = std::shared_ptr<const Container>
	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
	ScrollablePanel (const char *typeName=StaticWidgetType, bool initRenderer=true)

	ScrollablePanel (const ScrollablePanel &other)
	Copy constructor.

	ScrollablePanel (ScrollablePanel &&other) noexcept
	Move constructor.

ScrollablePanel &	operator= (const ScrollablePanel &other)
	Overload of assignment operator.

ScrollablePanel &	operator= (ScrollablePanel &&other) noexcept
	Overload of move assignment operator.

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

const ScrollablePanelRenderer *	getSharedRenderer () const override

ScrollablePanelRenderer *	getRenderer () 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 panel.

Vector2f	getInnerSize () const override
	Returns the space available for widgets inside the container.

Vector2f	getAbsolutePosition (Vector2f offset) const override

void	add (const Widget::Ptr &widget, const String &widgetName="") override
	Adds a widget at the end of the layout.

bool	remove (const Widget::Ptr &widget) override
	Removes a single widget that was added to the container.

void	removeAllWidgets () override
	Removes all widgets that were added to the container.

void	setContentSize (Vector2f size)
	Channges the size available for child widgets.

Vector2f	getContentSize () const
	Returns the size available for child widgets.

Vector2f	getContentOffset () const
	Returns the amount of pixels the child widgets have been shifted to be displayed by the scrollable panel.

float	getScrollbarWidth () const
	Returns the width of the scrollbars.

void	setVerticalScrollbarPolicy (Scrollbar::Policy policy)
	Changes when the vertical scrollbar should be displayed.

Scrollbar::Policy	getVerticalScrollbarPolicy () const
	Returns when the vertical scrollbar should be displayed.

void	setHorizontalScrollbarPolicy (Scrollbar::Policy policy)
	Changes when the horizontal scrollbar should be displayed.

Scrollbar::Policy	getHorizontalScrollbarPolicy () const
	Returns when the horizontal scrollbar should be displayed.

void	setVerticalScrollAmount (unsigned int scrollAmount)
	Changes how much the value changes when scrolling or pressing one of the arrows of the vertical scrollbar.

unsigned int	getVerticalScrollAmount () const
	Returns how much the value changes when scrolling or pressing one of the arrows of the vertical scrollbar.

void	setHorizontalScrollAmount (unsigned int scrollAmount)
	Changes how much the value changes when scrolling or pressing one of the arrows of the horizontal scrollbar.

unsigned int	getHorizontalScrollAmount () const
	Returns how much the value changes when scrolling or pressing one of the arrows of the horizontal scrollbar.

void	setVerticalScrollbarValue (unsigned int value)
	Changes the thumb position of the vertical scrollbar.

unsigned int	getVerticalScrollbarValue () const
	Returns the thumb position of the vertical scrollbar.

unsigned int	getVerticalScrollbarMaxValue () const
	Returns the maximum thumb position of the vertical scrollbar.

void	setHorizontalScrollbarValue (unsigned int value)
	Changes the thumb position of the horizontal scrollbar.

unsigned int	getHorizontalScrollbarValue () const
	Returns the thumb position of the horizontal scrollbar.

unsigned int	getHorizontalScrollbarMaxValue () const
	Returns the maximum thumb position of the horizontal scrollbar.

bool	isVerticalScrollbarShown () const
	Returns whether the vertical scrollbar is currently visible.

bool	isHorizontalScrollbarShown () const
	Returns whether the horizontal scrollbar is currently visible.

Widget::Ptr	getWidgetAtPos (Vector2f pos, bool recursive) const override
	Returns the widget that is located at the given position.

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

void	leftMouseButtonNoLongerDown () override

Widget::Ptr	askToolTip (Vector2f mousePos) override

void	draw (BackendRenderTarget &target, RenderStates states) const override
	Draw the widget to a render target.

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

Public Member Functions inherited from tgui::Panel
	Panel (const char *typeName=StaticWidgetType, bool initRenderer=true)

Vector2f	getChildWidgetsOffset () const override
	Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0)

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	rightMousePressed (Vector2f pos) override

void	rightMouseReleased (Vector2f pos) override

void	rightMouseButtonNoLongerDown () override

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

Public Member Functions inherited from tgui::Group
	Group (const char *typeName=StaticWidgetType, bool initRenderer=true)

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

Public Member Functions inherited from tgui::Container
	Container (const char *typeName, bool initRenderer)

	Container (const Container &copy)
	Copy constructor.

	Container (Container &&copy) noexcept
	Move constructor.

	~Container () override
	Destructor.

Container &	operator= (const Container &right)
	Overload of copy assignment operator.

Container &	operator= (Container &&right) noexcept
	Overload of move assignment operator.

const std::vector< Widget::Ptr > &	getWidgets () const
	Returns a list of all the widgets in this container.

template<typename Function >
void	sortWidgets (Function &&function)
	Sorts a list of all the widgets in this container.

Widget::Ptr	get (const String &widgetName) const
	Returns a pointer to a widget that was added earlier.

template<class WidgetType >
WidgetType::Ptr	get (const String &widgetName) const
	Returns a pointer to a widget that was added earlier.

void	loadWidgetsFromFile (const String &filename, bool replaceExisting=true)
	Loads the child widgets from a text file.

void	saveWidgetsToFile (const String &filename)
	Saves the child widgets to a text file.

void	loadWidgetsFromStream (std::stringstream &stream, bool replaceExisting=true)
	Loads the child widgets from a string stream.

void	loadWidgetsFromStream (std::stringstream &&stream, bool replaceExisting=true)
	Loads the child widgets from a string stream.

void	saveWidgetsToStream (std::stringstream &stream, const String &rootDirectory="") const
	Saves the child widgets to a text file.

void	loadWidgetsFromNodeTree (const std::unique_ptr< DataIO::Node > &rootNode, bool replaceExisting=true)
	Loads the child widgets from a tree of nodes that contain all information about the widgets.

std::unique_ptr< DataIO::Node >	saveWidgetsToNodeTree (const String &rootDirectory="") const
	Saves the child widgets to a tree of nodes that contain all information about the widgets.

void	moveWidgetToFront (const Widget::Ptr &widget)
	Places a widget before all other widgets, to the front of the z-order.

void	moveWidgetToBack (const Widget::Ptr &widget)
	Places a widget behind all other widgets, to the back of the z-order.

std::size_t	moveWidgetForward (const Widget::Ptr &widget)
	Places a widget one step forward in the z-order.

std::size_t	moveWidgetBackward (const Widget::Ptr &widget)
	Places a widget one step backward in the z-order.

virtual bool	setWidgetIndex (const Widget::Ptr &widget, std::size_t index)
	Changes the index of a widget in this container.

int	getWidgetIndex (const Widget::Ptr &widget) const
	Returns the current index of a widget in this container.

Widget::Ptr	getFocusedChild () const
	Returns the child widget that is focused inside this container.

Widget::Ptr	getFocusedLeaf () const
	Returns the leaf child widget that is focused inside this container.

virtual Widget::Ptr	getWidgetAtPosition (Vector2f pos) const
	Returns the leaf child widget that is located at the given position.

bool	focusNextWidget (bool recursive=true)
	Focuses the next widget in this container.

bool	focusPreviousWidget (bool recursive=true)
	Focuses the previous widget in this container.

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

bool	processMouseMoveEvent (Vector2f pos)
	Inform the container about a mouse move event.

bool	processMousePressEvent (Event::MouseButton button, Vector2f pos)
	Inform the container about a mouse press event.

bool	processMouseReleaseEvent (Event::MouseButton button, Vector2f pos)
	Inform the container about a mouse release event.

bool	processScrollEvent (float delta, Vector2f pos, bool touch)
	Inform the container about a scroll event (either mouse wheel or two finger scrolling on touchscreen)

bool	processKeyPressEvent (Event::KeyEvent event)
	Inform the container about a key press event.

bool	processTextEnteredEvent (char32_t key)
	Inform the container about a key press event.

void	childWidgetFocused (const Widget::Ptr &child)

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

bool	canHandleKeyPress (const Event::KeyEvent &event) override
	Called by the parent of the widget to check if keyPressed would process the event.

void	textEntered (char32_t key) override

void	setParent (Container *parent) override

void	setParentGui (BackendGui *gui)

void	updateChildrenWithAutoLayout ()

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.

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

Widget &	operator= (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.

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	getWidgetOffset () const
	Returns the distance between the position where the widget is drawn and where the widget is placed.

void	setAutoLayout (AutoLayout layout)
	Sets how the position is determined compared to the other widgets in the parent.

AutoLayout	getAutoLayout () const
	Returns how the position is determined compared to the other widgets in the parent.

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.

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.

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.

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.

BackendGui *	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 DataType >
DataType	getUserData () const
	Returns data stored in the widget.

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.

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.

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

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.

void	setNavigationUp (const Widget::Ptr &widgetAbove)
	Changes which widget should become focused when navigating upwards from this widget.

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.

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.

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.

Widget::Ptr	getNavigationRight () const
	Returns which widget would become focused when navigating to the right from this widget.

void	setIgnoreMouseEvents (bool ignore)
	Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.

bool	getIgnoreMouseEvents () const
	Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.

void	finishAllAnimations ()
	Makes all animations of the widget finish immediately.

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	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.

void	setAutoLayoutUpdateEnabled (bool enabled)

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

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.

void	rendererChangedCallback (const String &property)

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

	DualScrollbarChildInterface (const DualScrollbarChildInterface &)
	Copy constructor.

	DualScrollbarChildInterface (DualScrollbarChildInterface &&) noexcept
	Move constructor.

virtual	~DualScrollbarChildInterface ()=default
	Destructor.

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

DualScrollbarChildInterface &	operator= (DualScrollbarChildInterface &&) noexcept
	Move assignment.

ScrollbarAccessor *	getVerticalScrollbar ()
	Returns an object that provides access to the widget's vertical scrollbar.

const ScrollbarAccessor *	getVerticalScrollbar () const
	Returns an object that provides access to the widget's vertical scrollbar.

ScrollbarAccessor *	getHorizontalScrollbar ()
	Returns an object that provides access to the widget's horizontal scrollbar.

const ScrollbarAccessor *	getHorizontalScrollbar () const
	Returns an object that provides access to the widget's horizontal scrollbar.

Static Public Member Functions
static ScrollablePanel::Ptr	create (const Layout2d &size={"100%", "100%"}, Vector2f contentSize={0, 0})
	Creates a new scrollable panel widget.

static ScrollablePanel::Ptr	copy (const ScrollablePanel::ConstPtr &panel)
	Makes a copy of another scrollable panel.

Static Public Member Functions inherited from tgui::Panel
static Panel::Ptr	create (const Layout2d &size={"100%", "100%"})
	Creates a new panel widget.

static Panel::Ptr	copy (const Panel::ConstPtr &panel)
	Makes a copy of another panel.

static void	setEventBubbling (bool useEventBubbling)
	Changes whether event bubbling is used for the mouse events.

static bool	getEventBubbling ()
	Returns whether event bubbling is used for the mouse events.

Static Public Member Functions inherited from tgui::Group
static Group::Ptr	create (const Layout2d &size={"100%", "100%"})
	Creates a new group.

static Group::Ptr	copy (const Group::ConstPtr &group)
	Makes a copy of another group.

Static Public Attributes
static constexpr const char	StaticWidgetType [] = "ScrollablePanel"
	Type name of the widget.

Static Public Attributes inherited from tgui::Panel
static constexpr const char	StaticWidgetType [] = "Panel"
	Type name of the widget.

Static Public Attributes inherited from tgui::Group
static constexpr const char	StaticWidgetType [] = "Group"
	Type name of the widget.

Protected Member Functions
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	scrollbarPolicyChanged (Orientation orientation) override
	Called when the policy of one of the scrollbars has been changed calling either getVerticalScrollbar()->setPolicy(...) or getHorizontalScrollbar()->setPolicy(...)

void	scrollbarScrollAmountChanged (Orientation orientation) override
	Called when the scroll amount of one of the scrollbars has been changed calling either getVerticalScrollbar()->setScrollAmount(...) or getHorizontalScrollbar()->setScrollAmount(...)

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::Panel
Signal &	getSignal (String signalName) override
	Retrieves a signal based on its name.

bool	updateTime (Duration elapsedTime) override

Protected Member Functions inherited from tgui::Group
Protected Member Functions inherited from tgui::Container
void	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer)

Widget::Ptr	getWidgetBelowMouse (Vector2f mousePos) const

Widget::Ptr	updateWidgetBelowMouse (Vector2f mousePos)

std::size_t	getFocusedWidgetIndex () const

bool	tryFocusWidget (const Widget::Ptr &widget, bool reverseWidgetOrder, bool recursive)

Vector2f	transformMousePos (const Widget::Ptr &widget, Vector2f mousePos) const

void	widgetAdded (const Widget::Ptr &widgetPtr)

void	injectFormFilePath (const std::unique_ptr< DataIO::Node > &node, const String &path, std::map< String, bool > &checkedFilenames) const

void	loadWidgetsImpl (const std::unique_ptr< DataIO::Node > &rootNode, bool replaceExisting)

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 Member Functions inherited from tgui::DualScrollbarChildInterface
virtual void	scrollbarValueChanged (Orientation orientation)
	Called when the value of one of the scrollbars has been changed by calling either getVerticalScrollbar()->setValue(...) or getHorizontalScrollbar()->setValue(...)

void	saveScrollbarPolicies (std::unique_ptr< DataIO::Node > &node) const
	This function should be called inside the save function in order to save the configured scrollbar policies.

void	loadScrollbarPolicies (const std::unique_ptr< DataIO::Node > &node)
	This function should be called inside the load function in order to load the wanted scrollbar policies.

Protected Attributes
Vector2f	m_contentSize

Vector2f	m_mostBottomRightPosition

std::chrono::steady_clock::time_point	m_lastSuccessfulScrollTime

Vector2f	m_lastSuccessfulScrollPos

unsigned int	m_verticalScrollAmount = 0

unsigned int	m_horizontalScrollAmount = 0

bool	m_verticalScrollbarWasVisibleOnSizeUpdate = false

bool	m_horizontalScrollbarWasVisibleOnSizeUpdate = false

bool	m_recalculatingSizeDuringUpdateScrollbars = false

bool	m_stuckInUpdateScrollbars = false

std::unordered_map< Widget::Ptr, unsigned int >	m_connectedPositionCallbacks

std::unordered_map< Widget::Ptr, unsigned int >	m_connectedSizeCallbacks

Protected Attributes inherited from tgui::Panel
Borders	m_bordersCached

Color	m_borderColorCached

Color	m_backgroundColorCached

Sprite	m_spriteBackground

float	m_roundedBorderRadius = 0

bool	m_rightMouseDown = false

bool	m_possibleDoubleClick = false

Protected Attributes inherited from tgui::Group
Padding	m_paddingCached

Protected Attributes inherited from tgui::Container
std::vector< Widget::Ptr >	m_widgets

Widget::Ptr	m_widgetBelowMouse

Widget::Ptr	m_widgetWithLeftMouseDown

Widget::Ptr	m_widgetWithRightMouseDown

Widget::Ptr	m_focusedWidget

bool	m_draggingWidget = false

Vector2f	m_prevInnerSize

bool	m_isolatedFocus = false

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< 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
	Stores the flag indicating whether this widget is enabled.

bool	m_visible = true
	Stores the flag indicating whether this widget is visible.

Container *	m_parent = nullptr

BackendGui *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

std::weak_ptr< Widget >	m_navWidgetUp

std::weak_ptr< Widget >	m_navWidgetDown

std::weak_ptr< Widget >	m_navWidgetRight

std::weak_ptr< Widget >	m_navWidgetLeft

Duration	m_animationTimeElapsed

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_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

bool	m_ignoreMouseEvents = false

Font	m_fontCached = Font::getGlobalFont()

float	m_opacityCached = 1

bool	m_transparentTextureCached = false

unsigned int	m_textSizeCached = 0

Protected Attributes inherited from tgui::DualScrollbarChildInterface
CopiedSharedPtr< ScrollbarChildWidget >	m_verticalScrollbar

CopiedSharedPtr< ScrollbarChildWidget >	m_horizontalScrollbar

ScrollbarAccessor	m_verticalScrollbarAccessor

ScrollbarAccessor	m_horizontalScrollbarAccessor

Additional Inherited Members
Public Attributes inherited from tgui::Panel
SignalVector2f	onMousePress = {"MousePressed"}
	The mouse went down on the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onMouseRelease = {"MouseReleased"}
	The mouse was released on top of the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onClick = {"Clicked"}
	The panel was clicked. Optional parameter: mouse position relative to panel.

SignalVector2f	onDoubleClick = {"DoubleClicked"}
	The panel was double clicked. Optional parameter: mouse position relative to panel.

SignalVector2f	onRightMousePress = {"RightMousePressed"}
	The right mouse button went down on the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onRightMouseRelease = {"RightMouseReleased"}
	The right mouse button was released on top of the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onRightClick = {"RightClicked"}
	The panel was right clicked. Optional parameter: mouse position relative to panel.

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.

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

Static Protected Attributes inherited from tgui::Panel
static bool	m_eventBubbling

Detailed Description

Group of widgets that has a background color and optional borders.

Member Function Documentation

◆ add()

void tgui::ScrollablePanel::add	(	const Widget::Ptr &	widget,
		const String &	widgetName = "" )

overridevirtual

Adds a widget at the end of the layout.

Parameters

widget	Pointer to the widget you would like to add
widgetName	An identifier to access to the widget later

Warning: Widgets should be named as if they are C++ variables, i.e. names must not include any whitespace, or most symbols (e.g.: +, -, *, /, ., &), and should not start with a number. If you do not follow these rules, layout expressions may give unexpected results. Alphanumeric characters and underscores are safe to use, and widgets are permitted to have no name.

Reimplemented from tgui::Container.

◆ askToolTip()

Widget::Ptr tgui::ScrollablePanel::askToolTip ( Vector2f mousePos )

nodiscardoverridevirtual

Reimplemented from tgui::Container.

◆ clone()

Widget::Ptr tgui::ScrollablePanel::clone ( ) const

nodiscardoverrideprotectedvirtual

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

Reimplemented from tgui::Panel.

◆ copy()

static ScrollablePanel::Ptr tgui::ScrollablePanel::copy ( const ScrollablePanel::ConstPtr & panel )

staticnodiscard

Makes a copy of another scrollable panel.

Parameters

panel The other scrollable panel

Returns: The new scrollable panel

◆ create()

static ScrollablePanel::Ptr tgui::ScrollablePanel::create	(	const Layout2d &	size = {"100%", "100%"},
		Vector2f	contentSize = {0, 0} )

staticnodiscard

Creates a new scrollable panel widget.

Parameters

size	Size of the panel
contentSize	Size of the content area for which the scrollbars will appear if larger than the size

When contentSize is set to (0,0), the content size is determined by the child widgets of the panel.

Returns: The new scrollable panel

◆ draw()

void tgui::ScrollablePanel::draw	(	BackendRenderTarget &	target,
		RenderStates	states ) const

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current render states

Reimplemented from tgui::Panel.

◆ getAbsolutePosition()

Vector2f tgui::ScrollablePanel::getAbsolutePosition ( Vector2f offset ) const

nodiscardoverridevirtual

Warning: This function does not return the absolute position of the ScrollablePanel. It is implemented in a way that allows calling getAbsolutePosition() on a child widget of the ScrollablePanel to work.

Reimplemented from tgui::Widget.

◆ getContentOffset()

Vector2f tgui::ScrollablePanel::getContentOffset ( ) const

nodiscard

Returns the amount of pixels the child widgets have been shifted to be displayed by the scrollable panel.

Returns: Value of the scrollbars

◆ getContentSize()

Vector2f tgui::ScrollablePanel::getContentSize ( ) const

nodiscard

Returns the size available for child widgets.

Returns: Inner size of the container

If the content size is larger than the size of the panel then scrollbars will be displayed

◆ getHorizontalScrollAmount()

unsigned int tgui::ScrollablePanel::getHorizontalScrollAmount ( ) const

nodiscard

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

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

◆ getHorizontalScrollbarMaxValue()

unsigned int tgui::ScrollablePanel::getHorizontalScrollbarMaxValue ( ) const

nodiscard

Returns the maximum thumb position of the horizontal scrollbar.

Returns: Maximum value of the horizontal scrollbar

Since: TGUI 1.4

◆ getHorizontalScrollbarPolicy()

Scrollbar::Policy tgui::ScrollablePanel::getHorizontalScrollbarPolicy ( ) const

nodiscard

Returns when the horizontal scrollbar should be displayed.

Returns: The policy for displaying the horizontal scrollbar

◆ getHorizontalScrollbarValue()

unsigned int tgui::ScrollablePanel::getHorizontalScrollbarValue ( ) const

nodiscard

Returns the thumb position of the horizontal scrollbar.

Returns: Value of the horizontal scrollbar

◆ getInnerSize()

Vector2f tgui::ScrollablePanel::getInnerSize ( ) const

nodiscardoverridevirtual

Returns the space available for widgets inside the container.

Returns: Size without borders and padding, and without scrollbars if their policy is to always be visible

Reimplemented from tgui::Panel.

◆ getRenderer()

ScrollablePanelRenderer * tgui::ScrollablePanel::getRenderer ( )

nodiscardoverridevirtual

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::Panel.

◆ getScrollbarWidth()

float tgui::ScrollablePanel::getScrollbarWidth ( ) const

nodiscard

Returns the width of the scrollbars.

Returns: Scrollbar width

◆ getSharedRenderer() [1/2]

const ScrollablePanelRenderer * tgui::ScrollablePanel::getSharedRenderer ( ) const

nodiscardoverridevirtual

Reimplemented from tgui::Panel.

◆ getSharedRenderer() [2/2]

ScrollablePanelRenderer * tgui::ScrollablePanel::getSharedRenderer ( )

nodiscardoverridevirtual

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::Panel.

◆ getVerticalScrollAmount()

unsigned int tgui::ScrollablePanel::getVerticalScrollAmount ( ) const

nodiscard

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

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

◆ getVerticalScrollbarMaxValue()

unsigned int tgui::ScrollablePanel::getVerticalScrollbarMaxValue ( ) const

nodiscard

Returns the maximum thumb position of the vertical scrollbar.

Returns: Maximum value of the vertical scrollbar

Since: TGUI 1.4

◆ getVerticalScrollbarPolicy()

Scrollbar::Policy tgui::ScrollablePanel::getVerticalScrollbarPolicy ( ) const

nodiscard

Returns when the vertical scrollbar should be displayed.

Returns: The policy for displaying the vertical scrollbar

◆ getVerticalScrollbarValue()

unsigned int tgui::ScrollablePanel::getVerticalScrollbarValue ( ) const

nodiscard

Returns the thumb position of the vertical scrollbar.

Returns: Value of the vertical scrollbar

◆ getWidgetAtPos()

Widget::Ptr tgui::ScrollablePanel::getWidgetAtPos	(	Vector2f	pos,
		bool	recursive ) const

nodiscardoverridevirtual

Returns the widget that is located at the given position.

Parameters

pos	The location where the widget will be searched, relative to the container
recursive	If the widget at the position is a container, should the search continue inside it instead of just returning the container? The child container may still be returned when recursive is true, but only if none of its children are located at the searched position.

Returns: Widget at the queried position, or nullptr when there is no widget at that location

Since: TGUI 1.2

Reimplemented from tgui::Container.

◆ isHorizontalScrollbarShown()

bool tgui::ScrollablePanel::isHorizontalScrollbarShown ( ) const

nodiscard

Returns whether the horizontal scrollbar is currently visible.

Returns: Is the scrollbar visible?

◆ isVerticalScrollbarShown()

bool tgui::ScrollablePanel::isVerticalScrollbarShown ( ) const

nodiscard

Returns whether the vertical scrollbar is currently visible.

Returns: Is the scrollbar visible?

◆ leftMouseButtonNoLongerDown()

void tgui::ScrollablePanel::leftMouseButtonNoLongerDown ( )

overridevirtual

Reimplemented from tgui::Container.

◆ leftMousePressed()

bool tgui::ScrollablePanel::leftMousePressed ( Vector2f pos )

overridevirtual

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

Parameters

pos	Mouse 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::Panel.

◆ leftMouseReleased()

void tgui::ScrollablePanel::leftMouseReleased ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Panel.

◆ load()

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

overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Container.

◆ mouseMoved()

void tgui::ScrollablePanel::mouseMoved ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Container.

◆ mouseNoLongerOnWidget()

void tgui::ScrollablePanel::mouseNoLongerOnWidget ( )

overridevirtual

Reimplemented from tgui::Container.

◆ remove()

bool tgui::ScrollablePanel::remove ( const Widget::Ptr & widget )

overridevirtual

Removes a single widget that was added to the container.

Parameters

widget Pointer to the widget to remove

Returns: True when widget is removed, false when widget was not found

Reimplemented from tgui::Container.

◆ removeAllWidgets()

void tgui::ScrollablePanel::removeAllWidgets ( )

overridevirtual

Removes all widgets that were added to the container.

Reimplemented from tgui::Container.

◆ rendererChanged()

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

◆ save()

std::unique_ptr< DataIO::Node > tgui::ScrollablePanel::save ( SavingRenderersMap & renderers ) const

nodiscardoverrideprotectedvirtual

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

Reimplemented from tgui::Container.

◆ scrollbarPolicyChanged()

void tgui::ScrollablePanel::scrollbarPolicyChanged ( Orientation orientation )

overrideprotectedvirtual

Called when the policy of one of the scrollbars has been changed calling either getVerticalScrollbar()->setPolicy(...) or getHorizontalScrollbar()->setPolicy(...)

Parameters

orientation Vertical or Horizontal depending on which scrollbar triggered the callback

Reimplemented from tgui::DualScrollbarChildInterface.

◆ scrollbarScrollAmountChanged()

void tgui::ScrollablePanel::scrollbarScrollAmountChanged ( Orientation orientation )

overrideprotectedvirtual

Called when the scroll amount of one of the scrollbars has been changed calling either getVerticalScrollbar()->setScrollAmount(...) or getHorizontalScrollbar()->setScrollAmount(...)

Parameters

orientation Vertical or Horizontal depending on which scrollbar triggered the callback

Reimplemented from tgui::DualScrollbarChildInterface.

◆ scrolled()

bool tgui::ScrollablePanel::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

delta	Scroll offset (positive is up, negative is down). High-precision mice may use non-integral offsets.
pos	Mouse position, or the initial position of the touch events
touch	Was this a touch event or a mouse wheel scroll?

Returns: Was the scrolling was handled by the widget?

Reimplemented from tgui::Container.

◆ setContentSize()

void tgui::ScrollablePanel::setContentSize ( Vector2f size )

Channges the size available for child widgets.

Parameters

size	Inner size of the container

If the content size is larger than the size of the panel then scrollbars will be displayed.

When the content size is (0,0), which is the default, then the content size is determined by the child widgets.

◆ setHorizontalScrollAmount()

void tgui::ScrollablePanel::setHorizontalScrollAmount ( unsigned int scrollAmount )

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

Parameters

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

◆ setHorizontalScrollbarPolicy()

void tgui::ScrollablePanel::setHorizontalScrollbarPolicy ( Scrollbar::Policy policy )

Changes when the horizontal scrollbar should be displayed.

Parameters

policy The policy for displaying the horizontal scrollbar

◆ setHorizontalScrollbarValue()

void tgui::ScrollablePanel::setHorizontalScrollbarValue ( unsigned int value )

Changes the thumb position of the horizontal scrollbar.

Parameters

value New value of the horizontal scrollbar

◆ setSize() [1/2]

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

overridevirtual

Changes the size of the panel.

Parameters

size	The new size of the panel

Reimplemented from tgui::Panel.

◆ setSize() [2/2]

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

◆ setVerticalScrollAmount()

void tgui::ScrollablePanel::setVerticalScrollAmount ( unsigned int scrollAmount )

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

Parameters

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

◆ setVerticalScrollbarPolicy()

void tgui::ScrollablePanel::setVerticalScrollbarPolicy ( Scrollbar::Policy policy )

Changes when the vertical scrollbar should be displayed.

Parameters

policy The policy for displaying the vertical scrollbar

◆ setVerticalScrollbarValue()

void tgui::ScrollablePanel::setVerticalScrollbarValue ( unsigned int value )

Changes the thumb position of the vertical scrollbar.

Parameters

value New value of the vertical scrollbar

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

include/TGUI/Widgets/ScrollablePanel.hpp

TGUI

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add()

◆ askToolTip()

◆ clone()

◆ copy()

◆ create()

◆ draw()

◆ getAbsolutePosition()

◆ getContentOffset()

◆ getContentSize()

◆ getHorizontalScrollAmount()

◆ getHorizontalScrollbarMaxValue()

◆ getHorizontalScrollbarPolicy()

◆ getHorizontalScrollbarValue()

◆ getInnerSize()

◆ getRenderer()

◆ getScrollbarWidth()

◆ getSharedRenderer() [1/2]

◆ getSharedRenderer() [2/2]

◆ getVerticalScrollAmount()

◆ getVerticalScrollbarMaxValue()

◆ getVerticalScrollbarPolicy()

◆ getVerticalScrollbarValue()

◆ getWidgetAtPos()

◆ isHorizontalScrollbarShown()

◆ isVerticalScrollbarShown()

◆ leftMouseButtonNoLongerDown()

◆ leftMousePressed()

◆ leftMouseReleased()

◆ load()

◆ mouseMoved()

◆ mouseNoLongerOnWidget()

◆ remove()

◆ removeAllWidgets()

◆ rendererChanged()

◆ save()

◆ scrollbarPolicyChanged()

◆ scrollbarScrollAmountChanged()

◆ scrolled()

◆ setContentSize()

◆ setHorizontalScrollAmount()

◆ setHorizontalScrollbarPolicy()

◆ setHorizontalScrollbarValue()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setVerticalScrollAmount()

◆ setVerticalScrollbarPolicy()

◆ setVerticalScrollbarValue()