Terminal.Gui/docfx/api/Terminal/Terminal.Application.yml

### YamlMime:ManagedReference
items:
- uid: Terminal.Application
  id: Application
  children:
  - Terminal.Application.#ctor
  - Terminal.Application.Begin(Terminal.Toplevel)
  - Terminal.Application.Current
  - Terminal.Application.Driver
  - Terminal.Application.End(Terminal.Application.RunState)
  - Terminal.Application.GrabMouse(Terminal.View)
  - Terminal.Application.Init
  - Terminal.Application.Iteration
  - Terminal.Application.MainLoop
  - Terminal.Application.MakeCenteredRect(Terminal.Size)
  - Terminal.Application.Refresh
  - Terminal.Application.RequestStop
  - Terminal.Application.RootMouseEvent
  - Terminal.Application.Run
  - Terminal.Application.Run(Terminal.Toplevel)
  - Terminal.Application.RunLoop(Terminal.Application.RunState,System.Boolean)
  - Terminal.Application.Top
  - Terminal.Application.UngrabMouse
  langs:
  - csharp
  name: Application
  nameWithType: Application
  fullName: Terminal.Application
  type: Class
  assemblies:
  - Terminal
  namespace: Terminal
  summary: The application driver for gui.cs
  remarks: "<p>\n                You can hook up to the Iteration event to have your method \n                invoked on each iteration of the mainloop.\n              </p>\n    <p>\n                Creates a mainloop to process input events, handle timers and\n                other sources of data.   It is accessible via the MainLoop property.\n              </p>\n    <p>\n                When invoked sets the SynchronizationContext to one that is tied\n                to the mainloop, allowing user code to use async/await.\n              </p>"
  syntax:
    content: public class Application
  inheritance:
  - System.Object
  implements: []
  inheritedMembers: []
- uid: Terminal.Application.#ctor
  id: '#ctor'
  parent: Terminal.Application
  langs:
  - csharp
  name: Application()
  nameWithType: Application.Application()
  fullName: Application.Application()
  type: Constructor
  assemblies:
  - Terminal
  namespace: Terminal
  syntax:
    content: public Application ();
    parameters: []
  overload: Terminal.Application.#ctor*
  exceptions: []
- uid: Terminal.Application.Begin(Terminal.Toplevel)
  id: Begin(Terminal.Toplevel)
  parent: Terminal.Application
  langs:
  - csharp
  name: Begin(Toplevel)
  nameWithType: Application.Begin(Toplevel)
  fullName: Application.Begin(Toplevel)
  type: Method
  assemblies:
  - Terminal
  namespace: Terminal
  syntax:
    content: public static Terminal.Application.RunState Begin (Terminal.Toplevel toplevel);
    parameters:
    - id: toplevel
      type: Terminal.Toplevel
      description: To be added.
    return:
      type: Terminal.Application+RunState
      description: To be added.
  overload: Terminal.Application.Begin*
  exceptions: []
- uid: Terminal.Application.Current
  id: Current
  parent: Terminal.Application
  langs:
  - csharp
  name: Current
  nameWithType: Application.Current
  fullName: Application.Current
  type: Property
  assemblies:
  - Terminal
  namespace: Terminal
  summary: The current toplevel object.   This is updated when Application.Run enters and leaves and points to the current toplevel.
  syntax:
    content: public static Terminal.Toplevel Current { get; }
    return:
      type: Terminal.Toplevel
      description: The current.
  overload: Terminal.Application.Current*
  exceptions: []
- uid: Terminal.Application.Driver
  id: Driver
  parent: Terminal.Application
  langs:
  - csharp
  name: Driver
  nameWithType: Application.Driver
  fullName: Application.Driver
  type: Field
  assemblies:
  - Terminal
  namespace: Terminal
  summary: The current Console Driver in use.
  syntax:
    content: public static Terminal.ConsoleDriver Driver;
    return:
      type: Terminal.ConsoleDriver
      description: To be added.
  exceptions: []
- uid: Terminal.Application.End(Terminal.Application.RunState)
  id: End(Terminal.Application.RunState)
  parent: Terminal.Application
  langs:
  - csharp
  name: End(Application+RunState)
  nameWithType: Application.End(Application+RunState)
  fullName: Application.End(Application+RunState)
  type: Method
  assemblies:
  - Terminal
  namespace: Terminal
  syntax:
    content: public static void End (Terminal.Application.RunState rs);
    parameters:
    - id: rs
      type: Terminal.Application+RunState
      description: To be added.
  overload: Terminal.Application.End*
  exceptions: []
