CheckBox.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_CHECK_BOX_HPP
#define TGUI_CHECK_BOX_HPP
 
#include <TGUI/Renderers/CheckBoxRenderer.hpp>
#include <TGUI/Widgets/RadioButton.hpp>

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

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

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

        [[nodiscard]] static CheckBox::Ptr copy(const CheckBox::ConstPtr& checkbox);

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

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

        [[nodiscard]] Vector2f getFullSize() const override;

        [[nodiscard]] Vector2f getWidgetOffset() const override;

        void setChecked(bool checked) 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:
        void rendererChanged(const String& property) override;

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

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

 
    private:
        Texture m_textureUncheckedCached;
        Texture m_textureCheckedCached;
    };
} // namespace tgui
 
#endif // TGUI_CHECK_BOX_HPP