Update docs

This commit is contained in:
Miguel de Icaza
2018-03-22 11:53:07 -04:00
parent 9a0cfcd3a0
commit 852aa95236
69 changed files with 2074 additions and 134 deletions

View File

@@ -4,6 +4,7 @@ items:
id: MainLoop
children:
- Mono.Terminal.MainLoop.#ctor
- Mono.Terminal.MainLoop.#ctor(System.Boolean)
- Mono.Terminal.MainLoop.AddIdle(System.Func{System.Boolean})
- Mono.Terminal.MainLoop.AddTimeout(System.TimeSpan,System.Func{Mono.Terminal.MainLoop,System.Boolean})
- Mono.Terminal.MainLoop.AddWatch(System.Int32,Mono.Terminal.MainLoop.Condition,System.Func{Mono.Terminal.MainLoop,System.Boolean})
@@ -15,6 +16,7 @@ items:
- Mono.Terminal.MainLoop.RemoveWatch(System.Object)
- Mono.Terminal.MainLoop.Run
- Mono.Terminal.MainLoop.Stop
- Mono.Terminal.MainLoop.WindowsKeyPressed
langs:
- csharp
name: MainLoop
@@ -54,6 +56,26 @@ items:
parameters: []
overload: Mono.Terminal.MainLoop.#ctor*
exceptions: []
- uid: Mono.Terminal.MainLoop.#ctor(System.Boolean)
id: '#ctor(System.Boolean)'
parent: Mono.Terminal.MainLoop
langs:
- csharp
name: MainLoop(Boolean)
nameWithType: MainLoop.MainLoop(Boolean)
fullName: MainLoop.MainLoop(Boolean)
type: Constructor
assemblies:
- Terminal.Gui
namespace: Mono.Terminal
syntax:
content: public MainLoop (bool useUnix);
parameters:
- id: useUnix
type: System.Boolean
description: To be added.
overload: Mono.Terminal.MainLoop.#ctor*
exceptions: []
- uid: Mono.Terminal.MainLoop.AddIdle(System.Func{System.Boolean})
id: AddIdle(System.Func{System.Boolean})
parent: Mono.Terminal.MainLoop
@@ -306,6 +328,25 @@ items:
parameters: []
overload: Mono.Terminal.MainLoop.Stop*
exceptions: []
- uid: Mono.Terminal.MainLoop.WindowsKeyPressed
id: WindowsKeyPressed
parent: Mono.Terminal.MainLoop
langs:
- csharp
name: WindowsKeyPressed
nameWithType: MainLoop.WindowsKeyPressed
fullName: MainLoop.WindowsKeyPressed
type: Field
assemblies:
- Terminal.Gui
namespace: Mono.Terminal
summary: This event is raised when a key is pressed when using the Windows driver.
syntax:
content: public Action<ConsoleKeyInfo> WindowsKeyPressed;
return:
type: System.Action{System.ConsoleKeyInfo}
description: To be added.
exceptions: []
references:
- uid: System.Object
parent: System
@@ -319,6 +360,18 @@ references:
name: MainLoop()
nameWithType: MainLoop.MainLoop()
fullName: MainLoop.MainLoop()
- uid: Mono.Terminal.MainLoop.#ctor(System.Boolean)
parent: Mono.Terminal.MainLoop
isExternal: false
name: MainLoop(Boolean)
nameWithType: MainLoop.MainLoop(Boolean)
fullName: MainLoop.MainLoop(Boolean)
- uid: System.Boolean
parent: System
isExternal: true
name: Boolean
nameWithType: Boolean
fullName: System.Boolean
- uid: Mono.Terminal.MainLoop.AddIdle(System.Func{System.Boolean})
parent: Mono.Terminal.MainLoop
isExternal: false
@@ -329,10 +382,6 @@ references:
name: Func
nameWithType: Func
fullName: System.Func
- uid: System.Boolean
name: Boolean
nameWithType: Boolean
fullName: System.Boolean
- uid: System.Func{System.Boolean}
parent: System
isExternal: true
@@ -468,6 +517,41 @@ references:
name: Stop()
nameWithType: MainLoop.Stop()
fullName: MainLoop.Stop()
- uid: Mono.Terminal.MainLoop.WindowsKeyPressed
parent: Mono.Terminal.MainLoop
isExternal: false
name: WindowsKeyPressed
nameWithType: MainLoop.WindowsKeyPressed
fullName: MainLoop.WindowsKeyPressed
- uid: System.Action`1
name: Action
nameWithType: Action
fullName: System.Action
- uid: System.ConsoleKeyInfo
name: ConsoleKeyInfo
nameWithType: ConsoleKeyInfo
fullName: System.ConsoleKeyInfo
- uid: System.Action{System.ConsoleKeyInfo}
parent: System
isExternal: true
name: Action<ConsoleKeyInfo>
nameWithType: Action<ConsoleKeyInfo>
fullName: System.Action<System.ConsoleKeyInfo>
spec.csharp:
- uid: System.Action`1
name: Action
nameWithType: Action
fullName: System.Action
- name: <
nameWithType: <
fullName: <
- uid: System.ConsoleKeyInfo
name: ConsoleKeyInfo
nameWithType: ConsoleKeyInfo
fullName: System.ConsoleKeyInfo
- name: '>'
nameWithType: '>'
fullName: '>'
- uid: Mono.Terminal.MainLoop.#ctor*
parent: Mono.Terminal.MainLoop
isExternal: false

