TGUI  0.9-beta

Container widget. More...

#include <TGUI/Container.hpp>

Inheritance diagram for tgui::Container:
tgui::Widget tgui::ChildWindow tgui::Grid tgui::Group tgui::RootContainer tgui::MessageBox tgui::BoxLayout tgui::Panel tgui::RadioButtonGroup tgui::BoxLayoutRatios tgui::HorizontalWrap tgui::ScrollablePanel tgui::HorizontalLayout tgui::VerticalLayout

Public Types

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

 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.
 
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 setTextSize (unsigned int size) override
 Changes the character size of all existing and future child widgets. 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
 Saves the child widgets to a text file. 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...
 
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...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
virtual ~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...
 
Vector2f getPosition () const
 Gets the position 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 (ShowAnimationType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowAnimationType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
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...
 
GuiBasegetParentGui () 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...
 
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...
 
virtual unsigned int getTextSize () const
 Returns the character size of text in this widget. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const 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...
 
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 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...
 
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...
 

Protected Member Functions

void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed. More...
 
void draw (BackendRenderTargetBase &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.
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes.
 
- 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::Widget
SignalVector2f onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalVector2f onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
Signal onFocus = {"Focused"}
 The widget was focused.
 
Signal onUnfocus = {"Unfocused"}
 The widget was unfocused.
 
Signal onMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
Signal onMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 
SignalAnimation onAnimationFinish = {"AnimationFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

Detailed Description

Container widget.

Parent class for widgets that contain child widgets.

Signals:

  • Inherited signals from Widget

Member Function Documentation

◆ add()

virtual void tgui::Container::add ( const Widget::Ptr widgetPtr,
const String widgetName = "" 
)
virtual

Adds a widget to the container.

Parameters
widgetPtrPointer to the widget you would like to add
widgetNameYou can give the widget a unique name to retrieve it from the container later
Warning
The widget name should not contain whitespace

Reimplemented in tgui::ScrollablePanel, tgui::BoxLayoutRatios, and tgui::BoxLayout.

◆ draw()

void tgui::Container::draw ( BackendRenderTargetBase target,
RenderStates  states 
) const
overrideprotectedvirtual

Draw the child widgets to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

Reimplemented in tgui::ScrollablePanel, tgui::RadioButtonGroup, tgui::Panel, tgui::Group, tgui::ChildWindow, and tgui::RootContainer.

◆ focusNextWidget()

bool tgui::Container::focusNextWidget ( bool  recursive = true)

Focuses the next widget in this container.

Parameters
recursiveIf the focused widget is a container, should the next widget inside it be focused instead of focusing the sibling of the container?
Returns
Whether a new widget was focused

◆ focusPreviousWidget()

bool tgui::Container::focusPreviousWidget ( bool  recursive = true)

Focuses the previous widget in this container.

Parameters
recursiveIf the focused widget is a container, should the previous widget inside it be focused instead of focusing the sibling of the container?
Returns
Whether a new widget was focused

◆ get() [1/2]

Widget::Ptr tgui::Container::get ( const String widgetName) const

Returns a pointer to a widget that was added earlier.

Parameters
widgetNameThe name that was given to the widget when it was added to the container

The container will first search for widgets that are direct children of it, but when none of the child widgets match the given name, a recursive search will be performed.

Returns
Pointer to the earlier added widget
Warning
This function will return nullptr when an unknown widget name was passed

◆ get() [2/2]

template<class T >
T::Ptr tgui::Container::get ( const String widgetName) const
inline

Returns a pointer to a widget that was added earlier.

Parameters
widgetNameThe name that was given to the widget when it was added to the container
Returns
Pointer to the earlier added widget. The pointer will already be casted to the desired type

The container will first search for widgets that are direct children of it, but when none of the child widgets match the given name, a recursive search will be performed.

Warning
This function will return nullptr when an unknown widget name was passed

◆ getChildWidgetsOffset()

virtual Vector2f tgui::Container::getChildWidgetsOffset ( ) const
inlinevirtual

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

Returns
Offset of the widgets in the container

Reimplemented in tgui::Panel, tgui::Group, and tgui::ChildWindow.

◆ getFocusedChild()

Widget::Ptr tgui::Container::getFocusedChild ( ) const

Returns the child widget that is focused inside this container.

Returns
Focused child widget or nullptr if none of the widgets are currently focused

If the focused widget is a container then a pointer to that container is returned. If you want to know which widget is focused inside that container (recursively) then you should use the getFocusedLeaf() function.

◆ getFocusedLeaf()

Widget::Ptr tgui::Container::getFocusedLeaf ( ) const

Returns the leaf child widget that is focused inside this container.

Returns
Focused leaf child widget or nullptr if none of the widgets are currently focused

If the focused widget is a container then the getFocusedLeaf() is recursively called on that container. If you want to limit the search to only direct children of this container then you should use the getFocusedChild() function.

◆ getInnerSize()

virtual Vector2f tgui::Container::getInnerSize ( ) const
virtual

Returns the space available for widgets inside the container.

Returns
Size of the container

Reimplemented in tgui::Panel, tgui::Group, and tgui::ChildWindow.

◆ getWidgetAtPosition()

virtual Widget::Ptr tgui::Container::getWidgetAtPosition ( Vector2f  pos) const
virtual

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

◆ getWidgets()

const std::vector<Widget::Ptr>& tgui::Container::getWidgets ( ) const
inline

Returns a list of all the widgets in this container.

Returns
Vector of all widget pointers

◆ loadWidgetsFromFile()

void tgui::Container::loadWidgetsFromFile ( const String filename,
bool  replaceExisting = true 
)

Loads the child widgets from a text file.

Parameters
filenameFilename of the widget file
replaceExistingRemove existing widgets first if there are any
Exceptions
Exceptionwhen file could not be opened or parsing failed

◆ loadWidgetsFromStream() [1/2]

void tgui::Container::loadWidgetsFromStream ( std::stringstream &&  stream,
bool  replaceExisting = true 
)

Loads the child widgets from a string stream.

Parameters
streamstringstream that contains the widget file
replaceExistingRemove existing widgets first if there are any

◆ loadWidgetsFromStream() [2/2]

void tgui::Container::loadWidgetsFromStream ( std::stringstream &  stream,
bool  replaceExisting = true 
)

Loads the child widgets from a string stream.

Parameters
streamstringstream that contains the widget file
replaceExistingRemove existing widgets first if there are any

◆ moveWidgetBackward()

std::size_t tgui::Container::moveWidgetBackward ( const Widget::Ptr widget)

Places a widget one step backward in the z-order.

Parameters
widgetThe widget that should be moved one step backward
Returns
New index in the widgets list (one lower than the old index or the same if the widget was already at back), or getWidgets().size() if the widget was never added to this container.
See also
moveWidgetToBack

◆ moveWidgetForward()

std::size_t tgui::Container::moveWidgetForward ( const Widget::Ptr widget)

Places a widget one step forward in the z-order.

Parameters
widgetThe widget that should be moved one step forward
Returns
New index in the widgets list (one higher than the old index or the same if the widget was already in front), or getWidgets().size() if the widget was never added to this container.
See also
moveWidgetToFront

◆ moveWidgetToBack()

void tgui::Container::moveWidgetToBack ( const Widget::Ptr widget)

Places a widget behind all other widgets, to the back of the z-order.

Parameters
widgetThe widget that should be moved to the back
See also
moveWidgetBackward

◆ moveWidgetToFront()

void tgui::Container::moveWidgetToFront ( const Widget::Ptr widget)

Places a widget before all other widgets, to the front of the z-order.

Parameters
widgetThe widget that should be moved to the front
See also
moveWidgetForward

◆ processKeyPressEvent()

bool tgui::Container::processKeyPressEvent ( Event::KeyEvent  event)

Inform the container about a key press event.

Parameters
eventInformation on which key was pressed and the state of the modifier keys
Returns
True if the event was handled, false if no widget responded to the event

◆ processMouseMoveEvent()

bool tgui::Container::processMouseMoveEvent ( Vector2f  pos)

Inform the container about a mouse move event.

Parameters
posMouse position
Returns
True if the event was handled, false if no widget responded to the event

◆ processMousePressEvent()

bool tgui::Container::processMousePressEvent ( Event::MouseButton  button,
Vector2f  pos 
)

Inform the container about a mouse press event.

Parameters
buttonWhich mouse button has been pressed
posMouse position
Returns
True if the event was handled, false if no widget responded to the event

◆ processMouseReleaseEvent()

bool tgui::Container::processMouseReleaseEvent ( Event::MouseButton  button,
Vector2f  pos 
)

Inform the container about a mouse release event.

Parameters
buttonWhich mouse button has been released
posMouse position
Returns
True if the event was handled, false if no widget responded to the event

◆ processMouseWheelScrollEvent()

bool tgui::Container::processMouseWheelScrollEvent ( float  delta,
Vector2f  pos 
)

Inform the container about a mouse wheel scroll event.

Parameters
deltaWheel offset (positive is up, negative is down). High-precision mice may use non-integral offsets.
posMouse position
Returns
True if the event was handled, false if no widget responded to the event

◆ processTextEnteredEvent()

bool tgui::Container::processTextEnteredEvent ( char32_t  key)

Inform the container about a key press event.

Parameters
keyUTF-32 Unicode value of the character
Returns
True if the event was handled, false if no widget responded to the event

◆ remove()

virtual bool tgui::Container::remove ( const Widget::Ptr widget)
virtual

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 in tgui::ScrollablePanel, tgui::Grid, and tgui::BoxLayout.

◆ rendererChanged()

void tgui::Container::rendererChanged ( const 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::Widget.

Reimplemented in tgui::ScrollablePanel, tgui::Panel, tgui::MessageBox, tgui::Group, tgui::ChildWindow, and tgui::BoxLayout.

◆ saveWidgetsToFile()

void tgui::Container::saveWidgetsToFile ( const String filename)

Saves the child widgets to a text file.

Parameters
filenameFilename of the widget file
Exceptions
Exceptionwhen file could not be opened for writing

◆ saveWidgetsToStream()

void tgui::Container::saveWidgetsToStream ( std::stringstream &  stream) const

Saves the child widgets to a text file.

Parameters
streamstringstream to which the widget file will be added

◆ setFocused()

void tgui::Container::setFocused ( bool  focused)
overridevirtual

Focus or unfocus the widget.

Parameters
focusedIs the widget focused?

When a widget is focused, the previously focused widget will be unfocused.

Warning
This function only works properly when the widget was already added to its parent (e.g. the Gui).

Reimplemented from tgui::Widget.

Reimplemented in tgui::RootContainer.

◆ setSize() [1/3]

virtual void tgui::Widget::setSize

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});

◆ setSize() [2/3]

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

Changes the size of the container.

Parameters
sizeThe new size of the container

Reimplemented from tgui::Widget.

Reimplemented in tgui::ScrollablePanel, tgui::Panel, tgui::Group, tgui::Grid, tgui::ChildWindow, tgui::BoxLayout, and tgui::RootContainer.

◆ setSize() [3/3]

void tgui::Widget::setSize
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

◆ setTextSize()

void tgui::Container::setTextSize ( unsigned int  size)
overridevirtual

Changes the character size of all existing and future child widgets.

Parameters
sizeThe new text size

Reimplemented from tgui::Widget.

Reimplemented in tgui::MessageBox.

◆ sortWidgets()

template<typename Function >
void tgui::Container::sortWidgets ( Function &&  function)
inline

Sorts a list of all the widgets in this container.

Parameters
functionComparison function object (i.e. an object that satisfies the requirements of Compare) which returns true if the first argument is less than (i.e. is ordered before) the second.

The documentation for this class was generated from the following file:
TGUI_API Layout bindHeight(GuiBase &gui)
Bind to the height of the gui view.