|
|
@@ -1,6 +1,17 @@
|
|
|
# Terminal.Gui v2 Overview
|
|
|
|
|
|
- A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.
|
|
|
+ A toolkit for building rich Terminal User Interface (TUI) apps with .NET that run on Windows, the Mac, and Linux/Unix.
|
|
|
+
|
|
|
+## Features
|
|
|
+
|
|
|
+* **[Cross Platform](drivers.md)** - Windows, Mac, and Linux. Terminal drivers for Curses, Windows, and the .NET Console mean apps will work well on both color and monochrome terminals. Apps also work over SSH.
|
|
|
+* **[Templates](getting-started.md)** - The `dotnet new` command can be used to create a new Terminal.Gui app.
|
|
|
+* **[Keyboard](keyboard.md) and [Mouse](mouse.md) Input** - The library handles all the details of input processing and provides a simple event-based API for applications to consume.
|
|
|
+* **[Extensible Widgets](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.View.html)** - All visible UI elements are subclasses of the `View` class, and these in turn can contain an arbitrary number of sub-views. Dozens of [Built-in Views](views.md) are provided.
|
|
|
+* **[Flexible Layout](layout.md)** - *Computed Layout* makes it easy to lay out controls relative to each other and enables dynamic terminal UIs. *Absolute Layout* allows for precise control over the position and size of controls.
|
|
|
+* **[Clipboard support](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.Clipboard.html)** - Cut, Copy, and Paste is provided through the [`Clipboard`] class.
|
|
|
+* **Advanced App Features** - The [Mainloop](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.MainLoop.html) supports processing events, idle handlers, and timers. Most classes are safe for threading.
|
|
|
+* **[Reactive Extensions](https://github.com/dotnet/reactive)** - Use reactive extensions and benefit from increased code readability, and the ability to apply the MVVM pattern and [ReactiveUI](https://www.reactiveui.net/) data bindings. See the [source code](https://github.com/gui-cs/Terminal.GuiV2Docs/tree/master/ReactiveExample) of a sample app.
|
|
|
|
|
|
## Conceptual Documentation
|
|
|
|
|
|
@@ -12,131 +23,78 @@
|
|
|
* [TableView Deep Dive](tableview.md)
|
|
|
* [TreeView Deep Dive](treeview.md)
|
|
|
|
|
|
-## Features
|
|
|
-
|
|
|
-* **Cross Platform** - Windows, Mac, and Linux. Terminal drivers for Curses, [Windows Console](https://github.com/gui-cs/Terminal.GuiV2Docs/issues/27), and the .NET Console mean apps will work well on both color and monochrome terminals.
|
|
|
-* **Keyboard and Mouse Input** - Both keyboard and mouse input are supported, including support for drag & drop.
|
|
|
-* **[Flexible Layout](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/overview.html#layout)** - Supports both *Absolute layout* and an innovative *Computed Layout* system. *Computed Layout* makes it easy to lay out controls relative to each other and enables dynamic terminal UIs.
|
|
|
-* **Clipboard support** - Cut, Copy, and Paste of text provided through the [`Clipboard`](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.Clipboard.html) class.
|
|
|
-* **[Arbitrary Views](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.View.html)** - All visible UI elements are subclasses of the `View` class, and these in turn can contain an arbitrary number of sub-views.
|
|
|
-* **Advanced App Features** - The [Mainloop](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.MainLoop.html) supports processing events, idle handlers, timers, and monitoring file
|
|
|
-descriptors. Most classes are safe for threading.
|
|
|
-* **Reactive Extensions** - Use [reactive extensions](https://github.com/dotnet/reactive) and benefit from increased code readability, and the ability to apply the MVVM pattern and [ReactiveUI](https://www.reactiveui.net/) data bindings. See the [source code](https://github.com/gui-cs/Terminal.GuiV2Docs/tree/master/ReactiveExample) of a sample app in order to learn how to achieve this.
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-`Terminal.Gui` is a library intended to create console-based
|
|
|
-applications using C#. The framework has been designed to make it
|
|
|
-easy to write applications that will work on monochrome terminals, as
|
|
|
-well as modern color terminals with mouse support.
|
|
|
-
|
|
|
-This library works across Windows, Linux and MacOS.
|
|
|
-
|
|
|
-This library provides a text-based toolkit as works in a way similar
|
|
|
-to graphic toolkits. There are many controls that can be used to
|
|
|
-create your applications and it is event based, meaning that you
|
|
|
-create the user interface, hook up various events and then let the
|
|
|
-a processing loop run your application, and your code is invoked via
|
|
|
-one or more callbacks.
|
|
|
-
|
|
|
The simplest application looks like this:
|
|
|
|
|
|
```csharp
|
|
|
using Terminal.Gui;
|
|
|
-
|
|
|
-class Demo {
|
|
|
- static int Main ()
|
|
|
- {
|
|
|
- Application.Init ();
|
|
|
-
|
|
|
- var n = MessageBox.Query (50, 7,
|
|
|
- "Question", "Do you like console apps?", "Yes", "No");
|
|
|
-
|
|
|
- Application.Shutdown ();
|
|
|
- return n;
|
|
|
- }
|
|
|
-}
|
|
|
+Application.Init ();
|
|
|
+var n = MessageBox.Query (50, 5, "Question", "Do you like TUI apps?", "Yes", "No");
|
|
|
+Application.Shutdown ();
|
|
|
+return n;
|
|
|
```
|
|
|
|
|
|
-This example shows a prompt and returns an integer value depending on
|
|
|
-which value was selected by the user (Yes, No, or if they use chose
|
|
|
-not to make a decision and instead pressed the ESC key).
|
|
|
+This example shows a prompt and returns an integer value depending on which value was selected by the user.
|
|
|
|
|
|
-More interesting user interfaces can be created by composing some of
|
|
|
-the various views that are included. In the following sections, you
|
|
|
-will see how applications are put together.
|
|
|
+More interesting user interfaces can be created by composing some of the various `View` classes that are included.
|
|
|
|
|
|
-In the example above, you can see that we have initialized the runtime by calling
|
|
|
-[Applicaton.Init](~/api/Terminal.Gui.Application.yml#Terminal_Gui_Application_Init_Terminal_Gui_ConsoleDriver_) method in the Application class - this sets up the environment, initializes the color
|
|
|
-schemes available for your application and clears the screen to start your application.
|
|
|
+In the example above, [Applicaton.Init](~/api/Terminal.Gui.Application.yml#Terminal_Gui_Application_Init_Terminal_Gui_ConsoleDriver_) sets up the environment, initializes the color schemes, and clears the screen to start the application.
|
|
|
|
|
|
-The [Application](~/api/Terminal.Gui.Application.yml) class, additionally creates an instance of the [Toplevel](~/api/Terminal.Gui.Toplevel.yml) class that is ready to be consumed,
|
|
|
-this instance is available in the `Application.Top` property, and can be used like this:
|
|
|
+The [Application](~/api/Terminal.Gui.Application.yml) class additionally creates an instance of the [Toplevel](~/api/Terminal.Gui.Toplevel.yml) View available in the `Application.Top` property, and can be used like this:
|
|
|
|
|
|
```csharp
|
|
|
using Terminal.Gui;
|
|
|
+Application.Init ();
|
|
|
|
|
|
-class Demo {
|
|
|
- static int Main ()
|
|
|
- {
|
|
|
- Application.Init ();
|
|
|
-
|
|
|
- var label = new Label ("Hello World") {
|
|
|
- X = Pos.Center (),
|
|
|
- Y = Pos.Center (),
|
|
|
- Height = 1,
|
|
|
- };
|
|
|
- Application.Top.Add (label);
|
|
|
- Application.Run ();
|
|
|
- Application.Shutdown ();
|
|
|
- }
|
|
|
-}
|
|
|
+var label = new Label ("Hello World") {
|
|
|
+ X = Pos.Center (),
|
|
|
+ Y = Pos.Center (),
|
|
|
+ Height = 1,
|
|
|
+};
|
|
|
+
|
|
|
+Application.Top.Add (label);
|
|
|
+Application.Run ();
|
|
|
+Application.Shutdown ();
|
|
|
```
|
|
|
|
|
|
-Typically, you will want your application to have more than a label, you might
|
|
|
-want a menu, and a region for your application to live in, the following code
|
|
|
-does this:
|
|
|
+This example includes a menu bar at the top of the screen and a button that shows a message box when clicked:
|
|
|
|
|
|
```csharp
|
|
|
using Terminal.Gui;
|
|
|
|
|
|
-class Demo {
|
|
|
- static int Main ()
|
|
|
- {
|
|
|
- Application.Init ();
|
|
|
- var menu = new MenuBar (new MenuBarItem [] {
|
|
|
- new MenuBarItem ("_File", new MenuItem [] {
|
|
|
- new MenuItem ("_Quit", "", () => {
|
|
|
- Application.RequestStop ();
|
|
|
- })
|
|
|
- }),
|
|
|
- });
|
|
|
-
|
|
|
- var win = new Window ("Hello") {
|
|
|
- X = 0,
|
|
|
- Y = 1,
|
|
|
- Width = Dim.Fill (),
|
|
|
- Height = Dim.Fill () - 1
|
|
|
- };
|
|
|
-
|
|
|
- // Add both menu and win in a single call
|
|
|
- Application.Top.Add (menu, win);
|
|
|
- Application.Run ();
|
|
|
- Application.Shutdown ();
|
|
|
- }
|
|
|
-}
|
|
|
+Application.Init ();
|
|
|
+var menu = new MenuBar (new MenuBarItem [] {
|
|
|
+ new MenuBarItem ("_File", new MenuItem [] {
|
|
|
+ new MenuItem ("_Quit", "", () => {
|
|
|
+ Application.RequestStop ();
|
|
|
+ })
|
|
|
+ }),
|
|
|
+});
|
|
|
+
|
|
|
+var button = new Button ("_Hello") {
|
|
|
+ X = 0,
|
|
|
+ Y = Pos.Bottom (menu),
|
|
|
+ Width = Dim.Fill (),
|
|
|
+ Height = Dim.Fill () - 1
|
|
|
+};
|
|
|
+button.Clicked += () => {
|
|
|
+ MessageBox.Query (50, 5, "Hi", "Hello World! This is a message box", "Ok");
|
|
|
+};
|
|
|
+
|
|
|
+// Add both menu and win in a single call
|
|
|
+Application.Top.Add (menu, button);
|
|
|
+Application.Run ();
|
|
|
+Application.Shutdown ();
|
|
|
```
|
|
|
|
|
|
## Views
|
|
|
|
|
|
-All visible elements on a Terminal.Gui application are implemented as
|
|
|
+All visible elements in a Terminal.Gui application are implemented as
|
|
|
[Views](~/api/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
|
|
|
-[Add](~/api/Terminal.Gui.View.yml#Terminal_Gui_View_Add_Terminal_Gui_View_) method, for example, to add a couple of buttons to a UI, you can do this:
|
|
|
+Every view can contain an arbitrary number of child views, called `SubViews`. Call the
|
|
|
+[View.Add](~/api/Terminal.Gui.View.yml#Terminal_Gui_View_Add_Terminal_Gui_View_) method to add a couple of buttons to a UI:
|
|
|
|
|
|
```csharp
|
|
|
void SetupMyView (View myView)
|
|
|
@@ -164,216 +122,100 @@ View.
|
|
|
|
|
|
## Layout
|
|
|
|
|
|
-Terminal.Gui supports two different layout systems, absolute and computed \
|
|
|
-(controlled by the [LayoutStyle](~/api/Terminal.Gui.LayoutStyle.yml)
|
|
|
-property on the view.
|
|
|
+Terminal.Gui v2 supports the following View layout systems (controlled by the [View.LayoutStyle](~/api/Terminal.Gui.LayoutStyle.yml)):
|
|
|
|
|
|
-The absolute system is used when you want the view to be positioned exactly in
|
|
|
-one location and want to manually control where the view is. This is done
|
|
|
-by invoking your View constructor with an argument of type [Rect](~/api/Terminal.Gui.Rect.yml). When you do this, to change the position of the View, you can change the `Frame` property on the View.
|
|
|
+* **Absolute** - Used to have the View positioned exactly in a location, with a fixed size. Absolute layout is accomplished by constructing a View with an argument of type [Rect](~/api/Terminal.Gui.Rect.yml) or directly changing the `Frame` property on the View.
|
|
|
+* **Computed** - The Computed Layout system provides automatic aligning of Views with other Views, automatic centering, and automatic sizing. To use Computed layout set the
|
|
|
+ `X`, `Y`, `Width` and `Height` properties after the object has been created. Views laid out using the Computed Layout system can be resized with the mouse or keyboard, enabling tiled window managers and dynamic terminal UIs.
|
|
|
+* **Overlapped** - New in V2 (But not yet) - Overlapped layout enables views to be positioned on top of each other. Overlapped Views are movable and sizable with both the keyboard and the mouse.
|
|
|
|
|
|
-The computed layout system offers a few additional capabilities, like automatic
|
|
|
-centering, expanding of dimensions and a handful of other features. To use
|
|
|
-this you construct your object without an initial `Frame`, but set the
|
|
|
- `X`, `Y`, `Width` and `Height` properties after the object has been created.
|
|
|
+See the full [Layout documentation here](layout.md).
|
|
|
|
|
|
-Examples:
|
|
|
+## Modal Views
|
|
|
+
|
|
|
+Views can either be Modal or Non-modal. Modal views take over all user input until the user closes the View. Examples of Modal Views are Toplevel, Dialog, and Wizard. Non-modal views can be used to create a new experience in your application, one where you would have a new top-level menu for example. Setting the `Modal` property on a View to `true` makes it modal.
|
|
|
+
|
|
|
+To run any View (but especially Dialogs, Windows, or Toplevels) modally, invoke the `Application.Run` method on a Toplevel. Use the `Application.RequestStop()` method to terminate the modal execution.
|
|
|
|
|
|
```csharp
|
|
|
+bool okpressed = false;
|
|
|
+var ok = new Button(3, 14, "Ok") {
|
|
|
+ Clicked = () => { Application.RequestStop (); okpressed = true; }
|
|
|
+};
|
|
|
+var cancel = new Button(10, 14, "Cancel") {
|
|
|
+ Clicked = () => Application.RequestStop ()
|
|
|
+};
|
|
|
+var dialog = new Dialog ("Login", 60, 18, ok, cancel);
|
|
|
|
|
|
-// Dynamically computed
|
|
|
-var label = new Label ("Hello") {
|
|
|
- X = 1,
|
|
|
- Y = Pos.Center (),
|
|
|
+var entry = new TextField () {
|
|
|
+ X = 1,
|
|
|
+ Y = 1,
|
|
|
Width = Dim.Fill (),
|
|
|
Height = 1
|
|
|
};
|
|
|
-
|
|
|
-// Absolute position using the provided rectangle
|
|
|
-var label2 = new Label (new Rect (1, 2, 20, 1), "World")
|
|
|
-```
|
|
|
-
|
|
|
-The computed layout system does not take integers, instead the `X` and `Y` properties are of type [Pos](~/api/Terminal.Gui.Pos.yml) and the `Width` and `Height` properties are of type [Dim](~/api/Terminal.Gui.Dim.yml) both which can be created implicitly from integer values.
|
|
|
-
|
|
|
-### The `Pos` Type
|
|
|
-
|
|
|
-The `Pos` type on `X` and `Y` offers a few options:
|
|
|
-* Absolute position, by passing an integer
|
|
|
-* Percentage of the parent's view size - `Pos.Percent(n)`
|
|
|
-* Anchored from the end of the dimension - `AnchorEnd(int margin=0)`
|
|
|
-* Centered, using `Center()`
|
|
|
-* Reference the Left (X), Top (Y), Bottom, Right positions of another view
|
|
|
-
|
|
|
-The `Pos` values can be added or subtracted, like this:
|
|
|
-
|
|
|
-```csharp
|
|
|
-// Set the X coordinate to 10 characters left from the center
|
|
|
-view.X = Pos.Center () - 10;
|
|
|
-
|
|
|
-view.Y = Pos.Percent (20);
|
|
|
-
|
|
|
-anotherView.X = AnchorEnd (10);
|
|
|
-anotherView.Width = 9;
|
|
|
-
|
|
|
-myView.X = Pos.X (view);
|
|
|
-myView.Y = Pos.Bottom (anotherView);
|
|
|
-```
|
|
|
-
|
|
|
-### The `Dim` Type
|
|
|
-
|
|
|
-The `Dim` type is used for the `Width` and `Height` properties on the View and offers
|
|
|
-the following options:
|
|
|
-
|
|
|
-* Absolute size, by passing an integer
|
|
|
-* Percentage of the parent's view size - `Dim.Percent(n)`
|
|
|
-* Fill to the end - `Dim.Fill ()`
|
|
|
-* Reference the Width or Height of another view
|
|
|
-
|
|
|
-Like, `Pos`, objects of type `Dim` can be added an subtracted, like this:
|
|
|
-
|
|
|
-
|
|
|
-```csharp
|
|
|
-// Set the Width to be 10 characters less than filling
|
|
|
-// the remaining portion of the screen
|
|
|
-view.Width = Dim.Fill () - 10;
|
|
|
-
|
|
|
-view.Height = Dim.Percent(20) - 1;
|
|
|
-
|
|
|
-anotherView.Height = Dim.Height (view)+1
|
|
|
-```
|
|
|
-
|
|
|
-## TopLevels, Windows and Dialogs.
|
|
|
-
|
|
|
-Among the many kinds of views, you typically will create a [Toplevel](~/api/Terminal.Gui.Toplevel.yml) view (or any of its subclasses), like [Window](~/api/Terminal.Gui.Window.yml) or [Dialog](~/api/Terminal.Gui.Dialog.yml) which is special kind of views that can be executed modally - that is, the view can take over all input and returns
|
|
|
-only when the user chooses to complete their work there.
|
|
|
-
|
|
|
-The following sections cover the differences.
|
|
|
-
|
|
|
-### TopLevel Views
|
|
|
-
|
|
|
-[Toplevel](~/api/Terminal.Gui.Toplevel.yml) views have no visible user interface elements and occupy an arbitrary portion of the screen.
|
|
|
-
|
|
|
-You would use a toplevel Modal view for example to launch an entire new experience in your application, one where you would have a new top-level menu for example. You
|
|
|
-typically would add a Menu and a Window to your Toplevel, it would look like this:
|
|
|
-
|
|
|
-```csharp
|
|
|
-using Terminal.Gui;
|
|
|
-
|
|
|
-class Demo {
|
|
|
- static void Edit (string filename)
|
|
|
- {
|
|
|
- var top = new Toplevel () {
|
|
|
- X = 0,
|
|
|
- Y = 0,
|
|
|
- Width = Dim.Fill (),
|
|
|
- Height = Dim.Fill ()
|
|
|
- };
|
|
|
- var menu = new MenuBar (new MenuBarItem [] {
|
|
|
- new MenuBarItem ("_File", new MenuItem [] {
|
|
|
- new MenuItem ("_Close", "", () => {
|
|
|
- Application.RequestStop ();
|
|
|
- })
|
|
|
- }),
|
|
|
- });
|
|
|
-
|
|
|
- // nest a window for the editor
|
|
|
- var win = new Window (filename) {
|
|
|
- X = 0,
|
|
|
- Y = 1,
|
|
|
- Width = Dim.Fill (),
|
|
|
- Height = Dim.Fill () - 1
|
|
|
- };
|
|
|
-
|
|
|
- var editor = new TextView () {
|
|
|
- X = 0,
|
|
|
- Y = 0,
|
|
|
- Width = Dim.Fill (),
|
|
|
- Height = Dim.Fill ()
|
|
|
- };
|
|
|
- editor.Text = System.IO.File.ReadAllText (filename);
|
|
|
- win.Add (editor);
|
|
|
-
|
|
|
- // Add both menu and win in a single call
|
|
|
- top.Add (win, menu);
|
|
|
- Application.Run (top);
|
|
|
- Application.Shutdown ();
|
|
|
- }
|
|
|
-}
|
|
|
+dialog.Add (entry);
|
|
|
+Application.Run (dialog);
|
|
|
+if (okpressed)
|
|
|
+ Console.WriteLine ("The user entered: " + entry.Text);
|
|
|
```
|
|
|
|
|
|
-### Window Views
|
|
|
-
|
|
|
-[Window](~/api/Terminal.Gui.Window.yml) views extend the Toplevel view by providing a frame and a title around the toplevel - and can be moved on the screen with the mouse (caveat: code is currently disabled)
|
|
|
+There is no return value from running modally, so the modal view must have a mechanism to indicate the reason the modal was closed. In the case above, the `okpressed` value is set to true if the user pressed or selected the `Ok` button.
|
|
|
|
|
|
-From a user interface perspective, you might have more than one Window on the screen at a given time.
|
|
|
+## Windows
|
|
|
|
|
|
-### Dialogs
|
|
|
+[Window](~/api/Terminal.Gui.Window.yml) is a view used in `Overlapped` layouts, providing a frame and a title - and can be moved and sized with the keyboard or mouse.
|
|
|
|
|
|
-[Dialog](~/api/Terminal.Gui.Dialog.yml) are [Window](~/api/Terminal.Gui.Window.yml) objects that happen to be centered in the middle of the screen.
|
|
|
+## Dialogs
|
|
|
|
|
|
-Dialogs are instances of a Window that are centered in the screen, and are intended
|
|
|
-to be used modally - that is, they run, and they are expected to return a result
|
|
|
-before resuming execution of your application.
|
|
|
+[Dialogs](~/api/Terminal.Gui.Dialog.yml) are Modal [Windows](~/api/Terminal.Gui.Window.yml) that are centered in the middle of the screen and are intended to be used modally - that is, they run, and they are expected to return a result before resuming execution of the application.
|
|
|
|
|
|
-Dialogs are a subclass of `Window` and additionally expose the
|
|
|
-[`AddButton`](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui.Dialog.yml#Terminal_Gui_Dialog_AddButton_Terminal_Gui_Button_) API which manages the layout
|
|
|
-of any button passed to it, ensuring that the buttons are at the bottom of the dialog.
|
|
|
+Dialogs expose an API for adding buttons and managing the layout such that buttons are at the bottom of the dialog (e.g. [`AddButton`](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui.Dialog.yml#Terminal_Gui_Dialog_AddButton_Terminal_Gui_Button_)).
|
|
|
|
|
|
Example:
|
|
|
```csharp
|
|
|
bool okpressed = false;
|
|
|
var ok = new Button("Ok");
|
|
|
var cancel = new Button("Cancel");
|
|
|
-var dialog = new Dialog ("Quit", 60, 7, ok, cancel);
|
|
|
+var dialog = new Dialog ("Quit", ok, cancel) { Text = "Are you sure you want to quit?" };
|
|
|
```
|
|
|
|
|
|
Which will show something like this:
|
|
|
+
|
|
|
```
|
|
|
+- Quit -----------------------------------------------+
|
|
|
-| |
|
|
|
+| Are you sure you want to quit? |
|
|
|
| |
|
|
|
| [ Ok ] [ Cancel ] |
|
|
|
+------------------------------------------------------+
|
|
|
```
|
|
|
|
|
|
-### Running Modally
|
|
|
+## Wizards
|
|
|
|
|
|
-To run your Dialog, Window or Toplevel modally, you will invoke the `Application.Run`
|
|
|
-method on the toplevel. It is up to your code and event handlers to invoke the `Application.RequestStop()` method to terminate the modal execution.
|
|
|
+[Wizards](~/api/Terminal.Gui.Wizard.yml) are Dialogs that let users step through a series of steps to complete a task.
|
|
|
|
|
|
-```csharp
|
|
|
-bool okpressed = false;
|
|
|
-var ok = new Button(3, 14, "Ok") {
|
|
|
- Clicked = () => { Application.RequestStop (); okpressed = true; }
|
|
|
-};
|
|
|
-var cancel = new Button(10, 14, "Cancel") {
|
|
|
- Clicked = () => Application.RequestStop ()
|
|
|
-};
|
|
|
-var dialog = new Dialog ("Login", 60, 18, ok, cancel);
|
|
|
-
|
|
|
-var entry = new TextField () {
|
|
|
- X = 1,
|
|
|
- Y = 1,
|
|
|
- Width = Dim.Fill (),
|
|
|
- Height = 1
|
|
|
-};
|
|
|
-dialog.Add (entry);
|
|
|
-Application.Run (dialog);
|
|
|
-if (okpressed)
|
|
|
- Console.WriteLine ("The user entered: " + entry.Text);
|
|
|
```
|
|
|
-
|
|
|
-There is no return value from running modally, so your code will need to have a mechanism
|
|
|
-of indicating the reason that the execution of the modal dialog was completed, in the
|
|
|
-case above, the `okpressed` value is set to true if the user pressed or selected the Ok button.
|
|
|
+╔╡Gandolf - The last step╞════════════════════════════════════╗
|
|
|
+║ The wizard is complete! ║
|
|
|
+║☐ Enable Final Final Step ║
|
|
|
+║ Press the Finish ║
|
|
|
+║ button to continue. ║
|
|
|
+║ ║
|
|
|
+║ Pressing ESC will ║
|
|
|
+║ cancel the wizard. ║
|
|
|
+║ ║
|
|
|
+║ ║
|
|
|
+║─────────────────────────────────────────────────────────────║
|
|
|
+║⟦ Back ⟧ ⟦► Finish ◄⟧║
|
|
|
+╚═════════════════════════════════════════════════════════════╝
|
|
|
+```
|
|
|
|
|
|
## Input Handling
|
|
|
|
|
|
-Every view has a focused view, and if that view has nested views, one of those is
|
|
|
+Every view has a focused view, and if that view has nested SubViews, one of those is
|
|
|
the focused view. This is called the focus chain, and at any given time, only one
|
|
|
-View has the focus.
|
|
|
+View has the [Focus]().
|
|
|
|
|
|
-The library binds the key Tab to focus the next logical view, and the Shift-Tab combination to focus the previous logical view.
|
|
|
+The library provides a default focus mechanism that can be used to navigate the focus chain. The default focus mechanism is based on the Tab key, and the Shift-Tab key combination
|
|
|
|
|
|
Keyboard processing details are available on the [Keyboard Event Processing](keyboard.md) document.
|
|
|
|
|
|
@@ -382,8 +224,7 @@ Keyboard processing details are available on the [Keyboard Event Processing](key
|
|
|
All views have been configured with a color scheme that will work both in color
|
|
|
terminals as well as the more limited black and white terminals.
|
|
|
|
|
|
-The various styles are captured in the [Colors](~/api/Terminal.Gui.Colors.yml) class which defined color schemes for
|
|
|
-the toplevel, the normal views, the menu bar, popup dialog boxes and error dialog boxes, that you can use like this:
|
|
|
+The various styles are captured in the [Colors](~/api/Terminal.Gui.Colors.yml) class which defines color schemes for Toplevel, the normal views (Base), the menu bar, dialog boxes, and error UI::
|
|
|
|
|
|
* `Colors.Toplevel`
|
|
|
* `Colors.Base`
|
|
|
@@ -398,6 +239,8 @@ var w = new Window ("Hello");
|
|
|
w.ColorScheme = Colors.Error
|
|
|
```
|
|
|
|
|
|
+ColorSchemes can be configured with the [Configuration and Theme Manager](config.md).
|
|
|
+
|
|
|
The [ColorScheme](~/api/Terminal.Gui.ColorScheme.yml) represents
|
|
|
four values, the color used for Normal text, the color used for normal text when
|
|
|
a view is focused an the colors for the hot-keys both in focused and unfocused modes.
|
|
|
@@ -414,9 +257,11 @@ var label = new Label (...);
|
|
|
label.TextColor = myColor
|
|
|
```
|
|
|
|
|
|
+Learn more about colors in the [Drawing](drawing.md) overview.
|
|
|
+
|
|
|
## MainLoop, Threads and Input Handling
|
|
|
|
|
|
-Detailed description of the mainloop is described on the [Event Processing and the Application Main Loop](~/docs/mainloop.md) document.
|
|
|
+The Main Loop, threading, and timers are described on the [Event Processing and the Application Main Loop](~/docs/mainloop.md) document.
|
|
|
|
|
|
## Cross-Platform Drivers
|
|
|
|
Tig