Files
Terminal.Gui/UICatalog/Scenarios/Text.cs
Thomas Nind ea7981dc59 Adds Key Binding support. Also refactors Autocomplete and Undo/Redo. (#1556)
* Refactored ProcessKey to use public methods for case logic

* Added KeyBinding class

* Refactored key binding to split key->command from command->implementation

This reduces duplication and simplifies the API

* Finishing key bindings implementation in ListView.

* Adding more unit tests to the ListView.

* Added key bindings to the Button and more features.

* Replaces Action for Func<KeyEvent, bool> on CommandImplementations.

* Allowing commands to have any number of arguments.

* Implementing key bindings on Checkbox view.

* Added test for changing HotKey in Button and made ReplaceKeyBinding protected

* Changed `CommandImplementations` to `Func<KeyEvent, bool>` to better understand current command implementations

* Implementing key bindings in ComboBox.

* Renamed Command keys and fixed ComboBox issues:

- Fixed pressing Esc in ListAndCombos scenario without selecting cause an array out of bounds error
- Changed the Esc key in ComboBox to also collapse the list selection
- Added bool return to public virtual method Expand and Collapse (this is a breaking change)

* Implementing key bindings in DateField.

* Organizing some things.

* Implementing key bindings on TimeField.

* No key bindings on FrameView.

* Added keybinding support to TreeView

* Added mouse support and more features.

* Updating NuGet packages.

* Putting text on the same line.

* Changing function command to Func<bool>.

* Added a read only Position, CursorPosition properties and events.

* Keybindings for GraphView

* Added a stream argument to ApplyEdits to only save the edits.

* Implementing key bindings on the HexView.

* Added MenuOpened event and others bug fixes.

* Fixing typo.

* Unifying constructors initializations.

* Implementing keybindings in the Menu.

* Removing unnecessary variable.

* Implementing keybindings in RadioGroup view.

* Changing Home to TopHome and End to BottomEnd.

* Implementing keybindings in the ScrollView.

* Changing the PageLeft and PageRight keybindings.

* Fixing PageLeft and RightPage.

* Removing CleanUp command.

* Key bindings for TabView

* Keybindings for TableView

* Fixed unit tests for PageDown to correctly assign input focus to the TableView

* Fixes the CalculateLeftColumn method avoiding jump two columns on forward moving.

* Fixes #1525. Gives the same backspace behavior as TextView.

* Changes kill-to-start key to work on Linux too.

* Fixes SelectedStart, SelectedText and some cleaning.

* Implementing keybindings in TextField.

* Updated command names and merged as discussed with @BDisp

- Merged LeftItem and LeftChar to Left (same for Right).
- Also renamed Kill to Cut
- Added ScrollLeft / ScrollRight (and renamed ScrollLineUp to just ScrollUp

* Renamed Command.InsertChar to ToggleOverwriteMode and added Enable/Disable

* Removed 'Mode' suffix from toggle overwrite

* Allows navigation to outside a TextView if IsMdiContainer is true.

* Implementing keybindings in Toplevel.

* Fixing null reference exception.

* Changing to keys instances events instead static.

* Transferring the events to the Toplevel.

* Implementing keybindings in TextView.

* Removing static from the QuitKeyChanged and adding unit test.

* Replacing Added with the Initialized event.

* Ignore control characters and other special keys.

* Changing InvokeKeybindings to return Nullable bool and added two more keys to the Toplevel.

* Implementing keybindings in Autocomplete. I had to derive from View.

* Added keybindings menu item to UICatalog

* Added ClearBinding

* Implementing IAutocomplete, abstract Autocomplete and derived TextViewAutocomplete.

* Implementing keybindings in the TextValidateProvider

* Add keybinding to CellActivationKey.

* Fixing some formats.

* Add ObjectActivationKey to the keybindings.

* Made it much easier to implement abstract base `Autocomplete` in other views by moving methods up out of `TextViewAutocomplete` implementation

* Allowing Autocomplete to popup inside or outside the container.

* Fixes the cursor not being showing if the text length is equal to the view width.

* A unit test to prove the 4df5897.

* Removed unused method `GetCursorPosition` from Autocomplete

* Trimmed down implementation specific methods from IAutocomplete

* Fixed xmldoc comment tag

* Format Autocomplete on multiline and fixes wrap settings.

* Adding keys from a to z to avoid the Key.Space on ToString.

* Fixes the vertical position outside the container.

* Adding more key unit tests.

* Changing comment to upper case and proving that doesn't will breaking nothing.

* Replaces Pos.Bottom to Pos.AnchorEnd.

* Fixes popup on resizing.

* Should only using the Pos.Bottom to position outside the view.

* Fixes #1584

* Fixes https://github.com/migueldeicaza/gui.cs/issues/1584#issuecomment-1027987475

* Fixes some bugs with SelectedItem.

* Command must also return a nullable bool.

* Ensures updating the ComboBox text on leaving the control.

* Only with the nullable bool was possible to make the MoveUp and the MoveDown working.

* Added logging of which scenario failed in test

Co-authored-by: BDisp <bd.bdisp@gmail.com>
2022-02-08 10:40:40 -08:00

176 lines
4.7 KiB
C#

using NStack;
using System;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using Terminal.Gui;
using Terminal.Gui.TextValidateProviders;
namespace UICatalog.Scenarios {
[ScenarioMetadata (Name: "Text Input Controls", Description: "Tests all text input controls")]
[ScenarioCategory ("Controls")]
[ScenarioCategory ("Bug Repro")]
public class Text : Scenario {
public override void Setup ()
{
var s = "TAB to jump between text fields.";
var textField = new TextField (s) {
X = 1,
Y = 1,
Width = Dim.Percent (50),
//ColorScheme = Colors.Dialog
};
textField.TextChanging += TextField_TextChanging;
void TextField_TextChanging (TextChangingEventArgs e)
{
textField.Autocomplete.AllSuggestions = Regex.Matches (e.NewText.ToString (), "\\w+")
.Select (s => s.Value)
.Distinct ().ToList ();
}
Win.Add (textField);
var labelMirroringTextField = new Label (textField.Text) {
X = Pos.Right (textField) + 1,
Y = Pos.Top (textField),
Width = Dim.Fill (1)
};
Win.Add (labelMirroringTextField);
textField.TextChanged += (prev) => {
labelMirroringTextField.Text = textField.Text;
};
var textView = new TextView () {
X = 1,
Y = 3,
Width = Dim.Percent (50),
Height = Dim.Percent (30),
ColorScheme = Colors.Dialog
};
textView.Text = s;
textView.DrawContent += TextView_DrawContent;
void TextView_DrawContent (Rect e)
{
textView.Autocomplete.AllSuggestions = Regex.Matches (textView.Text.ToString (), "\\w+")
.Select (s => s.Value)
.Distinct ().ToList ();
}
Win.Add (textView);
var labelMirroringTextView = new Label (textView.Text) {
X = Pos.Right (textView) + 1,
Y = Pos.Top (textView),
Width = Dim.Fill (1),
Height = Dim.Height (textView),
};
Win.Add (labelMirroringTextView);
textView.TextChanged += () => {
labelMirroringTextView.Text = textView.Text;
};
var btnMultiline = new Button ("Toggle Multiline") {
X = Pos.Right (textView) + 1,
Y = Pos.Top (textView) + 1
};
btnMultiline.Clicked += () => textView.Multiline = !textView.Multiline;
Win.Add (btnMultiline);
// BUGBUG: 531 - TAB doesn't go to next control from HexView
var hexView = new HexView (new System.IO.MemoryStream (Encoding.ASCII.GetBytes (s))) {
X = 1,
Y = Pos.Bottom (textView) + 1,
Width = Dim.Fill (1),
Height = Dim.Percent (30),
//ColorScheme = Colors.Dialog
};
Win.Add (hexView);
var dateField = new DateField (System.DateTime.Now) {
X = 1,
Y = Pos.Bottom (hexView) + 1,
Width = 20,
//ColorScheme = Colors.Dialog,
IsShortFormat = false
};
Win.Add (dateField);
var labelMirroringDateField = new Label (dateField.Text) {
X = Pos.Right (dateField) + 1,
Y = Pos.Top (dateField),
Width = Dim.Width (dateField),
Height = Dim.Height (dateField),
};
Win.Add (labelMirroringDateField);
dateField.TextChanged += (prev) => {
labelMirroringDateField.Text = dateField.Text;
};
_timeField = new TimeField (DateTime.Now.TimeOfDay) {
X = Pos.Right (labelMirroringDateField) + 5,
Y = Pos.Bottom (hexView) + 1,
Width = 20,
//ColorScheme = Colors.Dialog,
IsShortFormat = false
};
Win.Add (_timeField);
_labelMirroringTimeField = new Label (_timeField.Text) {
X = Pos.Right (_timeField) + 1,
Y = Pos.Top (_timeField),
Width = Dim.Width (_timeField),
Height = Dim.Height (_timeField),
};
Win.Add (_labelMirroringTimeField);
_timeField.TimeChanged += TimeChanged;
// MaskedTextProvider
var netProviderLabel = new Label (".Net MaskedTextProvider [ 999 000 LLL >LLL| AAA aaa ]") {
X = Pos.Left (dateField),
Y = Pos.Bottom (dateField) + 1
};
Win.Add (netProviderLabel);
var netProvider = new NetMaskedTextProvider ("999 000 LLL > LLL | AAA aaa");
var netProviderField = new TextValidateField (netProvider) {
X = Pos.Right (netProviderLabel) + 1,
Y = Pos.Y (netProviderLabel)
};
Win.Add (netProviderField);
// TextRegexProvider
var regexProvider = new Label ("Gui.cs TextRegexProvider [ ^([0-9]?[0-9]?[0-9]|1000)$ ]") {
X = Pos.Left (netProviderLabel),
Y = Pos.Bottom (netProviderLabel) + 1
};
Win.Add (regexProvider);
var provider2 = new TextRegexProvider ("^([0-9]?[0-9]?[0-9]|1000)$") { ValidateOnInput = false };
var regexProviderField = new TextValidateField (provider2) {
X = Pos.Right (regexProvider) + 1,
Y = Pos.Y (regexProvider),
Width = 30,
TextAlignment = TextAlignment.Centered
};
Win.Add (regexProviderField);
}
TimeField _timeField;
Label _labelMirroringTimeField;
private void TimeChanged (DateTimeEventArgs<TimeSpan> e)
{
_labelMirroringTimeField.Text = _timeField.Text;
}
}
}