Files
Terminal.Gui/docfx/api/Terminal/Terminal.Window.yml
Miguel de Icaza 58f99c0bd8 API doc update
2018-01-17 14:24:58 -05:00

523 lines
15 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: Terminal.Window
id: Window
children:
- Terminal.Window.#ctor(Terminal.Rect,System.String)
- Terminal.Window.Add(Terminal.View)
- Terminal.Window.GetEnumerator
- Terminal.Window.Redraw(Terminal.Rect)
- Terminal.Window.Title
langs:
- csharp
name: Window
nameWithType: Window
fullName: Terminal.Window
type: Class
assemblies:
- Terminal
namespace: Terminal
summary: A toplevel view that draws a frame around its region and has a "ContentView" subview where the contents are added.
syntax:
content: 'public class Window : Terminal.Toplevel, System.Collections.IEnumerable'
inheritance:
- System.Object
- Terminal.Responder
- Terminal.View
- Terminal.Toplevel
derivedClasses:
- Terminal.Dialog
implements:
- System.Collections.IEnumerable
inheritedMembers:
- Terminal.Responder.MouseEvent(Terminal.MouseEvent)
- Terminal.Toplevel.CanFocus
- Terminal.Toplevel.Create
- Terminal.Toplevel.ProcessKey(Terminal.KeyEvent)
- Terminal.Toplevel.Running
- Terminal.View.Add(Terminal.View[])
- Terminal.View.AddCh(System.Int32,System.Int32,System.Int32)
- Terminal.View.Bounds
- Terminal.View.ChildNeedsDisplay
- Terminal.View.Clear
- Terminal.View.ClearNeedsDisplay
- Terminal.View.ColorScheme
- Terminal.View.DrawFrame(Terminal.Rect,System.Boolean)
- Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme)
- Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute)
- Terminal.View.Driver
- Terminal.View.EnsureFocus
- Terminal.View.Focused
- Terminal.View.FocusFirst
- Terminal.View.FocusLast
- Terminal.View.FocusNext
- Terminal.View.FocusPrev
- Terminal.View.Frame
- Terminal.View.HasFocus
- Terminal.View.Id
- Terminal.View.LayoutSubviews
- Terminal.View.MostFocused
- Terminal.View.Move(System.Int32,System.Int32)
- Terminal.View.PositionCursor
- Terminal.View.ProcessColdKey(Terminal.KeyEvent)
- Terminal.View.ProcessHotKey(Terminal.KeyEvent)
- Terminal.View.Remove(Terminal.View)
- Terminal.View.RemoveAll
- Terminal.View.ScreenToView(System.Int32,System.Int32)
- Terminal.View.SetFocus(Terminal.View)
- Terminal.View.SetNeedsDisplay
- Terminal.View.SetNeedsDisplay(Terminal.Rect)
- Terminal.View.Subviews
- Terminal.View.SuperView
- Terminal.View.ToString
- Terminal.View.WantMousePositionReports
- uid: Terminal.Window.#ctor(Terminal.Rect,System.String)
id: '#ctor(Terminal.Rect,System.String)'
parent: Terminal.Window
langs:
- csharp
name: Window(Rect, String)
nameWithType: Window.Window(Rect, String)
fullName: Window.Window(Rect, String)
type: Constructor
assemblies:
- Terminal
namespace: Terminal
summary: Initializes a new instance of the <xref href="Terminal.Window"></xref> class with an optioanl title
syntax:
content: public Window (Terminal.Rect frame, string title = null);
parameters:
- id: frame
type: Terminal.Rect
description: Frame.
- id: title
type: System.String
description: Title.
overload: Terminal.Window.#ctor*
exceptions: []
- uid: Terminal.Window.Add(Terminal.View)
id: Add(Terminal.View)
parent: Terminal.Window
langs:
- csharp
name: Add(View)
nameWithType: Window.Add(View)
fullName: Window.Add(View)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Add the specified view to the ContentView.
syntax:
content: public override void Add (Terminal.View view);
parameters:
- id: view
type: Terminal.View
description: View to add to the window.
overload: Terminal.Window.Add*
exceptions: []
- uid: Terminal.Window.GetEnumerator
id: GetEnumerator
parent: Terminal.Window
langs:
- csharp
name: GetEnumerator()
nameWithType: Window.GetEnumerator()
fullName: Window.GetEnumerator()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Enumerates the various views in the ContentView.
syntax:
content: public System.Collections.IEnumerator GetEnumerator ();
parameters: []
return:
type: System.Collections.IEnumerator
description: The enumerator.
overload: Terminal.Window.GetEnumerator*
exceptions: []
- uid: Terminal.Window.Redraw(Terminal.Rect)
id: Redraw(Terminal.Rect)
parent: Terminal.Window
langs:
- csharp
name: Redraw(Rect)
nameWithType: Window.Redraw(Rect)
fullName: Window.Redraw(Rect)
type: Method
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public override void Redraw (Terminal.Rect bounds);
parameters:
- id: bounds
type: Terminal.Rect
description: To be added.
overload: Terminal.Window.Redraw*
exceptions: []
- uid: Terminal.Window.Title
id: Title
parent: Terminal.Window
langs:
- csharp
name: Title
nameWithType: Window.Title
fullName: Window.Title
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: The title to be displayed for this window.
syntax:
content: public string Title { get; set; }
return:
type: System.String
description: The title.
overload: Terminal.Window.Title*
exceptions: []
references:
- uid: Terminal.Toplevel
parent: Terminal
isExternal: false
name: Toplevel
nameWithType: Toplevel
fullName: Terminal.Toplevel
- uid: Terminal.Window.#ctor(Terminal.Rect,System.String)
parent: Terminal.Window
isExternal: false
name: Window(Rect, String)
nameWithType: Window.Window(Rect, String)
fullName: Window.Window(Rect, String)
- uid: Terminal.Rect
parent: Terminal
isExternal: false
name: Rect
nameWithType: Rect
fullName: Terminal.Rect
- uid: System.String
parent: System
isExternal: true
name: String
nameWithType: String
fullName: System.String
- uid: Terminal.Window.Add(Terminal.View)
parent: Terminal.Window
isExternal: false
name: Add(View)
nameWithType: Window.Add(View)
fullName: Window.Add(View)
- uid: Terminal.View
parent: Terminal
isExternal: false
name: View
nameWithType: View
fullName: Terminal.View
- uid: Terminal.Window.GetEnumerator
parent: Terminal.Window
isExternal: false
name: GetEnumerator()
nameWithType: Window.GetEnumerator()
fullName: Window.GetEnumerator()
- uid: System.Collections.IEnumerator
parent: System.Collections
isExternal: true
name: IEnumerator
nameWithType: IEnumerator
fullName: System.Collections.IEnumerator
- uid: Terminal.Window.Redraw(Terminal.Rect)
parent: Terminal.Window
isExternal: false
name: Redraw(Rect)
nameWithType: Window.Redraw(Rect)
fullName: Window.Redraw(Rect)
- uid: Terminal.Window.Title
parent: Terminal.Window
isExternal: false
name: Title
nameWithType: Window.Title
fullName: Window.Title
- uid: Terminal.Window.#ctor*
parent: Terminal.Window
isExternal: false
name: Window
nameWithType: Window.Window
fullName: Window.Window
- uid: Terminal.Window.Add*
parent: Terminal.Window
isExternal: false
name: Add
nameWithType: Window.Add
fullName: Window.Add
- uid: Terminal.Window.GetEnumerator*
parent: Terminal.Window
isExternal: false
name: GetEnumerator
nameWithType: Window.GetEnumerator
fullName: Window.GetEnumerator
- uid: Terminal.Window.Redraw*
parent: Terminal.Window
isExternal: false
name: Redraw
nameWithType: Window.Redraw
fullName: Window.Redraw
- uid: Terminal.Window.Title*
parent: Terminal.Window
isExternal: false
name: Title
nameWithType: Window.Title
fullName: Window.Title
- uid: Terminal.Toplevel.CanFocus
parent: Terminal.Toplevel
isExternal: false
name: CanFocus
nameWithType: Toplevel.CanFocus
fullName: Toplevel.CanFocus
- uid: Terminal.View.HasFocus
parent: Terminal.View
isExternal: false
name: HasFocus
nameWithType: View.HasFocus
fullName: View.HasFocus
- uid: Terminal.Responder.MouseEvent(Terminal.MouseEvent)
parent: Terminal.Responder
isExternal: false
name: MouseEvent(MouseEvent)
nameWithType: Responder.MouseEvent(MouseEvent)
fullName: Responder.MouseEvent(MouseEvent)
- uid: Terminal.View.ProcessColdKey(Terminal.KeyEvent)
parent: Terminal.View
isExternal: false
name: ProcessColdKey(KeyEvent)
nameWithType: View.ProcessColdKey(KeyEvent)
fullName: View.ProcessColdKey(KeyEvent)
- uid: Terminal.View.ProcessHotKey(Terminal.KeyEvent)
parent: Terminal.View
isExternal: false
name: ProcessHotKey(KeyEvent)
nameWithType: View.ProcessHotKey(KeyEvent)
fullName: View.ProcessHotKey(KeyEvent)
- uid: Terminal.Toplevel.ProcessKey(Terminal.KeyEvent)
parent: Terminal.Toplevel
isExternal: false
name: ProcessKey(KeyEvent)
nameWithType: Toplevel.ProcessKey(KeyEvent)
fullName: Toplevel.ProcessKey(KeyEvent)
- uid: Terminal.View.Add(Terminal.View[])
parent: Terminal.View
isExternal: false
name: Add(View[])
nameWithType: View.Add(View[])
fullName: View.Add(View[])
- uid: Terminal.View.AddCh(System.Int32,System.Int32,System.Int32)
parent: Terminal.View
isExternal: false
name: AddCh(Int32, Int32, Int32)
nameWithType: View.AddCh(Int32, Int32, Int32)
fullName: View.AddCh(Int32, Int32, Int32)
- uid: Terminal.View.Bounds
parent: Terminal.View
isExternal: false
name: Bounds
nameWithType: View.Bounds
fullName: View.Bounds
- uid: Terminal.View.ChildNeedsDisplay
parent: Terminal.View
isExternal: false
name: ChildNeedsDisplay()
nameWithType: View.ChildNeedsDisplay()
fullName: View.ChildNeedsDisplay()
- uid: Terminal.View.Clear
parent: Terminal.View
isExternal: false
name: Clear()
nameWithType: View.Clear()
fullName: View.Clear()
- uid: Terminal.View.ClearNeedsDisplay
parent: Terminal.View
isExternal: false
name: ClearNeedsDisplay()
nameWithType: View.ClearNeedsDisplay()
fullName: View.ClearNeedsDisplay()
- uid: Terminal.View.ColorScheme
parent: Terminal.View
isExternal: false
name: ColorScheme
nameWithType: View.ColorScheme
fullName: View.ColorScheme
- uid: Terminal.View.DrawFrame(Terminal.Rect,System.Boolean)
parent: Terminal.View
isExternal: false
name: DrawFrame(Rect, Boolean)
nameWithType: View.DrawFrame(Rect, Boolean)
fullName: View.DrawFrame(Rect, Boolean)
- uid: Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme)
parent: Terminal.View
isExternal: false
name: DrawHotString(String, Boolean, ColorScheme)
nameWithType: View.DrawHotString(String, Boolean, ColorScheme)
fullName: View.DrawHotString(String, Boolean, ColorScheme)
- uid: Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute)
parent: Terminal.View
isExternal: false
name: DrawHotString(String, Attribute, Attribute)
nameWithType: View.DrawHotString(String, Attribute, Attribute)
fullName: View.DrawHotString(String, Attribute, Attribute)
- uid: Terminal.View.Driver
parent: Terminal.View
isExternal: false
name: Driver
nameWithType: View.Driver
fullName: View.Driver
- uid: Terminal.View.EnsureFocus
parent: Terminal.View
isExternal: false
name: EnsureFocus()
nameWithType: View.EnsureFocus()
fullName: View.EnsureFocus()
- uid: Terminal.View.Focused
parent: Terminal.View
isExternal: false
name: Focused
nameWithType: View.Focused
fullName: View.Focused
- uid: Terminal.View.FocusFirst
parent: Terminal.View
isExternal: false
name: FocusFirst()
nameWithType: View.FocusFirst()
fullName: View.FocusFirst()
- uid: Terminal.View.FocusLast
parent: Terminal.View
isExternal: false
name: FocusLast()
nameWithType: View.FocusLast()
fullName: View.FocusLast()
- uid: Terminal.View.FocusNext
parent: Terminal.View
isExternal: false
name: FocusNext()
nameWithType: View.FocusNext()
fullName: View.FocusNext()
- uid: Terminal.View.FocusPrev
parent: Terminal.View
isExternal: false
name: FocusPrev()
nameWithType: View.FocusPrev()
fullName: View.FocusPrev()
- uid: Terminal.View.Frame
parent: Terminal.View
isExternal: false
name: Frame
nameWithType: View.Frame
fullName: View.Frame
- uid: Terminal.View.Id
parent: Terminal.View
isExternal: false
name: Id
nameWithType: View.Id
fullName: View.Id
- uid: Terminal.View.LayoutSubviews
parent: Terminal.View
isExternal: false
name: LayoutSubviews()
nameWithType: View.LayoutSubviews()
fullName: View.LayoutSubviews()
- uid: Terminal.View.MostFocused
parent: Terminal.View
isExternal: false
name: MostFocused
nameWithType: View.MostFocused
fullName: View.MostFocused
- uid: Terminal.View.Move(System.Int32,System.Int32)
parent: Terminal.View
isExternal: false
name: Move(Int32, Int32)
nameWithType: View.Move(Int32, Int32)
fullName: View.Move(Int32, Int32)
- uid: Terminal.View.PositionCursor
parent: Terminal.View
isExternal: false
name: PositionCursor()
nameWithType: View.PositionCursor()
fullName: View.PositionCursor()
- uid: Terminal.View.Remove(Terminal.View)
parent: Terminal.View
isExternal: false
name: Remove(View)
nameWithType: View.Remove(View)
fullName: View.Remove(View)
- uid: Terminal.View.RemoveAll
parent: Terminal.View
isExternal: false
name: RemoveAll()
nameWithType: View.RemoveAll()
fullName: View.RemoveAll()
- uid: Terminal.View.ScreenToView(System.Int32,System.Int32)
parent: Terminal.View
isExternal: false
name: ScreenToView(Int32, Int32)
nameWithType: View.ScreenToView(Int32, Int32)
fullName: View.ScreenToView(Int32, Int32)
- uid: Terminal.View.SetFocus(Terminal.View)
parent: Terminal.View
isExternal: false
name: SetFocus(View)
nameWithType: View.SetFocus(View)
fullName: View.SetFocus(View)
- uid: Terminal.View.SetNeedsDisplay
parent: Terminal.View
isExternal: false
name: SetNeedsDisplay()
nameWithType: View.SetNeedsDisplay()
fullName: View.SetNeedsDisplay()
- uid: Terminal.View.SetNeedsDisplay(Terminal.Rect)
parent: Terminal.View
isExternal: false
name: SetNeedsDisplay(Rect)
nameWithType: View.SetNeedsDisplay(Rect)
fullName: View.SetNeedsDisplay(Rect)
- uid: Terminal.View.Subviews
parent: Terminal.View
isExternal: false
name: Subviews
nameWithType: View.Subviews
fullName: View.Subviews
- uid: Terminal.View.SuperView
parent: Terminal.View
isExternal: false
name: SuperView
nameWithType: View.SuperView
fullName: View.SuperView
- uid: Terminal.View.ToString
parent: Terminal.View
isExternal: false
name: ToString()
nameWithType: View.ToString()
fullName: View.ToString()
- uid: Terminal.View.WantMousePositionReports
parent: Terminal.View
isExternal: false
name: WantMousePositionReports
nameWithType: View.WantMousePositionReports
fullName: View.WantMousePositionReports
- uid: Terminal.Toplevel.Create
parent: Terminal.Toplevel
isExternal: false
name: Create()
nameWithType: Toplevel.Create()
fullName: Toplevel.Create()
- uid: Terminal.Toplevel.Running
parent: Terminal.Toplevel
isExternal: false
name: Running
nameWithType: Toplevel.Running
fullName: Toplevel.Running
- uid: System.Collections.IEnumerable
parent: System.Collections
isExternal: true
name: IEnumerable
nameWithType: IEnumerable
fullName: System.Collections.IEnumerable