TabsBase.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_TABS_BASE_HPP
#define TGUI_TABS_BASE_HPP
 
#include <TGUI/Renderers/TabsRenderer.hpp>
#include <TGUI/Text.hpp>
#include <TGUI/Widget.hpp>

 
namespace tgui
{
    class TGUI_API TabsBase : public Widget
    {
    public:
        using Ptr = std::shared_ptr<TabsBase>;            
        using ConstPtr = std::shared_ptr<const TabsBase>; 

        explicit TabsBase(const char* typeName, bool initRenderer);

        [[nodiscard]] TabsRenderer* getSharedRenderer() override;
        [[nodiscard]] const TabsRenderer* getSharedRenderer() const override;

        [[nodiscard]] TabsRenderer* getRenderer() override;

        void setEnabled(bool enabled) override;

        std::size_t add(const String& text, bool select = true);

        void insert(std::size_t index, const String& text, bool select = true);

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

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

        bool changeTextById(const String& id, const String& text);

        void setTabId(std::size_t index, const String& id);

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

        [[nodiscard]] int getIndexById(const String& id) const;

        bool select(const String& text);

        bool select(std::size_t index);

        bool selectById(const String& id);

        void deselect();

        bool remove(const String& text);

        bool remove(std::size_t index);

        bool removeById(const String& id);

        void removeAll();

        [[nodiscard]] String getSelected() const;

        [[nodiscard]] int getSelectedIndex() const;

        [[nodiscard]] String getSelectedId() const;

        [[nodiscard]] int getHoveredIndex() const;

        void setTabVisible(std::size_t index, bool visible);

        [[nodiscard]] bool getTabVisible(std::size_t index) const;

        void setTabEnabled(std::size_t index, bool enabled);

        [[nodiscard]] bool getTabEnabled(std::size_t index) const;

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

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

        void rightMousePressed(Vector2f pos) override;

        void mouseNoLongerOnWidget() override;

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

        // Recalculates the size of each tab image.
        virtual void recalculateTabsSize() = 0;

        // Update the colors of the text that is drawn on the tabs
        void updateTextColors();

        void rendererChanged(const String& property) 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;

        void updateTextSize() override;

 
    public:
        SignalString onTabSelect = {"TabSelected"};         
        SignalString onTabRightClick = {"TabRightClicked"}; 

 
    protected:
        int m_selectedTab = -1;
        int m_hoveringTab = -1;
 
        struct Tab
        {
            bool visible;
            bool enabled;
            float width;
            Text text;
            String id;
        };
        std::vector<Tab> m_tabs;
 
        Sprite m_spriteTab;
        Sprite m_spriteTabHover;
        Sprite m_spriteSelectedTab;
        Sprite m_spriteSelectedTabHover;
        Sprite m_spriteDisabledTab;
 
        // Cached renderer properties
        Borders m_bordersCached;
        Color m_borderColorCached;
        Color m_borderColorHoverCached;
        Color m_selectedBorderColorCached;
        Color m_selectedBorderColorHoverCached;
        Color m_backgroundColorCached;
        Color m_backgroundColorHoverCached;
        Color m_backgroundColorDisabledCached;
        Color m_selectedBackgroundColorCached;
        Color m_selectedBackgroundColorHoverCached;
        Color m_textColorCached;
        Color m_textColorHoverCached;
        Color m_textColorDisabledCached;
        Color m_selectedTextColorCached;
        Color m_selectedTextColorHoverCached;
        float m_distanceToSideCached = 0;
        float m_roundedBorderRadiusCached = 0;

    };

} // namespace tgui

 
#endif // TGUI_TABS_BASE_HPP