TGUI  1.6.1
Loading...
Searching...
No Matches
ClickableWidget.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 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#ifndef TGUI_CLICKABLE_WIDGET_HPP
26#define TGUI_CLICKABLE_WIDGET_HPP
27
28#include <TGUI/Widget.hpp>
29
31
32TGUI_MODULE_EXPORT namespace tgui
33{
37 class TGUI_API ClickableWidget : public Widget
38 {
39 public:
40
41 using Ptr = std::shared_ptr<ClickableWidget>;
42 using ConstPtr = std::shared_ptr<const ClickableWidget>;
43
44 static constexpr const char StaticWidgetType[] = "ClickableWidget";
45
53 ClickableWidget(const char* typeName = StaticWidgetType, bool initRenderer = true);
54
62 TGUI_NODISCARD static ClickableWidget::Ptr create(const Layout2d& size = {"100%", "100%"});
63
71 TGUI_NODISCARD static ClickableWidget::Ptr copy(const ClickableWidget::ConstPtr& widget);
72
77 TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
78
82 bool leftMousePressed(Vector2f pos) override;
83
87 void leftMouseReleased(Vector2f pos) override;
88
92 void rightMousePressed(Vector2f pos) override;
93
97 void rightMouseReleased(Vector2f pos) override;
98
102 void rightMouseButtonNoLongerDown() override;
103
110 void draw(BackendRenderTarget& target, RenderStates states) const override;
111
113 protected:
114
124 TGUI_NODISCARD Signal& getSignal(String signalName) override;
125
127 // Makes a copy of the widget
129 TGUI_NODISCARD Widget::Ptr clone() const override;
130
132 public:
133
134 SignalVector2f onMousePress = {"MousePressed"};
135 SignalVector2f onMouseRelease = {"MouseReleased"};
136 SignalVector2f onClick = {"Clicked"};
137
138 SignalVector2f onRightMousePress = {"RightMousePressed"};
139 SignalVector2f onRightMouseRelease = {"RightMouseReleased"};
140 SignalVector2f onRightClick = {"RightClicked"};
141
143 private:
144
145 bool m_rightMouseDown = false;
146
148 };
149
151}
152
154
155#endif // TGUI_CLICKABLE_WIDGET_HPP
156
Base class for render targets.
Definition BackendRenderTarget.hpp:46
Clickable widget.
Definition ClickableWidget.hpp:38
static ClickableWidget::Ptr create(const Layout2d &size={"100%", "100%"})
Creates a new clickable widget.
bool leftMousePressed(Vector2f pos) override
Called by the parent when the left mouse button goes down on top of the widget.
bool isMouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
std::shared_ptr< const ClickableWidget > ConstPtr
Shared constant widget pointer.
Definition ClickableWidget.hpp:42
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the widget to a render target.
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
std::shared_ptr< ClickableWidget > Ptr
Shared widget pointer.
Definition ClickableWidget.hpp:41
static ClickableWidget::Ptr copy(const ClickableWidget::ConstPtr &widget)
Makes a copy of another clickable widget.
Class to store the position or size of a widget.
Definition Layout.hpp:323
Signal to which the user can subscribe to get callbacks from.
Definition Signal.hpp:61
Wrapper class to store strings.
Definition String.hpp:96
The parent class for every widget.
Definition Widget.hpp:83
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition Widget.hpp:86
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:38
States used for drawing.
Definition RenderStates.hpp:38