فهرست منبع

Fixes Wizard cancel logic and updates docs (#1878)

* Fixed cancel logic. Title now shows for non-modal.

* trying to fix docs

* trying to fix docs
Tig Kindel 3 سال پیش
والد
کامیت
99890b18dc

+ 1 - 0
README.md

@@ -42,6 +42,7 @@ A toolkit for building rich console apps for .NET, .NET Core, and Mono that work
 * [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)
 
 ### Features
 

+ 1 - 0
docfx/articles/index.md

@@ -1,6 +1,7 @@
 # Conceptual Documentation
 
 * [Terminal.Gui Overview](overview.md)
+* [List of Views](views.md)
 * [Keyboard Event Processing](keyboard.md)
 * [Event Processing and the Application Main Loop](mainloop.md)
 * [TableView Deep Dive](tableview.md)

+ 5 - 5
docfx/articles/keyboard.md

@@ -2,7 +2,7 @@ Keyboard Event Processing
 =========================
 
 Keyboard events are sent by the [Main Loop](mainloop.md) to the
-Application class for processing.  The keyboard events are sent
+Application class for processing. The keyboard events are sent
 exclusively to the current `Toplevel`, this being either the default
 that is created when you call `Application.Init`, or one that you
 created an passed to `Application.Run(Toplevel)`. 
@@ -19,10 +19,10 @@ HotKey Processing
 
 Events are first send to all views as a "HotKey", this means that the
 `View.ProcessHotKey` method is invoked on the current toplevel, which
-in turns propagates this to all the views in the hierarchy.  If any
+in turns propagates this to all the views in the hierarchy. If any
 view decides to process the event, no further processing takes place.
 
-This is how hotkeys for buttons are implemented.  For example, the
+This is how hotkeys for buttons are implemented. For example, the
 keystroke "Alt-A" is handled by Buttons that have a hot-letter "A" to
 activate the button.
 
@@ -42,7 +42,7 @@ event, and is broadcast to all the views in the Toplevel.
 
 This method can be overwritten by views that want to provide
 accelerator functionality (Alt-key for example), but without
-interefering with normal ProcessKey behavior.
+interfering with normal ProcessKey behavior.
 
 Key Bindings
 -------------------
@@ -70,5 +70,5 @@ in `RadioGroup`.
 Global Key Handler
 --------------------
 Sometimes you may want to define global key handling logic for your entire 
-application that is invoked regardless of what Window/View has focus.  This can
+application that is invoked regardless of what Window/View has focus. This can
 be achieved by using the `Application.RootKeyEvent` event.

+ 6 - 6
docfx/articles/mainloop.md

@@ -32,7 +32,7 @@ When your code invokes `Application.Run (Toplevel)`, the application
 will prepare the current
 [`Toplevel`](~/api/Terminal.Gui/Terminal.Gui.Toplevel.yml) instance by
 redrawing the screen appropriately and then calling the mainloop to
-run.    
+run.   
 
 You can configure the Mainloop before calling Application.Run, or you
 can configure the MainLoop in response to events during the execution.
@@ -83,8 +83,8 @@ Idle Handlers
 You can register code to be executed when the application is idling
 and there are no events to process by calling the
 [`AddIdle`]()
-method.  This method takes as a parameter a function that will be
-invoked when the application is idling.  
+method. This method takes as a parameter a function that will be
+invoked when the application is idling. 
 
 Idle functions should return `true` if they should be invoked again,
 and `false` if the idle invocations should stop.
@@ -98,18 +98,18 @@ Threading
 Like other UI toolkits, Terminal.Gui is generally not thread safe.
 You should avoid calling methods in the UI classes from a background
 thread as there is no guarantee that they will not corrupt the state
-of the UI application.  
+of the UI application. 
 
 Generally, as there is not much state, you will get lucky, but the
 application will not behave properly.
 
 You will be served better off by using C# async machinery and the
-various APIs in the `System.Threading.Tasks.Task` APIs.   But if you
+various APIs in the `System.Threading.Tasks.Task` APIs.  But if you
 absolutely must work with threads on your own you should only invoke
 APIs in Terminal.Gui from the main thread.
 
 To make this simple, you can use the `Application.MainLoop.Invoke`
-method and pass an `Action`.  This action will be queued for execution
+method and pass an `Action`. This action will be queued for execution
 on the main thread at an appropriate time and will run your code
 there.
 

+ 49 - 23
docfx/articles/overview.md

@@ -8,7 +8,7 @@ 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
+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
@@ -38,7 +38,7 @@ 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).
 
 More interesting user interfaces can be created by composing some of
