Doc update

2025-12-26 15:57:56 +01:00 · 2018-11-05 16:25:56 -05:00
parent 1bad3994c0
commit 843ac02f2d
31 changed files with 440 additions and 112 deletions
--- a/docfx/api/Terminal.Gui/Terminal.Gui.Dialog.yml
+++ b/docfx/api/Terminal.Gui/Terminal.Gui.Dialog.yml
@@ -62,7 +62,6 @@ items:
  - Terminal.Gui.View.PositionCursor
  - Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)
  - Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)
-  - Terminal.Gui.View.RemoveAll
  - Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  - Terminal.Gui.View.SetClip(Terminal.Gui.Rect)
  - Terminal.Gui.View.SetFocus(Terminal.Gui.View)
@@ -80,6 +79,7 @@ items:
  - Terminal.Gui.Window.MouseEvent(Terminal.Gui.MouseEvent)
  - Terminal.Gui.Window.Redraw(Terminal.Gui.Rect)
  - Terminal.Gui.Window.Remove(Terminal.Gui.View)
+  - Terminal.Gui.Window.RemoveAll
  - Terminal.Gui.Window.Title
 - uid: Terminal.Gui.Dialog.#ctor(NStack.ustring,System.Int32,System.Int32,Terminal.Gui.Button[])
  id: '#ctor(NStack.ustring,System.Int32,System.Int32,Terminal.Gui.Button[])'
@@ -479,12 +479,12 @@ references:
  name: Remove(View)
  nameWithType: Window.Remove(View)
  fullName: Window.Remove(View)
- uid: Terminal.Gui.View.RemoveAll
-  parent: Terminal.Gui.View
+- uid: Terminal.Gui.Window.RemoveAll
+  parent: Terminal.Gui.Window
  isExternal: false
  name: RemoveAll()
-  nameWithType: View.RemoveAll()
-  fullName: View.RemoveAll()
+  nameWithType: Window.RemoveAll()
+  fullName: Window.RemoveAll()
 - uid: Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  parent: Terminal.Gui.View
  isExternal: false
--- a/docfx/api/Terminal.Gui/Terminal.Gui.FileDialog.yml
+++ b/docfx/api/Terminal.Gui/Terminal.Gui.FileDialog.yml
@@ -73,7 +73,6 @@ items:
  - Terminal.Gui.View.PositionCursor
  - Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)
  - Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)
-  - Terminal.Gui.View.RemoveAll
  - Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  - Terminal.Gui.View.SetClip(Terminal.Gui.Rect)
  - Terminal.Gui.View.SetFocus(Terminal.Gui.View)
@@ -91,6 +90,7 @@ items:
  - Terminal.Gui.Window.MouseEvent(Terminal.Gui.MouseEvent)
  - Terminal.Gui.Window.Redraw(Terminal.Gui.Rect)
  - Terminal.Gui.Window.Remove(Terminal.Gui.View)
+  - Terminal.Gui.Window.RemoveAll
  - Terminal.Gui.Window.Title
 - uid: Terminal.Gui.FileDialog.#ctor(NStack.ustring,NStack.ustring,NStack.ustring,NStack.ustring)
  id: '#ctor(NStack.ustring,NStack.ustring,NStack.ustring,NStack.ustring)'
@@ -709,12 +709,12 @@ references:
  name: Remove(View)
  nameWithType: Window.Remove(View)
  fullName: Window.Remove(View)
- uid: Terminal.Gui.View.RemoveAll
-  parent: Terminal.Gui.View
+- uid: Terminal.Gui.Window.RemoveAll
+  parent: Terminal.Gui.Window
  isExternal: false
  name: RemoveAll()
-  nameWithType: View.RemoveAll()
-  fullName: View.RemoveAll()
+  nameWithType: Window.RemoveAll()
+  fullName: Window.RemoveAll()
 - uid: Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  parent: Terminal.Gui.View
  isExternal: false
