SubwidgetContainer.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_SUBWIDGET_CONTAINER_HPP
#define TGUI_SUBWIDGET_CONTAINER_HPP
 
#include <TGUI/CopiedSharedPtr.hpp>
#include <TGUI/Widgets/Group.hpp>

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

        SubwidgetContainer(const char* typeName, bool initRenderer);

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

        void setFocused(bool focused) override;

        void setEnabled(bool enabled) override;

        [[nodiscard]] Container* getContainer();

        [[nodiscard]] const Container* getContainer() const;

        bool leftMousePressed(Vector2f pos) override;

        void leftMouseReleased(Vector2f pos) override;

        void rightMousePressed(Vector2f pos) override;

        void rightMouseReleased(Vector2f pos) override;

        void mouseMoved(Vector2f pos) override;

        void keyPressed(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.
        [[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;

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

        void setParent(Container* parent) 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 updateTextSize() override;

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

 
    protected:
        CopiedSharedPtr<Group> m_container;
    };
} // namespace tgui
 
#endif // TGUI_SUBWIDGET_CONTAINER_HPP