CanvasBase.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_CANVAS_BASE_HPP
#define TGUI_CANVAS_BASE_HPP
 
#include <TGUI/Widgets/ClickableWidget.hpp>

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

        CanvasBase(const char* typeName, bool initRenderer);

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

        TGUI_DEPRECATED("Use getIgnoreMouseEvents instead") [[nodiscard]] bool isIgnoringMouseEvents() const;

        [[nodiscard]] bool canGainFocus() const override;

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

 
    protected:
        [[nodiscard]] std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;

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

 
    private:
        bool m_ignoringMouseEvents = false; // TGUI_NEXT: Remove this property
    };
} // namespace tgui

 
#endif // TGUI_CANVAS_BASE_HPP