View File

@@ -14,6 +14,7 @@ items:
- Terminal.Gui.ColorScheme
- Terminal.Gui.ConsoleDriver
- Terminal.Gui.Dialog
- Terminal.Gui.FileDialog
- Terminal.Gui.FrameView
- Terminal.Gui.IListDataSource
- Terminal.Gui.Key
@@ -26,17 +27,20 @@ items:
- Terminal.Gui.MessageBox
- Terminal.Gui.MouseEvent
- Terminal.Gui.MouseFlags
- Terminal.Gui.OpenDialog
- Terminal.Gui.Point
- Terminal.Gui.ProgressBar
- Terminal.Gui.RadioGroup
- Terminal.Gui.Rect
- Terminal.Gui.Responder
- Terminal.Gui.SaveDialog
- Terminal.Gui.ScrollBarView
- Terminal.Gui.ScrollView
- Terminal.Gui.Size
- Terminal.Gui.SpecialChar
- Terminal.Gui.TextAlignment
- Terminal.Gui.TextField
- Terminal.Gui.TextView
- Terminal.Gui.Toplevel
- Terminal.Gui.View
- Terminal.Gui.Window
@@ -113,6 +117,12 @@ references:
name: Dialog
nameWithType: Dialog
fullName: Terminal.Gui.Dialog
- uid: Terminal.Gui.FileDialog
parent: Terminal.Gui
isExternal: false
name: FileDialog
nameWithType: FileDialog
fullName: Terminal.Gui.FileDialog
- uid: Terminal.Gui.FrameView
parent: Terminal.Gui
isExternal: false
@@ -185,6 +195,12 @@ references:
name: MouseFlags
nameWithType: MouseFlags
fullName: Terminal.Gui.MouseFlags
- uid: Terminal.Gui.OpenDialog
parent: Terminal.Gui
isExternal: false
name: OpenDialog
nameWithType: OpenDialog
fullName: Terminal.Gui.OpenDialog
- uid: Terminal.Gui.Point
parent: Terminal.Gui
isExternal: false
@@ -215,6 +231,12 @@ references:
name: Responder
nameWithType: Responder
fullName: Terminal.Gui.Responder
- uid: Terminal.Gui.SaveDialog
parent: Terminal.Gui
isExternal: false
name: SaveDialog
nameWithType: SaveDialog
fullName: Terminal.Gui.SaveDialog
- uid: Terminal.Gui.ScrollBarView
parent: Terminal.Gui
isExternal: false
@@ -251,6 +273,12 @@ references:
name: TextField
nameWithType: TextField
fullName: Terminal.Gui.TextField
- uid: Terminal.Gui.TextView
parent: Terminal.Gui
isExternal: false
name: TextView
nameWithType: TextView
fullName: Terminal.Gui.TextView
- uid: Terminal.Gui.Toplevel
parent: Terminal.Gui
isExternal: false

View File

@@ -60,7 +60,7 @@ items:
namespace: Terminal.Gui
summary: Dispose the specified disposing.
syntax:
content: public virtual void Dispose (bool disposing);
content: protected virtual void Dispose (bool disposing);
parameters:
- id: disposing
type: System.Boolean

View File

@@ -134,7 +134,7 @@ items:
namespace: Terminal.Gui
summary: 'Building block API: completes the exection of a Toplevel that was started with Begin.'
syntax:
content: public static void End (Terminal.Gui.Application.RunState rs);
content: public static void End (Terminal.Gui.Application.RunState runState);
parameters:
- id: rs
type: Terminal.Gui.Application+RunState

View File

