TGUI  1.0-alpha

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

#include <TGUI/Widgets/ScrollablePanel.hpp>

Inheritance diagram for tgui::ScrollablePanel:
tgui::Panel tgui::Group tgui::Container tgui::Widget

Public Types

typedef std::shared_ptr< ScrollablePanelPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ScrollablePanelConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Panel
typedef std::shared_ptr< PanelPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const PanelConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Group
typedef std::shared_ptr< GroupPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const GroupConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Container
typedef std::shared_ptr< ContainerPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ContainerConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

 ScrollablePanel (const char *typeName="ScrollablePanel", bool initRenderer=true)
 
 ScrollablePanel (const ScrollablePanel &other)
 Copy constructor.
 
 ScrollablePanel (ScrollablePanel &&other) noexcept
 Move constructor.
 
ScrollablePaneloperator= (const ScrollablePanel &other)
 Overload of assignment operator.
 
ScrollablePaneloperator= (ScrollablePanel &&other) noexcept
 Overload of move assignment operator.
 
ScrollablePanelRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const ScrollablePanelRenderergetSharedRenderer () const
 
ScrollablePanelRenderergetRenderer ()
 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 panel. More...
 
Vector2f getInnerSize () const override
 Returns the space available for widgets inside the container. More...
 
Vector2f getAbsolutePosition () const override
 
void add (const Widget::Ptr &widget, const String &widgetName="") override
 Adds a widget at the end of the layout. More...
 
bool remove (const Widget::Ptr &widget) override
 Removes a single widget that was added to the container. More...
 
void removeAllWidgets () override
 Removes all widgets that were added to the container. More...
 
void setContentSize (Vector2f size)
 Channges the size available for child widgets. More...
 
Vector2f getContentSize () const
 Returns the size available for child widgets. More...
 
Vector2f getContentOffset () const
 Returns the amount of pixels the child widgets have been shifted to be displayed by the scrollable panel. More...
 
float getScrollbarWidth () const
 Returns the width of the scrollbars. More...
 
void setVerticalScrollbarPolicy (Scrollbar::Policy policy)
 Changes when the vertical scrollbar should be displayed. More...
 
Scrollbar::Policy getVerticalScrollbarPolicy () const
 Returns when the vertical scrollbar should be displayed. More...
 
void setHorizontalScrollbarPolicy (Scrollbar::Policy policy)
 Changes when the horizontal scrollbar should be displayed. More...
 
Scrollbar::Policy getHorizontalScrollbarPolicy () const
 Returns when the horizontal scrollbar should be displayed. More...
 
void setVerticalScrollAmount (unsigned int scrollAmount)
 Changes how much the value changes when scrolling or pressing one of the arrows of the vertical scrollbar. More...
 
unsigned int getVerticalScrollAmount () const
 Returns how much the value changes when scrolling or pressing one of the arrows of the vertical scrollbar. More...
 
void setHorizontalScrollAmount (unsigned int scrollAmount)
 Changes how much the value changes when scrolling or pressing one of the arrows of the horizontal scrollbar. More...
 
unsigned int getHorizontalScrollAmount () const
 Returns how much the value changes when scrolling or pressing one of the arrows of the horizontal scrollbar. More...
 
void setVerticalScrollbarValue (unsigned int value)
 Changes the thumb position of the vertical scrollbar. More...
 
unsigned int getVerticalScrollbarValue () const
 Returns the thumb position of the vertical scrollbar. More...
 
void setHorizontalScrollbarValue (unsigned int value)
 Changes the thumb position of the horizontal scrollbar. More...
 
unsigned int getHorizontalScrollbarValue () const
 Returns the thumb position of the horizontal scrollbar. More...
 
Widget::Ptr getWidgetAtPosition (Vector2f pos) const override
 Returns the leaf child widget that is located at the given position. More...
 
void leftMousePressed (Vector2f pos) override
 
void leftMouseReleased (Vector2f pos) override
 
void mouseMoved (Vector2f pos) override
 
bool mouseWheelScrolled (float delta, Vector2f pos) override
 
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. 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::Panel
 Panel (const char *typeName="Panel", bool initRenderer=true)
 
PanelRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const PanelRenderergetSharedRenderer () const
 
PanelRenderergetRenderer ()
 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 panel. More...
 
Vector2f getInnerSize () const override
 Returns the space available for widgets inside the container. More...
 
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) More...
 
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void leftMousePressed (Vector2f pos) override
 
void leftMouseReleased (Vector2f pos) override
 
void rightMousePressed (Vector2f pos) override
 
void rightMouseReleased (Vector2f pos) override
 
void rightMouseButtonNoLongerDown () override
 
