RadioButton.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 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_RADIO_BUTTON_HPP
#define TGUI_RADIO_BUTTON_HPP
 
#include <TGUI/Renderers/RadioButtonRenderer.hpp>
#include <TGUI/Widgets/ClickableWidget.hpp>
#include <TGUI/Text.hpp>

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

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

        TGUI_NODISCARD static RadioButton::Ptr create();

        TGUI_NODISCARD static RadioButton::Ptr copy(const RadioButton::ConstPtr& radioButton);

        TGUI_NODISCARD RadioButtonRenderer* getSharedRenderer() override;
        TGUI_NODISCARD const RadioButtonRenderer* getSharedRenderer() const override;

        TGUI_NODISCARD RadioButtonRenderer* getRenderer() override;

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

        TGUI_NODISCARD Vector2f getFullSize() const override;

        TGUI_NODISCARD Vector2f getWidgetOffset() const override;

        void setMaxWidth(float maxWidth);

        TGUI_NODISCARD float getMaxWidth() const;

        void setEnabled(bool enabled) override;

        virtual void setChecked(bool checked);

        TGUI_NODISCARD bool isChecked() const
        {
            return m_checked;
        }

        void setText(const String& text);

        TGUI_NODISCARD const String& getText() const;

        void setTextClickable(bool acceptTextClick);

        TGUI_NODISCARD bool isTextClickable() const;

        TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;

        void leftMouseReleased(Vector2f pos) override;

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

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

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

    protected:

        TGUI_NODISCARD Signal& getSignal(String signalName) override;

        void rendererChanged(const String& property) override;

        TGUI_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;

        // 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;

        // Returns the size without the borders
        TGUI_NODISCARD Vector2f getInnerSize() const;

        // Returns the check color that is being used in the current state
        TGUI_NODISCARD const Color& getCurrentCheckColor() const;

        // Returns the background color that is being used in the current state
        TGUI_NODISCARD const Color& getCurrentBackgroundColor() const;

        // Returns the border color that is being used in the current state
        TGUI_NODISCARD const Color& getCurrentBorderColor() const;

        // Resets the sizes of the textures if they are used
        virtual void updateTextureSizes();

        // Updates the text color of the label depending on the current state
        void updateTextColor();

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

    public:
 
        SignalBool onCheck   = {"Checked"};   
        SignalBool onUncheck = {"Unchecked"}; 
        SignalBool onChange  = {"Changed"};   

    protected:
 
        // This is the checked flag. When the radio button is checked then this variable will be true.
        bool m_checked = false;
 
        // When this boolean is true (default) then the radio button will also be checked by clicking on the text.
        bool m_allowTextClick = true;
 
        // This will contain the text that is written next to radio button.
        String m_caption;
        Text m_text;
 
        float m_maxWidth = 0;
 
        Sprite m_spriteUnchecked;
        Sprite m_spriteChecked;
        Sprite m_spriteUncheckedHover;
        Sprite m_spriteCheckedHover;
        Sprite m_spriteUncheckedDisabled;
        Sprite m_spriteCheckedDisabled;
        Sprite m_spriteUncheckedFocused;
        Sprite m_spriteCheckedFocused;
 
        // Cached renderer properties
        Borders   m_bordersCached;
        TextStyles m_textStyleCached;
        TextStyles m_textStyleCheckedCached;
        Color     m_checkColorCached;
        Color     m_checkColorHoverCached;
        Color     m_checkColorDisabledCached;
        Color     m_borderColorCached;
        Color     m_borderColorHoverCached;
        Color     m_borderColorDisabledCached;
        Color     m_borderColorFocusedCached;
        Color     m_borderColorCheckedCached;
        Color     m_borderColorCheckedHoverCached;
        Color     m_borderColorCheckedDisabledCached;
        Color     m_borderColorCheckedFocusedCached;
        Color     m_backgroundColorCached;
        Color     m_backgroundColorHoverCached;
        Color     m_backgroundColorDisabledCached;
        Color     m_backgroundColorCheckedCached;
        Color     m_backgroundColorCheckedHoverCached;
        Color     m_backgroundColorCheckedDisabledCached;
        float     m_textDistanceRatioCached = 0.2f;
    };

}

 
#endif // TGUI_RADIO_BUTTON_HPP