- uid: Terminal.Application.GrabMouse(Terminal.View)
  id: GrabMouse(Terminal.View)
  parent: Terminal.Application
  langs:
  - csharp
  name: GrabMouse(View)
  nameWithType: Application.GrabMouse(View)
  fullName: Application.GrabMouse(View)
  type: Method
  assemblies:
  - Terminal
  namespace: Terminal
  summary: Grabs the mouse, forcing all mouse events to be routed to the specified view until UngrabMouse is called.
  syntax:
    content: public static void GrabMouse (Terminal.View view);
    parameters:
    - id: view
      type: Terminal.View
      description: View that will receive all mouse events until UngrabMouse is invoked.
  overload: Terminal.Application.GrabMouse*
  exceptions: []
- uid: Terminal.Application.Init
  id: Init
  parent: Terminal.Application
  langs:
  - csharp
  name: Init()
  nameWithType: Application.Init()
  fullName: Application.Init()
  type: Method
  assemblies:
  - Terminal
  namespace: Terminal
  summary: Initializes the Application
  syntax:
    content: public static void Init ();
    parameters: []
  overload: Terminal.Application.Init*
  exceptions: []
- uid: Terminal.Application.Iteration
  id: Iteration
  parent: Terminal.Application
  langs:
  - csharp
  name: Iteration
  nameWithType: Application.Iteration
  fullName: Application.Iteration
  type: Event
  assemblies:
  - Terminal
  namespace: Terminal
  summary: >-
    This event is raised on each iteration of the
                  main loop.
  remarks: See also <xref href="System.Threading.Timeout"></xref>
  syntax:
    content: public static event EventHandler Iteration;
    return:
      type: System.EventHandler
      description: To be added.
  exceptions: []
- uid: Terminal.Application.MainLoop
  id: MainLoop
  parent: Terminal.Application
  langs:
  - csharp
  name: MainLoop
  nameWithType: Application.MainLoop
  fullName: Application.MainLoop
  type: Property
  assemblies:
  - Terminal
  namespace: Terminal
  summary: The mainloop driver for the applicaiton
  syntax:
    content: public static Mono.Terminal.MainLoop MainLoop { get; }
    return:
      type: Mono.Terminal.MainLoop
      description: The main loop.
  overload: Terminal.Application.MainLoop*
  exceptions: []
- uid: Terminal.Application.MakeCenteredRect(Terminal.Size)
  id: MakeCenteredRect(Terminal.Size)
  parent: Terminal.Application
  langs:
  - csharp
  name: MakeCenteredRect(Size)
  nameWithType: Application.MakeCenteredRect(Size)
  fullName: Application.MakeCenteredRect(Size)
  type: Method
  assemblies:
  - Terminal
  namespace: Terminal
  summary: Returns a rectangle that is centered in the screen for the provided size.
  syntax:
    content: public static Terminal.Rect MakeCenteredRect (Terminal.Size size);
    parameters:
    - id: size
      type: Terminal.Size
      description: Size for the rectangle.
    return:
      type: Terminal.Rect
      description: The centered rect.
  overload: Terminal.Application.MakeCenteredRect*
  exceptions: []
- uid: Terminal.Application.Refresh
  id: Refresh
  parent: Terminal.Application
  langs:
  - csharp
  name: Refresh()
  nameWithType: Application.Refresh()
  fullName: Application.Refresh()
  type: Method
  assemblies:
  - Terminal
  namespace: Terminal
  summary: Triggers a refresh of the entire display.
  syntax:
    content: public static void Refresh ();
    parameters: []
  overload: Terminal.Application.Refresh*
  exceptions: []
- uid: Terminal.Application.RequestStop
  id: RequestStop
  parent: Terminal.Application
  langs:
  - csharp
  name: RequestStop()
  nameWithType: Application.RequestStop()
  fullName: Application.RequestStop()
  type: Method
  assemblies:
  - Terminal
  namespace: Terminal
  summary: Stops running the most recent toplevel
  syntax:
    content: public static void RequestStop ();
    parameters: []
  overload: Terminal.Application.RequestStop*
  exceptions: []
