mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 08:17:53 +01:00
be9d1939c1
* Refactor selectors and improve UI components Refactored `MarginEditor` and `UICatalogTop` to use new `OptionSelector` and `FlagSelector` classes, introducing type-safe generic versions for better flexibility and maintainability. Added `SelectorBase` as a shared foundation for these components, along with the `SelectorStyles` enum for customizable styles. Enhanced unit tests to cover new implementations and edge cases. Enabled nullable reference types for improved null safety. Improved code readability, reduced redundancy, and enhanced user experience with better hotkey management, focus handling, and layout adjustments. * Refactor UI components and remove unused classes Significant refactoring and simplification of the codebase: - Updated `CharacterMap` to use `OptionSelector<UnicodeCategory>`. - Removed `FlagSelector`, `FlagSelector<TEnum>`, and `FlagSelectorStyles`. - Replaced `OptionSelector.Options` with `Labels` in `MenuBarv2`. - Removed `OptionSelector` and its associated properties/methods. - Updated terminology from "Activate" to "Select" across components. - Refactored `SelectorBase` to align with new "Select" behavior. - Removed redundant methods, properties, and event handlers. These changes streamline the codebase, reduce complexity, and align with updated design principles. * Fixes #4374 - 'Application.Screen' is empty when 'Init' returns Refactor and enhance testability of ApplicationImpl Refactored `ApplicationImpl` and related classes to improve modularity and testability. Replaced `FakeConsoleOutput` with `FakeOutput` and introduced `FakeInput` for better test isolation. Added platform-specific factories (`FakeNetComponentFactory`, `FakeWindowsComponentFactory`) to simplify fake component creation. Refactored `GuiTestContext` into partial classes, adding methods for simulating user interactions and improving initialization logic. Enhanced error handling and logging during test setup. Updated tests to use the new `FakeOutput` and `FakeInput` implementations. Standardized driver initialization with `Application.Init(null, "fake")`. Skipped tests relying on the fake driver due to known issues. Performed general cleanup, modernized syntax, and removed redundant code to improve readability and maintainability. * Disable "windows" test case in SynchronizationContextTests The `InlineData("windows")` attribute in the `SynchronizationContext_Post` test method has been commented out. This change temporarily excludes the `"windows"` driverName from the test suite while retaining other test cases (`"fake"`, `"dotnet"`, and `"unix"`). The exclusion may be for debugging, deprecation, or other maintenance purposes. * Disable "windows" test case in SynchronizationContextTests The `[InlineData("windows")]` attribute in the `SynchronizationContextTests` class has been commented out, disabling the test case for the `"windows"` driver name. This change may have been made for debugging, deprecation, or because the test is no longer relevant. Other test cases (`"fake"`, `"dotnet"`, and `"unix"`) remain active. * Update Terminal.Gui/Drivers/FakeDriver/FakeConsole.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Views/Selectors/SelectorStyles.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Views/Selectors/SelectorBase.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Views/Selectors/OptionSelector.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Views/Selectors/OptionSelector.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Views/Selectors/OptionSelector.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Views/Selectors/SelectorBase.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Backported Checkbox from Activate PR * Backported Checkbox from Activate PR 2 * Backported Checkbox from Activate PR 3 * Backported Selctors Scenario * Backported Bars Scenario * Backported AllViewsTester Scenario * Backported Dialogs Scenario * Backported MessageBoxes Scenario * Backported ArrangementEditor * Backported mouse binding fix * Update Terminal.Gui/Views/Selectors/OptionSelector.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Drivers/WindowsDriver/WindowsOutput.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Views/CheckBox.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fixed typo * Refactor ArrangementEditor event handling Removed the `ArrangementFlagsOnValueChanged` method, which previously handled updates to `ViewToEdit` properties based on arrangement flags. Updated `ArrangementEditor_Initialized` to attach the event handler to `_arrangementSelector.ValueChanged`. The logic for handling arrangement changes has been refactored or relocated. * Refactor AlignKeys for type safety and readability Updated the `AlignKeys` method in the `Shortcuts` class to replace generic `View` references with the more specific `Shortcut` type. Improved type safety by using `IEnumerable<Shortcut>` and `.Cast<Shortcut>()`. Simplified the `max` calculation logic with a single LINQ query and removed redundant casting in the `foreach` loop. These changes enhance code readability, maintainability, and ensure better type safety. * Refactor ArrangementEditor for clarity and consistency Refactored `ArrangementEditor` to improve code readability and maintainability: - Enabled nullable reference types with `#nullable enable`. - Removed unused `using` directives. - Adjusted namespace declaration for formatting consistency. - Reformatted `_arrangementSelector` initialization and property assignment. - Simplified `OnViewToEditChanged` logic with a ternary expression. - Refactored `ArrangementEditor_Initialized` into a single-line block. * Update Examples/UICatalog/Scenarios/Shortcuts.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Views/Selectors/OptionSelector.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Refactor and enhance OptionSelector and SelectorBase Refactored `OptionSelector` and `SelectorBase` to simplify logic, improve hotkey assignment, and ensure robust behavior. Updated `Shortcuts.cs` and `DialogTests.cs` to address nullability issues. Added comprehensive unit tests for `OptionSelector` and `SelectorBase`, covering properties, methods, edge cases, and layout behaviors. These changes improve code readability, maintainability, and functionality while adhering to modern C# practices. * add FlagSelector comprehensive tests Refactored `UncheckNone` and `UncheckAll` methods in `FlagSelector` to improve clarity and prevent concurrent modifications using a new `_updatingChecked` flag. Removed the old `UncheckNone` implementation and reorganized logic for maintainability. Added extensive unit tests in `FlagSelectorTests` to validate functionality, including edge cases and generic implementations. Tests cover flag combination, toggling, "None" flag behavior, and enum-based generic handling. Improved overall maintainability and test coverage for the `FlagSelector` class. * Fixes #4375. UnixDriver fails Toplevel_TabGroup_Forward_Backward Fluent Tests * Refactor RadioGroup to use OptionSelector The `RadioGroup` class has been refactored to inherit from the `OptionSelector` class instead of `View`, marking it as `[Obsolete]` and recommending the use of `OptionSelector`. The previous implementation of `RadioGroup` has been entirely removed, including its properties, methods, events, and internal logic. This includes initialization logic, key bindings, layout management, and event handling. The new `RadioGroup` is now a thin wrapper around `OptionSelector` and implements the `IDesignable` interface. The `EnableForDesign` method has been simplified to set default options for design purposes. This change simplifies the codebase and encourages the use of `OptionSelector` for managing mutually exclusive options. * Backported focus tests and add bug-exposing test case Refactored `AdvanceFocusTests` to improve assertion clarity by replacing `Assert.True`/`Assert.False` with `Assert.Equal`. Enhanced test documentation with detailed view hierarchy comments for better readability. Added a new test case, `FocusNavigation_Should_Cycle_Back_To_Top_Level_Views`, which exposes a bug in focus navigation logic where focus does not cycle back to top-level views after traversing nested views. Updated existing tests to ensure consistent handling of `TabBehavior` and made minor adjustments for improved validation of focus navigation logic. * Remove all tests for RadioGroup component The `RadioGroupTests.cs` file has been completely cleared of all test cases and associated code. This includes the removal of unit tests that validated the `RadioGroup` component's functionality, behavior, and edge cases. The deleted tests covered: - Default constructor behavior and initialization. - Handling of the `SelectedItem` property, including edge cases. - Hotkey bindings and their behavior under different focus states. - Command handling for focus, selection, and acceptance. - Orientation changes and their impact on layout. - Event handling for `SelectedItemChanged`, `Selecting`, and `Accepting`. - Mouse interactions, including single-click and double-click events. This removal eliminates all automated validation for the `RadioGroup` component, leaving it untested and increasing the risk of regressions or undetected issues in future changes. * Fix unix and fake fluent tests. * More fixes for unix and fake drivers * Change classes names for more consistency * Fix typos in docs and method signature Updated XML documentation in `FakeConsole.cs` to replace `<see cref="FakeDriver"/>` with `<exception cref="FakeDriver"></exception>` for clarity. Corrected a parameter name in `WindowsOutput.cs`'s `WriteConsole` method from `numberOfCharsToWritten` to `numberOfCharsToWrite` to fix a typo and improve readability. * Refactor: Replace RadioGroup with OptionSelector Replaced all instances of `RadioGroup` with `OptionSelector` across the codebase to standardize the control for mutually exclusive options. Updated associated properties, methods, and event handlers to align with the `OptionSelector` API, including replacing `RadioLabels` with `AssignHotKeys` and `SelectedItemChanged` with `ValueChanged`. Removed the `RadioGroup` class, marking it as obsolete. Updated documentation, comments, and test cases to reflect the new control. Adjusted layout and positioning logic in various scenarios to ensure UI consistency. Refactored scenarios such as `Buttons`, `ColorPickers`, `DynamicMenuBar`, `FileDialogExamples`, `Images`, `PosAlignDemo`, `ProgressBarStyles`, `RegionScenario`, `Themes`, and others to use `OptionSelector`. Updated `Glyphs` and `View` classes to reflect the terminology change. Cleaned up redundant code and ensured compatibility across the application. * Refactor OptionSelector to use Value instead of SelectedItem Replaced the SelectedItem property with a nullable Value property across the codebase to simplify the API and improve consistency. Updated event handlers from SelectedItemChanged to ValueChanged and adjusted logic accordingly. Refactored UI scenarios (e.g., Buttons, CharacterMap, ColorPickers) and dependent classes (e.g., BorderEditor, DimEditor, PosEditor) to use the new Value property. Improved null handling and streamlined initialization of controls. Updated tests to validate the Value property and renamed test methods for clarity. Removed the RegionOpSelector class as it was no longer needed. Performed general code cleanup, including formatting and removal of redundant code. * Refactor OptionSelector: Replace RadioLabels with Labels Updated the `OptionSelector` class and its derived classes to replace the `RadioLabels` property with a more generic `Labels` property, aligning with the base class `SelectorBase`. This change standardizes the API and simplifies label-related functionality. Refactored all instances of `RadioLabels` across the codebase, including property assignments, method calls, and references in scenarios, tests, and examples. Updated classes include `ColorPickers`, `Dialogs`, `DimAutoDemo`, `DynamicMenuBar`, `FileDialogExamples`, `Images`, `PosAlignDemo`, `Selectors`, `Shortcuts`, `TextAlignmentAndDirection`, `Themes`, `UnicodeInMenu`, `Wizards`, `UICatalogTop`, and `ScenarioTests`. Modified `OptionSelector<TEnum>` to initialize `Labels` directly using `Enum.GetValues<TEnum>()`. Removed the `RadioLabels` property from `OptionSelector`, consolidating functionality under `Labels`. Verified functionality through updated tests and scenarios to ensure consistent behavior with the previous implementation. * Refactor: Replace "radio group" with "option selector" Updated terminology across multiple classes to replace "radio group" with "option selector" for improved clarity and consistency. - Removed unused `OptionSelector` in `ColorPickers`. - Renamed `Title` in `DimAutoDemo` to "Options" and updated `BorderStyle`. - Replaced `_radioItems` with `_optionLabels` in `DimEditor` and `PosEditor`. - Renamed `styleRadioGroup` to `styleOptionSelector` in `MessageBoxes`. - Renamed `radioGroup` to `optionSelector` in `UnicodeInMenu` and `OrientationTests`. - Adjusted related references, event handlers, and UI properties. These changes align the codebase with updated terminology and improve readability. * Replace RadioGroup with OptionSelector and update docs The `RadioGroup` control has been replaced or renamed to `OptionSelector`. Documentation has been updated to reflect this change, including the behavior of raising the `Selecting` event when an option is selected. The navigation table now describes `OptionSelector` as supporting multiple options with actions like `Advance`, `SetValue+OnAccept`, and `Focus+SetValue`. A new section introduces the `OptionSelector` view, which displays mutually-exclusive items with hotkeys. Enhancements to `Menuv2` and `MenuBarv2` include setting focus on `MenuItemv2` selections and raising the `SelectedMenuItemChanged` event. Additionally, a progress bar view has been introduced to visually indicate activity progress. * Fixed `EndAfterFirstIteration` Renamed the `EndAfterFirstIteration` property to `StopAfterFirstIteration` across the codebase for improved clarity and consistency. Updated all references in the `Application`, `ApplicationImpl`, `IApplication`, and `ITimedEvents` classes, as well as related tests and documentation. Modified the application loop logic to use `StopAfterFirstIteration` for controlling the termination of the application after the first iteration. Set its default value to `false`. Updated test cases, demo applications, and XML documentation to reflect the new property name. Added a new project, `OutputView`, to the solution with appropriate configuration entries. Performed minor code cleanup to ensure consistency in naming and behavior. * Enhance selectors and clean up documentation - Added `args.Handled = true` to `CheckBox` event handlers in `FlagSelector` and `OptionSelector` to mark events as handled. - Introduced `_value` field in `FlagSelector` and added a `Cycle` method in `OptionSelector` for better value management. - Updated `OptionSelector` documentation to reference `OptionSelector<TEnum>` for type-safe enum usage. - Improved `UpdateChecked` method documentation in `OptionSelector` to clarify exception behavior. - Enabled nullable reference types in `FlagSelectorTests` and `SelectorBaseTests` and moved them to a new namespace. - Removed outdated auto-generated content from `views.md`. - Removed `CheckBox.DefaultHighlightStyle` from the default theme configuration in `OutputView.cs`. * Update event handling and expand UI documentation Modified `args.Handled` in `FlagSelector` and `OptionSelector` to allow `Accepting` event propagation, improving event handling behavior. Added comments to clarify the changes. Expanded `views.md` with detailed documentation for built-in views and controls in *Terminal.Gui*, including descriptions, examples, and rendered outputs for components like `Bar`, `Button`, `CheckBox`, and more. This update enhances developer guidance for building terminal-based UIs. * Fixed `EndAfterFirstIteration` in `ApplicationImpl` Renamed the `EndAfterFirstIteration` property to `StopAfterFirstIteration` across the codebase for improved clarity. Updated its implementation to use a getter and setter that interact with the `ApplicationImpl.Instance` singleton for centralized management. Modified the `RunLoop` method to check the new `StopAfterFirstIteration` property. Updated the default value to `false` in the `Application` class. Added a private `_stopAfterFirstIteration` field and a corresponding public property in the `ApplicationImpl` class. Updated the `Run` method in `ApplicationImpl` to stop after the first iteration if the property is set to `true`, with appropriate logging. Updated the `IApplication` interface to include the `StopAfterFirstIteration` property and clarified the behavior of the `RequestStop` method. Revised XML documentation comments to reflect these changes. * Fixed EndfterFirstIteration in ApplicaitonImpl Refactored `StopAfterFirstIteration` in `ApplicationImpl` to use an auto-property for simplicity. Updated `RunIteration` to call `view.RequestStop()` instead of modifying `view.Running`. Replaced references to `Application.EndAfterFirstIteration` with `Application.StopAfterFirstIteration` across the codebase, including `ITimedEvents`, `ApplicationTests`, and `GlobalTestSetup`. Added a new test, `InitRunShutdown_StopAfterFirstIteration_Stops`, to verify the application stops correctly after the first iteration. Updated related documentation and assertions for consistency. * Refactor Value handling and improve type safety Refactored `Value` handling across multiple classes to use nullable generic types, improving type safety and eliminating unnecessary casting. Simplified `ValueChanged` event handlers with concise lambda expressions. Enhanced `FlagSelector<TFlagsEnum>` and `OptionSelector<TEnum>` with generic `ValueChanged` events and type-safe event handling. Added nullable reference type annotations to align with modern C# practices. Improved test code by using null-forgiving operators and more descriptive assertions. Cleaned up redundant code and ensured consistency in `Value` handling. Updated `FlagSelectorTests` and `SelectorBaseTests` for better readability and maintainability. Added the `System` namespace to `FlagSelectorTEnum.cs` for compatibility. Overall, these changes enhance code readability, maintainability, and robustness. * Merged v2_develop * Update README badges for v2_develop branch Updated the `.NET Core` badge to reference the `v2_develop` branch. Adjusted the `codecov` badge to remove branch-specific paths and added a token parameter. Reorganized the `codecov` badge position in the README. Retained other badges without modification. * codcov2 * fixed pos tests * Improve cleanup, coverage config, and SpinnerStyle tests Enhanced resource cleanup in `Pos.CombineTests.cs` by disposing of `Application.Top` to prevent leaks. Updated `codecov.yml` to focus coverage on `Terminal.Gui`, simplified path patterns, and clarified configurations. Added `SpinnerStyleTests` with extensive unit tests for `SpinnerStyle` and its variants, covering default properties, behaviors, edge cases, and immutability. Organized tests for readability and ensured thorough validation of all spinner styles. Enabled nullable reference types for improved safety. * Remove .NET Core badge; add comprehensive boundary tests The `.NET Core` workflow badge was removed from the `README.md` file. Added a comprehensive suite of unit tests for the `Region.DrawOuterBoundary` method in `DrawOuterBoundaryTests.cs`. These tests validate the method's behavior across various scenarios, including: - Intersected, unioned, and complex shapes. - Edge cases like empty regions, zero-width/height rectangles, and single-pixel rectangles. - Specific shapes such as L-shaped, T-shaped, and hollow rectangles. - Overlapping, adjacent, and separate rectangles. - Thread safety with parallel drawing. - Different line styles, custom attributes, and very large regions. - Various positions, sizes, and multiple calls on the same canvas. The tests use the `Xunit` framework and include both `[Fact]` and `[Theory]` test cases. These changes enhance the codebase's robustness and ensure correctness in a wide range of scenarios. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: BDisp <bd.bdisp@gmail.com>
732 lines
32 KiB
Markdown
732 lines
32 KiB
Markdown
<!--
|
||
This file is automatically generated from the API documentation and the OutputView tool found in the
|
||
.docfx/scripts/OutputView folder.
|
||
OutputView is a simple tool that takes a view name and outputs the view's rendered output to a file,
|
||
using Application.ToString to capture the view's rendered output.
|
||
-->
|
||
# 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_ ¡ ¢ £ ¤ ¥ ¦ § ¨ © ª « ¬ F░
|
||
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: 10/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 │ │┃
|
||
┃│\apispec │ │┃
|
||
┃│\docs │ │┃
|
||
┃│\images │ │┃
|
||
┃Find ┃
|
||
┃⟦►Tree⟧ ⟦► 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
|
||
☐ ShowAllFlag
|
||
☐ Show Value Editor Style
|
||
☐ All Styles
|
||
0
|
||
```
|
||
|
||
## [FlagSelector\<T\>](~/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: <20><><EFBFBD><EFBFBD>A
|
||
00000028 e2 84 9d f0 ┊ 9d 94 bd 21 <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>!
|
||
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
|
||
|
||
|
||
|
||
## [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\<T\>](~/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 │ │┃
|
||
┃│\apispec │ │┃
|
||
┃│\docs │ │┃
|
||
┃│\images │ │┃
|
||
┃Find ┃
|
||
┃⟦►Tree⟧ ⟦► 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.
|
||
|
||
|
||
|
||
## [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 │ │┃
|
||
┃│\apispec │ │┃
|
||
┃│\docs │ │┃
|
||
┃│\images │ │┃
|
||
┃Find ┃
|
||
┃⟦►Tree⟧ ⟦► 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\<T\>](~/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).
|
||
|
||
|
||
|
||
## [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\<T\>](~/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.
|
||
|
||
|