TGUI  1.3.0
Loading...
Searching...
No Matches

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

using Ptr = std::shared_ptr<Widget>
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr<const Widget>
 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.
 
virtual TGUI_NODISCARD WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
virtual TGUI_NODISCARD const WidgetRenderergetSharedRenderer () const
 
virtual TGUI_NODISCARD WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget.
 
TGUI_NODISCARD Vector2f getPosition () const
 Gets the position of the widget.
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget.
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
void setWidth (Layout width)
 Changes the width of the widget.
 
void setHeight (Layout height)
 Changes the height of the widget.
 
TGUI_NODISCARD Vector2f getSize () const
 Returns the size of the widget.
 
virtual TGUI_NODISCARD Vector2f getFullSize () const
 Returns the entire size that the widget is using.
 
virtual TGUI_NODISCARD Vector2f getAbsolutePosition (Vector2f offset={}) const
 Get the absolute position of the widget instead of the relative position to its parent.
 
virtual TGUI_NODISCARD Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed.
 
void setAutoLayout (AutoLayout layout)
 Sets how the position is determined compared to the other widgets in the parent.
 
TGUI_NODISCARD AutoLayout getAutoLayout () const
 Returns how the position is determined compared to the other widgets in the parent.
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based.
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based.
 
TGUI_NODISCARD Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based.
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget.
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget.
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget.
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget.
 
TGUI_NODISCARD Vector2f getScale () const
 Returns the scaling to be applied to the widget.
 
TGUI_NODISCARD Vector2f getScaleOrigin () const
 Returns the origin used for scaling.
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget.
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget.
 
TGUI_NODISCARD float getRotation () const
 Returns the rotation to be applied to the widget.
 
TGUI_NODISCARD Vector2f getRotationOrigin () const
 Returns the origin used for rotations.
 
void showWithEffect (ShowEffectType type, Duration duration)
 Shows the widget by introducing it with an animation.
 
void hideWithEffect (ShowEffectType type, Duration duration)
 Hides the widget by making it leave with an animation.
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration.
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration.
 
virtual void setVisible (bool visible)
 Shows or hides a widget.
 
TGUI_NODISCARD bool isVisible () const
 Returns true when the widget is visible.
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget.
 
TGUI_NODISCARD bool isEnabled () const
 Returns true when the widget is enabled.
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget.
 
TGUI_NODISCARD bool isFocused () const
 Returns true when the widget is focused and false otherwise.
 
TGUI_NODISCARD const StringgetWidgetType () const
 Returns the type of the widget.
 
TGUI_NODISCARD ContainergetParent () const
 Returns a pointer to the parent widget.
 
TGUI_NODISCARD BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs.
 
TGUI_NODISCARD bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect)
 
void moveToFront ()
 Places the widget before all other widgets.
 
void moveToBack ()
 Places the widget behind all other widgets.
 
void setUserData (Any userData)
 Stores some data into the widget.
 
template<typename DataType >
TGUI_NODISCARD DataType getUserData () const
 Returns data stored in the widget.
 
TGUI_NODISCARD bool hasUserData () const
 Returns whether data stored in the widget.
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer.
 
TGUI_NODISCARD const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer.
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.
 
TGUI_NODISCARD float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer.
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text.
 
TGUI_NODISCARD unsigned int getTextSize () const
 Returns the character size of text in this widget.
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget.
 
TGUI_NODISCARD Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget.
 
void setWidgetName (const String &name)
 Changes the name of a widget.
 
TGUI_NODISCARD String getWidgetName () const
 Returns the name of a widget.
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget.
 
TGUI_NODISCARD Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget.
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused.
 
TGUI_NODISCARD bool isFocusable () const
 Returns whether a widget could be focused.
 
void setNavigationUp (const Widget::Ptr &widgetAbove)
 Changes which widget should become focused when navigating upwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationUp () const
 Returns which widget would become focused when navigating upwards from this widget.
 
void setNavigationDown (const Widget::Ptr &widgetBelow)
 Changes which widget should become focused when navigating downwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationDown () const
 Returns which widget would become focused when navigating downwards from this widget.
 
