Files
Terminal.Gui/UICatalog/Scenarios/ContextMenus.cs
Tig dcb3b359ad Fixes #2926 - Refactor KeyEvent and KeyEventEventArgs to simplify (#2927)
* Adds basic MainLoop unit tests

* Remove WinChange action from Curses

* Remove WinChange action from Curses

* Remove ProcessInput action from Windows MainLoop

* Simplified MainLoop/ConsoleDriver by making MainLoop internal and moving impt fns to Application

* Modernized Terminal resize events

* Modernized Terminal resize events

* Removed un used property

* for _isWindowsTerminal devenv->wininit; not sure what changed

* Modernized mouse/keyboard events (Action->EventHandler)

* Updated OnMouseEvent API docs

* Using WT_SESSION to detect WT

* removes hacky GetParentProcess

* Updates to fix #2634 (clear last line)

* removes hacky GetParentProcess2

* Addressed mac resize issue

* Addressed mac resize issue

* Removes ConsoleDriver.PrepareToRun, has Init return MainLoop

* Removes unneeded Attribute methods

* Removed GetProcesssName

* Removed GetProcesssName

* Refactored KeyEvent and KeyEventEventArgs into a single class

* Revert "Refactored KeyEvent and KeyEventEventArgs into a single class"

This reverts commit 88a00658db.

* Fixed key repeat issue; reverted stupidity on 1049/1047 confusion

* Updated CSI API Docs

* merge

* Rearranged Event.cs to Keyboard.cs and Mouse.cs

* Renamed KeyEventEventArgs KeyEventArgs

* temp renamed KeyEvent OldKeyEvent

* Merged KeyEvent into KeyEventArgs

* Renamed Application.ProcessKey members

* Renamed Application.ProcessKey members

* Renamed Application.ProcessKey members

* Added Responder.KeyPressed

* Removed unused references

* Fixed arg naming

* InvokeKeybindings->InvokeKeyBindings

* InvokeKeybindings->InvokeKeyBindings

* Fixed unit tests fail

* More progress on refactoring key input; still broken and probably wrong

* Moved OnKeyPressed out of Responder and made ProcessKeyPrssed non-virtual

* Updated API docs

* Moved key handling from Responder to View

* Updated API docs

* Updated HotKey API docs

* Updated shortcut API docs

* Fixed responder unit tests

* Removed Shortcut from View as it is not used

* Removed unneeded OnHotKey override from Button

* Fixed BackTab logic

* Button now uses Key Bindings exclusively

* Button now uses Key Bindings exclusively

* Updated keyboard.md docs

* Fixed unit tests to account for Toplevel handling default button

* Added View.InvokeCommand API

* Modernized RadioGroup

* Removed ColdKey

* Modernized (partially) StatusBar

* Worked around FileDialog issue with Ctrl-F

* Fixed driver unit test; view must be focused to reciev key pressed

* Application code cleanup

* Start on updaing menu

* Menu now mostly works

* Menu Select refinement

* Fixed known menu bugs!

* Enabled HotKey to cause focus- experimental

* Fixes #3022 & adds unit test to prove it

* Actually Fixes #3022 & adds unit test to prove it

* Working through hotkey issues

* Misc fixes

* removed hot/cold key stuff from Keys scenario

* Fixed scenarios

* Simplified shortcut string handling

* Modernized Checkbox

* Modernized TileView

* Updated API docs

* Updated API docs

* attempting to publish v2 docs

* Revert "attempting to publish v2 docs"

This reverts commit 59dcec111b.

* Playing with api docs

* Removed Key.BackTab

* Removed Caps/Scroll/Numlock

* Partial removal of keymodifiers - unit tests pass

* Partial removal of keymodifiers - broke netdriver somewhere

* WindowsDriver & added KeyEventArgsTests

* Fixing menu shortcut/hotkeys - broke Menu.cs into separate files

* Fixed MenuBar!

* Finished modernizing Menu/MenuBar

* Removed Key.a-z. Broke lots of stuff

