mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
Tweaked API docs format and content. Fixed build warnings.
This commit is contained in:
Tig Kindel
11
docfx/_exported_templates/README.md
Normal file
11
docfx/_exported_templates/README.md
Normal file
@@ -0,0 +1,11 @@
|
||||
Regenerate anytime with
|
||||
|
||||
```powershell\
|
||||
docfx template export default
|
||||
```
|
||||
|
||||
Technically, this can be deleted from the Terminal.Gui project, but it's left in place
|
||||
for convenience.
|
||||
|
||||
See https://dotnet.github.io/docfx/tutorial/howto_create_custom_template.html
|
||||
|
||||
@@ -1,31 +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) - 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.
|
||||
* [Button](~/api/Terminal.Gui/Terminal.Gui.Button.yml) - A View that provides an item that invokes an System.Action when activated by the user.
|
||||
* [CheckBox](~/api/Terminal.Gui/Terminal.Gui.CheckBox.yml) - Shows an on/off toggle that the user can set.
|
||||
* [ColorPicker](~/api/Terminal.Gui/Terminal.Gui.ColorPicker.yml) - Enables to user to pick a color.
|
||||
* [ComboBox](~/api/Terminal.Gui/Terminal.Gui.ComboBox.yml) - Provides a drop-down list of items the user can select from.
|
||||
* [Dialog](~/api/Terminal.Gui/Terminal.Gui.Dialog.yml) - A pop-up Window that contains one or more Buttons.
|
||||
* [OpenDialog](~/api/Terminal.Gui/Terminal.Gui.OpenDialog.yml) - A Dialog providing an interactive pop-up Window for users to select files or directories.
|
||||
* [SaveDialog](~/api/Terminal.Gui/Terminal.Gui.SaveDialog.yml) - A Dialog providing an interactive pop-up Window for users to save files.
|
||||
* [FrameView](~/api/Terminal.Gui/Terminal.Gui.FrameView.yml) - A container View that draws a frame around its contents. Similar to a GroupBox in Windows.
|
||||
* [GraphView](~/api/Terminal.Gui/Terminal.Gui.GraphView.yml) - A View for rendering graphs (bar, scatter etc).
|
||||
* [Hex viewer/editor](~/api/Terminal.Gui/Terminal.Gui.HexView.yml) - A hex viewer and editor that operates over a file stream.
|
||||
* [Label](~/api/Terminal.Gui/Terminal.Gui.Label.yml) - Displays a string at a given position and supports multiple lines.
|
||||
* [ListView](~/api/Terminal.Gui/Terminal.Gui.ListView.yml) - Displays a scrollable list of data where each item can be activated to perform an action.
|
||||
* [MenuBar](~/api/Terminal.Gui/Terminal.Gui.MenuBar.yml) - Provides a menu bar with drop-down and cascading menus.
|
||||
* [MessageBox](~/api/Terminal.Gui/Terminal.Gui.MessageBox.yml) - Displays a modal (pup-up) message to the user, with a title, a message and a series of options that the user can choose from.
|
||||
* [ProgressBar](~/api/Terminal.Gui/Terminal.Gui.ProgressBar.yml) - Displays a progress Bar indicating progress of an activity.
|
||||
* [RadioGroup](~/api/Terminal.Gui/Terminal.Gui.RadioGroup.yml) - Displays a group of labels each with a selected indicator. Only one of those can be selected at a given time
|
||||
* [ScrollView](~/api/Terminal.Gui/Terminal.Gui.ScrollView.yml) - Present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView.
|
||||
* [ScrollBarView](~/api/Terminal.Gui/Terminal.Gui.ScrollBarView.yml) - display a 1-character scrollbar, either horizontal or vertical.
|
||||
* [StatusBar](~/api/Terminal.Gui/Terminal.Gui.StatusBar.yml) - A View that snaps to the bottom of a Toplevel displaying set of status items. Includes support for global app keyboard shortcuts.
|
||||
* [TableView](~/api/Terminal.Gui/Terminal.Gui.TableView.yml) - A View for tabular data based on a System.Data.DataTable.
|
||||
* [TimeField](~/api/Terminal.Gui/Terminal.Gui.TimeField.yml) & [DateField](~/api/Terminal.Gui/Terminal.Gui.TimeField.yml) - Enables structured editing of dates and times.
|
||||
* [TextField](~/api/Terminal.Gui/Terminal.Gui.TextField.yml) - Provides a single-line text entry.
|
||||
* [TextValidateField](~/api/Terminal.Gui/Terminal.Gui.TextValidateField.yml) - Text field that validates input through a ITextValidateProvider.
|
||||
* [TextView](~/api/Terminal.Gui/Terminal.Gui.TextView.yml)- A multi-line text editing View supporting word-wrap, auto-complete, context menus, undo/redo, and clipboard operations,
|
||||
* [TopLevel](~/api/Terminal.Gui/Terminal.Gui.Toplevel.yml) - The base class for modal/pop-up Windows.
|
||||
* [TreeView](~/api/Terminal.Gui/Terminal.Gui.TreeView.yml) - A hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder.
|
||||
* [View](~/api/Terminal.Gui/Terminal.Gui.View.yml) - The base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.
|
||||
* [Window](~/api/Terminal.Gui/Terminal.Gui.Window.yml) - A Toplevel view that draws a border around its Frame with a title at the top.
|
||||
* [Wizard](~/api/Terminal.Gui/Terminal.Gui.Wizard.yml) - Provides navigation and a user interface to collect related data across multiple steps.
|
||||
|
||||
@@ -6,4 +6,4 @@ rm ../docs -Recurse -Force
|
||||
|
||||
#docfx --metadata
|
||||
|
||||
docfx --metadata --serve
|
||||
docfx --serve --force
|
||||
|
Before Width: | Height: | Size: 10 MiB After Width: | Height: | Size: 10 MiB |
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
BIN
docfx/images/wizard.gif
Normal file
BIN
docfx/images/wizard.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 288 KiB |
@@ -1,6 +1,8 @@
|
||||
# Terminal.Gui - Terminal UI toolkit for .NET
|
||||
# Terminal.Gui - Cross Platform Terminal UI toolkit for .NET
|
||||
|
||||
A simple UI toolkit for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.
|
||||
A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.
|
||||
|
||||
|
||||
|
||||
* [Terminal.Gui Project on GitHub](https://github.com/migueldeicaza/gui.cs)
|
||||
|
||||
|
||||
@@ -114,6 +114,7 @@ article h4 {
|
||||
-webkit-box-shadow: var(--card-box-shadow);
|
||||
-moz-box-shadow: var(--card-box-shadow);
|
||||
box-shadow: var(--card-box-shadow);
|
||||
font-family: 'Source Code Pro', 'Courier New', Courier, monospace
|
||||
}
|
||||
|
||||
.subnav {
|
||||
|
||||
Reference in New Issue
Block a user