togglebutton.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_TOGGLEBUTTON_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_TOGGLEBUTTON_HPP_
 
// Standard library includes
#include <map>
#include <string>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/widgets/imagebutton.hpp"
 
namespace fcn
{
    class FIFEGUI_API ToggleButton : public fcn::ImageButton
    {
        public:
            ToggleButton();

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

            virtual bool isSelected() const;

            virtual void setSelected(bool selected);

            virtual void toggleSelected();

            void setGroup(std::string const & group);

            std::string const & getGroup() const;
 
            // Inherited from KeyListener
 
            void keyReleased(KeyEvent& keyEvent) override;
 
            // Inherited from MouseListener
 
            void mouseReleased(MouseEvent& mouseEvent) override;
 
        protected:
            // Inherited from Button
 
            bool isPressed() const override;

            bool mSelected{false};

            std::string mGroup;

            using GroupMap = std::multimap<std::string, ToggleButton*>;

            using GroupIterator = GroupMap::iterator;

            static GroupMap mGroupMap;
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_TOGGLEBUTTON_HPP_