BitmapButton.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_BITMAP_BUTTON_HPP
#define TGUI_BITMAP_BUTTON_HPP
 
#include <TGUI/Widgets/Button.hpp>

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

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

        BitmapButton(const BitmapButton& other);

        BitmapButton(BitmapButton&& other) noexcept;

        BitmapButton& operator=(const BitmapButton& other);

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

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

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

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

        void setImage(const Texture& image);

        [[nodiscard]] const Texture& getImage() const;

        void setImageScaling(float relativeHeight);

        [[nodiscard]] float getImageScaling() const;

 
    protected:
        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;

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

        void initComponentsBitmapButton();

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

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

 
    private:
        // Recalculates the glyph size based on the set relative glyph height
        void recalculateGlyphSize();

 
    private:
        priv::dev::StyleProperty<Texture> icon;
 
        // The component must be declared AFTER the style property
        std::shared_ptr<priv::dev::ImageComponent> m_imageComponent;
 
        float m_relativeGlyphHeight = 0;
    };
} // namespace tgui
 
#endif // TGUI_BITMAP_BUTTON_HPP