Files
Terminal.Gui/docfx/api/Terminal.Gui/Terminal.Gui.Dialog.yml
2019-05-20 21:11:22 -04:00

588 lines
18 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: Terminal.Gui.Dialog
id: Dialog
children:
- Terminal.Gui.Dialog.#ctor(NStack.ustring,System.Int32,System.Int32,Terminal.Gui.Button[])
- Terminal.Gui.Dialog.AddButton(Terminal.Gui.Button)
- Terminal.Gui.Dialog.LayoutSubviews
- Terminal.Gui.Dialog.ProcessKey(Terminal.Gui.KeyEvent)
langs:
- csharp
name: Dialog
nameWithType: Dialog
fullName: Terminal.Gui.Dialog
type: Class
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: "The dialog box is a window that by default is centered and contains one \n or more buttons. It defaults to the Colors.Dialog color scheme and has a\n 1 cell padding around the edges."
remarks: >-
To run the dialog modally, create the Dialog, and pass this to Application.Run which
will execute the dialog until it terminates via the [ESC] key, or when one of the views
or buttons added to the dialog set the Running property on the Dialog to false.
syntax:
content: 'public class Dialog : Terminal.Gui.Window'
inheritance:
- System.Object
- Terminal.Gui.Responder
- Terminal.Gui.View
- Terminal.Gui.Toplevel
- Terminal.Gui.Window
derivedClasses:
- Terminal.Gui.FileDialog
implements: []
inheritedMembers:
- Terminal.Gui.Toplevel.CanFocus
- Terminal.Gui.Toplevel.Create
- Terminal.Gui.Toplevel.Running
- Terminal.Gui.Toplevel.WillPresent
- Terminal.Gui.View.Add(Terminal.Gui.View[])
- Terminal.Gui.View.AddRune(System.Int32,System.Int32,System.Rune)
- Terminal.Gui.View.Bounds
- Terminal.Gui.View.ChildNeedsDisplay
- Terminal.Gui.View.Clear
- Terminal.Gui.View.Clear(Terminal.Gui.Rect)
- Terminal.Gui.View.ClearNeedsDisplay
- Terminal.Gui.View.ClipToBounds
- Terminal.Gui.View.ColorScheme
- Terminal.Gui.View.DrawFrame(Terminal.Gui.Rect,System.Int32,System.Boolean)
- Terminal.Gui.View.DrawHotString(NStack.ustring,System.Boolean,Terminal.Gui.ColorScheme)
- Terminal.Gui.View.DrawHotString(NStack.ustring,Terminal.Gui.Attribute,Terminal.Gui.Attribute)
- Terminal.Gui.View.Driver
- Terminal.Gui.View.EnsureFocus
- Terminal.Gui.View.Focused
- Terminal.Gui.View.FocusFirst
- Terminal.Gui.View.FocusLast
- Terminal.Gui.View.FocusNext
- Terminal.Gui.View.FocusPrev
- Terminal.Gui.View.Frame
- Terminal.Gui.View.HasFocus
- Terminal.Gui.View.Height
- Terminal.Gui.View.Id
- Terminal.Gui.View.LayoutStyle
- Terminal.Gui.View.MostFocused
- Terminal.Gui.View.Move(System.Int32,System.Int32)
- Terminal.Gui.View.PositionCursor
- Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)
- Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)
- Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)
- Terminal.Gui.View.SetClip(Terminal.Gui.Rect)
- Terminal.Gui.View.SetFocus(Terminal.Gui.View)
- Terminal.Gui.View.SetNeedsDisplay
- Terminal.Gui.View.SetNeedsDisplay(Terminal.Gui.Rect)
- Terminal.Gui.View.Subviews
- Terminal.Gui.View.SuperView
- Terminal.Gui.View.ToString
- Terminal.Gui.View.WantMousePositionReports
- Terminal.Gui.View.Width
- Terminal.Gui.View.X
- Terminal.Gui.View.Y
- Terminal.Gui.Window.Add(Terminal.Gui.View)
- Terminal.Gui.Window.GetEnumerator
- 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[])'
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.AddButton(Terminal.Gui.Button)
id: AddButton(Terminal.Gui.Button)
parent: Terminal.Gui.Dialog
langs:
- csharp
name: AddButton(Button)
nameWithType: Dialog.AddButton(Button)
fullName: Dialog.AddButton(Button)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: Adds a button to the dialog, its layout will be controled by the dialog
syntax:
content: public void AddButton (Terminal.Gui.Button button);
parameters:
- id: button
type: Terminal.Gui.Button
description: Button to add.
overload: Terminal.Gui.Dialog.AddButton*
exceptions: []
- uid: Terminal.Gui.Dialog.LayoutSubviews
id: LayoutSubviews
parent: Terminal.Gui.Dialog
langs:
- csharp
name: LayoutSubviews()
nameWithType: Dialog.LayoutSubviews()
fullName: Dialog.LayoutSubviews()
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
syntax:
content: public override void LayoutSubviews ();
parameters: []
overload: Terminal.Gui.Dialog.LayoutSubviews*
exceptions: []
- uid: Terminal.Gui.Dialog.ProcessKey(Terminal.Gui.KeyEvent)
id: ProcessKey(Terminal.Gui.KeyEvent)
parent: Terminal.Gui.Dialog
langs:
- csharp
name: ProcessKey(KeyEvent)
nameWithType: Dialog.ProcessKey(KeyEvent)
fullName: Dialog.ProcessKey(KeyEvent)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
syntax:
content: public override bool ProcessKey (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.Dialog.ProcessKey*
exceptions: []
references:
- uid: Terminal.Gui.Window
parent: Terminal.Gui
isExternal: false
name: Window
nameWithType: Window
fullName: Terminal.Gui.Window
- uid: Terminal.Gui.Dialog.#ctor(NStack.ustring,System.Int32,System.Int32,Terminal.Gui.Button[])
parent: Terminal.Gui.Dialog
isExternal: false
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: ustring
nameWithType: ustring
fullName: NStack.ustring
- uid: System.Int32
parent: System
isExternal: true
name: Int32
nameWithType: Int32
fullName: System.Int32
- uid: Terminal.Gui.Button
name: Button
nameWithType: Button
fullName: Terminal.Gui.Button
- uid: Terminal.Gui.Button[]
parent: Terminal.Gui
isExternal: false
name: Button[]
nameWithType: Button[]
fullName: Terminal.Gui.Button[]
spec.csharp:
- uid: Terminal.Gui.Button
name: Button
nameWithType: Button
fullName: Terminal.Gui.Button
- name: '[]'
nameWithType: '[]'
fullName: '[]'
- uid: Terminal.Gui.Dialog.AddButton(Terminal.Gui.Button)
parent: Terminal.Gui.Dialog
isExternal: false
name: AddButton(Button)
nameWithType: Dialog.AddButton(Button)
fullName: Dialog.AddButton(Button)
- uid: Terminal.Gui.Dialog.LayoutSubviews
parent: Terminal.Gui.Dialog
isExternal: false
name: LayoutSubviews()
nameWithType: Dialog.LayoutSubviews()
fullName: Dialog.LayoutSubviews()
- uid: Terminal.Gui.Dialog.ProcessKey(Terminal.Gui.KeyEvent)
parent: Terminal.Gui.Dialog
isExternal: false
name: ProcessKey(KeyEvent)
nameWithType: Dialog.ProcessKey(KeyEvent)
fullName: Dialog.ProcessKey(KeyEvent)
- uid: System.Boolean
parent: System
isExternal: true
name: Boolean
nameWithType: Boolean
fullName: System.Boolean
- uid: Terminal.Gui.KeyEvent
parent: Terminal.Gui
isExternal: false
name: KeyEvent
nameWithType: KeyEvent
fullName: Terminal.Gui.KeyEvent
- uid: Terminal.Gui.Dialog.#ctor*
parent: Terminal.Gui.Dialog
isExternal: false
name: Dialog
nameWithType: Dialog.Dialog
fullName: Dialog.Dialog
- uid: Terminal.Gui.Dialog.AddButton*
parent: Terminal.Gui.Dialog
isExternal: false
name: AddButton
nameWithType: Dialog.AddButton
fullName: Dialog.AddButton
- uid: Terminal.Gui.Dialog.LayoutSubviews*
parent: Terminal.Gui.Dialog
isExternal: false
name: LayoutSubviews
nameWithType: Dialog.LayoutSubviews
fullName: Dialog.LayoutSubviews
- uid: Terminal.Gui.Dialog.ProcessKey*
parent: Terminal.Gui.Dialog
isExternal: false
name: ProcessKey
nameWithType: Dialog.ProcessKey
fullName: Dialog.ProcessKey
- uid: Terminal.Gui.Toplevel.CanFocus
parent: Terminal.Gui.Toplevel
isExternal: false
name: CanFocus
nameWithType: Toplevel.CanFocus
fullName: Toplevel.CanFocus
- uid: Terminal.Gui.View.HasFocus
parent: Terminal.Gui.View
isExternal: false
name: HasFocus
nameWithType: View.HasFocus
fullName: View.HasFocus
- uid: Terminal.Gui.Window.MouseEvent(Terminal.Gui.MouseEvent)
parent: Terminal.Gui.Window
isExternal: false
name: MouseEvent(MouseEvent)
nameWithType: Window.MouseEvent(MouseEvent)
fullName: Window.MouseEvent(MouseEvent)
- 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.ProcessHotKey(Terminal.Gui.KeyEvent)
parent: Terminal.Gui.View
isExternal: false
name: ProcessHotKey(KeyEvent)
nameWithType: View.ProcessHotKey(KeyEvent)
fullName: View.ProcessHotKey(KeyEvent)
- uid: Terminal.Gui.Window.Add(Terminal.Gui.View)
parent: Terminal.Gui.Window
isExternal: false
name: Add(View)
nameWithType: Window.Add(View)
fullName: Window.Add(View)
- uid: Terminal.Gui.View.Add(Terminal.Gui.View[])
parent: Terminal.Gui.View
isExternal: false
name: Add(View[])
nameWithType: View.Add(View[])
fullName: View.Add(View[])
- uid: Terminal.Gui.View.AddRune(System.Int32,System.Int32,System.Rune)
parent: Terminal.Gui.View
isExternal: false
name: AddRune(Int32, Int32, Rune)
nameWithType: View.AddRune(Int32, Int32, Rune)
fullName: View.AddRune(Int32, Int32, Rune)
- uid: Terminal.Gui.View.Bounds
parent: Terminal.Gui.View
isExternal: false
name: Bounds
nameWithType: View.Bounds
fullName: View.Bounds
- uid: Terminal.Gui.View.ChildNeedsDisplay
parent: Terminal.Gui.View
isExternal: false
name: ChildNeedsDisplay()
nameWithType: View.ChildNeedsDisplay()
fullName: View.ChildNeedsDisplay()
- uid: Terminal.Gui.View.Clear
parent: Terminal.Gui.View
isExternal: false
name: Clear()
nameWithType: View.Clear()
fullName: View.Clear()
- uid: Terminal.Gui.View.Clear(Terminal.Gui.Rect)
parent: Terminal.Gui.View
isExternal: false
name: Clear(Rect)
nameWithType: View.Clear(Rect)
fullName: View.Clear(Rect)
- uid: Terminal.Gui.View.ClearNeedsDisplay
parent: Terminal.Gui.View
isExternal: false
name: ClearNeedsDisplay()
nameWithType: View.ClearNeedsDisplay()
fullName: View.ClearNeedsDisplay()
- uid: Terminal.Gui.View.ClipToBounds
parent: Terminal.Gui.View
isExternal: false
name: ClipToBounds()
nameWithType: View.ClipToBounds()
fullName: View.ClipToBounds()
- uid: Terminal.Gui.View.ColorScheme
parent: Terminal.Gui.View
isExternal: false
name: ColorScheme
nameWithType: View.ColorScheme
fullName: View.ColorScheme
- uid: Terminal.Gui.View.DrawFrame(Terminal.Gui.Rect,System.Int32,System.Boolean)
parent: Terminal.Gui.View
isExternal: false
name: DrawFrame(Rect, Int32, Boolean)
nameWithType: View.DrawFrame(Rect, Int32, Boolean)
fullName: View.DrawFrame(Rect, Int32, Boolean)
- uid: Terminal.Gui.View.DrawHotString(NStack.ustring,System.Boolean,Terminal.Gui.ColorScheme)
parent: Terminal.Gui.View
isExternal: false
name: DrawHotString(ustring, Boolean, ColorScheme)
nameWithType: View.DrawHotString(ustring, Boolean, ColorScheme)
fullName: View.DrawHotString(ustring, Boolean, ColorScheme)
- uid: Terminal.Gui.View.DrawHotString(NStack.ustring,Terminal.Gui.Attribute,Terminal.Gui.Attribute)
parent: Terminal.Gui.View
isExternal: false
name: DrawHotString(ustring, Attribute, Attribute)
nameWithType: View.DrawHotString(ustring, Attribute, Attribute)
fullName: View.DrawHotString(ustring, Attribute, Attribute)
- uid: Terminal.Gui.View.Driver
parent: Terminal.Gui.View
isExternal: false
name: Driver
nameWithType: View.Driver
fullName: View.Driver
- uid: Terminal.Gui.View.EnsureFocus
parent: Terminal.Gui.View
isExternal: false
name: EnsureFocus()
nameWithType: View.EnsureFocus()
fullName: View.EnsureFocus()
- uid: Terminal.Gui.View.Focused
parent: Terminal.Gui.View
isExternal: false
name: Focused
nameWithType: View.Focused
fullName: View.Focused
- uid: Terminal.Gui.View.FocusFirst
parent: Terminal.Gui.View
isExternal: false
name: FocusFirst()
nameWithType: View.FocusFirst()
fullName: View.FocusFirst()
- uid: Terminal.Gui.View.FocusLast
parent: Terminal.Gui.View
isExternal: false
name: FocusLast()
nameWithType: View.FocusLast()
fullName: View.FocusLast()
- uid: Terminal.Gui.View.FocusNext
parent: Terminal.Gui.View
isExternal: false
name: FocusNext()
nameWithType: View.FocusNext()
fullName: View.FocusNext()
- uid: Terminal.Gui.View.FocusPrev
parent: Terminal.Gui.View
isExternal: false
name: FocusPrev()
nameWithType: View.FocusPrev()
fullName: View.FocusPrev()
- uid: Terminal.Gui.View.Frame
parent: Terminal.Gui.View
isExternal: false
name: Frame
nameWithType: View.Frame
fullName: View.Frame
- uid: Terminal.Gui.Window.GetEnumerator
parent: Terminal.Gui.Window
isExternal: false
name: GetEnumerator()
nameWithType: Window.GetEnumerator()
fullName: Window.GetEnumerator()
- uid: Terminal.Gui.View.Height
parent: Terminal.Gui.View
isExternal: false
name: Height
nameWithType: View.Height
fullName: View.Height
- uid: Terminal.Gui.View.Id
parent: Terminal.Gui.View
isExternal: false
name: Id
nameWithType: View.Id
fullName: View.Id
- uid: Terminal.Gui.View.LayoutStyle
parent: Terminal.Gui.View
isExternal: false
name: LayoutStyle
nameWithType: View.LayoutStyle
fullName: View.LayoutStyle
- uid: Terminal.Gui.View.MostFocused
parent: Terminal.Gui.View
isExternal: false
name: MostFocused
nameWithType: View.MostFocused
fullName: View.MostFocused
- uid: Terminal.Gui.View.Move(System.Int32,System.Int32)
parent: Terminal.Gui.View
isExternal: false
name: Move(Int32, Int32)
nameWithType: View.Move(Int32, Int32)
fullName: View.Move(Int32, Int32)
- uid: Terminal.Gui.View.PositionCursor
parent: Terminal.Gui.View
isExternal: false
name: PositionCursor()
nameWithType: View.PositionCursor()
fullName: View.PositionCursor()
- uid: Terminal.Gui.Window.Redraw(Terminal.Gui.Rect)
parent: Terminal.Gui.Window
isExternal: false
name: Redraw(Rect)
nameWithType: Window.Redraw(Rect)
fullName: Window.Redraw(Rect)
- uid: Terminal.Gui.Window.Remove(Terminal.Gui.View)
parent: Terminal.Gui.Window
isExternal: false
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.View.ScreenToView(System.Int32,System.Int32)
parent: Terminal.Gui.View
isExternal: false
name: ScreenToView(Int32, Int32)
nameWithType: View.ScreenToView(Int32, Int32)
fullName: View.ScreenToView(Int32, Int32)
- uid: Terminal.Gui.View.SetClip(Terminal.Gui.Rect)
parent: Terminal.Gui.View
isExternal: false
name: SetClip(Rect)
nameWithType: View.SetClip(Rect)
fullName: View.SetClip(Rect)
- uid: Terminal.Gui.View.SetFocus(Terminal.Gui.View)
parent: Terminal.Gui.View
isExternal: false
name: SetFocus(View)
nameWithType: View.SetFocus(View)
fullName: View.SetFocus(View)
- uid: Terminal.Gui.View.SetNeedsDisplay
parent: Terminal.Gui.View
isExternal: false
name: SetNeedsDisplay()
nameWithType: View.SetNeedsDisplay()
fullName: View.SetNeedsDisplay()
- uid: Terminal.Gui.View.SetNeedsDisplay(Terminal.Gui.Rect)
parent: Terminal.Gui.View
isExternal: false
name: SetNeedsDisplay(Rect)
nameWithType: View.SetNeedsDisplay(Rect)
fullName: View.SetNeedsDisplay(Rect)
- uid: Terminal.Gui.View.Subviews
parent: Terminal.Gui.View
isExternal: false
name: Subviews
nameWithType: View.Subviews
fullName: View.Subviews
- uid: Terminal.Gui.View.SuperView
parent: Terminal.Gui.View
isExternal: false
name: SuperView
nameWithType: View.SuperView
fullName: View.SuperView
- uid: Terminal.Gui.View.ToString
parent: Terminal.Gui.View
isExternal: false
name: ToString()
nameWithType: View.ToString()
fullName: View.ToString()
- uid: Terminal.Gui.View.WantMousePositionReports
parent: Terminal.Gui.View
isExternal: false
name: WantMousePositionReports
nameWithType: View.WantMousePositionReports
fullName: View.WantMousePositionReports
- uid: Terminal.Gui.View.Width
parent: Terminal.Gui.View
isExternal: false
name: Width
nameWithType: View.Width
fullName: View.Width
- uid: Terminal.Gui.View.X
parent: Terminal.Gui.View
isExternal: false
name: X
nameWithType: View.X
fullName: View.X
- uid: Terminal.Gui.View.Y
parent: Terminal.Gui.View
isExternal: false
name: Y
nameWithType: View.Y
fullName: View.Y
- uid: Terminal.Gui.Toplevel.Create
parent: Terminal.Gui.Toplevel
isExternal: false
name: Create()
nameWithType: Toplevel.Create()
fullName: Toplevel.Create()
- uid: Terminal.Gui.Toplevel.Running
parent: Terminal.Gui.Toplevel
isExternal: false
name: Running
nameWithType: Toplevel.Running
fullName: Toplevel.Running
- uid: Terminal.Gui.Toplevel.WillPresent
parent: Terminal.Gui.Toplevel
isExternal: false
name: WillPresent()
nameWithType: Toplevel.WillPresent()
fullName: Toplevel.WillPresent()
- uid: Terminal.Gui.Window.Title
parent: Terminal.Gui.Window
isExternal: false
name: Title
nameWithType: Window.Title
fullName: Window.Title