diff --git a/Examples/CommunityToolkitExample/LoginView.Designer.cs b/Examples/CommunityToolkitExample/LoginView.Designer.cs index e1bddff45..77b114a33 100644 --- a/Examples/CommunityToolkitExample/LoginView.Designer.cs +++ b/Examples/CommunityToolkitExample/LoginView.Designer.cs @@ -1,4 +1,6 @@ -using Terminal.Gui; + +using Terminal.Gui.ViewBase; +using Terminal.Gui.Views; namespace CommunityToolkitExample; diff --git a/Examples/CommunityToolkitExample/LoginView.cs b/Examples/CommunityToolkitExample/LoginView.cs index 4e2d505fe..70ec87f07 100644 --- a/Examples/CommunityToolkitExample/LoginView.cs +++ b/Examples/CommunityToolkitExample/LoginView.cs @@ -1,5 +1,6 @@ using CommunityToolkit.Mvvm.Messaging; -using Terminal.Gui; +using Terminal.Gui.App; +using Terminal.Gui.ViewBase; namespace CommunityToolkitExample; diff --git a/Examples/CommunityToolkitExample/LoginViewModel.cs b/Examples/CommunityToolkitExample/LoginViewModel.cs index c2d624640..bdec99519 100644 --- a/Examples/CommunityToolkitExample/LoginViewModel.cs +++ b/Examples/CommunityToolkitExample/LoginViewModel.cs @@ -1,7 +1,8 @@ using CommunityToolkit.Mvvm.ComponentModel; using CommunityToolkit.Mvvm.Input; using CommunityToolkit.Mvvm.Messaging; -using Terminal.Gui; +using Terminal.Gui.Configuration; +using Terminal.Gui.Drawing; namespace CommunityToolkitExample; diff --git a/Examples/CommunityToolkitExample/Program.cs b/Examples/CommunityToolkitExample/Program.cs index a89b3848f..265c979aa 100644 --- a/Examples/CommunityToolkitExample/Program.cs +++ b/Examples/CommunityToolkitExample/Program.cs @@ -1,5 +1,8 @@ using Microsoft.Extensions.DependencyInjection; -using Terminal.Gui; +using Terminal.Gui.Configuration; +using Terminal.Gui.App; +using Terminal.Gui.ViewBase; + namespace CommunityToolkitExample; diff --git a/Examples/Example/Example.cs b/Examples/Example/Example.cs index 549220848..d3e02a342 100644 --- a/Examples/Example/Example.cs +++ b/Examples/Example/Example.cs @@ -1,9 +1,14 @@ -// This is a simple example application. For the full range of functionality +// A simple Terminal.Gui example in C# - using C# 9.0 Top-level statements + +// This is a simple example application. For the full range of functionality // see the UICatalog project -// A simple Terminal.Gui example in C# - using C# 9.0 Top-level statements - -using Terminal.Gui; +using Terminal.Gui.Configuration; +using Terminal.Gui.App; +using Terminal.Gui.Drawing; +using Terminal.Gui.ViewBase; +using Terminal.Gui.Views; +using Attribute = Terminal.Gui.Drawing.Attribute; // Override the default configuration for the application to use the Light theme ConfigurationManager.RuntimeConfig = """{ "Theme": "Light" }"""; diff --git a/Examples/NativeAot/Program.cs b/Examples/NativeAot/Program.cs index ff5636fdf..bfc566c6d 100644 --- a/Examples/NativeAot/Program.cs +++ b/Examples/NativeAot/Program.cs @@ -3,7 +3,10 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Globalization; -using Terminal.Gui; +using Terminal.Gui.Configuration; +using Terminal.Gui.Views; +using Terminal.Gui.App; +using Terminal.Gui.ViewBase; namespace NativeAot; diff --git a/Examples/ReactiveExample/LoginView.cs b/Examples/ReactiveExample/LoginView.cs index 4cef902fd..8cb97cb89 100644 --- a/Examples/ReactiveExample/LoginView.cs +++ b/Examples/ReactiveExample/LoginView.cs @@ -2,7 +2,10 @@ using System.Reactive.Disposables; using System.Reactive.Linq; using ReactiveMarbles.ObservableEvents; using ReactiveUI; -using Terminal.Gui; +using Terminal.Gui.Configuration; +using Terminal.Gui.Views; +using Terminal.Gui.App; +using Terminal.Gui.ViewBase; namespace ReactiveExample; diff --git a/Examples/ReactiveExample/LoginViewModel.cs b/Examples/ReactiveExample/LoginViewModel.cs index 2c2f98a53..d3efa88d6 100644 --- a/Examples/ReactiveExample/LoginViewModel.cs +++ b/Examples/ReactiveExample/LoginViewModel.cs @@ -1,12 +1,9 @@ -using System; -using System.ComponentModel; using System.Reactive; using System.Reactive.Linq; using System.Runtime.Serialization; -using System.Threading.Tasks; using ReactiveUI; using ReactiveUI.SourceGenerators; -using Terminal.Gui; +using Terminal.Gui.Input; namespace ReactiveExample; diff --git a/Examples/ReactiveExample/Program.cs b/Examples/ReactiveExample/Program.cs index 10b5bd3da..910d1f4a4 100644 --- a/Examples/ReactiveExample/Program.cs +++ b/Examples/ReactiveExample/Program.cs @@ -1,6 +1,9 @@ using System.Reactive.Concurrency; using ReactiveUI; -using Terminal.Gui; +using ReactiveUI.SourceGenerators; +using Terminal.Gui.Configuration; +using Terminal.Gui.App; +using Terminal.Gui.ViewBase; namespace ReactiveExample; diff --git a/Examples/ReactiveExample/TerminalScheduler.cs b/Examples/ReactiveExample/TerminalScheduler.cs index df1d882fd..9c8286722 100644 --- a/Examples/ReactiveExample/TerminalScheduler.cs +++ b/Examples/ReactiveExample/TerminalScheduler.cs @@ -1,7 +1,7 @@ using System; using System.Reactive.Concurrency; using System.Reactive.Disposables; -using Terminal.Gui; +using Terminal.Gui.App; namespace ReactiveExample; diff --git a/Examples/ReactiveExample/ViewExtensions.cs b/Examples/ReactiveExample/ViewExtensions.cs index 12c69291f..f1f639900 100644 --- a/Examples/ReactiveExample/ViewExtensions.cs +++ b/Examples/ReactiveExample/ViewExtensions.cs @@ -1,5 +1,6 @@ using System; -using Terminal.Gui; +using Terminal.Gui.ViewBase; +using Terminal.Gui.Views; namespace ReactiveExample; public static class ViewExtensions diff --git a/Examples/SelfContained/Program.cs b/Examples/SelfContained/Program.cs index c9b71a64f..2cfdb8cc9 100644 --- a/Examples/SelfContained/Program.cs +++ b/Examples/SelfContained/Program.cs @@ -3,7 +3,10 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Globalization; -using Terminal.Gui; +using Terminal.Gui.Configuration; +using Terminal.Gui.App; +using Terminal.Gui.ViewBase; +using Terminal.Gui.Views; namespace SelfContained; diff --git a/Examples/UICatalog/README.md b/Examples/UICatalog/README.md index 832ef7f7a..c9c810f42 100644 --- a/Examples/UICatalog/README.md +++ b/Examples/UICatalog/README.md @@ -55,7 +55,6 @@ To add a new **Scenario** simply: The sample below is provided in the `.\UICatalog\Scenarios` directory as a generic sample that can be copied and re-named: ```csharp -using Terminal.Gui; namespace UICatalog { [ScenarioMetadata (Name: "Generic", Description: "Generic sample - A template for creating new Scenarios")] diff --git a/Examples/UICatalog/Scenario.cs b/Examples/UICatalog/Scenario.cs index 5cef80218..702661bae 100644 --- a/Examples/UICatalog/Scenario.cs +++ b/Examples/UICatalog/Scenario.cs @@ -4,7 +4,6 @@ using System.Collections.Generic; using System.Collections.ObjectModel; using System.Diagnostics; using System.Linq; -using Terminal.Gui; namespace UICatalog; diff --git a/Examples/UICatalog/Scenarios/Adornments.cs b/Examples/UICatalog/Scenarios/Adornments.cs index 3374d0786..5ae5c5e68 100644 --- a/Examples/UICatalog/Scenarios/Adornments.cs +++ b/Examples/UICatalog/Scenarios/Adornments.cs @@ -1,5 +1,4 @@ using System; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/AllViewsTester.cs b/Examples/UICatalog/Scenarios/AllViewsTester.cs index 6c6b203cc..71d9edbe5 100644 --- a/Examples/UICatalog/Scenarios/AllViewsTester.cs +++ b/Examples/UICatalog/Scenarios/AllViewsTester.cs @@ -3,7 +3,6 @@ using System; using System.Collections.Generic; using System.Diagnostics; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/AnimationScenario/AnimationScenario.cs b/Examples/UICatalog/Scenarios/AnimationScenario/AnimationScenario.cs index 9acf2d931..bb3daaa7c 100644 --- a/Examples/UICatalog/Scenarios/AnimationScenario/AnimationScenario.cs +++ b/Examples/UICatalog/Scenarios/AnimationScenario/AnimationScenario.cs @@ -8,7 +8,6 @@ using System.Threading.Tasks; using SixLabors.ImageSharp; using SixLabors.ImageSharp.PixelFormats; using SixLabors.ImageSharp.Processing; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/AnsiRequestsScenario.cs b/Examples/UICatalog/Scenarios/AnsiRequestsScenario.cs index cc952913e..9a68b2567 100644 --- a/Examples/UICatalog/Scenarios/AnsiRequestsScenario.cs +++ b/Examples/UICatalog/Scenarios/AnsiRequestsScenario.cs @@ -2,7 +2,6 @@ using System.Collections.Generic; using System.Linq; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Arrangement.cs b/Examples/UICatalog/Scenarios/Arrangement.cs index 3d8d9d1a3..29994d78f 100644 --- a/Examples/UICatalog/Scenarios/Arrangement.cs +++ b/Examples/UICatalog/Scenarios/Arrangement.cs @@ -1,5 +1,4 @@ using System.Collections.Generic; -using Terminal.Gui; using Timer = System.Timers.Timer; namespace UICatalog.Scenarios; @@ -192,7 +191,7 @@ public class Arrangement : Scenario TransparentView transparentView = new () { Title = "Transparent", - ViewportSettings = Terminal.Gui.ViewportSettings.Transparent, + ViewportSettings = Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent, X = 30, Y = 5, Width = 35, @@ -209,7 +208,7 @@ public class Arrangement : Scenario testFrame.Add (new TransparentView () { Title = "Transparent|TransparentMouse", - ViewportSettings = Terminal.Gui.ViewportSettings.TransparentMouse | Terminal.Gui.ViewportSettings.Transparent + ViewportSettings = Terminal.Gui.ViewBase.ViewportSettingsFlags.TransparentMouse | Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent }); adornmentsEditor.AutoSelectSuperView = testFrame; @@ -336,7 +335,7 @@ public class Arrangement : Scenario Width = 30; Height = 10; Arrangement = ViewArrangement.Overlapped | ViewArrangement.Resizable | ViewArrangement.Movable; - ViewportSettings |= Terminal.Gui.ViewportSettings.Transparent | Terminal.Gui.ViewportSettings.TransparentMouse; + ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent | Terminal.Gui.ViewBase.ViewportSettingsFlags.TransparentMouse; Padding!.Thickness = new Thickness (1); diff --git a/Examples/UICatalog/Scenarios/Bars.cs b/Examples/UICatalog/Scenarios/Bars.cs index 1bd5385ce..538af7520 100644 --- a/Examples/UICatalog/Scenarios/Bars.cs +++ b/Examples/UICatalog/Scenarios/Bars.cs @@ -4,7 +4,6 @@ using System.Collections.ObjectModel; using System.ComponentModel; using System.Linq; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Buttons.cs b/Examples/UICatalog/Scenarios/Buttons.cs index 538a728d4..cc66fafba 100644 --- a/Examples/UICatalog/Scenarios/Buttons.cs +++ b/Examples/UICatalog/Scenarios/Buttons.cs @@ -3,7 +3,6 @@ using System.Collections.Generic; using System.ComponentModel; using System.Text; using JetBrains.Annotations; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs b/Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs index 2512e8de6..58f467d01 100644 --- a/Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs +++ b/Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs @@ -5,7 +5,6 @@ using System.Collections.Generic; using System.Globalization; using System.Linq; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ChineseUI.cs b/Examples/UICatalog/Scenarios/ChineseUI.cs index 0cc91ca4f..cc80c7ea9 100644 --- a/Examples/UICatalog/Scenarios/ChineseUI.cs +++ b/Examples/UICatalog/Scenarios/ChineseUI.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; - + namespace UICatalog.Scenarios; [ScenarioMetadata ("ChineseUI", "Chinese UI")] diff --git a/Examples/UICatalog/Scenarios/ClassExplorer.cs b/Examples/UICatalog/Scenarios/ClassExplorer.cs index 60e88e3e0..efcb0ceeb 100644 --- a/Examples/UICatalog/Scenarios/ClassExplorer.cs +++ b/Examples/UICatalog/Scenarios/ClassExplorer.cs @@ -3,7 +3,6 @@ using System.Collections.Generic; using System.Linq; using System.Reflection; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Clipping.cs b/Examples/UICatalog/Scenarios/Clipping.cs index c7fd83493..986a466f2 100644 --- a/Examples/UICatalog/Scenarios/Clipping.cs +++ b/Examples/UICatalog/Scenarios/Clipping.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; -using Timer = System.Timers.Timer; +using Timer = System.Timers.Timer; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/CollectionNavigatorTester.cs b/Examples/UICatalog/Scenarios/CollectionNavigatorTester.cs index 592164d31..d1dec203c 100644 --- a/Examples/UICatalog/Scenarios/CollectionNavigatorTester.cs +++ b/Examples/UICatalog/Scenarios/CollectionNavigatorTester.cs @@ -2,7 +2,6 @@ using System.Collections.Generic; using System.Collections.ObjectModel; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ColorPicker.cs b/Examples/UICatalog/Scenarios/ColorPicker.cs index 491b2543d..87e429177 100644 --- a/Examples/UICatalog/Scenarios/ColorPicker.cs +++ b/Examples/UICatalog/Scenarios/ColorPicker.cs @@ -1,6 +1,5 @@ using System; using System.Collections.Generic; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/CombiningMarks.cs b/Examples/UICatalog/Scenarios/CombiningMarks.cs index d35198251..da9370acf 100644 --- a/Examples/UICatalog/Scenarios/CombiningMarks.cs +++ b/Examples/UICatalog/Scenarios/CombiningMarks.cs @@ -1,4 +1,3 @@ -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ComboBoxIteration.cs b/Examples/UICatalog/Scenarios/ComboBoxIteration.cs index 1fd8ce69e..9440f37f3 100644 --- a/Examples/UICatalog/Scenarios/ComboBoxIteration.cs +++ b/Examples/UICatalog/Scenarios/ComboBoxIteration.cs @@ -1,6 +1,5 @@ using System.Collections.Generic; using System.Collections.ObjectModel; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ComputedLayout.cs b/Examples/UICatalog/Scenarios/ComputedLayout.cs index 316cb4d15..6a2320f91 100644 --- a/Examples/UICatalog/Scenarios/ComputedLayout.cs +++ b/Examples/UICatalog/Scenarios/ComputedLayout.cs @@ -1,7 +1,6 @@ using System; using System.Collections.Generic; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ConfigurationEditor.cs b/Examples/UICatalog/Scenarios/ConfigurationEditor.cs index 70351f915..f0689e73a 100644 --- a/Examples/UICatalog/Scenarios/ConfigurationEditor.cs +++ b/Examples/UICatalog/Scenarios/ConfigurationEditor.cs @@ -1,13 +1,9 @@ #nullable enable -using System; -using System.IO; -using System.Linq; using System.Reflection; -using Terminal.Gui; namespace UICatalog.Scenarios; -[ScenarioMetadata ("Configuration Editor", "Editor of Terminal.Gui Config Files")] +[ScenarioMetadata ("Configuration Editor", "Edits of Terminal.Gui Config Files")] [ScenarioCategory ("TabView")] [ScenarioCategory ("Colors")] [ScenarioCategory ("Files and IO")] @@ -15,56 +11,46 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("Configuration")] public class ConfigurationEditor : Scenario { - //private static Scheme _editorScheme = SchemeManager.GetScheme (Schemes.Base); - - //private static Action? _editorSchemeChanged; private TabView? _tabView; private Shortcut? _lenShortcut; - //[ConfigurationProperty (Scope = typeof (AppSettingsScope))] - //public static Scheme EditorScheme - //{ - // get => _editorScheme; - // set - // { - // _editorScheme = value; - // _editorSchemeChanged?.Invoke (); - // } - //} - public override void Main () { Application.Init (); Window? win = new (); - _lenShortcut = new Shortcut () + _lenShortcut = new () { Title = "", }; - var quitShortcut = new Shortcut () + Shortcut quitShortcut = new () { Key = Application.QuitKey, Title = $"Quit", Action = Quit }; - var reloadShortcut = new Shortcut () + Shortcut reloadShortcut = new () { Key = Key.F5.WithShift, Title = "Reload", }; - reloadShortcut.Accepting += (s, e) => { Reload (); }; + reloadShortcut.Accepting += (s, e) => + { + Reload (); + e.Handled = true; + }; - var saveShortcut = new Shortcut () + Shortcut saveShortcut = new () { Key = Key.F4, Title = "Save", Action = Save }; - var statusBar = new StatusBar ([quitShortcut, reloadShortcut, saveShortcut, _lenShortcut]); + StatusBar statusBar = new ([quitShortcut, reloadShortcut, saveShortcut, _lenShortcut]); _tabView = new () { @@ -77,43 +63,19 @@ public class ConfigurationEditor : Scenario win.Loaded += (s, a) => { Open (); - //_editorSchemeChanged?.Invoke (); }; - - - //_editorSchemeChanged += OnEditorSchemeChanged; - ConfigurationManager.Applied += ConfigurationManagerOnApplied; Application.Run (win); - //_editorSchemeChanged -= OnEditorSchemeChanged; win.Dispose (); - win = null; - Application.Shutdown (); return; - //void OnEditorSchemeChanged () - //{ - // if (Application.Top is { }) - // { - // return; - // } - - // foreach (ConfigTextView t in _tabView.SubViews.OfType ()) - // { - // t.SetScheme (EditorScheme); - // } - //} - void ConfigurationManagerOnApplied (object? sender, ConfigurationManagerEventArgs e) { - if (win is { }) - { - win.SetNeedsDraw (); - } + Application.Top?.SetNeedsDraw (); } } public void Save () @@ -126,7 +88,7 @@ public class ConfigurationEditor : Scenario private void Open () { - foreach (var config in ConfigurationManager.SourcesManager!.Sources) + foreach (KeyValuePair config in ConfigurationManager.SourcesManager!.Sources) { var homeDir = $"{Environment.GetFolderPath (Environment.SpecialFolder.UserProfile)}"; var fileInfo = new FileInfo (config.Value.Replace ("~", homeDir)); @@ -145,7 +107,7 @@ public class ConfigurationEditor : Scenario } - Tab tab = new Tab () + Tab tab = new () { View = editor, DisplayText = config.Key.ToString () @@ -186,32 +148,37 @@ public class ConfigurationEditor : Scenario return null; }).Cast ()) { - if (editor.IsDirty) + if (!editor.IsDirty) { - int result = MessageBox.Query ( - "Save Changes", - $"Save changes to {editor.FileInfo!.Name}", - "_Yes", - "_No", - "_Cancel" - ); + continue; + } - if (result == -1 || result == 2) - { - // user cancelled - } + int result = MessageBox.Query ( + "Save Changes", + $"Save changes to {editor.FileInfo!.Name}", + "_Yes", + "_No", + "_Cancel" + ); - if (result == 0) - { + switch (result) + { + case 0: editor.Save (); - } + + break; + + default: + case -1 or 2: + // user cancelled + return; } } Application.RequestStop (); } - private void Reload () + private static void Reload () { if (Application.Navigation?.GetFocused () is ConfigTextView editor) { @@ -226,7 +193,7 @@ public class ConfigurationEditor : Scenario TabStop = TabBehavior.TabGroup; } - internal FileInfo? FileInfo { get; set; } + internal FileInfo? FileInfo { get; init; } internal void Read () { @@ -247,16 +214,18 @@ public class ConfigurationEditor : Scenario string? name = assembly .GetManifestResourceNames () .FirstOrDefault (x => x.EndsWith ("config.json")); - if (!string.IsNullOrEmpty (name)) - { - using Stream? stream = assembly.GetManifestResourceStream (name); - using var reader = new StreamReader (stream!); - Text = reader.ReadToEnd (); - ReadOnly = true; - Enabled = true; + if (string.IsNullOrEmpty (name)) + { + return; } + using Stream? stream = assembly.GetManifestResourceStream (name); + using var reader = new StreamReader (stream!); + Text = reader.ReadToEnd (); + ReadOnly = true; + Enabled = true; + return; } diff --git a/Examples/UICatalog/Scenarios/ContextMenus.cs b/Examples/UICatalog/Scenarios/ContextMenus.cs index 4cc7343ab..141392f29 100644 --- a/Examples/UICatalog/Scenarios/ContextMenus.cs +++ b/Examples/UICatalog/Scenarios/ContextMenus.cs @@ -1,6 +1,5 @@ using System.Globalization; using JetBrains.Annotations; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/CsvEditor.cs b/Examples/UICatalog/Scenarios/CsvEditor.cs index d1b5acc95..609cb4e06 100644 --- a/Examples/UICatalog/Scenarios/CsvEditor.cs +++ b/Examples/UICatalog/Scenarios/CsvEditor.cs @@ -5,7 +5,6 @@ using System.IO; using System.Linq; using System.Text.RegularExpressions; using CsvHelper; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/DatePickers.cs b/Examples/UICatalog/Scenarios/DatePickers.cs index 0028b80ca..06eae0b40 100644 --- a/Examples/UICatalog/Scenarios/DatePickers.cs +++ b/Examples/UICatalog/Scenarios/DatePickers.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; - + namespace UICatalog.Scenarios; [ScenarioMetadata ("Date Picker", "Demonstrates how to use DatePicker class")] diff --git a/Examples/UICatalog/Scenarios/Dialogs.cs b/Examples/UICatalog/Scenarios/Dialogs.cs index 915a9db6b..949b45d4a 100644 --- a/Examples/UICatalog/Scenarios/Dialogs.cs +++ b/Examples/UICatalog/Scenarios/Dialogs.cs @@ -1,7 +1,6 @@ using System; using System.Collections.Generic; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/DimAutoDemo.cs b/Examples/UICatalog/Scenarios/DimAutoDemo.cs index 15bf1a74d..7c99647e4 100644 --- a/Examples/UICatalog/Scenarios/DimAutoDemo.cs +++ b/Examples/UICatalog/Scenarios/DimAutoDemo.cs @@ -1,6 +1,5 @@ using System; using System.Collections.Generic; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/DynamicMenuBar.cs b/Examples/UICatalog/Scenarios/DynamicMenuBar.cs index 4bb430946..2741800de 100644 --- a/Examples/UICatalog/Scenarios/DynamicMenuBar.cs +++ b/Examples/UICatalog/Scenarios/DynamicMenuBar.cs @@ -3,7 +3,6 @@ using System.ComponentModel; using System.Reflection; using System.Runtime.CompilerServices; using System.Text; -using Terminal.Gui; #pragma warning disable CS0618 // Type or member is obsolete diff --git a/Examples/UICatalog/Scenarios/DynamicStatusBar.cs b/Examples/UICatalog/Scenarios/DynamicStatusBar.cs index 6be42ab8f..de110d0c6 100644 --- a/Examples/UICatalog/Scenarios/DynamicStatusBar.cs +++ b/Examples/UICatalog/Scenarios/DynamicStatusBar.cs @@ -5,7 +5,6 @@ using System.Linq; using System.Reflection; using System.Runtime.CompilerServices; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Editor.cs b/Examples/UICatalog/Scenarios/Editor.cs index 5f1176bd1..ff45264ad 100644 --- a/Examples/UICatalog/Scenarios/Editor.cs +++ b/Examples/UICatalog/Scenarios/Editor.cs @@ -7,7 +7,6 @@ using System.Linq; using System.Text; using System.Text.RegularExpressions; using System.Threading; -using Terminal.Gui; using static UICatalog.Scenarios.DynamicMenuBar; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/AdornmentEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/AdornmentEditor.cs index 303b4c216..5ad44324b 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/AdornmentEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/AdornmentEditor.cs @@ -1,6 +1,5 @@ #nullable enable using System; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/AdornmentsEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/AdornmentsEditor.cs index d336e7334..382865f4b 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/AdornmentsEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/AdornmentsEditor.cs @@ -1,6 +1,5 @@ #nullable enable using System; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/AllViewsView.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/AllViewsView.cs index 707fc9e2f..85572c710 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/AllViewsView.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/AllViewsView.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; - + namespace UICatalog.Scenarios; public class AllViewsView : View diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ArrangementEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ArrangementEditor.cs index 7dab692d6..6d262ef2e 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ArrangementEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ArrangementEditor.cs @@ -1,7 +1,6 @@ #nullable enable using System; using System.Collections.Generic; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/BorderEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/BorderEditor.cs index def7810cb..2e883cc0a 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/BorderEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/BorderEditor.cs @@ -2,7 +2,6 @@ using System; using System.Collections.Generic; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/DimEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/DimEditor.cs index 7d7b0cbaa..523c4f1da 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/DimEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/DimEditor.cs @@ -3,7 +3,6 @@ using System; using System.Collections.Generic; using System.Diagnostics; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/EditorBase.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/EditorBase.cs index c40307cea..b4c548d0c 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/EditorBase.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/EditorBase.cs @@ -2,7 +2,6 @@ using System; using System.Diagnostics; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/EventLog.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/EventLog.cs index 167e751b3..b64acc865 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/EventLog.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/EventLog.cs @@ -1,7 +1,6 @@ #nullable enable using System; using System.Collections.ObjectModel; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ExpanderButton.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ExpanderButton.cs index 4afde21c3..2faf3c778 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ExpanderButton.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ExpanderButton.cs @@ -1,7 +1,6 @@ #nullable enable using System; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; @@ -14,9 +13,9 @@ namespace UICatalog.Scenarios; /// (F4) or mouse. /// /// -/// If is set to , the button will appear +/// If is set to , the button will appear /// at the top/right. -/// If is set to , the button will +/// If is set to , the button will /// appear at the /// bottom/left. /// diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/LayoutEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/LayoutEditor.cs index de7377245..cb84ac31d 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/LayoutEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/LayoutEditor.cs @@ -2,7 +2,6 @@ using System; using System.Collections.Generic; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/MarginEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/MarginEditor.cs index 626733f3b..fc3c89132 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/MarginEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/MarginEditor.cs @@ -1,6 +1,5 @@ #nullable enable using System; -using Terminal.Gui; namespace UICatalog.Scenarios; @@ -57,8 +56,8 @@ public class MarginEditor : AdornmentEditor var flags = new Dictionary () { - { (uint)Terminal.Gui.ViewportSettings.Transparent, "Transparent" }, - { (uint)Terminal.Gui.ViewportSettings.TransparentMouse, "TransparentMouse" } + { (uint)Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent, "Transparent" }, + { (uint)Terminal.Gui.ViewBase.ViewportSettingsFlags.TransparentMouse, "TransparentMouse" } }; _flagSelectorTransparent = new FlagSelector () @@ -82,7 +81,7 @@ public class MarginEditor : AdornmentEditor _flagSelectorTransparent.ValueChanged += (_, args) => { - ((Margin)AdornmentToEdit!).ViewportSettings = (Terminal.Gui.ViewportSettings)args.CurrentValue!; + ((Margin)AdornmentToEdit!).ViewportSettings = (ViewportSettingsFlags)args.CurrentValue!; }; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/PosEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/PosEditor.cs index 20b92adf9..c67a303d1 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/PosEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/PosEditor.cs @@ -3,7 +3,6 @@ using System; using System.Collections.Generic; using System.Diagnostics; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/SchemeViewer.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/SchemeViewer.cs index 00ba23185..16659aa70 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/SchemeViewer.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/SchemeViewer.cs @@ -1,5 +1,4 @@ #nullable enable -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ThemeViewer.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ThemeViewer.cs index 387e6fef3..fff8172d8 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ThemeViewer.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ThemeViewer.cs @@ -1,5 +1,4 @@ #nullable enable -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ViewPropertiesEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ViewPropertiesEditor.cs index 3acf31f7c..f8e77afaa 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ViewPropertiesEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ViewPropertiesEditor.cs @@ -1,5 +1,4 @@ #nullable enable -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ViewportSettingsEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ViewportSettingsEditor.cs index f989caaf7..74bd805b9 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ViewportSettingsEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ViewportSettingsEditor.cs @@ -1,6 +1,5 @@ #nullable enable using System; -using Terminal.Gui; namespace UICatalog.Scenarios; @@ -32,35 +31,35 @@ public sealed class ViewportSettingsEditor : EditorBase _contentSizeWidth!.Value = ViewToEdit.GetContentSize ().Width; _contentSizeHeight!.Value = ViewToEdit.GetContentSize ().Height; - _cbAllowNegativeX!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (Terminal.Gui.ViewportSettings.AllowNegativeX) + _cbAllowNegativeX!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (ViewportSettingsFlags.AllowNegativeX) ? CheckState.Checked : CheckState.UnChecked; - _cbAllowNegativeY!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (Terminal.Gui.ViewportSettings.AllowNegativeY) + _cbAllowNegativeY!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (ViewportSettingsFlags.AllowNegativeY) ? CheckState.Checked : CheckState.UnChecked; - _cbAllowXGreaterThanContentWidth!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (Terminal.Gui.ViewportSettings.AllowXGreaterThanContentWidth) + _cbAllowXGreaterThanContentWidth!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (ViewportSettingsFlags.AllowXGreaterThanContentWidth) ? CheckState.Checked : CheckState.UnChecked; - _cbAllowYGreaterThanContentHeight!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (Terminal.Gui.ViewportSettings.AllowYGreaterThanContentHeight) + _cbAllowYGreaterThanContentHeight!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (ViewportSettingsFlags.AllowYGreaterThanContentHeight) ? CheckState.Checked : CheckState.UnChecked; - _cbClearContentOnly!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (Terminal.Gui.ViewportSettings.ClearContentOnly) + _cbClearContentOnly!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (ViewportSettingsFlags.ClearContentOnly) ? CheckState.Checked : CheckState.UnChecked; - _cbClipContentOnly!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (Terminal.Gui.ViewportSettings.ClipContentOnly) + _cbClipContentOnly!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (ViewportSettingsFlags.ClipContentOnly) ? CheckState.Checked : CheckState.UnChecked; - _cbTransparent!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (Terminal.Gui.ViewportSettings.Transparent) + _cbTransparent!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (ViewportSettingsFlags.Transparent) ? CheckState.Checked : CheckState.UnChecked; - _cbTransparentMouse!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (Terminal.Gui.ViewportSettings.TransparentMouse) + _cbTransparentMouse!.CheckedState = ViewToEdit.ViewportSettings.HasFlag (ViewportSettingsFlags.TransparentMouse) ? CheckState.Checked : CheckState.UnChecked; @@ -120,11 +119,11 @@ public sealed class ViewportSettingsEditor : EditorBase { if (e.NewValue == CheckState.Checked) { - ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewportSettings.AllowNegativeX; + ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.AllowNegativeX; } else { - ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewportSettings.AllowNegativeX; + ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewBase.ViewportSettingsFlags.AllowNegativeX; } } @@ -132,11 +131,11 @@ public sealed class ViewportSettingsEditor : EditorBase { if (e.NewValue == CheckState.Checked) { - ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewportSettings.AllowXGreaterThanContentWidth; + ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.AllowXGreaterThanContentWidth; } else { - ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewportSettings.AllowXGreaterThanContentWidth; + ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewBase.ViewportSettingsFlags.AllowXGreaterThanContentWidth; } } @@ -158,11 +157,11 @@ public sealed class ViewportSettingsEditor : EditorBase { if (e.NewValue == CheckState.Checked) { - ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewportSettings.AllowNegativeY; + ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.AllowNegativeY; } else { - ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewportSettings.AllowNegativeY; + ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewBase.ViewportSettingsFlags.AllowNegativeY; } } @@ -170,11 +169,11 @@ public sealed class ViewportSettingsEditor : EditorBase { if (e.NewValue == CheckState.Checked) { - ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewportSettings.AllowYGreaterThanContentHeight; + ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.AllowYGreaterThanContentHeight; } else { - ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewportSettings.AllowYGreaterThanContentHeight; + ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewBase.ViewportSettingsFlags.AllowYGreaterThanContentHeight; } } @@ -248,11 +247,11 @@ public sealed class ViewportSettingsEditor : EditorBase { if (e.NewValue == CheckState.Checked) { - ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewportSettings.ClearContentOnly; + ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.ClearContentOnly; } else { - ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewportSettings.ClearContentOnly; + ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewBase.ViewportSettingsFlags.ClearContentOnly; } } @@ -269,11 +268,11 @@ public sealed class ViewportSettingsEditor : EditorBase { if (e.NewValue == CheckState.Checked) { - ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewportSettings.ClipContentOnly; + ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.ClipContentOnly; } else { - ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewportSettings.ClipContentOnly; + ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewBase.ViewportSettingsFlags.ClipContentOnly; } } @@ -290,11 +289,11 @@ public sealed class ViewportSettingsEditor : EditorBase { if (e.NewValue == CheckState.Checked) { - ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewportSettings.Transparent; + ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent; } else { - ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewportSettings.Transparent; + ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent; } } @@ -311,11 +310,11 @@ public sealed class ViewportSettingsEditor : EditorBase { if (e.NewValue == CheckState.Checked) { - ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewportSettings.TransparentMouse; + ViewToEdit!.ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.TransparentMouse; } else { - ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewportSettings.TransparentMouse; + ViewToEdit!.ViewportSettings &= ~Terminal.Gui.ViewBase.ViewportSettingsFlags.TransparentMouse; } } diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/VisualRoleViewer.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/VisualRoleViewer.cs index f410a854c..2b31f4267 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/VisualRoleViewer.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/VisualRoleViewer.cs @@ -1,5 +1,4 @@ #nullable enable -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/FileDialogExamples.cs b/Examples/UICatalog/Scenarios/FileDialogExamples.cs index 323752757..10dcf8c35 100644 --- a/Examples/UICatalog/Scenarios/FileDialogExamples.cs +++ b/Examples/UICatalog/Scenarios/FileDialogExamples.cs @@ -3,7 +3,6 @@ using System.IO; using System.IO.Abstractions; using System.Linq; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Generic.cs b/Examples/UICatalog/Scenarios/Generic.cs index 91c60a0f9..f0da0dd53 100644 --- a/Examples/UICatalog/Scenarios/Generic.cs +++ b/Examples/UICatalog/Scenarios/Generic.cs @@ -1,5 +1,4 @@ #nullable enable -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/GraphViewExample.cs b/Examples/UICatalog/Scenarios/GraphViewExample.cs index b6f6ea8b9..530acf8e4 100644 --- a/Examples/UICatalog/Scenarios/GraphViewExample.cs +++ b/Examples/UICatalog/Scenarios/GraphViewExample.cs @@ -3,8 +3,7 @@ using System.Collections.Generic; using System.ComponentModel; using System.Linq; using System.Text; -using Terminal.Gui; -using Application = Terminal.Gui.Application; +using Application = Terminal.Gui.App.Application; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/HexEditor.cs b/Examples/UICatalog/Scenarios/HexEditor.cs index 596d81913..9b13e1656 100644 --- a/Examples/UICatalog/Scenarios/HexEditor.cs +++ b/Examples/UICatalog/Scenarios/HexEditor.cs @@ -1,7 +1,6 @@ #nullable enable using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/HotKeys.cs b/Examples/UICatalog/Scenarios/HotKeys.cs index aa0e404e2..1babf13dc 100644 --- a/Examples/UICatalog/Scenarios/HotKeys.cs +++ b/Examples/UICatalog/Scenarios/HotKeys.cs @@ -1,4 +1,3 @@ -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Images.cs b/Examples/UICatalog/Scenarios/Images.cs index 2450d20e4..048974592 100644 --- a/Examples/UICatalog/Scenarios/Images.cs +++ b/Examples/UICatalog/Scenarios/Images.cs @@ -1,15 +1,9 @@ -using System; -using System.Collections.Concurrent; -using System.Collections.Generic; -using System.IO; -using System.Linq; +using System.Collections.Concurrent; using System.Text; using ColorHelper; using SixLabors.ImageSharp; using SixLabors.ImageSharp.PixelFormats; using SixLabors.ImageSharp.Processing; -using Terminal.Gui; -using Color = Terminal.Gui.Color; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/InteractiveTree.cs b/Examples/UICatalog/Scenarios/InteractiveTree.cs index 6cbcd7e76..c3b414901 100644 --- a/Examples/UICatalog/Scenarios/InteractiveTree.cs +++ b/Examples/UICatalog/Scenarios/InteractiveTree.cs @@ -1,5 +1,4 @@ using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/KeyBindings.cs b/Examples/UICatalog/Scenarios/KeyBindings.cs index e51dfc4e3..f68e67f17 100644 --- a/Examples/UICatalog/Scenarios/KeyBindings.cs +++ b/Examples/UICatalog/Scenarios/KeyBindings.cs @@ -3,7 +3,6 @@ using System.Collections.Generic; using System.Collections.ObjectModel; using System.Linq; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Keys.cs b/Examples/UICatalog/Scenarios/Keys.cs index 5f450bc93..8f0b0094d 100644 --- a/Examples/UICatalog/Scenarios/Keys.cs +++ b/Examples/UICatalog/Scenarios/Keys.cs @@ -1,5 +1,4 @@ using System.Collections.ObjectModel; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/LineCanvasExperiment.cs b/Examples/UICatalog/Scenarios/LineCanvasExperiment.cs index be8377067..85786a40e 100644 --- a/Examples/UICatalog/Scenarios/LineCanvasExperiment.cs +++ b/Examples/UICatalog/Scenarios/LineCanvasExperiment.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; - + namespace UICatalog.Scenarios; [ScenarioMetadata ("LineCanvas Experiments", "Experiments with LineCanvas")] diff --git a/Examples/UICatalog/Scenarios/LineDrawing.cs b/Examples/UICatalog/Scenarios/LineDrawing.cs index 79a35bf2f..46f51dda7 100644 --- a/Examples/UICatalog/Scenarios/LineDrawing.cs +++ b/Examples/UICatalog/Scenarios/LineDrawing.cs @@ -2,7 +2,6 @@ using System.Collections.Generic; using System.Linq; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/LineViewExample.cs b/Examples/UICatalog/Scenarios/LineViewExample.cs index 9113ccc5b..38290bdce 100644 --- a/Examples/UICatalog/Scenarios/LineViewExample.cs +++ b/Examples/UICatalog/Scenarios/LineViewExample.cs @@ -1,6 +1,5 @@ using System.Globalization; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ListColumns.cs b/Examples/UICatalog/Scenarios/ListColumns.cs index 4ba6911d4..402e2944d 100644 --- a/Examples/UICatalog/Scenarios/ListColumns.cs +++ b/Examples/UICatalog/Scenarios/ListColumns.cs @@ -2,7 +2,6 @@ using System.Collections; using System.Collections.Generic; using System.Data; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ListViewWithSelection.cs b/Examples/UICatalog/Scenarios/ListViewWithSelection.cs index 7571720d8..f85649da7 100644 --- a/Examples/UICatalog/Scenarios/ListViewWithSelection.cs +++ b/Examples/UICatalog/Scenarios/ListViewWithSelection.cs @@ -6,7 +6,6 @@ using System.Collections.Specialized; using System.ComponentModel; using System.Text; using JetBrains.Annotations; -using Terminal.Gui; namespace UICatalog.Scenarios; @@ -156,11 +155,11 @@ public class ListViewWithSelection : Scenario { if (stateEventArgs.NewValue == CheckState.Checked) { - _listView.ViewportSettings |= Terminal.Gui.ViewportSettings.AllowYGreaterThanContentHeight; + _listView.ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.AllowYGreaterThanContentHeight; } else { - _listView.ViewportSettings &= ~Terminal.Gui.ViewportSettings.AllowYGreaterThanContentHeight; + _listView.ViewportSettings &= ~Terminal.Gui.ViewBase.ViewportSettingsFlags.AllowYGreaterThanContentHeight; } _appWindow.SetNeedsDraw (); } diff --git a/Examples/UICatalog/Scenarios/ListsAndCombos.cs b/Examples/UICatalog/Scenarios/ListsAndCombos.cs index 273c5dfbe..dba1adc73 100644 --- a/Examples/UICatalog/Scenarios/ListsAndCombos.cs +++ b/Examples/UICatalog/Scenarios/ListsAndCombos.cs @@ -2,7 +2,6 @@ using System.Collections.ObjectModel; using System.IO; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Localization.cs b/Examples/UICatalog/Scenarios/Localization.cs index 994b5bd8d..229800f5e 100644 --- a/Examples/UICatalog/Scenarios/Localization.cs +++ b/Examples/UICatalog/Scenarios/Localization.cs @@ -2,7 +2,6 @@ using System.Globalization; using System.Linq; using System.Threading; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Mazing.cs b/Examples/UICatalog/Scenarios/Mazing.cs index 897fb0412..a9954d017 100644 --- a/Examples/UICatalog/Scenarios/Mazing.cs +++ b/Examples/UICatalog/Scenarios/Mazing.cs @@ -1,6 +1,5 @@ #nullable enable using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/MenuBarScenario.cs b/Examples/UICatalog/Scenarios/MenuBarScenario.cs index d5bf139df..e61438767 100644 --- a/Examples/UICatalog/Scenarios/MenuBarScenario.cs +++ b/Examples/UICatalog/Scenarios/MenuBarScenario.cs @@ -1,5 +1,4 @@ using System; -using Terminal.Gui; using static System.Runtime.InteropServices.JavaScript.JSType; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Menus.cs b/Examples/UICatalog/Scenarios/Menus.cs index 92d6309a0..70f67f6e2 100644 --- a/Examples/UICatalog/Scenarios/Menus.cs +++ b/Examples/UICatalog/Scenarios/Menus.cs @@ -6,7 +6,6 @@ using Microsoft.Extensions.Logging; using Serilog; using Serilog.Core; using Serilog.Events; -using Terminal.Gui; using ILogger = Microsoft.Extensions.Logging.ILogger; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/MessageBoxes.cs b/Examples/UICatalog/Scenarios/MessageBoxes.cs index cb110da1e..71dde85e2 100644 --- a/Examples/UICatalog/Scenarios/MessageBoxes.cs +++ b/Examples/UICatalog/Scenarios/MessageBoxes.cs @@ -1,7 +1,6 @@ using System; using System.Collections.Generic; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Mouse.cs b/Examples/UICatalog/Scenarios/Mouse.cs index be0fc7645..e7919c91f 100644 --- a/Examples/UICatalog/Scenarios/Mouse.cs +++ b/Examples/UICatalog/Scenarios/Mouse.cs @@ -2,7 +2,6 @@ using System.Collections.ObjectModel; using System.ComponentModel; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/MultiColouredTable.cs b/Examples/UICatalog/Scenarios/MultiColouredTable.cs index 43d5eb1f2..cf013f86c 100644 --- a/Examples/UICatalog/Scenarios/MultiColouredTable.cs +++ b/Examples/UICatalog/Scenarios/MultiColouredTable.cs @@ -1,7 +1,6 @@ using System; using System.Data; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Navigation.cs b/Examples/UICatalog/Scenarios/Navigation.cs index 4d99d0030..ccc2eb7fa 100644 --- a/Examples/UICatalog/Scenarios/Navigation.cs +++ b/Examples/UICatalog/Scenarios/Navigation.cs @@ -1,6 +1,5 @@ using System.Text; using System.Timers; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Notepad.cs b/Examples/UICatalog/Scenarios/Notepad.cs index 3c079d27e..c827ca59f 100644 --- a/Examples/UICatalog/Scenarios/Notepad.cs +++ b/Examples/UICatalog/Scenarios/Notepad.cs @@ -1,6 +1,5 @@ using System.IO; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/NumericUpDownDemo.cs b/Examples/UICatalog/Scenarios/NumericUpDownDemo.cs index e959ec9b9..0cdffdfc3 100644 --- a/Examples/UICatalog/Scenarios/NumericUpDownDemo.cs +++ b/Examples/UICatalog/Scenarios/NumericUpDownDemo.cs @@ -1,6 +1,5 @@ #nullable enable using System; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/PosAlignDemo.cs b/Examples/UICatalog/Scenarios/PosAlignDemo.cs index 49ea4c082..f7cd5ec20 100644 --- a/Examples/UICatalog/Scenarios/PosAlignDemo.cs +++ b/Examples/UICatalog/Scenarios/PosAlignDemo.cs @@ -1,7 +1,6 @@ using System; using System.Collections.Generic; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ProcessTable.cs b/Examples/UICatalog/Scenarios/ProcessTable.cs index 3349208b3..d7c38aa22 100644 --- a/Examples/UICatalog/Scenarios/ProcessTable.cs +++ b/Examples/UICatalog/Scenarios/ProcessTable.cs @@ -1,7 +1,6 @@ using System; using System.Collections.Generic; using System.Diagnostics; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Progress.cs b/Examples/UICatalog/Scenarios/Progress.cs index ff72c92cd..4696c160c 100644 --- a/Examples/UICatalog/Scenarios/Progress.cs +++ b/Examples/UICatalog/Scenarios/Progress.cs @@ -2,7 +2,6 @@ using System.Diagnostics; using System.Linq; using System.Threading; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ProgressBarStyles.cs b/Examples/UICatalog/Scenarios/ProgressBarStyles.cs index 0b020661a..368fabd1e 100644 --- a/Examples/UICatalog/Scenarios/ProgressBarStyles.cs +++ b/Examples/UICatalog/Scenarios/ProgressBarStyles.cs @@ -4,7 +4,6 @@ using System.Collections.Generic; using System.Collections.ObjectModel; using System.Linq; using System.Threading; -using Terminal.Gui; using static UICatalog.Scenarios.Adornments; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/RegionScenario.cs b/Examples/UICatalog/Scenarios/RegionScenario.cs index 16d487846..1eb314f00 100644 --- a/Examples/UICatalog/Scenarios/RegionScenario.cs +++ b/Examples/UICatalog/Scenarios/RegionScenario.cs @@ -3,7 +3,6 @@ using System; using System.Collections.Generic; using System.Linq; using System.Text; -using Terminal.Gui; using UICatalog; using UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/RunTExample.cs b/Examples/UICatalog/Scenarios/RunTExample.cs index de63b1247..6e4cfa1d7 100644 --- a/Examples/UICatalog/Scenarios/RunTExample.cs +++ b/Examples/UICatalog/Scenarios/RunTExample.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; - + namespace UICatalog.Scenarios; [ScenarioMetadata ("Run Example", "Illustrates using Application.Run to run a custom class")] diff --git a/Examples/UICatalog/Scenarios/RuneWidthGreaterThanOne.cs b/Examples/UICatalog/Scenarios/RuneWidthGreaterThanOne.cs index 9df913bf9..a10fd6ca8 100644 --- a/Examples/UICatalog/Scenarios/RuneWidthGreaterThanOne.cs +++ b/Examples/UICatalog/Scenarios/RuneWidthGreaterThanOne.cs @@ -1,5 +1,4 @@ using System; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ScrollBarDemo.cs b/Examples/UICatalog/Scenarios/ScrollBarDemo.cs index ee7ee50d3..50abe30c0 100644 --- a/Examples/UICatalog/Scenarios/ScrollBarDemo.cs +++ b/Examples/UICatalog/Scenarios/ScrollBarDemo.cs @@ -1,7 +1,6 @@ using System; using System.Collections.ObjectModel; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Scrolling.cs b/Examples/UICatalog/Scenarios/Scrolling.cs index 40ad83111..319afb9c1 100644 --- a/Examples/UICatalog/Scenarios/Scrolling.cs +++ b/Examples/UICatalog/Scenarios/Scrolling.cs @@ -1,6 +1,5 @@ using System; using Microsoft.CodeAnalysis.CSharp.Syntax; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/SendKeys.cs b/Examples/UICatalog/Scenarios/SendKeys.cs index e2989b94e..04a57d4e4 100644 --- a/Examples/UICatalog/Scenarios/SendKeys.cs +++ b/Examples/UICatalog/Scenarios/SendKeys.cs @@ -1,5 +1,4 @@ using System; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ShadowStyles.cs b/Examples/UICatalog/Scenarios/ShadowStyles.cs index 930d894d2..3c0e39f81 100644 --- a/Examples/UICatalog/Scenarios/ShadowStyles.cs +++ b/Examples/UICatalog/Scenarios/ShadowStyles.cs @@ -3,7 +3,6 @@ using System.Collections.Generic; using System.ComponentModel; using System.Diagnostics.Metrics; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Shortcuts.cs b/Examples/UICatalog/Scenarios/Shortcuts.cs index 5ba8340d2..58dd77d79 100644 --- a/Examples/UICatalog/Scenarios/Shortcuts.cs +++ b/Examples/UICatalog/Scenarios/Shortcuts.cs @@ -1,7 +1,6 @@ #nullable enable using System.Collections.ObjectModel; -using Terminal.Gui; using Timer = System.Timers.Timer; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/SingleBackgroundWorker.cs b/Examples/UICatalog/Scenarios/SingleBackgroundWorker.cs index 7b676b717..add1555ba 100644 --- a/Examples/UICatalog/Scenarios/SingleBackgroundWorker.cs +++ b/Examples/UICatalog/Scenarios/SingleBackgroundWorker.cs @@ -3,7 +3,6 @@ using System.Collections.Generic; using System.Collections.ObjectModel; using System.ComponentModel; using System.Threading; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Sliders.cs b/Examples/UICatalog/Scenarios/Sliders.cs index 3dcb42c7b..fae50c015 100644 --- a/Examples/UICatalog/Scenarios/Sliders.cs +++ b/Examples/UICatalog/Scenarios/Sliders.cs @@ -1,6 +1,5 @@ using System.Collections.ObjectModel; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Snake.cs b/Examples/UICatalog/Scenarios/Snake.cs index 957ec6757..582a130f4 100644 --- a/Examples/UICatalog/Scenarios/Snake.cs +++ b/Examples/UICatalog/Scenarios/Snake.cs @@ -1,6 +1,5 @@ using System.Diagnostics; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/SpinnerStyles.cs b/Examples/UICatalog/Scenarios/SpinnerStyles.cs index cf8992e9f..826eb04aa 100644 --- a/Examples/UICatalog/Scenarios/SpinnerStyles.cs +++ b/Examples/UICatalog/Scenarios/SpinnerStyles.cs @@ -2,7 +2,6 @@ using System.Collections.Generic; using System.Collections.ObjectModel; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/SyntaxHighlighting.cs b/Examples/UICatalog/Scenarios/SyntaxHighlighting.cs index c7f9bf6c3..7b0c05462 100644 --- a/Examples/UICatalog/Scenarios/SyntaxHighlighting.cs +++ b/Examples/UICatalog/Scenarios/SyntaxHighlighting.cs @@ -7,7 +7,6 @@ using System.Reflection; using System.Text; using System.Text.Json; using System.Text.RegularExpressions; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/TabViewExample.cs b/Examples/UICatalog/Scenarios/TabViewExample.cs index 9d48c0568..30f55d5f4 100644 --- a/Examples/UICatalog/Scenarios/TabViewExample.cs +++ b/Examples/UICatalog/Scenarios/TabViewExample.cs @@ -1,6 +1,5 @@ using System.Linq; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/TableEditor.cs b/Examples/UICatalog/Scenarios/TableEditor.cs index bb8391743..29b03b064 100644 --- a/Examples/UICatalog/Scenarios/TableEditor.cs +++ b/Examples/UICatalog/Scenarios/TableEditor.cs @@ -1,7 +1,6 @@ using System.Data; using System.Globalization; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; @@ -61,8 +60,8 @@ public class TableEditor : Scenario "Cuneiform Numbers and Punctuation" ), new ( - (uint)(Terminal.Gui.UnicodeRange.Ranges.Max (r => r.End) - 16), - (uint)Terminal.Gui.UnicodeRange.Ranges.Max (r => r.End), + (uint)(Terminal.Gui.Views.UnicodeRange.Ranges.Max (r => r.End) - 16), + (uint)Terminal.Gui.Views.UnicodeRange.Ranges.Max (r => r.End), "End" ), new (0x0020, 0x007F, "Basic Latin"), diff --git a/Examples/UICatalog/Scenarios/TextAlignmentAndDirection.cs b/Examples/UICatalog/Scenarios/TextAlignmentAndDirection.cs index fbebd89b1..f8666a1bc 100644 --- a/Examples/UICatalog/Scenarios/TextAlignmentAndDirection.cs +++ b/Examples/UICatalog/Scenarios/TextAlignmentAndDirection.cs @@ -2,7 +2,6 @@ using System.Collections.Generic; using System.Linq; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; @@ -15,7 +14,7 @@ public class TextAlignmentAndDirection : Scenario { public AlignmentAndDirectionView () { - ViewportSettings = Terminal.Gui.ViewportSettings.Transparent; + ViewportSettings = Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent; BorderStyle = LineStyle.Dotted; } } @@ -92,7 +91,7 @@ public class TextAlignmentAndDirection : Scenario SchemeName = "TextAlignmentAndDirection1", TextAlignment = Alignment.Start, Text = txt, - ViewportSettings = Terminal.Gui.ViewportSettings.Transparent + ViewportSettings = Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent }; var txtLabelHC = new View @@ -104,7 +103,7 @@ public class TextAlignmentAndDirection : Scenario SchemeName = "TextAlignmentAndDirection2", TextAlignment = Alignment.Center, Text = txt, - ViewportSettings = Terminal.Gui.ViewportSettings.Transparent + ViewportSettings = Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent }; var txtLabelHR = new View @@ -116,7 +115,7 @@ public class TextAlignmentAndDirection : Scenario SchemeName = "TextAlignmentAndDirection1", TextAlignment = Alignment.End, Text = txt, - ViewportSettings = Terminal.Gui.ViewportSettings.Transparent + ViewportSettings = Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent }; var txtLabelHJ = new View @@ -128,7 +127,7 @@ public class TextAlignmentAndDirection : Scenario SchemeName = "TextAlignmentAndDirection2", TextAlignment = Alignment.Fill, Text = txt, - ViewportSettings = Terminal.Gui.ViewportSettings.Transparent + ViewportSettings = Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent }; singleLineLabels.Add (txtLabelHL); @@ -209,7 +208,7 @@ public class TextAlignmentAndDirection : Scenario TextDirection = TextDirection.TopBottom_LeftRight, VerticalTextAlignment = Alignment.Start, Text = txt, - ViewportSettings = Terminal.Gui.ViewportSettings.Transparent + ViewportSettings = Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent }; txtLabelVT.TextFormatter.WordWrap = false; @@ -223,7 +222,7 @@ public class TextAlignmentAndDirection : Scenario TextDirection = TextDirection.TopBottom_LeftRight, VerticalTextAlignment = Alignment.Center, Text = txt, - ViewportSettings = Terminal.Gui.ViewportSettings.Transparent + ViewportSettings = Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent }; txtLabelVM.TextFormatter.WordWrap = false; @@ -237,7 +236,7 @@ public class TextAlignmentAndDirection : Scenario TextDirection = TextDirection.TopBottom_LeftRight, VerticalTextAlignment = Alignment.End, Text = txt, - ViewportSettings = Terminal.Gui.ViewportSettings.Transparent + ViewportSettings = Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent }; txtLabelVB.TextFormatter.WordWrap = false; @@ -251,7 +250,7 @@ public class TextAlignmentAndDirection : Scenario TextDirection = TextDirection.TopBottom_LeftRight, VerticalTextAlignment = Alignment.Fill, Text = txt, - ViewportSettings = Terminal.Gui.ViewportSettings.Transparent + ViewportSettings = Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent }; txtLabelVJ.TextFormatter.WordWrap = false; diff --git a/Examples/UICatalog/Scenarios/TextEffectsScenario.cs b/Examples/UICatalog/Scenarios/TextEffectsScenario.cs index 0598b4319..838ef4941 100644 --- a/Examples/UICatalog/Scenarios/TextEffectsScenario.cs +++ b/Examples/UICatalog/Scenarios/TextEffectsScenario.cs @@ -1,5 +1,4 @@ using System.Collections.Generic; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/TextFormatterDemo.cs b/Examples/UICatalog/Scenarios/TextFormatterDemo.cs index c6b983e95..08fba2c60 100644 --- a/Examples/UICatalog/Scenarios/TextFormatterDemo.cs +++ b/Examples/UICatalog/Scenarios/TextFormatterDemo.cs @@ -2,7 +2,6 @@ using System.Collections.Generic; using System.Linq; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/TextInputControls.cs b/Examples/UICatalog/Scenarios/TextInputControls.cs index dc4cdb181..d02a49fe0 100644 --- a/Examples/UICatalog/Scenarios/TextInputControls.cs +++ b/Examples/UICatalog/Scenarios/TextInputControls.cs @@ -1,6 +1,5 @@ using System.Text; using System.Text.RegularExpressions; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/TextStyles.cs b/Examples/UICatalog/Scenarios/TextStyles.cs index e76d2ef8c..902ad7399 100644 --- a/Examples/UICatalog/Scenarios/TextStyles.cs +++ b/Examples/UICatalog/Scenarios/TextStyles.cs @@ -1,5 +1,4 @@ #nullable enable -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/TextViewAutocompletePopup.cs b/Examples/UICatalog/Scenarios/TextViewAutocompletePopup.cs index 7911a9e23..934cc60f6 100644 --- a/Examples/UICatalog/Scenarios/TextViewAutocompletePopup.cs +++ b/Examples/UICatalog/Scenarios/TextViewAutocompletePopup.cs @@ -1,6 +1,5 @@ using System.Linq; using System.Text.RegularExpressions; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Themes.cs b/Examples/UICatalog/Scenarios/Themes.cs index 2d5dcb736..95b71f9f3 100644 --- a/Examples/UICatalog/Scenarios/Themes.cs +++ b/Examples/UICatalog/Scenarios/Themes.cs @@ -1,5 +1,4 @@ #nullable enable -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Threading.cs b/Examples/UICatalog/Scenarios/Threading.cs index 0770586d9..1adde0320 100644 --- a/Examples/UICatalog/Scenarios/Threading.cs +++ b/Examples/UICatalog/Scenarios/Threading.cs @@ -2,7 +2,6 @@ using System.Collections.ObjectModel; using System.Threading; using System.Threading.Tasks; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/TileViewNesting.cs b/Examples/UICatalog/Scenarios/TileViewNesting.cs index 749326864..2d262bf49 100644 --- a/Examples/UICatalog/Scenarios/TileViewNesting.cs +++ b/Examples/UICatalog/Scenarios/TileViewNesting.cs @@ -1,5 +1,4 @@ using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/TimeAndDate.cs b/Examples/UICatalog/Scenarios/TimeAndDate.cs index a96d27651..b29be8896 100644 --- a/Examples/UICatalog/Scenarios/TimeAndDate.cs +++ b/Examples/UICatalog/Scenarios/TimeAndDate.cs @@ -1,5 +1,4 @@ using System; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Transparent.cs b/Examples/UICatalog/Scenarios/Transparent.cs index 5ca1bd7d3..1b6f08df8 100644 --- a/Examples/UICatalog/Scenarios/Transparent.cs +++ b/Examples/UICatalog/Scenarios/Transparent.cs @@ -1,5 +1,4 @@ #nullable enable -using Terminal.Gui; namespace UICatalog.Scenarios; @@ -78,7 +77,7 @@ public sealed class Transparent : Scenario TextFormatter.Alignment = Alignment.Center; TextFormatter.VerticalAlignment = Alignment.Center; Arrangement = ViewArrangement.Overlapped | ViewArrangement.Resizable | ViewArrangement.Movable; - ViewportSettings |= Terminal.Gui.ViewportSettings.Transparent | Terminal.Gui.ViewportSettings.TransparentMouse; + ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.Transparent | Terminal.Gui.ViewBase.ViewportSettingsFlags.TransparentMouse; BorderStyle = LineStyle.RoundedDotted; //SchemeName = "Base"; @@ -139,7 +138,7 @@ public sealed class Transparent : Scenario //Padding.SchemeName = "Error"; Margin!.Thickness = new (1); - // Margin.ViewportSettings |= Terminal.Gui.ViewportSettings.Transparent; + // Margin.ViewportSettings |= Terminal.Gui.ViewportSettingsFlags.Transparent; } /// diff --git a/Examples/UICatalog/Scenarios/TreeUseCases.cs b/Examples/UICatalog/Scenarios/TreeUseCases.cs index 57cee729a..4603b9e54 100644 --- a/Examples/UICatalog/Scenarios/TreeUseCases.cs +++ b/Examples/UICatalog/Scenarios/TreeUseCases.cs @@ -1,6 +1,5 @@ using System.Collections.Generic; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/TreeViewFileSystem.cs b/Examples/UICatalog/Scenarios/TreeViewFileSystem.cs index 22a51f04a..cdd013fbc 100644 --- a/Examples/UICatalog/Scenarios/TreeViewFileSystem.cs +++ b/Examples/UICatalog/Scenarios/TreeViewFileSystem.cs @@ -1,6 +1,5 @@ using System.IO.Abstractions; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/TrueColors.cs b/Examples/UICatalog/Scenarios/TrueColors.cs index 16b623b1c..fb6670903 100644 --- a/Examples/UICatalog/Scenarios/TrueColors.cs +++ b/Examples/UICatalog/Scenarios/TrueColors.cs @@ -1,5 +1,4 @@ using System; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/Unicode.cs b/Examples/UICatalog/Scenarios/Unicode.cs index f494c071c..813e1cb49 100644 --- a/Examples/UICatalog/Scenarios/Unicode.cs +++ b/Examples/UICatalog/Scenarios/Unicode.cs @@ -1,7 +1,6 @@ using System.Collections.ObjectModel; using System.IO; using System.Text; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ViewExperiments.cs b/Examples/UICatalog/Scenarios/ViewExperiments.cs index c51019572..b7abf8588 100644 --- a/Examples/UICatalog/Scenarios/ViewExperiments.cs +++ b/Examples/UICatalog/Scenarios/ViewExperiments.cs @@ -1,5 +1,4 @@ using System; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/ViewportSettings.cs b/Examples/UICatalog/Scenarios/ViewportSettings.cs index 964ae24c4..4f447233c 100644 --- a/Examples/UICatalog/Scenarios/ViewportSettings.cs +++ b/Examples/UICatalog/Scenarios/ViewportSettings.cs @@ -1,7 +1,6 @@ using System; using System.Collections.Generic; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; @@ -28,8 +27,8 @@ public class ViewportSettings : Scenario Arrangement = ViewArrangement.Resizable; SetContentSize (new (60, 40)); - ViewportSettings |= Terminal.Gui.ViewportSettings.ClearContentOnly; - ViewportSettings |= Terminal.Gui.ViewportSettings.ClipContentOnly; + ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.ClearContentOnly; + ViewportSettings |= Terminal.Gui.ViewBase.ViewportSettingsFlags.ClipContentOnly; VerticalScrollBar.Visible = true; // Things this view knows how to do diff --git a/Examples/UICatalog/Scenarios/VkeyPacketSimulator.cs b/Examples/UICatalog/Scenarios/VkeyPacketSimulator.cs index 8c88163d4..f78f9e6a1 100644 --- a/Examples/UICatalog/Scenarios/VkeyPacketSimulator.cs +++ b/Examples/UICatalog/Scenarios/VkeyPacketSimulator.cs @@ -2,7 +2,6 @@ using System.Collections.Generic; using System.Threading; using System.Threading.Tasks; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/WindowsAndFrameViews.cs b/Examples/UICatalog/Scenarios/WindowsAndFrameViews.cs index 3569457fc..0a28a74fa 100644 --- a/Examples/UICatalog/Scenarios/WindowsAndFrameViews.cs +++ b/Examples/UICatalog/Scenarios/WindowsAndFrameViews.cs @@ -1,6 +1,5 @@ using System.Collections.Generic; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/Scenarios/WizardAsView.cs b/Examples/UICatalog/Scenarios/WizardAsView.cs index 1a3e61baa..65f417a82 100644 --- a/Examples/UICatalog/Scenarios/WizardAsView.cs +++ b/Examples/UICatalog/Scenarios/WizardAsView.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; - + namespace UICatalog.Scenarios; [ScenarioMetadata ("WizardAsView", "Shows using the Wizard class in an non-modal way")] diff --git a/Examples/UICatalog/Scenarios/Wizards.cs b/Examples/UICatalog/Scenarios/Wizards.cs index 734ce57cb..e74e54d9e 100644 --- a/Examples/UICatalog/Scenarios/Wizards.cs +++ b/Examples/UICatalog/Scenarios/Wizards.cs @@ -1,6 +1,5 @@ using System; using System.Linq; -using Terminal.Gui; namespace UICatalog.Scenarios; diff --git a/Examples/UICatalog/UICatalog.cs b/Examples/UICatalog/UICatalog.cs index 4b9d09f62..410e75517 100644 --- a/Examples/UICatalog/UICatalog.cs +++ b/Examples/UICatalog/UICatalog.cs @@ -1,4 +1,15 @@ -global using Attribute = Terminal.Gui.Attribute; +global using Attribute = Terminal.Gui.Drawing.Attribute; +global using Color = Terminal.Gui.Drawing.Color; +global using CM = Terminal.Gui.Configuration.ConfigurationManager; +global using Terminal.Gui.App; +global using Terminal.Gui.ViewBase; +global using Terminal.Gui.Drivers; +global using Terminal.Gui.Input; +global using Terminal.Gui.Configuration; +global using Terminal.Gui.Views; +global using Terminal.Gui.Drawing; +global using Terminal.Gui.Text; +global using Terminal.Gui.FileServices; using System.CommandLine; using System.CommandLine.Builder; using System.CommandLine.Parsing; @@ -13,8 +24,7 @@ using Microsoft.Extensions.Logging; using Serilog; using Serilog.Core; using Serilog.Events; -using Terminal.Gui; -using Command = Terminal.Gui.Command; +using Command = Terminal.Gui.Input.Command; using ILogger = Microsoft.Extensions.Logging.ILogger; #nullable enable diff --git a/Examples/UICatalog/UICatalog.csproj b/Examples/UICatalog/UICatalog.csproj index b1aa4908e..0b529c499 100644 --- a/Examples/UICatalog/UICatalog.csproj +++ b/Examples/UICatalog/UICatalog.csproj @@ -48,6 +48,5 @@ - \ No newline at end of file diff --git a/Examples/UICatalog/UICatalogTop.cs b/Examples/UICatalog/UICatalogTop.cs index 6dd78e7a4..d80ae86d5 100644 --- a/Examples/UICatalog/UICatalogTop.cs +++ b/Examples/UICatalog/UICatalogTop.cs @@ -4,8 +4,6 @@ using System.Runtime.InteropServices; using System.Text; using System.Text.Json.Serialization; using Microsoft.Extensions.Logging; -using Terminal.Gui; -using Command = Terminal.Gui.Command; using RuntimeEnvironment = Microsoft.DotNet.PlatformAbstractions.RuntimeEnvironment; #nullable enable diff --git a/Terminal.Gui/Application/Application.Driver.cs b/Terminal.Gui/App/Application.Driver.cs similarity index 98% rename from Terminal.Gui/Application/Application.Driver.cs rename to Terminal.Gui/App/Application.Driver.cs index e66c5dc96..c6eac4486 100644 --- a/Terminal.Gui/Application/Application.Driver.cs +++ b/Terminal.Gui/App/Application.Driver.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.App; public static partial class Application // Driver abstractions { diff --git a/Terminal.Gui/Application/Application.Initialization.cs b/Terminal.Gui/App/Application.Initialization.cs similarity index 97% rename from Terminal.Gui/Application/Application.Initialization.cs rename to Terminal.Gui/App/Application.Initialization.cs index e5dca86b6..61756e8e6 100644 --- a/Terminal.Gui/Application/Application.Initialization.cs +++ b/Terminal.Gui/App/Application.Initialization.cs @@ -3,7 +3,7 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Reflection; -namespace Terminal.Gui; +namespace Terminal.Gui.App; public static partial class Application // Initialization (Init/Shutdown) { @@ -22,10 +22,10 @@ public static partial class Application // Initialization (Init/Shutdown) /// /// /// The function combines - /// and + /// and /// into a single /// call. An application cam use without explicitly calling - /// . + /// . /// /// /// The to use. If neither or diff --git a/Terminal.Gui/Application/Application.Keyboard.cs b/Terminal.Gui/App/Application.Keyboard.cs similarity index 99% rename from Terminal.Gui/Application/Application.Keyboard.cs rename to Terminal.Gui/App/Application.Keyboard.cs index 4e586ac19..cb5065561 100644 --- a/Terminal.Gui/Application/Application.Keyboard.cs +++ b/Terminal.Gui/App/Application.Keyboard.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.App; public static partial class Application // Keyboard handling { diff --git a/Terminal.Gui/Application/Application.Mouse.cs b/Terminal.Gui/App/Application.Mouse.cs similarity index 98% rename from Terminal.Gui/Application/Application.Mouse.cs rename to Terminal.Gui/App/Application.Mouse.cs index 0febcfb47..b92818d2d 100644 --- a/Terminal.Gui/Application/Application.Mouse.cs +++ b/Terminal.Gui/App/Application.Mouse.cs @@ -1,8 +1,7 @@ #nullable enable using System.ComponentModel; -using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.App; public static partial class Application // Mouse handling { @@ -159,7 +158,7 @@ public static partial class Application // Mouse handling //Debug.Assert (mouseEvent.Position == mouseEvent.ScreenPosition); mouseEvent.Position = mouseEvent.ScreenPosition; - List currentViewsUnderMouse = View.GetViewsUnderLocation (mouseEvent.ScreenPosition, ViewportSettings.TransparentMouse); + List currentViewsUnderMouse = View.GetViewsUnderLocation (mouseEvent.ScreenPosition, ViewportSettingsFlags.TransparentMouse); View? deepestViewUnderMouse = currentViewsUnderMouse.LastOrDefault (); @@ -359,7 +358,7 @@ public static partial class Application // Mouse handling } /// - /// INTERNAL: Holds the non- views that are currently under the mouse. + /// INTERNAL: Holds the non- views that are currently under the mouse. /// internal static List CachedViewsUnderMouse { get; } = []; diff --git a/Terminal.Gui/Application/Application.Navigation.cs b/Terminal.Gui/App/Application.Navigation.cs similarity index 99% rename from Terminal.Gui/Application/Application.Navigation.cs rename to Terminal.Gui/App/Application.Navigation.cs index 3f4d92959..677b17f69 100644 --- a/Terminal.Gui/Application/Application.Navigation.cs +++ b/Terminal.Gui/App/Application.Navigation.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.App; public static partial class Application // Navigation stuff { diff --git a/Terminal.Gui/Application/Application.Popover.cs b/Terminal.Gui/App/Application.Popover.cs similarity index 89% rename from Terminal.Gui/Application/Application.Popover.cs rename to Terminal.Gui/App/Application.Popover.cs index 104994a0e..25a8ebe9c 100644 --- a/Terminal.Gui/Application/Application.Popover.cs +++ b/Terminal.Gui/App/Application.Popover.cs @@ -1,6 +1,6 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.App; public static partial class Application // Popover handling { diff --git a/Terminal.Gui/Application/Application.Run.cs b/Terminal.Gui/App/Application.Run.cs similarity index 98% rename from Terminal.Gui/Application/Application.Run.cs rename to Terminal.Gui/App/Application.Run.cs index 585b94d1d..860bed0fc 100644 --- a/Terminal.Gui/Application/Application.Run.cs +++ b/Terminal.Gui/App/Application.Run.cs @@ -2,7 +2,7 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; -namespace Terminal.Gui; +namespace Terminal.Gui.App; public static partial class Application // Run (Begin, Run, End, Stop) { @@ -354,11 +354,11 @@ public static partial class Application // Run (Begin, Run, End, Stop) /// modal s such as boxes. /// /// - /// To make a stop execution, call + /// To make a stop execution, call /// . /// /// - /// Calling is equivalent to calling + /// Calling is equivalent to calling /// , followed by , and then calling /// . /// @@ -371,7 +371,7 @@ public static partial class Application // Run (Begin, Run, End, Stop) /// /// /// When using or - /// + /// /// will be called automatically. /// /// @@ -551,7 +551,7 @@ public static partial class Application // Run (Begin, Run, End, Stop) /// /// This will cause to return. /// - /// Calling is equivalent to setting the + /// Calling is equivalent to setting the /// /// property on the currently running to false. /// diff --git a/Terminal.Gui/Application/Application.Screen.cs b/Terminal.Gui/App/Application.Screen.cs similarity index 98% rename from Terminal.Gui/Application/Application.Screen.cs rename to Terminal.Gui/App/Application.Screen.cs index 68e7bec3f..bd57585ea 100644 --- a/Terminal.Gui/Application/Application.Screen.cs +++ b/Terminal.Gui/App/Application.Screen.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.App; public static partial class Application // Screen related stuff { diff --git a/Terminal.Gui/Application/Application.Toplevel.cs b/Terminal.Gui/App/Application.Toplevel.cs similarity index 96% rename from Terminal.Gui/Application/Application.Toplevel.cs rename to Terminal.Gui/App/Application.Toplevel.cs index 1b7a58d94..add62a5a5 100644 --- a/Terminal.Gui/Application/Application.Toplevel.cs +++ b/Terminal.Gui/App/Application.Toplevel.cs @@ -1,7 +1,7 @@ #nullable enable using System.Collections.Concurrent; -namespace Terminal.Gui; +namespace Terminal.Gui.App; public static partial class Application // Toplevel handling { diff --git a/Terminal.Gui/Application/Application.cd b/Terminal.Gui/App/Application.cd similarity index 100% rename from Terminal.Gui/Application/Application.cd rename to Terminal.Gui/App/Application.cd diff --git a/Terminal.Gui/Application/Application.cs b/Terminal.Gui/App/Application.cs similarity index 99% rename from Terminal.Gui/Application/Application.cs rename to Terminal.Gui/App/Application.cs index 03a602b4b..8c9d086bb 100644 --- a/Terminal.Gui/Application/Application.cs +++ b/Terminal.Gui/App/Application.cs @@ -3,9 +3,8 @@ using System.Diagnostics; using System.Globalization; using System.Reflection; using System.Resources; -using Terminal.Gui.Resources; -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// A static, singleton class representing the application. This class is the entry point for the application. /// diff --git a/Terminal.Gui/Application/ApplicationImpl.cs b/Terminal.Gui/App/ApplicationImpl.cs similarity index 97% rename from Terminal.Gui/Application/ApplicationImpl.cs rename to Terminal.Gui/App/ApplicationImpl.cs index e6b8fe399..c9e9e8f47 100644 --- a/Terminal.Gui/Application/ApplicationImpl.cs +++ b/Terminal.Gui/App/ApplicationImpl.cs @@ -2,7 +2,7 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// /// Original Terminal.Gui implementation of core methods. @@ -102,11 +102,11 @@ public class ApplicationImpl : IApplication /// modal s such as boxes. /// /// - /// To make a stop execution, call + /// To make a stop execution, call /// . /// /// - /// Calling is equivalent to calling + /// Calling is equivalent to calling /// , followed by , and then calling /// . /// @@ -118,7 +118,7 @@ public class ApplicationImpl : IApplication /// return control immediately. /// /// When using or - /// + /// /// will be called automatically. /// /// diff --git a/Terminal.Gui/Application/ApplicationNavigation.cs b/Terminal.Gui/App/ApplicationNavigation.cs similarity index 99% rename from Terminal.Gui/Application/ApplicationNavigation.cs rename to Terminal.Gui/App/ApplicationNavigation.cs index d135773c6..4a64b037b 100644 --- a/Terminal.Gui/Application/ApplicationNavigation.cs +++ b/Terminal.Gui/App/ApplicationNavigation.cs @@ -2,7 +2,7 @@ using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// /// Helper class for navigation. Held by diff --git a/Terminal.Gui/Application/ApplicationPopover.cs b/Terminal.Gui/App/ApplicationPopover.cs similarity index 99% rename from Terminal.Gui/Application/ApplicationPopover.cs rename to Terminal.Gui/App/ApplicationPopover.cs index 8c2512e1c..061b10379 100644 --- a/Terminal.Gui/Application/ApplicationPopover.cs +++ b/Terminal.Gui/App/ApplicationPopover.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.App; /// /// Helper class for support of views for . Held by diff --git a/Terminal.Gui/Clipboard/Clipboard.cs b/Terminal.Gui/App/Clipboard/Clipboard.cs similarity index 99% rename from Terminal.Gui/Clipboard/Clipboard.cs rename to Terminal.Gui/App/Clipboard/Clipboard.cs index ecb59205f..6ee6116eb 100644 --- a/Terminal.Gui/Clipboard/Clipboard.cs +++ b/Terminal.Gui/App/Clipboard/Clipboard.cs @@ -1,6 +1,6 @@ using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// Provides cut, copy, and paste support for the OS clipboard. /// diff --git a/Terminal.Gui/Clipboard/ClipboardBase.cs b/Terminal.Gui/App/Clipboard/ClipboardBase.cs similarity index 99% rename from Terminal.Gui/Clipboard/ClipboardBase.cs rename to Terminal.Gui/App/Clipboard/ClipboardBase.cs index 2406cfe47..908035f91 100644 --- a/Terminal.Gui/Clipboard/ClipboardBase.cs +++ b/Terminal.Gui/App/Clipboard/ClipboardBase.cs @@ -1,6 +1,6 @@ using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// Shared abstract class to enforce rules from the implementation of the interface. public abstract class ClipboardBase : IClipboard diff --git a/Terminal.Gui/Clipboard/IClipboard.cs b/Terminal.Gui/App/Clipboard/IClipboard.cs similarity index 97% rename from Terminal.Gui/Clipboard/IClipboard.cs rename to Terminal.Gui/App/Clipboard/IClipboard.cs index 789b30aeb..4a50a231f 100644 --- a/Terminal.Gui/Clipboard/IClipboard.cs +++ b/Terminal.Gui/App/Clipboard/IClipboard.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// Definition to interact with the OS clipboard. public interface IClipboard diff --git a/Terminal.Gui/Application/IApplication.cs b/Terminal.Gui/App/IApplication.cs similarity index 93% rename from Terminal.Gui/Application/IApplication.cs rename to Terminal.Gui/App/IApplication.cs index a6362b09e..d8df8d552 100644 --- a/Terminal.Gui/Application/IApplication.cs +++ b/Terminal.Gui/App/IApplication.cs @@ -1,7 +1,7 @@ #nullable enable using System.Diagnostics.CodeAnalysis; -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// /// Interface for instances that provide backing functionality to static @@ -23,10 +23,10 @@ public interface IApplication /// /// /// The function combines - /// and + /// and /// into a single /// call. An application cam use without explicitly calling - /// . + /// . /// /// /// The to use. If neither or @@ -94,11 +94,11 @@ public interface IApplication /// modal s such as boxes. /// /// - /// To make a stop execution, call + /// To make a stop execution, call /// . /// /// - /// Calling is equivalent to calling + /// Calling is equivalent to calling /// , followed by , and then calling /// . /// @@ -110,7 +110,7 @@ public interface IApplication /// return control immediately. /// /// When using or - /// + /// /// will be called automatically. /// /// @@ -141,7 +141,7 @@ public interface IApplication /// /// This will cause to return. /// - /// Calling is equivalent to setting the + /// Calling is equivalent to setting the /// property on the currently running to false. /// /// diff --git a/Terminal.Gui/Application/IPopover.cs b/Terminal.Gui/App/IPopover.cs similarity index 96% rename from Terminal.Gui/Application/IPopover.cs rename to Terminal.Gui/App/IPopover.cs index 9ec5d05b1..cbff58597 100644 --- a/Terminal.Gui/Application/IPopover.cs +++ b/Terminal.Gui/App/IPopover.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.App; /// /// Interface identifying a View as being capable of being a Popover. diff --git a/Terminal.Gui/Application/ITimedEvents.cs b/Terminal.Gui/App/ITimedEvents.cs similarity index 99% rename from Terminal.Gui/Application/ITimedEvents.cs rename to Terminal.Gui/App/ITimedEvents.cs index 80a276933..1fd867a8c 100644 --- a/Terminal.Gui/Application/ITimedEvents.cs +++ b/Terminal.Gui/App/ITimedEvents.cs @@ -1,7 +1,7 @@ #nullable enable using System.Collections.ObjectModel; -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// /// Manages timers and idles diff --git a/Terminal.Gui/Application/IterationEventArgs.cs b/Terminal.Gui/App/IterationEventArgs.cs similarity index 83% rename from Terminal.Gui/Application/IterationEventArgs.cs rename to Terminal.Gui/App/IterationEventArgs.cs index 27887a4b5..417346eee 100644 --- a/Terminal.Gui/Application/IterationEventArgs.cs +++ b/Terminal.Gui/App/IterationEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// Event arguments for the event. public class IterationEventArgs : EventArgs diff --git a/Terminal.Gui/ConsoleDrivers/V2/Logging.cs b/Terminal.Gui/App/Logging.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/V2/Logging.cs rename to Terminal.Gui/App/Logging.cs index 8cf6f9a7a..449d0d5ef 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/Logging.cs +++ b/Terminal.Gui/App/Logging.cs @@ -3,7 +3,7 @@ using System.Runtime.CompilerServices; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging.Abstractions; -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// /// Singleton logging instance class. Do not use console loggers diff --git a/Terminal.Gui/Application/MainLoop.cs b/Terminal.Gui/App/MainLoop.cs similarity index 99% rename from Terminal.Gui/Application/MainLoop.cs rename to Terminal.Gui/App/MainLoop.cs index 3b6cf3b9d..65f4ed599 100644 --- a/Terminal.Gui/Application/MainLoop.cs +++ b/Terminal.Gui/App/MainLoop.cs @@ -8,7 +8,7 @@ using System.Collections.ObjectModel; -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// Interface to create a platform specific driver. internal interface IMainLoopDriver diff --git a/Terminal.Gui/Application/MainLoopSyncContext.cs b/Terminal.Gui/App/MainLoopSyncContext.cs similarity index 98% rename from Terminal.Gui/Application/MainLoopSyncContext.cs rename to Terminal.Gui/App/MainLoopSyncContext.cs index 749c76268..d2268c5ad 100644 --- a/Terminal.Gui/Application/MainLoopSyncContext.cs +++ b/Terminal.Gui/App/MainLoopSyncContext.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// /// provides the sync context set while executing code in Terminal.Gui, to let diff --git a/Terminal.Gui/Application/PopoverBaseImpl.cs b/Terminal.Gui/App/PopoverBaseImpl.cs similarity index 94% rename from Terminal.Gui/Application/PopoverBaseImpl.cs rename to Terminal.Gui/App/PopoverBaseImpl.cs index b16411e98..3800d886c 100644 --- a/Terminal.Gui/Application/PopoverBaseImpl.cs +++ b/Terminal.Gui/App/PopoverBaseImpl.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.App; /// /// Abstract base class for Popover Views. @@ -26,7 +27,7 @@ public abstract class PopoverBaseImpl : View, IPopover CanFocus = true; Width = Dim.Fill (); Height = Dim.Fill (); - ViewportSettings = ViewportSettings.Transparent | ViewportSettings.TransparentMouse; + ViewportSettings = ViewportSettingsFlags.Transparent | ViewportSettingsFlags.TransparentMouse; // TODO: Add a diagnostic setting for this? //TextFormatter.VerticalAlignment = Alignment.End; diff --git a/Terminal.Gui/Application/RunState.cs b/Terminal.Gui/App/RunState.cs similarity index 99% rename from Terminal.Gui/Application/RunState.cs rename to Terminal.Gui/App/RunState.cs index 503055892..e1ad8bb0f 100644 --- a/Terminal.Gui/Application/RunState.cs +++ b/Terminal.Gui/App/RunState.cs @@ -1,6 +1,6 @@ using System.Collections.Concurrent; -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// The execution state for a view. public class RunState : IDisposable diff --git a/Terminal.Gui/Application/RunStateEventArgs.cs b/Terminal.Gui/App/RunStateEventArgs.cs similarity index 93% rename from Terminal.Gui/Application/RunStateEventArgs.cs rename to Terminal.Gui/App/RunStateEventArgs.cs index abe25957c..95e11eb03 100644 --- a/Terminal.Gui/Application/RunStateEventArgs.cs +++ b/Terminal.Gui/App/RunStateEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// Event arguments for events about public class RunStateEventArgs : EventArgs diff --git a/Terminal.Gui/Application/TimedEvents.cs b/Terminal.Gui/App/TimedEvents.cs similarity index 99% rename from Terminal.Gui/Application/TimedEvents.cs rename to Terminal.Gui/App/TimedEvents.cs index 8325e6ed6..13553a43b 100644 --- a/Terminal.Gui/Application/TimedEvents.cs +++ b/Terminal.Gui/App/TimedEvents.cs @@ -1,7 +1,7 @@ #nullable enable using System.Collections.ObjectModel; -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// /// Handles timeouts and idles diff --git a/Terminal.Gui/Application/Timeout.cs b/Terminal.Gui/App/Timeout.cs similarity index 93% rename from Terminal.Gui/Application/Timeout.cs rename to Terminal.Gui/App/Timeout.cs index 721aac411..615ca2d9f 100644 --- a/Terminal.Gui/Application/Timeout.cs +++ b/Terminal.Gui/App/Timeout.cs @@ -5,7 +5,7 @@ // Miguel de Icaza (miguel@gnome.org) // -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// Provides data for timers running manipulation. public sealed class Timeout diff --git a/Terminal.Gui/Application/TimeoutEventArgs.cs b/Terminal.Gui/App/TimeoutEventArgs.cs similarity index 95% rename from Terminal.Gui/Application/TimeoutEventArgs.cs rename to Terminal.Gui/App/TimeoutEventArgs.cs index 2e01228c1..b77741db4 100644 --- a/Terminal.Gui/Application/TimeoutEventArgs.cs +++ b/Terminal.Gui/App/TimeoutEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.App; /// for timeout events (e.g. ) public class TimeoutEventArgs : EventArgs diff --git a/Terminal.Gui/AssemblyInfo.cs b/Terminal.Gui/AssemblyInfo.cs new file mode 100644 index 000000000..4e9b2b2db --- /dev/null +++ b/Terminal.Gui/AssemblyInfo.cs @@ -0,0 +1,13 @@ +global using Attribute = Terminal.Gui.Drawing.Attribute; +global using Color = Terminal.Gui.Drawing.Color; +global using CM = Terminal.Gui.Configuration.ConfigurationManager; +global using Terminal.Gui.App; +global using Terminal.Gui.Drivers; +global using Terminal.Gui.Input; +global using Terminal.Gui.Configuration; +global using Terminal.Gui.ViewBase; +global using Terminal.Gui.Views; +global using Terminal.Gui.Drawing; +global using Terminal.Gui.Text; +global using Terminal.Gui.Resources; +global using Terminal.Gui.FileServices; \ No newline at end of file diff --git a/Terminal.Gui/Configuration/AppSettingsScope.cs b/Terminal.Gui/Configuration/AppSettingsScope.cs index f32777b0f..35594cacb 100644 --- a/Terminal.Gui/Configuration/AppSettingsScope.cs +++ b/Terminal.Gui/Configuration/AppSettingsScope.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// The class for application-defined configuration settings. /// diff --git a/Terminal.Gui/Configuration/AttributeJsonConverter.cs b/Terminal.Gui/Configuration/AttributeJsonConverter.cs index 543cf8953..34ee281c5 100644 --- a/Terminal.Gui/Configuration/AttributeJsonConverter.cs +++ b/Terminal.Gui/Configuration/AttributeJsonConverter.cs @@ -2,7 +2,7 @@ using System.Text.Json; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// Json converter from the class. [RequiresUnreferencedCode ("AOT")] diff --git a/Terminal.Gui/Configuration/ColorJsonConverter.cs b/Terminal.Gui/Configuration/ColorJsonConverter.cs index c49029916..70d6ca7e7 100644 --- a/Terminal.Gui/Configuration/ColorJsonConverter.cs +++ b/Terminal.Gui/Configuration/ColorJsonConverter.cs @@ -1,7 +1,7 @@ using System.Text.Json; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// /// Json converter for the class. diff --git a/Terminal.Gui/Configuration/ConcurrentDictionaryJsonConverter.cs b/Terminal.Gui/Configuration/ConcurrentDictionaryJsonConverter.cs index bd1e3c271..a33f9181a 100644 --- a/Terminal.Gui/Configuration/ConcurrentDictionaryJsonConverter.cs +++ b/Terminal.Gui/Configuration/ConcurrentDictionaryJsonConverter.cs @@ -3,7 +3,7 @@ using System.Diagnostics.CodeAnalysis; using System.Text.Json; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; [RequiresUnreferencedCode("AOT")] internal class ConcurrentDictionaryJsonConverter : JsonConverter> diff --git a/Terminal.Gui/Configuration/ConfigLocations.cs b/Terminal.Gui/Configuration/ConfigLocations.cs index 10daa4b47..8f348fa8c 100644 --- a/Terminal.Gui/Configuration/ConfigLocations.cs +++ b/Terminal.Gui/Configuration/ConfigLocations.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// /// Describes the location of the configuration settings. The constants can be combined (bitwise) to specify multiple diff --git a/Terminal.Gui/Configuration/ConfigProperty.cs b/Terminal.Gui/Configuration/ConfigProperty.cs index 394e9e494..8854b6ef2 100644 --- a/Terminal.Gui/Configuration/ConfigProperty.cs +++ b/Terminal.Gui/Configuration/ConfigProperty.cs @@ -1,13 +1,12 @@ #nullable enable using System.Collections.Concurrent; using System.Collections.Immutable; -using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Reflection; using System.Text.Json; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// /// Holds a property's value and the that allows to diff --git a/Terminal.Gui/Configuration/ConfigurationManager.cs b/Terminal.Gui/Configuration/ConfigurationManager.cs index 0ef9482e7..c082ab564 100644 --- a/Terminal.Gui/Configuration/ConfigurationManager.cs +++ b/Terminal.Gui/Configuration/ConfigurationManager.cs @@ -9,7 +9,7 @@ using System.Text.Encodings.Web; using System.Text.Json; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// /// Provides settings and configuration management for Terminal.Gui applications. See the Configuration Deep Dive for diff --git a/Terminal.Gui/Configuration/ConfigurationManagerEventArgs.cs b/Terminal.Gui/Configuration/ConfigurationManagerEventArgs.cs index d8c341737..3ac43d9ee 100644 --- a/Terminal.Gui/Configuration/ConfigurationManagerEventArgs.cs +++ b/Terminal.Gui/Configuration/ConfigurationManagerEventArgs.cs @@ -1,6 +1,6 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// Event arguments for the events. public class ConfigurationManagerEventArgs : EventArgs diff --git a/Terminal.Gui/Configuration/ConfigurationManagerNotEnabledException.cs b/Terminal.Gui/Configuration/ConfigurationManagerNotEnabledException.cs index a8e976751..45206c876 100644 --- a/Terminal.Gui/Configuration/ConfigurationManagerNotEnabledException.cs +++ b/Terminal.Gui/Configuration/ConfigurationManagerNotEnabledException.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// /// The exception that is thrown when a API is called but the configuration manager is not enabled. diff --git a/Terminal.Gui/Configuration/ConfigurationPropertyAttribute.cs b/Terminal.Gui/Configuration/ConfigurationPropertyAttribute.cs index 793cc6fb2..2f1218aa9 100644 --- a/Terminal.Gui/Configuration/ConfigurationPropertyAttribute.cs +++ b/Terminal.Gui/Configuration/ConfigurationPropertyAttribute.cs @@ -1,6 +1,6 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// An attribute indicating a property is managed by . /// diff --git a/Terminal.Gui/Configuration/DeepCloner.cs b/Terminal.Gui/Configuration/DeepCloner.cs index d91ad663b..abdb01ef9 100644 --- a/Terminal.Gui/Configuration/DeepCloner.cs +++ b/Terminal.Gui/Configuration/DeepCloner.cs @@ -7,7 +7,7 @@ using System.Reflection; using System.Text.Json; using System.Text.Json.Serialization.Metadata; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// /// Provides deep cloning functionality for Terminal.Gui configuration objects. diff --git a/Terminal.Gui/Configuration/DictionaryJsonConverter.cs b/Terminal.Gui/Configuration/DictionaryJsonConverter.cs index ee1aebb4e..bfd940d33 100644 --- a/Terminal.Gui/Configuration/DictionaryJsonConverter.cs +++ b/Terminal.Gui/Configuration/DictionaryJsonConverter.cs @@ -2,7 +2,7 @@ using System.Text.Json; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; [RequiresUnreferencedCode ("AOT")] internal class DictionaryJsonConverter : JsonConverter> diff --git a/Terminal.Gui/Configuration/KeyCodeJsonConverter.cs b/Terminal.Gui/Configuration/KeyCodeJsonConverter.cs index 7bec8f91f..04d8d9765 100644 --- a/Terminal.Gui/Configuration/KeyCodeJsonConverter.cs +++ b/Terminal.Gui/Configuration/KeyCodeJsonConverter.cs @@ -1,7 +1,7 @@ using System.Text.Json; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; internal class KeyCodeJsonConverter : JsonConverter { diff --git a/Terminal.Gui/Configuration/KeyJsonConverter.cs b/Terminal.Gui/Configuration/KeyJsonConverter.cs index 775f45d87..01413c432 100644 --- a/Terminal.Gui/Configuration/KeyJsonConverter.cs +++ b/Terminal.Gui/Configuration/KeyJsonConverter.cs @@ -1,7 +1,7 @@ using System.Text.Json; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// Support for in JSON in the form of "Ctrl-X" or "Alt-Shift-F1". public class KeyJsonConverter : JsonConverter diff --git a/Terminal.Gui/Configuration/RuneJsonConverter.cs b/Terminal.Gui/Configuration/RuneJsonConverter.cs index 118780d05..8fc7f9f7b 100644 --- a/Terminal.Gui/Configuration/RuneJsonConverter.cs +++ b/Terminal.Gui/Configuration/RuneJsonConverter.cs @@ -3,7 +3,7 @@ using System.Text.Json; using System.Text.Json.Serialization; using System.Text.RegularExpressions; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// /// Json converter for . diff --git a/Terminal.Gui/Configuration/SchemeJsonConverter.cs b/Terminal.Gui/Configuration/SchemeJsonConverter.cs index 58bba896b..cabeefacf 100644 --- a/Terminal.Gui/Configuration/SchemeJsonConverter.cs +++ b/Terminal.Gui/Configuration/SchemeJsonConverter.cs @@ -3,10 +3,10 @@ using System.Diagnostics.CodeAnalysis; using System.Text.Json; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; // ReSharper disable StringLiteralTypo -/// Implements a JSON converter for . +/// Implements a JSON converter for . [RequiresUnreferencedCode ("AOT")] internal class SchemeJsonConverter : JsonConverter { diff --git a/Terminal.Gui/Configuration/SchemeManager.cs b/Terminal.Gui/Configuration/SchemeManager.cs index eb9a3f119..f8b22c3a9 100644 --- a/Terminal.Gui/Configuration/SchemeManager.cs +++ b/Terminal.Gui/Configuration/SchemeManager.cs @@ -1,17 +1,14 @@ #nullable enable -using System.Collections; -using System.Collections.Concurrent; using System.Collections.Immutable; -using System.Collections.Specialized; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// -/// Holds the s that define the s that are used by views to render -/// themselves. A Scheme is a mapping from s (such as ) to s. +/// Holds the s that define the s that are used by views to render +/// themselves. A Scheme is a mapping from s (such as ) to s. /// A Scheme defines how a `View` should look based on its purpose (e.g. Menu or Dialog). /// public sealed class SchemeManager// : INotifyCollectionChanged, IDictionary @@ -28,7 +25,7 @@ public sealed class SchemeManager// : INotifyCollectionChanged, IDictionary? GetHardCodedSchemes () { return Scheme.GetHardCodedSchemes ()!; } /// - /// Use , , , , etc... instead. + /// Use , , , , etc... instead. /// [ConfigurationProperty (Scope = typeof (ThemeScope), OmitClassName = true)] [JsonConverter (typeof (DictionaryJsonConverter))] @@ -111,7 +108,7 @@ public sealed class SchemeManager// : INotifyCollectionChanged, IDictionary - /// Gets the for the specified . + /// Gets the for the specified . /// /// /// diff --git a/Terminal.Gui/Configuration/Scope.cs b/Terminal.Gui/Configuration/Scope.cs index a525353c7..9f713b0e9 100644 --- a/Terminal.Gui/Configuration/Scope.cs +++ b/Terminal.Gui/Configuration/Scope.cs @@ -3,7 +3,7 @@ using System.Collections.Concurrent; using System.Diagnostics.CodeAnalysis; using System.Text.Json; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// /// Defines a configuration settings scope. Classes that inherit from this abstract class can be used to define @@ -185,7 +185,7 @@ public class Scope : ConcurrentDictionary { if (IsEmpty) { - throw new JsonException ($@"Empty!"); + //throw new JsonException ($@"Empty!"); } } } diff --git a/Terminal.Gui/Configuration/ScopeJsonConverter.cs b/Terminal.Gui/Configuration/ScopeJsonConverter.cs index 4f3152be1..51f94317c 100644 --- a/Terminal.Gui/Configuration/ScopeJsonConverter.cs +++ b/Terminal.Gui/Configuration/ScopeJsonConverter.cs @@ -4,7 +4,7 @@ using System.Reflection; using System.Text.Json; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// /// Converts instances to/from JSON. Does all the heavy lifting of reading/writing config diff --git a/Terminal.Gui/Configuration/SettingsScope.cs b/Terminal.Gui/Configuration/SettingsScope.cs index 804215cdb..d2802c5f0 100644 --- a/Terminal.Gui/Configuration/SettingsScope.cs +++ b/Terminal.Gui/Configuration/SettingsScope.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; // TODO: Change to internal to prevent app usage /// diff --git a/Terminal.Gui/Configuration/SourceGenerationContext.cs b/Terminal.Gui/Configuration/SourceGenerationContext.cs index 300b85056..82cd4bb84 100644 --- a/Terminal.Gui/Configuration/SourceGenerationContext.cs +++ b/Terminal.Gui/Configuration/SourceGenerationContext.cs @@ -1,7 +1,7 @@ using System.Collections.Concurrent; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// /// Allow AOT and self-contained single file applications with the . diff --git a/Terminal.Gui/Configuration/SourcesManager.cs b/Terminal.Gui/Configuration/SourcesManager.cs index 83a412c6e..729086541 100644 --- a/Terminal.Gui/Configuration/SourcesManager.cs +++ b/Terminal.Gui/Configuration/SourcesManager.cs @@ -4,7 +4,7 @@ using System.Diagnostics.CodeAnalysis; using System.Reflection; using System.Text.Json; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// /// Manages the Sources and provides the API for loading them. Source is a location where a configuration can be stored. Sources are defined in . diff --git a/Terminal.Gui/Configuration/ThemeManager.cs b/Terminal.Gui/Configuration/ThemeManager.cs index b9a3aefa4..ef4daaccf 100644 --- a/Terminal.Gui/Configuration/ThemeManager.cs +++ b/Terminal.Gui/Configuration/ThemeManager.cs @@ -4,7 +4,7 @@ using System.Collections.Immutable; using System.Diagnostics.CodeAnalysis; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; /// Manages Themes. /// diff --git a/Terminal.Gui/Configuration/ThemeScope.cs b/Terminal.Gui/Configuration/ThemeScope.cs index f379cd888..541cb80f6 100644 --- a/Terminal.Gui/Configuration/ThemeScope.cs +++ b/Terminal.Gui/Configuration/ThemeScope.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Configuration; // TODO: Change to internal to prevent app usage /// diff --git a/Terminal.Gui/Drawing/Attribute.cs b/Terminal.Gui/Drawing/Attribute.cs index 8f8c218ca..eeee8583b 100644 --- a/Terminal.Gui/Drawing/Attribute.cs +++ b/Terminal.Gui/Drawing/Attribute.cs @@ -2,7 +2,7 @@ using System.Numerics; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Represents the visual styling for a UI element, including foreground and background color and text style. diff --git a/Terminal.Gui/Drawing/Cell.cs b/Terminal.Gui/Drawing/Cell.cs index 001fe5054..0a76f8713 100644 --- a/Terminal.Gui/Drawing/Cell.cs +++ b/Terminal.Gui/Drawing/Cell.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drawing; /// /// Represents a single row/column in a Terminal.Gui rendering surface (e.g. and @@ -78,7 +79,7 @@ public record struct Cell (Attribute? Attribute = null, bool IsDirty = false, Ru /// Converts the string into a . /// The string to convert. - /// The to use. + /// The to use. /// public static List ToCellList (string str, Attribute? attribute = null) { diff --git a/Terminal.Gui/Drawing/CellEventArgs.cs b/Terminal.Gui/Drawing/CellEventArgs.cs index f2a8115dc..b8e7bfcfb 100644 --- a/Terminal.Gui/Drawing/CellEventArgs.cs +++ b/Terminal.Gui/Drawing/CellEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// Args for events that relate to a specific . public record struct CellEventArgs diff --git a/Terminal.Gui/Drawing/Color/AnsiColorCode.cs b/Terminal.Gui/Drawing/Color/AnsiColorCode.cs index 35af3fed8..56bc857a8 100644 --- a/Terminal.Gui/Drawing/Color/AnsiColorCode.cs +++ b/Terminal.Gui/Drawing/Color/AnsiColorCode.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// The 16 foreground color codes used by ANSI Esc sequences for 256 color terminals. Add 10 to these values for diff --git a/Terminal.Gui/Drawing/Color/AnsiColorNameResolver.cs b/Terminal.Gui/Drawing/Color/AnsiColorNameResolver.cs index 403a0d35a..aae4a6da5 100644 --- a/Terminal.Gui/Drawing/Color/AnsiColorNameResolver.cs +++ b/Terminal.Gui/Drawing/Color/AnsiColorNameResolver.cs @@ -3,7 +3,7 @@ using System.Collections.Immutable; using System.Diagnostics.CodeAnalysis; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Color name resolver for . diff --git a/Terminal.Gui/Drawing/Color/Color.ColorExtensions.cs b/Terminal.Gui/Drawing/Color/Color.ColorExtensions.cs index 0e8e9b84f..84e5f089a 100644 --- a/Terminal.Gui/Drawing/Color/Color.ColorExtensions.cs +++ b/Terminal.Gui/Drawing/Color/Color.ColorExtensions.cs @@ -2,7 +2,7 @@ using System.Collections.Frozen; using ColorHelper; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; internal static class ColorExtensions { diff --git a/Terminal.Gui/Drawing/Color/Color.ColorName.cs b/Terminal.Gui/Drawing/Color/Color.ColorName.cs index 45bc0577c..70d4667c5 100644 --- a/Terminal.Gui/Drawing/Color/Color.ColorName.cs +++ b/Terminal.Gui/Drawing/Color/Color.ColorName.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Defines the 16 legacy color names and values that can be used to set the foreground and background colors in diff --git a/Terminal.Gui/Drawing/Color/Color.ColorParseException.cs b/Terminal.Gui/Drawing/Color/Color.ColorParseException.cs index c22dca6de..97595db04 100644 --- a/Terminal.Gui/Drawing/Color/Color.ColorParseException.cs +++ b/Terminal.Gui/Drawing/Color/Color.ColorParseException.cs @@ -1,7 +1,7 @@ #nullable enable using System.Diagnostics.CodeAnalysis; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// An exception thrown when something goes wrong when trying to parse a . /// Contains additional information to help locate the problem.
Not intended to be thrown by consumers. diff --git a/Terminal.Gui/Drawing/Color/Color.Formatting.cs b/Terminal.Gui/Drawing/Color/Color.Formatting.cs index 323ae1416..15e0dccb9 100644 --- a/Terminal.Gui/Drawing/Color/Color.Formatting.cs +++ b/Terminal.Gui/Drawing/Color/Color.Formatting.cs @@ -3,7 +3,7 @@ using System.Diagnostics.CodeAnalysis; using System.Globalization; using System.Runtime.CompilerServices; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; public readonly partial record struct Color { @@ -459,7 +459,7 @@ public readonly partial record struct Color /// Converts the provided to a new value. /// /// The text to analyze. Formats supported are "#RGB", "#RRGGBB", "#ARGB", "#AARRGGBB", "rgb(r,g,b)", - /// "rgb(r,g,b,a)", "rgba(r,g,b)", "rgba(r,g,b,a)", and any of the string + /// "rgb(r,g,b,a)", "rgba(r,g,b)", "rgba(r,g,b,a)", and any of the string /// values. /// /// diff --git a/Terminal.Gui/Drawing/Color/Color.Operators.cs b/Terminal.Gui/Drawing/Color/Color.Operators.cs index 8807f8cae..831f32bab 100644 --- a/Terminal.Gui/Drawing/Color/Color.Operators.cs +++ b/Terminal.Gui/Drawing/Color/Color.Operators.cs @@ -2,7 +2,7 @@ using System.Diagnostics.Contracts; using System.Numerics; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; public readonly partial record struct Color { @@ -53,7 +53,7 @@ public readonly partial record struct Color public static implicit operator Color (uint u) { return new Color (u); } /// - /// Implicit conversion from to via lookup from + /// Implicit conversion from to via lookup from /// . /// [Pure] diff --git a/Terminal.Gui/Drawing/Color/Color.cs b/Terminal.Gui/Drawing/Color/Color.cs index 28eba7076..f220de1ab 100644 --- a/Terminal.Gui/Drawing/Color/Color.cs +++ b/Terminal.Gui/Drawing/Color/Color.cs @@ -8,7 +8,7 @@ using System.Text.Json.Serialization; using ColorHelper; using ColorConverter = ColorHelper.ColorConverter; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Represents a 24-bit color encoded in ARGB32 format. @@ -178,7 +178,7 @@ public readonly partial record struct Color : ISpanParsable, IUtf8SpanPar /// will return the closest 16 color match to the true color when no exact value is found. /// /// - /// Get returns the of the closest 24-bit color value. Set + /// Get returns the of the closest 24-bit color value. Set /// sets the RGB /// value using a hard-coded map. /// @@ -189,7 +189,7 @@ public readonly partial record struct Color : ISpanParsable, IUtf8SpanPar /// . /// /// - /// The to check if this is closer + /// The to check if this is closer /// to than any other configured named color. /// /// @@ -209,11 +209,11 @@ public readonly partial record struct Color : ISpanParsable, IUtf8SpanPar /// . /// /// - /// The color to test against the value in + /// The color to test against the value in /// . /// /// - /// The to check if this is closer + /// The to check if this is closer /// to than any other configured named color. /// /// diff --git a/Terminal.Gui/Drawing/Color/ColorEventArgs.cs b/Terminal.Gui/Drawing/Color/ColorEventArgs.cs index 66361d503..8823a45bb 100644 --- a/Terminal.Gui/Drawing/Color/ColorEventArgs.cs +++ b/Terminal.Gui/Drawing/Color/ColorEventArgs.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drawing; /// Event arguments for the events. public class ColorEventArgs : EventArgs diff --git a/Terminal.Gui/Drawing/Color/ColorModel.cs b/Terminal.Gui/Drawing/Color/ColorModel.cs index e6d523611..6af865a9c 100644 --- a/Terminal.Gui/Drawing/Color/ColorModel.cs +++ b/Terminal.Gui/Drawing/Color/ColorModel.cs @@ -1,6 +1,6 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Describes away of modelling color e.g. Hue diff --git a/Terminal.Gui/Drawing/Color/ColorQuantizer.cs b/Terminal.Gui/Drawing/Color/ColorQuantizer.cs index ec6d102ea..b163d4f43 100644 --- a/Terminal.Gui/Drawing/Color/ColorQuantizer.cs +++ b/Terminal.Gui/Drawing/Color/ColorQuantizer.cs @@ -1,6 +1,6 @@ using System.Collections.Concurrent; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Translates colors in an image into a Palette of up to colors (typically 256). diff --git a/Terminal.Gui/Drawing/Color/ColorStrings.cs b/Terminal.Gui/Drawing/Color/ColorStrings.cs index f365bd871..705ea13e4 100644 --- a/Terminal.Gui/Drawing/Color/ColorStrings.cs +++ b/Terminal.Gui/Drawing/Color/ColorStrings.cs @@ -1,7 +1,7 @@ #nullable enable using System.Globalization; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Provides a mapping between and the W3C standard color name strings. diff --git a/Terminal.Gui/Drawing/Color/IColorDistance.cs b/Terminal.Gui/Drawing/Color/IColorDistance.cs index fb8dc3aa2..28ff6460a 100644 --- a/Terminal.Gui/Drawing/Color/IColorDistance.cs +++ b/Terminal.Gui/Drawing/Color/IColorDistance.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Interface for algorithms that compute the relative distance between pairs of colors. diff --git a/Terminal.Gui/Drawing/Color/IColorNameResolver.cs b/Terminal.Gui/Drawing/Color/IColorNameResolver.cs index cbbe70985..36881adb3 100644 --- a/Terminal.Gui/Drawing/Color/IColorNameResolver.cs +++ b/Terminal.Gui/Drawing/Color/IColorNameResolver.cs @@ -2,7 +2,7 @@ using System.Diagnostics.CodeAnalysis; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// When implemented by a class, allows mapping to diff --git a/Terminal.Gui/Drawing/Color/ICustomColorFormatter.cs b/Terminal.Gui/Drawing/Color/ICustomColorFormatter.cs index 553f3f0c2..425a02441 100644 --- a/Terminal.Gui/Drawing/Color/ICustomColorFormatter.cs +++ b/Terminal.Gui/Drawing/Color/ICustomColorFormatter.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// An interface to support custom formatting and parsing of values. public interface ICustomColorFormatter : IFormatProvider, ICustomFormatter diff --git a/Terminal.Gui/Drawing/Color/MultiStandardColorNameResolver.cs b/Terminal.Gui/Drawing/Color/MultiStandardColorNameResolver.cs index 40f5be1f8..d409950eb 100644 --- a/Terminal.Gui/Drawing/Color/MultiStandardColorNameResolver.cs +++ b/Terminal.Gui/Drawing/Color/MultiStandardColorNameResolver.cs @@ -5,7 +5,7 @@ using System.Collections.Immutable; using System.Diagnostics.CodeAnalysis; using System.Globalization; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Color name resolver prioritizing Standard (W3C+) colors with fallback to ANSI 4-bit (16) colors. diff --git a/Terminal.Gui/Drawing/Color/StandardColor.cs b/Terminal.Gui/Drawing/Color/StandardColor.cs index 21071b360..45d586a03 100644 --- a/Terminal.Gui/Drawing/Color/StandardColor.cs +++ b/Terminal.Gui/Drawing/Color/StandardColor.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Represents standard color names with their RGB values. Derived from the W3C color names, but includes other common diff --git a/Terminal.Gui/Drawing/Color/StandardColors.cs b/Terminal.Gui/Drawing/Color/StandardColors.cs index 02a829692..05adfdb30 100644 --- a/Terminal.Gui/Drawing/Color/StandardColors.cs +++ b/Terminal.Gui/Drawing/Color/StandardColors.cs @@ -3,7 +3,7 @@ using System.Collections.Frozen; using System.Collections.Immutable; using System.Diagnostics.CodeAnalysis; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Helper class for transforming to and from enum. diff --git a/Terminal.Gui/Drawing/Color/StandardColorsNameResolver.cs b/Terminal.Gui/Drawing/Color/StandardColorsNameResolver.cs index 8c582aeff..daae80b9e 100644 --- a/Terminal.Gui/Drawing/Color/StandardColorsNameResolver.cs +++ b/Terminal.Gui/Drawing/Color/StandardColorsNameResolver.cs @@ -2,7 +2,7 @@ using System.Diagnostics.CodeAnalysis; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Standard (W3C+) color name resolver. diff --git a/Terminal.Gui/Drawing/FillPair.cs b/Terminal.Gui/Drawing/FillPair.cs index d0ea12608..f282c15d4 100644 --- a/Terminal.Gui/Drawing/FillPair.cs +++ b/Terminal.Gui/Drawing/FillPair.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Describes a pair of which cooperate in creating diff --git a/Terminal.Gui/Drawing/Glyphs.cs b/Terminal.Gui/Drawing/Glyphs.cs index e429e6aa0..984366462 100644 --- a/Terminal.Gui/Drawing/Glyphs.cs +++ b/Terminal.Gui/Drawing/Glyphs.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drawing; /// Defines the standard set of glyphs used to draw checkboxes, lines, borders, etc... /// diff --git a/Terminal.Gui/Drawing/Gradient.cs b/Terminal.Gui/Drawing/Gradient.cs index 3b41e3e49..1ff4a69cf 100644 --- a/Terminal.Gui/Drawing/Gradient.cs +++ b/Terminal.Gui/Drawing/Gradient.cs @@ -1,6 +1,6 @@ // This code is a C# port from python library Terminal Text Effects https://github.com/ChrisBuilds/terminaltexteffects/ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Describes the pattern that a results in e.g. , diff --git a/Terminal.Gui/Drawing/GradientFill.cs b/Terminal.Gui/Drawing/GradientFill.cs index 6518d2dab..87cfabfaf 100644 --- a/Terminal.Gui/Drawing/GradientFill.cs +++ b/Terminal.Gui/Drawing/GradientFill.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Implementation of that uses a color gradient (including diff --git a/Terminal.Gui/Drawing/IFill.cs b/Terminal.Gui/Drawing/IFill.cs index 7d1d19a68..e619d2379 100644 --- a/Terminal.Gui/Drawing/IFill.cs +++ b/Terminal.Gui/Drawing/IFill.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Describes an area fill (e.g. solid color or gradient). diff --git a/Terminal.Gui/Drawing/LineCanvas/IntersectionDefinition.cs b/Terminal.Gui/Drawing/LineCanvas/IntersectionDefinition.cs index d7f668aa1..a03f8bca8 100644 --- a/Terminal.Gui/Drawing/LineCanvas/IntersectionDefinition.cs +++ b/Terminal.Gui/Drawing/LineCanvas/IntersectionDefinition.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; internal class IntersectionDefinition { diff --git a/Terminal.Gui/Drawing/LineCanvas/IntersectionRuneType.cs b/Terminal.Gui/Drawing/LineCanvas/IntersectionRuneType.cs index 467b8ff5b..b32310fa7 100644 --- a/Terminal.Gui/Drawing/LineCanvas/IntersectionRuneType.cs +++ b/Terminal.Gui/Drawing/LineCanvas/IntersectionRuneType.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// The type of Rune that we will use before considering double width, curved borders etc internal enum IntersectionRuneType diff --git a/Terminal.Gui/Drawing/LineCanvas/IntersectionType.cs b/Terminal.Gui/Drawing/LineCanvas/IntersectionType.cs index 158e9ee8e..87a051e55 100644 --- a/Terminal.Gui/Drawing/LineCanvas/IntersectionType.cs +++ b/Terminal.Gui/Drawing/LineCanvas/IntersectionType.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; internal enum IntersectionType { diff --git a/Terminal.Gui/Drawing/LineCanvas/LineCanvas.cs b/Terminal.Gui/Drawing/LineCanvas/LineCanvas.cs index 7a7b8e309..672c24830 100644 --- a/Terminal.Gui/Drawing/LineCanvas/LineCanvas.cs +++ b/Terminal.Gui/Drawing/LineCanvas/LineCanvas.cs @@ -1,8 +1,8 @@ #nullable enable -using System.Buffers; + using System.Runtime.InteropServices; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// Facilitates box drawing and line intersection detection and rendering. Does not support diagonal lines. public class LineCanvas : IDisposable diff --git a/Terminal.Gui/Drawing/LineCanvas/LineStyle.cs b/Terminal.Gui/Drawing/LineCanvas/LineStyle.cs index fb56fccfd..9c8f234fe 100644 --- a/Terminal.Gui/Drawing/LineCanvas/LineStyle.cs +++ b/Terminal.Gui/Drawing/LineCanvas/LineStyle.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// Defines the style of lines for a . [JsonConverter (typeof (JsonStringEnumConverter))] diff --git a/Terminal.Gui/Drawing/LineCanvas/StraightLine.cs b/Terminal.Gui/Drawing/LineCanvas/StraightLine.cs index c2b1e034b..5e64c0b7a 100644 --- a/Terminal.Gui/Drawing/LineCanvas/StraightLine.cs +++ b/Terminal.Gui/Drawing/LineCanvas/StraightLine.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Drawing; #nullable enable // TODO: Add events that notify when StraightLine changes to enable dynamic layout diff --git a/Terminal.Gui/Drawing/LineCanvas/StraightLineExtensions.cs b/Terminal.Gui/Drawing/LineCanvas/StraightLineExtensions.cs index a931f2bfa..1cff548ae 100644 --- a/Terminal.Gui/Drawing/LineCanvas/StraightLineExtensions.cs +++ b/Terminal.Gui/Drawing/LineCanvas/StraightLineExtensions.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Drawing; /// Extension methods for (including collections). public static class StraightLineExtensions diff --git a/Terminal.Gui/Drawing/Quant/EuclideanColorDistance.cs b/Terminal.Gui/Drawing/Quant/EuclideanColorDistance.cs index 935d59826..93e4b1cff 100644 --- a/Terminal.Gui/Drawing/Quant/EuclideanColorDistance.cs +++ b/Terminal.Gui/Drawing/Quant/EuclideanColorDistance.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// diff --git a/Terminal.Gui/Drawing/Quant/IPaletteBuilder.cs b/Terminal.Gui/Drawing/Quant/IPaletteBuilder.cs index 232842d99..df6555f72 100644 --- a/Terminal.Gui/Drawing/Quant/IPaletteBuilder.cs +++ b/Terminal.Gui/Drawing/Quant/IPaletteBuilder.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Builds a palette of a given size for a given set of input colors. diff --git a/Terminal.Gui/Drawing/Quant/PopularityPaletteWithThreshold.cs b/Terminal.Gui/Drawing/Quant/PopularityPaletteWithThreshold.cs index 86bbed404..0e7f53596 100644 --- a/Terminal.Gui/Drawing/Quant/PopularityPaletteWithThreshold.cs +++ b/Terminal.Gui/Drawing/Quant/PopularityPaletteWithThreshold.cs @@ -1,6 +1,4 @@ -using Terminal.Gui; -using Color = Terminal.Gui.Color; - + /// /// Simple fast palette building algorithm which uses the frequency that a color is seen /// to determine whether it will appear in the final palette. Includes a threshold where diff --git a/Terminal.Gui/Drawing/Region.cs b/Terminal.Gui/Drawing/Region.cs index 1cfea8638..f3abb8e07 100644 --- a/Terminal.Gui/Drawing/Region.cs +++ b/Terminal.Gui/Drawing/Region.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drawing; /// /// Represents a region composed of one or more rectangles, providing methods for geometric set operations such as diff --git a/Terminal.Gui/Drawing/RegionOp.cs b/Terminal.Gui/Drawing/RegionOp.cs index 9bf31f285..e40de1663 100644 --- a/Terminal.Gui/Drawing/RegionOp.cs +++ b/Terminal.Gui/Drawing/RegionOp.cs @@ -1,6 +1,6 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Specifies the operation to perform when combining two regions or a with a diff --git a/Terminal.Gui/Drawing/Ruler.cs b/Terminal.Gui/Drawing/Ruler.cs index 1eea7f263..258ce8c12 100644 --- a/Terminal.Gui/Drawing/Ruler.cs +++ b/Terminal.Gui/Drawing/Ruler.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drawing; /// Draws a ruler on the screen. /// diff --git a/Terminal.Gui/Drawing/Scheme.cs b/Terminal.Gui/Drawing/Scheme.cs index a01149be4..acbc699cc 100644 --- a/Terminal.Gui/Drawing/Scheme.cs +++ b/Terminal.Gui/Drawing/Scheme.cs @@ -3,7 +3,7 @@ using System.Collections.Immutable; using System.Numerics; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Represents a theme definition that maps each (such as , diff --git a/Terminal.Gui/View/SchemeEventArgs.cs b/Terminal.Gui/Drawing/SchemeEventArgs.cs similarity index 95% rename from Terminal.Gui/View/SchemeEventArgs.cs rename to Terminal.Gui/Drawing/SchemeEventArgs.cs index f9b7f952f..e9546cafb 100644 --- a/Terminal.Gui/View/SchemeEventArgs.cs +++ b/Terminal.Gui/Drawing/SchemeEventArgs.cs @@ -1,7 +1,7 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// Event args for draw events public class SchemeEventArgs : CancelEventArgs diff --git a/Terminal.Gui/Drawing/Schemes.cs b/Terminal.Gui/Drawing/Schemes.cs index ffcdce4a6..5408f6b8c 100644 --- a/Terminal.Gui/Drawing/Schemes.cs +++ b/Terminal.Gui/Drawing/Schemes.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; // ReSharper disable InconsistentNaming /// diff --git a/Terminal.Gui/Drawing/Sixel/SixelEncoder.cs b/Terminal.Gui/Drawing/Sixel/SixelEncoder.cs index 22e205c7d..1beab914a 100644 --- a/Terminal.Gui/Drawing/Sixel/SixelEncoder.cs +++ b/Terminal.Gui/Drawing/Sixel/SixelEncoder.cs @@ -4,7 +4,7 @@ // libsixel (C/C++) - https://github.com/saitoha/libsixel // Copyright (c) 2014-2016 Hayaki Saito @license MIT -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Encodes a images into the sixel console image output format. diff --git a/Terminal.Gui/Drawing/Sixel/SixelSupportDetector.cs b/Terminal.Gui/Drawing/Sixel/SixelSupportDetector.cs index d0135fcde..2ee0ee8fa 100644 --- a/Terminal.Gui/Drawing/Sixel/SixelSupportDetector.cs +++ b/Terminal.Gui/Drawing/Sixel/SixelSupportDetector.cs @@ -1,6 +1,6 @@ using System.Text.RegularExpressions; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Uses Ansi escape sequences to detect whether sixel is supported diff --git a/Terminal.Gui/Drawing/Sixel/SixelSupportResult.cs b/Terminal.Gui/Drawing/Sixel/SixelSupportResult.cs index ddd182b4d..b1037d82f 100644 --- a/Terminal.Gui/Drawing/Sixel/SixelSupportResult.cs +++ b/Terminal.Gui/Drawing/Sixel/SixelSupportResult.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Describes the discovered state of sixel support and ancillary information diff --git a/Terminal.Gui/Drawing/Sixel/SixelToRender.cs b/Terminal.Gui/Drawing/Sixel/SixelToRender.cs index f9981f19f..a2a3e9bb7 100644 --- a/Terminal.Gui/Drawing/Sixel/SixelToRender.cs +++ b/Terminal.Gui/Drawing/Sixel/SixelToRender.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Describes a request to render a given at a given . diff --git a/Terminal.Gui/Drawing/SolidFill.cs b/Terminal.Gui/Drawing/SolidFill.cs index 2619f67ea..70c549608 100644 --- a/Terminal.Gui/Drawing/SolidFill.cs +++ b/Terminal.Gui/Drawing/SolidFill.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// implementation that uses a solid color for all points diff --git a/Terminal.Gui/Drawing/TextStyle.cs b/Terminal.Gui/Drawing/TextStyle.cs index 204b7ee80..5eee94558 100644 --- a/Terminal.Gui/Drawing/TextStyle.cs +++ b/Terminal.Gui/Drawing/TextStyle.cs @@ -1,6 +1,6 @@ using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Defines non-color style flags for an . diff --git a/Terminal.Gui/Drawing/Thickness.cs b/Terminal.Gui/Drawing/Thickness.cs index ed73b3913..b8690a060 100644 --- a/Terminal.Gui/Drawing/Thickness.cs +++ b/Terminal.Gui/Drawing/Thickness.cs @@ -2,7 +2,7 @@ using System.Numerics; using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Describes the thickness of a frame around a rectangle. Four values describe the diff --git a/Terminal.Gui/Drawing/VisualRole.cs b/Terminal.Gui/Drawing/VisualRole.cs index 8286e1e4b..661c3fc9b 100644 --- a/Terminal.Gui/Drawing/VisualRole.cs +++ b/Terminal.Gui/Drawing/VisualRole.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drawing; /// /// Represents the semantic visual role of a visual element rendered by a . Each VisualRole maps to diff --git a/Terminal.Gui/Drawing/VisualRoleEventArgs.cs b/Terminal.Gui/Drawing/VisualRoleEventArgs.cs index 52be6055f..62659de0a 100644 --- a/Terminal.Gui/Drawing/VisualRoleEventArgs.cs +++ b/Terminal.Gui/Drawing/VisualRoleEventArgs.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drawing; /// Args for events that relate . public class VisualRoleEventArgs : CancelEventArgs diff --git a/Terminal.Gui/ConsoleDrivers/AnsiEscapeSequence.cs b/Terminal.Gui/Drivers/AnsiEscapeSequence.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/AnsiEscapeSequence.cs rename to Terminal.Gui/Drivers/AnsiEscapeSequence.cs index 40b891c73..5b0471776 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiEscapeSequence.cs +++ b/Terminal.Gui/Drivers/AnsiEscapeSequence.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Describes an Ansi escape sequence. This is a 'blueprint'. If you diff --git a/Terminal.Gui/ConsoleDrivers/AnsiEscapeSequenceRequest.cs b/Terminal.Gui/Drivers/AnsiEscapeSequenceRequest.cs similarity index 97% rename from Terminal.Gui/ConsoleDrivers/AnsiEscapeSequenceRequest.cs rename to Terminal.Gui/Drivers/AnsiEscapeSequenceRequest.cs index 3bffbbb7c..0bdc82ca9 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiEscapeSequenceRequest.cs +++ b/Terminal.Gui/Drivers/AnsiEscapeSequenceRequest.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; /// /// Describes an ongoing ANSI request sent to the console. diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiMouseParser.cs b/Terminal.Gui/Drivers/AnsiResponseParser/AnsiMouseParser.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiMouseParser.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/AnsiMouseParser.cs index 76d141c27..7f3f82709 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiMouseParser.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/AnsiMouseParser.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.RegularExpressions; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Parses mouse ansi escape sequences into diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiRequestScheduler.cs b/Terminal.Gui/Drivers/AnsiResponseParser/AnsiRequestScheduler.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiRequestScheduler.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/AnsiRequestScheduler.cs index 6b30b3d10..3f20af735 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiRequestScheduler.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/AnsiRequestScheduler.cs @@ -1,7 +1,7 @@ #nullable enable using System.Collections.Concurrent; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Manages made to an . diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiResponseExpectation.cs b/Terminal.Gui/Drivers/AnsiResponseParser/AnsiResponseExpectation.cs similarity index 86% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiResponseExpectation.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/AnsiResponseExpectation.cs index c66f11183..fd087de75 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiResponseExpectation.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/AnsiResponseExpectation.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal record AnsiResponseExpectation (string? Terminator, Action Response, Action? Abandoned) { diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiResponseParser.cs b/Terminal.Gui/Drivers/AnsiResponseParser/AnsiResponseParser.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiResponseParser.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/AnsiResponseParser.cs index 4c6656de8..0c4d5d3ba 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiResponseParser.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/AnsiResponseParser.cs @@ -2,7 +2,7 @@ using Microsoft.Extensions.Logging; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal abstract class AnsiResponseParserBase : IAnsiResponseParser { diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiResponseParserState.cs b/Terminal.Gui/Drivers/AnsiResponseParser/AnsiResponseParserState.cs similarity index 95% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiResponseParserState.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/AnsiResponseParserState.cs index a28050f64..41f0912c1 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiResponseParserState.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/AnsiResponseParserState.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Describes the current state of an diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/GenericHeld.cs b/Terminal.Gui/Drivers/AnsiResponseParser/GenericHeld.cs similarity index 95% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/GenericHeld.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/GenericHeld.cs index a89808803..79933472e 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/GenericHeld.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/GenericHeld.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Implementation of for diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/IAnsiResponseParser.cs b/Terminal.Gui/Drivers/AnsiResponseParser/IAnsiResponseParser.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/IAnsiResponseParser.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/IAnsiResponseParser.cs index 4663bd6be..cfdb775f0 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/IAnsiResponseParser.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/IAnsiResponseParser.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// When implemented in a derived class, allows watching an input stream of characters diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/IHeld.cs b/Terminal.Gui/Drivers/AnsiResponseParser/IHeld.cs similarity index 96% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/IHeld.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/IHeld.cs index ab18ef16e..369ef4732 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/IHeld.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/IHeld.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Describes a sequence of chars (and optionally T metadata) accumulated diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/AnsiKeyboardParser.cs b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/AnsiKeyboardParser.cs similarity index 96% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/AnsiKeyboardParser.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/AnsiKeyboardParser.cs index 42aa368e7..ee41d6cca 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/AnsiKeyboardParser.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/AnsiKeyboardParser.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Parses ANSI escape sequence strings that describe keyboard activity into . diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/AnsiKeyboardParserPattern.cs b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/AnsiKeyboardParserPattern.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/AnsiKeyboardParserPattern.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/AnsiKeyboardParserPattern.cs index 7ad36019c..62b0acb64 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/AnsiKeyboardParserPattern.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/AnsiKeyboardParserPattern.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; /// /// Base class for ANSI keyboard parsing patterns. diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/CsiCursorPattern.cs b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/CsiCursorPattern.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/CsiCursorPattern.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/CsiCursorPattern.cs index 9d0fac963..0255e7394 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/CsiCursorPattern.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/CsiCursorPattern.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.RegularExpressions; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Detects ansi escape sequences in strings that have been read from diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/CsiKeyPattern.cs b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/CsiKeyPattern.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/CsiKeyPattern.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/CsiKeyPattern.cs index d70d42da1..f0fb3b20b 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/CsiKeyPattern.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/CsiKeyPattern.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.RegularExpressions; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Detects ansi escape sequences in strings that have been read from diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/EscAsAltPattern.cs b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/EscAsAltPattern.cs similarity index 95% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/EscAsAltPattern.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/EscAsAltPattern.cs index 829bbb88e..1db3e8757 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/EscAsAltPattern.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/EscAsAltPattern.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.RegularExpressions; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal class EscAsAltPattern : AnsiKeyboardParserPattern { diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/Ss3Pattern.cs b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/Ss3Pattern.cs similarity index 97% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/Ss3Pattern.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/Ss3Pattern.cs index 1b8535405..ffb82fc09 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/Keyboard/Ss3Pattern.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/Keyboard/Ss3Pattern.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.RegularExpressions; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Parser for SS3 terminal escape sequences. These describe specific keys e.g. diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/ReasonCannotSend.cs b/Terminal.Gui/Drivers/AnsiResponseParser/ReasonCannotSend.cs similarity index 94% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/ReasonCannotSend.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/ReasonCannotSend.cs index c2e31a6c3..675c9ff64 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/ReasonCannotSend.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/ReasonCannotSend.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal enum ReasonCannotSend { diff --git a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/StringHeld.cs b/Terminal.Gui/Drivers/AnsiResponseParser/StringHeld.cs similarity index 94% rename from Terminal.Gui/ConsoleDrivers/AnsiResponseParser/StringHeld.cs rename to Terminal.Gui/Drivers/AnsiResponseParser/StringHeld.cs index 55a25d9bc..3202410ab 100644 --- a/Terminal.Gui/ConsoleDrivers/AnsiResponseParser/StringHeld.cs +++ b/Terminal.Gui/Drivers/AnsiResponseParser/StringHeld.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Implementation of for diff --git a/Terminal.Gui/ConsoleDrivers/ConsoleDriver.cs b/Terminal.Gui/Drivers/ConsoleDriver.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/ConsoleDriver.cs rename to Terminal.Gui/Drivers/ConsoleDriver.cs index 5f17707ff..cf85db80c 100644 --- a/Terminal.Gui/ConsoleDrivers/ConsoleDriver.cs +++ b/Terminal.Gui/Drivers/ConsoleDriver.cs @@ -2,7 +2,7 @@ using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// Base class for Terminal.Gui IConsoleDriver implementations. /// diff --git a/Terminal.Gui/ConsoleDrivers/ConsoleKeyMapping.cs b/Terminal.Gui/Drivers/ConsoleKeyMapping.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/ConsoleKeyMapping.cs rename to Terminal.Gui/Drivers/ConsoleKeyMapping.cs index a57efa5be..8e9964147 100644 --- a/Terminal.Gui/ConsoleDrivers/ConsoleKeyMapping.cs +++ b/Terminal.Gui/Drivers/ConsoleKeyMapping.cs @@ -1,7 +1,7 @@ using System.Globalization; using System.Runtime.InteropServices; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; // QUESTION: This class combines Windows specific code with cross-platform code. Should this be split into two classes? /// Helper class to handle the scan code and virtual key from a . diff --git a/Terminal.Gui/ConsoleDrivers/CursesDriver/ClipboardImpl.cs b/Terminal.Gui/Drivers/CursesDriver/ClipboardImpl.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/CursesDriver/ClipboardImpl.cs rename to Terminal.Gui/Drivers/CursesDriver/ClipboardImpl.cs index 85f9cd88c..057d9b700 100644 --- a/Terminal.Gui/ConsoleDrivers/CursesDriver/ClipboardImpl.cs +++ b/Terminal.Gui/Drivers/CursesDriver/ClipboardImpl.cs @@ -1,7 +1,7 @@ using System.Runtime.InteropServices; using Unix.Terminal; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// A clipboard implementation for Linux. This implementation uses the xclip command to access the clipboard. /// If xclip is not installed, this implementation will not work. diff --git a/Terminal.Gui/ConsoleDrivers/CursesDriver/CursesDriver.cs b/Terminal.Gui/Drivers/CursesDriver/CursesDriver.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/CursesDriver/CursesDriver.cs rename to Terminal.Gui/Drivers/CursesDriver/CursesDriver.cs index bdca5ac79..350697d58 100644 --- a/Terminal.Gui/ConsoleDrivers/CursesDriver/CursesDriver.cs +++ b/Terminal.Gui/Drivers/CursesDriver/CursesDriver.cs @@ -6,7 +6,7 @@ using System.Runtime.InteropServices; using Unix.Terminal; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// A Linux/Mac driver based on the Curses library. internal class CursesDriver : ConsoleDriver diff --git a/Terminal.Gui/ConsoleDrivers/CursesDriver/README.md b/Terminal.Gui/Drivers/CursesDriver/README.md similarity index 100% rename from Terminal.Gui/ConsoleDrivers/CursesDriver/README.md rename to Terminal.Gui/Drivers/CursesDriver/README.md diff --git a/Terminal.Gui/ConsoleDrivers/CursesDriver/UnixMainLoop.cs b/Terminal.Gui/Drivers/CursesDriver/UnixMainLoop.cs similarity index 97% rename from Terminal.Gui/ConsoleDrivers/CursesDriver/UnixMainLoop.cs rename to Terminal.Gui/Drivers/CursesDriver/UnixMainLoop.cs index cb6a0f5d1..c3486e702 100644 --- a/Terminal.Gui/ConsoleDrivers/CursesDriver/UnixMainLoop.cs +++ b/Terminal.Gui/Drivers/CursesDriver/UnixMainLoop.cs @@ -4,8 +4,10 @@ // using System.Runtime.InteropServices; +using IMainLoopDriver = Terminal.Gui.App.IMainLoopDriver; +using MainLoop = Terminal.Gui.App.MainLoop; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// Unix main loop, suitable for using on Posix systems /// @@ -16,7 +18,7 @@ internal class UnixMainLoop : IMainLoopDriver { /// Condition on which to wake up from file descriptor activity. These match the Linux/BSD poll definitions. [Flags] - public enum Condition : short + internal enum Condition : short { /// There is data to read PollIn = 1, diff --git a/Terminal.Gui/ConsoleDrivers/CursesDriver/UnmanagedLibrary.cs b/Terminal.Gui/Drivers/CursesDriver/UnmanagedLibrary.cs similarity index 100% rename from Terminal.Gui/ConsoleDrivers/CursesDriver/UnmanagedLibrary.cs rename to Terminal.Gui/Drivers/CursesDriver/UnmanagedLibrary.cs diff --git a/Terminal.Gui/ConsoleDrivers/CursesDriver/binding.cs b/Terminal.Gui/Drivers/CursesDriver/binding.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/CursesDriver/binding.cs rename to Terminal.Gui/Drivers/CursesDriver/binding.cs index 16caaa05c..9f56488b4 100644 --- a/Terminal.Gui/ConsoleDrivers/CursesDriver/binding.cs +++ b/Terminal.Gui/Drivers/CursesDriver/binding.cs @@ -43,12 +43,11 @@ // using System.Runtime.InteropServices; -using Terminal.Gui; namespace Unix.Terminal; #pragma warning disable CS1591 // Missing XML comment for publicly visible type or member -public partial class Curses +internal partial class Curses { // We encode ESC + char (what Alt-char generates) as 0x2000 + char public const int KeyAlt = 0x2000; @@ -425,7 +424,7 @@ public partial class Curses //}; [StructLayout (LayoutKind.Sequential)] - public struct MouseEvent + internal struct MouseEvent { public short ID; public int X, Y, Z; diff --git a/Terminal.Gui/ConsoleDrivers/CursesDriver/constants.cs b/Terminal.Gui/Drivers/CursesDriver/constants.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/CursesDriver/constants.cs rename to Terminal.Gui/Drivers/CursesDriver/constants.cs index 5700b779f..108d1087f 100644 --- a/Terminal.Gui/ConsoleDrivers/CursesDriver/constants.cs +++ b/Terminal.Gui/Drivers/CursesDriver/constants.cs @@ -8,7 +8,7 @@ using System.Runtime.InteropServices; namespace Unix.Terminal; #pragma warning disable CS1591 // Missing XML comment for publicly visible type or member -public partial class Curses +internal partial class Curses { public const int A_NORMAL = 0x0; public const int A_STANDOUT = 0x10000; @@ -58,7 +58,7 @@ public partial class Curses public const int TIOCGWINSZ = 0x5413; public const int TIOCGWINSZ_MAC = 0x40087468; [Flags] - public enum Event : long + internal enum Event : long { Button1Pressed = 0x2, Button1Released = 0x1, diff --git a/Terminal.Gui/ConsoleDrivers/CursesDriver/handles.cs b/Terminal.Gui/Drivers/CursesDriver/handles.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/CursesDriver/handles.cs rename to Terminal.Gui/Drivers/CursesDriver/handles.cs index c1fc7da64..376dec825 100644 --- a/Terminal.Gui/ConsoleDrivers/CursesDriver/handles.cs +++ b/Terminal.Gui/Drivers/CursesDriver/handles.cs @@ -28,9 +28,9 @@ namespace Unix.Terminal; #pragma warning disable CS1591 // Missing XML comment for publicly visible type or member -public partial class Curses +internal partial class Curses { - public class Window + internal class Window { public readonly nint Handle; diff --git a/Terminal.Gui/ConsoleDrivers/CursorVisibility.cs b/Terminal.Gui/Drivers/CursorVisibility.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/CursorVisibility.cs rename to Terminal.Gui/Drivers/CursorVisibility.cs index b96d31fd4..ca86e9a0a 100644 --- a/Terminal.Gui/ConsoleDrivers/CursorVisibility.cs +++ b/Terminal.Gui/Drivers/CursorVisibility.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// Terminal Cursor Visibility settings. /// diff --git a/Terminal.Gui/ConsoleDrivers/EscSeqUtils/EscSeqReqStatus.cs b/Terminal.Gui/Drivers/EscSeqUtils/EscSeqReqStatus.cs similarity index 96% rename from Terminal.Gui/ConsoleDrivers/EscSeqUtils/EscSeqReqStatus.cs rename to Terminal.Gui/Drivers/EscSeqUtils/EscSeqReqStatus.cs index d832f0659..ab062e253 100644 --- a/Terminal.Gui/ConsoleDrivers/EscSeqUtils/EscSeqReqStatus.cs +++ b/Terminal.Gui/Drivers/EscSeqUtils/EscSeqReqStatus.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Represents the status of an ANSI escape sequence request made to the terminal using diff --git a/Terminal.Gui/ConsoleDrivers/EscSeqUtils/EscSeqRequests.cs b/Terminal.Gui/Drivers/EscSeqUtils/EscSeqRequests.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/EscSeqUtils/EscSeqRequests.cs rename to Terminal.Gui/Drivers/EscSeqUtils/EscSeqRequests.cs index 579aa0cd9..6e69f6a12 100644 --- a/Terminal.Gui/ConsoleDrivers/EscSeqUtils/EscSeqRequests.cs +++ b/Terminal.Gui/Drivers/EscSeqUtils/EscSeqRequests.cs @@ -1,6 +1,6 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Manages ANSI Escape Sequence requests and responses. The list of diff --git a/Terminal.Gui/ConsoleDrivers/EscSeqUtils/EscSeqUtils.cs b/Terminal.Gui/Drivers/EscSeqUtils/EscSeqUtils.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/EscSeqUtils/EscSeqUtils.cs rename to Terminal.Gui/Drivers/EscSeqUtils/EscSeqUtils.cs index 8bd54b275..b035a2335 100644 --- a/Terminal.Gui/ConsoleDrivers/EscSeqUtils/EscSeqUtils.cs +++ b/Terminal.Gui/Drivers/EscSeqUtils/EscSeqUtils.cs @@ -1,7 +1,7 @@ #nullable enable using System.Globalization; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; // QUESTION: Should this class be refactored into separate classes for: // QUESTION: CSI definitions diff --git a/Terminal.Gui/ConsoleDrivers/FakeDriver/FakeConsole.cs b/Terminal.Gui/Drivers/FakeDriver/FakeConsole.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/FakeDriver/FakeConsole.cs rename to Terminal.Gui/Drivers/FakeDriver/FakeConsole.cs index cea3367ec..9eb566768 100644 --- a/Terminal.Gui/ConsoleDrivers/FakeDriver/FakeConsole.cs +++ b/Terminal.Gui/Drivers/FakeDriver/FakeConsole.cs @@ -2,7 +2,7 @@ // FakeConsole.cs: A fake .NET Windows Console API implementation for unit tests. // -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; #pragma warning disable RCS1138 // Add summary to documentation comment. /// diff --git a/Terminal.Gui/ConsoleDrivers/FakeDriver/FakeDriver.cs b/Terminal.Gui/Drivers/FakeDriver/FakeDriver.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/FakeDriver/FakeDriver.cs rename to Terminal.Gui/Drivers/FakeDriver/FakeDriver.cs index 5c4872ae4..d10d48f92 100644 --- a/Terminal.Gui/ConsoleDrivers/FakeDriver/FakeDriver.cs +++ b/Terminal.Gui/Drivers/FakeDriver/FakeDriver.cs @@ -7,7 +7,7 @@ using System.Runtime.InteropServices; // Alias Console to MockConsole so we don't accidentally use Console -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// Implements a mock IConsoleDriver for unit testing public class FakeDriver : ConsoleDriver diff --git a/Terminal.Gui/ConsoleDrivers/FakeDriver/FakeMainLoop.cs b/Terminal.Gui/Drivers/FakeDriver/FakeMainLoop.cs similarity index 95% rename from Terminal.Gui/ConsoleDrivers/FakeDriver/FakeMainLoop.cs rename to Terminal.Gui/Drivers/FakeDriver/FakeMainLoop.cs index 6b6789fc4..d9d918031 100644 --- a/Terminal.Gui/ConsoleDrivers/FakeDriver/FakeMainLoop.cs +++ b/Terminal.Gui/Drivers/FakeDriver/FakeMainLoop.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; internal class FakeMainLoop : IMainLoopDriver { diff --git a/Terminal.Gui/ConsoleDrivers/IConsoleDriver.cs b/Terminal.Gui/Drivers/IConsoleDriver.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/IConsoleDriver.cs rename to Terminal.Gui/Drivers/IConsoleDriver.cs index a661b8439..a88850c3d 100644 --- a/Terminal.Gui/ConsoleDrivers/IConsoleDriver.cs +++ b/Terminal.Gui/Drivers/IConsoleDriver.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; /// Base interface for Terminal.Gui ConsoleDriver implementations. /// @@ -70,7 +71,7 @@ public interface IConsoleDriver bool Force16Colors { get; set; } /// - /// The that will be used for the next or + /// The that will be used for the next or /// call. /// Attribute CurrentAttribute { get; set; } diff --git a/Terminal.Gui/ConsoleDrivers/KeyCode.cs b/Terminal.Gui/Drivers/KeyCode.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/KeyCode.cs rename to Terminal.Gui/Drivers/KeyCode.cs index 2a89667ea..85924cb5f 100644 --- a/Terminal.Gui/ConsoleDrivers/KeyCode.cs +++ b/Terminal.Gui/Drivers/KeyCode.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// The enumeration encodes key information from s and provides a diff --git a/Terminal.Gui/ConsoleDrivers/NetDriver/NetDriver.cs b/Terminal.Gui/Drivers/NetDriver/NetDriver.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/NetDriver/NetDriver.cs rename to Terminal.Gui/Drivers/NetDriver/NetDriver.cs index 59d75b581..e3b8760c3 100644 --- a/Terminal.Gui/ConsoleDrivers/NetDriver/NetDriver.cs +++ b/Terminal.Gui/Drivers/NetDriver/NetDriver.cs @@ -7,9 +7,9 @@ using System.Collections.Concurrent; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Runtime.InteropServices; -using static Terminal.Gui.NetEvents; +using static Terminal.Gui.Drivers.NetEvents; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal class NetDriver : ConsoleDriver { diff --git a/Terminal.Gui/ConsoleDrivers/NetDriver/NetEvents.cs b/Terminal.Gui/Drivers/NetDriver/NetEvents.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/NetDriver/NetEvents.cs rename to Terminal.Gui/Drivers/NetDriver/NetEvents.cs index c19c5e1be..4a7e66269 100644 --- a/Terminal.Gui/ConsoleDrivers/NetDriver/NetEvents.cs +++ b/Terminal.Gui/Drivers/NetDriver/NetEvents.cs @@ -2,7 +2,7 @@ using System.Collections.Concurrent; using System.Diagnostics.CodeAnalysis; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal class NetEvents : IDisposable { diff --git a/Terminal.Gui/ConsoleDrivers/NetDriver/NetMainLoop.cs b/Terminal.Gui/Drivers/NetDriver/NetMainLoop.cs similarity index 97% rename from Terminal.Gui/ConsoleDrivers/NetDriver/NetMainLoop.cs rename to Terminal.Gui/Drivers/NetDriver/NetMainLoop.cs index cf5ee0e76..b33964be4 100644 --- a/Terminal.Gui/ConsoleDrivers/NetDriver/NetMainLoop.cs +++ b/Terminal.Gui/Drivers/NetDriver/NetMainLoop.cs @@ -1,8 +1,10 @@ #nullable enable using System.Collections.Concurrent; +using IMainLoopDriver = Terminal.Gui.App.IMainLoopDriver; +using MainLoop = Terminal.Gui.App.MainLoop; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Mainloop intended to be used with the .NET System.Console API, and can be used on Windows and Unix, it is diff --git a/Terminal.Gui/ConsoleDrivers/NetDriver/NetWinVTConsole.cs b/Terminal.Gui/Drivers/NetDriver/NetWinVTConsole.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/NetDriver/NetWinVTConsole.cs rename to Terminal.Gui/Drivers/NetDriver/NetWinVTConsole.cs index 98666f460..4750a32e8 100644 --- a/Terminal.Gui/ConsoleDrivers/NetDriver/NetWinVTConsole.cs +++ b/Terminal.Gui/Drivers/NetDriver/NetWinVTConsole.cs @@ -1,7 +1,7 @@ #nullable enable using System.Runtime.InteropServices; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal class NetWinVTConsole { diff --git a/Terminal.Gui/ConsoleDrivers/V2/ApplicationV2.cs b/Terminal.Gui/Drivers/V2/ApplicationV2.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/V2/ApplicationV2.cs rename to Terminal.Gui/Drivers/V2/ApplicationV2.cs index ba72a16db..e10a621b7 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/ApplicationV2.cs +++ b/Terminal.Gui/Drivers/V2/ApplicationV2.cs @@ -4,7 +4,7 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using Microsoft.Extensions.Logging; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Implementation of that boots the new 'v2' diff --git a/Terminal.Gui/ConsoleDrivers/V2/ConsoleDriverFacade.cs b/Terminal.Gui/Drivers/V2/ConsoleDriverFacade.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/V2/ConsoleDriverFacade.cs rename to Terminal.Gui/Drivers/V2/ConsoleDriverFacade.cs index e3c88aeab..ea695008a 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/ConsoleDriverFacade.cs +++ b/Terminal.Gui/Drivers/V2/ConsoleDriverFacade.cs @@ -1,7 +1,7 @@ using System.Runtime.InteropServices; using Microsoft.Extensions.Logging; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal class ConsoleDriverFacade : IConsoleDriver, IConsoleDriverFacade { @@ -153,7 +153,7 @@ internal class ConsoleDriverFacade : IConsoleDriver, IConsoleDriverFacade } /// - /// The that will be used for the next or + /// The that will be used for the next or /// call. /// public Attribute CurrentAttribute diff --git a/Terminal.Gui/ConsoleDrivers/V2/ConsoleInput.cs b/Terminal.Gui/Drivers/V2/ConsoleInput.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/V2/ConsoleInput.cs rename to Terminal.Gui/Drivers/V2/ConsoleInput.cs index d3ddbbd02..981f2de9e 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/ConsoleInput.cs +++ b/Terminal.Gui/Drivers/V2/ConsoleInput.cs @@ -1,7 +1,7 @@ #nullable enable using System.Collections.Concurrent; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Base class for reading console input in perpetual loop diff --git a/Terminal.Gui/ConsoleDrivers/V2/IConsoleDriverFacade.cs b/Terminal.Gui/Drivers/V2/IConsoleDriverFacade.cs similarity index 92% rename from Terminal.Gui/ConsoleDrivers/V2/IConsoleDriverFacade.cs rename to Terminal.Gui/Drivers/V2/IConsoleDriverFacade.cs index 6d316e6f2..2bebf3c9b 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/IConsoleDriverFacade.cs +++ b/Terminal.Gui/Drivers/V2/IConsoleDriverFacade.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Interface for v2 driver abstraction layer diff --git a/Terminal.Gui/ConsoleDrivers/V2/IConsoleInput.cs b/Terminal.Gui/Drivers/V2/IConsoleInput.cs similarity index 96% rename from Terminal.Gui/ConsoleDrivers/V2/IConsoleInput.cs rename to Terminal.Gui/Drivers/V2/IConsoleInput.cs index 03f712861..a79b9159b 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/IConsoleInput.cs +++ b/Terminal.Gui/Drivers/V2/IConsoleInput.cs @@ -1,6 +1,6 @@ using System.Collections.Concurrent; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Interface for reading console input indefinitely - diff --git a/Terminal.Gui/ConsoleDrivers/V2/IConsoleOutput.cs b/Terminal.Gui/Drivers/V2/IConsoleOutput.cs similarity index 97% rename from Terminal.Gui/ConsoleDrivers/V2/IConsoleOutput.cs rename to Terminal.Gui/Drivers/V2/IConsoleOutput.cs index cbd703ee8..aa35c06ee 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/IConsoleOutput.cs +++ b/Terminal.Gui/Drivers/V2/IConsoleOutput.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Interface for writing console output diff --git a/Terminal.Gui/ConsoleDrivers/V2/IInputProcessor.cs b/Terminal.Gui/Drivers/V2/IInputProcessor.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/V2/IInputProcessor.cs rename to Terminal.Gui/Drivers/V2/IInputProcessor.cs index bb79ec83f..93d5cd777 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/IInputProcessor.cs +++ b/Terminal.Gui/Drivers/V2/IInputProcessor.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; /// /// Interface for main loop class that will process the queued input buffer contents. diff --git a/Terminal.Gui/ConsoleDrivers/V2/IKeyConverter.cs b/Terminal.Gui/Drivers/V2/IKeyConverter.cs similarity index 94% rename from Terminal.Gui/ConsoleDrivers/V2/IKeyConverter.cs rename to Terminal.Gui/Drivers/V2/IKeyConverter.cs index 12cc379fa..c915e933c 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/IKeyConverter.cs +++ b/Terminal.Gui/Drivers/V2/IKeyConverter.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; /// /// Interface for subcomponent of a which diff --git a/Terminal.Gui/ConsoleDrivers/V2/IMainLoop.cs b/Terminal.Gui/Drivers/V2/IMainLoop.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/V2/IMainLoop.cs rename to Terminal.Gui/Drivers/V2/IMainLoop.cs index 73493eb7e..2638e4074 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/IMainLoop.cs +++ b/Terminal.Gui/Drivers/V2/IMainLoop.cs @@ -1,7 +1,7 @@ #nullable enable using System.Collections.Concurrent; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Interface for main loop that runs the core Terminal.Gui UI loop. diff --git a/Terminal.Gui/ConsoleDrivers/V2/IMainLoopCoordinator.cs b/Terminal.Gui/Drivers/V2/IMainLoopCoordinator.cs similarity index 94% rename from Terminal.Gui/ConsoleDrivers/V2/IMainLoopCoordinator.cs rename to Terminal.Gui/Drivers/V2/IMainLoopCoordinator.cs index 7a1ccf35b..d2fc8690a 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/IMainLoopCoordinator.cs +++ b/Terminal.Gui/Drivers/V2/IMainLoopCoordinator.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Interface for main Terminal.Gui loop manager in v2. diff --git a/Terminal.Gui/ConsoleDrivers/V2/INetInput.cs b/Terminal.Gui/Drivers/V2/INetInput.cs similarity index 65% rename from Terminal.Gui/ConsoleDrivers/V2/INetInput.cs rename to Terminal.Gui/Drivers/V2/INetInput.cs index 610eee236..74f7e495b 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/INetInput.cs +++ b/Terminal.Gui/Drivers/V2/INetInput.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal interface INetInput : IConsoleInput { } diff --git a/Terminal.Gui/ConsoleDrivers/V2/IOutputBuffer.cs b/Terminal.Gui/Drivers/V2/IOutputBuffer.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/V2/IOutputBuffer.cs rename to Terminal.Gui/Drivers/V2/IOutputBuffer.cs index 29c3475ef..80f33a0c0 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/IOutputBuffer.cs +++ b/Terminal.Gui/Drivers/V2/IOutputBuffer.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; /// /// Describes the screen state that you want the console to be in. diff --git a/Terminal.Gui/ConsoleDrivers/V2/IToplevelTransitionManager.cs b/Terminal.Gui/Drivers/V2/IToplevelTransitionManager.cs similarity index 94% rename from Terminal.Gui/ConsoleDrivers/V2/IToplevelTransitionManager.cs rename to Terminal.Gui/Drivers/V2/IToplevelTransitionManager.cs index 984c54490..82389c9f3 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/IToplevelTransitionManager.cs +++ b/Terminal.Gui/Drivers/V2/IToplevelTransitionManager.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Interface for class that handles bespoke behaviours that occur when application diff --git a/Terminal.Gui/ConsoleDrivers/V2/IWindowSizeMonitor.cs b/Terminal.Gui/Drivers/V2/IWindowSizeMonitor.cs similarity index 94% rename from Terminal.Gui/ConsoleDrivers/V2/IWindowSizeMonitor.cs rename to Terminal.Gui/Drivers/V2/IWindowSizeMonitor.cs index 5bfedfaf5..2cee6e8a8 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/IWindowSizeMonitor.cs +++ b/Terminal.Gui/Drivers/V2/IWindowSizeMonitor.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; /// /// Interface for classes responsible for reporting the current diff --git a/Terminal.Gui/ConsoleDrivers/V2/IWindowsInput.cs b/Terminal.Gui/Drivers/V2/IWindowsInput.cs similarity index 70% rename from Terminal.Gui/ConsoleDrivers/V2/IWindowsInput.cs rename to Terminal.Gui/Drivers/V2/IWindowsInput.cs index 63bf8e293..d8431b22f 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/IWindowsInput.cs +++ b/Terminal.Gui/Drivers/V2/IWindowsInput.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal interface IWindowsInput : IConsoleInput { } diff --git a/Terminal.Gui/ConsoleDrivers/V2/InputProcessor.cs b/Terminal.Gui/Drivers/V2/InputProcessor.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/V2/InputProcessor.cs rename to Terminal.Gui/Drivers/V2/InputProcessor.cs index e870fd4e9..607ad3a23 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/InputProcessor.cs +++ b/Terminal.Gui/Drivers/V2/InputProcessor.cs @@ -2,7 +2,7 @@ using System.Collections.Concurrent; using Microsoft.Extensions.Logging; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Processes the queued input buffer contents - which must be of Type . diff --git a/Terminal.Gui/ConsoleDrivers/V2/MainLoop.cs b/Terminal.Gui/Drivers/V2/MainLoop.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/V2/MainLoop.cs rename to Terminal.Gui/Drivers/V2/MainLoop.cs index 3021bf297..392a9934f 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/MainLoop.cs +++ b/Terminal.Gui/Drivers/V2/MainLoop.cs @@ -2,7 +2,7 @@ using System.Collections.Concurrent; using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// public class MainLoop : IMainLoop diff --git a/Terminal.Gui/ConsoleDrivers/V2/MainLoopCoordinator.cs b/Terminal.Gui/Drivers/V2/MainLoopCoordinator.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/V2/MainLoopCoordinator.cs rename to Terminal.Gui/Drivers/V2/MainLoopCoordinator.cs index 9594bb08b..a2cc34c49 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/MainLoopCoordinator.cs +++ b/Terminal.Gui/Drivers/V2/MainLoopCoordinator.cs @@ -1,7 +1,7 @@ using System.Collections.Concurrent; using Microsoft.Extensions.Logging; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// diff --git a/Terminal.Gui/ConsoleDrivers/V2/MouseButtonStateEx.cs b/Terminal.Gui/Drivers/V2/MouseButtonStateEx.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/V2/MouseButtonStateEx.cs rename to Terminal.Gui/Drivers/V2/MouseButtonStateEx.cs index fb1aa27fe..099151c2c 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/MouseButtonStateEx.cs +++ b/Terminal.Gui/Drivers/V2/MouseButtonStateEx.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; /// /// Not to be confused with diff --git a/Terminal.Gui/ConsoleDrivers/V2/MouseInterpreter.cs b/Terminal.Gui/Drivers/V2/MouseInterpreter.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/V2/MouseInterpreter.cs rename to Terminal.Gui/Drivers/V2/MouseInterpreter.cs index f6546302e..cb585ed9f 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/MouseInterpreter.cs +++ b/Terminal.Gui/Drivers/V2/MouseInterpreter.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; internal class MouseInterpreter { diff --git a/Terminal.Gui/ConsoleDrivers/V2/NetInput.cs b/Terminal.Gui/Drivers/V2/NetInput.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/V2/NetInput.cs rename to Terminal.Gui/Drivers/V2/NetInput.cs index d263c5749..7cfe488d3 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/NetInput.cs +++ b/Terminal.Gui/Drivers/V2/NetInput.cs @@ -1,6 +1,6 @@ using Microsoft.Extensions.Logging; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Console input implementation that uses native dotnet methods e.g. . diff --git a/Terminal.Gui/ConsoleDrivers/V2/NetInputProcessor.cs b/Terminal.Gui/Drivers/V2/NetInputProcessor.cs similarity index 98% rename from Terminal.Gui/ConsoleDrivers/V2/NetInputProcessor.cs rename to Terminal.Gui/Drivers/V2/NetInputProcessor.cs index c3afe85de..4e11d402a 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/NetInputProcessor.cs +++ b/Terminal.Gui/Drivers/V2/NetInputProcessor.cs @@ -1,6 +1,6 @@ using System.Collections.Concurrent; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Input processor for , deals in stream diff --git a/Terminal.Gui/ConsoleDrivers/V2/NetKeyConverter.cs b/Terminal.Gui/Drivers/V2/NetKeyConverter.cs similarity index 96% rename from Terminal.Gui/ConsoleDrivers/V2/NetKeyConverter.cs rename to Terminal.Gui/Drivers/V2/NetKeyConverter.cs index b7c17e615..198875463 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/NetKeyConverter.cs +++ b/Terminal.Gui/Drivers/V2/NetKeyConverter.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; /// /// capable of converting the diff --git a/Terminal.Gui/ConsoleDrivers/V2/NetOutput.cs b/Terminal.Gui/Drivers/V2/NetOutput.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/V2/NetOutput.cs rename to Terminal.Gui/Drivers/V2/NetOutput.cs index 7299c0262..33f0e9434 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/NetOutput.cs +++ b/Terminal.Gui/Drivers/V2/NetOutput.cs @@ -1,6 +1,6 @@ using Microsoft.Extensions.Logging; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Implementation of that uses native dotnet diff --git a/Terminal.Gui/ConsoleDrivers/V2/NotInitializedException.cs b/Terminal.Gui/Drivers/V2/NotInitializedException.cs similarity index 96% rename from Terminal.Gui/ConsoleDrivers/V2/NotInitializedException.cs rename to Terminal.Gui/Drivers/V2/NotInitializedException.cs index 5c63b4071..dd3530204 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/NotInitializedException.cs +++ b/Terminal.Gui/Drivers/V2/NotInitializedException.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Thrown when user code attempts to access a property or perform a method diff --git a/Terminal.Gui/ConsoleDrivers/V2/OutputBuffer.cs b/Terminal.Gui/Drivers/V2/OutputBuffer.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/V2/OutputBuffer.cs rename to Terminal.Gui/Drivers/V2/OutputBuffer.cs index 24137100d..fa44d5630 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/OutputBuffer.cs +++ b/Terminal.Gui/Drivers/V2/OutputBuffer.cs @@ -1,7 +1,7 @@ #nullable enable using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Stores the desired output state for the whole application. This is updated during diff --git a/Terminal.Gui/ConsoleDrivers/V2/ToplevelTransitionManager.cs b/Terminal.Gui/Drivers/V2/ToplevelTransitionManager.cs similarity index 96% rename from Terminal.Gui/ConsoleDrivers/V2/ToplevelTransitionManager.cs rename to Terminal.Gui/Drivers/V2/ToplevelTransitionManager.cs index 49bd86e4b..6a12f0861 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/ToplevelTransitionManager.cs +++ b/Terminal.Gui/Drivers/V2/ToplevelTransitionManager.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; /// /// Handles bespoke behaviours that occur when application top level changes. diff --git a/Terminal.Gui/ConsoleDrivers/V2/V2.cd b/Terminal.Gui/Drivers/V2/V2.cd similarity index 100% rename from Terminal.Gui/ConsoleDrivers/V2/V2.cd rename to Terminal.Gui/Drivers/V2/V2.cd diff --git a/Terminal.Gui/ConsoleDrivers/V2/WindowSizeMonitor.cs b/Terminal.Gui/Drivers/V2/WindowSizeMonitor.cs similarity index 97% rename from Terminal.Gui/ConsoleDrivers/V2/WindowSizeMonitor.cs rename to Terminal.Gui/Drivers/V2/WindowSizeMonitor.cs index 18707fa83..24cef5e9a 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/WindowSizeMonitor.cs +++ b/Terminal.Gui/Drivers/V2/WindowSizeMonitor.cs @@ -1,6 +1,6 @@ using Microsoft.Extensions.Logging; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal class WindowSizeMonitor : IWindowSizeMonitor { diff --git a/Terminal.Gui/ConsoleDrivers/V2/WindowsInput.cs b/Terminal.Gui/Drivers/V2/WindowsInput.cs similarity index 78% rename from Terminal.Gui/ConsoleDrivers/V2/WindowsInput.cs rename to Terminal.Gui/Drivers/V2/WindowsInput.cs index 423c6f06a..4ded6a089 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/WindowsInput.cs +++ b/Terminal.Gui/Drivers/V2/WindowsInput.cs @@ -1,10 +1,10 @@ using System.Runtime.InteropServices; using Microsoft.Extensions.Logging; -using static Terminal.Gui.WindowsConsole; +using static Terminal.Gui.Drivers.WindowsConsole; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; -internal class WindowsInput : ConsoleInput, IWindowsInput +internal class WindowsInput : ConsoleInput, IWindowsInput { private readonly nint _inputHandle; @@ -44,16 +44,16 @@ internal class WindowsInput : ConsoleInput, IWindowsInput _originalConsoleMode = v; uint newConsoleMode = _originalConsoleMode; - newConsoleMode |= (uint)(ConsoleModes.EnableMouseInput | ConsoleModes.EnableExtendedFlags); - newConsoleMode &= ~(uint)ConsoleModes.EnableQuickEditMode; - newConsoleMode &= ~(uint)ConsoleModes.EnableProcessedInput; + newConsoleMode |= (uint)(WindowsConsole.ConsoleModes.EnableMouseInput | WindowsConsole.ConsoleModes.EnableExtendedFlags); + newConsoleMode &= ~(uint)WindowsConsole.ConsoleModes.EnableQuickEditMode; + newConsoleMode &= ~(uint)WindowsConsole.ConsoleModes.EnableProcessedInput; SetConsoleMode (_inputHandle, newConsoleMode); } protected override bool Peek () { const int bufferSize = 1; // We only need to check if there's at least one event - nint pRecord = Marshal.AllocHGlobal (Marshal.SizeOf () * bufferSize); + nint pRecord = Marshal.AllocHGlobal (Marshal.SizeOf () * bufferSize); try { @@ -83,10 +83,10 @@ internal class WindowsInput : ConsoleInput, IWindowsInput } } - protected override IEnumerable Read () + protected override IEnumerable Read () { const int bufferSize = 1; - nint pRecord = Marshal.AllocHGlobal (Marshal.SizeOf () * bufferSize); + nint pRecord = Marshal.AllocHGlobal (Marshal.SizeOf () * bufferSize); try { @@ -98,7 +98,7 @@ internal class WindowsInput : ConsoleInput, IWindowsInput return numberEventsRead == 0 ? [] - : new [] { Marshal.PtrToStructure (pRecord) }; + : new [] { Marshal.PtrToStructure (pRecord) }; } catch (Exception) { diff --git a/Terminal.Gui/ConsoleDrivers/V2/WindowsInputProcessor.cs b/Terminal.Gui/Drivers/V2/WindowsInputProcessor.cs similarity index 76% rename from Terminal.Gui/ConsoleDrivers/V2/WindowsInputProcessor.cs rename to Terminal.Gui/Drivers/V2/WindowsInputProcessor.cs index 5a79ed58d..cdd2e1dfe 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/WindowsInputProcessor.cs +++ b/Terminal.Gui/Drivers/V2/WindowsInputProcessor.cs @@ -1,10 +1,9 @@ #nullable enable using System.Collections.Concurrent; -using static Terminal.Gui.WindowsConsole; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; -using InputRecord = InputRecord; +using InputRecord = WindowsConsole.InputRecord; /// /// Input processor for , deals in stream. @@ -21,7 +20,7 @@ internal class WindowsInputProcessor : InputProcessor { switch (inputEvent.EventType) { - case EventType.Key: + case WindowsConsole.EventType.Key: // TODO: For now ignore keyup because ANSI comes in as down+up which is confusing to try and parse/pair these things up if (!inputEvent.KeyEvent.bKeyDown) @@ -58,7 +57,7 @@ internal class WindowsInputProcessor : InputProcessor break; - case EventType.Mouse: + case WindowsConsole.EventType.Mouse: MouseEventArgs me = ToDriverMouse (inputEvent.MouseEvent); OnMouseEvent (me); @@ -79,17 +78,17 @@ internal class WindowsInputProcessor : InputProcessor } } - public MouseEventArgs ToDriverMouse (MouseEventRecord e) + public MouseEventArgs ToDriverMouse (WindowsConsole.MouseEventRecord e) { var mouseFlags = MouseFlags.None; - mouseFlags = UpdateMouseFlags (mouseFlags, e.ButtonState, ButtonState.Button1Pressed, MouseFlags.Button1Pressed, MouseFlags.Button1Released, 0); - mouseFlags = UpdateMouseFlags (mouseFlags, e.ButtonState, ButtonState.Button2Pressed, MouseFlags.Button2Pressed, MouseFlags.Button2Released, 1); - mouseFlags = UpdateMouseFlags (mouseFlags, e.ButtonState, ButtonState.Button4Pressed, MouseFlags.Button4Pressed, MouseFlags.Button4Released, 3); + mouseFlags = UpdateMouseFlags (mouseFlags, e.ButtonState, WindowsConsole.ButtonState.Button1Pressed, MouseFlags.Button1Pressed, MouseFlags.Button1Released, 0); + mouseFlags = UpdateMouseFlags (mouseFlags, e.ButtonState, WindowsConsole.ButtonState.Button2Pressed, MouseFlags.Button2Pressed, MouseFlags.Button2Released, 1); + mouseFlags = UpdateMouseFlags (mouseFlags, e.ButtonState, WindowsConsole.ButtonState.Button4Pressed, MouseFlags.Button4Pressed, MouseFlags.Button4Released, 3); // Deal with button 3 separately because it is considered same as 'rightmost button' - if (e.ButtonState.HasFlag (ButtonState.Button3Pressed) || e.ButtonState.HasFlag (ButtonState.RightmostButtonPressed)) + if (e.ButtonState.HasFlag (WindowsConsole.ButtonState.Button3Pressed) || e.ButtonState.HasFlag (WindowsConsole.ButtonState.RightmostButtonPressed)) { mouseFlags |= MouseFlags.Button3Pressed; _lastWasPressed [2] = true; @@ -104,7 +103,7 @@ internal class WindowsInputProcessor : InputProcessor } } - if (e.EventFlags == EventFlags.MouseWheeled) + if (e.EventFlags == WindowsConsole.EventFlags.MouseWheeled) { switch ((int)e.ButtonState) { @@ -120,32 +119,32 @@ internal class WindowsInputProcessor : InputProcessor } } - if (e.EventFlags != EventFlags.NoEvent) + if (e.EventFlags != WindowsConsole.EventFlags.NoEvent) { switch (e.EventFlags) { - case EventFlags.MouseMoved: + case WindowsConsole.EventFlags.MouseMoved: mouseFlags |= MouseFlags.ReportMousePosition; break; } } - if (e.ControlKeyState != ControlKeyState.NoControlKeyPressed) + if (e.ControlKeyState != WindowsConsole.ControlKeyState.NoControlKeyPressed) { switch (e.ControlKeyState) { - case ControlKeyState.RightAltPressed: - case ControlKeyState.LeftAltPressed: + case WindowsConsole.ControlKeyState.RightAltPressed: + case WindowsConsole.ControlKeyState.LeftAltPressed: mouseFlags |= MouseFlags.ButtonAlt; break; - case ControlKeyState.RightControlPressed: - case ControlKeyState.LeftControlPressed: + case WindowsConsole.ControlKeyState.RightControlPressed: + case WindowsConsole.ControlKeyState.LeftControlPressed: mouseFlags |= MouseFlags.ButtonCtrl; break; - case ControlKeyState.ShiftPressed: + case WindowsConsole.ControlKeyState.ShiftPressed: mouseFlags |= MouseFlags.ButtonShift; break; @@ -163,8 +162,8 @@ internal class WindowsInputProcessor : InputProcessor private MouseFlags UpdateMouseFlags ( MouseFlags current, - ButtonState newState, - ButtonState pressedState, + WindowsConsole.ButtonState newState, + WindowsConsole.ButtonState pressedState, MouseFlags pressedFlag, MouseFlags releasedFlag, int buttonIndex diff --git a/Terminal.Gui/ConsoleDrivers/V2/WindowsKeyConverter.cs b/Terminal.Gui/Drivers/V2/WindowsKeyConverter.cs similarity index 97% rename from Terminal.Gui/ConsoleDrivers/V2/WindowsKeyConverter.cs rename to Terminal.Gui/Drivers/V2/WindowsKeyConverter.cs index c74e10ca7..8ecbfe661 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/WindowsKeyConverter.cs +++ b/Terminal.Gui/Drivers/V2/WindowsKeyConverter.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Drivers; /// /// capable of converting the diff --git a/Terminal.Gui/ConsoleDrivers/V2/WindowsOutput.cs b/Terminal.Gui/Drivers/V2/WindowsOutput.cs similarity index 90% rename from Terminal.Gui/ConsoleDrivers/V2/WindowsOutput.cs rename to Terminal.Gui/Drivers/V2/WindowsOutput.cs index 16ae59913..17fc2aff6 100644 --- a/Terminal.Gui/ConsoleDrivers/V2/WindowsOutput.cs +++ b/Terminal.Gui/Drivers/V2/WindowsOutput.cs @@ -3,9 +3,9 @@ using System.Buffers; using System.ComponentModel; using System.Runtime.InteropServices; using Microsoft.Extensions.Logging; -using static Terminal.Gui.WindowsConsole; +using static Terminal.Gui.Drivers.WindowsConsole; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal partial class WindowsOutput : IConsoleOutput { @@ -32,7 +32,7 @@ internal partial class WindowsOutput : IConsoleOutput ); [DllImport ("kernel32.dll", SetLastError = true)] - private static extern bool GetConsoleScreenBufferInfoEx (nint hConsoleOutput, ref CONSOLE_SCREEN_BUFFER_INFOEX csbi); + private static extern bool GetConsoleScreenBufferInfoEx (nint hConsoleOutput, ref WindowsConsole.CONSOLE_SCREEN_BUFFER_INFOEX csbi); [Flags] private enum ShareMode : uint @@ -54,10 +54,10 @@ internal partial class WindowsOutput : IConsoleOutput private static extern bool SetConsoleActiveScreenBuffer (nint handle); [DllImport ("kernel32.dll")] - private static extern bool SetConsoleCursorPosition (nint hConsoleOutput, Coord dwCursorPosition); + private static extern bool SetConsoleCursorPosition (nint hConsoleOutput, WindowsConsole.Coord dwCursorPosition); [DllImport ("kernel32.dll", SetLastError = true)] - private static extern bool SetConsoleCursorInfo (nint hConsoleOutput, [In] ref ConsoleCursorInfo lpConsoleCursorInfo); + private static extern bool SetConsoleCursorInfo (nint hConsoleOutput, [In] ref WindowsConsole.ConsoleCursorInfo lpConsoleCursorInfo); private readonly nint _screenBuffer; @@ -102,7 +102,7 @@ internal partial class WindowsOutput : IConsoleOutput public void Write (IOutputBuffer buffer) { - ExtendedCharInfo [] outputBuffer = new ExtendedCharInfo [buffer.Rows * buffer.Cols]; + WindowsConsole.ExtendedCharInfo [] outputBuffer = new WindowsConsole.ExtendedCharInfo [buffer.Rows * buffer.Cols]; // TODO: probably do need this right? /* @@ -111,7 +111,7 @@ internal partial class WindowsOutput : IConsoleOutput return; }*/ - var bufferCoords = new Coord + var bufferCoords = new WindowsConsole.Coord { X = (short)buffer.Cols, //Clip.Width, Y = (short)buffer.Rows //Clip.Height @@ -162,7 +162,7 @@ internal partial class WindowsOutput : IConsoleOutput } } - var damageRegion = new SmallRect + var damageRegion = new WindowsConsole.SmallRect { Top = 0, Left = 0, @@ -186,10 +186,10 @@ internal partial class WindowsOutput : IConsoleOutput } } - SmallRect.MakeEmpty (ref damageRegion); + WindowsConsole.SmallRect.MakeEmpty (ref damageRegion); } - public bool WriteToConsole (Size size, ExtendedCharInfo [] charInfoBuffer, Coord bufferSize, SmallRect window, bool force16Colors) + public bool WriteToConsole (Size size, WindowsConsole.ExtendedCharInfo [] charInfoBuffer, WindowsConsole.Coord bufferSize, WindowsConsole.SmallRect window, bool force16Colors) { //Debug.WriteLine ("WriteToConsole"); @@ -204,9 +204,9 @@ internal partial class WindowsOutput : IConsoleOutput if (force16Colors) { var i = 0; - CharInfo [] ci = new CharInfo [charInfoBuffer.Length]; + WindowsConsole.CharInfo [] ci = new WindowsConsole.CharInfo [charInfoBuffer.Length]; - foreach (ExtendedCharInfo info in charInfoBuffer) + foreach (WindowsConsole.ExtendedCharInfo info in charInfoBuffer) { ci [i++] = new () { @@ -227,7 +227,7 @@ internal partial class WindowsOutput : IConsoleOutput Attribute? prev = null; - foreach (ExtendedCharInfo info in charInfoBuffer) + foreach (WindowsConsole.ExtendedCharInfo info in charInfoBuffer) { Attribute attr = info.Attribute; @@ -293,7 +293,7 @@ internal partial class WindowsOutput : IConsoleOutput public Size GetWindowSize () { - var csbi = new CONSOLE_SCREEN_BUFFER_INFOEX (); + var csbi = new WindowsConsole.CONSOLE_SCREEN_BUFFER_INFOEX (); csbi.cbSize = (uint)Marshal.SizeOf (csbi); if (!GetConsoleScreenBufferInfoEx (_screenBuffer, ref csbi)) @@ -314,7 +314,7 @@ internal partial class WindowsOutput : IConsoleOutput { if (Application.Driver!.Force16Colors) { - var info = new ConsoleCursorInfo + var info = new WindowsConsole.ConsoleCursorInfo { dwSize = (uint)visibility & 0x00FF, bVisible = ((uint)visibility & 0xFF00) != 0 diff --git a/Terminal.Gui/ConsoleDrivers/WindowsDriver/ClipboardImpl.cs b/Terminal.Gui/Drivers/WindowsDriver/ClipboardImpl.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/WindowsDriver/ClipboardImpl.cs rename to Terminal.Gui/Drivers/WindowsDriver/ClipboardImpl.cs index d38ffb408..6dc708110 100644 --- a/Terminal.Gui/ConsoleDrivers/WindowsDriver/ClipboardImpl.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/ClipboardImpl.cs @@ -2,7 +2,7 @@ using System.ComponentModel; using System.Runtime.InteropServices; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal class WindowsClipboard : ClipboardBase { diff --git a/Terminal.Gui/ConsoleDrivers/WindowsDriver/WindowsConsole.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsConsole.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/WindowsDriver/WindowsConsole.cs rename to Terminal.Gui/Drivers/WindowsDriver/WindowsConsole.cs index 90c5aa412..6153df249 100644 --- a/Terminal.Gui/ConsoleDrivers/WindowsDriver/WindowsConsole.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsConsole.cs @@ -3,7 +3,7 @@ using System.Collections.Concurrent; using System.ComponentModel; using System.Runtime.InteropServices; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal partial class WindowsConsole { diff --git a/Terminal.Gui/ConsoleDrivers/WindowsDriver/WindowsDriver.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsDriver.cs similarity index 99% rename from Terminal.Gui/ConsoleDrivers/WindowsDriver/WindowsDriver.cs rename to Terminal.Gui/Drivers/WindowsDriver/WindowsDriver.cs index 302e71883..8af14dbb9 100644 --- a/Terminal.Gui/ConsoleDrivers/WindowsDriver/WindowsDriver.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsDriver.cs @@ -20,7 +20,7 @@ using System.ComponentModel; using System.Diagnostics; using System.Runtime.InteropServices; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; internal class WindowsDriver : ConsoleDriver { diff --git a/Terminal.Gui/ConsoleDrivers/WindowsDriver/WindowsMainLoop.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsMainLoop.cs similarity index 97% rename from Terminal.Gui/ConsoleDrivers/WindowsDriver/WindowsMainLoop.cs rename to Terminal.Gui/Drivers/WindowsDriver/WindowsMainLoop.cs index 547f5dcd2..0e10a99b9 100644 --- a/Terminal.Gui/ConsoleDrivers/WindowsDriver/WindowsMainLoop.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsMainLoop.cs @@ -3,8 +3,11 @@ #define HACK_CHECK_WINCHANGED using System.Collections.Concurrent; +using IMainLoopDriver = Terminal.Gui.App.IMainLoopDriver; +using MainLoop = Terminal.Gui.App.MainLoop; +using SizeChangedEventArgs = Terminal.Gui.ViewBase.SizeChangedEventArgs; -namespace Terminal.Gui; +namespace Terminal.Gui.Drivers; /// /// Mainloop intended to be used with the , and can diff --git a/Terminal.Gui/FileServices/AllowedType.cs b/Terminal.Gui/FileServices/AllowedType.cs index 8d840edec..691c3ef69 100644 --- a/Terminal.Gui/FileServices/AllowedType.cs +++ b/Terminal.Gui/FileServices/AllowedType.cs @@ -1,6 +1,5 @@ -using Terminal.Gui.Resources; - -namespace Terminal.Gui; + +namespace Terminal.Gui.FileServices; /// Interface for restrictions on which file type(s) the user is allowed to select/enter. public interface IAllowedType diff --git a/Terminal.Gui/FileServices/DefaultFileOperations.cs b/Terminal.Gui/FileServices/DefaultFileOperations.cs index bdbc88964..032e4a0eb 100644 --- a/Terminal.Gui/FileServices/DefaultFileOperations.cs +++ b/Terminal.Gui/FileServices/DefaultFileOperations.cs @@ -1,7 +1,6 @@ using System.IO.Abstractions; -using Terminal.Gui.Resources; -namespace Terminal.Gui; +namespace Terminal.Gui.FileServices; /// Default file operation handlers using modal dialogs. public class DefaultFileOperations : IFileOperations diff --git a/Terminal.Gui/FileServices/DefaultSearchMatcher.cs b/Terminal.Gui/FileServices/DefaultSearchMatcher.cs index a3160c61e..3c10e2a1c 100644 --- a/Terminal.Gui/FileServices/DefaultSearchMatcher.cs +++ b/Terminal.Gui/FileServices/DefaultSearchMatcher.cs @@ -1,6 +1,6 @@ using System.IO.Abstractions; -namespace Terminal.Gui; +namespace Terminal.Gui.FileServices; internal class DefaultSearchMatcher : ISearchMatcher { diff --git a/Terminal.Gui/FileServices/FileDialogHistory.cs b/Terminal.Gui/FileServices/FileDialogHistory.cs index ddb019d27..b6a6ac183 100644 --- a/Terminal.Gui/FileServices/FileDialogHistory.cs +++ b/Terminal.Gui/FileServices/FileDialogHistory.cs @@ -1,6 +1,6 @@ using System.IO.Abstractions; -namespace Terminal.Gui; +namespace Terminal.Gui.FileServices; internal class FileDialogHistory { diff --git a/Terminal.Gui/FileServices/FileDialogState.cs b/Terminal.Gui/FileServices/FileDialogState.cs index 042b5a75d..b79f172f0 100644 --- a/Terminal.Gui/FileServices/FileDialogState.cs +++ b/Terminal.Gui/FileServices/FileDialogState.cs @@ -1,6 +1,6 @@ using System.IO.Abstractions; -namespace Terminal.Gui; +namespace Terminal.Gui.FileServices; internal class FileDialogState { diff --git a/Terminal.Gui/FileServices/FileDialogStyle.cs b/Terminal.Gui/FileServices/FileDialogStyle.cs index dec3e2d1d..b460b3540 100644 --- a/Terminal.Gui/FileServices/FileDialogStyle.cs +++ b/Terminal.Gui/FileServices/FileDialogStyle.cs @@ -1,10 +1,9 @@ using System.Diagnostics.CodeAnalysis; using System.Globalization; using System.IO.Abstractions; -using Terminal.Gui.Resources; using static System.Environment; -namespace Terminal.Gui; +namespace Terminal.Gui.FileServices; /// Stores style settings for . public class FileDialogStyle diff --git a/Terminal.Gui/FileServices/FileSystemInfoStats.cs b/Terminal.Gui/FileServices/FileSystemInfoStats.cs index 594a42015..11bac6e2f 100644 --- a/Terminal.Gui/FileServices/FileSystemInfoStats.cs +++ b/Terminal.Gui/FileServices/FileSystemInfoStats.cs @@ -1,8 +1,7 @@ using System.Globalization; using System.IO.Abstractions; -using Terminal.Gui.Resources; -namespace Terminal.Gui; +namespace Terminal.Gui.FileServices; /// /// Wrapper for that contains additional information (e.g. ) diff --git a/Terminal.Gui/FileServices/FileSystemTreeBuilder.cs b/Terminal.Gui/FileServices/FileSystemTreeBuilder.cs index 6c13f7d16..87aba39af 100644 --- a/Terminal.Gui/FileServices/FileSystemTreeBuilder.cs +++ b/Terminal.Gui/FileServices/FileSystemTreeBuilder.cs @@ -1,6 +1,6 @@ using System.IO.Abstractions; -namespace Terminal.Gui; +namespace Terminal.Gui.FileServices; /// TreeView builder for creating file system based trees. public class FileSystemTreeBuilder : ITreeBuilder, IComparer diff --git a/Terminal.Gui/FileServices/FilesSelectedEventArgs.cs b/Terminal.Gui/FileServices/FilesSelectedEventArgs.cs index 4b3423498..7f09bda30 100644 --- a/Terminal.Gui/FileServices/FilesSelectedEventArgs.cs +++ b/Terminal.Gui/FileServices/FilesSelectedEventArgs.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.FileServices; /// Event args for the event public class FilesSelectedEventArgs : EventArgs diff --git a/Terminal.Gui/FileServices/IFileOperations.cs b/Terminal.Gui/FileServices/IFileOperations.cs index 46a43b433..610d097be 100644 --- a/Terminal.Gui/FileServices/IFileOperations.cs +++ b/Terminal.Gui/FileServices/IFileOperations.cs @@ -1,6 +1,6 @@ using System.IO.Abstractions; -namespace Terminal.Gui; +namespace Terminal.Gui.FileServices; /// /// Interface for defining how to handle file/directory deletion, rename and newing attempts in diff --git a/Terminal.Gui/FileServices/ISearchMatcher.cs b/Terminal.Gui/FileServices/ISearchMatcher.cs index bac846a72..7efefc78e 100644 --- a/Terminal.Gui/FileServices/ISearchMatcher.cs +++ b/Terminal.Gui/FileServices/ISearchMatcher.cs @@ -1,6 +1,6 @@ using System.IO.Abstractions; -namespace Terminal.Gui; +namespace Terminal.Gui.FileServices; /// Defines whether a given file/directory matches a set of search terms. public interface ISearchMatcher diff --git a/Terminal.Gui/GlobalSuppressions.cs b/Terminal.Gui/GlobalSuppressions.cs new file mode 100644 index 000000000..98d24d0e7 --- /dev/null +++ b/Terminal.Gui/GlobalSuppressions.cs @@ -0,0 +1,9 @@ +// This file is used by Code Analysis to maintain SuppressMessage +// attributes that are applied to this project. +// Project-level suppressions either have no target or are given +// a specific target and scoped to a namespace, type, member, etc. + +using System.Diagnostics.CodeAnalysis; + +[assembly: SuppressMessage ("Style", "IDE0130:Namespace does not match folder structure", Justification = "", Scope = "namespace", Target = "~N:Terminal.Gui.Core")] +[assembly: SuppressMessage ("Style", "IDE0130:Namespace does not match folder structure", Justification = "", Scope = "namespace", Target = "~N:Terminal.Gui")] diff --git a/Terminal.Gui/Input/Command.cs b/Terminal.Gui/Input/Command.cs index 003ec3c74..36800875d 100644 --- a/Terminal.Gui/Input/Command.cs +++ b/Terminal.Gui/Input/Command.cs @@ -1,7 +1,8 @@ // These classes use a keybinding system based on the design implemented in Scintilla.Net which is an // MIT licensed open source project https://github.com/jacobslusser/ScintillaNET/blob/master/src/ScintillaNET/Command.cs -namespace Terminal.Gui; + +namespace Terminal.Gui.Input; /// /// Actions which can be performed by a . diff --git a/Terminal.Gui/Input/CommandContext.cs b/Terminal.Gui/Input/CommandContext.cs index 282e2ed4c..fe6c9c194 100644 --- a/Terminal.Gui/Input/CommandContext.cs +++ b/Terminal.Gui/Input/CommandContext.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Input; #pragma warning disable CS1574, CS0419 // XML comment has cref attribute that could not be resolved /// diff --git a/Terminal.Gui/Input/CommandEventArgs.cs b/Terminal.Gui/Input/CommandEventArgs.cs index b98eb514f..05d662437 100644 --- a/Terminal.Gui/Input/CommandEventArgs.cs +++ b/Terminal.Gui/Input/CommandEventArgs.cs @@ -1,7 +1,7 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Input; /// /// Event arguments for events. Set to diff --git a/Terminal.Gui/Input/ICommandContext.cs b/Terminal.Gui/Input/ICommandContext.cs index a7407d787..a9d4e641c 100644 --- a/Terminal.Gui/Input/ICommandContext.cs +++ b/Terminal.Gui/Input/ICommandContext.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Input; #pragma warning disable CS1574 // XML comment has cref attribute that could not be resolved /// diff --git a/Terminal.Gui/Input/IInputBinding.cs b/Terminal.Gui/Input/IInputBinding.cs index eff835347..f0ae3a25a 100644 --- a/Terminal.Gui/Input/IInputBinding.cs +++ b/Terminal.Gui/Input/IInputBinding.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Input; /// /// Describes an input binding. Used to bind a set of objects to a specific input event. diff --git a/Terminal.Gui/Input/InputBindings.cs b/Terminal.Gui/Input/InputBindings.cs index 353557023..9c2b446e1 100644 --- a/Terminal.Gui/Input/InputBindings.cs +++ b/Terminal.Gui/Input/InputBindings.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Input; /// /// Abstract class for and . diff --git a/Terminal.Gui/Input/Keyboard/Key.cs b/Terminal.Gui/Input/Keyboard/Key.cs index e6ba29d44..cd9924047 100644 --- a/Terminal.Gui/Input/Keyboard/Key.cs +++ b/Terminal.Gui/Input/Keyboard/Key.cs @@ -2,7 +2,7 @@ using System.Diagnostics.CodeAnalysis; using System.Globalization; -namespace Terminal.Gui; +namespace Terminal.Gui.Input; /// /// Provides an abstraction for common keyboard operations and state. Used for processing keyboard input and @@ -11,7 +11,7 @@ namespace Terminal.Gui; /// /// /// This class provides a high-level abstraction with helper methods and properties for common keyboard -/// operations. Use this class instead of the enumeration for keyboard input +/// operations. Use this class instead of the enumeration for keyboard input /// whenever possible. /// /// @@ -63,7 +63,7 @@ namespace Terminal.Gui; /// /// Keys are persisted as "[Modifiers]+[Key]. For example /// new Key(Key.Delete).WithAlt.WithDel is persisted as "Ctrl+Alt+Delete". See -/// and for more +/// and for more /// information. /// /// @@ -123,7 +123,7 @@ public class Key : EventArgs, IEquatable /// /// Constructs a new Key from a string describing the key. See - /// for information on the format of the string. + /// for information on the format of the string. /// /// The string describing the key. public Key (string str) @@ -236,7 +236,7 @@ public class Key : EventArgs, IEquatable /// The encoded key value. /// - /// IMPORTANT: Lowercase alpha keys are encoded (in ) as values between 65 and 90 + /// IMPORTANT: Lowercase alpha keys are encoded (in ) as values between 65 and 90 /// corresponding to the un-shifted A to Z keys on a keyboard. Enum values are provided for these (e.g. /// , , etc.). Even though the values are the same as the ASCII values /// for uppercase characters, these enum values represent *lowercase*, un-shifted characters. diff --git a/Terminal.Gui/Input/Keyboard/KeyBinding.cs b/Terminal.Gui/Input/Keyboard/KeyBinding.cs index 59806ab16..b55a66842 100644 --- a/Terminal.Gui/Input/Keyboard/KeyBinding.cs +++ b/Terminal.Gui/Input/Keyboard/KeyBinding.cs @@ -1,15 +1,16 @@ #nullable enable + // These classes use a key binding system based on the design implemented in Scintilla.Net which is an // MIT licensed open source project https://github.com/jacobslusser/ScintillaNET/blob/master/src/ScintillaNET/Command.cs -namespace Terminal.Gui; +namespace Terminal.Gui.Input; /// /// Provides a collection of objects stored in . /// -/// -/// +/// +/// /// public record struct KeyBinding : IInputBinding { diff --git a/Terminal.Gui/Input/Keyboard/KeyBindings.cs b/Terminal.Gui/Input/Keyboard/KeyBindings.cs index 7b7590729..c4a2952eb 100644 --- a/Terminal.Gui/Input/Keyboard/KeyBindings.cs +++ b/Terminal.Gui/Input/Keyboard/KeyBindings.cs @@ -1,11 +1,12 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Input; /// /// Provides a collection of s bound to s. /// -/// -/// +/// +/// /// public class KeyBindings : InputBindings { diff --git a/Terminal.Gui/Input/Keyboard/KeyChangedEventArgs.cs b/Terminal.Gui/Input/Keyboard/KeyChangedEventArgs.cs index 7af356461..92cafc586 100644 --- a/Terminal.Gui/Input/Keyboard/KeyChangedEventArgs.cs +++ b/Terminal.Gui/Input/Keyboard/KeyChangedEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Input; /// /// Event args for when a is changed from one value to a new value (e.g. in diff --git a/Terminal.Gui/Input/Keyboard/KeyEqualityComparer.cs b/Terminal.Gui/Input/Keyboard/KeyEqualityComparer.cs index fe02f13dc..287dd9cfa 100644 --- a/Terminal.Gui/Input/Keyboard/KeyEqualityComparer.cs +++ b/Terminal.Gui/Input/Keyboard/KeyEqualityComparer.cs @@ -1,5 +1,4 @@ #nullable enable -using Terminal.Gui; /// /// diff --git a/Terminal.Gui/Input/Keyboard/KeystrokeNavigatorEventArgs.cs b/Terminal.Gui/Input/Keyboard/KeystrokeNavigatorEventArgs.cs index 7f128f60b..4e7509dfd 100644 --- a/Terminal.Gui/Input/Keyboard/KeystrokeNavigatorEventArgs.cs +++ b/Terminal.Gui/Input/Keyboard/KeystrokeNavigatorEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Input; /// Event arguments for the event. public class KeystrokeNavigatorEventArgs : EventArgs diff --git a/Terminal.Gui/Input/Mouse/GrabMouseEventArgs.cs b/Terminal.Gui/Input/Mouse/GrabMouseEventArgs.cs index 622d33d9a..c05fd7471 100644 --- a/Terminal.Gui/Input/Mouse/GrabMouseEventArgs.cs +++ b/Terminal.Gui/Input/Mouse/GrabMouseEventArgs.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Input; /// Args GrabMouse related events. public class GrabMouseEventArgs : EventArgs diff --git a/Terminal.Gui/Input/Mouse/MouseBinding.cs b/Terminal.Gui/Input/Mouse/MouseBinding.cs index c4b7ad25d..0ca5747a3 100644 --- a/Terminal.Gui/Input/Mouse/MouseBinding.cs +++ b/Terminal.Gui/Input/Mouse/MouseBinding.cs @@ -1,6 +1,6 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Input; /// /// Provides a collection of bound to s. diff --git a/Terminal.Gui/Input/Mouse/MouseBindings.cs b/Terminal.Gui/Input/Mouse/MouseBindings.cs index afcab50da..55d0bf61d 100644 --- a/Terminal.Gui/Input/Mouse/MouseBindings.cs +++ b/Terminal.Gui/Input/Mouse/MouseBindings.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Input; /// /// Provides a collection of objects bound to a combination of . diff --git a/Terminal.Gui/Input/Mouse/MouseEventArgs.cs b/Terminal.Gui/Input/Mouse/MouseEventArgs.cs index cdf3aafb1..db0008ef3 100644 --- a/Terminal.Gui/Input/Mouse/MouseEventArgs.cs +++ b/Terminal.Gui/Input/Mouse/MouseEventArgs.cs @@ -1,11 +1,11 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Input; /// -/// Specifies the event arguments for . This is a higher-level construct than -/// the wrapped class and is used for the events defined on +/// Specifies the event arguments for . This is a higher-level construct than +/// the wrapped class and is used for the events defined on /// and subclasses /// of View (e.g. and ). /// @@ -95,7 +95,7 @@ public class MouseEventArgs : HandledEventArgs || Flags.HasFlag (MouseFlags.WheeledLeft) || Flags.HasFlag (MouseFlags.WheeledRight); - /// Returns a that represents the current . - /// A that represents the current . + /// Returns a that represents the current . + /// A that represents the current . public override string ToString () { return $"({ScreenPosition}):{Flags}:{View?.Id}:{Position}"; } } diff --git a/Terminal.Gui/Input/Mouse/MouseFlags.cs b/Terminal.Gui/Input/Mouse/MouseFlags.cs index 56bed6e88..7f15764b0 100644 --- a/Terminal.Gui/Input/Mouse/MouseFlags.cs +++ b/Terminal.Gui/Input/Mouse/MouseFlags.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Input; /// Mouse flags reported in . /// They just happen to map to the ncurses ones. @@ -6,7 +6,7 @@ namespace Terminal.Gui; public enum MouseFlags { /// - /// No mouse event. This is the default value for when no mouse event is being reported. + /// No mouse event. This is the default value for when no mouse event is being reported. /// None = 0, diff --git a/Terminal.Gui/Input/Mouse/MouseFlagsChangedEventArgs.cs b/Terminal.Gui/Input/Mouse/MouseFlagsChangedEventArgs.cs index 0af4c996a..e24420aca 100644 --- a/Terminal.Gui/Input/Mouse/MouseFlagsChangedEventArgs.cs +++ b/Terminal.Gui/Input/Mouse/MouseFlagsChangedEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Input; // TODO: This class is unnecessary. Replace it with CancelEventArgs from Terminal.Gui.View\CancelEventArgs.cs /// Args for events that describe a change in diff --git a/Terminal.Gui/Resources/GlobalResources.cs b/Terminal.Gui/Resources/GlobalResources.cs index 625dd20c5..8a9ac5a0c 100644 --- a/Terminal.Gui/Resources/GlobalResources.cs +++ b/Terminal.Gui/Resources/GlobalResources.cs @@ -4,7 +4,7 @@ using System.Collections; using System.Globalization; using System.Resources; -namespace Terminal.Gui.Resources; +namespace Terminal.Gui.App; /// /// Provide static access to the ResourceManagerWrapper diff --git a/Terminal.Gui/Resources/ResourceManagerWrapper.cs b/Terminal.Gui/Resources/ResourceManagerWrapper.cs index fcebe7b66..8bcc9271f 100644 --- a/Terminal.Gui/Resources/ResourceManagerWrapper.cs +++ b/Terminal.Gui/Resources/ResourceManagerWrapper.cs @@ -4,7 +4,7 @@ using System.Collections; using System.Globalization; using System.Resources; -namespace Terminal.Gui.Resources; +namespace Terminal.Gui.App; internal class ResourceManagerWrapper (ResourceManager resourceManager) { diff --git a/Terminal.Gui/Terminal.Gui.csproj b/Terminal.Gui/Terminal.Gui.csproj index 67444b57c..32d33f646 100644 --- a/Terminal.Gui/Terminal.Gui.csproj +++ b/Terminal.Gui/Terminal.Gui.csproj @@ -75,7 +75,6 @@ - diff --git a/Terminal.Gui/Text/NerdFonts.cs b/Terminal.Gui/Text/NerdFonts.cs index b0ae8c917..2ceaf4fa7 100644 --- a/Terminal.Gui/Text/NerdFonts.cs +++ b/Terminal.Gui/Text/NerdFonts.cs @@ -3,7 +3,7 @@ using System.IO.Abstractions; -namespace Terminal.Gui; +namespace Terminal.Gui.Text; internal class NerdFonts { diff --git a/Terminal.Gui/Text/RuneExtensions.cs b/Terminal.Gui/Text/RuneExtensions.cs index f5097316f..6ff5d8e2e 100644 --- a/Terminal.Gui/Text/RuneExtensions.cs +++ b/Terminal.Gui/Text/RuneExtensions.cs @@ -3,7 +3,7 @@ using System.Globalization; using Wcwidth; -namespace Terminal.Gui; +namespace Terminal.Gui.Text; /// Extends to support TUI text manipulation. public static class RuneExtensions diff --git a/Terminal.Gui/Text/StringExtensions.cs b/Terminal.Gui/Text/StringExtensions.cs index 0dc1acdec..a38bb5799 100644 --- a/Terminal.Gui/Text/StringExtensions.cs +++ b/Terminal.Gui/Text/StringExtensions.cs @@ -1,7 +1,7 @@ #nullable enable using System.Buffers; -namespace Terminal.Gui; +namespace Terminal.Gui.Text; /// Extensions to to support TUI text manipulation. public static class StringExtensions diff --git a/Terminal.Gui/Text/StringPropertyEventArgs.cs b/Terminal.Gui/Text/StringPropertyEventArgs.cs index 9de062d8c..6dccf5cd9 100644 --- a/Terminal.Gui/Text/StringPropertyEventArgs.cs +++ b/Terminal.Gui/Text/StringPropertyEventArgs.cs @@ -1,7 +1,7 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Text; /// Event args for type property events public class StringPropertyEventArgs : CancelEventArgs diff --git a/Terminal.Gui/Text/TextDirection.cs b/Terminal.Gui/Text/TextDirection.cs index 18e889c8b..2ea3ba3a4 100644 --- a/Terminal.Gui/Text/TextDirection.cs +++ b/Terminal.Gui/Text/TextDirection.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Text; /// Text direction enumeration, controls how text is displayed. /// diff --git a/Terminal.Gui/Text/TextFormatter.cs b/Terminal.Gui/Text/TextFormatter.cs index 2478ddc3b..6b1b5256e 100644 --- a/Terminal.Gui/Text/TextFormatter.cs +++ b/Terminal.Gui/Text/TextFormatter.cs @@ -2,7 +2,7 @@ using System.Buffers; using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.Text; /// /// Provides text formatting. Supports s, horizontal and vertical alignment, text direction, diff --git a/Terminal.Gui/View/Adornment/Adornment.cs b/Terminal.Gui/ViewBase/Adornment/Adornment.cs similarity index 99% rename from Terminal.Gui/View/Adornment/Adornment.cs rename to Terminal.Gui/ViewBase/Adornment/Adornment.cs index 3911c1847..19b95bfca 100644 --- a/Terminal.Gui/View/Adornment/Adornment.cs +++ b/Terminal.Gui/ViewBase/Adornment/Adornment.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/View/Adornment/Border.Arrangment.cs b/Terminal.Gui/ViewBase/Adornment/Border.Arrangment.cs similarity index 99% rename from Terminal.Gui/View/Adornment/Border.Arrangment.cs rename to Terminal.Gui/ViewBase/Adornment/Border.Arrangment.cs index 7baccb835..46fdf6891 100644 --- a/Terminal.Gui/View/Adornment/Border.Arrangment.cs +++ b/Terminal.Gui/ViewBase/Adornment/Border.Arrangment.cs @@ -2,7 +2,7 @@ using System.ComponentModel; using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; // Border Arrange Mode diff --git a/Terminal.Gui/View/Adornment/Border.cs b/Terminal.Gui/ViewBase/Adornment/Border.cs similarity index 99% rename from Terminal.Gui/View/Adornment/Border.cs rename to Terminal.Gui/ViewBase/Adornment/Border.cs index 4afd993bc..46a3f894a 100644 --- a/Terminal.Gui/View/Adornment/Border.cs +++ b/Terminal.Gui/ViewBase/Adornment/Border.cs @@ -1,17 +1,17 @@ #nullable enable using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// The Border for a . Accessed via /// /// /// Renders a border around the view with the . A border using -/// will be drawn on the sides of that are greater than zero. +/// will be drawn on the sides of that are greater than zero. /// /// /// The of will be drawn based on the value of -/// : +/// : /// /// // If Thickness.Top is 1: /// ┌┤1234├──┐ diff --git a/Terminal.Gui/View/Adornment/BorderSettings.cs b/Terminal.Gui/ViewBase/Adornment/BorderSettings.cs similarity index 92% rename from Terminal.Gui/View/Adornment/BorderSettings.cs rename to Terminal.Gui/ViewBase/Adornment/BorderSettings.cs index 7b4846d34..516842000 100644 --- a/Terminal.Gui/View/Adornment/BorderSettings.cs +++ b/Terminal.Gui/ViewBase/Adornment/BorderSettings.cs @@ -1,6 +1,6 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Determines the settings for . diff --git a/Terminal.Gui/View/Adornment/Margin.cs b/Terminal.Gui/ViewBase/Adornment/Margin.cs similarity index 96% rename from Terminal.Gui/View/Adornment/Margin.cs rename to Terminal.Gui/ViewBase/Adornment/Margin.cs index 9930a8104..6d14b1c84 100644 --- a/Terminal.Gui/View/Adornment/Margin.cs +++ b/Terminal.Gui/ViewBase/Adornment/Margin.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; /// The Margin for a . Accessed via /// @@ -11,8 +12,8 @@ namespace Terminal.Gui; /// Margins are drawn after all other Views in the application View hierarchy are drawn. /// /// -/// Margins have enabled by default and are thus -/// transparent to the mouse. This can be overridden by explicitly setting . +/// Margins have enabled by default and are thus +/// transparent to the mouse. This can be overridden by explicitly setting . /// /// See the class. /// @@ -42,10 +43,10 @@ public class Margin : Adornment CanFocus = false; // Margins are transparent by default - ViewportSettings |= ViewportSettings.Transparent; + ViewportSettings |= ViewportSettingsFlags.Transparent; // Margins are transparent to mouse by default - ViewportSettings |= ViewportSettings.TransparentMouse; + ViewportSettings |= ViewportSettingsFlags.TransparentMouse; } // When the Parent is drawn, we cache the clip region so we can draw the Margin after all other Views @@ -152,7 +153,7 @@ public class Margin : Adornment /// protected override bool OnDrawingText () { - return ViewportSettings.HasFlag(ViewportSettings.Transparent); + return ViewportSettings.HasFlag(ViewportSettingsFlags.Transparent); } #region Shadow diff --git a/Terminal.Gui/View/Adornment/Padding.cs b/Terminal.Gui/ViewBase/Adornment/Padding.cs similarity index 97% rename from Terminal.Gui/View/Adornment/Padding.cs rename to Terminal.Gui/ViewBase/Adornment/Padding.cs index 8af97c2f2..508670504 100644 --- a/Terminal.Gui/View/Adornment/Padding.cs +++ b/Terminal.Gui/ViewBase/Adornment/Padding.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; /// The Padding for a . Accessed via /// diff --git a/Terminal.Gui/View/Adornment/ShadowStyle.cs b/Terminal.Gui/ViewBase/Adornment/ShadowStyle.cs similarity index 95% rename from Terminal.Gui/View/Adornment/ShadowStyle.cs rename to Terminal.Gui/ViewBase/Adornment/ShadowStyle.cs index 7a95e78ed..6d0fb6b49 100644 --- a/Terminal.Gui/View/Adornment/ShadowStyle.cs +++ b/Terminal.Gui/ViewBase/Adornment/ShadowStyle.cs @@ -1,6 +1,6 @@ using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Defines the style of shadow to be drawn on the right and bottom sides of the . diff --git a/Terminal.Gui/View/Adornment/ShadowView.cs b/Terminal.Gui/ViewBase/Adornment/ShadowView.cs similarity index 97% rename from Terminal.Gui/View/Adornment/ShadowView.cs rename to Terminal.Gui/ViewBase/Adornment/ShadowView.cs index 4a9f8b61c..12f2e08d9 100644 --- a/Terminal.Gui/View/Adornment/ShadowView.cs +++ b/Terminal.Gui/ViewBase/Adornment/ShadowView.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; /// /// Draws a shadow on the right or bottom of the view. Used internally by . @@ -64,7 +65,7 @@ internal class ShadowView : View Visible = value != ShadowStyle.None; _shadowStyle = value; - ViewportSettings |= ViewportSettings.TransparentMouse; + ViewportSettings |= ViewportSettingsFlags.TransparentMouse; } } @@ -162,7 +163,7 @@ internal class ShadowView : View // use the Normal attribute from the View under the shadow. if (newAttribute.Background == Color.DarkGray) { - List currentViewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettings.Transparent); + List currentViewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettingsFlags.Transparent); View? underView = currentViewsUnderMouse!.LastOrDefault (); attr = underView?.GetAttributeForRole (VisualRole.Normal) ?? Attribute.Default; diff --git a/Terminal.Gui/View/CancelEventArgs.cs b/Terminal.Gui/ViewBase/CancelEventArgs.cs similarity index 98% rename from Terminal.Gui/View/CancelEventArgs.cs rename to Terminal.Gui/ViewBase/CancelEventArgs.cs index c41fb5d14..2bdd5c20e 100644 --- a/Terminal.Gui/View/CancelEventArgs.cs +++ b/Terminal.Gui/ViewBase/CancelEventArgs.cs @@ -1,7 +1,7 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; #pragma warning disable CS1711 diff --git a/Terminal.Gui/View/DrawContext.cs b/Terminal.Gui/ViewBase/DrawContext.cs similarity index 93% rename from Terminal.Gui/View/DrawContext.cs rename to Terminal.Gui/ViewBase/DrawContext.cs index 2648caefe..95eec9a2e 100644 --- a/Terminal.Gui/View/DrawContext.cs +++ b/Terminal.Gui/ViewBase/DrawContext.cs @@ -1,9 +1,10 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; /// /// Tracks the region that has been drawn during . This is primarily -/// in support of . +/// in support of . /// public class DrawContext { diff --git a/Terminal.Gui/View/DrawEventArgs.cs b/Terminal.Gui/ViewBase/DrawEventArgs.cs similarity index 89% rename from Terminal.Gui/View/DrawEventArgs.cs rename to Terminal.Gui/ViewBase/DrawEventArgs.cs index b172d85ab..f00bdb618 100644 --- a/Terminal.Gui/View/DrawEventArgs.cs +++ b/Terminal.Gui/ViewBase/DrawEventArgs.cs @@ -1,7 +1,7 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// Event args for draw events public class DrawEventArgs : CancelEventArgs @@ -18,7 +18,7 @@ public class DrawEventArgs : CancelEventArgs /// /// Add any regions that have been drawn to during operations to this context. This is /// primarily - /// in support of . + /// in support of . /// public DrawEventArgs (Rectangle newViewport, Rectangle oldViewport, DrawContext? drawContext) { @@ -36,7 +36,7 @@ public class DrawEventArgs : CancelEventArgs /// /// Add any regions that have been drawn to during operations to this context. This is /// primarily - /// in support of . + /// in support of . /// public DrawContext? DrawContext { get; } } diff --git a/Terminal.Gui/EnumExtensions/AddOrSubtractExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/AddOrSubtractExtensions.cs similarity index 76% rename from Terminal.Gui/EnumExtensions/AddOrSubtractExtensions.cs rename to Terminal.Gui/ViewBase/EnumExtensions/AddOrSubtractExtensions.cs index 8fb98d81c..eef2b4372 100644 --- a/Terminal.Gui/EnumExtensions/AddOrSubtractExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/AddOrSubtractExtensions.cs @@ -5,9 +5,9 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; -namespace Terminal.Gui.EnumExtensions; +namespace Terminal.Gui.ViewBase; -/// Extension methods for the type. +/// Extension methods for the type. [GeneratedCode ("Terminal.Gui.Analyzers.Internal", "1.0")] [CompilerGenerated] [DebuggerNonUserCode] @@ -16,7 +16,7 @@ namespace Terminal.Gui.EnumExtensions; public static class AddOrSubtractExtensions { /// - /// Directly converts this value to an value with the + /// Directly converts this value to an value with the /// same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -24,7 +24,7 @@ public static class AddOrSubtractExtensions public static int AsInt32 (this AddOrSubtract e) => Unsafe.As (ref e); /// - /// Directly converts this value to a value with the + /// Directly converts this value to a value with the /// same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -33,7 +33,7 @@ public static class AddOrSubtractExtensions /// /// Determines if the specified value is explicitly defined as a named value of the - /// type. + /// type. /// /// /// Only explicitly named values return true, as with IsDefined. Combined valid flag values of flags enums which are diff --git a/Terminal.Gui/EnumExtensions/AlignmentExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/AlignmentExtensions.cs similarity index 76% rename from Terminal.Gui/EnumExtensions/AlignmentExtensions.cs rename to Terminal.Gui/ViewBase/EnumExtensions/AlignmentExtensions.cs index 3666d2de5..e94e6b93e 100644 --- a/Terminal.Gui/EnumExtensions/AlignmentExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/AlignmentExtensions.cs @@ -5,9 +5,9 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; -namespace Terminal.Gui.EnumExtensions; +namespace Terminal.Gui.ViewBase; -/// Extension methods for the type. +/// Extension methods for the type. [GeneratedCode ("Terminal.Gui.Analyzers.Internal", "1.0")] [CompilerGenerated] [DebuggerNonUserCode] @@ -16,7 +16,7 @@ namespace Terminal.Gui.EnumExtensions; public static class AlignmentExtensions { /// - /// Directly converts this value to an value with the same + /// Directly converts this value to an value with the same /// binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -24,7 +24,7 @@ public static class AlignmentExtensions public static int AsInt32 (this Alignment e) => Unsafe.As (ref e); /// - /// Directly converts this value to a value with the same + /// Directly converts this value to a value with the same /// binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -33,7 +33,7 @@ public static class AlignmentExtensions /// /// Determines if the specified value is explicitly defined as a named value of the - /// type. + /// type. /// /// /// Only explicitly named values return true, as with IsDefined. Combined valid flag values of flags enums which are diff --git a/Terminal.Gui/EnumExtensions/AlignmentModesExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/AlignmentModesExtensions.cs similarity index 77% rename from Terminal.Gui/EnumExtensions/AlignmentModesExtensions.cs rename to Terminal.Gui/ViewBase/EnumExtensions/AlignmentModesExtensions.cs index 3babe81b6..da91e93df 100644 --- a/Terminal.Gui/EnumExtensions/AlignmentModesExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/AlignmentModesExtensions.cs @@ -5,9 +5,9 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; -namespace Terminal.Gui.EnumExtensions; +namespace Terminal.Gui.ViewBase; -/// Extension methods for the type. +/// Extension methods for the type. [GeneratedCode ("Terminal.Gui.Analyzers.Internal", "1.0")] [CompilerGenerated] [DebuggerNonUserCode] @@ -16,7 +16,7 @@ namespace Terminal.Gui.EnumExtensions; public static class AlignmentModesExtensions { /// - /// Directly converts this value to an value with the + /// Directly converts this value to an value with the /// same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -24,7 +24,7 @@ public static class AlignmentModesExtensions public static int AsInt32 (this AlignmentModes e) => Unsafe.As (ref e); /// - /// Directly converts this value to a value with the + /// Directly converts this value to a value with the /// same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -33,12 +33,12 @@ public static class AlignmentModesExtensions /// /// Determines if the specified flags are set in the current value of this - /// . + /// . /// /// NO VALIDATION IS PERFORMED! /// /// True, if all flags present in are also present in the current value of the - /// .
Otherwise false. + /// .
Otherwise false. /// [MethodImpl (MethodImplOptions.AggressiveInlining)] public static bool FastHasFlags (this AlignmentModes e, AlignmentModes checkFlags) @@ -51,13 +51,13 @@ public static class AlignmentModesExtensions /// /// Determines if the specified mask bits are set in the current value of this - /// . + /// . /// - /// The value to check against the value. + /// The value to check against the value. /// A mask to apply to the current value. /// /// True, if all bits set to 1 in the mask are also set to 1 in the current value of the - /// .
Otherwise false. + /// .
Otherwise false. /// /// NO VALIDATION IS PERFORMED! [MethodImpl (MethodImplOptions.AggressiveInlining)] @@ -70,7 +70,7 @@ public static class AlignmentModesExtensions /// /// Determines if the specified value is explicitly defined as a named value of the - /// type. + /// type. /// /// /// Only explicitly named values return true, as with IsDefined. Combined valid flag values of flags enums which are diff --git a/Terminal.Gui/EnumExtensions/BorderSettingsExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/BorderSettingsExtensions.cs similarity index 77% rename from Terminal.Gui/EnumExtensions/BorderSettingsExtensions.cs rename to Terminal.Gui/ViewBase/EnumExtensions/BorderSettingsExtensions.cs index 074a45976..b908950d6 100644 --- a/Terminal.Gui/EnumExtensions/BorderSettingsExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/BorderSettingsExtensions.cs @@ -5,9 +5,9 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; -namespace Terminal.Gui.EnumExtensions; +namespace Terminal.Gui.ViewBase; -/// Extension methods for the type. +/// Extension methods for the type. [GeneratedCode ("Terminal.Gui.Analyzers.Internal", "1.0")] [CompilerGenerated] [DebuggerNonUserCode] @@ -16,7 +16,7 @@ namespace Terminal.Gui.EnumExtensions; public static class BorderSettingsExtensions { /// - /// Directly converts this value to an value with the + /// Directly converts this value to an value with the /// same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -24,7 +24,7 @@ public static class BorderSettingsExtensions public static int AsInt32 (this BorderSettings e) => Unsafe.As (ref e); /// - /// Directly converts this value to a value with the + /// Directly converts this value to a value with the /// same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -33,12 +33,12 @@ public static class BorderSettingsExtensions /// /// Determines if the specified flags are set in the current value of this - /// . + /// . /// /// NO VALIDATION IS PERFORMED! /// /// True, if all flags present in are also present in the current value of the - /// .
Otherwise false. + /// .
Otherwise false. /// [MethodImpl (MethodImplOptions.AggressiveInlining)] public static bool FastHasFlags (this BorderSettings e, BorderSettings checkFlags) @@ -51,13 +51,13 @@ public static class BorderSettingsExtensions /// /// Determines if the specified mask bits are set in the current value of this - /// . + /// . /// - /// The value to check against the value. + /// The value to check against the value. /// A mask to apply to the current value. /// /// True, if all bits set to 1 in the mask are also set to 1 in the current value of the - /// .
Otherwise false. + /// .
Otherwise false. /// /// NO VALIDATION IS PERFORMED! [MethodImpl (MethodImplOptions.AggressiveInlining)] @@ -70,7 +70,7 @@ public static class BorderSettingsExtensions /// /// Determines if the specified value is explicitly defined as a named value of the - /// type. + /// type. /// /// /// Only explicitly named values return true, as with IsDefined. Combined valid flag values of flags enums which are diff --git a/Terminal.Gui/EnumExtensions/DimAutoStyleExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/DimAutoStyleExtensions.cs similarity index 77% rename from Terminal.Gui/EnumExtensions/DimAutoStyleExtensions.cs rename to Terminal.Gui/ViewBase/EnumExtensions/DimAutoStyleExtensions.cs index 6c0813df8..edccb473e 100644 --- a/Terminal.Gui/EnumExtensions/DimAutoStyleExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/DimAutoStyleExtensions.cs @@ -5,9 +5,9 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; -namespace Terminal.Gui.EnumExtensions; +namespace Terminal.Gui.ViewBase; -/// Extension methods for the type. +/// Extension methods for the type. [GeneratedCode ("Terminal.Gui.Analyzers.Internal", "1.0")] [CompilerGenerated] [DebuggerNonUserCode] @@ -16,7 +16,7 @@ namespace Terminal.Gui.EnumExtensions; public static class DimAutoStyleExtensions { /// - /// Directly converts this value to an value with the + /// Directly converts this value to an value with the /// same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -24,7 +24,7 @@ public static class DimAutoStyleExtensions public static int AsInt32 (this DimAutoStyle e) => Unsafe.As (ref e); /// - /// Directly converts this value to a value with the + /// Directly converts this value to a value with the /// same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -32,13 +32,13 @@ public static class DimAutoStyleExtensions public static uint AsUInt32 (this DimAutoStyle e) => Unsafe.As (ref e); /// - /// Determines if the specified flags are set in the current value of this + /// Determines if the specified flags are set in the current value of this /// . /// /// NO VALIDATION IS PERFORMED! /// /// True, if all flags present in are also present in the current value of the - /// .
Otherwise false. + /// .
Otherwise false. /// [MethodImpl (MethodImplOptions.AggressiveInlining)] public static bool FastHasFlags (this DimAutoStyle e, DimAutoStyle checkFlags) @@ -51,13 +51,13 @@ public static class DimAutoStyleExtensions /// /// Determines if the specified mask bits are set in the current value of this - /// . + /// . /// - /// The value to check against the value. + /// The value to check against the value. /// A mask to apply to the current value. /// /// True, if all bits set to 1 in the mask are also set to 1 in the current value of the - /// .
Otherwise false. + /// .
Otherwise false. /// /// NO VALIDATION IS PERFORMED! [MethodImpl (MethodImplOptions.AggressiveInlining)] @@ -70,7 +70,7 @@ public static class DimAutoStyleExtensions /// /// Determines if the specified value is explicitly defined as a named value of the - /// type. + /// type. /// /// /// Only explicitly named values return true, as with IsDefined. Combined valid flag values of flags enums which are diff --git a/Terminal.Gui/EnumExtensions/DimPercentModeExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/DimPercentModeExtensions.cs similarity index 76% rename from Terminal.Gui/EnumExtensions/DimPercentModeExtensions.cs rename to Terminal.Gui/ViewBase/EnumExtensions/DimPercentModeExtensions.cs index 2fc943f17..f6a62db75 100644 --- a/Terminal.Gui/EnumExtensions/DimPercentModeExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/DimPercentModeExtensions.cs @@ -5,9 +5,9 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; -namespace Terminal.Gui.EnumExtensions; +namespace Terminal.Gui.ViewBase; -/// Extension methods for the type. +/// Extension methods for the type. [GeneratedCode ("Terminal.Gui.Analyzers.Internal", "1.0")] [CompilerGenerated] [DebuggerNonUserCode] @@ -16,7 +16,7 @@ namespace Terminal.Gui.EnumExtensions; public static class DimPercentModeExtensions { /// - /// Directly converts this value to an value with the + /// Directly converts this value to an value with the /// same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -24,7 +24,7 @@ public static class DimPercentModeExtensions public static int AsInt32 (this DimPercentMode e) => Unsafe.As (ref e); /// - /// Directly converts this value to a value with the + /// Directly converts this value to a value with the /// same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -33,7 +33,7 @@ public static class DimPercentModeExtensions /// /// Determines if the specified value is explicitly defined as a named value of the - /// type. + /// type. /// /// /// Only explicitly named values return true, as with IsDefined. Combined valid flag values of flags enums which are diff --git a/Terminal.Gui/EnumExtensions/DimensionExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/DimensionExtensions.cs similarity index 76% rename from Terminal.Gui/EnumExtensions/DimensionExtensions.cs rename to Terminal.Gui/ViewBase/EnumExtensions/DimensionExtensions.cs index ccbfbf5ed..0a217e1a8 100644 --- a/Terminal.Gui/EnumExtensions/DimensionExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/DimensionExtensions.cs @@ -5,9 +5,9 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; -namespace Terminal.Gui.EnumExtensions; +namespace Terminal.Gui.ViewBase; -/// Extension methods for the type. +/// Extension methods for the type. [GeneratedCode ("Terminal.Gui.Analyzers.Internal", "1.0")] [CompilerGenerated] [DebuggerNonUserCode] @@ -15,7 +15,7 @@ namespace Terminal.Gui.EnumExtensions; public static class DimensionExtensions { /// - /// Directly converts this value to an value with the same + /// Directly converts this value to an value with the same /// binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -23,7 +23,7 @@ public static class DimensionExtensions public static int AsInt32 (this Dimension e) => Unsafe.As (ref e); /// - /// Directly converts this value to a value with the same + /// Directly converts this value to a value with the same /// binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -32,7 +32,7 @@ public static class DimensionExtensions /// /// Determines if the specified value is explicitly defined as a named value of the - /// type. + /// type. /// /// /// Only explicitly named values return true, as with IsDefined. Combined valid flag values of flags enums which are diff --git a/Terminal.Gui/EnumExtensions/SideExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/SideExtensions.cs similarity index 76% rename from Terminal.Gui/EnumExtensions/SideExtensions.cs rename to Terminal.Gui/ViewBase/EnumExtensions/SideExtensions.cs index b50e12bdc..f7a2a548f 100644 --- a/Terminal.Gui/EnumExtensions/SideExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/SideExtensions.cs @@ -5,9 +5,9 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; -namespace Terminal.Gui.EnumExtensions; +namespace Terminal.Gui.ViewBase; -/// Extension methods for the type. +/// Extension methods for the type. [GeneratedCode ("Terminal.Gui.Analyzers.Internal", "1.0")] [CompilerGenerated] [DebuggerNonUserCode] @@ -16,7 +16,7 @@ namespace Terminal.Gui.EnumExtensions; public static class SideExtensions { /// - /// Directly converts this value to an value with the same binary + /// Directly converts this value to an value with the same binary /// representation. /// /// NO VALIDATION IS PERFORMED! @@ -24,7 +24,7 @@ public static class SideExtensions public static int AsInt32 (this Side e) => Unsafe.As (ref e); /// - /// Directly converts this value to a value with the same binary + /// Directly converts this value to a value with the same binary /// representation. /// /// NO VALIDATION IS PERFORMED! @@ -33,7 +33,7 @@ public static class SideExtensions /// /// Determines if the specified value is explicitly defined as a named value of the - /// type. + /// type. /// /// /// Only explicitly named values return true, as with IsDefined. Combined valid flag values of flags enums which are diff --git a/Terminal.Gui/EnumExtensions/ViewDiagnosticFlagsExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/ViewDiagnosticFlagsExtensions.cs similarity index 77% rename from Terminal.Gui/EnumExtensions/ViewDiagnosticFlagsExtensions.cs rename to Terminal.Gui/ViewBase/EnumExtensions/ViewDiagnosticFlagsExtensions.cs index 1aa18fe72..e0d089184 100644 --- a/Terminal.Gui/EnumExtensions/ViewDiagnosticFlagsExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/ViewDiagnosticFlagsExtensions.cs @@ -5,9 +5,9 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; -namespace Terminal.Gui.EnumExtensions; +namespace Terminal.Gui.ViewBase; -/// Extension methods for the type. +/// Extension methods for the type. [GeneratedCode ("Terminal.Gui.Analyzers.Internal", "1.0")] [CompilerGenerated] [DebuggerNonUserCode] @@ -16,7 +16,7 @@ namespace Terminal.Gui.EnumExtensions; public static class ViewDiagnosticFlagsExtensions { /// - /// Directly converts this value to an value with + /// Directly converts this value to an value with /// the same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -24,7 +24,7 @@ public static class ViewDiagnosticFlagsExtensions public static int AsInt32 (this ViewDiagnosticFlags e) => Unsafe.As (ref e); /// - /// Directly converts this value to a value with + /// Directly converts this value to a value with /// the same binary representation. /// /// NO VALIDATION IS PERFORMED! @@ -33,12 +33,12 @@ public static class ViewDiagnosticFlagsExtensions /// /// Determines if the specified flags are set in the current value of this - /// . + /// . /// /// NO VALIDATION IS PERFORMED! /// /// True, if all flags present in are also present in the current value of the - /// .
Otherwise false. + /// .
Otherwise false. /// [MethodImpl (MethodImplOptions.AggressiveInlining)] public static bool FastHasFlags (this ViewDiagnosticFlags e, ViewDiagnosticFlags checkFlags) @@ -51,16 +51,16 @@ public static class ViewDiagnosticFlagsExtensions /// /// Determines if the specified mask bits are set in the current value of this - /// . + /// . /// /// - /// The value to check against the + /// The value to check against the /// value. /// /// A mask to apply to the current value. /// /// True, if all bits set to 1 in the mask are also set to 1 in the current value of the - /// .
Otherwise false. + /// .
Otherwise false. /// /// NO VALIDATION IS PERFORMED! [MethodImpl (MethodImplOptions.AggressiveInlining)] @@ -73,7 +73,7 @@ public static class ViewDiagnosticFlagsExtensions /// /// Determines if the specified value is explicitly defined as a named value of the - /// type. + /// type. /// /// /// Only explicitly named values return true, as with IsDefined. Combined valid flag values of flags enums which are diff --git a/Terminal.Gui/View/EventArgs.cs b/Terminal.Gui/ViewBase/EventArgs.cs similarity index 95% rename from Terminal.Gui/View/EventArgs.cs rename to Terminal.Gui/ViewBase/EventArgs.cs index 1de2347c6..2ddba6383 100644 --- a/Terminal.Gui/View/EventArgs.cs +++ b/Terminal.Gui/ViewBase/EventArgs.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; #pragma warning disable CS1711 /// diff --git a/Terminal.Gui/StackExtensions.cs b/Terminal.Gui/ViewBase/Helpers/StackExtensions.cs similarity index 99% rename from Terminal.Gui/StackExtensions.cs rename to Terminal.Gui/ViewBase/Helpers/StackExtensions.cs index b3e7c01d8..96201df73 100644 --- a/Terminal.Gui/StackExtensions.cs +++ b/Terminal.Gui/ViewBase/Helpers/StackExtensions.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// Extension of helper to work with specific public static class StackExtensions diff --git a/Terminal.Gui/View/HighlightStyle.cs b/Terminal.Gui/ViewBase/HighlightStyle.cs similarity index 95% rename from Terminal.Gui/View/HighlightStyle.cs rename to Terminal.Gui/ViewBase/HighlightStyle.cs index 391eeb910..8c2993761 100644 --- a/Terminal.Gui/View/HighlightStyle.cs +++ b/Terminal.Gui/ViewBase/HighlightStyle.cs @@ -1,6 +1,6 @@ using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Describes the highlight style of a view when the mouse is over it. diff --git a/Terminal.Gui/View/IDesignable.cs b/Terminal.Gui/ViewBase/IDesignable.cs similarity index 96% rename from Terminal.Gui/View/IDesignable.cs rename to Terminal.Gui/ViewBase/IDesignable.cs index 13d8cbae6..382bdd91b 100644 --- a/Terminal.Gui/View/IDesignable.cs +++ b/Terminal.Gui/ViewBase/IDesignable.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Interface declaring common functionality useful for designer implementations. diff --git a/Terminal.Gui/View/Layout/AddOrSubtract.cs b/Terminal.Gui/ViewBase/Layout/AddOrSubtract.cs similarity index 90% rename from Terminal.Gui/View/Layout/AddOrSubtract.cs rename to Terminal.Gui/ViewBase/Layout/AddOrSubtract.cs index 83d1dd12c..1783f91f3 100644 --- a/Terminal.Gui/View/Layout/AddOrSubtract.cs +++ b/Terminal.Gui/ViewBase/Layout/AddOrSubtract.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Describes whether an operation should add or subtract values. diff --git a/Terminal.Gui/Drawing/Aligner.cs b/Terminal.Gui/ViewBase/Layout/Aligner.cs similarity index 99% rename from Terminal.Gui/Drawing/Aligner.cs rename to Terminal.Gui/ViewBase/Layout/Aligner.cs index 47b4109f8..72aae7ad5 100644 --- a/Terminal.Gui/Drawing/Aligner.cs +++ b/Terminal.Gui/ViewBase/Layout/Aligner.cs @@ -1,9 +1,9 @@ using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// -/// Aligns items within a container based on the specified . Both horizontal and vertical +/// Aligns items within a container based on the specified . Both horizontal and vertical /// alignments are supported. /// public class Aligner : INotifyPropertyChanged diff --git a/Terminal.Gui/Drawing/Alignment.cs b/Terminal.Gui/ViewBase/Layout/Alignment.cs similarity index 98% rename from Terminal.Gui/Drawing/Alignment.cs rename to Terminal.Gui/ViewBase/Layout/Alignment.cs index 4e2338f55..46f052727 100644 --- a/Terminal.Gui/Drawing/Alignment.cs +++ b/Terminal.Gui/ViewBase/Layout/Alignment.cs @@ -1,6 +1,6 @@ using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Determines the position of items when arranged in a container. diff --git a/Terminal.Gui/Drawing/AlignmentModes.cs b/Terminal.Gui/ViewBase/Layout/AlignmentModes.cs similarity index 97% rename from Terminal.Gui/Drawing/AlignmentModes.cs rename to Terminal.Gui/ViewBase/Layout/AlignmentModes.cs index d06dbf6be..7543b3943 100644 --- a/Terminal.Gui/Drawing/AlignmentModes.cs +++ b/Terminal.Gui/ViewBase/Layout/AlignmentModes.cs @@ -1,6 +1,6 @@ using System.Text.Json.Serialization; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Determines alignment modes for . diff --git a/Terminal.Gui/View/Layout/Dim.cs b/Terminal.Gui/ViewBase/Layout/Dim.cs similarity index 99% rename from Terminal.Gui/View/Layout/Dim.cs rename to Terminal.Gui/ViewBase/Layout/Dim.cs index 072fc77bf..83cc2e42e 100644 --- a/Terminal.Gui/View/Layout/Dim.cs +++ b/Terminal.Gui/ViewBase/Layout/Dim.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; using System.Numerics; diff --git a/Terminal.Gui/View/Layout/DimAbsolute.cs b/Terminal.Gui/ViewBase/Layout/DimAbsolute.cs similarity index 96% rename from Terminal.Gui/View/Layout/DimAbsolute.cs rename to Terminal.Gui/ViewBase/Layout/DimAbsolute.cs index cb078a121..6fd9e8072 100644 --- a/Terminal.Gui/View/Layout/DimAbsolute.cs +++ b/Terminal.Gui/ViewBase/Layout/DimAbsolute.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a dimension that is a fixed size. diff --git a/Terminal.Gui/View/Layout/DimAuto.cs b/Terminal.Gui/ViewBase/Layout/DimAuto.cs similarity index 99% rename from Terminal.Gui/View/Layout/DimAuto.cs rename to Terminal.Gui/ViewBase/Layout/DimAuto.cs index f1f610f33..6974fd45b 100644 --- a/Terminal.Gui/View/Layout/DimAuto.cs +++ b/Terminal.Gui/ViewBase/Layout/DimAuto.cs @@ -1,7 +1,7 @@ #nullable enable using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a dimension that automatically sizes the view to fit all the view's Content, SubViews, and/or Text. diff --git a/Terminal.Gui/View/Layout/DimAutoStyle.cs b/Terminal.Gui/ViewBase/Layout/DimAutoStyle.cs similarity index 98% rename from Terminal.Gui/View/Layout/DimAutoStyle.cs rename to Terminal.Gui/ViewBase/Layout/DimAutoStyle.cs index efd2b4b33..d3080dd94 100644 --- a/Terminal.Gui/View/Layout/DimAutoStyle.cs +++ b/Terminal.Gui/ViewBase/Layout/DimAutoStyle.cs @@ -1,6 +1,6 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Specifies how will compute the dimension. diff --git a/Terminal.Gui/View/Layout/DimCombine.cs b/Terminal.Gui/ViewBase/Layout/DimCombine.cs similarity index 98% rename from Terminal.Gui/View/Layout/DimCombine.cs rename to Terminal.Gui/ViewBase/Layout/DimCombine.cs index 7a5d23614..3bf3b3534 100644 --- a/Terminal.Gui/View/Layout/DimCombine.cs +++ b/Terminal.Gui/ViewBase/Layout/DimCombine.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a dimension that is a combination of two other dimensions. diff --git a/Terminal.Gui/View/Layout/DimFill.cs b/Terminal.Gui/ViewBase/Layout/DimFill.cs similarity index 95% rename from Terminal.Gui/View/Layout/DimFill.cs rename to Terminal.Gui/ViewBase/Layout/DimFill.cs index a32031ca5..0e278cbc5 100644 --- a/Terminal.Gui/View/Layout/DimFill.cs +++ b/Terminal.Gui/ViewBase/Layout/DimFill.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a dimension that fills the dimension, leaving the specified margin. diff --git a/Terminal.Gui/View/Layout/DimFunc.cs b/Terminal.Gui/ViewBase/Layout/DimFunc.cs similarity index 72% rename from Terminal.Gui/View/Layout/DimFunc.cs rename to Terminal.Gui/ViewBase/Layout/DimFunc.cs index 5fbc28dc2..9047bd96b 100644 --- a/Terminal.Gui/View/Layout/DimFunc.cs +++ b/Terminal.Gui/ViewBase/Layout/DimFunc.cs @@ -1,12 +1,12 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// -/// Represents a function object that computes the dimension by executing the provided function. +/// Represents a function object that computes the dimension by executing the provided function. /// /// /// This is a low-level API that is typically used internally by the layout system. Use the various static -/// methods on the class to create objects instead. +/// methods on the class to create objects instead. /// /// The function that computes the dimension. If this function throws ... public record DimFunc (Func Fn) : Dim diff --git a/Terminal.Gui/View/Layout/DimPercent.cs b/Terminal.Gui/ViewBase/Layout/DimPercent.cs similarity index 97% rename from Terminal.Gui/View/Layout/DimPercent.cs rename to Terminal.Gui/ViewBase/Layout/DimPercent.cs index e94be76a7..499ffb6fd 100644 --- a/Terminal.Gui/View/Layout/DimPercent.cs +++ b/Terminal.Gui/ViewBase/Layout/DimPercent.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a dimension that is a percentage of the width or height of the SuperView. diff --git a/Terminal.Gui/View/Layout/DimPercentMode.cs b/Terminal.Gui/ViewBase/Layout/DimPercentMode.cs similarity index 92% rename from Terminal.Gui/View/Layout/DimPercentMode.cs rename to Terminal.Gui/ViewBase/Layout/DimPercentMode.cs index 10077848b..3f9aed836 100644 --- a/Terminal.Gui/View/Layout/DimPercentMode.cs +++ b/Terminal.Gui/ViewBase/Layout/DimPercentMode.cs @@ -1,6 +1,6 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Indicates the mode for a object. diff --git a/Terminal.Gui/View/Layout/DimView.cs b/Terminal.Gui/ViewBase/Layout/DimView.cs similarity index 97% rename from Terminal.Gui/View/Layout/DimView.cs rename to Terminal.Gui/ViewBase/Layout/DimView.cs index b37f9bb7e..0a25e1983 100644 --- a/Terminal.Gui/View/Layout/DimView.cs +++ b/Terminal.Gui/ViewBase/Layout/DimView.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a dimension that tracks the Height or Width of the specified View. diff --git a/Terminal.Gui/View/Layout/Dimension.cs b/Terminal.Gui/ViewBase/Layout/Dimension.cs similarity index 92% rename from Terminal.Gui/View/Layout/Dimension.cs rename to Terminal.Gui/ViewBase/Layout/Dimension.cs index 8cfb3f7f0..5fae94360 100644 --- a/Terminal.Gui/View/Layout/Dimension.cs +++ b/Terminal.Gui/ViewBase/Layout/Dimension.cs @@ -1,6 +1,6 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Indicates the dimension for operations. diff --git a/Terminal.Gui/View/Layout/LayoutEventArgs.cs b/Terminal.Gui/ViewBase/Layout/LayoutEventArgs.cs similarity index 76% rename from Terminal.Gui/View/Layout/LayoutEventArgs.cs rename to Terminal.Gui/ViewBase/Layout/LayoutEventArgs.cs index 200ef2461..02cc3f5fd 100644 --- a/Terminal.Gui/View/Layout/LayoutEventArgs.cs +++ b/Terminal.Gui/ViewBase/Layout/LayoutEventArgs.cs @@ -1,9 +1,9 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// Event arguments for the event. public class LayoutEventArgs : EventArgs { - /// Creates a new instance of the class. + /// Creates a new instance of the class. /// The view that the event is about. public LayoutEventArgs (Size oldContentSize) { OldContentSize = oldContentSize; } diff --git a/Terminal.Gui/View/Layout/LayoutException.cs b/Terminal.Gui/ViewBase/Layout/LayoutException.cs similarity index 96% rename from Terminal.Gui/View/Layout/LayoutException.cs rename to Terminal.Gui/ViewBase/Layout/LayoutException.cs index 389b5a5ce..e21dc51f8 100644 --- a/Terminal.Gui/View/Layout/LayoutException.cs +++ b/Terminal.Gui/ViewBase/Layout/LayoutException.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents an exception that is thrown when a layout operation fails. diff --git a/Terminal.Gui/View/Layout/Pos.cs b/Terminal.Gui/ViewBase/Layout/Pos.cs similarity index 96% rename from Terminal.Gui/View/Layout/Pos.cs rename to Terminal.Gui/ViewBase/Layout/Pos.cs index 6ffe9b8d9..f213e0941 100644 --- a/Terminal.Gui/View/Layout/Pos.cs +++ b/Terminal.Gui/ViewBase/Layout/Pos.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; /// /// Describes the position of a which can be an absolute value, a percentage, centered, or @@ -351,9 +352,9 @@ public abstract record Pos #region operators - /// Adds a to a , yielding a new . - /// The first to add. - /// The second to add. + /// Adds a to a , yielding a new . + /// The first to add. + /// The second to add. /// The that is the sum of the values of left and right. public static Pos operator + (Pos left, Pos right) { @@ -378,11 +379,11 @@ public abstract record Pos public static implicit operator Pos (int n) { return new PosAbsolute (n); } /// - /// Subtracts a from a , yielding a new + /// Subtracts a from a , yielding a new /// . /// - /// The to subtract from (the minuend). - /// The to subtract (the subtrahend). + /// The to subtract from (the minuend). + /// The to subtract (the subtrahend). /// The that is the left minus right. public static Pos operator - (Pos left, Pos right) { diff --git a/Terminal.Gui/View/Layout/PosAbsolute.cs b/Terminal.Gui/ViewBase/Layout/PosAbsolute.cs similarity index 96% rename from Terminal.Gui/View/Layout/PosAbsolute.cs rename to Terminal.Gui/ViewBase/Layout/PosAbsolute.cs index b71da5013..b21711355 100644 --- a/Terminal.Gui/View/Layout/PosAbsolute.cs +++ b/Terminal.Gui/ViewBase/Layout/PosAbsolute.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents an absolute position in the layout. This is used to specify a fixed position in the layout. diff --git a/Terminal.Gui/View/Layout/PosAlign.cs b/Terminal.Gui/ViewBase/Layout/PosAlign.cs similarity index 99% rename from Terminal.Gui/View/Layout/PosAlign.cs rename to Terminal.Gui/ViewBase/Layout/PosAlign.cs index 14e2470b0..82187c573 100644 --- a/Terminal.Gui/View/Layout/PosAlign.cs +++ b/Terminal.Gui/ViewBase/Layout/PosAlign.cs @@ -2,7 +2,7 @@ using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Enables alignment of a set of views. diff --git a/Terminal.Gui/View/Layout/PosAnchorEnd.cs b/Terminal.Gui/ViewBase/Layout/PosAnchorEnd.cs similarity index 98% rename from Terminal.Gui/View/Layout/PosAnchorEnd.cs rename to Terminal.Gui/ViewBase/Layout/PosAnchorEnd.cs index 3b66923ff..3cf2195ac 100644 --- a/Terminal.Gui/View/Layout/PosAnchorEnd.cs +++ b/Terminal.Gui/ViewBase/Layout/PosAnchorEnd.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a position anchored to the end (right side or bottom). diff --git a/Terminal.Gui/View/Layout/PosCenter.cs b/Terminal.Gui/ViewBase/Layout/PosCenter.cs similarity index 94% rename from Terminal.Gui/View/Layout/PosCenter.cs rename to Terminal.Gui/ViewBase/Layout/PosCenter.cs index 1d7cdc1e1..4a7945cd2 100644 --- a/Terminal.Gui/View/Layout/PosCenter.cs +++ b/Terminal.Gui/ViewBase/Layout/PosCenter.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a position that is centered. diff --git a/Terminal.Gui/View/Layout/PosCombine.cs b/Terminal.Gui/ViewBase/Layout/PosCombine.cs similarity index 98% rename from Terminal.Gui/View/Layout/PosCombine.cs rename to Terminal.Gui/ViewBase/Layout/PosCombine.cs index 884bb2704..833b499f0 100644 --- a/Terminal.Gui/View/Layout/PosCombine.cs +++ b/Terminal.Gui/ViewBase/Layout/PosCombine.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a position that is a combination of two other positions. diff --git a/Terminal.Gui/View/Layout/PosFunc.cs b/Terminal.Gui/ViewBase/Layout/PosFunc.cs similarity index 93% rename from Terminal.Gui/View/Layout/PosFunc.cs rename to Terminal.Gui/ViewBase/Layout/PosFunc.cs index cb7f99c14..a55ff6647 100644 --- a/Terminal.Gui/View/Layout/PosFunc.cs +++ b/Terminal.Gui/ViewBase/Layout/PosFunc.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a position that is computed by executing a function that returns an integer position. diff --git a/Terminal.Gui/View/Layout/PosPercent.cs b/Terminal.Gui/ViewBase/Layout/PosPercent.cs similarity index 96% rename from Terminal.Gui/View/Layout/PosPercent.cs rename to Terminal.Gui/ViewBase/Layout/PosPercent.cs index 17b99cb69..98505dd3b 100644 --- a/Terminal.Gui/View/Layout/PosPercent.cs +++ b/Terminal.Gui/ViewBase/Layout/PosPercent.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a position that is a percentage of the width or height of the SuperView. diff --git a/Terminal.Gui/View/Layout/PosView.cs b/Terminal.Gui/ViewBase/Layout/PosView.cs similarity index 98% rename from Terminal.Gui/View/Layout/PosView.cs rename to Terminal.Gui/ViewBase/Layout/PosView.cs index 9e6a3d7c6..fb7f7266a 100644 --- a/Terminal.Gui/View/Layout/PosView.cs +++ b/Terminal.Gui/ViewBase/Layout/PosView.cs @@ -1,7 +1,7 @@ #nullable enable using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Represents a position that is anchored to the side of another view. diff --git a/Terminal.Gui/View/Layout/Side.cs b/Terminal.Gui/ViewBase/Layout/Side.cs similarity index 93% rename from Terminal.Gui/View/Layout/Side.cs rename to Terminal.Gui/ViewBase/Layout/Side.cs index afdc5640e..b2256faac 100644 --- a/Terminal.Gui/View/Layout/Side.cs +++ b/Terminal.Gui/ViewBase/Layout/Side.cs @@ -1,6 +1,6 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Indicates the side for operations. diff --git a/Terminal.Gui/View/Layout/SizeChangedEventArgs.cs b/Terminal.Gui/ViewBase/Layout/SizeChangedEventArgs.cs similarity index 94% rename from Terminal.Gui/View/Layout/SizeChangedEventArgs.cs rename to Terminal.Gui/ViewBase/Layout/SizeChangedEventArgs.cs index 4e2f20297..8c4f9d6f6 100644 --- a/Terminal.Gui/View/Layout/SizeChangedEventArgs.cs +++ b/Terminal.Gui/ViewBase/Layout/SizeChangedEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// Args for events about Size (e.g. Resized) public class SizeChangedEventArgs : EventArgs diff --git a/Terminal.Gui/View/SuperViewChangedEventArgs.cs b/Terminal.Gui/ViewBase/Layout/SuperViewChangedEventArgs.cs similarity index 95% rename from Terminal.Gui/View/SuperViewChangedEventArgs.cs rename to Terminal.Gui/ViewBase/Layout/SuperViewChangedEventArgs.cs index c3406ff6a..f1e79536d 100644 --- a/Terminal.Gui/View/SuperViewChangedEventArgs.cs +++ b/Terminal.Gui/ViewBase/Layout/SuperViewChangedEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Args for events where the of a is changed (e.g. diff --git a/Terminal.Gui/View/ViewArrangement.cs b/Terminal.Gui/ViewBase/Layout/ViewArrangement.cs similarity index 98% rename from Terminal.Gui/View/ViewArrangement.cs rename to Terminal.Gui/ViewBase/Layout/ViewArrangement.cs index b43703ec2..63a735c4b 100644 --- a/Terminal.Gui/View/ViewArrangement.cs +++ b/Terminal.Gui/ViewBase/Layout/ViewArrangement.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Describes what user actions are enabled for arranging a within it's diff --git a/Terminal.Gui/View/Navigation/AdvanceFocusEventArgs.cs b/Terminal.Gui/ViewBase/Navigation/AdvanceFocusEventArgs.cs similarity index 94% rename from Terminal.Gui/View/Navigation/AdvanceFocusEventArgs.cs rename to Terminal.Gui/ViewBase/Navigation/AdvanceFocusEventArgs.cs index fd3a64951..7daa314c9 100644 --- a/Terminal.Gui/View/Navigation/AdvanceFocusEventArgs.cs +++ b/Terminal.Gui/ViewBase/Navigation/AdvanceFocusEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// The event arguments for events. public class AdvanceFocusEventArgs : CancelEventArgs diff --git a/Terminal.Gui/View/Navigation/FocusEventArgs.cs b/Terminal.Gui/ViewBase/Navigation/FocusEventArgs.cs similarity index 96% rename from Terminal.Gui/View/Navigation/FocusEventArgs.cs rename to Terminal.Gui/ViewBase/Navigation/FocusEventArgs.cs index c895e4e88..9149c2680 100644 --- a/Terminal.Gui/View/Navigation/FocusEventArgs.cs +++ b/Terminal.Gui/ViewBase/Navigation/FocusEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// The event arguments for events. public class HasFocusEventArgs : CancelEventArgs diff --git a/Terminal.Gui/View/NavigationDirection.cs b/Terminal.Gui/ViewBase/Navigation/NavigationDirection.cs similarity index 87% rename from Terminal.Gui/View/NavigationDirection.cs rename to Terminal.Gui/ViewBase/Navigation/NavigationDirection.cs index b47995f9d..7030b4231 100644 --- a/Terminal.Gui/View/NavigationDirection.cs +++ b/Terminal.Gui/ViewBase/Navigation/NavigationDirection.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Indicates navigation direction. diff --git a/Terminal.Gui/View/Navigation/TabBehavior.cs b/Terminal.Gui/ViewBase/Navigation/TabBehavior.cs similarity index 96% rename from Terminal.Gui/View/Navigation/TabBehavior.cs rename to Terminal.Gui/ViewBase/Navigation/TabBehavior.cs index ba8b189c9..859cce17a 100644 --- a/Terminal.Gui/View/Navigation/TabBehavior.cs +++ b/Terminal.Gui/ViewBase/Navigation/TabBehavior.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Describes how behaves. A TabStop is a stop-point for keyboard navigation between Views. diff --git a/Terminal.Gui/View/Orientation/IOrientation.cs b/Terminal.Gui/ViewBase/Orientation/IOrientation.cs similarity index 97% rename from Terminal.Gui/View/Orientation/IOrientation.cs rename to Terminal.Gui/ViewBase/Orientation/IOrientation.cs index db76a6f83..4f86d21dd 100644 --- a/Terminal.Gui/View/Orientation/IOrientation.cs +++ b/Terminal.Gui/ViewBase/Orientation/IOrientation.cs @@ -1,6 +1,6 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; using System; /// diff --git a/Terminal.Gui/View/Orientation/Orientation.cs b/Terminal.Gui/ViewBase/Orientation/Orientation.cs similarity index 87% rename from Terminal.Gui/View/Orientation/Orientation.cs rename to Terminal.Gui/ViewBase/Orientation/Orientation.cs index 480bb435c..fa4c766ee 100644 --- a/Terminal.Gui/View/Orientation/Orientation.cs +++ b/Terminal.Gui/ViewBase/Orientation/Orientation.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// Direction of an element (horizontal or vertical) public enum Orientation diff --git a/Terminal.Gui/View/Orientation/OrientationHelper.cs b/Terminal.Gui/ViewBase/Orientation/OrientationHelper.cs similarity index 99% rename from Terminal.Gui/View/Orientation/OrientationHelper.cs rename to Terminal.Gui/ViewBase/Orientation/OrientationHelper.cs index 380dfbb53..4aa98cfe4 100644 --- a/Terminal.Gui/View/Orientation/OrientationHelper.cs +++ b/Terminal.Gui/ViewBase/Orientation/OrientationHelper.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Helper class for implementing . diff --git a/Terminal.Gui/View/View.Adornments.cs b/Terminal.Gui/ViewBase/View.Adornments.cs similarity index 99% rename from Terminal.Gui/View/View.Adornments.cs rename to Terminal.Gui/ViewBase/View.Adornments.cs index 44b53f973..de0ca20a1 100644 --- a/Terminal.Gui/View/View.Adornments.cs +++ b/Terminal.Gui/ViewBase/View.Adornments.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; public partial class View // Adornments { diff --git a/Terminal.Gui/View/View.Arrangement.cs b/Terminal.Gui/ViewBase/View.Arrangement.cs similarity index 93% rename from Terminal.Gui/View/View.Arrangement.cs rename to Terminal.Gui/ViewBase/View.Arrangement.cs index e11b1d389..a0d1e01f7 100644 --- a/Terminal.Gui/View/View.Arrangement.cs +++ b/Terminal.Gui/ViewBase/View.Arrangement.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; public partial class View { diff --git a/Terminal.Gui/View/View.Command.cs b/Terminal.Gui/ViewBase/View.Command.cs similarity index 99% rename from Terminal.Gui/View/View.Command.cs rename to Terminal.Gui/ViewBase/View.Command.cs index a11fa8063..deaa709f3 100644 --- a/Terminal.Gui/View/View.Command.cs +++ b/Terminal.Gui/ViewBase/View.Command.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; public partial class View // Command APIs { diff --git a/Terminal.Gui/View/View.Content.cs b/Terminal.Gui/ViewBase/View.Content.cs similarity index 96% rename from Terminal.Gui/View/View.Content.cs rename to Terminal.Gui/ViewBase/View.Content.cs index 780dc51b3..f8b19d93b 100644 --- a/Terminal.Gui/View/View.Content.cs +++ b/Terminal.Gui/ViewBase/View.Content.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; public partial class View { @@ -268,12 +269,12 @@ public partial class View #region Viewport - private ViewportSettings _viewportSettings; + private ViewportSettingsFlags _viewportSettings; /// /// Gets or sets how scrolling the on the View's Content Area is handled. /// - public ViewportSettings ViewportSettings + public ViewportSettingsFlags ViewportSettings { get => _viewportSettings; set @@ -402,7 +403,7 @@ public partial class View void ApplySettings (ref Rectangle newViewport) { - if (!ViewportSettings.HasFlag (ViewportSettings.AllowXGreaterThanContentWidth)) + if (!ViewportSettings.HasFlag (ViewportSettingsFlags.AllowXGreaterThanContentWidth)) { if (newViewport.X >= GetContentSize ().Width) { @@ -411,7 +412,7 @@ public partial class View } // IMPORTANT: Check for negative location AFTER checking for location greater than content width - if (!ViewportSettings.HasFlag (ViewportSettings.AllowNegativeX)) + if (!ViewportSettings.HasFlag (ViewportSettingsFlags.AllowNegativeX)) { if (newViewport.X < 0) { @@ -419,7 +420,7 @@ public partial class View } } - if (!ViewportSettings.HasFlag (ViewportSettings.AllowNegativeXWhenWidthGreaterThanContentWidth)) + if (!ViewportSettings.HasFlag (ViewportSettingsFlags.AllowNegativeXWhenWidthGreaterThanContentWidth)) { if (Viewport.Width > GetContentSize ().Width) { @@ -427,7 +428,7 @@ public partial class View } } - if (!ViewportSettings.HasFlag (ViewportSettings.AllowYGreaterThanContentHeight)) + if (!ViewportSettings.HasFlag (ViewportSettingsFlags.AllowYGreaterThanContentHeight)) { if (newViewport.Y >= GetContentSize ().Height) { @@ -435,7 +436,7 @@ public partial class View } } - if (!ViewportSettings.HasFlag (ViewportSettings.AllowNegativeYWhenHeightGreaterThanContentHeight)) + if (!ViewportSettings.HasFlag (ViewportSettingsFlags.AllowNegativeYWhenHeightGreaterThanContentHeight)) { if (Viewport.Height > GetContentSize ().Height) { @@ -444,7 +445,7 @@ public partial class View } // IMPORTANT: Check for negative location AFTER checking for location greater than content width - if (!ViewportSettings.HasFlag (ViewportSettings.AllowNegativeY)) + if (!ViewportSettings.HasFlag (ViewportSettingsFlags.AllowNegativeY)) { if (newViewport.Y < 0) { diff --git a/Terminal.Gui/View/View.Cursor.cs b/Terminal.Gui/ViewBase/View.Cursor.cs similarity index 94% rename from Terminal.Gui/View/View.Cursor.cs rename to Terminal.Gui/ViewBase/View.Cursor.cs index 700398526..daaf75d69 100644 --- a/Terminal.Gui/View/View.Cursor.cs +++ b/Terminal.Gui/ViewBase/View.Cursor.cs @@ -1,11 +1,12 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; public partial class View { /// /// Gets or sets the cursor style to be used when the view is focused. The default is - /// . + /// . /// public CursorVisibility CursorVisibility { get; set; } = CursorVisibility.Invisible; diff --git a/Terminal.Gui/View/View.Diagnostics.cs b/Terminal.Gui/ViewBase/View.Diagnostics.cs similarity index 94% rename from Terminal.Gui/View/View.Diagnostics.cs rename to Terminal.Gui/ViewBase/View.Diagnostics.cs index d935fe283..d920ef4bf 100644 --- a/Terminal.Gui/View/View.Diagnostics.cs +++ b/Terminal.Gui/ViewBase/View.Diagnostics.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; public partial class View { diff --git a/Terminal.Gui/View/View.Drawing.Attribute.cs b/Terminal.Gui/ViewBase/View.Drawing.Attribute.cs similarity index 88% rename from Terminal.Gui/View/View.Drawing.Attribute.cs rename to Terminal.Gui/ViewBase/View.Drawing.Attribute.cs index 9dcd79719..a91aa6e58 100644 --- a/Terminal.Gui/View/View.Drawing.Attribute.cs +++ b/Terminal.Gui/ViewBase/View.Drawing.Attribute.cs @@ -1,38 +1,38 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; public partial class View { #region Get - /// Gets the current used by . + /// Gets the current used by . /// The current attribute. public Attribute GetCurrentAttribute () { return Driver?.GetAttribute () ?? Attribute.Default; } /// - /// Gets the associated with a specified - /// from the . + /// Gets the associated with a specified + /// from the . /// /// Raises / /// which can cancel the default behavior, and optionally change the attribute in the event args. /// /// - /// If is , + /// If is , /// will be used instead of . /// To override this behavior use / /// to cancel the method, and return a different attribute. /// /// /// If is not and is , - /// the will be used instead of . + /// the will be used instead of . /// To override this behavior use / /// to cancel the method, and return a different attribute. /// /// - /// The semantic describing the element being rendered. - /// The corresponding from the . + /// The semantic describing the element being rendered. + /// The corresponding from the . public Attribute GetAttributeForRole (VisualRole role) { Attribute schemeAttribute = GetScheme ()!.GetAttributeForRole (role); @@ -64,7 +64,7 @@ public partial class View } /// - /// Called when the Attribute for a is being retrieved. + /// Called when the Attribute for a is being retrieved. /// Implementations can /// return to stop further processing and optionally set the in the /// event args to a different value. @@ -75,7 +75,7 @@ public partial class View protected virtual bool OnGettingAttributeForRole (in VisualRole role, ref Attribute currentAttribute) { return false; } /// - /// Raised when the Attribute for a is being retrieved. + /// Raised when the Attribute for a is being retrieved. /// Handlers should check if /// has been set to and do nothing if so. If Cancel is /// a handler can set it to to stop further processing optionally change the diff --git a/Terminal.Gui/View/View.Drawing.Clipping.cs b/Terminal.Gui/ViewBase/View.Drawing.Clipping.cs similarity index 97% rename from Terminal.Gui/View/View.Drawing.Clipping.cs rename to Terminal.Gui/ViewBase/View.Drawing.Clipping.cs index 89b25283e..49a0e1fe3 100644 --- a/Terminal.Gui/View/View.Drawing.Clipping.cs +++ b/Terminal.Gui/ViewBase/View.Drawing.Clipping.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; public partial class View { @@ -130,7 +131,7 @@ public partial class View /// content to be drawn beyond the viewport. /// /// - /// If has set, clipping will be + /// If has set, clipping will be /// applied to just the visible content area. /// /// @@ -157,7 +158,7 @@ public partial class View Rectangle viewport = ViewportToScreen (new Rectangle (Point.Empty, Viewport.Size)); viewportRegion?.Intersect (viewport); - if (ViewportSettings.HasFlag (ViewportSettings.ClipContentOnly)) + if (ViewportSettings.HasFlag (ViewportSettingsFlags.ClipContentOnly)) { // Clamp the Clip to the just content area that is within the viewport Rectangle visibleContent = ViewportToScreen (new Rectangle (new (-Viewport.X, -Viewport.Y), GetContentSize ())); diff --git a/Terminal.Gui/View/View.Drawing.Primitives.cs b/Terminal.Gui/ViewBase/View.Drawing.Primitives.cs similarity index 98% rename from Terminal.Gui/View/View.Drawing.Primitives.cs rename to Terminal.Gui/ViewBase/View.Drawing.Primitives.cs index 79a648a5b..d9d9333ee 100644 --- a/Terminal.Gui/View/View.Drawing.Primitives.cs +++ b/Terminal.Gui/ViewBase/View.Drawing.Primitives.cs @@ -1,6 +1,6 @@ -using static Terminal.Gui.SpinnerStyle; + -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; public partial class View { diff --git a/Terminal.Gui/View/View.Drawing.Scheme.cs b/Terminal.Gui/ViewBase/View.Drawing.Scheme.cs similarity index 99% rename from Terminal.Gui/View/View.Drawing.Scheme.cs rename to Terminal.Gui/ViewBase/View.Drawing.Scheme.cs index 14127f9fb..89efe0e17 100644 --- a/Terminal.Gui/View/View.Drawing.Scheme.cs +++ b/Terminal.Gui/ViewBase/View.Drawing.Scheme.cs @@ -1,7 +1,7 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; public partial class View { diff --git a/Terminal.Gui/View/View.Drawing.cs b/Terminal.Gui/ViewBase/View.Drawing.cs similarity index 98% rename from Terminal.Gui/View/View.Drawing.cs rename to Terminal.Gui/ViewBase/View.Drawing.cs index 7cb3bd057..30482fd6b 100644 --- a/Terminal.Gui/View/View.Drawing.cs +++ b/Terminal.Gui/ViewBase/View.Drawing.cs @@ -1,8 +1,7 @@ #nullable enable using System.ComponentModel; -using static Unix.Terminal.Curses; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; public partial class View // Drawing APIs { @@ -268,7 +267,7 @@ public partial class View // Drawing APIs internal void DoClearViewport (DrawContext? context = null) { - if (ViewportSettings.HasFlag (ViewportSettings.Transparent) || OnClearingViewport ()) + if (ViewportSettings.HasFlag (ViewportSettingsFlags.Transparent) || OnClearingViewport ()) { return; } @@ -283,7 +282,7 @@ public partial class View // Drawing APIs return; } - if (!ViewportSettings.HasFlag (ViewportSettings.Transparent)) + if (!ViewportSettings.HasFlag (ViewportSettingsFlags.Transparent)) { ClearViewport (context); OnClearedViewport (); @@ -318,11 +317,11 @@ public partial class View // Drawing APIs /// Clears with the normal background. /// /// - /// If has only + /// If has only /// the portion of the content /// area that is visible within the will be cleared. This is useful for views that have /// a - /// content area larger than the Viewport (e.g. when is + /// content area larger than the Viewport (e.g. when is /// enabled) and want /// the area outside the content to be visually distinct. /// @@ -337,7 +336,7 @@ public partial class View // Drawing APIs // Get screen-relative coords Rectangle toClear = ViewportToScreen (Viewport with { Location = new (0, 0) }); - if (ViewportSettings.HasFlag (ViewportSettings.ClearContentOnly)) + if (ViewportSettings.HasFlag (ViewportSettingsFlags.ClearContentOnly)) { Rectangle visibleContent = ViewportToScreen (new Rectangle (new (-Viewport.X, -Viewport.Y), GetContentSize ())); toClear = Rectangle.Intersect (toClear, visibleContent); @@ -553,7 +552,7 @@ public partial class View // Drawing APIs foreach (View view in InternalSubViews.Where (view => view.Visible).Reverse ()) { // TODO: HACK - This forcing of SetNeedsDraw with SuperViewRendersLineCanvas enables auto line join to work, but is brute force. - if (view.SuperViewRendersLineCanvas || view.ViewportSettings.HasFlag (ViewportSettings.Transparent)) + if (view.SuperViewRendersLineCanvas || view.ViewportSettings.HasFlag (ViewportSettingsFlags.Transparent)) { view.SetNeedsDraw (); } @@ -646,7 +645,7 @@ public partial class View // Drawing APIs // Now, update the clip to exclude this view (not including Margin) if (this is not Adornment) { - if (ViewportSettings.HasFlag (ViewportSettings.Transparent)) + if (ViewportSettings.HasFlag (ViewportSettingsFlags.Transparent)) { // context!.DrawnRegion is the region that was drawn by this view. It may include regions outside // the Viewport. We need to clip it to the Viewport. diff --git a/Terminal.Gui/View/View.Hierarchy.cs b/Terminal.Gui/ViewBase/View.Hierarchy.cs similarity index 99% rename from Terminal.Gui/View/View.Hierarchy.cs rename to Terminal.Gui/ViewBase/View.Hierarchy.cs index 0d9a8098d..64a836138 100644 --- a/Terminal.Gui/View/View.Hierarchy.cs +++ b/Terminal.Gui/ViewBase/View.Hierarchy.cs @@ -3,7 +3,7 @@ using System.Collections.ObjectModel; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; public partial class View // SuperView/SubView hierarchy management (SuperView, SubViews, Add, Remove, etc.) { @@ -18,7 +18,7 @@ public partial class View // SuperView/SubView hierarchy management (SuperView, /// Gets the list of SubViews. /// - /// Use and to add or remove subviews. + /// Use and to add or remove subviews. /// public IReadOnlyCollection SubViews => InternalSubViews?.AsReadOnly () ?? _empty; diff --git a/Terminal.Gui/View/View.Keyboard.cs b/Terminal.Gui/ViewBase/View.Keyboard.cs similarity index 99% rename from Terminal.Gui/View/View.Keyboard.cs rename to Terminal.Gui/ViewBase/View.Keyboard.cs index e4f01228f..0c910a4f0 100644 --- a/Terminal.Gui/View/View.Keyboard.cs +++ b/Terminal.Gui/ViewBase/View.Keyboard.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; public partial class View // Keyboard APIs { @@ -228,7 +229,7 @@ public partial class View // Keyboard APIs return; // throw new InvalidOperationException ("Can't set HotKey unless a TextFormatter has been created"); } - if (TextFormatter.FindHotKey (_title, HotKeySpecifier, out _, out Key hk)) + if (Terminal.Gui.Text.TextFormatter.FindHotKey (_title, HotKeySpecifier, out _, out Key hk)) { if (_hotKey != hk) { diff --git a/Terminal.Gui/View/View.Layout.cs b/Terminal.Gui/ViewBase/View.Layout.cs similarity index 99% rename from Terminal.Gui/View/View.Layout.cs rename to Terminal.Gui/ViewBase/View.Layout.cs index 14d9a8828..e9fc65fa7 100644 --- a/Terminal.Gui/View/View.Layout.cs +++ b/Terminal.Gui/ViewBase/View.Layout.cs @@ -1,7 +1,7 @@ #nullable enable using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; public partial class View // Layout APIs { @@ -1153,10 +1153,10 @@ public partial class View // Layout APIs /// /// Screen-relative location. /// - /// If set, excludes Views that have the or + /// If set, excludes Views that have the or /// flags set in their ViewportSettings. /// - public static List GetViewsUnderLocation (in Point screenLocation, ViewportSettings excludeViewportSettingsFlags) + public static List GetViewsUnderLocation (in Point screenLocation, ViewportSettingsFlags excludeViewportSettingsFlags) { // PopoverHost - If visible, start with it instead of Top if (Application.Popover?.GetActivePopover () is View { Visible: true } visiblePopover) @@ -1221,14 +1221,14 @@ public partial class View // Layout APIs /// /// Screen-relative location. /// - /// If set, excludes Views that have the or + /// If set, excludes Views that have the or /// flags set in their ViewportSettings. /// - internal static List GetViewsUnderLocation (View root, in Point screenLocation, ViewportSettings excludeViewportSettingsFlags) + internal static List GetViewsUnderLocation (View root, in Point screenLocation, ViewportSettingsFlags excludeViewportSettingsFlags) { List viewsUnderLocation = GetViewsAtLocation (root, screenLocation); - if (!excludeViewportSettingsFlags.HasFlag (ViewportSettings.Transparent) && !excludeViewportSettingsFlags.HasFlag (ViewportSettings.TransparentMouse)) + if (!excludeViewportSettingsFlags.HasFlag (ViewportSettingsFlags.Transparent) && !excludeViewportSettingsFlags.HasFlag (ViewportSettingsFlags.TransparentMouse)) { // Only filter views if we are excluding transparent views. return viewsUnderLocation; diff --git a/Terminal.Gui/View/View.Mouse.cs b/Terminal.Gui/ViewBase/View.Mouse.cs similarity index 98% rename from Terminal.Gui/View/View.Mouse.cs rename to Terminal.Gui/ViewBase/View.Mouse.cs index 4a4b3ca92..71a992d7b 100644 --- a/Terminal.Gui/View/View.Mouse.cs +++ b/Terminal.Gui/ViewBase/View.Mouse.cs @@ -1,7 +1,7 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; public partial class View // Mouse APIs { @@ -97,8 +97,8 @@ public partial class View // Mouse APIs } /// - /// Gets the to use when the view is highlighted. The highlight colorscheme - /// is based on the current , using . + /// Gets the to use when the view is highlighted. The highlight colorscheme + /// is based on the current , using . /// /// The highlight scheme. public Scheme GetHighlightScheme () @@ -268,7 +268,7 @@ public partial class View // Mouse APIs /// /// If is , the / /// event - /// will be raised on any new mouse event where indicates a button + /// will be raised on any new mouse event where indicates a button /// is pressed. /// /// diff --git a/Terminal.Gui/View/View.Navigation.cs b/Terminal.Gui/ViewBase/View.Navigation.cs similarity index 99% rename from Terminal.Gui/View/View.Navigation.cs rename to Terminal.Gui/ViewBase/View.Navigation.cs index ca5d5d50e..2a6d1f35b 100644 --- a/Terminal.Gui/View/View.Navigation.cs +++ b/Terminal.Gui/ViewBase/View.Navigation.cs @@ -1,7 +1,8 @@ #nullable enable using System.Diagnostics; -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; public partial class View // Focus and cross-view navigation management (TabStop, TabIndex, etc...) { diff --git a/Terminal.Gui/View/View.ScrollBars.cs b/Terminal.Gui/ViewBase/View.ScrollBars.cs similarity index 99% rename from Terminal.Gui/View/View.ScrollBars.cs rename to Terminal.Gui/ViewBase/View.ScrollBars.cs index 3db3149d6..6c084bfb0 100644 --- a/Terminal.Gui/View/View.ScrollBars.cs +++ b/Terminal.Gui/ViewBase/View.ScrollBars.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; public partial class View { diff --git a/Terminal.Gui/View/View.Text.cs b/Terminal.Gui/ViewBase/View.Text.cs similarity index 95% rename from Terminal.Gui/View/View.Text.cs rename to Terminal.Gui/ViewBase/View.Text.cs index 610ad0859..32694d33f 100644 --- a/Terminal.Gui/View/View.Text.cs +++ b/Terminal.Gui/ViewBase/View.Text.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.ViewBase; public partial class View // Text Property APIs { @@ -13,7 +14,7 @@ public partial class View // Text Property APIs /// /// Gets or sets whether trailing spaces at the end of word-wrapped lines are preserved - /// or not when is enabled. + /// or not when is enabled. /// If trailing spaces at the end of wrapped lines will be removed when /// is formatted for display. The default is . /// @@ -119,7 +120,7 @@ public partial class View // Text Property APIs } /// - /// Gets or sets the used to format . + /// Gets or sets the used to format . /// public TextFormatter TextFormatter { get; init; } = new (); @@ -165,7 +166,7 @@ public partial class View // Text Property APIs /// Internal API. Sets .Width/Height. /// /// - /// Use this API to set /Height when the view has changed such that the + /// Use this API to set /Height when the view has changed such that the /// size required to fit the text has changed. /// changes. /// diff --git a/Terminal.Gui/View/View.cs b/Terminal.Gui/ViewBase/View.cs similarity index 99% rename from Terminal.Gui/View/View.cs rename to Terminal.Gui/ViewBase/View.cs index 71b842add..3dd4c9c99 100644 --- a/Terminal.Gui/View/View.cs +++ b/Terminal.Gui/ViewBase/View.cs @@ -3,7 +3,7 @@ using System.Collections.Concurrent; using System.ComponentModel; using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; #region API Docs @@ -429,7 +429,7 @@ public partial class View : IDisposable, ISupportInitializeNotification private string _title = string.Empty; - /// Gets the used to format . + /// Gets the used to format . internal TextFormatter TitleTextFormatter { get; init; } = new (); /// diff --git a/Terminal.Gui/View/ViewDiagnosticFlags.cs b/Terminal.Gui/ViewBase/ViewDiagnosticFlags.cs similarity index 97% rename from Terminal.Gui/View/ViewDiagnosticFlags.cs rename to Terminal.Gui/ViewBase/ViewDiagnosticFlags.cs index fc625d414..345ec3c78 100644 --- a/Terminal.Gui/View/ViewDiagnosticFlags.cs +++ b/Terminal.Gui/ViewBase/ViewDiagnosticFlags.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// Enables diagnostic functions for . [Flags] diff --git a/Terminal.Gui/View/ViewEventArgs.cs b/Terminal.Gui/ViewBase/ViewEventArgs.cs similarity index 81% rename from Terminal.Gui/View/ViewEventArgs.cs rename to Terminal.Gui/ViewBase/ViewEventArgs.cs index cdcbaa009..d2de59ec0 100644 --- a/Terminal.Gui/View/ViewEventArgs.cs +++ b/Terminal.Gui/ViewBase/ViewEventArgs.cs @@ -1,9 +1,9 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// Args for events that relate to specific public class ViewEventArgs : EventArgs { - /// Creates a new instance of the class. + /// Creates a new instance of the class. /// The view that the event is about. public ViewEventArgs (View view) { View = view; } diff --git a/Terminal.Gui/View/ViewportSettings.cs b/Terminal.Gui/ViewBase/ViewportSettingsFlags.cs similarity index 99% rename from Terminal.Gui/View/ViewportSettings.cs rename to Terminal.Gui/ViewBase/ViewportSettingsFlags.cs index b77f7c5e5..10c0d763a 100644 --- a/Terminal.Gui/View/ViewportSettings.cs +++ b/Terminal.Gui/ViewBase/ViewportSettingsFlags.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.ViewBase; /// /// Settings for how the behaves. @@ -8,7 +8,7 @@ /// /// [Flags] -public enum ViewportSettings +public enum ViewportSettingsFlags { /// /// No settings. diff --git a/Terminal.Gui/Text/Autocomplete/AppendAutocomplete.cs b/Terminal.Gui/Views/Autocomplete/AppendAutocomplete.cs similarity index 99% rename from Terminal.Gui/Text/Autocomplete/AppendAutocomplete.cs rename to Terminal.Gui/Views/Autocomplete/AppendAutocomplete.cs index 5d61076c0..b53971624 100644 --- a/Terminal.Gui/Text/Autocomplete/AppendAutocomplete.cs +++ b/Terminal.Gui/Views/Autocomplete/AppendAutocomplete.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Autocomplete for a which shows suggestions within the box. Displayed suggestions can diff --git a/Terminal.Gui/Text/Autocomplete/Autocomplete.cd b/Terminal.Gui/Views/Autocomplete/Autocomplete.cd similarity index 100% rename from Terminal.Gui/Text/Autocomplete/Autocomplete.cd rename to Terminal.Gui/Views/Autocomplete/Autocomplete.cd diff --git a/Terminal.Gui/Text/Autocomplete/AutocompleteBase.cs b/Terminal.Gui/Views/Autocomplete/AutocompleteBase.cs similarity index 98% rename from Terminal.Gui/Text/Autocomplete/AutocompleteBase.cs rename to Terminal.Gui/Views/Autocomplete/AutocompleteBase.cs index b11d0b7e0..f2122fa4b 100644 --- a/Terminal.Gui/Text/Autocomplete/AutocompleteBase.cs +++ b/Terminal.Gui/Views/Autocomplete/AutocompleteBase.cs @@ -1,6 +1,6 @@ using System.Collections.ObjectModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Abstract implementation of allows for tailoring how autocomplete is diff --git a/Terminal.Gui/Text/Autocomplete/AutocompleteContext.cs b/Terminal.Gui/Views/Autocomplete/AutocompleteContext.cs similarity index 96% rename from Terminal.Gui/Text/Autocomplete/AutocompleteContext.cs rename to Terminal.Gui/Views/Autocomplete/AutocompleteContext.cs index ed55b0d3f..d2e7e4d59 100644 --- a/Terminal.Gui/Text/Autocomplete/AutocompleteContext.cs +++ b/Terminal.Gui/Views/Autocomplete/AutocompleteContext.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Describes the current state of a which is proposing autocomplete. Suggestions are based on diff --git a/Terminal.Gui/Views/AutocompleteFilepathContext.cs b/Terminal.Gui/Views/Autocomplete/AutocompleteFilepathContext.cs similarity index 99% rename from Terminal.Gui/Views/AutocompleteFilepathContext.cs rename to Terminal.Gui/Views/Autocomplete/AutocompleteFilepathContext.cs index fbdf168fa..6c3e12c34 100644 --- a/Terminal.Gui/Views/AutocompleteFilepathContext.cs +++ b/Terminal.Gui/Views/Autocomplete/AutocompleteFilepathContext.cs @@ -1,7 +1,7 @@ using System.IO.Abstractions; using System.Runtime.InteropServices; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; internal class AutocompleteFilepathContext (string currentLine, int cursorPosition, FileDialogState state) : AutocompleteContext (Cell.ToCellList (currentLine), cursorPosition) diff --git a/Terminal.Gui/Text/Autocomplete/IAutocomplete.cs b/Terminal.Gui/Views/Autocomplete/IAutocomplete.cs similarity index 99% rename from Terminal.Gui/Text/Autocomplete/IAutocomplete.cs rename to Terminal.Gui/Views/Autocomplete/IAutocomplete.cs index 532fd8aa8..717122e9d 100644 --- a/Terminal.Gui/Text/Autocomplete/IAutocomplete.cs +++ b/Terminal.Gui/Views/Autocomplete/IAutocomplete.cs @@ -1,6 +1,6 @@ using System.Collections.ObjectModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' diff --git a/Terminal.Gui/Text/Autocomplete/ISuggestionGenerator.cs b/Terminal.Gui/Views/Autocomplete/ISuggestionGenerator.cs similarity index 95% rename from Terminal.Gui/Text/Autocomplete/ISuggestionGenerator.cs rename to Terminal.Gui/Views/Autocomplete/ISuggestionGenerator.cs index 1c0417f4d..08fd17c9a 100644 --- a/Terminal.Gui/Text/Autocomplete/ISuggestionGenerator.cs +++ b/Terminal.Gui/Views/Autocomplete/ISuggestionGenerator.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Generates autocomplete based on a given cursor location within a string public interface ISuggestionGenerator diff --git a/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.PopUp.cs b/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.PopUp.cs similarity index 96% rename from Terminal.Gui/Text/Autocomplete/PopupAutocomplete.PopUp.cs rename to Terminal.Gui/Views/Autocomplete/PopupAutocomplete.PopUp.cs index 2abe2091d..b7a67726e 100644 --- a/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.PopUp.cs +++ b/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.PopUp.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; public abstract partial class PopupAutocomplete { diff --git a/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.cs b/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.cs similarity index 99% rename from Terminal.Gui/Text/Autocomplete/PopupAutocomplete.cs rename to Terminal.Gui/Views/Autocomplete/PopupAutocomplete.cs index 0f519e71d..5b2475fb0 100644 --- a/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.cs +++ b/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.cs @@ -1,6 +1,6 @@ using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' diff --git a/Terminal.Gui/Text/Autocomplete/SingleWordSuggestionGenerator.cs b/Terminal.Gui/Views/Autocomplete/SingleWordSuggestionGenerator.cs similarity index 99% rename from Terminal.Gui/Text/Autocomplete/SingleWordSuggestionGenerator.cs rename to Terminal.Gui/Views/Autocomplete/SingleWordSuggestionGenerator.cs index 64461c578..1accda922 100644 --- a/Terminal.Gui/Text/Autocomplete/SingleWordSuggestionGenerator.cs +++ b/Terminal.Gui/Views/Autocomplete/SingleWordSuggestionGenerator.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// which suggests from a collection of words those that match the diff --git a/Terminal.Gui/Text/Autocomplete/Suggestion.cs b/Terminal.Gui/Views/Autocomplete/Suggestion.cs similarity index 97% rename from Terminal.Gui/Text/Autocomplete/Suggestion.cs rename to Terminal.Gui/Views/Autocomplete/Suggestion.cs index bba2592ec..7b7bbd12a 100644 --- a/Terminal.Gui/Text/Autocomplete/Suggestion.cs +++ b/Terminal.Gui/Views/Autocomplete/Suggestion.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// A replacement suggestion made by public class Suggestion diff --git a/Terminal.Gui/Views/Bar.cs b/Terminal.Gui/Views/Bar.cs index 7c683ceb5..55e4a7914 100644 --- a/Terminal.Gui/Views/Bar.cs +++ b/Terminal.Gui/Views/Bar.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Provides a horizontally or vertically oriented container for s to be used as a menu, toolbar, or status diff --git a/Terminal.Gui/Views/Button.cs b/Terminal.Gui/Views/Button.cs index b955f107d..5a45c642b 100644 --- a/Terminal.Gui/Views/Button.cs +++ b/Terminal.Gui/Views/Button.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// A button View that can be pressed with the mouse or keyboard. diff --git a/Terminal.Gui/Views/CharMap/CharMap.cs b/Terminal.Gui/Views/CharMap/CharMap.cs index 7d162d2a3..b6d318e8f 100644 --- a/Terminal.Gui/Views/CharMap/CharMap.cs +++ b/Terminal.Gui/Views/CharMap/CharMap.cs @@ -2,9 +2,8 @@ using System.Diagnostics.CodeAnalysis; using System.Globalization; using System.Text.Json; -using Terminal.Gui.Resources; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// A scrollable map of the Unicode codepoints. diff --git a/Terminal.Gui/Views/CharMap/UcdApiClient.cs b/Terminal.Gui/Views/CharMap/UcdApiClient.cs index b6b2efce0..ae0af4838 100644 --- a/Terminal.Gui/Views/CharMap/UcdApiClient.cs +++ b/Terminal.Gui/Views/CharMap/UcdApiClient.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// A helper class for accessing the ucdapi.org API. diff --git a/Terminal.Gui/Views/CharMap/UnicodeRange.cs b/Terminal.Gui/Views/CharMap/UnicodeRange.cs index 1880b2671..24f7378b2 100644 --- a/Terminal.Gui/Views/CharMap/UnicodeRange.cs +++ b/Terminal.Gui/Views/CharMap/UnicodeRange.cs @@ -2,7 +2,7 @@ using System.Reflection; using System.Text.Unicode; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Represents all of the Uniicode ranges.from System.Text.Unicode.UnicodeRange plus diff --git a/Terminal.Gui/Views/CheckBox.cs b/Terminal.Gui/Views/CheckBox.cs index e8d018c73..626f4516d 100644 --- a/Terminal.Gui/Views/CheckBox.cs +++ b/Terminal.Gui/Views/CheckBox.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// Shows a checkbox that can be cycled between two or three states. /// diff --git a/Terminal.Gui/Views/CheckState.cs b/Terminal.Gui/Views/CheckState.cs index 54f818bc7..2b001ddea 100644 --- a/Terminal.Gui/Views/CheckState.cs +++ b/Terminal.Gui/Views/CheckState.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Represents the state of a . diff --git a/Terminal.Gui/Views/CollectionNavigation/CollectionNavigator.cs b/Terminal.Gui/Views/CollectionNavigation/CollectionNavigator.cs index 5bbb04485..a12d769c5 100644 --- a/Terminal.Gui/Views/CollectionNavigation/CollectionNavigator.cs +++ b/Terminal.Gui/Views/CollectionNavigation/CollectionNavigator.cs @@ -1,6 +1,6 @@ using System.Collections; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// This implementation is based on a static of objects. diff --git a/Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs b/Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs index 61b21a12b..274d32622 100644 --- a/Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs +++ b/Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// internal abstract class CollectionNavigatorBase : ICollectionNavigator diff --git a/Terminal.Gui/Views/CollectionNavigation/DefaultCollectionNavigatorMatcher.cs b/Terminal.Gui/Views/CollectionNavigation/DefaultCollectionNavigatorMatcher.cs index 2fb65a7a3..20bee6809 100644 --- a/Terminal.Gui/Views/CollectionNavigation/DefaultCollectionNavigatorMatcher.cs +++ b/Terminal.Gui/Views/CollectionNavigation/DefaultCollectionNavigatorMatcher.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Default implementation of , performs diff --git a/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigator.cs b/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigator.cs index 9b7a1b3e0..85a68d300 100644 --- a/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigator.cs +++ b/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigator.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Navigates a collection of items using keystrokes. The keystrokes are used to build a search string. The diff --git a/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigatorMatcher.cs b/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigatorMatcher.cs index ec8cbc3e6..f45b59c0f 100644 --- a/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigatorMatcher.cs +++ b/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigatorMatcher.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Determines which keys trigger collection manager navigation diff --git a/Terminal.Gui/Views/CollectionNavigation/IListCollectionNavigator.cs b/Terminal.Gui/Views/CollectionNavigation/IListCollectionNavigator.cs index ca640975f..f89e3f7c4 100644 --- a/Terminal.Gui/Views/CollectionNavigation/IListCollectionNavigator.cs +++ b/Terminal.Gui/Views/CollectionNavigation/IListCollectionNavigator.cs @@ -1,10 +1,10 @@ using System.Collections; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// sub-interface for and . See also -/// / +/// / /// public interface IListCollectionNavigator : ICollectionNavigator { diff --git a/Terminal.Gui/Views/CollectionNavigation/TableCollectionNavigator.cs b/Terminal.Gui/Views/CollectionNavigation/TableCollectionNavigator.cs index ea1faba88..69a817e50 100644 --- a/Terminal.Gui/Views/CollectionNavigation/TableCollectionNavigator.cs +++ b/Terminal.Gui/Views/CollectionNavigation/TableCollectionNavigator.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Collection navigator for cycling selections in a . internal class TableCollectionNavigator : CollectionNavigatorBase diff --git a/Terminal.Gui/Views/Color/BBar.cs b/Terminal.Gui/Views/Color/BBar.cs index c42dfdd9a..b59b5eecb 100644 --- a/Terminal.Gui/Views/Color/BBar.cs +++ b/Terminal.Gui/Views/Color/BBar.cs @@ -2,7 +2,7 @@ using ColorHelper; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; internal class BBar : ColorBar { diff --git a/Terminal.Gui/Views/Color/ColorBar.cs b/Terminal.Gui/Views/Color/ColorBar.cs index ac504847c..262abc99e 100644 --- a/Terminal.Gui/Views/Color/ColorBar.cs +++ b/Terminal.Gui/Views/Color/ColorBar.cs @@ -1,10 +1,12 @@ #nullable enable -namespace Terminal.Gui; +using ColorHelper; + +namespace Terminal.Gui.Views; /// /// A bar representing a single component of a e.g. -/// the Red portion of a . +/// the Red portion of a . /// internal abstract class ColorBar : View, IColorBar { @@ -57,7 +59,7 @@ internal abstract class ColorBar : View, IColorBar /// /// The currently selected amount of the color component stored by this class e.g. - /// the amount of Hue in a . + /// the amount of Hue in a . /// public int Value { diff --git a/Terminal.Gui/Views/Color/ColorModelStrategy.cs b/Terminal.Gui/Views/Color/ColorModelStrategy.cs index 75d26da39..eb3f15608 100644 --- a/Terminal.Gui/Views/Color/ColorModelStrategy.cs +++ b/Terminal.Gui/Views/Color/ColorModelStrategy.cs @@ -3,7 +3,7 @@ using ColorHelper; using ColorConverter = ColorHelper.ColorConverter; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; internal class ColorModelStrategy { diff --git a/Terminal.Gui/Views/Color/ColorPicker.16.cs b/Terminal.Gui/Views/Color/ColorPicker.16.cs index 07152caa2..221883399 100644 --- a/Terminal.Gui/Views/Color/ColorPicker.16.cs +++ b/Terminal.Gui/Views/Color/ColorPicker.16.cs @@ -1,7 +1,8 @@ #nullable enable -namespace Terminal.Gui; -/// The Color picker. +namespace Terminal.Gui.Views; + +/// A sinple color picker that supports the legacy 16 ANSI colors public class ColorPicker16 : View { /// Initializes a new instance of . diff --git a/Terminal.Gui/Views/Color/ColorPicker.Prompt.cs b/Terminal.Gui/Views/Color/ColorPicker.Prompt.cs index fdc2ac94c..ee519f12a 100644 --- a/Terminal.Gui/Views/Color/ColorPicker.Prompt.cs +++ b/Terminal.Gui/Views/Color/ColorPicker.Prompt.cs @@ -1,6 +1,5 @@ -using Terminal.Gui.Resources; - -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; public partial class ColorPicker { diff --git a/Terminal.Gui/Views/Color/ColorPicker.Style.cs b/Terminal.Gui/Views/Color/ColorPicker.Style.cs index 80e1b820a..616687156 100644 --- a/Terminal.Gui/Views/Color/ColorPicker.Style.cs +++ b/Terminal.Gui/Views/Color/ColorPicker.Style.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Contains style settings for e.g. which diff --git a/Terminal.Gui/Views/Color/ColorPicker.cs b/Terminal.Gui/Views/Color/ColorPicker.cs index 8934231a2..cc44fa32d 100644 --- a/Terminal.Gui/Views/Color/ColorPicker.cs +++ b/Terminal.Gui/Views/Color/ColorPicker.cs @@ -1,9 +1,11 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// -/// True color picker using HSL +/// Color Picker supporting RGB, HSL, and HSV color models. Supports choosing colors with +/// sliders and color names from the . /// public partial class ColorPicker : View, IDesignable { diff --git a/Terminal.Gui/Views/Color/GBar.cs b/Terminal.Gui/Views/Color/GBar.cs index c3f1ec6e6..ac9a7227f 100644 --- a/Terminal.Gui/Views/Color/GBar.cs +++ b/Terminal.Gui/Views/Color/GBar.cs @@ -2,7 +2,7 @@ using ColorHelper; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; internal class GBar : ColorBar { diff --git a/Terminal.Gui/Views/Color/HueBar.cs b/Terminal.Gui/Views/Color/HueBar.cs index 0968b51be..9f7d29e45 100644 --- a/Terminal.Gui/Views/Color/HueBar.cs +++ b/Terminal.Gui/Views/Color/HueBar.cs @@ -3,7 +3,7 @@ using ColorHelper; using ColorConverter = ColorHelper.ColorConverter; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; internal class HueBar : ColorBar { diff --git a/Terminal.Gui/Views/Color/IColorBar.cs b/Terminal.Gui/Views/Color/IColorBar.cs index f825e70ad..b8139b8d5 100644 --- a/Terminal.Gui/Views/Color/IColorBar.cs +++ b/Terminal.Gui/Views/Color/IColorBar.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; internal interface IColorBar { diff --git a/Terminal.Gui/Views/Color/LightnessBar.cs b/Terminal.Gui/Views/Color/LightnessBar.cs index bc32e1549..0f176a3f6 100644 --- a/Terminal.Gui/Views/Color/LightnessBar.cs +++ b/Terminal.Gui/Views/Color/LightnessBar.cs @@ -3,7 +3,7 @@ using ColorHelper; using ColorConverter = ColorHelper.ColorConverter; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; internal class LightnessBar : ColorBar { diff --git a/Terminal.Gui/Views/Color/RBar.cs b/Terminal.Gui/Views/Color/RBar.cs index 99651ec66..2610c66bb 100644 --- a/Terminal.Gui/Views/Color/RBar.cs +++ b/Terminal.Gui/Views/Color/RBar.cs @@ -2,7 +2,7 @@ using ColorHelper; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; internal class RBar : ColorBar { diff --git a/Terminal.Gui/Views/Color/SaturationBar.cs b/Terminal.Gui/Views/Color/SaturationBar.cs index bd25fc82f..76fcd2029 100644 --- a/Terminal.Gui/Views/Color/SaturationBar.cs +++ b/Terminal.Gui/Views/Color/SaturationBar.cs @@ -3,7 +3,7 @@ using ColorHelper; using ColorConverter = ColorHelper.ColorConverter; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; internal class SaturationBar : ColorBar { diff --git a/Terminal.Gui/Views/Color/ValueBar.cs b/Terminal.Gui/Views/Color/ValueBar.cs index 0baced3d5..6352c7cab 100644 --- a/Terminal.Gui/Views/Color/ValueBar.cs +++ b/Terminal.Gui/Views/Color/ValueBar.cs @@ -3,7 +3,7 @@ using ColorHelper; using ColorConverter = ColorHelper.ColorConverter; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; internal class ValueBar : ColorBar { diff --git a/Terminal.Gui/Views/ComboBox.cs b/Terminal.Gui/Views/ComboBox.cs index 54c2dea48..209f94bae 100644 --- a/Terminal.Gui/Views/ComboBox.cs +++ b/Terminal.Gui/Views/ComboBox.cs @@ -8,7 +8,7 @@ using System.Collections.ObjectModel; using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Provides a drop-down list of items the user can select from. public class ComboBox : View, IDesignable diff --git a/Terminal.Gui/Views/DatePicker.cs b/Terminal.Gui/Views/DatePicker.cs index 2962464ec..2e2ffa4bc 100644 --- a/Terminal.Gui/Views/DatePicker.cs +++ b/Terminal.Gui/Views/DatePicker.cs @@ -7,9 +7,9 @@ using System.Data; using System.Globalization; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; -/// The Date Picker. +/// Lets the user pick a date from a visual calendar. public class DatePicker : View { private TableView _calendar; diff --git a/Terminal.Gui/Views/DateTimeEventArgs.cs b/Terminal.Gui/Views/DateTimeEventArgs.cs index 28adcc9d6..8dfa4d78d 100644 --- a/Terminal.Gui/Views/DateTimeEventArgs.cs +++ b/Terminal.Gui/Views/DateTimeEventArgs.cs @@ -6,7 +6,7 @@ // Licensed under the MIT license // -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Defines the event arguments for and diff --git a/Terminal.Gui/Views/Dialog.cs b/Terminal.Gui/Views/Dialog.cs index a5e4f8c52..88f2af02c 100644 --- a/Terminal.Gui/Views/Dialog.cs +++ b/Terminal.Gui/Views/Dialog.cs @@ -1,9 +1,9 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// -/// The is a that by default is centered and contains -/// one or more s. It defaults to the Colors.Schemes ["Dialog"] scheme and has a -/// 1 cell padding around the edges. +/// A . Supports a simple API for adding s +/// across the bottom. By default, the is centered and used the +/// scheme. /// /// /// To run the modally, create the , and pass it to @@ -38,9 +38,8 @@ public class Dialog : Window [ConfigurationProperty (Scope = typeof (ThemeScope))] public static int DefaultMinimumHeight { get; set; } = 80; - /// - /// Gets or sets whether all s are shown with a shadow effect by default. + /// Gets or sets whether all s are shown with a shadow effect by default. /// [ConfigurationProperty (Scope = typeof (ThemeScope))] public new static ShadowStyle DefaultShadow { get; set; } = ShadowStyle.Transparent; @@ -61,7 +60,8 @@ public class Dialog : Window /// /// By default, , , , and are /// set - /// such that the will be centered in, and no larger than 90% of , if there is one. Otherwise, + /// such that the will be centered in, and no larger than 90% of , if + /// there is one. Otherwise, /// it will be bound by the screen dimensions. /// public Dialog () @@ -87,8 +87,8 @@ public class Dialog : Window // BUGBUG: Calls these methods. // TODO: Fix this in https://github.com/gui-cs/Terminal.Gui/issues/2381 - /// - /// + /// + /// protected override bool OnGettingAttributeForRole (in VisualRole role, ref Attribute currentAttribute) { if (role == VisualRole.Normal || role == VisualRole.Focus) @@ -110,7 +110,7 @@ public class Dialog : Window get { #if DEBUG_IDISPOSABLE - if (View.EnableDebugIDisposableAsserts && WasDisposed) + if (EnableDebugIDisposableAsserts && WasDisposed) { throw new ObjectDisposedException (GetType ().FullName); } @@ -120,7 +120,7 @@ public class Dialog : Window set { #if DEBUG_IDISPOSABLE - if (View.EnableDebugIDisposableAsserts && WasDisposed) + if (EnableDebugIDisposableAsserts && WasDisposed) { throw new ObjectDisposedException (GetType ().FullName); } diff --git a/Terminal.Gui/Views/FileDialog.cd b/Terminal.Gui/Views/FileDialogs/FileDialog.cd similarity index 100% rename from Terminal.Gui/Views/FileDialog.cd rename to Terminal.Gui/Views/FileDialogs/FileDialog.cd diff --git a/Terminal.Gui/Views/FileDialog.cs b/Terminal.Gui/Views/FileDialogs/FileDialog.cs similarity index 99% rename from Terminal.Gui/Views/FileDialog.cs rename to Terminal.Gui/Views/FileDialogs/FileDialog.cs index f245f71e7..ae1f7dfea 100644 --- a/Terminal.Gui/Views/FileDialog.cs +++ b/Terminal.Gui/Views/FileDialogs/FileDialog.cs @@ -1,14 +1,12 @@ using System.IO.Abstractions; using System.Text.RegularExpressions; -using Terminal.Gui.Resources; #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// -/// Modal dialog for selecting files/directories. Has auto-complete and expandable navigation pane (Recent, Root -/// drives etc). +/// The base-class for and /// public class FileDialog : Dialog, IDesignable { diff --git a/Terminal.Gui/Views/FileDialogCollectionNavigator.cs b/Terminal.Gui/Views/FileDialogs/FileDialogCollectionNavigator.cs similarity index 95% rename from Terminal.Gui/Views/FileDialogCollectionNavigator.cs rename to Terminal.Gui/Views/FileDialogs/FileDialogCollectionNavigator.cs index 481581de5..d482c0a89 100644 --- a/Terminal.Gui/Views/FileDialogCollectionNavigator.cs +++ b/Terminal.Gui/Views/FileDialogs/FileDialogCollectionNavigator.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; internal class FileDialogCollectionNavigator (FileDialog fileDialog, TableView tableView) : CollectionNavigatorBase { diff --git a/Terminal.Gui/Views/FileDialogTableSource.cs b/Terminal.Gui/Views/FileDialogs/FileDialogTableSource.cs similarity index 98% rename from Terminal.Gui/Views/FileDialogTableSource.cs rename to Terminal.Gui/Views/FileDialogs/FileDialogTableSource.cs index c142d3dc8..00ef33d6f 100644 --- a/Terminal.Gui/Views/FileDialogTableSource.cs +++ b/Terminal.Gui/Views/FileDialogs/FileDialogTableSource.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; internal class FileDialogTableSource : ITableSource { diff --git a/Terminal.Gui/Views/FileSystemColorProvider.cs b/Terminal.Gui/Views/FileDialogs/FileSystemColorProvider.cs similarity index 99% rename from Terminal.Gui/Views/FileSystemColorProvider.cs rename to Terminal.Gui/Views/FileDialogs/FileSystemColorProvider.cs index 03c962420..d76c2970d 100644 --- a/Terminal.Gui/Views/FileSystemColorProvider.cs +++ b/Terminal.Gui/Views/FileDialogs/FileSystemColorProvider.cs @@ -3,7 +3,7 @@ using System.Diagnostics.CodeAnalysis; using System.IO.Abstractions; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Provides a way to get the color of a file or directory. public class FileSystemColorProvider diff --git a/Terminal.Gui/Views/FileSystemIconProvider.cs b/Terminal.Gui/Views/FileDialogs/FileSystemIconProvider.cs similarity index 99% rename from Terminal.Gui/Views/FileSystemIconProvider.cs rename to Terminal.Gui/Views/FileDialogs/FileSystemIconProvider.cs index 0716a84b7..d5350a67d 100644 --- a/Terminal.Gui/Views/FileSystemIconProvider.cs +++ b/Terminal.Gui/Views/FileDialogs/FileSystemIconProvider.cs @@ -1,6 +1,6 @@ using System.IO.Abstractions; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Determines which symbol to use to represent files and directories. public class FileSystemIconProvider diff --git a/Terminal.Gui/Views/OpenDialog.cs b/Terminal.Gui/Views/FileDialogs/OpenDialog.cs similarity index 80% rename from Terminal.Gui/Views/OpenDialog.cs rename to Terminal.Gui/Views/FileDialogs/OpenDialog.cs index 8197671d8..5f916b1de 100644 --- a/Terminal.Gui/Views/OpenDialog.cs +++ b/Terminal.Gui/Views/FileDialogs/OpenDialog.cs @@ -10,24 +10,10 @@ // * DirListView: Add mouse support using System.Collections.ObjectModel; -using Terminal.Gui.Resources; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; -/// Determine which type to open. -public enum OpenMode -{ - /// Opens only file or files. - File, - - /// Opens only directory or directories. - Directory, - - /// Opens files and directories. - Mixed -} - -/// The provides an interactive dialog box for users to select files or directories. +/// Provides an interactive for selecting files or directories for opening /// /// /// The open dialog can be used to select files for opening, it can be configured to allow multiple items to be diff --git a/Terminal.Gui/Views/FileDialogs/OpenMode.cs b/Terminal.Gui/Views/FileDialogs/OpenMode.cs new file mode 100644 index 000000000..e50370ea2 --- /dev/null +++ b/Terminal.Gui/Views/FileDialogs/OpenMode.cs @@ -0,0 +1,14 @@ +namespace Terminal.Gui.Views; + +/// Determine which type to open. +public enum OpenMode +{ + /// Opens only file or files. + File, + + /// Opens only directory or directories. + Directory, + + /// Opens files and directories. + Mixed +} diff --git a/Terminal.Gui/Views/SaveDialog.cs b/Terminal.Gui/Views/FileDialogs/SaveDialog.cs similarity index 92% rename from Terminal.Gui/Views/SaveDialog.cs rename to Terminal.Gui/Views/FileDialogs/SaveDialog.cs index 3c7f52be5..7646817f8 100644 --- a/Terminal.Gui/Views/SaveDialog.cs +++ b/Terminal.Gui/Views/FileDialogs/SaveDialog.cs @@ -10,11 +10,10 @@ // * DirListView: Add mouse support using System.IO.Abstractions; -using Terminal.Gui.Resources; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; -/// The provides an interactive dialog box for users to pick a file to save. +/// Provides an interactive for selecting files or directories for saving /// /// /// To use, create an instance of , and pass it to diff --git a/Terminal.Gui/Views/FlagSelector.cs b/Terminal.Gui/Views/FlagSelector.cs index 1640b9c70..7e2298c32 100644 --- a/Terminal.Gui/Views/FlagSelector.cs +++ b/Terminal.Gui/Views/FlagSelector.cs @@ -1,8 +1,9 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// -/// Provides a user interface for displaying and selecting flags. +/// Provides a user interface for displaying and selecting non-mutually-exclusive flags. /// Flags can be set from a dictionary or directly from an enum type. /// public class FlagSelector : View, IOrientation, IDesignable diff --git a/Terminal.Gui/Views/FlagSelectorStyles.cs b/Terminal.Gui/Views/FlagSelectorStyles.cs index 95ea6f230..98ddbbb23 100644 --- a/Terminal.Gui/Views/FlagSelectorStyles.cs +++ b/Terminal.Gui/Views/FlagSelectorStyles.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Styles for . diff --git a/Terminal.Gui/Views/FlagSelectorTEnum.cs b/Terminal.Gui/Views/FlagSelectorTEnum.cs index cec0342c4..29a1e2291 100644 --- a/Terminal.Gui/Views/FlagSelectorTEnum.cs +++ b/Terminal.Gui/Views/FlagSelectorTEnum.cs @@ -1,8 +1,8 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// -/// Provides a user interface for displaying and selecting flags. +/// Provides a user interface for displaying and selecting non-mutually-exclusive flags. /// Flags can be set from a dictionary or directly from an enum type. /// public sealed class FlagSelector : FlagSelector where TEnum : struct, Enum diff --git a/Terminal.Gui/Views/FrameView.cs b/Terminal.Gui/Views/FrameView.cs index 698d0d397..4f8713c8b 100644 --- a/Terminal.Gui/Views/FrameView.cs +++ b/Terminal.Gui/Views/FrameView.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; // TODO: FrameView is mis-named, really. It's far more about it being a TabGroup than a frame. @@ -8,7 +9,7 @@ namespace Terminal.Gui; /// /// /// -/// FrameView has set to and +/// FrameView has set to and /// inherits it's scheme from the . /// /// @@ -19,7 +20,7 @@ namespace Terminal.Gui; public class FrameView : View { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// layout. /// public FrameView () diff --git a/Terminal.Gui/Views/GraphView/Annotations.cs b/Terminal.Gui/Views/GraphView/Annotations.cs deleted file mode 100644 index f01f1075c..000000000 --- a/Terminal.Gui/Views/GraphView/Annotations.cs +++ /dev/null @@ -1,240 +0,0 @@ -namespace Terminal.Gui; - -/// -/// Describes an overlay element that is rendered either before or after a series. -/// -/// Annotations can be positioned either in screen space (e.g. a legend) or in graph space (e.g. a line showing -/// high point) -/// -/// Unlike , annotations are allowed to draw into graph margins -/// -public interface IAnnotation -{ - /// - /// True if annotation should be drawn before . This allows Series and later annotations to - /// potentially draw over the top of this annotation. - /// - bool BeforeSeries { get; } - - /// - /// Called once after series have been rendered (or before if is true). Use - /// to draw and to avoid drawing outside of graph - /// - /// - void Render (GraphView graph); -} - -/// Displays text at a given position (in screen space or graph space) -public class TextAnnotation : IAnnotation -{ - /// - /// The location in graph space to draw the . This annotation will only show if the point is in - /// the current viewable area of the graph presented in the - /// - public PointF GraphPosition { get; set; } - - /// - /// The location on screen to draw the regardless of scroll/zoom settings. This overrides - /// if specified. - /// - public Point? ScreenPosition { get; set; } - - /// Text to display on the graph - public string Text { get; set; } - - /// True to add text before plotting series. Defaults to false - public bool BeforeSeries { get; set; } - - /// Draws the annotation - /// - public void Render (GraphView graph) - { - if (ScreenPosition.HasValue) - { - DrawText (graph, ScreenPosition.Value.X, ScreenPosition.Value.Y); - - return; - } - - Point screenPos = graph.GraphSpaceToScreen (GraphPosition); - DrawText (graph, screenPos.X, screenPos.Y); - } - - /// - /// Draws the at the given coordinates with truncation to avoid spilling over - /// of the - /// - /// - /// Screen x position to start drawing string - /// Screen y position to start drawing string - protected void DrawText (GraphView graph, int x, int y) - { - // the draw point is out of control bounds - if (!graph.Viewport.Contains (new Point (x, y))) - { - return; - } - - // There is no text to draw - if (string.IsNullOrWhiteSpace (Text)) - { - return; - } - - graph.Move (x, y); - - int availableWidth = graph.Viewport.Width - x; - - if (availableWidth <= 0) - { - return; - } - - if (Text.Length < availableWidth) - { - graph.Driver?.AddStr (Text); - } - else - { - graph.Driver?.AddStr (Text.Substring (0, availableWidth)); - } - } -} - -/// A box containing symbol definitions e.g. meanings for colors in a graph. The 'Key' to the graph -public class LegendAnnotation : View, IAnnotation -{ - /// Ordered collection of entries that are rendered in the legend. - private readonly List> _entries = new (); - - /// Creates a new empty legend at the empty screen coordinates. - public LegendAnnotation () : this (Rectangle.Empty) { } - - /// Creates a new empty legend at the given screen coordinates. - /// - /// Defines the area available for the legend to render in (within the graph). This is in - /// screen units (i.e. not graph space) - /// - public LegendAnnotation (Rectangle legendBounds) - { - X = legendBounds.X; - Y = legendBounds.Y; - Width = legendBounds.Width; - Height = legendBounds.Height; - BorderStyle = LineStyle.Single; - } - - /// Returns false i.e. Legends render after series - public bool BeforeSeries => false; - - // BUGBUG: Legend annotations are subviews. But for some reason the are rendered directly in OnDrawContent - // BUGBUG: instead of just being normal subviews. They get rendered as blank rects and thus we disable subview drawing. - /// - protected override bool OnDrawingText () { return true; } - - // BUGBUG: Legend annotations are subviews. But for some reason the are rendered directly in OnDrawContent - // BUGBUG: instead of just being normal subviews. They get rendered as blank rects and thus we disable subview drawing. - /// - protected override bool OnClearingViewport () { return true; } - - - /// Draws the Legend and all entries into the area within - /// - public void Render (GraphView graph) - { - if (!IsInitialized) - { - // BUGBUG: We should be getting a visual role here? - SetScheme (new Scheme { Normal = Application.Driver?.GetAttribute () ?? Attribute.Default}); - graph.Add (this); - } - - if (BorderStyle != LineStyle.None) - { - DrawAdornments (); - RenderLineCanvas (); - } - - var linesDrawn = 0; - - foreach (Tuple entry in _entries) - { - if (entry.Item1.Color.HasValue) - { - SetAttribute (entry.Item1.Color.Value); - } - else - { - graph.SetDriverColorToGraphColor (); - } - - // add the symbol - AddRune (0, linesDrawn, entry.Item1.Rune); - - // switch to normal coloring (for the text) - graph.SetDriverColorToGraphColor (); - - // add the text - Move (1, linesDrawn); - - string str = TextFormatter.ClipOrPad (entry.Item2, Viewport.Width - 1); - Application.Driver?.AddStr (str); - - linesDrawn++; - - // Legend has run out of space - if (linesDrawn >= Viewport.Height) - { - break; - } - } - } - - /// Adds an entry into the legend. Duplicate entries are permissible - /// The symbol appearing on the graph that should appear in the legend - /// - /// Text to render on this line of the legend. Will be truncated if outside of Legend - /// - /// - public void AddEntry (GraphCellToRender graphCellToRender, string text) { _entries.Add (Tuple.Create (graphCellToRender, text)); } -} - -/// Sequence of lines to connect points e.g. of a -public class PathAnnotation : IAnnotation -{ - /// Color for the line that connects points - public Attribute? LineColor { get; set; } - - /// The symbol that gets drawn along the line, defaults to '.' - public Rune LineRune { get; set; } = new ('.'); - - /// Points that should be connected. Lines will be drawn between points in the order they appear in the list - public List Points { get; set; } = new (); - - /// True to add line before plotting series. Defaults to false - public bool BeforeSeries { get; set; } - - /// Draws lines connecting each of the - /// - public void Render (GraphView graph) - { - graph.SetAttribute (LineColor ?? graph.GetAttributeForRole(VisualRole.Normal)); - - foreach (LineF line in PointsToLines ()) - { - Point start = graph.GraphSpaceToScreen (line.Start); - Point end = graph.GraphSpaceToScreen (line.End); - graph.DrawLine (start, end, LineRune); - } - } - - /// Generates lines joining - /// - private IEnumerable PointsToLines () - { - for (var i = 0; i < Points.Count - 1; i++) - { - yield return new LineF (Points [i], Points [i + 1]); - } - } -} diff --git a/Terminal.Gui/Views/GraphView/Axis.cs b/Terminal.Gui/Views/GraphView/Axis.cs index 01d78ee03..3e5d6acf2 100644 --- a/Terminal.Gui/Views/GraphView/Axis.cs +++ b/Terminal.Gui/Views/GraphView/Axis.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// Renders a continuous line with grid line ticks and labels public abstract class Axis diff --git a/Terminal.Gui/Views/GraphView/BarSeriesBar.cs b/Terminal.Gui/Views/GraphView/BarSeriesBar.cs index 386320910..efe17b59c 100644 --- a/Terminal.Gui/Views/GraphView/BarSeriesBar.cs +++ b/Terminal.Gui/Views/GraphView/BarSeriesBar.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// A single bar in a public class BarSeriesBar diff --git a/Terminal.Gui/Views/GraphView/GraphCellToRender.cs b/Terminal.Gui/Views/GraphView/GraphCellToRender.cs index 4cd116698..8bf4d99e9 100644 --- a/Terminal.Gui/Views/GraphView/GraphCellToRender.cs +++ b/Terminal.Gui/Views/GraphView/GraphCellToRender.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Describes how to render a single row/column of a based on the value(s) in diff --git a/Terminal.Gui/Views/GraphView/GraphView.cs b/Terminal.Gui/Views/GraphView/GraphView.cs index 8b83e0f6b..dfd6bab9b 100644 --- a/Terminal.Gui/Views/GraphView/GraphView.cs +++ b/Terminal.Gui/Views/GraphView/GraphView.cs @@ -1,7 +1,8 @@ #nullable enable -namespace Terminal.Gui; -/// View for rendering graphs (bar, scatter, etc...). +namespace Terminal.Gui.Views; + +/// Displays graphs (bar, scatter, etc...) with flexible labels, scaling, and scrolling public class GraphView : View, IDesignable { /// Creates a new graph with a 1 to 1 graph space with absolute layout. @@ -9,8 +10,8 @@ public class GraphView : View, IDesignable { CanFocus = true; - AxisX = new HorizontalAxis (); - AxisY = new VerticalAxis (); + AxisX = new (); + AxisY = new (); // Things this view knows how to do AddCommand ( @@ -188,12 +189,12 @@ public class GraphView : View, IDesignable /// public Point GraphSpaceToScreen (PointF location) { - return new Point ( - (int)((location.X - ScrollOffset.X) / CellSize.X) + (int)MarginLeft, + return new ( + (int)((location.X - ScrollOffset.X) / CellSize.X) + (int)MarginLeft, - // screen coordinates are top down while graph coordinates are bottom up - Viewport.Height - 1 - (int)MarginBottom - (int)((location.Y - ScrollOffset.Y) / CellSize.Y) - ); + // screen coordinates are top down while graph coordinates are bottom up + Viewport.Height - 1 - (int)MarginBottom - (int)((location.Y - ScrollOffset.Y) / CellSize.Y) + ); } /// @@ -201,7 +202,7 @@ public class GraphView : View, IDesignable { if (CellSize.X == 0 || CellSize.Y == 0) { - throw new Exception ($"{nameof (CellSize)} cannot be 0"); + throw new ($"{nameof (CellSize)} cannot be 0"); } SetDriverColorToGraphColor (); @@ -212,7 +213,7 @@ public class GraphView : View, IDesignable for (var i = 0; i < Viewport.Height; i++) { Move (0, i); - Driver?.AddStr (new string (' ', Viewport.Width)); + Driver?.AddStr (new (' ', Viewport.Width)); } // If there is no data do not display a graph @@ -275,6 +276,7 @@ public class GraphView : View, IDesignable { a.Render (this); } + return true; } @@ -290,8 +292,8 @@ public class GraphView : View, IDesignable /// public void Reset () { - ScrollOffset = new PointF (0, 0); - CellSize = new PointF (1, 1); + ScrollOffset = new (0, 0); + CellSize = new (1, 1); AxisX.Reset (); AxisY.Reset (); Series.Clear (); @@ -389,5 +391,4 @@ public class GraphView : View, IDesignable return true; } - } diff --git a/Terminal.Gui/Views/GraphView/IAnnotation.cs b/Terminal.Gui/Views/GraphView/IAnnotation.cs new file mode 100644 index 000000000..9ebfe4904 --- /dev/null +++ b/Terminal.Gui/Views/GraphView/IAnnotation.cs @@ -0,0 +1,25 @@ +namespace Terminal.Gui.Views; + +/// +/// Describes an overlay element that is rendered either before or after a series. +/// +/// Annotations can be positioned either in screen space (e.g. a legend) or in graph space (e.g. a line showing +/// high point) +/// +/// Unlike , annotations are allowed to draw into graph margins +/// +public interface IAnnotation +{ + /// + /// True if annotation should be drawn before . This allows Series and later annotations to + /// potentially draw over the top of this annotation. + /// + bool BeforeSeries { get; } + + /// + /// Called once after series have been rendered (or before if is true). Use + /// to draw and to avoid drawing outside of graph + /// + /// + void Render (GraphView graph); +} diff --git a/Terminal.Gui/Views/GraphView/LegendAnnotation.cs b/Terminal.Gui/Views/GraphView/LegendAnnotation.cs new file mode 100644 index 000000000..813228f7d --- /dev/null +++ b/Terminal.Gui/Views/GraphView/LegendAnnotation.cs @@ -0,0 +1,100 @@ +namespace Terminal.Gui.Views; + +/// +/// Used by to render smbol definitions in a graph, e.g. colors and their meanings +/// +public class LegendAnnotation : View, IAnnotation +{ + /// Ordered collection of entries that are rendered in the legend. + private readonly List> _entries = new (); + + /// Creates a new empty legend at the empty screen coordinates. + public LegendAnnotation () : this (Rectangle.Empty) { } + + /// Creates a new empty legend at the given screen coordinates. + /// + /// Defines the area available for the legend to render in (within the graph). This is in + /// screen units (i.e. not graph space) + /// + public LegendAnnotation (Rectangle legendBounds) + { + X = legendBounds.X; + Y = legendBounds.Y; + Width = legendBounds.Width; + Height = legendBounds.Height; + BorderStyle = LineStyle.Single; + } + + /// Returns false i.e. Legends render after series + public bool BeforeSeries => false; + + // BUGBUG: Legend annotations are subviews. But for some reason the are rendered directly in OnDrawContent + // BUGBUG: instead of just being normal subviews. They get rendered as blank rects and thus we disable subview drawing. + /// + protected override bool OnDrawingText () { return true; } + + // BUGBUG: Legend annotations are subviews. But for some reason the are rendered directly in OnDrawContent + // BUGBUG: instead of just being normal subviews. They get rendered as blank rects and thus we disable subview drawing. + /// + protected override bool OnClearingViewport () { return true; } + + /// Draws the Legend and all entries into the area within + /// + public void Render (GraphView graph) + { + if (!IsInitialized) + { + // BUGBUG: We should be getting a visual role here? + SetScheme (new() { Normal = Application.Driver?.GetAttribute () ?? Attribute.Default }); + graph.Add (this); + } + + if (BorderStyle != LineStyle.None) + { + DrawAdornments (); + RenderLineCanvas (); + } + + var linesDrawn = 0; + + foreach (Tuple entry in _entries) + { + if (entry.Item1.Color.HasValue) + { + SetAttribute (entry.Item1.Color.Value); + } + else + { + graph.SetDriverColorToGraphColor (); + } + + // add the symbol + AddRune (0, linesDrawn, entry.Item1.Rune); + + // switch to normal coloring (for the text) + graph.SetDriverColorToGraphColor (); + + // add the text + Move (1, linesDrawn); + + string str = TextFormatter.ClipOrPad (entry.Item2, Viewport.Width - 1); + Application.Driver?.AddStr (str); + + linesDrawn++; + + // Legend has run out of space + if (linesDrawn >= Viewport.Height) + { + break; + } + } + } + + /// Adds an entry into the legend. Duplicate entries are permissible + /// The symbol appearing on the graph that should appear in the legend + /// + /// Text to render on this line of the legend. Will be truncated if outside of Legend + /// + /// + public void AddEntry (GraphCellToRender graphCellToRender, string text) { _entries.Add (Tuple.Create (graphCellToRender, text)); } +} diff --git a/Terminal.Gui/Views/GraphView/LineF.cs b/Terminal.Gui/Views/GraphView/LineF.cs index 343d37211..67ef51cd1 100644 --- a/Terminal.Gui/Views/GraphView/LineF.cs +++ b/Terminal.Gui/Views/GraphView/LineF.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Describes two points in graph space and a line between them public class LineF diff --git a/Terminal.Gui/Views/GraphView/PathAnnotation.cs b/Terminal.Gui/Views/GraphView/PathAnnotation.cs new file mode 100644 index 000000000..4a623f7df --- /dev/null +++ b/Terminal.Gui/Views/GraphView/PathAnnotation.cs @@ -0,0 +1,41 @@ +namespace Terminal.Gui.Views; + +/// Sequence of lines to connect points e.g. of a +public class PathAnnotation : IAnnotation +{ + /// Color for the line that connects points + public Attribute? LineColor { get; set; } + + /// The symbol that gets drawn along the line, defaults to '.' + public Rune LineRune { get; set; } = new ('.'); + + /// Points that should be connected. Lines will be drawn between points in the order they appear in the list + public List Points { get; set; } = new (); + + /// True to add line before plotting series. Defaults to false + public bool BeforeSeries { get; set; } + + /// Draws lines connecting each of the + /// + public void Render (GraphView graph) + { + graph.SetAttribute (LineColor ?? graph.GetAttributeForRole (VisualRole.Normal)); + + foreach (LineF line in PointsToLines ()) + { + Point start = graph.GraphSpaceToScreen (line.Start); + Point end = graph.GraphSpaceToScreen (line.End); + graph.DrawLine (start, end, LineRune); + } + } + + /// Generates lines joining + /// + private IEnumerable PointsToLines () + { + for (var i = 0; i < Points.Count - 1; i++) + { + yield return new (Points [i], Points [i + 1]); + } + } +} diff --git a/Terminal.Gui/Views/GraphView/Series.cs b/Terminal.Gui/Views/GraphView/Series.cs index 194bfeac2..187d6e6be 100644 --- a/Terminal.Gui/Views/GraphView/Series.cs +++ b/Terminal.Gui/Views/GraphView/Series.cs @@ -1,6 +1,6 @@ using System.Collections.ObjectModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; #nullable enable /// Describes a series of data that can be rendered into a > public interface ISeries diff --git a/Terminal.Gui/Views/GraphView/TextAnnotation.cs b/Terminal.Gui/Views/GraphView/TextAnnotation.cs new file mode 100644 index 000000000..91ae17c98 --- /dev/null +++ b/Terminal.Gui/Views/GraphView/TextAnnotation.cs @@ -0,0 +1,78 @@ +namespace Terminal.Gui.Views; + +/// Displays text at a given position (in screen space or graph space) +public class TextAnnotation : IAnnotation +{ + /// + /// The location in graph space to draw the . This annotation will only show if the point is in + /// the current viewable area of the graph presented in the + /// + public PointF GraphPosition { get; set; } + + /// + /// The location on screen to draw the regardless of scroll/zoom settings. This overrides + /// if specified. + /// + public Point? ScreenPosition { get; set; } + + /// Text to display on the graph + public string Text { get; set; } + + /// True to add text before plotting series. Defaults to false + public bool BeforeSeries { get; set; } + + /// Draws the annotation + /// + public void Render (GraphView graph) + { + if (ScreenPosition.HasValue) + { + DrawText (graph, ScreenPosition.Value.X, ScreenPosition.Value.Y); + + return; + } + + Point screenPos = graph.GraphSpaceToScreen (GraphPosition); + DrawText (graph, screenPos.X, screenPos.Y); + } + + /// + /// Draws the at the given coordinates with truncation to avoid spilling over + /// of the + /// + /// + /// Screen x position to start drawing string + /// Screen y position to start drawing string + protected void DrawText (GraphView graph, int x, int y) + { + // the draw point is out of control bounds + if (!graph.Viewport.Contains (new Point (x, y))) + { + return; + } + + // There is no text to draw + if (string.IsNullOrWhiteSpace (Text)) + { + return; + } + + graph.Move (x, y); + + int availableWidth = graph.Viewport.Width - x; + + if (availableWidth <= 0) + { + return; + } + + if (Text.Length < availableWidth) + { + graph.Driver?.AddStr (Text); + } + else + { + graph.Driver?.AddStr (Text.Substring (0, availableWidth)); + } + } +} diff --git a/Terminal.Gui/Views/HexView.cs b/Terminal.Gui/Views/HexView.cs index 9e275614c..cf645b03d 100644 --- a/Terminal.Gui/Views/HexView.cs +++ b/Terminal.Gui/Views/HexView.cs @@ -7,19 +7,17 @@ // TODO: Support shrinking the stream (e.g. del/backspace should work). // -using System; using System.Buffers; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; -/// Hex viewer and editor over a +/// +/// Provides a hex editor with the left side +/// showing the hex values of the bytes in a `Stream` and the right side showing the contents +/// (filtered +/// to printable Unicode glyphs). +/// /// -/// -/// provides a hex editor on top of a seekable with the left side -/// showing the hex values of the bytes in the and the right side showing the contents -/// (filtered -/// to non-control sequence ASCII characters). -/// /// Users can switch from one side to the other by using the tab key. /// /// To enable editing, set to true. When is true the user can @@ -456,7 +454,7 @@ public class HexView : View, IDesignable for (var line = 0; line < Viewport.Height; line++) { - int max = -Viewport.X; + int max = -Viewport.X; Move (max, line); long addressOfLine = addressOfFirstLine + line * nBlocks * NUM_BYTES_PER_HEX_COLUMN; @@ -526,18 +524,18 @@ public class HexView : View, IDesignable // break; case > 127: + { + byte [] utf8 = GetData (data, offset, 4, out bool _); + + OperationStatus status = Rune.DecodeFromUtf8 (utf8, out c, out utf8BytesConsumed); + + while (status == OperationStatus.NeedMoreData) { - byte [] utf8 = GetData (data, offset, 4, out bool _); - - OperationStatus status = Rune.DecodeFromUtf8 (utf8, out c, out utf8BytesConsumed); - - while (status == OperationStatus.NeedMoreData) - { - status = Rune.DecodeFromUtf8 (utf8, out c, out utf8BytesConsumed); - } - - break; + status = Rune.DecodeFromUtf8 (utf8, out c, out utf8BytesConsumed); } + + break; + } default: Rune.DecodeFromUtf8 (new (ref b), out c, out _); @@ -565,6 +563,7 @@ public class HexView : View, IDesignable } SetAttribute (editingAttribute); + // Fill rest of line for (int x = max; x < Viewport.Width; x++) { diff --git a/Terminal.Gui/Views/HexViewEventArgs.cs b/Terminal.Gui/Views/HexViewEventArgs.cs index 49586aac9..11e372115 100644 --- a/Terminal.Gui/Views/HexViewEventArgs.cs +++ b/Terminal.Gui/Views/HexViewEventArgs.cs @@ -6,7 +6,7 @@ // - Bug showing the last line // -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Defines the event arguments for event. public class HexViewEventArgs : EventArgs diff --git a/Terminal.Gui/Views/IListDataSource.cs b/Terminal.Gui/Views/IListDataSource.cs index 981642f0b..37f1a63d6 100644 --- a/Terminal.Gui/Views/IListDataSource.cs +++ b/Terminal.Gui/Views/IListDataSource.cs @@ -2,7 +2,7 @@ using System.Collections; using System.Collections.Specialized; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Implement to provide custom rendering for a . public interface IListDataSource : IDisposable diff --git a/Terminal.Gui/Views/Label.cs b/Terminal.Gui/Views/Label.cs index 973b80289..0483f42cb 100644 --- a/Terminal.Gui/Views/Label.cs +++ b/Terminal.Gui/Views/Label.cs @@ -1,10 +1,9 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// -/// The Label displays text that describes the View next in the . When -/// Label -/// receives a command it will pass it to the next in -/// . +/// Displays text that describes the View next in the . When +/// the user presses a hotkey that matches the of the Label, the next in +/// will be activated. /// /// /// @@ -35,7 +34,7 @@ public class Label : View, IDesignable { if (!CanFocus) { - e.Handled = InvokeCommand (Command.HotKey, new ([Command.HotKey], this, data: this)) == true; + e.Handled = InvokeCommand (Command.HotKey, new ([Command.HotKey], this, this)) == true; } } diff --git a/Terminal.Gui/Views/Line.cs b/Terminal.Gui/Views/Line.cs index 45d2fa3cf..3301aaf56 100644 --- a/Terminal.Gui/Views/Line.cs +++ b/Terminal.Gui/Views/Line.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Draws a single line using the specified by . diff --git a/Terminal.Gui/Views/LineView.cs b/Terminal.Gui/Views/LineView.cs index 77cbfed96..e90e99970 100644 --- a/Terminal.Gui/Views/LineView.cs +++ b/Terminal.Gui/Views/LineView.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// A straight line control either horizontal or vertical public class LineView : View diff --git a/Terminal.Gui/Views/ListView.cs b/Terminal.Gui/Views/ListView.cs index a48be3d89..d337ea9ce 100644 --- a/Terminal.Gui/Views/ListView.cs +++ b/Terminal.Gui/Views/ListView.cs @@ -2,10 +2,10 @@ using System.Collections; using System.Collections.ObjectModel; using System.Collections.Specialized; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// -/// ListView renders a scrollable list of data where each item can be activated to perform an +/// Provides a scrollable list of data where each item can be activated to perform an /// action. /// /// diff --git a/Terminal.Gui/Views/ListViewEventArgs.cs b/Terminal.Gui/Views/ListViewEventArgs.cs index 89e32936a..fe83de580 100644 --- a/Terminal.Gui/Views/ListViewEventArgs.cs +++ b/Terminal.Gui/Views/ListViewEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// for events. public class ListViewItemEventArgs : EventArgs diff --git a/Terminal.Gui/Views/Menu/MenuBarItemv2.cs b/Terminal.Gui/Views/Menu/MenuBarItemv2.cs index 8130dae0c..ca82d7fc3 100644 --- a/Terminal.Gui/Views/Menu/MenuBarItemv2.cs +++ b/Terminal.Gui/Views/Menu/MenuBarItemv2.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// A -derived object to be used as items in a . @@ -153,14 +154,23 @@ public class MenuBarItemv2 : MenuItemv2 } } + /// + /// + /// public void RaisePopoverMenuOpenChanged () { OnPopoverMenuOpenChanged(); PopoverMenuOpenChanged?.Invoke (this, new EventArgs (PopoverMenuOpen)); } + /// + /// + /// protected virtual void OnPopoverMenuOpenChanged () {} + /// + /// + /// public event EventHandler>? PopoverMenuOpenChanged; /// diff --git a/Terminal.Gui/Views/Menu/MenuBarv2.cs b/Terminal.Gui/Views/Menu/MenuBarv2.cs index 90eb15b7e..7f3392913 100644 --- a/Terminal.Gui/Views/Menu/MenuBarv2.cs +++ b/Terminal.Gui/Views/Menu/MenuBarv2.cs @@ -2,7 +2,7 @@ using System.ComponentModel; using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// A horizontal list of s. Each can have a diff --git a/Terminal.Gui/Views/Menu/MenuItemv2.cs b/Terminal.Gui/Views/Menu/MenuItemv2.cs index 06f69b99b..c5f472307 100644 --- a/Terminal.Gui/Views/Menu/MenuItemv2.cs +++ b/Terminal.Gui/Views/Menu/MenuItemv2.cs @@ -1,9 +1,8 @@ #nullable enable using System.ComponentModel; -using Terminal.Gui.Resources; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// A -derived object to be used as a menu item in a . Has title, an diff --git a/Terminal.Gui/Views/Menu/Menuv2.cs b/Terminal.Gui/Views/Menu/Menuv2.cs index b3ddd120b..7a0b0b1f1 100644 --- a/Terminal.Gui/Views/Menu/Menuv2.cs +++ b/Terminal.Gui/Views/Menu/Menuv2.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// A -derived object to be used as a vertically-oriented menu. Each subview is a . diff --git a/Terminal.Gui/Views/Menu/PopoverMenu.cs b/Terminal.Gui/Views/Menu/PopoverMenu.cs index 3a97e842b..c2bd0d5ed 100644 --- a/Terminal.Gui/Views/Menu/PopoverMenu.cs +++ b/Terminal.Gui/Views/Menu/PopoverMenu.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Provides a cascading menu that pops over all other content. Can be used as a context menu or a drop-down diff --git a/Terminal.Gui/Views/Menuv1/Menu.cs b/Terminal.Gui/Views/Menuv1/Menu.cs index 44d431366..54bd6ed6d 100644 --- a/Terminal.Gui/Views/Menuv1/Menu.cs +++ b/Terminal.Gui/Views/Menuv1/Menu.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; #pragma warning disable CS0618 // Type or member is obsolete diff --git a/Terminal.Gui/Views/Menuv1/MenuBar.cs b/Terminal.Gui/Views/Menuv1/MenuBar.cs index f376aef0e..b9d233e70 100644 --- a/Terminal.Gui/Views/Menuv1/MenuBar.cs +++ b/Terminal.Gui/Views/Menuv1/MenuBar.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Provides a menu bar that spans the top of a View with drop-down and cascading menus. diff --git a/Terminal.Gui/Views/Menuv1/MenuBarItem.cs b/Terminal.Gui/Views/Menuv1/MenuBarItem.cs index 0a284bed3..8b3be2116 100644 --- a/Terminal.Gui/Views/Menuv1/MenuBarItem.cs +++ b/Terminal.Gui/Views/Menuv1/MenuBarItem.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// is a menu item on . MenuBarItems do not support diff --git a/Terminal.Gui/Views/Menuv1/MenuClosingEventArgs.cs b/Terminal.Gui/Views/Menuv1/MenuClosingEventArgs.cs index c6f005eee..0a830c2b8 100644 --- a/Terminal.Gui/Views/Menuv1/MenuClosingEventArgs.cs +++ b/Terminal.Gui/Views/Menuv1/MenuClosingEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; #pragma warning disable CS0618 // Type or member is obsolete diff --git a/Terminal.Gui/Views/Menuv1/MenuItem.cs b/Terminal.Gui/Views/Menuv1/MenuItem.cs index 7f5742f45..cc9b345df 100644 --- a/Terminal.Gui/Views/Menuv1/MenuItem.cs +++ b/Terminal.Gui/Views/Menuv1/MenuItem.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// A has title, an associated help text, and an action to execute on activation. MenuItems diff --git a/Terminal.Gui/Views/Menuv1/MenuItemCheckStyle.cs b/Terminal.Gui/Views/Menuv1/MenuItemCheckStyle.cs index f7b7b5210..87bc5168e 100644 --- a/Terminal.Gui/Views/Menuv1/MenuItemCheckStyle.cs +++ b/Terminal.Gui/Views/Menuv1/MenuItemCheckStyle.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Specifies how a shows selection state. [Flags] diff --git a/Terminal.Gui/Views/Menuv1/MenuOpenedEventArgs.cs b/Terminal.Gui/Views/Menuv1/MenuOpenedEventArgs.cs index 4e9879847..ba6c4adcf 100644 --- a/Terminal.Gui/Views/Menuv1/MenuOpenedEventArgs.cs +++ b/Terminal.Gui/Views/Menuv1/MenuOpenedEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; #pragma warning disable CS0618 // Type or member is obsolete /// Defines arguments for the event diff --git a/Terminal.Gui/Views/Menuv1/MenuOpeningEventArgs.cs b/Terminal.Gui/Views/Menuv1/MenuOpeningEventArgs.cs index 8956e0190..e19421caa 100644 --- a/Terminal.Gui/Views/Menuv1/MenuOpeningEventArgs.cs +++ b/Terminal.Gui/Views/Menuv1/MenuOpeningEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; #pragma warning disable CS0618 // Type or member is obsolete diff --git a/Terminal.Gui/Views/MessageBox.cs b/Terminal.Gui/Views/MessageBox.cs index 3c52b2bd5..55a865441 100644 --- a/Terminal.Gui/Views/MessageBox.cs +++ b/Terminal.Gui/Views/MessageBox.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// MessageBox displays a modal message to the user, with a title, a message and a series of options that the user diff --git a/Terminal.Gui/Views/NumericUpDown.cs b/Terminal.Gui/Views/NumericUpDown.cs index 5e6155913..a1099bef3 100644 --- a/Terminal.Gui/Views/NumericUpDown.cs +++ b/Terminal.Gui/Views/NumericUpDown.cs @@ -1,10 +1,10 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// -/// Enables the user to increase or decrease a value with the mouse or keyboard. +/// Enables the user to increase or decrease a value with the mouse or keyboard in type-safe way. /// /// /// Supports the following types: , , , , diff --git a/Terminal.Gui/Views/OptionSelector.cs b/Terminal.Gui/Views/OptionSelector.cs index 2142f89a6..0d6491261 100644 --- a/Terminal.Gui/Views/OptionSelector.cs +++ b/Terminal.Gui/Views/OptionSelector.cs @@ -1,7 +1,7 @@ #nullable enable using System.Diagnostics; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Provides a user interface for displaying and selecting a single item from a list of options. @@ -317,7 +317,7 @@ public class OptionSelector : View, IOrientation, IDesignable public bool EnableForDesign () { AssignHotKeysToCheckBoxes = true; - Options = new [] { "Option 1", "Option 2", "Option 3" }; + Options = ["Option 1", "Option 2", "Third Option", "Option Quattro"]; return true; } diff --git a/Terminal.Gui/Views/ProgressBar.cs b/Terminal.Gui/Views/ProgressBar.cs index 07e2164b5..0d78b2c93 100644 --- a/Terminal.Gui/Views/ProgressBar.cs +++ b/Terminal.Gui/Views/ProgressBar.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// Specifies the style that a uses to indicate the progress of an operation. public enum ProgressBarStyle @@ -78,7 +79,7 @@ public class ProgressBar : View, IDesignable /// Specifies the format that a uses to indicate the visual presentation. public ProgressBarFormat ProgressBarFormat { get; set; } = ProgressBarFormat.Simple; - /// Gets/Sets the progress bar style based on the + /// Gets/Sets the progress bar style based on the public ProgressBarStyle ProgressBarStyle { get => _progressBarStyle; diff --git a/Terminal.Gui/Views/RadioGroup.cs b/Terminal.Gui/Views/RadioGroup.cs index 53205bf3d..b3c522b25 100644 --- a/Terminal.Gui/Views/RadioGroup.cs +++ b/Terminal.Gui/Views/RadioGroup.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// Displays a list of mutually-exclusive items. Each items can have its own hotkey. public class RadioGroup : View, IDesignable, IOrientation diff --git a/Terminal.Gui/Views/ReadOnlyCollectionExtensions.cs b/Terminal.Gui/Views/ReadOnlyCollectionExtensions.cs index 58dd33e6c..6eb572e29 100644 --- a/Terminal.Gui/Views/ReadOnlyCollectionExtensions.cs +++ b/Terminal.Gui/Views/ReadOnlyCollectionExtensions.cs @@ -1,7 +1,17 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; -internal static class ReadOnlyCollectionExtensions +/// +/// Extends with methods to find the index of an element. +/// +public static class ReadOnlyCollectionExtensions { + /// + /// Returns the index of the first element in the collection that matches the specified predicate. + /// + /// + /// + /// + /// public static int IndexOf (this IReadOnlyCollection self, Func predicate) { var i = 0; @@ -19,6 +29,13 @@ internal static class ReadOnlyCollectionExtensions return -1; } + /// + /// Returns the index of the first element in the collection that matches the specified predicate. + /// + /// + /// + /// + /// public static int IndexOf (this IReadOnlyCollection self, T toFind) { var i = 0; diff --git a/Terminal.Gui/Views/ScrollBar/ScrollBar.cs b/Terminal.Gui/Views/ScrollBar/ScrollBar.cs index 6e84aa677..8d36f41b8 100644 --- a/Terminal.Gui/Views/ScrollBar/ScrollBar.cs +++ b/Terminal.Gui/Views/ScrollBar/ScrollBar.cs @@ -2,7 +2,7 @@ using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Indicates the size of scrollable content and controls the position of the visible content, either vertically or diff --git a/Terminal.Gui/Views/ScrollBar/ScrollSlider.cs b/Terminal.Gui/Views/ScrollBar/ScrollSlider.cs index da5314eab..db0511a51 100644 --- a/Terminal.Gui/Views/ScrollBar/ScrollSlider.cs +++ b/Terminal.Gui/Views/ScrollBar/ScrollSlider.cs @@ -2,18 +2,13 @@ using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// -/// The ScrollSlider can be dragged with the mouse, constrained by the size of the Viewport of it's superview. The -/// ScrollSlider can be +/// Represents the proportion of the visible content to the Viewport in a . +/// Can be dragged with the mouse, constrained by the size of the Viewport of it's superview. Can be /// oriented either vertically or horizontally. /// -/// -/// -/// Used to represent the proportion of the visible content to the Viewport in a . -/// -/// public class ScrollSlider : View, IOrientation, IDesignable { /// diff --git a/Terminal.Gui/Views/SelectedItemChangedArgs.cs b/Terminal.Gui/Views/SelectedItemChangedArgs.cs index dca578b2d..691dea2f6 100644 --- a/Terminal.Gui/Views/SelectedItemChangedArgs.cs +++ b/Terminal.Gui/Views/SelectedItemChangedArgs.cs @@ -1,5 +1,5 @@ #nullable enable -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Event arguments for the SelectedItemChanged event. public class SelectedItemChangedArgs : EventArgs diff --git a/Terminal.Gui/Views/Shortcut.cs b/Terminal.Gui/Views/Shortcut.cs index 10dddc318..c031cd737 100644 --- a/Terminal.Gui/Views/Shortcut.cs +++ b/Terminal.Gui/Views/Shortcut.cs @@ -1,7 +1,7 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Displays a command, help text, and a key binding. When the key specified by is pressed, the @@ -25,7 +25,7 @@ namespace Terminal.Gui; /// /// By default, a Shortcut displays the command text on the left side, the help text in the middle, and the key /// binding on the -/// right side. Set to to reverse the order. +/// right side. Set to to reverse the order. /// /// /// The command text can be set by setting the 's Text property or by setting @@ -473,7 +473,7 @@ public class Shortcut : View, IOrientation, IDesignable { CommandView.Margin.Thickness = GetMarginThickness (); // strip off ViewportSettings.TransparentMouse - CommandView.Margin.ViewportSettings &= ~ViewportSettings.TransparentMouse; + CommandView.Margin.ViewportSettings &= ~ViewportSettingsFlags.TransparentMouse; } CommandView.X = Pos.Align (Alignment.End, AlignmentModes); @@ -535,7 +535,7 @@ public class Shortcut : View, IOrientation, IDesignable { HelpView.Margin.Thickness = GetMarginThickness (); // strip off ViewportSettings.TransparentMouse - HelpView.Margin.ViewportSettings &= ~ViewportSettings.TransparentMouse; + HelpView.Margin.ViewportSettings &= ~ViewportSettingsFlags.TransparentMouse; } HelpView.X = Pos.Align (Alignment.End, AlignmentModes); @@ -668,7 +668,7 @@ public class Shortcut : View, IOrientation, IDesignable { KeyView.Margin.Thickness = GetMarginThickness (); // strip off ViewportSettings.TransparentMouse - KeyView.Margin.ViewportSettings &= ~ViewportSettings.TransparentMouse; + KeyView.Margin.ViewportSettings &= ~ViewportSettingsFlags.TransparentMouse; } KeyView.X = Pos.Align (Alignment.End, AlignmentModes); diff --git a/Terminal.Gui/Views/Slider.cs b/Terminal.Gui/Views/Slider/Slider.cs similarity index 99% rename from Terminal.Gui/Views/Slider.cs rename to Terminal.Gui/Views/Slider/Slider.cs index 83ff44670..4dff5965e 100644 --- a/Terminal.Gui/Views/Slider.cs +++ b/Terminal.Gui/Views/Slider/Slider.cs @@ -1,8 +1,11 @@ using System.Transactions; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; -/// Slider control. +/// +/// Provides a slider control letting the user navigate from a set of typed options in a linear manner using the +/// keyboard or mouse. +/// public class Slider : Slider { /// Initializes a new instance of the class. @@ -17,7 +20,7 @@ public class Slider : Slider } /// -/// Provides a slider control letting the user navigate from a set of typed options in a linear manner using the +/// Provides a tpe-safe slider control letting the user navigate from a set of typed options in a linear manner using the /// keyboard or mouse. /// /// @@ -266,7 +269,7 @@ public class Slider : View, IOrientation } #endregion - /// Legends Orientation. + /// Legends Orientation. public Orientation LegendsOrientation { get => _config._legendsOrientation; diff --git a/Terminal.Gui/Views/SliderAttributes.cs b/Terminal.Gui/Views/Slider/SliderAttributes.cs similarity index 93% rename from Terminal.Gui/Views/SliderAttributes.cs rename to Terminal.Gui/Views/Slider/SliderAttributes.cs index 6f75546dd..db7f199dc 100644 --- a/Terminal.Gui/Views/SliderAttributes.cs +++ b/Terminal.Gui/Views/Slider/SliderAttributes.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Legend Style public class SliderAttributes diff --git a/Terminal.Gui/Views/SliderConfiguration.cs b/Terminal.Gui/Views/Slider/SliderConfiguration.cs similarity index 95% rename from Terminal.Gui/Views/SliderConfiguration.cs rename to Terminal.Gui/Views/Slider/SliderConfiguration.cs index 3cadafd86..2e75ada0c 100644 --- a/Terminal.Gui/Views/SliderConfiguration.cs +++ b/Terminal.Gui/Views/Slider/SliderConfiguration.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// All configuration are grouped in this class. internal class SliderConfiguration diff --git a/Terminal.Gui/Views/SliderEventArgs.cs b/Terminal.Gui/Views/Slider/SliderEventArgs.cs similarity index 96% rename from Terminal.Gui/Views/SliderEventArgs.cs rename to Terminal.Gui/Views/Slider/SliderEventArgs.cs index 76c4eed90..b4f93ca12 100644 --- a/Terminal.Gui/Views/SliderEventArgs.cs +++ b/Terminal.Gui/Views/Slider/SliderEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// for events. public class SliderEventArgs : EventArgs diff --git a/Terminal.Gui/Views/SliderOption.cs b/Terminal.Gui/Views/Slider/SliderOption.cs similarity index 98% rename from Terminal.Gui/Views/SliderOption.cs rename to Terminal.Gui/Views/Slider/SliderOption.cs index a3d10781d..95a929d6a 100644 --- a/Terminal.Gui/Views/SliderOption.cs +++ b/Terminal.Gui/Views/Slider/SliderOption.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Represents an option in a . /// Data type of the option. diff --git a/Terminal.Gui/Views/SliderOptionEventArgs.cs b/Terminal.Gui/Views/Slider/SliderOptionEventArgs.cs similarity index 93% rename from Terminal.Gui/Views/SliderOptionEventArgs.cs rename to Terminal.Gui/Views/Slider/SliderOptionEventArgs.cs index b4b5e6936..8014c2a77 100644 --- a/Terminal.Gui/Views/SliderOptionEventArgs.cs +++ b/Terminal.Gui/Views/Slider/SliderOptionEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// for events. public class SliderOptionEventArgs : EventArgs diff --git a/Terminal.Gui/Views/SliderStyle.cs b/Terminal.Gui/Views/Slider/SliderStyle.cs similarity index 97% rename from Terminal.Gui/Views/SliderStyle.cs rename to Terminal.Gui/Views/Slider/SliderStyle.cs index e6429d6cb..38c6570c3 100644 --- a/Terminal.Gui/Views/SliderStyle.cs +++ b/Terminal.Gui/Views/Slider/SliderStyle.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// Style public class SliderStyle diff --git a/Terminal.Gui/Views/SliderType.cs b/Terminal.Gui/Views/Slider/SliderType.cs similarity index 96% rename from Terminal.Gui/Views/SliderType.cs rename to Terminal.Gui/Views/Slider/SliderType.cs index 7cbde908a..7ad287a97 100644 --- a/Terminal.Gui/Views/SliderType.cs +++ b/Terminal.Gui/Views/Slider/SliderType.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Types public enum SliderType diff --git a/Terminal.Gui/Views/SpinnerView/SpinnerStyle.cs b/Terminal.Gui/Views/SpinnerView/SpinnerStyle.cs index fac2005c9..e1818daa1 100644 --- a/Terminal.Gui/Views/SpinnerView/SpinnerStyle.cs +++ b/Terminal.Gui/Views/SpinnerView/SpinnerStyle.cs @@ -27,7 +27,7 @@ #pragma warning disable CA1034 // Nested types should not be visible -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// SpinnerStyles used in a . public abstract class SpinnerStyle diff --git a/Terminal.Gui/Views/SpinnerView/SpinnerView.cs b/Terminal.Gui/Views/SpinnerView/SpinnerView.cs index f040bc807..5ee1db270 100644 --- a/Terminal.Gui/Views/SpinnerView/SpinnerView.cs +++ b/Terminal.Gui/Views/SpinnerView/SpinnerView.cs @@ -1,13 +1,14 @@ #nullable enable + //------------------------------------------------------------------------------ // Windows Terminal supports Unicode and Emoji characters, but by default // conhost shells (e.g., PowerShell and cmd.exe) do not. See // . //------------------------------------------------------------------------------ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; -/// A which displays (by default) a spinning line character. +/// Displays a spinning glyph or combinations of glyphs to indicate progress or activity /// /// By default, animation only occurs when you call . Use /// to make the automate calls to . diff --git a/Terminal.Gui/Views/SplitterEventArgs.cs b/Terminal.Gui/Views/SplitterEventArgs.cs index 305e1c436..7354209e9 100644 --- a/Terminal.Gui/Views/SplitterEventArgs.cs +++ b/Terminal.Gui/Views/SplitterEventArgs.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// Provides data for events. public class SplitterEventArgs : EventArgs diff --git a/Terminal.Gui/Views/StatusBar.cs b/Terminal.Gui/Views/StatusBar.cs index 5118ffc2d..9be738c7d 100644 --- a/Terminal.Gui/Views/StatusBar.cs +++ b/Terminal.Gui/Views/StatusBar.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// A status bar is a that snaps to the bottom of a displaying set of diff --git a/Terminal.Gui/Views/TabView/Tab.cs b/Terminal.Gui/Views/TabView/Tab.cs index 52fb0bdf9..f0025b983 100644 --- a/Terminal.Gui/Views/TabView/Tab.cs +++ b/Terminal.Gui/Views/TabView/Tab.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// A single tab in a . public class Tab : View diff --git a/Terminal.Gui/Views/TabView/TabChangedEventArgs.cs b/Terminal.Gui/Views/TabView/TabChangedEventArgs.cs index 0fe003f61..acaa90fd6 100644 --- a/Terminal.Gui/Views/TabView/TabChangedEventArgs.cs +++ b/Terminal.Gui/Views/TabView/TabChangedEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Describes a change in public class TabChangedEventArgs : EventArgs diff --git a/Terminal.Gui/Views/TabView/TabMouseEventArgs.cs b/Terminal.Gui/Views/TabView/TabMouseEventArgs.cs index 30b64d15a..df572140a 100644 --- a/Terminal.Gui/Views/TabView/TabMouseEventArgs.cs +++ b/Terminal.Gui/Views/TabView/TabMouseEventArgs.cs @@ -1,7 +1,7 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Describes a mouse event over a specific in a . public class TabMouseEventArgs : HandledEventArgs diff --git a/Terminal.Gui/Views/TabView/TabRow.cs b/Terminal.Gui/Views/TabView/TabRow.cs index a34d4075d..f85db683a 100644 --- a/Terminal.Gui/Views/TabView/TabRow.cs +++ b/Terminal.Gui/Views/TabView/TabRow.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; internal class TabRow : View { diff --git a/Terminal.Gui/Views/TabView/TabStyle.cs b/Terminal.Gui/Views/TabView/TabStyle.cs index 85404d05d..07ac12884 100644 --- a/Terminal.Gui/Views/TabView/TabStyle.cs +++ b/Terminal.Gui/Views/TabView/TabStyle.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Describes render stylistic selections of a public class TabStyle diff --git a/Terminal.Gui/Views/TabView/TabView.cs b/Terminal.Gui/Views/TabView/TabView.cs index 98ce20b21..8d0533cff 100644 --- a/Terminal.Gui/Views/TabView/TabView.cs +++ b/Terminal.Gui/Views/TabView/TabView.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// Control that hosts multiple sub views, presenting a single one at once. public class TabView : View diff --git a/Terminal.Gui/Views/TableView/CellActivatedEventArgs.cs b/Terminal.Gui/Views/TableView/CellActivatedEventArgs.cs index 94800aa6a..d5dc4eb3e 100644 --- a/Terminal.Gui/Views/TableView/CellActivatedEventArgs.cs +++ b/Terminal.Gui/Views/TableView/CellActivatedEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; // TOOD: SHould support Handled /// Defines the event arguments for event diff --git a/Terminal.Gui/Views/TableView/CellColorGetterArgs.cs b/Terminal.Gui/Views/TableView/CellColorGetterArgs.cs index 1fd78d6ca..2dfcc069e 100644 --- a/Terminal.Gui/Views/TableView/CellColorGetterArgs.cs +++ b/Terminal.Gui/Views/TableView/CellColorGetterArgs.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Arguments for a . Describes a cell for which a rendering diff --git a/Terminal.Gui/Views/TableView/CellToggledEventArgs.cs b/Terminal.Gui/Views/TableView/CellToggledEventArgs.cs index 9a9fa10ec..281dbb6f9 100644 --- a/Terminal.Gui/Views/TableView/CellToggledEventArgs.cs +++ b/Terminal.Gui/Views/TableView/CellToggledEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Event args for the event. public class CellToggledEventArgs : EventArgs diff --git a/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapper.cs b/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapper.cs index 9b5895692..c058b2557 100644 --- a/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapper.cs +++ b/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapper.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// for a which adds a checkbox column as an additional column diff --git a/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapperByIndex.cs b/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapperByIndex.cs index e6033e170..b82bebb13 100644 --- a/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapperByIndex.cs +++ b/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapperByIndex.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Implementation of which records toggled rows by their row number. public class CheckBoxTableSourceWrapperByIndex : CheckBoxTableSourceWrapperBase diff --git a/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapperByObject.cs b/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapperByObject.cs index 8eaa868ce..faa746ced 100644 --- a/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapperByObject.cs +++ b/Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapperByObject.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Implementation of which records toggled rows by a property on row diff --git a/Terminal.Gui/Views/TableView/ColumnStyle.cs b/Terminal.Gui/Views/TableView/ColumnStyle.cs index fa56292a2..e9afecaa7 100644 --- a/Terminal.Gui/Views/TableView/ColumnStyle.cs +++ b/Terminal.Gui/Views/TableView/ColumnStyle.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Describes how to render a given column in a including and diff --git a/Terminal.Gui/Views/TableView/DataTableSource.cs b/Terminal.Gui/Views/TableView/DataTableSource.cs index a475e46b7..551b38b05 100644 --- a/Terminal.Gui/Views/TableView/DataTableSource.cs +++ b/Terminal.Gui/Views/TableView/DataTableSource.cs @@ -1,6 +1,6 @@ using System.Data; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// implementation that wraps a . This class is diff --git a/Terminal.Gui/Views/TableView/EnumerableTableSource.cs b/Terminal.Gui/Views/TableView/EnumerableTableSource.cs index 327cdaf5c..a771ca6fd 100644 --- a/Terminal.Gui/Views/TableView/EnumerableTableSource.cs +++ b/Terminal.Gui/Views/TableView/EnumerableTableSource.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// implementation that wraps arbitrary data. /// diff --git a/Terminal.Gui/Views/TableView/IEnumerableTableSource.cs b/Terminal.Gui/Views/TableView/IEnumerableTableSource.cs index 44e09fd09..c21700836 100644 --- a/Terminal.Gui/Views/TableView/IEnumerableTableSource.cs +++ b/Terminal.Gui/Views/TableView/IEnumerableTableSource.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Interface for all which present an object per row (of type diff --git a/Terminal.Gui/Views/TableView/ITableSource.cs b/Terminal.Gui/Views/TableView/ITableSource.cs index c84882b79..4848642da 100644 --- a/Terminal.Gui/Views/TableView/ITableSource.cs +++ b/Terminal.Gui/Views/TableView/ITableSource.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Tabular matrix of data to be displayed in a . public interface ITableSource diff --git a/Terminal.Gui/Views/TableView/ListColumnStyle.cs b/Terminal.Gui/Views/TableView/ListColumnStyle.cs index 1b81450bc..cce3376b0 100644 --- a/Terminal.Gui/Views/TableView/ListColumnStyle.cs +++ b/Terminal.Gui/Views/TableView/ListColumnStyle.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// Defines rendering options that affect how the view is displayed. public class ListColumnStyle diff --git a/Terminal.Gui/Views/TableView/ListTableSource.cs b/Terminal.Gui/Views/TableView/ListTableSource.cs index 6a117698f..bc07d404f 100644 --- a/Terminal.Gui/Views/TableView/ListTableSource.cs +++ b/Terminal.Gui/Views/TableView/ListTableSource.cs @@ -1,7 +1,7 @@ using System.Collections; using System.Data; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// implementation that wraps a . This class is diff --git a/Terminal.Gui/Views/TableView/RowColorGetterArgs.cs b/Terminal.Gui/Views/TableView/RowColorGetterArgs.cs index 15b3ffa75..6335a484d 100644 --- a/Terminal.Gui/Views/TableView/RowColorGetterArgs.cs +++ b/Terminal.Gui/Views/TableView/RowColorGetterArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Arguments for . Describes a row of data in a diff --git a/Terminal.Gui/Views/TableView/SelectedCellChangedEventArgs.cs b/Terminal.Gui/Views/TableView/SelectedCellChangedEventArgs.cs index 57cb04e2d..4aad9ccae 100644 --- a/Terminal.Gui/Views/TableView/SelectedCellChangedEventArgs.cs +++ b/Terminal.Gui/Views/TableView/SelectedCellChangedEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Defines the event arguments for public class SelectedCellChangedEventArgs : EventArgs diff --git a/Terminal.Gui/Views/TableView/TableSelection.cs b/Terminal.Gui/Views/TableView/TableSelection.cs index f9062be30..f6217ef0b 100644 --- a/Terminal.Gui/Views/TableView/TableSelection.cs +++ b/Terminal.Gui/Views/TableView/TableSelection.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Describes a selected region of the table public class TableSelection diff --git a/Terminal.Gui/Views/TableView/TableStyle.cs b/Terminal.Gui/Views/TableView/TableStyle.cs index b23c6ea5f..77f380147 100644 --- a/Terminal.Gui/Views/TableView/TableStyle.cs +++ b/Terminal.Gui/Views/TableView/TableStyle.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Defines rendering options that affect how the table is displayed. diff --git a/Terminal.Gui/Views/TableView/TableView.cs b/Terminal.Gui/Views/TableView/TableView.cs index ac8220b6b..a269d69d0 100644 --- a/Terminal.Gui/Views/TableView/TableView.cs +++ b/Terminal.Gui/Views/TableView/TableView.cs @@ -1,7 +1,7 @@ using System.Data; using System.Globalization; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Delegate for providing color to cells based on the value being rendered /// Contains information about the cell for which color is needed @@ -14,8 +14,8 @@ public delegate Scheme CellColorGetterDelegate (CellColorGetterArgs args); public delegate Scheme RowColorGetterDelegate (RowColorGetterArgs args); /// -/// View for tabular data based on a . -/// See TableView Deep Dive for more information. +/// Displays and enables infinite scrolling through tabular data based on a . +/// See the TableView Deep Dive for more. /// public class TableView : View, IDesignable { diff --git a/Terminal.Gui/Views/TableView/TreeTableSource.cs b/Terminal.Gui/Views/TableView/TreeTableSource.cs index 06b304634..c8c4a01fe 100644 --- a/Terminal.Gui/Views/TableView/TreeTableSource.cs +++ b/Terminal.Gui/Views/TableView/TreeTableSource.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// An with expandable rows. /// diff --git a/Terminal.Gui/Views/TextInput/ContentsChangedEventArgs.cs b/Terminal.Gui/Views/TextInput/ContentsChangedEventArgs.cs index 0d76a0343..23e1a5dab 100644 --- a/Terminal.Gui/Views/TextInput/ContentsChangedEventArgs.cs +++ b/Terminal.Gui/Views/TextInput/ContentsChangedEventArgs.cs @@ -1,6 +1,6 @@ // TextView.cs: multi-line text editing -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Event arguments for events for when the contents of the TextView change. E.g. the diff --git a/Terminal.Gui/Views/TextInput/DateField.cs b/Terminal.Gui/Views/TextInput/DateField.cs index d1f138a93..e85ceb60a 100644 --- a/Terminal.Gui/Views/TextInput/DateField.cs +++ b/Terminal.Gui/Views/TextInput/DateField.cs @@ -8,10 +8,9 @@ using System.Globalization; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; -/// Simple Date editing -/// The provides date editing functionality with mouse support. +/// Provides date editing functionality with mouse support. public class DateField : TextField { private const string RightToLeftMark = "\u200f"; diff --git a/Terminal.Gui/Views/TextInput/HistoryText.cs b/Terminal.Gui/Views/TextInput/HistoryText.cs index 8670a8f66..62fd65c8b 100644 --- a/Terminal.Gui/Views/TextInput/HistoryText.cs +++ b/Terminal.Gui/Views/TextInput/HistoryText.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; internal class HistoryText { diff --git a/Terminal.Gui/Views/TextInput/HistoryTextItemEventArgs.cs b/Terminal.Gui/Views/TextInput/HistoryTextItemEventArgs.cs index f8c4937a9..875c039a3 100644 --- a/Terminal.Gui/Views/TextInput/HistoryTextItemEventArgs.cs +++ b/Terminal.Gui/Views/TextInput/HistoryTextItemEventArgs.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Event arguments for item events. Used by and . diff --git a/Terminal.Gui/Views/TextInput/ITextValidateProvider.cs b/Terminal.Gui/Views/TextInput/ITextValidateProvider.cs index 496d6c7a5..e25306cd3 100644 --- a/Terminal.Gui/Views/TextInput/ITextValidateProvider.cs +++ b/Terminal.Gui/Views/TextInput/ITextValidateProvider.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// TextValidateField Providers Interface. All TextValidateField are created with a ITextValidateProvider. public interface ITextValidateProvider diff --git a/Terminal.Gui/Views/TextInput/NetMaskedTextProvider.cs b/Terminal.Gui/Views/TextInput/NetMaskedTextProvider.cs index b45da3d60..11dd5d811 100644 --- a/Terminal.Gui/Views/TextInput/NetMaskedTextProvider.cs +++ b/Terminal.Gui/Views/TextInput/NetMaskedTextProvider.cs @@ -1,7 +1,7 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// .Net MaskedTextProvider Provider for TextValidateField. diff --git a/Terminal.Gui/Views/TextInput/TextEditingLineStatus.cs b/Terminal.Gui/Views/TextInput/TextEditingLineStatus.cs index 4f31ffac7..e71f6de1d 100644 --- a/Terminal.Gui/Views/TextInput/TextEditingLineStatus.cs +++ b/Terminal.Gui/Views/TextInput/TextEditingLineStatus.cs @@ -1,4 +1,3 @@ -using Terminal.Gui; /// /// Represents the status of a line during text editing operations in a . diff --git a/Terminal.Gui/Views/TextInput/TextField.cs b/Terminal.Gui/Views/TextInput/TextField.cs index 75fada129..b87308009 100644 --- a/Terminal.Gui/Views/TextInput/TextField.cs +++ b/Terminal.Gui/Views/TextInput/TextField.cs @@ -1,9 +1,8 @@ using System.Globalization; -using Terminal.Gui.Resources; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; -/// Single-line text entry +/// Single-line text editor. /// The provides editing functionality and mouse support. public class TextField : View, IDesignable { diff --git a/Terminal.Gui/Views/TextInput/TextModel.cs b/Terminal.Gui/Views/TextInput/TextModel.cs index 2bd70b519..b76955ba5 100644 --- a/Terminal.Gui/Views/TextInput/TextModel.cs +++ b/Terminal.Gui/Views/TextInput/TextModel.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Represents the underlying data model for managing and manipulating multi-line text in a . diff --git a/Terminal.Gui/Views/TextInput/TextRegexProvider.cs b/Terminal.Gui/Views/TextInput/TextRegexProvider.cs index 42b9da431..753c8c1bc 100644 --- a/Terminal.Gui/Views/TextInput/TextRegexProvider.cs +++ b/Terminal.Gui/Views/TextInput/TextRegexProvider.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.RegularExpressions; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Regex Provider for TextValidateField. public class TextRegexProvider : ITextValidateProvider diff --git a/Terminal.Gui/Views/TextInput/TextValidateField.cs b/Terminal.Gui/Views/TextInput/TextValidateField.cs index c10dbf497..1b32d5cf0 100644 --- a/Terminal.Gui/Views/TextInput/TextValidateField.cs +++ b/Terminal.Gui/Views/TextInput/TextValidateField.cs @@ -1,9 +1,10 @@ #nullable enable -namespace Terminal.Gui; -/// Text field that validates input through a -public class TextValidateField : View +namespace Terminal.Gui.Views; + +/// Masked text editor that validates input through a +public class TextValidateField : View, IDesignable { private const int DEFAULT_LENGTH = 10; private int _cursorPosition; @@ -366,4 +367,18 @@ public class TextValidateField : View return true; } + + /// + public bool EnableForDesign () + { + TextRegexProvider provider = new ("^([0-9]?[0-9]?[0-9]|1000)$") { ValidateOnInput = false }; + + BorderStyle = LineStyle.Single; + Title = provider.Pattern; + Provider = provider; + + Text = "999"; + + return true; + } } diff --git a/Terminal.Gui/Views/TextInput/TextView.cs b/Terminal.Gui/Views/TextInput/TextView.cs index 0006b8ca6..e4e1dc0a3 100644 --- a/Terminal.Gui/Views/TextInput/TextView.cs +++ b/Terminal.Gui/Views/TextInput/TextView.cs @@ -3,15 +3,11 @@ // TextView.cs: multi-line text editing using System.Globalization; using System.Runtime.CompilerServices; -using Terminal.Gui.Resources; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; -/// Multi-line text editing . +/// Fully featured multi-line text editor /// -/// -/// provides a fully featured multi-line text editor. -/// /// /// /// Shortcut Action performed diff --git a/Terminal.Gui/Views/TextInput/TimeField.cs b/Terminal.Gui/Views/TextInput/TimeField.cs index 932f67ddb..69a372267 100644 --- a/Terminal.Gui/Views/TextInput/TimeField.cs +++ b/Terminal.Gui/Views/TextInput/TimeField.cs @@ -7,10 +7,9 @@ using System.Globalization; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; -/// Time editing -/// The provides time editing functionality with mouse support. +/// Provides time editing functionality with mouse support public class TimeField : TextField { private readonly int _longFieldLen = 8; diff --git a/Terminal.Gui/Views/TextInput/WordWrapManager.cs b/Terminal.Gui/Views/TextInput/WordWrapManager.cs index a167ad6cd..ced8c2a7c 100644 --- a/Terminal.Gui/Views/TextInput/WordWrapManager.cs +++ b/Terminal.Gui/Views/TextInput/WordWrapManager.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Manages word wrapping for a in a . diff --git a/Terminal.Gui/Views/Tile.cs b/Terminal.Gui/Views/Tile.cs index f93c55a6b..45bcd259b 100644 --- a/Terminal.Gui/Views/Tile.cs +++ b/Terminal.Gui/Views/Tile.cs @@ -1,7 +1,7 @@ #nullable enable using System.ComponentModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// A single presented in a . To create new instances use @@ -43,7 +43,7 @@ public class Tile /// The text that should be displayed above the . This will appear over the splitter line /// or border (above the view client area). /// - /// Title are not rendered for root level tiles is . + /// Title are not rendered for root level tiles is . public string Title { get => _title; diff --git a/Terminal.Gui/Views/TileView.cs b/Terminal.Gui/Views/TileView.cs index 0f7631373..6a993ae57 100644 --- a/Terminal.Gui/Views/TileView.cs +++ b/Terminal.Gui/Views/TileView.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// A consisting of a moveable bar that divides the display area into resizeable diff --git a/Terminal.Gui/Views/Toplevel.cs b/Terminal.Gui/Views/Toplevel.cs index 21dc01f55..a62252f57 100644 --- a/Terminal.Gui/Views/Toplevel.cs +++ b/Terminal.Gui/Views/Toplevel.cs @@ -1,5 +1,6 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// Toplevel views are used for both an application's main view (filling the entire screen and for modal (pop-up) diff --git a/Terminal.Gui/Views/ToplevelEventArgs.cs b/Terminal.Gui/Views/ToplevelEventArgs.cs index 4608f1892..0c8d15fc7 100644 --- a/Terminal.Gui/Views/ToplevelEventArgs.cs +++ b/Terminal.Gui/Views/ToplevelEventArgs.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// Args for events that relate to a specific . public class ToplevelEventArgs : EventArgs diff --git a/Terminal.Gui/Views/TreeView/AspectGetterDelegate.cs b/Terminal.Gui/Views/TreeView/AspectGetterDelegate.cs index 5865be9a3..4382da300 100644 --- a/Terminal.Gui/Views/TreeView/AspectGetterDelegate.cs +++ b/Terminal.Gui/Views/TreeView/AspectGetterDelegate.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Delegates of this type are used to fetch string representations of user's model objects /// The object that is being rendered diff --git a/Terminal.Gui/Views/TreeView/Branch.cs b/Terminal.Gui/Views/TreeView/Branch.cs index 8103710f8..5b628ef12 100644 --- a/Terminal.Gui/Views/TreeView/Branch.cs +++ b/Terminal.Gui/Views/TreeView/Branch.cs @@ -1,6 +1,7 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; internal class Branch where T : class { diff --git a/Terminal.Gui/Views/TreeView/DelegateTreeBuilder.cs b/Terminal.Gui/Views/TreeView/DelegateTreeBuilder.cs index f3edef285..131dff2d6 100644 --- a/Terminal.Gui/Views/TreeView/DelegateTreeBuilder.cs +++ b/Terminal.Gui/Views/TreeView/DelegateTreeBuilder.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Implementation of that uses user defined functions public class DelegateTreeBuilder : TreeBuilder diff --git a/Terminal.Gui/Views/TreeView/DrawTreeViewLineEventArgs.cs b/Terminal.Gui/Views/TreeView/DrawTreeViewLineEventArgs.cs index 3bea431e0..1ef543eeb 100644 --- a/Terminal.Gui/Views/TreeView/DrawTreeViewLineEventArgs.cs +++ b/Terminal.Gui/Views/TreeView/DrawTreeViewLineEventArgs.cs @@ -2,7 +2,8 @@ // by phillip.piper@gmail.com). Phillip has explicitly granted permission for his design // and code to be used in this library under the MIT license. -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// Event args for the event /// diff --git a/Terminal.Gui/Views/TreeView/ITreeBuilder.cs b/Terminal.Gui/Views/TreeView/ITreeBuilder.cs index 22da05482..f03129525 100644 --- a/Terminal.Gui/Views/TreeView/ITreeBuilder.cs +++ b/Terminal.Gui/Views/TreeView/ITreeBuilder.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Interface for supplying data to a on demand as root level nodes are expanded by the diff --git a/Terminal.Gui/Views/ITreeViewFilter.cs b/Terminal.Gui/Views/TreeView/ITreeViewFilter.cs similarity index 90% rename from Terminal.Gui/Views/ITreeViewFilter.cs rename to Terminal.Gui/Views/TreeView/ITreeViewFilter.cs index 17bd72703..dde9a3a98 100644 --- a/Terminal.Gui/Views/ITreeViewFilter.cs +++ b/Terminal.Gui/Views/TreeView/ITreeViewFilter.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Provides filtering for a . public interface ITreeViewFilter where T : class diff --git a/Terminal.Gui/Views/TreeView/ObjectActivatedEventArgs.cs b/Terminal.Gui/Views/TreeView/ObjectActivatedEventArgs.cs index d1fe1f541..195f62945 100644 --- a/Terminal.Gui/Views/TreeView/ObjectActivatedEventArgs.cs +++ b/Terminal.Gui/Views/TreeView/ObjectActivatedEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Event args for the event /// diff --git a/Terminal.Gui/Views/TreeView/SelectionChangedEventArgs.cs b/Terminal.Gui/Views/TreeView/SelectionChangedEventArgs.cs index 5253f3d40..4b9eb93b9 100644 --- a/Terminal.Gui/Views/TreeView/SelectionChangedEventArgs.cs +++ b/Terminal.Gui/Views/TreeView/SelectionChangedEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Event arguments describing a change in selected object in a tree view public class SelectionChangedEventArgs : EventArgs where T : class diff --git a/Terminal.Gui/Views/TreeView/TreeBuilder.cs b/Terminal.Gui/Views/TreeView/TreeBuilder.cs index 9dc690e4f..afb7f5e18 100644 --- a/Terminal.Gui/Views/TreeView/TreeBuilder.cs +++ b/Terminal.Gui/Views/TreeView/TreeBuilder.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// Abstract implementation of . public abstract class TreeBuilder : ITreeBuilder diff --git a/Terminal.Gui/Views/TreeView/TreeNode.cs b/Terminal.Gui/Views/TreeView/TreeNode.cs index 351e61620..3377b92ac 100644 --- a/Terminal.Gui/Views/TreeView/TreeNode.cs +++ b/Terminal.Gui/Views/TreeView/TreeNode.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Interface to implement when you want the regular (non-generic) to automatically diff --git a/Terminal.Gui/Views/TreeView/TreeNodeBuilder.cs b/Terminal.Gui/Views/TreeView/TreeNodeBuilder.cs index c61b373ee..08dc93108 100644 --- a/Terminal.Gui/Views/TreeView/TreeNodeBuilder.cs +++ b/Terminal.Gui/Views/TreeView/TreeNodeBuilder.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// implementation for objects public class TreeNodeBuilder : TreeBuilder diff --git a/Terminal.Gui/Views/TreeView/TreeStyle.cs b/Terminal.Gui/Views/TreeView/TreeStyle.cs index 0b560f2a9..fe5eea7c4 100644 --- a/Terminal.Gui/Views/TreeView/TreeStyle.cs +++ b/Terminal.Gui/Views/TreeView/TreeStyle.cs @@ -1,4 +1,5 @@ -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// Defines rendering options that affect how the tree is displayed. public class TreeStyle diff --git a/Terminal.Gui/Views/TreeView/TreeView.cs b/Terminal.Gui/Views/TreeView/TreeView.cs index 11e4e6744..858bc465d 100644 --- a/Terminal.Gui/Views/TreeView/TreeView.cs +++ b/Terminal.Gui/Views/TreeView/TreeView.cs @@ -4,7 +4,7 @@ using System.Collections.ObjectModel; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Interface for all non-generic members of . diff --git a/Terminal.Gui/Views/TreeViewTextFilter.cs b/Terminal.Gui/Views/TreeView/TreeViewTextFilter.cs similarity index 98% rename from Terminal.Gui/Views/TreeViewTextFilter.cs rename to Terminal.Gui/Views/TreeView/TreeViewTextFilter.cs index 907c1b5dc..4be43e00a 100644 --- a/Terminal.Gui/Views/TreeViewTextFilter.cs +++ b/Terminal.Gui/Views/TreeView/TreeViewTextFilter.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// implementation which searches the of diff --git a/Terminal.Gui/Views/Window.cs b/Terminal.Gui/Views/Window.cs index bab4bdca0..f2b51ce40 100644 --- a/Terminal.Gui/Views/Window.cs +++ b/Terminal.Gui/Views/Window.cs @@ -1,12 +1,13 @@ #nullable enable -namespace Terminal.Gui; + +namespace Terminal.Gui.Views; /// /// An overlapped container for other views with a border and optional title. /// /// /// -/// Window has set to , +/// Window has set to , /// set to , and /// uses the "Base" scheme by default. /// diff --git a/Terminal.Gui/Views/Wizard/Wizard.cs b/Terminal.Gui/Views/Wizard/Wizard.cs index 6384da94f..3b826674a 100644 --- a/Terminal.Gui/Views/Wizard/Wizard.cs +++ b/Terminal.Gui/Views/Wizard/Wizard.cs @@ -1,7 +1,6 @@ #nullable enable -using Terminal.Gui.Resources; -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// /// Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step ( diff --git a/Terminal.Gui/Views/Wizard/WizardEventArgs.cs b/Terminal.Gui/Views/Wizard/WizardEventArgs.cs index b592f6f2f..85444fd30 100644 --- a/Terminal.Gui/Views/Wizard/WizardEventArgs.cs +++ b/Terminal.Gui/Views/Wizard/WizardEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui; +namespace Terminal.Gui.Views; /// for transition events. public class WizardButtonEventArgs : EventArgs diff --git a/Terminal.Gui/Views/Wizard/WizardStep.cs b/Terminal.Gui/Views/Wizard/WizardStep.cs index 617a47c19..6e211b1e8 100644 --- a/Terminal.Gui/Views/Wizard/WizardStep.cs +++ b/Terminal.Gui/Views/Wizard/WizardStep.cs @@ -1,5 +1,6 @@ -#nullable enable -namespace Terminal.Gui; +#nullable enable + +namespace Terminal.Gui.Views; /// /// Represents a basic step that is displayed in a . The view is diff --git a/Tests/Benchmarks/ConsoleDrivers/EscSeqUtils/CSI_SetVsAppend.cs b/Tests/Benchmarks/ConsoleDrivers/EscSeqUtils/CSI_SetVsAppend.cs index 169ebd740..7f1f9397e 100644 --- a/Tests/Benchmarks/ConsoleDrivers/EscSeqUtils/CSI_SetVsAppend.cs +++ b/Tests/Benchmarks/ConsoleDrivers/EscSeqUtils/CSI_SetVsAppend.cs @@ -1,6 +1,6 @@ using System.Text; using BenchmarkDotNet.Attributes; -using Tui = Terminal.Gui; +using Tui = Terminal.Gui.Drivers; namespace Terminal.Gui.Benchmarks.ConsoleDrivers.EscSeqUtils; diff --git a/Tests/Benchmarks/ConsoleDrivers/EscSeqUtils/CSI_SetVsWrite.cs b/Tests/Benchmarks/ConsoleDrivers/EscSeqUtils/CSI_SetVsWrite.cs index 9ed6b328c..5577907b0 100644 --- a/Tests/Benchmarks/ConsoleDrivers/EscSeqUtils/CSI_SetVsWrite.cs +++ b/Tests/Benchmarks/ConsoleDrivers/EscSeqUtils/CSI_SetVsWrite.cs @@ -1,5 +1,5 @@ using BenchmarkDotNet.Attributes; -using Tui = Terminal.Gui; +using Tui = Terminal.Gui.Drivers; namespace Terminal.Gui.Benchmarks.ConsoleDrivers.EscSeqUtils; diff --git a/Tests/Benchmarks/Text/RuneExtensions/DecodeSurrogatePair.cs b/Tests/Benchmarks/Text/RuneExtensions/DecodeSurrogatePair.cs index 5cce34424..422d7b057 100644 --- a/Tests/Benchmarks/Text/RuneExtensions/DecodeSurrogatePair.cs +++ b/Tests/Benchmarks/Text/RuneExtensions/DecodeSurrogatePair.cs @@ -1,11 +1,12 @@ using System.Text; using BenchmarkDotNet.Attributes; -using Tui = Terminal.Gui; +using Terminal.Gui.Text; +using Tui = Terminal.Gui.Text; namespace Terminal.Gui.Benchmarks.Text.RuneExtensions; /// -/// Benchmarks for performance fine-tuning. +/// Benchmarks for performance fine-tuning. /// [MemoryDiagnoser] [BenchmarkCategory (nameof (Tui.RuneExtensions))] diff --git a/Tests/Benchmarks/Text/RuneExtensions/Encode.cs b/Tests/Benchmarks/Text/RuneExtensions/Encode.cs index 6f88ac554..413658413 100644 --- a/Tests/Benchmarks/Text/RuneExtensions/Encode.cs +++ b/Tests/Benchmarks/Text/RuneExtensions/Encode.cs @@ -1,6 +1,6 @@ using System.Text; using BenchmarkDotNet.Attributes; -using Tui = Terminal.Gui; +using Tui = Terminal.Gui.Text; namespace Terminal.Gui.Benchmarks.Text.RuneExtensions; diff --git a/Tests/Benchmarks/Text/RuneExtensions/EncodeSurrogatePair.cs b/Tests/Benchmarks/Text/RuneExtensions/EncodeSurrogatePair.cs index 7319fdba4..10e500aae 100644 --- a/Tests/Benchmarks/Text/RuneExtensions/EncodeSurrogatePair.cs +++ b/Tests/Benchmarks/Text/RuneExtensions/EncodeSurrogatePair.cs @@ -1,6 +1,6 @@ using System.Text; using BenchmarkDotNet.Attributes; -using Tui = Terminal.Gui; +using Tui = Terminal.Gui.Text; namespace Terminal.Gui.Benchmarks.Text.RuneExtensions; diff --git a/Tests/Benchmarks/Text/RuneExtensions/GetEncodingLength.cs b/Tests/Benchmarks/Text/RuneExtensions/GetEncodingLength.cs index 4682940de..754bd6e59 100644 --- a/Tests/Benchmarks/Text/RuneExtensions/GetEncodingLength.cs +++ b/Tests/Benchmarks/Text/RuneExtensions/GetEncodingLength.cs @@ -1,6 +1,6 @@ using System.Text; using BenchmarkDotNet.Attributes; -using Tui = Terminal.Gui; +using Tui = Terminal.Gui.Text; namespace Terminal.Gui.Benchmarks.Text.RuneExtensions; diff --git a/Tests/Benchmarks/Text/RuneExtensions/IsSurrogatePair.cs b/Tests/Benchmarks/Text/RuneExtensions/IsSurrogatePair.cs index 865f075a3..dd925831d 100644 --- a/Tests/Benchmarks/Text/RuneExtensions/IsSurrogatePair.cs +++ b/Tests/Benchmarks/Text/RuneExtensions/IsSurrogatePair.cs @@ -1,6 +1,6 @@ using System.Text; using BenchmarkDotNet.Attributes; -using Tui = Terminal.Gui; +using Tui = Terminal.Gui.Text; namespace Terminal.Gui.Benchmarks.Text.RuneExtensions; diff --git a/Tests/Benchmarks/Text/StringExtensions/ToStringEnumerable.cs b/Tests/Benchmarks/Text/StringExtensions/ToStringEnumerable.cs index b44f33ad5..23a68403a 100644 --- a/Tests/Benchmarks/Text/StringExtensions/ToStringEnumerable.cs +++ b/Tests/Benchmarks/Text/StringExtensions/ToStringEnumerable.cs @@ -1,6 +1,6 @@ using System.Text; using BenchmarkDotNet.Attributes; -using Tui = Terminal.Gui; +using Tui = Terminal.Gui.Text; namespace Terminal.Gui.Benchmarks.Text.StringExtensions; diff --git a/Tests/Benchmarks/Text/TextFormatter/RemoveHotKeySpecifier.cs b/Tests/Benchmarks/Text/TextFormatter/RemoveHotKeySpecifier.cs index e72dc0e1e..74a8fff82 100644 --- a/Tests/Benchmarks/Text/TextFormatter/RemoveHotKeySpecifier.cs +++ b/Tests/Benchmarks/Text/TextFormatter/RemoveHotKeySpecifier.cs @@ -1,6 +1,6 @@ using System.Text; using BenchmarkDotNet.Attributes; -using Tui = Terminal.Gui; +using Tui = Terminal.Gui.Text; namespace Terminal.Gui.Benchmarks.Text.TextFormatter; diff --git a/Tests/Benchmarks/Text/TextFormatter/ReplaceCRLFWithSpace.cs b/Tests/Benchmarks/Text/TextFormatter/ReplaceCRLFWithSpace.cs index ebfeb05a4..60cf18acf 100644 --- a/Tests/Benchmarks/Text/TextFormatter/ReplaceCRLFWithSpace.cs +++ b/Tests/Benchmarks/Text/TextFormatter/ReplaceCRLFWithSpace.cs @@ -1,6 +1,7 @@ using System.Text; using BenchmarkDotNet.Attributes; -using Tui = Terminal.Gui; +using Terminal.Gui.Text; +using Tui = Terminal.Gui.Text; namespace Terminal.Gui.Benchmarks.Text.TextFormatter; diff --git a/Tests/Benchmarks/Text/TextFormatter/StripCRLF.cs b/Tests/Benchmarks/Text/TextFormatter/StripCRLF.cs index f12dd2831..da74d5b3c 100644 --- a/Tests/Benchmarks/Text/TextFormatter/StripCRLF.cs +++ b/Tests/Benchmarks/Text/TextFormatter/StripCRLF.cs @@ -1,6 +1,7 @@ using System.Text; using BenchmarkDotNet.Attributes; -using Tui = Terminal.Gui; +using Terminal.Gui.Text; +using Tui = Terminal.Gui.Text; namespace Terminal.Gui.Benchmarks.Text.TextFormatter; diff --git a/Tests/IntegrationTests/AssemblyInfo.cs b/Tests/IntegrationTests/AssemblyInfo.cs new file mode 100644 index 000000000..4e9b2b2db --- /dev/null +++ b/Tests/IntegrationTests/AssemblyInfo.cs @@ -0,0 +1,13 @@ +global using Attribute = Terminal.Gui.Drawing.Attribute; +global using Color = Terminal.Gui.Drawing.Color; +global using CM = Terminal.Gui.Configuration.ConfigurationManager; +global using Terminal.Gui.App; +global using Terminal.Gui.Drivers; +global using Terminal.Gui.Input; +global using Terminal.Gui.Configuration; +global using Terminal.Gui.ViewBase; +global using Terminal.Gui.Views; +global using Terminal.Gui.Drawing; +global using Terminal.Gui.Text; +global using Terminal.Gui.Resources; +global using Terminal.Gui.FileServices; \ No newline at end of file diff --git a/Tests/IntegrationTests/FluentTests/BasicFluentAssertionTests.cs b/Tests/IntegrationTests/FluentTests/BasicFluentAssertionTests.cs index 966da0e9a..f45236ba9 100644 --- a/Tests/IntegrationTests/FluentTests/BasicFluentAssertionTests.cs +++ b/Tests/IntegrationTests/FluentTests/BasicFluentAssertionTests.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; -using TerminalGuiFluentTesting; +using TerminalGuiFluentTesting; using Xunit.Abstractions; namespace IntegrationTests.FluentTests; diff --git a/Tests/IntegrationTests/FluentTests/FileDialogFluentTests.cs b/Tests/IntegrationTests/FluentTests/FileDialogFluentTests.cs index 067b25327..936bebba2 100644 --- a/Tests/IntegrationTests/FluentTests/FileDialogFluentTests.cs +++ b/Tests/IntegrationTests/FluentTests/FileDialogFluentTests.cs @@ -1,7 +1,6 @@ using System.IO.Abstractions; using System.IO.Abstractions.TestingHelpers; using System.Runtime.InteropServices; -using Terminal.Gui; using TerminalGuiFluentTesting; using TerminalGuiFluentTestingXunit; using Xunit.Abstractions; diff --git a/Tests/IntegrationTests/FluentTests/MenuBarv2Tests.cs b/Tests/IntegrationTests/FluentTests/MenuBarv2Tests.cs index 8e68a1f24..76e0a4d7f 100644 --- a/Tests/IntegrationTests/FluentTests/MenuBarv2Tests.cs +++ b/Tests/IntegrationTests/FluentTests/MenuBarv2Tests.cs @@ -1,5 +1,4 @@ using System.Reflection; -using Terminal.Gui; using TerminalGuiFluentTesting; using Xunit.Abstractions; diff --git a/Tests/IntegrationTests/FluentTests/PopverMenuTests.cs b/Tests/IntegrationTests/FluentTests/PopverMenuTests.cs index 63a817f59..15f56b675 100644 --- a/Tests/IntegrationTests/FluentTests/PopverMenuTests.cs +++ b/Tests/IntegrationTests/FluentTests/PopverMenuTests.cs @@ -1,5 +1,4 @@ using System.Reflection; -using Terminal.Gui; using TerminalGuiFluentTesting; using Xunit.Abstractions; diff --git a/Tests/IntegrationTests/FluentTests/TextFieldFluentTests.cs b/Tests/IntegrationTests/FluentTests/TextFieldFluentTests.cs index 0197f7f24..057fb71a8 100644 --- a/Tests/IntegrationTests/FluentTests/TextFieldFluentTests.cs +++ b/Tests/IntegrationTests/FluentTests/TextFieldFluentTests.cs @@ -5,7 +5,6 @@ using System.IO.Abstractions; using System.Linq; using System.Text; using System.Threading.Tasks; -using Terminal.Gui; using TerminalGuiFluentTesting; using TerminalGuiFluentTestingXunit; using Xunit.Abstractions; diff --git a/Tests/IntegrationTests/FluentTests/TreeViewFluentTests.cs b/Tests/IntegrationTests/FluentTests/TreeViewFluentTests.cs index 145f1337e..1327a52c2 100644 --- a/Tests/IntegrationTests/FluentTests/TreeViewFluentTests.cs +++ b/Tests/IntegrationTests/FluentTests/TreeViewFluentTests.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; -using TerminalGuiFluentTesting; +using TerminalGuiFluentTesting; using TerminalGuiFluentTestingXunit; using Xunit.Abstractions; diff --git a/Tests/IntegrationTests/UICatalog/ScenarioTests.cs b/Tests/IntegrationTests/UICatalog/ScenarioTests.cs index ec8cafc1e..ab85b1391 100644 --- a/Tests/IntegrationTests/UICatalog/ScenarioTests.cs +++ b/Tests/IntegrationTests/UICatalog/ScenarioTests.cs @@ -2,7 +2,6 @@ using System.Collections.ObjectModel; using System.Diagnostics; using System.Reflection; using System.Runtime.CompilerServices; -using Terminal.Gui; using UICatalog; using UnitTests; using Xunit.Abstractions; diff --git a/Tests/StressTests/ApplicationStressTests.cs b/Tests/StressTests/ApplicationStressTests.cs index 86f1aa77b..ee2c835de 100644 --- a/Tests/StressTests/ApplicationStressTests.cs +++ b/Tests/StressTests/ApplicationStressTests.cs @@ -1,4 +1,3 @@ -using Terminal.Gui; using UnitTests; using Xunit.Abstractions; diff --git a/Tests/StressTests/AssemblyInfo.cs b/Tests/StressTests/AssemblyInfo.cs new file mode 100644 index 000000000..4e9b2b2db --- /dev/null +++ b/Tests/StressTests/AssemblyInfo.cs @@ -0,0 +1,13 @@ +global using Attribute = Terminal.Gui.Drawing.Attribute; +global using Color = Terminal.Gui.Drawing.Color; +global using CM = Terminal.Gui.Configuration.ConfigurationManager; +global using Terminal.Gui.App; +global using Terminal.Gui.Drivers; +global using Terminal.Gui.Input; +global using Terminal.Gui.Configuration; +global using Terminal.Gui.ViewBase; +global using Terminal.Gui.Views; +global using Terminal.Gui.Drawing; +global using Terminal.Gui.Text; +global using Terminal.Gui.Resources; +global using Terminal.Gui.FileServices; \ No newline at end of file diff --git a/Tests/StressTests/ScenariosStressTests.cs b/Tests/StressTests/ScenariosStressTests.cs index 66f61dcf6..30e4bc131 100644 --- a/Tests/StressTests/ScenariosStressTests.cs +++ b/Tests/StressTests/ScenariosStressTests.cs @@ -1,5 +1,4 @@ using System.Diagnostics; -using Terminal.Gui; using UICatalog; using UnitTests; using Xunit.Abstractions; diff --git a/Tests/TerminalGuiFluentTesting/AssemblyInfo.cs b/Tests/TerminalGuiFluentTesting/AssemblyInfo.cs new file mode 100644 index 000000000..4e9b2b2db --- /dev/null +++ b/Tests/TerminalGuiFluentTesting/AssemblyInfo.cs @@ -0,0 +1,13 @@ +global using Attribute = Terminal.Gui.Drawing.Attribute; +global using Color = Terminal.Gui.Drawing.Color; +global using CM = Terminal.Gui.Configuration.ConfigurationManager; +global using Terminal.Gui.App; +global using Terminal.Gui.Drivers; +global using Terminal.Gui.Input; +global using Terminal.Gui.Configuration; +global using Terminal.Gui.ViewBase; +global using Terminal.Gui.Views; +global using Terminal.Gui.Drawing; +global using Terminal.Gui.Text; +global using Terminal.Gui.Resources; +global using Terminal.Gui.FileServices; \ No newline at end of file diff --git a/Tests/TerminalGuiFluentTesting/FakeInput.cs b/Tests/TerminalGuiFluentTesting/FakeInput.cs index fa57c164d..28bbd6fec 100644 --- a/Tests/TerminalGuiFluentTesting/FakeInput.cs +++ b/Tests/TerminalGuiFluentTesting/FakeInput.cs @@ -1,5 +1,4 @@ using System.Collections.Concurrent; -using Terminal.Gui; namespace TerminalGuiFluentTesting; diff --git a/Tests/TerminalGuiFluentTesting/FakeNetInput.cs b/Tests/TerminalGuiFluentTesting/FakeNetInput.cs index 6ccede491..dc58c6063 100644 --- a/Tests/TerminalGuiFluentTesting/FakeNetInput.cs +++ b/Tests/TerminalGuiFluentTesting/FakeNetInput.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; - + namespace TerminalGuiFluentTesting; internal class FakeNetInput (CancellationToken hardStopToken) : FakeInput (hardStopToken), INetInput diff --git a/Tests/TerminalGuiFluentTesting/FakeOutput.cs b/Tests/TerminalGuiFluentTesting/FakeOutput.cs index b20f91fa4..1b73d9ba1 100644 --- a/Tests/TerminalGuiFluentTesting/FakeOutput.cs +++ b/Tests/TerminalGuiFluentTesting/FakeOutput.cs @@ -1,5 +1,4 @@ using System.Drawing; -using Terminal.Gui; namespace TerminalGuiFluentTesting; diff --git a/Tests/TerminalGuiFluentTesting/FakeWindowsInput.cs b/Tests/TerminalGuiFluentTesting/FakeWindowsInput.cs index 42ccf8098..a042ce0e3 100644 --- a/Tests/TerminalGuiFluentTesting/FakeWindowsInput.cs +++ b/Tests/TerminalGuiFluentTesting/FakeWindowsInput.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; - + namespace TerminalGuiFluentTesting; internal class FakeWindowsInput (CancellationToken hardStopToken) : FakeInput (hardStopToken), IWindowsInput diff --git a/Tests/TerminalGuiFluentTesting/GuiTestContext.cs b/Tests/TerminalGuiFluentTesting/GuiTestContext.cs index 4442c4f54..c79bc7477 100644 --- a/Tests/TerminalGuiFluentTesting/GuiTestContext.cs +++ b/Tests/TerminalGuiFluentTesting/GuiTestContext.cs @@ -1,7 +1,6 @@ using System.Drawing; using System.Text; using Microsoft.Extensions.Logging; -using Terminal.Gui; namespace TerminalGuiFluentTesting; diff --git a/Tests/TerminalGuiFluentTesting/With.cs b/Tests/TerminalGuiFluentTesting/With.cs index 078fdb189..2015f4aba 100644 --- a/Tests/TerminalGuiFluentTesting/With.cs +++ b/Tests/TerminalGuiFluentTesting/With.cs @@ -1,5 +1,4 @@ -using Terminal.Gui; - + namespace TerminalGuiFluentTesting; /// diff --git a/Tests/UnitTests/Application/ApplicationTests.cs b/Tests/UnitTests/Application/ApplicationTests.cs index eafe98e05..4273a806e 100644 --- a/Tests/UnitTests/Application/ApplicationTests.cs +++ b/Tests/UnitTests/Application/ApplicationTests.cs @@ -1,7 +1,7 @@ using System.Diagnostics; using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.ConfigurationManager; +using static Terminal.Gui.Configuration.ConfigurationManager; // Alias Console to MockConsole so we don't accidentally use Console diff --git a/Tests/UnitTests/Application/MainLoopTests.cs b/Tests/UnitTests/Application/MainLoopTests.cs index 49bd831ab..b40f362b0 100644 --- a/Tests/UnitTests/Application/MainLoopTests.cs +++ b/Tests/UnitTests/Application/MainLoopTests.cs @@ -597,7 +597,7 @@ public class MainLoopTests Assert.Empty (mainloop.TimedEvents.IdleHandlers); Assert.NotNull ( - new Timeout { Span = new (), Callback = () => true } + new App.Timeout { Span = new (), Callback = () => true } ); } diff --git a/Tests/UnitTests/Application/Mouse/ApplicationMouseEnterLeaveTests.cs b/Tests/UnitTests/Application/Mouse/ApplicationMouseEnterLeaveTests.cs index 967adfecd..ea2919d0d 100644 --- a/Tests/UnitTests/Application/Mouse/ApplicationMouseEnterLeaveTests.cs +++ b/Tests/UnitTests/Application/Mouse/ApplicationMouseEnterLeaveTests.cs @@ -126,7 +126,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (0, view1.OnMouseEnterCalled); @@ -139,7 +139,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -152,7 +152,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -165,7 +165,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -178,7 +178,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -253,7 +253,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (0, view1.OnMouseEnterCalled); @@ -266,7 +266,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -279,7 +279,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -292,7 +292,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -305,7 +305,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -318,7 +318,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -372,7 +372,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (0, view1.OnMouseEnterCalled); @@ -385,7 +385,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -398,7 +398,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -411,7 +411,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (1, view1.OnMouseEnterCalled); @@ -424,7 +424,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (2, view1.OnMouseEnterCalled); @@ -437,7 +437,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (2, view1.OnMouseEnterCalled); @@ -450,7 +450,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (2, view1.OnMouseEnterCalled); @@ -463,7 +463,7 @@ public class ApplicationMouseEnterLeaveTests Application.RaiseMouseEnterLeaveEvents ( mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettings.TransparentMouse)); + View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); // Assert Assert.Equal (3, view1.OnMouseEnterCalled); diff --git a/Tests/UnitTests/AssemblyInfo.cs b/Tests/UnitTests/AssemblyInfo.cs index 97d54f7cf..4e9b2b2db 100644 --- a/Tests/UnitTests/AssemblyInfo.cs +++ b/Tests/UnitTests/AssemblyInfo.cs @@ -1 +1,13 @@ -global using CM = Terminal.Gui.ConfigurationManager; +global using Attribute = Terminal.Gui.Drawing.Attribute; +global using Color = Terminal.Gui.Drawing.Color; +global using CM = Terminal.Gui.Configuration.ConfigurationManager; +global using Terminal.Gui.App; +global using Terminal.Gui.Drivers; +global using Terminal.Gui.Input; +global using Terminal.Gui.Configuration; +global using Terminal.Gui.ViewBase; +global using Terminal.Gui.Views; +global using Terminal.Gui.Drawing; +global using Terminal.Gui.Text; +global using Terminal.Gui.Resources; +global using Terminal.Gui.FileServices; \ No newline at end of file diff --git a/Tests/UnitTests/Configuration/AppScopeTests.cs b/Tests/UnitTests/Configuration/AppScopeTests.cs index c29f132da..19171c062 100644 --- a/Tests/UnitTests/Configuration/AppScopeTests.cs +++ b/Tests/UnitTests/Configuration/AppScopeTests.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.Json; using UnitTests; -using static Terminal.Gui.ConfigurationManager; +using static Terminal.Gui.Configuration.ConfigurationManager; namespace Terminal.Gui.ConfigurationTests; diff --git a/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs b/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs index 4d3d1f18d..f6ae402e6 100644 --- a/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs +++ b/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs @@ -5,7 +5,7 @@ using System.Text; using System.Text.Json; using ColorHelper; using Xunit.Abstractions; -using static Terminal.Gui.ConfigurationManager; +using static Terminal.Gui.Configuration.ConfigurationManager; using File = System.IO.File; #pragma warning disable IDE1006 diff --git a/Tests/UnitTests/Configuration/GlyphTests.cs b/Tests/UnitTests/Configuration/GlyphTests.cs index e61a9a949..7f848b379 100644 --- a/Tests/UnitTests/Configuration/GlyphTests.cs +++ b/Tests/UnitTests/Configuration/GlyphTests.cs @@ -1,7 +1,7 @@ using System.Reflection; using System.Text; using System.Text.Json; -using static Terminal.Gui.ConfigurationManager; +using static Terminal.Gui.Configuration.ConfigurationManager; namespace Terminal.Gui.ConfigurationTests; diff --git a/Tests/UnitTests/Configuration/SchemeManagerTests.cs b/Tests/UnitTests/Configuration/SchemeManagerTests.cs index 656a84a51..5a3897c42 100644 --- a/Tests/UnitTests/Configuration/SchemeManagerTests.cs +++ b/Tests/UnitTests/Configuration/SchemeManagerTests.cs @@ -2,7 +2,7 @@ using System.Collections.Concurrent; using System.Collections.Immutable; using System.Text.Json; -using static Terminal.Gui.ConfigurationManager; +using static Terminal.Gui.Configuration.ConfigurationManager; namespace Terminal.Gui.ConfigurationTests; @@ -194,7 +194,7 @@ public class SchemeManagerTests Disable (true); } - [Fact] + [Fact (Skip = "TODO: This should throw an exception")] public void Load_Null_Scheme_Throws () { try @@ -217,7 +217,7 @@ public class SchemeManagerTests // Load the test theme // TODO: This should throw an exception! - Assert.Throws (() => Load (ConfigLocations.Runtime)); + Assert.Throws< JsonException > (() => Load (ConfigLocations.Runtime)); Assert.Contains ("TestTheme", ThemeManager.Themes!); Assert.Equal ("TestTheme", ThemeManager.Theme); Assert.Throws (SchemeManager.GetSchemes); @@ -462,12 +462,12 @@ public class SchemeManagerTests Assert.Equal ( new (Color.Red), - ((Dictionary)theme["Schemes"].PropertyValue!) ["test"].Normal.Foreground + ((Dictionary)theme ["Schemes"].PropertyValue!) ["test"].Normal.Foreground ); Assert.Equal ( new (Color.Green), - ((Dictionary)theme["Schemes"].PropertyValue!) ["test"].Normal.Background + ((Dictionary)theme ["Schemes"].PropertyValue!) ["test"].Normal.Background ); // Act diff --git a/Tests/UnitTests/Configuration/SettingsScopeTests.cs b/Tests/UnitTests/Configuration/SettingsScopeTests.cs index 33b1c4bf2..4b1bd4344 100644 --- a/Tests/UnitTests/Configuration/SettingsScopeTests.cs +++ b/Tests/UnitTests/Configuration/SettingsScopeTests.cs @@ -1,6 +1,6 @@ #nullable enable using System.Collections.Concurrent; -using static Terminal.Gui.ConfigurationManager; +using static Terminal.Gui.Configuration.ConfigurationManager; namespace Terminal.Gui.ConfigurationTests; diff --git a/Tests/UnitTests/Configuration/ThemeManagerTests.cs b/Tests/UnitTests/Configuration/ThemeManagerTests.cs index 1bb6b46f6..07dec136e 100644 --- a/Tests/UnitTests/Configuration/ThemeManagerTests.cs +++ b/Tests/UnitTests/Configuration/ThemeManagerTests.cs @@ -3,7 +3,7 @@ using System.Collections.Concurrent; using System.Diagnostics.Metrics; using System.Text; using Xunit.Abstractions; -using static Terminal.Gui.ConfigurationManager; +using static Terminal.Gui.Configuration.ConfigurationManager; namespace Terminal.Gui.ConfigurationTests; diff --git a/Tests/UnitTests/Configuration/ThemeScopeTests.cs b/Tests/UnitTests/Configuration/ThemeScopeTests.cs index 75e200585..d3d2e8e54 100644 --- a/Tests/UnitTests/Configuration/ThemeScopeTests.cs +++ b/Tests/UnitTests/Configuration/ThemeScopeTests.cs @@ -1,6 +1,6 @@ using System.Collections.Concurrent; using System.Text.Json; -using static Terminal.Gui.ConfigurationManager; +using static Terminal.Gui.Configuration.ConfigurationManager; namespace Terminal.Gui.ConfigurationTests; diff --git a/Tests/UnitTests/Configuration/ThemeTests.cs b/Tests/UnitTests/Configuration/ThemeTests.cs index a1eabf3f7..5b1769f65 100644 --- a/Tests/UnitTests/Configuration/ThemeTests.cs +++ b/Tests/UnitTests/Configuration/ThemeTests.cs @@ -1,5 +1,5 @@ using System.Text.Json; -using static Terminal.Gui.ConfigurationManager; +using static Terminal.Gui.Configuration.ConfigurationManager; namespace Terminal.Gui.ConfigurationTests; diff --git a/Tests/UnitTests/ConsoleDrivers/ConsoleDriverTests.cs b/Tests/UnitTests/ConsoleDrivers/ConsoleDriverTests.cs index de2965278..7e5b914d2 100644 --- a/Tests/UnitTests/ConsoleDrivers/ConsoleDriverTests.cs +++ b/Tests/UnitTests/ConsoleDrivers/ConsoleDriverTests.cs @@ -2,7 +2,7 @@ using Xunit.Abstractions; // Alias Console to MockConsole so we don't accidentally use Console -using Console = Terminal.Gui.FakeConsole; +using Console = Terminal.Gui.Drivers.FakeConsole; namespace Terminal.Gui.DriverTests; diff --git a/Tests/UnitTests/ConsoleDrivers/ConsoleScrolllingTests.cs b/Tests/UnitTests/ConsoleDrivers/ConsoleScrolllingTests.cs index c82de6afb..7994a0bd6 100644 --- a/Tests/UnitTests/ConsoleDrivers/ConsoleScrolllingTests.cs +++ b/Tests/UnitTests/ConsoleDrivers/ConsoleScrolllingTests.cs @@ -1,7 +1,7 @@ using Xunit.Abstractions; // Alias Console to MockConsole so we don't accidentally use Console -using Console = Terminal.Gui.FakeConsole; +using Console = Terminal.Gui.Drivers.FakeConsole; namespace Terminal.Gui.DriverTests; diff --git a/Tests/UnitTests/ConsoleDrivers/DriverColorTests.cs b/Tests/UnitTests/ConsoleDrivers/DriverColorTests.cs index 856e0481a..3d6249e7e 100644 --- a/Tests/UnitTests/ConsoleDrivers/DriverColorTests.cs +++ b/Tests/UnitTests/ConsoleDrivers/DriverColorTests.cs @@ -1,6 +1,6 @@ // Alias Console to MockConsole so we don't accidentally use Console -using Console = Terminal.Gui.FakeConsole; +using Console = Terminal.Gui.Drivers.FakeConsole; namespace Terminal.Gui.DriverTests; diff --git a/Tests/UnitTests/ConsoleDrivers/V2/WindowsInputProcessorTests.cs b/Tests/UnitTests/ConsoleDrivers/V2/WindowsInputProcessorTests.cs index 2d9f74950..314b80062 100644 --- a/Tests/UnitTests/ConsoleDrivers/V2/WindowsInputProcessorTests.cs +++ b/Tests/UnitTests/ConsoleDrivers/V2/WindowsInputProcessorTests.cs @@ -1,9 +1,9 @@ using System.Collections.Concurrent; -using InputRecord = Terminal.Gui.WindowsConsole.InputRecord; -using ButtonState = Terminal.Gui.WindowsConsole.ButtonState; -using EventFlags = Terminal.Gui.WindowsConsole.EventFlags; -using ControlKeyState = Terminal.Gui.WindowsConsole.ControlKeyState; -using MouseEventRecord = Terminal.Gui.WindowsConsole.MouseEventRecord; +using InputRecord = Terminal.Gui.Drivers.WindowsConsole.InputRecord; +using ButtonState = Terminal.Gui.Drivers.WindowsConsole.ButtonState; +using EventFlags = Terminal.Gui.Drivers.WindowsConsole.EventFlags; +using ControlKeyState = Terminal.Gui.Drivers.WindowsConsole.ControlKeyState; +using MouseEventRecord = Terminal.Gui.Drivers.WindowsConsole.MouseEventRecord; namespace UnitTests.ConsoleDrivers.V2; diff --git a/Tests/UnitTests/Dialogs/DialogTests.cs b/Tests/UnitTests/Dialogs/DialogTests.cs index 8ab138e6e..1e3f907e7 100644 --- a/Tests/UnitTests/Dialogs/DialogTests.cs +++ b/Tests/UnitTests/Dialogs/DialogTests.cs @@ -1,7 +1,7 @@ #nullable enable using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.Application; +using static Terminal.Gui.App.Application; namespace Terminal.Gui.DialogTests; diff --git a/Tests/UnitTests/DriverAssert.cs b/Tests/UnitTests/DriverAssert.cs index 0174d7588..d46f79f59 100644 --- a/Tests/UnitTests/DriverAssert.cs +++ b/Tests/UnitTests/DriverAssert.cs @@ -1,12 +1,11 @@ using System.Text; using System.Text.RegularExpressions; using Xunit.Abstractions; -using Attribute = Terminal.Gui.Attribute; namespace UnitTests; /// -/// Provides xUnit-style assertions for contents. +/// Provides xUnit-style assertions for contents. /// internal partial class DriverAssert { diff --git a/Tests/UnitTests/Resources/ResourceManagerTests.cs b/Tests/UnitTests/Resources/ResourceManagerTests.cs index 75767f144..53735815d 100644 --- a/Tests/UnitTests/Resources/ResourceManagerTests.cs +++ b/Tests/UnitTests/Resources/ResourceManagerTests.cs @@ -4,7 +4,6 @@ using System.Collections; using System.Globalization; using System.Resources; using System.Runtime.CompilerServices; -using Terminal.Gui.Resources; namespace Terminal.Gui.ResourcesTests; diff --git a/Tests/UnitTests/TestsAllViews.cs b/Tests/UnitTests/TestsAllViews.cs index 7b7a77b1a..056a5050c 100644 --- a/Tests/UnitTests/TestsAllViews.cs +++ b/Tests/UnitTests/TestsAllViews.cs @@ -1,7 +1,6 @@ #nullable enable using System.Drawing; using System.Reflection; -using Terminal.Gui; namespace UnitTests; diff --git a/Tests/UnitTests/View/Adornment/AdornmentSubViewTests.cs b/Tests/UnitTests/View/Adornment/AdornmentSubViewTests.cs index 953836673..bd79d71d4 100644 --- a/Tests/UnitTests/View/Adornment/AdornmentSubViewTests.cs +++ b/Tests/UnitTests/View/Adornment/AdornmentSubViewTests.cs @@ -21,7 +21,7 @@ public class AdornmentSubViewTests (ITestOutputHelper output) }; Application.Top.Margin.Thickness = new Thickness (viewMargin); // Turn of TransparentMouse for the test - Application.Top.Margin.ViewportSettings = ViewportSettings.None; + Application.Top.Margin.ViewportSettings = ViewportSettingsFlags.None; var subView = new View () { @@ -32,12 +32,12 @@ public class AdornmentSubViewTests (ITestOutputHelper output) }; subView.Margin.Thickness = new Thickness (subViewMargin); // Turn of TransparentMouse for the test - subView.Margin.ViewportSettings = ViewportSettings.None; + subView.Margin.ViewportSettings = ViewportSettingsFlags.None; Application.Top.Margin.Add (subView); Application.Top.Layout (); - var foundView = View.GetViewsUnderLocation (new Point(0, 0), ViewportSettings.None).LastOrDefault (); + var foundView = View.GetViewsUnderLocation (new Point(0, 0), ViewportSettingsFlags.None).LastOrDefault (); bool found = foundView == subView || foundView == subView.Margin; Assert.Equal (expectedFound, found); @@ -66,7 +66,7 @@ public class AdornmentSubViewTests (ITestOutputHelper output) Application.Top.Padding.Add (subView); Application.Top.Layout (); - Assert.Equal (Application.Top.Padding, View.GetViewsUnderLocation (new Point(0, 0), ViewportSettings.None).LastOrDefault ()); + Assert.Equal (Application.Top.Padding, View.GetViewsUnderLocation (new Point(0, 0), ViewportSettingsFlags.None).LastOrDefault ()); Application.Top?.Dispose (); Application.ResetState (ignoreDisposed: true); } diff --git a/Tests/UnitTests/View/Adornment/MarginTests.cs b/Tests/UnitTests/View/Adornment/MarginTests.cs index 2cd0faa17..64615ada5 100644 --- a/Tests/UnitTests/View/Adornment/MarginTests.cs +++ b/Tests/UnitTests/View/Adornment/MarginTests.cs @@ -16,7 +16,7 @@ public class MarginTests (ITestOutputHelper output) view.Margin.Thickness = new (1); Application.Top = new Toplevel (); - Application.TopLevels.Push (Gui.Application.Top); + Application.TopLevels.Push (Application.Top); Application.Top.SetScheme (new() { @@ -49,10 +49,10 @@ public class MarginTests (ITestOutputHelper output) var view = new View { Height = 3, Width = 3 }; view.Margin!.Diagnostics = ViewDiagnosticFlags.Thickness; view.Margin.Thickness = new (1); - view.Margin.ViewportSettings = ViewportSettings.None; + view.Margin.ViewportSettings = ViewportSettingsFlags.None; Application.Top = new Toplevel (); - Application.TopLevels.Push (Gui.Application.Top); + Application.TopLevels.Push (Application.Top); Application.Top.SetScheme (new () { diff --git a/Tests/UnitTests/View/Draw/ClearViewportTests.cs b/Tests/UnitTests/View/Draw/ClearViewportTests.cs index 3be3326e2..5aa69954f 100644 --- a/Tests/UnitTests/View/Draw/ClearViewportTests.cs +++ b/Tests/UnitTests/View/Draw/ClearViewportTests.cs @@ -31,7 +31,7 @@ public class ClearViewportTests (ITestOutputHelper output) { // Arrange Mock view = new () { CallBase = true }; - view.Object.ViewportSettings = ViewportSettings.Transparent; + view.Object.ViewportSettings = ViewportSettingsFlags.Transparent; // Act view.Object.DoClearViewport (); @@ -158,7 +158,7 @@ public class ClearViewportTests (ITestOutputHelper output) X = 1, Y = 1, Width = 3, Height = 3, BorderStyle = LineStyle.Single, - ViewportSettings = ViewportSettings.ClearContentOnly + ViewportSettings = ViewportSettingsFlags.ClearContentOnly }; superView.Add (view); superView.BeginInit (); diff --git a/Tests/UnitTests/View/Draw/ClipTests.cs b/Tests/UnitTests/View/Draw/ClipTests.cs index d3d1ed039..893900e59 100644 --- a/Tests/UnitTests/View/Draw/ClipTests.cs +++ b/Tests/UnitTests/View/Draw/ClipTests.cs @@ -252,7 +252,7 @@ public class ClipTests (ITestOutputHelper _output) { Width = Dim.Fill (), Height = Dim.Fill (), - ViewportSettings = ViewportSettings.ClipContentOnly + ViewportSettings = ViewportSettingsFlags.ClipContentOnly }; view.SetContentSize (new Size (10, 10)); view.Border!.Thickness = new (1); diff --git a/Tests/UnitTests/View/Draw/TransparentTests.cs b/Tests/UnitTests/View/Draw/TransparentTests.cs index a1f3159f4..02fc4f5a7 100644 --- a/Tests/UnitTests/View/Draw/TransparentTests.cs +++ b/Tests/UnitTests/View/Draw/TransparentTests.cs @@ -33,7 +33,7 @@ public class TransparentTests (ITestOutputHelper output) Height = 3, Id = "sub", Text = "Sub", - ViewportSettings = ViewportSettings.Transparent, + ViewportSettings = ViewportSettingsFlags.Transparent, BorderStyle = LineStyle.Single }; @@ -76,7 +76,7 @@ public class TransparentTests (ITestOutputHelper output) Width = 15, Height = 3, Id = "sub", - ViewportSettings = ViewportSettings.Transparent, + ViewportSettings = ViewportSettingsFlags.Transparent, BorderStyle = LineStyle.Single }; diff --git a/Tests/UnitTests/View/Layout/Dim.Tests.cs b/Tests/UnitTests/View/Layout/Dim.Tests.cs index 6a3179440..63251a994 100644 --- a/Tests/UnitTests/View/Layout/Dim.Tests.cs +++ b/Tests/UnitTests/View/Layout/Dim.Tests.cs @@ -2,7 +2,7 @@ using System.Globalization; using System.Text; using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.Dim; +using static Terminal.Gui.ViewBase.Dim; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTests/View/Layout/GetViewsUnderLocationTests.cs b/Tests/UnitTests/View/Layout/GetViewsUnderLocationTests.cs index ca06d66b0..03e6ad28f 100644 --- a/Tests/UnitTests/View/Layout/GetViewsUnderLocationTests.cs +++ b/Tests/UnitTests/View/Layout/GetViewsUnderLocationTests.cs @@ -85,7 +85,7 @@ public class GetViewsUnderLocationTests var location = new Point (testX, testY); // Act - List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettings.TransparentMouse); + List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettingsFlags.TransparentMouse); // Assert if (expectedViewsFound.Length == 0) @@ -117,7 +117,7 @@ public class GetViewsUnderLocationTests var location = new Point (testX, testY); // Act - List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettings.TransparentMouse); + List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettingsFlags.TransparentMouse); // Assert Assert.Contains (viewsUnderMouse, v => v == Application.Top); @@ -139,7 +139,7 @@ public class GetViewsUnderLocationTests Width = 10, Height = 10 }; - Assert.Same (Application.Top, View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse).LastOrDefault ()); + Assert.Same (Application.Top, View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault ()); Application.Top.Dispose (); Application.ResetState (true); } @@ -167,7 +167,7 @@ public class GetViewsUnderLocationTests }; Application.Top.Add (subview); - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse).LastOrDefault (); + View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); Assert.Equal (expectedSubViewFound, found == subview); Application.Top.Dispose (); @@ -197,7 +197,7 @@ public class GetViewsUnderLocationTests }; Application.Top.Add (subview); - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse).LastOrDefault (); + View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); Assert.Equal (expectedSubViewFound, found == subview); Application.Top.Dispose (); @@ -229,7 +229,7 @@ public class GetViewsUnderLocationTests subview.Visible = true; Assert.True (subview.Visible); Assert.False (Application.Top.Visible); - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse).LastOrDefault (); + View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); Assert.Equal (expectedSubViewFound, found == subview); Application.Top.Dispose (); @@ -262,7 +262,7 @@ public class GetViewsUnderLocationTests }; Application.Top.Add (subview); - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse).LastOrDefault (); + View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); Assert.Equal (expectedSubViewFound, found == subview); Application.Top.Dispose (); @@ -283,7 +283,7 @@ public class GetViewsUnderLocationTests Application.Top = new () { Width = 10, Height = 10, - ViewportSettings = ViewportSettings.AllowNegativeLocation + ViewportSettings = ViewportSettingsFlags.AllowNegativeLocation }; Application.Top.Viewport = new (offset, offset, 10, 10); @@ -294,7 +294,7 @@ public class GetViewsUnderLocationTests }; Application.Top.Add (subview); - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse).LastOrDefault (); + View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); Assert.Equal (expectedSubViewFound, found == subview); Application.Top.Dispose (); @@ -328,7 +328,7 @@ public class GetViewsUnderLocationTests Application.Top.BeginInit (); Application.Top.EndInit (); - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse).LastOrDefault (); + View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); Assert.Equal (expectedSubViewFound, found == subview); Application.Top.Dispose (); @@ -367,7 +367,7 @@ public class GetViewsUnderLocationTests }; Application.Top.Add (subview); - List viewsUnderMouse = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse); + List viewsUnderMouse = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse); string [] foundIds = viewsUnderMouse.Select (v => v!.Id).ToArray (); Assert.Equal (expectedViewsFound, foundIds); @@ -404,7 +404,7 @@ public class GetViewsUnderLocationTests subview.Border.Id = "border"; Application.Top.Add (subview); - List viewsUnderMouse = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse); + List viewsUnderMouse = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse); string [] foundIds = viewsUnderMouse.Select (v => v!.Id).ToArray (); Assert.Equal (expectedViewsFound, foundIds); @@ -438,11 +438,11 @@ public class GetViewsUnderLocationTests Width = 5, Height = 5 }; subview.Border!.Thickness = new (1); - subview.Border.ViewportSettings = ViewportSettings.TransparentMouse; + subview.Border.ViewportSettings = ViewportSettingsFlags.TransparentMouse; subview.Border.Id = "border"; Application.Top.Add (subview); - List viewsUnderMouse = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse); + List viewsUnderMouse = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse); string [] foundIds = viewsUnderMouse.Select (v => v!.Id).ToArray (); Assert.Equal (expectedViewsFound, foundIds); @@ -490,7 +490,7 @@ public class GetViewsUnderLocationTests Application.Top.BeginInit (); Application.Top.EndInit (); - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse).LastOrDefault (); + View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); Assert.Equal (expectedSubViewFound, found == paddingSubView); Application.Top.Dispose (); @@ -541,7 +541,7 @@ public class GetViewsUnderLocationTests Application.Top.BeginInit (); Application.Top.EndInit (); - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse).LastOrDefault (); + View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); Assert.Equal (expectedSubViewFound, found == paddingSubView); Application.Top.Dispose (); @@ -585,7 +585,7 @@ public class GetViewsUnderLocationTests Application.Top.Add (subviews [0]); - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettings.TransparentMouse).LastOrDefault (); + View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); Assert.Equal (expectedSubViewFound, subviews.IndexOf (found!)); Application.Top.Dispose (); Application.ResetState (true); @@ -632,7 +632,7 @@ public class GetViewsUnderLocationTests view.Add (subView); Application.Top.Add (view); - List found = View.GetViewsUnderLocation (new (mouseX, mouseY), ViewportSettings.TransparentMouse); + List found = View.GetViewsUnderLocation (new (mouseX, mouseY), ViewportSettingsFlags.TransparentMouse); string [] foundIds = found.Select (v => v!.Id).ToArray (); @@ -685,7 +685,7 @@ public class GetViewsUnderLocationTests view.Add (popOver); Application.Top.Add (view); - List found = View.GetViewsUnderLocation (new (mouseX, mouseY), ViewportSettings.TransparentMouse); + List found = View.GetViewsUnderLocation (new (mouseX, mouseY), ViewportSettingsFlags.TransparentMouse); string [] foundIds = found.Select (v => v!.Id).ToArray (); @@ -719,7 +719,7 @@ public class GetViewsUnderLocationTests Application.TopLevels.Push (secondaryToplevel); Application.Top = secondaryToplevel; - List found = View.GetViewsUnderLocation (new (2, 2), ViewportSettings.TransparentMouse); + List found = View.GetViewsUnderLocation (new (2, 2), ViewportSettingsFlags.TransparentMouse); Assert.Contains (found, v => v?.Id == topToplevel.Id); Assert.Contains (found, v => v == topToplevel); @@ -753,7 +753,7 @@ public class GetViewsUnderLocationTests Application.TopLevels.Push (secondaryToplevel); Application.Top = secondaryToplevel; - List found = View.GetViewsUnderLocation (new (7, 7), ViewportSettings.TransparentMouse); + List found = View.GetViewsUnderLocation (new (7, 7), ViewportSettingsFlags.TransparentMouse); Assert.Contains (found, v => v?.Id == secondaryToplevel.Id); Assert.DoesNotContain (found, v => v?.Id == topToplevel.Id); @@ -786,15 +786,15 @@ public class GetViewsUnderLocationTests Application.TopLevels.Push (secondaryToplevel); Application.Top = secondaryToplevel; - secondaryToplevel.Margin.ViewportSettings = ViewportSettings.None; + secondaryToplevel.Margin.ViewportSettings = ViewportSettingsFlags.None; - List found = View.GetViewsUnderLocation (new (5, 5), ViewportSettings.TransparentMouse); + List found = View.GetViewsUnderLocation (new (5, 5), ViewportSettingsFlags.TransparentMouse); Assert.Contains (found, v => v == secondaryToplevel); Assert.Contains (found, v => v == secondaryToplevel.Margin); Assert.DoesNotContain (found, v => v?.Id == topToplevel.Id); - secondaryToplevel.Margin.ViewportSettings = ViewportSettings.TransparentMouse; - found = View.GetViewsUnderLocation (new (5, 5), ViewportSettings.TransparentMouse); + secondaryToplevel.Margin.ViewportSettings = ViewportSettingsFlags.TransparentMouse; + found = View.GetViewsUnderLocation (new (5, 5), ViewportSettingsFlags.TransparentMouse); Assert.DoesNotContain (found, v => v == secondaryToplevel); Assert.DoesNotContain (found, v => v == secondaryToplevel.Margin); Assert.Contains (found, v => v?.Id == topToplevel.Id); @@ -829,7 +829,7 @@ public class GetViewsUnderLocationTests Application.TopLevels.Push (secondaryToplevel); Application.Top = secondaryToplevel; - List found = View.GetViewsUnderLocation (new (20, 20), ViewportSettings.TransparentMouse); + List found = View.GetViewsUnderLocation (new (20, 20), ViewportSettingsFlags.TransparentMouse); Assert.Empty (found); topToplevel.Dispose (); diff --git a/Tests/UnitTests/View/Layout/Pos.CenterTests.cs b/Tests/UnitTests/View/Layout/Pos.CenterTests.cs index 693c8e3e9..26529fc50 100644 --- a/Tests/UnitTests/View/Layout/Pos.CenterTests.cs +++ b/Tests/UnitTests/View/Layout/Pos.CenterTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.Dim; -using static Terminal.Gui.Pos; +using static Terminal.Gui.ViewBase.Dim; +using static Terminal.Gui.ViewBase.Pos; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTests/View/Layout/Pos.CombineTests.cs b/Tests/UnitTests/View/Layout/Pos.CombineTests.cs index c38dd2868..a54ed687f 100644 --- a/Tests/UnitTests/View/Layout/Pos.CombineTests.cs +++ b/Tests/UnitTests/View/Layout/Pos.CombineTests.cs @@ -1,8 +1,8 @@ using Microsoft.VisualStudio.TestPlatform.Utilities; using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.Dim; -using static Terminal.Gui.Pos; +using static Terminal.Gui.ViewBase.Dim; +using static Terminal.Gui.ViewBase.Pos; namespace Terminal.Gui.LayoutTests; @@ -72,7 +72,7 @@ public class PosCombineTests (ITestOutputHelper output) Assert.Equal (new Rectangle (0, 2, 10, 3), win2.Frame); Assert.Equal (new Rectangle (0, 0, 8, 1), view2.Frame); Assert.Equal (new Rectangle (0, 0, 7, 1), view3.Frame); - var foundView = View.GetViewsUnderLocation (new Point(9, 4), ViewportSettings.None).LastOrDefault (); + var foundView = View.GetViewsUnderLocation (new Point(9, 4), ViewportSettingsFlags.None).LastOrDefault (); Assert.Equal (foundView, view2); Application.Top.Dispose (); Application.ResetState (ignoreDisposed: true); diff --git a/Tests/UnitTests/View/Layout/Pos.Tests.cs b/Tests/UnitTests/View/Layout/Pos.Tests.cs index d0683086a..b0f9d203f 100644 --- a/Tests/UnitTests/View/Layout/Pos.Tests.cs +++ b/Tests/UnitTests/View/Layout/Pos.Tests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.Dim; -using static Terminal.Gui.Pos; +using static Terminal.Gui.ViewBase.Dim; +using static Terminal.Gui.ViewBase.Pos; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTests/View/Layout/Pos.ViewTests.cs b/Tests/UnitTests/View/Layout/Pos.ViewTests.cs index 398dae7f8..b9f4c896d 100644 --- a/Tests/UnitTests/View/Layout/Pos.ViewTests.cs +++ b/Tests/UnitTests/View/Layout/Pos.ViewTests.cs @@ -1,6 +1,6 @@ using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.Pos; +using static Terminal.Gui.ViewBase.Pos; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTests/View/Layout/SetLayoutTests.cs b/Tests/UnitTests/View/Layout/SetLayoutTests.cs index 9f5b2ae0c..19ba99050 100644 --- a/Tests/UnitTests/View/Layout/SetLayoutTests.cs +++ b/Tests/UnitTests/View/Layout/SetLayoutTests.cs @@ -1,6 +1,5 @@ using UnitTests; using Xunit.Abstractions; -using static System.Net.Mime.MediaTypeNames; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTests/View/Viewport/ViewportSettings.TransparentMouseTests.cs b/Tests/UnitTests/View/Viewport/ViewportSettings.TransparentMouseTests.cs index 59be700ef..7f1ffafa3 100644 --- a/Tests/UnitTests/View/Viewport/ViewportSettings.TransparentMouseTests.cs +++ b/Tests/UnitTests/View/Viewport/ViewportSettings.TransparentMouseTests.cs @@ -26,7 +26,7 @@ public class TransparentMouseTests Application.Top = top; var underlying = new MouseTrackingView { Id = "underlying", X = 0, Y = 0, Width = 10, Height = 10 }; - var overlay = new MouseTrackingView { Id = "overlay", X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettings.TransparentMouse }; + var overlay = new MouseTrackingView { Id = "overlay", X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettingsFlags.TransparentMouse }; top.Add (underlying); top.Add (overlay); @@ -59,7 +59,7 @@ public class TransparentMouseTests Application.Top = top; var underlying = new MouseTrackingView { X = 0, Y = 0, Width = 10, Height = 10 }; - var overlay = new MouseTrackingView { X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettings.None }; + var overlay = new MouseTrackingView { X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettingsFlags.None }; top.Add (underlying); top.Add (overlay); @@ -92,8 +92,8 @@ public class TransparentMouseTests var top = new Toplevel (); Application.Top = top; - var underlying = new MouseTrackingView { X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettings.TransparentMouse }; - var overlay = new MouseTrackingView { X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettings.TransparentMouse }; + var underlying = new MouseTrackingView { X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettingsFlags.TransparentMouse }; + var overlay = new MouseTrackingView { X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettingsFlags.TransparentMouse }; top.Add (underlying); top.Add (overlay); diff --git a/Tests/UnitTestsParallelizable/AssemblyInfo.cs b/Tests/UnitTestsParallelizable/AssemblyInfo.cs index 97d54f7cf..4e9b2b2db 100644 --- a/Tests/UnitTestsParallelizable/AssemblyInfo.cs +++ b/Tests/UnitTestsParallelizable/AssemblyInfo.cs @@ -1 +1,13 @@ -global using CM = Terminal.Gui.ConfigurationManager; +global using Attribute = Terminal.Gui.Drawing.Attribute; +global using Color = Terminal.Gui.Drawing.Color; +global using CM = Terminal.Gui.Configuration.ConfigurationManager; +global using Terminal.Gui.App; +global using Terminal.Gui.Drivers; +global using Terminal.Gui.Input; +global using Terminal.Gui.Configuration; +global using Terminal.Gui.ViewBase; +global using Terminal.Gui.Views; +global using Terminal.Gui.Drawing; +global using Terminal.Gui.Text; +global using Terminal.Gui.Resources; +global using Terminal.Gui.FileServices; \ No newline at end of file diff --git a/Tests/UnitTestsParallelizable/Drawing/Color/MultiStandardColorNameResolverTests.cs b/Tests/UnitTestsParallelizable/Drawing/Color/MultiStandardColorNameResolverTests.cs index ff8ca8af4..ca75dfb50 100644 --- a/Tests/UnitTestsParallelizable/Drawing/Color/MultiStandardColorNameResolverTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/Color/MultiStandardColorNameResolverTests.cs @@ -2,7 +2,6 @@ using System.Collections.Generic; using Xunit.Abstractions; -using static Terminal.Gui.StandardColors; namespace Terminal.Gui.DrawingTests; @@ -22,7 +21,7 @@ public class MultiStandardColorNameResolverTests (ITestOutputHelper output) Assert.True (parsed, $"TryParseColor should succeed for {name}"); - Color expectedColor = new (GetArgb (standardColor)); + Color expectedColor = new (Drawing.StandardColors.GetArgb (standardColor)); Assert.Equal (expectedColor.R, actualColor.R); Assert.Equal (expectedColor.G, actualColor.G); @@ -33,7 +32,7 @@ public class MultiStandardColorNameResolverTests (ITestOutputHelper output) [MemberData (nameof (StandardColors))] public void TryNameColor_ResolvesAllStandardColors (StandardColor standardColor) { - Color color = new (GetArgb (standardColor)); + Color color = new (Drawing.StandardColors.GetArgb (standardColor)); bool success = _candidate.TryNameColor (color, out string? resolvedName); @@ -45,7 +44,7 @@ public class MultiStandardColorNameResolverTests (ITestOutputHelper output) Assert.True (success, $"TryNameColor should succeed for {standardColor}"); List expectedNames = Enum.GetNames () - .Where (name => GetArgb (Enum.Parse (name)) == color.Argb) + .Where (name => Drawing.StandardColors.GetArgb (Enum.Parse (name)) == color.Argb) .ToList (); Assert.Contains (resolvedName, expectedNames); @@ -58,7 +57,7 @@ public class MultiStandardColorNameResolverTests (ITestOutputHelper output) foreach (StandardColor sc in Enum.GetValues ()) { - Color color = new (GetArgb (sc)); + Color color = new (Drawing.StandardColors.GetArgb (sc)); if (!_candidate.TryNameColor (color, out _)) { unmapped.Add (sc); diff --git a/Tests/UnitTestsParallelizable/Drawing/SixelEncoderTests.cs b/Tests/UnitTestsParallelizable/Drawing/SixelEncoderTests.cs index f85942e72..e128cc5a2 100644 --- a/Tests/UnitTestsParallelizable/Drawing/SixelEncoderTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/SixelEncoderTests.cs @@ -1,5 +1,4 @@ -using Color = Terminal.Gui.Color; - + namespace Terminal.Gui.DrawingTests; public class SixelEncoderTests diff --git a/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingTests.cs b/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingTests.cs index 9d011e407..7976b7ed2 100644 --- a/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingTests.cs +++ b/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingTests.cs @@ -1,5 +1,4 @@ -using Terminal.Gui.EnumExtensions; -using Xunit.Abstractions; +using Xunit.Abstractions; namespace Terminal.Gui.InputTests; diff --git a/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingsTests.cs b/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingsTests.cs index 05147e615..85fe140aa 100644 --- a/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingsTests.cs +++ b/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingsTests.cs @@ -1,5 +1,4 @@ -using Terminal.Gui.EnumExtensions; -using Xunit.Abstractions; +using Xunit.Abstractions; using static Unix.Terminal.Delegates; namespace Terminal.Gui.InputTests; diff --git a/Tests/UnitTestsParallelizable/MockConsoleDriver.cs b/Tests/UnitTestsParallelizable/MockConsoleDriver.cs index a5e97f26a..1eb4699e1 100644 --- a/Tests/UnitTestsParallelizable/MockConsoleDriver.cs +++ b/Tests/UnitTestsParallelizable/MockConsoleDriver.cs @@ -1,9 +1,6 @@ #nullable enable using System.Text; -using Terminal.Gui; -using Attribute = Terminal.Gui.Attribute; -using Color = Terminal.Gui.Color; internal class MockConsoleDriver : IConsoleDriver { diff --git a/Tests/UnitTestsParallelizable/ParallelizableBase.cs b/Tests/UnitTestsParallelizable/ParallelizableBase.cs index f6fc50c39..e2cb7355c 100644 --- a/Tests/UnitTestsParallelizable/ParallelizableBase.cs +++ b/Tests/UnitTestsParallelizable/ParallelizableBase.cs @@ -1,3 +1,4 @@ + namespace UnitTests.Parallelizable; /// diff --git a/Tests/UnitTestsParallelizable/View/Adornment/MarginTests.cs b/Tests/UnitTestsParallelizable/View/Adornment/MarginTests.cs index 3b834e8e9..26ff16088 100644 --- a/Tests/UnitTestsParallelizable/View/Adornment/MarginTests.cs +++ b/Tests/UnitTestsParallelizable/View/Adornment/MarginTests.cs @@ -9,14 +9,14 @@ public class MarginTests public void Is_Visually_Transparent () { var view = new View { Height = 3, Width = 3 }; - Assert.True(view.Margin!.ViewportSettings.HasFlag(ViewportSettings.Transparent), "Margin should be transparent by default."); + Assert.True(view.Margin!.ViewportSettings.HasFlag(ViewportSettingsFlags.Transparent), "Margin should be transparent by default."); } [Fact] public void Is_Transparent_To_Mouse () { var view = new View { Height = 3, Width = 3 }; - Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettings.TransparentMouse), "Margin should be transparent to mouse by default."); + Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.TransparentMouse), "Margin should be transparent to mouse by default."); } [Fact] @@ -31,7 +31,7 @@ public class MarginTests view.Margin.Text = "Test"; // Strip off ViewportSettings.Transparent - view.Margin!.ViewportSettings &= ~ViewportSettings.Transparent; + view.Margin!.ViewportSettings &= ~ViewportSettingsFlags.Transparent; // @@ -50,8 +50,8 @@ public class MarginTests { var view = new View { Height = 3, Width = 3, ShadowStyle = ShadowStyle.Transparent }; Assert.Equal (ShadowStyle.Transparent, view.Margin!.ShadowStyle); - Assert.True (view.Margin.ViewportSettings.HasFlag (ViewportSettings.TransparentMouse), "Margin should be transparent to mouse when ShadowStyle is Transparent."); - Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettings.Transparent), "Margin should be transparent when ShadowStyle is Transparent.."); + Assert.True (view.Margin.ViewportSettings.HasFlag (ViewportSettingsFlags.TransparentMouse), "Margin should be transparent to mouse when ShadowStyle is Transparent."); + Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.Transparent), "Margin should be transparent when ShadowStyle is Transparent.."); } [Fact] @@ -59,8 +59,8 @@ public class MarginTests { var view = new View { Height = 3, Width = 3, ShadowStyle = ShadowStyle.Opaque }; Assert.Equal (ShadowStyle.Opaque, view.Margin!.ShadowStyle); - Assert.True (view.Margin.ViewportSettings.HasFlag (ViewportSettings.TransparentMouse), "Margin should be transparent to mouse when ShadowStyle is Opaque."); - Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettings.Transparent), "Margin should be transparent when ShadowStyle is Opaque.."); + Assert.True (view.Margin.ViewportSettings.HasFlag (ViewportSettingsFlags.TransparentMouse), "Margin should be transparent to mouse when ShadowStyle is Opaque."); + Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.Transparent), "Margin should be transparent when ShadowStyle is Opaque.."); } } diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.cs index 19eb1387c..6335c58c5 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.cs @@ -1,7 +1,7 @@ using System.Text; using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.Dim; +using static Terminal.Gui.ViewBase.Dim; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.CombineTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Dim.CombineTests.cs index 5ad9ab350..d48dfe799 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.CombineTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/Dim.CombineTests.cs @@ -1,5 +1,5 @@ using Xunit.Abstractions; -using static Terminal.Gui.Dim; +using static Terminal.Gui.ViewBase.Dim; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.FuncTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Dim.FuncTests.cs index ab40cbf85..7dfc2a7bb 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.FuncTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/Dim.FuncTests.cs @@ -1,5 +1,5 @@ using Xunit.Abstractions; -using static Terminal.Gui.Dim; +using static Terminal.Gui.ViewBase.Dim; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.PercentTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Dim.PercentTests.cs index ce462aa90..2ccfd3861 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.PercentTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/Dim.PercentTests.cs @@ -1,7 +1,7 @@ using System.Globalization; using System.Text; using Xunit.Abstractions; -using static Terminal.Gui.Dim; +using static Terminal.Gui.ViewBase.Dim; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.Tests.cs b/Tests/UnitTestsParallelizable/View/Layout/Dim.Tests.cs index a363c0f84..8c716e1ec 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.Tests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/Dim.Tests.cs @@ -2,7 +2,7 @@ using System.Globalization; using System.Text; using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.Dim; +using static Terminal.Gui.ViewBase.Dim; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.ViewTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Dim.ViewTests.cs index ef1e1f85b..ceb463548 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.ViewTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/Dim.ViewTests.cs @@ -1,4 +1,4 @@ -using static Terminal.Gui.Dim; +using static Terminal.Gui.ViewBase.Dim; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationForRootTests.cs b/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationForRootTests.cs index d492b9e47..a624fa8d1 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationForRootTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationForRootTests.cs @@ -12,7 +12,7 @@ public class GetViewsUnderLocationForRootTests { Frame = new (0, 0, 10, 10) }; - List result = View.GetViewsUnderLocation (top, new (5, 5), ViewportSettings.TransparentMouse); + List result = View.GetViewsUnderLocation (top, new (5, 5), ViewportSettingsFlags.TransparentMouse); Assert.Contains (top, result); } @@ -23,7 +23,7 @@ public class GetViewsUnderLocationForRootTests { Frame = new (0, 0, 10, 10) }; - List result = View.GetViewsUnderLocation (top, new (20, 20), ViewportSettings.TransparentMouse); + List result = View.GetViewsUnderLocation (top, new (20, 20), ViewportSettingsFlags.TransparentMouse); Assert.Empty (result); } @@ -40,7 +40,7 @@ public class GetViewsUnderLocationForRootTests X = 2, Y = 2, Width = 5, Height = 5 }; top.Add (sub); - List result = View.GetViewsUnderLocation (top, new (3, 3), ViewportSettings.TransparentMouse); + List result = View.GetViewsUnderLocation (top, new (3, 3), ViewportSettingsFlags.TransparentMouse); Assert.Contains (top, result); Assert.Contains (sub, result); Assert.Equal (sub, result.Last ()); @@ -57,14 +57,14 @@ public class GetViewsUnderLocationForRootTests View sub = new () { X = 2, Y = 2, Width = 5, Height = 5, - ViewportSettings = ViewportSettings.TransparentMouse + ViewportSettings = ViewportSettingsFlags.TransparentMouse }; top.Add (sub); - List result = View.GetViewsUnderLocation (top, new (3, 3), ViewportSettings.TransparentMouse); + List result = View.GetViewsUnderLocation (top, new (3, 3), ViewportSettingsFlags.TransparentMouse); Assert.Single (result); Assert.Contains (top, result); - result = View.GetViewsUnderLocation (top, new (3, 3), ViewportSettings.None); + result = View.GetViewsUnderLocation (top, new (3, 3), ViewportSettingsFlags.None); Assert.Equal (2, result.Count); Assert.Contains (top, result); Assert.Contains (sub, result); @@ -78,8 +78,8 @@ public class GetViewsUnderLocationForRootTests Frame = new (0, 0, 10, 10) }; top.Margin!.Thickness = new (1); - top.Margin!.ViewportSettings = ViewportSettings.None; - List result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettings.TransparentMouse); + top.Margin!.ViewportSettings = ViewportSettingsFlags.None; + List result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettingsFlags.TransparentMouse); Assert.Contains (top, result); Assert.Contains (top.Margin, result); } @@ -92,8 +92,8 @@ public class GetViewsUnderLocationForRootTests Frame = new (0, 0, 10, 10) }; top.Margin!.Thickness = new (1); - top.Margin!.ViewportSettings = ViewportSettings.TransparentMouse; - List result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettings.TransparentMouse); + top.Margin!.ViewportSettings = ViewportSettingsFlags.TransparentMouse; + List result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettingsFlags.TransparentMouse); Assert.DoesNotContain (top, result); Assert.DoesNotContain (top.Margin, result); } @@ -106,8 +106,8 @@ public class GetViewsUnderLocationForRootTests Frame = new (0, 0, 10, 10) }; top.Margin!.Thickness = new (1); - top.Margin!.ViewportSettings = ViewportSettings.None; - List result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettings.TransparentMouse); + top.Margin!.ViewportSettings = ViewportSettingsFlags.None; + List result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettingsFlags.TransparentMouse); Assert.Contains (top, result); Assert.Contains (top.Margin, result); } @@ -120,7 +120,7 @@ public class GetViewsUnderLocationForRootTests Frame = new (0, 0, 10, 10) }; top.Border!.Thickness = new (1); - List result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettings.TransparentMouse); + List result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettingsFlags.TransparentMouse); Assert.Contains (top, result); Assert.Contains (top.Border, result); } @@ -135,7 +135,7 @@ public class GetViewsUnderLocationForRootTests top.Border!.Thickness = new (1); top.Padding!.Thickness = new (1); top.Layout (); - List result = View.GetViewsUnderLocation (top, new (1, 1), ViewportSettings.TransparentMouse); + List result = View.GetViewsUnderLocation (top, new (1, 1), ViewportSettingsFlags.TransparentMouse); Assert.Contains (top, result); Assert.Contains (top.Padding, result); } @@ -146,12 +146,12 @@ public class GetViewsUnderLocationForRootTests Toplevel top = new () { Frame = new (0, 0, 10, 10), - ViewportSettings = ViewportSettings.TransparentMouse + ViewportSettings = ViewportSettingsFlags.TransparentMouse }; - List result = View.GetViewsUnderLocation (top, new (5, 5), ViewportSettings.TransparentMouse); + List result = View.GetViewsUnderLocation (top, new (5, 5), ViewportSettingsFlags.TransparentMouse); Assert.Empty (result); - result = View.GetViewsUnderLocation (top, new (5, 5), ViewportSettings.None); + result = View.GetViewsUnderLocation (top, new (5, 5), ViewportSettingsFlags.None); Assert.NotEmpty (result); } @@ -174,7 +174,7 @@ public class GetViewsUnderLocationForRootTests }; sub1.Add (sub2); top.Add (sub1); - List result = View.GetViewsUnderLocation (top, new (3, 3), ViewportSettings.TransparentMouse); + List result = View.GetViewsUnderLocation (top, new (3, 3), ViewportSettingsFlags.TransparentMouse); Assert.Contains (sub2, result); Assert.Equal (sub2, result.Last ()); } @@ -192,18 +192,18 @@ public class GetViewsUnderLocationForRootTests Frame = new (0, 0, 5, 5) }; subView.Margin!.Thickness = new (1); - subView.Margin!.ViewportSettings = ViewportSettings.None; + subView.Margin!.ViewportSettings = ViewportSettingsFlags.None; top.Add (subView); Assert.True (subView.Contains (new Point (4, 4))); - List result = View.GetViewsUnderLocation (top, new (4, 4), ViewportSettings.TransparentMouse); + List result = View.GetViewsUnderLocation (top, new (4, 4), ViewportSettingsFlags.TransparentMouse); Assert.Contains (top, result); Assert.Contains (subView.Margin, result); Assert.Contains (subView, result); - subView.Margin!.ViewportSettings = ViewportSettings.TransparentMouse; + subView.Margin!.ViewportSettings = ViewportSettingsFlags.TransparentMouse; - result = View.GetViewsUnderLocation (top, new (4, 4), ViewportSettings.TransparentMouse); + result = View.GetViewsUnderLocation (top, new (4, 4), ViewportSettingsFlags.TransparentMouse); Assert.Contains (top, result); Assert.DoesNotContain (subView.Margin, result); Assert.DoesNotContain (subView, result); @@ -254,10 +254,10 @@ public class GetViewsUnderLocationForRootTests adornment!.Add (adornmentSubView); // Set adornment ViewportSettings to None so it doesn't interfere with the test - adornment.ViewportSettings = ViewportSettings.None; + adornment.ViewportSettings = ViewportSettingsFlags.None; // Act: Point inside adornmentSubView (which is inside the adornment) - var result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettings.TransparentMouse); + var result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettingsFlags.TransparentMouse); // Assert: Should contain top, subView, adornment, and adornmentSubView Assert.Contains (top, result); @@ -317,10 +317,10 @@ public class GetViewsUnderLocationForRootTests }; adornment!.Add (adornmentSubView); - adornment.ViewportSettings = ViewportSettings.TransparentMouse; + adornment.ViewportSettings = ViewportSettingsFlags.TransparentMouse; // Act: Point inside adornmentSubView (which is inside the adornment) - var result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettings.TransparentMouse); + var result = View.GetViewsUnderLocation (top, new (0, 0), ViewportSettingsFlags.TransparentMouse); // Assert: Should contain top, subView, adornment, and adornmentSubView Assert.Contains (top, result); diff --git a/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationTests.cs b/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationTests.cs index 070e83425..4433bef3a 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationTests.cs @@ -20,7 +20,7 @@ public class GetViewsUnderLocationTests var location = new Point (testX, testY); // Act - List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettings.None); + List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettingsFlags.None); // Assert Assert.Empty (viewsUnderMouse); @@ -42,7 +42,7 @@ public class GetViewsUnderLocationTests var location = new Point (testX, testY); // Act - List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettings.None); + List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettingsFlags.None); // Assert Assert.Empty (viewsUnderMouse); diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.AnchorEndTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Pos.AnchorEndTests.cs index b0735252a..ddd59432b 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.AnchorEndTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/Pos.AnchorEndTests.cs @@ -1,5 +1,5 @@ using Xunit.Abstractions; -using static Terminal.Gui.Pos; +using static Terminal.Gui.ViewBase.Pos; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.CenterTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Pos.CenterTests.cs index 31416de8b..96fbc95b7 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.CenterTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/Pos.CenterTests.cs @@ -1,5 +1,5 @@ using Xunit.Abstractions; -using static Terminal.Gui.Pos; +using static Terminal.Gui.ViewBase.Pos; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.CombineTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Pos.CombineTests.cs index 4dc2e420a..a5bb92976 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.CombineTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/Pos.CombineTests.cs @@ -1,8 +1,8 @@ using Microsoft.VisualStudio.TestPlatform.Utilities; using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.Dim; -using static Terminal.Gui.Pos; +using static Terminal.Gui.ViewBase.Dim; +using static Terminal.Gui.ViewBase.Pos; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.PercentTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Pos.PercentTests.cs index 0c6eadba6..e508ea699 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.PercentTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/Pos.PercentTests.cs @@ -1,5 +1,5 @@ using Xunit.Abstractions; -using static Terminal.Gui.Pos; +using static Terminal.Gui.ViewBase.Pos; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.ViewTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Pos.ViewTests.cs index c1531140c..b6bc54d91 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.ViewTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/Pos.ViewTests.cs @@ -1,4 +1,4 @@ -using static Terminal.Gui.Pos; +using static Terminal.Gui.ViewBase.Pos; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/SetRelativeLayoutTests.cs b/Tests/UnitTestsParallelizable/View/Layout/SetRelativeLayoutTests.cs index 3ac89f638..133ac3ab3 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/SetRelativeLayoutTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/SetRelativeLayoutTests.cs @@ -1,6 +1,6 @@ using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.Dim; +using static Terminal.Gui.ViewBase.Dim; namespace Terminal.Gui.LayoutTests; diff --git a/Tests/UnitTestsParallelizable/View/Layout/ToScreenTests.cs b/Tests/UnitTestsParallelizable/View/Layout/ToScreenTests.cs index e9b04a973..82fd79d32 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/ToScreenTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/ToScreenTests.cs @@ -628,7 +628,7 @@ public class ToScreenTests () { Width = 10, Height = 10, - ViewportSettings = ViewportSettings.AllowNegativeLocation + ViewportSettings = ViewportSettingsFlags.AllowNegativeLocation }; view.Layout (); diff --git a/Tests/UnitTestsParallelizable/View/Layout/ViewportTests.cs b/Tests/UnitTestsParallelizable/View/Layout/ViewportTests.cs index 541f34c1e..4dc07beb8 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/ViewportTests.cs +++ b/Tests/UnitTestsParallelizable/View/Layout/ViewportTests.cs @@ -158,7 +158,7 @@ public class ViewportTests (ITestOutputHelper output) { Width = 10, Height = 10, - ViewportSettings = ViewportSettings.AllowNegativeLocation + ViewportSettings = ViewportSettingsFlags.AllowNegativeLocation }; view.Layout (); @@ -257,7 +257,7 @@ public class ViewportTests (ITestOutputHelper output) { Width = viewWidth, Height = viewHeight, - ViewportSettings = ViewportSettings.AllowLocationGreaterThanContentSize + ViewportSettings = ViewportSettingsFlags.AllowLocationGreaterThanContentSize }; var newViewport = new Rectangle (10, 10, viewWidth, viewHeight); @@ -275,7 +275,7 @@ public class ViewportTests (ITestOutputHelper output) var view = new View (); view.SetContentSize (new (100, 100)); var newViewport = new Rectangle (0, 0, 200, 200); - view.ViewportSettings = ViewportSettings.AllowLocationGreaterThanContentSize; + view.ViewportSettings = ViewportSettingsFlags.AllowLocationGreaterThanContentSize; // Act view.Viewport = newViewport; @@ -290,7 +290,7 @@ public class ViewportTests (ITestOutputHelper output) // Arrange var view = new View (); var newViewport = new Rectangle (-10, -10, 100, 100); - view.ViewportSettings = ViewportSettings.AllowNegativeLocation; + view.ViewportSettings = ViewportSettingsFlags.AllowNegativeLocation; // Act view.Viewport = newViewport; @@ -305,7 +305,7 @@ public class ViewportTests (ITestOutputHelper output) // Arrange var view = new View (); var newViewport = new Rectangle (-10, -10, 100, 100); - view.ViewportSettings = ViewportSettings.None; + view.ViewportSettings = ViewportSettingsFlags.None; // Act view.Viewport = newViewport; diff --git a/Tests/UnitTestsParallelizable/View/SchemeTests.cs b/Tests/UnitTestsParallelizable/View/SchemeTests.cs index 34c059f86..7ff9bbc9f 100644 --- a/Tests/UnitTestsParallelizable/View/SchemeTests.cs +++ b/Tests/UnitTestsParallelizable/View/SchemeTests.cs @@ -1,5 +1,4 @@ #nullable enable -using Terminal.Gui; using Xunit; namespace Terminal.Gui.ViewTests; diff --git a/docfx/README.md b/docfx/README.md index c84568266..1d59cdd59 100644 --- a/docfx/README.md +++ b/docfx/README.md @@ -5,6 +5,12 @@ The API documentation is generated via a GitHub Action (`.github/workflows/api-d ## To Generate the Docs Locally 0. Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html -1. Change to the `./docfx` folder and run `./build.ps1` +1. Run `./docfx/scripts/Build.ps1` 2. Browse to http://localhost:8080 and verify everything looks good. 3. Hit ctrl-c to stop the script. + +## To update `views.md` + +0. Switch to the `./docfx` folder +1. Run `./scripts/generate-views-doc.ps1` +2. Commit the changes to `docs/views.md` diff --git a/docfx/_exported_templates/modern/public/main.css b/docfx/_exported_templates/modern/public/main.css index 12b0b40cb..c0e882bb3 100644 --- a/docfx/_exported_templates/modern/public/main.css +++ b/docfx/_exported_templates/modern/public/main.css @@ -1,10 +1,12 @@ :root { --bs-font-monospace: 'Cascadia Code', SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace; --bs-font-sans-serif: "Segoe UI", Roboto, "Helvetica Neue", "Noto Sans", "Liberation Sans", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; - --bs-body-font-weight: 300; + --bs-body-font-weight: 200; --bs-body-font-weight: 0.9rem; - - --bs-navbar-brand-font-size: 1.5em; + --bs-body-font-size: 0.9rem; + --bs-nav-link-font-size: 0.8rem; + --bs-nav-link-font-weight: 200; + --bs-navbar-brand-font-size: 1.3em; } [data-bs-theme=dark] { @@ -22,24 +24,31 @@ } .toc { - font-size: 13em; + font-size: var(--bs-nav-link-font-size); } .toc li { - font-weight: 300; margin: .2em 0; } +.toc ul { + font-size: var(--bs-nav-link-font-size); +} + h6, .h6, h5, .h5, h4, .h4, h3, .h3, h2, .h2, h1, .h1 { font-weight: 200; } .toc form.filter>i.bi { - font-size: var(--bs-body-font-size); + font-size: var(--bs-nav-link-font-size); } .toc .flex-fill { - font-size: var(--bs-body-font-size); + font-size: var(--bs-nav-link-font-size); } +.form-control { + font-size: var(--bs-nav-link-font-size); + font-weight: var(--bs-nav-link-font-weight); +} .inheritedMembers { display: none; } diff --git a/docfx/aboutbox.png b/docfx/aboutbox.png index 1fbf892c4..42eb0f03d 100644 Binary files a/docfx/aboutbox.png and b/docfx/aboutbox.png differ diff --git a/docfx/build.ps1 b/docfx/build.ps1 deleted file mode 100644 index b94ae6623..000000000 --- a/docfx/build.ps1 +++ /dev/null @@ -1,21 +0,0 @@ -# Builds the Terminal.gui API documentation using docfx - -$prevPwd = $PWD; Set-Location -ErrorAction Stop -LiteralPath $PSScriptRoot - -try { - $PWD # output the current location - - dotnet tool update -g docfx - - # Force delete metadata - rm ./api -Recurse -Force -ErrorAction SilentlyContinue - - $env:DOCFX_SOURCE_BRANCH_NAME="v2_develop" - - docfx --serve -} -finally { - # Restore the previous location. - $prevPwd | Set-Location -} - diff --git a/docfx/docfx.json b/docfx/docfx.json index 0878c7b8e..ae1768cbe 100644 --- a/docfx/docfx.json +++ b/docfx/docfx.json @@ -41,7 +41,8 @@ "schemas/**.json" ], "exclude": [ - "_site/**" + "_site/**", + "includes/**" ] } ], diff --git a/docfx/docs/Popovers.md b/docfx/docs/Popovers.md index 74ca7e864..bfbe549dd 100644 --- a/docfx/docs/Popovers.md +++ b/docfx/docs/Popovers.md @@ -4,15 +4,15 @@ Normally Views cannot draw outside of their `Viewport`. Options for influencing 1) Modifying the `Border` behavior 2) Modifying the `Margin` behavior -3) Using @Terminal.Gui.Application.Popover +3) Using @Terminal.Gui.App.Application.Popover Popovers are useful for scenarios such as menus, autocomplete popups, and drop-down combo boxes. -A Popover is any View that meets these characteristics" +A `Popover` is any View that meets these characteristics: -- Implements the @Terminal.Gui.IPopover interface +- Implements the @Terminal.Gui.App.IPopover interface - Is Focusable (`CetFocus = true`) - Is Transparent (`ViewportSettings = ViewportSettings.Transparent | ViewportSettings.TransparentMouse` - Sets `Visible = false` when it receives `Application.QuitKey` -@Terminal.Gui.PopoverMenu provides a sophisticated implementation. \ No newline at end of file +@Terminal.Gui.Views.PopoverMenu provides a sophisticated implementation that can be used as a context menu and is the basis for @Terminal.Gui.MenuBarv2. \ No newline at end of file diff --git a/docfx/docs/View.md b/docfx/docs/View.md index c47350d8d..af69a5713 100644 --- a/docfx/docs/View.md +++ b/docfx/docs/View.md @@ -1,18 +1,24 @@ # View Deep Dive -## View Lexicon & Taxonomy +## Hierarchy -### Hierarchy - - * *@"Terminal.Gui.View"* - The base class for implementing higher-level visual/interactive Terminal.Gui elements. Implemented in the @Terminal.Gui.View base class. + * @Terminal.Gui.View - The base class for implementing higher-level visual/interactive Terminal.Gui elements. Implemented in the @Terminal.Gui.ViewBase.View base class. - * *SubView* - A View that is contained in another view and will be rendered as part of the containing view's **ContentArea**. SubViews are added to another view via the @"Terminal.Gui.View.Add(Terminal.Gui.View)" method. A View may only be a SubView of a single View. Each View has a @Terminal.Gui.View.SubViews property that is a list of all SubViews that have been added. + * *SubView* - A View that is contained in another view and will be rendered as part of the containing view's **ContentArea**. SubViews are added to another view via the @"Terminal.Gui.ViewBase.View.Add(Terminal.Gui.View)" method. A View may only be a SubView of a single View. Each View has a @Terminal.Gui.ViewBase.View.SubViews property that is a list of all SubViews that have been added. - * *@"Terminal.Gui.View.SuperView"* - The View that is a container for SubViews. Each View has a @Terminal.Gui.View.SuperView property that references it's SuperView after it has been added. + * @Terminal.Gui.View.SuperView - The View that is a container for SubViews. Each View has a @Terminal.Gui.ViewBase.View.SuperView property that references it's SuperView after it has been added. * *Child View* - A view that holds a reference to another view in a parent/child relationship. Terminal.Gui uses the terms "Child" and "Parent" sparingly. Generally SubView/SuperView is preferred. * *Parent View* - A view that holds a reference to another view in a parent/child relationship, but is NOT a SuperView of the child. Terminal.Gui uses the terms "Child" and "Parent" sparingly. Generally SubView/SuperView is preferred. + +## Composition + +[!INCLUDE [View Composition](~/includes/view-composition.md)] + +### List of Built-In Views + +See [List of Built-In Views](views.md) ### Commands @@ -38,15 +44,71 @@ See the [Navigation Deep Dive](navigation.md). See the [Scrolling Deep Dive](scrolling.md). +## Modal Views -### Application Concepts +Views can either be Modal or Non-modal. Modal views take over all user input until the user closes the View. Examples of Modal Views are Toplevel, Dialog, and Wizard. Non-modal views can be used to create a new experience in your application, one where you would have a new top-level menu for example. Setting the `Modal` property on a View to `true` makes it modal. + +To run any View (but especially Dialogs, Windows, or Toplevels) modally, invoke the `Application.Run` method on a Toplevel. Use the `Application.RequestStop()` method to terminate the modal execution. + +```csharp + +``` + +There is no return value from running modally, so the modal view must have a mechanism to indicate the reason the modal was closed. In the case above, the `okpressed` value is set to true if the user pressed or selected the `Ok` button. + +### Dialogs + +[Dialogs](~/api/Terminal.Gui.Views.Dialog.yml) are Modal [Windows](~/api/Terminal.Gui.Views.Window.yml) that are centered in the middle of the screen and are intended to be used modally - that is, they run, and they are expected to return a result before resuming execution of the application. + +Dialogs expose an API for adding buttons and managing the layout such that buttons are at the bottom of the dialog (e.g. [`AddButton`](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui.Dialog.yml#Terminal_Gui_Dialog_AddButton_Terminal_Gui_Button_)). + +Example: +```csharp +bool okpressed = false; +var ok = new Button() { Title = "Ok" }; +var cancel = new Button() { Title = "Cancel" }; +var dialog = new Dialog () { Text = "Are you sure you want to quit?", Title = "Quit", Buttons = { ok, cancel } }; +``` + +Which will show something like this: + +``` ++- Quit -----------------------------------------------+ +| Are you sure you want to quit? | +| | +| [ Ok ] [ Cancel ] | ++------------------------------------------------------+ +``` + +### Wizards + +[Wizards](~/api/Terminal.Gui.Views.Wizard.yml) are Dialogs that let users step through a series of steps to complete a task. + +``` +╔╡Gandolf - The last step╞════════════════════════════════════╗ +║ The wizard is complete! ║ +║☐ Enable Final Final Step ║ +║ Press the Finish ║ +║ button to continue. ║ +║ ║ +║ Pressing ESC will ║ +║ cancel the wizard. ║ +║ ║ +║ ║ +║─────────────────────────────────────────────────────────────║ +║⟦ Back ⟧ ⟦► Finish ◄⟧║ +╚═════════════════════════════════════════════════════════════╝ +``` + + +## Application Concepts * *TopLevel* - The v1 term used to describe a view that can have a MenuBar and/or StatusBar. In v2, we will delete the `TopLevel` class and ensure ANY View can have a menu bar and/or status bar (via `Adornments`). - * NOTE: There will still be an `Application.Top` which is the [View](~/api/Terminal.Gui.View.yml) that is the root of the `Application`'s view hierarchy. + * NOTE: There will still be an `Application.Top` which is the [View](~/api/Terminal.Gui.ViewBase.View.yml) that is the root of the `Application`'s view hierarchy. * *Runnable* - TBD - * *Modal* - *Modal* - The term used when describing a [View](~/api/Terminal.Gui.View.yml) that was created using the `Application.Run(view)` or `Application.Run` APIs. When a View is running as a modal, user input is restricted to just that View until `Application.Run` exits. A `Modal` View has its own `RunState`. + * *Modal* - *Modal* - The term used when describing a [View](~/api/Terminal.Gui.Viewbase.View.yml) that was created using the `Application.Run(view)` or `Application.Run` APIs. When a View is running as a modal, user input is restricted to just that View until `Application.Run` exits. A `Modal` View has its own `RunState`. * In v1, classes derived from `Dialog` were originally thought to only work modally. However, `Wizard` proved that a `Dialog`-based class can also work non-modally. * In v2, we will simplify the `Dialog` class, and let any class be run via `Applicaiton.Run`. The `Modal` property will be set by `Application.Run` so the class can detect it is running modally if it needs to. diff --git a/docfx/docs/arrangement.md b/docfx/docs/arrangement.md index ce74a0e3c..ba15c305d 100644 --- a/docfx/docs/arrangement.md +++ b/docfx/docs/arrangement.md @@ -2,21 +2,58 @@ Terminal.Gui provides a feature of Layout known as **Arrangement**, which controls how the user can use the mouse and keyboard to arrange views and enables either **Tiled** or **Overlapped** layouts. Arrangement is a sub-topic of [Layout](layout.md). +## Arrangement Taxonomy & Lexicon -* **Arrangement** - Describes the feature of [Layout](layout.md) which controls how the user can use the mouse and keyboard to arrange views and enables either **Tiled** or **Overlapped** layouts. +[!INCLUDE [Arrangement Lexicon](~/includes/arrangement-lexicon.md)] -* **Arrange Mode** - The Arrange Modes are set via the @Terminal.Gui.View.Arrangement property. When a user presses `Ctrl+F5` (configurable via the @Terminal.Gui.Application.ArrangeKey property) the application goes into **Arrange Mode**. In this mode, indicators are displayed on an arrangeable view indicating which aspect of the View can be arranged. If @Terminal.Gui.ViewArrangement.Movable, a `◊` will be displayed in the top-left corner of the @Terminal.Gui.View.Border. If @Terminal.Gui.ViewArrangement.Resizable, pressing `Tab` (or `Shift+Tab`) will cycle to an an indictor in the bottom-right corner of the Border. The up/down/left/right cursor keys will act appropriately. `Esc`, `Ctrl+F5` or clicking outside of the Border will exit Arrange Mode. +## Arrangement -* **Modal** - A modal view is one that is run as an "application" via @Terminal.Gui.Application.Run(System.Func{System.Exception,System.Boolean},Terminal.Gui.IConsoleDriver) where `Modal == true`. `Dialog`, `Messagebox`, and `Wizard` are the prototypical examples. When run this way, there IS a `z-order` but it is highly-constrained: the modal view has a z-order of 1 and everything else is at 0. +Describes the feature of [Layout](layout.md) which controls how the user can use the mouse and keyboard to arrange views and enables either **Tiled** or **Overlapped** layouts. The @Terminal.Gui.ViewBase.View.Arrangement property controls the arrangement behavior for each view. -* **Movable** - Describes a View that can be moved by the user using the keyboard or mouse. **Movable** is enabled on a per-View basis by setting the @Terminal.Gui.ViewArrangement.Movable flag on @Terminal.Gui.View.Arrangement. Dragging on the top @Terminal.Gui.View.Border of a View will move such a view. Pressing `Ctrl+F5` will activate **Arrange Mode** letting the user move the view with the up/down/left/right cursor keys. +## Arrange Mode -* **Overlapped** - A form of layout where SubViews of a View are visually arranged such that their Frames overlap. In Overlap view arrangements there is a Z-axis (Z-order) in addition to the X and Y dimension. The Z-order indicates which Views are shown above other views. **Overlapped** is enabled on a per-View basis by setting the @Terminal.Gui.ViewArrangement.Overlapped flag on @Terminal.Gui.View.Arrangement. +The Arrange Modes are set via the @Terminal.Gui.ViewBase.View.Arrangement property. When a user presses `Ctrl+F5` (configurable via the @Terminal.Gui.App.Application.ArrangeKey property) the application goes into **Arrange Mode**. -* **Sizable** - Describes a View that can be sized by the user using the keyboard or mouse. **Sizable** is enabled on a per-View basis by setting the @Terminal.Gui.ViewArrangement.Resizable flag on @Terminal.Gui.View.Arrangement. Dragging on the left, right, or bottom @Terminal.Gui.View.Border of a View will size that side of such a view. Pressing `Ctrl+F5` will activate **Arrange Mode** letting the user size the view with the up/down/left/right cursor keys. +In this mode, indicators are displayed on an arrangeable view indicating which aspect of the View can be arranged: +- If @Terminal.Gui.ViewBase.ViewArrangement.Movable, a `◊` will be displayed in the top-left corner of the @Terminal.Gui.ViewBase.View.Border +- If @Terminal.Gui.ViewBase.ViewArrangement.Resizable, pressing `Tab` (or `Shift+Tab`) will cycle to an indicator in the bottom-right corner of the Border -* **Tiled** - A form of layout where SubViews of a View are visually arranged such that their Frames do not typically overlap. With **Tiled** views, there is no 'z-order` to the SubViews of a View. In most use-cases, subviews do not overlap with each other (the exception being when it's done intentionally to create some visual effect). As a result, the default layout for most TUI apps is "tiled", and by default @Terminal.Gui.View.Arrangement is set to @Terminal.Gui.ViewArrangement.Fixed. +The up/down/left/right cursor keys will act appropriately. `Esc`, `Ctrl+F5` or clicking outside of the Border will exit Arrange Mode. -* **Runnable** - Today, Overlapped and Runnable are intrinsically linked. A runnable view is one where `Application.Run(Toplevel)` is called. Each *Runnable* view where (`Modal == false`) has it's own `RunState` and is, effectively, a self-contained "application". `Application.Run()` non-preemptively dispatches events (screen, keyboard, mouse , Timers, and Idle handlers) to the associated `Toplevel`. It is possible for such a `Toplevel` to create a thread and call `Application.Run(someotherToplevel)` on that thread, enabling pre-emptive user-interface multitasking (`BackgroundWorkerCollection` does this). +## Modal + +A modal view is one that is run as an "application" via @Terminal.Gui.App.Application.Run(System.Func{System.Exception,System.Boolean},Terminal.Gui.Drivers.IConsoleDriver) where `Modal == true`. + +`Dialog`, `MessageBox`, and `Wizard` are the prototypical examples. When run this way, there IS a `z-order` but it is highly-constrained: the modal view has a z-order of 1 and everything else is at 0. + +## Movable + +Describes a View that can be moved by the user using the keyboard or mouse. **Movable** is enabled on a per-View basis by setting the @Terminal.Gui.ViewBase.ViewArrangement.Movable flag on @Terminal.Gui.ViewBase.View.Arrangement. + +Dragging on the top @Terminal.Gui.ViewBase.View.Border of a View will move such a view. Pressing `Ctrl+F5` will activate **Arrange Mode** letting the user move the view with the up/down/left/right cursor keys. + +## Overlapped + +A form of layout where SubViews of a View are visually arranged such that their Frames overlap. In Overlap view arrangements there is a Z-axis (Z-order) in addition to the X and Y dimension. The Z-order indicates which Views are shown above other views. + +**Overlapped** is enabled on a per-View basis by setting the @Terminal.Gui.ViewBase.ViewArrangement.Overlapped flag on @Terminal.Gui.ViewBase.View.Arrangement. + +## Resizable + +Describes a View that can be sized by the user using the keyboard or mouse. **Resizable** is enabled on a per-View basis by setting the @Terminal.Gui.ViewBase.ViewArrangement.Resizable flag on @Terminal.Gui.ViewBase.View.Arrangement. + +Dragging on the left, right, or bottom @Terminal.Gui.ViewBase.View.Border of a View will size that side of such a view. Pressing `Ctrl+F5` will activate **Arrange Mode** letting the user size the view with the up/down/left/right cursor keys. + +## Tiled + +A form of layout where SubViews of a View are visually arranged such that their Frames do not typically overlap. With **Tiled** views, there is no 'z-order` to the SubViews of a View. + +In most use-cases, subviews do not overlap with each other (the exception being when it's done intentionally to create some visual effect). As a result, the default layout for most TUI apps is "tiled", and by default @Terminal.Gui.ViewBase.View.Arrangement is set to @Terminal.Gui.ViewBase.ViewArrangement.Fixed. + +## Runnable + +Today, Overlapped and Runnable are intrinsically linked. A runnable view is one where `Application.Run(Toplevel)` is called. Each *Runnable* view where (`Modal == false`) has it's own `RunState` and is, effectively, a self-contained "application". + +`Application.Run()` non-preemptively dispatches events (screen, keyboard, mouse, Timers, and Idle handlers) to the associated `Toplevel`. It is possible for such a `Toplevel` to create a thread and call `Application.Run(someotherToplevel)` on that thread, enabling pre-emptive user-interface multitasking (`BackgroundWorkerCollection` does this). diff --git a/docfx/docs/cancellable-work-pattern.md b/docfx/docs/cancellable-work-pattern.md index 4cd3904c3..b0a418e6b 100644 --- a/docfx/docs/cancellable-work-pattern.md +++ b/docfx/docs/cancellable-work-pattern.md @@ -21,14 +21,9 @@ The *Cancellable Work Pattern* is designed to achieve the following: 3. **Cancellation**: Enable halting of a phase or the entire workflow, giving consumers control over the process. 4. **Decoupling**: Use events to reduce reliance on inheritance, minimizing the need for subclasses to understand base class details. -## Components +## Lexicon and Taxonomy -The *Cancellable Work Pattern* consists of the following components: -- **Workflow**: A sequence of phases, which may be multi-phase (e.g., rendering in `View.Draw`), linear (e.g., key processing in `View.Keyboard`), per-unit (e.g., command execution in `View.Command`), or event-driven (e.g., key handling in `Application.Keyboard`, property changes in `OrientationHelper`). -- **Notifications**: Events (e.g., `DrawingText`, `KeyDown`, `Activating`, `OrientationChanging`) and virtual methods (e.g., `OnDrawingText`, `OnKeyDown`, `OnActivating`, `OnOrientationChanging`) raised at each phase to notify observers. -- **Cancellation**: Mechanisms to halt a phase or workflow, such as setting `Cancel`/`Handled` properties in event arguments or returning `bool` from virtual methods. -- **Context**: Data passed to observers for informed decision-making, such as `DrawContext` (drawing), `Key` (keyboard), `ICommandContext` (commands), or `CancelEventArgs` (orientation). -- **Default Behavior**: A standard implementation for each phase, such as `DrawText` (drawing), `InvokeCommands` (keyboard and application-level), `RaiseActivating` (commands), or updating a property (`OrientationHelper`). +[!INCLUDE [Events Lexicon](~/includes/events-lexicon.md)] ## Implementation in Terminal.Gui diff --git a/docfx/docs/command.md b/docfx/docs/command.md index c23ed3584..f8b10ef9a 100644 --- a/docfx/docs/command.md +++ b/docfx/docs/command.md @@ -1,5 +1,13 @@ # Deep Dive into Command and View.Command in Terminal.Gui +## See Also + +* [Lexicon & Taxonomy](lexicon.md) +* [Cancellable Work Pattern](cancellable-work-pattern.md) +* [Events](events.md) + +## Overview + The `Command` system in Terminal.Gui provides a standardized framework for defining and executing actions that views can perform, such as selecting items, accepting input, or navigating content. Implemented primarily through the `View.Command` APIs, this system integrates tightly with input handling (e.g., keyboard and mouse events) and leverages the *Cancellable Work Pattern* to ensure extensibility, cancellation, and decoupling. Central to this system are the `Selecting` and `Accepting` events, which encapsulate common user interactions: `Selecting` for changing a view’s state or preparing it for interaction (e.g., toggling a checkbox, focusing a menu item), and `Accepting` for confirming an action or state (e.g., executing a menu command, submitting a dialog). This deep dive explores the `Command` and `View.Command` APIs, focusing on the `Selecting` and `Accepting` concepts, their implementation, and their propagation behavior. It critically evaluates the need for additional events (`Selected`/`Accepted`) and the propagation of `Selecting` events, drawing on insights from `Menuv2`, `MenuItemv2`, `MenuBarv2`, `CheckBox`, and `FlagSelector`. These implementations highlight the system’s application in hierarchical (menus) and stateful (checkboxes, flag selectors) contexts. The document reflects the current implementation, including the `Cancel` property in `CommandEventArgs` and local handling of `Command.Select`. An appendix briefly summarizes proposed changes from a filed issue to rename `Command.Select` to `Command.Activate`, replace `Cancel` with `Handled`, and introduce a propagation mechanism, addressing limitations in the current system. @@ -18,7 +26,7 @@ The `Command` system in Terminal.Gui defines a set of standard actions via the ` The `Command` system bridges user input and view behavior, enabling: - **Consistency**: Standard commands ensure predictable interactions (e.g., `Enter` triggers `Accept` in buttons, menus, checkboxes). - **Extensibility**: Custom handlers and events allow behavior customization. -- **Decoupling**: Events reduce reliance on subclassing, though current propagation mechanisms may require subview-superview coordination. +- **Decoupling**: Events reduce reliance on sub-classing, though current propagation mechanisms may require subview-superview coordination. ### Note on `Cancel` Property The `CommandEventArgs` class uses a `Cancel` property to indicate that a command event (e.g., `Accepting`) should stop processing. This is misleading, as it implies action negation rather than completion. A filed issue proposes replacing `Cancel` with `Handled` to align with input events (e.g., `Key.Handled`). This document uses `Cancel` to reflect the current implementation, with the appendix summarizing the proposed change. diff --git a/docfx/docs/config.md b/docfx/docs/config.md index 8a09fd363..f77787d11 100644 --- a/docfx/docs/config.md +++ b/docfx/docs/config.md @@ -1,32 +1,10 @@ # Configuration Management -Terminal.Gui provides persistent configuration settings via the [`ConfigurationManager`](~/api/Terminal.Gui.ConfigurationManager.yml) class. +Terminal.Gui provides persistent configuration settings via the [`ConfigurationManager`](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml) class. ## Configuration Lexicon and Taxonomy -| Term | Meaning | -|:-----|:--------| -| **AppSettings** | Application-specific settings stored in the application's resources. | -| **Apply** | Apply the configuration to the application; copies settings from configuration properties to corresponding `static` `[ConfigProperty]` properties. | -| **Attribute** | Defines concrete visual styling for a visual element (Foreground color, Background color, TextStyle). | -| **BackgroundColor** | A property of `Attribute` describing the background text color. | -| **Color** | Base terminal color (supports TrueColor and named values like White, Black, Cyan, etc.). | -| **ConfigProperty** | A property decorated with `[ConfigProperty]` that can be configured via the configuration system. | -| **Configuration** | A collection of settings defining application behavior and appearance. | -| **ConfigurationManager** | System that loads and manages application runtime settings from external sources. | -| **ForegroundColor** | A property of `Attribute` describing the foreground text color. | -| **Load** | Load configuration from given location(s), updating with new values. Loading doesn't apply settings automatically. | -| **Location** | Storage location for configuration (e.g., user's home directory, application directory). | -| **Reset** | Reset configuration to current values or hard-coded defaults. Does not load configuration. | -| **Scope** | Defines the context where configuration applies (Settings, Theme, or AppSettings). | -| **Scheme** | Maps `VisualRole` to `Attribute`, defining visual element appearance (color and style) based on semantic purpose. | -| **Settings** | Runtime options including both system settings and application-specific settings. | -| **Sources** | Set of locations where configuration can be stored (@Terminal.Gui.ConfigLocations enum). | -| **Style** | Property of `Attribute` for font-like hints (bold, italic, underline). | -| **Theme** | Named instance containing specific appearance settings. | -| **ThemeInheritance** | Mechanism where themes can inherit and override settings from other themes. | -| **Themes** | Collection of named Theme definitions bundling visual and layout settings. | -| **VisualRole** | Semantic role/purpose of a visual element (Normal, Focus, HotFocus, Active, Disabled, ReadOnly). | +[!INCLUDE [Config Lexicon](~/includes/config-lexicon.md)] # Fundamentals @@ -36,20 +14,20 @@ Settings are defined in JSON format, according to this schema: https://gui-cs.gi Terminal.Gui library developers can define settings in code and set the default values in the Terminal.Gui assembly's resources (e.g. `Terminal.Gui.Resources.config.json`). -Terminal.Gui application developers can define settings in their apps' code and set the default values in their apps' resources (e.g. `Resources/config.json`) or by setting @Terminal.Gui.Application.RuntimeConfig to string containing JSON. +Terminal.Gui application developers can define settings in their apps' code and set the default values in their apps' resources (e.g. `Resources/config.json`) or by setting @Terminal.Gui.Configuration.ConfigurationManager.RuntimeConfig to string containing JSON. Users can change settings on a global or per-application basis by providing JSON formatted configuration files. The configuration files can be placed in at .tui folder in the user's home directory (e.g. `C:/Users/username/.tui`, or `/usr/username/.tui`) or the folder where the Terminal.Gui application was launched from (e.g. `./.tui`). ## CM is Disabled by Default -The `ConfigurationManager` must be enabled explicitly by calling @Terminal.Gui.ConfigurationManager.Enable() in an application's `Main` method. +The `ConfigurationManager` must be enabled explicitly by calling @Terminal.Gui.Configuration.ConfigurationManager.Enable(Terminal.Gui.Configuration.ConfigLocations) in an application's `Main` method. ```csharp // Enable configuration with all sources ConfigurationManager.Enable(ConfigLocations.All); ``` -If `ConfigurationManager.Enable()` is not called (`ConfigurationManager.IsEnabled` is 'false'), all configuration settings are ignored and ConfigurationManager will effectively be a no-op. All `[ConfigurationProperty]` properties will initially be their hard-coded default values. Calling @Terminal.Gui.ConfigurationManager.Reset will reset all configuration properties back to their hard-coded default values. +If `ConfigurationManager.Enable()` is not called (`ConfigurationManager.IsEnabled` is 'false'), all configuration settings are ignored and ConfigurationManager will effectively be a no-op. All `[ConfigurationProperty]` properties will initially be their hard-coded default values. Other than that, no other ConfigurationManager APIs will have any effect. @@ -57,7 +35,7 @@ Other than that, no other ConfigurationManager APIs will have any effect. Optionally, developers can more granularly control the loading and applying of configuration by calling the `Load` and `Apply` methods directly. -When a configuration has been loaded, the @Terminal.Gui.ConfigurationManager.Apply method must be called to apply the settings to the application. This method uses reflection to find all static fields decorated with the `[ConfigurationProperty]` attribute and applies the settings to the corresponding properties. +When a configuration has been loaded, the @Terminal.Gui.Configuration.ConfigurationManager.Apply method must be called to apply the settings to the application. This method uses reflection to find all static fields decorated with the `[ConfigurationProperty]` attribute and applies the settings to the corresponding properties. ```csharp // Load the configuration from just the users home directory. @@ -67,7 +45,7 @@ ConfigurationManager.Apply(); ``` > [!IMPORTANT] -> Configuration Settings Apply at the Process Level. +> Configuration Settings Apply at the Process Level. > Configuration settings are applied at the process level, which means that they are applied to all applications that are part of the same process. This is due to the fact that configuration properties are defined as static fields, which are static for the process. ## Configuration Types and Scopes @@ -111,29 +89,28 @@ graph TD Settings are applied using the following precedence (higher precedence settings overwrite lower precedence settings): -1. Hard-coded default values in any static property decorated with the `[ConfigurationProperty]` attribute. +1. @Terminal.Gui.Configuration.ConfigLocations.HardCoded Hard-coded default values in any static property decorated with the `[ConfigurationProperty]` attribute. -2. @Terminal.Gui.ConfigLocations.Default - Default settings in the Terminal.Gui assembly -- Lowest precedence. +2. @Terminal.Gui.Configuration.ConfigLocations.LibraryResources - Default settings in the Terminal.Gui assembly -- Lowest precedence. -3. @Terminal.Gui.ConfigLocations.Runtime - Settings stored in the @Terminal.Gui.ConfigurationManager.RuntimeConfig static property. +3. @Terminal.Gui.Configuration.ConfigLocations.Runtime - Settings stored in the @Terminal.Gui.Configuration.ConfigurationManager.RuntimeConfig static property. -4. @Terminal.Gui.ConfigLocations.AppResources - App settings in app resources (`Resources/config.json`). +4. @Terminal.Gui.Configuration.ConfigLocations.AppResources - App settings in app resources (`Resources/config.json`). -5. @Terminal.Gui.ConfigLocations.AppHome - App-specific settings in the users's home directory (`~/.tui/appname.config.json`). +5. @Terminal.Gui.Configuration.ConfigLocations.AppHome - App-specific settings in the users's home directory (`~/.tui/appname.config.json`). -6. @Terminal.Gui.ConfigLocations.AppCurrent - App-specific settings in the directory the app was launched from (`./.tui/appname.config.json`). +6. @Terminal.Gui.Configuration.ConfigLocations.AppCurrent - App-specific settings in the directory the app was launched from (`./.tui/appname.config.json`). -7. @Terminal.Gui.ConfigLocations.GlobalHome - Global settings in the the user's home directory (`~/.tui/config.json`). +7. @Terminal.Gui.Configuration.ConfigLocations.GlobalHome - Global settings in the the user's home directory (`~/.tui/config.json`). -8. @Terminal.Gui.ConfigLocations.GlobalCurrent - Global settings in the directory the app was launched from (`./.tui/config.json`) --- Hightest precedence. +8. @Terminal.Gui.Configuration.ConfigLocations.GlobalCurrent - Global settings in the directory the app was launched from (`./.tui/config.json`) --- Hightest precedence. -The [`ConfigurationManager`](~/api/Terminal.Gui.ConfigurationManager.yml) will look for configuration files in the `.tui` folder in the user's home directory (e.g. `C:/Users/username/.tui` or `/usr/username/.tui`), the folder where the Terminal.Gui application was launched from (e.g. `./.tui`), or as a resource within the Terminal.Gui application's main assembly. +The [`ConfigurationManager`](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml) will look for configuration files in the `.tui` folder in the user's home directory (e.g. `C:/Users/username/.tui` or `/usr/username/.tui`), the folder where the Terminal.Gui application was launched from (e.g. `./.tui`), or as a resource within the Terminal.Gui application's main assembly. Settings that will apply to all applications (global settings) reside in files named `config.json`. Settings that will apply to a specific Terminal.Gui application reside in files named `appname.config.json`, where *appname* is the assembly name of the application (e.g. `UICatalog.config.json`). - ## Configuration Events The ConfigurationManager provides several events to track configuration changes: @@ -179,7 +156,8 @@ The above example will define a configuration property in the `AppSettings` scop Terminal.Gui library developers can use the `SettingsScope` and `ThemeScope` attributes to define settings and themes for the terminal.Gui library. -> [!IMPORTANT] App developers cannot define `SettingScope` or `ThemeScope` properties. +> [!IMPORTANT] +App developers cannot define `SettingScope` or `ThemeScope` properties. ```csharp /// @@ -191,9 +169,9 @@ Terminal.Gui library developers can use the `SettingsScope` and `ThemeScope` att # Sample Code -The `UICatalog` application provides an example of how to use the [`ConfigurationManager`](~/api/Terminal.Gui.ConfigurationManager.yml) class to load and save configuration files. +The `UICatalog` application provides an example of how to use the [`ConfigurationManager`](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml) class to load and save configuration files. -The `Configuration Editor` Scenario provides an editor that allows users to edit the configuration files. UI Catalog also uses a file system watcher to detect changes to the configuration files to tell [`ConfigurationManager`](~/api/Terminal.Gui.ConfigurationManager.yml) to reload them; allowing users to change settings without having to restart the application. +The `Configuration Editor` Scenario provides an editor that allows users to edit the configuration files. UI Catalog also uses a file system watcher to detect changes to the configuration files to tell [`ConfigurationManager`](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml) to reload them; allowing users to change settings without having to restart the application. The `Themes` Scenario in the UI Catalog provides a viewer for the themes defined in the configuration files. @@ -201,15 +179,14 @@ The `Themes` Scenario in the UI Catalog provides a viewer for the themes defined `ConfigurationManager` provides the following features: -1) **Settings**. Settings are applied to the [`Application`](~/api/Terminal.Gui.Application.yml) class. Settings are accessed via the `Settings` property of [`ConfigurationManager`](~/api/Terminal.Gui.ConfigurationManager.yml). E.g. `Settings["Application.QuitKey"]` +1) **Settings**. Settings are applied to the [`Application`](~/api/Terminal.Gui.App.Application.yml) class. Settings are accessed via the `Settings` property of [`ConfigurationManager`](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml). E.g. `Settings["Application.QuitKey"]` 2) **Themes**. Themes are a named collection of settings impacting how applications look. The default theme is named "Default". Two other built-in themes are provided: "Dark", and "Light". Additional themes can be defined in the configuration files. `Settings ["Themes"]` is a dictionary of theme names to theme settings. -3) **AppSettings**. Applications can use the [`ConfigurationManager`](~/api/Terminal.Gui.ConfigurationManager.yml) to store and retrieve application-specific settings. +3) **AppSettings**. Applications can use the [`ConfigurationManager`](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml) to store and retrieve application-specific settings. Methods for discovering what can be configured are available in the `ConfigurationManager` class: -- Call @ConfigurationManager.GetConfigurationProperties() +- Call @Terminal.Gui.Configuration.ConfigurationManager.GetHardCodedConfig() - Search the source code for `[ConfigurationProperty]` -- View `./Terminal.Gui/Resources/config.json` For complete schema details and examples, refer to: - Schema: https://gui-cs.github.io/Terminal.GuiV2Docs/schemas/tui-config-schema.json @@ -219,11 +196,11 @@ For complete schema details and examples, refer to: A Theme is a named collection of settings that impact the visual style of Terminal.Gui applications. The default theme is named "Default". The built-in configuration within the Terminal.Gui library defines two more themes: "Dark", and "Light". Additional themes can be defined in the configuration files. The JSON property `Theme` defines the name of the theme that will be used. If the theme is not found, the default theme will be used. -Themes support defining Schemes (a set of colors and styles that define the appearance of views) as well as various default settings for Views. Both the default color schemes and user-defined color schemes can be configured. See [Schemes](~/api/Terminal.Gui.Schemes.yml) for more information. +Themes support defining Schemes (a set of colors and styles that define the appearance of views) as well as various default settings for Views. Both the default color schemes and user-defined color schemes can be configured. See [Schemes](~/api/Terminal.Gui.Drawing.Schemes.yml) for more information. ### Theme Configuration -Themes provide a way to bundle visual settings together. When @Terminal.Gui.ConfigurationManager.Apply is called, the theme settings are applied to the application. +Themes provide a way to bundle visual settings together. When @Terminal.Gui.Configuration.ConfigurationManager.Apply is called, the theme settings are applied to the application. ```json // ... @@ -264,7 +241,7 @@ ConfigurationManager.Apply(); ### Glyphs -Themes support changing the standard set of glyphs used by views (e.g. the default indicator for [Button](~/api/Terminal.Gui.Button.yml)) and line drawing (e.g. [LineCanvas](~/api/Terminal.Gui.LineCanvas.yml)). +Themes support changing the standard set of glyphs used by views (e.g. the default indicator for [Button](~/api/Terminal.Gui.Views.Button.yml)) and line drawing (e.g. [LineCanvas](~/api/Terminal.Gui.Drawing.LineCanvas.yml)). The value can be either a decimal number or a string. The string may be: @@ -400,6 +377,4 @@ https://gui-cs.github.io/Terminal.Gui/schemas/tui-config-schema.json To illustrate the syntax, the below is the `config.json` file found in `Terminal.Gui.dll`: -[!code-json[config.json](../../Terminal.Gui/Resources/config.json)] - - +[!code-json[config.json](../../Terminal.Gui/Resources/config.json)] \ No newline at end of file diff --git a/docfx/docs/dimauto.md b/docfx/docs/dimauto.md index f831c3ac6..abab0b52b 100644 --- a/docfx/docs/dimauto.md +++ b/docfx/docs/dimauto.md @@ -1,5 +1,12 @@ # Dim.Auto Deep Dive +## See Also + +* [Lexicon & Taxonomy](lexicon.md) +* [Layout](layout.md) + +## Overview + The `Dim.Auto` type is a type of `Dim` that automatically sizes the view based on its content. This is useful when you want to size a view based on the content it contains. That content can either be the `Text`, the `SubViews`, or something else defined by the view. Like all `Dim` types, `Dim.Auto` is used to set the `Width` or `Height` of a view and can be combined with other `Dim` types using addition or subtraction (see. `DimCombine`). diff --git a/docfx/docs/drawing.md b/docfx/docs/drawing.md index 65f9db7f0..598ec7a38 100644 --- a/docfx/docs/drawing.md +++ b/docfx/docs/drawing.md @@ -2,99 +2,84 @@ Terminal.Gui provides a set of APIs for formatting text, line drawing, and character-based graphing. -## Drawing Lexicon and Taxonomy +## Drawing Taxonomy & Lexicon -| Term | Meaning | -|:-----|:--------| -| **Attribute** | Defines the concrete visual styling for a visual element, including Foreground color, Background color, and TextStyle. | -| **BackgroundColor** | A property of `Attribute` that describes the color of background text. | -| **Color** | Base terminal color (part of the color palette; supports TrueColor and named values like White, Black, Cyan, etc.). | -| **Cell** | A single character and its attributes which occupies a particular row and column in the terminal. Not exposed directly to the developer, but used internally by drivers. See @Terminal.Gui.Cell | -| **ForegroundColor** | A property of `Attribute` that describes the color of foreground text. | -| **Scheme** | A Scheme is a mapping from `VisualRole`s (e.g. `VisualRole.Focus`) to `Attribute`s, defining how a `View` should look based on its purpose (e.g. Menu or Dialog). | -| **Style** | A property of `Attribute` that captures additional font-like hints such as bold, italic, underline, beyond color. | -| **Theme** | A single named instance containing specific appearance settings (e.g., "Default", "Dark"). | -| **Themes** | A collection of named Theme definitions, each of which bundles visual and layout settings. | -| **VisualRole** | The semantic role/purpose of a visual element inside a View (e.g., Normal, Focus, HotFocus, Active, Disabled, ReadOnly). | +[!INCLUDE [Drawing Lexicon](~/includes/drawing-lexicon.md)] # View Drawing API -Terminal.Gui apps draw using the @Terminal.Gui.View.Move(System.Int32,System.Int32) and @Terminal.Gui.View.AddRune(System.Text.Rune) APIs. Move selects the column and row of the cell and AddRune places the specified glyph in that cell using the @Terminal.Gui.Attribute that was most recently set via @Terminal.Gui.View.SetAttribute(Terminal.Gui.Attribute). The @Terminal.Gui.ConsoleDriver caches all changed Cells and efficiently outputs them to the terminal each iteration of the Application. In other words, Terminal.Gui uses deferred rendering. +Terminal.Gui apps draw using the @Terminal.Gui.ViewBase.View.Move(System.Int32,System.Int32) and @Terminal.Gui.ViewBase.View.AddRune(System.Text.Rune) APIs. Move selects the column and row of the cell and AddRune places the specified glyph in that cell using the @Terminal.Gui.Drawing.Attribute that was most recently set via @Terminal.Gui.ViewBase.View.SetAttribute(Terminal.Gui.Drawing.Attribute). The @Terminal.Gui.Drivers.ConsoleDriver caches all changed Cells and efficiently outputs them to the terminal each iteration of the Application. In other words, Terminal.Gui uses deferred rendering. ## Coordinate System for Drawing -The @Terminal.Gui.View draw APIs all take coordinates specified in *Viewport-Relative* coordinates. That is, `0, 0` is the top-left cell visible to the user. +The @Terminal.Gui.ViewBase.View draw APIs all take coordinates specified in *Viewport-Relative* coordinates. That is, `0, 0` is the top-left cell visible to the user. See [Layout](layout.md) for more details of the Terminal.Gui coordinate system. ## Outputting unformatted text -1) Moving the draw cursor using @Terminal.Gui.View.Move(System.Int32,System.Int32). -2) Setting the attributes using @Terminal.Gui.View.SetAttribute(Terminal.Gui.Attribute). -3) Outputting glyphs by calling @Terminal.Gui.View.AddRune(System.Text.Rune) or @Terminal.Gui.View.AddStr(System.String) . +1) Moving the draw cursor using @Terminal.Gui.ViewBase.View.Move(System.Int32,System.Int32). +2) Setting the attributes using @Terminal.Gui.ViewBase.View.SetAttribute(Terminal.Gui.Drawing.Attribute). +3) Outputting glyphs by calling @Terminal.Gui.ViewBase.View.AddRune(System.Text.Rune) or @Terminal.Gui.ViewBase.View.AddStr(System.String) . ## Outputting formatted text -1) Adding the text to a @Terminal.Gui.TextFormatter object. -2) Setting formatting options, such as @Terminal.Gui.TextFormatter.Alignment. -3) Calling @Terminal.Gui.TextFormatter.Draw(System.Drawing.Rectangle,Terminal.Gui.Attribute,Terminal.Gui.Attribute,System.Drawing.Rectangle,Terminal.Gui.IConsoleDriver). +1) Adding the text to a @Terminal.Gui.Text.TextFormatter object. +2) Setting formatting options, such as @Terminal.Gui.Text.TextFormatter.Alignment. +3) Calling @Terminal.Gui.Text.TextFormatter.Draw(System.Drawing.Rectangle,Terminal.Gui.Drawing.Attribute,Terminal.Gui.Drawing.Attribute,System.Drawing.Rectangle,Terminal.Gui.Drivers.IConsoleDriver). ## Line drawing -1) Add the lines via @Terminal.Gui.LineCanvas.AddLine(System.Drawing.Point,System.Int32,Terminal.Gui.Orientation,Terminal.Gui.LineStyle,System.Nullable{Terminal.Gui.Attribute}). -2) Either render the line canvas via @Terminal.Gui.LineCanvas.GetMap or let the @Terminal.Gui.View do so automatically (which enables automatic line joining across Views). +1) Add the lines via @Terminal.Gui.Drawing.LineCanvas +2) Either render the line canvas via @Terminal.Gui.Drawing.LineCanvas.GetMap or let the @Terminal.Gui.ViewBase.View do so automatically (which enables automatic line joining across Views). ## When Drawing Occurs -The @Terminal.Gui.Application MainLoop will iterate over all Views in the view hierarchy, starting with @Terminal.Gui.Application.Toplevels. The @Terminal.Gui.View.Draw method will be called which, in turn: +The @Terminal.Gui.App.Application MainLoop will iterate over all Views in the view hierarchy performing the following steps: -0) Determines if @Terminal.Gui.View.NeedsDraw or @Terminal.Gui.View.SubViewNeedsDraw are set. If neither is set, processing stops. +0) Determines if @Terminal.Gui.ViewBase.View.NeedsDraw or @Terminal.Gui.ViewBase.View.SubViewNeedsDraw are set. If neither is set, processing stops. 1) Sets the clip to the view's Frame. -2) Draws the @Terminal.Gui.View.Border and @Terminal.Gui.View.Padding (but NOT the Margin). +2) Draws the @Terminal.Gui.ViewBase.View.Border and @Terminal.Gui.ViewBase.View.Padding (but NOT the Margin). 3) Sets the clip to the view's Viewport. 4) Sets the Normal color scheme. -5) Calls Draw on any @Terminal.Gui.View.SubViews. -6) Draws @Terminal.Gui.View.Text. +5) Calls Draw on any @Terminal.Gui.ViewBase.View.SubViews. +6) Draws @Terminal.Gui.ViewBase.View.Text. 7) Draws any non-text content (the base View does nothing.) 8) Sets the clip back to the view's Frame. -9) Draws @Terminal.Gui.View.LineCanvas (which may have been added to by any of the steps above). -10) Draws the @Terminal.Gui.View.Border and @Terminal.Gui.View.Padding SubViews (just the subviews). (but NOT the Margin). -11) The Clip at this point excludes all SubViews NOT INCLUDING their Margins. This clip is cached so @Terminal.Gui.View.Margin can be rendered later. +9) Draws @Terminal.Gui.ViewBase.View.LineCanvas (which may have been added to by any of the steps above). +10) Draws the @Terminal.Gui.ViewBase.View.Border and @Terminal.Gui.ViewBase.View.Padding SubViews (just the subviews). (but NOT the Margin). +11) The Clip at this point excludes all SubViews NOT INCLUDING their Margins. This clip is cached so @Terminal.Gui.ViewBase.View.Margin can be rendered later. 12) DrawComplete is raised. 13) The current View's Frame NOT INCLUDING the Margin is excluded from the current Clip region. -Most of the steps above can be overridden by developers using the standard [Terminal.Gui Cancellable Work Pattern](cancellable-work-pattern.md). For example, the base @Terminal.Gui.View always clears the viewport. To override this, a subclass can override @Terminal.Gui.View.OnClearingViewport to simply return `true`. Or, a user of `View` can subscribe to the @Terminal.Gui.View.ClearingViewport event and set the `Cancel` argument to `true`. +Most of the steps above can be overridden by developers using the standard [Terminal.Gui Cancellable Work Pattern](cancellable-work-pattern.md). For example, the base @Terminal.Gui.ViewBase.View always clears the viewport. To override this, a subclass can override @Terminal.Gui.ViewBase.View.OnClearingViewport to simply return `true`. Or, a user of `View` can subscribe to the @Terminal.Gui.ViewBase.View.ClearingViewport event and set the `Cancel` argument to `true`. -Then, after the above steps have completed, the Mainloop will iterate through all views in the view hierarchy again, this time calling Draw on any @Terminal.Gui.View.Margin objects, using the cached Clip region mentioned above. This enables Margin to be transparent. +Then, after the above steps have completed, the Mainloop will iterate through all views in the view hierarchy again, this time calling Draw on any @Terminal.Gui.ViewBase.View.Margin objects, using the cached Clip region mentioned above. This enables Margin to be transparent. ### Declaring that drawing is needed -If a View need to redraw because something changed within it's Content Area it can call @Terminal.Gui.View.SetNeedsDraw. If a View needs to be redrawn because something has changed the size of the Viewport, it can call @Terminal.Gui.View.SetNeedsLayout. +If a View need to redraw because something changed within it's Content Area it can call @Terminal.Gui.ViewBase.View.SetNeedsDraw. If a View needs to be redrawn because something has changed the size of the Viewport, it can call @Terminal.Gui.ViewBase.View.SetNeedsLayout. ## Clipping -Clipping enables better performance and features like transparent margins by ensuring regions of the terminal that need to be drawn actually get drawn by the @Terminal.Gui.ConsoleDriver. Terminal.Gui supports non-rectangular clip regions with @Terminal.Gui.Region. @Terminal.Gui.ConsoleDriver.Clip is the application managed clip region and is managed by @Terminal.Gui.Application. Developers cannot change this directly, but can use @Terminal.Gui.View.ClipToScreen, @Terminal.Gui.View.SetClip(Region), @Terminal.Gui.View.ClipToFrame, and @Terminal.Gui.ClipToViewPort. +Clipping enables better performance and features like transparent margins by ensuring regions of the terminal that need to be drawn actually get drawn by the @Terminal.Gui.Drivers.ConsoleDriver. Terminal.Gui supports non-rectangular clip regions with @Terminal.Gui.Drawing.Region. @Terminal.Gui.Drivers.ConsoleDriver.Clip is the application managed clip region and is managed by @Terminal.Gui.App.Application. Developers cannot change this directly, but can use @Terminal.Gui.ViewBase.View.SetClipToScreen, @Terminal.Gui.ViewBase.View.SetClip(Terminal.Gui.Drawing.Region), @Terminal.Gui.ViewBase.View.SetClipToFrame, etc... ## Cell -The @Terminal.Gui.Cell class represents a single cell on the screen. It contains a character and an attribute. The character is of type `Rune` and the attribute is of type @Terminal.Gui.Attribute. +The @Terminal.Gui.Drawing.Cell class represents a single cell on the screen. It contains a character and an attribute. The character is of type `Rune` and the attribute is of type @Terminal.Gui.Drawing.Attribute. -`Cell` is not exposed directly to the developer. Instead, the @Terminal.Gui.ConsoleDriver.yml) classes manage the `Cell` array that represents the screen. +`Cell` is not exposed directly to the developer. Instead, the @Terminal.Gui.Drivers.ConsoleDriver classes manage the `Cell` array that represents the screen. -To draw a `Cell` to the screen, use Terminal.Gui.View.Move(System.Int32,System.Int32) to specify the row and column coordinates and then use the @Terminal.Gui.View.AddRune(System.Int32,System.Int32,System.Text.Rune) method to draw a single glyph. +To draw a `Cell` to the screen, use @Terminal.Gui.ViewBase.View.Move(System.Int32,System.Int32) to specify the row and column coordinates and then use the @Terminal.Gui.ViewBase.View.AddRune(System.Int32,System.Int32,System.Text.Rune) method to draw a single glyph. -## Unicode - -Terminal.Gui supports the full range of Unicode/wide characters. This includes emoji, CJK characters, and other wide characters. For Unicode characters that require more than one cell, `AddRune` and the `ConsoleDriver` automatically manage the cells. Extension methods to `Rune` are provided to determine if a `Rune` is a wide character and to get the width of a `Rune`. - -See the Character Map sample app in the [UI Catalog](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/overview.html#ui-catalog) for examples of Unicode characters. +// ... existing code ... ## Attribute -The @Terminal.Gui.Attribute class represents the formatting attributes of a `Cell`. It exposes properties for the foreground and background colors as well as the text style. The foreground and background colors are of type @Terminal.Gui.Color. Bold, underline, and other formatting attributes are supported via the @Terminal.Gui.Attribute.Style property. +The @Terminal.Gui.Drawing.Attribute class represents the formatting attributes of a `Cell`. It exposes properties for the foreground and background colors as well as the text style. The foreground and background colors are of type @Terminal.Gui.Drawing.Color. Bold, underline, and other formatting attributes are supported via the @Terminal.Gui.Drawing.Attribute.Style property. -Use @Terminal.Gui.View.SetAttribute to indicate which Attribute subsequent @Terminal.Gui.View.AddRune and @Terminal.Gui.View.AddStr calls will use: +Use @Terminal.Gui.ViewBase.View.SetAttribute(Terminal.Gui.Drawing.Attribute) to indicate which Attribute subsequent @Terminal.Gui.ViewBase.View.AddRune(System.Text.Rune) and @Terminal.Gui.ViewBase.View.AddStr(System.String) calls will use: ```cs // This is for illustration only. Developers typically use SetAttributeForRole instead. @@ -102,7 +87,7 @@ SetAttribute (new Attribute (Color.Red, Color.Black, Style.Underline)); AddStr ("Red on Black Underlined."); ``` -In the above example a hard-coded Attribute is set. Normally, developers will use @Terminal.Gui.View.SetAttributeForRole(VisualRole) to have the system use the Attributes associated with a `VisualRole` (see below). +In the above example a hard-coded Attribute is set. Normally, developers will use @Terminal.Gui.ViewBase.View.SetAttributeForRole(Terminal.Gui.Drawing.VisualRole) to have the system use the Attributes associated with a `VisualRole` (see below). ```cs // Modify the View's Scheme such that Focus is Red on Black Underlined @@ -115,33 +100,25 @@ SetAttributeForRole (VisualRole.Focus); AddStr ("Red on Black Underlined."); ``` -## Color - -Color is supported on all platforms, including Windows, Mac, and Linux. The default colors are 24-bit RGB colors, but the library will gracefully degrade to 16-colors if the terminal does not support 24-bit color, and black and white if the terminal does not support 16-colors. - -The `Color` class represents a color. It provides automatic mapping between the legacy 4-bit (16-color) system and 24-bit colors. It contains properties for the red, green, and blue components of the color. The `StandardColor` enum provides a set of predefined colors. - -```cs -Attribute attribute = new Attribute(StandardColor.Goldenrod, StandardColor.Wheat Style.None); -``` +// ... existing code ... ## VisualRole Represents the semantic visual role of a visual element rendered by a View (e.g., Normal text, Focused item, Active selection). -@Terminal.Gui.VisualRole provides a set of predefined VisualRoles: +@Terminal.Gui.Drawing.VisualRole provides a set of predefined VisualRoles: [!code-csharp[VisualRole.cs](../../Terminal.Gui/Drawing/VisualRole.cs)] ## Schemes -[!code-md[Scheme Overview](scheme.md#Scheme-Overview)] +[!INCLUDE [Scheme Overview](~/includes/scheme-overview.md)] See [Scheme Deep Dive](scheme.md) for more details. ## Text Formatting -Terminal.Gui supports text formatting using @Terminal.Gui.View.TextFormatter. @Terminal.Gui.TextFormatter provides methods for formatting text using the following formatting options: +Terminal.Gui supports text formatting using @Terminal.Gui.Text.TextFormatter. @Terminal.Gui.Text.TextFormatter provides methods for formatting text using the following formatting options: * Horizontal Alignment - Left, Center, Right * Vertical Alignment - Top, Middle, Bottom @@ -150,18 +127,18 @@ Terminal.Gui supports text formatting using @Terminal.Gui.View.TextFormatter. @T ## Glyphs -The @Terminal.Gui.Glyphs class defines the common set of glyphs used to draw checkboxes, lines, borders, etc... The default glyphs can be changed per-ThemeScope via @Terminal.Gui.ConfigurationManager. +The @Terminal.Gui.Drawing.Glyphs class defines the common set of glyphs used to draw checkboxes, lines, borders, etc... The default glyphs can be changed per-ThemeScope via @Terminal.Gui.Configuration.ConfigurationManager. ## Line Drawing -Terminal.Gui supports drawing lines and shapes using box-drawing glyphs. The @Terminal.Gui.LineCanvas class provides *auto join*, a smart TUI drawing system that automatically selects the correct line/box drawing glyphs for intersections making drawing complex shapes easy. See @Terminal.Gui.LineCanvas. +Terminal.Gui supports drawing lines and shapes using box-drawing glyphs. The @Terminal.Gui.Drawing.LineCanvas class provides *auto join*, a smart TUI drawing system that automatically selects the correct line/box drawing glyphs for intersections making drawing complex shapes easy. See @Terminal.Gui.Drawing.LineCanvas. ## Thickness -Describes the thickness of a frame around a rectangle. The thickness is specified for each side of the rectangle using a @Terminal.Gui.Thickness object. The Thickness class contains properties for the left, top, right, and bottom thickness. The @Terminal.Gui.Adornment class uses @Terminal.Gui.Thickness to support drawing the frame around a view. +Describes the thickness of a frame around a rectangle. The thickness is specified for each side of the rectangle using a @Terminal.Gui.Drawing.Thickness object. The Thickness class contains properties for the left, top, right, and bottom thickness. The @Terminal.Gui.ViewBase.Adornment class uses @Terminal.Gui.Drawing.Thickness to support drawing the frame around a view. See [View Deep Dive](View.md) for details. ## Diagnostics -The @Terminal.Gui.ViewDiagnostics.DisplayIndicator flag can be set on @Terminal.Gui.View.Diagnostics to cause an animated glyph to appear in the `Border` of each View. The glyph will animate each time that View's `Draw` method is called where either @Terminal.Gui.View.NeedsDraw or @Terminal.Gui.View.SubViewNeedsDraw is set. \ No newline at end of file +The @Terminal.Gui.ViewBase.ViewDiagnosticFlags.DrawIndicator flag can be set on @Terminal.Gui.ViewBase.View.Diagnostics to cause an animated glyph to appear in the `Border` of each View. The glyph will animate each time that View's `Draw` method is called where either @Terminal.Gui.ViewBase.View.NeedsDraw or @Terminal.Gui.ViewBase.View.SubViewNeedsDraw is set. \ No newline at end of file diff --git a/docfx/docs/drivers.md b/docfx/docs/drivers.md index 121723645..0a62cf40d 100644 --- a/docfx/docs/drivers.md +++ b/docfx/docs/drivers.md @@ -1,8 +1,24 @@ # Cross-Platform Driver Model -**Terminal.Gui** has support for [ncurses](https://github.com/gui-cs/Terminal.Gui/blob/master/Terminal.Gui/ConsoleDrivers/CursesDriver/CursesDriver.cs), [`System.Console`](https://github.com/gui-cs/Terminal.Gui/blob/master/Terminal.Gui/ConsoleDrivers/NetDriver.cs), and a full [Win32 Console](https://github.com/gui-cs/Terminal.Gui/blob/master/Terminal.Gui/ConsoleDrivers/WindowsDriver.cs) front-end. +[!IMPORTANT] +> In v1, the driver model was a source of pain and confusion. In v2, our goal is to make the driver model a source of pride and joy. It is still a work in progress. We will update this document as we add more information. + +## Overview + +The driver model is the mechanism by which Terminal.Gui can support multiple platforms. Windows, Mac, Linux, and even (eventually) web browsers are supported. + +## Drivers + +### Legacy + +- `WindowsDriver` - A driver that uses the Windows API to draw to the console. +- `NetDriver` - A driver that uses the .NET `System.Console` to draw to the console. +- `CursesDriver` - A driver that uses the ncurses library to draw to the console. + +### In Development for v2 + +- `v2win` - A driver optimized for Windows. +- `v2net` - A driver that uses the .NET `System.Console` to draw to the console and works on all platforms. -`ncurses` is used on Mac/Linux/Unix with color support based on what your library is compiled with; the Windows driver supports full color and mouse, and an easy-to-debug `System.Console` can be used on Windows and Unix, but lacks mouse support. -You can force the use of `System.Console` on Unix as well; see `Core.cs`. \ No newline at end of file diff --git a/docfx/docs/events.md b/docfx/docs/events.md index abd2a080f..3a1038d18 100644 --- a/docfx/docs/events.md +++ b/docfx/docs/events.md @@ -6,6 +6,7 @@ Terminal.Gui exposes and uses events in many places. This deep dive covers the p * [Cancellable Work Pattern](cancellable-work-pattern.md) * [Command Deep Dive](command.md) +* [Lexicon & Taxonomy](lexicon.md) ## Tenets for Terminal.Gui Events (Unless you know better ones...) @@ -15,14 +16,7 @@ Tenets higher in the list have precedence over tenets lower in the list. ## Lexicon and Taxonomy -* *Action* -* *Event* -* *Command* -* *Invoke* -* *Raise* -* *Listen* -* *Handle/Handling/Handled* - Applies to scenarios where an event can either be handled by an event listener (or override) vs not handled. Events that originate from a user action like mouse moves and key presses are examples. -* *Cancel/Cancelling/Cancelled* - Applies to scenarios where something can be cancelled. Changing the `Orientation` of a `Slider` is cancelable. +[!INCLUDE [Events Lexicon](~/includes/events-lexicon.md)] ## Useful External Documentation @@ -36,6 +30,10 @@ TG follows the *naming* advice provided in [.NET Naming Guidelines - Names of Ev ## Common Event Patterns +### Cancellable Work Pattern + +The [Cancellable Work Pattern](cancellable-work-pattern.md) is a pattern that allows for the cancellation of work. + ### OnEvent/Event The primary pattern for events is the `OnEvent/Event` idiom. diff --git a/docfx/docs/index.md b/docfx/docs/index.md index 2389bdda9..aa06ee233 100644 --- a/docfx/docs/index.md +++ b/docfx/docs/index.md @@ -1,208 +1,38 @@ -# Terminal.Gui v2 Overview +# Terminal.Gui Documentation - A toolkit for building rich Terminal User Interface (TUI) apps with .NET that run on Windows, the Mac, and Linux/Unix. +Welcome to the Terminal.Gui documentation! This comprehensive guide covers everything you need to know about building modern terminal user interfaces with Terminal.Gui. - (This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.html) +> [!NOTE] +> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.html -## Features +## Getting Started -* **[Cross Platform](drivers.md)** - Windows, Mac, and Linux. Terminal drivers for Curses, Windows, and the .NET Console mean apps will work well on both color and monochrome terminals. Apps also work over SSH. -* **[Templates](getting-started.md)** - The `dotnet new` command can be used to create a new Terminal.Gui app. -* **[Extensible UI](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.View.html)** - All visible UI elements are subclasses of the `View` class, and these in turn can contain an arbitrary number of sub-views. Dozens of [Built-in Views](views.md) are provided. -* **[Keyboard](keyboard.md) and [Mouse](mouse.md) Input** - The library handles all the details of input processing and provides a simple event-based API for applications to consume. -* **[Powerful Layout Engine](layout.md)** - The layout engine makes it easy to lay out controls relative to each other and enables dynamic terminal UIs. -* **[Machine, User, and App-Level Configuration](config.md)** - Persistent configuration settings, including overriding default look & feel with Themes, keyboard bindings, and more via the [ConfigurationManager](~/api/Terminal.Gui.ConfigurationManager.yml) class. -* **[Clipboard support](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.Clipboard.html)** - Cut, Copy, and Paste is provided through the [`Clipboard`] class. -* **Multi-tasking** - The [Mainloop](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.MainLoop.html) supports processing events, idle handlers, and timers. Most classes are safe for threading. -* **[Reactive Extensions](https://github.com/dotnet/reactive)** - Use reactive extensions and benefit from increased code readability, and the ability to apply the MVVM pattern and [ReactiveUI](https://www.reactiveui.net/) data bindings. See the [source code](https://github.com/gui-cs/Terminal.GuiV2Docs/tree/master/ReactiveExample) of a sample app. +- [Getting Started](~/docs/getting-started.md) - Quick start guide to create your first Terminal.Gui application +- [Migrating from v1 to v2](~/docs/migratingfromv1.md) - Complete guide for upgrading existing applications +- [What's New in v2](~/docs/newinv2.md) - Overview of new features and improvements -See [What's New in V2 For more](newinv2.md). +## Deep Dives -## Conceptual Documentation +- [ANSI Response Parser](~/docs/ansiparser.md) - Terminal sequence parsing and state management +- [Cancellable Work Pattern](~/docs/cancellable-work-pattern.md) - Core design pattern for extensible workflows +- [Character Map Scenario](~/docs/CharacterMap.md) - Complex drawing, scrolling, and Unicode rendering example +- [Command System](~/docs/command.md) - Command execution, key bindings, and the Selecting/Accepting concepts +- [Configuration Management](~/docs/config.md) - Persistent settings, themes, and configuration scopes +- [Cross-Platform Driver Model](~/docs/drivers.md) - Platform abstraction and console driver architecture +- [Cursor System](~/docs/cursor.md) - Modern cursor management and positioning (proposed design) +- [Dim.Auto](~/docs/dimauto.md) - Automatic view sizing based on content +- [Events](~/docs/events.md) - Event patterns and handling throughout the framework +- [Keyboard Input](~/docs/keyboard.md) - Key handling, bindings, commands, and shortcuts +- [Layout System](~/docs/layout.md) - View positioning, sizing, and arrangement +- [Lexicon & Taxonomy](~/docs/lexicon.md) - Terminology and concepts used throughout Terminal.Gui +- [Logging & Metrics](~/docs/logging.md) - Comprehensive logging and performance monitoring +- [Main Loop & Event Processing](~/docs/mainloop.md) - Application lifecycle and event dispatching +- [Mouse Input](~/docs/mouse.md) - Mouse event handling and interaction patterns +- [Navigation](~/docs/navigation.md) - Focus management, keyboard navigation, and accessibility +- [Popovers](~/docs/Popovers.md) - Drawing outside viewport boundaries for menus and popups +- [Scrolling](~/docs/scrolling.md) - Built-in scrolling, virtual content areas, and scroll bars -* [Arrangement API](arrangement.md) -* [Cancellable Work Pattern](cancellable-work-pattern.md) -* [Configuration and Theme Manager](config.md) -* [Command Deep Dive](command.md) -* [Cursor Deep Dive](cursor.md) -* [Cross-platform Driver Model](drivers.md) -* [Dim.Auto Deep Dive](dimauto.md) -* [Drawing](drawing.md) -* [Events Deep Dive](events.md) -* [Keyboard API](keyboard.md) -* [Layout Engine](layout.md) -* [Migrating from Terminal.Gui v1](migratingfromv1.md) -* [Mouse API](mouse.md) -* [Multi-tasking and the Application Main Loop](mainloop.md) -* [Navigation](navigation.md) -* [Popovers](Popovers.md) -* [View Deep Dive](View.md) -* [Views](views.md) -* [Scrolling Deep Dive](scrolling.md) -* [TableView Deep Dive](tableview.md) -* [TreeView Deep Dive](treeview.md) +## API Reference -The simplest application looks like this: +For detailed API documentation, see the [API Reference](~/api). -```csharp -using Terminal.Gui; -ConfigurationManager.Enable(ConfigLocations.All); -Application.Init (); -var n = MessageBox.Query (50, 5, "Question", "Do you like TUI apps?", "Yes", "No"); -Application.Shutdown (); -return n; -``` - -This example shows a prompt and returns an integer value depending on which value was selected by the user. - -More interesting user interfaces can be created by composing some of the various `View` classes that are included. - -In the example above, @Terminal.Gui.Application.Init(Terminal.Gui.IConsoleDriver,System.String) sets up the environment, initializes the color schemes, and clears the screen to start the application. - -The [Application](~/api/Terminal.Gui.Application.yml) class additionally creates an instance of the [Toplevel](~/api/Terminal.Gui.Toplevel.yml) View available in the `Application.Top` property, and can be used like this: - -```csharp -using Terminal.Gui; -ConfigurationManager.Enable(ConfigLocations.All); -Application.Init (); - -var label = new Label () { - Title = "Hello World", - X = Pos.Center (), - Y = Pos.Center (), - Height = 1, -}; - -var app = new Toplevel (); -app.Add (label); -Application.Run (app); -app.Dispose (); -Application.Shutdown (); -``` - -This example includes a menu bar at the top of the screen and a button that shows a message box when clicked: - -```csharp -using Terminal.Gui; - -ConfigurationManager.Enable(ConfigLocations.All); -Application.Init (); -var menu = new MenuBar (new MenuBarItem [] { - new MenuBarItem ("_File", new MenuItem [] { - new MenuItem ("_Quit", "", () => { - Application.RequestStop (); - }) - }), -}); - -var button = new Button () { - Title = "_Hello", - X = 0, - Y = Pos.Bottom (menu), - Width = Dim.Fill (), - Height = Dim.Fill () - 1 -}; -button.Accepting += () => { - MessageBox.Query (50, 5, "Hi", "Hello World! This is a message box", "Ok"); -}; - -var app = new Toplevel (); -// Add both menu and win in a single call -top.Add (menu, button); -Application.Run (top); -top.Dispose (); -Application.Shutdown (); -``` - -## Views - -All visible elements in a Terminal.Gui application are implemented as -[Views](~/api/Terminal.Gui.View.yml). Views are self-contained objects that take care of displaying themselves, can receive keyboard and mouse input and participate in the focus mechanism. - -See the full list of [Views provided by the Terminal.Gui library here](views.md). - -Every view can contain an arbitrary number of child views, called `SubViews`. Call @Terminal.Gui.View.Add(View) to add a couple of buttons to a UI: - -```csharp -void SetupMyView (View myView) -{ - var label = new Label () { - Title = "_Username:" - X = 1, - Y = 1, - Width = 20, - Height = 1 - }; - myView.Add (label); - - var username = new TextField () { - X = Pos.Right (label) + 1, - Y = 2, - Width = 30, - Height = 1 - }; - myView.Add (username); -} -``` - -The container of a given view is called the `SuperView` and it is a property of every View. - -## Modal Views - -Views can either be Modal or Non-modal. Modal views take over all user input until the user closes the View. Examples of Modal Views are Toplevel, Dialog, and Wizard. Non-modal views can be used to create a new experience in your application, one where you would have a new top-level menu for example. Setting the `Modal` property on a View to `true` makes it modal. - -To run any View (but especially Dialogs, Windows, or Toplevels) modally, invoke the `Application.Run` method on a Toplevel. Use the `Application.RequestStop()` method to terminate the modal execution. - -```csharp - -``` - -There is no return value from running modally, so the modal view must have a mechanism to indicate the reason the modal was closed. In the case above, the `okpressed` value is set to true if the user pressed or selected the `Ok` button. - -## Windows - -[Window](~/api/Terminal.Gui.Window.yml) is a view used in `Overlapped` layouts, providing a frame and a title - and can be moved and sized with the keyboard or mouse. - -## Dialogs - -[Dialogs](~/api/Terminal.Gui.Dialog.yml) are Modal [Windows](~/api/Terminal.Gui.Window.yml) that are centered in the middle of the screen and are intended to be used modally - that is, they run, and they are expected to return a result before resuming execution of the application. - -Dialogs expose an API for adding buttons and managing the layout such that buttons are at the bottom of the dialog (e.g. [`AddButton`](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui.Dialog.yml#Terminal_Gui_Dialog_AddButton_Terminal_Gui_Button_)). - -Example: -```csharp -bool okpressed = false; -var ok = new Button() { Title = "Ok" }; -var cancel = new Button() { Title = "Cancel" }; -var dialog = new Dialog () { Text = "Are you sure you want to quit?", Title = "Quit", Buttons = { ok, cancel } }; -``` - -Which will show something like this: - -``` -+- Quit -----------------------------------------------+ -| Are you sure you want to quit? | -| | -| [ Ok ] [ Cancel ] | -+------------------------------------------------------+ -``` - -## Wizards - -[Wizards](~/api/Terminal.Gui.Wizard.yml) are Dialogs that let users step through a series of steps to complete a task. - -``` -╔╡Gandolf - The last step╞════════════════════════════════════╗ -║ The wizard is complete! ║ -║☐ Enable Final Final Step ║ -║ Press the Finish ║ -║ button to continue. ║ -║ ║ -║ Pressing ESC will ║ -║ cancel the wizard. ║ -║ ║ -║ ║ -║─────────────────────────────────────────────────────────────║ -║⟦ Back ⟧ ⟦► Finish ◄⟧║ -╚═════════════════════════════════════════════════════════════╝ -``` diff --git a/docfx/docs/keyboard.md b/docfx/docs/keyboard.md index 267af3514..ea1790596 100644 --- a/docfx/docs/keyboard.md +++ b/docfx/docs/keyboard.md @@ -4,12 +4,14 @@ * [Cancellable Work Pattern](cancellable-work-pattern.md) * [Command Deep Dive](command.md) +* [Mouse Deep Dive](mouse.md) +* [Lexicon & Taxonomy](lexicon.md) ## Tenets for Terminal.Gui Keyboard Handling (Unless you know better ones...) Tenets higher in the list have precedence over tenets lower in the list. -* **Users Have Control** - *Terminal.Gui* provides default key bindings consistent with these tenets, but those defaults are configurable by the user. For example, @Terminal.Gui.ConfigurationManager allows users to redefine key bindings for the system, a user, or an application. +* **Users Have Control** - *Terminal.Gui* provides default key bindings consistent with these tenets, but those defaults are configurable by the user. For example, @Terminal.Gui.Configuration.ConfigurationManager allows users to redefine key bindings for the system, a user, or an application. * **More Editor than Command Line** - Once a *Terminal.Gui* app starts, the user is no longer using the command line. Users expect keyboard idioms in TUI apps to be consistent with GUI apps (such as VS Code, Vim, and Emacs). For example, in almost all GUI apps, `Ctrl+V` is `Paste`. But the Linux shells often use `Shift+Insert`. *Terminal.Gui* binds `Ctrl+V` by default. @@ -17,21 +19,21 @@ Tenets higher in the list have precedence over tenets lower in the list. * **The Source of Truth is Wikipedia** - We use this [Wikipedia article](https://en.wikipedia.org/wiki/Table_of_keyboard_shortcuts) as our guide for default key bindings. -* **If It's Hot, It Works** - If a View with a @Terminal.Gui.View.HotKey is visible, and the HotKey is visible, the user should be able to press that HotKey and whatever behavior is defined for it should work. For example, in v1, when a Modal view was active, the HotKeys on MenuBar continued to show "hot". In v2 we strive to ensure this doesn't happen. +* **If It's Hot, It Works** - If a View with a @Terminal.Gui.ViewBase.View.HotKey is visible, and the HotKey is visible, the user should be able to press that HotKey and whatever behavior is defined for it should work. For example, in v1, when a Modal view was active, the HotKeys on MenuBar continued to show "hot". In v2 we strive to ensure this doesn't happen. ## Keyboard APIs *Terminal.Gui* provides the following APIs for handling keyboard input: -* **Key** - @Terminal.Gui.Key provides a platform-independent abstraction for common keyboard operations. It is used for processing keyboard input and raising keyboard events. This class provides a high-level abstraction with helper methods and properties for common keyboard operations. Use this class instead of the low-level `KeyCode` enum when possible. -* **Key Bindings** - Key Bindings provide a declarative method for handling keyboard input in View implementations. The View calls Terminal.Gui.View.AddCommand(Terminal.Gui.Command,System.Func{System.Nullable{System.Boolean}}) to declare it supports a particular command and then uses @Terminal.Gui.KeyBindings to indicate which key presses will invoke the command. -* **Key Events** - The Key Bindings API is rich enough to support the vast majority of use-cases. However, in some cases subscribing directly to key events is needed (e.g. when capturing arbitrary typing by a user). Use @Terminal.Gui.View.KeyDown and related events in these cases. +* **Key** - @Terminal.Gui.Input.Key provides a platform-independent abstraction for common keyboard operations. It is used for processing keyboard input and raising keyboard events. This class provides a high-level abstraction with helper methods and properties for common keyboard operations. Use this class instead of the low-level `KeyCode` enum when possible. +* **Key Bindings** - Key Bindings provide a declarative method for handling keyboard input in View implementations. The View calls @Terminal.Gui.ViewBase.View.AddCommand(Terminal.Gui.Input.Command,System.Func{System.Nullable{System.Boolean}}) to declare it supports a particular command and then uses @Terminal.Gui.Input.KeyBindings to indicate which key presses will invoke the command. +* **Key Events** - The Key Bindings API is rich enough to support the vast majority of use-cases. However, in some cases subscribing directly to key events is needed (e.g. when capturing arbitrary typing by a user). Use @Terminal.Gui.ViewBase.View.KeyDown and related events in these cases. Each of these APIs are described more fully below. -### **[Key Bindings](~/api/Terminal.Gui.KeyBindings.yml)** +### **[Key Bindings](~/api/Terminal.Gui.Input.KeyBindings.yml)** -Key Bindings is the preferred way of handling keyboard input in View implementations. The View calls @Terminal.Gui.View.AddCommand(Terminal.Gui.Command,System.Func{System.Nullable{System.Boolean}}) to declare it supports a particular command and then uses @Terminal.Gui.KeyBindings to indicate which key presses will invoke the command. For example, if a View wants to respond to the user pressing the up arrow key to scroll up it would do this +Key Bindings is the preferred way of handling keyboard input in View implementations. The View calls @Terminal.Gui.ViewBase.View.AddCommand(Terminal.Gui.Input.Command,System.Func{System.Nullable{System.Boolean}}) to declare it supports a particular command and then uses @Terminal.Gui.Input.KeyBindings to indicate which key presses will invoke the command. For example, if a View wants to respond to the user pressing the up arrow key to scroll up it would do this ```cs public MyView : View @@ -43,9 +45,9 @@ public MyView : View The `Character Map` Scenario includes a View called `CharMap` that is a good example of the Key Bindings API. -The [Command](~/api/Terminal.Gui.Command.yml) enum lists generic operations that are implemented by views. For example `Command.Accept` in a `Button` results in the `Accepting` event +The [Command](~/api/Terminal.Gui.Input.Command.yml) enum lists generic operations that are implemented by views. For example `Command.Accept` in a `Button` results in the `Accepting` event firing while in `TableView` it is bound to `CellActivated`. Not all commands -are implemented by all views (e.g. you cannot scroll in a `Button`). Use the @Terminal.Gui.View.GetSupportedCommands method to determine which commands are implemented by a `View`. +are implemented by all views (e.g. you cannot scroll in a `Button`). Use the @Terminal.Gui.ViewBase.View.GetSupportedCommands method to determine which commands are implemented by a `View`. The default key for activating a button is `Space`. You can change this using `KeyBindings.ReplaceKey()`: @@ -59,15 +61,15 @@ Key Bindings can be added at the `Application` or `View` level. For **Application-scoped Key Bindings** there are two categories of Application-scoped Key Bindings: -1) **Application Command Key Bindings** - Bindings for `Command`s supported by @Terminal.Gui.Application. For example, @Terminal.Gui.Application.QuitKey, which is bound to `Command.Quit` and results in @Terminal.Gui.Application.RequestStop(Terminal.Gui.Toplevel) being called. +1) **Application Command Key Bindings** - Bindings for `Command`s supported by @Terminal.Gui.App.Application. For example, @Terminal.Gui.App.Application.QuitKey, which is bound to `Command.Quit` and results in @Terminal.Gui.App.Application.RequestStop(Terminal.Gui.Views.Toplevel) being called. 2) **Application Key Bindings** - Bindings for `Command`s supported on arbitrary `Views` that are meant to be invoked regardless of which part of the application is visible/active. -Use @Terminal.Gui.Application.KeyBindings to add or modify Application-scoped Key Bindings. +Use @Terminal.Gui.App.Application.KeyBindings to add or modify Application-scoped Key Bindings. **View-scoped Key Bindings** also have two categories: -1) **HotKey Bindings** - These bind to `Command`s that will be invoked regardless of whether the View has focus or not. The most common use-case for `HotKey` bindings is @Terminal.Gui.View.HotKey. For example, a `Button` with a `Title` of `_OK`, the user can press `Alt-O` and the button will be accepted regardless of whether it has focus or not. Add and modify HotKey bindings with @Terminal.Gui.View.HotKeyBindings. -2) **Focused Bindings** - These bind to `Command`s that will be invoked only when the View has focus. Focused Key Bindings are the easiest way to enable a View to support responding to key events. Add and modify Focused bindings with @Terminal.Gui.View.KeyBindings. +1) **HotKey Bindings** - These bind to `Command`s that will be invoked regardless of whether the View has focus or not. The most common use-case for `HotKey` bindings is @Terminal.Gui.ViewBase.View.HotKey. For example, a `Button` with a `Title` of `_OK`, the user can press `Alt-O` and the button will be accepted regardless of whether it has focus or not. Add and modify HotKey bindings with @Terminal.Gui.ViewBase.View.HotKeyBindings. +2) **Focused Bindings** - These bind to `Command`s that will be invoked only when the View has focus. Focused Key Bindings are the easiest way to enable a View to support responding to key events. Add and modify Focused bindings with @Terminal.Gui.ViewBase.View.KeyBindings. **Application-Scoped** Key Bindings @@ -75,43 +77,43 @@ Use @Terminal.Gui.Application.KeyBindings to add or modify Application-scoped Ke A **HotKey** is a key press that selects a visible UI item. For selecting items across `View`s (e.g. a `Button` in a `Dialog`) the key press must have the `Alt` modifier. For selecting items within a `View` that are not `View`s themselves, the key press can be key without the `Alt` modifier. For example, in a `Dialog`, a `Button` with the text of "_Text" can be selected with `Alt+T`. Or, in a `Menu` with "_File _Edit", `Alt+F` will select (show) the "_File" menu. If the "_File" menu has a sub-menu of "_New" `Alt+N` or `N` will ONLY select the "_New" sub-menu if the "_File" menu is already opened. -By default, the `Text` of a `View` is used to determine the `HotKey` by looking for the first occurrence of the @Terminal.Gui.View.HotKeySpecifier (which is underscore (`_`) by default). The character following the underscore is the `HotKey`. If the `HotKeySpecifier` is not found in `Text`, the first character of `Text` is used as the `HotKey`. The `Text` of a `View` can be changed at runtime, and the `HotKey` will be updated accordingly. @"Terminal.Gui.View.HotKey" is `virtual` enabling this behavior to be customized. +By default, the `Text` of a `View` is used to determine the `HotKey` by looking for the first occurrence of the @Terminal.Gui.ViewBase.View.HotKeySpecifier (which is underscore (`_`) by default). The character following the underscore is the `HotKey`. If the `HotKeySpecifier` is not found in `Text`, the first character of `Text` is used as the `HotKey`. The `Text` of a `View` can be changed at runtime, and the `HotKey` will be updated accordingly. @"Terminal.Gui.ViewBase.View.HotKey" is `virtual` enabling this behavior to be customized. ### **Shortcut** -A **Shortcut** is an opinionated (visually & API) View for displaying a command, help text, key key press that invokes a [Command](~/api/Terminal.Gui.Command.yml). +A **Shortcut** is an opinionated (visually & API) View for displaying a command, help text, key key press that invokes a [Command](~/api/Terminal.Gui.Input.Command.yml). The Command can be invoked even if the `View` that defines them is not focused or visible (but the `View` must be enabled). Shortcuts can be any key press; `Key.A`, `Key.A.WithCtrl`, `Key.A.WithCtrl.WithAlt`, `Key.Del`, and `Key.F1`, are all valid. `Shortcuts` are used to define application-wide actions or actions that are not visible (e.g. `Copy`). -[MenuBar](~/api/Terminal.Gui.MenuBar.yml), [ContextMenu](~/api/Terminal.Gui.ContextMenu.yml), and [StatusBar](~/api/Terminal.Gui.StatusBar.yml) support `Shortcut`s. +[MenuBar](~/api/Terminal.Gui.Views.MenuBar.yml), [PopoverMenu](~/api/Terminal.Gui.Views.PopoverMenu.yml), and [StatusBar](~/api/Terminal.Gui.Views.StatusBar.yml) support `Shortcut`s. ### **Key Events** -Keyboard events are retrieved from [Console Drivers](drivers.md) each iteration of the [Application](~/api/Terminal.Gui.Application.yml) [Main Loop](mainloop.md). The console driver raises the @Terminal.Gui.ConsoleDriver.KeyDown and @Terminal.Gui.ConsoleDriver.KeyUp events which invoke @Terminal.Gui.Application.RaiseKeyDownEvent(Terminal.Gui.Key) and @Terminal.Gui.Application.RaiseKeyUpEvent(Terminal.Gui.Key) respectively. +Keyboard events are retrieved from [Console Drivers](drivers.md) each iteration of the [Application](~/api/Terminal.Gui.App.Application.yml) [Main Loop](mainloop.md). The console driver raises the @Terminal.Gui.Drivers.ConsoleDriver.KeyDown and @Terminal.Gui.Drivers.ConsoleDriver.KeyUp events which invoke @Terminal.Gui.App.Application.RaiseKeyDownEvent* and @Terminal.Gui.App.Application.RaiseKeyUpEvent(Terminal.Gui.Input.Key) respectively. > [!NOTE] > Not all drivers/platforms support sensing distinct KeyUp events. These drivers will simulate KeyUp events by raising KeyUp after KeyDown. -@Terminal.Gui.Application.RaiseKeyDownEvent(Terminal.Gui.Key) raises @Terminal.Gui.Application.KeyDown and then calls @Terminal.Gui.View.NewKeyDownEvent(Terminal.Gui.Key) on all toplevel Views. If no View handles the key event, any Application-scoped key bindings will be invoked. +@Terminal.Gui.App.Application.RaiseKeyDownEvent* raises @Terminal.Gui.App.Application.KeyDown and then calls @Terminal.Gui.ViewBase.View.NewKeyDownEvent* on all toplevel Views. If no View handles the key event, any Application-scoped key bindings will be invoked. -If a view is enabled, the @Terminal.Gui.View.NewKeyDownEvent(Terminal.Gui.Key) method will do the following: +If a view is enabled, the @Terminal.Gui.ViewBase.View.NewKeyDownEvent* method will do the following: 1) If the view has a subview that has focus, 'NewKeyDown' on the focused view will be called. This is recursive. If the most-focused view handles the key press, processing stops. -2) If there is no most-focused sub-view, or a most-focused sub-view does not handle the key press, @Terminal.Gui.View.OnKeyDown(Terminal.Gui.Key) will be called. If the view handles the key press, processing stops. -3) If @Terminal.Gui.View.OnKeyDown(Terminal.Gui.Key) does not handle the event. @Terminal.Gui.View.KeyDown will be raised. -4) If the view does not handle the key down event, any bindings for the key will be invoked (see the @Terminal.Gui.View.KeyBindings property). If the key is bound and any of it's command handlers return true, processing stops. -5) If the key is not bound, or the bound command handlers do not return true, @Terminal.Gui.View.OnKeyDownNotHandled(Terminal.Gui.Key) is called. +2) If there is no most-focused sub-view, or a most-focused sub-view does not handle the key press, @Terminal.Gui.ViewBase.View.OnKeyDown* will be called. If the view handles the key press, processing stops. +3) If @Terminal.Gui.ViewBase.View.OnKeyDown* does not handle the event. @Terminal.Gui.ViewBase.View.KeyDown will be raised. +4) If the view does not handle the key down event, any bindings for the key will be invoked (see the @Terminal.Gui.ViewBase.View.KeyBindings property). If the key is bound and any of it's command handlers return true, processing stops. +5) If the key is not bound, or the bound command handlers do not return true, @Terminal.Gui.ViewBase.View.OnKeyDownNotHandled* is called. ## **Application Key Handling** -To define application key handling logic for an entire application in cases where the methods listed above are not suitable, use the @Terminal.Gui.Application.KeyDown event. +To define application key handling logic for an entire application in cases where the methods listed above are not suitable, use the @Terminal.Gui.App.Application.KeyDown event. ## **Key Down/Up Events** -*Terminal.Gui* supports key up/down events with @Terminal.Gui.View.OnKeyDown(Terminal.Gui.Key) and @Terminal.Gui.View.OnKeyUp(Terminal.Gui.Key), but not all [Console Drivers](drivers.md) do. To receive these key down and key up events, you must use a driver that supports them (e.g. `WindowsDriver`). +*Terminal.Gui* supports key up/down events with @Terminal.Gui.ViewBase.View.OnKeyDown* and @Terminal.Gui.ViewBase.View.OnKeyUp*, but not all [Console Drivers](drivers.md) do. To receive these key down and key up events, you must use a driver that supports them (e.g. `WindowsDriver`). # General input model @@ -141,13 +143,11 @@ To define application key handling logic for an entire application in cases wher ## Application * Implements support for `KeyBindingScope.Application`. -* Exposes @Terminal.Gui.Application.KeyBindings. +* Exposes @Terminal.Gui.App.Application.KeyBindings. * Exposes cancelable `KeyDown/Up` events (via `Handled = true`). The `OnKey/Down/Up/` methods are public and can be used to simulate keyboard input. ## View * Implements support for `KeyBindings` and `HotKeyBindings`. * Exposes cancelable non-virtual methods for a new key event: `NewKeyDownEvent` and `NewKeyUpEvent`. These methods are called by `Application` can be called to simulate keyboard input. -* Exposes cancelable virtual methods for a new key event: `OnKeyDown` and `OnKeyUp`. These methods are called by `NewKeyDownEvent` and `NewKeyUpEvent` and can be overridden to handle keyboard input. - - \ No newline at end of file +* Exposes cancelable virtual methods for a new key event: `OnKeyDown` and `OnKeyUp`. These methods are called by `NewKeyDownEvent` and `NewKeyUpEvent` and can be overridden to handle keyboard input. \ No newline at end of file diff --git a/docfx/docs/layout.md b/docfx/docs/layout.md index a5d77a03b..4f6cbb7b4 100644 --- a/docfx/docs/layout.md +++ b/docfx/docs/layout.md @@ -6,93 +6,39 @@ See [View Deep Dive](View.md), [Arrangement Deep Dive](arrangement.md), [Scrolli ## Lexicon & Taxonomy -### Coordinates - -* **Screen-Relative** - Describes the dimensions and characteristics of the underlying terminal. Currently Terminal.Gui only supports applications that run "full-screen", meaning they fill the entire terminal when running. As the user resizes their terminal, the @Terminal.Gui.Application.Screen changes size and the application will be resized to fit. *Screen-Relative* means an origin (`0, 0`) at the top-left corner of the terminal. @Terminal.Gui.ConsoleDriver s operate exclusively on *Screen-Relative* coordinates. - -* **Application-Relative** - The dimensions and characteristics of the application. Because only full-screen apps are currently supported, @Terminal.Gui.Application is effectively the same as `Screen` from a layout perspective. *Application-Relative* currently means an origin (`0, 0`) at the top-left corner of the terminal. @Terminal.Gui.Application.Top is a `View` with a top-left corner fixed at the *Application.Relative* coordinate of (`0, 0`) and is the size of `Screen`. - -* **Frame-Relative** - The @Terminal.Gui.View.Frame property of a `View` is a rectangle that describes the current location and size of the view relative to the `Superview`'s content area. *Frame-Relative* means a coordinate is relative to the top-left corner of the View in question. @Terminal.Gui.View.FrameToScreen and @Terminal.Gui.View.ScreenToFrame are helper methods for translating a *Frame-Relative* coordinate to a *Screen-Relative* coordinate and vice-versa. - -* **Content-Relative** - A rectangle, with an origin of (`0, 0`) and size (defined by @Terminal.Gui.View.GetContentSize) where the View's content exists. *Content-Relative* means a coordinate is relative to the top-left corner of the content, which is always (`0,0`). @Terminal.Gui.View.ContentToScreen and @Terminal.Gui.View.ScreenToContent are helper methods for translating a *Content-Relative* coordinate to a *Screen-Relative* coordinate and vice-versa. - -* **Viewport-Relative** - A *Content-Relative* rectangle representing the subset of the View's content that is visible to the user: @Terminal.Gui.View.Viewport. - - If @Terminal.Gui.View.GetContentSize is larger than the @Terminal.Gui.View.Viewport, scrolling is enabled. - - *Viewport-Relative* means a coordinate that is bound by (`0,0`) and the size of the inner-rectangle of the View's `Padding`. The View drawing primitives (e.g. `View.Move`) take *Viewport-Relative* coordinates; `Move (0, 0)` means the `Cell` in the top-left corner of the inner rectangle of `Padding`. `View.ViewportToScreen ()` and `View.ScreenToViewport ()` are helper methods for translating a *Viewport-Relative* coordinate to a *Screen-Relative* coordinate and vice-versa. To convert a *Viewport-Relative* coordinate to a *Content-Relative* coordinate, simply subtract `Viewport.X` and/or `Viewport.Y` from the *Content-Relative* coordinate. To convert a *Viewport-Relative* coordinate to a *Frame-Relative* coordinate, subtract the point returned by @Terminal.Gui.View.GetViewportOffsetFromFrame. - -### View Composition - -* *@Terminal.Gui.Thickness* - A `record struct` describing a rectangle where each of the four sides can have a width. Valid width values are >= 0. The inner area of a Thickness is the sum of the widths of the four sides minus the size of the rectangle. - -* *@Terminal.Gui.View.Frame* - The `Rectangle` that defines the location and size of the @Terminal.Gui.View including all of the margin, border, padding, and content area. The coordinates are relative to the SuperView of the View (or, in the case of `Application.Top`, `ConsoleDriver.Row == 0; ConsoleDriver.Col == 0`). The Frame's location and size are controlled by the `.X`, `.Y`, `.Height`, and `.Width` properties of the View. - -* *Adornments* - The `Thickness`es that separate the `Frame` from the `ContentArea`. There are three Adornments, `Margin`, `Padding`, and `Border`. Adornments are not part of the View's content and are not clipped by the View's `ClipArea`. Examples of Adornments: - -* *@Terminal.Gui.View.Margin* - The `Adornment` that separates a View from other SubViews of the same SuperView. The Margin is not part of the View's content and is not clipped by the View's `ClipArea`. By default `Margin` is `{0,0,0,0}`. - - Enabling @Terminal.Gui.View.ShadowStyle will change the `Thickness` of the `Margin` to include the shadow. - - `Margin` can be used instead of (or with) `Dim.Pos` to position a View relative to another View. - - Eg. - ```cs - view.X = Pos.Right (otherView) + 1; - view.Y = Pos.Bottom (otherView) + 1; - ``` - is equivalent to - ```cs - otherView.Margin.Thickness = new Thickness (0, 0, 1, 1); - view.X = Pos.Right (otherView); - view.Y = Pos.Bottom (otherView); - ``` - -* *@Terminal.Gui.View.Border* - The `Adornment` where a visual border (drawn using line-drawing glyphs) and the @Terminal.Gui.View.Title are drawn, and where the user can interact with the mouse/keyboard to adjust the Views' [Arrangement](arrangement.md). - - The Border expands inward; in other words if `Border.Thickness.Top == 2` the border & title will take up the first row and the second row will be filled with spaces. The Border is not part of the View's content and is not clipped by the View's `Clip`. - -* *@Terminal.Gui.View.Padding* - The `Adornment` that offsets the `ContentArea` from the `Border`. `Padding` is `{0, 0, 0, 0}` by default. Padding is not part of the View's content and is not clipped by the View's `Clip`. - - When, enabled, scroll bars reside within `Padding`. +[!INCLUDE [Layout Lexicon](~/includes/layout-lexicon.md)] ## Arrangement Modes See [Arrangement Deep Dive](arrangement.md) for more. -* *Tile*, *Tiled*, *Tiling* - Refer to a form of @Terminal.Gui.View are visually arranged such that they abut each other and do not overlap. In a Tiled view arrangement, Z-ordering only comes into play when a developer intentionally causes views to be aligned such that they overlap. Borders that are drawn between the SubViews can optionally support resizing the SubViews (negating the need for `TileView`). +## Composition -* *Overlap*, *Overlapped*, *Overlapping* - Refers to a form [Layout](layout.md) where SubViews of a View are visually arranged such that their Frames overlap. In Overlap view arrangements there is a Z-axis (Z-order) in addition to the X and Y dimension. The Z-order indicates which Views are shown above other views. - -## The Frame - -The @Terminal.Gui.View.Frame property of a `View` is a rectangle that describes the current location and size of the view relative to the `Superview`'s content area. The `Frame` has a `Location` and `Size`. The `Location` describes the top-left corner of the view relative to the `SuperView`'s content area. The `Size` describes the width and height of the view. The `Frame` is used to determine where the view is drawn on the screen and is used to calculate the Viewport and content size. +[!INCLUDE [View Composition](~/includes/view-composition.md)] ## The Content Area - The content area is the area where the view's content is drawn. Content can be any combination of the @Terminal.Gui.View.Text property, `SubViews`, and other content drawn by the View. The @Terminal.Gui.View.GetContentSize method gets the size of the content area of the view. *Content Area* refers to the rectangle with a location of `0,0` with the size returned by @Terminal.Gui.View.GetContentSize. +**Content Area** refers to the rectangle with a location of `0,0` with the size returned by @Terminal.Gui.ViewBase.View.GetContentSize*. - The Content Area size tracks the size of the @Terminal.Gui.View.Viewport by default. If the content size is set via @Terminal.Gui.View.SetContentSize, the content area is the provided size. If the content size is larger than the @Terminal.Gui.View.Viewport, scrolling is enabled. +The content area is the area where the view's content is drawn. Content can be any combination of the @Terminal.Gui.ViewBase.View.Text property, `SubViews`, and other content drawn by the View. The @Terminal.Gui.ViewBase.View.GetContentSize* method gets the size of the content area of the view. + + The Content Area size tracks the size of the @Terminal.Gui.ViewBase.View.Viewport by default. If the content size is set via @Terminal.Gui.ViewBase.View.SetContentSize*, the content area is the provided size. If the content size is larger than the @Terminal.Gui.ViewBase.View.Viewport, scrolling is enabled. ## The Viewport -The Viewport (@Terminal.Gui.View.Viewport) is a rectangle describing the portion of the *Content Area* that is currently visible to the user. It is a "portal" into the content. The `Viewport.Location` is relative to the top-left corner of the inner rectangle of `View.Padding`. If `Viewport.Size` is the same as `View.GetContentSize()`, `Viewport.Location` will be `0,0`. +The @Terminal.Gui.ViewBase.View.Viewport is a rectangle describing the portion of the **Content Area** that is visible to the user. It is a "portal" into the content. The `Viewport.Location` is relative to the top-left corner of the inner rectangle of `View.Padding`. If `Viewport.Size` is the same as `View.GetContentSize()`, `Viewport.Location` will be `0,0`. To enable scrolling call `View.SetContentSize()` and then set `Viewport.Location` to positive values. Making `Viewport.Location` positive moves the Viewport down and to the right in the content. See the [Scrolling Deep Dive](scrolling.md) for details on how to enable scrolling. -The @Terminal.Gui.View.ViewportSettings property controls how the Viewport is constrained. By default, the `ViewportSettings` is set to `ViewportSettings.None`. To enable the viewport to be moved up-and-to-the-left of the content, use `ViewportSettings.AllowNegativeX` and or `ViewportSettings.AllowNegativeY`. +The @Terminal.Gui.ViewBase.View.ViewportSettings property controls how the Viewport is constrained. By default, the `ViewportSettings` is set to `ViewportSettings.None`. To enable the viewport to be moved up-and-to-the-left of the content, use `ViewportSettings.AllowNegativeX` and or `ViewportSettings.AllowNegativeY`. The default `ViewportSettings` also constrains the Viewport to the size of the content, ensuring the right-most column or bottom-most row of the content will always be visible (in v1 the equivalent concept was `ScrollBarView.AlwaysKeepContentInViewport`). To allow the Viewport to be smaller than the content, set `ViewportSettings.AllowXGreaterThanContentWidth` and/or `ViewportSettings.AllowXGreaterThanContentHeight`. -* *@Terminal.Gui.View.GetContentSize()* - The content area is the area where the view's content is drawn. Content can be any combination of the @Terminal.Gui.View.Text property, `SubViews`, and other content drawn by the View. The @Terminal.Gui.View.GetContentSize method gets the size of the content area of the view. *Content Area* refers to the rectangle with a location of `0,0` with the size returned by @Terminal.Gui.View.GetContentSize. The [Layout Deep Dive](layout.md) has more details on the Content Area. +## Layout Engine -* *@Terminal.Gui.View.Viewport* A rectangle describing the portion of the *Content Area* that is currently visible to the user. It is a "portal" into the content. The `Viewport.Location` is relative to the top-left corner of the inner rectangle of `View.Padding`. If `Viewport.Size` is the same as `View.GetContentSize()`, `Viewport.Location` will be `0,0`. - -## Layout - -Terminal.Gui provides a rich system for how views are laid out relative to each other. The position of a view is set by setting the `X` and `Y` properties, which are of time @Terminal.Gui.Pos. The size is set via `Width` and `Height`, which are of type @Terminal.Gui.Dim. +Terminal.Gui provides a rich system for how views are laid out relative to each other. The position of a view is set by setting the `X` and `Y` properties, which are of time @Terminal.Gui.ViewBase.Pos. The size is set via `Width` and `Height`, which are of type @Terminal.Gui.ViewBase.Dim. ```cs var label1 = new Label () { X = 1, Y = 2, Width = 3, Height = 4, Title = "Absolute") @@ -106,19 +52,17 @@ var label2 = new Label () { }; ``` -The `Frame` property is a rectangle that provides the current location and size of the view relative to the View's `Superview`'s Content area. +### @Terminal.Gui.ViewBase.Pos -## The `Pos` Type +@Terminal.Gui.ViewBase.Pos is the type of `View.X` and `View.Y` and supports the following sub-types: -The @Terminal.Gui.Pos is the type of `View.X` and `View.Y` and supports the following sub-types: - -* Absolute position, by passing an integer - @Terminal.Gui.Pos.Absolute(System.Int32). -* Percentage of the parent's view size - @Terminal.Gui.Pos.Percent(System.Int32) -* Anchored from the end of the dimension - @Terminal.Gui.Pos.AnchorEnd(System.Int32) -* Centered, using @Terminal.Gui.Pos.Center() -* The @Terminal.Gui.Pos.Left(Terminal.Gui.View), @Terminal.Gui.Pos.Right(Terminal.Gui.View), @Terminal.Gui.Pos.Top(Terminal.Gui.View), and @Terminal.Gui.Pos.Bottom(Terminal.Gui.View) tracks the position of another view. -* Aligned (left, right, center, etc...) with other views - @Terminal.Gui.Pos.Align(Terminal.Gui.Alignment,Terminal.Gui.AlignmentModes,System.Int32). -* An arbitrary function - @Terminal.Gui.Pos.FuncTerminal.Gui.Pos.Func(System.Func{System.Int32}) +* Absolute position, by passing an integer - @Terminal.Gui.ViewBase.Pos.Absolute*. +* Percentage of the parent's view size - @Terminal.Gui.ViewBase.Pos.Percent(System.Int32) +* Anchored from the end of the dimension - @Terminal.Gui.ViewBase.Pos.AnchorEnd(System.Int32) +* Centered, using @Terminal.Gui.ViewBase.Pos.Center* +* The @Terminal.Gui.ViewBase.Pos.Left*, @Terminal.Gui.ViewBase.Pos.Right*, @Terminal.Gui.ViewBase.Pos.Top*, and @Terminal.Gui.ViewBase.Pos.Bottom* tracks the position of another view. +* Aligned (left, right, center, etc...) with other views - @Terminal.Gui.ViewBase.Pos.Align* +* An arbitrary function - @Terminal.Gui.ViewBase.Pos.Func* All `Pos` coordinates are relative to the SuperView's content area. @@ -135,16 +79,16 @@ anotherView.Width = 9; myView.X = Pos.X (view); myView.Y = Pos.Bottom (anotherView) + 5; ``` -## The `Dim` Type +### @Terminal.Gui.ViewBase.Dim -The @Terminal.Gui.Dim is the type of `View.Width` and `View.Height` and supports the following sub-types: +@Terminal.Gui.ViewBase.Dim is the type of `View.Width` and `View.Height` and supports the following sub-types: -* Automatic size based on the View's content (either SubViews or Text) - @Terminal.Gui.Dim.Auto(Terminal.Gui.DimAutoStyle,Terminal.Gui.Dim,Terminal.Gui.Dim) - See [Dim.Auto Deep Dive](dimauto.md). -* Absolute size, by passing an integer - @Terminal.Gui.Dim.Absolute(System.Int32). -* Percentage of the SuperView's Content Area - @Terminal.Gui.Dim.Percent(System.Int32). -* Fill to the end of the SuperView's Content Area - @Terminal.Gui.Dim.Fill. -* Reference the Width or Height of another view - @Terminal.Gui.Dim.Width(Terminal.Gui.View), @Terminal.Gui.Dim.Height(Terminal.Gui.View). -* An arbitrary function - @Terminal.Gui.Dim.Func(System.Func{System.Int32}). +* Automatic size based on the View's content (either SubViews or Text) - @Terminal.Gui.ViewBase.Dim.Auto* - See [Dim.Auto Deep Dive](dimauto.md). +* Absolute size, by passing an integer - @Terminal.Gui.ViewBase.Dim.Absolute(System.Int32). +* Percentage of the SuperView's Content Area - @Terminal.Gui.ViewBase.Dim.Percent(System.Int32). +* Fill to the end of the SuperView's Content Area - @Terminal.Gui.ViewBase.Dim.Fill*. +* Reference the Width or Height of another view - @Terminal.Gui.ViewBase.Dim.Width(Terminal.Gui.ViewBase.View), @Terminal.Gui.ViewBase.Dim.Height(Terminal.Gui.ViewBase.View). +* An arbitrary function - @Terminal.Gui.ViewBase.Dim.Func(System.Func{System.Int32}). All `Dim` dimensions are relative to the SuperView's content area. @@ -159,3 +103,38 @@ view.Height = Dim.Percent(20) - 1; anotherView.Height = Dim.Height (view) + 1; ``` + +```mermaid +classDiagram + class View { + } + + View --> Frame : is Rectangle + View --> Viewport : is Rectangle + + class Border { + } + + class Adornment { + } + + class Thickness { + } + + + Margin --> Adornment : is + Border --> Adornment : is + Padding --> Adornment : is + Adornment --> Thickness : has + + View --> Margin : has + View --> Border : has + View --> Padding : has + + note for View "Defines location and size relative to SuperView" + note for Viewport "Defines the visible portion of the Content Area" + note for Margin "Where Shadows live" + note for Border "Where Border, Title, and Arrangement controls live" + note for Padding "Where ScrollBars live" + note for Thickness "A rectangle where each side can have a width" +``` diff --git a/docfx/docs/lexicon.md b/docfx/docs/lexicon.md new file mode 100644 index 000000000..aea2dc61a --- /dev/null +++ b/docfx/docs/lexicon.md @@ -0,0 +1,31 @@ +# Terminal.Gui Lexicon & Taxonomy + +## Arrangement + +[!INCLUDE [Arrangement](~/includes/arrangement-lexicon.md)] + +## Configuration + +[!INCLUDE [Configuration](~/includes/config-lexicon.md)] + +## Drawing + +[!INCLUDE [Drawing](../includes/drawing-lexicon.md)] + +## Events + +[!INCLUDE [Events](~/includes/events-lexicon.md)] + +## Layout + +[!INCLUDE [Layout](./../includes/layout-lexicon.md)] + +## Navigation + +[!INCLUDE [Navigation](~/includes/navigation-lexicon.md)] + +## Scrolling + +[!INCLUDE [Scrolling](~/includes/scrolling-lexicon.md)] + + diff --git a/docfx/docs/logging.md b/docfx/docs/logging.md index a175591ed..8740e9e90 100644 --- a/docfx/docs/logging.md +++ b/docfx/docs/logging.md @@ -2,7 +2,7 @@ Logging has come to Terminal.Gui! You can now enable comprehensive logging of the internals of the library. This can help diagnose issues with specific terminals, keyboard cultures and/or operating system specific issues. -To enable file logging you should set the static property `Logging.Logger` to an instance of `Microsoft.Extensions.Logging.ILogger`. If your program already uses logging you can provide a shared instance or instance from Dependency Injection (DI). +To enable file logging you should set the static property @Terminal.Gui.App.Logging.Logger to an instance of `Microsoft.Extensions.Logging.ILogger`. If your program already uses logging you can provide a shared instance or instance from Dependency Injection (DI). Alternatively you can create a new log to ensure only Terminal.Gui logs appear. diff --git a/docfx/docs/mainloop.md b/docfx/docs/mainloop.md index 5b959a0d0..5421e461a 100644 --- a/docfx/docs/mainloop.md +++ b/docfx/docs/mainloop.md @@ -16,11 +16,11 @@ This class provides the following capabilities: * Idle processing handlers * Invoking UI code from a background thread -The `MainLoop` property in the the [`Application`](~/api/Terminal.Gui.Application.yml) +The `MainLoop` property in the the [`Application`](~/api/Terminal.Gui.App.Application.yml) provides access to these functions. When `Application.Run (Toplevel)` is called, the application will prepare the current -[`Toplevel`](~/api/Terminal.Gui.Toplevel.yml) instance by redrawing the screen appropriately and then starting the main loop. +[`Toplevel`](~/api/Terminal.Gui.Views.Toplevel.yml) instance by redrawing the screen appropriately and then starting the main loop. Configure the Mainloop before calling Application.Run, or configure the MainLoop in response to events during the execution. diff --git a/docfx/docs/migratingfromv1.md b/docfx/docs/migratingfromv1.md index 374d1e9f0..8bdbb903b 100644 --- a/docfx/docs/migratingfromv1.md +++ b/docfx/docs/migratingfromv1.md @@ -85,7 +85,7 @@ When measuring the screen space taken up by a `string` you can use the extension In v1, @Terminal.Gui.View was derived from `Responder` which supported `IDisposable`. In v2, `Responder` has been removed and @Terminal.Gui.View is the base-class supporting `IDisposable`. -In v1, @Terminal.Gui./Terminal.Gui.Application.Init) automatically created a toplevel view and set [Application.Top](~/api/Terminal.Gui.Application.Top. In v2, @Terminal.Gui.Application.Init no longer automatically creates a toplevel or sets @Terminal.Gui.Application.Top; app developers must explicitly create the toplevel view and pass it to @Terminal.Gui.Application.Run (or use `Application.Run`). Developers are responsible for calling `Dispose` on any toplevel they create before exiting. +In v1, @Terminal.Gui./Terminal.Gui.Application.Init) automatically created a toplevel view and set [Application.Top](~/api/Terminal.Gui.Application.Top. In v2, @Terminal.Gui.App.Application.Init no longer automatically creates a toplevel or sets @Terminal.Gui.App.Application.Top; app developers must explicitly create the toplevel view and pass it to @Terminal.Gui.App.Application.Run (or use `Application.Run`). Developers are responsible for calling `Dispose` on any toplevel they create before exiting. ### How to Fix @@ -115,9 +115,9 @@ In v1, @Terminal.Gui./Terminal.Gui.Application.Init) automatically created a top In v2, the layout system has been improved to make it easier to create complex user interfaces. If you are using custom layouts in your application, you may need to update them to use the new layout system. * The distinction between `Absolute Layout` and `Computed Layout` has been removed, as has the `LayoutStyle` enum. v1 drew a false distinction between these styles. -* @Terminal.Gui.View.Frame now represents the position and size of the view in the superview's coordinate system. The `Frame` property is of type `Rectangle`. -* @Terminal.Gui.View.Bounds has been replaced by @Terminal.Gui.View.Viewport. The `Viewport` property represents the visible area of the view in its own coordinate system. The `Viewport` property is of type `Rectangle`. -* @Terminal.Gui.View.GetContentSize represents the size of the view's content. This replaces `ScrollView` and `ScrollBarView` in v1. See more below. +* @Terminal.Gui.ViewBase.View.Frame now represents the position and size of the view in the superview's coordinate system. The `Frame` property is of type `Rectangle`. +* @Terminal.Gui.ViewBase.View.Bounds has been replaced by @Terminal.Gui.ViewBase.View.Viewport. The `Viewport` property represents the visible area of the view in its own coordinate system. The `Viewport` property is of type `Rectangle`. +* @Terminal.Gui.ViewBase.View.GetContentSize represents the size of the view's content. This replaces `ScrollView` and `ScrollBarView` in v1. See more below. ### How to Fix @@ -128,7 +128,7 @@ In v2, the layout system has been improved to make it easier to create complex u * Update any code that assumed `Bounds.Location` was always `Point.Empty`. * Update any code that used `Bounds` to refer to the size of the view's content. Use `GetContentSize()` instead. * Update any code that assumed `Bounds.Size` was the same as `Frame.Size`. `Frame.Size` defines the size of the view in the superview's coordinate system, while `Viewport.Size` defines the visible area of the view in its own coordinate system. -* Use @Terminal.Gui.View.GetAdornmentsThickness to get the total thickness of the view's border, margin, and padding. +* Use @Terminal.Gui.ViewBase.View.GetAdornmentsThickness to get the total thickness of the view's border, margin, and padding. * Not assume a View can draw outside of 'Viewport'. Use the 'Margin', 'Border', and 'Padding' Adornments to do things outside of `Viewport`. View subclasses should not implement their own concept of padding or margins but leverage these `Adornments` instead. * Mouse and draw events now provide coordinates relative to the `Viewport` not the `Frame`. @@ -144,21 +144,21 @@ In v1, `View.AutoSize` was used to size a view to its `Text`. In v2, `View.AutoS In v2, the `Border`, `Margin`, and `Padding` properties have been added to all views. This simplifies view development and enables a sophisticated look and feel. If you are using custom borders, margins, or padding in your application, you may need to update them to use the new properties. -* `View.Border` is now of type @Terminal.Gui.Adornment. @Terminal.Gui.View.BorderStyle is provided as a convenience property to set the border style (`myView.BorderStyle = LineStyle.Double`). +* `View.Border` is now of type @Terminal.Gui.Adornment. @Terminal.Gui.ViewBase.View.BorderStyle is provided as a convenience property to set the border style (`myView.BorderStyle = LineStyle.Double`). ### How to Fix ## Built-in Scrolling -In v1, scrolling was enabled by using `ScrollView` or `ScrollBarView`. In v2, the base @Terminal.Gui.View class supports scrolling inherently. The area of a view visible to the user at a given moment was previously a rectangle called `Bounds`. `Bounds.Location` was always `Point.Empty`. In v2 the visible area is a rectangle called `Viewport` which is a protal into the Views content, which can be bigger (or smaller) than the area visible to the user. Causing a view to scroll is as simple as changing `View.Viewport.Location`. The View's content is described by @Terminal.Gui.View.GetContentSize. See [Layout](layout.md) for details. +In v1, scrolling was enabled by using `ScrollView` or `ScrollBarView`. In v2, the base @Terminal.Gui.View class supports scrolling inherently. The area of a view visible to the user at a given moment was previously a rectangle called `Bounds`. `Bounds.Location` was always `Point.Empty`. In v2 the visible area is a rectangle called `Viewport` which is a protal into the Views content, which can be bigger (or smaller) than the area visible to the user. Causing a view to scroll is as simple as changing `View.Viewport.Location`. The View's content is described by @Terminal.Gui.ViewBase.View.GetContentSize. See [Layout](layout.md) for details. -@Terminal.Gui.ScrollBar replaces `ScrollBarView` with a much cleaner implementation of a scrollbar. In addition, @Terminal.Gui.View.VerticalScrollBar and @Terminal.Gui.View.HorizontalScrollBar provide a simple way to enable scroll bars in any View with almost no code. See See [Scrolling Deep Dive](scrolling.md) for more. +@Terminal.Gui.ScrollBar replaces `ScrollBarView` with a much cleaner implementation of a scrollbar. In addition, @Terminal.Gui.ViewBase.View.VerticalScrollBar and @Terminal.Gui.ViewBase.View.HorizontalScrollBar provide a simple way to enable scroll bars in any View with almost no code. See See [Scrolling Deep Dive](scrolling.md) for more. ### How to Fix -* Replace `ScrollView` with @Terminal.Gui.View and use `Viewport` and @Terminal.Gui.View.GetContentSize to control scrolling. +* Replace `ScrollView` with @Terminal.Gui.View and use `Viewport` and @Terminal.Gui.ViewBase.View.GetContentSize to control scrolling. * Update any code that assumed `Bounds.Location` was always `Point.Empty`. -* Update any code that used `Bounds` to refer to the size of the view's content. Use @Terminal.Gui.View.GetContentSize instead. +* Update any code that used `Bounds` to refer to the size of the view's content. Use @Terminal.Gui.ViewBase.View.GetContentSize instead. * Update any code that assumed `Bounds.Size` was the same as `Frame.Size`. `Frame.Size` defines the size of the view in the superview's coordinate system, while `Viewport.Size` defines the visible area of the view in its own coordinate system. * Replace `ScrollBarView` with @Terminal.Gui.ScrollBar. See [Scrolling Deep Dive](scrolling.md) for more. @@ -168,15 +168,15 @@ The API for handling keyboard input is significantly improved. See [Keyboard API * The @Terminal.Gui.Key class replaces the `KeyEvent` struct and provides a platform-independent abstraction for common keyboard operations. It is used for processing keyboard input and raising keyboard events. This class provides a high-level abstraction with helper methods and properties for common keyboard operations. Use this class instead of the low-level @Terminal.Gui.KeyCode enum when possible. See @Terminal.Gui.Key for more details. * The preferred way to enable Application-wide or View-heirarchy-dependent keystrokes is to use the @Terminal.Gui.Shortcut View or the built-in View's that utilize it, such as the @Terminal.Gui.Bar-based views. -* The preferred way to handle single keystrokes is to use **Key Bindings**. Key Bindings map a key press to a @Terminal.Gui.Command. A view can declare which commands it supports, and provide a lambda that implements the functionality of the command, using `View.AddCommand()`. Use the @Terminal.Gui.View.Keybindings to configure the key bindings. +* The preferred way to handle single keystrokes is to use **Key Bindings**. Key Bindings map a key press to a @Terminal.Gui.Input.Command. A view can declare which commands it supports, and provide a lambda that implements the functionality of the command, using `View.AddCommand()`. Use the @Terminal.Gui.ViewBase.View.Keybindings to configure the key bindings. * For better consistency and user experience, the default key for closing an app or `Toplevel` is now `Esc` (it was previously `Ctrl+Q`). * The `Application.RootKeyEvent` method has been replaced with `Application.KeyDown` ### How to Fix * Replace `KeyEvent` with `Key` -* Use @Terminal.Gui.View.AddCommand to define commands your view supports. -* Use @Terminal.Gui.View.Keybindings to configure key bindings to `Command`s. +* Use @Terminal.Gui.ViewBase.View.AddCommand to define commands your view supports. +* Use @Terminal.Gui.ViewBase.View.Keybindings to configure key bindings to `Command`s. * It should be very uncommon for v2 code to override `OnKeyPressed` etc... * Anywhere `Ctrl+Q` was hard-coded as the "quit key", replace with `Application.QuitKey`. * See *Navigation* below for more information on v2's navigation keys. @@ -187,7 +187,7 @@ The API for handling keyboard input is significantly improved. See [Keyboard API + Application.KeyDown(object? sender, Key e) ``` -## **@"Terminal.Gui.Command" has been expanded and simplified +## **@"Terminal.Gui.Input.Command" has been expanded and simplified In v1, the `Command` enum had duplicate entries and inconsistent naming. In v2 it has been both expanded and simplified. @@ -201,16 +201,16 @@ The API for mouse input is now internally consistent and easier to use. * The @Terminal.Gui.MouseEventArgs class replaces `MouseEventEventArgs`. * More granular APIs are provided to ease handling specific mouse actions. See [Mouse API](mouse.md). -* Views can use the @Terminal.Gui.View.Highlight event to have the view be visibly highlighted on various mouse events. -* Views can set `View.WantContinousButtonPresses = true` to have their @Terminal.Gui.Command.Accept command be invoked repeatedly as the user holds a mouse button down on the view. +* Views can use the @Terminal.Gui.ViewBase.View.Highlight event to have the view be visibly highlighted on various mouse events. +* Views can set `View.WantContinousButtonPresses = true` to have their @Terminal.Gui.Input.Command.Accept command be invoked repeatedly as the user holds a mouse button down on the view. * Mouse and draw events now provide coordinates relative to the `Viewport` not the `Screen`. * The `Application.RootMouseEvent` method has been replaced with `Application.MouseEvent` ### How to Fix * Replace `MouseEventEventArgs` with `MouseEvent` -* Use the @Terminal.Gui.View.Highlight event to have the view be visibly highlighted on various mouse events. -* Set `View.WantContinousButtonPresses = true` to have the @Terminal.Gui.Command.Accept command be invoked repeatedly as the user holds a mouse button down on the view. +* Use the @Terminal.Gui.ViewBase.View.Highlight event to have the view be visibly highlighted on various mouse events. +* Set `View.WantContinousButtonPresses = true` to have the @Terminal.Gui.Input.Command.Accept command be invoked repeatedly as the user holds a mouse button down on the view. * Update any code that assumed mouse events provided coordinates relative to the `Screen`. * Replace `Application.RootMouseEvent` with `Application.MouseEvent`. @@ -241,8 +241,8 @@ In v2, the API is (NOT YET IMPLEMENTED) simplified. A view simply reports the st #### How to Fix (Cursor API) -* Use @Terminal.Gui.View.CursorPosition to set the cursor position in a view. Set @Terminal.Gui.View.CursorPosition to `null` to hide the cursor. -* Set @Terminal.Gui.View.CursorVisibility to the cursor style you want to use. +* Use @Terminal.Gui.ViewBase.View.CursorPosition to set the cursor position in a view. Set @Terminal.Gui.ViewBase.View.CursorPosition to `null` to hide the cursor. +* Set @Terminal.Gui.ViewBase.View.CursorVisibility to the cursor style you want to use. * Remove any overrides of `OnEnter` and `OnLeave` that explicitly change the cursor. ### Focus @@ -266,9 +266,9 @@ See also [Keyboard](keyboard.md) where HotKey is covered more deeply... ### How to Fix (Focus API) -* Set @Terminal.Gui.View.CanFocus to `true` for any View sub-class that wants to be focusable. -* Use @Terminal.Gui.Application.Navigation.GetFocused to get the most focused view in the application. -* Use @Terminal.Gui.Application.Navigation.AdvanceFocus to cause focus to change. +* Set @Terminal.Gui.ViewBase.View.CanFocus to `true` for any View sub-class that wants to be focusable. +* Use @Terminal.Gui.App.Application.Navigation.GetFocused to get the most focused view in the application. +* Use @Terminal.Gui.App.Application.Navigation.AdvanceFocus to cause focus to change. ### Keyboard Navigation @@ -376,7 +376,7 @@ Replace references to nested types with the new standalone version ## View and Text Alignment Changes -In v1, both `TextAlignment` and `VerticalTextAlignment` enums were used to align text in views. In v2, these enums have been replaced with the @Terminal.Gui.Alignment enum. The @Terminal.Gui.View.TextAlignment property controls horizontal text alignment and the @Terminal.Gui.View.VerticalTextAlignment property controls vertical text alignment. +In v1, both `TextAlignment` and `VerticalTextAlignment` enums were used to align text in views. In v2, these enums have been replaced with the @Terminal.Gui.Alignment enum. The @Terminal.Gui.ViewBase.View.TextAlignment property controls horizontal text alignment and the @Terminal.Gui.ViewBase.View.VerticalTextAlignment property controls vertical text alignment. v2 now supports @Terminal.Gui.Pos.Align which enables views to be easily aligned within their Superview. @@ -460,17 +460,17 @@ In v2, these methods have been named correctly. ## `Mdi` Replaced by `ViewArrangement.Overlapped` -In v1, it apps with multiple overlapping views could be created using a set of APIs spread across `Application` (e.g. `Application.MdiTop`) and `Toplevel` (e.g. `IsMdiContainer`). This functionality has been replaced in v2 with @Terminal.Gui.View.Arrangement. Specifically, overlapped views with @Terminal.Gui.View.Arrangement having the @Terminal.Gui.ViewArrangement.Overlapped flag set will be arranged in an overlapped fashion using the order in their SuperView's subview list as the Z-order. +In v1, it apps with multiple overlapping views could be created using a set of APIs spread across `Application` (e.g. `Application.MdiTop`) and `Toplevel` (e.g. `IsMdiContainer`). This functionality has been replaced in v2 with @Terminal.Gui.ViewBase.View.Arrangement. Specifically, overlapped views with @Terminal.Gui.ViewBase.View.Arrangement having the @Terminal.Gui.ViewBase.ViewArrangement.Overlapped flag set will be arranged in an overlapped fashion using the order in their SuperView's subview list as the Z-order. -Setting the @Terminal.Gui.ViewArrangement.Movable flag will enable the overlapped views to be movable with the mouse or keyboard (`Ctrl+F5` to activate). +Setting the @Terminal.Gui.ViewBase.ViewArrangement.Movable flag will enable the overlapped views to be movable with the mouse or keyboard (`Ctrl+F5` to activate). -Setting the @Terminal.Gui.ViewArrangement.Sizable flag will enable the overlapped views to be resized with the mouse or keyboard (`Ctrl+F5` to activate). +Setting the @Terminal.Gui.ViewBase.ViewArrangement.Sizable flag will enable the overlapped views to be resized with the mouse or keyboard (`Ctrl+F5` to activate). In v1, only Views derived from `Toplevel` could be overlapped. In v2, any view can be. v1 conflated the concepts of -## `ContextMenu` replaced by `PopoverMenu` +## `PopoverMenu` replaced by `PopoverMenu` `PopoverMenu` replaces `ContrextMenu`. @@ -494,6 +494,6 @@ new ( * To simplify programming, any `View` added as a SubView another `View` will have it's lifecycle owned by the Superview; when a `View` is disposed, it will call `Dispose` on all the items in the `SubViews` property. Note this behavior is the same as it was in v1, just clarified. -* In v1, `Application.End` called `Dispose ()` on @Terminal.Gui.Application.Top (via `Runstate.Toplevel`). This was incorrect as it meant that after `Application.Run` returned, `Application.Top` had been disposed, and any code that wanted to interrogate the results of `Run` by accessing `Application.Top` only worked by accident. This is because GC had not actually happened; if it had the application would have crashed. In v2 `Application.End` does NOT call `Dispose`, and it is the caller to `Application.Run` who is responsible for disposing the `Toplevel` that was either passed to `Application.Run (View)` or created by `Application.Run ()`. +* In v1, `Application.End` called `Dispose ()` on @Terminal.Gui.App.Application.Top (via `Runstate.Toplevel`). This was incorrect as it meant that after `Application.Run` returned, `Application.Top` had been disposed, and any code that wanted to interrogate the results of `Run` by accessing `Application.Top` only worked by accident. This is because GC had not actually happened; if it had the application would have crashed. In v2 `Application.End` does NOT call `Dispose`, and it is the caller to `Application.Run` who is responsible for disposing the `Toplevel` that was either passed to `Application.Run (View)` or created by `Application.Run ()`. * Any code that creates a `Toplevel`, either by using `top = new()` or by calling either `top = Application.Run ()` or `top = ApplicationRun()` must call `top.Dispose` when complete. The exception to this is if `top` is passed to `myView.Add(top)` making it a subview of `myView`. This is because the semantics of `Add` are that the `myView` takes over responsibility for the subviews lifetimes. Of course, if someone calls `myView.Remove(top)` to remove said subview, they then re-take responsbility for `top`'s lifetime and they must call `top.Dispose`. \ No newline at end of file diff --git a/docfx/docs/mouse.md b/docfx/docs/mouse.md index 8455c82c4..e80e4613d 100644 --- a/docfx/docs/mouse.md +++ b/docfx/docs/mouse.md @@ -4,8 +4,8 @@ * [Cancellable Work Pattern](cancellable-work-pattern.md) * [Command Deep Dive](command.md) - - +* [Keyboard Deep Dive](keyboard.md) +* [Lexicon & Taxonomy](lexicon.md) ## Tenets for Terminal.Gui Mouse Handling (Unless you know better ones...) @@ -19,15 +19,15 @@ Tenets higher in the list have precedence over tenets lower in the list. *Terminal.Gui* provides the following APIs for handling mouse input: -* **MouseEventArgs** - @Terminal.Gui.MouseEventArgs provides a platform-independent abstraction for common mouse operations. It is used for processing mouse input and raising mouse events. -* **Mouse Bindings** - Mouse Bindings provide a declarative method for handling mouse input in View implementations. The View calls Terminal.Gui.View.AddCommand(Terminal.Gui.Command,System.Func{System.Nullable{System.Boolean}}) to declare it supports a particular command and then uses @Terminal.Gui.MouseBindings to indicate which mouse events will invoke the command. -* **Mouse Events** - The Mouse Bindings API is rich enough to support the majority of use-cases. However, in some cases subscribing directly to key events is needed (e.g. drag & drop). Use @Terminal.Gui.View.MouseEvent and related events in these cases. +* **MouseEventArgs** - @Terminal.Gui.Input.MouseEventArgs provides a platform-independent abstraction for common mouse operations. It is used for processing mouse input and raising mouse events. +* **Mouse Bindings** - Mouse Bindings provide a declarative method for handling mouse input in View implementations. The View calls Terminal.Gui.ViewBase.View.AddCommand* to declare it supports a particular command and then uses @Terminal.Gui.Input.MouseBindings to indicate which mouse events will invoke the command. +* **Mouse Events** - The Mouse Bindings API is rich enough to support the majority of use-cases. However, in some cases subscribing directly to key events is needed (e.g. drag & drop). Use @Terminal.Gui.ViewBase.View.MouseEvent and related events in these cases. Each of these APIs are described more fully below. ## Mouse Bindings -Mouse Bindings is the preferred way of handling mouse input in View implementations. The View calls Terminal.Gui.View.AddCommand(Terminal.Gui.Command,System.Func{System.Nullable{System.Boolean}}) to declare it supports a particular command and then uses @Terminal.Gui.MouseBindings to indicate which mouse events will invoke the command. For example, if a View wants to respond to the user using the mouse wheel to scroll up, it would do this: +Mouse Bindings is the preferred way of handling mouse input in View implementations. The View calls Terminal.Gui.ViewBase.View.AddCommand* to declare it supports a particular command and then uses @Terminal.Gui.Input.MouseBindings to indicate which mouse events will invoke the command. For example, if a View wants to respond to the user using the mouse wheel to scroll up, it would do this: ```cs public MyView : View @@ -37,11 +37,11 @@ public MyView : View } ``` -The [Command](~/api/Terminal.Gui.Command.yml) enum lists generic operations that are implemented by views. +The [Command](~/api/Terminal.Gui.Input.Command.yml) enum lists generic operations that are implemented by views. ## Mouse Events -At the core of *Terminal.Gui*'s mouse API is the @Terminal.Gui.MouseEventArgs class. The @Terminal.Gui.MouseEventArgs class provides a platform-independent abstraction for common mouse events. Every mouse event can be fully described in a @Terminal.Gui.MouseEventArgs instance, and most of the mouse-related APIs are simply helper functions for decoding a @Terminal.Gui.MouseEventArgs. +At the core of *Terminal.Gui*'s mouse API is the @Terminal.Gui.Input.MouseEventArgs class. The @Terminal.Gui.Input.MouseEventArgs class provides a platform-independent abstraction for common mouse events. Every mouse event can be fully described in a @Terminal.Gui.Input.MouseEventArgs instance, and most of the mouse-related APIs are simply helper functions for decoding a @Terminal.Gui.Input.MouseEventArgs. When the user does something with the mouse, the `ConsoleDriver` maps the platform-specific mouse event into a `MouseEventArgs` and calls `Application.RaiseMouseEvent`. Then, `Application.RaiseMouseEvent` determines which `View` the event should go to. The `View.OnMouseEvent` method can be overridden or the `View.MouseEvent` event can be subscribed to, to handle the low-level mouse event. If the low-level event is not handled by a view, `Application` will then call the appropriate high-level helper APIs. For example, if the user double-clicks the mouse, `View.OnMouseClick` will be called/`View.MouseClick` will be raised with the event arguments indicating which mouse button was double-clicked. @@ -55,9 +55,9 @@ When the user does something with the mouse, the `ConsoleDriver` maps the platfo ## **Global Mouse Handling** -The @Terminal.Gui.Application.MouseEvent event can be used if an application wishes to receive all mouse events. +The @Terminal.Gui.App.Application.MouseEvent event can be used if an application wishes to receive all mouse events. ## Mouse Enter/Leave Events -The @Terminal.Gui.View.MouseEnter and @Terminal.Gui.View.MouseLeave events enable a View to take action when the mouse is over the view. Internally, this is used to enable @Terminal.Gui.View.Highlight. +The @Terminal.Gui.ViewBase.View.MouseEnter and @Terminal.Gui.ViewBase.View.MouseLeave events enable a View to take action when the mouse is over the view. Internally, this is used to enable @Terminal.Gui.ViewBase.View.Highlight. diff --git a/docfx/docs/navigation.md b/docfx/docs/navigation.md index eb108e744..5d953d53b 100644 --- a/docfx/docs/navigation.md +++ b/docfx/docs/navigation.md @@ -8,18 +8,15 @@ - What is the order in which UI elements are traversed when using keyboard navigation? - What are the default actions for standard key/mouse input (e.g. Hotkey, `Space`, `Enter`, `MouseClick`)? +## See Also + +* [Keyboard Deep Dive](keyboard.md) +* [Mouse Deep Dive](mouse.md) +* [Lexicon & Taxonomy](lexicon.md) + ## Lexicon & Taxonomy -- **Navigation** refers to the user experience for moving focus between views in the application view-hierarchy. -- **Focus** - Refers to the state where a particular UI element (`View`), such as a button, input field, or any interactive component, is actively selected and ready to receive user input. When an element has focus, it typically responds to keyboard events and other interactions. -- **Focus Chain** - The ordered sequence of UI elements that can receive focus, starting from the currently focused element and extending to its parent (SuperView) elements up to the root of the focus tree (`Application.Top`). This chain determines the path that focus traversal follows within the application. Only one focus chain in an application can have focus (`top.HasFocus == true`), and there is one, and only one, View in a focus chain that is the most-focused; the one receiving keyboard input. -- **Cursor** - A visual indicator to the user where keyboard input will have an impact. There is one Cursor per terminal session. See [Cursor](cursor.md) for a deep-dive. -- **Focus Ordering** - The order focusable Views are navigated. Focus Ordering is typically used in UI frameworks to enable screen readers and improve the Accessibility of an application. In v1, `TabIndex`/`TabIndexes` enabled Focus Ordering. -- **Tab** - Describes the `Tab` key found on all keyboards, a break in text that is wider than a space, or a UI element that is a stop-point for keyboard navigation. The use of the word "Tab" for this comes from the typewriter, and is reinforced by the existence of a `Tab` key on all keyboards. -- **TabStop** - A `View` that is an ultimate stop-point for keyboard navigation. In this usage, ultimate means the `View` has no focusable subviews. The `Application.NextTabStopKey` and `Application.PrevTabStopKey` are `Key.Tab` and `Key.Tab.WithShift` respectively. These keys navigate only between peer-views. -- **TabGroup** - A `View` that is a container for other focusable views. The `Application.NextTabGroupKey` and `Application.PrevTabGroupKey` are `Key.PageDown.WithCtrl` and `Key.PageUp.WithCtrl` respectively. These keys enable the user to use the keyboard to navigate up and down the view-hierarchy. -- **Enter** / **Gain** - Means a View that previously was not focused is now becoming focused. "The View is entering focus" is the same as "The View is gaining focus". These terms are legacy terms from v1. -- **Leave** / **Lose** - Means a View that previously was focused is now becoming un-focused. "The View is leaving focus" is the same as "The View is losing focus". These terms are legacy terms from v1. +[!INCLUDE [Navigation Lexicon](~/includes/navigation-lexicon.md)] ## Tenets for Terminal.Gui UI Navigation (Unless you know better ones...) @@ -80,13 +77,13 @@ For this to work properly, there must be logic that removes the focus-cache used ## Application Level Navigation -At the application level, navigation is encapsulated within the @Terminal.Gui.ApplicationNavigation helper class which is publicly exposed via the @Terminal.Gui.Application.Navigation property. +At the application level, navigation is encapsulated within the @Terminal.Gui.ApplicationNavigation helper class which is publicly exposed via the @Terminal.Gui.App.Application.Navigation property. -@Terminal.Gui.ApplicationNavigation.GetFocused gets the most-focused View in the application. Will return `null` if there is no view with focus (an extremely rare situation). This replaces `View.MostFocused` in v1. +@Terminal.Gui.App.ApplicationNavigation.GetFocused gets the most-focused View in the application. Will return `null` if there is no view with focus (an extremely rare situation). This replaces `View.MostFocused` in v1. -The @Terminal.Gui.ApplicationNavigation.FocusedChanged and @Terminal.Gui.ApplicationNavigation.FocusedChanging events are raised when the most-focused View in the application is changing or has changed. `FocusedChanged` is useful for apps that want to do something with the most-focused view (e.g. see `AdornmentsEditor`). `FocusChanging` is useful apps that want to override what view can be focused across an entire app. +The @Terminal.Gui.App.ApplicationNavigation.FocusedChanged and @Terminal.Gui.App.ApplicationNavigation.FocusedChanging events are raised when the most-focused View in the application is changing or has changed. `FocusedChanged` is useful for apps that want to do something with the most-focused view (e.g. see `AdornmentsEditor`). `FocusChanging` is useful apps that want to override what view can be focused across an entire app. -The @Terminal.Gui.ApplicationNavigation.AdvanceFocus(Terminal.Gui.NavigationDirection,System.Nullable{Terminal.Gui.TabBehavior}) method causes the focus to advance (forward or backwards) to the next View in the application view-hierarchy, using `behavior` as a filter. +The @Terminal.Gui.App.ApplicationNavigation.AdvanceFocus* method causes the focus to advance (forward or backwards) to the next View in the application view-hierarchy, using `behavior` as a filter. The implementation is simple: @@ -100,9 +97,9 @@ This method replaces about a dozen functions in v1 (scattered across `Applicatio ## View Level Navigation -@Terminal.Gui.View.AdvanceFocus(Terminal.Gui.NavigationDirection,System.Nullable{Terminal.Gui.TabBehavior}) is the primary method for developers to cause a view to gain or lose focus. +@Terminal.Gui.ViewBase.View.AdvanceFocus* is the primary method for developers to cause a view to gain or lose focus. -Various events are raised when a View's focus is changing. For example, @Terminal.Gui.View.HasFocusChanging and @Terminal.Gui.View.HasFocusChanged. +Various events are raised when a View's focus is changing. For example, @Terminal.Gui.ViewBase.View.HasFocusChanging and @Terminal.Gui.ViewBase.View.HasFocusChanged. ## What makes a View focusable? @@ -168,7 +165,7 @@ In v2, the automatic setting of `TabStop` in `Add` is retained because it is not ## Knowing When a View's Focus is Changing -@Terminal.Gui.View.HasFocusChanging and @Terminal.Gui.View.HasFocusChanged are raised when a View's focus is changing. +@Terminal.Gui.ViewBase.View.HasFocusChanging and @Terminal.Gui.ViewBase.View.HasFocusChanged are raised when a View's focus is changing. ## Built-In Views Interactivity @@ -183,7 +180,7 @@ In v2, the automatic setting of `TabStop` in `Add` is retained because it is not | **Slider** | > 1 | No | No | 1 | SetFocusedOption | SetFocusedOption
OnAccept | Focus | SetFocus
SetFocusedOption | | SetFocus
SetFocusedOption | | Yes | | **ListView** | > 1 | No | No | 1 | MarkUnMarkRow | OpenSelectedItem
OnAccept | OnAccept | SetMark
OnSelectedChanged | OpenSelectedItem
OnAccept | | | No | -## Accesibilty Tenets +## Accessibility Tenets See https://devblogs.microsoft.com/dotnet/the-journey-to-accessible-apps-keyboard-accessible/ diff --git a/docfx/docs/newinv2.md b/docfx/docs/newinv2.md index 4c0353c2b..90d0af68b 100644 --- a/docfx/docs/newinv2.md +++ b/docfx/docs/newinv2.md @@ -12,39 +12,39 @@ Apps built with Terminal.Gui now feel modern thanks to these improvements: * *Enhanced Borders and Padding* - Terminal.Gui now supports a `Border`, `Margin`, and `Padding` property on all views. This simplifies View development and enables a sophisticated look and feel. See [Adornments](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/overview.html#adornments) for details. * *User Configurable Color Themes* - See [Color Themes](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/overview.html#color-themes) for details. * *Enhanced Unicode/Wide Character support* - Terminal.Gui now supports the full range of Unicode/wide characters. See [Unicode](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/overview.html#unicode) for details. -* [LineCanvas](~/api/Terminal.Gui.LineCanvas.yml) - Terminal.Gui now supports a line canvas enabling high-performance drawing of lines and shapes using box-drawing glyphs. `LineCanvas` provides *auto join*, a smart TUI drawing system that automatically selects the correct line/box drawing glyphs for intersections making drawing complex shapes easy. See [Line Canvas](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/overview.html#line-canvas) for details. +* [LineCanvas](~/api/Terminal.Gui.Drawing.LineCanvas.yml) - Terminal.Gui now supports a line canvas enabling high-performance drawing of lines and shapes using box-drawing glyphs. `LineCanvas` provides *auto join*, a smart TUI drawing system that automatically selects the correct line/box drawing glyphs for intersections making drawing complex shapes easy. See [Line Canvas](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/overview.html#line-canvas) for details. ## Simplified API The entire library has been reviewed and simplified. As a result, the API is more consistent and uses modern .NET API standards (e.g. for events). This refactoring resulted in the removal of thousands of lines of code, better unit tests, and higher performance than v1. -## [View](~/api/Terminal.Gui.View.yml) Improvements +## [View](~/api/Terminal.Gui.ViewBase.View.yml) Improvements * *Improved!* View Lifetime Management is Now Deterministic - In v1 the rules for lifetime management of `View` objects was unclear and led to non-dterministic behavior and hard to diagnose bugs. This was particularly acute in the behavior of `Application.Run`. In v2, the rules are clear and the code and unit test infrastructure tries to enforce them. See [Migrating From v1 To v2](migratingfromv1.md) for more details. -* *New!* Adornments - Adornments are a special form of View that appear outside the `Viewport`: @Terminal.Gui.View.Margin, @Terminal.Gui.View.Border, and @Terminal.Gui.View.Padding. +* *New!* Adornments - Adornments are a special form of View that appear outside the `Viewport`: @Terminal.Gui.ViewBase.View.Margin, @Terminal.Gui.ViewBase.View.Border, and @Terminal.Gui.ViewBase.View.Padding. * *New!* Built-in Scrolling/Virtual Content Area - In v1, to have a view a user could scroll required either a bespoke scrolling implementation, inheriting from `ScrollView`, or managing the complexity of `ScrollBarView` directly. In v2, the base-View class supports scrolling inherently. The area of a view visible to the user at a given moment was previously a rectangle called `Bounds`. `Bounds.Location` was always `Point.Empty`. In v2 the visible area is a rectangle called `Viewport` which is a portal into the Views content, which can be bigger (or smaller) than the area visible to the user. Causing a view to scroll is as simple as changing `View.Viewport.Location`. The View's content described by `View.GetContentSize()`. See [Layout](layout.md) for details. -* *Improved!* @Terminal.Gui.ScrollBar replaces `ScrollBarView` with a much cleaner implementation of a scrollbar. In addition, @Terminal.Gui.View.VerticalScrollBar and @Terminal.Gui.View.HorizontalScrollBar provide a simple way to enable scroll bars in any View with almost no code. See See [Scrolling Deep Dive](scrolling.md) for more. -* *New!* @Terminal.Gui.DimAuto - Automatically sizes the view to fit the view's Text, SubViews, or ContentArea. -* *Improved!* @Terminal.Gui.PosAnchorEnd - New to v2 is `Pos.AnchorEnd ()` (with no parameters) which allows a view to be anchored to the right or bottom of the SuperView. -* *New!* @Terminal.Gui.PosAlign - Aligns a set of views horizontally or vertically (left, right, center, etc...). -* *New!* @Terminal.Gui.View.Arrangement enables tiled and overlapped view arrangement and moving/resizing Views with the keyboard and mouse. See [Arrangement](arrangement.md). +* *Improved!* @Terminal.Gui.Views.ScrollBar replaces `ScrollBarView` with a much cleaner implementation of a scrollbar. In addition, @Terminal.Gui.ViewBase.View.VerticalScrollBar and @Terminal.Gui.ViewBase.View.HorizontalScrollBar provide a simple way to enable scroll bars in any View with almost no code. See See [Scrolling Deep Dive](scrolling.md) for more. +* *New!* @Terminal.Gui.ViewBase.DimAuto - Automatically sizes the view to fit the view's Text, SubViews, or ContentArea. +* *Improved!* @Terminal.Gui.ViewBase.PosAnchorEnd - New to v2 is `Pos.AnchorEnd ()` (with no parameters) which allows a view to be anchored to the right or bottom of the SuperView. +* *New!* @Terminal.Gui.ViewBase.PosAlign - Aligns a set of views horizontally or vertically (left, right, center, etc...). +* *New!* @Terminal.Gui.ViewBase.View.Arrangement enables tiled and overlapped view arrangement and moving/resizing Views with the keyboard and mouse. See [Arrangement](arrangement.md). * *Improved!* Keyboard [Navigation](navigation.md) has been revamped to be more reliability and ensure TUI apps built with Terminal.Gui are accessible. * *New!* Sizable/Movable views - Any view can now be set to have resizeable borders and/or be dragged around. * *Improved!* Consistent tabbing behavior - Tab navigation now behaves as expected, cleanly and consistently. ## New and Improved Built-in Views -* *[DatePicker](~/api/Terminal.Gui.DatePicker.yml)* - NEW! +* *[DatePicker](~/api/Terminal.Gui.Views.DatePicker.yml)* - NEW! * *ScrollView* - Replaced by built-in scrolling. -* *@"Terminal.Gui.ScrollBar"* - Replaces *ScrollBarView* with a much simpler view. -* *[Slider](~/api/Terminal.Gui.Slider.yml)* - NEW! -* *[Shortcut](~/api/Terminal.Gui.Shortcut.yml)* - NEW! An opinionated (visually & API) View for displaying a command, helptext, key. -* *[Bar](~/api/Terminal.Gui.Bar.yml)* - NEW! Building-block View for containing Shortcuts. Opinionated relative to Orientation but minimially so. The basis for the new StatusBar, MenuBar, and Menu views. -* *[StatusBar](~/api/Terminal.Gui.StatusBar.yml)* - New implementation based on `Bar` -* *[MenuBar](~/api/Terminal.Gui.MenuBar.yml)* - COMING SOON! New implementation based on `Bar` -* *[ContextMenu](~/api/Terminal.Gui.ContextMenu.yml)* - COMING SOON! New implementation based on `Bar` -* *[FileDialog](~/api/Terminal.Gui.FileDialog.yml)* - The new, modern file dialog includes icons (in TUI!) for files/folders, search, and a `TreeView`. -* *[TableView](tableview.md)* - No longer just DataTable, now supports any collections, checkboxes and even expandable trees -* *@"Terminal.Gui.ColorPicker"* - Fully supports TrueColor with the ability to choose a color using HSV, RGB, or HSL as well as W3C standard color names. +* *@"Terminal.Gui.Views.ScrollBar"* - Replaces *ScrollBarView* with a much simpler view. +* *[Slider](~/api/Terminal.Gui.Views.Slider.yml)* - NEW! +* *[Shortcut](~/api/Terminal.Gui.Views.Shortcut.yml)* - NEW! An opinionated (visually & API) View for displaying a command, helptext, key. +* *[Bar](~/api/Terminal.Gui.Views.Bar.yml)* - NEW! Building-block View for containing Shortcuts. Opinionated relative to Orientation but minimially so. The basis for the new StatusBar, MenuBar, and Menu views. +* *[StatusBar](~/api/Terminal.Gui.Views.StatusBar.yml)* - New implementation based on `Bar` +* *[MenuBar](~/api/Terminal.Gui.Views.MenuBar.yml)* - COMING SOON! New implementation based on `Bar` +* *[PopoverMenu](~/api/Terminal.Gui.Views.PopoverMenu.yml)* - COMING SOON! New implementation based on `Bar` +* *[FileDialog](~/api/Terminal.Gui.Views.FileDialog.yml)* - The new, modern file dialog includes icons (in TUI!) for files/folders, search, and a `TreeView`. +* *[TableView](~/api/Terminal.Gui.Views.TableView.yml)* - No longer just DataTable, now supports any collections, checkboxes and even expandable trees +* *@"Terminal.Gui.Views.ColorPicker"* - Fully supports TrueColor with the ability to choose a color using HSV, RGB, or HSL as well as W3C standard color names. ## Beauty @@ -71,8 +71,8 @@ Recently added to Windows Terminal and long supported in mainstream linux termin The API for handling keyboard input is significantly improved. See [Keyboard API](keyboard.md). -* The `Key` class replaces the `KeyEvent` struct and provides a platform-independent abstraction for common keyboard operations. It is used for processing keyboard input and raising keyboard events. This class provides a high-level abstraction with helper methods and properties for common keyboard operations. Use this class instead of the low-level `KeyCode` enum when possible. See [Key](~/api/Terminal.Gui.Key.yml) for more details. -* The preferred way to handle single keystrokes is to use **Key Bindings**. Key Bindings map a key press to a [Command](~/api/Terminal.Gui.Command.yml). A view can declare which commands it supports, and provide a lambda that implements the functionality of the command, using `View.AddCommand()`. Use the `View.Keybindings` to configure the key bindings. +* The `Key` class replaces the `KeyEvent` struct and provides a platform-independent abstraction for common keyboard operations. It is used for processing keyboard input and raising keyboard events. This class provides a high-level abstraction with helper methods and properties for common keyboard operations. Use this class instead of the low-level `KeyCode` enum when possible. See [Key](~/api/Terminal.Gui.Input.Key.yml) for more details. +* The preferred way to handle single keystrokes is to use **Key Bindings**. Key Bindings map a key press to a [Command](~/api/Terminal.Gui.Input.Command.yml). A view can declare which commands it supports, and provide a lambda that implements the functionality of the command, using `View.AddCommand()`. Use the `View.Keybindings` to configure the key bindings. * For better consistency and user experience, the default key for closing an app or `Toplevel` is now `Esc` (it was previously `Ctrl+Q`). ## Updated Mouse API @@ -82,7 +82,7 @@ The API for mouse input is now internally consistent and easiser to use. * The `MouseEvent` class replaces `MouseEventEventArgs`. * More granular APIs are provided to ease handling specific mouse actions. See [Mouse API](mouse.md). * Views can use the `View.Highlight` event to have the view be visibly highlighted on various mouse events. -* Views can set `View.WantContinousButtonPresses = true` to ahve their `Command.Accept` command be invoked repeatedly as the user holds a mouse button down on the view. +* Views can set `View.WantContinousButtonPresses = true` to have their `Command.Accept` command be invoked repeatedly as the user holds a mouse button down on the view. ## AOT support *AOT/single file app support* now works out of the box. \ No newline at end of file diff --git a/docfx/docs/scheme.md b/docfx/docs/scheme.md index a4c3d983f..9a5ec8c5f 100644 --- a/docfx/docs/scheme.md +++ b/docfx/docs/scheme.md @@ -2,31 +2,13 @@ See [Drawing](drawing.md) for an overview of the drawing system and [Configuration](config.md) for an overview of the configuration system. -## Scheme Overview +## Overview -A Scheme is named a mapping from `VisualRole`s (e.g. `VisualRole.Focus`) to `Attribute`s, defining how a `View` should look based on its purpose (e.g. Menu or Dialog). @Terminal.Gui.SchemeManager.Schemes is a dictionary of `Scheme`s, indexed by name. - -A Scheme defines how Views look based on their semantic purpose. The following schemes are supported: - -| Scheme Name | Description | -|:-----|:--------| -| **Base** | The base scheme used for most Views. | -| **Dialog** | The dialog scheme; used for Dialog, MessageBox, and other views dialog-like views. | -| **Error** | The scheme for showing errors, such as in `ErrorQuery`. | -| **Menu** | The menu scheme; used for Terminal.Gui.Menu, MenuBar, and StatusBar. | -| **TopLevel** | The application Toplevel scheme; used for the Toplevel View. | - -@Terminal.Gui.SchemeManager manages the set of available schemes and provides a set of convenience methods for getting the current scheme and for overriding the default values for these schemes. - -```csharp -Scheme dialogScheme = SchemeManager.GetScheme (Schemes.Dialog); -``` - -[ConfigurationManager](config.md) can be used to override the default values for these schemes and add additional schemes. +[!INCLUDE [Scheme Overview](~/includes/scheme-overview.md)] ### Scheme Inheritance - A `Scheme` enables consistent, semantic theming of UI elements by associating each visual state with a specific style. Each property (e.g., `Normal` or `Focus`) is an @Terminal.Gui.Attribute. + A `Scheme` enables consistent, semantic theming of UI elements by associating each visual state with a specific style. Each property (e.g., `Normal` or `Focus`) is an @Terminal.Gui.Drawing.Attribute. Only `Normal` is required. If other properties are not explicitly set, its value is derived from other roles (typically `Normal`) using well-defined inheritance rules. See the source code for the `Scheme` class for more details. diff --git a/docfx/docs/scrolling.md b/docfx/docs/scrolling.md index fbbcc8124..2af75760d 100644 --- a/docfx/docs/scrolling.md +++ b/docfx/docs/scrolling.md @@ -2,39 +2,40 @@ Terminal.Gui provides a rich system for how [View](View.md) users can scroll content with the keyboard and/or mouse. +## See Also + +- [View Deep Dive](View.md) +- [Layout](layout.md) +- [Arrangement](arrangement.md) + ## Lexicon & Taxonomy -See [View Deep Dive](View.md) for broader definitions. - -* *Scroll* (Verb) - The act of causing content to move either horizontally or vertically within the @Terminal.Gui.View.Viewport. Also referred to as "Content Scrolling". -* *ScrollSlider* - A visual indicator that shows the proportion of the scrollable content to the size of the @Terminal.Gui.View.Viewport and allows the user to use the mouse to scroll. -* *[ScrollBar](~/api/Terminal.Gui.ScrollBar.yml)* - Indicates the size of scrollable content and controls the position of the visible content, either vertically or horizontally. At each end, a @Terminal.Gui.Button is provided, one to scroll up or left and one to scroll down or right. Between the - buttons is a @Terminal.Gui.ScrollSlider that can be dragged to control the position of the visible content. The ScrollSlider is sized to show the proportion of the scrollable content to the size of the @Terminal.Gui.View.Viewport. +[!INCLUDE [Scrolling Lexicon](./../includes/scrolling-lexicon.md)] ## Overview -The ability to scroll content is built into View. The @Terminal.Gui.View.Viewport represents the scrollable "viewport" into the View's Content Area (which is defined by the return value of @Terminal.Gui.View.GetContentSize ). +The ability to scroll content is built into View. The @Terminal.Gui.ViewBase.View.Viewport represents the scrollable "viewport" into the View's Content Area (which is defined by the return value of @Terminal.Gui.ViewBase.View.GetContentSize ). -By default, [View](~/api/Terminal.Gui.View.yml), includes no bindings for the typical directional keyboard and mouse input and cause the Content Area. +By default, [View](~/api/Terminal.Gui.ViewBase.View.yml), includes no bindings for the typical directional keyboard and mouse input and cause the Content Area. Terminal.Gui also provides the ability show a visual scroll bar that responds to mouse input. This ability is not enabled by default given how precious TUI screen real estate is. Scrolling with the mouse and keyboard are enabled by: -1) Making the @Terminal.Gui.View.Viewport size smaller than the size returned by @Terminal.Gui.View.GetContentSize. -2) Creating key bindings for the appropriate directional keys, and calling @Terminal.Gui.View.ScrollHorizontal(System.Int32) / @Terminal.Gui.View.ScrollVertical(System.Int32) as needed. -3) Subscribing to @Terminal.Gui.View.MouseEvent and calling calling @Terminal.Gui.View.ScrollHorizontal(System.Int32) / @Terminal.Gui.View.ScrollVertical(System.Int32) as needed. -4) Enabling the ScrollBars built into View by making @Terminal.Gui.View.HorizontalScrollBar or @Terminal.Gui.View.VerticalScrollBar visible or by enabling automatic show/hide behavior (seethe @Terminal.Gui.ScrollBar.AutoShow property). +1) Making the @Terminal.Gui.ViewBase.View.Viewport size smaller than the size returned by @Terminal.Gui.ViewBase.View.GetContentSize. +2) Creating key bindings for the appropriate directional keys, and calling @Terminal.Gui.ViewBase.View.ScrollHorizontal(System.Int32) / @Terminal.Gui.ViewBase.View.ScrollVertical(System.Int32) as needed. +3) Subscribing to @Terminal.Gui.ViewBase.View.MouseEvent and calling calling @Terminal.Gui.ViewBase.View.ScrollHorizontal(System.Int32) / @Terminal.Gui.ViewBase.View.ScrollVertical(System.Int32) as needed. +4) Enabling the ScrollBars built into View by making @Terminal.Gui.ViewBase.View.HorizontalScrollBar or @Terminal.Gui.ViewBase.View.VerticalScrollBar visible or by enabling automatic show/hide behavior (seethe @Terminal.Gui.Views.ScrollBar.AutoShow property). -While @Terminal.Gui.ScrollBar can be used in a standalone manner to provide proportional scrolling, it is typically enabled automatically via the @Terminal.Gui.View.HorizontalScrollBar and @Terminal.Gui.View.VerticalScrollBar properties. +While @Terminal.Gui.Views.ScrollBar can be used in a standalone manner to provide proportional scrolling, it is typically enabled automatically via the @Terminal.Gui.ViewBase.View.HorizontalScrollBar and @Terminal.Gui.ViewBase.View.VerticalScrollBar properties. ## Examples -These Scenarios illustrate Terminal.Gui scrolling: +These `UI Catalog` Scenarios illustrate Terminal.Gui scrolling: -* *Scrolling* - Demonstrates the @Terminal.Gui.ScrollBar objects built into-View. -* *ScrollBar Demo* - Demonstrates using @Terminal.Gui.ScrollBar view in a standalone manner. -* *ViewportSettings* - Demonstrates the various @Terminal.Gui.ViewportSettings (see below) in an interactive manner. Used by the development team to visually verify that convoluted View layout and arrangement scenarios scroll properly. +* *Scrolling* - Demonstrates the @Terminal.Gui.Views.ScrollBar objects built into-View. +* *ScrollBar Demo* - Demonstrates using @Terminal.Gui.Views.ScrollBar view in a standalone manner. +* *ViewportSettings* - Demonstrates the various @Terminal.Gui.ViewBase.ViewportSettingsFlags (see below) in an interactive manner. Used by the development team to visually verify that convoluted View layout and arrangement scenarios scroll properly. * *Character Map* - Demonstrates a sophisticated scrolling use-case. The entire set of Unicode code-points can be scrolled and searched. From a scrolling perspective, this Scenario illustrates how to manually configure Viewport, Content Area, and Viewport Settings to enable horizontal and vertical headers (as might appear in a spreadsheet), full keyboard and mouse support, and more. * *ListView* and *HexEdit* - The source code to these built-in Views are good references for how to support scrolling and ScrollBars in a re-usable View sub-class. @@ -44,9 +45,11 @@ Use @Terminal.Gui.ViewportSettings to adjust the behavior of scrolling. * `AllowNegativeX/Y` - If set, Viewport.Size can be set to negative coordinates enabling scrolling beyond the top-left of the content area. -* `AllowX/YGreaterThanContentWidth` - If set, @Terminal.Gui.View.Viewport `.Size` can be set to values greater than @Terminal.Gui.View.GetContentSize enabling scrolling beyond the bottom-right of the Content Area. When not set, @Terminal.Gui.View.Viewport `.Location` is constrained to the dimension of the content area - 1. This means the last column of the content will remain visible even if there is an attempt to scroll the Viewport past the last column. The practical effect of this is that the last column/row of the content will always be visible. +* `AllowX/YGreaterThanContentWidth` - If set, @Terminal.Gui.ViewBase.View.Viewport `.Size` can be set to values greater than @Terminal.Gui.ViewBase.View.GetContentSize enabling scrolling beyond the bottom-right of the Content Area. When not set, @Terminal.Gui.ViewBase.View.Viewport `.Location` is constrained to the dimension of the content area - 1. -* `ClipContentOnly` - By default, clipping is applied to @Terminal.Gui.View.Viewport. Setting this flag will cause clipping to be applied to the visible content area. + This means the last column of the content will remain visible even if there is an attempt to scroll the Viewport past the last column. The practical effect of this is that the last column/row of the content will always be visible. -* `ClearContentOnly`- If set @Terminal.Gui.View.ClearViewport will clear only the portion of the content area that is visible within the Viewport. This is useful for views that have a content area larger than the Viewport and want the area outside the content to be visually distinct. +* `ClipContentOnly` - By default, clipping is applied to @Terminal.Gui.ViewBase.View.Viewport. Setting this flag will cause clipping to be applied to the visible content area. + +* `ClearContentOnly`- If set @Terminal.Gui.ViewBase.View.ClearViewport will clear only the portion of the content area that is visible within the Viewport. This is useful for views that have a content area larger than the Viewport and want the area outside the content to be visually distinct. diff --git a/docfx/docs/tableview.md b/docfx/docs/tableview.md index 3af87e25c..1857a44a2 100644 --- a/docfx/docs/tableview.md +++ b/docfx/docs/tableview.md @@ -4,7 +4,7 @@ This control supports viewing and editing tabular data. It provides a view of a System.DataTable is a core class of .net standard and can be created very easily -[TableView API Reference](~/api/Terminal.Gui.TableView.yml) +[TableView API Reference](~/api/Terminal.Gui.Views.TableView.yml) ## Csv Example @@ -78,7 +78,7 @@ TableView supports any size of table. You can have thousands of columns and/or m Horizontal and vertical scrolling can be done using the mouse or keyboard. TableView uses `ColumnOffset` and `RowOffset` to determine the first visible cell of the `System.DataTable`. -Rendering then continues until the avaialble console space is exhausted. Updating the `ColumnOffset` and +Rendering then continues until the available console space is exhausted. Updating the `ColumnOffset` and `RowOffset` changes which part of the table is rendered (scrolls the viewport). This approach ensures that no matter how big the table, only a small number of columns/rows need to be diff --git a/docfx/docs/toc.yml b/docfx/docs/toc.yml index 07a1d8e28..838e9fc9a 100644 --- a/docfx/docs/toc.yml +++ b/docfx/docs/toc.yml @@ -24,6 +24,8 @@ href: drivers.md - name: Events Deep Dive href: events.md +- name: Lexicon & Taxonomy + href: lexicon.md - name: Keyboard href: keyboard.md - name: Layout Engine diff --git a/docfx/docs/treeview.md b/docfx/docs/treeview.md index 2525084ef..2b1344b60 100644 --- a/docfx/docs/treeview.md +++ b/docfx/docs/treeview.md @@ -2,7 +2,7 @@ TreeView is a control for navigating hierarchical objects. It comes in two forms `TreeView` and `TreeView`. -[TreeView API Reference](~/api/Terminal.Gui.TreeView.yml) +[TreeView API Reference](~/api/Terminal.Gui.Views.TreeView.yml) ## Using TreeView diff --git a/docfx/docs/views.md b/docfx/docs/views.md index 668f13230..85fb126db 100644 --- a/docfx/docs/views.md +++ b/docfx/docs/views.md @@ -1,30 +1,757 @@ -*Terminal.Gui* provides a rich set of views and controls for building terminal user interfaces: + +# Terminal Gui's Built-in Views + +*Terminal.Gui* provides the following set of built-in views and controls for building terminal user interfaces: + + +## [Bar](~/api/Terminal.Gui.Views.Bar.yml) + +Provides a horizontally or vertically oriented container for [Shortcut](~/api/Terminal.Gui.Views.Shortcut.yml)s to be used as a menu, toolbar, or status bar. + +```text +Quit Quit Ctrl+Z Help Help Text F1 ☐ Check +``` + +## [Button](~/api/Terminal.Gui.Views.Button.yml) + +A button View that can be pressed with the mouse or keyboard. + +```text +⟦ Button ⟧ +``` + +## [CharMap](~/api/Terminal.Gui.Views.CharMap.yml) + +A scrollable map of the Unicode codepoints. + +```text +0 1 2 3 4 5 6 7 8 9 a b c d +U+00000_ ▲ +U+00001_ █ +U+00002_ ! " # $ % & ' ( ) * + , -░ +U+00003_ 0 1 2 3 4 5 6 7 8 9 : ; < =░ +U+00004_ @ A B C D E F G H I J K L M░ +U+00005_ P Q R S T U V W X Y Z [ \ ]░ +U+00006_ ` a b c d e f g h i j k l m░ +U+00007_ p q r s t u v w x y z { | }░ +U+00008_ ░ +U+00009_ ░ +U+0000a_   ¡ ¢ £ ¤ ¥ ¦ § ¨ © ª « ¬ ­░ +U+0000b_ ° ± ² ³ ´ µ ¶ · ¸ ¹ º » ¼ ½░ +U+0000c_ À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í░ +U+0000d_ Ð Ñ Ò Ó Ô Õ Ö × Ø Ù Ú Û Ü Ý░ +U+0000e_ à á â ã ä å æ ç è é ê ë ì í░ +U+0000f_ ð ñ ò ó ô õ ö ÷ ø ù ú û ü ý░ +U+00010_ Ā ā Ă ă Ą ą Ć ć Ĉ ĉ Ċ ċ Č č░ +U+00011_ Đ đ Ē ē Ĕ ĕ Ė ė Ę ę Ě ě Ĝ ĝ▼ + ◄█████████████████████████████████░░░░░░► +``` + +## [CheckBox](~/api/Terminal.Gui.Views.CheckBox.yml) + +Shows a checkbox that can be cycled between two or three states. + +```text +☐ Demo Title +``` + +## [ColorPicker](~/api/Terminal.Gui.Views.ColorPicker.yml) + +Color Picker supporting RGB, HSL, and HSV color models. Supports choosing colors with sliders and color names from the [IColorNameResolver](~/api/Terminal.Gui.Drawing.IColorNameResolver.yml). + +```text +H: ▲355 +S: ▲ 70 +V: ▲ 91 +Hex:#E74856 ■ +``` + +## [ColorPicker16](~/api/Terminal.Gui.Views.ColorPicker16.yml) + +A sinple color picker that supports the legacy 16 ANSI colors + +```text +┌┄┄┐ +└┄┄┘ +``` + +## [ComboBox](~/api/Terminal.Gui.Views.ComboBox.yml) + +Provides a drop-down list of items the user can select from. + +```text +▼ +``` + +## [DateField](~/api/Terminal.Gui.Views.DateField.yml) + +Provides date editing functionality with mouse support. + +```text +01/01/0001 +``` + +## [DatePicker](~/api/Terminal.Gui.Views.DatePicker.yml) + +Lets the user pick a date from a visual calendar. + +```text +┌┤Demo Title├────────────────┐ +│Date: 05/31/2025 │ +│┌───┬───┬───┬───┬───┬───┬──┐│ +││Sun│Mon│Tue│Wed│Thu│Fri│Sa││ +│├───┼───┼───┼───┼───┼───┼──┤│ +││- │- │- │- │1 │2 │3 ││ +││4 │5 │6 │7 │8 │9 │10││ +││11 │12 │13 │14 │15 │16 │17││ +││18 │19 │20 │21 │22 │23 │24││ +││25 │26 │27 │28 │29 │30 │31││ +││- │- │- │- │- │- │- ││ +│└───┴───┴───┴───┴───┴───┴──┘│ +│ ◄◄ ►► │ +└────────────────────────────┘ +``` + +## [Dialog](~/api/Terminal.Gui.Views.Dialog.yml) + +A [Toplevel.Modal](~/api/Terminal.Gui.Views.Toplevel.Modal.yml) [Window](~/api/Terminal.Gui.Views.Window.yml). Supports a simple API for adding [Button](~/api/Terminal.Gui.Views.Button.yml)s across the bottom. By default, the [Dialog](~/api/Terminal.Gui.Views.Dialog.yml) is centered and used the [Schemes.Dialog](~/api/Terminal.Gui.Drawing.Schemes.Dialog.yml) scheme. + +```text +┏┥Demo Title┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃Demo Text ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┃ ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +``` + +## [FileDialog](~/api/Terminal.Gui.Views.FileDialog.yml) + +The base-class for [OpenDialog](~/api/Terminal.Gui.Views.OpenDialog.yml) and [SaveDialog](~/api/Terminal.Gui.Views.SaveDialog.yml) + +```text +┏┥Open┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃C:\Users\Tig\s\gui-cs\Terminal.Gui\doc┃ +┃⟦▲⟧ ┃ +┃┌────────────────────┬───────────────┐┃ +┃│Filename (▲) │Size │┃ +┃├────────────────────┼───────────────►┃ +┃│.. │ │┃ +┃│\_exported_templates│ │┃ +┃│\_site │ │┃ +┃│\api │ │┃ +┃│\docs │ │┃ +┃│\images │ │┃ +┃│\schemas │ │┃ +┃│\scripts │ │┃ +┃⟦ ►► ⟧ Enter Search⟦► OK ◄⟧ ⟦ Cancel ⟧┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +``` + +## [FlagSelector](~/api/Terminal.Gui.Views.FlagSelector.yml) + +Provides a user interface for displaying and selecting non-mutually-exclusive flags. Flags can be set from a dictionary or directly from an enum type. + +```text +☒ No Style +☐ Show None Value Style +☐ Show Value Editor Style +☐ All Styles +0 +``` + +## [FlagSelector\](~/api/Terminal.Gui.Views.FlagSelector-1.yml) + +Provides a user interface for displaying and selecting non-mutually-exclusive flags. Flags can be set from a dictionary or directly from an enum type. + + + +## [FrameView](~/api/Terminal.Gui.Views.FrameView.yml) + +A non-overlapped container for other views with a border and optional title. + +```text +╭┤Demo Title├────────────────────────────────────╮ +│Demo Text │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +╰────────────────────────────────────────────────╯ +``` + +## [GraphView](~/api/Terminal.Gui.Views.GraphView.yml) + +Displays graphs (bar, scatter, etc.) with flexible labels, scaling, and scrolling + +```text +│ . + │ .. + 0.60┤ . + ┤ ∙ + │ . + │ .. + 0.20┤. + ┬────┬────┬────┬────┬────∙────┬────┬────┬────┬─ + -2.50 -1.50 -0.50 .│ 0.50 1.50 +↑ . │ +Y -0.20┤ +.. . │ + . ∙ ┤ + ∙ . │ + . .. -0.60┤ + .. . │ + . ..∙ ┤ + ∙....∙.. -1.00┤ + + X → +``` + +## [HexView](~/api/Terminal.Gui.Views.HexView.yml) + +Provides a hex editor with the left side showing the hex values of the bytes in a `Stream` and the right side showing the contents (filtered to printable Unicode glyphs). + +```text +00000000 48 65 78 56 ┊ 69 65 77 20 HexView +00000008 64 61 74 61 ┊ 20 77 69 74 data wit +00000010 68 20 77 69 ┊ 64 65 20 63 h wide c +00000018 6f 64 65 70 ┊ 6f 69 6e 74 odepoint +00000020 73 3a 20 f0 ┊ 9d 94 b9 41 s: ����A +00000028 e2 84 9d f0 ┊ 9d 94 bd 21 �������! +00000030 ┊ +00000038 ┊ +00000040 ┊ +00000048 ┊ +00000050 ┊ +00000058 ┊ +00000060 ┊ +00000068 ┊ +00000070 ┊ +00000078 ┊ +00000080 ┊ +00000088 ┊ +00000090 ┊ +00000098 ┊ +``` + +## [Label](~/api/Terminal.Gui.Views.Label.yml) + +Displays text that describes the View next in the [View.SubViews](~/api/Terminal.Gui.ViewBase.View.SubViews.yml). When the user presses a hotkey that matches the [View.HotKey](~/api/Terminal.Gui.ViewBase.View.HotKey.yml) of the Label, the next [View](~/api/Terminal.Gui.ViewBase.View.yml) in [View.SubViews](~/api/Terminal.Gui.ViewBase.View.SubViews.yml) will be activated. + +```text +Label +``` + +## [LegendAnnotation](~/api/Terminal.Gui.Views.LegendAnnotation.yml) + +Used by [GraphView](~/api/Terminal.Gui.Views.GraphView.yml) to render smbol definitions in a graph, e.g. colors and their meanings + +```text +┌┤Demo Title├────────────────────────────────────┐ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +└────────────────────────────────────────────────┘ +``` + +## [Line](~/api/Terminal.Gui.Views.Line.yml) + +Draws a single line using the [LineStyle](~/api/Terminal.Gui.Drawing.LineStyle.yml) specified by [View.BorderStyle](~/api/Terminal.Gui.ViewBase.View.BorderStyle.yml). + +```text +────────────────────────────────────────────────── +``` + +## [LineView](~/api/Terminal.Gui.Views.LineView.yml) + +A straight line control either horizontal or vertical + +```text +────────────────────────────────────────────────── +``` + +## [ListView](~/api/Terminal.Gui.Views.ListView.yml) + +Provides a scrollable list of data where each item can be activated to perform an action. + +```text +List Item 1 +List Item two +List Item Quattro +Last List Item +``` + +## [MenuBar](~/api/Terminal.Gui.Views.MenuBar.yml) + +Provides a menu bar that spans the top of a [Toplevel](~/api/Terminal.Gui.Views.Toplevel.yml) View with drop-down and cascading menus. By default, any sub-sub-menus (sub-menus of the [MenuItem](~/api/Terminal.Gui.Views.MenuItem.yml)s added to [MenuBarItem](~/api/Terminal.Gui.Views.MenuBarItem.yml)s) are displayed in a cascading manner, where each sub-sub-menu pops out of the sub-menu frame (either to the right or left, depending on where the sub-menu is relative to the edge of the screen). By setting [MenuBar.UseSubMenusSingleFrame](~/api/Terminal.Gui.Views.MenuBar.UseSubMenusSingleFrame.yml) to true, this behavior can be changed such that all sub-sub-menus are drawn within a single frame below the MenuBar. + +```text +File Edit About (Top-Level) +``` + +## [MenuBarItemv2](~/api/Terminal.Gui.Views.MenuBarItemv2.yml) + +A [Shortcut](~/api/Terminal.Gui.Views.Shortcut.yml)-derived object to be used as items in a [MenuBarv2](~/api/Terminal.Gui.Views.MenuBarv2.yml). MenuBarItems hold a [MenuBarItemv2.PopoverMenu](~/api/Terminal.Gui.Views.MenuBarItemv2.PopoverMenu.yml) instead of a [MenuBarItemv2.SubMenu](~/api/Terminal.Gui.Views.MenuBarItemv2.SubMenu.yml). + +```text +Shortcut Shortcut help F1 +``` + +## [MenuBarv2](~/api/Terminal.Gui.Views.MenuBarv2.yml) + +A horizontal list of [MenuBarItemv2](~/api/Terminal.Gui.Views.MenuBarItemv2.yml)s. Each [MenuBarItemv2](~/api/Terminal.Gui.Views.MenuBarItemv2.yml) can have a [PopoverMenu](~/api/Terminal.Gui.Views.PopoverMenu.yml) that is shown when the [MenuBarItemv2](~/api/Terminal.Gui.Views.MenuBarItemv2.yml) is selected. + +```text +File Edit Help +``` + +## [MenuItemv2](~/api/Terminal.Gui.Views.MenuItemv2.yml) + +A [Shortcut](~/api/Terminal.Gui.Views.Shortcut.yml)-derived object to be used as a menu item in a [Menuv2](~/api/Terminal.Gui.Views.Menuv2.yml). Has title, an A [Shortcut](~/api/Terminal.Gui.Views.Shortcut.yml)-derived object to be used as a menu item in a [Menuv2](~/api/Terminal.Gui.Views.Menuv2.yml). Has title, an associated help text, and an action to execute on activation. + +```text +Shortcut Shortcut help F1 +``` + +## [Menuv2](~/api/Terminal.Gui.Views.Menuv2.yml) + +A [Bar](~/api/Terminal.Gui.Views.Bar.yml)-derived object to be used as a vertically-oriented menu. Each subview is a [MenuItemv2](~/api/Terminal.Gui.Views.MenuItemv2.yml). + +```text +┌─────────────────────────┐ +│ Quit Quit Ctrl+Z │ +│ Help Help Text F1 │ +│ ☐ Check Czech F9 │ +└─────────────────────────┘ +``` + +## [NumericUpDown](~/api/Terminal.Gui.Views.NumericUpDown.yml) + +Enables the user to increase or decrease an int by clicking on the up or down buttons. + +```text +▼0▲ +``` + +## [NumericUpDown\](~/api/Terminal.Gui.Views.NumericUpDown-1.yml) + +Enables the user to increase or decrease a value with the mouse or keyboard in type-safe way. + + + +## [OpenDialog](~/api/Terminal.Gui.Views.OpenDialog.yml) + +Provides an interactive [Dialog](~/api/Terminal.Gui.Views.Dialog.yml) for selecting files or directories for opening + +```text +┏┥Open┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃C:\Users\Tig\s\gui-cs\Terminal.Gui\doc┃ +┃⟦▲⟧ ┃ +┃┌────────────────────┬───────────────┐┃ +┃│Filename (▲) │Size │┃ +┃├────────────────────┼───────────────►┃ +┃│.. │ │┃ +┃│\_exported_templates│ │┃ +┃│\_site │ │┃ +┃│\api │ │┃ +┃│\docs │ │┃ +┃│\images │ │┃ +┃│\schemas │ │┃ +┃│\scripts │ │┃ +┃⟦ ►► ⟧ Enter Search⟦► OK ◄⟧ ⟦ Cancel ⟧┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +``` + +## [OptionSelector](~/api/Terminal.Gui.Views.OptionSelector.yml) + +Provides a user interface for displaying and selecting a single item from a list of options. Each option is represented by a checkbox, but only one can be selected at a time. + +```text +○ Option 1 +○ Option 2 +○ Third Option +○ Option Quattro +``` + +## [PopoverMenu](~/api/Terminal.Gui.Views.PopoverMenu.yml) + +Provides a cascading menu that pops over all other content. Can be used as a context menu or a drop-down all other content. Can be used as a context menu or a drop-down menu as part of [MenuBarv2](~/api/Terminal.Gui.Views.MenuBarv2.yml) as part of [MenuBarv2](~/api/Terminal.Gui.Views.MenuBarv2.yml). + + + +## [ProgressBar](~/api/Terminal.Gui.Views.ProgressBar.yml) + +A Progress Bar view that can indicate progress of an activity visually. + +```text +▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌ +``` + +## [RadioGroup](~/api/Terminal.Gui.Views.RadioGroup.yml) + +Displays a list of mutually-exclusive items. Each items can have its own hotkey. + +```text +◉ Option 1 +○ Option 2 +○ Option 3 +``` + +## [SaveDialog](~/api/Terminal.Gui.Views.SaveDialog.yml) + +Provides an interactive [Dialog](~/api/Terminal.Gui.Views.Dialog.yml) for selecting files or directories for saving + +```text +┏┥Save┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃C:\Users\Tig\s\gui-cs\Terminal.Gui\doc┃ +┃⟦▲⟧ ┃ +┃┌────────────────────┬───────────────┐┃ +┃│Filename (▲) │Size │┃ +┃├────────────────────┼───────────────►┃ +┃│.. │ │┃ +┃│\_exported_templates│ │┃ +┃│\_site │ │┃ +┃│\api │ │┃ +┃│\docs │ │┃ +┃│\images │ │┃ +┃│\schemas │ │┃ +┃│\scripts │ │┃ +┃⟦ ►► ⟧ Enter Sear⟦► Save ◄⟧ ⟦ Cancel ⟧┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +``` + +## [ScrollBar](~/api/Terminal.Gui.Views.ScrollBar.yml) + +Indicates the size of scrollable content and controls the position of the visible content, either vertically or horizontally. Two [Button](~/api/Terminal.Gui.Views.Button.yml)s are provided, one to scroll up or left and one to scroll down or right. Between the buttons is a [ScrollSlider](~/api/Terminal.Gui.Views.ScrollSlider.yml) that can be dragged to control the position of the visible content. The ScrollSlier is sized to show the proportion of the scrollable content to the size of the [View.Viewport](~/api/Terminal.Gui.ViewBase.View.Viewport.yml). + +```text +▲ +█ +░ +░ +░ +░ +░ +░ +░ +░ +░ +░ +░ +░ +░ +░ +░ +░ +░ +▼ +``` + +## [ScrollSlider](~/api/Terminal.Gui.Views.ScrollSlider.yml) + +Represents the proportion of the visible content to the Viewport in a [ScrollBar](~/api/Terminal.Gui.Views.ScrollBar.yml). Can be dragged with the mouse, constrained by the size of the Viewport of it's superview. Can be oriented either vertically or horizontally. + +```text +██████████████████████████████████████████████████ +██████████████████████████████████████████████████ +██████████████████████████████████████████████████ +██████████████████████████████████████████████████ +██████████████████████████████████████████████████ +``` + +## [Shortcut](~/api/Terminal.Gui.Views.Shortcut.yml) + +Displays a command, help text, and a key binding. When the key specified by [Shortcut.Key](~/api/Terminal.Gui.Views.Shortcut.Key.yml) is pressed, the command will be invoked. Useful for displaying a command in [Bar](~/api/Terminal.Gui.Views.Bar.yml) such as a menu, toolbar, or status bar. + +```text +Shortcut Shortcut help F1 +``` + +## [Slider](~/api/Terminal.Gui.Views.Slider.yml) + +Provides a slider control letting the user navigate from a set of typed options in a linear manner using the keyboard or mouse. + +```text +● +Demo Text +``` + +## [Slider\](~/api/Terminal.Gui.Views.Slider-1.yml) + +Provides a tpe-safe slider control letting the user navigate from a set of typed options in a linear manner using the keyboard or mouse. + + + +## [SpinnerView](~/api/Terminal.Gui.Views.SpinnerView.yml) + +Displays a spinning glyph or combinations of glyphs to indicate progress or activity + +```text +●∙∙ +``` + +## [StatusBar](~/api/Terminal.Gui.Views.StatusBar.yml) + +A status bar is a [View](~/api/Terminal.Gui.ViewBase.View.yml) that snaps to the bottom of a [Toplevel](~/api/Terminal.Gui.Views.Toplevel.yml) displaying set of [Shortcut](~/api/Terminal.Gui.Views.Shortcut.yml)s. The [StatusBar](~/api/Terminal.Gui.Views.StatusBar.yml) should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a status bar. + +```text +Ctrl+Z Quit Quit │ F1 Help Text Help │ F10 ☐ +``` + +## [Tab](~/api/Terminal.Gui.Views.Tab.yml) + +A single tab in a [TabView](~/api/Terminal.Gui.Views.TabView.yml). + +```text +╭┤Demo Title├────────────────────────────────────╮ +│Demo Text │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +╰────────────────────────────────────────────────╯ +``` + +## [TableView](~/api/Terminal.Gui.Views.TableView.yml) + +Displays and enables infinite scrolling through tabular data based on a [ITableSource](~/api/Terminal.Gui.Views.ITableSource.yml). See the TableView Deep Dive for more. + +```text +┌──────────────────┬──────────────────────┬──────┐ +│StrCol │DateCol │IntCol│ +├──────────────────┼──────────────────────┼──────► +│Demo text in row 0│12/25/2000 12:00:00 AM│0 │ +│Demo text in row 1│12/25/2001 12:00:00 AM│0 │ +│Demo text in row 2│12/25/2002 12:00:00 AM│0 │ +│Demo text in row 3│12/25/2003 12:00:00 AM│2 │ +│Demo text in row 4│12/25/2004 12:00:00 AM│1 │ +``` + +## [TabView](~/api/Terminal.Gui.Views.TabView.yml) + +Control that hosts multiple sub views, presenting a single one at once. + +```text +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +└────────────────────────────────────────────────┘ +``` + +## [TextField](~/api/Terminal.Gui.Views.TextField.yml) + +Single-line text editor. + +```text +This is a test. +``` + +## [TextValidateField](~/api/Terminal.Gui.Views.TextValidateField.yml) + +Masked text editor that validates input through a [ITextValidateProvider](~/api/Terminal.Gui.Views.ITextValidateProvider.yml) + +```text +┌┤^([0-9]?[0-9]?[0-9]|1000)$├────────────────────┐ +│999 │ +└────────────────────────────────────────────────┘ +``` + +## [TextView](~/api/Terminal.Gui.Views.TextView.yml) + +Fully featured multi-line text editor + +```text +TextView provides a fully featured multi-line text +It supports word wrap and history for undo. +``` + +## [TileView](~/api/Terminal.Gui.Views.TileView.yml) + +A [View](~/api/Terminal.Gui.ViewBase.View.yml) consisting of a moveable bar that divides the display area into resizeable [TileView.Tiles](~/api/Terminal.Gui.Views.TileView.Tiles.yml). + +```text +│ + │ + │ + │ + │ + │ + │ + │ + │ + │ + │ + │ + │ + │ + │ + │ + │ + │ + │ + │ +``` + +## [TimeField](~/api/Terminal.Gui.Views.TimeField.yml) + +Provides time editing functionality with mouse support + +```text +02:48:05 +``` + +## [Toplevel](~/api/Terminal.Gui.Views.Toplevel.yml) + +Toplevel views are used for both an application's main view (filling the entire screen and for modal (pop-up) views such as [Dialog](~/api/Terminal.Gui.Views.Dialog.yml), [MessageBox](~/api/Terminal.Gui.Views.MessageBox.yml), and [Wizard](~/api/Terminal.Gui.Views.Wizard.yml)). + +```text +Demo Text +``` + +## [TreeView](~/api/Terminal.Gui.Views.TreeView.yml) + +Convenience implementation of generic [TreeView%601](~/api/Terminal.Gui.Views.TreeView%601.yml) for any tree were all nodes implement [ITreeNode](~/api/Terminal.Gui.Views.ITreeNode.yml). See TreeView Deep Dive for more information. + +```text +├-Root1 +│ ├─Child1.1 +│ └─Child1.2 +└-Root2 + ├─Child2.1 + └─Child2.2 +``` + +## [TreeView\](~/api/Terminal.Gui.Views.TreeView-1.yml) + +Hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined [ITreeBuilder%601](~/api/Terminal.Gui.Views.ITreeBuilder%601.yml). See TreeView Deep Dive for more information. + + + +## [Window](~/api/Terminal.Gui.Views.Window.yml) + +An overlapped container for other views with a border and optional title. + +```text +┌┤Demo Title├────────────────────────────────────┐ +│Demo Text │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +└────────────────────────────────────────────────┘ +``` + +## [Wizard](~/api/Terminal.Gui.Views.Wizard.yml) + +Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step ( [WizardStep](~/api/Terminal.Gui.Views.WizardStep.yml)) can host arbitrary [View](~/api/Terminal.Gui.ViewBase.View.yml)s, much like a [Dialog](~/api/Terminal.Gui.Views.Dialog.yml). Each step also has a pane for help text. Along the bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard. + +```text +╔╡Demo Title╞════════════════════════════╗ +║Demo Text ║ +║ ║ +║ ║ +║ ║ +║ ║ +║ ║ +║ ║ +║ ║ +║ ║ +║ ║ +║ ║ +║ ║ +║ ║ +║ ║ +║────────────────────────────────────────║ +║⟦ Back ⟧ ⟦► Finish ◄⟧║ +╚════════════════════════════════════════╝ +``` + +## [WizardStep](~/api/Terminal.Gui.Views.WizardStep.yml) + +Represents a basic step that is displayed in a [Wizard](~/api/Terminal.Gui.Views.Wizard.yml). The [WizardStep](~/api/Terminal.Gui.Views.WizardStep.yml) view is divided horizontally in two. On the left is the content view where [View](~/api/Terminal.Gui.ViewBase.View.yml)s can be added, On the right is the help for the step. Set [WizardStep.HelpText](~/api/Terminal.Gui.Views.WizardStep.HelpText.yml) to set the help text. If the help text is empty the help pane will not be shown. If there are no Views added to the WizardStep the [WizardStep.HelpText](~/api/Terminal.Gui.Views.WizardStep.HelpText.yml) (if not empty) will fill the wizard step. + -* [Button](~/api/Terminal.Gui.Button.yml) - A View that provides an item that invokes an System.Action when activated by the user. -* [CheckBox](~/api/Terminal.Gui.CheckBox.yml) - Shows an on/off toggle that the user can set. -* [ColorPicker](~/api/Terminal.Gui.ColorPicker.yml) - Enables to user to pick a color. -* [ComboBox](~/api/Terminal.Gui.ComboBox.yml) - Provides a drop-down list of items the user can select from. -* [Dialog](~/api/Terminal.Gui.Dialog.yml) - A pop-up Window that contains one or more Buttons. - * [OpenDialog](~/api/Terminal.Gui.OpenDialog.yml) - A Dialog providing an interactive pop-up Window for users to select files or directories. - * [SaveDialog](~/api/Terminal.Gui.SaveDialog.yml) - A Dialog providing an interactive pop-up Window for users to save files. -* [FrameView](~/api/Terminal.Gui.FrameView.yml) - A container View that draws a frame around its contents. Similar to a GroupBox in Windows. -* [GraphView](~/api/Terminal.Gui.GraphView.yml) - A View for rendering graphs (bar, scatter etc). -* [Hex viewer/editor](~/api/Terminal.Gui.HexView.yml) - A hex viewer and editor that operates over a file stream. -* [Label](~/api/Terminal.Gui.Label.yml) - Displays a string at a given position and supports multiple lines. -* [ListView](~/api/Terminal.Gui.ListView.yml) - Displays a scrollable list of data where each item can be activated to perform an action. -* [MenuBar](~/api/Terminal.Gui.MenuBar.yml) - Provides a menu bar with drop-down and cascading menus. -* [MessageBox](~/api/Terminal.Gui.MessageBox.yml) - Displays a modal (pup-up) message to the user, with a title, a message and a series of options that the user can choose from. -* [ProgressBar](~/api/Terminal.Gui.ProgressBar.yml) - Displays a progress Bar indicating progress of an activity. -* [RadioGroup](~/api/Terminal.Gui.RadioGroup.yml) - Displays a group of labels each with a selected indicator. Only one of those can be selected at a given time -* [ScrollBarView](~/api/Terminal.Gui.ScrollBar.yml) - A scrollbar, either horizontal or vertical. -* [StatusBar](~/api/Terminal.Gui.StatusBar.yml) - A View that snaps to the bottom of a Toplevel displaying set of status items. Includes support for global app keyboard shortcuts. -* [TableView](~/api/Terminal.Gui.TableView.yml) - A View for tabular data based on a System.Data.DataTable. -* [TimeField](~/api/Terminal.Gui.TimeField.yml) & [DateField](~/api/Terminal.Gui.TimeField.yml) - Enables structured editing of dates and times. -* [TextField](~/api/Terminal.Gui.TextField.yml) - Provides a single-line text entry. -* [TextValidateField](~/api/Terminal.Gui.TextValidateField.yml) - Text field that validates input through a ITextValidateProvider. -* [TextView](~/api/Terminal.Gui.TextView.yml)- A multi-line text editing View supporting word-wrap, auto-complete, context menus, undo/redo, and clipboard operations, -* [TopLevel](~/api/Terminal.Gui.Toplevel.yml) - The base class for modal/pop-up Windows. -* [TreeView](~/api/Terminal.Gui.TreeView.yml) - A hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder. -* [View](~/api/Terminal.Gui.View.yml) - The base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views. -* [Window](~/api/Terminal.Gui.Window.yml) - A Toplevel view that draws a border around its Frame with a title at the top. -* [Wizard](~/api/Terminal.Gui.Wizard.yml) - Provides navigation and a user interface to collect related data across multiple steps. diff --git a/docfx/images/logo.png b/docfx/images/logo.png index f61497939..751b62aa7 100644 Binary files a/docfx/images/logo.png and b/docfx/images/logo.png differ diff --git a/docfx/images/logo48.png b/docfx/images/logo48.png index 102f68861..18c26383e 100644 Binary files a/docfx/images/logo48.png and b/docfx/images/logo48.png differ diff --git a/docfx/images/sample.gif b/docfx/images/sample.gif index ea82d9096..524a2cab3 100644 Binary files a/docfx/images/sample.gif and b/docfx/images/sample.gif differ diff --git a/docfx/includes/arrangement-lexicon.md b/docfx/includes/arrangement-lexicon.md new file mode 100644 index 000000000..2633e1818 --- /dev/null +++ b/docfx/includes/arrangement-lexicon.md @@ -0,0 +1,10 @@ +| Term | Meaning | +|:-----|:--------| +| **Arrange Mode** | Interactive mode activated via `Ctrl+F5` that displays indicators on arrangeable views and allows keyboard-based arrangement. | +| **Arrangement** | The feature of [Layout](~/docs/layout.md) which controls how the user can use the mouse and keyboard to arrange views and enables either **Tiled** or **Overlapped** layouts. | +| **Modal** | A view run as an "application" via @Terminal.Gui.App.Application.Run where `Modal == true`. Has constrained z-order with modal view at z-order 1. | +| **Movable** | A View that can be moved by the user using keyboard or mouse. Enabled by setting @Terminal.Gui.ViewBase.ViewArrangement.Movable flag. | +| **Overlapped** | Layout where SubViews have overlapping Frames with Z-order determining visual stacking. Enabled by @Terminal.Gui.ViewBase.ViewArrangement.Overlapped flag. | +| **Resizable** | A View that can be resized by the user using keyboard or mouse. Enabled by setting @Terminal.Gui.ViewBase.ViewArrangement.Resizable flag. | +| **Runnable** | A view where `Application.Run(Toplevel)` is called. Each non-modal Runnable view has its own `RunState` and operates as a self-contained application. | +| **Tiled** | Layout where SubViews typically do not overlap, with no z-order. Default layout mode set to @Terminal.Gui.ViewBase.ViewArrangement.Fixed. | \ No newline at end of file diff --git a/docfx/includes/config-lexicon.md b/docfx/includes/config-lexicon.md new file mode 100644 index 000000000..83b1195bd --- /dev/null +++ b/docfx/includes/config-lexicon.md @@ -0,0 +1,16 @@ +| Term | Meaning | +|:-----|:--------| +| **AppSettings** | Application-specific settings stored in the application's resources. | +| **Apply** | Apply the configuration to the application; copies settings from configuration properties to corresponding `static` `[ConfigProperty]` properties. | +| **ConfigProperty** | A property decorated with `[ConfigProperty]` that can be configured via the configuration system. | +| **Configuration** | A collection of settings defining application behavior and appearance. | +| **ConfigurationManager** | System that loads and manages application runtime settings from external sources. | +| **Load** | Load configuration from given location(s), updating with new values. Loading doesn't apply settings automatically. | +| **Location** | Storage location for configuration (e.g., user's home directory, application directory). | +| **Reset** | Reset configuration to current values or hard-coded defaults. Does not load configuration. | +| **Scope** | Defines the context where configuration applies (Settings, Theme, or AppSettings). | +| **Settings** | Runtime options including both system settings and application-specific settings. | +| **Sources** | Set of locations where configuration can be stored (@Terminal.Gui.Configuration.ConfigLocations enum). | +| **Theme** | Named instance containing specific appearance settings. | +| **ThemeInheritance** | Mechanism where themes can inherit and override settings from other themes. | +| **Themes** | Collection of named Theme definitions bundling visual and layout settings. | diff --git a/docfx/includes/drawing-lexicon.md b/docfx/includes/drawing-lexicon.md new file mode 100644 index 000000000..082c4c5e3 --- /dev/null +++ b/docfx/includes/drawing-lexicon.md @@ -0,0 +1,11 @@ +| Term | Meaning | +|:-----|:--------| +| **Attribute** | Defines concrete visual styling for a visual element (Foreground color, Background color, TextStyle). | +| **BackgroundColor** | A property of `Attribute` describing the background text color. | +| **Color** | Base terminal color (supports TrueColor and named values like White, Black, Cyan, etc.). | +| **ForegroundColor** | A property of `Attribute` describing the foreground text color. | +| **Glyph** | A graphical representation of a character. | +| **Rune** | Unicode character. | +| **Scheme** | Maps `VisualRole` to `Attribute`, defining visual element appearance (color and style) based on semantic purpose. | +| **Style** | Property of `Attribute` for font-like hints (bold, italic, underline). | +| **VisualRole** | Semantic role/purpose of a visual element (Normal, Focus, HotFocus, Active, Disabled, ReadOnly). | \ No newline at end of file diff --git a/docfx/includes/events-lexicon.md b/docfx/includes/events-lexicon.md new file mode 100644 index 000000000..41221df4c --- /dev/null +++ b/docfx/includes/events-lexicon.md @@ -0,0 +1,15 @@ +| Term | Meaning | +|:-----|:--------| +| **Action** | A delegate type that represents a method that can be called with specific parameters but returns no value. Used for simple callbacks in Terminal.Gui. | +| **Cancel/Cancelling/Cancelled** | Applies to scenarios where something can be cancelled. Changing the `Orientation` of a `Slider` is cancelable. | +| **Cancellation** | Mechanisms to halt a phase or workflow in the [Cancellable Work Pattern](~/docs/cancellable-work-pattern.md), such as setting `Cancel`/`Handled` properties in event arguments or returning `bool` from virtual methods. | +| **Command** | A pattern that encapsulates a request as an object, allowing for parameterization and queuing of requests. See [Command Deep Dive](~/docs/command.md). | +| **Context** | Data passed to observers for informed decision-making in the [Cancellable Work Pattern](~/docs/cancellable-work-pattern.md), such as `DrawContext` (drawing), `Key` (keyboard), `ICommandContext` (commands), or `CancelEventArgs` (orientation). | +| **Default Behavior** | A standard implementation for each phase in the [Cancellable Work Pattern](~/docs/cancellable-work-pattern.md), such as `DrawText` (drawing), `InvokeCommands` (keyboard and application-level), `RaiseActivating` (commands), or updating a property (`OrientationHelper`). | +| **Event** | A notification mechanism that allows objects to communicate when something of interest occurs. Terminal.Gui uses events extensively for UI interactions. | +| **Handle/Handling/Handled** | Applies to scenarios where an event can either be handled by an event listener (or override) vs not handled. Events that originate from a user action like mouse moves and key presses are examples. | +| **Invoke** | The act of calling or triggering an event, action, or method. | +| **Listen** | The act of subscribing to or registering for an event to receive notifications when it occurs. | +| **Notifications** | Events (e.g., `DrawingText`, `KeyDown`, `Activating`, `OrientationChanging`) and virtual methods (e.g., `OnDrawingText`, `OnKeyDown`, `OnActivating`, `OnOrientationChanging`) raised at each phase to notify observers in the [Cancellable Work Pattern](~/docs/cancellable-work-pattern.md). | +| **Raise** | The act of triggering an event, notifying all registered event handlers that the event has occurred. | +| **Workflow** | A sequence of phases in the [Cancellable Work Pattern](~/docs/cancellable-work-pattern.md), which may be multi-phase (e.g., rendering in `View.Draw`), linear (e.g., key processing in `View.Keyboard`), per-unit (e.g., command execution in `View.Command`), or event-driven (e.g., key handling in `Application.Keyboard`, property changes in `OrientationHelper`). | \ No newline at end of file diff --git a/docfx/includes/layout-lexicon.md b/docfx/includes/layout-lexicon.md new file mode 100644 index 000000000..3c80d8c17 --- /dev/null +++ b/docfx/includes/layout-lexicon.md @@ -0,0 +1,17 @@ +| Term | Meaning | +|:-----|:--------| +| **Adornment** | The `Thickness`es that separate the `Frame` from the `Viewport`. There are three Adornments: `Margin`, `Padding`, and `Border`. Adornments are not part of the View's content and are not clipped by the View's `ClipArea`. | +| **Application-Relative** | The dimensions and characteristics of the application. Because only full-screen apps are currently supported, @Terminal.Gui.App.Application is effectively the same as `Screen` from a layout perspective. *Application-Relative* currently means an origin (`0, 0`) at the top-left corner of the terminal. @Terminal.Gui.App.Application.Top is a `View` with a top-left corner fixed at the *Application.Relative* coordinate of (`0, 0`) and is the size of `Screen`. | +| **Border** | The `Adornment` that resides in the inside of the `Margin`. The Border is where a visual border (drawn using line-drawing glyphs) and the @Terminal.Gui.ViewBase.View.Title are drawn, and where the user can interact with the mouse/keyboard to adjust the Views' [Arrangement](~/docs/arrangement.md). | +| **Content Area** | Describes the View's total content. The location of the content is always `(0, 0)` and the size is set by @Terminal.Gui.ViewBase.View.SetContentSize* and defaults to the size of the `Viewport`. If the content size is larger than the `Viewport`, scrolling is enabled. | +| **Content-Relative** | A rectangle, with an origin of (`0, 0`) and size, defined by @Terminal.Gui.ViewBase.View.GetContentSize*, where the View's content exists. *Content-Relative* means a coordinate is relative to the top-left corner of the content, which is always (`0,0`). @Terminal.Gui.ViewBase.View.ContentToScreen* and @Terminal.Gui.ViewBase.View.ScreenToContent* are helper methods for translating coordinates. | +| **Frame** | A `Rectangle` that defines the location and size of the @Terminal.Gui.ViewBase.View. The coordinates are relative to the SuperView of the View (or, in the case of `Application.Top`, the console size). Controlled by @Terminal.Gui.ViewBase.View.X, @Terminal.Gui.ViewBase.View.Y, @Terminal.Gui.ViewBase.View.Width, and @Terminal.Gui.ViewBase.View.Height. | +| **Frame-Relative** | The @Terminal.Gui.ViewBase.View.Frame property of a `View` is a rectangle that describes the current location and size of the view relative to the `Superview`'s content area. *Frame-Relative* means a coordinate is relative to the top-left corner of the View in question. @Terminal.Gui.ViewBase.View.FrameToScreen* and @Terminal.Gui.ViewBase.View.ScreenToFrame* are helper methods for translating coordinates. | +| **Margin** | The outermost `Adornment`. The outside of the margin is a rectangle the same size as the `Frame`. By default `Margin` is `{0,0,0,0}`. When made thicker, Margins are visually transparent and transparent to mouse events by default. | +| **Overlapped/Overlapping** | Refers to a form [Layout](~/docs/layout.md) where SubViews of a View are visually arranged such that their Frames overlap. In Overlap view arrangements there is a Z-axis (Z-order) in addition to the X and Y dimension. | +| **Padding** | The `Adornment` resides in the inside of the `Border` and outside of the `Viewport`. `Padding` is `{0, 0, 0, 0}` by default. Padding is not part of the View's content and is not clipped by the View's `Clip`. When enabled, scroll bars reside within `Padding`. | +| **Screen-Relative** | Describes the dimensions and characteristics of the underlying terminal. Currently Terminal.Gui only supports applications that run "full-screen", meaning they fill the entire terminal when running. *Screen-Relative* means an origin (`0, 0`) at the top-left corner of the terminal. @Terminal.Gui.Drivers.ConsoleDriver implementations operate exclusively on *Screen-Relative* coordinates. | +| **Thickness** | A smart `record struct` describing a rectangle where each of the four sides can have a width. Valid width values are >= 0. The inner area of a Thickness is the sum of the widths of the four sides minus the size of the rectangle. | +| **Tiled/Tiling** | Refer to a form of Views that are visually arranged such that they abut each other and do not overlap. In a Tiled view arrangement, Z-ordering only comes into play when a developer intentionally causes views to be aligned such that they overlap. | +| **Viewport** | The `Rectangle` that describes the portion of the View's `Content Area` that is currently visible to the user. If size of the `Content Area` is larger than the `Viewport`, scrolling is enabled and the `Viewport` location determines which portion of the content is visible. | +| **Viewport-Relative** | A *Content-Relative* rectangle representing the subset of the View's content that is visible to the user: @Terminal.Gui.ViewBase.View.Viewport. *Viewport-Relative* means a coordinate that is bound by (`0,0`) and the size of the inner-rectangle of the View's `Padding`. The View drawing primitives (e.g. `View.Move`) take *Viewport-Relative* coordinates. | \ No newline at end of file diff --git a/docfx/includes/navigation-lexicon.md b/docfx/includes/navigation-lexicon.md new file mode 100644 index 000000000..d984d81de --- /dev/null +++ b/docfx/includes/navigation-lexicon.md @@ -0,0 +1,12 @@ +| Term | Meaning | +|:-----|:--------| +| **Cursor** | A visual indicator to the user where keyboard input will have an impact. There is one Cursor per terminal session. See [Cursor](~/docs/cursor.md) for a deep-dive. | +| **Enter** / **Gain** | Means a View that previously was not focused is now becoming focused. "The View is entering focus" is the same as "The View is gaining focus". These terms are legacy terms from v1. | +| **Focus** | The state where a particular UI element (`View`) is actively selected and ready to receive user input. When an element has focus, it typically responds to keyboard events and other interactions. | +| **Focus Chain** | The ordered sequence of UI elements that can receive focus, starting from the currently focused element and extending to its parent (SuperView) elements up to the root of the focus tree (`Application.Top`). Only one focus chain in an application can have focus (`top.HasFocus == true`), and there is one, and only one, View in a focus chain that is the most-focused; the one receiving keyboard input. | +| **Focus Ordering** | The order focusable Views are navigated. Focus Ordering is typically used in UI frameworks to enable screen readers and improve the Accessibility of an application. In v1, `TabIndex`/`TabIndexes` enabled Focus Ordering. | +| **Leave** / **Lose** | Means a View that previously was focused is now becoming un-focused. "The View is leaving focus" is the same as "The View is losing focus". These terms are legacy terms from v1. | +| **Navigation** | The user experience for moving focus between views in the application view-hierarchy. | +| **Tab** | Describes the `Tab` key found on all keyboards, a break in text that is wider than a space, or a UI element that is a stop-point for keyboard navigation. The use of the word "Tab" for this comes from the typewriter, and is reinforced by the existence of a `Tab` key on all keyboards. | +| **TabGroup** | A `View` that is a container for other focusable views. The `Application.NextTabGroupKey` and `Application.PrevTabGroupKey` are `Key.PageDown.WithCtrl` and `Key.PageUp.WithCtrl` respectively. These keys enable the user to use the keyboard to navigate up and down the view-hierarchy. | +| **TabStop** | A `View` that is an ultimate stop-point for keyboard navigation. In this usage, ultimate means the `View` has no focusable subviews. The `Application.NextTabStopKey` and `Application.PrevTabStopKey` are `Key.Tab` and `Key.Tab.WithShift` respectively. These keys navigate only between peer-views. | \ No newline at end of file diff --git a/docfx/includes/scheme-overview.md b/docfx/includes/scheme-overview.md new file mode 100644 index 000000000..c79438111 --- /dev/null +++ b/docfx/includes/scheme-overview.md @@ -0,0 +1,19 @@ +A Scheme is named a mapping from `VisualRole`s (e.g. `VisualRole.Focus`) to `Attribute`s, defining how a `View` should look based on its purpose (e.g. Menu or Dialog). @Terminal.Gui.SchemeManager.Schemes is a dictionary of `Scheme`s, indexed by name. + +A Scheme defines how Views look based on their semantic purpose. The following schemes are supported: + +| Scheme Name | Description | +|:-----|:--------| +| **Base** | The base scheme used for most Views. | +| **Dialog** | The dialog scheme; used for Dialog, MessageBox, and other views dialog-like views. | +| **Error** | The scheme for showing errors, such as in `ErrorQuery`. | +| **Menu** | The menu scheme; used for Terminal.Gui.Menu, MenuBar, and StatusBar. | +| **TopLevel** | The application `TopLevel` scheme; used for the `TopLevel` View. | + +@Terminal.Gui.SchemeManager manages the set of available schemes and provides a set of convenience methods for getting the current scheme and for overriding the default values for these schemes. + +```csharp +Scheme dialogScheme = SchemeManager.GetScheme (Schemes.Dialog); +``` + +[ConfigurationManager](~/docs/config.md) can be used to override the default values for these schemes and add additional schemes. diff --git a/docfx/includes/scrolling-lexicon.md b/docfx/includes/scrolling-lexicon.md new file mode 100644 index 000000000..a72bad6fd --- /dev/null +++ b/docfx/includes/scrolling-lexicon.md @@ -0,0 +1,8 @@ +| Term | Meaning | +|:-----|:--------| +| **Content Area** | The total area of content that can be scrolled, defined by @Terminal.Gui.ViewBase.View.GetContentSize. When larger than the Viewport, scrolling is enabled. | +| **Scroll** | The act of causing content to move either horizontally or vertically within the @Terminal.Gui.ViewBase.View.Viewport. Also referred to as "Content Scrolling". | +| **ScrollBar** | Indicates the size of scrollable content and controls the position of the visible content, either vertically or horizontally. At each end, a @Terminal.Gui.Views.Button is provided, one to scroll up or left and one to scroll down or right. Between the buttons is a @Terminal.Gui.Views.ScrollSlider that can be dragged to control the position of the visible content. The ScrollSlider is sized to show the proportion of the scrollable content to the size of the @Terminal.Gui.ViewBase.View.Viewport. | +| **ScrollSlider** | A visual indicator that shows the proportion of the scrollable content to the size of the @Terminal.Gui.ViewBase.View.Viewport and allows the user to use the mouse to scroll. | +| **Viewport** | The scrollable "viewport" into the View's Content Area (which is defined by the return value of @Terminal.Gui.ViewBase.View.GetContentSize). See [Layout Deep Dive](~/docs/layout.md) for more details. | +| **ViewportSettings** | Configuration flags that adjust the behavior of scrolling, including whether negative coordinates are allowed and how clipping is applied. | \ No newline at end of file diff --git a/docfx/includes/view-composition.md b/docfx/includes/view-composition.md new file mode 100644 index 000000000..c4c35d901 --- /dev/null +++ b/docfx/includes/view-composition.md @@ -0,0 +1,50 @@ +# View Composition Diagram + +```mermaid +classDiagram + class View { + +Frame: Rectangle + +Margin: Adornment - outermost + +Border: Adornment - border lines and Title + +Padding: Adornment - innermost - Scrollbars + +Viewport: Rectangle describing portal into ContentArea + +ContentArea: Rectangle with Location always 0,0 + +GetContentSize(): Size + +SetContentSize(Size) + } + + class Adornment { + +Thickness: Thickness + } + + class Thickness { + +Top: int + +Right: int + +Bottom: int + +Left: int + } + + class Rectangle { + +Location: Point + +Size: Size + } + + View --> Adornment : has + Adornment --> Thickness : has + View --> Rectangle : has + + note for View "Frame defines location and size relative to SuperView" + note for Adornment "Separates Frame from Viewport" + note for Rectangle "Defines location and size" +``` + +The diagram above shows the structure of a View's composition: + +1. **Frame**: The outermost rectangle defining the View's location and size +2. **Margin**: Separates the View from other SubViews +3. **Border**: Contains visual border and title +4. **Padding**: Offsets the Viewport from the Border +5. **Viewport**: The visible portion of the Content Area +6. **Content Area**: Where the View's content is drawn (shown larger than Viewport to illustrate scrolling) + +Each layer is defined by a Thickness that specifies the width of each side (top, right, bottom, left). The Content Area is shown as a separate container that the Viewport "looks into" - this illustrates how scrolling works. In this example, the Viewport is positioned at (5,5) relative to the Content Area, showing how scrolling works. \ No newline at end of file diff --git a/docfx/index.md b/docfx/index.md index 0333b5457..1aef8ba67 100644 --- a/docfx/index.md +++ b/docfx/index.md @@ -1,19 +1,115 @@ # Terminal.Gui v2 - Cross Platform Terminal UI toolkit for .NET -> **NOTE** : v2 is still in development (see the `v2_develop` branch). The current stable version of v1 is in the `develop` branch. - A toolkit for building rich console apps for .NET that run on Windows, the Mac, and Linux. +> [!NOTE] +> v2 is still in development (see the `v2_develop` branch). The current stable version of v1 is in the `develop` branch. + ![Sample](images/sample.gif) -## Terminal.Gui API Documentation +> [!NOTE] +> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.html -* [Conceptual Docs & Deep Dives](docs/index.md) -* [API Reference](~/api/Terminal.Gui.yml) +## Features -## UI Catalog +* **[Dozens of Built-in Views](~/docs/views.md)** - The library provides a rich set of built-in views that can be used to build complex user interfaces. + +* **[Cross Platform](~/docs/drivers.md)** - Windows, Mac, and Linux. Terminal drivers for Curses, Windows, and the .NET Console mean apps will work well on both color and monochrome terminals. Apps also work over SSH. + +* **[Templates](~/docs/getting-started.md)** - The `dotnet new` command can be used to create a new Terminal.Gui app. + +* **[Extensible UI](~/api/Terminal.Gui.ViewBase.View.yml)** - All visible UI elements are subclasses of the `View` class, and these in turn can contain an arbitrary number of sub-views. Dozens of [Built-in Views](~/docs/views.md) are provided. + +* **[Keyboard](~/docs/keyboard.md) and [Mouse](~/docs/mouse.md) Input** - The library handles all the details of input processing and provides a simple event-based API for applications to consume. + +* **[Powerful Layout Engine](~/docs/layout.md)** - The layout engine makes it easy to lay out controls relative to each other and enables dynamic terminal UIs. + +* **[Machine, User, and App-Level Configuration](~/docs/config.md)** - Persistent configuration settings, including overriding default look & feel with Themes, keyboard bindings, and more via the [ConfigurationManager](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml) class. + +* **[Clipboard support](~/api/Terminal.Gui.App.Clipboard.yml)** - Cut, Copy, and Paste is provided through the [`Clipboard`] class. + +* **Multi-tasking** - The [Mainloop](~/api/Terminal.Gui.App.MainLoop.yml) supports processing events, idle handlers, and timers. Most classes are safe for threading. + +* **[Reactive Extensions](https://github.com/dotnet/reactive)** - Use reactive extensions and benefit from increased code readability, and the ability to apply the MVVM pattern and [ReactiveUI](https://www.reactiveui.net/) data bindings. See the [source code](https://github.com/gui-cs/Terminal.GuiV2Docs/tree/master/ReactiveExample) of a sample app. + +See [What's New in V2 For more](~/docs/newinv2.md). + +## Examples + +The simplest application looks like this: + +```csharp +using Terminal.Gui; +Application.Init (); +var n = MessageBox.Query (50, 5, "Question", "Do you like TUI apps?", "Yes", "No"); +Application.Shutdown (); +return n; +``` + +This example shows a prompt and returns an integer value depending on which value was selected by the user. + +More interesting user interfaces can be created by composing some of the various `View` classes that are included. + +In the example above, @Terminal.Gui.App.Application.Init* sets up the environment, initializes the color schemes, and clears the screen to start the application. + +The [Application](~/api/Terminal.Gui.App.Application.yml) class additionally creates an instance of the [Toplevel](~/api/Terminal.Gui.Views.Toplevel.yml) View available in the `Application.Top` property, and can be used like this: + +```csharp +using Terminal.Gui; +Application.Init (); +var label = new Label () { + Title = "Hello World", + X = Pos.Center (), + Y = Pos.Center (), + Height = 1, +}; +var app = new Toplevel (); +app.Add (label); +Application.Run (app); +app.Dispose (); +Application.Shutdown (); +``` + +This example includes a menu bar at the top of the screen and a button that shows a message box when clicked: + +```csharp +using Terminal.Gui; +Application.Init (); +var menu = new MenuBar (new MenuBarItem [] { + new MenuBarItem ("_File", new MenuItem [] { + new MenuItem ("_Quit", "", () => { + Application.RequestStop (); + }) + }), +}); + +var button = new Button () { + Title = "_Hello", + X = 0, + Y = Pos.Bottom (menu), + Width = Dim.Fill (), + Height = Dim.Fill () - 1 +}; +button.Accepting += () => { + MessageBox.Query (50, 5, "Hi", "Hello World! This is a message box", "Ok"); +}; + +var app = new Toplevel (); +// Add both menu and win in a single call +top.Add (menu, button); +Application.Run (top); +top.Dispose (); +Application.Shutdown (); +``` + +### UI Catalog UI Catalog is a comprehensive sample library for Terminal.Gui. It provides a simple UI for adding to the catalog of scenarios. -* [UI Catalog API Reference](~/api/UICatalog/UICatalog.yml) * [UI Catalog Source](https://github.com/gui-cs/Terminal.Gui/tree/master/UICatalog) + +More examples can be found in the [Examples](https://github.com/gui-cs/Terminal.Gui/tree/v2_develop/Examples) directory. + +## More Information + +See the [Deep Dives](~/docs/index.md) for deep dives into the various features of the library. diff --git a/docfx/scripts/OutputView/OutputView.cs b/docfx/scripts/OutputView/OutputView.cs new file mode 100644 index 000000000..821c31aab --- /dev/null +++ b/docfx/scripts/OutputView/OutputView.cs @@ -0,0 +1,211 @@ +#nullable enable +using Terminal.Gui.App; +using Terminal.Gui.Configuration; +using Terminal.Gui.Drawing; +using Terminal.Gui.ViewBase; +using Terminal.Gui.Views; +using Attribute = Terminal.Gui.Drawing.Attribute; + +// Disable all shadows and highlights +ConfigurationManager.RuntimeConfig = """ + { + "Themes": [ + { + "Default": { + "Window.DefaultShadow": "None", + "CheckBox.DefaultHighlightStyle": "None", + "Dialog.DefaultShadow": "None", + "Button.DefaultShadow": "None", + "Menuv2.DefaultBorderStyle": "Single" + } + } + ] + } + """; + +ConfigurationManager.Enable (ConfigLocations.Runtime); + +// Get the view name and output file from commandline +string? viewName = null; +string? outputFile = null; + +string [] commandArgs = Environment.GetCommandLineArgs (); + +for (var i = 0; i < commandArgs.Length; i++) +{ + if (commandArgs [i].StartsWith ("--view=", StringComparison.OrdinalIgnoreCase)) + { + viewName = commandArgs [i] ["--view=".Length..]; + } + else if (commandArgs [i] == "--view" && i + 1 < commandArgs.Length) + { + viewName = commandArgs [i + 1]; + } + else if (commandArgs [i].StartsWith ("--output=", StringComparison.OrdinalIgnoreCase)) + { + outputFile = commandArgs [i] ["--output=".Length..]; + } + else if (commandArgs [i] == "--output" && i + 1 < commandArgs.Length) + { + outputFile = commandArgs [i + 1]; + } +} + +if (string.IsNullOrEmpty (viewName)) +{ + Console.WriteLine (@"No view name specified. Use --view=ViewName to specify a view."); + + return; +} + +ViewDemoWindow.ViewName = viewName; + +// Force 16 colors and end after first iteration +Application.EndAfterFirstIteration = true; + +var demoWindow = Application.Run (); +string? output = demoWindow.Output?.Trim (); +demoWindow.Dispose (); + +// Before the application exits, reset Terminal.Gui for clean shutdown +Application.Shutdown (); + +if (output is null) +{ + Console.WriteLine (@"No output was generated."); + + return; +} + +// Write to file or console +if (!string.IsNullOrEmpty (outputFile)) +{ + File.WriteAllText (outputFile, output); +} +else +{ + Console.WriteLine (output); +} + +// Defines a top-level window with border and title +public class ViewDemoWindow : Window +{ + public static string? ViewName { get; set; } + public string? Output { get; set; } + + public ViewDemoWindow () + { + // Limit the size of the window to 50x20, which works good for most views + Width = 50; + Height = 20; + + // Use only white on black + SetScheme (new (new Attribute (ColorName16.White, ColorName16.Black))); + BorderStyle = LineStyle.None; + + // Convert ViewName to type that's in the Terminal.Gui assembly: + var type = Type.GetType ($"Terminal.Gui.Views.{ViewName!}, Terminal.Gui", false, true); + + if (type is null) + { + Console.WriteLine (@$"View {ViewName} type is invalid."); + + return; + } + + // Create the view + View? view = CreateView (type!); + + if (view is null) + { + Console.WriteLine (@$"View {ViewName} could not be created."); + + return; + } + + // Initialize the view + view.Initialized += ViewInitialized; + + base.Add (view); + + // In normal apps, each iteration would call Application.LayoutAndDraw() + // but since we set Application.EndAfterFirstIteration = true, we need to + // call it manually here and capture the output + Application.Iteration += (sender, args) => + { + Application.LayoutAndDraw (); + Output = Application.ToString (); + }; + } + + private static View? CreateView (Type type) + { + // If we are to create a generic Type + if (type.IsGenericType) + { + // For each of the arguments + List typeArguments = new (); + + // use or the original type if applicable + foreach (Type arg in type.GetGenericArguments ()) + { + if (arg.IsValueType && Nullable.GetUnderlyingType (arg) == null) + { + typeArguments.Add (arg); + } + else + { + typeArguments.Add (typeof (object)); + } + } + + // And change what type we are instantiating from MyClass to MyClass or MyClass + type = type.MakeGenericType (typeArguments.ToArray ()); + } + + // Ensure the type does not contain any generic parameters + if (type.ContainsGenericParameters) + { + Console.WriteLine (@$"Cannot create an instance of {type} because it contains generic parameters."); + + return null; + } + + // Instantiate view + var view = (View)Activator.CreateInstance (type)!; + + if (view is IDesignable designable) + { + var settingsEditorDemoText = "Demo Text"; + designable.EnableForDesign (ref settingsEditorDemoText); + } + else + { + view.Text = "Demo Text"; + view.Title = "_Demo Title"; + } + + return view; + } + + private static void ViewInitialized (object? sender, EventArgs e) + { + if (sender is not View view) + { + return; + } + + if (view.Width == Dim.Absolute (0) || view.Width is null) + { + view.Width = Dim.Fill (); + } + + if (view.Height == Dim.Absolute (0) || view.Height is null) + { + view.Height = Dim.Fill (); + } + + view.X = 0; + view.Y = 0; + } +} diff --git a/docfx/scripts/OutputView/OutputView.csproj b/docfx/scripts/OutputView/OutputView.csproj new file mode 100644 index 000000000..3c071d093 --- /dev/null +++ b/docfx/scripts/OutputView/OutputView.csproj @@ -0,0 +1,8 @@ + + + Exe + + + + + \ No newline at end of file diff --git a/docfx/scripts/build.ps1 b/docfx/scripts/build.ps1 new file mode 100644 index 000000000..6a4afa3e2 --- /dev/null +++ b/docfx/scripts/build.ps1 @@ -0,0 +1,25 @@ +# Builds the Terminal.gui API documentation using docfx + +# Get the script directory and derive the docfx directory from it +$scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path +$docfxDir = Split-Path -Parent $scriptDir +$prevPwd = $PWD +Set-Location $docfxDir + +try { + Write-Host "Working directory: $(Get-Location)" + + dotnet tool update -g docfx + + # Force delete metadata + Remove-Item ./api -Recurse -Force -ErrorAction SilentlyContinue + + $env:DOCFX_SOURCE_BRANCH_NAME="v2_develop" + + docfx --serve +} +finally { + # Restore the previous location + $prevPwd | Set-Location +} + diff --git a/docfx/scripts/generate-views-doc.ps1 b/docfx/scripts/generate-views-doc.ps1 new file mode 100644 index 000000000..85b48707e --- /dev/null +++ b/docfx/scripts/generate-views-doc.ps1 @@ -0,0 +1,147 @@ +# Script to generate views.md from API documentation +param( + [string]$ApiPath = "api", + [string]$OutputPath = "docs/views.md", + [switch]$Debug +) + +# Ensure we're in the correct directory (docfx root) +$scriptPath = Split-Path -Parent $MyInvocation.MyCommand.Path +$rootPath = Split-Path -Parent $scriptPath +Set-Location $rootPath + +Write-Host "Working directory: $(Get-Location)" +Write-Host "Looking for view files in: $ApiPath" + +# Get all .yml files in the API directory that are Views +if ($Debug) { + $viewFiles = Get-ChildItem -Path $ApiPath -Filter "Terminal.Gui.Views.HexView.yml" + Write-Host "DEBUG MODE: Only processing" $viewFiles -ForegroundColor Cyan +} else { + $viewFiles = Get-ChildItem -Path $ApiPath -Filter "Terminal.Gui.Views.*.yml" +} +Write-Host "Found $($viewFiles.Count) view files" + +# Start building the markdown content +$content = @" + +# Terminal Gui's Built-in Views + +*Terminal.Gui* provides the following set of built-in views and controls for building terminal user interfaces: + + +"@ + +# Process each view file +$views = @() +foreach ($file in $viewFiles) { + try { + $yml = Get-Content $file.FullName -Raw | ConvertFrom-Yaml + + # Check if this is actually a View type + $isView = $false + if ($yml.items[0].inheritance) { + $isView = $yml.items[0].inheritance -contains "Terminal.Gui.ViewBase.View" + } + + if (-not $isView) { + continue + } + + # Extract the view name and description + $name = $file.BaseName -replace "^Terminal\.Gui\.Views\.", "" + + # Handle generic types + if ($name -match "(.+)-(\d+)$") { + $name = "$($matches[1])\" + } + + $description = $yml.items[0].summary + + # Clean up the description + $description = $description -replace "`r`n", " " # Replace newlines with spaces + $description = $description -replace "\s+", " " # Replace multiple spaces with single space + $description = $description.Trim() # Trim leading/trailing whitespace + + # Remove duplicate content (only for repeated phrases, not characters) + $description = $description -replace '([^a-zA-Z0-9]+)\1+', '$1' + + # Clean up HTML tags + $description = $description -replace '

|

', '' # Remove paragraph tags + $description = $description -replace '([^<]+)', '$1' # Remove links but keep text + + # Convert ALL xref tags to markdown links + $description = $description -replace ']*>([^<]+)', '[$2](~/api/$1.yml)' + $description = $description -replace '', '[$1](~/api/$1.yml)' + $description = $description -replace '([^<]+)', '`$1`' + + # Convert code tags to backticks + $description = $description -replace '([^<]*)', '`$1`' + + # Fix any remaining xref tags + $description = $description -replace ']*>', '[$1](~/api/$1.yml)' + + # Extract just the class name from full type names + $description = $description -replace '\[Terminal\.Gui\.Views\.([^\]]+)\]', '[$1]' + $description = $description -replace '\[Terminal\.Gui\.ViewBase\.([^\]]+)\]', '[$1]' + $description = $description -replace '\[Terminal\.Gui\.Drawing\.([^\]]+)\]', '[$1]' + $description = $description -replace '\[Terminal\.Gui\.Input\.([^\]]+)\]', '[$1]' + $description = $description -replace '\[System\.([^\]]+)\]', '[$1]' + + # Get the view output + $viewOutput = "" + try { + $viewName = $file.BaseName -replace "^Terminal\.Gui\.Views\.", "" + $tempFile = [System.IO.Path]::GetTempFileName() + Write-Host "Running: dotnet run --project scripts/OutputView --view=$viewName --output=$tempFile" -ForegroundColor Cyan + + dotnet run --project scripts/OutputView --view=$viewName --output=$tempFile + + if (Test-Path $tempFile) { + $output = Get-Content $tempFile -Raw + if ($output -and $output.Trim()) { + $lines = $output.Trim() -split "`n" + $trimmedLines = $lines | ForEach-Object { $_.TrimEnd() } + $viewOutput = "``````text" + "`n" + $($trimmedLines -join "`n") + "`n" + "``````" + } + Write-Host "View output: $viewOutput" -ForegroundColor Blue + } else { + Write-Host "Temp file was not created!" -ForegroundColor Red + } + + if (-not $viewOutput) { + Write-Host " No output generated for $($file.Name)" -ForegroundColor Yellow + } + } + catch { + Write-Host " Error running OutputView for $($file.Name): $_" -ForegroundColor Red + } + + Write-Host "Found view: $name" + $views += "## [$name](~/api/$($file.BaseName).yml)`n`n$description`n`n$viewOutput`n" + } + catch { + Write-Host " Error processing $($file.Name): $_" -ForegroundColor Red + Write-Host " YAML content:" + Write-Host (Get-Content $file.FullName -Raw) + } +} + +Write-Host "Sorting views..." +# Sort the views alphabetically +$views = $views | Sort-Object + +Write-Host "Generating markdown..." +# Add the views to the content +$content += "`n" + ($views -join "`n") + +Write-Host "Writing to $OutputPath..." +# Write the content to the output file +$content | Set-Content -Path $OutputPath -NoNewline + +Write-Host "Generated $OutputPath successfully" -ForegroundColor Green \ No newline at end of file