ButtonBase.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_BASE_HPP
#define TGUI_BUTTON_BASE_HPP
 
#include <TGUI/Components.hpp>
#include <TGUI/Renderers/ButtonRenderer.hpp>
#include <TGUI/Widgets/ClickableWidget.hpp>

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

        ButtonBase(const char* typeName, bool initRenderer);

        ButtonBase(const ButtonBase& other);

        ButtonBase(ButtonBase&& other) noexcept;

        ButtonBase& operator=(const ButtonBase& other);

        ButtonBase& operator=(ButtonBase&& other) noexcept;

        ~ButtonBase() override;

        [[nodiscard]] ButtonRenderer* getSharedRenderer() override;
        [[nodiscard]] const ButtonRenderer* getSharedRenderer() const override;

        [[nodiscard]] ButtonRenderer* getRenderer() override;

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

        void setEnabled(bool enabled) override;

        virtual void setText(const String& caption);

        [[nodiscard]] const String& getText() const;

        void setTextPosition(Vector2<AbsoluteOrRelativeValue> position, Vector2f origin);

        void setIgnoreKeyEvents(bool ignore);

        [[nodiscard]] bool getIgnoreKeyEvents() const;

        void setFocused(bool focused) override;

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

        bool leftMousePressed(Vector2f pos) override;

        void leftMouseReleased(Vector2f pos) override;

        void leftMouseButtonNoLongerDown() override;

        void draw(BackendRenderTarget& target, RenderStates states) const 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;

        void rendererChanged(const String& property) override;

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

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

        void updateTextSize() override;

        // Updates the state of the button
        void updateState();

        // Called when size of button is updated
        virtual void updateSize();

        // Called whenever the text position might need to be updated
        virtual void updateTextPosition();

        virtual void initComponents();

        void addComponent(const std::shared_ptr<priv::dev::Component>& component);

        [[nodiscard]] std::shared_ptr<priv::dev::Component> getComponent(const String& name);

 
    protected:
        String m_string;
 
        bool m_down = false;
        priv::dev::ComponentState m_state = priv::dev::ComponentState::Normal;
 
        bool m_autoSize = true;
        bool m_updatingTextSize = false; // Internal variable so that updateSize knows that it is called from updateTextSize
        bool m_ignoreKeyEvents = false;  // Whether we ignore space and return key presses or not when the button is focused
 
        Vector2<AbsoluteOrRelativeValue> m_textPosition;
        Vector2f m_textOrigin;
 
        priv::dev::StylePropertyBackground background;
        priv::dev::StylePropertyText text;
 
        std::uint64_t m_textStyleChangedCallbackId = 0;
 
        // These maps must be declared AFTER the style properties
        std::map<String, priv::dev::StylePropertyBase*> m_stylePropertiesNames;
        std::map<String, std::vector<priv::dev::StylePropertyBase*>> m_stylePropertiesGlobalNames;
        std::map<String, std::shared_ptr<priv::dev::Component>> m_namedComponents;
 
        // These components must be declared AFTER the style properties
        std::shared_ptr<priv::dev::BackgroundComponent> m_backgroundComponent;
        std::shared_ptr<priv::dev::TextComponent> m_textComponent;
 
        std::vector<std::shared_ptr<priv::dev::Component>> m_components;
    };

} // namespace tgui

 
#endif // TGUI_BUTTON_BASE_HPP