--- a/docfx/api/Terminal.Gui/Terminal.Gui.FrameView.yml
+++ b/docfx/api/Terminal.Gui/Terminal.Gui.FrameView.yml
@@ -8,6 +8,7 @@ items:
  - Terminal.Gui.FrameView.Add(Terminal.Gui.View)
  - Terminal.Gui.FrameView.Redraw(Terminal.Gui.Rect)
  - Terminal.Gui.FrameView.Remove(Terminal.Gui.View)
+  - Terminal.Gui.FrameView.RemoveAll
  - Terminal.Gui.FrameView.Title
  langs:
  - csharp
@@ -61,7 +62,6 @@ items:
  - Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)
  - Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)
  - Terminal.Gui.View.ProcessKey(Terminal.Gui.KeyEvent)
-  - Terminal.Gui.View.RemoveAll
  - Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  - Terminal.Gui.View.SetClip(Terminal.Gui.Rect)
  - Terminal.Gui.View.SetFocus(Terminal.Gui.View)
@@ -185,6 +185,24 @@ items:
      description: To be added.
  overload: Terminal.Gui.FrameView.Remove*
  exceptions: []
+- uid: Terminal.Gui.FrameView.RemoveAll
+  id: RemoveAll
+  parent: Terminal.Gui.FrameView
+  langs:
+  - csharp
+  name: RemoveAll()
+  nameWithType: FrameView.RemoveAll()
+  fullName: FrameView.RemoveAll()
+  type: Method
+  assemblies:
+  - Terminal.Gui
+  namespace: Terminal.Gui
+  summary: Removes all widgets from this container.
+  syntax:
+    content: public override void RemoveAll ();
+    parameters: []
+  overload: Terminal.Gui.FrameView.RemoveAll*
+  exceptions: []
 - uid: Terminal.Gui.FrameView.Title
  id: Title
  parent: Terminal.Gui.FrameView
@@ -254,6 +272,12 @@ references:
  name: Remove(View)
  nameWithType: FrameView.Remove(View)
  fullName: FrameView.Remove(View)
+- uid: Terminal.Gui.FrameView.RemoveAll
+  parent: Terminal.Gui.FrameView
+  isExternal: false
+  name: RemoveAll()
+  nameWithType: FrameView.RemoveAll()
+  fullName: FrameView.RemoveAll()
 - uid: Terminal.Gui.FrameView.Title
  parent: Terminal.Gui.FrameView
  isExternal: false
@@ -284,6 +308,12 @@ references:
  name: Remove
  nameWithType: FrameView.Remove
  fullName: FrameView.Remove
+- uid: Terminal.Gui.FrameView.RemoveAll*
+  parent: Terminal.Gui.FrameView
+  isExternal: false
+  name: RemoveAll
+  nameWithType: FrameView.RemoveAll
+  fullName: FrameView.RemoveAll
 - uid: Terminal.Gui.FrameView.Title*
  parent: Terminal.Gui.FrameView
  isExternal: false
@@ -494,12 +524,6 @@ references:
  name: PositionCursor()
  nameWithType: View.PositionCursor()
  fullName: View.PositionCursor()
- uid: Terminal.Gui.View.RemoveAll
-  parent: Terminal.Gui.View
-  isExternal: false
-  name: RemoveAll()
-  nameWithType: View.RemoveAll()
-  fullName: View.RemoveAll()
 - uid: Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  parent: Terminal.Gui.View
  isExternal: false
--- a/docfx/api/Terminal.Gui/Terminal.Gui.ListView.yml
+++ b/docfx/api/Terminal.Gui/Terminal.Gui.ListView.yml
@@ -3,6 +3,7 @@ items:
 - uid: Terminal.Gui.ListView
  id: ListView
  children:
