TGUI  1.0-alpha
Panel.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2022 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
35namespace tgui
36{
40 class TGUI_API Panel : public Group
41 {
42 public:
43
44 typedef std::shared_ptr<Panel> Ptr;
45 typedef std::shared_ptr<const Panel> ConstPtr;
46
47
55 Panel(const char* typeName = "Panel", bool initRenderer = true);
56
57
66 static Panel::Ptr create(Layout2d size = {"100%", "100%"});
67
68
78
79
85 const PanelRenderer* getSharedRenderer() const;
86
93
94
101 void setSize(const Layout2d& size) override;
102 using Widget::setSize;
103
104
109 Vector2f getInnerSize() const override;
110
111
120
121
128 bool isMouseOnWidget(Vector2f pos) const override;
129
133 void leftMousePressed(Vector2f pos) override;
134
138 void leftMouseReleased(Vector2f pos) override;
139
143 void rightMousePressed(Vector2f pos) override;
144
148 void rightMouseReleased(Vector2f pos) override;
149
153 void rightMouseButtonNoLongerDown() override;
154
155
163 void draw(BackendRenderTarget& target, RenderStates states) const override;
164
165
167 protected:
168
178 Signal& getSignal(String signalName) override;
179
180
187 void rendererChanged(const String& property) override;
188
189
191 // This function is called every frame with the time passed since the last frame.
193 bool updateTime(Duration elapsedTime) override;
194
195
197 // Makes a copy of the widget
199 Widget::Ptr clone() const override;
200
201
203 public:
204
205 SignalVector2f onMousePress = {"MousePressed"};
206 SignalVector2f onMouseRelease = {"MouseReleased"};
207 SignalVector2f onClick = {"Clicked"};
208 SignalVector2f onDoubleClick = {"DoubleClicked"};
209
210 SignalVector2f onRightMousePress = {"RightMousePressed"};
211 SignalVector2f onRightMouseRelease = {"RightMouseReleased"};
212 SignalVector2f onRightClick = {"RightClicked"};
213
214
216 protected:
217
218 // Cached renderer properties
219 Borders m_bordersCached;
220 Color m_borderColorCached;
221 Color m_backgroundColorCached;
222 Sprite m_spriteBackground;
223
224 float m_roundedBorderRadius = 0;
225
226 bool m_rightMouseDown = false;
227
228 // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
229 bool m_possibleDoubleClick = false;
230
232 };
233
235}
236
238
239#endif // TGUI_PANEL_HPP
Base class for render targets.
Definition: BackendRenderTarget.hpp:48
Wrapper for colors.
Definition: Color.hpp:63
Wrapper for durations.
Definition: Duration.hpp:52
Group widget.
Definition: Group.hpp:44
Class to store the position or size of a widget.
Definition: Layout.hpp:284
Definition: Outline.hpp:39
Definition: PanelRenderer.hpp:37
Group of widgets that has a background color and optional borders.
Definition: Panel.hpp:41
static Panel::Ptr copy(Panel::ConstPtr panel)
Makes a copy of another panel.
std::shared_ptr< Panel > Ptr
Shared widget pointer.
Definition: Panel.hpp:44
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
Vector2f getChildWidgetsOffset() const override
Returns the distance between the position of the container and a widget that would be drawn inside th...
Vector2f getInnerSize() const override
Returns the space available for widgets inside the container.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
bool isMouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
void setSize(const Layout2d &size) override
Changes the size of the panel.
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the widget to a render target.
static Panel::Ptr create(Layout2d size={"100%", "100%"})
Creates a new panel widget.
std::shared_ptr< const Panel > ConstPtr
Shared constant widget pointer.
Definition: Panel.hpp:45
PanelRenderer * getRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
PanelRenderer * getSharedRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:58
Definition: Sprite.hpp:45
Wrapper class to store strings.
Definition: String.hpp:79
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:73
virtual void setSize(const Layout2d &size)
Changes the size of the widget.
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
States used for drawing.
Definition: RenderStates.hpp:39