mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
Updated docs; regeneraged docs (#1881)
This commit is contained in:
Tig Kindel
GitHub
@@ -106,9 +106,9 @@ Views
|
||||
=====
|
||||
|
||||
All visible elements on a Terminal.Gui application are implemented as
|
||||
[Views](~/api/Terminal.Gui/Terminal.Gui.View.yml). Views are self-contained
|
||||
objects that take care of displaying themselves, can receive keyboard and mouse
|
||||
input and participate in the focus mechanism.
|
||||
[Views](~/api/Terminal.Gui/Terminal.Gui.View.yml). Views are self-contained objects that take care of displaying themselves, can receive keyboard and mouse input and participate in the focus mechanism.
|
||||
|
||||
See the full list of [Views provided by the Terminal.Gui library here](views.md).
|
||||
|
||||
Every view can contain an arbitrary number of children views. These are called
|
||||
the Subviews. You can add a view to an existing view, by calling the
|
||||
@@ -138,36 +138,6 @@ void SetupMyView (View myView)
|
||||
The container of a given view is called the `SuperView` and it is a property of every
|
||||
View.
|
||||
|
||||
*Terminal.Gui* provides a rich set of views and controls for building terminal user interfaces:
|
||||
|
||||
* [Button](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Button.html)
|
||||
* [CheckBox](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.CheckBox.html)
|
||||
* [ColorPicker](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ColorPicker.html)
|
||||
* [ComboBox](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ComboBox.html)
|
||||
* [Dialog](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Dialog.html)
|
||||
* [OpenDialog](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.OpenDialog.html)
|
||||
* [SaveDialog](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.SaveDialog.html)
|
||||
* [FrameView](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.FrameView.html)
|
||||
* [GraphView](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.GraphView.html)
|
||||
* [Hex viewer/editor](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.HexView.html)
|
||||
* [Label](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Label.html)
|
||||
* [ListView](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ListView.html)
|
||||
* [Menu](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.MenuBar.html)
|
||||
* [MessageBox](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.MessageBox.html)
|
||||
* [ProgressBar](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html)
|
||||
* [Radio buttons](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html)
|
||||
* [TableView](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TableView.html)
|
||||
* [Time & Date Fields](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TimeField.html)
|
||||
* [TextField](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TextField.html)
|
||||
* [TextValidateField](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html)
|
||||
* [TextView (Text Editor)](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TextView.html)
|
||||
* [TreeView](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TreeView.html)
|
||||
* [ScrollView](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ScrollView.html)
|
||||
* [ScrollBarView](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html)
|
||||
* [StatusBar](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.StatusBar.html)
|
||||
* [Window](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Window.html)
|
||||
* [Wizard](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Wizard.html)
|
||||
|
||||
Layout
|
||||
------
|
||||
|
||||
|
||||
@@ -1,29 +1,31 @@
|
||||
*Terminal.Gui* provides a rich set of views and controls for building terminal user interfaces:
|
||||
|
||||
* [Button](~/api/Terminal.Gui/Terminal.Gui.Button.html)
|
||||
* [CheckBox](~/api/Terminal.Gui/Terminal.Gui.CheckBox.html)
|
||||
* [ColorPicker](~/api/Terminal.Gui/Terminal.Gui.ColorPicker.html)
|
||||
* [ComboBox](~/api/Terminal.Gui/Terminal.Gui.ComboBox.html)
|
||||
* [Dialog](~/api/Terminal.Gui/Terminal.Gui.Dialog.html)
|
||||
* [OpenDialog](~/api/Terminal.Gui/Terminal.Gui.OpenDialog.html)
|
||||
* [SaveDialog](~/api/Terminal.Gui/Terminal.Gui.SaveDialog.html)
|
||||
* [FrameView](~/api/Terminal.Gui/Terminal.Gui.FrameView.html)
|
||||
* [GraphView](~/api/Terminal.Gui/Terminal.Gui.GraphView.html)
|
||||
* [Hex viewer/editor](~/api/Terminal.Gui/Terminal.Gui.HexView.html)
|
||||
* [Label](~/api/Terminal.Gui/Terminal.Gui.Label.html)
|
||||
* [ListView](~/api/Terminal.Gui/Terminal.Gui.ListView.html)
|
||||
* [Menu](~/api/Terminal.Gui/Terminal.Gui.MenuBar.html)
|
||||
* [MessageBox](~/api/Terminal.Gui/Terminal.Gui.MessageBox.html)
|
||||
* [ProgressBar](~/api/Terminal.Gui/Terminal.Gui.ProgressBar.html)
|
||||
* [Radio buttons](~/api/Terminal.Gui/Terminal.Gui.RadioGroup.html)
|
||||
* [TableView](~/api/Terminal.Gui/Terminal.Gui.TableView.html)
|
||||
* [Time & Date Fields](~/api/Terminal.Gui/Terminal.Gui.TimeField.html)
|
||||
* [TextField](~/api/Terminal.Gui/Terminal.Gui.TextField.html)
|
||||
* [TextValidateField](~/api/Terminal.Gui/Terminal.Gui.TextValidateField.html)
|
||||
* [TextView (Text Editor)](~/api/Terminal.Gui/Terminal.Gui.TextView.html)
|
||||
* [TreeView](~/api/Terminal.Gui/Terminal.Gui.TreeView.html)
|
||||
* [ScrollView](~/api/Terminal.Gui/Terminal.Gui.ScrollView.html)
|
||||
* [ScrollBarView](~/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html)
|
||||
* [StatusBar](~/api/Terminal.Gui/Terminal.Gui.StatusBar.html)
|
||||
* [Window](~/api/Terminal.Gui/Terminal.Gui.Window.html)
|
||||
* [Wizard](~/api/Terminal.Gui/Terminal.Gui.Wizard.html)
|
||||
* [Button](~/api/Terminal.Gui/Terminal.Gui.Button.html) - A View that provides an item that invokes an System.Action when activated by the user.
|
||||
* [CheckBox](~/api/Terminal.Gui/Terminal.Gui.CheckBox.html) - Shows an on/off toggle that the user can set.
|
||||
* [ColorPicker](~/api/Terminal.Gui/Terminal.Gui.ColorPicker.html) - Enables to user to pick a color.
|
||||
* [ComboBox](~/api/Terminal.Gui/Terminal.Gui.ComboBox.html) - Provides a drop-down list of items the user can select from.
|
||||
* [Dialog](~/api/Terminal.Gui/Terminal.Gui.Dialog.html) - A pop-up Window that contains one or more Buttons.
|
||||
* [OpenDialog](~/api/Terminal.Gui/Terminal.Gui.OpenDialog.html) - A Dialog providing an interactive pop-up Window for users to select files or directories.
|
||||
* [SaveDialog](~/api/Terminal.Gui/Terminal.Gui.SaveDialog.html) - A Dialog providing an interactive pop-up Window for users to save files.
|
||||
* [FrameView](~/api/Terminal.Gui/Terminal.Gui.FrameView.html) - A container View that draws a frame around its contents. Similar to a GroupBox in Windows.
|
||||
* [GraphView](~/api/Terminal.Gui/Terminal.Gui.GraphView.html) - A View for rendering graphs (bar, scatter etc).
|
||||
* [Hex viewer/editor](~/api/Terminal.Gui/Terminal.Gui.HexView.html) - A hex viewer and editor that operates over a file stream.
|
||||
* [Label](~/api/Terminal.Gui/Terminal.Gui.Label.html) - Displays a string at a given position and supports multiple lines.
|
||||
* [ListView](~/api/Terminal.Gui/Terminal.Gui.ListView.html) - Displays a scrollable list of data where each item can be activated to perform an action.
|
||||
* [MenuBar](~/api/Terminal.Gui/Terminal.Gui.MenuBar.html) - Provides a menu bar with drop-down and cascading menus.
|
||||
* [MessageBox](~/api/Terminal.Gui/Terminal.Gui.MessageBox.html) - Displays a modal (pup-up) message to the user, with a title, a message and a series of options that the user can choose from.
|
||||
* [ProgressBar](~/api/Terminal.Gui/Terminal.Gui.ProgressBar.html) - Displays a progress Bar indicating progress of an activity.
|
||||
* [RadioGroup](~/api/Terminal.Gui/Terminal.Gui.RadioGroup.html) - Displays a group of labels each with a selected indicator. Only one of those can be selected at a given time
|
||||
* [ScrollView](~/api/Terminal.Gui/Terminal.Gui.ScrollView.html) - Present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView.
|
||||
* [ScrollBarView](~/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html) - display a 1-character scrollbar, either horizontal or vertical.
|
||||
* [StatusBar](~/api/Terminal.Gui/Terminal.Gui.StatusBar.html) - A View that snaps to the bottom of a Toplevel displaying set of status items. Includes support for global app keyboard shortcuts.
|
||||
* [TableView](~/api/Terminal.Gui/Terminal.Gui.TableView.html) - A View for tabular data based on a System.Data.DataTable.
|
||||
* [TimeField](~/api/Terminal.Gui/Terminal.Gui.TimeField.html) & [DateField](~/api/Terminal.Gui/Terminal.Gui.TimeField.html) - Enables structured editing of dates and times.
|
||||
* [TextField](~/api/Terminal.Gui/Terminal.Gui.TextField.html) - Provides a single-line text entry.
|
||||
* [TextValidateField](~/api/Terminal.Gui/Terminal.Gui.TextValidateField.html) - Text field that validates input through a ITextValidateProvider.
|
||||
* [TextView](~/api/Terminal.Gui/Terminal.Gui.TextView.html)- A multi-line text editing View supporting word-wrap, auto-complete, context menus, undo/redo, and clipboard operations,
|
||||
* [TopLevel](~/api/Terminal.Gui/Terminal.Gui.Toplevel.html) - The base class for modal/pop-up Windows.
|
||||
* [TreeView](~/api/Terminal.Gui/Terminal.Gui.TreeView.html) - A hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder.
|
||||
* [View](!/api/Terminal.Gui/Terminal.Gui.View.html) - The base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.
|
||||
* [Window](~/api/Terminal.Gui/Terminal.Gui.Window.html) - A Toplevel view that draws a border around its Frame with a title at the top.
|
||||
* [Wizard](~/api/Terminal.Gui/Terminal.Gui.Wizard.html) - Provides navigation and a user interface to collect related data across multiple steps.
|
||||
|
||||
@@ -4,34 +4,32 @@
|
||||
"src": [
|
||||
{
|
||||
"files": [
|
||||
"Terminal.Gui.csproj"
|
||||
"Terminal.Gui.dll"
|
||||
],
|
||||
"exclude": [
|
||||
"**/obj/**",
|
||||
"**/bin/**",
|
||||
"_site/**"
|
||||
],
|
||||
"src": "../Terminal.Gui"
|
||||
"src": "../Terminal.Gui/bin/Release/net6.0"
|
||||
}
|
||||
],
|
||||
"dest": "api/Terminal.Gui",
|
||||
"shouldSkipMarkup": true,
|
||||
"properties": {
|
||||
"TargetFramework": "netstandard2.0"
|
||||
"TargetFramework": "net6.0"
|
||||
}
|
||||
},
|
||||
{
|
||||
"src": [
|
||||
{
|
||||
"files": [
|
||||
"UICatalog.csproj"
|
||||
"UICatalog.dll"
|
||||
],
|
||||
"exclude": [
|
||||
"**/obj/**",
|
||||
"**/bin/**",
|
||||
"_site/**"
|
||||
],
|
||||
"src": "../UICatalog"
|
||||
"src": "../UICatalog/bin/Release/net6.0"
|
||||
}
|
||||
],
|
||||
"dest": "api/UICatalog",
|
||||
|
||||
Reference in New Issue
Block a user