checkbox.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2004 - 2008 Olof Naessén and Per Larsson
// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
 
#ifndef INCLUDE_FIFECHAN_WIDGETS_CHECKBOX_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_CHECKBOX_HPP_
 
#include <memory>
#include <string>
 
#include "fifechan/platform.hpp"
#include "fifechan/widgets/imagebutton.hpp"
 
namespace fcn
{
    class Image;

    class FIFEGUI_API CheckBox : public fcn::ImageButton
    {
    public:
        enum class MarkerStyle : uint8_t
        {
            Checkmark = 0,
            Cross,
            Dot,
            Rhombus,
            Image
        };
 
        CheckBox();

        explicit CheckBox(std::string const & caption, bool selected = false);
 
        ~CheckBox() override;
 
        CheckBox(CheckBox const &)            = delete;
        CheckBox& operator=(CheckBox const &) = delete;
        CheckBox(CheckBox&&)                  = delete;
        CheckBox& operator=(CheckBox&&)       = delete;

        virtual bool isSelected() const;

        virtual void setSelected(bool selected);

        virtual void toggleSelected();

        void setBackgroundImage(std::string const & filename);

        void setBackgroundImage(Image const * image);

        Image const * getBackgroundImage() const;

        MarkerStyle getMarkerStyle() const;

        void setMarkerStyle(MarkerStyle mode);
 
        // Inherited from Widget
 
        void adjustSize() override;
        void draw(Graphics* graphics) override;
 
        // Inherited from KeyListener
 
        void keyPressed(KeyEvent& keyEvent) override;
        void keyReleased(KeyEvent& keyEvent) override;
 
        // Inherited from MouseListener
 
        void mousePressed(MouseEvent& mouseEvent) override;
        void mouseReleased(MouseEvent& mouseEvent) override;
        void mouseClicked(MouseEvent& mouseEvent) override;
 
    protected:
        virtual void drawBox(Graphics* graphics);

        void adjustSizeImpl() override;

        void drawCheckmark(Graphics* graphics, Rectangle const & rec);

        void drawCross(Graphics* graphics, Rectangle const & rec);

        void drawDot(Graphics* graphics, Rectangle const & rec);

        void drawMarkerImage(Graphics* graphics, Rectangle const & rec);

        void drawRhombus(Graphics* graphics);

        Image const * mBackgroundImage{nullptr};
        // std::shared_ptr<Image const> mBackgroundImage{nullptr};

        std::string mCaption;

        bool mInternalBackgroundImage{false};

        bool mSelected{false};

        MarkerStyle mMode{MarkerStyle::Checkmark};
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_CHECKBOX_HPP_