Files
Terminal.Gui/UICatalog/Scenarios/Text.cs
BDisp a3627aed5e Fixes #3189. TextValidateField doesn't show the cursor and doesn't have TextChanged event. (#3190)
* Prefix private fields with underscore and code cleanup.

* Rename to SetInitialProperties and fix a typo.

* Cleaning code and some adjustments.

* Fix default width for view.

* Enable cursor visibility.

* Reduces indentation and remove AutoInitShutdown.

* Add unit test for default Width is always equal to the provider DisplayText.Length.

* Also prevents showing the cursor if position is less than 0.

* Add OnTextChanged method and TextChanged event.

* Remove unnecessary TextChanged.
2024-01-24 22:53:34 -07:00

278 lines
9.4 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using Terminal.Gui;
using Terminal.Gui.TextValidateProviders;
namespace UICatalog.Scenarios;
[ScenarioMetadata ("Text Input Controls", "Tests all text input controls")]
[ScenarioCategory ("Controls")]
[ScenarioCategory ("Mouse and Keyboard")]
[ScenarioCategory ("Text and Formatting")]
public class Text : Scenario {
Label _labelMirroringTimeField;
TimeField _timeField;
public override void Setup ()
{
// TextField is a simple, single-line text input control
var textField = new TextField ("TextField with test text. Unicode shouldn't 𝔹A𝔽!") {
X = 1,
Y = 0,
Width = Dim.Percent (50) - 1,
// Height will be replaced with 1
Height = 2
};
var singleWordGenerator = new SingleWordSuggestionGenerator ();
textField.Autocomplete.SuggestionGenerator = singleWordGenerator;
textField.TextChanging += TextField_TextChanging;
void TextField_TextChanging (object sender, TextChangingEventArgs e)
{
singleWordGenerator.AllSuggestions = Regex.Matches (e.NewText, "\\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) - 1
};
Win.Add (labelMirroringTextField);
textField.TextChanged += (s, prev) => {
labelMirroringTextField.Text = textField.Text;
};
// TextView is a rich (as in functionality, not formatting) text editing control
var textView = new TextView {
X = 1,
Y = Pos.Bottom (textField) + 1,
Width = Dim.Percent (50) - 1,
Height = Dim.Percent (30)
};
textView.Text = "TextView with some more test text. Unicode shouldn't 𝔹A𝔽!";
textView.DrawContent += TextView_DrawContent;
// This shows how to enable autocomplete in TextView.
void TextView_DrawContent (object sender, DrawEventArgs e)
{
singleWordGenerator.AllSuggestions = Regex.Matches (textView.Text, "\\w+")
.Select (s => s.Value)
.Distinct ().ToList ();
}
Win.Add (textView);
var labelMirroringTextView = new Label {
X = Pos.Right (textView) + 1,
Y = Pos.Top (textView),
Width = Dim.Fill (1) - 1,
Height = Dim.Height (textView) - 1
};
Win.Add (labelMirroringTextView);
// Use ContentChanged to detect if the user has typed something in a TextView.
// The TextChanged property is only fired if the TextView.Text property is
// explicitly set
textView.ContentsChanged += (s, a) => {
labelMirroringTextView.Enabled = !labelMirroringTextView.Enabled;
labelMirroringTextView.Text = textView.Text;
};
// By default TextView is a multi-line control. It can be forced to
// single-line mode.
var chxMultiline = new CheckBox ("Multiline") {
X = Pos.Left (textView),
Y = Pos.Bottom (textView),
Checked = textView.Multiline
};
Win.Add (chxMultiline);
var chxWordWrap = new CheckBox ("Word Wrap") {
X = Pos.Right (chxMultiline) + 2,
Y = Pos.Top (chxMultiline),
Checked = textView.WordWrap
};
chxWordWrap.Toggled += (s, e) => textView.WordWrap = (bool)e.NewValue;
Win.Add (chxWordWrap);
// TextView captures Tabs (so users can enter /t into text) by default;
// This means using Tab to navigate doesn't work by default. This shows
// how to turn tab capture off.
var chxCaptureTabs = new CheckBox ("Capture Tabs") {
X = Pos.Right (chxWordWrap) + 2,
Y = Pos.Top (chxWordWrap),
Checked = textView.AllowsTab
};
chxMultiline.Toggled += (s, e) => {
textView.Multiline = (bool)e.NewValue;
if (!textView.Multiline && (bool)chxWordWrap.Checked) {
chxWordWrap.Checked = false;
}
if (!textView.Multiline && (bool)chxCaptureTabs.Checked) {
chxCaptureTabs.Checked = false;
}
};
var keyTab = textView.KeyBindings.GetKeyFromCommands (Command.Tab);
var keyBackTab = textView.KeyBindings.GetKeyFromCommands (Command.BackTab);
chxCaptureTabs.Toggled += (s, e) => {
if (e.NewValue == true) {
textView.KeyBindings.Add (keyTab, Command.Tab);
textView.KeyBindings.Add (keyBackTab, Command.BackTab);
} else {
textView.KeyBindings.Remove (keyTab);
textView.KeyBindings.Remove (keyBackTab);
}
textView.AllowsTab = (bool)e.NewValue;
};
Win.Add (chxCaptureTabs);
var hexEditor = new HexView (new MemoryStream (Encoding.UTF8.GetBytes ("HexEditor Unicode that shouldn't 𝔹A𝔽!"))) {
X = 1,
Y = Pos.Bottom (chxMultiline) + 1,
Width = Dim.Percent (50) - 1,
Height = Dim.Percent (30)
};
Win.Add (hexEditor);
var labelMirroringHexEditor = new Label {
X = Pos.Right (hexEditor) + 1,
Y = Pos.Top (hexEditor),
Width = Dim.Fill (1) - 1,
Height = Dim.Height (hexEditor) - 1
};
var array = ((MemoryStream)hexEditor.Source).ToArray ();
labelMirroringHexEditor.Text = Encoding.UTF8.GetString (array, 0, array.Length);
hexEditor.Edited += (s, kv) => {
hexEditor.ApplyEdits ();
var array = ((MemoryStream)hexEditor.Source).ToArray ();
labelMirroringHexEditor.Text = Encoding.UTF8.GetString (array, 0, array.Length);
};
Win.Add (labelMirroringHexEditor);
var dateField = new DateField (System.DateTime.Now) {
X = 1,
Y = Pos.Bottom (hexEditor) + 1,
Width = 20
};
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 += (s, prev) => {
labelMirroringDateField.Text = dateField.Text;
};
_timeField = new TimeField (DateTime.Now.TimeOfDay) {
X = Pos.Right (labelMirroringDateField) + 5,
Y = Pos.Bottom (hexEditor) + 1,
Width = 20,
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 - uses .NET MaskedTextProvider
var netProviderLabel = new Label ("NetMaskedTextProvider [ 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);
var labelMirroringNetProviderField = new Label (netProviderField.Text) {
X = Pos.Right (netProviderField) + 1,
Y = Pos.Top (netProviderField),
Width = Dim.Width (netProviderField),
Height = Dim.Height (netProviderField)
};
Win.Add (labelMirroringNetProviderField);
netProviderField.Provider.TextChanged += (s, prev) => {
labelMirroringNetProviderField.Text = netProviderField.Text;
};
// TextRegexProvider - Regex provider implemented by Terminal.Gui
var regexProvider = new Label ("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);
var labelMirroringRegexProviderField = new Label (regexProviderField.Text) {
X = Pos.Right (regexProviderField) + 1,
Y = Pos.Top (regexProviderField),
Width = Dim.Width (regexProviderField),
Height = Dim.Height (regexProviderField)
};
Win.Add (labelMirroringRegexProviderField);
regexProviderField.Provider.TextChanged += (s, prev) => {
labelMirroringRegexProviderField.Text = regexProviderField.Text;
};
var labelAppendAutocomplete = new Label ("Append Autocomplete:") {
Y = Pos.Y (regexProviderField) + 2,
X = 1
};
var appendAutocompleteTextField = new TextField {
X = Pos.Right (labelAppendAutocomplete),
Y = Pos.Top (labelAppendAutocomplete),
Width = Dim.Fill ()
};
appendAutocompleteTextField.Autocomplete = new AppendAutocomplete (appendAutocompleteTextField);
appendAutocompleteTextField.Autocomplete.SuggestionGenerator = new SingleWordSuggestionGenerator {
AllSuggestions = new List<string> {
"fish", "flipper", "fin", "fun", "the", "at", "there", "some", "my", "of", "be", "use", "her", "than", "and", "this", "an", "would", "first", "have", "each", "make", "water", "to", "from", "which", "like", "been", "in", "or", "she", "him", "call", "is", "one", "do", "into", "who", "you", "had", "how", "time", "oil", "that", "by", "their", "has", "its", "it", "word", "if", "look", "now", "he", "but", "will", "two", "find", "was", "not", "up", "more", "long", "for", "what", "other", "write",
"down", "on", "all", "about", "go", "day", "are", "were", "out", "see", "did", "as", "we", "many", "number", "get", "with", "when", "then", "no", "come", "his", "your", "them", "way", "made", "they", "can", "these", "could", "may", "said", "so", "people", "part"
}
};
Win.Add (labelAppendAutocomplete);
Win.Add (appendAutocompleteTextField);
}
void TimeChanged (object sender, DateTimeEventArgs<TimeSpan> e) => _labelMirroringTimeField.Text = _timeField.Text;
}