Dalamud/Dalamud/Game/Gui/ContextMenu/MenuItem.cs

using Dalamud.Game.Text;
using Dalamud.Game.Text.SeStringHandling;

using Lumina.Excel.GeneratedSheets;

namespace Dalamud.Game.Gui.ContextMenu;

/// <summary>
/// A menu item that can be added to a context menu.
/// </summary>
public sealed record MenuItem
{
    /// <summary>
    /// Gets or sets the display name of the menu item.
    /// </summary>
    public SeString Name { get; set; } = SeString.Empty;

    /// <summary>
    /// Gets or sets the prefix attached to the beginning of <see cref="Name"/>.
    /// </summary>
    public SeIconChar? Prefix { get; set; }

    /// <summary>
    /// Sets the character to prefix the <see cref="Name"/> with. Will be converted into a fancy boxed letter icon. Must be an uppercase letter.
    /// </summary>
    /// <exception cref="ArgumentException"><paramref name="value"/> must be an uppercase letter.</exception>
    public char? PrefixChar
    {
        set
        {
            if (value is { } prefix)
            {
                if (!char.IsAsciiLetterUpper(prefix))
                    throw new ArgumentException("Prefix must be an uppercase letter", nameof(value));

                this.Prefix = SeIconChar.BoxedLetterA + prefix - 'A';
            }
            else
            {
                this.Prefix = null;
            }
        }
    }

    /// <summary>
    /// Gets or sets the color of the <see cref="Prefix"/>. Specifies a <see cref="UIColor"/> row id.
    /// </summary>
    public ushort PrefixColor { get; set; }

    /// <summary>
    /// Gets or sets the callback to be invoked when the menu item is clicked.
    /// </summary>
    public Action<MenuItemClickedArgs>? OnClicked { get; set; }

    /// <summary>
    /// Gets or sets the priority (or order) with which the menu item should be displayed in descending order.
    /// Priorities below 0 will be displayed above the native menu items.
    /// Other priorities will be displayed below the native menu items.
    /// </summary>
    public int Priority { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether the menu item is enabled.
    /// Disabled items will be faded and cannot be clicked on.
    /// </summary>
    public bool IsEnabled { get; set; } = true;

    /// <summary>
    /// Gets or sets a value indicating whether the menu item is a submenu.
    /// This value is purely visual. Submenu items will have an arrow to its right.
    /// </summary>
    public bool IsSubmenu { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether the menu item is a return item.
    /// This value is purely visual. Return items will have a back arrow to its left.
    /// If both <see cref="IsSubmenu"/> and <see cref="IsReturn"/> are true, the return arrow will take precedence.
    /// </summary>
    public bool IsReturn { get; set; }

    /// <summary>
    /// Gets the name with the given prefix.
    /// </summary>
    internal SeString PrefixedName =>
        this.Prefix is { } prefix
            ? new SeStringBuilder()
                .AddUiForeground($"{prefix.ToIconString()} ", this.PrefixColor)
                .Append(this.Name)
                .Build()
            : this.Name;
}