TGUI  0.9-dev
TabContainer.hpp
1
2//
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_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 typedef std::shared_ptr<TabContainer> Ptr;
49 typedef std::shared_ptr<const TabContainer> ConstPtr;
50
51
59 TabContainer(const char* typeName = "TabContainer", bool initRenderer = true);
60
61
67 static TabContainer::Ptr create(const Layout2d& size = { "100%", "100%" });
68
69
78
79
85 const TabsRenderer* getTabsSharedRenderer() const;
86
93 const TabsRenderer* getTabsRenderer() const;
94
95
101 void setSize(const Layout2d& size) override;
103
104
110 void setTabsHeight(Layout height);
111
112
121 Panel::Ptr addTab(const String& name, bool select = true);
122
123
133 Panel::Ptr insertTab(std::size_t index, const String& name, bool select = true);
134
135
145 bool removeTab(const String& text);
146
147
157 bool removeTab(std::size_t index);
158
159
160#ifndef TGUI_REMOVE_DEPRECATED_CODE
168 TGUI_DEPRECATED("Use addTab instead") void addPanel(Panel::Ptr ptr, const String& name, bool select = true);
169
170
180 TGUI_DEPRECATED("Use insertTab instead") bool insertPanel(Panel::Ptr ptr, const String& name, std::size_t index, bool select = true);
181
182
188 TGUI_DEPRECATED("Use removeTab instead") void removePanel(Panel::Ptr ptr);
189#endif
190
197 void select(std::size_t index, bool genEvents = true);
198
199
205 std::size_t getPanelCount() const;
206
207
215
216
223
224
230 int getSelectedIndex() const;
231
232
240
241
248
249
256 String getTabText(std::size_t index) const;
257
258
267 bool changeTabText(std::size_t index, const String& text);
268
269
271 protected:
272
274 // Makes a copy of the widget
276 Widget::Ptr clone() const override
277 {
278 return std::make_shared<TabContainer>(*this);
279 }
280
281
285 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
286
287
289 private:
290
292 // Helper function that initializes the widget when constructing a new widget or loading one from a file
294 void init();
295
297 public:
298
300 SignalInt onSelectionChanged = { "SelectionChanged" };
301
304 SignalTyped2<int, bool*> onSelectionChanging = { "SelectionChanging" };
305
306
308 private:
309 std::vector<Panel::Ptr> m_panels;
310 int m_index = -1;
311
312 Tabs::Ptr m_tabs;
313 };
314
316}
317
319
320#endif // TGUI_TAB_CONTAINER_HPP
Class to store the position or size of a widget.
Definition: Layout.hpp:262
Class to store the left, top, width or height of a widget.
Definition: Layout.hpp:50
Group of widgets that has a background color and optional borders.
Definition: Panel.hpp:41
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
void setSize(const Layout2d &size) override
Changes the size of the widget.
std::shared_ptr< SubwidgetContainer > Ptr
Shared widget pointer.
Definition: SubwidgetContainer.hpp:46
TabContainer widget.
Definition: TabContainer.hpp:45
std::shared_ptr< const TabContainer > ConstPtr
Shared constant widget pointer.
Definition: TabContainer.hpp:49
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.
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.
Panel::Ptr getSelected()
Returns the selected panel or nullptr.
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
Definition: TabContainer.hpp:276
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.
static TabContainer::Ptr copy(TabContainer::ConstPtr tabContainer)
Makes a copy of another tab container.
int getIndex(Panel::Ptr ptr)
Returns index of the specified panel.
void setSize(const Layout2d &size) override
Changes the size of the tab container.
void select(std::size_t index, bool genEvents=true)
Sets selection to panel.
void setTabsHeight(Layout height)
Changes the height of tabs part of the widget.
std::shared_ptr< TabContainer > Ptr
Shared widget pointer.
Definition: TabContainer.hpp:48
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