Files
Terminal.Gui/docfx/docs/views.md
Tig a84b2c4896 Fixes #4419, #4148, #4408 - Toplevel is GONE - Replaced by Runnable (#4422)
* WIP: Broken

* Got working. Mostly.

* Parllel tests pass

* More progres

* Fixed app tests.

* Mouse

* more progress.

* working on shortcut

* Shortcut accept on ENTER is broken.

* One left...

* More test progress.

* All unit tests pass. Still some issues though.

* tweak

* Fixed Integration Tests

* Fixed UI Catalog

* Tweaking CP to try to find race condition

* Refactor StandardColors and improve ColorPicker logic

Refactored `StandardColors` to use lazy initialization for static fields, improving performance and avoiding static constructor convoy effects. Introduced `NamesValueFactory` and `MapValueFactory` methods for encapsulated initialization logic.

Simplified `GetColorNames` to directly return `_names.Value`. Improved `TryParseColor` by clarifying default value usage and adopting object initializer syntax. Updated `TryNameColor` to use `_argbNameMap.Value`.

Refactored `GetArgb` for better readability. Replaced `MultiStandardColorNameResolver` with `StandardColorsNameResolver` in `ColorPicker`. Commented out `app.Init("Fake")` in `ColorPickerTests` for testing purposes.

Made minor formatting improvements, including updated comments and XML documentation for consistency.

* revert

* Throttle input loop to prevent CPU spinning

Introduce a 20ms delay in the input loop of `InputImpl<TInputRecord>`
to prevent excessive CPU usage when no input is available. Removed
the `DateTime dt = Now();` line and the `while (Peek())` block, which
previously enqueued input records.

This change improves resource management, especially in scenarios
where multiple `ApplicationImpl` instances are created in parallel
tests without calling `Shutdown()`. It prevents thread pool
exhaustion and ensures better performance in such cases.

* Refactor ApplicationImpl to use IDisposable pattern

Implemented the IDisposable pattern in ApplicationImpl to improve resource management. Added `Dispose` and `DisposeCore` methods, and marked the `Shutdown` method as obsolete, encouraging the use of `Dispose` or `using` statements instead. Updated the `IApplication` interface to inherit from IDisposable and added `GetResult` methods for retrieving run session results.

Refactored unit tests to adopt the new lifecycle management approach, replacing legacy `Shutdown` calls with `Dispose` or `using`. Removed fragile and obsolete tests, and re-enabled previously skipped tests after addressing underlying issues.

Updated `FakeApplicationLifecycle` and `SetupFakeApplicationAttribute` to align with the new disposal pattern. Improved documentation and examples to guide users toward modern usage patterns. Maintained backward compatibility for legacy singleton usage.

* Add IDisposable pattern with input loop throttling

- Add IDisposable to IApplication for proper resource cleanup
- Add 20ms throttle to input loop (prevents CPU spinning)
- Add Lazy<T> to StandardColors (eliminates convoy effect)
- Add MainLoopCoordinatorTests suite (5 new tests)
- Add Dispose() calls to all 16 ColorPickerTests
- Mark Application.Shutdown() as [Obsolete]

IApplication now requires Dispose() for cleanup

Performance: 100x CPU reduction, 15x faster disposal, tests complete in <5s

Fixes: Thread leaks, CPU saturation, test hangs in parallel execution
Docs: Updated application.md and newinv2.md with disposal patterns

* Refactor test for input loop throttling clarity

Updated `InputLoop_Throttle_Limits_Poll_Rate` test to improve clarity, reliability, and efficiency:
- Rewrote summary comment to clarify purpose and emphasize the 20ms throttle's role in preventing CPU spinning.
- Replaced `var` with explicit types for better readability.
- Reduced test duration from 1s to 500ms to improve test speed.
- Revised assertions:
  - Replaced range-based assertion with upper-bound check to ensure poll count is below 500, avoiding timing sensitivity issues.
  - Added assertion to verify the thread ran and was not immediately canceled.
- Added a 2-second timeout to `inputTask.Wait` and verified task completion.
- Improved comments to explain test behavior and reasoning behind changes.

* tweaks

* Fix nullabiltiy stuff.

* runnable fixes

* more nullabe

* More nullability

* warnings gone

* Fixed fluent test failure.

