Browse Source

Update docs

miguel 7 years ago
parent
commit
527e787c9b
4 changed files with 491 additions and 38 deletions
  1. 208 34
      docfx/articles/overview.md
  2. 276 4
      docs/articles/overview.html
  3. 7 0
      docs/articles/views.html
  4. 0 0
      docs/manifest.json

+ 208 - 34
docfx/articles/overview.md

@@ -17,7 +17,7 @@ one or more callbacks.
 
 
 The simplest application looks like this:
 The simplest application looks like this:
 
 
-```
+```csharp
 using Terminal.Gui;
 using Terminal.Gui;
 
 
 class Demo {
 class Demo {
@@ -25,9 +25,10 @@ class Demo {
     {
     {
         Application.Init ();
         Application.Init ();
 
 
-	var n = MessageBox.Query (50, 7, "Question", "Do you like console apps?", "Yes", "No");
+        var n = MessageBox.Query (50, 7, 
+            "Question", "Do you like console apps?", "Yes", "No");
 
 
-	return n;
+        return n;
     }
     }
 }
 }
 ```
 ```
@@ -47,7 +48,7 @@ schemes available for your application and clears the screen to start your appli
 The [`Application`](../api/Terminal.Gui/Terminal.Gui.Application.html) class, additionally creates an instance of the [Toplevel]((../api/Terminal.Gui/Terminal.Gui.Toplevel.html) class that is ready to be consumed, 
 The [`Application`](../api/Terminal.Gui/Terminal.Gui.Application.html) class, additionally creates an instance of the [Toplevel]((../api/Terminal.Gui/Terminal.Gui.Toplevel.html) class that is ready to be consumed, 
 this instance is available in the `Application.Top` property, and can be used like this:
 this instance is available in the `Application.Top` property, and can be used like this:
 
 
-```
+```csharp
 using Terminal.Gui;
 using Terminal.Gui;
 
 
 class Demo {
 class Demo {
@@ -70,7 +71,7 @@ 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
 want a menu, and a region for your application to live in, the following code
 does this:
 does this:
 
 
-```
+```csharp
 using Terminal.Gui;
 using Terminal.Gui;
 
 
 class Demo {
 class Demo {
@@ -78,17 +79,19 @@ class Demo {
     {
     {
         Application.Init ();
         Application.Init ();
         var menu = new MenuBar (new MenuBarItem [] {
         var menu = new MenuBar (new MenuBarItem [] {
-			new MenuBarItem ("_File", new MenuItem [] {
-				new MenuItem ("_Quit", "", () => { Application.Top.Running = false; })
-			}),
-		});
+            new MenuBarItem ("_File", new MenuItem [] {
+                new MenuItem ("_Quit", "", () => { 
+                    Application.RequestStop (); 
+                })
+            }),
+        });
         
         
         var win = new Window ("Hello") {
         var win = new Window ("Hello") {
-			X = 0,
-			Y = 1,
-			Width = Dim.Fill (),
-			Height = Dim.Fill () - 1
-		};
+            X = 0,
+            Y = 1,
+            Width = Dim.Fill (),
+            Height = Dim.Fill () - 1
+        };
 
 
         // Add both menu and win in a single call
         // Add both menu and win in a single call
         Application.Top.Add (menu, win);
         Application.Top.Add (menu, win);
@@ -133,33 +136,156 @@ void SetupMyView (View myView)
 The container of a given view is called the `SuperView` and it is a property of every
 The container of a given view is called the `SuperView` and it is a property of every
 View.
 View.
 
 
-Among the many kinds of views, you typically will create a [Toplevel](../api/Terminal.Gui/Terminal.Gui.Toplevel.html) view or a [Window]
-(../api/Terminal.Gui/Terminal.Gui.Window.html) which are special kinds of views
+There are many views that you can use to spice up your application:
+
+[Buttons](../api/Terminal.Gui/Terminal.Gui.Button.html), [Labels](../api/Terminal.Gui/Terminal.Gui.Label.html), [Text entry](../api/Terminal.Gui/Terminal.Gui.TextField.html), [Text view](../api/Terminal.Gui/Terminal.Gui.TextView.html), [Radio buttons](../api/Terminal.Gui/Terminal.Gui.RadioGroup.html), [Checkboxes](../api/Terminal.Gui/Terminal.Gui.CheckBox.html), [Dialog boxes](../api/Terminal.Gui/Terminal.Gui.Dialog.html), [Message boxes](../api/Terminal.Gui/Terminal.Gui.MessageBox.html), [Windows](../api/Terminal.Gui/Terminal.Gui.Window.html), [Menus](../api/Terminal.Gui/Terminal.Gui.MenuBar.html), [ListViews](../api/Terminal.Gui/Terminal.Gui.ListView.html), [Frames](../api/Terminal.Gui/Terminal.Gui.FrameView.html), [ProgressBars](../api/Terminal.Gui/Terminal.Gui.ProgressBar.html), [Scroll views](../api/Terminal.Gui/Terminal.Gui.ScrollView.html) and [Scrollbars](../api/Terminal.Gui/Terminal.Gui.ScrollBarView.html).
+
+Layout
+------
+
+`Terminal.Gui` supports two different layout systems, absolute and computed \
+(controlled by the [`LayoutStyle`](../api/Terminal.Gui/Terminal.Gui.LayoutStyle.html)
+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.html).   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
+this you construct your object without an initial `Frame`, but set the 
+ `X`, `Y`, `Width` and `Height` properties after the object has been created.
+
+Examples:
+
+```csharp
+
+// Dynamically computed
+var label = new Label ("Hello") {
+    X = 1,
+    Y = Pos.Center (),
+    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/Terminal.Gui.Pos.html) and the `Width` and `Height` properties are of type [`Dim`](../api/Terminal.Gui/Terminal.Gui.Dim.html) 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()`
+
+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;
+```
+
+### 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 ()`
+
+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;
+```
+
+# TopLevels, Windows and Dialogs.
+
+Among the many kinds of views, you typically will create a [Toplevel](../api/Terminal.Gui/Terminal.Gui.Toplevel.html) view (or any of its subclasses,
+like [Window](../api/Terminal.Gui/Terminal.Gui.Window.html) or [Dialog](../api/Terminal.Gui/Terminal.Gui.Dialog.html) which is special kind of views
 that can be executed modally - that is, the view can take over all input and returns
 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.   
 
 
-Modal views take over all the event processing, and do not let other views
-receive any events while they are running.
+The following sections cover the differences.
 
 
-There are many views that you can use to spice up your application:
+## TopLevel Views
+
+[Toplevel](../api/Terminal.Gui/Terminal.Gui.Toplevel.html) 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);
+    }
+}
+```
+
+Window Views
+------------
 
 
-* [Buttons](../api/Terminal.Gui/Terminal.Gui.Button.html) 
-* [Labels](../api/Terminal.Gui/Terminal.Gui.Label.html)
-* [Text entry](../api/Terminal.Gui/Terminal.Gui.TextField.html)
-* [Text view](../api/Terminal.Gui/Terminal.Gui.TextView.html)
-* [Radio buttons](../api/Terminal.Gui/Terminal.Gui.RadioGroup.html)
-* [Checkboxes](../api/Terminal.Gui/Terminal.Gui.CheckBox.html)
-* [Dialog boxes](../api/Terminal.Gui/Terminal.Gui.Dialog.html)
-  * [Message boxes](../api/Terminal.Gui/Terminal.Gui.MessageBox.html)
-* [Windows](../api/Terminal.Gui/Terminal.Gui.Window.html)
-* [Menus](../api/Terminal.Gui/Terminal.Gui.MenuBar.html)
-* [ListViews](../api/Terminal.Gui/Terminal.Gui.ListView.html)
-* [Frames](../api/Terminal.Gui/Terminal.Gui.FrameView.html)
-* [ProgressBars](../api/Terminal.Gui/Terminal.Gui.ProgressBar.html)
-* [Scroll views](../api/Terminal.Gui/Terminal.Gui.ScrollView.html) and [Scrollbars](../api/Terminal.Gui/Terminal.Gui.ScrollBarView.html)
+[Window](../api/Terminal.Gui/Terminal.Gui.Window.html) 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)
+
+From a user interface perspective, you might have more than one Window on the screen at a given time.
 
 
 Dialogs
 Dialogs
-=======
+-------
+
+[Dialog](../api/Terminal.Gui/Terminal.Gui.Dialog.html) are [Window](../api/Terminal.Gui/Terminal.Gui.Window.html) objects that happen to be centered in the middle of the screen.
 
 
 Dialogs are instances of a Window that are centered in the screen, and are intended
 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 
 to be used modally - that is, they run, and they are expected to return a result 
@@ -169,6 +295,54 @@ Dialogs are a subclass of `Window` and additionally expose the
 [`AddButton`](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Dialog.html#Terminal_Gui_Dialog_AddButton_Terminal_Gui_Button_) API which manages the layout
 [`AddButton`](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Dialog.html#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.
 of any button passed to it, ensuring that the buttons are at the bottom of the dialog.
 
 
+Example:
+```csharp
+bool okpressed = false;
+var ok = new Button("Ok");
+var cancel = new Button("Cancel");
+var dialog = new Dialog ("Quit", 60, 7, ok, cancel);
+```
+
+Which will show something like this:
+```
++- Quit -----------------------------------------------+
+|                                                      |
+|                                                      |
+|                  [ Ok ] [ Cancel ]                   |
++------------------------------------------------------+
+```
+
+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.
+
+```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.
 
 
 Input Handling
 Input Handling
 ==============
 ==============

+ 276 - 4
docs/articles/overview.html

@@ -65,6 +65,7 @@
 applications using C#.  The framework has been designed to make it
 applications using C#.  The framework has been designed to make it
 easy to write applications that will work on monochrome terminals, as
 easy to write applications that will work on monochrome terminals, as
 well as modern color terminals with mouse support.</p>
 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
 <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 your applications and it is event based, meaning that you
@@ -72,16 +73,17 @@ create the user interface, hook up various events and then let the
 a processing loop run your application, and your code is invoked via
 a processing loop run your application, and your code is invoked via
 one or more callbacks.</p>
 one or more callbacks.</p>
 <p>The simplest application looks like this:</p>
 <p>The simplest application looks like this:</p>
-<pre><code>using Terminal.Gui;
+<pre><code class="lang-csharp">using Terminal.Gui;
 
 
 class Demo {
 class Demo {
     static int Main ()
     static int Main ()
     {
     {
         Application.Init ();
         Application.Init ();
 
 
-    var n = MessageBox.Query (50, 7, &quot;Question&quot;, &quot;Do you like console apps?&quot;, &quot;Yes&quot;, &quot;No&quot;);
+        var n = MessageBox.Query (50, 7, 
+            &quot;Question&quot;, &quot;Do you like console apps?&quot;, &quot;Yes&quot;, &quot;No&quot;);
 
 
-    return n;
+        return n;
     }
     }
 }
 }
 </code></pre><p>This example shows a prompt and returns an integer value depending on
 </code></pre><p>This example shows a prompt and returns an integer value depending on
@@ -90,7 +92,277 @@ not to make a decision and instead pressed the ESC key).</p>
 <p>More interesting user interfaces can be created by composing some of
 <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>
 will see how applications are put together.</p>
-<h1 id="view">View</h1>
+<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"><code>Init</code></a> 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.</p>
+<p>The <a href="../api/Terminal.Gui/Terminal.Gui.Application.html"><code>Application</code></a> class, additionally creates an instance of the [Toplevel]((../api/Terminal.Gui/Terminal.Gui.Toplevel.html) class that is ready to be consumed, 
+this instance is available in the <code>Application.Top</code> property, and can be used like this:</p>
+<pre><code class="lang-csharp">using Terminal.Gui;
+
+class Demo {
+    static int Main ()
+    {
+        Application.Init ();
+
+        var label = new Label (&quot;Hello World&quot;) {
+            X = Pos.Center (),
+            Y = Pos.Center (),
+            Height = 1,
+        };
+        Application.Top.Add (label);
+        Application.Run ();
+    }
+}
+</code></pre><p>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:</p>
+<pre><code class="lang-csharp">using Terminal.Gui;
+
+class Demo {
+    static int Main ()
+    {
+        Application.Init ();
+        var menu = new MenuBar (new MenuBarItem [] {
+            new MenuBarItem (&quot;_File&quot;, new MenuItem [] {
+                new MenuItem (&quot;_Quit&quot;, &quot;&quot;, () =&gt; { 
+                    Application.RequestStop (); 
+                })
+            }),
+        });
+
+        var win = new Window (&quot;Hello&quot;) {
+            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 ();
+    }
+}
+</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
+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>
+<pre><code class="lang-csharp">void SetupMyView (View myView)
+{
+    var label = new Label (&quot;Username: &quot;) {
+        X = 1,
+        Y = 1,
+        Width = 20,
+        Height = 1
+    };
+    myView.Add (label);
+
+    var username = new TextField (&quot;&quot;) {
+        X = 1,
+        Y = 2,
+        Width = 30,
+        Height = 1
+    }
+    myView.Add (username);
+}
+</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>
+<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
+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
+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>
+<pre><code class="lang-csharp">
+// Dynamically computed
+var label = new Label (&quot;Hello&quot;) {
+    X = 1,
+    Y = Pos.Center (),
+    Width = Dim.Fill (),
+    Height = 1
+};
+
+// Absolute position using the provided rectangle
+var label2 = new Label (new Rect (1, 2, 20, 1), &quot;World&quot;)
+</code></pre><p>The computed layout system does not take integers, instead the <code>X</code> and <code>Y</code> properties are of type <a href="../api/Terminal.Gui/Terminal.Gui.Pos.html"><code>Pos</code></a> and the <code>Width</code> and <code>Height</code> properties are of type <a href="../api/Terminal.Gui/Terminal.Gui.Dim.html"><code>Dim</code></a> both which can be created implicitly from integer values.</p>
+<h3 id="the-pos-type">The <code>Pos</code> Type</h3>
+<p>The <code>Pos</code> type on <code>X</code> and <code>Y</code> offers a few options:</p>
+<ul>
+<li>Absolute position, by passing an integer</li>
+<li>Percentage of the parent&#39;s view size - <code>Pos.Percent(n)</code></li>
+<li>Anchored from the end of the dimension - <code>AnchorEnd(int margin=0)</code></li>
+<li>Centered, using <code>Center()</code></li>
+</ul>
+<p>The <code>Pos</code> values can be added or subtracted, like this:</p>
+<pre><code class="lang-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;
+</code></pre><h3 id="the-dim-type">The <code>Dim</code> Type</h3>
+<p>The <code>Dim</code> type is used for the <code>Width</code> and <code>Height</code> properties on the View and offers
+the following options:</p>
+<ul>
+<li>Absolute size, by passing an integer</li>
+<li>Percentage of the parent&#39;s view size - <code>Dim.Percent(n)</code></li>
+<li>Fill to the end - <code>Dim.Fill ()</code></li>
+</ul>
+<p>Like, <code>Pos</code>, objects of type <code>Dim</code> can be added an subtracted, like this:</p>
+<pre><code class="lang-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;
+</code></pre><h1 id="toplevels-windows-and-dialogs">TopLevels, Windows and Dialogs.</h1>
+<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>
+<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 
+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;
+
+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 (&quot;_File&quot;, new MenuItem [] {
+                new MenuItem (&quot;_Close&quot;, &quot;&quot;, () =&gt; { 
+                    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);
+    }
+}
+</code></pre><h2 id="window-views">Window Views</h2>
+<p><a href="../api/Terminal.Gui/Terminal.Gui.Window.html">Window</a> 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)</p>
+<p>From a user interface perspective, you might have more than one Window on the screen at a given time.</p>
+<h2 id="dialogs">Dialogs</h2>
+<p><a href="../api/Terminal.Gui/Terminal.Gui.Dialog.html">Dialog</a> are <a href="../api/Terminal.Gui/Terminal.Gui.Window.html">Window</a> objects that happen to be centered in the middle of the screen.</p>
+<p>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.</p>
+<p>Dialogs are a subclass of <code>Window</code> and additionally expose the 
+<a href="https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Dialog.html#Terminal_Gui_Dialog_AddButton_Terminal_Gui_Button_"><code>AddButton</code></a> API which manages the layout
+of any button passed to it, ensuring that the buttons are at the bottom of the dialog.</p>
+<p>Example:</p>
+<pre><code class="lang-csharp">bool okpressed = false;
+var ok = new Button(&quot;Ok&quot;);
+var cancel = new Button(&quot;Cancel&quot;);
+var dialog = new Dialog (&quot;Quit&quot;, 60, 7, ok, cancel);
+</code></pre><p>Which will show something like this:</p>
+<pre><code>+- Quit -----------------------------------------------+
+|                                                      |
+|                                                      |
+|                  [ 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>
+<pre><code class="lang-csharp">bool okpressed = false;
+var ok = new Button(3, 14, &quot;Ok&quot;) { 
+    Clicked = () =&gt; { Application.RequestStop (); okpressed = true; }
+};
+var cancel = new Button(10, 14, &quot;Cancel&quot;) {
+    Clicked = () =&gt; Application.RequestStop () 
+};
+var dialog = new Dialog (&quot;Login&quot;, 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 (&quot;The user entered: &quot; + entry.Text);
+</code></pre><p>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 <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>
+<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>
+<p>Keyboard processing is divided in three stages: HotKey processing, regular processing and
+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
+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>
+<li><p>If no view processed the hotkey, then the key is sent to the currently focused
+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
+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>
+</ul>
+<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>
+<h1 id="color-schemes">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
+the normal views, the menu bar, popup dialog boxes and error dialog boxes.</p>
+<p>The <a href="../api/Terminal.Gui/Terminal.Gui.ColorScheme.html"><code>ColorScheme</code></a> 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.</p>
+<p>By using <code>ColorSchemes</code> you ensure that your application will work correctbly both
+in color and black and white terminals.</p>
 </article>
 </article>
           </div>
           </div>
           
           

+ 7 - 0
docs/articles/views.html

@@ -61,6 +61,13 @@
             <article class="content wrap" id="_content" data-uid="">
             <article class="content wrap" id="_content" data-uid="">
 <h1 id="views">Views</h1>
 <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>
 </article>
 </article>
           </div>
           </div>
           
           

File diff suppressed because it is too large
+ 0 - 0
docs/manifest.json


Some files were not shown because too many files changed in this diff