#include <TGUI/Container.hpp>

Inheritance diagram for tgui::Container:

Public Types
typedef std::shared_ptr< Container >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Container >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
	Container (const Container &copy)
	Copy constructor. More...

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

virtual void	setFont (const Font &font) override
	Changes the font of the text in the widget and its children. More...

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

const std::vector< sf::String > &	getWidgetNames ()
	Returns a list of the names of all the widgets. More...

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

Widget::Ptr	get (const sf::String &widgetName, bool recursive=false) const
	Returns a pointer to an earlier created widget. More...

template<class T >
T::Ptr	get (const sf::String &widgetName, bool recursive=false) const
	Returns a pointer to an earlier created widget. 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.

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	focusWidget (Widget *const widget)
	Focuses a widget. More...

void	focusNextWidget ()
	Focuses the next widget. More...

void	focusPreviousWidget ()
	Focuses the previous widget. More...

void	unfocusWidgets ()
	Unfocus all the widgets.

void	uncheckRadioButtons ()
	Uncheck all the radio buttons.

virtual void	setOpacity (float opacity) override
	Changes the opacity of the container and all its child widgets. More...

virtual sf::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 std::string &filename)
	Load the child widgets from a text file. More...

void	saveWidgetsToFile (const std::string &filename)
	Save the child widgets to a text file. More...

void	loadWidgetsFromStream (std::stringstream &stream)
	Load the child widgets from a string stream. More...

void	saveWidgetsToStream (std::stringstream &stream)
	Save the child widgets to a text file. More...

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

	Widget (const Widget &copy)
	Copy constructor. More...

	~Widget ()
	Destructor.

Widget &	operator= (const Widget &right)
	Overload of assignment operator. More...

std::shared_ptr< WidgetRenderer >	getRenderer () const
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

virtual void	setPosition (const Layout2d &position) override
	set the position of the widget More...

virtual void	setSize (const Layout2d &size) override
	Changes the size of the widget. More...

virtual sf::Vector2f	getAbsolutePosition () const
	Get the absolute position of the widget instead of the relative position to its parent. 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 (bool blockMouseEvents=true)
	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...

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

float	getOpacity () const
	Returns the opacity of the widget. More...

virtual void	moveToFront ()
	Places the widget before all other widgets.

virtual void	moveToBack ()
	Places the widget behind all other widgets.

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

std::shared_ptr< sf::Font >	getFont () const
	Returns the font associated with the widget (if any) More...

void	detachTheme ()
	Detach the theme from the widget. More...

std::shared_ptr< BaseTheme >	getTheme () const
	Returns the theme to which the widget is currently connected. More...

std::string	getPrimaryLoadingParameter () const
	Returns the primary parameter that was passed to the loader to load this widget. More...

std::string	getSecondaryLoadingParameter () const
	Returns the secondary parameter that was passed to the loader to load this widget. 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 Widget::Ptr	clone () const =0
	Makes a copy of the widget if you don't know its exact type. More...

virtual void	setPosition (const Layout2d &position)
	set the position of the widget More...

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

virtual void	setSize (const Layout2d &size)
	Changes the size of the widget. More...

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

Public Member Functions inherited from tgui::Transformable
virtual	~Transformable ()
	Virtual destructor.

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

sf::Vector2f	getPosition () const
	get the position of the widget More...

void	move (const Layout2d &offset)
	Move the widget by a given offset. More...

void	move (const Layout &x, const Layout &y)
	Move the widget by a given offset. More...

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

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

void	scale (const Layout2d &factors)
	Scale the widget. More...

void	scale (const Layout &x, const Layout &y)
	Scale the widget. More...

Public Member Functions inherited from tgui::SignalWidgetBase
	SignalWidgetBase ()=default
	Default constructor.

	SignalWidgetBase (const SignalWidgetBase &copy)
	Copy constructor. More...

SignalWidgetBase &	operator= (const SignalWidgetBase &right)
	Overload of assignment operator. More...

template<typename Func , typename... Args>
unsigned int	connect (const std::string &signalNames, Func func, Args... args)
	Connects a signal handler function to one or more signals. More...

template<typename Func , typename... Args>
unsigned int	connectEx (const std::string &signalName, Func func, Args... args)
	Connects a signal handler function to one or more signals. More...

void	disconnect (unsigned int id)
	Disconnects a connection. More...

void	disconnectAll (const std::string &signalName)
	Disconnect all connections from a certain signal. More...

void	disconnectAll ()
	Disconnect all connections from a all signals.

Protected Member Functions
void	moveWidgetToFront (Widget *const widget)
	Places a widget before all other widgets. More...

void	moveWidgetToBack (Widget *const widget)
	Places a widget behind all other widgets. More...

Protected Member Functions inherited from tgui::Widget
void	attachTheme (std::shared_ptr< BaseTheme > theme)
	Attach a theme to the widget. More...

virtual void	reload (const std::string &primary="", const std::string &secondary="", bool force=false)
	Reload the widget. More...

Detailed Description

Container widget.

Parent class for widgets that store multiple widgets.

Signals:

Inherited signals from Widget

Constructor & Destructor Documentation

◆ Container()

tgui::Container::Container ( const Container & copy )

Copy constructor.

Parameters

copy	Instance to copy

Member Function Documentation

◆ add()

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

virtual

