menuitem.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2026 Fifengine contributors
 
#ifndef INCLUDE_FIFECHAN_WIDGETS_MENUITEM_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_MENUITEM_HPP_
 
// Standard library includes
#include <memory>
#include <string>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/image.hpp"
#include "fifechan/listeners/actionlistener.hpp"
#include "fifechan/widgets/button.hpp"
 
namespace fcn
{
    class Font;
    class MenuPopup;

    struct MenuItemMetrics
    {
            int iconW{0};

            int captionW{0};

            int shortcutW{0};

            int arrowW{0};

            int height{0};
    };

    struct MenuColumns
    {
            int iconW{0};

            int captionW{0};

            int shortcutW{0};

            int arrowW{0};
    };

    struct ColumnLayout
    {
            int xIcon;

            int xCaption;

            int xShortcut;

            int xArrow;

            MenuColumns cols;
    };

    class FIFEGUI_API MenuItem : public Button
    {
        public:
            enum class Type : std::uint8_t
            {
                Action,
                Submenu,
                Separator,
                Checkable
            };

            explicit MenuItem(std::string const & text);
 
            ~MenuItem() override = default;
 
            MenuItem(MenuItem const &)            = delete;
            MenuItem& operator=(MenuItem const &) = delete;
            MenuItem(MenuItem&&)                  = delete;
            MenuItem& operator=(MenuItem&&)       = delete;

            void setType(Type type);

            Type getType() const;

            void setSubmenu(MenuPopup* popup);

            MenuPopup* getSubmenu() const;

            void setShortcut(std::string const & shortcut);

            std::string const & getShortcut() const;

            void setText(std::string const & text);
            std::string const & getText() const;

            void setIcon(Image const * image);
            Image const * getIcon() const;

            void setIconGlyph(std::string const & glyph, Font* font = nullptr);
            std::string const & getIconGlyph() const;

            void setIconGlyphFont(Font* font);

            Font* getIconGlyphFont() const;

            void setChecked(bool checked);

            bool isChecked() const;

            // cppcheck-suppress duplInheritedMember
            void setEnabled(bool enabled);

            // cppcheck-suppress duplInheritedMember
            bool isEnabled() const;
 
            // Override draw for custom rendering
            void draw(Graphics* graphics) override;
 
            // Mouse event handlers are inherited from `Button`.
            // (Previously overridden for tracing; no custom logic required.)

            MenuItemMetrics measure(Font const & font) const;

            void layoutColumns(ColumnLayout const & layout);
 
        protected:
            Type mType{Type::Action};

            MenuPopup* mSubmenu{nullptr};

            std::string mShortcut;

            Image const * mIcon{nullptr};

            std::string mIconGlyph;
            Font* mIconGlyphFont{nullptr};

            bool mChecked{false};

            // cppcheck-suppress duplInheritedMember
            bool mEnabled{true};

            std::unique_ptr<ColumnLayout> mColumnLayout;
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_MENUITEM_HPP_