@@ -3,9 +3,13 @@ items:
- uid: Terminal.Gui.Button
id: Button
children:
- Terminal.Gui.Button.#ctor(NStack.ustring)
- Terminal.Gui.Button.#ctor(System.String)
- Terminal.Gui.Button.#ctor(NStack.ustring,System.Boolean)
- Terminal.Gui.Button.#ctor(System.String,System.Boolean)
- Terminal.Gui.Button.#ctor(System.Int32,System.Int32,NStack.ustring)
- Terminal.Gui.Button.#ctor(System.Int32,System.Int32,System.String)
- Terminal.Gui.Button.#ctor(System.Int32,System.Int32,NStack.ustring,System.Boolean)
- Terminal.Gui.Button.#ctor(System.Int32,System.Int32,System.String,System.Boolean)
- Terminal.Gui.Button.Clicked
- Terminal.Gui.Button.IsDefault
@@ -88,6 +92,32 @@ items:
- Terminal.Gui.View.SuperView
- Terminal.Gui.View.ToString
- Terminal.Gui.View.WantMousePositionReports
- uid: Terminal.Gui.Button.#ctor(NStack.ustring)
id: '#ctor(NStack.ustring)'
parent: Terminal.Gui.Button
langs:
- csharp
name: Button(ustring)
nameWithType: Button.Button(ustring)
fullName: Button.Button(ustring)
type: Constructor
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: >-
Public constructor, creates a button based on
the given text at position 0,0
remarks: >-
The size of the button is computed based on the
text length. This button is not a default button.
syntax:
content: public Button (NStack.ustring text);
parameters:
- id: text
type: NStack.ustring
description: The button's text
overload: Terminal.Gui.Button.#ctor*
exceptions: []
- uid: Terminal.Gui.Button.#ctor(System.String)
id: '#ctor(System.String)'
parent: Terminal.Gui.Button
@@ -114,6 +144,36 @@ items:
description: To be added.
overload: Terminal.Gui.Button.#ctor*
exceptions: []
- uid: Terminal.Gui.Button.#ctor(NStack.ustring,System.Boolean)
id: '#ctor(NStack.ustring,System.Boolean)'
parent: Terminal.Gui.Button
langs:
- csharp
name: Button(ustring, Boolean)
nameWithType: Button.Button(ustring, Boolean)
fullName: Button.Button(ustring, Boolean)
type: Constructor
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: >-
Public constructor, creates a button based on
the given text.
remarks: >-
If the value for is_default is true, a special
decoration is used, and the enter key on a
dialog would implicitly activate this button.
syntax:
content: public Button (NStack.ustring text, bool is_default);
parameters:
- id: text
type: NStack.ustring
description: The button's text
- id: is_default
type: System.Boolean
description: If set, this makes the button the default button in the current view, which means that if the user presses return on a view that does not handle return, it will be treated as if he had clicked on the button
overload: Terminal.Gui.Button.#ctor*
exceptions: []
- uid: Terminal.Gui.Button.#ctor(System.String,System.Boolean)
id: '#ctor(System.String,System.Boolean)'
parent: Terminal.Gui.Button
@@ -144,6 +204,38 @@ items:
description: To be added.
overload: Terminal.Gui.Button.#ctor*
exceptions: []
- uid: Terminal.Gui.Button.#ctor(System.Int32,System.Int32,NStack.ustring)
id: '#ctor(System.Int32,System.Int32,NStack.ustring)'
parent: Terminal.Gui.Button
langs:
- csharp
name: Button(Int32, Int32, ustring)
nameWithType: Button.Button(Int32, Int32, ustring)
fullName: Button.Button(Int32, Int32, ustring)
type: Constructor
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: >-
Public constructor, creates a button based on
the given text at the given position.
remarks: >-
The size of the button is computed based on the
text length. This button is not a default button.
syntax:
content: public Button (int x, int y, NStack.ustring text);
parameters:
- id: x
type: System.Int32
description: X position where the button will be shown.
- id: y
type: System.Int32
description: Y position where the button will be shown.
- id: text
type: NStack.ustring
description: The button's text
overload: Terminal.Gui.Button.#ctor*
exceptions: []
- uid: Terminal.Gui.Button.#ctor(System.Int32,System.Int32,System.String)
id: '#ctor(System.Int32,System.Int32,System.String)'
parent: Terminal.Gui.Button
@@ -176,6 +268,42 @@ items:
description: To be added.
overload: Terminal.Gui.Button.#ctor*
exceptions: []
- uid: Terminal.Gui.Button.#ctor(System.Int32,System.Int32,NStack.ustring,System.Boolean)
id: '#ctor(System.Int32,System.Int32,NStack.ustring,System.Boolean)'
parent: Terminal.Gui.Button
langs:
- csharp
name: Button(Int32, Int32, ustring, Boolean)
nameWithType: Button.Button(Int32, Int32, ustring, Boolean)
fullName: Button.Button(Int32, Int32, ustring, Boolean)
type: Constructor
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: >-
Public constructor, creates a button based on
the given text at the given position.
remarks: >-
If the value for is_default is true, a special
decoration is used, and the enter key on a
dialog would implicitly activate this button.
syntax:
content: public Button (int x, int y, NStack.ustring text, bool is_default);
parameters:
- id: x
type: System.Int32
description: X position where the button will be shown.
- id: y
type: System.Int32
description: Y position where the button will be shown.
- id: text
type: NStack.ustring
description: The button's text
- id: is_default
type: System.Boolean
description: If set, this makes the button the default button in the current view, which means that if the user presses return on a view that does not handle return, it will be treated as if he had clicked on the button
overload: Terminal.Gui.Button.#ctor*
exceptions: []
- uid: Terminal.Gui.Button.#ctor(System.Int32,System.Int32,System.String,System.Boolean)
id: '#ctor(System.Int32,System.Int32,System.String,System.Boolean)'
parent: Terminal.Gui.Button
@@ -411,6 +539,18 @@ references:
name: View
nameWithType: View
fullName: Terminal.Gui.View
- uid: Terminal.Gui.Button.#ctor(NStack.ustring)
parent: Terminal.Gui.Button
isExternal: false
name: Button(ustring)
nameWithType: Button.Button(ustring)
fullName: Button.Button(ustring)
- uid: NStack.ustring
parent: NStack
isExternal: true
name: ustring
nameWithType: ustring
fullName: NStack.ustring
- uid: Terminal.Gui.Button.#ctor(System.String)
parent: Terminal.Gui.Button
isExternal: false
@@ -423,30 +563,48 @@ references:
name: String
nameWithType: String
fullName: System.String
- uid: Terminal.Gui.Button.#ctor(System.String,System.Boolean)
- uid: Terminal.Gui.Button.#ctor(NStack.ustring,System.Boolean)
parent: Terminal.Gui.Button
isExternal: false
name: Button(String, Boolean)
nameWithType: Button.Button(String, Boolean)
fullName: Button.Button(String, Boolean)
name: Button(ustring, Boolean)
nameWithType: Button.Button(ustring, Boolean)
fullName: Button.Button(ustring, Boolean)
- uid: System.Boolean
parent: System
isExternal: true
name: Boolean
nameWithType: Boolean
fullName: System.Boolean
- uid: Terminal.Gui.Button.#ctor(System.Int32,System.Int32,System.String)
- uid: Terminal.Gui.Button.#ctor(System.String,System.Boolean)
parent: Terminal.Gui.Button
isExternal: false
name: Button(Int32, Int32, String)
nameWithType: Button.Button(Int32, Int32, String)
fullName: Button.Button(Int32, Int32, String)
name: Button(String, Boolean)
nameWithType: Button.Button(String, Boolean)
fullName: Button.Button(String, Boolean)
- uid: Terminal.Gui.Button.#ctor(System.Int32,System.Int32,NStack.ustring)
parent: Terminal.Gui.Button
isExternal: false
name: Button(Int32, Int32, ustring)
nameWithType: Button.Button(Int32, Int32, ustring)
fullName: Button.Button(Int32, Int32, ustring)
- uid: System.Int32
parent: System
isExternal: true
name: Int32
nameWithType: Int32
fullName: System.Int32
- uid: Terminal.Gui.Button.#ctor(System.Int32,System.Int32,System.String)
parent: Terminal.Gui.Button
isExternal: false
name: Button(Int32, Int32, String)
nameWithType: Button.Button(Int32, Int32, String)
fullName: Button.Button(Int32, Int32, String)
- uid: Terminal.Gui.Button.#ctor(System.Int32,System.Int32,NStack.ustring,System.Boolean)
parent: Terminal.Gui.Button
isExternal: false
name: Button(Int32, Int32, ustring, Boolean)
nameWithType: Button.Button(Int32, Int32, ustring, Boolean)
fullName: Button.Button(Int32, Int32, ustring, Boolean)
- uid: Terminal.Gui.Button.#ctor(System.Int32,System.Int32,System.String,System.Boolean)
parent: Terminal.Gui.Button
isExternal: false
@@ -531,12 +689,6 @@ references:
name: Text
nameWithType: Button.Text
fullName: Button.Text
- uid: NStack.ustring
parent: NStack
isExternal: true
name: ustring
nameWithType: ustring
fullName: NStack.ustring
- uid: Terminal.Gui.Button.#ctor*
parent: Terminal.Gui.Button
isExternal: false

