Terminal.Gui/Terminal.Gui/Drawing/VisualRole.cs at develop · harder/Terminal.Gui · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
namespace Terminal.Gui.Drawing;

/// <summary>
///     Represents the semantic visual role of a visual element rendered by a <see cref="View"/>. Each VisualRole maps to
///     a property of <see cref="Scheme"/> (e.g., <see cref="Scheme.Normal"/>).
/// </summary>
/// <remarks>
///     A single View may render as one or multiple elements. Each element can be associated with a different
///     <see cref="VisualRole"/>.
/// </remarks>
public enum VisualRole
{
    /// <summary>
    ///     The default visual role for unfocused, unselected, enabled elements.
    /// </summary>
    Normal,

    /// <summary>
    ///     The visual role for <see cref="Normal"/> elements with a <see cref="View.HotKey"/> indicator.
    /// </summary>
    HotNormal,

    /// <summary>
    ///     The visual role when the element is focused.
    /// </summary>
    Focus,

    /// <summary>
    ///     The visual role for <see cref="Focus"/> elements with a <see cref="View.HotKey"/> indicator.
    /// </summary>
    HotFocus,

    /// <summary>
    ///     The visual role for elements that are active or selected (e.g., selected item in a <see cref="ListView"/>). Also
    ///     used
    ///     for headers in, <see cref="HexView"/>, <see cref="CharMap"/>.
    /// </summary>
    Active,

    /// <summary>
    ///     The visual role for <see cref="Active"/> elements with a <see cref="View.HotKey"/> indicator.
    /// </summary>
    HotActive,

    /// <summary>
    ///     The visual role for elements that are highlighted (e.g., when the mouse is inside over a <see cref="Button"/>).
    /// </summary>
    Highlight,

    /// <summary>
    ///     The visual role for elements that are disabled and not interactable.
    /// </summary>
    Disabled,

    /// <summary>
    ///     The visual role for elements that are editable (e.g., <see cref="TextField"/>).
    /// </summary>
    Editable,

    /// <summary>
    ///     The visual role for elements that are normally editable but currently read-only.
    /// </summary>
    ReadOnly,

    /// <summary>
    ///     The visual role for preformatted or source code content (e.g., <see cref="MarkdownCodeBlock"/>, inline code).
    ///     If not explicitly set, derived from <see cref="Editable"/> with a dimmed background and bold style.
    /// </summary>
    Code,

    /// <summary>The visual role for source-code comments.</summary>
    CodeComment,

    /// <summary>The visual role for source-code keywords.</summary>
    CodeKeyword,

    /// <summary>The visual role for source-code string literals.</summary>
    CodeString,

    /// <summary>The visual role for source-code numeric literals.</summary>
    CodeNumber,

    /// <summary>The visual role for source-code operators.</summary>
    CodeOperator,

    /// <summary>The visual role for source-code type names.</summary>
    CodeType,

    /// <summary>The visual role for source-code preprocessor directives.</summary>
    CodePreprocessor,

    /// <summary>The visual role for source-code identifiers.</summary>
    CodeIdentifier,

    /// <summary>The visual role for source-code constants.</summary>
    CodeConstant,

    /// <summary>The visual role for source-code punctuation.</summary>
    CodePunctuation,

    /// <summary>The visual role for source-code function names.</summary>
    CodeFunctionName,

    /// <summary>The visual role for source-code attributes.</summary>
    CodeAttribute
}