* Refactor ApplicationImpl and update Runnable layout logic

Refactored `ApplicationImpl.Run.cs` for improved readability and
atomicity:
- Combined `if (wasModal)` with `SessionStack?.TryPop` to streamline
  logic.
- Simplified restoration of `previousRunnable` by reducing nesting.
- Updated comments for clarity and retained `SetIsModal` call.

Simplified focus-setting logic in `ApplicationImpl.Run.cs` using
pattern matching for `TopRunnableView`.

In `Runnable<TResult>`, added `SetNeedsLayout` after `IsModalChanged`
to ensure layout updates. Removed an unused empty line for cleanup.

Corrected namespace in `GetViewsUnderLocationForRootTests.cs` to
align with test structure.

* Update layout on modal state change

A call to `SetNeedsLayout()` was added to the `OnIsModalChanged`
method in the `Runnable` class. This ensures that the layout
is updated whenever the modal state changes.

* Increase test timeout for inputTask.Wait to 10 seconds

Extended the timeout duration for the `inputTask.Wait` method
from 4 seconds to 10 seconds in `MainLoopCoordinatorTests`.
This change ensures the test has a longer window to complete
under conditions of increased load or slower execution
environments, reducing the likelihood of false test failures.

* Refactor project files and simplify test logic

Removed `<LangVersion>` and `<ImplicitUsings>` properties from
`UnitTests.csproj` and `UnitTests.Parallelizable.csproj` to rely
on default SDK settings and disable implicit global usings.

Simplified the `SizeChanged_Event_Still_Fires_For_Compatibility`
test in `FakeDriverTests` by removing the `screenChangedFired`
variable, its associated event handler, and related assertions.
Also removed obsolete warning suppression directives as they
are no longer needed.

* Reduce UnitTestsParallelizable iterations from 10 to 3

Reduced the number of iterations for the UnitTestsParallelizable
test suite from 10 to 3 to save time and resources while still
exposing concurrency issues. Updated the loop and log messages
to reflect the new iteration count.

* disabled InputLoop_Throttle_Limits_Poll_Rate

* Refactor app lifecycle and improve Runnable API

Refactored `Program.cs` to simplify application lifecycle:
- Modularized app creation, initialization, and disposal.
- Improved result handling and ensured proper resource cleanup.

Re-implemented `Runnable<TResult>` with a cleaner design:
- Retained functionality while improving readability and structure.
- Added XML documentation and followed the Cancellable Work Pattern.

Re-implemented `RunnableWrapper<TView, TResult>`:
- Enabled wrapping any `View` to make it runnable with typed results.
- Added examples and remarks for better developer guidance.

Re-implemented `ViewRunnableExtensions`:
- Provided fluent API for making views runnable with or without results.
- Enhanced documentation with examples for common use cases.

General improvements:
- Enhanced code readability, maintainability, and error handling.
- Replaced redundant code with cleaner, more maintainable versions.

* Modernize codebase for Terminal.Gui and MVVM updates

Refactored `LoginView` to remove redundant `Application.LayoutAndDraw()`
call. Enhanced `LoginViewModel` with new observable properties for
automatic property change notifications. Updated `Message` class to use
nullable generics for improved type safety.

Replaced legacy `Application.Init()` and `Application.Run()` calls with
the modern `IApplication` API across `Program.cs`, `Example.cs`, and
`ReactiveExample`. Ensured proper disposal of `IApplication` instances
to prevent resource leaks.

Updated `TerminalScheduler` to integrate with `IApplication` for
invoking actions and managing timeouts. Added null checks and improved
timeout disposal logic for robustness.

Refactored `ExampleWindow` for better readability and alignment with
modern `Terminal.Gui` conventions. Cleaned up unused imports and
improved code clarity across the codebase.

Updated README.md to reflect the latest `Terminal.Gui` practices,
including examples of the `IApplication` API and automatic UI refresh
handling. Renamed `LoginAction` to `LoginActions` for consistency.

* Refactor: Transition to IRunnable-based architecture

Replaced `Toplevel` with `Window` as the primary top-level UI element. Introduced the `IRunnable` interface to modernize the architecture, enabling greater flexibility and testability. Deprecated the static `Application` class in favor of the instance-based `IApplication` model, which supports multiple application contexts.

