Terminal.Gui/docfx/api/Terminal.Gui/Terminal.Gui.Toplevel.yml

### YamlMime:ManagedReference
items:
- uid: Terminal.Gui.Toplevel
  id: Toplevel
  children:
  - Terminal.Gui.Toplevel.#ctor
  - Terminal.Gui.Toplevel.#ctor(Terminal.Gui.Rect)
  - Terminal.Gui.Toplevel.CanFocus
  - Terminal.Gui.Toplevel.Create
  - Terminal.Gui.Toplevel.ProcessKey(Terminal.Gui.KeyEvent)
  - Terminal.Gui.Toplevel.Running
  - Terminal.Gui.Toplevel.WillPresent
  langs:
  - csharp
  name: Toplevel
  nameWithType: Toplevel
  fullName: Terminal.Gui.Toplevel
  type: Class
  assemblies:
  - Terminal.Gui
  namespace: Terminal.Gui
  summary: Toplevel views can be modally executed.
  remarks: >-
    <p>
                    Toplevels can be modally executing views, and they return control
                    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'
  inheritance:
  - System.Object
  - Terminal.Gui.Responder
  - Terminal.Gui.View
  derivedClasses:
  - Terminal.Gui.Window
  implements: []
  inheritedMembers:
  - Terminal.Gui.Responder.MouseEvent(Terminal.Gui.MouseEvent)
  - Terminal.Gui.View.Add(Terminal.Gui.View)
  - 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.GetEnumerator
  - Terminal.Gui.View.HasFocus
  - Terminal.Gui.View.Height
  - Terminal.Gui.View.Id
  - Terminal.Gui.View.LayoutStyle
  - Terminal.Gui.View.LayoutSubviews
  - 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.Redraw(Terminal.Gui.Rect)
  - 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)
  - 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
- uid: Terminal.Gui.Toplevel.#ctor
  id: '#ctor'
  parent: Terminal.Gui.Toplevel
  langs:
  - csharp
  name: Toplevel()
  nameWithType: Toplevel.Toplevel()
  fullName: Toplevel.Toplevel()
  type: Constructor
  assemblies:
  - Terminal.Gui
  namespace: Terminal.Gui
  summary: Initializes a new instance of the <xref href="Terminal.Gui.Toplevel"></xref> class with Computed layout, defaulting to `async` full screen.
  syntax:
    content: public Toplevel ();
    parameters: []
  overload: Terminal.Gui.Toplevel.#ctor*
  exceptions: []
- uid: Terminal.Gui.Toplevel.#ctor(Terminal.Gui.Rect)
  id: '#ctor(Terminal.Gui.Rect)'
  parent: Terminal.Gui.Toplevel
  langs:
  - csharp
  name: Toplevel(Rect)
  nameWithType: Toplevel.Toplevel(Rect)
  fullName: Toplevel.Toplevel(Rect)
  type: Constructor
  assemblies:
  - Terminal.Gui
  namespace: Terminal.Gui
  summary: Initializes a new instance of the <xref href="Terminal.Gui.Toplevel"></xref> class with the specified absolute layout.
  syntax:
    content: public Toplevel (Terminal.Gui.Rect frame);
    parameters:
    - id: frame
      type: Terminal.Gui.Rect
      description: Frame.
  overload: Terminal.Gui.Toplevel.#ctor*
  exceptions: []
- uid: Terminal.Gui.Toplevel.CanFocus
  id: CanFocus
  parent: Terminal.Gui.Toplevel
  langs:
  - csharp
  name: CanFocus
  nameWithType: Toplevel.CanFocus
  fullName: Toplevel.CanFocus
  type: Property
  assemblies:
  - Terminal.Gui
  namespace: Terminal.Gui
  syntax:
    content: public override bool CanFocus { get; }
    return:
      type: System.Boolean
      description: To be added.
  overload: Terminal.Gui.Toplevel.CanFocus*
  exceptions: []
- uid: Terminal.Gui.Toplevel.Create
  id: Create
  parent: Terminal.Gui.Toplevel
  langs:
  - csharp
  name: Create()
  nameWithType: Toplevel.Create()
  fullName: Toplevel.Create()
  type: Method
  assemblies:
  - Terminal.Gui
  namespace: Terminal.Gui
  summary: Convenience factory method that creates a new toplevel with the current terminal dimensions.
  syntax:
    content: public static Terminal.Gui.Toplevel Create ();
    parameters: []
    return:
      type: Terminal.Gui.Toplevel
      description: The create.
  overload: Terminal.Gui.Toplevel.Create*
  exceptions: []
- uid: Terminal.Gui.Toplevel.ProcessKey(Terminal.Gui.KeyEvent)
  id: ProcessKey(Terminal.Gui.KeyEvent)
  parent: Terminal.Gui.Toplevel
  langs:
  - csharp
  name: ProcessKey(KeyEvent)
  nameWithType: Toplevel.ProcessKey(KeyEvent)
  fullName: Toplevel.ProcessKey(KeyEvent)
  type: Method
  assemblies:
  - Terminal.Gui
  namespace: Terminal.Gui
  syntax:
    content: public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);
    parameters:
    - id: keyEvent
      type: Terminal.Gui.KeyEvent
      description: To be added.
    return:
      type: System.Boolean
      description: To be added.
  overload: Terminal.Gui.Toplevel.ProcessKey*
  exceptions: []
- uid: Terminal.Gui.Toplevel.Running
  id: Running
  parent: Terminal.Gui.Toplevel
  langs:
  - csharp
  name: Running
  nameWithType: Toplevel.Running
  fullName: Toplevel.Running
  type: Field
  assemblies:
  - Terminal.Gui
  namespace: Terminal.Gui
  summary: >-
    This flag is checked on each iteration of the mainloop and it continues
                running until this flag is set to false.
  syntax:
    content: public bool Running;
    return:
      type: System.Boolean
      description: To be added.
  exceptions: []
