Container.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 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_CONTAINER_HPP
#define TGUI_CONTAINER_HPP
 
#include <TGUI/Widget.hpp>
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
    #include <list>
#endif

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

        Container(const char* typeName, bool initRenderer);

        Container(const Container& copy);

        Container(Container&& copy) noexcept;

        ~Container() override;

        Container& operator= (const Container& right);

        Container& operator= (Container&& right) noexcept;

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

        TGUI_NODISCARD const std::vector<Widget::Ptr>& getWidgets() const
        {
            return m_widgets;
        }

        template<typename Function>
        void sortWidgets(Function&& function)
        {
            std::sort(m_widgets.begin(), m_widgets.end(), std::forward<Function>(function));
        }

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

        TGUI_NODISCARD Widget::Ptr get(const String& widgetName) const;

        template <class WidgetType>
        TGUI_NODISCARD typename WidgetType::Ptr get(const String& widgetName) const
        {
            return std::dynamic_pointer_cast<WidgetType>(get(widgetName));
        }

        virtual bool remove(const Widget::Ptr& widget);

        virtual void removeAllWidgets();

        TGUI_NODISCARD virtual Vector2f getInnerSize() const;

        TGUI_NODISCARD virtual Vector2f getChildWidgetsOffset() const
        {
            return Vector2f{0, 0};
        }

        void loadWidgetsFromFile(const String& filename, bool replaceExisting = true);

        void saveWidgetsToFile(const String& filename);

        void loadWidgetsFromStream(std::stringstream& stream, bool replaceExisting = true);

        void loadWidgetsFromStream(std::stringstream&& stream, bool replaceExisting = true);

        void saveWidgetsToStream(std::stringstream& stream, const String& rootDirectory = "") const;

        void loadWidgetsFromNodeTree(const std::unique_ptr<DataIO::Node>& rootNode, bool replaceExisting = true);

        TGUI_NODISCARD std::unique_ptr<DataIO::Node> saveWidgetsToNodeTree(const String& rootDirectory = "") const;

        void moveWidgetToFront(const Widget::Ptr& widget);

        void moveWidgetToBack(const Widget::Ptr& widget);

        std::size_t moveWidgetForward(const Widget::Ptr& widget);

        std::size_t moveWidgetBackward(const Widget::Ptr& widget);

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

        TGUI_NODISCARD int getWidgetIndex(const Widget::Ptr& widget) const;

        TGUI_NODISCARD Widget::Ptr getFocusedChild() const;

        TGUI_NODISCARD Widget::Ptr getFocusedLeaf() const;
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use getWidgetAtPos instead") TGUI_NODISCARD virtual Widget::Ptr getWidgetAtPosition(Vector2f pos) const;
#endif
        TGUI_NODISCARD virtual Widget::Ptr getWidgetAtPos(Vector2f pos, bool recursive) const;

        bool focusNextWidget(bool recursive = true);

        bool focusPreviousWidget(bool recursive = true);

        void setFocused(bool focused) override;

        bool processMouseMoveEvent(Vector2f pos);

        bool processMousePressEvent(Event::MouseButton button, Vector2f pos);

        bool processMouseReleaseEvent(Event::MouseButton button, Vector2f pos);

        bool processScrollEvent(float delta, Vector2f pos, bool touch);

        bool processKeyPressEvent(Event::KeyEvent event);

        bool processTextEnteredEvent(char32_t key);

        void childWidgetFocused(const Widget::Ptr& child);

        bool leftMousePressed(Vector2f pos) override;

        void rightMousePressed(Vector2f pos) override;

        void leftMouseReleased(Vector2f pos) override;

        void rightMouseReleased(Vector2f pos) override;

        void mouseMoved(Vector2f pos) override;

        void keyPressed(const Event::KeyEvent& event) override;

        bool canHandleKeyPress(const Event::KeyEvent& event) override;

        void textEntered(char32_t key) override;

        bool scrolled(float delta, Vector2f pos, bool touch) override;

        void mouseNoLongerOnWidget() override;

        void leftMouseButtonNoLongerDown() override;

        void rightMouseButtonNoLongerDown() override;

        // Shows the tool tip when the widget is located below the mouse.
        // Returns its tool tip or the tool tip from a child widget if the mouse is on top of the widget.
        // A nullptr is returned when the mouse is not on top of the widget or when the tool tip is empty.
        TGUI_NODISCARD Widget::Ptr askToolTip(Vector2f mousePos) override;

        // This function is called every frame with the time passed since the last frame.
        bool updateTime(Duration elapsedTime) override;

        void setParent(Container* parent) override;

        void setParentGui(BackendGui* gui);

        void updateChildrenWithAutoLayout();

    protected:

        void rendererChanged(const String& property) override;

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

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

        // Checks above which widget the mouse is standing.
        // If there is no widget below the mouse then this function will return a null pointer.
        TGUI_NODISCARD Widget::Ptr getWidgetBelowMouse(Vector2f mousePos) const;

        // Checks which widget is below the mouse and updates the cached value.
        // Note that a nullptr is stored and returned if the widget that is found by getWidgetBelowMouse is disabled.
        Widget::Ptr updateWidgetBelowMouse(Vector2f mousePos);

        // Find out what the index of the focused widget is. Returns 0 when no widget is focused and index+1 otherwise.
        TGUI_NODISCARD std::size_t getFocusedWidgetIndex() const;

        // Try to focus the given child widget
        bool tryFocusWidget(const Widget::Ptr &widget, bool reverseWidgetOrder, bool recursive);

        // Transform the mouse position for the child widget based its origin, rotation and scaling.
        TGUI_NODISCARD Vector2f transformMousePos(const Widget::Ptr& widget, Vector2f mousePos) const;

        // Finishes adding a widget to the container
        void widgetAdded(const Widget::Ptr& widgetPtr);

        // Turns texture and font filenames into paths relative to the form file
        void injectFormFilePath(const std::unique_ptr<DataIO::Node>& node, const String& path, std::map<String, bool>& checkedFilenames) const;

        // Mutual code in loadWidgetsFromFile and loadWidgetsFromStream
        void loadWidgetsImpl(const std::unique_ptr<DataIO::Node>& rootNode, bool replaceExisting);

    protected:
 
        std::vector<Widget::Ptr> m_widgets;
 
        Widget::Ptr m_widgetBelowMouse;
        Widget::Ptr m_widgetWithLeftMouseDown;
        Widget::Ptr m_widgetWithRightMouseDown;
        Widget::Ptr m_focusedWidget;
        bool m_draggingWidget = false;
 
        Vector2f m_prevInnerSize;
 
        // Does focusing the next widget always keep a widget from this container focused (e.g. in a ChildWindow)?
        bool m_isolatedFocus = false;
 
        friend class SubwidgetContainer; // Needs access to save and load functions

    };

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

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

        void setFocused(bool focused) override;

        TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;

        void mouseNoLongerOnWidget() override;

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

    private:

        // Returns a nullptr.
        Widget::Ptr clone() const override
        {
            return nullptr;
        }

    };

}

 
#endif // TGUI_CONTAINER_HPP