- uid: Terminal.Application.RootMouseEvent
  id: RootMouseEvent
  parent: Terminal.Application
  langs:
  - csharp
  name: RootMouseEvent
  nameWithType: Application.RootMouseEvent
  fullName: Application.RootMouseEvent
  type: Field
  assemblies:
  - Terminal
  namespace: Terminal
  summary: Merely a debugging aid to see the raw mouse events
  syntax:
    content: public static Action<Terminal.MouseEvent> RootMouseEvent;
    return:
      type: System.Action{Terminal.MouseEvent}
      description: To be added.
  exceptions: []
- uid: Terminal.Application.Run
  id: Run
  parent: Terminal.Application
  langs:
  - csharp
  name: Run()
  nameWithType: Application.Run()
  fullName: Application.Run()
  type: Method
  assemblies:
  - Terminal
  namespace: Terminal
  summary: Runs the application with the built-in toplevel view
  syntax:
    content: public static void Run ();
    parameters: []
  overload: Terminal.Application.Run*
  exceptions: []
- uid: Terminal.Application.Run(Terminal.Toplevel)
  id: Run(Terminal.Toplevel)
  parent: Terminal.Application
  langs:
  - csharp
  name: Run(Toplevel)
  nameWithType: Application.Run(Toplevel)
  fullName: Application.Run(Toplevel)
  type: Method
  assemblies:
  - Terminal
  namespace: Terminal
  summary: Runs the main loop on the given container.
  remarks: >-
    <p>
                    This method is used to start processing events
                    for the main application, but it is also used to
                    run modal dialog boxes.
                  </p>
        <p>
                    To make a toplevel stop execution, set the "Running"
                    property to false.
                  </p>
  syntax:
    content: public static void Run (Terminal.Toplevel view);
    parameters:
    - id: view
      type: Terminal.Toplevel
      description: To be added.
  overload: Terminal.Application.Run*
  exceptions: []
- uid: Terminal.Application.RunLoop(Terminal.Application.RunState,System.Boolean)
  id: RunLoop(Terminal.Application.RunState,System.Boolean)
  parent: Terminal.Application
  langs:
  - csharp
  name: RunLoop(Application+RunState, Boolean)
  nameWithType: Application.RunLoop(Application+RunState, Boolean)
  fullName: Application.RunLoop(Application+RunState, Boolean)
  type: Method
  assemblies:
  - Terminal
  namespace: Terminal
  summary: Runs the main loop for the created dialog
  remarks: >-
    Use the wait parameter to control whether this is a
                  blocking or non-blocking call.
  syntax:
    content: public static void RunLoop (Terminal.Application.RunState state, bool wait = true);
    parameters:
    - id: state
      type: Terminal.Application+RunState
      description: To be added.
    - id: wait
      type: System.Boolean
      description: To be added.
  overload: Terminal.Application.RunLoop*
  exceptions: []
- uid: Terminal.Application.Top
  id: Top
  parent: Terminal.Application
  langs:
  - csharp
  name: Top
  nameWithType: Application.Top
  fullName: Application.Top
  type: Property
  assemblies:
  - Terminal
  namespace: Terminal
  summary: The Toplevel object used for the application on startup.
  syntax:
    content: public static Terminal.Toplevel Top { get; }
    return:
      type: Terminal.Toplevel
      description: The top.
  overload: Terminal.Application.Top*
  exceptions: []
- uid: Terminal.Application.UngrabMouse
  id: UngrabMouse
  parent: Terminal.Application
  langs:
  - csharp
  name: UngrabMouse()
  nameWithType: Application.UngrabMouse()
  fullName: Application.UngrabMouse()
  type: Method
  assemblies:
  - Terminal
  namespace: Terminal
  summary: Releases the mouse grab, so mouse events will be routed to the view on which the mouse is.
  syntax:
    content: public static void UngrabMouse ();
    parameters: []
  overload: Terminal.Application.UngrabMouse*
  exceptions: []
references:
- uid: System.Object
  parent: System
  isExternal: true
  name: Object
  nameWithType: Object
  fullName: System.Object
- uid: Terminal.Application.#ctor
  parent: Terminal.Application
  isExternal: false
  name: Application()
  nameWithType: Application.Application()
  fullName: Application.Application()