View File

@@ -28,8 +28,8 @@ items:
- Terminal.Gui.ConsoleDriver.RightTee
- Terminal.Gui.ConsoleDriver.Rows
- Terminal.Gui.ConsoleDriver.SetAttribute(Terminal.Gui.Attribute)
- Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)
- Terminal.Gui.ConsoleDriver.SetColors(System.ConsoleColor,System.ConsoleColor)
- Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)
- Terminal.Gui.ConsoleDriver.StartReportingMouseMoves
- Terminal.Gui.ConsoleDriver.Stipple
- Terminal.Gui.ConsoleDriver.StopReportingMouseMoves
@@ -37,6 +37,8 @@ items:
- Terminal.Gui.ConsoleDriver.TopTee
- Terminal.Gui.ConsoleDriver.ULCorner
- Terminal.Gui.ConsoleDriver.UncookMouse
- Terminal.Gui.ConsoleDriver.UpdateCursor
- Terminal.Gui.ConsoleDriver.UpdateScreen
- Terminal.Gui.ConsoleDriver.URCorner
- Terminal.Gui.ConsoleDriver.VLine
langs:
@@ -449,7 +451,7 @@ items:
- Terminal.Gui
namespace: Terminal.Gui
syntax:
content: public abstract void PrepareToRun (Mono.Terminal.MainLoop mainLoop, Action<Terminal.Gui.KeyEvent> target, Action<Terminal.Gui.MouseEvent> mouse);
content: public abstract void PrepareToRun (Mono.Terminal.MainLoop mainLoop, Action<Terminal.Gui.KeyEvent> keyHandler, Action<Terminal.Gui.MouseEvent> mouseHandler);
parameters:
- id: mainLoop
type: Mono.Terminal.MainLoop
@@ -557,6 +559,29 @@ items:
description: C.
overload: Terminal.Gui.ConsoleDriver.SetAttribute*
exceptions: []
- uid: Terminal.Gui.ConsoleDriver.SetColors(System.ConsoleColor,System.ConsoleColor)
id: SetColors(System.ConsoleColor,System.ConsoleColor)
parent: Terminal.Gui.ConsoleDriver
langs:
- csharp
name: SetColors(ConsoleColor, ConsoleColor)
nameWithType: ConsoleDriver.SetColors(ConsoleColor, ConsoleColor)
fullName: ConsoleDriver.SetColors(ConsoleColor, ConsoleColor)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
syntax:
content: public abstract void SetColors (ConsoleColor foreground, ConsoleColor background);
parameters:
- id: foreground
type: System.ConsoleColor
description: To be added.
- id: background
type: System.ConsoleColor
description: To be added.
overload: Terminal.Gui.ConsoleDriver.SetColors*
exceptions: []
- uid: Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)
id: SetColors(System.Int16,System.Int16)
parent: Terminal.Gui.ConsoleDriver
@@ -581,29 +606,6 @@ items:
description: Background color identifier.
overload: Terminal.Gui.ConsoleDriver.SetColors*
exceptions: []
- uid: Terminal.Gui.ConsoleDriver.SetColors(System.ConsoleColor,System.ConsoleColor)
id: SetColors(System.ConsoleColor,System.ConsoleColor)
parent: Terminal.Gui.ConsoleDriver
langs:
- csharp
name: SetColors(ConsoleColor, ConsoleColor)
nameWithType: ConsoleDriver.SetColors(ConsoleColor, ConsoleColor)
fullName: ConsoleDriver.SetColors(ConsoleColor, ConsoleColor)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
syntax:
content: public abstract void SetColors (ConsoleColor foreground, ConsoleColor background);
parameters:
- id: foreground
type: System.ConsoleColor
description: To be added.
- id: background
type: System.ConsoleColor
description: To be added.
overload: Terminal.Gui.ConsoleDriver.SetColors*
exceptions: []
- uid: Terminal.Gui.ConsoleDriver.StartReportingMouseMoves
id: StartReportingMouseMoves
parent: Terminal.Gui.ConsoleDriver
@@ -731,6 +733,42 @@ items:
parameters: []
overload: Terminal.Gui.ConsoleDriver.UncookMouse*
exceptions: []
- uid: Terminal.Gui.ConsoleDriver.UpdateCursor
id: UpdateCursor
parent: Terminal.Gui.ConsoleDriver
langs:
- csharp
name: UpdateCursor()
nameWithType: ConsoleDriver.UpdateCursor()
fullName: ConsoleDriver.UpdateCursor()
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: Updates the location of the cursor position
syntax:
content: public abstract void UpdateCursor ();
parameters: []
overload: Terminal.Gui.ConsoleDriver.UpdateCursor*
exceptions: []
- uid: Terminal.Gui.ConsoleDriver.UpdateScreen
id: UpdateScreen
parent: Terminal.Gui.ConsoleDriver
langs:
- csharp
name: UpdateScreen()
nameWithType: ConsoleDriver.UpdateScreen()
fullName: ConsoleDriver.UpdateScreen()
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: Redraws the physical screen with the contents that have been queued up via any of the printing commands.
syntax:
content: public abstract void UpdateScreen ();
parameters: []
overload: Terminal.Gui.ConsoleDriver.UpdateScreen*
exceptions: []
- uid: Terminal.Gui.ConsoleDriver.URCorner
id: URCorner
parent: Terminal.Gui.ConsoleDriver
@@ -1040,18 +1078,6 @@ references:
name: Attribute
nameWithType: Attribute
fullName: Terminal.Gui.Attribute
- uid: Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)
parent: Terminal.Gui.ConsoleDriver
isExternal: false
name: SetColors(Int16, Int16)
nameWithType: ConsoleDriver.SetColors(Int16, Int16)
fullName: ConsoleDriver.SetColors(Int16, Int16)
- uid: System.Int16
parent: System
isExternal: true
name: Int16
nameWithType: Int16
fullName: System.Int16
- uid: Terminal.Gui.ConsoleDriver.SetColors(System.ConsoleColor,System.ConsoleColor)
parent: Terminal.Gui.ConsoleDriver
isExternal: false
@@ -1064,6 +1090,18 @@ references:
name: ConsoleColor
nameWithType: ConsoleColor
fullName: System.ConsoleColor
- uid: Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)
parent: Terminal.Gui.ConsoleDriver
isExternal: false
name: SetColors(Int16, Int16)
nameWithType: ConsoleDriver.SetColors(Int16, Int16)
fullName: ConsoleDriver.SetColors(Int16, Int16)
- uid: System.Int16
parent: System
isExternal: true
name: Int16
nameWithType: Int16
fullName: System.Int16
- uid: Terminal.Gui.ConsoleDriver.StartReportingMouseMoves
parent: Terminal.Gui.ConsoleDriver
isExternal: false
@@ -1106,6 +1144,18 @@ references:
name: UncookMouse()
nameWithType: ConsoleDriver.UncookMouse()
fullName: ConsoleDriver.UncookMouse()
- uid: Terminal.Gui.ConsoleDriver.UpdateCursor
parent: Terminal.Gui.ConsoleDriver
isExternal: false
name: UpdateCursor()
nameWithType: ConsoleDriver.UpdateCursor()
fullName: ConsoleDriver.UpdateCursor()
- uid: Terminal.Gui.ConsoleDriver.UpdateScreen
parent: Terminal.Gui.ConsoleDriver
isExternal: false
name: UpdateScreen()
nameWithType: ConsoleDriver.UpdateScreen()
fullName: ConsoleDriver.UpdateScreen()
- uid: Terminal.Gui.ConsoleDriver.URCorner
parent: Terminal.Gui.ConsoleDriver
isExternal: false
@@ -1250,3 +1300,15 @@ references:
name: UncookMouse
nameWithType: ConsoleDriver.UncookMouse
fullName: ConsoleDriver.UncookMouse
- uid: Terminal.Gui.ConsoleDriver.UpdateCursor*
parent: Terminal.Gui.ConsoleDriver
isExternal: false
name: UpdateCursor
nameWithType: ConsoleDriver.UpdateCursor
fullName: ConsoleDriver.UpdateCursor
- uid: Terminal.Gui.ConsoleDriver.UpdateScreen*
parent: Terminal.Gui.ConsoleDriver
isExternal: false
name: UpdateScreen
nameWithType: ConsoleDriver.UpdateScreen
fullName: ConsoleDriver.UpdateScreen

