The parent class for every widget. More...

#include <TGUI/Widget.hpp>

Inheritance diagram for tgui::Widget:

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

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

Public Member Functions
	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...

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

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

virtual void	setFocused (bool focused)
	Focus or 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...

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 void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text. 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...

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

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

virtual void	draw (sf::RenderTarget &target, sf::RenderStates states) const =0
	Draw the widget to a render target. 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...

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.

Public Attributes
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
virtual void	rendererChanged (const std::string &property)
	Function called when one of the properties of the renderer is changed. More...

virtual std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const
	Saves the widget as a tree node in order to save it to a file.

virtual void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers)
	Loads the widget from a tree of nodes.

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

The parent class for every widget.

Member Function Documentation

◆ canGainFocus()

virtual bool tgui::Widget::canGainFocus ( ) const

virtual

Returns whether the widget can currently gain focus.

Returns: Can the widget be focused right now?

A widget has to be visible, enabled and focusable for this function to return true.

Reimplemented in tgui::CustomWidgetForBindings, tgui::Canvas, tgui::Label, and tgui::Picture.

◆ clone()

virtual Widget::Ptr tgui::Widget::clone ( ) const

pure virtual

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

Implemented in tgui::CustomWidgetForBindings, tgui::BitmapButton, tgui::Button, tgui::Canvas, tgui::ChatBox, tgui::CheckBox, tgui::ChildWindow, tgui::ClickableWidget, tgui::ColorPicker, tgui::ComboBox, tgui::EditBox, tgui::Grid, tgui::Group, tgui::HorizontalLayout, tgui::HorizontalWrap, tgui::Knob, tgui::Label, tgui::ListBox, tgui::ListView, tgui::MenuBar, tgui::MessageBox, tgui::Panel, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::RadioButtonGroup, tgui::RangeSlider, tgui::ScrollablePanel, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tabs, tgui::TextBox, tgui::TreeView, and tgui::VerticalLayout.

◆ draw()

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

pure virtual

Draw the widget to a render target.

This is a pure virtual function that has to be implemented by the derived class to define how the widget is drawn.

Parameters

target	Render target to draw to
states	Current render states

Implemented in tgui::CustomWidgetForBindings, tgui::SubwidgetContainer, tgui::BitmapButton, tgui::Button, tgui::Canvas, tgui::CheckBox, tgui::ChildWindow, tgui::ClickableWidget, tgui::ComboBox, tgui::EditBox, tgui::Grid, tgui::Group, tgui::Knob, tgui::Label, tgui::ListBox, tgui::ListView, tgui::Panel, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::RadioButtonGroup, tgui::RangeSlider, tgui::ScrollablePanel, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tabs, tgui::TextBox, and tgui::TreeView.

◆ getAbsolutePosition()

virtual Vector2f tgui::Widget::getAbsolutePosition ( ) const

virtual

Get the absolute position of the widget instead of the relative position to its parent.

Returns: Absolute position of the widget

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

◆ getFullSize()

virtual Vector2f tgui::Widget::getFullSize ( ) const

virtual

Returns the entire size that the widget is using.

This function will return a value equal or greater than what getSize returns. If the widget would e.g. have borders around it then this function will return the size, including these borders.

Returns: Full size of the widget

Reimplemented in tgui::CustomWidgetForBindings, tgui::CheckBox, tgui::ChildWindow, tgui::RadioButton, tgui::RangeSlider, and tgui::Slider.

◆ getInheritedFont()

const Font & tgui::Widget::getInheritedFont ( ) const

Returns the font of the widget that is used when no font is set in the renderer.

Returns: Font of the widget

◆ getInheritedOpacity()

float tgui::Widget::getInheritedOpacity ( ) const

Returns the opacity of the widget that is multiplied with the opacity set in the renderer.

Returns: Opacity of the widget

◆ getParent()

Container * tgui::Widget::getParent ( ) const

inline

Returns a pointer to the parent widget.

Returns: Pointer to the parent

◆ getPosition()

Vector2f tgui::Widget::getPosition ( ) const

inline

Gets the position of the widget.

Returns: Current position

◆ getRenderer()