void draw (BackendRenderTarget &target, 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::Group
 Group (const char *typeName="Group", bool initRenderer=true)
 
GroupRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const GroupRenderergetSharedRenderer () const
 
GroupRenderergetRenderer ()
 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 group. More...
 
Vector2f getInnerSize () const override
 Returns the space available for widgets inside the container. More...
 
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) More...
 
bool isMouseOnWidget (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 (BackendRenderTarget &target, RenderStates states) const override
 Draw the child widgets 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::Container
 Container (const char *typeName, bool initRenderer)
 
 Container (const Container &copy)
 Copy constructor.
 
 Container (Container &&copy) noexcept
 Move constructor.
 
 ~Container ()
 Destructor.
 
Containeroperator= (const Container &right)
 Overload of copy assignment operator.
 
Containeroperator= (Container &&right) noexcept
 Overload of move assignment operator.
 
void setSize (const Layout2d &size) override
 Changes the size of the container. More...
 
const std::vector< Widget::Ptr > & getWidgets () const
 Returns a list of all the widgets in this container. More...
 
template<typename Function >
void sortWidgets (Function &&function)
 Sorts a list of all the widgets in this container. More...
 
virtual void add (const Widget::Ptr &widgetPtr, const String &widgetName="")
 Adds a widget to the container. More...
 
Widget::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier. More...
 
template<class T >
T::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier. More...
 
virtual bool remove (const Widget::Ptr &widget)
 Removes a single widget that was added to the container. More...
 
virtual void removeAllWidgets ()
 Removes all widgets that were added to the container. More...
 
virtual Vector2f getInnerSize () const
 Returns the space available for widgets inside the container. More...
 
virtual Vector2f getChildWidgetsOffset () const
 Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0) More...
 
void loadWidgetsFromFile (const String &filename, bool replaceExisting=true)
 Loads the child widgets from a text file. More...
 
void saveWidgetsToFile (const String &filename)
 Saves the child widgets to a text file. More...
 
void loadWidgetsFromStream (std::stringstream &stream, bool replaceExisting=true)
 Loads the child widgets from a string stream. More...
 
void loadWidgetsFromStream (std::stringstream &&stream, bool replaceExisting=true)
 Loads the child widgets from a string stream. More...
 
void saveWidgetsToStream (std::stringstream &stream, const String &rootDirectory="") const
 Saves the child widgets to a text file. More...
 
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. More...
 
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. More...
 
void moveWidgetToFront (const Widget::Ptr &widget)
 Places a widget before all other widgets, to the front of the z-order. More...
 
void moveWidgetToBack (const Widget::Ptr &widget)
 Places a widget behind all other widgets, to the back of the z-order. More...
 
std::size_t moveWidgetForward (const Widget::Ptr &widget)
 Places a widget one step forward in the z-order. More...
 
std::size_t moveWidgetBackward (const Widget::Ptr &widget)
 Places a widget one step backward in the z-order. More...
 
bool setWidgetIndex (const Widget::Ptr &widget, std::size_t index)
 Changes the index of a widget in this container. More...
 
int getWidgetIndex (const Widget::Ptr &widget) const
 Returns the current index of a widget in this container. More...
 
Widget::Ptr getFocusedChild () const
 Returns the child widget that is focused inside this container. More...
 
Widget::Ptr getFocusedLeaf () const
 Returns the leaf child widget that is focused inside this container. More...
 
virtual Widget::Ptr getWidgetAtPosition (Vector2f pos) const
 Returns the leaf child widget that is located at the given position. More...
 
bool focusNextWidget (bool recursive=true)
 Focuses the next widget in this container. More...
 
bool focusPreviousWidget (bool recursive=true)
 Focuses the previous widget in this container. More...
 
void setFocused (bool focused) override
 Focus or unfocus the widget. More...
 
bool processMouseMoveEvent (Vector2f pos)
 Inform the container about a mouse move event. More...
 
bool processMousePressEvent (Event::MouseButton button, Vector2f pos)
 Inform the container about a mouse press event. More...
 
bool processMouseReleaseEvent (Event::MouseButton button, Vector2f pos)
 Inform the container about a mouse release event. More...
 
bool processMouseWheelScrollEvent (float delta, Vector2f pos)
 Inform the container about a mouse wheel scroll event. More...
 
bool processKeyPressEvent (Event::KeyEvent event)
 Inform the container about a key press event. More...
 
bool processTextEnteredEvent (char32_t key)
 Inform the container about a key press event. More...
 
void childWidgetFocused (const Widget::Ptr &child)
 
void leftMousePressed (Vector2f pos) override
 
void rightMousePressed (Vector2f pos) override
 
void leftMouseReleased (Vector2f pos) override
 
void rightMouseReleased (Vector2f pos) override
 
void mouseMoved (Vector2f pos) override
 
void keyPressed (const Event::KeyEvent &event) override
 
void textEntered (char32_t key) override
 
bool mouseWheelScrolled (float delta, Vector2f pos) override
 
