Widget.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_WIDGET_HPP
#define TGUI_WIDGET_HPP

 
#include <TGUI/Signal.hpp>
#include <TGUI/Font.hpp>
#include <TGUI/Sprite.hpp>
#include <TGUI/Layout.hpp>
#include <TGUI/String.hpp>
#include <TGUI/Vector2.hpp>
#include <TGUI/Duration.hpp>
#include <TGUI/CopiedPtr.hpp>
#include <TGUI/Cursor.hpp>
#include <TGUI/Event.hpp>
#include <TGUI/Any.hpp>
#include <TGUI/Backend/Renderer/BackendRenderTarget.hpp>
#include <TGUI/Loading/Theme.hpp>
#include <TGUI/Loading/DataIO.hpp>
#include <TGUI/Loading/Serializer.hpp>
#include <TGUI/Loading/Deserializer.hpp>
#include <TGUI/Renderers/WidgetRenderer.hpp>
 
#include <unordered_set>

 
// We used to rely on Aurora (https://bromeon.ch/libraries/aurora/index.html) for some functionality.
// For backwards compatibility the replacement functions are still placed in the aurora namespace.
// TGUI_NEXT: Remove this namespace and the include files in the extlibs folder.
namespace aurora
{
    using tgui::CopiedPtr;
    using tgui::makeCopied;
    using tgui::downcast;
}
 
namespace tgui
{
    class BackendGui;
    class Container;
 
    enum class ShowEffectType;
}
 
namespace tgui
{
    namespace priv
    {
        class Animation;
    }
}
 
namespace tgui
{
    class TGUI_API Widget : public std::enable_shared_from_this<Widget>
    {
    public:
 
        using Ptr = std::shared_ptr<Widget>; 
        using ConstPtr = std::shared_ptr<const Widget>; 

        /// @internal
        /// @brief Constructor
        /// @param typeName     Type of the widget
        /// @param initRenderer Should the renderer be initialized? Should be true unless a derived class initializes it.
        /// @see create
        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        Widget(const char* typeName, bool initRenderer);

        Widget(const Widget&);

        Widget(Widget&&) noexcept;

        virtual ~Widget();

        Widget& operator=(const Widget&);

        Widget& operator=(Widget&&) noexcept;

        void setRenderer(std::shared_ptr<RendererData> rendererData);

        TGUI_NODISCARD virtual WidgetRenderer* getSharedRenderer();
        TGUI_NODISCARD virtual const WidgetRenderer* getSharedRenderer() const;

        TGUI_NODISCARD virtual WidgetRenderer* getRenderer();

        virtual void setPosition(const Layout2d& position);

        void setPosition(Layout x, Layout y)
        {
            setPosition({std::move(x), std::move(y)});
        }

        TGUI_NODISCARD Vector2f getPosition() const
        {
            return m_position.getValue();
        }

        virtual void setSize(const Layout2d& size);

        void setSize(Layout width, Layout height)
        {
            setSize({std::move(width), std::move(height)});
        }

        void setWidth(Layout width)
        {
            setSize({std::move(width), m_size.y});
        }

        void setHeight(Layout height)
        {
            setSize({m_size.x, std::move(height)});
        }

        TGUI_NODISCARD Vector2f getSize() const
        {
            return m_size.getValue();
        }

        TGUI_NODISCARD virtual Vector2f getFullSize() const;

        TGUI_NODISCARD virtual Vector2f getAbsolutePosition(Vector2f offset = {}) const;

        TGUI_NODISCARD virtual Vector2f getWidgetOffset() const;

        void setAutoLayout(AutoLayout layout);

        TGUI_NODISCARD AutoLayout getAutoLayout() const;

        void setOrigin(float x, float y)
        {
            setOrigin({x, y});
        }

        void setOrigin(Vector2f origin);

        TGUI_NODISCARD Vector2f getOrigin() const
        {
            return m_origin;
        }

        void setScale(Vector2f scaleFactors);

        void setScale(Vector2f scaleFactors, Vector2f origin);

        void setScale(float scaleFactor)
        {
            setScale({scaleFactor, scaleFactor});
        }

        void setScale(float scaleFactor, Vector2f origin)
        {
            setScale({scaleFactor, scaleFactor}, origin);
        }

        TGUI_NODISCARD Vector2f getScale() const
        {
            return m_scaleFactors;
        }

        TGUI_NODISCARD Vector2f getScaleOrigin() const;

        void setRotation(float angle);

        void setRotation(float angle, Vector2f origin);

        TGUI_NODISCARD float getRotation() const
        {
            return m_rotationDeg;
        }

