TGUI  1.3.0
Loading...
Searching...
No Matches
Panel.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
26#ifndef TGUI_PANEL_HPP
27#define TGUI_PANEL_HPP
28
29
30#include <TGUI/Widgets/Group.hpp>
31#include <TGUI/Renderers/PanelRenderer.hpp>
32
34
35TGUI_MODULE_EXPORT namespace tgui
36{
40 class TGUI_API Panel : public Group
41 {
42 public:
43
44 using Ptr = std::shared_ptr<Panel>;
45 using ConstPtr = std::shared_ptr<const Panel>;
46
47 static constexpr const char StaticWidgetType[] = "Panel";
48
56 Panel(const char* typeName = StaticWidgetType, bool initRenderer = true);
57
65 TGUI_NODISCARD static Panel::Ptr create(const Layout2d& size = {"100%", "100%"});
66
74 TGUI_NODISCARD static Panel::Ptr copy(const Panel::ConstPtr& panel);
75
80 TGUI_NODISCARD PanelRenderer* getSharedRenderer() override;
81 TGUI_NODISCARD const PanelRenderer* getSharedRenderer() const override;
82
88 TGUI_NODISCARD PanelRenderer* getRenderer() override;
89
95 void setSize(const Layout2d& size) override;
96 using Widget::setSize;
97
102 TGUI_NODISCARD Vector2f getInnerSize() const override;
103
110 TGUI_NODISCARD Vector2f getChildWidgetsOffset() const override;
111
117 TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
118
122 bool leftMousePressed(Vector2f pos) override;
123
127 void leftMouseReleased(Vector2f pos) override;
128
132 void rightMousePressed(Vector2f pos) override;
133
137 void rightMouseReleased(Vector2f pos) override;
138
142 void rightMouseButtonNoLongerDown() override;
143
151 void draw(BackendRenderTarget& target, RenderStates states) const override;
152
163 static void setEventBubbling(bool useEventBubbling);
164
170 TGUI_NODISCARD static bool getEventBubbling();
171
173 protected:
174
184 TGUI_NODISCARD Signal& getSignal(String signalName) override;
185
192 void rendererChanged(const String& property) override;
193
195 // This function is called every frame with the time passed since the last frame.
197 bool updateTime(Duration elapsedTime) override;
198
200 // Makes a copy of the widget
202 TGUI_NODISCARD Widget::Ptr clone() const override;
203
205 public:
206
207 SignalVector2f onMousePress = {"MousePressed"};
208 SignalVector2f onMouseRelease = {"MouseReleased"};
209 SignalVector2f onClick = {"Clicked"};
210 SignalVector2f onDoubleClick = {"DoubleClicked"};
211
212 SignalVector2f onRightMousePress = {"RightMousePressed"};
213 SignalVector2f onRightMouseRelease = {"RightMouseReleased"};
214 SignalVector2f onRightClick = {"RightClicked"};
215
217 protected:
218
219 static bool m_eventBubbling;
220
221 // Cached renderer properties
222 Borders m_bordersCached;
223 Color m_borderColorCached;
224 Color m_backgroundColorCached;
225 Sprite m_spriteBackground;
226
227 float m_roundedBorderRadius = 0;
228
229 bool m_rightMouseDown = false;
230
231 // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
232 bool m_possibleDoubleClick = false;
233
235 };
236
238}
239
241
242#endif // TGUI_PANEL_HPP
Base class for render targets.
Definition BackendRenderTarget.hpp:48
Wrapper for colors.
Definition Color.hpp:74
Wrapper for durations.
Definition Duration.hpp:56
Group widget.
Definition Group.hpp:44
Class to store the position or size of a widget.
Definition Layout.hpp:328
Definition Outline.hpp:39
Definition PanelRenderer.hpp:37
Group of widgets that has a background color and optional borders.
Definition Panel.hpp:41
static void setEventBubbling(bool useEventBubbling)
Changes whether event bubbling is used for the mouse events.
TGUI_NODISCARD Vector2f getChildWidgetsOffset() const override
Returns the distance between the position of the container and a widget that would be drawn inside th...
TGUI_NODISCARD Vector2f getInnerSize() const override
Returns the space available for widgets inside the container.
static TGUI_NODISCARD Panel::Ptr copy(const Panel::ConstPtr &panel)
Makes a copy of another panel.
TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
TGUI_NODISCARD PanelRenderer * getSharedRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
std::shared_ptr< const Panel > ConstPtr
Shared constant widget pointer.
Definition Panel.hpp:45
TGUI_NODISCARD Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
std::shared_ptr< Panel > Ptr
Shared widget pointer.
Definition Panel.hpp:44
TGUI_NODISCARD Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
static TGUI_NODISCARD Panel::Ptr create(const Layout2d &size={"100%", "100%"})
Creates a new panel widget.
void setSize(const Layout2d &size) override
Changes the size of the panel.
bool leftMousePressed(Vector2f pos) override
Called by the parent when the left mouse button goes down on top of the widget.
TGUI_NODISCARD PanelRenderer * getRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the widget to a render target.
static TGUI_NODISCARD bool getEventBubbling()
Returns whether event bubbling is used for the mouse events.
Signal to which the user can subscribe to get callbacks from.
Definition Signal.hpp:62
Definition Sprite.hpp:48
Wrapper class to store strings.
Definition String.hpp:101
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition Widget.hpp:87
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39
States used for drawing.
Definition RenderStates.hpp:39