Button.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_BUTTON_HPP
#define TGUI_BUTTON_HPP
 
#include <TGUI/Widgets/ButtonBase.hpp>

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

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

        [[nodiscard]] static Button::Ptr create(const String& text = "");

        [[nodiscard]] static Button::Ptr copy(const Button::ConstPtr& button);

        bool leftMousePressed(Vector2f pos) override;

        void leftMouseReleased(Vector2f pos) override;

        void leftMouseButtonNoLongerDown() override;

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

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

 
    protected:
        // This function is called when the mouse enters the widget. If requested, a callback will be send.
        void mouseEnteredWidget() override;

        // This function is called when the mouse leaves the widget. If requested, a callback will be send.
        void mouseLeftWidget() override;

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

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

 
    public:
        SignalString onPress = {"Pressed"}; 
    };
} // namespace tgui
 
#endif // TGUI_BUTTON_HPP