WidgetRenderer * tgui::Widget::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()

WidgetRenderer * tgui::Widget::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::Widget::getSignal ( std::string signalName )

overridevirtual

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

Implements tgui::SignalWidgetBase.

Reimplemented in tgui::Button, tgui::ChildWindow, tgui::ClickableWidget, tgui::ColorPicker, tgui::ComboBox, tgui::EditBox, tgui::Knob, tgui::Label, tgui::ListBox, tgui::ListView, tgui::MenuBar, tgui::MessageBox, tgui::Panel, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::RangeSlider, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tabs, tgui::TextBox, and tgui::TreeView.

◆ getSize()

Vector2f tgui::Widget::getSize ( ) const

inline

Returns the size of the widget.

Returns: Size of the widget

◆ getTextSize()

virtual unsigned int tgui::Widget::getTextSize ( ) const

virtual

Returns the character size of text in this widget.

Returns: The current text size

Reimplemented in tgui::Button, tgui::ComboBox, tgui::EditBox, tgui::ProgressBar, and tgui::RadioButton.

◆ getToolTip()

Widget::Ptr tgui::Widget::getToolTip ( ) const

Returns the tool tip that is displayed when hovering over the widget.

Returns: The widget that is used as tool tip or nullptr when no tool tip has been set

◆ getUserData()

template<typename T >

T tgui::Widget::getUserData ( ) const

inline

Returns data stored in the widget.

Returns: Stored data

Exceptions

std::bad_cast if the template type does not match the type inside the std::any variable passed in setUserData.

◆ getWidgetName()

sf::String tgui::Widget::getWidgetName ( ) const

Returns the name of a widget.

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

◆ getWidgetOffset()

virtual Vector2f tgui::Widget::getWidgetOffset ( ) const

virtual

Returns the distance between the position where the widget is drawn and where the widget is placed.

The offset is (0,0) for almost all widgets.

Returns: Offset of the widget

Reimplemented in tgui::CustomWidgetForBindings, tgui::CheckBox, tgui::RadioButton, tgui::RangeSlider, and tgui::Slider.

◆ getWidgetType()

const std::string & tgui::Widget::getWidgetType ( ) const

Returns the type of the widget.

Returns: Type of the widget

◆ hideWithEffect()

virtual void tgui::Widget::hideWithEffect	(	ShowAnimationType	type,
		sf::Time	duration
	)

virtual

Hides the widget by making it leave with an animation.

If the widget is already hidden then the animation will still play but you will not see it.

During the animation the position, size and/or opacity may change. Once the animation is done the widget will be back in the state in which it was when this function was called, except that it will no longer be visible.

Parameters

type	Type of the animation
duration	Duration of the animation

See also: showWithEffect

◆ isAnimationPlaying()

bool tgui::Widget::isAnimationPlaying ( ) const

Returns whether there is an active animation (started with showWithEffect or hideWithEffect)

Returns: Is an animation that shows or hides the widget playing?

◆ isContainer()

bool tgui::Widget::isContainer ( ) const

Returns whether the widget is a container widget or not.

Returns: Does the widget inherit from the Container class, giving it the ability to have child widgets?

◆ isEnabled()

bool tgui::Widget::isEnabled ( ) const

inline

Returns true when the widget is enabled.

Returns: Is the widget enabled?

If this function returns false then the widget is disabled and will longer receive events and it will thus no longer send callbacks. All widgets are enabled by default.

◆ isFocusable()

bool tgui::Widget::isFocusable ( ) const

Returns whether a widget could be focused.

Returns: Should it be possible for the widget to gain focus?

By default all widgets are focusable.

◆ isFocused()

bool tgui::Widget::isFocused ( ) const

inline

Returns true when the widget is focused and false otherwise.

Returns: Is the widget focused?

◆ isVisible()

bool tgui::Widget::isVisible ( ) const

inline

Returns true when the widget is visible.

Returns: Is the widget visible?

If this function returns false then the widget is hidden, which means that it won't receive events (and thus won't send callbacks) and it won't be drawn. All widgets are visible by default.

◆ mouseOnWidget()

virtual bool tgui::Widget::mouseOnWidget ( Vector2f pos ) const

