Files
Terminal.Gui/docfx/api/Terminal/Terminal.View.yml
Miguel de Icaza f3f32f6a24 Update docs
2018-01-15 23:17:12 -05:00

1511 lines
42 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: Terminal.View
id: View
children:
- Terminal.View.#ctor(Terminal.Rect)
- Terminal.View.Add(Terminal.View)
- 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.DrawFrame(Terminal.Rect,System.Boolean)
- Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute)
- Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme)
- 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.GetEnumerator
- 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.ProcessKey(Terminal.KeyEvent)
- Terminal.View.Redraw(Terminal.Rect)
- 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
langs:
- csharp
name: View
nameWithType: View
fullName: Terminal.View
type: Class
assemblies:
- Terminal
namespace: Terminal
summary: View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.
remarks: "<p>\n The View defines the base functionality for user interface elements in Terminal/gui.cs. Views\n can contain one or more subviews, can respond to user input and render themselves on the screen.\n </p>\n <p>\n Views are created with a specified rectangle region (the frame) that is relative to the container\n that they are added into. \n </p>\n <p>\n Subviews can be added to a View by calling the Add method. The container of a view is the \n Superview.\n </p>\n <p>\n Developers can call the SetNeedsDisplay method on the view to flag a region or the entire view\n as requiring to be redrawn.\n </p>"
syntax:
content: 'public class View : Terminal.Responder, System.Collections.IEnumerable'
inheritance:
- System.Object
- Terminal.Responder
derivedClasses:
- Terminal.Button
- Terminal.CheckBox
- Terminal.Label
- Terminal.MenuBar
- Terminal.RadioGroup
- Terminal.ScrollView
- Terminal.TextField
- Terminal.Toplevel
implements:
- System.Collections.IEnumerable
inheritedMembers:
- Terminal.Responder.CanFocus
- Terminal.Responder.MouseEvent(Terminal.MouseEvent)
- uid: Terminal.View.#ctor(Terminal.Rect)
id: '#ctor(Terminal.Rect)'
parent: Terminal.View
langs:
- csharp
name: View(Rect)
nameWithType: View.View(Rect)
fullName: View.View(Rect)
type: Constructor
assemblies:
- Terminal
namespace: Terminal
summary: Initializes a new instance of the <xref href="Terminal.View"></xref> class with the specified frame. This is the default constructor.
syntax:
content: public View (Terminal.Rect frame);
parameters:
- id: frame
type: Terminal.Rect
description: The region covered by this view.
overload: Terminal.View.#ctor*
exceptions: []
- uid: Terminal.View.Add(Terminal.View)
id: Add(Terminal.View)
parent: Terminal.View
langs:
- csharp
name: Add(View)
nameWithType: View.Add(View)
fullName: View.Add(View)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Adds a subview to this view.
syntax:
content: public virtual void Add (Terminal.View view);
parameters:
- id: view
type: Terminal.View
description: To be added.
overload: Terminal.View.Add*
exceptions: []
- uid: Terminal.View.Add(Terminal.View[])
id: Add(Terminal.View[])
parent: Terminal.View
langs:
- csharp
name: Add(View[])
nameWithType: View.Add(View[])
fullName: View.Add(View[])
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Adds the specified views to the view.
syntax:
content: public void Add (Terminal.View[] views);
parameters:
- id: views
type: Terminal.View[]
description: Array of one or more views (can be optional parameter).
overload: Terminal.View.Add*
exceptions: []
- uid: Terminal.View.AddCh(System.Int32,System.Int32,System.Int32)
id: AddCh(System.Int32,System.Int32,System.Int32)
parent: Terminal.View
langs:
- csharp
name: AddCh(Int32, Int32, Int32)
nameWithType: View.AddCh(Int32, Int32, Int32)
fullName: View.AddCh(Int32, Int32, Int32)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Displays the specified character in the specified column and row.
syntax:
content: public void AddCh (int col, int row, int ch);
parameters:
- id: col
type: System.Int32
description: Col.
- id: row
type: System.Int32
description: Row.
- id: ch
type: System.Int32
description: Ch.
overload: Terminal.View.AddCh*
exceptions: []
- uid: Terminal.View.Bounds
id: Bounds
parent: Terminal.View
langs:
- csharp
name: Bounds
nameWithType: View.Bounds
fullName: View.Bounds
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: The bounds represent the View-relative rectangle used for this view. Updates to the Bounds update the Frame, and has the same side effects as updating the frame.
syntax:
content: public Terminal.Rect Bounds { get; set; }
return:
type: Terminal.Rect
description: The bounds.
overload: Terminal.View.Bounds*
exceptions: []
- uid: Terminal.View.ChildNeedsDisplay
id: ChildNeedsDisplay
parent: Terminal.View
langs:
- csharp
name: ChildNeedsDisplay()
nameWithType: View.ChildNeedsDisplay()
fullName: View.ChildNeedsDisplay()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Flags this view for requiring the children views to be repainted.
syntax:
content: public void ChildNeedsDisplay ();
parameters: []
overload: Terminal.View.ChildNeedsDisplay*
exceptions: []
- uid: Terminal.View.Clear
id: Clear
parent: Terminal.View
langs:
- csharp
name: Clear()
nameWithType: View.Clear()
fullName: View.Clear()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Clears the view region with the current color.
remarks: >-
<p>
This clears the entire region used by this view.
</p>
syntax:
content: public void Clear ();
parameters: []
overload: Terminal.View.Clear*
exceptions: []
- uid: Terminal.View.ClearNeedsDisplay
id: ClearNeedsDisplay
parent: Terminal.View
langs:
- csharp
name: ClearNeedsDisplay()
nameWithType: View.ClearNeedsDisplay()
fullName: View.ClearNeedsDisplay()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Removes the SetNeedsDisplay and the ChildNeedsDisplay setting on this view.
syntax:
content: protected void ClearNeedsDisplay ();
parameters: []
overload: Terminal.View.ClearNeedsDisplay*
exceptions: []
- uid: Terminal.View.DrawFrame(Terminal.Rect,System.Boolean)
id: DrawFrame(Terminal.Rect,System.Boolean)
parent: Terminal.View
langs:
- csharp
name: DrawFrame(Rect, Boolean)
nameWithType: View.DrawFrame(Rect, Boolean)
fullName: View.DrawFrame(Rect, Boolean)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Draws a frame in the current view, clipped by the boundary of this view
syntax:
content: public void DrawFrame (Terminal.Rect rect, bool fill = false);
parameters:
- id: rect
type: Terminal.Rect
description: Rectangular region for the frame to be drawn.
- id: fill
type: System.Boolean
description: If set to <code>true</code> it fill will the contents.
overload: Terminal.View.DrawFrame*
exceptions: []
- uid: Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute)
id: DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute)
parent: Terminal.View
langs:
- csharp
name: DrawHotString(String, Attribute, Attribute)
nameWithType: View.DrawHotString(String, Attribute, Attribute)
fullName: View.DrawHotString(String, Attribute, Attribute)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Utility function to draw strings that contain a hotkey
syntax:
content: public void DrawHotString (string text, Terminal.Attribute hotColor, Terminal.Attribute normalColor);
parameters:
- id: text
type: System.String
description: String to display, the underscoore before a letter flags the next letter as the hotkey.
- id: hotColor
type: Terminal.Attribute
description: Hot color.
- id: normalColor
type: Terminal.Attribute
description: Normal color.
overload: Terminal.View.DrawHotString*
exceptions: []
- uid: Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme)
id: DrawHotString(System.String,System.Boolean,Terminal.ColorScheme)
parent: Terminal.View
langs:
- csharp
name: DrawHotString(String, Boolean, ColorScheme)
nameWithType: View.DrawHotString(String, Boolean, ColorScheme)
fullName: View.DrawHotString(String, Boolean, ColorScheme)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Utility function to draw strings that contains a hotkey using a colorscheme and the "focused" state.
syntax:
content: public void DrawHotString (string text, bool focused, Terminal.ColorScheme scheme);
parameters:
- id: text
type: System.String
description: String to display, the underscoore before a letter flags the next letter as the hotkey.
- id: focused
type: System.Boolean
description: If set to <code>true</code> this uses the focused colors from the color scheme, otherwise the regular ones.
- id: scheme
type: Terminal.ColorScheme
description: The color scheme to use.
overload: Terminal.View.DrawHotString*
exceptions: []
- uid: Terminal.View.Driver
id: Driver
parent: Terminal.View
langs:
- csharp
name: Driver
nameWithType: View.Driver
fullName: View.Driver
type: Field
assemblies:
- Terminal
namespace: Terminal
summary: >-
Points to the current driver in use by the view, it is a convenience property
for simplifying the development of new views.
syntax:
content: public static Terminal.ConsoleDriver Driver;
return:
type: Terminal.ConsoleDriver
description: To be added.
exceptions: []
- uid: Terminal.View.EnsureFocus
id: EnsureFocus
parent: Terminal.View
langs:
- csharp
name: EnsureFocus()
nameWithType: View.EnsureFocus()
fullName: View.EnsureFocus()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.
syntax:
content: public void EnsureFocus ();
parameters: []
overload: Terminal.View.EnsureFocus*
exceptions: []
- uid: Terminal.View.Focused
id: Focused
parent: Terminal.View
langs:
- csharp
name: Focused
nameWithType: View.Focused
fullName: View.Focused
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Returns the currently focused view inside this view, or null if nothing is focused.
syntax:
content: public Terminal.View Focused { get; }
return:
type: Terminal.View
description: The focused.
overload: Terminal.View.Focused*
exceptions: []
- uid: Terminal.View.FocusFirst
id: FocusFirst
parent: Terminal.View
langs:
- csharp
name: FocusFirst()
nameWithType: View.FocusFirst()
fullName: View.FocusFirst()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Focuses the first focusable subview if one exists.
syntax:
content: public void FocusFirst ();
parameters: []
overload: Terminal.View.FocusFirst*
exceptions: []
- uid: Terminal.View.FocusLast
id: FocusLast
parent: Terminal.View
langs:
- csharp
name: FocusLast()
nameWithType: View.FocusLast()
fullName: View.FocusLast()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Focuses the last focusable subview if one exists.
syntax:
content: public void FocusLast ();
parameters: []
overload: Terminal.View.FocusLast*
exceptions: []
- uid: Terminal.View.FocusNext
id: FocusNext
parent: Terminal.View
langs:
- csharp
name: FocusNext()
nameWithType: View.FocusNext()
fullName: View.FocusNext()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Focuses the next view.
syntax:
content: public bool FocusNext ();
parameters: []
return:
type: System.Boolean
description: <code>true</code>, if next was focused, <code>false</code> otherwise.
overload: Terminal.View.FocusNext*
exceptions: []
- uid: Terminal.View.FocusPrev
id: FocusPrev
parent: Terminal.View
langs:
- csharp
name: FocusPrev()
nameWithType: View.FocusPrev()
fullName: View.FocusPrev()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Focuses the previous view.
syntax:
content: public bool FocusPrev ();
parameters: []
return:
type: System.Boolean
description: <code>true</code>, if previous was focused, <code>false</code> otherwise.
overload: Terminal.View.FocusPrev*
exceptions: []
- uid: Terminal.View.Frame
id: Frame
parent: Terminal.View
langs:
- csharp
name: Frame
nameWithType: View.Frame
fullName: View.Frame
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Gets or sets the frame for the view.
remarks: "Altering the Frame of a view will trigger the redrawing of the \n view as well as the redrawing of the affected regions in the superview."
syntax:
content: public Terminal.Rect Frame { get; set; }
return:
type: Terminal.Rect
description: The frame.
overload: Terminal.View.Frame*
exceptions: []
- uid: Terminal.View.GetEnumerator
id: GetEnumerator
parent: Terminal.View
langs:
- csharp
name: GetEnumerator()
nameWithType: View.GetEnumerator()
fullName: View.GetEnumerator()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Gets an enumerator that enumerates the subviews in this view.
syntax:
content: >-
[System.Runtime.CompilerServices.IteratorStateMachine(typeof(Terminal.View/<GetEnumerator>d__23))]
public System.Collections.IEnumerator GetEnumerator ();
parameters: []
return:
type: System.Collections.IEnumerator
description: The enumerator.
overload: Terminal.View.GetEnumerator*
exceptions: []
attributes:
- type: System.Runtime.CompilerServices.IteratorStateMachine
- uid: Terminal.View.HasFocus
id: HasFocus
parent: Terminal.View
langs:
- csharp
name: HasFocus
nameWithType: View.HasFocus
fullName: View.HasFocus
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Gets or sets a value indicating whether this <xref href="Terminal.View"></xref> has focus.
syntax:
content: public override bool HasFocus { get; }
return:
type: System.Boolean
description: <code>true</code> if has focus; otherwise, <code>false</code>.
overload: Terminal.View.HasFocus*
exceptions: []
- uid: Terminal.View.Id
id: Id
parent: Terminal.View
langs:
- csharp
name: Id
nameWithType: View.Id
fullName: View.Id
type: Property
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public string Id { get; set; }
return:
type: System.String
description: To be added.
overload: Terminal.View.Id*
exceptions: []
- uid: Terminal.View.LayoutSubviews
id: LayoutSubviews
parent: Terminal.View
langs:
- csharp
name: LayoutSubviews()
nameWithType: View.LayoutSubviews()
fullName: View.LayoutSubviews()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: "This virtual method is invoked when a view starts executing or \n when the dimensions of the view have changed, for example in \n response to the container view or terminal resizing."
syntax:
content: public virtual void LayoutSubviews ();
parameters: []
overload: Terminal.View.LayoutSubviews*
exceptions: []
- uid: Terminal.View.MostFocused
id: MostFocused
parent: Terminal.View
langs:
- csharp
name: MostFocused
nameWithType: View.MostFocused
fullName: View.MostFocused
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Returns the most focused view in the chain of subviews (the leaf view that has the focus).
syntax:
content: public Terminal.View MostFocused { get; }
return:
type: Terminal.View
description: The most focused.
overload: Terminal.View.MostFocused*
exceptions: []
- uid: Terminal.View.Move(System.Int32,System.Int32)
id: Move(System.Int32,System.Int32)
parent: Terminal.View
langs:
- csharp
name: Move(Int32, Int32)
nameWithType: View.Move(Int32, Int32)
fullName: View.Move(Int32, Int32)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: This moves the cursor to the specified column and row in the view.
syntax:
content: public void Move (int col, int row);
parameters:
- id: col
type: System.Int32
description: Col.
- id: row
type: System.Int32
description: Row.
overload: Terminal.View.Move*
exceptions: []
- uid: Terminal.View.PositionCursor
id: PositionCursor
parent: Terminal.View
langs:
- csharp
name: PositionCursor()
nameWithType: View.PositionCursor()
fullName: View.PositionCursor()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Positions the cursor in the right position based on the currently focused view in the chain.
syntax:
content: public virtual void PositionCursor ();
parameters: []
overload: Terminal.View.PositionCursor*
exceptions: []
- uid: Terminal.View.ProcessColdKey(Terminal.KeyEvent)
id: ProcessColdKey(Terminal.KeyEvent)
parent: Terminal.View
langs:
- csharp
name: ProcessColdKey(KeyEvent)
nameWithType: View.ProcessColdKey(KeyEvent)
fullName: View.ProcessColdKey(KeyEvent)
type: Method
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public override bool ProcessColdKey (Terminal.KeyEvent kb);
parameters:
- id: kb
type: Terminal.KeyEvent
description: To be added.
return:
type: System.Boolean
description: To be added.
overload: Terminal.View.ProcessColdKey*
exceptions: []
- uid: Terminal.View.ProcessHotKey(Terminal.KeyEvent)
id: ProcessHotKey(Terminal.KeyEvent)
parent: Terminal.View
langs:
- csharp
name: ProcessHotKey(KeyEvent)
nameWithType: View.ProcessHotKey(KeyEvent)
fullName: View.ProcessHotKey(KeyEvent)
type: Method
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public override bool ProcessHotKey (Terminal.KeyEvent kb);
parameters:
- id: kb
type: Terminal.KeyEvent
description: To be added.
return:
type: System.Boolean
description: To be added.
overload: Terminal.View.ProcessHotKey*
exceptions: []
- uid: Terminal.View.ProcessKey(Terminal.KeyEvent)
id: ProcessKey(Terminal.KeyEvent)
parent: Terminal.View
langs:
- csharp
name: ProcessKey(KeyEvent)
nameWithType: View.ProcessKey(KeyEvent)
fullName: View.ProcessKey(KeyEvent)
type: Method
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public override bool ProcessKey (Terminal.KeyEvent kb);
parameters:
- id: kb
type: Terminal.KeyEvent
description: To be added.
return:
type: System.Boolean
description: To be added.
overload: Terminal.View.ProcessKey*
exceptions: []
- uid: Terminal.View.Redraw(Terminal.Rect)
id: Redraw(Terminal.Rect)
parent: Terminal.View
langs:
- csharp
name: Redraw(Rect)
nameWithType: View.Redraw(Rect)
fullName: View.Redraw(Rect)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Performs a redraw of this view and its subviews, only redraws the views that have been flagged for a re-display.
remarks: The region argument is relative to the view itself.
syntax:
content: public virtual void Redraw (Terminal.Rect region);
parameters:
- id: region
type: Terminal.Rect
description: To be added.
overload: Terminal.View.Redraw*
exceptions: []
- uid: Terminal.View.Remove(Terminal.View)
id: Remove(Terminal.View)
parent: Terminal.View
langs:
- csharp
name: Remove(View)
nameWithType: View.Remove(View)
fullName: View.Remove(View)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Removes a widget from this container.
syntax:
content: public virtual void Remove (Terminal.View view);
parameters:
- id: view
type: Terminal.View
description: To be added.
overload: Terminal.View.Remove*
exceptions: []
- uid: Terminal.View.RemoveAll
id: RemoveAll
parent: Terminal.View
langs:
- csharp
name: RemoveAll()
nameWithType: View.RemoveAll()
fullName: View.RemoveAll()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Removes all the widgets from this container.
syntax:
content: public virtual void RemoveAll ();
parameters: []
overload: Terminal.View.RemoveAll*
exceptions: []
- uid: Terminal.View.ScreenToView(System.Int32,System.Int32)
id: ScreenToView(System.Int32,System.Int32)
parent: Terminal.View
langs:
- csharp
name: ScreenToView(Int32, Int32)
nameWithType: View.ScreenToView(Int32, Int32)
fullName: View.ScreenToView(Int32, Int32)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Converts a point from screen coordinates into the view coordinate space.
syntax:
content: public Terminal.Point ScreenToView (int x, int y);
parameters:
- id: x
type: System.Int32
description: X screen-coordinate point.
- id: y
type: System.Int32
description: Y screen-coordinate point.
return:
type: Terminal.Point
description: The mapped point.
overload: Terminal.View.ScreenToView*
exceptions: []
- uid: Terminal.View.SetFocus(Terminal.View)
id: SetFocus(Terminal.View)
parent: Terminal.View
langs:
- csharp
name: SetFocus(View)
nameWithType: View.SetFocus(View)
fullName: View.SetFocus(View)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Focuses the specified sub-view.
syntax:
content: public void SetFocus (Terminal.View view);
parameters:
- id: view
type: Terminal.View
description: View.
overload: Terminal.View.SetFocus*
exceptions: []
- uid: Terminal.View.SetNeedsDisplay
id: SetNeedsDisplay
parent: Terminal.View
langs:
- csharp
name: SetNeedsDisplay()
nameWithType: View.SetNeedsDisplay()
fullName: View.SetNeedsDisplay()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: >-
Invoke to flag that this view needs to be redisplayed, by any code
that alters the state of the view.
syntax:
content: public void SetNeedsDisplay ();
parameters: []
overload: Terminal.View.SetNeedsDisplay*
exceptions: []
- uid: Terminal.View.SetNeedsDisplay(Terminal.Rect)
id: SetNeedsDisplay(Terminal.Rect)
parent: Terminal.View
langs:
- csharp
name: SetNeedsDisplay(Rect)
nameWithType: View.SetNeedsDisplay(Rect)
fullName: View.SetNeedsDisplay(Rect)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Flags the specified rectangle region on this view as needing to be repainted.
syntax:
content: public void SetNeedsDisplay (Terminal.Rect region);
parameters:
- id: region
type: Terminal.Rect
description: The region that must be flagged for repaint.
overload: Terminal.View.SetNeedsDisplay*
exceptions: []
- uid: Terminal.View.Subviews
id: Subviews
parent: Terminal.View
langs:
- csharp
name: Subviews
nameWithType: View.Subviews
fullName: View.Subviews
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: This returns a list of the subviews contained by this view.
syntax:
content: public System.Collections.Generic.IList<Terminal.View> Subviews { get; }
return:
type: System.Collections.Generic.IList{Terminal.View}
description: The subviews.
overload: Terminal.View.Subviews*
exceptions: []
- uid: Terminal.View.SuperView
id: SuperView
parent: Terminal.View
langs:
- csharp
name: SuperView
nameWithType: View.SuperView
fullName: View.SuperView
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Returns the container for this view, or null if this view has not been added to a container.
syntax:
content: public Terminal.View SuperView { get; }
return:
type: Terminal.View
description: The super view.
overload: Terminal.View.SuperView*
exceptions: []
- uid: Terminal.View.ToString
id: ToString
parent: Terminal.View
langs:
- csharp
name: ToString()
nameWithType: View.ToString()
fullName: View.ToString()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Returns a <xref href="System.String"></xref> that represents the current <xref href="Terminal.View"></xref>.
syntax:
content: public override string ToString ();
parameters: []
return:
type: System.String
description: A <xref href="System.String"></xref> that represents the current <xref href="Terminal.View"></xref>.
overload: Terminal.View.ToString*
exceptions: []
- uid: Terminal.View.WantMousePositionReports
id: WantMousePositionReports
parent: Terminal.View
langs:
- csharp
name: WantMousePositionReports
nameWithType: View.WantMousePositionReports
fullName: View.WantMousePositionReports
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Gets or sets a value indicating whether this <xref href="Terminal.View"></xref> want mouse position reports.
syntax:
content: public virtual bool WantMousePositionReports { get; set; }
return:
type: System.Boolean
description: <code>true</code> if want mouse position reports; otherwise, <code>false</code>.
overload: Terminal.View.WantMousePositionReports*
exceptions: []
references:
- uid: Terminal.Responder
parent: Terminal
isExternal: false
name: Responder
nameWithType: Responder
fullName: Terminal.Responder
- uid: Terminal.View.#ctor(Terminal.Rect)
parent: Terminal.View
isExternal: false
name: View(Rect)
nameWithType: View.View(Rect)
fullName: View.View(Rect)
- uid: Terminal.Rect
parent: Terminal
isExternal: false
name: Rect
nameWithType: Rect
fullName: Terminal.Rect
- 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
parent: Terminal
isExternal: false
name: View
nameWithType: View
fullName: Terminal.View
- 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[]
parent: Terminal
isExternal: false
name: View[]
nameWithType: View[]
fullName: Terminal.View[]
spec.csharp:
- uid: Terminal.View
name: View
nameWithType: View
fullName: Terminal.View
- name: '[]'
nameWithType: '[]'
fullName: '[]'
- 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: System.Int32
parent: System
isExternal: true
name: Int32
nameWithType: Int32
fullName: System.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.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: System.Boolean
parent: System
isExternal: true
name: Boolean
nameWithType: Boolean
fullName: System.Boolean
- 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: System.String
parent: System
isExternal: true
name: String
nameWithType: String
fullName: System.String
- uid: Terminal.Attribute
parent: Terminal
isExternal: false
name: Attribute
nameWithType: Attribute
fullName: Terminal.Attribute
- 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.ColorScheme
parent: Terminal
isExternal: false
name: ColorScheme
nameWithType: ColorScheme
fullName: Terminal.ColorScheme
- uid: Terminal.View.Driver
parent: Terminal.View
isExternal: false
name: Driver
nameWithType: View.Driver
fullName: View.Driver
- uid: Terminal.ConsoleDriver
parent: Terminal
isExternal: false
name: ConsoleDriver
nameWithType: ConsoleDriver
fullName: Terminal.ConsoleDriver
- 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.GetEnumerator
parent: Terminal.View
isExternal: false
name: GetEnumerator()
nameWithType: View.GetEnumerator()
fullName: View.GetEnumerator()
- uid: System.Collections.IEnumerator
parent: System.Collections
isExternal: true
name: IEnumerator
nameWithType: IEnumerator
fullName: System.Collections.IEnumerator
- uid: Terminal.View.HasFocus
parent: Terminal.View
isExternal: false
name: HasFocus
nameWithType: View.HasFocus
fullName: View.HasFocus
- 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.ProcessColdKey(Terminal.KeyEvent)
parent: Terminal.View
isExternal: false
name: ProcessColdKey(KeyEvent)
nameWithType: View.ProcessColdKey(KeyEvent)
fullName: View.ProcessColdKey(KeyEvent)
- uid: Terminal.KeyEvent
parent: Terminal
isExternal: false
name: KeyEvent
nameWithType: KeyEvent
fullName: Terminal.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.View.ProcessKey(Terminal.KeyEvent)
parent: Terminal.View
isExternal: false
name: ProcessKey(KeyEvent)
nameWithType: View.ProcessKey(KeyEvent)
fullName: View.ProcessKey(KeyEvent)
- uid: Terminal.View.Redraw(Terminal.Rect)
parent: Terminal.View
isExternal: false
name: Redraw(Rect)
nameWithType: View.Redraw(Rect)
fullName: View.Redraw(Rect)
- 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.Point
parent: Terminal
isExternal: false
name: Point
nameWithType: Point
fullName: Terminal.Point
- 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: System.Collections.Generic.IList`1
name: IList
nameWithType: IList
fullName: System.Collections.Generic.IList
- uid: System.Collections.Generic.IList{Terminal.View}
parent: System.Collections.Generic
isExternal: true
name: IList<View>
nameWithType: IList<View>
fullName: System.Collections.Generic.IList<Terminal.View>
spec.csharp:
- uid: System.Collections.Generic.IList`1
name: IList
nameWithType: IList
fullName: System.Collections.Generic.IList
- name: <
nameWithType: <
fullName: <
- uid: Terminal.View
name: View
nameWithType: View
fullName: Terminal.View
- name: '>'
nameWithType: '>'
fullName: '>'
- 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.View.#ctor*
parent: Terminal.View
isExternal: false
name: View
nameWithType: View.View
fullName: View.View
- uid: Terminal.View.Add*
parent: Terminal.View
isExternal: false
name: Add
nameWithType: View.Add
fullName: View.Add
- uid: Terminal.View.AddCh*
parent: Terminal.View
isExternal: false
name: AddCh
nameWithType: View.AddCh
fullName: View.AddCh
- 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.DrawFrame*
parent: Terminal.View
isExternal: false
name: DrawFrame
nameWithType: View.DrawFrame
fullName: View.DrawFrame
- uid: Terminal.View.DrawHotString*
parent: Terminal.View
isExternal: false
name: DrawHotString
nameWithType: View.DrawHotString
fullName: View.DrawHotString
- 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.GetEnumerator*
parent: Terminal.View
isExternal: false
name: GetEnumerator
nameWithType: View.GetEnumerator
fullName: View.GetEnumerator
- uid: Terminal.View.HasFocus*
parent: Terminal.View
isExternal: false
name: HasFocus
nameWithType: View.HasFocus
fullName: View.HasFocus
- 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*
parent: Terminal.View
isExternal: false
name: Move
nameWithType: View.Move
fullName: View.Move
- uid: Terminal.View.PositionCursor*
parent: Terminal.View
isExternal: false
name: PositionCursor
nameWithType: View.PositionCursor
fullName: View.PositionCursor
- uid: Terminal.View.ProcessColdKey*
parent: Terminal.View
isExternal: false
name: ProcessColdKey
nameWithType: View.ProcessColdKey
fullName: View.ProcessColdKey
- uid: Terminal.View.ProcessHotKey*
parent: Terminal.View
isExternal: false
name: ProcessHotKey
nameWithType: View.ProcessHotKey
fullName: View.ProcessHotKey
- uid: Terminal.View.ProcessKey*
parent: Terminal.View
isExternal: false
name: ProcessKey
nameWithType: View.ProcessKey
fullName: View.ProcessKey
- uid: Terminal.View.Redraw*
parent: Terminal.View
isExternal: false
name: Redraw
nameWithType: View.Redraw
fullName: View.Redraw
- uid: Terminal.View.Remove*
parent: Terminal.View
isExternal: false
name: Remove
nameWithType: View.Remove
fullName: View.Remove
- uid: Terminal.View.RemoveAll*
parent: Terminal.View
isExternal: false
name: RemoveAll
nameWithType: View.RemoveAll
fullName: View.RemoveAll
- uid: Terminal.View.ScreenToView*
parent: Terminal.View
isExternal: false
name: ScreenToView
nameWithType: View.ScreenToView
fullName: View.ScreenToView
- uid: Terminal.View.SetFocus*
parent: Terminal.View
isExternal: false
name: SetFocus
nameWithType: View.SetFocus
fullName: View.SetFocus
- uid: Terminal.View.SetNeedsDisplay*
parent: Terminal.View
isExternal: false
name: SetNeedsDisplay
nameWithType: View.SetNeedsDisplay
fullName: View.SetNeedsDisplay
- 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.Responder.CanFocus
parent: Terminal.Responder
isExternal: false
name: CanFocus
nameWithType: Responder.CanFocus
fullName: Responder.CanFocus
- uid: Terminal.Responder.MouseEvent(Terminal.MouseEvent)
parent: Terminal.Responder
isExternal: false
name: MouseEvent(MouseEvent)
nameWithType: Responder.MouseEvent(MouseEvent)
fullName: Responder.MouseEvent(MouseEvent)
- uid: System.Collections.IEnumerable
parent: System.Collections
isExternal: true
name: IEnumerable
nameWithType: IEnumerable
fullName: System.Collections.IEnumerable