TGUI  0.9.1
BoxLayout.hpp
1 //
3 // TGUI - Texus' Graphical User Interface
4 // Copyright (C) 2012-2021 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_BOX_LAYOUT_HPP
27 #define TGUI_BOX_LAYOUT_HPP
28 
29 #include <TGUI/Widgets/Group.hpp>
30 #include <TGUI/Renderers/BoxLayoutRenderer.hpp>
31 
33 
34 namespace tgui
35 {
40  class TGUI_API BoxLayout : public Group
41  {
42  public:
43 
44  typedef std::shared_ptr<BoxLayout> Ptr;
45  typedef std::shared_ptr<const BoxLayout> ConstPtr;
46 
47 
55  BoxLayout(const char* typeName, bool initRenderer);
56 
57 
63  const BoxLayoutRenderer* getSharedRenderer() const;
64 
71  const BoxLayoutRenderer* getRenderer() const;
72 
73 
80  void setSize(const Layout2d& size) override;
81  using Widget::setSize;
82 
83 
91  void add(const Widget::Ptr& widget, const String& widgetName = "") override;
92 
93 
104  virtual void insert(std::size_t index, const Widget::Ptr& widget, const String& widgetName = "");
105 
106 
115  bool remove(const Widget::Ptr& widget) override;
116 
117 
126  virtual bool remove(std::size_t index);
127 
128 
137  Widget::Ptr get(std::size_t index) const;
138  using Container::get;
139 
140 
142  protected:
143 
150  void rendererChanged(const String& property) override;
151 
152 
154  // @brief Repositions and resize the widgets
156  virtual void updateWidgets() = 0;
157 
158 
160  protected:
161 
162  float m_spaceBetweenWidgetsCached = 0;
163 
164 
166  };
167 
168 
170 }
171 
173 
174 #endif // TGUI_BOX_LAYOUT_HPP
Definition: BoxLayoutRenderer.hpp:37
Abstract class for box layout containers.
Definition: BoxLayout.hpp:41
std::shared_ptr< BoxLayout > Ptr
Shared widget pointer.
Definition: BoxLayout.hpp:44
void add(const Widget::Ptr &widget, const String &widgetName="") override
Adds a widget at the end of the layout.
virtual void insert(std::size_t index, const Widget::Ptr &widget, const String &widgetName="")
Inserts a widget to the layout.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
bool remove(const Widget::Ptr &widget) override
Removes a single widget that was added to the container.
Widget::Ptr get(std::size_t index) const
Returns the widget at the given index in the layout.
virtual bool remove(std::size_t index)
Removes a single widget that was added to the container.
BoxLayoutRenderer * getSharedRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
void setSize(const Layout2d &size) override
Changes the size of the group.
std::shared_ptr< const BoxLayout > ConstPtr
Shared constant widget pointer.
Definition: BoxLayout.hpp:45
BoxLayoutRenderer * getRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Widget::Ptr get(const String &widgetName) const
Returns a pointer to a widget that was added earlier.
Group widget.
Definition: Group.hpp:44
Class to store the position or size of a widget.
Definition: Layout.hpp:262
Wrapper class to store strings.
Definition: String.hpp:74
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