- uid: Terminal.Application.Begin(Terminal.Toplevel)
  parent: Terminal.Application
  isExternal: false
  name: Begin(Toplevel)
  nameWithType: Application.Begin(Toplevel)
  fullName: Application.Begin(Toplevel)
- uid: Terminal.Application
  parent: Terminal
  isExternal: false
  name: Application
  nameWithType: Application
  fullName: Terminal.Application+RunState
- uid: Terminal.Toplevel
  parent: Terminal
  isExternal: false
  name: Toplevel
  nameWithType: Toplevel
  fullName: Terminal.Toplevel
- uid: Terminal.Application.Current
  parent: Terminal.Application
  isExternal: false
  name: Current
  nameWithType: Application.Current
  fullName: Application.Current
- uid: Terminal.Application.Driver
  parent: Terminal.Application
  isExternal: false
  name: Driver
  nameWithType: Application.Driver
  fullName: Application.Driver
- uid: Terminal.ConsoleDriver
  parent: Terminal
  isExternal: false
  name: ConsoleDriver
  nameWithType: ConsoleDriver
  fullName: Terminal.ConsoleDriver
- uid: Terminal.Application.End(Terminal.Application.RunState)
  parent: Terminal.Application
  isExternal: false
  name: End(Application+RunState)
  nameWithType: Application.End(Application+RunState)
  fullName: Application.End(Application+RunState)
- uid: Terminal.Application.GrabMouse(Terminal.View)
  parent: Terminal.Application
  isExternal: false
  name: GrabMouse(View)
  nameWithType: Application.GrabMouse(View)
  fullName: Application.GrabMouse(View)
- uid: Terminal.View
  parent: Terminal
  isExternal: false
  name: View
  nameWithType: View
  fullName: Terminal.View
- uid: Terminal.Application.Init
  parent: Terminal.Application
  isExternal: false
  name: Init()
  nameWithType: Application.Init()
  fullName: Application.Init()
- uid: Terminal.Application.Iteration
  parent: Terminal.Application
  isExternal: false
  name: Iteration
  nameWithType: Application.Iteration
  fullName: Application.Iteration
- uid: System.EventHandler
  parent: System
  isExternal: true
  name: EventHandler
  nameWithType: EventHandler
  fullName: System.EventHandler
- uid: Terminal.Application.MainLoop
  parent: Terminal.Application
  isExternal: false
  name: MainLoop
  nameWithType: Application.MainLoop
  fullName: Application.MainLoop
- uid: Mono.Terminal.MainLoop
  parent: Mono.Terminal
  isExternal: true
  name: MainLoop
  nameWithType: MainLoop
  fullName: Mono.Terminal.MainLoop
- uid: Terminal.Application.MakeCenteredRect(Terminal.Size)
  parent: Terminal.Application
  isExternal: false
  name: MakeCenteredRect(Size)
  nameWithType: Application.MakeCenteredRect(Size)
  fullName: Application.MakeCenteredRect(Size)
- uid: Terminal.Rect
  parent: Terminal
  isExternal: false
  name: Rect
  nameWithType: Rect
  fullName: Terminal.Rect
- uid: Terminal.Size
  parent: Terminal
  isExternal: false
  name: Size
  nameWithType: Size
  fullName: Terminal.Size
- uid: Terminal.Application.Refresh
  parent: Terminal.Application
  isExternal: false
  name: Refresh()
  nameWithType: Application.Refresh()
  fullName: Application.Refresh()
- uid: Terminal.Application.RequestStop
  parent: Terminal.Application
  isExternal: false
  name: RequestStop()
  nameWithType: Application.RequestStop()
  fullName: Application.RequestStop()
- uid: Terminal.Application.RootMouseEvent
  parent: Terminal.Application
  isExternal: false
  name: RootMouseEvent
  nameWithType: Application.RootMouseEvent
  fullName: Application.RootMouseEvent
- uid: System.Action`1
  name: Action
  nameWithType: Action
  fullName: System.Action
- uid: Terminal.MouseEvent
  name: MouseEvent
  nameWithType: MouseEvent
  fullName: Terminal.MouseEvent
- uid: System.Action{Terminal.MouseEvent}
  parent: System
  isExternal: true
  name: Action<MouseEvent>
  nameWithType: Action<MouseEvent>
  fullName: System.Action<Terminal.MouseEvent>
  spec.csharp:
  - uid: System.Action`1
    name: Action
    nameWithType: Action
    fullName: System.Action
  - name: <
    nameWithType: <
    fullName: <
  - uid: Terminal.MouseEvent
    name: MouseEvent
    nameWithType: MouseEvent
    fullName: Terminal.MouseEvent
  - name: '>'
    nameWithType: '>'
    fullName: '>'