void setNavigationLeft (const Widget::Ptr &widgetLeft)
 Changes which widget should become focused when navigating to the left from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationLeft () const
 Returns which widget would become focused when navigating to the left from this widget.
 
void setNavigationRight (const Widget::Ptr &widgetRight)
 Changes which widget should become focused when navigating to the right from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationRight () const
 Returns which widget would become focused when navigating to the right from this widget.
 
void setIgnoreMouseEvents (bool ignore)
 Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.
 
TGUI_NODISCARD bool getIgnoreMouseEvents () const
 Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
virtual TGUI_NODISCARD bool canGainFocus () const
 Returns whether the widget can currently gain focus.
 
TGUI_NODISCARD bool isContainer () const
 Returns whether the widget is a container widget or not.
 
TGUI_NODISCARD bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget.
 
virtual TGUI_NODISCARD SignalgetSignal (String signalName)
 Retrieves a signal based on its name.
 
virtual void setParent (Container *parent)
 
virtual bool updateTime (Duration elapsedTime)
 
void setAutoLayoutUpdateEnabled (bool enabled)
 
virtual TGUI_NODISCARD bool isMouseOnWidget (Vector2f pos) const =0
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
 
virtual bool leftMousePressed (Vector2f pos)
 Called by the parent when the left mouse button goes down on top of the widget.
 
virtual void leftMouseReleased (Vector2f pos)
 
virtual void rightMousePressed (Vector2f pos)
 
virtual void rightMouseReleased (Vector2f pos)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual void mouseMoved (Vector2f pos)
 
virtual void keyPressed (const Event::KeyEvent &event)
 
virtual bool canHandleKeyPress (const Event::KeyEvent &event)
 Called by the parent of the widget to check if keyPressed would process the event.
 
virtual void textEntered (char32_t key)
 
virtual bool scrolled (float delta, Vector2f pos, bool touch)
 Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)
 
virtual void mouseNoLongerOnWidget ()
 
virtual void leftMouseButtonNoLongerDown ()
 
virtual void rightMouseButtonNoLongerDown ()
 
virtual TGUI_NODISCARD Widget::Ptr askToolTip (Vector2f mousePos)
 
TGUI_NODISCARD const Layout2dgetPositionLayout () const
 
TGUI_NODISCARD 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.
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
virtual TGUI_NODISCARD Widget::Ptr clone () const =0
 Makes a copy of the widget if you don't know its exact type.
 
void rendererChangedCallback (const String &property)
 
virtual void updateTextSize ()
 

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.
 

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.
 
virtual TGUI_NODISCARD 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.
 
void recalculateBoundPositionLayouts ()
 Calls recalculateValue() on each layout in m_boundPositionLayouts.
 
void recalculateBoundSizeLayouts ()
 Calls recalculateValue() on each layout in m_boundSizeLayouts.
 

Protected Attributes

String m_type
 
String m_name
 
Layout2d m_position
 Stores the position of this widget.
 
Layout2d m_size
 Stores the size of this widget.
 
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
 Stores the flag indicating whether this widget is enabled.
 
bool m_visible = true
 Stores the flag indicating whether this widget is visible.
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
std::weak_ptr< Widgetm_navWidgetUp
 
std::weak_ptr< Widgetm_navWidgetDown
 
std::weak_ptr< Widgetm_navWidgetRight
 
std::weak_ptr< Widgetm_navWidgetLeft
 
Duration m_animationTimeElapsed
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::unique_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 
AutoLayout m_autoLayout = AutoLayout::Manual
 
bool m_autoLayoutUpdateEnabled = true
 
bool m_ignoreMouseEvents = false
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 

Friends

class Container
 

Detailed Description

The parent class for every widget.

Member Function Documentation

◆ canGainFocus()

virtual TGUI_NODISCARD 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::CanvasBase, tgui::CustomWidgetForBindings, tgui::Label, and tgui::Picture.

◆ canHandleKeyPress()

