TabContainer.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2022 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
 
#ifndef TGUI_TAB_CONTAINER_HPP
#define TGUI_TAB_CONTAINER_HPP
 
 
#include <TGUI/SubwidgetContainer.hpp>
#include <TGUI/Widgets/Tabs.hpp>
#include <TGUI/Widgets/Panel.hpp>
 
 
namespace tgui
{
    class TGUI_API TabContainer : public SubwidgetContainer
    {
    public:
 
        typedef std::shared_ptr<TabContainer> Ptr; 
        typedef std::shared_ptr<const TabContainer> ConstPtr; 
 
 
        TabContainer(const char* typeName = "TabContainer", bool initRenderer = true);
 
 
        static TabContainer::Ptr create(const Layout2d& size = { "100%", "100%" });
 
 
        static TabContainer::Ptr copy(TabContainer::ConstPtr tabContainer);
 
 
        TabsRenderer* getTabsSharedRenderer();
        const TabsRenderer* getTabsSharedRenderer() const;
 
        TabsRenderer* getTabsRenderer();
        const TabsRenderer* getTabsRenderer() const;
 
 
        void setSize(const Layout2d& size) override;
        using SubwidgetContainer::setSize;
 
 
        void setTabsHeight(Layout height);
 
 
        Panel::Ptr addTab(const String& name, bool select = true);
 
 
        Panel::Ptr insertTab(std::size_t index, const String& name, bool select = true);
 
 
        bool removeTab(const String& text);
 
 
        bool removeTab(std::size_t index);
 
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use addTab instead") void addPanel(Panel::Ptr ptr, const String& name, bool select = true);
 
 
        TGUI_DEPRECATED("Use insertTab instead") bool insertPanel(Panel::Ptr ptr, const String& name, std::size_t index, bool select = true);
 
 
        TGUI_DEPRECATED("Use removeTab instead") void removePanel(Panel::Ptr ptr);
#endif
 
        void select(std::size_t index, bool genEvents = true);
 
 
        std::size_t getPanelCount() const;
 
 
        int getIndex(Panel::Ptr ptr);
 
 
        Panel::Ptr getSelected();
 
 
        int getSelectedIndex() const;
 
 
        Panel::Ptr getPanel(int index);
 
 
        Tabs::Ptr getTabs();
 
 
        String getTabText(std::size_t index) const;
 
 
        bool changeTabText(std::size_t index, const String& text);
 
 
    protected:
 
        // Makes a copy of the widget
        Widget::Ptr clone() const override
        {
            return std::make_shared<TabContainer>(*this);
        }
 
 
        void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
 
    private:
 
        // Helper function that initializes the widget when constructing a new widget or loading one from a file
        void init();
 
    public:
 
        SignalInt onSelectionChanged = { "SelectionChanged" };
 
        SignalTyped2<int, bool*> onSelectionChanging = { "SelectionChanging" };
 
 
    private:
        std::vector<Panel::Ptr> m_panels;
        int m_index = -1;
 
        Tabs::Ptr m_tabs;
    };
 
}
 
 
#endif // TGUI_TAB_CONTAINER_HPP