TGUI  1.0-alpha

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::MenuBarMenuPlaceholder tgui::RangeSlider tgui::Scrollbar tgui::Slider tgui::SubwidgetContainer tgui::Tabs tgui::TextArea 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 (const char *typeName, bool initRenderer)
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&) noexcept
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&) noexcept
 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...
 
const WidgetRenderergetSharedRenderer () const
 
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...
 
void setWidth (Layout width)
 Changes the width of the widget. More...
 
void setHeight (Layout height)
 Changes the height 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 top-left point 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 setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based. More...
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based. More...
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based. More...
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget. More...
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget. More...
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling. More...
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget. More...
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget. More...
 
float getRotation () const
 Returns the rotation to be applied to the widget. More...
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations. More...
 
void showWithEffect (ShowEffectType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowEffectType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration. More...
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration. 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...
 
BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs. 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...
 
bool hasUserData () const
 Returns whether 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...
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text. More...
 
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 setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget. More...
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the 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...
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
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...
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget. More...
 
virtual SignalgetSignal (String signalName)
 Retrieves a signal based on its name. More...
 
virtual void setParent (Container *parent)
 
virtual bool updateTime (Duration elapsedTime)
 
virtual bool isMouseOnWidget (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 leftMousePressed (Vector2f pos)
 
virtual void leftMouseReleased (Vector2f pos)
 
virtual void rightMousePressed (Vector2f pos)
 
virtual void rightMouseReleased (Vector2f pos)
 
virtual void mousePressed (Event::MouseButton button, Vector2f pos)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual void mouseMoved (Vector2f pos)
 
virtual void keyPressed (const Event::KeyEvent &event)
 
virtual void textEntered (char32_t key)
 
virtual bool mouseWheelScrolled (float delta, Vector2f pos)
 
virtual void mouseNoLongerOnWidget ()
 
virtual void leftMouseButtonNoLongerDown ()
 
virtual void rightMouseButtonNoLongerDown ()
 
virtual Widget::Ptr askToolTip (Vector2f mousePos)
 
const Layout2dgetPositionLayout () const
 
const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
virtual void draw (BackendRenderTarget &target, 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...
 
void rendererChangedCallback (const String &property)
 

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.
 
SignalShowEffect onShowEffectFinish = {"ShowEffectFinished"}
 A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.
 
SignalAnimationType onAnimationFinish = {"AnimationFinished"}
 An animation has finished. More...
 

Protected Types

using SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > >
 
using LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > >
 

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. More...
 
virtual void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers)
 Loads the widget from a tree of nodes. More...
 
virtual void updateTextSize ()
 Called when the text size is changed (either by setTextSize or via the renderer) More...
 
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget. More...
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget. More...
 

Protected Attributes

String m_type
 
String m_name
 
Layout2d m_position
 
Layout2d m_size
 
unsigned int m_textSize = 0
 
Vector2f m_origin
 
Optional< Vector2fm_rotationOrigin
 
Optional< Vector2fm_scaleOrigin
 
Vector2f m_scaleFactors = {1, 1}
 
float m_rotationDeg = 0
 
Vector2f m_prevPosition
 
Vector2f m_prevSize
 
std::unordered_set< Layout * > m_boundPositionLayouts
 
std::unordered_set< Layout * > m_boundSizeLayouts
 
bool m_enabled = true
 
bool m_visible = true
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
Duration m_animationTimeElapsed
 
bool m_draggableWidget = false
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::shared_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 

Friends

class Container
 

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::CanvasGLES2, tgui::CanvasOpenGL3, tgui::CanvasSDL, tgui::CanvasSFML, tgui::CustomWidgetForBindings, tgui::Label, and tgui::Picture.

◆ clone()

◆ draw()

◆ getAbsolutePosition()

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

Get the absolute position of the top-left point 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::MenuBarMenuPlaceholder, 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

◆ getMouseCursor()

Cursor::Type tgui::Widget::getMouseCursor ( ) const

Returns which mouse cursor is shown when hovering over the widget.

Returns
The cursor to show when the mouse is on top of the widget

◆ getOrigin()

Vector2f tgui::Widget::getOrigin ( ) const
inline

Returns the relative origin point on which the position, scale and rotation is based.

Returns
Relative origin point of the widget (0 for left/top, 1 for right/bottom)
See also
setOrigin

◆ getParent()

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

Returns a pointer to the parent widget.

Returns
Pointer to the parent

◆ getParentGui()

BackendGui * tgui::Widget::getParentGui ( ) const
inline

Returns a pointer to the gui to which this widget belongs.

Returns
Pointer to the gui

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

◆ getRotation()

float tgui::Widget::getRotation ( ) const
inline

Returns the rotation to be applied to the widget.

Returns
How many degrees the widget is rotated clockwise
See also
setRotation

◆ getRotationOrigin()

Vector2f tgui::Widget::getRotationOrigin ( ) const

Returns the origin used for rotations.

Returns
Origin around which the rotation occurs
See also
setRotation

◆ getScale()

Vector2f tgui::Widget::getScale ( ) const
inline

Returns the scaling to be applied to the widget.

Returns
How many times the widget is enlarged (or shrunk if scale factor is smaller than 1)
See also
setScaling

◆ getScaleOrigin()

Vector2f tgui::Widget::getScaleOrigin ( ) const

Returns the origin used for scaling.

Returns
Origin from where the widget is scaled
See also
setScale

◆ 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

◆ getSize()

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

Returns the size of the widget.

Returns
Size of the widget

◆ getTextSize()

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

Returns the character size of text in this widget.

Returns
The current text size
Warning
This returns the actual text size. If the renderer specifies a text size then the value returned by this function will be the one from the renderer and not the one provided when calling setTextSize.

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

◆ getWidgetType()

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

Returns the type of the widget.

Returns
Type of the widget

◆ hasUserData()

bool tgui::Widget::hasUserData ( ) const
inline

Returns whether data stored in the widget.

Returns
True if data was set via setUserData before, false if setUserData wasn't called or passed an empty object.

◆ hideWithEffect()

void tgui::Widget::hideWithEffect ( ShowEffectType  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::ShowEffectType::SlideToRight, std::chrono::milliseconds(500));
@ SlideToRight
Slide to the right to hide or from left to show.

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

◆ isDraggableWidget()

bool tgui::Widget::isDraggableWidget ( ) const

Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)

Returns
Should the widget receive mouse move events even when the mouse left it after the mouse went down on it?

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

◆ isMouseDown()

bool tgui::Widget::isMouseDown ( ) const

Returns whether the left mouse button has been pressed on top of the widget.

Returns
Is the left mouse button being pressed on top of the widget

◆ isMouseOnWidget()

virtual bool tgui::Widget::isMouseOnWidget ( Vector2f  pos) const
pure virtual

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

◆ load()

◆ mouseEnteredWidget()

virtual void tgui::Widget::mouseEnteredWidget ( )
protectedvirtual

This function is called when the mouse enters the widget.

Reimplemented in tgui::CustomWidgetForBindings, tgui::Button, tgui::ButtonBase, tgui::ChildWindow, tgui::ListView, and tgui::RadioButton.

◆ mouseLeftWidget()

virtual void tgui::Widget::mouseLeftWidget ( )
protectedvirtual

This function is called when the mouse leaves the widget.

Reimplemented in tgui::CustomWidgetForBindings, tgui::Button, tgui::ButtonBase, tgui::ChildWindow, tgui::ListView, and tgui::RadioButton.

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

◆ moveWithAnimation()

void tgui::Widget::moveWithAnimation ( Layout2d  position,
Duration  duration 
)

Moves the widget from its current position to the given position, over a given duration.

Parameters
positionFinal position of the widget
durationHow long before the widget reaches its final position

◆ rendererChanged()

◆ resizeWithAnimation()

void tgui::Widget::resizeWithAnimation ( Layout2d  size,
Duration  duration 
)

Resizes the widget from its current size to the given size, over a given duration.

Parameters
sizeFinal size of the widget
durationHow long before the widget reaches its final size

◆ save()

◆ 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::CustomWidgetForBindings, tgui::SubwidgetContainer, tgui::ButtonBase, tgui::ComboBox, tgui::EditBox, tgui::MenuBar, tgui::RadioButton, and tgui::Tabs.

◆ 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::Container, tgui::RootContainer, tgui::CustomWidgetForBindings, tgui::SubwidgetContainer, tgui::ButtonBase, tgui::EditBox, and tgui::TextArea.

◆ setHeight()

void tgui::Widget::setHeight ( Layout  height)
inline

Changes the height of the widget.

Parameters
heightHeight of the widget

This function is a helper function that just calls setSize with the existing width.

See also
setSize

◆ 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

This function is called by the parent widget and is not supposed to be directly. To set the font of this widget, the Font property in the renderer should be changed.

◆ 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

This function is called by the parent widget and is not supposed to be directly.To set the opacity of this widget, the Opacity property in the renderer should be changed.

◆ setMouseCursor()

void tgui::Widget::setMouseCursor ( Cursor::Type  cursor)

Changes which mouse cursor is shown when hovering over the widget.

Parameters
cursorThe cursor to show when the mouse is on top of the widget

By default, the arrow cursor is shown.

◆ setOrigin() [1/2]

void tgui::Widget::setOrigin ( float  x,
float  y 
)
inline

Sets the origin point on which the position, scale and rotation is based.

Parameters
xRelative horizontal position of the origin point
yRelative vertical position of the origin point

Valid x and y values range from 0 to 1, with 0 representing the left/top of the widget and 1 being right/bottom

Warning
This functionality is still experimental.

◆ setOrigin() [2/2]

void tgui::Widget::setOrigin ( Vector2f  origin)

Sets the origin point on which the position, scale and rotation is based.

Parameters
originRelative position of the origin point

Valid x and y values range from 0 to 1, with 0 representing the left/top of the widget and 1 being right/bottom

Warning
This functionality is still experimental.

◆ 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});
TGUI_API Layout bindBottom(std::shared_ptr< Widget > widget)
Bind to the bottom of the widget.
TGUI_API Layout bindLeft(std::shared_ptr< Widget > widget)
Bind to the left position of the widget.

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

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

