TGUI  0.9.1
Button.hpp
1 //
3 // TGUI - Texus' Graphical User Interface
4 // Copyright (C) 2012-2021 Bruno Van de Velde (vdv_b@tgui.eu)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 
26 #ifndef TGUI_BUTTON_HPP
27 #define TGUI_BUTTON_HPP
28 
29 #include <TGUI/Widgets/ButtonBase.hpp>
30 
32 
33 namespace tgui
34 {
38  class TGUI_API Button : public ButtonBase
39  {
40  public:
41 
42  typedef std::shared_ptr<Button> Ptr;
43  typedef std::shared_ptr<const Button> ConstPtr;
44 
45 
53  Button(const char* typeName = "Button", bool initRenderer = true);
54 
55 
64  static Button::Ptr create(const String& text = "");
65 
66 
76 
77 
81  void leftMousePressed(Vector2f pos) override;
82 
86  void leftMouseReleased(Vector2f pos) override;
87 
91  void leftMouseButtonNoLongerDown() override;
92 
96  void keyPressed(const Event::KeyEvent& event) override;
97 
98 
100  protected:
101 
103  // This function is called when the mouse enters the widget. If requested, a callback will be send.
105  void mouseEnteredWidget() override;
106 
107 
109  // This function is called when the mouse leaves the widget. If requested, a callback will be send.
111  void mouseLeftWidget() override;
112 
113 
123  Signal& getSignal(String signalName) override;
124 
125 
127  // Makes a copy of the widget
129  Widget::Ptr clone() const override
130  {
131  return std::make_shared<Button>(*this);
132  }
133 
134 
136  public:
137 
138  SignalString onPress = {"Pressed"};
139  };
140 
142 }
143 
145 
146 #endif // TGUI_BUTTON_HPP
147 
Base class for button widgets.
Definition: ButtonBase.hpp:42
Button widget.
Definition: Button.hpp:39
Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
void mouseLeftWidget() override
This function is called when the mouse leaves the widget.
static Button::Ptr create(const String &text="")
Creates a new button widget.
std::shared_ptr< Button > Ptr
Shared widget pointer.
Definition: Button.hpp:42
void mouseEnteredWidget() override
This function is called when the mouse enters the widget.
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
Definition: Button.hpp:129
std::shared_ptr< const Button > ConstPtr
Shared constant widget pointer.
Definition: Button.hpp:43
static Button::Ptr copy(Button::ConstPtr button)
Makes a copy of another button.
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:58
Wrapper class to store strings.
Definition: String.hpp:74
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:73
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
KeyPressed event parameters.
Definition: Event.hpp:167