Updated methods like `Application.Run()` and `Application.RequestStop()` to use `IRunnable`. Removed or replaced legacy `Modal` properties with `IsModal`. Enhanced the `IApplication` interface with a fluent API, including methods like `Run<TRunnable>()` and `GetResult<T>()`.

Refactored tests and examples to align with the new architecture. Updated documentation to reflect the instance-based model. Deprecated obsolete members and methods, including `Application.Current` and `Application.TopRunnable`.

Improved event handling by replacing the `Accept` event with `Accepting` and using `e.Handled` for event processing. Updated threading examples to use `App?.Invoke()` or `app.Invoke()` for UI updates. Cleaned up redundant code and redefined modal behavior for better consistency.

These changes modernize the `Terminal.Gui` library, improving clarity, usability, and maintainability while ensuring backward compatibility where possible.

* Refactor: Replace Toplevel with Runnable class

This commit introduces a major architectural update to the `Terminal.Gui` library, replacing the legacy `Toplevel` class with the new `Runnable` class. The changes span the entire codebase, including core functionality, tests, documentation, and configuration files.

- **Core Class Replacement**:
  - Replaced `Toplevel` with `Runnable` as the base class for modal views and session management.
  - Updated all references to `Toplevel` in the codebase, including constructors, methods, and properties.

- **Configuration Updates**:
  - Updated `tui-config-schema.json` to reflect the new `Runnable` scheme.

- **New Classes**:
  - Added `UICatalogRunnable` for managing the UI Catalog application.
  - Introduced `Runnable<TResult>` as a generic base class for blocking sessions with result handling.

- **Documentation and Tests**:
  - Updated documentation to emphasize `Runnable` and mark `Toplevel` as obsolete.
  - Refactored test cases to use `Runnable` and ensure compatibility.

- **Behavioral Improvements**:
  - Enhanced lifecycle management and alignment with the `IRunnable` interface.
  - Improved clarity and consistency in naming conventions.

These changes modernize the library, improve flexibility, and provide a clearer architecture for developers.

* Refactor: Consolidate Runnable classes and decouple View from ApplicationImpl

- Made Runnable<TResult> inherit from Runnable (eliminating ~180 LOC duplication)
- Moved View init/layout/cursor logic from ApplicationImpl to Runnable lifecycle events
- ApplicationImpl.Begin now operates purely on IRunnable interface

Related to #4419

* Simplified the disposal logic in `ApplicationImpl.Run.cs` by replacing
the type-specific check for `View` with a more general check for
`IDisposable`. This ensures proper disposal of any `IDisposable`
object, improving robustness.

Removed the `FrameworkOwnedRunnable` property from the `ApplicationImpl`
class in `ApplicationImpl.cs` and the `IApplication` interface in
`IApplication.cs`. This eliminates the need to manage this property,
reducing complexity and improving maintainability.

Updated `application.md` to reflect the removal of the
`FrameworkOwnedRunnable` property, ensuring the documentation aligns
with the updated codebase.

* Replaces the legacy `Shutdown()` method with `Dispose()` to align
with the `IDisposable` pattern, ensuring proper resource cleanup
and simplifying the API. The `Dispose()` method is now the
recommended way to release resources, with `using` statements
encouraged for automatic disposal.

Key changes:
- Marked `Shutdown()` as obsolete; it now internally calls `Dispose()`.
- Updated the fluent API to remove `Shutdown()` from chaining.
- Enhanced session lifecycle management for thread safety.
- Updated tests to validate proper disposal and state reset.
- Improved `IRunnable` integration with automatic disposal for
  framework-created runnables.
- Maintained backward compatibility for the legacy static
  `Application` singleton.
- Refactored documentation and examples to reflect modern practices
  and emphasize `Dispose()` usage.

These changes modernize the `Terminal.Gui` lifecycle, improve
testability, and encourage alignment with .NET conventions.

* Refactor runnable app context handling in ApplicationImpl

Refactor how the application context is set for `runnable` objects
by introducing a new `SetApp` method in the `IRunnable` interface.
This replaces the previous logic of directly setting the `App`
property for `View` objects, making the process more generic and
encapsulated within `IRunnable` implementations.

Simplify `Mouse.UngrabMouse()` by removing the conditional check
and calling it unconditionally.