virtual bool tgui::Widget::canHandleKeyPress ( const Event::KeyEvent & event)
virtual

Called by the parent of the widget to check if keyPressed would process the event.

Parameters
eventKey event that took place
Returns
True if the event would be handled by the widget, false if the key event doesn't affect the widget
Since
TGUI 1.1

Reimplemented in tgui::Button, tgui::CheckBox, tgui::ChildWindow, tgui::Container, tgui::EditBox, tgui::FileDialog, tgui::ListBox, tgui::ListView, tgui::RadioButton, tgui::TextArea, tgui::ToggleButton, and tgui::TreeView.

◆ clone()

◆ draw()

◆ getAbsolutePosition()

virtual TGUI_NODISCARD Vector2f tgui::Widget::getAbsolutePosition ( Vector2f offset = {}) const
virtual

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

Parameters
offsetOffset of the top-left corner inside the widget to calculate the position for
Returns
Absolute position of the widget

Reimplemented in tgui::ScrollablePanel.

◆ getAutoLayout()

TGUI_NODISCARD AutoLayout tgui::Widget::getAutoLayout ( ) const

Returns how the position is determined compared to the other widgets in the parent.

Returns
Alignment for how to position the widget in its parent

The default value is Manual which means the position and size are manually set and are unrelated to other widgets.

◆ getFullSize()

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

◆ getIgnoreMouseEvents()

TGUI_NODISCARD bool tgui::Widget::getIgnoreMouseEvents ( ) const

Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.

Returns
Are mouse events ignored by this widget?
Since
TGUI 1.3

◆ getInheritedFont()

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

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

TGUI_NODISCARD 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

◆ getNavigationDown()

TGUI_NODISCARD Widget::Ptr tgui::Widget::getNavigationDown ( ) const

Returns which widget would become focused when navigating downwards from this widget.

Returns
The widget located below this one, or nullptr if pressing the down arrow doesn't change focus
Since
TGUI 1.1

◆ getNavigationLeft()

TGUI_NODISCARD Widget::Ptr tgui::Widget::getNavigationLeft ( ) const

Returns which widget would become focused when navigating to the left from this widget.

Returns
The widget located to the left of this one, or nullptr if pressing the left arrow doesn't change focus
Since
TGUI 1.1

◆ getNavigationRight()

TGUI_NODISCARD Widget::Ptr tgui::Widget::getNavigationRight ( ) const

Returns which widget would become focused when navigating to the right from this widget.

Returns
The widget located to the right of this one, or nullptr if pressing the right arrow doesn't change focus
Since
TGUI 1.1

◆ getNavigationUp()

TGUI_NODISCARD Widget::Ptr tgui::Widget::getNavigationUp ( ) const

Returns which widget would become focused when navigating upwards from this widget.

Returns
The widget located above this one, or nullptr if pressing the up arrow doesn't change focus
Since
TGUI 1.1

◆ getOrigin()

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

◆ getParent()

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

Returns a pointer to the parent widget.

Returns
Pointer to the parent

◆ getParentGui()

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

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

Returns
Pointer to the gui

◆ getPosition()

TGUI_NODISCARD Vector2f tgui::Widget::getPosition ( ) const
inline

Gets the position of the widget.

Returns
Current position

◆ getRenderer()

virtual TGUI_NODISCARD WidgetRenderer * tgui::Widget::getRenderer ( )
virtual

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.

Reimplemented in tgui::BoxLayout, tgui::ButtonBase, tgui::ChatBox, tgui::CheckBox, tgui::ChildWindow, tgui::ColorPicker, tgui::ComboBox, tgui::EditBox, tgui::FileDialog, tgui::Group, tgui::Knob, tgui::Label, tgui::ListBox, tgui::ListView, tgui::MenuBar, tgui::MessageBox, tgui::Panel, tgui::PanelListBox, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::RangeSlider, tgui::ScrollablePanel, tgui::Scrollbar, tgui::SeparatorLine, tgui::Slider, tgui::SpinButton, tgui::Tabs, tgui::TextArea, and tgui::TreeView.