+  - Terminal.Gui.ListView.#ctor
  - Terminal.Gui.ListView.#ctor(System.Collections.IList)
  - Terminal.Gui.ListView.#ctor(Terminal.Gui.IListDataSource)
  - Terminal.Gui.ListView.#ctor(Terminal.Gui.Rect,System.Collections.IList)
@@ -82,6 +83,24 @@ items:
  - Terminal.Gui.View.Width
  - Terminal.Gui.View.X
  - Terminal.Gui.View.Y
+- uid: Terminal.Gui.ListView.#ctor
+  id: '#ctor'
+  parent: Terminal.Gui.ListView
+  langs:
+  - csharp
+  name: ListView()
+  nameWithType: ListView.ListView()
+  fullName: ListView.ListView()
+  type: Constructor
+  assemblies:
+  - Terminal.Gui
+  namespace: Terminal.Gui
+  summary: Initializes a new instance of the <xref href="Terminal.Gui.ListView"></xref> class.   You must set the Source property for this to show something.
+  syntax:
+    content: public ListView ();
+    parameters: []
+  overload: Terminal.Gui.ListView.#ctor*
+  exceptions: []
 - uid: Terminal.Gui.ListView.#ctor(System.Collections.IList)
  id: '#ctor(System.Collections.IList)'
  parent: Terminal.Gui.ListView
@@ -385,6 +404,12 @@ references:
  name: View
  nameWithType: View
  fullName: Terminal.Gui.View
+- uid: Terminal.Gui.ListView.#ctor
+  parent: Terminal.Gui.ListView
+  isExternal: false
+  name: ListView()
+  nameWithType: ListView.ListView()
+  fullName: ListView.ListView()
 - uid: Terminal.Gui.ListView.#ctor(System.Collections.IList)
  parent: Terminal.Gui.ListView
  isExternal: false
--- a/docfx/api/Terminal.Gui/Terminal.Gui.OpenDialog.yml
+++ b/docfx/api/Terminal.Gui/Terminal.Gui.OpenDialog.yml
@@ -89,7 +89,6 @@ items:
  - Terminal.Gui.View.PositionCursor
  - Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)
  - Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)
-  - Terminal.Gui.View.RemoveAll
  - Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  - Terminal.Gui.View.SetClip(Terminal.Gui.Rect)
  - Terminal.Gui.View.SetFocus(Terminal.Gui.View)
@@ -107,6 +106,7 @@ items:
  - Terminal.Gui.Window.MouseEvent(Terminal.Gui.MouseEvent)
  - Terminal.Gui.Window.Redraw(Terminal.Gui.Rect)
  - Terminal.Gui.Window.Remove(Terminal.Gui.View)
+  - Terminal.Gui.Window.RemoveAll
  - Terminal.Gui.Window.Title
 - uid: Terminal.Gui.OpenDialog.#ctor(NStack.ustring,NStack.ustring)
  id: '#ctor(NStack.ustring,NStack.ustring)'
@@ -541,12 +541,12 @@ references:
  name: Remove(View)
  nameWithType: Window.Remove(View)
  fullName: Window.Remove(View)
- uid: Terminal.Gui.View.RemoveAll
-  parent: Terminal.Gui.View
+- uid: Terminal.Gui.Window.RemoveAll
+  parent: Terminal.Gui.Window
  isExternal: false
  name: RemoveAll()
-  nameWithType: View.RemoveAll()
-  fullName: View.RemoveAll()
+  nameWithType: Window.RemoveAll()
+  fullName: Window.RemoveAll()
 - uid: Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  parent: Terminal.Gui.View
  isExternal: false
--- a/docfx/api/Terminal.Gui/Terminal.Gui.SaveDialog.yml
+++ b/docfx/api/Terminal.Gui/Terminal.Gui.SaveDialog.yml
@@ -73,7 +73,6 @@ items:
  - Terminal.Gui.View.PositionCursor
  - Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)
  - Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)
-  - Terminal.Gui.View.RemoveAll
  - Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  - Terminal.Gui.View.SetClip(Terminal.Gui.Rect)
  - Terminal.Gui.View.SetFocus(Terminal.Gui.View)
