#include <TGUI/Container.hpp>

Inheritance diagram for tgui::Container:

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

void	setSize (const Layout2d &size) override
	Changes the size of the container.

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

virtual void	add (const Widget::Ptr &widgetPtr, const String &widgetName="")
	Adds a widget to the container.

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

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

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

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

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

virtual TGUI_NODISCARD 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)

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.

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

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

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

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

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

virtual TGUI_NODISCARD Widget::Ptr	getWidgetAtPos (Vector2f pos, bool recursive) const
	Returns the 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)

bool	leftMousePressed (Vector2f pos) override
	Called by the parent when the left mouse button goes down on top of the widget.

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

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

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

void	rightMouseButtonNoLongerDown () override

TGUI_NODISCARD Widget::Ptr	askToolTip (Vector2f mousePos) override

bool	updateTime (Duration elapsedTime) 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 TGUI_NODISCARD WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

virtual TGUI_NODISCARD const WidgetRenderer *	getSharedRenderer () const

virtual TGUI_NODISCARD WidgetRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

virtual void	setPosition (const Layout2d &position)
	sets the position of the widget

void	setPosition (Layout x, Layout y)
	Sets the position of the widget.

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

TGUI_NODISCARD Vector2f	getSize () const
	Returns the size of the widget.

virtual TGUI_NODISCARD Vector2f	getFullSize () const
	Returns the entire size that the widget is using.

virtual TGUI_NODISCARD Vector2f	getAbsolutePosition (Vector2f offset={}) const
	Get the absolute position of the widget instead of the relative position to its parent.

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

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

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

TGUI_NODISCARD Vector2f	getScale () const
	Returns the scaling to be applied to the widget.

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

TGUI_NODISCARD float	getRotation () const
	Returns the rotation to be applied to the widget.

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

TGUI_NODISCARD bool	isVisible () const
	Returns true when the widget is visible.

virtual void	setEnabled (bool enabled)
	Enables or disables the widget.

TGUI_NODISCARD bool	isEnabled () const
	Returns true when the widget is enabled.

TGUI_NODISCARD bool	isFocused () const
	Returns true when the widget is focused and false otherwise.

TGUI_NODISCARD const String &	getWidgetType () const
	Returns the type of the widget.

TGUI_NODISCARD Container *	getParent () const
	Returns a pointer to the parent widget.

TGUI_NODISCARD BackendGui *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.

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

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

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

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

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

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

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

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

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

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

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

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

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

TGUI_NODISCARD 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 TGUI_NODISCARD bool	canGainFocus () const
	Returns whether the widget can currently gain focus.

TGUI_NODISCARD bool	isContainer () const
	Returns whether the widget is a container widget or not.

TGUI_NODISCARD bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.

virtual TGUI_NODISCARD Signal &	getSignal (String signalName)
	Retrieves a signal based on its name.

void	setAutoLayoutUpdateEnabled (bool enabled)

virtual TGUI_NODISCARD bool	isMouseOnWidget (Vector2f pos) const =0
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

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

TGUI_NODISCARD const Layout2d &	getPositionLayout () const

TGUI_NODISCARD const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

virtual TGUI_NODISCARD Widget::Ptr	clone () const =0
	Makes a copy of the widget if you don't know its exact type.

void	rendererChangedCallback (const String &property)

Protected Member Functions
void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.

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

TGUI_NODISCARD 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	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer)

TGUI_NODISCARD Widget::Ptr	getWidgetBelowMouse (Vector2f mousePos) const

Widget::Ptr	updateWidgetBelowMouse (Vector2f mousePos)

TGUI_NODISCARD std::size_t	getFocusedWidgetIndex () const

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

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

Friends
class	SubwidgetContainer

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.

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

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

widgetPtr	Pointer to the widget you would like to add
widgetName	You can give the widget a unique name to retrieve it from the container 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 in tgui::BoxLayout, tgui::BoxLayoutRatios, tgui::ScrollablePanel, and tgui::SplitContainer.

◆ askToolTip()

TGUI_NODISCARD Widget::Ptr tgui::Container::askToolTip ( Vector2f mousePos )

overridevirtual

Reimplemented from tgui::Widget.

◆ canHandleKeyPress()

bool tgui::Container::canHandleKeyPress ( const Event::KeyEvent & event )

overridevirtual

Called by the parent of the widget to check if keyPressed would process the event.

Parameters

event Key event that took place

Returns: True if the event would be handled by the widget, false if the key event doesn't affect the widget

Since: TGUI 1.1

Reimplemented from tgui::Widget.

Reimplemented in tgui::FileDialog.

◆ draw()

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

overrideprotectedvirtual

Draw the child widgets to a render target.

Parameters

target	Render target to draw to
states	Current render states

Implements tgui::Widget.

Reimplemented in tgui::Group, tgui::Panel, tgui::RootContainer, tgui::ScrollablePanel, and tgui::SplitContainer.