◆ setRotation() [1/2]

void tgui::Widget::setRotation ( float  angle)

Sets the rotation to be applied to the widget.

Parameters
angleHow many degrees clockwise should the widget be rotated?

The origin of the rotation is set with the setOrigin function. If you want to use a separate origin for position and rotation then you can use the setRotation(float,Vector2f) function to pass a rotation origin.

Warning
This functionality is still experimental. Clipping isn't supported and is disabled when a rotation is set!

◆ setRotation() [2/2]

void tgui::Widget::setRotation ( float  angle,
Vector2f  origin 
)

Sets the rotation to be applied to the widget.

Parameters
angleHow many degrees clockwise should the widget be rotated?
originThe origin around which the rotation should occur

In the origin the x and y value 0 represent the left/top of the widget while 1 represents right/bottom

Warning
This functionality is still experimental. Clipping isn't supported and is disabled when a rotation is set!

◆ setScale() [1/4]

void tgui::Widget::setScale ( float  scaleFactor)
inline

Sets the scaling to be applied to the widget.

Parameters
scaleFactorHow many times should the widget be enlarged (or shrunk if scale factor is smaller than 1)

This scaling works on top of the size that is set with setSize. A widget with size (50, 20) with a scaling factor of 2 will appear on the screen as a (100, 40) widget with its entire contents stretched.

