TGUI  0.7.4

The parent class for every widget. More...

#include <Widget.hpp>

Inheritance diagram for tgui::Widget:
tgui::Transformable tgui::SignalWidgetBase tgui::ChatBox tgui::ClickableWidget tgui::ComboBox tgui::Container tgui::Knob tgui::ListBox tgui::MenuBar tgui::Scrollbar tgui::Slider tgui::Tab 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)
 Copy constructor. More...
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &right)
 Overload of assignment operator. More...
 
std::shared_ptr< WidgetRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position) override
 set the position of the widget More...
 
virtual void setSize (const Layout2d &size) override
 Changes the size of the widget. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. 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 (bool blockMouseEvents=true)
 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 setOpacity (float opacity)
 Changes the opacity of the widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets.
 
virtual void moveToBack ()
 Places the widget behind all other widgets.
 
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 void setFont (const Font &font)
 Changes the font of the text in the widget. More...
 
std::shared_ptr< sf::Font > getFont () const
 Returns the font associated with the widget (if any) More...
 
void detachTheme ()
 Detach the theme from the widget. More...
 
std::shared_ptr< BaseThemegetTheme () const
 Returns the theme to which the widget is currently connected. More...
 
std::string getPrimaryLoadingParameter () const
 Returns the primary parameter that was passed to the loader to load this widget. More...
 
std::string getSecondaryLoadingParameter () const
 Returns the secondary parameter that was passed to the loader to load this widget. 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 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::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 set the position of the widget More...
 
sf::Vector2f getPosition () const
 get the position of the widget More...
 
void move (const Layout2d &offset)
 Move the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Move the widget by a given offset. More...
 
void setSize (const Layout &width, const Layout &height)
 Changes the size of the widget. More...
 
virtual 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...
 
void scale (const Layout2d &factors)
 Scale the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scale the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
 SignalWidgetBase ()=default
 Default constructor.
 
 SignalWidgetBase (const SignalWidgetBase &copy)
 Copy constructor. More...
 
SignalWidgetBaseoperator= (const SignalWidgetBase &right)
 Overload of assignment operator. More...
 
