SplitContainer.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_SPLIT_CONTAINER_HPP
#define TGUI_SPLIT_CONTAINER_HPP
 
#include <TGUI/Renderers/SplitContainerRenderer.hpp>
#include <TGUI/Widgets/Group.hpp>

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

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

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

        [[nodiscard]] static SplitContainer::Ptr copy(const SplitContainer::ConstPtr& splitContainer);

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

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

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

        void add(const Widget::Ptr& widgetPtr, const String& widgetName = "") override;

        bool setWidgetIndex(const Widget::Ptr& widget, std::size_t index) override;

        void setOrientation(Orientation orientation);

        [[nodiscard]] Orientation getOrientation() const;

        void setMinValidSplitterOffset(AbsoluteOrRelativeValue minOffset);

        [[nodiscard]] float getMinValidSplitterOffset() const;

        void setMaxValidSplitterOffset(AbsoluteOrRelativeValue maxOffset);

        [[nodiscard]] float getMaxValidSplitterOffset() const;

        void setSplitterOffset(AbsoluteOrRelativeValue offset);

        [[nodiscard]] float getSplitterOffset() const;

        void setSplitterWidth(float width);

        [[nodiscard]] float getSplitterWidth() const;

        void setMinimumGrabWidth(float width);

        [[nodiscard]] float getMinimumGrabWidth() const;

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

        bool leftMousePressed(Vector2f pos) override;

        void mouseMoved(Vector2f pos) override;

        void mouseNoLongerOnWidget() override;

        void draw(BackendRenderTarget& target, RenderStates states) const override;

 
    protected:
        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 mouseEnteredWidget() override;

        void mouseLeftWidget() override;

        // Makes a copy of the widget
        [[nodiscard]] Widget::Ptr clone() const override;

        // Updates the splitter offset if it is defined as a relative value, and then calls updateChildren()
        void updateAvailableSize();

        // Updates the position and sizes of the 2 child widgets based on the current splitter offset
        void updateChildren();

        // Returns the area occupied by the splitter, with a marin around it if m_minimumGrabWidth > m_splitterWidth
        [[nodiscard]] FloatRect getSplitterInteractRect() const;

 
    protected:
        Orientation m_orientation = Orientation::Horizontal;
        AbsoluteOrRelativeValue m_splitterMinOffset;
        AbsoluteOrRelativeValue m_splitterMaxOffset = RelativeValue(1);
        AbsoluteOrRelativeValue m_splitterOffset = RelativeValue(0.5f);
        float m_currentSplitterOffset = 0;
        float m_splitterWidth = 3;
        float m_minimumGrabWidth = 5;
 
        bool m_mouseHoverOnSplitter = false;
        bool m_mouseDownOnSplitter = false;
        float m_mouseDownOnSplitterOffset = 0;
        Cursor::Type m_currentSplitContainerMouseCursor = Cursor::Type::Arrow;
 
        // Cached renderer properties
        Color m_splitterColorCached;
        Color m_splitterColorHoverCached;
    };
} // namespace tgui
 
#endif // TGUI_SPLIT_CONTAINER_HPP