View File

@@ -3,6 +3,7 @@ items:
- uid: Terminal.Gui.Dialog
id: Dialog
children:
- Terminal.Gui.Dialog.#ctor(NStack.ustring,System.Int32,System.Int32,Terminal.Gui.Button[])
- Terminal.Gui.Dialog.#ctor(System.String,System.Int32,System.Int32,Terminal.Gui.Button[])
- Terminal.Gui.Dialog.AddButton(Terminal.Gui.Button)
- Terminal.Gui.Dialog.LayoutSubviews
@@ -25,6 +26,8 @@ items:
- Terminal.Gui.View
- Terminal.Gui.Toplevel
- Terminal.Gui.Window
derivedClasses:
- Terminal.Gui.FileDialog
implements: []
inheritedMembers:
- Terminal.Gui.Toplevel.CanFocus
@@ -77,6 +80,36 @@ items:
- Terminal.Gui.Window.Redraw(Terminal.Gui.Rect)
- Terminal.Gui.Window.Remove(Terminal.Gui.View)
- 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[])'
parent: Terminal.Gui.Dialog
langs:
- csharp
name: Dialog(ustring, Int32, Int32, Button[])
nameWithType: Dialog.Dialog(ustring, Int32, Int32, Button[])
fullName: Dialog.Dialog(ustring, Int32, Int32, Button[])
type: Constructor
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: Initializes a new instance of the <xref href="Terminal.Gui.Dialog"></xref> class with an optional set of buttons to display
syntax:
content: public Dialog (NStack.ustring title, int width, int height, Terminal.Gui.Button[] buttons);
parameters:
- id: title
type: NStack.ustring
description: Title for the dialog.
- id: width
type: System.Int32
description: Width for the dialog.
- id: height
type: System.Int32
description: Height for the dialog.
- id: buttons
type: Terminal.Gui.Button[]
description: Optional buttons to lay out at the bottom of the dialog.
overload: Terminal.Gui.Dialog.#ctor*
exceptions: []
- uid: Terminal.Gui.Dialog.#ctor(System.String,System.Int32,System.Int32,Terminal.Gui.Button[])
id: '#ctor(System.String,System.Int32,System.Int32,Terminal.Gui.Button[])'
parent: Terminal.Gui.Dialog
@@ -175,18 +208,18 @@ references:
name: Window
nameWithType: Window
fullName: Terminal.Gui.Window
- uid: Terminal.Gui.Dialog.#ctor(System.String,System.Int32,System.Int32,Terminal.Gui.Button[])
- uid: Terminal.Gui.Dialog.#ctor(NStack.ustring,System.Int32,System.Int32,Terminal.Gui.Button[])
parent: Terminal.Gui.Dialog
isExternal: false
name: Dialog(String, Int32, Int32, Button[])
nameWithType: Dialog.Dialog(String, Int32, Int32, Button[])
fullName: Dialog.Dialog(String, Int32, Int32, Button[])
- uid: System.String
parent: System
name: Dialog(ustring, Int32, Int32, Button[])
nameWithType: Dialog.Dialog(ustring, Int32, Int32, Button[])
fullName: Dialog.Dialog(ustring, Int32, Int32, Button[])
- uid: NStack.ustring
parent: NStack
isExternal: true
name: String
nameWithType: String
fullName: System.String
name: ustring
nameWithType: ustring
fullName: NStack.ustring
- uid: System.Int32
parent: System
isExternal: true
@@ -211,6 +244,18 @@ references:
- name: '[]'
nameWithType: '[]'
fullName: '[]'
- uid: Terminal.Gui.Dialog.#ctor(System.String,System.Int32,System.Int32,Terminal.Gui.Button[])
parent: Terminal.Gui.Dialog
isExternal: false
name: Dialog(String, Int32, Int32, Button[])
nameWithType: Dialog.Dialog(String, Int32, Int32, Button[])
fullName: Dialog.Dialog(String, Int32, Int32, Button[])
- uid: System.String
parent: System
isExternal: true
name: String
nameWithType: String
fullName: System.String
- uid: Terminal.Gui.Dialog.AddButton(Terminal.Gui.Button)
parent: Terminal.Gui.Dialog
isExternal: false

