TGUI  0.9.1
TabContainer.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_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 
36 namespace 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 tgui::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 
120  void addPanel(tgui::Panel::Ptr ptr, const tgui::String& name, bool select = true);
121 
122 
132  bool insertPanel(tgui::Panel::Ptr ptr, const tgui::String& name, std::size_t index, bool select = true);
133 
134 
141 
142 
149  void select(std::size_t index, bool genEvents = true);
150 
151 
157  std::size_t getPanelCount() const;
158 
159 
167 
168 
175 
176 
182  int getSelectedIndex() const;
183 
184 
192 
193 
200 
201 
208  tgui::String getTabText(std::size_t index) const;
209 
210 
219  bool changeTabText(std::size_t index, const tgui::String& text);
220 
222  protected:
223 
225  // Makes a copy of the widget
227  Widget::Ptr clone() const override
228  {
229  return std::make_shared<TabContainer>(*this);
230  }
231 
232 
236  void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
237 
238 
240  private:
241 
243  // Helper function that initializes the widget when constructing a new widget or loading one from a file
245  void init();
246 
248  public:
249 
251  SignalInt onSelectionChanged = { "SelectionChanged" };
252 
255  SignalTyped2<int, bool*> onSelectionChanging = { "SelectionChanging" };
256 
257 
259  private:
260  std::vector<tgui::Panel::Ptr> m_panels;
261  int m_index = -1;
262 
263  tgui::Tabs::Ptr m_tabs;
264  };
265 
267 }
268 
270 
271 #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
std::shared_ptr< Panel > Ptr
Shared widget pointer.
Definition: Panel.hpp:44
Wrapper class to store strings.
Definition: String.hpp:74
Base class for widgets that consist of subwidgets that act together as if they are a single widget.
Definition: SubwidgetContainer.hpp:43
virtual void setSize(const Layout2d &size)
Changes the size of the widget.
TabContainer widget.
Definition: TabContainer.hpp:45
tgui::Tabs::Ptr getTabs()
Returns internal tabs widget.
std::shared_ptr< const TabContainer > ConstPtr
Shared constant widget pointer.
Definition: TabContainer.hpp:49
int getSelectedIndex() const
Returns index of the selected panel.
void addPanel(tgui::Panel::Ptr ptr, const tgui::String &name, bool select=true)
Adds a new panel.
std::size_t getPanelCount() const
Returns the number of holded panels.
tgui::Panel::Ptr getPanel(int index)
Returns the panel with given index.
tgui::String getTabText(std::size_t index) const
Gets the text of one of the tabs.
static TabContainer::Ptr create(const tgui::Layout2d &size={ "100%", "100%" })
Creates a new tab container widget.
TabsRenderer * getTabsSharedRenderer()
Returns the renderer of tabs part of widget.
int getIndex(tgui::Panel::Ptr ptr)
Returns index of the specified panel.
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
Definition: TabContainer.hpp:227
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
tgui::Panel::Ptr getSelected()
Returns the selected panel or nullptr.
static TabContainer::Ptr copy(TabContainer::ConstPtr tabContainer)
Makes a copy of another tab container.
void setSize(const Layout2d &size) override
Changes the size of the tab container.
bool insertPanel(tgui::Panel::Ptr ptr, const tgui::String &name, std::size_t index, bool select=true)
Adds a new panel.
bool changeTabText(std::size_t index, const tgui::String &text)
Changes the text of one of the tabs.
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.
TabsRenderer * getTabsRenderer()
Returns the renderer of tabs part of widget.
std::shared_ptr< TabContainer > Ptr
Shared widget pointer.
Definition: TabContainer.hpp:48
void removePanel(tgui::Panel::Ptr ptr)
Remove panel specified by pointer.
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