tabbedarea.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2004 - 2008 Olof Naessén and Per Larsson
// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
 
#ifndef INCLUDE_FIFECHAN_WIDGETS_TABBEDAREA_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_TABBEDAREA_HPP_
 
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>
 
#include "fifechan/actionlistener.hpp"
#include "fifechan/keylistener.hpp"
#include "fifechan/mouselistener.hpp"
#include "fifechan/platform.hpp"
#include "fifechan/widget.hpp"
#include "fifechan/widgets/container.hpp"
 
namespace fcn
{
    class Tab;

    class FIFEGUI_API TabbedArea : public ActionListener, public KeyListener, public MouseListener, public Widget
    {
        friend class Tab;
 
    public:
        TabbedArea();
 
        ~TabbedArea() override;
 
        TabbedArea(TabbedArea const &)            = delete;
        TabbedArea& operator=(TabbedArea const &) = delete;
        TabbedArea(TabbedArea&&)                  = delete;
        TabbedArea& operator=(TabbedArea&&)       = delete;

        void setOpaque(bool opaque);

        bool isOpaque() const;

        virtual void addTab(Tab* tab, Widget* widget);

        virtual void removeTabWithIndex(unsigned int index);

        virtual void removeTab(Tab* tab);

        int getNumberOfTabs() const;

        virtual bool isTabSelected(unsigned int index) const;

        virtual bool isTabSelected(Tab* tab) const;

        virtual void setSelectedTab(unsigned int index);

        virtual void setSelectedTab(Tab* tab);

        virtual int getSelectedTabIndex() const;

        Tab* getSelectedTab() const;
 
        // Inherited from Widget
 
        using Widget::expandContent;
        using Widget::resizeToContent;
 
        void resizeToContent(bool recursion) override;
 
        void expandContent(bool recursion) override;

        void adjustSize() override;
 
        Rectangle getChildrenArea() override;
 
        void draw(Graphics* graphics) override;

        void setWidth(int width);

        void setHeight(int height);

        void setSize(int width, int height);

        void setDimension(Rectangle const & dimension);

        void setBaseColor(Color const & color) override;

        void setBackgroundWidget(Widget* widget);

        Widget* getBackgroundWidget();

        void setLayout(Container::LayoutPolicy policy);

        Container::LayoutPolicy getLayout() const;

        virtual void setUniformSize(bool uniform);

        virtual bool isUniformSize() const;

        virtual void setVerticalSpacing(unsigned int spacing);

        virtual unsigned int getVerticalSpacing() const;

        virtual void setHorizontalSpacing(unsigned int spacing);

        virtual unsigned int getHorizontalSpacing() const;
 
        // Inherited from ActionListener
 
        void action(ActionEvent const & actionEvent) override;
 
        // Inherited from DeathListener

        virtual void death(Event const & event);
 
        // Inherited from KeyListener
 
        void keyPressed(KeyEvent& keyEvent) override;
 
        // Inherited from MouseListener
 
        void mousePressed(MouseEvent& mouseEvent) override;
 
    protected:
        void adjustTabPositions();

        Tab* mSelectedTab{nullptr};

        Container* mTabContainer;

        Container* mWidgetContainer;

        std::vector<std::unique_ptr<Tab>> mTabsToDelete;

        std::vector<std::pair<Tab*, Widget*>> mTabs;

        bool mOpaque{false};
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_TABBEDAREA_HPP_