TGUI  0.8-dev

Button widget. More...

#include <Button.hpp>

Inheritance diagram for tgui::Button:
tgui::ClickableWidget tgui::Widget tgui::SignalWidgetBase

Public Types

typedef std::shared_ptr< ButtonPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ButtonConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::ClickableWidget
typedef std::shared_ptr< ClickableWidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ClickableWidgetConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

ButtonRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
ButtonRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the button. More...
 
void enable () override
 Enables the widget. More...
 
void disable () override
 Disables the widget. More...
 
void setText (const sf::String &text)
 Changes the caption of the button. More...
 
const sf::String & getText () const
 Returns the caption of the button. More...
 
void setTextSize (unsigned int size)
 Changes the character size of the text. More...
 
unsigned int getTextSize () const
 Returns the character size of the text. More...
 
void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::ClickableWidget
 ClickableWidget ()
 Default constructor.
 
bool mouseOnWidget (sf::Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual sf::Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hide ()
 Hides the widget. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void focus ()
 Focus the widget. More...
 
virtual void unfocus ()
 Unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const std::string & getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets. More...
 
virtual void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip ()
 Returns the tool tip that is displayed when hovering over the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(const Args &...)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, const Args &... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if< std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)>>::value &&!std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs>
unsigned int connect (std::initializer_list< std::string > signalNames, Func &&handler, BoundArgs &&... args)
 Connect a signal handler to multiple signals. More...
 
bool disconnect (unsigned int id)
 Disconnects a signal handler. More...
 
void disconnectAll (std::string signalName)
 Disconnects all signal handler from a certain signal. More...
 
void disconnectAll ()
 Disconnects all signal handlers from signals.
 

Static Public Member Functions

static Button::Ptr create (const sf::String &text="")
 Creates a new button widget. More...
 
static Button::Ptr copy (Button::ConstPtr button)
 Makes a copy of another button. More...
 
- Static Public Member Functions inherited from tgui::ClickableWidget
static ClickableWidget::Ptr create (Layout2d size={"100%", "100%"})
 Creates a new clickable widget. More...
 
static ClickableWidget::Ptr copy (ClickableWidget::ConstPtr widget)
 Makes a copy of another clickable widget. More...
 

Public Attributes

SignalString onPress = {"Pressed"}
 The button was pressed. Optional parameter: text of the button.
 
- Public Attributes inherited from tgui::ClickableWidget
SignalVector2f onMousePress = {"MousePressed"}
 The mouse went down on the widget. Optional parameter: mouse position relative to widget.
 
SignalVector2f onMouseRelease = {"MouseReleased"}
 The mouse was released on top of the widget. Optional parameter: mouse position relative to widget.
 
SignalVector2f onClick = {"Clicked"}
 The widget was clicked. Optional parameter: mouse position relative to widget.
 
- Public Attributes inherited from tgui::Widget
SignalVector2f onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalVector2f onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
Signal onFocus = {"Focused"}
 The widget was focused.
 
Signal onUnfocus = {"Unfocused"}
 The widget was unfocused.
 
Signal onMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
Signal onMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 

Protected Member Functions

void mouseEnteredWidget () override
 This function is called when the mouse enters the widget.
 
void mouseLeftWidget () override
 This function is called when the mouse leaves the widget.
 
SignalgetSignal (std::string signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. More...
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- Protected Member Functions inherited from tgui::ClickableWidget
SignalgetSignal (std::string signalName) override
 Retrieves a signal based on its name. More...
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 

Detailed Description

Button widget.

Member Function Documentation

◆ clone()

Widget::Ptr tgui::Button::clone ( ) const
inlineoverrideprotectedvirtual

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

Implements tgui::Widget.

◆ copy()

static Button::Ptr tgui::Button::copy ( Button::ConstPtr  button)
static

Makes a copy of another button.

Parameters
buttonThe other button
Returns
The new button

◆ create()

static Button::Ptr tgui::Button::create ( const sf::String &  text = "")
static

Creates a new button widget.

Parameters
textThe text to display on the button
Returns
The new button

◆ disable()

void tgui::Button::disable ( )
overridevirtual

Disables the widget.

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

Reimplemented from tgui::Widget.

◆ draw()

void tgui::Button::draw ( sf::RenderTarget &  target,
sf::RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ enable()

void tgui::Button::enable ( )
overridevirtual

Enables the widget.

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

Reimplemented from tgui::Widget.

◆ getRenderer()

ButtonRenderer* tgui::Button::getRenderer ( )

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

Returns
Temporary pointer to the renderer
Warning
After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getSharedRenderer()

ButtonRenderer* tgui::Button::getSharedRenderer ( )

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

Returns
Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getSignal()

Signal& tgui::Button::getSignal ( std::string  signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

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

Reimplemented from tgui::Widget.

◆ getText()

const sf::String& tgui::Button::getText ( ) const

Returns the caption of the button.

Returns
Text that is drawn on top of the button

◆ getTextSize()

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

Returns the character size of the text.

Returns
The current text size

◆ rendererChanged()

void tgui::Button::rendererChanged ( const std::string &  property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyLowercase name of the property that was changed

Reimplemented from tgui::Widget.

◆ setSize()

void tgui::Button::setSize ( const Layout2d size)
overridevirtual

Changes the size of the button.

Parameters
sizeThe new size of the button

Reimplemented from tgui::Widget.

◆ setText()

void tgui::Button::setText ( const sf::String &  text)

Changes the caption of the button.

Parameters
textNew text to draw on top of the button

◆ setTextSize()

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

Changes the character size of the text.

Parameters
sizeThe new text size If the size is set to 0 then the text will be auto-sized to fit inside the button.

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