void mouseNoLongerOnWidget () override
 
void leftMouseButtonNoLongerDown () override
 
void rightMouseButtonNoLongerDown () override
 
Widget::Ptr askToolTip (Vector2f mousePos) override
 
bool updateTime (Duration elapsedTime) override
 
void setParent (Container *parent) override
 
void setParentGui (BackendGui *gui)
 
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 (const char *typeName, bool initRenderer)
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&) noexcept
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&) noexcept
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const WidgetRenderergetSharedRenderer () const
 
WidgetRenderergetRenderer ()
 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...
 
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...
 
void setWidth (Layout width)
 Changes the width of the widget. More...
 
void setHeight (Layout height)
 Changes the height 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 top-left point 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...
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based. More...
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based. More...
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based. More...
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget. More...
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget. More...
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling. More...
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget. More...
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget. More...
 
float getRotation () const
 Returns the rotation to be applied to the widget. More...
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations. More...
 
void showWithEffect (ShowEffectType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowEffectType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration. More...
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration. 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 StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
bool hasUserData () const
 Returns whether 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 FontgetInheritedFont () 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...
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text. More...
 
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 String &name)
 Changes the name of a widget. More...
 
String getWidgetName () const
 Returns the name of a widget. More...
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget. More...
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the 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...
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
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...
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget. More...
 
virtual SignalgetSignal (String signalName)
 Retrieves a signal based on its name. More...
 
virtual void setParent (Container *parent)
 
virtual bool updateTime (Duration elapsedTime)
 
virtual bool isMouseOnWidget (Vector2f pos) const =0
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
virtual void leftMousePressed (Vector2f pos)
 
virtual void leftMouseReleased (Vector2f pos)
 
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 mouseMoved (Vector2f pos)
 
virtual void keyPressed (const Event::KeyEvent &event)
 
virtual void textEntered (char32_t key)
 
virtual bool mouseWheelScrolled (float delta, Vector2f pos)
 
virtual void mouseNoLongerOnWidget ()
 
virtual void leftMouseButtonNoLongerDown ()
 
virtual void rightMouseButtonNoLongerDown ()
 
virtual Widget::Ptr askToolTip (Vector2f mousePos)
 
const Layout2dgetPositionLayout () const
 
const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
virtual void draw (BackendRenderTarget &target, RenderStates states) const =0
 Draw the widget to a render target. More...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
virtual Widget::Ptr clone () const =0
 Makes a copy of the widget if you don't know its exact type. More...
 
void rendererChangedCallback (const String &property)
 

Static Public Member Functions

static ScrollablePanel::Ptr create (Layout2d size={"100%", "100%"}, Vector2f contentSize={0, 0})
 Creates a new scrollable panel widget. More...
 
static ScrollablePanel::Ptr copy (ScrollablePanel::ConstPtr panel)
 Makes a copy of another scrollbable panel. More...
 
- Static Public Member Functions inherited from tgui::Panel
static Panel::Ptr create (Layout2d size={"100%", "100%"})
 Creates a new panel widget. More...
 
static Panel::Ptr copy (Panel::ConstPtr panel)
 Makes a copy of another panel. More...
 
- Static Public Member Functions inherited from tgui::Group
static Group::Ptr create (const Layout2d &size={"100%", "100%"})
 Creates a new group. More...
 
static Group::Ptr copy (Group::ConstPtr group)
 Makes a copy of another group. More...
 

Protected Member Functions