◆ focusNextWidget()

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

Focuses the next widget in this container.

Parameters

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

recursive If 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]

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

Returns a pointer to a widget that was added earlier.

Parameters

widgetName The 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 WidgetType >

TGUI_NODISCARD WidgetType::Ptr tgui::Container::get ( const String & widgetName ) const

inline

Returns a pointer to a widget that was added earlier.

Parameters

widgetName The 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 TGUI_NODISCARD 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::ChildWindow, tgui::Group, and tgui::Panel.

◆ getFocusedChild()

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

TGUI_NODISCARD 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 TGUI_NODISCARD Vector2f tgui::Container::getInnerSize ( ) const

virtual

Returns the space available for widgets inside the container.

Returns: Size of the container

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

◆ getWidgetAtPos()

virtual TGUI_NODISCARD Widget::Ptr tgui::Container::getWidgetAtPos	(	Vector2f	pos,
		bool	recursive ) const

virtual

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

◆ getWidgetAtPosition()

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

virtual

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

Parameters

pos	The location where the widget will be searched, relative to the parent of this container

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

Deprecated: Replaced by getWidgetAtPos in TGUI 1.2

◆ getWidgetIndex()

TGUI_NODISCARD int tgui::Container::getWidgetIndex ( const Widget::Ptr & widget ) const

Returns the current index of a widget in this container.

Returns: Index of the widget, or -1 if the widget wasn't found in this container

◆ getWidgets()

TGUI_NODISCARD 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

◆ keyPressed()

void tgui::Container::keyPressed ( const Event::KeyEvent & event )

overridevirtual

Reimplemented from tgui::Widget.

◆ leftMouseButtonNoLongerDown()

void tgui::Container::leftMouseButtonNoLongerDown ( )

overridevirtual

Reimplemented from tgui::Widget.

◆ leftMousePressed()

bool tgui::Container::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::Widget.

Reimplemented in tgui::Panel, tgui::PanelListBox, tgui::ScrollablePanel, and tgui::SplitContainer.

◆ leftMouseReleased()

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

overridevirtual

Reimplemented from tgui::Widget.

◆ load()

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

overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

Reimplemented in tgui::FileDialog, tgui::Grid, tgui::MessageBox, tgui::PanelListBox, tgui::ScrollablePanel, tgui::SplitContainer, and tgui::TabContainer.

◆ loadWidgetsFromFile()

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

Loads the child widgets from a text file.

Parameters

filename	Filename of the widget file
replaceExisting	Remove existing widgets first if there are any

Exceptions

Exception when file could not be opened or parsing failed

◆ loadWidgetsFromNodeTree()

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

Parameters

rootNode	Root node of the tree
replaceExisting	Remove existing widgets first if there are any

This function is used internally by the other load functions.

See also: loadWidgetsFromFile; loadWidgetsFromStream

◆ loadWidgetsFromStream() [1/2]

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

Loads the child widgets from a string stream.

Parameters

stream	stringstream that contains the widget file
replaceExisting	Remove 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

stream	stringstream that contains the widget file
replaceExisting	Remove existing widgets first if there are any

◆ mouseMoved()

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

overridevirtual

Reimplemented from tgui::Widget.

◆ mouseNoLongerOnWidget()

void tgui::Container::mouseNoLongerOnWidget ( )

overridevirtual

Reimplemented from tgui::Widget.

◆ moveWidgetBackward()

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

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

Parameters

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

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

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

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

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

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

button	Which mouse button has been pressed
pos	Mouse 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

button	Which mouse button has been released
pos	Mouse position

Returns: True if the event was handled, false if no widget responded to the event

◆ processScrollEvent()

bool tgui::Container::processScrollEvent	(	float	delta,
		Vector2f	pos,
		bool	touch )

Inform the container about a scroll event (either mouse wheel or two finger scrolling on touchscreen)

Parameters

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

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

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

widget Pointer to the widget to remove

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

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

◆ removeAllWidgets()

virtual void tgui::Container::removeAllWidgets ( )

virtual

Removes all widgets that were added to the container.

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

◆ rendererChanged()

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

Reimplemented in tgui::FileDialog, tgui::Group, tgui::MessageBox, tgui::Panel, tgui::PanelListBox, tgui::ScrollablePanel, and tgui::SplitContainer.

◆ rightMouseButtonNoLongerDown()

void tgui::Container::rightMouseButtonNoLongerDown ( )

overridevirtual

Reimplemented from tgui::Widget.

◆ rightMousePressed()

void tgui::Container::rightMousePressed ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ rightMouseReleased()

void tgui::Container::rightMouseReleased ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ save()

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

overrideprotectedvirtual

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

Reimplemented from tgui::Widget.

Reimplemented in tgui::FileDialog, tgui::Grid, tgui::MessageBox, tgui::PanelListBox, tgui::ScrollablePanel, tgui::SplitContainer, and tgui::TabContainer.

