Files
Terminal.Gui/UICatalog/Scenarios/ASCIICustomButton.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

314 lines
9.5 KiB
C#

using System;
using System.Collections.Generic;
using System.Diagnostics;
using Terminal.Gui;
namespace UICatalog.Scenarios {
[ScenarioMetadata (Name: "ASCIICustomButtonTest", Description: "ASCIICustomButton sample")]
[ScenarioCategory ("Controls")]
public class ASCIICustomButtonTest : Scenario {
private static bool _smallerWindow;
private ScrollViewTestWindow _scrollViewTestWindow;
private MenuItem _miSmallerWindow;
public override void Init ()
{
Application.Init ();
_scrollViewTestWindow = new ScrollViewTestWindow ();
var menu = new MenuBar (new MenuBarItem [] {
new MenuBarItem("Window Size", new MenuItem [] {
_miSmallerWindow = new MenuItem ("Smaller Window", "", ChangeWindowSize) {
CheckType = MenuItemCheckStyle.Checked
},
null,
new MenuItem("Quit", "",() => Application.RequestStop(),null,null, (KeyCode)Application.QuitKey)
})
});
Application.Top.Add (menu, _scrollViewTestWindow);
Application.Run ();
}
private void ChangeWindowSize ()
{
_smallerWindow = (bool)(_miSmallerWindow.Checked = !_miSmallerWindow.Checked);
_scrollViewTestWindow.Dispose ();
Application.Top.Remove (_scrollViewTestWindow);
_scrollViewTestWindow = new ScrollViewTestWindow ();
Application.Top.Add (_scrollViewTestWindow);
}
public override void Run ()
{
}
public class ASCIICustomButton : Button {
public string Description => $"Description of: {id}";
public event Action<ASCIICustomButton> PointerEnter;
private Label fill;
private FrameView border;
private string id;
public ASCIICustomButton (string text, Pos x, Pos y, int width, int height) : base (text)
{
CustomInitialize ("", text, x, y, width, height);
}
public ASCIICustomButton (string id, string text, Pos x, Pos y, int width, int height) : base (text)
{
CustomInitialize (id, text, x, y, width, height);
}
private void CustomInitialize (string id, string text, Pos x, Pos y, int width, int height)
{
this.id = id;
X = x;
Y = y;
Frame = new Rect {
Width = width,
Height = height
};
border = new FrameView () {
Width = width,
Height = height
};
AutoSize = false;
var fillText = new System.Text.StringBuilder ();
for (int i = 0; i < Bounds.Height; i++) {
if (i > 0) {
fillText.AppendLine ("");
}
for (int j = 0; j < Bounds.Width; j++) {
fillText.Append ("█");
}
}
fill = new Label (fillText.ToString ()) {
Visible = false,
CanFocus = false
};
var title = new Label (text) {
X = Pos.Center (),
Y = Pos.Center (),
};
border.MouseClick += This_MouseClick;
// BUGBUG: v2 This uses internal knowledge of FrameView an breaks in v2 where FrameView does not have a ContentView
//border.Subviews [0].MouseClick += This_MouseClick;
fill.MouseClick += This_MouseClick;
title.MouseClick += This_MouseClick;
Add (border, fill, title);
}
private void This_MouseClick (object sender, MouseEventEventArgs obj)
{
OnMouseEvent (obj.MouseEvent);
}
public override bool OnMouseEvent (MouseEvent mouseEvent)
{
Debug.WriteLine ($"{mouseEvent.Flags}");
if (mouseEvent.Flags == MouseFlags.Button1Clicked) {
if (!HasFocus && SuperView != null) {
if (!SuperView.HasFocus) {
SuperView.SetFocus ();
}
SetFocus ();
SetNeedsDisplay ();
}
OnClicked ();
return true;
}
return base.OnMouseEvent (mouseEvent);
}
public override bool OnEnter (View view)
{
border.Visible = false;
fill.Visible = true;
PointerEnter.Invoke (this);
view = this;
return base.OnEnter (view);
}
public override bool OnLeave (View view)
{
border.Visible = true;
fill.Visible = false;
if (view == null)
view = this;
return base.OnLeave (view);
}
}
public class ScrollViewTestWindow : Window {
private List<Button> buttons;
private const int BUTTONS_ON_PAGE = 7;
private const int BUTTON_HEIGHT = 3;
private ScrollView scrollView;
private ASCIICustomButton selected;
public ScrollViewTestWindow ()
{
Title = "ScrollViewTestWindow";
Label titleLabel = null;
if (_smallerWindow) {
Width = 80;
Height = 25;
scrollView = new ScrollView () {
X = 3,
Y = 1,
Width = 24,
Height = BUTTONS_ON_PAGE * BUTTON_HEIGHT,
ShowVerticalScrollIndicator = true,
ShowHorizontalScrollIndicator = false
};
} else {
Width = Dim.Fill ();
Height = Dim.Fill ();
titleLabel = new Label ("DOCUMENTS") {
X = 0,
Y = 0
};
scrollView = new ScrollView () {
X = 0,
Y = 1,
Width = 27,
Height = BUTTONS_ON_PAGE * BUTTON_HEIGHT,
ShowVerticalScrollIndicator = true,
ShowHorizontalScrollIndicator = false
};
}
scrollView.KeyBindings.Clear ();
buttons = new List<Button> ();
Button prevButton = null;
int count = 20;
for (int j = 0; j < count; j++) {
Pos yPos = prevButton == null ? 0 : Pos.Bottom (prevButton);
var button = new ASCIICustomButton (j.ToString (), $"section {j}", 0, yPos, 25, BUTTON_HEIGHT);
button.Id = $"button{j}";
button.Clicked += Button_Clicked;
button.PointerEnter += Button_PointerEnter;
button.MouseClick += Button_MouseClick;
button.KeyDown += Button_KeyPress;
scrollView.Add (button);
buttons.Add (button);
prevButton = button;
}
var closeButton = new ASCIICustomButton ("close", "Close", 0, Pos.Bottom (prevButton), 25, BUTTON_HEIGHT);
closeButton.Clicked += Button_Clicked;
closeButton.PointerEnter += Button_PointerEnter;
closeButton.MouseClick += Button_MouseClick;
closeButton.KeyDown += Button_KeyPress;
scrollView.Add (closeButton);
buttons.Add (closeButton);
var pages = buttons.Count / BUTTONS_ON_PAGE;
if (buttons.Count % BUTTONS_ON_PAGE > 0)
pages++;
scrollView.ContentSize = new Size (25, pages * BUTTONS_ON_PAGE * BUTTON_HEIGHT);
if (_smallerWindow) {
Add (scrollView);
} else {
Add (titleLabel, scrollView);
}
}
private void Button_KeyPress (object sender, Key obj)
{
switch (obj.KeyCode) {
case KeyCode.End:
scrollView.ContentOffset = new Point (scrollView.ContentOffset.X,
-(scrollView.ContentSize.Height - scrollView.Frame.Height
+ (scrollView.ShowHorizontalScrollIndicator ? 1 : 0)));
obj.Handled = true;
return;
case KeyCode.Home:
scrollView.ContentOffset = new Point (scrollView.ContentOffset.X, 0);
obj.Handled = true;
return;
case KeyCode.PageDown:
scrollView.ContentOffset = new Point (scrollView.ContentOffset.X,
Math.Max (scrollView.ContentOffset.Y - scrollView.Frame.Height,
-(scrollView.ContentSize.Height - scrollView.Frame.Height
+ (scrollView.ShowHorizontalScrollIndicator ? 1 : 0))));
obj.Handled = true;
return;
case KeyCode.PageUp:
scrollView.ContentOffset = new Point (scrollView.ContentOffset.X,
Math.Min (scrollView.ContentOffset.Y + scrollView.Frame.Height, 0));
obj.Handled = true;
return;
}
}
private void Button_MouseClick (object sender, MouseEventEventArgs obj)
{
if (obj.MouseEvent.Flags == MouseFlags.WheeledDown) {
scrollView.ContentOffset = new Point (scrollView.ContentOffset.X,
scrollView.ContentOffset.Y - BUTTON_HEIGHT);
obj.Handled = true;
} else if (obj.MouseEvent.Flags == MouseFlags.WheeledUp) {
scrollView.ContentOffset = new Point (scrollView.ContentOffset.X,
Math.Min (scrollView.ContentOffset.Y + BUTTON_HEIGHT, 0));
obj.Handled = true;
}
}
private void Button_Clicked (object sender, EventArgs e)
{
MessageBox.Query ("Button clicked.", $"'{selected.Text}' clicked!", "Ok");
if (selected.Text == "Close") {
Application.RequestStop ();
}
}
private void Button_PointerEnter (ASCIICustomButton obj)
{
bool? moveDown;
if (obj.Frame.Y > selected?.Frame.Y) {
moveDown = true;
} else if (obj.Frame.Y < selected?.Frame.Y) {
moveDown = false;
} else {
moveDown = null;
}
var offSet = selected != null ? obj.Frame.Y - selected.Frame.Y + (-scrollView.ContentOffset.Y % BUTTON_HEIGHT) : 0;
selected = obj;
if (moveDown == true && selected.Frame.Y + scrollView.ContentOffset.Y + BUTTON_HEIGHT >= scrollView.Frame.Height && offSet != BUTTON_HEIGHT) {
scrollView.ContentOffset = new Point (scrollView.ContentOffset.X,
Math.Min (scrollView.ContentOffset.Y - BUTTON_HEIGHT, -(selected.Frame.Y - scrollView.Frame.Height + BUTTON_HEIGHT)));
} else if (moveDown == true && selected.Frame.Y + scrollView.ContentOffset.Y >= scrollView.Frame.Height) {
scrollView.ContentOffset = new Point (scrollView.ContentOffset.X,
scrollView.ContentOffset.Y - BUTTON_HEIGHT);
} else if (moveDown == true && selected.Frame.Y + scrollView.ContentOffset.Y < 0) {
scrollView.ContentOffset = new Point (scrollView.ContentOffset.X,
-selected.Frame.Y);
} else if (moveDown == false && selected.Frame.Y < -scrollView.ContentOffset.Y) {
scrollView.ContentOffset = new Point (scrollView.ContentOffset.X,
Math.Max (scrollView.ContentOffset.Y + BUTTON_HEIGHT, selected.Frame.Y));
} else if (moveDown == false && selected.Frame.Y + scrollView.ContentOffset.Y > scrollView.Frame.Height) {
scrollView.ContentOffset = new Point (scrollView.ContentOffset.X,
-(selected.Frame.Y - scrollView.Frame.Height + BUTTON_HEIGHT));
}
}
}
}
}