        TGUI_NODISCARD Vector2f getRotationOrigin() const;

        void showWithEffect(ShowEffectType type, Duration duration);

        void hideWithEffect(ShowEffectType type, Duration duration);

        void moveWithAnimation(Layout2d position, Duration duration);

        void resizeWithAnimation(Layout2d size, Duration duration);

        virtual void setVisible(bool visible);

        TGUI_NODISCARD bool isVisible() const
        {
            return m_visible;
        }

        virtual void setEnabled(bool enabled);

        TGUI_NODISCARD bool isEnabled() const
        {
            return m_enabled;
        }

        virtual void setFocused(bool focused);

        TGUI_NODISCARD bool isFocused() const
        {
            return m_focused;
        }

        TGUI_NODISCARD const String& getWidgetType() const;

        TGUI_NODISCARD Container* getParent() const
        {
            return m_parent;
        }

        TGUI_NODISCARD BackendGui* getParentGui() const
        {
            return m_parentGui;
        }

        TGUI_NODISCARD bool isAnimationPlaying() const;

        void moveToFront();

        void moveToBack();

        void setUserData(Any userData)
        {
            m_userData = std::move(userData);
        }

        template <typename DataType>
        TGUI_NODISCARD DataType getUserData() const
        {
            return AnyCast<DataType>(m_userData);
        }

        TGUI_NODISCARD bool hasUserData() const
        {
            return m_userData.has_value();
        }

        void setInheritedFont(const Font& font);

        TGUI_NODISCARD const Font& getInheritedFont() const;

        void setInheritedOpacity(float opacity);

        TGUI_NODISCARD float getInheritedOpacity() const;

        void setTextSize(unsigned int size);

        TGUI_NODISCARD unsigned int getTextSize() const;

        void setToolTip(Widget::Ptr toolTip);

        TGUI_NODISCARD Widget::Ptr getToolTip() const;

        void setWidgetName(const String& name);

        TGUI_NODISCARD String getWidgetName() const;

        void setMouseCursor(Cursor::Type cursor);

        TGUI_NODISCARD Cursor::Type getMouseCursor() const;

        void setFocusable(bool focusable);

        TGUI_NODISCARD bool isFocusable() const;

        void setNavigationUp(const Widget::Ptr& widgetAbove);

        TGUI_NODISCARD Widget::Ptr getNavigationUp() const;

        void setNavigationDown(const Widget::Ptr& widgetBelow);

        TGUI_NODISCARD Widget::Ptr getNavigationDown() const;

        void setNavigationLeft(const Widget::Ptr& widgetLeft);

        TGUI_NODISCARD Widget::Ptr getNavigationLeft() const;

        void setNavigationRight(const Widget::Ptr& widgetRight);

        TGUI_NODISCARD Widget::Ptr getNavigationRight() const;

        void setIgnoreMouseEvents(bool ignore);

        TGUI_NODISCARD bool getIgnoreMouseEvents() const;

        void finishAllAnimations();

        TGUI_NODISCARD virtual bool canGainFocus() const;

        TGUI_NODISCARD bool isContainer() const;

        TGUI_NODISCARD bool isMouseDown() const;

        TGUI_NODISCARD virtual Signal& getSignal(String signalName);

        virtual void setParent(Container* parent);

        virtual bool updateTime(Duration elapsedTime);

        void setAutoLayoutUpdateEnabled(bool enabled);

        TGUI_NODISCARD virtual bool isMouseOnWidget(Vector2f pos) const = 0;

        virtual bool leftMousePressed(Vector2f pos);

        virtual void leftMouseReleased(Vector2f pos);

        virtual void rightMousePressed(Vector2f pos);

        virtual void rightMouseReleased(Vector2f pos);

        virtual void mouseReleased(Event::MouseButton button, Vector2f pos);

        virtual void mouseMoved(Vector2f pos);

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

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

        virtual void textEntered(char32_t key);

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

        virtual void mouseNoLongerOnWidget();

        virtual void leftMouseButtonNoLongerDown();

        virtual void rightMouseButtonNoLongerDown();

        // Show 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 virtual Widget::Ptr askToolTip(Vector2f mousePos);

        TGUI_NODISCARD const Layout2d& getPositionLayout() const
        {
            return m_position;
        }

        TGUI_NODISCARD const Layout2d& getSizeLayout() const
        {
            return m_size;
        }

        void bindPositionLayout(Layout* layout);

        void unbindPositionLayout(Layout* layout);

        void bindSizeLayout(Layout* layout);

        void unbindSizeLayout(Layout* layout);

        virtual void draw(BackendRenderTarget& target, RenderStates states) const = 0;

