gui-cs.Terminal.Gui/Terminal.Gui/View/ViewDiagnostics.cs


using Terminal.Gui.Analyzers.Internal.Attributes;

namespace Terminal.Gui;

/// <summary>Enables diagnostic functions for <see cref="View"/>.</summary>
[Flags]
[GenerateEnumExtensionMethods(FastHasFlags = true)]
public enum ViewDiagnosticFlags : uint
{
    /// <summary>All diagnostics off</summary>
    Off = 0b_0000_0000,

    /// <summary>
    ///     When enabled, <see cref="View.OnDrawAdornments"/> will draw a ruler in the Thickness.
    /// </summary>
    Ruler = 0b_0000_0001,

    /// <summary>
    ///     When enabled, <see cref="View.OnDrawAdornments"/> will draw the first letter of the Adornment name ('M', 'B', or 'P')
    ///     in the Thickness.
    /// </summary>
    Padding = 0b_0000_0010,

    /// <summary>
    ///     When enabled, <see cref="Adornment.OnMouseEnter(Gui.MouseEvent)"/> and <see cref="Adornment.OnMouseLeave(Gui.MouseEvent)"/>
    ///     will invert the foreground and background colors.
    /// </summary>
    MouseEnter = 0b_0000_00100
}

public partial class View
{
    /// <summary>Flags to enable/disable <see cref="View"/> diagnostics.</summary>
    public static ViewDiagnosticFlags Diagnostics { get; set; }
}