TGUI  0.8.8
ClickableWidget.hpp
1 //
3 // TGUI - Texus' Graphical User Interface
4 // Copyright (C) 2012-2020 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_CLICKABLE_WIDGET_HPP
27 #define TGUI_CLICKABLE_WIDGET_HPP
28 
29 
30 #include <TGUI/Widget.hpp>
31 
33 
34 namespace tgui
35 {
39  class TGUI_API ClickableWidget : public Widget
40  {
41  public:
42 
43  typedef std::shared_ptr<ClickableWidget> Ptr;
44  typedef std::shared_ptr<const ClickableWidget> ConstPtr;
45 
46 
52 
53 
62  static ClickableWidget::Ptr create(Layout2d size = {"100%", "100%"});
63 
64 
74 
75 
80  bool mouseOnWidget(Vector2f pos) const override;
81 
85  void leftMousePressed(Vector2f pos) override;
86 
90  void leftMouseReleased(Vector2f pos) override;
91 
95  void rightMousePressed(Vector2f pos) override;
96 
100  void rightMouseReleased(Vector2f pos) override;
101 
105  void rightMouseButtonNoLongerDown() override;
106 
107 
115  void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
116 
117 
119  protected:
120 
130  Signal& getSignal(std::string signalName) override;
131 
132 
134  // Makes a copy of the widget
136  Widget::Ptr clone() const override
137  {
138  return std::make_shared<ClickableWidget>(*this);
139  }
140 
141 
143  public:
144 
145  SignalVector2f onMousePress = {"MousePressed"};
146  SignalVector2f onMouseRelease = {"MouseReleased"};
147  SignalVector2f onClick = {"Clicked"};
148 
149  SignalVector2f onRightMousePress = {"RightMousePressed"};
150  SignalVector2f onRightMouseRelease = {"RightMouseReleased"};
151  SignalVector2f onRightClick = {"RightClicked"};
152 
153 
155  private:
156 
157  bool m_rightMouseDown = false;
158 
160  };
161 
163 }
164 
166 
167 #endif // TGUI_CLICKABLE_WIDGET_HPP
168 
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:224
ClickableWidget()
Default constructor.
Signal & getSignal(std::string signalName) override
Retrieves a signal based on its name.
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:77
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:37
std::shared_ptr< ClickableWidget > Ptr
Shared widget pointer.
Definition: ClickableWidget.hpp:43
void draw(sf::RenderTarget &target, sf::RenderStates states) const override
Draw the widget to a render target.
Class to store the position or size of a widget.
Definition: Layout.hpp:260
bool mouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
std::shared_ptr< const ClickableWidget > ConstPtr
Shared constant widget pointer.
Definition: ClickableWidget.hpp:44
Definition: Vector2f.hpp:39
static ClickableWidget::Ptr create(Layout2d size={"100%", "100%"})
Creates a new clickable widget.
The parent class for every widget.
Definition: Widget.hpp:74
Clickable widget.
Definition: ClickableWidget.hpp:40
static ClickableWidget::Ptr copy(ClickableWidget::ConstPtr widget)
Makes a copy of another clickable widget.
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
Definition: ClickableWidget.hpp:136