container.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_CONTAINER_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_CONTAINER_HPP_
 
#include <list>
#include <memory>
#include <string>
 
#include "fifechan/containerlistener.hpp"
#include "fifechan/graphics.hpp"
#include "fifechan/platform.hpp"
#include "fifechan/widget.hpp"
 
namespace fcn
{
    class FIFEGUI_API Container : public Widget
    {
    public:
        enum class LayoutPolicy : uint8_t
        {
            Absolute,
            AutoSize,
            Vertical,
            Horizontal,
            Circular
        };

        Container();
 
        ~Container() override;
 
        Container(Container const &)            = delete;
        Container& operator=(Container const &) = delete;
        Container(Container&&)                  = delete;
        Container& operator=(Container&&)       = delete;

        virtual void setOpaque(bool opaque);

        virtual bool isOpaque() const;

        virtual void add(Widget* widget);

        virtual void addWidget(std::unique_ptr<Widget> widget);

        virtual void add(Widget* widget, int x, int y);

        virtual void addWidget(std::unique_ptr<Widget> widget, int x, int y);

        void remove(Widget* widget) override;

        void removeAllChildren() override;

        Widget* findWidgetById(std::string const & id) override;

        void addContainerListener(ContainerListener* containerListener);

        void removeContainerListener(ContainerListener* containerListener);

        Widget* getChild(unsigned int index) const;
 
        // Inherited from Widget
 
        using Widget::expandContent;
        using Widget::resizeToContent;

        void resizeToContent(bool recursion) override;

        void adjustSize() override;

        void expandContent(bool recursion) override;
        void draw(Graphics* graphics) override;
        Rectangle getChildrenArea() override;
        bool isLayouted() override
        {
            return mLayout != LayoutPolicy::Absolute;
        };

        virtual void setLayout(LayoutPolicy policy);

        virtual 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;

        void setBackgroundWidget(Widget* widget);

        Widget* getBackgroundWidget();
 
    protected:
        void distributeWidgetAddedEvent(Widget* source);

        void distributeWidgetRemovedEvent(Widget* source);

        bool mOpaque{true};

        using ContainerListenerList = std::list<ContainerListener*>;

        ContainerListenerList mContainerListeners;

        using ContainerListenerIterator = ContainerListenerList::iterator;

        LayoutPolicy mLayout{LayoutPolicy::Absolute};

        bool mUniform{false};

        unsigned int mVerticalSpacing{2};

        unsigned int mHorizontalSpacing{2};

        Widget* mBackgroundWidget{nullptr};
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_CONTAINER_HPP_