The origin of the scaling is set with the setOrigin function. If you want to use a separate origin for position and scale then you can use the setScale(float,Vector2f) function to pass a scaling origin.

Warning
This functionality is still experimental, it will not work perfectly for all widgets.

◆ setScale() [2/4]

void tgui::Widget::setScale ( float  scaleFactor,
Vector2f  origin 
)
inline

Sets the scaling to be applied to the widget.

Parameters
scaleFactorHow many times should the widget be enlarged (or shrunk if scale factor is smaller than 1)
originThe origin from where to scale the widget. The widget origin will be used if no value is provided.

This scaling works on top of the size that is set with setSize. A widget with size (50, 20) with a scaling factor of 2 will appear on the screen as a (100, 40) widget with its entire contents stretched.

In the origin the x and y value 0 represent the left/top of the widget while 1 represents right/bottom

Warning
This functionality is still experimental, it will not work perfectly for all widgets.

◆ setScale() [3/4]

void tgui::Widget::setScale ( Vector2f  scaleFactors)

Sets the scaling to be applied to the widget.

Parameters
scaleFactorsHow many times should the widget be enlarged horizontally and vertically (or shrunk if factor < 1)

This scaling works on top of the size that is set with setSize. A widget with size (50, 20) with a scaling factor of (3,2) will appear on the screen as a (150, 40) widget with its entire contents stretched.