View File

@@ -26,6 +26,7 @@ items:
- Terminal.Gui.Key.ControlQ
- Terminal.Gui.Key.ControlR
- Terminal.Gui.Key.ControlS
- Terminal.Gui.Key.ControlSpace
- Terminal.Gui.Key.ControlT
- Terminal.Gui.Key.ControlU
- Terminal.Gui.Key.ControlV
@@ -158,6 +159,10 @@ items:
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: >-
Mask that indictes that this is a character value, values outside this range
indicate special characters like Alt-key combinations or special keys on the
keyboard like function keys, arrows keys and so on.
syntax:
content: CharMask
return:
@@ -525,6 +530,25 @@ items:
type: Terminal.Gui.Key
description: To be added.
exceptions: []
- uid: Terminal.Gui.Key.ControlSpace
id: ControlSpace
parent: Terminal.Gui.Key
langs:
- csharp
name: ControlSpace
nameWithType: Key.ControlSpace
fullName: Key.ControlSpace
type: Field
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: The key code for the user pressing Control-spacebar
syntax:
content: ControlSpace
return:
type: Terminal.Gui.Key
description: To be added.
exceptions: []
- uid: Terminal.Gui.Key.ControlT
id: ControlT
parent: Terminal.Gui.Key
@@ -1324,6 +1348,12 @@ references:
name: ControlS
nameWithType: Key.ControlS
fullName: Key.ControlS
- uid: Terminal.Gui.Key.ControlSpace
parent: Terminal.Gui.Key
isExternal: false
name: ControlSpace
nameWithType: Key.ControlSpace
fullName: Key.ControlSpace
- uid: Terminal.Gui.Key.ControlT
parent: Terminal.Gui.Key
isExternal: false