◆ saveWidgetsToFile()

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

Saves the child widgets to a text file.

Parameters

filename Filename of the widget file

Exceptions

Exception when file could not be opened for writing

◆ saveWidgetsToNodeTree()

TGUI_NODISCARD std::unique_ptr< DataIO::Node > tgui::Container::saveWidgetsToNodeTree ( const String & rootDirectory = "" ) const

Saves the child widgets to a tree of nodes that contain all information about the widgets.

Parameters

rootDirectory Directory to use as root when making paths relative. Empty to skip additional path conversion.

Returns: Root node of the tree

This function is used internally by the other save functions.

See also: saveWidgetsToFile; saveWidgetsToStream

◆ saveWidgetsToStream()

void tgui::Container::saveWidgetsToStream	(	std::stringstream &	stream,
		const String &	rootDirectory = "" ) const

Saves the child widgets to a text file.

Parameters

stream	stringstream to which the widget file will be added
rootDirectory	Directory to use as root when making paths relative. Empty to skip additional path conversion.

◆ scrolled()

bool tgui::Container::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::Widget.

Reimplemented in tgui::ScrollablePanel.

◆ setFocused()

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

overridevirtual

Focus or unfocus the widget.

Parameters

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

◆ setParent()

void tgui::Container::setParent ( Container * parent )

overridevirtual

Reimplemented from tgui::Widget.

◆ setSize() [1/2]

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

overridevirtual

Changes the size of the container.

Parameters

size	The new size of the container

Reimplemented from tgui::Widget.

Reimplemented in tgui::Grid, tgui::Group, tgui::MessageBox, tgui::Panel, tgui::PanelListBox, tgui::ScrollablePanel, tgui::SplitContainer, and tgui::TabContainer.

◆ 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

◆ setWidgetIndex()

virtual bool tgui::Container::setWidgetIndex	(	const Widget::Ptr &	widget,
		std::size_t	index )

virtual

Changes the index of a widget in this container.

Widgets are drawn in the order of the list, so overlapping widgets with a higher index will appear on top of others.

Parameters

widget	Widget that is to be moved to a different index
index	New index of the widget, corresponding to the widget position after the widget has been moved

Returns: True when the index was changed, false if widget wasn't found in the container or index was too high

Reimplemented in tgui::BoxLayout, and tgui::SplitContainer.

◆ sortWidgets()

template<typename Function >

void tgui::Container::sortWidgets ( Function && function )

inline

Sorts a list of all the widgets in this container.

Parameters

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

◆ textEntered()

void tgui::Container::textEntered ( char32_t key )

overridevirtual

Reimplemented from tgui::Widget.

◆ updateTextSize()

void tgui::Container::updateTextSize ( )

overrideprotectedvirtual

Called when the text size is changed (either by setTextSize or via the renderer)

Reimplemented from tgui::Widget.

Reimplemented in tgui::MessageBox.

◆ updateTime()

bool tgui::Container::updateTime ( Duration elapsedTime )

overridevirtual

Reimplemented from tgui::Widget.

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

include/TGUI/Container.hpp

TGUI

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add()

◆ askToolTip()

◆ canHandleKeyPress()

◆ draw()

◆ focusNextWidget()

◆ focusPreviousWidget()

◆ get() [1/2]

◆ get() [2/2]

◆ getChildWidgetsOffset()

◆ getFocusedChild()

◆ getFocusedLeaf()

◆ getInnerSize()

◆ getWidgetAtPos()

◆ getWidgetAtPosition()

◆ getWidgetIndex()

◆ getWidgets()

◆ keyPressed()

◆ leftMouseButtonNoLongerDown()

◆ leftMousePressed()

◆ leftMouseReleased()

◆ load()

◆ loadWidgetsFromFile()

◆ loadWidgetsFromNodeTree()

◆ loadWidgetsFromStream() [1/2]

◆ loadWidgetsFromStream() [2/2]

◆ mouseMoved()

◆ mouseNoLongerOnWidget()

◆ moveWidgetBackward()

◆ moveWidgetForward()

◆ moveWidgetToBack()

◆ moveWidgetToFront()

◆ processKeyPressEvent()

◆ processMouseMoveEvent()

◆ processMousePressEvent()

◆ processMouseReleaseEvent()

◆ processScrollEvent()

◆ processTextEnteredEvent()

◆ remove()

◆ removeAllWidgets()

◆ rendererChanged()

◆ rightMouseButtonNoLongerDown()

◆ rightMousePressed()

◆ rightMouseReleased()

◆ save()

◆ saveWidgetsToFile()

◆ saveWidgetsToNodeTree()

◆ saveWidgetsToStream()

◆ scrolled()

◆ setFocused()

◆ setParent()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setWidgetIndex()

◆ sortWidgets()

◆ textEntered()

◆ updateTextSize()

◆ updateTime()