-the various views that are included.   In the following sections, you
+the various views that are included. In the following sections, you
 will see how applications are put together.
 
 In the example above, you can see that we have initialized the runtime by calling the 
@@ -106,12 +106,12 @@ Views
 =====
 
 All visible elements on a Terminal.Gui application are implemented as
-[Views](~/api/Terminal.Gui/Terminal.Gui.View.yml).   Views are self-contained
+[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.
 
-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 
+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/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:
 
 ```csharp
@@ -138,9 +138,35 @@ void SetupMyView (View myView)
 The container of a given view is called the `SuperView` and it is a property of every
 View.
 
-There are many views that you can use to spice up your application:
-
-[Buttons](~/api/Terminal.Gui/Terminal.Gui.Button.yml), [Labels](~/api/Terminal.Gui/Terminal.Gui.Label.yml), [Text entry](~/api/Terminal.Gui/Terminal.Gui.TextField.yml), [Text view](~/api/Terminal.Gui/Terminal.Gui.TextView.yml), [Radio buttons](~/api/Terminal.Gui/Terminal.Gui.RadioGroup.yml), [Checkboxes](~/api/Terminal.Gui/Terminal.Gui.CheckBox.yml), [Dialog boxes](~/api/Terminal.Gui/Terminal.Gui.Dialog.yml), [Message boxes](~/api/Terminal.Gui/Terminal.Gui.MessageBox.yml), [Windows](~/api/Terminal.Gui/Terminal.Gui.Window.yml), [Menus](~/api/Terminal.Gui/Terminal.Gui.MenuBar.yml), [ListViews](~/api/Terminal.Gui/Terminal.Gui.ListView.yml), [Frames](~/api/Terminal.Gui/Terminal.Gui.FrameView.yml), [ProgressBars](~/api/Terminal.Gui/Terminal.Gui.ProgressBar.yml), [Scroll views](~/api/Terminal.Gui/Terminal.Gui.ScrollView.yml) and [Scrollbars](~/api/Terminal.Gui/Terminal.Gui.ScrollBarView.yml).
+*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
 ------
@@ -150,12 +176,12 @@ Layout
 property on the view.
 
 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/Terminal.Gui.Rect.yml).   When you do this, to change the
+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/Terminal.Gui.Rect.yml). When you do this, to change the
 position of the View, you can change the `Frame` property on the View.
 
 The computed layout system offers a few additional capabilities, like automatic
-centering, expanding of dimensions and a handful of other features.  To use
+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.
 
@@ -229,7 +255,7 @@ anotherView.Height = Dim.Height (view)+1
 Among the many kinds of views, you typically will create a [Toplevel](~/api/Terminal.Gui/Terminal.Gui.Toplevel.yml) view (or any of its subclasses,
 like [Window](~/api/Terminal.Gui/Terminal.Gui.Window.yml) or [Dialog](~/api/Terminal.Gui/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.   
+only when the user chooses to complete their work there. 
 
 The following sections cover the differences.
 
@@ -237,7 +263,7 @@ The following sections cover the differences.
 
 [Toplevel](~/api/Terminal.Gui/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 
+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
@@ -326,7 +352,7 @@ Running Modally
 ---------------
 
 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.
+method on the toplevel. It is up to your code and event handlers to invoke the `Application.RequestStop()` method to terminate the modal execution.
 
 ```csharp
 bool okpressed = false;
@@ -358,17 +384,17 @@ Input Handling
 ==============
 
 Every view has a focused view, and if that view has nested views, one of those is 
-the focused view.   This is called the focus chain, and at any given time, only one
-View has the focus.   
+the focused view. This is called the focus chain, and at any given time, only one
+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.   
+and the Shift-Tab combination to focus the previous logical view. 
 
 Keyboard processing is divided in three stages: HotKey processing, regular processing and
-cold key processing.   
+cold key processing. 
 
 * Hot key processing happens first, and it gives all the views in the current
-  toplevel a chance to monitor whether the key needs to be treated specially.  This
+  toplevel a chance to monitor whether the key needs to be treated specially. This
   for example handles the scenarios where the user pressed Alt-o, and a view with a 
   highlighted "o" is being displayed.
 
@@ -376,7 +402,7 @@ cold key processing.
   view.
 
 * If the key was not processed by the normal processing, all views are given 
-  a chance to process the keystroke in their cold processing stage.  Examples
+  a chance to process the keystroke in their cold processing stage. Examples
   include the processing of the "return" key in a dialog when a button in the
   dialog has been flagged as the "default" action.
 
@@ -384,8 +410,8 @@ The most common case is the normal processing, which sends the keystrokes to the
 currently focused view.
 
 Mouse events are processed in visual order, and the event will be sent to the
-view on the screen.   The only exception is that no mouse events are delivered
-to background views when a modal view is running.   
+view on the screen. The only exception is that no mouse events are delivered
+to background views when a modal view is running. 
 
 More details are available on the [`Keyboard Event Processing`](keyboard.md) document.
 
@@ -393,7 +419,7 @@ Colors and Color Schemes
 ========================
 
 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.   
+terminals as well as the more limited black and white terminals. 
 
 The various styles are captured in the [`Colors`](~/api/Terminal.Gui/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:

+ 3 - 3
docfx/articles/tableview.md

@@ -56,12 +56,12 @@ tableView.Table = yourDataTable;
 ```
 
 ## Table Rendering
-TableView supports any size of table (limited only by the RAM requirements of `System.DataTable`).  You can have
-thousands of columns and/or millions of rows if you want.  Horizontal and vertical scrolling can be done using
+TableView supports any size of table (limited only by the RAM requirements of `System.DataTable`). You can have
+thousands of columns and/or millions of rows if you want. Horizontal and vertical scrolling can be done using
 the mouse or keyboard.
 
 TableView uses `ColumnOffset` and `RowOffset` to determine the first visible cell of the `System.DataTable`.
-Rendering then continues until the avaialble console space is exhausted.  Updating the `ColumnOffset` and 
+Rendering then continues until the avaialble console space is exhausted. Updating the `ColumnOffset` and 
 `RowOffset` changes which part of the table is rendered (scrolls the viewport).
 
 This approach ensures that no matter how big the table, only a small number of columns/rows need to be

+ 29 - 24
docfx/articles/views.md

@@ -1,24 +1,29 @@
-Views
-=====
-
-Layout
-======
-
-Creating Custom Views
-=====================
-
-Constructor
------------
-
-Rendering
----------
-
-### Using Custom Colors
-
-Keyboard processing
--------------------
-
-Mouse event processing
-----------------------
-
-
+*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)

+ 1 - 0
docfx/index.md

@@ -7,6 +7,7 @@ A simple UI toolkit for .NET, .NET Core, and Mono that works on Windows, the Mac
 ## Terminal.Gui API Documentation
 
 * [API Reference](~/api/Terminal.Gui/Terminal.Gui.yml)
+* [Views and controls built into the Terminal.Gui library](~/articles/views.md)
 * [Terminal.Gui API Overview](~/articles/overview.md)
 * [Keyboard Event Processing](~/articles/keyboard.md)
 * [Event Processing and the Application Main Loop](~/articles/mainloop.md)

+ 1 - 0
docs/articles/index.html

@@ -74,6 +74,7 @@
 
 <ul>
 <li><a href="overview.html">Terminal.Gui Overview</a></li>
+<li><a href="views.html">List of Views</a></li>
 <li><a href="keyboard.html">Keyboard Event Processing</a></li>
 <li><a href="mainloop.html">Event Processing and the Application Main Loop</a></li>
 <li><a href="tableview.html">TableView Deep Dive</a></li>

+ 5 - 5
docs/articles/keyboard.html

@@ -73,7 +73,7 @@
 <h1 id="keyboard-event-processing">Keyboard Event Processing</h1>
 
 <p>Keyboard events are sent by the <a href="mainloop.html">Main Loop</a> to the
-Application class for processing.  The keyboard events are sent
+Application class for processing. The keyboard events are sent
 exclusively to the current <code>Toplevel</code>, this being either the default
 that is created when you call <code>Application.Init</code>, or one that you
 created an passed to <code>Application.Run(Toplevel)</code>. </p>
@@ -84,9 +84,9 @@ processed the key.</p>
 <h2 id="hotkey-processing">HotKey Processing</h2>
 <p>Events are first send to all views as a &quot;HotKey&quot;, this means that the
 <code>View.ProcessHotKey</code> method is invoked on the current toplevel, which
-in turns propagates this to all the views in the hierarchy.  If any
+in turns propagates this to all the views in the hierarchy. If any
 view decides to process the event, no further processing takes place.</p>
-<p>This is how hotkeys for buttons are implemented.  For example, the
+<p>This is how hotkeys for buttons are implemented. For example, the
 keystroke &quot;Alt-A&quot; is handled by Buttons that have a hot-letter &quot;A&quot; to
 activate the button.</p>
 <h2 id="regular-processing">Regular Processing</h2>
@@ -98,7 +98,7 @@ the currently focused view in the focus chain.</p>
 event, and is broadcast to all the views in the Toplevel.</p>
 <p>This method can be overwritten by views that want to provide
 accelerator functionality (Alt-key for example), but without
-interefering with normal ProcessKey behavior.</p>
+interfering with normal ProcessKey behavior.</p>
 <h2 id="key-bindings">Key Bindings</h2>
 <p><strong>Terminal.Gui</strong> supports rebinding keys. For example the default key
 for activating a button is Enter. You can change this using the 
@@ -117,7 +117,7 @@ method.</p>
 in <code>RadioGroup</code>.</p>
 <h2 id="global-key-handler">Global Key Handler</h2>
 <p>Sometimes you may want to define global key handling logic for your entire 
-application that is invoked regardless of what Window/View has focus.  This can
+application that is invoked regardless of what Window/View has focus. This can
 be achieved by using the <code>Application.RootKeyEvent</code> event.</p>
 </article>
           </div>

+ 6 - 6
docs/articles/mainloop.html

@@ -99,7 +99,7 @@ provides access to these functions.</p>
 will prepare the current
 <a href="../api/Terminal.Gui/Terminal.Gui.Toplevel.html"><code>Toplevel</code></a> instance by
 redrawing the screen appropriately and then calling the mainloop to
-run.    </p>
+run.   </p>
 <p>You can configure the Mainloop before calling Application.Run, or you
 can configure the MainLoop in response to events during the execution.</p>
 <p>The keyboard inputs is dispatched by the application class to the
@@ -130,8 +130,8 @@ you desire to cancel the timer before it runs:</p>
 <p>You can register code to be executed when the application is idling
 and there are no events to process by calling the
 <a href=""><code>AddIdle</code></a>
-method.  This method takes as a parameter a function that will be
-invoked when the application is idling.  </p>
+method. This method takes as a parameter a function that will be
+invoked when the application is idling. </p>
 <p>Idle functions should return <code>true</code> if they should be invoked again,
 and <code>false</code> if the idle invocations should stop.</p>
 <p>Like the timer APIs, the return value is a token that can be used to
@@ -140,15 +140,15 @@ cancel the scheduled idle function from being executed.</p>
 <p>Like other UI toolkits, Terminal.Gui is generally not thread safe.
 You should avoid calling methods in the UI classes from a background
 thread as there is no guarantee that they will not corrupt the state
-of the UI application.  </p>
+of the UI application. </p>
 <p>Generally, as there is not much state, you will get lucky, but the
 application will not behave properly.</p>
 <p>You will be served better off by using C# async machinery and the
-various APIs in the <code>System.Threading.Tasks.Task</code> APIs.   But if you
+various APIs in the <code>System.Threading.Tasks.Task</code> APIs.  But if you
 absolutely must work with threads on your own you should only invoke
 APIs in Terminal.Gui from the main thread.</p>
 <p>To make this simple, you can use the <code>Application.MainLoop.Invoke</code>
-method and pass an <code>Action</code>.  This action will be queued for execution
+method and pass an <code>Action</code>. This action will be queued for execution
 on the main thread at an appropriate time and will run your code
 there.</p>
 <p>For example, the following shows how to properly update a label from a

+ 55 - 25
docs/articles/overview.html

@@ -78,7 +78,7 @@ easy to write applications that will work on monochrome terminals, as
 well as modern color terminals with mouse support.</p>
 <p>This library works across Windows, Linux and MacOS.</p>
 <p>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
+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
@@ -102,7 +102,7 @@ class Demo {
 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).</p>
 <p>More interesting user interfaces can be created by composing some of
-the various views that are included.   In the following sections, you
+the various views that are included. In the following sections, you
 will see how applications are put together.</p>
 <p>In the example above, you can see that we have initialized the runtime by calling the 
 <a href="../api/Terminal.Gui/Terminal.Gui.Application.html#Terminal_Gui_Application_Init_Terminal_Gui_ConsoleDriver_Terminal_Gui_IMainLoopDriver_"><code>Init</code></a> method in the Application class - this sets up the environment, initializes the color
@@ -158,12 +158,12 @@ class Demo {
 }
 </code></pre><h1 id="views">Views</h1>
 <p>All visible elements on a Terminal.Gui application are implemented as
-<a href="../api/Terminal.Gui/Terminal.Gui.View.html">Views</a>.   Views are self-contained
+<a href="../api/Terminal.Gui/Terminal.Gui.View.yml">Views</a>. Views are self-contained
 objects that take care of displaying themselves, can receive keyboard and mouse
 input and participate in the focus mechanism.</p>
-<p>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 
-<a href="../api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_"><code>Add</code></a> method, for example, to add a couple of buttons to a UI, you can do this:</p>
+<p>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 
+<a href="../api/Terminal.Gui/Terminal.Gui.View.yml#Terminal_Gui_View_Add_Terminal_Gui_View_"><code>Add</code></a> method, for example, to add a couple of buttons to a UI, you can do this:</p>
 <pre><code class="lang-csharp">void SetupMyView (View myView)
 {
     var label = new Label (&quot;Username: &quot;) {
@@ -184,18 +184,48 @@ the Subviews.   You can add a view to an existing view, by calling the
 }
 </code></pre><p>The container of a given view is called the <code>SuperView</code> and it is a property of every
 View.</p>
-<p>There are many views that you can use to spice up your application:</p>
-<p><a href="../api/Terminal.Gui/Terminal.Gui.Button.html">Buttons</a>, <a href="../api/Terminal.Gui/Terminal.Gui.Label.html">Labels</a>, <a href="../api/Terminal.Gui/Terminal.Gui.TextField.html">Text entry</a>, <a href="../api/Terminal.Gui/Terminal.Gui.TextView.html">Text view</a>, <a href="../api/Terminal.Gui/Terminal.Gui.RadioGroup.html">Radio buttons</a>, <a href="../api/Terminal.Gui/Terminal.Gui.CheckBox.html">Checkboxes</a>, <a href="../api/Terminal.Gui/Terminal.Gui.Dialog.html">Dialog boxes</a>, <a href="../api/Terminal.Gui/Terminal.Gui.MessageBox.html">Message boxes</a>, <a href="../api/Terminal.Gui/Terminal.Gui.Window.html">Windows</a>, <a href="../api/Terminal.Gui/Terminal.Gui.MenuBar.html">Menus</a>, <a href="../api/Terminal.Gui/Terminal.Gui.ListView.html">ListViews</a>, <a href="../api/Terminal.Gui/Terminal.Gui.FrameView.html">Frames</a>, <a href="../api/Terminal.Gui/Terminal.Gui.ProgressBar.html">ProgressBars</a>, <a href="../api/Terminal.Gui/Terminal.Gui.ScrollView.html">Scroll views</a> and <a href="../api/Terminal.Gui/Terminal.Gui.ScrollBarView.html">Scrollbars</a>.</p>
+<p><em>Terminal.Gui</em> provides a rich set of views and controls for building terminal user interfaces:</p>
+<ul>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Button.html">Button</a> </li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.CheckBox.html">CheckBox</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ColorPicker.html">ColorPicker</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ComboBox.html">ComboBox</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Dialog.html">Dialog</a><ul>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.OpenDialog.html">OpenDialog</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.SaveDialog.html">SaveDialog</a></li>
+</ul>
+</li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.FrameView.html">FrameView</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.GraphView.html">GraphView</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.HexView.html">Hex viewer/editor</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Label.html">Label</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ListView.html">ListView</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.MenuBar.html">Menu</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.MessageBox.html">MessageBox</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html">ProgressBar</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html">Radio buttons</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TableView.html">TableView</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TimeField.html">Time &amp; Date Fields</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TextField.html">TextField</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html">TextValidateField</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TextView.html">TextView (Text Editor)</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TreeView.html">TreeView</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ScrollView.html">ScrollView</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html">ScrollBarView</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.StatusBar.html">StatusBar</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Window.html">Window</a></li>
+<li><a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Wizard.html">Wizard</a></li>
+</ul>
 <h2 id="layout">Layout</h2>
 <p><code>Terminal.Gui</code> supports two different layout systems, absolute and computed \
 (controlled by the <a href="../api/Terminal.Gui/Terminal.Gui.LayoutStyle.html"><code>LayoutStyle</code></a>
 property on the view.</p>
 <p>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 <a href="../api/Terminal.Gui/Terminal.Gui.Rect.html"><code>Rect</code></a>.   When you do this, to change the
+one location and want to manually control where the view is. This is done
+by invoking your View constructor with an argument of type <a href="../api/Terminal.Gui/Terminal.Gui.Rect.yml"><code>Rect</code></a>. When you do this, to change the
 position of the View, you can change the <code>Frame</code> property on the View.</p>
 <p>The computed layout system offers a few additional capabilities, like automatic
-centering, expanding of dimensions and a handful of other features.  To use
+centering, expanding of dimensions and a handful of other features. To use
 this you construct your object without an initial <code>Frame</code>, but set the 
  <code>X</code>, <code>Y</code>, <code>Width</code> and <code>Height</code> properties after the object has been created.</p>
 <p>Examples:</p>
@@ -252,11 +282,11 @@ anotherView.Height = Dim.Height (view)+1
 <p>Among the many kinds of views, you typically will create a <a href="../api/Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a> view (or any of its subclasses,
 like <a href="../api/Terminal.Gui/Terminal.Gui.Window.html">Window</a> or <a href="../api/Terminal.Gui/Terminal.Gui.Dialog.html">Dialog</a> 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.   </p>
+only when the user chooses to complete their work there. </p>
 <p>The following sections cover the differences.</p>
 <h2 id="toplevel-views">TopLevel Views</h2>
-<p><a href="../api/Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a> views have no visible user interface elements and occupy an arbitrary portion of the screen.</p>
-<p>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 
+<p><a href="../api/Terminal.Gui/Terminal.Gui.Toplevel.yml">Toplevel</a> views have no visible user interface elements and occupy an arbitrary portion of the screen.</p>
+<p>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:</p>
 <pre><code class="lang-csharp">using Terminal.Gui;
 
@@ -324,7 +354,7 @@ var dialog = new Dialog (&quot;Quit&quot;, 60, 7, ok, cancel);
 +------------------------------------------------------+
 </code></pre><h2 id="running-modally">Running Modally</h2>
 <p>To run your Dialog, Window or Toplevel modally, you will invoke the <code>Application.Run</code>
-method on the toplevel.   It is up to your code and event handlers to invoke the <code>Application.RequestStop()</code> method to terminate the modal execution.</p>
+method on the toplevel. It is up to your code and event handlers to invoke the <code>Application.RequestStop()</code> method to terminate the modal execution.</p>
 <pre><code class="lang-csharp">bool okpressed = false;
 var ok = new Button(3, 14, &quot;Ok&quot;) { 
     Clicked = () =&gt; { Application.RequestStop (); okpressed = true; }
@@ -349,15 +379,15 @@ of indicating the reason that the execution of the modal dialog was completed, i
 case above, the <code>okpressed</code> value is set to true if the user pressed or selected the Ok button.</p>
 <h1 id="input-handling">Input Handling</h1>
 <p>Every view has a focused view, and if that view has nested views, one of those is 
-the focused view.   This is called the focus chain, and at any given time, only one
-View has the focus.   </p>
+the focused view. This is called the focus chain, and at any given time, only one
+View has the focus. </p>
 <p>The library binds the key Tab to focus the next logical view,
-and the Shift-Tab combination to focus the previous logical view.   </p>
+and the Shift-Tab combination to focus the previous logical view. </p>
 <p>Keyboard processing is divided in three stages: HotKey processing, regular processing and
-cold key processing.   </p>
+cold key processing. </p>
 <ul>
 <li><p>Hot key processing happens first, and it gives all the views in the current
-toplevel a chance to monitor whether the key needs to be treated specially.  This
+toplevel a chance to monitor whether the key needs to be treated specially. This
 for example handles the scenarios where the user pressed Alt-o, and a view with a 
 highlighted &quot;o&quot; is being displayed.</p>
 </li>
@@ -365,7 +395,7 @@ highlighted &quot;o&quot; is being displayed.</p>
 view.</p>
 </li>
 <li><p>If the key was not processed by the normal processing, all views are given 
-a chance to process the keystroke in their cold processing stage.  Examples
+a chance to process the keystroke in their cold processing stage. Examples
 include the processing of the &quot;return&quot; key in a dialog when a button in the
 dialog has been flagged as the &quot;default&quot; action.</p>
 </li>
@@ -373,13 +403,13 @@ dialog has been flagged as the &quot;default&quot; action.</p>
 <p>The most common case is the normal processing, which sends the keystrokes to the
 currently focused view.</p>
 <p>Mouse events are processed in visual order, and the event will be sent to the
-view on the screen.   The only exception is that no mouse events are delivered
-to background views when a modal view is running.   </p>
+view on the screen. The only exception is that no mouse events are delivered
+to background views when a modal view is running. </p>
 <p>More details are available on the <a href="keyboard.html"><code>Keyboard Event Processing</code></a> document.</p>
 <h1 id="colors-and-color-schemes">Colors and Color Schemes</h1>
 <p>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.   </p>
-<p>The various styles are captured in the <a href="../api/Terminal.Gui/Terminal.Gui.Colors.html"><code>Colors</code></a> class which defined color schemes for
+terminals as well as the more limited black and white terminals. </p>
+<p>The various styles are captured in the <a href="../api/Terminal.Gui/Terminal.Gui.Colors.yml"><code>Colors</code></a> 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:</p>
 <ul>
 <li><code>Colors.Toplevel</code></li>

+ 3 - 3
docs/articles/tableview.html

@@ -110,11 +110,11 @@ using(var con = new SqlConnection(&quot;Server=myServerAddress;Database=myDataBa
 
 tableView.Table = yourDataTable;
 </code></pre><h2 id="table-rendering">Table Rendering</h2>
-<p>TableView supports any size of table (limited only by the RAM requirements of <code>System.DataTable</code>).  You can have
-thousands of columns and/or millions of rows if you want.  Horizontal and vertical scrolling can be done using
+<p>TableView supports any size of table (limited only by the RAM requirements of <code>System.DataTable</code>). You can have
+thousands of columns and/or millions of rows if you want. Horizontal and vertical scrolling can be done using
 the mouse or keyboard.</p>
 <p>TableView uses <code>ColumnOffset</code> and <code>RowOffset</code> to determine the first visible cell of the <code>System.DataTable</code>.
-Rendering then continues until the avaialble console space is exhausted.  Updating the <code>ColumnOffset</code> and 
+Rendering then continues until the avaialble console space is exhausted. Updating the <code>ColumnOffset</code> and 
 <code>RowOffset</code> changes which part of the table is rendered (scrolls the viewport).</p>
 <p>This approach ensures that no matter how big the table, only a small number of columns/rows need to be
 evaluated for rendering.</p>

+ 34 - 10
docs/articles/views.html

@@ -5,9 +5,9 @@
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-    <title>Views </title>
+    <title> </title>
     <meta name="viewport" content="width=device-width">
-    <meta name="title" content="Views ">
+    <meta name="title" content=" ">
     <meta name="generator" content="docfx 2.59.3.0">
     
     <link rel="shortcut icon" href="../favicon.ico">
@@ -70,15 +70,39 @@
         <div class="article row grid">
           <div class="col-md-10">
             <article class="content wrap" id="_content" data-uid="">
-<h1 id="views">Views</h1>
 
-<h1 id="layout">Layout</h1>
-<h1 id="creating-custom-views">Creating Custom Views</h1>
-<h2 id="constructor">Constructor</h2>
-<h2 id="rendering">Rendering</h2>
-<h3 id="using-custom-colors">Using Custom Colors</h3>
-<h2 id="keyboard-processing">Keyboard processing</h2>
-<h2 id="mouse-event-processing">Mouse event processing</h2>
+<p><em>Terminal.Gui</em> provides a rich set of views and controls for building terminal user interfaces:</p>
+<ul>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.Button.html">Button</a> </li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.CheckBox.html">CheckBox</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.ColorPicker.html">ColorPicker</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.ComboBox.html">ComboBox</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.Dialog.html">Dialog</a><ul>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.OpenDialog.html">OpenDialog</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.SaveDialog.html">SaveDialog</a></li>
+</ul>
+</li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.FrameView.html">FrameView</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.GraphView.html">GraphView</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.HexView.html">Hex viewer/editor</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.Label.html">Label</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.ListView.html">ListView</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.MenuBar.html">Menu</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.MessageBox.html">MessageBox</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.ProgressBar.html">ProgressBar</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.RadioGroup.html">Radio buttons</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.TableView.html">TableView</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.TimeField.html">Time &amp; Date Fields</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.TextField.html">TextField</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.TextValidateField.html">TextValidateField</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.TextView.html">TextView (Text Editor)</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.TreeView.html">TreeView</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.ScrollView.html">ScrollView</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.ScrollBarView.html">ScrollBarView</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.StatusBar.html">StatusBar</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.Window.html">Window</a></li>
+<li><a href="../api/Terminal.Gui/Terminal.Gui.Wizard.html">Wizard</a></li>
+</ul>
 </article>
           </div>
           

+ 2 - 1
docs/index.html

@@ -78,7 +78,8 @@
 </ul>
 <h2 id="terminalgui-api-documentation">Terminal.Gui API Documentation</h2>
 <ul>
-<li><a href="api/Terminal.Gui/Terminal.Gui.html">API Reference</a></li>
+<li><a href="api/Terminal.Gui/Terminal.Gui.yml">API Reference</a></li>
+<li><a href="articles/views.html">Views and controls built into the Terminal.Gui library</a></li>
 <li><a href="articles/overview.html">Terminal.Gui API Overview</a></li>
 <li><a href="articles/keyboard.html">Keyboard Event Processing</a></li>
 <li><a href="articles/mainloop.html">Event Processing and the Application Main Loop</a></li>

تفاوت فایلی نمایش داده نمی شود زیرا این فایل بسیار بزرگ است
+ 1 - 1
docs/index.json


تفاوت فایلی نمایش داده نمی شود زیرا این فایل بسیار بزرگ است
+ 1 - 3061
docs/manifest.json


برخی فایل ها در این مقایسه diff نمایش داده نمی شوند زیرا تعداد فایل ها بسیار زیاد است