TGUI  0.8-dev

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

#include <ScrollablePanel.hpp>

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

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 Layout2d &size={"100%", "100%"}, sf::Vector2f contentSize={0, 0})
 Default constructor. More...
 
ScrollablePanelRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
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...
 
void add (const tgui::Widget::Ptr &widget, const sf::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.
 
void setContentSize (sf::Vector2f size)
 Channges the size available for child widgets. More...
 
sf::Vector2f getContentSize () const
 Returns the size available for child widgets. More...
 
sf::Vector2f getContentOffset () const
 Returns the amount of pixels the child widgets have been shifted to be displayed by the scrollable panel. More...
 
void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::Panel
 Panel (const Layout2d &size={"100%", "100%"})
 Default constructor. More...
 
PanelRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
PanelRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
sf::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 mouseOnWidget (sf::Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
- Public Member Functions inherited from tgui::Group
 Group (const Layout2d &size={"100%", "100%"})
 Default constructor. More...
 
GroupRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
GroupRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
- Public Member Functions inherited from tgui::Container
 Container (const Container &copy)
 Copy constructor.
 
 Container (Container &&copy)
 Move constructor.
 
 ~Container ()
 Destructor.
 
Containeroperator= (const Container &right)
 Overload of copy assignment operator.
 
Containeroperator= (Container &&right)
 Overload of move assignment operator.
 
const std::vector< Widget::Ptr > & getWidgets () const
 Returns a list of all the widgets. More...
 
const std::vector< sf::String > & getWidgetNames () const
 Returns a list of the names of all the widgets. More...
 
Widget::Ptr get (const sf::String &widgetName) const
 Returns a pointer to an earlier created widget. More...
 
template<class T >
T::Ptr get (const sf::String &widgetName) const
 Returns a pointer to an earlier created widget. More...
 
bool setWidgetName (const Widget::Ptr &widget, const std::string &name)
 Changes the name of a widget. More...
 
std::string getWidgetName (const Widget::Ptr &widget) const
 Returns the name of a widget. More...
 
void focusWidget (const Widget::Ptr &widget)
 Focuses a widget. More...
 
void focusNextWidget ()
 Focuses the next widget. More...
 
void focusPreviousWidget ()
 Focuses the previous widget. More...
 
void unfocusWidgets ()
 Unfocuses all the widgets.
 
void uncheckRadioButtons ()
 Unchecks all the radio buttons.
 
void loadWidgetsFromFile (const std::string &filename)
 Loads the child widgets from a text file. More...
 
void saveWidgetsToFile (const std::string &filename)
 Saves the child widgets to a text file. More...
 
void loadWidgetsFromStream (std::stringstream &stream)
 Loads the child widgets from a string stream. More...
 
void loadWidgetsFromStream (std::stringstream &&stream)
 Loads the child widgets from a string stream. More...
 
void saveWidgetsToStream (std::stringstream &stream) const
 Saves the child widgets to a text file. More...
 
void moveWidgetToFront (const Widget::Ptr &widget)
 Places a widget before all other widgets. More...
 
void moveWidgetToBack (const Widget::Ptr &widget)
 Places a widget behind all other widgets. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (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...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
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...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual sf::Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hide ()
 Hides the widget. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void enable ()
 Enables the widget. More...
 
virtual void disable ()
 Disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void focus ()
 Focus the widget. More...
 
virtual void unfocus ()
 Unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const std::string & getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets. More...
 
virtual void moveToBack ()
 Places the widget behind all other widgets. 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 setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip ()
 Returns the tool tip that is displayed when hovering over the widget. More...
 
- 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 &..., 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.
 

Static Public Member Functions

static ScrollablePanel::Ptr create (Layout2d size={"100%", "100%"}, sf::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 std::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::Panel
sf::Vector2f getInnerSize () const
 Returns the size without borders and padding.
 
SignalgetSignal (std::string signalName) override
 Retrieves a signal based on its name. 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.
 

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

Detailed Description

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

Constructor & Destructor Documentation

◆ ScrollablePanel()

tgui::ScrollablePanel::ScrollablePanel ( const Layout2d size = {"100%", "100%"},
sf::Vector2f  contentSize = {0, 0} 
)

Default constructor.

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.

Member Function Documentation

◆ add()

void tgui::ScrollablePanel::add ( const tgui::Widget::Ptr widget,
const sf::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.

◆ clone()

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

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

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

Returns
Copy of the widget

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%"},
sf::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 ( sf::RenderTarget &  target,
sf::RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Reimplemented from tgui::Panel.

◆ getContentOffset()

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

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

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

◆ 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

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

◆ rendererChanged()

void tgui::ScrollablePanel::rendererChanged ( const std::string &  property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyLowercase name of the property that was changed

Reimplemented from tgui::Panel.

◆ setContentSize()

void tgui::ScrollablePanel::setContentSize ( sf::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.

◆ setSize()

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.


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