TabContainer.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2026 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/Widgets/Panel.hpp>
#include <TGUI/Widgets/Tabs.hpp>

 
namespace tgui
{
    class TGUI_API TabContainer : public Container
    {
    public:
        using Ptr = std::shared_ptr<TabContainer>;            
        using ConstPtr = std::shared_ptr<const TabContainer>; 
 
        static constexpr char StaticWidgetType[] = "TabContainer"; 

        enum class TabAlign : std::uint8_t
        {
            Top = 0,        
            Bottom = 1 << 0 
        };

        explicit TabContainer(const char* typeName = StaticWidgetType, bool initRenderer = true);

        TabContainer(const TabContainer& other);

        TabContainer(TabContainer&& other) noexcept;

        TabContainer& operator=(const TabContainer& other);

        TabContainer& operator=(TabContainer&& other) noexcept;

        [[nodiscard]] static TabContainer::Ptr create(const Layout2d& size = {"100%", "100%"});

        [[nodiscard]] static TabContainer::Ptr copy(const TabContainer::ConstPtr& tabContainer);

        [[nodiscard]] TabsRenderer* getTabsSharedRenderer();
        [[nodiscard]] const TabsRenderer* getTabsSharedRenderer() const;

        [[nodiscard]] TabsRenderer* getTabsRenderer();

        void setSize(const Layout2d& size) override;
        using Container::setSize;

        void setTabsHeight(const 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);

        void select(std::size_t index);

        [[nodiscard]] std::size_t getPanelCount() const;

        [[nodiscard]] int getIndex(const Panel::Ptr& panel);

        [[nodiscard]] Panel::Ptr getSelected() const;

        [[nodiscard]] int getSelectedIndex() const;

        [[nodiscard]] Panel::Ptr getPanel(int index) const;

        [[nodiscard]] Tabs::Ptr getTabs() const;

        [[nodiscard]] String getTabText(std::size_t index) const;

        bool changeTabText(std::size_t index, const String& text);

        void setTabAlignment(TabAlign align);

        [[nodiscard]] TabAlign getTabAlignment() const;

        void setTabFixedSize(float fixedSize);

        [[nodiscard]] float getTabFixedSize() const;

        [[nodiscard]] bool isMouseOnWidget(Vector2f pos) const override;

 
    protected:
        [[nodiscard]] Signal& getSignal(String signalName) override;

        [[nodiscard]] Widget::Ptr clone() const override;

        [[nodiscard]] std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;

        void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;

 
    private:
        void init(); // Helper function that initializes the widget when constructing a new widget or loading one from a file
 
        void layoutTabs(); // Helper function that sets position and size of the tabs according to the tab alignment
 
        void layoutPanel(const Panel::Ptr& panel); // Helper function that sets position of a panel according to the tab alignment

 
    public:
        SignalInt onSelectionChange = {"SelectionChanged"};

        SignalTyped2<int, bool*> onSelectionChanging = {"SelectionChanging"};

 
    private:
        std::vector<Panel::Ptr> m_panels; // Stores the tab panels.
 
        Panel::Ptr m_selectedPanel = nullptr; // Stores the panel belonging to the selected tab
 
        Tabs::Ptr m_tabs = Tabs::create(); // Stores the tabs.
 
        TabAlign m_tabAlign = TabAlign::Top; // Stores the tab alignment.
 
        float m_tabFixedSize = 0.0f; // Stores the tab fixed size for fixed size alignment, default is 0.0f.
    };
} // namespace tgui
 
#endif // TGUI_TAB_CONTAINER_HPP