pure virtual

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?

Implemented in tgui::CustomWidgetForBindings, tgui::Button, tgui::ChatBox, tgui::ChildWindow, tgui::ClickableWidget, tgui::ComboBox, tgui::EditBox, tgui::Grid, tgui::Group, tgui::Knob, tgui::Label, tgui::ListBox, tgui::ListView, tgui::MenuBar, tgui::Panel, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::RangeSlider, tgui::Scrollbar, tgui::Slider, tgui::Tabs, tgui::TextBox, and tgui::TreeView.

◆ moveToBack()

virtual void tgui::Widget::moveToBack ( )

virtual

Places the widget behind all other widgets.

Warning: This function only has an effect when the widget was already added to its parent (e.g. the Gui).

◆ moveToFront()

virtual void tgui::Widget::moveToFront ( )

virtual

Places the widget before all other widgets.

Warning: This function only has an effect when the widget was already added to its parent (e.g. the Gui).

◆ rendererChanged()

virtual void tgui::Widget::rendererChanged ( const std::string & property )

protectedvirtual

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

Parameters

property Lowercase name of the property that was changed

Reimplemented in tgui::Container, tgui::CustomWidgetForBindings, tgui::BoxLayout, tgui::Button, tgui::Canvas, tgui::ChatBox, tgui::CheckBox, tgui::ChildWindow, tgui::ColorPicker, tgui::ComboBox, tgui::EditBox, tgui::Group, tgui::Knob, tgui::Label, tgui::ListBox, tgui::ListView, tgui::MenuBar, tgui::MessageBox, tgui::Panel, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::RangeSlider, tgui::ScrollablePanel, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tabs, tgui::TextBox, and tgui::TreeView.

◆ setEnabled()

virtual void tgui::Widget::setEnabled ( bool enabled )

virtual

Enables or disables the widget.

Parameters

enabled Is the widget enabled?

The disabled widget will no longer receive events and thus no longer send callbacks. All widgets are enabled by default.

Reimplemented in tgui::CustomWidgetForBindings, tgui::Button, tgui::ComboBox, tgui::EditBox, tgui::MenuBar, and tgui::Tabs.

◆ setFocusable()

void tgui::Widget::setFocusable ( bool focusable )

Changes whether a widget could be focused.

Parameters

focusable Should it be possible for the widget to gain focus?

By default all widgets are focusable.

◆ setFocused()

virtual void tgui::Widget::setFocused ( bool focused )

virtual

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 in tgui::Container, tgui::CustomWidgetForBindings, tgui::EditBox, and tgui::TextBox.

◆ setInheritedFont()

void tgui::Widget::setInheritedFont ( const Font & font )

Sets the font of the widget that is used when no font is set in the renderer.

Parameters

font	New font for the widget

◆ setInheritedOpacity()

void tgui::Widget::setInheritedOpacity ( float opacity )

Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.

Parameters

opacity Opacity of the widget

◆ setPosition() [1/2]

virtual void tgui::Widget::setPosition ( const Layout2d & position )

virtual

sets the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

position New position

See also: move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition({40, 30});
 
// Place the widget relative to the size of its parent
widget->setPosition({"5%", "10%"});
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition({tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50});

Reimplemented in tgui::ChildWindow, tgui::ListBox, tgui::CustomWidgetForBindings, tgui::ChildWindow, and tgui::ListBox.

◆ setPosition() [2/2]

void tgui::Widget::setPosition	(	Layout	x,
		Layout	y
	)

inline

Sets the position of the widget.

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

x	New x coordinate
y	New y coordinate

Warning: This setPosition overload must never be used from internal TGUI code or by custom widget implementations

◆ setRenderer()

void tgui::Widget::setRenderer ( std::shared_ptr< RendererData > rendererData )

Sets a new renderer for the widget. The renderer determines how the widget looks.

Parameters

rendererData new renderer data

The renderer data is shared with this widget. When the data is changed, this widget will be updated as well.

