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

187 lines
4.9 KiB
C#

using System.Linq;
using System.Text.RegularExpressions;
using Terminal.Gui;
namespace UICatalog.Scenarios {
[ScenarioMetadata (Name: "TextView Autocomplete Popup", Description: "Show five TextView Autocomplete Popup effects")]
[ScenarioCategory ("Controls")]
public class TextViewAutocompletePopup : Scenario {
TextView textViewTopLeft;
TextView textViewTopRight;
TextView textViewBottomLeft;
TextView textViewBottomRight;
TextView textViewCentered;
MenuItem miMultiline;
MenuItem miWrap;
StatusItem siMultiline;
StatusItem siWrap;
int height = 10;
public override void Setup ()
{
Win.Title = GetName ();
var width = 20;
var colorScheme = Colors.Dialog;
var text = " jamp jemp jimp jomp jump";
var menu = new MenuBar (new MenuBarItem [] {
new MenuBarItem ("_File", new MenuItem [] {
miMultiline = new MenuItem ("_Multiline", "", () => Multiline()){CheckType = MenuItemCheckStyle.Checked},
miWrap = new MenuItem ("_Word Wrap", "", () => WordWrap()){CheckType = MenuItemCheckStyle.Checked},
new MenuItem ("_Quit", "", () => Quit())
})
});
Top.Add (menu);
textViewTopLeft = new TextView () {
Width = width,
Height = height,
ColorScheme = colorScheme,
Text = text
};
textViewTopLeft.DrawContent += TextViewTopLeft_DrawContent;
Win.Add (textViewTopLeft);
textViewTopRight = new TextView () {
X = Pos.AnchorEnd (width),
Width = width,
Height = height,
ColorScheme = colorScheme,
Text = text
};
textViewTopRight.DrawContent += TextViewTopRight_DrawContent;
Win.Add (textViewTopRight);
textViewBottomLeft = new TextView () {
Y = Pos.AnchorEnd (height),
Width = width,
Height = height,
ColorScheme = colorScheme,
Text = text
};
textViewBottomLeft.DrawContent += TextViewBottomLeft_DrawContent;
Win.Add (textViewBottomLeft);
textViewBottomRight = new TextView () {
X = Pos.AnchorEnd (width),
Y = Pos.AnchorEnd (height),
Width = width,
Height = height,
ColorScheme = colorScheme,
Text = text
};
textViewBottomRight.DrawContent += TextViewBottomRight_DrawContent;
Win.Add (textViewBottomRight);
textViewCentered = new TextView () {
X = Pos.Center (),
Y = Pos.Center (),
Width = width,
Height = height,
ColorScheme = colorScheme,
Text = text
};
textViewCentered.DrawContent += TextViewCentered_DrawContent;
Win.Add (textViewCentered);
miMultiline.Checked = textViewTopLeft.Multiline;
miWrap.Checked = textViewTopLeft.WordWrap;
var statusBar = new StatusBar (new StatusItem [] {
new StatusItem(Key.CtrlMask | Key.Q, "~^Q~ Quit", () => Quit()),
siMultiline = new StatusItem(Key.Null, "", null),
siWrap = new StatusItem(Key.Null, "", null)
});
Top.Add (statusBar);
Win.LayoutStarted += Win_LayoutStarted;
}
private void Win_LayoutStarted (View.LayoutEventArgs obj)
{
miMultiline.Checked = textViewTopLeft.Multiline;
miWrap.Checked = textViewTopLeft.WordWrap;
SetMultilineStatusText ();
SetWrapStatusText ();
if (miMultiline.Checked) {
height = 10;
} else {
height = 1;
}
textViewBottomLeft.Y = textViewBottomRight.Y = Pos.AnchorEnd (height);
}
private void SetMultilineStatusText ()
{
siMultiline.Title = $"Multiline: {miMultiline.Checked}";
}
private void SetWrapStatusText ()
{
siWrap.Title = $"WordWrap: {miWrap.Checked}";
}
private void SetAllSuggestions (TextView view)
{
view.Autocomplete.AllSuggestions = Regex.Matches (view.Text.ToString (), "\\w+")
.Select (s => s.Value)
.Distinct ().ToList ();
}
private void TextViewCentered_DrawContent (Rect obj)
{
SetAllSuggestions (textViewCentered);
}
private void TextViewBottomRight_DrawContent (Rect obj)
{
SetAllSuggestions (textViewBottomRight);
}
private void TextViewBottomLeft_DrawContent (Rect obj)
{
SetAllSuggestions (textViewBottomLeft);
}
private void TextViewTopRight_DrawContent (Rect obj)
{
SetAllSuggestions (textViewTopRight);
}
private void TextViewTopLeft_DrawContent (Rect obj)
{
SetAllSuggestions (textViewTopLeft);
}
private void Multiline ()
{
miMultiline.Checked = !miMultiline.Checked;
SetMultilineStatusText ();
textViewTopLeft.Multiline = miMultiline.Checked;
textViewTopRight.Multiline = miMultiline.Checked;
textViewBottomLeft.Multiline = miMultiline.Checked;
textViewBottomRight.Multiline = miMultiline.Checked;
textViewCentered.Multiline = miMultiline.Checked;
}
private void WordWrap ()
{
miWrap.Checked = !miWrap.Checked;
textViewTopLeft.WordWrap = miWrap.Checked;
textViewTopRight.WordWrap = miWrap.Checked;
textViewBottomLeft.WordWrap = miWrap.Checked;
textViewBottomRight.WordWrap = miWrap.Checked;
textViewCentered.WordWrap = miWrap.Checked;
miWrap.Checked = textViewTopLeft.WordWrap;
SetWrapStatusText ();
}
private void Quit ()
{
Application.RequestStop ();
}
}
}