template<typename Func , typename... Args>
unsigned int connect (const std::string &signalNames, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
template<typename Func , typename... Args>
unsigned int connectEx (const std::string &signalName, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
void disconnect (unsigned int id)
 Disconnects a connection. More...
 
void disconnectAll (const std::string &signalName)
 Disconnect all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnect all connections from a all signals.
 

Protected Member Functions

void attachTheme (std::shared_ptr< BaseTheme > theme)
 Attach a theme to the widget. More...
 
virtual void reload (const std::string &primary="", const std::string &secondary="", bool force=false)
 Reload the widget. More...
 

Detailed Description

The parent class for every widget.

Signals

  • PositionChanged (Position of the widget has changed)
    • Optional parameter sf::Vector2f: New widget position
    • Uses Callback member 'position'
  • SizeChanged (Size of the widget has changed)
    • Optional parameter sf::Vector2f: New widget size
    • Uses Callback member 'size'
  • Focused (Widget gained focus)
  • Unfocused (Widget lost focus)
  • MouseEntered (Mouse cursor entered in the Widget area)
  • MouseLeft (Mouse cursor left the Widget area)

Constructor & Destructor Documentation

◆ Widget()

tgui::Widget::Widget ( const Widget copy)

Copy constructor.

Parameters
copyInstance to copy

Member Function Documentation

◆ attachTheme()

void tgui::Widget::attachTheme ( std::shared_ptr< BaseTheme theme)
protected

Attach a theme to the widget.

Parameters
themeTheme to be shared with this widget

If a theme was already attached, it will receive a detach event

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

◆ detachTheme()

void tgui::Widget::detachTheme ( )

Detach the theme from the widget.

The theme will be told that the widget no longer shares the theme with the other widgets

◆ disable()

virtual void tgui::Widget::disable ( bool  blockMouseEvents = true)
virtual

Disables the widget.

Parameters
blockMouseEventsShould mouse events be passed to the widget behind this one or blocked?

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

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

◆ focus()

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

Focus the widget.

The previously focused widget will be unfocused.

See also
unfocus
focusNextWidget

◆ 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
Position of the widget

◆ getFont()

std::shared_ptr<sf::Font> tgui::Widget::getFont ( ) const

Returns the font associated with the widget (if any)

Returns
Font used by widget

◆ getOpacity()

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

Returns the opacity of the widget.

Returns
The opacity of the widget. 0 means completely transparent, while 1 (default) means fully opaque.

◆ getParent()

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

Returns a pointer to the parent widget.

Returns
Pointer to the parent.

◆ getPrimaryLoadingParameter()

std::string tgui::Widget::getPrimaryLoadingParameter ( ) const
inline

Returns the primary parameter that was passed to the loader to load this widget.

Returns
Primary loading parameter

◆ getRenderer()

std::shared_ptr<WidgetRenderer> tgui::Widget::getRenderer ( ) const
inline

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Reference to the renderer

◆ getSecondaryLoadingParameter()

std::string tgui::Widget::getSecondaryLoadingParameter ( ) const
inline

Returns the secondary parameter that was passed to the loader to load this widget.

Returns
Primary loading parameter

◆ getTheme()

std::shared_ptr<BaseTheme> tgui::Widget::getTheme ( ) const
inline

Returns the theme to which the widget is currently connected.

Returns
Currently shared theme (if any)

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

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

This is basically the width and height of the optional borders drawn around widgets.

Returns
Offset of the widget

Reimplemented in tgui::ComboBox, tgui::ListBox, tgui::ChatBox, tgui::EditBox, tgui::Tab, tgui::Label, tgui::ProgressBar, tgui::TextBox, tgui::Knob, tgui::SpinButton, tgui::Slider, and tgui::Button.

◆ getWidgetType()

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

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.

Parameters
typeType of the animation
durationDuration of the animation

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

◆ operator=()

Widget& tgui::Widget::operator= ( const Widget right)

Overload of assignment operator.

Parameters
rightInstance to assign
Returns
Reference to itself

◆ reload()

virtual void tgui::Widget::reload ( const std::string &  primary = "",
const std::string &  secondary = "",
bool  force = false 
)
protectedvirtual

Reload the widget.

Parameters
primaryPrimary parameter for the loader
secondarySecondary parameter for the loader
forceTry to only change the looks of the widget and not alter the widget itself when false
Exceptions
Exceptionwhen the connected theme could not create the widget

When primary is an empty string the built-in white theme will be used.

Reimplemented in tgui::ComboBox, tgui::ListBox, tgui::ChatBox, tgui::ChildWindow, tgui::EditBox, tgui::TextBox, tgui::Tab, tgui::Label, tgui::Knob, tgui::ProgressBar, tgui::MenuBar, tgui::Scrollbar, tgui::SpinButton, tgui::Slider, tgui::RadioButton, tgui::Button, and tgui::MessageBox.

◆ setFont()

virtual void tgui::Widget::setFont ( const Font font)
virtual

Changes the font of the text in the widget.

Parameters
fontThe new font.

When you don't call this function then the font from the parent widget will be used.

Some widget don't need a font and won't do anything when this function is called.

Reimplemented in tgui::ChatBox, tgui::ChildWindow, tgui::ListBox, tgui::Label, tgui::EditBox, tgui::ComboBox, tgui::TextBox, tgui::ProgressBar, tgui::Tab, tgui::RadioButton, tgui::Button, tgui::MenuBar, tgui::MessageBox, tgui::Container, and tgui::BoxLayout.

◆ setOpacity()

virtual void tgui::Widget::setOpacity ( float  opacity)
virtual

Changes the opacity of the widget.

Parameters
opacityThe opacity of the widget. 0 means completely transparent, while 1 (default) means fully opaque.

Reimplemented in tgui::ComboBox, tgui::ListBox, tgui::ChatBox, tgui::EditBox, tgui::Tab, tgui::Label, tgui::ProgressBar, tgui::TextBox, tgui::Knob, tgui::MenuBar, tgui::Container, tgui::Picture, tgui::Scrollbar, tgui::SpinButton, tgui::RadioButton, tgui::ChildWindow, tgui::Slider, tgui::Button, and tgui::Canvas.

◆ setPosition()

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

set 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 50 pixels below another widget
widget->setPosition(otherWidget->getPosition() + sf::Vector2f{0, otherWidget->getSize().y + 50});
// 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 from tgui::Transformable.

Reimplemented in tgui::Picture, tgui::ListBox, tgui::EditBox, tgui::ChildWindow, tgui::Label, tgui::ComboBox, tgui::TextBox, tgui::ProgressBar, tgui::Canvas, tgui::RadioButton, tgui::Button, tgui::Slider, tgui::SpinButton, tgui::MenuBar, tgui::Knob, tgui::Scrollbar, and tgui::Tab.

◆ setSize()

virtual void tgui::Widget::setSize ( const Layout2d size)
overridevirtual

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Make the widget 50 pixels higher than some other widget
widget->setSize(otherWidget->getSize() + sf::Vector2f{0, 50});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize(tgui::bindSize(otherWidget) + sf::Vector2f{0, 50});

Reimplemented from tgui::Transformable.

Reimplemented in tgui::Picture, tgui::ListBox, tgui::Label, tgui::EditBox, tgui::ChildWindow, tgui::ComboBox, tgui::TextBox, tgui::ProgressBar, tgui::ChatBox, tgui::Canvas, tgui::Grid, tgui::Tab, tgui::RadioButton, tgui::Button, tgui::MenuBar, tgui::Slider, tgui::SpinButton, tgui::Knob, tgui::Scrollbar, and tgui::BoxLayout.

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

See also
focus
focusNextWidget

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