◆ getRotation()

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

TGUI_NODISCARD Vector2f tgui::Widget::getRotationOrigin ( ) const

Returns the origin used for rotations.

Returns
Origin around which the rotation occurs
See also
setRotation

◆ getScale()

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

TGUI_NODISCARD Vector2f tgui::Widget::getScaleOrigin ( ) const

Returns the origin used for scaling.

Returns
Origin from where the widget is scaled
See also
setScale

◆ getSharedRenderer()

virtual TGUI_NODISCARD WidgetRenderer * tgui::Widget::getSharedRenderer ( )
virtual

◆ getSignal()

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

◆ getSize()

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

Returns the size of the widget.

Returns
Size of the widget

◆ getTextSize()

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

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

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

◆ getWidgetType()

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

Returns the type of the widget.

Returns
Type of the widget

◆ hasUserData()

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

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

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

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

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

TGUI_NODISCARD bool tgui::Widget::isFocused ( ) const
inline

Returns true when the widget is focused and false otherwise.

Returns
Is the widget focused?

◆ isMouseDown()

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

◆ isVisible()

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

◆ leftMousePressed()

virtual bool tgui::Widget::leftMousePressed ( Vector2f pos)
virtual

Called by the parent when the left mouse button goes down on top of the widget.

Parameters
posMouse position in view coordinates relative to the parent widget
Returns
True if the clicked part of the widget is draggable, i.e. if the widget should continue to receive mouse move events until the mouse is released, even when the mouse leaves the widget. When false is returned, the mouse move events will only be sent to the widget as long as the mouse is on top of the widget.

Reimplemented in tgui::Button, tgui::ButtonBase, tgui::ChatBox, tgui::ChildWindow, tgui::ClickableWidget, tgui::ColorPicker, tgui::ComboBox, tgui::Container, tgui::CustomWidgetForBindings, tgui::EditBox, tgui::Knob, tgui::Label, tgui::ListBox, tgui::ListView, tgui::MenuBar, tgui::Panel, tgui::PanelListBox, tgui::RangeSlider, tgui::ScrollablePanel, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::SubwidgetContainer, tgui::Tabs, tgui::TextArea, and tgui::TreeView.

◆ load()

◆ mouseEnteredWidget()

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

This function is called when the mouse enters the widget.

Reimplemented in tgui::Button, tgui::ButtonBase, tgui::ChildWindow, tgui::CustomWidgetForBindings, 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::Button, tgui::ButtonBase, tgui::ChildWindow, tgui::CustomWidgetForBindings, 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()

◆ scrolled()

virtual bool tgui::Widget::scrolled ( float delta,
Vector2f pos,
bool touch )
virtual

Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

Parameters
deltaScroll offset (positive is up, negative is down). High-precision mice may use non-integral offsets.
posMouse position, or the initial position of the touch events
touchWas this a touch event or a mouse wheel scroll?
Returns
Was the scrolling was handled by the widget?

Reimplemented in tgui::ChatBox, tgui::ComboBox, tgui::Container, tgui::CustomWidgetForBindings, tgui::Label, tgui::ListBox, tgui::ListView, tgui::ScrollablePanel, tgui::Scrollbar, tgui::Slider, tgui::SubwidgetContainer, tgui::TextArea, and tgui::TreeView.

◆ setAutoLayout()

void tgui::Widget::setAutoLayout ( AutoLayout layout)

Sets how the position is determined compared to the other widgets in the parent.

Parameters
layoutAlignment for how to position the widget in its parent

The default value is Manual which means the position and size are manually set and are unrelated to other widgets.

◆ 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::ButtonBase, tgui::ComboBox, tgui::CustomWidgetForBindings, tgui::EditBox, tgui::MenuBar, tgui::RadioButton, tgui::SubwidgetContainer, 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::ButtonBase, tgui::Container, tgui::CustomWidgetForBindings, tgui::EditBox, tgui::RootContainer, tgui::SubwidgetContainer, 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

◆ setIgnoreMouseEvents()

