TGUI  0.8-dev

Button widget. More...

#include <Button.hpp>

Inheritance diagram for tgui::Button:
tgui::ClickableWidget tgui::Widget tgui::Transformable 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

ButtonRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setSize (const Layout2d &size) override
 Changes the size of the button. More...
 
virtual void enable () override
 Enables the widget. More...
 
virtual 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...
 
virtual 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.
 
- 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...
 
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
 sets the position 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 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.
 
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...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 Sets the position of the widget. More...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void move (const Layout2d &offset)
 Moves the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Moves 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)
 Scales the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scales the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
virtual ~SignalWidgetBase ()
 Virtual destructor.
 
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)
 Disconnects all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnects all connections from a all signals.
 

Static Public Member Functions

static Button::Ptr create (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...
 

Protected Member Functions

virtual void mouseEnteredWidget () override
 This function is called when the mouse enters the widget.
 
virtual void mouseLeftWidget () override
 This function is called when the mouse leaves the widget.
 
virtual void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. More...
 
virtual Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 

Detailed Description

Button widget.

Signals:

  • Pressed (the button was pressed)
    • Optional parameter sf::String: Caption of the button
    • Uses Callback member 'text'
  • Inherited signals from ClickableWidget

Member Function Documentation

§ clone()

virtual 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

Reimplemented from tgui::ClickableWidget.

§ 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 ( sf::String  text = "")
static

Creates a new button widget.

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

§ disable()

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

virtual 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

Reimplemented from tgui::ClickableWidget.

§ enable()

virtual 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 ( ) const
inline

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

Returns
Temporary pointer to the renderer

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

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

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