Picture.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_PICTURE_HPP
#define TGUI_PICTURE_HPP
 
#include <TGUI/Widgets/ClickableWidget.hpp>
#include <TGUI/Renderers/PictureRenderer.hpp>

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

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

        TGUI_NODISCARD static Picture::Ptr create();

        TGUI_NODISCARD static Picture::Ptr create(const Texture& texture, bool transparentTexture = false);

        TGUI_NODISCARD static Picture::Ptr copy(const Picture::ConstPtr& picture);

        TGUI_NODISCARD PictureRenderer* getSharedRenderer() override;
        TGUI_NODISCARD const PictureRenderer* getSharedRenderer() const override;

        TGUI_NODISCARD PictureRenderer* getRenderer() override;

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

        TGUI_DEPRECATED("Use setIgnoreMouseEvents instead") void ignoreMouseEvents(bool ignore = true);

        TGUI_DEPRECATED("Use getIgnoreMouseEvents instead") TGUI_NODISCARD bool isIgnoringMouseEvents() const;

        TGUI_NODISCARD bool canGainFocus() const override;

        TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;

        void leftMouseReleased(Vector2f pos) override;

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

    protected:

        TGUI_NODISCARD Signal& getSignal(String signalName) override;

    public:
 
        SignalVector2f onDoubleClick = {"DoubleClicked"};  

    protected:

        void rendererChanged(const String& property) 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;

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

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

    protected:
 
        Sprite  m_sprite;
 
        bool m_ignoringMouseEvents = false; // TGUI_NEXT: Remove this property
 
        // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
        bool m_possibleDoubleClick = false;
    };

}

 
#endif // TGUI_PICTURE_HPP