void tgui::Widget::setIgnoreMouseEvents ( bool ignore)

Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.

Parameters
ignoreShould mouse events be ignored by this widget?

By default, mouse events are NOT ignored.

If you want the widget to ignore the events without the events being passed to the widgets behind this one, then you need to call setEnabled(false) instead of setIgnoreMouseEvents(true).

Since
TGUI 1.3

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

◆ setNavigationDown()

void tgui::Widget::setNavigationDown ( const Widget::Ptr & widgetBelow)

Changes which widget should become focused when navigating downwards from this widget.

Parameters
widgetBelowThe widget located below this one, or nullptr if pressing the down arrow shouldn't change focus
Warning
Navigation only works if gui.setKeyboardNavigationEnabled(true) has been called
Since
TGUI 1.1

◆ setNavigationLeft()

void tgui::Widget::setNavigationLeft ( const Widget::Ptr & widgetLeft)

Changes which widget should become focused when navigating to the left from this widget.

Parameters
widgetLeftThe widget located left of this one, or nullptr if pressing the left arrow shouldn't change focus
Warning
Navigation only works if gui.setKeyboardNavigationEnabled(true) has been called
Since
TGUI 1.1

◆ setNavigationRight()

void tgui::Widget::setNavigationRight ( const Widget::Ptr & widgetRight)

Changes which widget should become focused when navigating to the right from this widget.

Parameters
widgetRightThe widget located right this one, or nullptr if pressing the right arrow shouldn't change focus
Warning
Navigation only works if gui.setKeyboardNavigationEnabled(true) has been called
Since
TGUI 1.1

◆ setNavigationUp()

void tgui::Widget::setNavigationUp ( const Widget::Ptr & widgetAbove)

Changes which widget should become focused when navigating upwards from this widget.

Parameters
widgetAboveThe widget located above this one, or nullptr if pressing the up arrow shouldn't change focus
Warning
Navigation only works if gui.setKeyboardNavigationEnabled(true) has been called
Since
TGUI 1.1

◆ 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 function should not be used if the AutoLayout is set to something other than Manual

◆ 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 function should not be used if the AutoLayout is set to something other than Manual

◆ 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});
Warning
This function should not be used if the AutoLayout is set to something other than Manual

Reimplemented in tgui::ChildWindow, 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
This function should not be used if the AutoLayout is set to something other than Manual

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

◆ 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

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

◆ 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

◆ 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::BitmapButton, tgui::BoxLayout, tgui::ButtonBase, tgui::CanvasGLES2, tgui::CanvasOpenGL3, tgui::CanvasRaylib, tgui::CanvasSDL, tgui::CanvasSFML, tgui::ChatBox, tgui::ChildWindow, tgui::ComboBox, tgui::Container, tgui::CustomWidgetForBindings, tgui::EditBox, tgui::EditBoxSlider, tgui::Grid, tgui::Group, tgui::Knob, tgui::Label, tgui::ListBox, tgui::ListView, tgui::MenuBar, tgui::MessageBox, tgui::Panel, tgui::PanelListBox, tgui::Picture, tgui::ProgressBar, tgui::RadioButton, tgui::RangeSlider, tgui::ScrollablePanel, tgui::Scrollbar, tgui::Slider, tgui::SpinButton, tgui::SpinControl, tgui::SubwidgetContainer, 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.
Widgets should be named as if they are C++ variables, i.e. names must not include any whitespace, or most symbols (e.g.: +, -, *, /, ., &), and should not start with a number. If you do not follow these rules, layout expressions may give unexpected results. Alphanumeric characters and underscores are safe to use, and widgets are permitted to have no name.

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

Member Data Documentation

◆ m_enabled

bool tgui::Widget::m_enabled = true
protected

Stores the flag indicating whether this widget is enabled.

When a widget is disabled, it will no longer receive events

◆ m_visible

bool tgui::Widget::m_visible = true
protected

Stores the flag indicating whether this widget is visible.

When a widget is is invisible, it will not receive events and it won't be drawn

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