* checkout@v4

* progress on key mapping and formatting

* VK tests are still failing

* Fixed some unit tests

* Added Hotkey and Keybinding unit tests

* fixed unit test

* All unit tests pass again...

* Fixed broken unit tests

* KeyEventArgs.KeyValue -> AsRune

* Fixed bugs. Still some broken

* Added KeyEventArgs.IsAlpha. Added KeyEventArgs.cast ops. Fixed bugs. Unit tests pass

* Fixed WindowsDriver

* Oops.

* Refactoring based on bdisp's help. Not complete!

* removed calling into subviews from OnKeyBindings

* removed calling into subviews from OnKeyBindings

* Improved View KeyEvent unit tests

* More hotkey unit tests

* BIg change - Got rid of KeyPress w/in Application/Drivers

* Unit tests now pass again

* Refreshed API docs

* Better HotKey logic. More progress. Getting close.

* Fixed handling of shifted chars like ö

* Minor code cleanup

* Minor code cleanup2

* Why is build Action failing?

* Why is build Action failing??

* upgraded to .net8 to try to fix weird CI/CD build errors

* upgraded to .net8 to try to fix weird CI/CD build errors2

* Disabling TextViewTests to diagnose build errors

* reenable TextViewTests to diagnose build errors

* Arrrrrrg

* Merged v2_develop

* Fixed uppercase accented keys in WindowsDriver

* Fixed key binding api docs

* Experimental impl of CommandScope.SubViews for MenuBar

* Removed dead code from application.cs

* Removed dead code from application.cs

* Removed dead code from ConsoleDriver.cs

* Cleaned up some key binding stuff

* Disabled Alt to activate menu for now

* Updated label commands

* Fixed menu bugs. Upgraded menu unit tests

* Fixed unit tests

* Working on NetDriver

* fixed netdriver

* Fixed issues called out by @bdisp CR

* fixed CursesDriver

* added todo to netdriver

* Cherry picked treeview test fix 1b415e5

* Fix NetDriver.

* CommandScope->KeyBindingScope

* Address some tznind feedback

* Refactored KeyBindings big time!

* Added key consts to KeyEventArgs and renamed Key to ConsoleDriverKey

* Fixed some API docs

* Moved ConsoleDriverKey to ConsoleDriver.cs

* Renamed Key->ConsoleDriverKey

* Renamed Key->ConsoleDriverKey

* Renamed Key->ConsoleDriverKey

* renamed file I forgot to rename before

* Updated name and API docs of KeyEventArgs.isAlpha

* Fixed issues with OnKeyUp not doing the right thing.

* Fixed MainLoop.Running never being used

* Fixed MainLoop.Running never being used - unit tests

* Claned up BUGBUG comments

* Disabled a unit test to see why ci/cd tests are failing

* Removed defunct commented code

* Removed more defunct commented code

* Re-eanbled unit test; jsut removing one test case...

* Disabled more...

* Renambed Global->Applicaton and updated scope API docs

* Disabled more unit tests...

* Removed dead code

* Disabled more unit tests...2

* Disabled more unit tests...3

* Renambed Global->Applicaton and updated scope API docs 2

* Added more KeyBinding scope tests

* Added more KeyBinding scope tests2

* ConsoleDriverKey too long. Key too ambiguous. Settled on KeyCode. (Partialy because eventually I want to intro a class named Key).

* KeyEventArgs improvements. cast to Rune must be explicit as it's lossy

* Fixed warnings

* Renamed KeyEventArgs to Key... progress on fixing broken stuff that resulted

* Fix ConsoleKeyMapping bugs.

* Fix NetDriver issue from converting a lower case to a upper case.

* Started migration to Key from KeyCode - e.g. made HotKeys all consistent.

* Fixed build warnings

* Added key defns to Key

* KeyBindings now uses Key vs. KeyCode

* Verified by tweaking UICatalog

* Fixed treeview test ... again

* Renamed ProcessKeyDown/Up to NewKeyDown/Up and OnKeyPressed to OnProcessKeyDown to make things more clear

