refreshed api docs

This commit is contained in:
Charlie Kindel
2020-08-15 09:12:25 -07:00
parent 0b58bf7f0c
commit fc215f1a6d
97 changed files with 3051 additions and 608 deletions

View File

@@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class TextView
">
<meta name="generator" content="docfx 2.56.1.0">
<meta name="generator" content="docfx 2.56.2.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
@@ -281,7 +281,7 @@ Multi-line text editing <a class="xref" href="Terminal.Gui.View.html">View</a>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
@@ -358,6 +358,9 @@ Multi-line text editing <a class="xref" href="Terminal.Gui.View.html">View</a>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
</div>
@@ -508,7 +511,9 @@ Raised when the <a class="xref" href="Terminal.Gui.TextView.html#Terminal_Gui_Te
<a id="Terminal_Gui_TextView_CanFocus_" data-uid="Terminal.Gui.TextView.CanFocus*"></a>
<h4 id="Terminal_Gui_TextView_CanFocus" data-uid="Terminal.Gui.TextView.CanFocus">CanFocus</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary">
Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> can focus.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -525,7 +530,7 @@ Raised when the <a class="xref" href="Terminal.Gui.TextView.html#Terminal_Gui_Te
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
<td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
</tr>
</tbody>
</table>
@@ -750,7 +755,9 @@ Loads the contents of the stream into the <a class="xref" href="Terminal.Gui.Te
<a id="Terminal_Gui_TextView_MouseEvent_" data-uid="Terminal.Gui.TextView.MouseEvent*"></a>
<h4 id="Terminal_Gui_TextView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TextView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary">
Method invoked when a mouse event is generated
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -784,7 +791,7 @@ Loads the contents of the stream into the <a class="xref" href="Terminal.Gui.Te
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
<td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
</tr>
</tbody>
</table>
@@ -808,7 +815,10 @@ Positions the cursor on the current row and column
<a id="Terminal_Gui_TextView_ProcessKey_" data-uid="Terminal.Gui.TextView.ProcessKey*"></a>
<h4 id="Terminal_Gui_TextView_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextView.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary">
If the view is focused, gives the view a
chance to process the keystroke.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -848,11 +858,32 @@ Positions the cursor on the current row and column
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
<h5 id="Terminal_Gui_TextView_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
<div class="markdown level1 remarks">
<p>
Views can override this method if they are
interested in processing the given keystroke.
If they consume the keystroke, they must
return true to stop the keystroke from being
processed by other widgets or consumed by the
widget engine. If they return false, the
keystroke will be passed using the ProcessColdKey
method to other views to process.
</p>
<p>
The View implementation does nothing but return false,
so it is not necessary to call base.ProcessKey if you
derive directly from View, but you should if you derive
other View subclasses.
</p>
</div>
<a id="Terminal_Gui_TextView_Redraw_" data-uid="Terminal.Gui.TextView.Redraw*"></a>
<h4 id="Terminal_Gui_TextView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary">
Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -871,12 +902,26 @@ Positions the cursor on the current row and column
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">bounds</span></td>
<td></td>
<td>The bounds (view-relative region) to redraw.</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
<h5 id="Terminal_Gui_TextView_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
<div class="markdown level1 remarks">
<p>
Always use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> (view-relative) when calling <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a>, NOT <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> (superview-relative).
</p>
<p>
Views should set the color that they want to use on entry, as otherwise this will inherit
the last color that was set globally on the driver.
</p>
<p>
Overrides of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a> must ensure they do not set <code>Driver.Clip</code> to a clip region
larger than the <code>region</code> parameter.
</p>
</div>
<a id="Terminal_Gui_TextView_ScrollTo_" data-uid="Terminal.Gui.TextView.ScrollTo*"></a>