mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 07:47:54 +01:00
ff18ad4532
* Fixed warnings I recently introduced. Replaced nullable App references with null-forgiving operator (!) in MessageBox and dialog calls to suppress nullable warnings. Updated XML docs to use Dim.Fill() and clarified method references. Made Application.Popover registration null-safe. Fixed test output helper usage in ShadowTests. No functional changes. * Fixes Release build warnings
572 lines
24 KiB
C#
572 lines
24 KiB
C#
#nullable enable
|
|
|
|
using System.Collections.ObjectModel;
|
|
using Timer = System.Timers.Timer;
|
|
|
|
namespace UICatalog.Scenarios;
|
|
|
|
[ScenarioMetadata ("Shortcuts", "Illustrates Shortcut class.")]
|
|
[ScenarioCategory ("Controls")]
|
|
public class Shortcuts : Scenario
|
|
{
|
|
public override void Main ()
|
|
{
|
|
Application.Init ();
|
|
var quitKey = Application.QuitKey;
|
|
Window app = new ();
|
|
|
|
app.IsModalChanged += App_Loaded;
|
|
|
|
Application.Run (app);
|
|
app.Dispose ();
|
|
Application.Shutdown ();
|
|
Application.QuitKey = quitKey;
|
|
}
|
|
|
|
// Setting everything up in Loaded handler because we change the
|
|
// QuitKey and it only sticks if changed after init
|
|
private void App_Loaded (object? sender, EventArgs e)
|
|
{
|
|
Application.QuitKey = Key.F4.WithCtrl;
|
|
Application.TopRunnableView!.Title = GetQuitKeyAndName ();
|
|
|
|
ObservableCollection<string> eventSource = new ();
|
|
|
|
var eventLog = new ListView
|
|
{
|
|
Id = "eventLog",
|
|
X = Pos.AnchorEnd (),
|
|
Y = 0,
|
|
Height = Dim.Fill (4),
|
|
SchemeName = "Runnable",
|
|
Source = new ListWrapper<string> (eventSource),
|
|
BorderStyle = LineStyle.Double,
|
|
Title = "E_vents"
|
|
};
|
|
|
|
eventLog.Width = Dim.Func (
|
|
_ => Math.Min (
|
|
Application.TopRunnableView.Viewport.Width / 2,
|
|
eventLog?.MaxLength + eventLog!.GetAdornmentsThickness ().Horizontal ?? 0));
|
|
|
|
eventLog.Width = Dim.Func (
|
|
_ => Math.Min (
|
|
eventLog.SuperView!.Viewport.Width / 2,
|
|
eventLog?.MaxLength + eventLog!.GetAdornmentsThickness ().Horizontal ?? 0));
|
|
Application.TopRunnableView.Add (eventLog);
|
|
|
|
var alignKeysShortcut = new Shortcut
|
|
{
|
|
Id = "alignKeysShortcut",
|
|
X = 0,
|
|
Y = 0,
|
|
Width = Dim.Fill ()! - Dim.Width (eventLog),
|
|
HelpText = "Fill to log",
|
|
CommandView = new CheckBox
|
|
{
|
|
Text = "_Align Keys",
|
|
CanFocus = false,
|
|
HighlightStates = MouseState.None,
|
|
CheckedState = CheckState.Checked
|
|
},
|
|
Key = Key.F5.WithCtrl.WithAlt.WithShift
|
|
};
|
|
|
|
((CheckBox)alignKeysShortcut.CommandView).CheckedStateChanging += (s, e) =>
|
|
{
|
|
if (alignKeysShortcut.CommandView is CheckBox cb)
|
|
{
|
|
bool align = e.Result == CheckState.Checked;
|
|
eventSource.Add (
|
|
$"{alignKeysShortcut.Id}.CommandView.CheckedStateChanging: {cb.Text}");
|
|
eventLog.MoveDown ();
|
|
|
|
AlignKeys (align);
|
|
}
|
|
};
|
|
|
|
|
|
Application.TopRunnableView.Add (alignKeysShortcut);
|
|
|
|
var commandFirstShortcut = new Shortcut
|
|
{
|
|
Id = "commandFirstShortcut",
|
|
X = 0,
|
|
Y = Pos.Bottom (alignKeysShortcut),
|
|
Width = Dim.Fill ()! - Dim.Width (eventLog),
|
|
HelpText = "Show _Command first",
|
|
CommandView = new CheckBox
|
|
{
|
|
Text = "Command _First",
|
|
CanFocus = false,
|
|
HighlightStates = MouseState.None
|
|
},
|
|
Key = Key.F.WithCtrl
|
|
};
|
|
|
|
((CheckBox)commandFirstShortcut.CommandView).CheckedState =
|
|
commandFirstShortcut.AlignmentModes.HasFlag (AlignmentModes.EndToStart) ? CheckState.UnChecked : CheckState.Checked;
|
|
|
|
((CheckBox)commandFirstShortcut.CommandView).CheckedStateChanging += (s, e) =>
|
|
{
|
|
if (commandFirstShortcut.CommandView is CheckBox cb)
|
|
{
|
|
eventSource.Add (
|
|
$"{commandFirstShortcut.Id}.CommandView.CheckedStateChanging: {cb.Text}");
|
|
eventLog.MoveDown ();
|
|
|
|
IEnumerable<View> toAlign = Application.TopRunnableView.SubViews.OfType<Shortcut> ();
|
|
IEnumerable<View> enumerable = toAlign as View [] ?? toAlign.ToArray ();
|
|
|
|
foreach (View view in enumerable)
|
|
{
|
|
var peer = (Shortcut)view;
|
|
|
|
if (e.Result == CheckState.Checked)
|
|
{
|
|
peer.AlignmentModes &= ~AlignmentModes.EndToStart;
|
|
}
|
|
else
|
|
{
|
|
peer.AlignmentModes |= AlignmentModes.EndToStart;
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
Application.TopRunnableView.Add (commandFirstShortcut);
|
|
|
|
var canFocusShortcut = new Shortcut
|
|
{
|
|
Id = "canFocusShortcut",
|
|
X = 0,
|
|
Y = Pos.Bottom (commandFirstShortcut),
|
|
Width = Dim.Fill ()! - Dim.Width (eventLog),
|
|
Key = Key.F4,
|
|
HelpText = "Changes all CommandView.CanFocus",
|
|
CommandView = new CheckBox { Text = "_CommandView.CanFocus" },
|
|
};
|
|
|
|
((CheckBox)canFocusShortcut.CommandView).CheckedStateChanging += (s, e) =>
|
|
{
|
|
if (canFocusShortcut.CommandView is CheckBox cb)
|
|
{
|
|
eventSource.Add ($"Toggle: {cb.Text}");
|
|
eventLog.MoveDown ();
|
|
|
|
//cb.CanFocus = e.NewValue == CheckState.Checked;
|
|
|
|
SetCanFocus (e.Result == CheckState.Checked);
|
|
}
|
|
};
|
|
Application.TopRunnableView.Add (canFocusShortcut);
|
|
|
|
var appShortcut = new Shortcut
|
|
{
|
|
Id = "appShortcut",
|
|
X = 0,
|
|
Y = Pos.Bottom (canFocusShortcut),
|
|
Width = Dim.Fill (Dim.Func (_ => eventLog.Frame.Width)),
|
|
Title = "A_pp Shortcut",
|
|
Key = Key.F1,
|
|
Text = "Width is DimFill",
|
|
BindKeyToApplication = true
|
|
};
|
|
|
|
Application.TopRunnableView.Add (appShortcut);
|
|
|
|
var buttonShortcut = new Shortcut
|
|
{
|
|
Id = "buttonShortcut",
|
|
X = 0,
|
|
Y = Pos.Bottom (appShortcut),
|
|
Width = Dim.Fill ()! - Dim.Width (eventLog),
|
|
HelpText = "Accepting pops MB",
|
|
CommandView = new Button
|
|
{
|
|
Title = "_Button",
|
|
ShadowStyle = ShadowStyle.None,
|
|
HighlightStates = MouseState.None
|
|
},
|
|
Key = Key.K
|
|
};
|
|
var button = (Button)buttonShortcut.CommandView;
|
|
buttonShortcut.Accepting += Button_Clicked;
|
|
|
|
Application.TopRunnableView.Add (buttonShortcut);
|
|
|
|
var optionSelectorShortcut = new Shortcut
|
|
{
|
|
Id = "optionSelectorShortcut",
|
|
HelpText = "Option Selector",
|
|
X = 0,
|
|
Y = Pos.Bottom (buttonShortcut),
|
|
Key = Key.F2,
|
|
Width = Dim.Fill ()! - Dim.Width (eventLog),
|
|
CommandView = new OptionSelector ()
|
|
{
|
|
Orientation = Orientation.Vertical,
|
|
Labels = ["O_ne", "T_wo", "Th_ree", "Fo_ur"],
|
|
HighlightStates = MouseState.None,
|
|
},
|
|
};
|
|
|
|
((OptionSelector)optionSelectorShortcut.CommandView).ValueChanged += (o, args) =>
|
|
{
|
|
if (o is { })
|
|
{
|
|
eventSource.Add (
|
|
$"ValueChanged: {o.GetType ().Name} - {args.Value}");
|
|
eventLog.MoveDown ();
|
|
}
|
|
};
|
|
|
|
Application.TopRunnableView.Add (optionSelectorShortcut);
|
|
|
|
var sliderShortcut = new Shortcut
|
|
{
|
|
Id = "sliderShortcut",
|
|
X = 0,
|
|
Y = Pos.Bottom (optionSelectorShortcut),
|
|
Width = Dim.Fill ()! - Dim.Width (eventLog),
|
|
HelpText = "Sliders work!",
|
|
CommandView = new Slider<string>
|
|
{
|
|
Orientation = Orientation.Horizontal,
|
|
AllowEmpty = true
|
|
},
|
|
Key = Key.F5
|
|
};
|
|
|
|
((Slider<string>)sliderShortcut.CommandView).Options = [new () { Legend = "A" }, new () { Legend = "B" }, new () { Legend = "C" }];
|
|
((Slider<string>)sliderShortcut.CommandView).SetOption (0);
|
|
|
|
((Slider<string>)sliderShortcut.CommandView).OptionsChanged += (o, args) =>
|
|
{
|
|
eventSource.Add (
|
|
$"OptionsChanged: {o?.GetType ().Name} - {string.Join (",", ((Slider<string>)o!)!.GetSetOptions ())}");
|
|
eventLog.MoveDown ();
|
|
};
|
|
|
|
Application.TopRunnableView.Add (sliderShortcut);
|
|
|
|
ListView listView = new ListView ()
|
|
{
|
|
Height = Dim.Auto (),
|
|
Width = Dim.Auto (),
|
|
Title = "ListView",
|
|
BorderStyle = LineStyle.Single
|
|
};
|
|
listView.EnableForDesign ();
|
|
|
|
var listViewShortcut = new Shortcut ()
|
|
{
|
|
Id = "listViewShortcut",
|
|
X = 0,
|
|
Y = Pos.Bottom (sliderShortcut),
|
|
Width = Dim.Fill ()! - Dim.Width (eventLog),
|
|
HelpText = "A ListView with Border",
|
|
CommandView = listView,
|
|
Key = Key.F5.WithCtrl,
|
|
};
|
|
|
|
Application.TopRunnableView.Add (listViewShortcut);
|
|
|
|
var noCommandShortcut = new Shortcut
|
|
{
|
|
Id = "noCommandShortcut",
|
|
X = 0,
|
|
Y = Pos.Bottom (listViewShortcut),
|
|
Width = Dim.Width (listViewShortcut),
|
|
HelpText = "No Command",
|
|
Key = Key.D0
|
|
};
|
|
|
|
Application.TopRunnableView.Add (noCommandShortcut);
|
|
|
|
var noKeyShortcut = new Shortcut
|
|
{
|
|
Id = "noKeyShortcut",
|
|
X = 0,
|
|
Y = Pos.Bottom (noCommandShortcut),
|
|
Width = Dim.Width (noCommandShortcut),
|
|
|
|
Title = "No Ke_y",
|
|
HelpText = "Keyless"
|
|
};
|
|
|
|
Application.TopRunnableView.Add (noKeyShortcut);
|
|
|
|
var noHelpShortcut = new Shortcut
|
|
{
|
|
Id = "noHelpShortcut",
|
|
X = 0,
|
|
Y = Pos.Bottom (noKeyShortcut),
|
|
Width = Dim.Width (noKeyShortcut),
|
|
Key = Key.F6,
|
|
Title = "Not _very much help",
|
|
HelpText = ""
|
|
};
|
|
|
|
Application.TopRunnableView.Add (noHelpShortcut);
|
|
noHelpShortcut.SetFocus ();
|
|
|
|
var framedShortcut = new Shortcut
|
|
{
|
|
Id = "framedShortcut",
|
|
X = 0,
|
|
Y = Pos.Bottom (noHelpShortcut) + 1,
|
|
Width = Dim.Width (noHelpShortcut),
|
|
Title = "Framed Shortcut",
|
|
Key = Key.K.WithCtrl,
|
|
Text = "Help: You can resize this",
|
|
BorderStyle = LineStyle.Dotted,
|
|
Arrangement = ViewArrangement.RightResizable | ViewArrangement.BottomResizable
|
|
};
|
|
framedShortcut.Border!.Settings = BorderSettings.Title;
|
|
//framedShortcut.Orientation = Orientation.Horizontal;
|
|
|
|
if (framedShortcut.Padding is { })
|
|
{
|
|
framedShortcut.Padding.Thickness = new (0, 1, 0, 0);
|
|
framedShortcut.Padding.Diagnostics = ViewDiagnosticFlags.Ruler;
|
|
}
|
|
|
|
if (framedShortcut.CommandView.Margin is { })
|
|
{
|
|
framedShortcut.CommandView.SchemeName = framedShortcut.CommandView.SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Dialog);
|
|
framedShortcut.HelpView.SchemeName = framedShortcut.HelpView.SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Error);
|
|
framedShortcut.KeyView.SchemeName = framedShortcut.KeyView.SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Base);
|
|
}
|
|
|
|
framedShortcut.SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Runnable);
|
|
Application.TopRunnableView.Add (framedShortcut);
|
|
|
|
// Horizontal
|
|
var progressShortcut = new Shortcut
|
|
{
|
|
Id = "progressShortcut",
|
|
X = Pos.Align (Alignment.Start, AlignmentModes.IgnoreFirstOrLast, 1),
|
|
Y = Pos.AnchorEnd () - 1,
|
|
Key = Key.F7,
|
|
HelpText = "Horizontal"
|
|
};
|
|
|
|
progressShortcut.CommandView = new ProgressBar
|
|
{
|
|
Text = "Progress",
|
|
Title = "P",
|
|
Fraction = 0.5f,
|
|
Width = 10,
|
|
Height = 1,
|
|
ProgressBarStyle = ProgressBarStyle.Continuous
|
|
};
|
|
progressShortcut.CommandView.Width = 10;
|
|
progressShortcut.CommandView.Height = 1;
|
|
progressShortcut.CommandView.CanFocus = false;
|
|
|
|
Timer timer = new (10)
|
|
{
|
|
AutoReset = true
|
|
};
|
|
|
|
timer.Elapsed += (o, args) =>
|
|
{
|
|
if (progressShortcut.CommandView is ProgressBar pb)
|
|
{
|
|
if (pb.Fraction == 1.0)
|
|
{
|
|
pb.Fraction = 0;
|
|
}
|
|
|
|
pb.Fraction += 0.01f;
|
|
|
|
|
|
pb.SetNeedsDraw ();
|
|
}
|
|
};
|
|
timer.Start ();
|
|
|
|
Application.TopRunnableView.Add (progressShortcut);
|
|
|
|
var textField = new TextField
|
|
{
|
|
Text = "Edit me",
|
|
Width = 10,
|
|
Height = 1
|
|
};
|
|
|
|
var textFieldShortcut = new Shortcut
|
|
{
|
|
Id = "textFieldShortcut",
|
|
X = Pos.Align (Alignment.Start, AlignmentModes.IgnoreFirstOrLast, 1),
|
|
Y = Pos.AnchorEnd () - 1,
|
|
Key = Key.F8,
|
|
HelpText = "TextField",
|
|
CanFocus = true,
|
|
CommandView = textField
|
|
};
|
|
textField.CanFocus = true;
|
|
|
|
Application.TopRunnableView.Add (textFieldShortcut);
|
|
|
|
var bgColorShortcut = new Shortcut
|
|
{
|
|
Id = "bgColorShortcut",
|
|
X = Pos.Align (Alignment.Start, AlignmentModes.IgnoreFirstOrLast, 1),
|
|
Y = Pos.AnchorEnd (),
|
|
Key = Key.F9,
|
|
HelpText = "Cycles BG Color"
|
|
};
|
|
|
|
var bgColor = new ColorPicker16
|
|
{
|
|
BoxHeight = 1,
|
|
BoxWidth = 1
|
|
};
|
|
|
|
bgColorShortcut.Activating += (o, args) =>
|
|
{
|
|
//args.Cancel = true;
|
|
};
|
|
|
|
bgColorShortcut.Accepting += (o, args) =>
|
|
{
|
|
if (bgColor.SelectedColor == ColorName16.White)
|
|
{
|
|
bgColor.SelectedColor = ColorName16.Black;
|
|
|
|
return;
|
|
}
|
|
|
|
bgColor.SelectedColor++;
|
|
args.Handled = true;
|
|
};
|
|
|
|
bgColor.ColorChanged += (o, args) =>
|
|
{
|
|
if (o is { })
|
|
{
|
|
eventSource.Add ($"ColorChanged: {o.GetType ().Name} - {args.Result}");
|
|
eventLog.MoveDown ();
|
|
|
|
Application.TopRunnableView.SetScheme (
|
|
new (Application.TopRunnableView.GetScheme ())
|
|
{
|
|
Normal = new (
|
|
Application.TopRunnableView!.GetAttributeForRole (VisualRole.Normal).Foreground,
|
|
args.Result,
|
|
Application.TopRunnableView!.GetAttributeForRole (VisualRole.Normal).Style)
|
|
});
|
|
}
|
|
};
|
|
bgColorShortcut.CommandView = bgColor;
|
|
|
|
Application.TopRunnableView.Add (bgColorShortcut);
|
|
|
|
var appQuitShortcut = new Shortcut
|
|
{
|
|
Id = "appQuitShortcut",
|
|
X = Pos.Align (Alignment.Start, AlignmentModes.IgnoreFirstOrLast, 1),
|
|
Y = Pos.AnchorEnd () - 1,
|
|
Key = Key.Esc,
|
|
BindKeyToApplication = true,
|
|
Title = "Quit",
|
|
HelpText = "App Scope"
|
|
};
|
|
appQuitShortcut.Accepting += (o, args) => { Application.RequestStop (); };
|
|
|
|
Application.TopRunnableView.Add (appQuitShortcut);
|
|
|
|
foreach (Shortcut shortcut in Application.TopRunnableView.SubViews.OfType<Shortcut> ())
|
|
{
|
|
shortcut.Activating += (o, args) =>
|
|
{
|
|
if (args.Handled)
|
|
{
|
|
return;
|
|
}
|
|
|
|
eventSource.Add ($"{shortcut!.Id}.Activating: {shortcut!.CommandView.Text} {shortcut!.CommandView.GetType ().Name}");
|
|
eventLog.MoveDown ();
|
|
};
|
|
|
|
shortcut.CommandView.Activating += (o, args) =>
|
|
{
|
|
if (args.Handled)
|
|
{
|
|
return;
|
|
}
|
|
|
|
eventSource.Add (
|
|
$"{shortcut!.Id}.CommandView.Activating: {shortcut!.CommandView.Text} {shortcut!.CommandView.GetType ().Name}");
|
|
eventLog.MoveDown ();
|
|
//args.Handled = true;
|
|
};
|
|
|
|
shortcut.Accepting += (o, args) =>
|
|
{
|
|
eventSource.Add ($"{shortcut!.Id}.Accepting: {shortcut!.CommandView.Text} {shortcut!.CommandView.GetType ().Name}");
|
|
eventLog.MoveDown ();
|
|
|
|
// We don't want this to exit the Scenario
|
|
//args.Handled = true;
|
|
};
|
|
|
|
shortcut.CommandView.Accepting += (o, args) =>
|
|
{
|
|
eventSource.Add (
|
|
$"{shortcut!.Id}.CommandView.Accepting: {shortcut!.CommandView.Text} {shortcut!.CommandView.GetType ().Name}");
|
|
eventLog.MoveDown ();
|
|
};
|
|
}
|
|
|
|
SetCanFocus (false);
|
|
|
|
AlignKeys (true);
|
|
|
|
return;
|
|
|
|
void SetCanFocus (bool canFocus)
|
|
{
|
|
foreach (Shortcut peer in Application.TopRunnableView!.SubViews.OfType<Shortcut> ())
|
|
{
|
|
if (peer.CanFocus)
|
|
{
|
|
peer.CommandView.CanFocus = canFocus;
|
|
}
|
|
}
|
|
}
|
|
|
|
void AlignKeys (bool align)
|
|
{
|
|
var max = 0;
|
|
|
|
IEnumerable<Shortcut> toAlign = Application.TopRunnableView!.SubViews.OfType<Shortcut> ().Where(s => !s.Y.Has<PosAnchorEnd>(out _)).Cast<Shortcut>();
|
|
IEnumerable<Shortcut> enumerable = toAlign as Shortcut [] ?? toAlign.ToArray ();
|
|
|
|
if (align)
|
|
{
|
|
max = (from Shortcut? peer in enumerable
|
|
select peer!.Key.ToString ().GetColumns ()).Prepend (max)
|
|
.Max ();
|
|
|
|
max = enumerable.Select (peer => peer.KeyView.Text.GetColumns ()).Prepend (max).Max ();
|
|
}
|
|
|
|
foreach (Shortcut shortcut in enumerable)
|
|
{
|
|
Shortcut peer = shortcut;
|
|
peer.MinimumKeyTextSize = max;
|
|
}
|
|
}
|
|
}
|
|
|
|
private void Button_Clicked (object? sender, CommandEventArgs e)
|
|
{
|
|
e.Handled = true;
|
|
var view = sender as View;
|
|
MessageBox.Query ((sender as View)?.App!, "Hi", $"You clicked {view?.Text}", "_Ok");
|
|
}
|
|
}
|