* Added test AllViews_KeyDown_All_EventsFire unit tests and fixed a few Views that were wrong

* fixed stupid KeyUp event bug

* If key not handled, return false for datefield

* dotnet test --no-restore --verbosity diag

* dotnet test --blame

* run tests on windows

* Fix TestVKPacket unit test and move it to ConsoleKeyMappingTests.cs file.

* Remove unnecessary commented code.

* Tweaked unit tests and removed Key.BareKey

* Fixed little details and updated api docs

* updated api docs

* AddKeyBindingsForHotKey: KeyCode->Key

* Cleaned up more old KeyCode usages. Added TODOs

---------

Co-authored-by: BDisp <bd.bdisp@gmail.com>
2023-12-16 12:04:23 -07:00

173 lines
5.8 KiB
C#

using System.Collections.Generic;
using System.Globalization;
using System.Threading;
using Terminal.Gui;
namespace UICatalog.Scenarios;
[ScenarioMetadata (Name: "ContextMenus", Description: "Context Menu Sample.")]
[ScenarioCategory ("Menus")]
public class ContextMenus : Scenario {
private ContextMenu _contextMenu = new ContextMenu ();
private readonly List<CultureInfo> _cultureInfos = Application.SupportedCultures;
private MenuItem _miForceMinimumPosToZero;
private bool _forceMinimumPosToZero = true;
private TextField _tfTopLeft, _tfTopRight, _tfMiddle, _tfBottomLeft, _tfBottomRight;
private MenuItem _miUseSubMenusSingleFrame;
private bool _useSubMenusSingleFrame;
public override void Setup ()
{
var text = "Context Menu";
var width = 20;
KeyCode winContextMenuKey = KeyCode.Space | KeyCode.CtrlMask;
var label = new Label ($"Press '{winContextMenuKey}' to open the Window context menu.") {
X = Pos.Center (),
Y = 1
};
Win.Add (label);
label = new Label ($"Press '{ContextMenu.DefaultKey}' to open the TextField context menu.") {
X = Pos.Center (),
Y = Pos.Bottom (label)
};
Win.Add (label);
_tfTopLeft = new TextField (text) {
Width = width
};
Win.Add (_tfTopLeft);
_tfTopRight = new TextField (text) {
X = Pos.AnchorEnd (width),
Width = width
};
Win.Add (_tfTopRight);
_tfMiddle = new TextField (text) {
X = Pos.Center (),
Y = Pos.Center (),
Width = width
};
Win.Add (_tfMiddle);
_tfBottomLeft = new TextField (text) {
Y = Pos.AnchorEnd (1),
Width = width
};
Win.Add (_tfBottomLeft);
_tfBottomRight = new TextField (text) {
X = Pos.AnchorEnd (width),
Y = Pos.AnchorEnd (1),
Width = width
};
Win.Add (_tfBottomRight);
Point mousePos = default;
Win.KeyDown += (s, e) => {
if (e.KeyCode == winContextMenuKey) {
ShowContextMenu (mousePos.X, mousePos.Y);
e.Handled = true;
}
};
Win.MouseClick += (s, e) => {
if (e.MouseEvent.Flags == _contextMenu.MouseFlags) {
ShowContextMenu (e.MouseEvent.X, e.MouseEvent.Y);
e.Handled = true;
}
};
Application.MouseEvent += ApplicationMouseEvent;
void ApplicationMouseEvent (object sender, MouseEventEventArgs a)
{
mousePos = new Point (a.MouseEvent.X, a.MouseEvent.Y);
}
Win.WantMousePositionReports = true;
Application.Top.Closed += (s, e) => {
Thread.CurrentThread.CurrentUICulture = new CultureInfo ("en-US");
Application.MouseEvent -= ApplicationMouseEvent;
};
}
private void ShowContextMenu (int x, int y)
{
_contextMenu = new ContextMenu (x, y,
new MenuBarItem (new MenuItem [] {
new MenuItem ("_Configuration", "Show configuration", () => MessageBox.Query (50, 5, "Info", "This would open settings dialog", "Ok")),
new MenuBarItem ("More options", new MenuItem [] {
new MenuItem ("_Setup", "Change settings", () => MessageBox.Query (50, 5, "Info", "This would open setup dialog", "Ok"), shortcut: KeyCode.T | KeyCode.CtrlMask),
new MenuItem ("_Maintenance", "Maintenance mode", () => MessageBox.Query (50, 5, "Info", "This would open maintenance dialog", "Ok")),
}),
new MenuBarItem ("_Languages", GetSupportedCultures ()),
_miForceMinimumPosToZero = new MenuItem ("ForceMinimumPosToZero", "", () => {
_miForceMinimumPosToZero.Checked = _forceMinimumPosToZero = !_forceMinimumPosToZero;
_tfTopLeft.ContextMenu.ForceMinimumPosToZero = _forceMinimumPosToZero;
_tfTopRight.ContextMenu.ForceMinimumPosToZero = _forceMinimumPosToZero;
_tfMiddle.ContextMenu.ForceMinimumPosToZero = _forceMinimumPosToZero;
_tfBottomLeft.ContextMenu.ForceMinimumPosToZero = _forceMinimumPosToZero;
_tfBottomRight.ContextMenu.ForceMinimumPosToZero = _forceMinimumPosToZero;
}) { CheckType = MenuItemCheckStyle.Checked, Checked = _forceMinimumPosToZero },
_miUseSubMenusSingleFrame = new MenuItem ("Use_SubMenusSingleFrame", "",
() => _contextMenu.UseSubMenusSingleFrame = (bool)(_miUseSubMenusSingleFrame.Checked = _useSubMenusSingleFrame = !_useSubMenusSingleFrame)) {
CheckType = MenuItemCheckStyle.Checked, Checked = _useSubMenusSingleFrame
},
null,
new MenuItem ("_Quit", "", () => Application.RequestStop ())
})
) { ForceMinimumPosToZero = _forceMinimumPosToZero, UseSubMenusSingleFrame = _useSubMenusSingleFrame };
_tfTopLeft.ContextMenu.ForceMinimumPosToZero = _forceMinimumPosToZero;
_tfTopRight.ContextMenu.ForceMinimumPosToZero = _forceMinimumPosToZero;
_tfMiddle.ContextMenu.ForceMinimumPosToZero = _forceMinimumPosToZero;
_tfBottomLeft.ContextMenu.ForceMinimumPosToZero = _forceMinimumPosToZero;
_tfBottomRight.ContextMenu.ForceMinimumPosToZero = _forceMinimumPosToZero;
_contextMenu.Show ();
}
private MenuItem [] GetSupportedCultures ()
{
List<MenuItem> supportedCultures = new List<MenuItem> ();
var index = -1;
foreach (var c in _cultureInfos) {
var culture = new MenuItem {
CheckType = MenuItemCheckStyle.Checked
};
if (index == -1) {
culture.Title = "_English";
culture.Help = "en-US";
culture.Checked = Thread.CurrentThread.CurrentUICulture.Name == "en-US";
CreateAction (supportedCultures, culture);
supportedCultures.Add (culture);
index++;
culture = new MenuItem {
CheckType = MenuItemCheckStyle.Checked
};
}
culture.Title = $"_{c.Parent.EnglishName}";
culture.Help = c.Name;
culture.Checked = Thread.CurrentThread.CurrentUICulture.Name == c.Name;
CreateAction (supportedCultures, culture);
supportedCultures.Add (culture);
}
return supportedCultures.ToArray ();
void CreateAction (List<MenuItem> supportedCultures, MenuItem culture)
{
culture.Action += () => {
Thread.CurrentThread.CurrentUICulture = new CultureInfo (culture.Help);
culture.Checked = true;
foreach (var item in supportedCultures) {
item.Checked = item.Help == Thread.CurrentThread.CurrentUICulture.Name;
}
};
}
}
}