void rendererChanged (const 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. More...
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes. More...
 
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::Panel
SignalgetSignal (String signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed. More...
 
bool updateTime (Duration elapsedTime) override
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed. More...
 
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::Container
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed. More...
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the child widgets to a render target. 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. More...
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes. More...
 
void updateTextSize () override
 Called when the text size is changed (either by setTextSize or via the renderer) More...
 
Widget::Ptr getWidgetBelowMouse (Vector2f mousePos) const
 
Widget::Ptr updateWidgetBelowMouse (Vector2f mousePos)
 
std::size_t getFocusedWidgetIndex () const
 
bool tryFocusWidget (const tgui::Widget::Ptr &widget, bool reverseWidgetOrder, bool recursive)
 
Vector2f transformMousePos (const Widget::Ptr &widget, Vector2f mousePos) const
 
void widgetAdded (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 rendererChanged (const String &property)
 Function called when one of the properties of the renderer is changed. More...
 
virtual std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const
 Saves the widget as a tree node in order to save it to a file. More...
 
virtual void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers)
 Loads the widget from a tree of nodes. More...
 
virtual void updateTextSize ()
 Called when the text size is changed (either by setTextSize or via the renderer) More...
 
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget. More...
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget. More...
 

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. More...
 
- 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 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::Ptrm_widgets
 
Widget::Ptr m_widgetBelowMouse
 
Widget::Ptr m_widgetWithLeftMouseDown
 
Widget::Ptr m_widgetWithRightMouseDown
 
Widget::Ptr m_focusedWidget
 
Vector2f m_prevInnerSize
 
bool m_isolatedFocus = false
 
- 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< Vector2fm_rotationOrigin
 
Optional< Vector2fm_scaleOrigin
 
Vector2f m_scaleFactors = {1, 1}
 
float m_rotationDeg = 0
 
Vector2f m_prevPosition
 
Vector2f m_prevSize
 
std::unordered_set< Layout * > m_boundPositionLayouts
 
std::unordered_set< Layout * > m_boundSizeLayouts
 
bool m_enabled = true
 
bool m_visible = true
 
Containerm_parent = nullptr
 
BackendGuim_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< WidgetRendererm_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
 
unsigned int m_textSizeCached = 0
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 

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
widgetPointer to the widget you would like to add
widgetNameAn identifier to access to the widget later

Reimplemented from tgui::Container.

◆ askToolTip()

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

Reimplemented from tgui::Container.

◆ clone()

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

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns
Copy of the widget

Reimplemented from tgui::Panel.

◆ copy()

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

Makes a copy of another scrollbable panel.

Parameters
panelThe other scrollbable panel
Returns
The new scrollbable panel

◆ create()

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

Creates a new scrollable panel widget.

Parameters
sizeSize of the panel
contentSizeSize 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
targetRender target to draw to
statesCurrent render states

Reimplemented from tgui::Panel.

◆ getAbsolutePosition()

Vector2f tgui::ScrollablePanel::getAbsolutePosition ( ) const
overridevirtual
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

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

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

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?

◆ getHorizontalScrollbarPolicy()

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

Returns when the horizontal scrollbar should be displayed.

Returns
The policy for displaying the horizontal scrollbar

◆ getHorizontalScrollbarValue()

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

Returns the thumb position of the horizontal scrollbar.

Returns
Value of the horizontal scrollbar

◆ getInnerSize()

Vector2f tgui::ScrollablePanel::getInnerSize ( ) const
overridevirtual

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

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.

◆ getScrollbarWidth()

float tgui::ScrollablePanel::getScrollbarWidth ( ) const

Returns the width of the scrollbars.

Returns
Scrollbar width

◆ getSharedRenderer()

ScrollablePanelRenderer * tgui::ScrollablePanel::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

◆ getVerticalScrollAmount()

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

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?

◆ getVerticalScrollbarPolicy()

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

Returns when the vertical scrollbar should be displayed.

Returns
The policy for displaying the vertical scrollbar

◆ getVerticalScrollbarValue()

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

Returns the thumb position of the vertical scrollbar.

Returns
Value of the vertical scrollbar

◆ getWidgetAtPosition()

Widget::Ptr tgui::ScrollablePanel::getWidgetAtPosition ( Vector2f  pos) const
overridevirtual

Returns the leaf child widget that is located at the given position.

Parameters
posThe location where the widget will be searched, relative to the container
Returns
Widget at the queried position, or nullptr when there is no widget at that location

Reimplemented from tgui::Container.

◆ leftMouseButtonNoLongerDown()

void tgui::ScrollablePanel::leftMouseButtonNoLongerDown ( )
overridevirtual

Reimplemented from tgui::Container.

◆ leftMousePressed()

void tgui::ScrollablePanel::leftMousePressed ( Vector2f  pos)
overridevirtual

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.

◆ mouseWheelScrolled()

bool tgui::ScrollablePanel::mouseWheelScrolled ( float  delta,
Vector2f  pos 
)
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
widgetPointer 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
propertyName of the property that was changed

Reimplemented from tgui::Panel.

◆ save()

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

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

Reimplemented from tgui::Container.

◆ setContentSize()

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

Channges the size available for child widgets.

Parameters
sizeInner 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
scrollAmountHow 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
policyThe policy for displaying the horizontal scrollbar

◆ setHorizontalScrollbarValue()

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

Changes the thumb position of the horizontal scrollbar.

Parameters
valueNew value of the horizontal scrollbar

◆ setSize() [1/3]

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

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});
TGUI_API Layout bindHeight(std::shared_ptr< Widget > widget)
Bind to the height of the widget.

Reimplemented from tgui::Panel.

◆ setSize() [2/3]

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

Changes the size of the panel.

Parameters
sizeThe new size of the panel

Reimplemented from tgui::Panel.

◆ setSize() [3/3]

void tgui::Widget::setSize ( Layout  width,
Layout  height 
)
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ 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
scrollAmountHow 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
policyThe policy for displaying the vertical scrollbar

◆ setVerticalScrollbarValue()

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

Changes the thumb position of the vertical scrollbar.

Parameters
valueNew value of the vertical scrollbar

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