Adds a widget to the container.

Parameters

widgetPtr	Pointer to the widget you would like to add
widgetName	If you want to access the widget later then you must do this with this name

Warning: The widget name should not contain whitespace.

Reimplemented in tgui::BoxLayout.

◆ focusNextWidget()

void tgui::Container::focusNextWidget ( )

Focuses the next widget.

The currently focused widget will be unfocused, even if it was the only widget. When no widget was focused, the first widget in the container will be focused.

◆ focusPreviousWidget()

void tgui::Container::focusPreviousWidget ( )

Focuses the previous widget.

The currently focused widget will be unfocused, even if it was the only widget. When no widget was focused, the last widget in the container will be focused.

◆ focusWidget() [1/2]

void tgui::Container::focusWidget ( const Widget::Ptr & widget )

Focuses a widget.

The previously focused widget will be unfocused.

Parameters

widget The widget that has to be focused.

◆ focusWidget() [2/2]

void tgui::Container::focusWidget ( Widget *const widget )

Focuses a widget.

The previously focused widget will be unfocused.

Parameters

widget The widget that has to be focused.

◆ get() [1/2]

Widget::Ptr tgui::Container::get	(	const sf::String &	widgetName,
		bool	recursive = `false`
	)		const

Returns a pointer to an earlier created widget.

Parameters

widgetName	The name that was given to the widget when it was added to the container.
recursive	Should the function also search for widgets inside containers that are inside this container?

Returns: Pointer to the earlier created 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 sf::String &	widgetName,
		bool	recursive = `false`
	)		const

inline

Returns a pointer to an earlier created widget.

Parameters

widgetName	The name that was given to the widget when it was added to the container.
recursive	Should the function also search for widgets inside containers that are inside this container?

Returns: Pointer to the earlier created widget. The pointer will already be casted to the desired type.

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

◆ getChildWidgetsOffset()

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

◆ getWidgetName()

std::string tgui::Container::getWidgetName ( const Widget::Ptr & widget ) const

Returns the name of a widget.

Parameters

widget Widget of which the name should be retrieved

Returns: Name of the widget or an empty string when the widget didn't exist or wasn't given a name

◆ getWidgetNames()

const std::vector< sf::String > & tgui::Container::getWidgetNames ( )

inline

Returns a list of the names of all the widgets.

Returns: Vector of all widget names

◆ getWidgets()

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

inline

Returns a list of all the widgets.

Returns: Vector of all widget pointers

◆ loadWidgetsFromFile()

void tgui::Container::loadWidgetsFromFile ( const std::string & filename )

Load the child widgets from a text file.

Parameters

filename Filename of the widget file

◆ loadWidgetsFromStream()

void tgui::Container::loadWidgetsFromStream ( std::stringstream & stream )

Load the child widgets from a string stream.

Parameters

stream stringstream that contains the widget file

◆ moveWidgetToBack()

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

protected

Places a widget behind all other widgets.

Parameters

widget The widget that should be moved to the back

◆ moveWidgetToFront()

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

protected

Places a widget before all other widgets.

Parameters

widget The widget that should be moved to the front

◆ operator=()

Container & tgui::Container::operator= ( const Container & right )

Overload of assignment operator.

Parameters

right Instance to assign

Returns: Reference to itself

◆ 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, and tgui::Grid.

◆ saveWidgetsToFile()

void tgui::Container::saveWidgetsToFile ( const std::string & filename )

Save the child widgets to a text file.

Parameters

filename Filename of the widget file

◆ saveWidgetsToStream()

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

Save the child widgets to a text file.

Parameters

stream stringstream to which the widget file will be added

◆ setFont()

virtual void tgui::Container::setFont ( const Font & font )

overridevirtual

Changes the font of the text in the widget and its children.

Parameters

font	The new font.

When you don't call this function then the font from the parent widget will be used.

Reimplemented from tgui::Widget.

Reimplemented in tgui::BoxLayout, tgui::ChildWindow, and tgui::MessageBox.

◆ setOpacity()

virtual void tgui::Container::setOpacity ( float opacity )

overridevirtual

Changes the opacity of the container and all its child widgets.

Parameters

opacity The opacity of the widgets. 0 means completely transparent, while 1 (default) means fully opaque.

Reimplemented from tgui::Widget.

Reimplemented in tgui::ChildWindow.

◆ setWidgetName()

bool tgui::Container::setWidgetName	(	const Widget::Ptr &	widget,
		const std::string &	name
	)

Changes the name of a widget.

Parameters

widget	Widget of which the name should be changed
name	New name for the widget

Returns: True when the name was changed, false when the widget wasn't part of this container.

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

include/TGUI/Container.hpp

TGUI

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Container()

Member Function Documentation

◆ add()

◆ focusNextWidget()

◆ focusPreviousWidget()

◆ focusWidget() [1/2]

◆ focusWidget() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ getChildWidgetsOffset()

◆ getWidgetName()

◆ getWidgetNames()

◆ getWidgets()

◆ loadWidgetsFromFile()

◆ loadWidgetsFromStream()

◆ moveWidgetToBack()

◆ moveWidgetToFront()

◆ operator=()

◆ remove()

◆ saveWidgetsToFile()

◆ saveWidgetsToStream()

◆ setFont()

◆ setOpacity()

◆ setWidgetName()