- uid: Terminal.Application.Run
  parent: Terminal.Application
  isExternal: false
  name: Run()
  nameWithType: Application.Run()
  fullName: Application.Run()
- uid: Terminal.Application.Run(Terminal.Toplevel)
  parent: Terminal.Application
  isExternal: false
  name: Run(Toplevel)
  nameWithType: Application.Run(Toplevel)
  fullName: Application.Run(Toplevel)
- uid: Terminal.Application.RunLoop(Terminal.Application.RunState,System.Boolean)
  parent: Terminal.Application
  isExternal: false
  name: RunLoop(Application+RunState, Boolean)
  nameWithType: Application.RunLoop(Application+RunState, Boolean)
  fullName: Application.RunLoop(Application+RunState, Boolean)
- uid: System.Boolean
  parent: System
  isExternal: true
  name: Boolean
  nameWithType: Boolean
  fullName: System.Boolean
- uid: Terminal.Application.Top
  parent: Terminal.Application
  isExternal: false
  name: Top
  nameWithType: Application.Top
  fullName: Application.Top
- uid: Terminal.Application.UngrabMouse
  parent: Terminal.Application
  isExternal: false
  name: UngrabMouse()
  nameWithType: Application.UngrabMouse()
  fullName: Application.UngrabMouse()
- uid: Terminal.Application.#ctor*
  parent: Terminal.Application
  isExternal: false
  name: Application
  nameWithType: Application.Application
  fullName: Application.Application
- uid: Terminal.Application.Begin*
  parent: Terminal.Application
  isExternal: false
  name: Begin
  nameWithType: Application.Begin
  fullName: Application.Begin
- uid: Terminal.Application.Current*
  parent: Terminal.Application
  isExternal: false
  name: Current
  nameWithType: Application.Current
  fullName: Application.Current
- uid: Terminal.Application.End*
  parent: Terminal.Application
  isExternal: false
  name: End
  nameWithType: Application.End
  fullName: Application.End
- uid: Terminal.Application.GrabMouse*
  parent: Terminal.Application
  isExternal: false
  name: GrabMouse
  nameWithType: Application.GrabMouse
  fullName: Application.GrabMouse
- uid: Terminal.Application.Init*
  parent: Terminal.Application
  isExternal: false
  name: Init
  nameWithType: Application.Init
  fullName: Application.Init
- uid: Terminal.Application.MainLoop*
  parent: Terminal.Application
  isExternal: false
  name: MainLoop
  nameWithType: Application.MainLoop
  fullName: Application.MainLoop
- uid: Terminal.Application.MakeCenteredRect*
  parent: Terminal.Application
  isExternal: false
  name: MakeCenteredRect
  nameWithType: Application.MakeCenteredRect
  fullName: Application.MakeCenteredRect
- uid: Terminal.Application.Refresh*
  parent: Terminal.Application
  isExternal: false
  name: Refresh
  nameWithType: Application.Refresh
  fullName: Application.Refresh
- uid: Terminal.Application.RequestStop*
  parent: Terminal.Application
  isExternal: false
  name: RequestStop
  nameWithType: Application.RequestStop
  fullName: Application.RequestStop
- uid: Terminal.Application.Run*
  parent: Terminal.Application
  isExternal: false
  name: Run
  nameWithType: Application.Run
  fullName: Application.Run
- uid: Terminal.Application.RunLoop*
  parent: Terminal.Application
  isExternal: false
  name: RunLoop
  nameWithType: Application.RunLoop
  fullName: Application.RunLoop
- uid: Terminal.Application.Top*
  parent: Terminal.Application
  isExternal: false
  name: Top
  nameWithType: Application.Top
  fullName: Application.Top
- uid: Terminal.Application.UngrabMouse*
  parent: Terminal.Application
  isExternal: false
  name: UngrabMouse
  nameWithType: Application.UngrabMouse
  fullName: Application.UngrabMouse