-
-
Notifications
You must be signed in to change notification settings - Fork 746
Expand file tree
/
Copy pathMenuItem.cs
More file actions
150 lines (125 loc) · 5.35 KB
/
MenuItem.cs
File metadata and controls
150 lines (125 loc) · 5.35 KB
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
using System;
using System.Text.Json.Serialization;
using System.Runtime.Versioning;
namespace ElectronNET.API.Entities
{
/// <summary>
///
/// </summary>
/// <remarks>Up-to-date with Electron API 39.2</remarks>
public class MenuItem
{
/// <summary>
/// Will be called with click(menuItem, browserWindow, event) when the menu item is
/// clicked.
/// </summary>
[JsonIgnore]
public Action Click { get; set; }
/// <summary>
/// Gets or sets the action (role) of the menu item. When specified, the click property will be ignored.
/// </summary>
public MenuRole Role { get; set; }
/// <summary>
/// Gets or sets the menu item type. Can be normal, separator, submenu, checkbox, radio, header (macOS 14+), or palette (macOS 14+).
/// </summary>
public MenuType Type { get; set; }
/// <summary>
/// Gets or sets the label.
/// </summary>
/// <value>
/// The label.
/// </value>
public string Label { get; set; }
/// <summary>
/// Gets or sets the sublabel.
/// </summary>
/// <value>
/// The sublabel.
/// </value>
[SupportedOSPlatform("macos")]
public string Sublabel { get; set; }
/// <summary>
/// Hover text for this menu item (macOS).
/// </summary>
[SupportedOSPlatform("macos")]
public string ToolTip { get; set; }
/// <summary>
/// Gets or sets the accelerator.
/// </summary>
/// <value>
/// The accelerator.
/// </value>
public string Accelerator { get; set; }
/// <summary>
/// Gets or sets the icon.
/// </summary>
/// <value>
/// The icon.
/// </value>
public string Icon { get; set; }
/// <summary>
/// Gets or sets a value indicating whether the item is enabled. If false, the menu item will be greyed out and unclickable.
/// </summary>
public bool Enabled { get; set; } = true;
/// <summary>
/// Gets or sets a value indicating whether the item is visible. If false, the menu item will be entirely hidden.
/// </summary>
public bool Visible { get; set; } = true;
/// <summary>
/// Gets or sets a value indicating whether the accelerator should work when the item is hidden. Default is true (macOS).
/// When false, prevents the accelerator from triggering the item if the item is not visible.
/// </summary>
[SupportedOSPlatform("macos")]
public bool? AcceleratorWorksWhenHidden { get; set; }
/// <summary>
/// Gets or sets a value indicating whether the accelerator should be registered with the system or only displayed (Linux/Windows). Defaults to true.
/// </summary>
[SupportedOSPlatform("windows")]
[SupportedOSPlatform("linux")]
public bool? RegisterAccelerator { get; set; }
/// <summary>
/// Gets or sets a value indicating whether the item is checked. Should only be specified for checkbox or radio items.
/// </summary>
public bool Checked { get; set; }
/// <summary>
/// Should be specified for submenu type menu items. If submenu is specified, the
/// type: 'submenu' can be omitted.If the value is not a Menu then it will be
/// automatically converted to one using Menu.buildFromTemplate.
/// </summary>
public MenuItem[] Submenu { get; set; }
/// <summary>
/// The item to share when the role is shareMenu (macOS).
/// </summary>
[SupportedOSPlatform("macos")]
public SharingItem SharingItem { get; set; }
/// <summary>
/// Gets or sets a unique id within a single menu. If defined then it can be used as a reference for placement.
/// </summary>
public string Id { get; internal set; }
/// <summary>
/// This field allows fine-grained definition of the specific location within a given menu.
/// </summary>
public string Position { get; set; }
/// <summary>
/// Gets or sets a list of item ids. Inserts this item before the item(s) with the specified id(s).
/// If the referenced item doesn't exist the item will be inserted at the end of the menu.
/// Also implies that this item should be placed in the same group as the referenced item(s).
/// </summary>
public string[] Before { get; set; }
/// <summary>
/// Gets or sets a list of item ids. Inserts this item after the item(s) with the specified id(s).
/// If the referenced item doesn't exist the item will be inserted at the end of the menu.
/// </summary>
public string[] After { get; set; }
/// <summary>
/// Gets or sets a list of item ids. Places this item's containing group before the containing group
/// of the item(s) with the specified id(s).
/// </summary>
public string[] BeforeGroupContaining { get; set; }
/// <summary>
/// Gets or sets a list of item ids. Places this item's containing group after the containing group
/// of the item(s) with the specified id(s).
/// </summary>
public string[] AfterGroupContaining { get; set; }
}
}