TGUI  0.9-dev

The parent class for every widget. More...

#include <TGUI/Widget.hpp>

Inheritance diagram for tgui::Widget:
tgui::ChatBox tgui::ClickableWidget tgui::ComboBox tgui::Container tgui::CustomWidgetForBindings tgui::Knob tgui::ListBox tgui::ListView tgui::MenuBar tgui::RangeSlider tgui::Scrollbar tgui::Slider tgui::SubwidgetContainer tgui::Tabs tgui::TextBox tgui::TreeView

Public Types

typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
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...
 
void showWithEffect (ShowAnimationType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowAnimationType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
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 StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () 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...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
virtual 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 String &name)
 Changes the name of a widget. More...
 
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 SignalgetSignal (String signalName)
 Retrieves a signal based on its name. 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...
 
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 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 onAnimationFinish = {"AnimationFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

Protected Member Functions

virtual void rendererChanged (const 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::Label, tgui::Canvas, tgui::CustomWidgetForBindings, and tgui::Picture.

◆ clone()

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

◆ draw()

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

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

◆ 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::Slider, tgui::RangeSlider, tgui::CustomWidgetForBindings, tgui::RadioButton, and tgui::CheckBox.

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

virtual Signal& tgui::Widget::getSignal ( String  signalName)
virtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

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

◆ 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::ComboBox, tgui::EditBox, tgui::ProgressBar, tgui::RadioButton, and tgui::Button.

◆ 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_castif the template type does not match the type inside the std::any variable passed in setUserData.

◆ getWidgetName()

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::Slider, tgui::RangeSlider, tgui::RadioButton, and tgui::CheckBox.

◆ getWidgetType()

const String& tgui::Widget::getWidgetType ( ) const

Returns the type of the widget.

Returns
Type of the widget

◆ hideWithEffect()

void tgui::Widget::hideWithEffect ( ShowAnimationType  type,
Duration  duration 
)

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
typeType of the animation
durationDuration of the animation
See also
showWithEffect

Usage example:

widget->hideWithEffect(tgui::ShowAnimationType::SlideToRight, std::chrono::milliseconds(500));

◆ 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

◆ moveToBack()

void tgui::Widget::moveToBack ( )

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

void tgui::Widget::moveToFront ( )

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 String property)
protectedvirtual

◆ setEnabled()

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

Enables or disables the widget.

Parameters
enabledIs 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::MenuBar, tgui::CustomWidgetForBindings, tgui::EditBox, tgui::Tabs, and tgui::Button.

◆ setFocusable()

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

Changes whether a widget could be focused.

Parameters
focusableShould 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
focusedIs the widget focused?

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

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

Reimplemented in tgui::EditBox, tgui::TextBox, tgui::Container, and tgui::CustomWidgetForBindings.

◆ 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
fontNew 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
opacityOpacity 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
positionNew 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, and tgui::CustomWidgetForBindings.

◆ 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
xNew x coordinate
yNew 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
rendererDatanew 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
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

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

◆ setSize() [2/2]

void tgui::Widget::setSize ( Layout  width,
Layout  height 
)
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setTextSize()

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

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

Parameters
sizeThe new text size

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

◆ setToolTip()

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

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

Parameters
toolTipAny widget that you want to use as a tool tip (usually a Label)

◆ setUserData()

void tgui::Widget::setUserData ( Any  userData)
inline

Stores some data into the widget.

Parameters
userDataData 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
visibleIs 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 String name)

Changes the name of a widget.

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

◆ showWithEffect()

void tgui::Widget::showWithEffect ( ShowAnimationType  type,
Duration  duration 
)

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
typeType of the animation
durationDuration of the animation
See also
hideWithEffect

Usage example:

widget->showWithEffect(tgui::ShowAnimationType::SlideFromLeft, std::chrono::milliseconds(500));

The documentation for this class was generated from the following file:
TGUI_API Layout bindHeight(Gui &gui)
Bind to the height of the gui view.
@ SlideFromLeft
Slide from left to show or to the right to hide.
@ SlideToRight
Slide to the right to hide or from left to show.
TGUI_API Layout bindLeft(std::shared_ptr< Widget > widget)
Bind to the x position of the widget.
TGUI_API Layout bindBottom(std::shared_ptr< Widget > widget)
Bind to the bottom of the widget.