View File

@@ -7,6 +7,7 @@ items:
- Terminal.Gui.RadioGroup.#ctor(System.Int32,System.Int32,System.String[],System.Int32)
- Terminal.Gui.RadioGroup.MouseEvent(Terminal.Gui.MouseEvent)
- Terminal.Gui.RadioGroup.PositionCursor
- Terminal.Gui.RadioGroup.ProcessColdKey(Terminal.Gui.KeyEvent)
- Terminal.Gui.RadioGroup.ProcessHotKey(Terminal.Gui.KeyEvent)
- Terminal.Gui.RadioGroup.ProcessKey(Terminal.Gui.KeyEvent)
- Terminal.Gui.RadioGroup.RadioLabels
@@ -63,7 +64,6 @@ items:
- Terminal.Gui.View.LayoutSubviews
- Terminal.Gui.View.MostFocused
- Terminal.Gui.View.Move(System.Int32,System.Int32)
- Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)
- Terminal.Gui.View.Remove(Terminal.Gui.View)
- Terminal.Gui.View.RemoveAll
- Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
@@ -174,6 +174,29 @@ items:
parameters: []
overload: Terminal.Gui.RadioGroup.PositionCursor*
exceptions: []
- uid: Terminal.Gui.RadioGroup.ProcessColdKey(Terminal.Gui.KeyEvent)
id: ProcessColdKey(Terminal.Gui.KeyEvent)
parent: Terminal.Gui.RadioGroup
langs:
- csharp
name: ProcessColdKey(KeyEvent)
nameWithType: RadioGroup.ProcessColdKey(KeyEvent)
fullName: RadioGroup.ProcessColdKey(KeyEvent)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
syntax:
content: public override bool ProcessColdKey (Terminal.Gui.KeyEvent kb);
parameters:
- id: kb
type: Terminal.Gui.KeyEvent
description: To be added.
return:
type: System.Boolean
description: To be added.
overload: Terminal.Gui.RadioGroup.ProcessColdKey*
exceptions: []
- uid: Terminal.Gui.RadioGroup.ProcessHotKey(Terminal.Gui.KeyEvent)
id: ProcessHotKey(Terminal.Gui.KeyEvent)
parent: Terminal.Gui.RadioGroup
@@ -371,18 +394,24 @@ references:
name: PositionCursor()
nameWithType: RadioGroup.PositionCursor()
fullName: RadioGroup.PositionCursor()
- uid: Terminal.Gui.RadioGroup.ProcessHotKey(Terminal.Gui.KeyEvent)
- uid: Terminal.Gui.RadioGroup.ProcessColdKey(Terminal.Gui.KeyEvent)
parent: Terminal.Gui.RadioGroup
isExternal: false
name: ProcessHotKey(KeyEvent)
nameWithType: RadioGroup.ProcessHotKey(KeyEvent)
fullName: RadioGroup.ProcessHotKey(KeyEvent)
name: ProcessColdKey(KeyEvent)
nameWithType: RadioGroup.ProcessColdKey(KeyEvent)
fullName: RadioGroup.ProcessColdKey(KeyEvent)
- uid: Terminal.Gui.KeyEvent
parent: Terminal.Gui
isExternal: false
name: KeyEvent
nameWithType: KeyEvent
fullName: Terminal.Gui.KeyEvent
- uid: Terminal.Gui.RadioGroup.ProcessHotKey(Terminal.Gui.KeyEvent)
parent: Terminal.Gui.RadioGroup
isExternal: false
name: ProcessHotKey(KeyEvent)
nameWithType: RadioGroup.ProcessHotKey(KeyEvent)
fullName: RadioGroup.ProcessHotKey(KeyEvent)
- uid: Terminal.Gui.RadioGroup.ProcessKey(Terminal.Gui.KeyEvent)
parent: Terminal.Gui.RadioGroup
isExternal: false
@@ -456,6 +485,12 @@ references:
name: PositionCursor
nameWithType: RadioGroup.PositionCursor
fullName: RadioGroup.PositionCursor
- uid: Terminal.Gui.RadioGroup.ProcessColdKey*
parent: Terminal.Gui.RadioGroup
isExternal: false
name: ProcessColdKey
nameWithType: RadioGroup.ProcessColdKey
fullName: RadioGroup.ProcessColdKey
- uid: Terminal.Gui.RadioGroup.ProcessHotKey*
parent: Terminal.Gui.RadioGroup
isExternal: false
@@ -498,12 +533,6 @@ references:
name: HasFocus
nameWithType: View.HasFocus
fullName: View.HasFocus
- uid: Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)
parent: Terminal.Gui.View
isExternal: false
name: ProcessColdKey(KeyEvent)
nameWithType: View.ProcessColdKey(KeyEvent)
fullName: View.ProcessColdKey(KeyEvent)
- uid: Terminal.Gui.View.Add(Terminal.Gui.View)
parent: Terminal.Gui.View
isExternal: false

