mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
1294 lines
48 KiB
HTML
1294 lines
48 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class View
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class View
|
|
">
|
|
<meta name="generator" content="docfx 2.18.2.0">
|
|
|
|
<link rel="shortcut icon" href="../../favicon.ico">
|
|
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../../styles/docfx.css">
|
|
<link rel="stylesheet" href="../../styles/main.css">
|
|
<meta property="docfx:navrel" content="">
|
|
<meta property="docfx:tocrel" content="../toc.html">
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../../index.html">
|
|
<img id="logo" class="svg" src="../../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Terminal.View">
|
|
|
|
|
|
<h1 id="Terminal_View" data-uid="Terminal.View">Class View
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>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.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><a class="xref" href="Terminal.Responder.html">Responder</a></div>
|
|
<div class="level2"><span class="xref">View</span></div>
|
|
</div>
|
|
<div class="level3"><a class="xref" href="Terminal.Button.html">Button</a></div>
|
|
<div class="level3"><a class="xref" href="Terminal.CheckBox.html">CheckBox</a></div>
|
|
<div class="level3"><a class="xref" href="Terminal.Label.html">Label</a></div>
|
|
<div class="level3"><a class="xref" href="Terminal.MenuBar.html">MenuBar</a></div>
|
|
<div class="level3"><a class="xref" href="Terminal.RadioGroup.html">RadioGroup</a></div>
|
|
<div class="level3"><a class="xref" href="Terminal.ScrollView.html">ScrollView</a></div>
|
|
<div class="level3"><a class="xref" href="Terminal.TextField.html">TextField</a></div>
|
|
<div class="level3"><a class="xref" href="Terminal.Toplevel.html">Toplevel</a></div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="Terminal.Responder.html#Terminal_Responder_CanFocus">Responder.CanFocus</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Terminal.Responder.html#Terminal_Responder_MouseEvent_Terminal_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.html">Terminal</a></h6>
|
|
<h6><strong>Assembly</strong>: Terminal.dll</h6>
|
|
<h5 id="Terminal_View_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class View : Terminal.Responder, System.Collections.IEnumerable</code></pre>
|
|
</div>
|
|
<h5 id="Terminal_View_remarks"><strong>Remarks</strong></h5>
|
|
<div class="markdown level0 remarks"><p>
|
|
The View defines the base functionality for user interface elements in Terminal/gui.cs. Views
|
|
can contain one or more subviews, can respond to user input and render themselves on the screen.
|
|
</p>
|
|
<p>
|
|
Views are created with a specified rectangle region (the frame) that is relative to the container
|
|
that they are added into.<br> </p>
|
|
<p>
|
|
Subviews can be added to a View by calling the Add method. The container of a view is the
|
|
Superview.
|
|
</p>
|
|
<p>
|
|
Developers can call the SetNeedsDisplay method on the view to flag a region or the entire view
|
|
as requiring to be redrawn.
|
|
</p>
|
|
<p>
|
|
Views have a ColorScheme property that defines the default colors that subviews
|
|
should use for rendering. This ensures that the views fit in the context where
|
|
they are being used, and allows for themes to be plugged in. For example, the
|
|
default colors for windows and toplevels uses a blue background, while it uses
|
|
a white background for dialog boxes and a red background for errors.
|
|
</p>
|
|
<p>
|
|
If a ColorScheme is not set on a view, the result of the ColorScheme is the
|
|
value of the SuperView and the value might only be valid once a view has been
|
|
added to a SuperView, so your subclasses should not rely on ColorScheme being
|
|
set at construction time.
|
|
</p>
|
|
<p>
|
|
Using ColorSchemes has the advantage that your application will work both
|
|
in color as well as black and white displays.
|
|
</p></div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
|
|
|
|
<a id="Terminal_View__ctor_" data-uid="Terminal.View.#ctor*"></a>
|
|
<h4 id="Terminal_View__ctor_Terminal_Rect_" data-uid="Terminal.View.#ctor(Terminal.Rect)">View(Rect)</h4>
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Terminal.View.html">View</a> class with the specified frame. This is the default constructor.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public View (Terminal.Rect frame);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.Rect.html">Rect</a></td>
|
|
<td><span class="parametername">frame</span></td>
|
|
<td><p>The region covered by this view.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="fields">Fields
|
|
</h3>
|
|
|
|
|
|
<h4 id="Terminal_View_Driver" data-uid="Terminal.View.Driver">Driver</h4>
|
|
<div class="markdown level1 summary"><p>Points to the current driver in use by the view, it is a convenience property
|
|
for simplifying the development of new views.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Terminal.ConsoleDriver Driver;</code></pre>
|
|
</div>
|
|
<h5 class="fieldValue">Field Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.ConsoleDriver.html">ConsoleDriver</a></td>
|
|
<td><p>To be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
|
|
|
|
<a id="Terminal_View_Bounds_" data-uid="Terminal.View.Bounds*"></a>
|
|
<h4 id="Terminal_View_Bounds" data-uid="Terminal.View.Bounds">Bounds</h4>
|
|
<div class="markdown level1 summary"><p>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.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Terminal.Rect Bounds { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.Rect.html">Rect</a></td>
|
|
<td><p>The bounds.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_ColorScheme_" data-uid="Terminal.View.ColorScheme*"></a>
|
|
<h4 id="Terminal_View_ColorScheme" data-uid="Terminal.View.ColorScheme">ColorScheme</h4>
|
|
<div class="markdown level1 summary"><p>The color scheme for this view, if it is not defined, it returns the parent's
|
|
color scheme.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Terminal.ColorScheme ColorScheme { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.ColorScheme.html">ColorScheme</a></td>
|
|
<td><p>To be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_Focused_" data-uid="Terminal.View.Focused*"></a>
|
|
<h4 id="Terminal_View_Focused" data-uid="Terminal.View.Focused">Focused</h4>
|
|
<div class="markdown level1 summary"><p>Returns the currently focused view inside this view, or null if nothing is focused.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Terminal.View Focused { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.View.html">View</a></td>
|
|
<td><p>The focused.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_Frame_" data-uid="Terminal.View.Frame*"></a>
|
|
<h4 id="Terminal_View_Frame" data-uid="Terminal.View.Frame">Frame</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the frame for the view.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Terminal.Rect Frame { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.Rect.html">Rect</a></td>
|
|
<td><p>The frame.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Terminal_View_Frame_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>Altering the Frame of a view will trigger the redrawing of the
|
|
view as well as the redrawing of the affected regions in the superview.</p>
|
|
</div>
|
|
|
|
|
|
<a id="Terminal_View_HasFocus_" data-uid="Terminal.View.HasFocus*"></a>
|
|
<h4 id="Terminal_View_HasFocus" data-uid="Terminal.View.HasFocus">HasFocus</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether this <a class="xref" href="Terminal.View.html">View</a> has focus.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override bool HasFocus { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if has focus; otherwise, <code>false</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_Id_" data-uid="Terminal.View.Id*"></a>
|
|
<h4 id="Terminal_View_Id" data-uid="Terminal.View.Id">Id</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets an identifier for the view;</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string Id { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><p>The identifier.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_MostFocused_" data-uid="Terminal.View.MostFocused*"></a>
|
|
<h4 id="Terminal_View_MostFocused" data-uid="Terminal.View.MostFocused">MostFocused</h4>
|
|
<div class="markdown level1 summary"><p>Returns the most focused view in the chain of subviews (the leaf view that has the focus).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Terminal.View MostFocused { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.View.html">View</a></td>
|
|
<td><p>The most focused.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_Subviews_" data-uid="Terminal.View.Subviews*"></a>
|
|
<h4 id="Terminal_View_Subviews" data-uid="Terminal.View.Subviews">Subviews</h4>
|
|
<div class="markdown level1 summary"><p>This returns a list of the subviews contained by this view.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public System.Collections.Generic.IList<Terminal.View> Subviews { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Terminal.View.html">View</a>></td>
|
|
<td><p>The subviews.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_SuperView_" data-uid="Terminal.View.SuperView*"></a>
|
|
<h4 id="Terminal_View_SuperView" data-uid="Terminal.View.SuperView">SuperView</h4>
|
|
<div class="markdown level1 summary"><p>Returns the container for this view, or null if this view has not been added to a container.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Terminal.View SuperView { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.View.html">View</a></td>
|
|
<td><p>The super view.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_WantMousePositionReports_" data-uid="Terminal.View.WantMousePositionReports*"></a>
|
|
<h4 id="Terminal_View_WantMousePositionReports" data-uid="Terminal.View.WantMousePositionReports">WantMousePositionReports</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether this <a class="xref" href="Terminal.View.html">View</a> want mouse position reports.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual bool WantMousePositionReports { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if want mouse position reports; otherwise, <code>false</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="Terminal_View_Add_" data-uid="Terminal.View.Add*"></a>
|
|
<h4 id="Terminal_View_Add_Terminal_View_" data-uid="Terminal.View.Add(Terminal.View)">Add(View)</h4>
|
|
<div class="markdown level1 summary"><p>Adds a subview to this view.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual void Add (Terminal.View view);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.View.html">View</a></td>
|
|
<td><span class="parametername">view</span></td>
|
|
<td><p>To be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_Add_" data-uid="Terminal.View.Add*"></a>
|
|
<h4 id="Terminal_View_Add_Terminal_View___" data-uid="Terminal.View.Add(Terminal.View[])">Add(View[])</h4>
|
|
<div class="markdown level1 summary"><p>Adds the specified views to the view.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Add (Terminal.View[] views);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.View.html">View</a>[]</td>
|
|
<td><span class="parametername">views</span></td>
|
|
<td><p>Array of one or more views (can be optional parameter).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_AddCh_" data-uid="Terminal.View.AddCh*"></a>
|
|
<h4 id="Terminal_View_AddCh_System_Int32_System_Int32_System_Int32_" data-uid="Terminal.View.AddCh(System.Int32,System.Int32,System.Int32)">AddCh(Int32, Int32, Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Displays the specified character in the specified column and row.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void AddCh (int col, int row, int ch);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">col</span></td>
|
|
<td><p>Col.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">row</span></td>
|
|
<td><p>Row.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">ch</span></td>
|
|
<td><p>Ch.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_ChildNeedsDisplay_" data-uid="Terminal.View.ChildNeedsDisplay*"></a>
|
|
<h4 id="Terminal_View_ChildNeedsDisplay" data-uid="Terminal.View.ChildNeedsDisplay">ChildNeedsDisplay()</h4>
|
|
<div class="markdown level1 summary"><p>Flags this view for requiring the children views to be repainted.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ChildNeedsDisplay ();</code></pre>
|
|
</div>
|
|
|
|
|
|
<a id="Terminal_View_Clear_" data-uid="Terminal.View.Clear*"></a>
|
|
<h4 id="Terminal_View_Clear" data-uid="Terminal.View.Clear">Clear()</h4>
|
|
<div class="markdown level1 summary"><p>Clears the view region with the current color.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Clear ();</code></pre>
|
|
</div>
|
|
<h5 id="Terminal_View_Clear_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>
|
|
This clears the entire region used by this view.
|
|
</p></div>
|
|
|
|
|
|
<a id="Terminal_View_ClearNeedsDisplay_" data-uid="Terminal.View.ClearNeedsDisplay*"></a>
|
|
<h4 id="Terminal_View_ClearNeedsDisplay" data-uid="Terminal.View.ClearNeedsDisplay">ClearNeedsDisplay()</h4>
|
|
<div class="markdown level1 summary"><p>Removes the SetNeedsDisplay and the ChildNeedsDisplay setting on this view.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected void ClearNeedsDisplay ();</code></pre>
|
|
</div>
|
|
|
|
|
|
<a id="Terminal_View_DrawFrame_" data-uid="Terminal.View.DrawFrame*"></a>
|
|
<h4 id="Terminal_View_DrawFrame_Terminal_Rect_System_Boolean_" data-uid="Terminal.View.DrawFrame(Terminal.Rect,System.Boolean)">DrawFrame(Rect, Boolean)</h4>
|
|
<div class="markdown level1 summary"><p>Draws a frame in the current view, clipped by the boundary of this view</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void DrawFrame (Terminal.Rect rect, bool fill = false);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.Rect.html">Rect</a></td>
|
|
<td><span class="parametername">rect</span></td>
|
|
<td><p>Rectangular region for the frame to be drawn.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">fill</span></td>
|
|
<td><p>If set to <code>true</code> it fill will the contents.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_DrawHotString_" data-uid="Terminal.View.DrawHotString*"></a>
|
|
<h4 id="Terminal_View_DrawHotString_System_String_System_Boolean_Terminal_ColorScheme_" data-uid="Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme)">DrawHotString(String, Boolean, ColorScheme)</h4>
|
|
<div class="markdown level1 summary"><p>Utility function to draw strings that contains a hotkey using a colorscheme and the "focused" state.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void DrawHotString (string text, bool focused, Terminal.ColorScheme scheme);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">text</span></td>
|
|
<td><p>String to display, the underscoore before a letter flags the next letter as the hotkey.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">focused</span></td>
|
|
<td><p>If set to <code>true</code> this uses the focused colors from the color scheme, otherwise the regular ones.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.ColorScheme.html">ColorScheme</a></td>
|
|
<td><span class="parametername">scheme</span></td>
|
|
<td><p>The color scheme to use.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_DrawHotString_" data-uid="Terminal.View.DrawHotString*"></a>
|
|
<h4 id="Terminal_View_DrawHotString_System_String_Terminal_Attribute_Terminal_Attribute_" data-uid="Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute)">DrawHotString(String, Attribute, Attribute)</h4>
|
|
<div class="markdown level1 summary"><p>Utility function to draw strings that contain a hotkey</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void DrawHotString (string text, Terminal.Attribute hotColor, Terminal.Attribute normalColor);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">text</span></td>
|
|
<td><p>String to display, the underscoore before a letter flags the next letter as the hotkey.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.Attribute.html">Attribute</a></td>
|
|
<td><span class="parametername">hotColor</span></td>
|
|
<td><p>Hot color.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.Attribute.html">Attribute</a></td>
|
|
<td><span class="parametername">normalColor</span></td>
|
|
<td><p>Normal color.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_EnsureFocus_" data-uid="Terminal.View.EnsureFocus*"></a>
|
|
<h4 id="Terminal_View_EnsureFocus" data-uid="Terminal.View.EnsureFocus">EnsureFocus()</h4>
|
|
<div class="markdown level1 summary"><p>Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void EnsureFocus ();</code></pre>
|
|
</div>
|
|
|
|
|
|
<a id="Terminal_View_FocusFirst_" data-uid="Terminal.View.FocusFirst*"></a>
|
|
<h4 id="Terminal_View_FocusFirst" data-uid="Terminal.View.FocusFirst">FocusFirst()</h4>
|
|
<div class="markdown level1 summary"><p>Focuses the first focusable subview if one exists.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void FocusFirst ();</code></pre>
|
|
</div>
|
|
|
|
|
|
<a id="Terminal_View_FocusLast_" data-uid="Terminal.View.FocusLast*"></a>
|
|
<h4 id="Terminal_View_FocusLast" data-uid="Terminal.View.FocusLast">FocusLast()</h4>
|
|
<div class="markdown level1 summary"><p>Focuses the last focusable subview if one exists.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void FocusLast ();</code></pre>
|
|
</div>
|
|
|
|
|
|
<a id="Terminal_View_FocusNext_" data-uid="Terminal.View.FocusNext*"></a>
|
|
<h4 id="Terminal_View_FocusNext" data-uid="Terminal.View.FocusNext">FocusNext()</h4>
|
|
<div class="markdown level1 summary"><p>Focuses the next view.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool FocusNext ();</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code>, if next was focused, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_FocusPrev_" data-uid="Terminal.View.FocusPrev*"></a>
|
|
<h4 id="Terminal_View_FocusPrev" data-uid="Terminal.View.FocusPrev">FocusPrev()</h4>
|
|
<div class="markdown level1 summary"><p>Focuses the previous view.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool FocusPrev ();</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code>, if previous was focused, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_GetEnumerator_" data-uid="Terminal.View.GetEnumerator*"></a>
|
|
<h4 id="Terminal_View_GetEnumerator" data-uid="Terminal.View.GetEnumerator">GetEnumerator()</h4>
|
|
<div class="markdown level1 summary"><p>Gets an enumerator that enumerates the subviews in this view.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[System.Runtime.CompilerServices.IteratorStateMachine(typeof(Terminal.View/<GetEnumerator>d__23))]
|
|
public System.Collections.IEnumerator GetEnumerator ();</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Collections.IEnumerator</span></td>
|
|
<td><p>The enumerator.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_LayoutSubviews_" data-uid="Terminal.View.LayoutSubviews*"></a>
|
|
<h4 id="Terminal_View_LayoutSubviews" data-uid="Terminal.View.LayoutSubviews">LayoutSubviews()</h4>
|
|
<div class="markdown level1 summary"><p>This virtual method is invoked when a view starts executing or
|
|
when the dimensions of the view have changed, for example in
|
|
response to the container view or terminal resizing.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual void LayoutSubviews ();</code></pre>
|
|
</div>
|
|
|
|
|
|
<a id="Terminal_View_Move_" data-uid="Terminal.View.Move*"></a>
|
|
<h4 id="Terminal_View_Move_System_Int32_System_Int32_" data-uid="Terminal.View.Move(System.Int32,System.Int32)">Move(Int32, Int32)</h4>
|
|
<div class="markdown level1 summary"><p>This moves the cursor to the specified column and row in the view.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Move (int col, int row);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">col</span></td>
|
|
<td><p>Col.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">row</span></td>
|
|
<td><p>Row.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_PositionCursor_" data-uid="Terminal.View.PositionCursor*"></a>
|
|
<h4 id="Terminal_View_PositionCursor" data-uid="Terminal.View.PositionCursor">PositionCursor()</h4>
|
|
<div class="markdown level1 summary"><p>Positions the cursor in the right position based on the currently focused view in the chain.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual void PositionCursor ();</code></pre>
|
|
</div>
|
|
|
|
|
|
<a id="Terminal_View_ProcessColdKey_" data-uid="Terminal.View.ProcessColdKey*"></a>
|
|
<h4 id="Terminal_View_ProcessColdKey_Terminal_KeyEvent_" data-uid="Terminal.View.ProcessColdKey(Terminal.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override bool ProcessColdKey (Terminal.KeyEvent kb);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.KeyEvent.html">KeyEvent</a></td>
|
|
<td><span class="parametername">kb</span></td>
|
|
<td><p>To be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p>To be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_ProcessHotKey_" data-uid="Terminal.View.ProcessHotKey*"></a>
|
|
<h4 id="Terminal_View_ProcessHotKey_Terminal_KeyEvent_" data-uid="Terminal.View.ProcessHotKey(Terminal.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override bool ProcessHotKey (Terminal.KeyEvent kb);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.KeyEvent.html">KeyEvent</a></td>
|
|
<td><span class="parametername">kb</span></td>
|
|
<td><p>To be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p>To be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_ProcessKey_" data-uid="Terminal.View.ProcessKey*"></a>
|
|
<h4 id="Terminal_View_ProcessKey_Terminal_KeyEvent_" data-uid="Terminal.View.ProcessKey(Terminal.KeyEvent)">ProcessKey(KeyEvent)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.KeyEvent kb);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.KeyEvent.html">KeyEvent</a></td>
|
|
<td><span class="parametername">kb</span></td>
|
|
<td><p>To be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p>To be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_Redraw_" data-uid="Terminal.View.Redraw*"></a>
|
|
<h4 id="Terminal_View_Redraw_Terminal_Rect_" data-uid="Terminal.View.Redraw(Terminal.Rect)">Redraw(Rect)</h4>
|
|
<div class="markdown level1 summary"><p>Performs a redraw of this view and its subviews, only redraws the views that have been flagged for a re-display.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual void Redraw (Terminal.Rect region);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.Rect.html">Rect</a></td>
|
|
<td><span class="parametername">region</span></td>
|
|
<td><p>To be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Terminal_View_Redraw_Terminal_Rect__remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>The region argument is relative to the view itself.</p>
|
|
</div>
|
|
|
|
|
|
<a id="Terminal_View_Remove_" data-uid="Terminal.View.Remove*"></a>
|
|
<h4 id="Terminal_View_Remove_Terminal_View_" data-uid="Terminal.View.Remove(Terminal.View)">Remove(View)</h4>
|
|
<div class="markdown level1 summary"><p>Removes a widget from this container.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual void Remove (Terminal.View view);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.View.html">View</a></td>
|
|
<td><span class="parametername">view</span></td>
|
|
<td><p>To be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_RemoveAll_" data-uid="Terminal.View.RemoveAll*"></a>
|
|
<h4 id="Terminal_View_RemoveAll" data-uid="Terminal.View.RemoveAll">RemoveAll()</h4>
|
|
<div class="markdown level1 summary"><p>Removes all the widgets from this container.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual void RemoveAll ();</code></pre>
|
|
</div>
|
|
|
|
|
|
<a id="Terminal_View_ScreenToView_" data-uid="Terminal.View.ScreenToView*"></a>
|
|
<h4 id="Terminal_View_ScreenToView_System_Int32_System_Int32_" data-uid="Terminal.View.ScreenToView(System.Int32,System.Int32)">ScreenToView(Int32, Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Converts a point from screen coordinates into the view coordinate space.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Terminal.Point ScreenToView (int x, int y);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">x</span></td>
|
|
<td><p>X screen-coordinate point.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">y</span></td>
|
|
<td><p>Y screen-coordinate point.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.Point.html">Point</a></td>
|
|
<td><p>The mapped point.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_SetFocus_" data-uid="Terminal.View.SetFocus*"></a>
|
|
<h4 id="Terminal_View_SetFocus_Terminal_View_" data-uid="Terminal.View.SetFocus(Terminal.View)">SetFocus(View)</h4>
|
|
<div class="markdown level1 summary"><p>Focuses the specified sub-view.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SetFocus (Terminal.View view);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.View.html">View</a></td>
|
|
<td><span class="parametername">view</span></td>
|
|
<td><p>View.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_SetNeedsDisplay_" data-uid="Terminal.View.SetNeedsDisplay*"></a>
|
|
<h4 id="Terminal_View_SetNeedsDisplay" data-uid="Terminal.View.SetNeedsDisplay">SetNeedsDisplay()</h4>
|
|
<div class="markdown level1 summary"><p>Invoke to flag that this view needs to be redisplayed, by any code
|
|
that alters the state of the view.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SetNeedsDisplay ();</code></pre>
|
|
</div>
|
|
|
|
|
|
<a id="Terminal_View_SetNeedsDisplay_" data-uid="Terminal.View.SetNeedsDisplay*"></a>
|
|
<h4 id="Terminal_View_SetNeedsDisplay_Terminal_Rect_" data-uid="Terminal.View.SetNeedsDisplay(Terminal.Rect)">SetNeedsDisplay(Rect)</h4>
|
|
<div class="markdown level1 summary"><p>Flags the specified rectangle region on this view as needing to be repainted.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SetNeedsDisplay (Terminal.Rect region);</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.Rect.html">Rect</a></td>
|
|
<td><span class="parametername">region</span></td>
|
|
<td><p>The region that must be flagged for repaint.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_View_ToString_" data-uid="Terminal.View.ToString*"></a>
|
|
<h4 id="Terminal_View_ToString" data-uid="Terminal.View.ToString">ToString()</h4>
|
|
<div class="markdown level1 summary"><p>Returns a <span class="xref">System.String</span> that represents the current <a class="xref" href="Terminal.View.html">View</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override string ToString ();</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><p>A <span class="xref">System.String</span> that represents the current <a class="xref" href="Terminal.View.html">View</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../../styles/main.js"></script>
|
|
</body>
|
|
</html>
|