TGUI  0.8-dev
Panel.hpp
1 //
3 // TGUI - Texus' Graphical User Interface
4 // Copyright (C) 2012-2017 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 
35 namespace 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 
54  Panel(const Layout2d& size = {RelLayout{1}, RelLayout{1}});
55 
56 
65  static Panel::Ptr create(Layout2d size = {RelLayout{1}, RelLayout{1}});
66 
67 
76  static Panel::Ptr copy(Panel::ConstPtr panel);
77 
78 
86  {
87  return aurora::downcast<PanelRenderer*>(m_renderer.get());
88  }
89 
90 
97  virtual void setSize(const Layout2d& size) override;
99 
100 
107  virtual sf::Vector2f getContentSize() const override;
108 
109 
117  virtual sf::Vector2f getChildWidgetsOffset() const override;
118 
119 
126  virtual bool mouseOnWidget(sf::Vector2f pos) const override;
127 
131  virtual void leftMousePressed(sf::Vector2f pos) override;
132 
136  virtual void leftMouseReleased(sf::Vector2f pos) override;
137 
138 
146  virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
147 
148 
150  protected:
151 
161  virtual Signal& getSignal(std::string&& signalName) override;
162 
163 
170  virtual void rendererChanged(const std::string& property) override;
171 
172 
174  // Makes a copy of the widget
176  virtual Widget::Ptr clone() const override
177  {
178  return std::make_shared<Panel>(*this);
179  }
180 
181 
183  public:
184 
185  SignalWrapper<SignalVector2f> onMousePress = {"MousePressed"};
186  SignalWrapper<SignalVector2f> onMouseRelease = {"MouseReleased"};
187  SignalWrapper<SignalVector2f> onClick = {"Clicked"};
188 
189 
191  private:
192 
193  // Cached renderer properties
194  Borders m_bordersCached;
195  Color m_borderColorCached;
196  Color m_backgroundColorCached;
197 
198 
200  };
201 
203 }
204 
206 
207 #endif // TGUI_PANEL_HPP
Namespace that contains all TGUI functions and classes.
Definition: Animation.hpp:33
Wrapper for colors.
Definition: Color.hpp:46
Class to store the position or size of a widget.
Definition: Layout.hpp:205
Group widget.
Definition: Group.hpp:43
virtual void setSize(const Layout2d &size)
Changes the size of the widget.
Definition: Transformable.hpp:123
Definition: PanelRenderer.hpp:36
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:62
Group of widgets that has a background color and optional borders.
Definition: Panel.hpp:40
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:61
virtual Widget::Ptr clone() const override
Makes a copy of the widget if you don&#39;t know its exact type.
Definition: Panel.hpp:176
Class to create a relative layout without using a string.
Definition: Layout.hpp:189
Definition: Outline.hpp:37
PanelRenderer * getRenderer() const
Returns the renderer, which gives access to functions that determine how the widget is displayed...
Definition: Panel.hpp:85
std::shared_ptr< const Panel > ConstPtr
Shared constant widget pointer.
Definition: Panel.hpp:45
std::shared_ptr< Panel > Ptr
Shared widget pointer.
Definition: Panel.hpp:44