mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
cab22566ea
* upgraded to gitversion 6 2 * Remove invalid prevent-increment property * upgraded to gitversion 6 3 * Fixed gitversion * touching publish.yml * cleanup * Fixes #4000. Named colors as enums. (#4005) * Add W3C color enum with the RGB as numeric value * Add transform helper class for W3cColor enum For the sake of backwards compatibility prioritize parsing 16 color mode color names over the W3C colors because the previous resource-based color names/values had a mix of W3C and 16 color mode RGB values. Mechanism for choosing/prioritizing one color scheme over the other is currently only available at higher application/driver/output level. * IColorNameResolver enable null analysis * Remove obsolete color name related ResourceManagerTests * Replace remains of W3CColors with direct W3C color name resolver Temporarily breaks backwards compatibility and tests even further. * Add ANSI 4-bit (ColorName16) color name resolver * Add multi-standard color name resolver Combined resolver for both ANSI 4-bit (ColorName16) and W3C colors while trying to maintain backwards compatibility for ColorPicker. * Split conditional name resolver test cases * Change W3C colors tests to be similar to name resolvers * Change W3cColorsTests to W3cColorNameResolverTests More consistent when all the tests refer to the color name resolver layer. * Make W3cColors internal Color name resolver is the public interface. * W3cColors: Use Color.Argb instead of individual RGB components * MultiStandardColorNameResolver: Substitute instead of blocking alternative W3C names Changes color picker behavior a bit, e.g. Aqua will match to Cyan instead of jumping to Aquamarine. * Remove leftover color string resources * Consistent position for IColorNameResolver #nullable enable directive * Add missing XML comments to ColorScheme.Colors.cs * Fixes #3691 - Adds `ViewArrangement.Popover` (#3852) * Added Applicaton.Popover. Refactored FindDeepestView * Popover prototype * Testing highlight * Fixed click outside issue * Fixed DialogTests * Fixed click outside issue (agbain) * Enabled mouse wheel in Bar * Enabled mouse wheel in Bar * Progress. Broke arrangement * Added popover tests. Fixed a bunch more CM issues related ot unreliable unit tests. Updated config.json to include Glyphs. * Can't set ForceDriver to empty in Resources/config.json. * added BUGBUG * Made Position/ScreenPosition clear * Added View.IsInHierarchy tests * Added Contextmenuv2 scenario. * Implemented CM2 in TextView * Removed unneeded CM stuff from testhelpers * Shortcut API docs * Fixed keybinding unit tests * Fixed mouse handling * Fighting with CM related unit test failures * Unit tests pass. I think. * Shortcut code cleanup * TextView uses new CM2 * Starting on OnSelect etc... * Starting on OnSelect etc... * Fixed ContextMenuv2 * ContextMenu is working again. * Ugh. ANd fixed button api docs * Fixed DrawHorizontalShadowTransparent (vertical was already fixed). * Made Scenarios compatible with #nullable enable * Undid some keybinding stuff * Fixed stuff * Sped up unit tests * Sped up unit tests 2 * Sped up unit tests 3 * Messing with menus * merged latest v2_develop * Added more Popover unit tests * Added more Popover unit tests2 * Fixed positioning bug * Fixed mouse bug * Fixed Bar draw issue * WIP * merge v2_develop * CM2 sorta works * Enabled Bar subclasses to have IDesignable * Added ViewportSettings.Transparent * Region -> nullable enable * Added ViewportSettigs Editor * merged v2_develop part 2 * merged v2_develop part 3 * WIP: GetViewsUnderMouse * WIP: More GetViewsUnderMouse work * Bars works again * Added unit tests * CM now works * MenuItemv2 POC * SubMenu POC * CommandNotBound * More POC * Optimize Margin to not defer draw if there's no shadow * Logger cleanup * Reverted Generic * Cascading mostly working * fixed layout bug * API docs * API docs * Fixed cascade * Events basically work * code cleanup * Fixed IsDefault bug; * Enabled hotkey support * Made context-menu-like * Improved usability * Refactored ApplicationPopover again * Cleanup * Menuv2 POC basically complete * Code Cleanup * Made menu API simpler * Fixed Strings bugs * Got old ContextMenu scenario mostly working * ContextMenu scenario now works * ContextMenu fixes * ContextMenu fixes * Tons of menu cleanup * ContextMenu works in TextView * Fixed unit tes * Added unit tests * Fixed tests * code cleanup * More code cleanup * Deep dive * scenario * typos * Demo colorpicker in a Menu * Added Region tests proving Region is broken in some Union cases * fixed v2win/net * Partially Fixes #2975 - Replaces old `ContextMenu` with new `Bar/Shortcut` based implementation (#4008) * touching publish.yml * Nuked ContextMenuv2 - use PopverMenu instead * WIP context menu stuff * More robust dispose * Removed ConextMenu; use PopoverMenu instead * Code cleanup * Code cleanup2 * Partially Fixes #2975 - Upgrades UICatalog to `Menuv2` (#4011) * Fixes #4009 - fix tree ordering (#4015) * Fixes #4022 file dialog tests and bugfix for cancellation (#4024) * Add class for detecting information about console in extensible way * WIP - Create test for reordering * Change Dictionary to List and preserve TreeBuilder order * Add test to ensure branch expansion/status remains consistent despite reorder * Cleanup code * Fix regression when removed child was the selected one * Revert "Add class for detecting information about console in extensible way" This reverts commit7e4253cf28. * Code cleanup and enable nullable on Branch * Remove color scheme and driver from Branch draw * Add xunit context extensions * Investigate codegen for xunit * Getting closer to something that works * Fix code generation * Further explore code gen * Generate all methods in single class for easier extensibility * Simplify code gen by moving parameter creation to its own method * Implement asserts A-I * Add remaining assert calls that are not obsolete * Fix unit test * Roll back versions to be compatible with CI version of csharp * Handle params and ref etc * Fix null warning * WIP - start to add integration tests for FileDialog * Add ability to tab focus to specific control with simple one line delegate * Clarify test criteria * Add unit tests for Ok and other ways of canceling dialog * Fix other buttons also triggering save * Fix for linux environment tests * Fix for linux again * Fix application null race condition - add better way of knowing if stuff is finished * Better fix for shutdown detection * Add test that shows #4026 is not an issue * Switch to `_fileSystem.Directory.GetLogicalDrives ()` * Don't show duplicate MyDocuments etc * Partial on #2975 - Replaces Menu v1 in many places with v2 (#4040) * touching publish.yml * Fixed UICatalog bugs. Added fluent tests. * marked v1 menu stuff as obsolte * Tweaks. Added View.GetSubMenus<type>(). * fixed unit tests * general messing around * general messing around * Playing with Fluent * ColorScheme tweaks * WIP: ColorScheme tweaks * Playing with Fluent * Merged from laptop2 * Hacky-ish fixes to: - #4016 - #4014 * Fixed Region bug preventing menus without borders from working * Tweaks * Fixed a bunch of CM issues * Fixed OoptionSelector * ip * FixedCM issues * Fixed CM issues2 * Revert "FixedCM issues" This reverts commitdd6c6a70a3. * Reverted stuff * Found and fixed bug in AllViews_Center_Properly * Fixed CM issues2 * removed menuv2 onapplied. Changed how UICatalog Applys CM * changed test time out to see if it helkps with ubuntu fails * reset app on fail? * back to 1500ms * Made StatusBar nullable. * Code Cleanup. * HexEditor Code Cleanup. * HexEditor Code Cleanup. * Back to 3000ms. Sigh. * Trying different logic * Trying different logic2 * Fixed potential crash in runlop * Fixed potential crash in runlop2 * Tweaked Spinner stuff * Removed TabView from TextEffects scenario. Not needed and possible culprit. * back to 2000ms * WIP: Revamping menu scenarios * Menu Scenario refinements. Fixed a few bugs. Code cleanup. * fixed unit test * Fixed warnings * Fixed warnings2 * Fixed File.Exit * WIP: Dealing with QuitKey struggles * WIP: Dealing with QuitKey struggles 2 * WIP: Dealing with QuitKey struggles 3 * Fixed ListView collection nav bug * Fixed a bunch of menu stuff. Fixed Appv2 stuff. * Lots of refactoring and fixing * Lots of unit test issues * Fixed DebugIDisposable issues * Fixed release build issue * Fixed release build issue 2 * DebugIDisposable -> EnableDebugIDisposableAsserts and more * DebugIDisposable -> EnableDebugIDisposableAsserts and more 2 * Fixed Menus scenario - context menu * Added @bdisp suggested assert. Commented it out as it breaks tests. * Code cleanup * Fixed disposed but * Fixed UICatalog exit * Fixed Unit test I broke. Added 'Minimal' Theme that turns off all borders etc... * Fixes #3966. TextField crashes app when pasting unicode surrogate pair (#3982) * Add constructor Key(int) and operator for handled with non-Bmp. * Fix TextField non-BMP issues * Fix TextField PositionCursor. * Reformat * Add IsValidInput method to handle clipboard paste when pressing CTRL+V in WT * Add handle IsValidInput in FakeDriver and unit tests * Fixes #3984 - `Margin` w/out shadow should not force draw (#3985) * shortcut tests * Generic demos * Optimize Margin to not defer draw if there's no shadow * Fixes #4041. WSLClipboard doesn't handles well with surrogate pairs * Avoid running Clipboard.Contents twice * Fixes #4042. Microsoft.VisualStudio.TestPlatform.ObjectModel.TestPlatformException: Could not find testhost * Moving tests to the parallelizable unit tests * Remove unused folder * Prevent warnings about not installed nuget packages * Using Toplevel instead of Application.Top * Cleanup code --------- Co-authored-by: Tig <tig@users.noreply.github.com> * Goblin fighter (#4037) * touching publish.yml * WIP Investigate how to build random maze * Fix maze rendering * Use line canvas for rendering * Move around the maze * Code cleanup * Infinite maze * Fight goblins * Generate new npcs on new maps * Code cleanup * Make it possible to die * Fix variable naming * Refactored Mazing to use Commmands and KeyBindings. Code cleanup of Mazing. Refactored Snake to use KeyBindings/Commmands + some code cleanup * Fix bug where your health would regenerate when reaching end making it impossible to loose. --------- Co-authored-by: Tig <tig@users.noreply.github.com> * Fixes #4046 - Moves examples into `./Examples` and fixes `./Tests` (#4047) * touching publish.yml * Moved Examples into ./Examples * Moved Benchmarks into ./Tests * Moved Benchmarks into ./Tests * Moved UICatalog into ./Examples * Moved UICatalog into ./Examples 2 * Moved tests into ./Tests * Updated nuget * Fixes #4027. Add collection search matcher (#4029) * Add collection search matcher * Fix naming * fix naming * Move FileDialogCollectionNavigator to its own file (no longer private class) Add class diagram for collectionNavigation * Add ICollectionNavigator interface * Move to separate file IListCollectionNavigator * Update class diagram * update class diagram * Add tests for overriding ICollectionNavigatorMatcher * xmldoc and nullability warning fixes * Code Cleanup * Make requested changes to naming and terminology * Move to seperate namespace * Update class diagram and change TreeView to reference the interface not concrete class * Switch to implicit new * highlight that this class also works with tree view * Apply tig patch to ensure keybindings get priority over navigator See: https://github.com/gui-cs/Terminal.Gui/issues/4027#issuecomment-2810020893 * Apply 'keybinding has priority' fix to TreeView too * Apply 'keybindngs priority over navigation' fix to TableView * Remove entire branch for selectively returning false now that it is default when there is a keybinding collision * Make classes internal and remove 'custom' navigator that was configured in UICatlaogToplevel * Change logging in collection navigator from Trace to Debug * Switch to NewKeyDownEvent and directly setting HasFocus * Remove application top dependency * Remove references to application * Remove Application * Move new tests to parallel --------- Co-authored-by: Tig <tig@users.noreply.github.com> * Fixes #4051 - Adds `cancellable_work_pattern.md` (#4052) * touching publish.yml * Updated md files * Updated md files 2 * Updated md files 3 * Updated API docs to point * commmand->command * Update Terminal.Gui/View/View.Command.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update getting-started.md (#4063) * Fixes #4035 - FileDialog keeps path when selecting folder (optionally) (#4065) * WIP keep path * Make new 'sticky filename' behaviour optional * Tests for new behaviour when selecting in TreeView * Add more tests, this time for table view navigation * Add the new style option into UICatalog scenario * Allow hotkey specifier to be at any position in label (#4067) Allow hotkey specifier to be at any position in label "D_irectory" doesn't work because hotPos is hardcoded 0 * Fixes #4053. v2 WindowsDriver and v2win doesn't show any scenario in the UICatalog with cmd or conhost (#4055) * Fix WindowsDriver to work with non-WindowsTerminal * Fix unit test failure * Fix v2win to work with non-WindowsTerminal * Force16Colors isn't being setting in v2win driver on changing. --------- Co-authored-by: Tig <tig@users.noreply.github.com> * Fixes #4023 - Changes `CommandEventArgs` to be based on `HandledEventArgs` instead of `CancelEventArgs` (#4054) * touching publish.yml * CancelEventArgs->HandledEventArgs * Fixed Handled issues * Fixes #4076 cursor text field (#4077) * Add test for TextField cursor position * Add comment and one more assert * Fix cursor position at the end * Remove unused local field --------- Co-authored-by: BDisp <bd.bdisp@gmail.com> * Fixes #4074 - Popover eats `Key.Space` (#4075) * touching publish.yml * Added unit tests. Fixed * Actually fixed bug. * Addres Bdisp feedback * Addres Bdisp feedback2 * Addresses #4058. Basic support for non-color text styles. (#4071) * TextStyle enum * CSI_AppendTextStyleChange * Add TextStyle to Attribute * Apply text style in NetOutput.Write() * Don't append escape code if nothing to change * Make TextStyle an init property * Apply TextStyle to OutputBuffer attributes * Fix flag checking Misunderstood how Enum.HasFlag worked, fixed now * Allow bold-faint text Also adds remarks to TextStyle noting that they may be incompatible depending on terminal settings. * Remove unnecessary check Realized it's actually impossible for no escape codes to be added, as this is only the case when prev and next are the same, which is already accounted for. * Remove redundant check Attributes are records, and thus already use equality-by-value, meaning attr != redrawAttr will already be false when the TextStyle changes. * WindowsOutput support for text style --------- Co-authored-by: Tig <tig@users.noreply.github.com> * More on #4058 - Adds `TextStyle` Scenario (#4079) * Fixed Generic.cs. Added TextStyles Scenario. * Code cleanup * Fixes #4070 - `GetContentSize()` api docs (#4081) * touching publish.yml * Fixed api docs * Fixes #4070 - `GetContentSize()` API docs -2nd try (#4082) * Fixed api docs again * Fixes 4088 mouse released flag cannot be combined safely with report position (#4091) * added more mouse under tests * Fixes #4057 - MASSIVE! Fully implements `ColorScheme`->`Scheme` + `VisualRole` + `Colors.`->`SchemeManager.` (#4062) * touching publish.yml * ColorScheme->Scheme * ColorScheme->Scheme 2 * Prototype of GetAttributeForRole * Badly broke CM * Further Badly broke CM * Refactored CM big-time. View still broken * All unit test pass again. Tons added. CM is still WIP, but Schemes is not mostly refactored and working. * Actually: All unit test pass again. Tons added. CM is still WIP, but Schemes is not mostly refactored and working. * Bug fixes. DeepMemberWiseClone cleanup * Further cleanup of Scope<T>, ConfigProperty, etc. * Made ConfigManager thread safe. * WIP: Broken * WIP: new deep clone impl * WIP: new deep clone impl is done. Now fixing CM * WIP: - config.md - Working on AOT clean up - Core CM is broken; but known. * WIP * Merged. Removed CM from Application.Init * WIP * More WIP; Less broke * All CM unit tests pass... Not sure if it actually works though * All unit tests pass... Themes are broken though in UI Cat * CM Ready for review? * Fixed failures due to TextStyles PR * Working on Scheme/Attribute * Working on Scheme/Attribute 2 * Working on Scheme/Attribute 3 * Working on Scheme/Attribute 4 * Working on Scheme/Attribute 5 * Working on Scheme/Attribute 6 * Added test to show how awful memory usage is * Improved schema. Updated config.json * Nade Scope<T> concurrentdictionary and added test to prove * Made Themes ConcrurrentDictionary. Added bunches of tests * Code cleanup * Code cleanup 2 * Code cleanup 3 * Tweaking Scheme * ClearJsonErrors * ClearJsonErrors2 * Updated Attribute API * It all (mostly) works! * Skip odd unit test * Messed with Themes * Theme tweaks * Code reorg. New .md stuff * Fixed Enabled. Added mock driver * Fixed a bunch of View.Enabled related issues * Scheme -> Get/SetScheme() * Cleanup * Cleanup2 * Broke something * Fixed everything * Made CM.Enable better * Text Style Scenario * Added comments * Fixed UI Catalog Theme Changing * Fixed more dynamic CM update stuff * Warning cleanup * New Default Theme * fixed unit test * Refactoring Scheme and Attribute to fix inheritance * more unit tests * ConfigProperty is not updating schemes correctly * All unit tests pass. Code cleanup * All unit tests pass. Code cleanup2 * Fixed unit tests * Upgraded TextField and TextView * Fixed TextView !Enabled bug * More updates to TextView. More unit tests for SchemeManager * Upgraded CharMap * API docs * Fixe HexView API * upgrade HexView * Fixed shortcut KeyView * Fixed more bugs. Added new themes * updated themes * upgraded Border * Fixed themes memory usage...mostly * Fixed themes memory usage...mostly2 * Fixed themes memory usage...2 * Fixed themes memory usage...3 * Added new colors * Fixed GetHardCodedConfig bug * Added Themes Scenario - WIP * Added Themes Scenario * Tweaked Themes Scenario * Code cleanup * Fixed json schmea * updated deepdives * updated deepdives * Tweaked Themes Scenario * Made Schemes a concurrent dict * Test cleanup * Thread safe ConfigProperty tests * trying to make things more thread safe * more trying to make things more thread safe * Fixing bugs in shadowview * Fixing bugs in shadowview 2 * Refactored GetViewsUnderMouse to GetViewsUnderLocation etc... * Fixed dupe unit tests? * Added better description of layout and coordiantes to deep dive * Added better description of layout and coordiantes to deep dive * Modified tests that call v2.AddTimeout; they were returning true which means restart the timer! This was causing mac/linux unit test failures. I think * Fixed auto scheme. Broke TextView/TextField selection * Realized Attribute.IsExplicitlySet is stupid; just use nullable * Fixed Attribute. Simplified. MOre theme testing * Updated themes again * GetViewsUnderMouse to GetViewsUnderLocation broke TransparentMouse. * Fixing mouseunder bugs * rewriting... * All working again. Shadows are now slick as snot. GetViewsUnderLocation is rewritten to actually work and be readable. Tons more low-level unit tests. Margin is now actually ViewportSettings.Transparent. * Code cleanup * Code cleanup * Code cleanup of color apis * Fixed Hover/Highlight * Update Examples/UICatalog/Scenarios/AllViewsTester.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Examples/UICatalog/Scenarios/Clipping.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fixed race condition? * reverted * Simplified Attribute API by removing events from SetAttributeForRole * Removed recursion from GetViewsAtLocation * Removed unneeded code * Code clean up. Fixed Scheme bug. * reverted temporary disable * Adjusted scheme algo * Upgraded TextValidateField * Fixed TextValidate bugs * Tweaks * Frameview rounded border by default * API doc cleanup * Readme fix * Addressed tznind feeback * Fixed more unit test issues by protecting Application statics from being set if Application.Initialized is not true * Fixed more unit test issues by protecting Application statics from being set if Application.Initialized is not true 2 * cleanup --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Removed API key2? * Simplified usings * Cleand up curses. Fixed css * One proposal * Proposal 2 * Clean up * Fixed API docs * Auto gen list of views * Auto gen list of views * More API doc cleanup * TextValidateField IDesignable * regen view.md * Fixed unit test failure * Clean up * Fixed CM editor bug * Removed dupe file * Deep dive clean up * Fixed warnings --------- Co-authored-by: Tonttu <15074459+TheTonttu@users.noreply.github.com> Co-authored-by: Thomas Nind <31306100+tznind@users.noreply.github.com> Co-authored-by: BDisp <bd.bdisp@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Brandon G <bgiromini@users.noreply.github.com> Co-authored-by: M3Logic <joe.bailey@m3logic.com> Co-authored-by: Error-String-Expected-Got-Nil <103805191+Error-String-Expected-Got-Nil@users.noreply.github.com>
758 lines
33 KiB
Markdown
758 lines
33 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_ ¡ ¢ £ ¤ ¥ ¦ § ¨ © ª « ¬ ░
|
||
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\<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
|
||
|
||
```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\<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 │ │┃
|
||
┃│\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\<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).
|
||
|
||
```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\<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.
|
||
|
||
|