-
Notifications
You must be signed in to change notification settings - Fork 673
/
Button.cs
292 lines (260 loc) · 8.46 KB
/
Button.cs
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
//
// Button.cs: Button control
//
// Authors:
// Miguel de Icaza (miguel@gnome.org)
//
using System;
using NStack;
namespace Terminal.Gui {
/// <summary>
/// Button is a <see cref="View"/> that provides an item that invokes an <see cref="Action"/> when activated by the user.
/// </summary>
/// <remarks>
/// <para>
/// Provides a button showing text invokes an <see cref="Action"/> when clicked on with a mouse
/// or when the user presses SPACE, ENTER, or hotkey. The hotkey is the first letter or digit following the first underscore ('_')
/// in the button text.
/// </para>
/// <para>
/// Use <see cref="View.HotKeySpecifier"/> to change the hotkey specifier from the default of ('_').
/// </para>
/// <para>
/// If no hotkey specifier is found, the first uppercase letter encountered will be used as the hotkey.
/// </para>
/// <para>
/// When the button is configured as the default (<see cref="IsDefault"/>) and the user presses
/// the ENTER key, if no other <see cref="View"/> processes the <see cref="KeyEvent"/>, the <see cref="Button"/>'s
/// <see cref="Action"/> will be invoked.
/// </para>
/// </remarks>
public class Button : View {
bool is_default;
Rune _leftBracket;
Rune _rightBracket;
Rune _leftDefault;
Rune _rightDefault;
/// <summary>
/// Initializes a new instance of <see cref="Button"/> using <see cref="LayoutStyle.Computed"/> layout.
/// </summary>
/// <remarks>
/// The width of the <see cref="Button"/> is computed based on the
/// text length. The height will always be 1.
/// </remarks>
public Button () : this (text: string.Empty, is_default: false) { }
/// <summary>
/// Initializes a new instance of <see cref="Button"/> using <see cref="LayoutStyle.Computed"/> layout.
/// </summary>
/// <remarks>
/// The width of the <see cref="Button"/> is computed based on the
/// text length. The height will always be 1.
/// </remarks>
/// <param name="text">The button's text</param>
/// <param name="is_default">
/// If <c>true</c>, a special decoration is used, and the user pressing the enter key
/// in a <see cref="Dialog"/> will implicitly activate this button.
/// </param>
public Button (ustring text, bool is_default = false) : base (text)
{
Initialize (text, is_default);
}
/// <summary>
/// Initializes a new instance of <see cref="Button"/> using <see cref="LayoutStyle.Absolute"/> layout, based on the given text
/// </summary>
/// <remarks>
/// The width of the <see cref="Button"/> is computed based on the
/// text length. The height will always be 1.
/// </remarks>
/// <param name="x">X position where the button will be shown.</param>
/// <param name="y">Y position where the button will be shown.</param>
/// <param name="text">The button's text</param>
public Button (int x, int y, ustring text) : this (x, y, text, false) { }
/// <summary>
/// Initializes a new instance of <see cref="Button"/> using <see cref="LayoutStyle.Absolute"/> layout, based on the given text.
/// </summary>
/// <remarks>
/// The width of the <see cref="Button"/> is computed based on the
/// text length. The height will always be 1.
/// </remarks>
/// <param name="x">X position where the button will be shown.</param>
/// <param name="y">Y position where the button will be shown.</param>
/// <param name="text">The button's text</param>
/// <param name="is_default">
/// If <c>true</c>, a special decoration is used, and the user pressing the enter key
/// in a <see cref="Dialog"/> will implicitly activate this button.
/// </param>
public Button (int x, int y, ustring text, bool is_default)
: base (new Rect (x, y, text.RuneCount + 4 + (is_default ? 2 : 0), 1), text)
{
Initialize (text, is_default);
}
void Initialize (ustring text, bool is_default)
{
TextAlignment = TextAlignment.Centered;
VerticalTextAlignment = VerticalTextAlignment.Middle;
HotKeySpecifier = new Rune ('_');
_leftBracket = new Rune (Driver != null ? Driver.LeftBracket : '[');
_rightBracket = new Rune (Driver != null ? Driver.RightBracket : ']');
_leftDefault = new Rune (Driver != null ? Driver.LeftDefaultIndicator : '<');
_rightDefault = new Rune (Driver != null ? Driver.RightDefaultIndicator : '>');
CanFocus = true;
AutoSize = true;
this.is_default = is_default;
Text = text ?? string.Empty;
UpdateTextFormatterText ();
ProcessResizeView ();
// Things this view knows how to do
AddCommand (Command.Accept, () => AcceptKey ());
// Default keybindings for this view
AddKeyBinding (Key.Enter, Command.Accept);
AddKeyBinding (Key.Space, Command.Accept);
if (HotKey != Key.Null) {
AddKeyBinding (Key.Space | HotKey, Command.Accept);
}
}
/// <summary>
/// Gets or sets whether the <see cref="Button"/> is the default action to activate in a dialog.
/// </summary>
/// <value><c>true</c> if is default; otherwise, <c>false</c>.</value>
/// <remarks>
/// If is <see langword="true"/> the current focused view
/// will remain focused if the window is not closed.
/// </remarks>
public bool IsDefault {
get => is_default;
set {
is_default = value;
UpdateTextFormatterText ();
ProcessResizeView ();
}
}
/// <inheritdoc/>
public override Key HotKey {
get => base.HotKey;
set {
if (base.HotKey != value) {
var v = value == Key.Unknown ? Key.Null : value;
if (base.HotKey != Key.Null && ContainsKeyBinding (Key.Space | base.HotKey)) {
if (v == Key.Null) {
ClearKeybinding (Key.Space | base.HotKey);
} else {
ReplaceKeyBinding (Key.Space | base.HotKey, Key.Space | v);
}
} else if (v != Key.Null) {
AddKeyBinding (Key.Space | v, Command.Accept);
}
base.HotKey = TextFormatter.HotKey = v;
}
}
}
/// <inheritdoc/>
protected override void UpdateTextFormatterText ()
{
if (IsDefault)
TextFormatter.Text = ustring.Make (_leftBracket) + ustring.Make (_leftDefault) + " " + Text + " " + ustring.Make (_rightDefault) + ustring.Make (_rightBracket);
else
TextFormatter.Text = ustring.Make (_leftBracket) + " " + Text + " " + ustring.Make (_rightBracket);
}
///<inheritdoc/>
public override bool ProcessHotKey (KeyEvent kb)
{
if (!Enabled) {
return false;
}
return ExecuteHotKey (kb);
}
///<inheritdoc/>
public override bool ProcessColdKey (KeyEvent kb)
{
if (!Enabled) {
return false;
}
return ExecuteColdKey (kb);
}
///<inheritdoc/>
public override bool ProcessKey (KeyEvent kb)
{
if (!Enabled) {
return false;
}
var result = InvokeKeybindings (kb);
if (result != null)
return (bool)result;
return base.ProcessKey (kb);
}
bool ExecuteHotKey (KeyEvent ke)
{
if (ke.Key == (Key.AltMask | HotKey)) {
return AcceptKey ();
}
return false;
}
bool ExecuteColdKey (KeyEvent ke)
{
if (IsDefault && ke.KeyValue == '\n') {
return AcceptKey ();
}
return ExecuteHotKey (ke);
}
bool AcceptKey ()
{
if (!IsDefault && !HasFocus) {
SetFocus ();
}
OnClicked ();
return true;
}
/// <summary>
/// Virtual method to invoke the <see cref="Clicked"/> event.
/// </summary>
public virtual void OnClicked ()
{
Clicked?.Invoke ();
}
/// <summary>
/// Clicked <see cref="Action"/>, raised when the user clicks the primary mouse button within the Bounds of this <see cref="View"/>
/// or if the user presses the action key while this view is focused. (TODO: IsDefault)
/// </summary>
/// <remarks>
/// Client code can hook up to this event, it is
/// raised when the button is activated either with
/// the mouse or the keyboard.
/// </remarks>
public event Action Clicked;
///<inheritdoc/>
public override bool MouseEvent (MouseEvent me)
{
if (me.Flags == MouseFlags.Button1Clicked) {
if (CanFocus && Enabled) {
if (!HasFocus) {
SetFocus ();
SetNeedsDisplay ();
Redraw (Bounds);
}
OnClicked ();
}
return true;
}
return false;
}
///<inheritdoc/>
public override void PositionCursor ()
{
if (HotKey == Key.Unknown && Text != "") {
for (int i = 0; i < TextFormatter.Text.RuneCount; i++) {
if (TextFormatter.Text [i] == Text [0]) {
Move (i, 0);
return;
}
}
}
base.PositionCursor ();
}
///<inheritdoc/>
public override bool OnEnter (View view)
{
Application.Driver.SetCursorVisibility (CursorVisibility.Invisible);
return base.OnEnter (view);
}
}
}