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

#include <TGUI/Widgets/Panel.hpp>

Inheritance diagram for tgui::Panel:

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

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

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

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

Public Types inherited from tgui::Container
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
	Panel (const Layout2d &size={"100%", "100%"})
	Default constructor. More...

PanelRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

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

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

Vector2f	getInnerSize () const override
	Returns the space available for widgets inside the container. More...

Vector2f	getChildWidgetsOffset () const override
	Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0) More...

bool	mouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...

void	draw (sf::RenderTarget &target, sf::RenderStates states) const override
	Draw the widget to a render target. More...

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

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

Public Member Functions inherited from tgui::Group
	Group (const Layout2d &size={"100%", "100%"})
	Default constructor. More...

GroupRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

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

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

Public Member Functions inherited from tgui::Container
	Container (const Container &copy)
	Copy constructor.

	Container (Container &&copy)
	Move constructor.

	~Container ()
	Destructor.

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

Container &	operator= (Container &&right)
	Overload of move assignment operator.

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

const std::vector< sf::String >	getWidgetNames () const
	Returns a list of the names of all the widgets in this container. 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) const
	Returns a pointer to a widget that was added earlier. More...

template<class T >
T::Ptr	get (const sf::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.

bool	setWidgetName (const Widget::Ptr &widget, const std::string &name)
	Changes the name of a widget. More...

std::string	getWidgetName (const Widget::ConstPtr &widget) const
	Returns the name of a widget. More...

void	uncheckRadioButtons ()
	Unchecks all the radio buttons.

void	setTextSize (unsigned int size) override
	Changes the character size of all existing and future child widgets. More...

void	loadWidgetsFromFile (const std::string &filename, bool replaceExisting=true)
	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, 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 (sf::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...

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

void	setWidgetName (const sf::String &name)
	Changes the name of a widget. More...

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

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&)
	Move constructor.

	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (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...

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

WidgetRenderer *	getRenderer ()
	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...

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

virtual void	showWithEffect (ShowAnimationType type, sf::Time duration)
	Shows the widget by introducing it with an animation. More...

virtual void	hideWithEffect (ShowAnimationType type, sf::Time 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 std::string &	getWidgetType () const
	Returns the type of the widget. More...

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

bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...

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

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

void	setUserData (std::any userData)
	Stores some data into the widget. More...

template<typename T >
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 Font &	getInheritedFont () 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 sf::String &name)
	Changes the name of a widget. More...

sf::String	getWidgetName () const
	Returns the name of a 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...

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

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

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 &...)> >::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, 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 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...

Public Attributes
SignalVector2f	onMousePress = {"MousePressed"}
	The mouse went down on the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onMouseRelease = {"MouseReleased"}
	The mouse was released on top of the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onClick = {"Clicked"}
	The panel was clicked. Optional parameter: mouse position relative to panel.

SignalVector2f	onRightMousePress = {"RightMousePressed"}
	The right mouse button went down on the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onRightMouseRelease = {"RightMouseReleased"}
	The right mouse button was released on top of the panel. Optional parameter: mouse position relative to panel.

SignalVector2f	onRightClick = {"RightClicked"}
	The panel was right clicked. Optional parameter: mouse position relative to panel.

Public Attributes inherited from tgui::Widget
SignalVector2f	onPositionChange = {"PositionChanged"}
	The position of the widget changed. Optional parameter: new position.

SignalVector2f	onSizeChange = {"SizeChanged"}
	The size of the widget changed. Optional parameter: new size.

Signal	onFocus = {"Focused"}
	The widget was focused.

Signal	onUnfocus = {"Unfocused"}
	The widget was unfocused.

Signal	onMouseEnter = {"MouseEntered"}
	The mouse entered the widget.

Signal	onMouseLeave = {"MouseLeft"}
	The mouse left the widget.

SignalAnimation	onAnimationFinished = {"AnimationFinished"}
	A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.

Protected Member Functions
Signal &	getSignal (std::string signalName) override
	Retrieves a signal based on its name. More...

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

Detailed Description

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

Constructor & Destructor Documentation

◆ Panel()

tgui::Panel::Panel ( const Layout2d & size = {"100%", "100%"} )

Default constructor.

Parameters

size	Size of the panel

Member Function Documentation

◆ clone()

Widget::Ptr tgui::Panel::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::Group.

Reimplemented in tgui::ScrollablePanel.

◆ copy()

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

static

Makes a copy of another panel.

Parameters

panel The other panel

Returns: The new panel

◆ create()

static Panel::Ptr tgui::Panel::create ( Layout2d size = {"100%", "100%"} )

static

Creates a new panel widget.

Parameters

size	Size of the panel

Returns: The new panel

◆ draw()

void tgui::Panel::draw	(	sf::RenderTarget &	target,
		sf::RenderStates	states
	)		const

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current render states

Reimplemented from tgui::Group.

Reimplemented in tgui::ScrollablePanel.

◆ getChildWidgetsOffset()

Vector2f tgui::Panel::getChildWidgetsOffset ( ) const

overridevirtual

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 from tgui::Group.

◆ getInnerSize()

Vector2f tgui::Panel::getInnerSize ( ) const

overridevirtual

Returns the space available for widgets inside the container.

Returns: Size without borders and padding

Reimplemented from tgui::Group.

◆ getRenderer()

PanelRenderer * tgui::Panel::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()

PanelRenderer * tgui::Panel::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

◆ getSignal()

Signal & tgui::Panel::getSignal ( std::string signalName )

overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters

signalName Name of the signal

Returns: Signal that corresponds to the name

Exceptions

Exception when the name does not match any signal

Reimplemented from tgui::Widget.

◆ mouseOnWidget()

bool tgui::Panel::mouseOnWidget ( Vector2f pos ) const

overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns: Is the mouse on top of the widget?

Reimplemented from tgui::Group.

◆ rendererChanged()

void tgui::Panel::rendererChanged ( const std::string & property )

overrideprotectedvirtual

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

Parameters

property Lowercase name of the property that was changed

Reimplemented from tgui::Group.

Reimplemented in tgui::ScrollablePanel.

◆ setSize() [1/3]

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

virtual

Changes the size of the widget.

Parameters

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

Reimplemented from tgui::Group.

Reimplemented in tgui::ScrollablePanel.

◆ setSize() [2/3]

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

overridevirtual

Changes the size of the panel.

Parameters

size	The new size of the panel

Reimplemented from tgui::Group.

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

◆ setSize() [3/3]

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

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

include/TGUI/Widgets/Panel.hpp

TGUI

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Panel()

Member Function Documentation

◆ clone()

◆ copy()

◆ create()

◆ draw()

◆ getChildWidgetsOffset()

◆ getInnerSize()

◆ getRenderer()

◆ getSharedRenderer()

◆ getSignal()

◆ mouseOnWidget()

◆ rendererChanged()

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]