        template <typename WidgetType>
        TGUI_NODISCARD std::shared_ptr<const WidgetType> cast() const
        {
            return std::dynamic_pointer_cast<const WidgetType>(shared_from_this());
        }

        template <typename WidgetType>
        TGUI_NODISCARD std::shared_ptr<WidgetType> cast()
        {
            return std::dynamic_pointer_cast<WidgetType>(shared_from_this());
        }

        TGUI_NODISCARD virtual Widget::Ptr clone() const = 0;

        void rendererChangedCallback(const String& property);

        virtual void updateTextSize();

    protected:
 
        using SavingRenderersMap = std::map<const Widget*, std::pair<std::unique_ptr<DataIO::Node>, String>>;
        using LoadingRenderersMap = std::map<String, std::shared_ptr<RendererData>>;

        virtual void rendererChanged(const String& property);

        TGUI_NODISCARD virtual std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const;

        virtual void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers);

        virtual void mouseEnteredWidget();

        virtual void mouseLeftWidget();

        void recalculateBoundPositionLayouts();

        void recalculateBoundSizeLayouts();

    public:
 
        SignalVector2f      onPositionChange   = {"PositionChanged"};         
        SignalVector2f      onSizeChange       = {"SizeChanged"};             
        Signal              onFocus            = {"Focused"};                 
        Signal              onUnfocus          = {"Unfocused"};               
        Signal              onMouseEnter       = {"MouseEntered"};            
        Signal              onMouseLeave       = {"MouseLeft"};               
        SignalShowEffect    onShowEffectFinish = {"ShowEffectFinished"};      

        SignalAnimationType onAnimationFinish  = {"AnimationFinished"};

    protected:
 
        String m_type;
        String m_name;

        Layout2d m_position;

        Layout2d m_size;
        unsigned int m_textSize = 0; // This may be overwritten by the renderer, m_textSizeCached contains the actual text size
 
        Vector2f m_origin;
        Optional<Vector2f> m_rotationOrigin;
        Optional<Vector2f> m_scaleOrigin;
        Vector2f m_scaleFactors = {1, 1};
        float m_rotationDeg = 0;
 
        // The previous position and size have to be stored because when setPosition/setSize is called, the layout may already be
        // changed and there would be no way for the widget to detect whether the values changed or not.
        Vector2f m_prevPosition;
        Vector2f m_prevSize;
 
        // Layouts that need to recalculate their value when the position or size of this widget changes
        std::unordered_set<Layout*> m_boundPositionLayouts;
        std::unordered_set<Layout*> m_boundSizeLayouts;

        bool m_enabled = true;

        bool m_visible = true;
 
        // This will point to our parent widget. If there is no parent then this will be nullptr.
        Container* m_parent = nullptr;
        BackendGui* m_parentGui = nullptr;
 
        // Is the mouse on top of the widget? Did the mouse go down on the widget?
        bool m_mouseHover = false;
        bool m_mouseDown = false;
 
        // Is the widget focused?
        bool m_focused = false;
 
        // Can the widget be focused?
        bool m_focusable = true;
 
        // Widgets that can be navigated to from this widgets with the arrow keys
        std::weak_ptr<Widget> m_navWidgetUp;
        std::weak_ptr<Widget> m_navWidgetDown;
        std::weak_ptr<Widget> m_navWidgetRight;
        std::weak_ptr<Widget> m_navWidgetLeft;
 
        // Keep track of the elapsed time.
        Duration m_animationTimeElapsed;
 
        // This is set to true for widgets that store other widgets inside them
        bool m_containerWidget = false;
 
        // The tool tip connected to the widget
        Widget::Ptr m_toolTip = nullptr;
 
        // Renderer of the widget
        CopiedPtr<WidgetRenderer> m_renderer = nullptr;
 
        // Show animations
        std::vector<std::unique_ptr<priv::Animation>> m_showAnimations;
 
        // Renderer properties that can be passed from containers to their children
        Font m_inheritedFont;
        float m_inheritedOpacity = 1;
 
        Any m_userData;
        Cursor::Type m_mouseCursor = Cursor::Type::Arrow;
        AutoLayout m_autoLayout = AutoLayout::Manual;
        bool m_autoLayoutUpdateEnabled = true;
        bool m_ignoreMouseEvents = false;
 
        // Cached renderer properties
        Font  m_fontCached = Font::getGlobalFont();
        float m_opacityCached = 1;
        bool m_transparentTextureCached = false;
        unsigned int m_textSizeCached = 0;

 
        friend class Container; // Container accesses save and load functions
    };

}

 
#endif // TGUI_WIDGET_HPP