- uid: Terminal.Gui.Toplevel.WillPresent
  id: WillPresent
  parent: Terminal.Gui.Toplevel
  langs:
  - csharp
  name: WillPresent()
  nameWithType: Toplevel.WillPresent()
  fullName: Toplevel.WillPresent()
  type: Method
  assemblies:
  - Terminal.Gui
  namespace: Terminal.Gui
  summary: >-
    This method is invoked by Application.Begin as part of the Application.Run after
                the views have been laid out, and before the views are drawn for the first time.
  syntax:
    content: public virtual void WillPresent ();
    parameters: []
  overload: Terminal.Gui.Toplevel.WillPresent*
  exceptions: []
references:
- uid: Terminal.Gui.View
  parent: Terminal.Gui
  isExternal: false
  name: View
  nameWithType: View
  fullName: Terminal.Gui.View
- uid: Terminal.Gui.Toplevel.#ctor
  parent: Terminal.Gui.Toplevel
  isExternal: false
  name: Toplevel()
  nameWithType: Toplevel.Toplevel()
  fullName: Toplevel.Toplevel()
- uid: Terminal.Gui.Toplevel.#ctor(Terminal.Gui.Rect)
  parent: Terminal.Gui.Toplevel
  isExternal: false
  name: Toplevel(Rect)
  nameWithType: Toplevel.Toplevel(Rect)
  fullName: Toplevel.Toplevel(Rect)
- uid: Terminal.Gui.Rect
  parent: Terminal.Gui
  isExternal: false
  name: Rect
  nameWithType: Rect
  fullName: Terminal.Gui.Rect
- uid: Terminal.Gui.Toplevel.CanFocus
  parent: Terminal.Gui.Toplevel
  isExternal: false
  name: CanFocus
  nameWithType: Toplevel.CanFocus
  fullName: Toplevel.CanFocus
- uid: System.Boolean
  parent: System
  isExternal: true
  name: Boolean
  nameWithType: Boolean
  fullName: System.Boolean
- uid: Terminal.Gui.Toplevel.Create
  parent: Terminal.Gui.Toplevel
  isExternal: false
  name: Create()
  nameWithType: Toplevel.Create()
  fullName: Toplevel.Create()
- uid: Terminal.Gui.Toplevel
  parent: Terminal.Gui
  isExternal: false
  name: Toplevel
  nameWithType: Toplevel
  fullName: Terminal.Gui.Toplevel
- uid: Terminal.Gui.Toplevel.ProcessKey(Terminal.Gui.KeyEvent)
  parent: Terminal.Gui.Toplevel
  isExternal: false
  name: ProcessKey(KeyEvent)
  nameWithType: Toplevel.ProcessKey(KeyEvent)
  fullName: Toplevel.ProcessKey(KeyEvent)
- uid: Terminal.Gui.KeyEvent
  parent: Terminal.Gui
  isExternal: false
  name: KeyEvent
  nameWithType: KeyEvent
  fullName: Terminal.Gui.KeyEvent
- 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.Toplevel.#ctor*
  parent: Terminal.Gui.Toplevel
  isExternal: false
  name: Toplevel
  nameWithType: Toplevel.Toplevel
  fullName: Toplevel.Toplevel
- uid: Terminal.Gui.Toplevel.CanFocus*
  parent: Terminal.Gui.Toplevel
  isExternal: false
  name: CanFocus
  nameWithType: Toplevel.CanFocus
  fullName: Toplevel.CanFocus
- uid: Terminal.Gui.Toplevel.Create*
  parent: Terminal.Gui.Toplevel
  isExternal: false
  name: Create
  nameWithType: Toplevel.Create
  fullName: Toplevel.Create
- uid: Terminal.Gui.Toplevel.ProcessKey*
  parent: Terminal.Gui.Toplevel
  isExternal: false
  name: ProcessKey
  nameWithType: Toplevel.ProcessKey
  fullName: Toplevel.ProcessKey
- uid: Terminal.Gui.Toplevel.WillPresent*
  parent: Terminal.Gui.Toplevel
  isExternal: false
  name: WillPresent
  nameWithType: Toplevel.WillPresent
  fullName: Toplevel.WillPresent
- uid: Terminal.Gui.View.HasFocus
  parent: Terminal.Gui.View
  isExternal: false
  name: HasFocus
  nameWithType: View.HasFocus
  fullName: View.HasFocus
- uid: Terminal.Gui.Responder.MouseEvent(Terminal.Gui.MouseEvent)
  parent: Terminal.Gui.Responder
  isExternal: false
  name: MouseEvent(MouseEvent)
  nameWithType: Responder.MouseEvent(MouseEvent)
  fullName: Responder.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.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.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.View.GetEnumerator
  parent: Terminal.Gui.View
  isExternal: false
  name: GetEnumerator()
  nameWithType: View.GetEnumerator()
  fullName: View.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.LayoutSubviews
  parent: Terminal.Gui.View
  isExternal: false
  name: LayoutSubviews()
  nameWithType: View.LayoutSubviews()
  fullName: View.LayoutSubviews()
- 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.View.Redraw(Terminal.Gui.Rect)
  parent: Terminal.Gui.View
  isExternal: false
  name: Redraw(Rect)
  nameWithType: View.Redraw(Rect)
  fullName: View.Redraw(Rect)
- uid: Terminal.Gui.View.Remove(Terminal.Gui.View)
  parent: Terminal.Gui.View
  isExternal: false
  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
  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