The origin of the scaling is set with the setOrigin function. If you want to use a separate origin for position and scale then you can use the setScale(Vector2f,Vector2f) function to pass a scaling origin.

Warning
This functionality is still experimental, it will not work perfectly for all widgets.

◆ setScale() [4/4]

void tgui::Widget::setScale ( Vector2f  scaleFactors,
Vector2f  origin 
)

Sets the scaling to be applied to the widget.

Parameters
scaleFactorsHow many times should the widget be enlarged horizontally and vertically (or shrunk if factor < 1)
originThe origin from where to scale the widget. The widget origin will be used if no value is provided.

This scaling works on top of the size that is set with setSize. A widget with size (50, 20) with a scaling factor of (3,2) will appear on the screen as a (150, 40) widget with its entire contents stretched.

In the origin the x and y value 0 represent the left/top of the widget while 1 represents right/bottom

Warning
This functionality is still experimental, it will not work perfectly for all widgets.

◆ 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});
TGUI_API Layout bindHeight(std::shared_ptr< Widget > widget)
Bind to the height of the widget.

Reimplemented in tgui::CanvasGLES2, tgui::CanvasOpenGL3, tgui::CanvasSDL, tgui::CanvasSFML, tgui::Container, tgui::RootContainer, tgui::SubwidgetContainer, tgui::BitmapButton, tgui::BoxLayout, tgui::ButtonBase, tgui::ChatBox, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Grid, 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::SpinControl, tgui::TabContainer, tgui::Tabs, tgui::TextArea, tgui::TreeView, tgui::CanvasGLES2, tgui::CanvasOpenGL3, tgui::CanvasSDL, tgui::CanvasSFML, tgui::Container, tgui::RootContainer, tgui::CustomWidgetForBindings, tgui::SubwidgetContainer, tgui::BitmapButton, tgui::BoxLayout, tgui::ButtonBase, tgui::ChatBox, tgui::ChildWindow, tgui::ComboBox, tgui::EditBox, tgui::Grid, 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::SpinControl, tgui::SpinControl, tgui::TabContainer, tgui::TabContainer, tgui::Tabs, tgui::TextArea, and tgui::TreeView.

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

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

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

Parameters
sizeThe new text size
Warning
This value isn't used when a text size is specified in the renderer.

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

◆ setWidth()

void tgui::Widget::setWidth ( Layout  width)
inline

Changes the width of the widget.

Parameters
widthWidth of the widget

This function is a helper function that just calls setSize with the existing height.

See also
setSize

◆ showWithEffect()

void tgui::Widget::showWithEffect ( ShowEffectType  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::ShowEffectType::SlideFromLeft, std::chrono::milliseconds(500));
@ SlideFromLeft
Slide from left to show or to the right to hide.

◆ updateTextSize()

virtual void tgui::Widget::updateTextSize ( )
protectedvirtual

Member Data Documentation

◆ onAnimationFinish

SignalAnimationType tgui::Widget::onAnimationFinish = {"AnimationFinished"}

An animation has finished.

Animations are started by calling showWithEffect, hideWithEffect, moveWithAnimation and resizeWithAnimation. The showWithEffect and hideWithEffect functions also trigger the onShowEffectFinish signal when the effect ends.

Optional parameter: animation type


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