◆ setSize() [1/2]

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 in tgui::Container, tgui::SubwidgetContainer, tgui::BitmapButton, tgui::BoxLayout, tgui::Button, tgui::Canvas, tgui::ChatBox, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Grid, tgui::Group, tgui::Knob, tgui::Label, tgui::ListBox, tgui::ListView, tgui::MenuBar, tgui::Panel, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::RangeSlider, tgui::ScrollablePanel, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tabs, tgui::TextBox, tgui::TreeView, tgui::Container, tgui::CustomWidgetForBindings, tgui::SubwidgetContainer, tgui::BitmapButton, tgui::BoxLayout, tgui::Button, tgui::Canvas, tgui::ChatBox, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Grid, tgui::Group, tgui::Knob, tgui::Label, tgui::ListBox, tgui::ListView, tgui::MenuBar, tgui::Panel, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::RangeSlider, tgui::ScrollablePanel, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::Tabs, tgui::TextBox, and tgui::TreeView.

◆ 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

◆ setTextSize()

virtual void tgui::Widget::setTextSize ( unsigned int size )

virtual

Changes the character size of text in this widget if it uses text.

Parameters

size	The new text size

Reimplemented in tgui::Container, tgui::Button, tgui::ChatBox, tgui::Label, tgui::MenuBar, tgui::MessageBox, tgui::ProgressBar, tgui::RadioButton, tgui::Tabs, tgui::TextBox, tgui::ComboBox, tgui::EditBox, tgui::ListBox, tgui::ListView, and tgui::TreeView.

◆ setToolTip()

void tgui::Widget::setToolTip ( Widget::Ptr toolTip )

Sets the tool tip that should be displayed when hovering over the widget.

Parameters

toolTip Any widget that you want to use as a tool tip (usually a Label)

◆ setUserData()

void tgui::Widget::setUserData ( std::any userData )

inline

Stores some data into the widget.

Parameters

userData Data to store

Examples:

widget->setUserData("Data"); // Note: type to retrieve with getUserData is 'const char*' here

widget->setUserData(5);

◆ setVisible()

virtual void tgui::Widget::setVisible ( bool visible )

virtual

Shows or hides a widget.

Parameters

visible Is the widget visible?

The widget won't receive events (and thus won't send callbacks) nor will it be drawn when hidden. The widget is visible by default.

Reimplemented in tgui::CustomWidgetForBindings.

◆ setWidgetName()

void tgui::Widget::setWidgetName ( const sf::String & name )

Changes the name of a widget.

Parameters

name	New name for the widget

Warning: This name is overwritten when adding the widget to its parent. You should only set it afterwards.

◆ showWithEffect()

virtual void tgui::Widget::showWithEffect	(	ShowAnimationType	type,
		sf::Time	duration
	)

virtual

Shows the widget by introducing it with an animation.

The animation will also be played if the widget was already visible.

During the animation the position, size and/or opacity may change. Once the animation is done the widget will be back in the state in which it was when this function was called.

Parameters

type	Type of the animation
duration	Duration of the animation

See also: hideWithEffect

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

include/TGUI/Widget.hpp

TGUI

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ canGainFocus()

◆ clone()

◆ draw()

◆ getAbsolutePosition()

◆ getFullSize()

◆ getInheritedFont()

◆ getInheritedOpacity()

◆ getParent()

◆ getPosition()

◆ getRenderer()

◆ getSharedRenderer()

◆ getSignal()

◆ getSize()

◆ getTextSize()

◆ getToolTip()

◆ getUserData()

◆ getWidgetName()

◆ getWidgetOffset()

◆ getWidgetType()

◆ hideWithEffect()

◆ isAnimationPlaying()

◆ isContainer()

◆ isEnabled()

◆ isFocusable()

◆ isFocused()

◆ isVisible()

◆ mouseOnWidget()

◆ moveToBack()

◆ moveToFront()

◆ rendererChanged()

◆ setEnabled()

◆ setFocusable()

◆ setFocused()

◆ setInheritedFont()

◆ setInheritedOpacity()

◆ setPosition() [1/2]

◆ setPosition() [2/2]

◆ setRenderer()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setTextSize()

◆ setToolTip()

◆ setUserData()

◆ setVisible()

◆ setWidgetName()

◆ showWithEffect()