TGUI  0.8-dev

The parent class for every widget. More...

#include <Widget.hpp>

Inheritance diagram for tgui::Widget:
tgui::SignalWidgetBase tgui::ChatBox tgui::ClickableWidget tgui::ComboBox tgui::Container tgui::Knob tgui::ListBox tgui::MenuBar tgui::RangeSlider tgui::Scrollbar tgui::Slider tgui::Tabs tgui::TextBox

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.
 
 ~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...
 
sf::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...
 
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...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. 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 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 ()
 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...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets. More...
 
virtual void moveToBack ()
 Places the widget behind all other widgets. 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...
 
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...
 
virtual bool mouseOnWidget (sf::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...
 
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 &..., 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.
 

Protected Member Functions

SignalgetSignal (std::string signalName) override
 Retrieves a signal based on its name. More...
 
virtual void rendererChanged (const std::string &property)
 Function called when one of the properties of the renderer is changed. More...
 
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

◆ 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::ComboBox, tgui::ListBox, tgui::EditBox, tgui::ChatBox, tgui::Tabs, tgui::TextBox, tgui::ChildWindow, tgui::Grid, tgui::Label, tgui::MenuBar, tgui::Knob, tgui::RadioButton, tgui::ProgressBar, tgui::RangeSlider, tgui::Scrollbar, tgui::Slider, tgui::Button, tgui::SpinButton, tgui::Picture, tgui::ScrollablePanel, tgui::MessageBox, tgui::Canvas, tgui::Panel, tgui::Group, tgui::CheckBox, tgui::ClickableWidget, tgui::RadioButtonGroup, tgui::HorizontalLayout, tgui::VerticalLayout, and tgui::HorizontalWrap.

◆ disable()

virtual void tgui::Widget::disable ( )
virtual

Disables the widget.

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

Reimplemented in tgui::EditBox, and tgui::Button.

◆ 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
targetRender target to draw to
statesCurrent render states

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

◆ enable()

virtual void tgui::Widget::enable ( )
virtual

Enables the widget.

The widget will receive events and send callbacks again. All widgets are enabled by default.

Reimplemented in tgui::EditBox, and tgui::Button.

◆ focus()

virtual void tgui::Widget::focus ( )
virtual

Focus the widget.

The previously focused widget will be unfocused.

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

◆ getAbsolutePosition()

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

◆ getFullSize()

virtual sf::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::ChildWindow, tgui::RangeSlider, tgui::Slider, 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()

sf::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)
overrideprotectedvirtual

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

Implements tgui::SignalWidgetBase.

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

◆ getSize()

sf::Vector2f tgui::Widget::getSize ( ) const
inline

Returns the size of the widget.

Returns
Size of the widget

◆ getToolTip()

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

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

◆ getWidgetOffset()

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

◆ getWidgetType()

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

Returns the type of the widget.

Returns
Type of the widget

◆ hide()

virtual void tgui::Widget::hide ( )
virtual

Hides the widget.

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.

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

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

◆ 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 ( sf::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::ComboBox, tgui::ListBox, tgui::ChatBox, tgui::Tabs, tgui::ChildWindow, tgui::Grid, tgui::MenuBar, tgui::TextBox, tgui::Knob, tgui::RangeSlider, tgui::Scrollbar, tgui::RadioButton, tgui::Slider, tgui::Picture, tgui::Group, tgui::Panel, and tgui::ClickableWidget.

◆ 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

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

◆ 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

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

◆ show()

virtual void tgui::Widget::show ( )
virtual

Shows the widget.

The widget is visible by default.

See also
hide

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

◆ unfocus()

virtual void tgui::Widget::unfocus ( )
virtual

Unfocus the widget.

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

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