TGUI  1.0-beta
Loading...
Searching...
No Matches
TabContainer.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_TAB_CONTAINER_HPP
27#define TGUI_TAB_CONTAINER_HPP
28
29
30#include <TGUI/SubwidgetContainer.hpp>
31#include <TGUI/Widgets/Tabs.hpp>
32#include <TGUI/Widgets/Panel.hpp>
33
35
36namespace tgui
37{
44 class TGUI_API TabContainer : public SubwidgetContainer
45 {
46 public:
47
48 using Ptr = std::shared_ptr<TabContainer>;
49 using ConstPtr = std::shared_ptr<const TabContainer>;
50
51 static constexpr const char StaticWidgetType[] = "TabContainer";
52
53
58 {
59 Top = 0,
60 Bottom = 1 << 0
61 };
62
63
71 TabContainer(const char* typeName = StaticWidgetType, bool initRenderer = true);
72
73
79 static TabContainer::Ptr create(const Layout2d& size = { "100%", "100%" });
80
81
89 static TabContainer::Ptr copy(const TabContainer::ConstPtr& tabContainer);
90
91
97 const TabsRenderer* getTabsSharedRenderer() const;
98
105 const TabsRenderer* getTabsRenderer() const;
106
107
113 void setSize(const Layout2d& size) override;
114 using SubwidgetContainer::setSize;
115
116
122 void setTabsHeight(const Layout& height);
123
124
133 Panel::Ptr addTab(const String& name, bool select = true);
134
135
145 Panel::Ptr insertTab(std::size_t index, const String& name, bool select = true);
146
147
157 bool removeTab(const String& text);
158
159
169 bool removeTab(std::size_t index);
170
171
177 void select(std::size_t index);
178
179
185 std::size_t getPanelCount() const;
186
187
194 int getIndex(const Panel::Ptr& ptr);
195
196
203
204
210 int getSelectedIndex() const;
211
212
220
221
228
229
236 String getTabText(std::size_t index) const;
237
238
247 bool changeTabText(std::size_t index, const String& text);
248
249
259
260
267
268
278 void setTabFixedSize(float fixedSize);
279
280
286 float getTabFixedSize() const;
287
288
290 protected:
291
295 Widget::Ptr clone() const override;
296
297
301 std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
302
303
307 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
308
309
311 private:
312
313 void init(); // Helper function that initializes the widget when constructing a new widget or loading one from a file
314
315 void layoutTabs(); // Helper function that sets position and size of the tabs according to the tab alignment
316
317 void layoutPanel(const Panel::Ptr& panel); // Helper function that sets position of a panel according to the tab alignment
318
319
321 public:
322
324 SignalInt onSelectionChanged = { "SelectionChanged" };
325
328 SignalTyped2<int, bool*> onSelectionChanging = { "SelectionChanging" };
329
330
332 private:
333
334 std::vector<Panel::Ptr> m_panels; // Stores the tab panels.
335
336 Panel::Ptr m_selectedPanel = nullptr; // Stores the panel belonging to the selected tab
337
338 Tabs::Ptr m_tabs = Tabs::create(); // Stores the tabs.
339
340 TabContainer::TabAlign m_tabAlign = TabContainer::TabAlign::Top; // Stores the tab alignment.
341
342 float m_tabFixedSize = 0.0f; // Stores the tab fixed size for fixed size alignment, default is 0.0f.
343 };
344
346}
347
349
350#endif // TGUI_TAB_CONTAINER_HPP
Class to store the position or size of a widget.
Definition: Layout.hpp:284
Class to store the left, top, width or height of a widget.
Definition: Layout.hpp:50
std::shared_ptr< Panel > Ptr
Shared widget pointer.
Definition: Panel.hpp:44
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:371
Wrapper class to store strings.
Definition: String.hpp:79
Base class for widgets that consist of subwidgets that act together as if they are a single widget.
Definition: SubwidgetContainer.hpp:43
TabContainer widget.
Definition: TabContainer.hpp:45
std::shared_ptr< TabContainer > Ptr
Shared widget pointer.
Definition: TabContainer.hpp:48
bool changeTabText(std::size_t index, const String &text)
Changes the text of one of the tabs.
Panel::Ptr getPanel(int index)
Returns the panel with given index.
int getSelectedIndex() const
Returns index of the selected panel.
TabsRenderer * getTabsRenderer()
Returns the renderer of tabs part of widget.
Tabs::Ptr getTabs()
Returns internal tabs widget.
bool removeTab(std::size_t index)
Removes a tab and its corresponding panel with a given index.
int getIndex(const Panel::Ptr &ptr)
Returns index of the specified panel.
std::size_t getPanelCount() const
Returns the number of holded panels.
String getTabText(std::size_t index) const
Gets the text of one of the tabs.
static TabContainer::Ptr create(const Layout2d &size={ "100%", "100%" })
Creates a new tab container widget.
TabsRenderer * getTabsSharedRenderer()
Returns the renderer of tabs part of widget.
Panel::Ptr addTab(const String &name, bool select=true)
Adds a new tab and corresponding panel.
void setTabsHeight(const Layout &height)
Changes the height of tabs part of the widget.
std::unique_ptr< DataIO::Node > save(SavingRenderersMap &renderers) const override
Saves the widget as a tree of nodes in order to save it to a file.
static TabContainer::Ptr copy(const TabContainer::ConstPtr &tabContainer)
Makes a copy of another tab container.
Panel::Ptr getSelected()
Returns the selected panel or nullptr.
float getTabFixedSize() const
Returns the tab fixed size for fixed size alignment, default is 0.0f.
Widget::Ptr clone() const override
Makes a copy of the widget.
void setTabFixedSize(float fixedSize)
Changes the tab fixed size for fixed size alignment.
bool removeTab(const String &text)
Removes a tab and its corresponding panel, given the text of the tab.
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
Panel::Ptr insertTab(std::size_t index, const String &name, bool select=true)
Inserts a new tab and panel somewhere between the existing ones.
TabContainer::TabAlign getTabAlignment() const
Returns the alignment of the tabs.
std::shared_ptr< const TabContainer > ConstPtr
Shared constant widget pointer.
Definition: TabContainer.hpp:49
void select(std::size_t index)
Sets selection to panel.
void setSize(const Layout2d &size) override
Changes the size of the tab container.
void setTabAlignment(TabContainer::TabAlign align)
Changes the alignment of the tabs.
TabAlign
Enumeration of the tab alignments for tabs.
Definition: TabContainer.hpp:58
Definition: TabsRenderer.hpp:37
std::shared_ptr< Tabs > Ptr
Shared widget pointer.
Definition: Tabs.hpp:48
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:73
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36