|
@@ -72,7 +72,8 @@
|
|
|
|
|
|
<h1 id="Terminal_View" data-uid="Terminal.View">Class View
|
|
|
</h1>
|
|
|
- <div class="markdown level0 summary"></div>
|
|
|
+ <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>
|
|
@@ -103,13 +104,30 @@
|
|
|
<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></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"></div>
|
|
|
+ <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">
|
|
@@ -128,7 +146,7 @@
|
|
|
<tr>
|
|
|
<td><a class="xref" href="Terminal.Rect.html">Rect</a></td>
|
|
|
<td><span class="parametername">frame</span></td>
|
|
|
- <td><p>To be added.</p>
|
|
|
+ <td><p>The region covered by this view.</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
@@ -138,7 +156,9 @@
|
|
|
|
|
|
|
|
|
<h4 id="Terminal_View_Driver" data-uid="Terminal.View.Driver">Driver</h4>
|
|
|
- <div class="markdown level1 summary"></div>
|
|
|
+ <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">
|
|
@@ -160,38 +180,14 @@
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
-
|
|
|
-
|
|
|
- <h4 id="Terminal_View_empty" data-uid="Terminal.View.empty">empty</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 static System.Collections.Generic.IList<Terminal.View> empty;</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><span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Terminal.View.html">View</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"></div>
|
|
|
+ <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">
|
|
@@ -208,7 +204,7 @@
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td><a class="xref" href="Terminal.Rect.html">Rect</a></td>
|
|
|
- <td><p>To be added.</p>
|
|
|
+ <td><p>The bounds.</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
@@ -244,7 +240,8 @@
|
|
|
|
|
|
<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"></div>
|
|
|
+ <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">
|
|
@@ -261,16 +258,21 @@
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td><a class="xref" href="Terminal.Rect.html">Rect</a></td>
|
|
|
- <td><p>To be added.</p>
|
|
|
+ <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"></div>
|
|
|
+ <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">
|
|
@@ -287,7 +289,7 @@
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
|
- <td><p>To be added.</p>
|
|
|
+ <td><p><code>true</code> if has focus; otherwise, <code>false</code>.</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
@@ -322,7 +324,8 @@
|
|
|
|
|
|
<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"></div>
|
|
|
+ <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">
|
|
@@ -339,7 +342,7 @@
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td><a class="xref" href="Terminal.View.html">View</a></td>
|
|
|
- <td><p>To be added.</p>
|
|
|
+ <td><p>The most focused.</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
@@ -348,7 +351,8 @@
|
|
|
|
|
|
<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"></div>
|
|
|
+ <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">
|
|
@@ -365,7 +369,7 @@
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td><span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Terminal.View.html">View</a>></td>
|
|
|
- <td><p>To be added.</p>
|
|
|
+ <td><p>The subviews.</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
@@ -374,7 +378,8 @@
|
|
|
|
|
|
<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"></div>
|
|
|
+ <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">
|
|
@@ -391,7 +396,7 @@
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td><a class="xref" href="Terminal.View.html">View</a></td>
|
|
|
- <td><p>To be added.</p>
|
|
|
+ <td><p>The super view.</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
@@ -458,7 +463,8 @@
|
|
|
|
|
|
<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"></div>
|
|
|
+ <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">
|
|
@@ -477,7 +483,7 @@
|
|
|
<tr>
|
|
|
<td><a class="xref" href="Terminal.View.html">View</a>[]</td>
|
|
|
<td><span class="parametername">views</span></td>
|
|
|
- <td><p>To be added.</p>
|
|
|
+ <td><p>Array of one or more views (can be optional parameter).</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
@@ -527,7 +533,8 @@
|
|
|
|
|
|
<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"></div>
|
|
|
+ <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">
|
|
@@ -552,7 +559,8 @@
|
|
|
|
|
|
<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"></div>
|
|
|
+ <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">
|
|
@@ -766,7 +774,8 @@
|
|
|
|
|
|
<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"></div>
|
|
|
+ <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">
|
|
@@ -784,7 +793,7 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td><span class="xref">System.Collections.IEnumerator</span></td>
|
|
|
- <td><p>To be added.</p>
|
|
|
+ <td><p>The enumerator.</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
@@ -793,7 +802,10 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
|
|
|
|
|
|
<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"></div>
|
|
|
+ <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">
|
|
@@ -1145,7 +1157,8 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
|
|
|
|
|
|
<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"></div>
|
|
|
+ <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">
|
|
@@ -1164,7 +1177,7 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
|
|
|
<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><p>The region that must be flagged for repaint.</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
@@ -1173,7 +1186,8 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
|
|
|
|
|
|
<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"></div>
|
|
|
+ <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">
|
|
@@ -1190,7 +1204,7 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td><span class="xref">System.String</span></td>
|
|
|
- <td><p>To be added.</p>
|
|
|
+ <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>
|