@@ -91,6 +90,7 @@ items:
  - Terminal.Gui.Window.MouseEvent(Terminal.Gui.MouseEvent)
  - Terminal.Gui.Window.Redraw(Terminal.Gui.Rect)
  - Terminal.Gui.Window.Remove(Terminal.Gui.View)
+  - Terminal.Gui.Window.RemoveAll
  - Terminal.Gui.Window.Title
 - uid: Terminal.Gui.SaveDialog.#ctor(NStack.ustring,NStack.ustring)
  id: '#ctor(NStack.ustring,NStack.ustring)'
@@ -396,12 +396,12 @@ references:
  name: Remove(View)
  nameWithType: Window.Remove(View)
  fullName: Window.Remove(View)
- uid: Terminal.Gui.View.RemoveAll
-  parent: Terminal.Gui.View
+- uid: Terminal.Gui.Window.RemoveAll
+  parent: Terminal.Gui.Window
  isExternal: false
  name: RemoveAll()
-  nameWithType: View.RemoveAll()
-  fullName: View.RemoveAll()
+  nameWithType: Window.RemoveAll()
+  fullName: Window.RemoveAll()
 - uid: Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  parent: Terminal.Gui.View
  isExternal: false
--- a/docfx/api/Terminal.Gui/Terminal.Gui.ScrollView.yml
+++ b/docfx/api/Terminal.Gui/Terminal.Gui.ScrollView.yml
@@ -10,6 +10,7 @@ items:
  - Terminal.Gui.ScrollView.PositionCursor
  - Terminal.Gui.ScrollView.ProcessKey(Terminal.Gui.KeyEvent)
  - Terminal.Gui.ScrollView.Redraw(Terminal.Gui.Rect)
+  - Terminal.Gui.ScrollView.RemoveAll
  - Terminal.Gui.ScrollView.ScrollDown(System.Int32)
  - Terminal.Gui.ScrollView.Scrolled
  - Terminal.Gui.ScrollView.ScrollLeft(System.Int32)
@@ -69,7 +70,6 @@ items:
  - Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)
  - Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)
  - Terminal.Gui.View.Remove(Terminal.Gui.View)
-  - Terminal.Gui.View.RemoveAll
  - Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  - Terminal.Gui.View.SetClip(Terminal.Gui.Rect)
  - Terminal.Gui.View.SetFocus(Terminal.Gui.View)
@@ -223,6 +223,24 @@ items:
      description: To be added.
  overload: Terminal.Gui.ScrollView.Redraw*
  exceptions: []
+- uid: Terminal.Gui.ScrollView.RemoveAll
+  id: RemoveAll
+  parent: Terminal.Gui.ScrollView
+  langs:
+  - csharp
+  name: RemoveAll()
+  nameWithType: ScrollView.RemoveAll()
+  fullName: ScrollView.RemoveAll()
+  type: Method
+  assemblies:
+  - Terminal.Gui
+  namespace: Terminal.Gui
+  summary: Removes all widgets from this container.
+  syntax:
+    content: public override void RemoveAll ();
+    parameters: []
+  overload: Terminal.Gui.ScrollView.RemoveAll*
+  exceptions: []
 - uid: Terminal.Gui.ScrollView.ScrollDown(System.Int32)
  id: ScrollDown(System.Int32)
  parent: Terminal.Gui.ScrollView
@@ -457,6 +475,12 @@ references:
  name: Redraw(Rect)
  nameWithType: ScrollView.Redraw(Rect)
  fullName: ScrollView.Redraw(Rect)
+- uid: Terminal.Gui.ScrollView.RemoveAll
+  parent: Terminal.Gui.ScrollView
+  isExternal: false
+  name: RemoveAll()
+  nameWithType: ScrollView.RemoveAll()
+  fullName: ScrollView.RemoveAll()
 - uid: Terminal.Gui.ScrollView.ScrollDown(System.Int32)
  parent: Terminal.Gui.ScrollView
  isExternal: false
