TGUI  1.2.0
Loading...
Searching...
No Matches
BoxLayout.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_BOX_LAYOUT_HPP
27#define TGUI_BOX_LAYOUT_HPP
28
29#include <TGUI/Widgets/Group.hpp>
30#include <TGUI/Renderers/BoxLayoutRenderer.hpp>
31
33
34TGUI_MODULE_EXPORT namespace tgui
35{
40 class TGUI_API BoxLayout : public Group
41 {
42 public:
43
44 using Ptr = std::shared_ptr<BoxLayout>;
45 using ConstPtr = std::shared_ptr<const BoxLayout>;
46
47
55 BoxLayout(const char* typeName, bool initRenderer);
56
57
62 TGUI_NODISCARD BoxLayoutRenderer* getSharedRenderer() override;
63 TGUI_NODISCARD const BoxLayoutRenderer* getSharedRenderer() const override;
64
70 TGUI_NODISCARD BoxLayoutRenderer* getRenderer() override;
71
72
79 void setSize(const Layout2d& size) override;
80 using Widget::setSize;
81
82
95 void add(const Widget::Ptr& widget, const String& widgetName = "") override;
96
97
113 virtual void insert(std::size_t index, const Widget::Ptr& widget, const String& widgetName = "");
114
115
124 bool remove(const Widget::Ptr& widget) override;
125
126
135 virtual bool remove(std::size_t index);
136
137
146 TGUI_NODISCARD Widget::Ptr get(std::size_t index) const;
147 using Container::get;
148
149
160 virtual bool setWidgetIndex(const Widget::Ptr& widget, std::size_t index) override;
161
162
164 protected:
165
172 void rendererChanged(const String& property) override;
173
174
176 // @brief Repositions and resize the widgets
178 virtual void updateWidgets() = 0;
179
180
182 protected:
183
184 float m_spaceBetweenWidgetsCached = 0;
185
186
188 };
189
190
192}
193
195
196#endif // TGUI_BOX_LAYOUT_HPP
Definition BoxLayoutRenderer.hpp:37
Abstract class for box layout containers.
Definition BoxLayout.hpp:41
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.
virtual bool remove(std::size_t index)
Removes a single widget that was added to the container.
TGUI_NODISCARD Widget::Ptr get(std::size_t index) const
Returns the widget at the given index in the layout.
TGUI_NODISCARD BoxLayoutRenderer * getRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
std::shared_ptr< const BoxLayout > ConstPtr
Shared constant widget pointer.
Definition BoxLayout.hpp:45
std::shared_ptr< BoxLayout > Ptr
Shared widget pointer.
Definition BoxLayout.hpp:44
void setSize(const Layout2d &size) override
Changes the size of the group.
virtual bool setWidgetIndex(const Widget::Ptr &widget, std::size_t index) override
Changes the index of a widget in this container.
TGUI_NODISCARD BoxLayoutRenderer * getSharedRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Group widget.
Definition Group.hpp:44
Class to store the position or size of a widget.
Definition Layout.hpp:305
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