Make a minor formatting adjustment in the generic constraint of
`Run<TRunnable>` in `ApplicationImpl`.

Add `SetApp(IApplication app)` to the `IRunnable` interface and
implement it in the `Runnable` class to set the `App` property
to the provided application instance.

* Improve docs, tests, and modularity across the codebase

Reorganized and updated `CONTRIBUTING.md`:
- Added **Key Architecture Concepts** section and reordered the table of contents.
- Updated testing requirements to discourage legacy patterns.
- Added instructions for replicating CI workflows locally.
- Clarified PR guidelines and coding style expectations.

Enhanced `README.md` with detailed CI/CD workflow documentation.

Refactored `ColorPicker.Prompt` to use `IApplication` for improved modularity and testability.

Introduced `IApplicationScreenChangedTests` for comprehensive testing of `ScreenChanged` events and `Screen` property.

Refactored `ApplicationScreenTests` and `TextView.PromptForColors` to align with modern patterns.

Updated `Terminal.sln` to include `.github/workflows/README.md`.

Performed general cleanup:
- Removed outdated documentation links.
- Improved XML documentation and coding consistency.

* readme tweaks

* Improve thread safety, layout, and test coverage

Refactored `OutputBufferImpl.cs` to enhance thread safety by locking shared resources and adding bounds checks for columns and rows. Improved handling of wide characters and removed outdated TODO comments.

Updated `Runnable.cs` to call `SetNeedsDraw()` on modal state changes, ensuring proper layout and drawing updates. Simplified layout handling in `ApplicationImpl.Run.cs` by replacing redundant comments with a `LayoutAndDraw()` call.

Added a check in `AllViewsTester.cs` to skip creating instances of `RunnableWrapper` types with unsatisfiable generic constraints, logging a warning when encountered.

Enhanced `ListViewTests.cs` by adding explicit `app.LayoutAndDraw()` calls to validate visual output and ensure tests reflect the updated application state.

These changes improve robustness, prevent race conditions, and ensure consistent behavior across the application.

* Refactor: Rename Toplevel to Runnable and update logic

Updated the `Border` class to use `Command.Quit` instead of
`Command.QuitToplevel` in the `CloseButton.Accept` handler.

Renamed test methods in `GetViewsAtLocationTests.cs` to replace
"Toplevel" with "Runnable" for consistency. Updated `Runnable<bool>`
instances to use "topRunnable" as the `Id` property.

These changes align the codebase with updated naming conventions
and improve clarity.

* Removed `ToplevelTests` and migrated relevant test cases to
`MouseDragTests` with improved structure and coverage. Updated
tests to use `Application.Create`, `app.Begin`, and `app.End`
for better resource management and lifecycle handling.

Replaced direct event handling with `app.Mouse.RaiseMouseEvent`
to align with the application's event-handling mechanism. Added
`Runnable` objects to ensure views are properly initialized and
disposed of within the application context.

Enhanced tests to include assertions for minimum width and
height constraints during resize operations. Removed redundant
tests and streamlined logic to reduce duplication and improve
maintainability.

* Reorged Unit Test namespaces.

* more

* Refactor tests and update namespaces for consistency

Updated namespaces in `ArrangementTests.cs` and `MouseDragTests.cs` for better organization. Enhanced `ArrangementTests.cs` with additional checks for arrangement flags. Reformatted and re-added `MouseDragTests.cs` and `SchemeTests.cs` with modern C# features like nullable annotations and object initializers. Ensured no functional changes while improving code clarity and consistency.

* Fix nullability warnings in MouseDragTests.cs

Updated `app.End` calls to use the null-forgiving operator (`!`)
on `app.SessionStack` to ensure it is treated as non-null.
This change addresses potential nullability warnings and
improves code safety and clarity. Applied consistently across
all relevant test cases in the `MouseDragTests` class.
2025-12-01 12:54:21 -07:00

732 lines
32 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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

<!--
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 [Runnable.Modal](~/api/Terminal.Gui.Views.Runnable.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 [Runnable](~/api/Terminal.Gui.Views.Runnable.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 type-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 [Runnable](~/api/Terminal.Gui.Views.Runnable.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
```
## [Runnable](~/api/Terminal.Gui.Views.Runnable.yml)
Runnable 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.