ClickableWidget.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_CLICKABLE_WIDGET_HPP
#define TGUI_CLICKABLE_WIDGET_HPP
 
#include <TGUI/Widget.hpp>

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

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

        [[nodiscard]] static ClickableWidget::Ptr create(const Layout2d& size = {"100%", "100%"});

        [[nodiscard]] static ClickableWidget::Ptr copy(const ClickableWidget::ConstPtr& widget);

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

        bool leftMousePressed(Vector2f pos) override;

        void leftMouseReleased(Vector2f pos) override;

        void rightMousePressed(Vector2f pos) override;

        void rightMouseReleased(Vector2f pos) override;

        void rightMouseButtonNoLongerDown() override;

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

 
    protected:
        [[nodiscard]] Signal& getSignal(String signalName) override;

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

 
    public:
        SignalVector2f onMousePress = {
            "MousePressed"}; 
        SignalVector2f onMouseRelease = {
            "MouseReleased"}; 
        SignalVector2f onClick = {"Clicked"}; 
 
        SignalVector2f onRightMousePress = {
            "RightMousePressed"}; 
        SignalVector2f onRightMouseRelease = {
            "RightMouseReleased"}; 
        SignalVector2f onRightClick = {"RightClicked"}; 

 
    private:
        bool m_rightMouseDown = false;
    };
} // namespace tgui
 
#endif // TGUI_CLICKABLE_WIDGET_HPP