@@ -576,6 +600,12 @@ references:
  name: Redraw
  nameWithType: ScrollView.Redraw
  fullName: ScrollView.Redraw
+- uid: Terminal.Gui.ScrollView.RemoveAll*
+  parent: Terminal.Gui.ScrollView
+  isExternal: false
+  name: RemoveAll
+  nameWithType: ScrollView.RemoveAll
+  fullName: ScrollView.RemoveAll
 - uid: Terminal.Gui.ScrollView.ScrollDown*
  parent: Terminal.Gui.ScrollView
  isExternal: false
@@ -810,12 +840,6 @@ references:
  name: Remove(View)
  nameWithType: View.Remove(View)
  fullName: View.Remove(View)
- uid: Terminal.Gui.View.RemoveAll
-  parent: Terminal.Gui.View
-  isExternal: false
-  name: RemoveAll()
-  nameWithType: View.RemoveAll()
-  fullName: View.RemoveAll()
 - uid: Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  parent: Terminal.Gui.View
  isExternal: false
--- a/docfx/api/Terminal.Gui/Terminal.Gui.TextView.yml
+++ b/docfx/api/Terminal.Gui/Terminal.Gui.TextView.yml
@@ -13,6 +13,7 @@ items:
  - Terminal.Gui.TextView.MouseEvent(Terminal.Gui.MouseEvent)
  - Terminal.Gui.TextView.PositionCursor
  - Terminal.Gui.TextView.ProcessKey(Terminal.Gui.KeyEvent)
+  - Terminal.Gui.TextView.ReadOnly
  - Terminal.Gui.TextView.Redraw(Terminal.Gui.Rect)
  - Terminal.Gui.TextView.Text
  langs:
@@ -286,6 +287,25 @@ items:
      description: To be added.
  overload: Terminal.Gui.TextView.ProcessKey*
  exceptions: []
+- uid: Terminal.Gui.TextView.ReadOnly
+  id: ReadOnly
+  parent: Terminal.Gui.TextView
+  langs:
+  - csharp
+  name: ReadOnly
+  nameWithType: TextView.ReadOnly
+  fullName: TextView.ReadOnly
+  type: Property
+  assemblies:
+  - Terminal.Gui
+  namespace: Terminal.Gui
+  syntax:
+    content: public bool ReadOnly { get; set; }
+    return:
+      type: System.Boolean
+      description: To be added.
+  overload: Terminal.Gui.TextView.ReadOnly*
+  exceptions: []
 - uid: Terminal.Gui.TextView.Redraw(Terminal.Gui.Rect)
  id: Redraw(Terminal.Gui.Rect)
  parent: Terminal.Gui.TextView
@@ -436,6 +456,12 @@ references:
  name: KeyEvent
  nameWithType: KeyEvent
  fullName: Terminal.Gui.KeyEvent
+- uid: Terminal.Gui.TextView.ReadOnly
+  parent: Terminal.Gui.TextView
+  isExternal: false
+  name: ReadOnly
+  nameWithType: TextView.ReadOnly
+  fullName: TextView.ReadOnly
 - uid: Terminal.Gui.TextView.Redraw(Terminal.Gui.Rect)
  parent: Terminal.Gui.TextView
  isExternal: false
@@ -508,6 +534,12 @@ references:
  name: ProcessKey
  nameWithType: TextView.ProcessKey
  fullName: TextView.ProcessKey
+- uid: Terminal.Gui.TextView.ReadOnly*
+  parent: Terminal.Gui.TextView
+  isExternal: false
+  name: ReadOnly
+  nameWithType: TextView.ReadOnly
+  fullName: TextView.ReadOnly
 - uid: Terminal.Gui.TextView.Redraw*
  parent: Terminal.Gui.TextView
  isExternal: false