View File

@@ -21,7 +21,14 @@ items:
remarks: >-
<p>
Toplevels can be modally executing views, and they return control
to the caller when the "Running" property is set to false.
to the caller when the "Running" property is set to false, or
by calling <xref href="Terminal.Gui.Application.RequestStop()"></xref></p>
<p>
There will be a toplevel created for you on the first time use
and can be accessed from the property <xref href="Terminal.Gui.Application.Top"></xref>,
but new toplevels can be created and ran on top of it. To run, create the
toplevel and then invoke <xref href="Terminal.Gui.Application.Run"></xref> with the
new toplevel.
</p>
syntax:
content: 'public class Toplevel : Terminal.Gui.View'

View File

@@ -79,6 +79,7 @@ items:
- Terminal.Gui.ScrollBarView
- Terminal.Gui.ScrollView
- Terminal.Gui.TextField
- Terminal.Gui.TextView
- Terminal.Gui.Toplevel
implements:
- System.Collections.IEnumerable

View File

@@ -31,6 +31,8 @@
name: ConsoleDriver
- uid: Terminal.Gui.Dialog
name: Dialog
- uid: Terminal.Gui.FileDialog
name: FileDialog
- uid: Terminal.Gui.FrameView
name: FrameView
- uid: Terminal.Gui.IListDataSource
@@ -55,6 +57,8 @@
name: MouseEvent
- uid: Terminal.Gui.MouseFlags
name: MouseFlags
- uid: Terminal.Gui.OpenDialog
name: OpenDialog
- uid: Terminal.Gui.Point
name: Point
- uid: Terminal.Gui.ProgressBar
@@ -65,6 +69,8 @@
name: Rect
- uid: Terminal.Gui.Responder
name: Responder
- uid: Terminal.Gui.SaveDialog
name: SaveDialog
- uid: Terminal.Gui.ScrollBarView
name: ScrollBarView
- uid: Terminal.Gui.ScrollView
@@ -77,6 +83,8 @@
name: TextAlignment
- uid: Terminal.Gui.TextField
name: TextField
- uid: Terminal.Gui.TextView
name: TextView
- uid: Terminal.Gui.Toplevel
name: Toplevel
- uid: Terminal.Gui.View