--- a/docfx/api/Terminal.Gui/Terminal.Gui.Window.yml
+++ b/docfx/api/Terminal.Gui/Terminal.Gui.Window.yml
@@ -12,6 +12,7 @@ items:
  - Terminal.Gui.Window.MouseEvent(Terminal.Gui.MouseEvent)
  - Terminal.Gui.Window.Redraw(Terminal.Gui.Rect)
  - Terminal.Gui.Window.Remove(Terminal.Gui.View)
+  - Terminal.Gui.Window.RemoveAll
  - Terminal.Gui.Window.Title
  langs:
  - csharp
@@ -70,7 +71,6 @@ items:
  - Terminal.Gui.View.PositionCursor
  - Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)
  - Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)
-  - Terminal.Gui.View.RemoveAll
  - Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  - Terminal.Gui.View.SetClip(Terminal.Gui.Rect)
  - Terminal.Gui.View.SetFocus(Terminal.Gui.View)
@@ -285,6 +285,24 @@ items:
      description: To be added.
  overload: Terminal.Gui.Window.Remove*
  exceptions: []
+- uid: Terminal.Gui.Window.RemoveAll
+  id: RemoveAll
+  parent: Terminal.Gui.Window
+  langs:
+  - csharp
+  name: RemoveAll()
+  nameWithType: Window.RemoveAll()
+  fullName: Window.RemoveAll()
+  type: Method
+  assemblies:
+  - Terminal.Gui
+  namespace: Terminal.Gui
+  summary: Removes all widgets from this container.
+  syntax:
+    content: public override void RemoveAll ();
+    parameters: []
+  overload: Terminal.Gui.Window.RemoveAll*
+  exceptions: []
 - uid: Terminal.Gui.Window.Title
  id: Title
  parent: Terminal.Gui.Window
@@ -408,6 +426,12 @@ references:
  name: Remove(View)
  nameWithType: Window.Remove(View)
  fullName: Window.Remove(View)
+- uid: Terminal.Gui.Window.RemoveAll
+  parent: Terminal.Gui.Window
+  isExternal: false
+  name: RemoveAll()
+  nameWithType: Window.RemoveAll()
+  fullName: Window.RemoveAll()
 - uid: Terminal.Gui.Window.Title
  parent: Terminal.Gui.Window
  isExternal: false
@@ -450,6 +474,12 @@ references:
  name: Remove
  nameWithType: Window.Remove
  fullName: Window.Remove
+- uid: Terminal.Gui.Window.RemoveAll*
+  parent: Terminal.Gui.Window
+  isExternal: false
+  name: RemoveAll
+  nameWithType: Window.RemoveAll
+  fullName: Window.RemoveAll
 - uid: Terminal.Gui.Window.Title*
  parent: Terminal.Gui.Window
  isExternal: false
@@ -648,12 +678,6 @@ references:
  name: PositionCursor()
  nameWithType: View.PositionCursor()
  fullName: View.PositionCursor()
- uid: Terminal.Gui.View.RemoveAll
-  parent: Terminal.Gui.View
-  isExternal: false
-  name: RemoveAll()
-  nameWithType: View.RemoveAll()
-  fullName: View.RemoveAll()
 - uid: Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
  parent: Terminal.Gui.View
  isExternal: false
--- a/docfx/articles/overview.md
+++ b/docfx/articles/overview.md
@@ -384,6 +384,8 @@ 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.   

+More details are available on the [`Keyboard Event Processing`](keyboard.html) document.
+
 Color Schemes
 =============

@@ -400,4 +402,7 @@ a view is focused an the colors for the hot-keys both in focused and unfocused m
 By using `ColorSchemes` you ensure that your application will work correctbly both
 in color and black and white terminals.

+MainLoop, Threads and Input Handling
+====================================

+Detailed description of the mainlop is described on the [Event Processing and the Application Main Loop](mainloop.html) document.