mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2026-01-01 00:46:39 +01:00
Rebuild docs
This commit is contained in:
@@ -79,10 +79,18 @@
|
||||
<h4><a class="xref" href="Mono.Terminal/Mono.Terminal.MainLoop.html">MainLoop</a></h4>
|
||||
<section><p>Simple main loop implementation that can be used to monitor
|
||||
file descriptor, run timers and idle handlers.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Mono.Terminal/Mono.Terminal.UnixMainLoop.html">UnixMainLoop</a></h4>
|
||||
<section><p>Unix main loop, suitable for using on Posix systems</p>
|
||||
</section>
|
||||
<h3 id="interfaces">Interfaces
|
||||
</h3>
|
||||
<h4><a class="xref" href="Mono.Terminal/Mono.Terminal.IMainLoopDriver.html">IMainLoopDriver</a></h4>
|
||||
<section><p>Public interface to create your own platform specific main loop driver.</p>
|
||||
</section>
|
||||
<h3 id="enums">Enums
|
||||
</h3>
|
||||
<h4><a class="xref" href="Mono.Terminal/Mono.Terminal.MainLoop.Condition.html">MainLoop.Condition</a></h4>
|
||||
<h4><a class="xref" href="Mono.Terminal/Mono.Terminal.UnixMainLoop.Condition.html">UnixMainLoop.Condition</a></h4>
|
||||
<section><p>Condition on which to wake up from file descriptor activity. These match the Linux/BSD poll definitions.</p>
|
||||
</section>
|
||||
</article>
|
||||
|
||||
@@ -107,12 +107,14 @@
|
||||
|
||||
|
||||
<a id="Mono_Terminal_MainLoop__ctor_" data-uid="Mono.Terminal.MainLoop.#ctor*"></a>
|
||||
<h4 id="Mono_Terminal_MainLoop__ctor_System_Boolean_" data-uid="Mono.Terminal.MainLoop.#ctor(System.Boolean)">MainLoop(Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<h4 id="Mono_Terminal_MainLoop__ctor_Mono_Terminal_IMainLoopDriver_" data-uid="Mono.Terminal.MainLoop.#ctor(Mono.Terminal.IMainLoopDriver)">MainLoop(IMainLoopDriver)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates a new Mainloop, to run it you must provide a driver, and choose
|
||||
one of the implementations UnixMainLoop, NetMainLoop or WindowsMainLoop.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MainLoop (bool useUnix);</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MainLoop (Mono.Terminal.IMainLoopDriver driver);</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
@@ -125,8 +127,8 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">useUnix</span></td>
|
||||
<td><a class="xref" href="Mono.Terminal.IMainLoopDriver.html">IMainLoopDriver</a></td>
|
||||
<td><span class="parametername">driver</span></td>
|
||||
<td><p>To be added.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -156,6 +158,35 @@
|
||||
<tr>
|
||||
<td><span class="xref">System.Action</span><<span class="xref">System.ConsoleKeyInfo</span>></td>
|
||||
<td><p>To be added.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
|
||||
|
||||
<a id="Mono_Terminal_MainLoop_Driver_" data-uid="Mono.Terminal.MainLoop.Driver*"></a>
|
||||
<h4 id="Mono_Terminal_MainLoop_Driver" data-uid="Mono.Terminal.MainLoop.Driver">Driver</h4>
|
||||
<div class="markdown level1 summary"><p>The current IMainLoopDriver in use.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Mono.Terminal.IMainLoopDriver Driver { 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="Mono.Terminal.IMainLoopDriver.html">IMainLoopDriver</a></td>
|
||||
<td><p>The driver.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -108,9 +108,13 @@
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Dim.html">Dim</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.FileDialog.html">FileDialog</a></h4>
|
||||
<section></section>
|
||||
<section><p>Base class for the OpenDialog and the SaveDialog</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.FrameView.html">FrameView</a></h4>
|
||||
<section><p>The FrameView is a container frame that draws a frame around the contents</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.HexView.html">HexView</a></h4>
|
||||
<section><p>An Hex viewer an editor view over a System.IO.Stream</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Label.html">Label</a></h4>
|
||||
<section><p>Label view, displays a string at a given position, can include multiple lines.</p>
|
||||
@@ -131,7 +135,8 @@
|
||||
<section><p>Message box displays a modal message to the user, with a title, a message and a series of options that the user can choose from.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.OpenDialog.html">OpenDialog</a></h4>
|
||||
<section></section>
|
||||
<section><p>The Open Dialog provides an interactive dialog box for users to select files or directories.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Pos.html">Pos</a></h4>
|
||||
<section><p>Describes a position which can be an absolute value, a percentage, centered, or
|
||||
relative to the ending dimension. Integer values are implicitly convertible to
|
||||
@@ -146,9 +151,12 @@
|
||||
<section><p>Radio group shows a group of labels, only one of those can be selected at a given time</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Responder.html">Responder</a></h4>
|
||||
<section></section>
|
||||
<section><p>Responder base class implemented by objects that want to participate on keyboard and mouse input.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.SaveDialog.html">SaveDialog</a></h4>
|
||||
<section></section>
|
||||
<section><p>The save dialog provides an interactive dialog box for users to pick a file to
|
||||
save.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.ScrollBarView.html">ScrollBarView</a></h4>
|
||||
<section><p>ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical</p>
|
||||
</section>
|
||||
@@ -159,7 +167,8 @@
|
||||
<section><p>Text data entry widget</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.TextView.html">TextView</a></h4>
|
||||
<section></section>
|
||||
<section><p>Multi-line text editing view</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a></h4>
|
||||
<section><p>Toplevel views can be modally executed.</p>
|
||||
</section>
|
||||
|
||||
@@ -97,6 +97,9 @@
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Running">Toplevel.Running</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_WillPresent">Toplevel.WillPresent()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
|
||||
</div>
|
||||
|
||||
@@ -246,6 +246,51 @@
|
||||
</table>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_Dim_Sized_" data-uid="Terminal.Gui.Dim.Sized*"></a>
|
||||
<h4 id="Terminal_Gui_Dim_Sized_System_Int32_" data-uid="Terminal.Gui.Dim.Sized(System.Int32)">Sized(Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates an Absolute Pos from the specified integer value.</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.Gui.Dim Sized (int n);</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">n</span></td>
|
||||
<td><p>The value to convert to the pos.</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.Gui.Dim.html">Dim</a></td>
|
||||
<td><p>The Absolute Pos.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_Dim_Width_" data-uid="Terminal.Gui.Dim.Width*"></a>
|
||||
<h4 id="Terminal_Gui_Dim_Width_Terminal_Gui_View_" data-uid="Terminal.Gui.Dim.Width(Terminal.Gui.View)">Width(View)</h4>
|
||||
<div class="markdown level1 summary"><p>Returns a Dim object tracks the Width of the specified view.</p>
|
||||
|
||||
@@ -72,7 +72,8 @@
|
||||
|
||||
<h1 id="Terminal_Gui_FileDialog" data-uid="Terminal.Gui.FileDialog">Class FileDialog
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 summary"><p>Base class for the OpenDialog and the SaveDialog</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
@@ -550,6 +551,18 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_FileDialog_WillPresent_" data-uid="Terminal.Gui.FileDialog.WillPresent*"></a>
|
||||
<h4 id="Terminal_Gui_FileDialog_WillPresent" data-uid="Terminal.Gui.FileDialog.WillPresent">WillPresent()</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 void WillPresent ();</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -72,7 +72,8 @@
|
||||
|
||||
<h1 id="Terminal_Gui_OpenDialog" data-uid="Terminal.Gui.OpenDialog">Class OpenDialog
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 summary"><p>The Open Dialog provides an interactive dialog box for users to select files or directories.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
@@ -123,6 +124,9 @@
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.FileDialog.html#Terminal_Gui_FileDialog_Prompt">FileDialog.Prompt</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.FileDialog.html#Terminal_Gui_FileDialog_WillPresent">FileDialog.WillPresent()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_CanFocus">Toplevel.CanFocus</a>
|
||||
</div>
|
||||
@@ -283,6 +287,20 @@
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class OpenDialog : Terminal.Gui.FileDialog</code></pre>
|
||||
</div>
|
||||
<h5 id="Terminal_Gui_OpenDialog_remarks"><strong>Remarks</strong></h5>
|
||||
<div class="markdown level0 remarks"><p>
|
||||
The open dialog can be used to select files for opening, it can be configured to allow
|
||||
multiple items to be selected (based on the AllowsMultipleSelection) variable and
|
||||
you can control whether this should allow files or directories to be selected.
|
||||
</p>
|
||||
<p>
|
||||
To use it, create an instance of the OpenDialog, configure its properties, and then
|
||||
call Application.Run on the resulting instance. This will run the dialog modally,
|
||||
and when this returns, the list of filds will be available on the FilePaths property.
|
||||
</p>
|
||||
<p>
|
||||
To select more than one file, users can use the spacebar, or control-t.
|
||||
</p></div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
|
||||
@@ -343,7 +361,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><p><code>true</code> if allows multiple selection; otherwise, <code>false</code>.</p>
|
||||
<td><p><code>true</code> if allows multiple selection; otherwise, <code>false</code>, defaults to false.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -370,7 +388,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><p><code>true</code> if can choose directories; otherwise, <code>false</code>.</p>
|
||||
<td><p><code>true</code> if can choose directories; otherwise, <code>false</code> defaults to <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -397,7 +415,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><p><code>true</code> if can choose files; otherwise, <code>false</code>.</p>
|
||||
<td><p><code>true</code> if can choose files; otherwise, <code>false</code>. Defaults to <code>true</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -406,12 +424,12 @@
|
||||
|
||||
<a id="Terminal_Gui_OpenDialog_FilePaths_" data-uid="Terminal.Gui.OpenDialog.FilePaths*"></a>
|
||||
<h4 id="Terminal_Gui_OpenDialog_FilePaths" data-uid="Terminal.Gui.OpenDialog.FilePaths">FilePaths</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the file paths selected</p>
|
||||
<div class="markdown level1 summary"><p>Returns the selected files, or an empty list if nothing has been selected</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.IReadOnlyList<NStack.ustring> FilePaths { get; }</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public System.Collections.Generic.IReadOnlyList<string> FilePaths { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue">Property Value</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
@@ -423,7 +441,7 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyList</span><<span class="xref">NStack.ustring</span>></td>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyList</span><<span class="xref">System.String</span>></td>
|
||||
<td><p>The file paths.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@@ -167,6 +167,51 @@
|
||||
</table>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_Pos_At_" data-uid="Terminal.Gui.Pos.At*"></a>
|
||||
<h4 id="Terminal_Gui_Pos_At_System_Int32_" data-uid="Terminal.Gui.Pos.At(System.Int32)">At(Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates an Absolute Pos from the specified integer value.</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.Gui.Pos At (int n);</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">n</span></td>
|
||||
<td><p>The value to convert to the pos.</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.Gui.Pos.html">Pos</a></td>
|
||||
<td><p>The Absolute Pos.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_Pos_Bottom_" data-uid="Terminal.Gui.Pos.Bottom*"></a>
|
||||
<h4 id="Terminal_Gui_Pos_Bottom_Terminal_Gui_View_" data-uid="Terminal.Gui.Pos.Bottom(Terminal.Gui.View)">Bottom(View)</h4>
|
||||
<div class="markdown level1 summary"><p>Returns a Pos object tracks the Bottom (Y+Height) coordinate of the specified view.</p>
|
||||
|
||||
@@ -72,7 +72,8 @@
|
||||
|
||||
<h1 id="Terminal_Gui_Responder" data-uid="Terminal.Gui.Responder">Class Responder
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 summary"><p>Responder base class implemented by objects that want to participate on keyboard and mouse input.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
@@ -104,7 +105,8 @@
|
||||
|
||||
<a id="Terminal_Gui_Responder_CanFocus_" data-uid="Terminal.Gui.Responder.CanFocus*"></a>
|
||||
<h4 id="Terminal_Gui_Responder_CanFocus" data-uid="Terminal.Gui.Responder.CanFocus">CanFocus</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.Gui.Responder.html">Responder</a> can focus.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
@@ -121,7 +123,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><p>To be added.</p>
|
||||
<td><p><code>true</code> if can focus; otherwise, <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -130,7 +132,8 @@
|
||||
|
||||
<a id="Terminal_Gui_Responder_HasFocus_" data-uid="Terminal.Gui.Responder.HasFocus*"></a>
|
||||
<h4 id="Terminal_Gui_Responder_HasFocus" data-uid="Terminal.Gui.Responder.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.Gui.Responder.html">Responder</a> has focus.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
@@ -147,7 +150,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>
|
||||
|
||||
@@ -72,7 +72,9 @@
|
||||
|
||||
<h1 id="Terminal_Gui_SaveDialog" data-uid="Terminal.Gui.SaveDialog">Class SaveDialog
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 summary"><p>The save dialog provides an interactive dialog box for users to pick a file to
|
||||
save.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
@@ -123,6 +125,9 @@
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.FileDialog.html#Terminal_Gui_FileDialog_Prompt">FileDialog.Prompt</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.FileDialog.html#Terminal_Gui_FileDialog_WillPresent">FileDialog.WillPresent()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_CanFocus">Toplevel.CanFocus</a>
|
||||
</div>
|
||||
@@ -283,6 +288,13 @@
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SaveDialog : Terminal.Gui.FileDialog</code></pre>
|
||||
</div>
|
||||
<h5 id="Terminal_Gui_SaveDialog_remarks"><strong>Remarks</strong></h5>
|
||||
<div class="markdown level0 remarks"><p>
|
||||
To use it, create an instance of the SaveDialog, and then
|
||||
call Application.Run on the resulting instance. This will run the dialog modally,
|
||||
and when this returns, the FileName property will contain the selected value or
|
||||
null if the user canceled.
|
||||
</p></div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
|
||||
@@ -315,6 +327,36 @@
|
||||
<td><span class="xref">NStack.ustring</span></td>
|
||||
<td><span class="parametername">message</span></td>
|
||||
<td><p>To be added.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_SaveDialog_FileName_" data-uid="Terminal.Gui.SaveDialog.FileName*"></a>
|
||||
<h4 id="Terminal_Gui_SaveDialog_FileName" data-uid="Terminal.Gui.SaveDialog.FileName">FileName</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the name of the file the user selected for saving, or null
|
||||
if the user canceled the dialog box.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public NStack.ustring FileName { 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">NStack.ustring</span></td>
|
||||
<td><p>The name of the file.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -260,6 +260,35 @@
|
||||
</table>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
|
||||
<h4 id="Terminal_Gui_TextField__ctor_System_String_" data-uid="Terminal.Gui.TextField.#ctor(System.String)">TextField(String)</h4>
|
||||
<div class="markdown level1 summary"><p>Public constructor that creates a text field, with layout controlled with X, Y, Width and Height.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public TextField (string text);</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>Initial text contents.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
|
||||
<h4 id="Terminal_Gui_TextField__ctor_System_Int32_System_Int32_System_Int32_NStack_ustring_" data-uid="Terminal.Gui.TextField.#ctor(System.Int32,System.Int32,System.Int32,NStack.ustring)">TextField(Int32, Int32, Int32, ustring)</h4>
|
||||
<div class="markdown level1 summary"><p>Public constructor that creates a text field at an absolute position and size.</p>
|
||||
|
||||
@@ -72,7 +72,8 @@
|
||||
|
||||
<h1 id="Terminal_Gui_TextView" data-uid="Terminal.Gui.TextView">Class TextView
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 summary"><p>Multi-line text editing view</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
@@ -225,6 +226,46 @@
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class TextView : Terminal.Gui.View</code></pre>
|
||||
</div>
|
||||
<h5 id="Terminal_Gui_TextView_remarks"><strong>Remarks</strong></h5>
|
||||
<div class="markdown level0 remarks"><p><p>
|
||||
The text view provides a multi-line text view. Users interact
|
||||
with it with the standard Emacs commands for movement or the arrow
|
||||
keys.
|
||||
</p>
|
||||
<table><thead><tr><th>Shortcut</th><th>Action performed</th></tr></thead><tbody><tr><td>Left cursor, Control-b</td><td>
|
||||
Moves the editing point left.
|
||||
</td></tr><tr><td>Right cursor, Control-f</td><td>
|
||||
Moves the editing point right.
|
||||
</td></tr><tr><td>Alt-b</td><td>
|
||||
Moves one word back.
|
||||
</td></tr><tr><td>Alt-f</td><td>
|
||||
Moves one word forward.
|
||||
</td></tr><tr><td>Up cursor, Control-p</td><td>
|
||||
Moves the editing point one line up.
|
||||
</td></tr><tr><td>Down cursor, Control-n</td><td>
|
||||
Moves the editing point one line down
|
||||
</td></tr><tr><td>Home key, Control-a</td><td>
|
||||
Moves the cursor to the beginning of the line.
|
||||
</td></tr><tr><td>End key, Control-e</td><td>
|
||||
Moves the cursor to the end of the line.
|
||||
</td></tr><tr><td>Delete, Control-d</td><td>
|
||||
Deletes the character in front of the cursor.
|
||||
</td></tr><tr><td>Backspace</td><td>
|
||||
Deletes the character behind the cursor.
|
||||
</td></tr><tr><td>Control-k</td><td>
|
||||
Deletes the text until the end of the line and replaces the kill buffer
|
||||
with the deleted text. You can paste this text in a different place by
|
||||
using Control-y.
|
||||
</td></tr><tr><td>Control-y</td><td>
|
||||
Pastes the content of the kill ring into the current position.
|
||||
</td></tr><tr><td>Alt-d</td><td>
|
||||
Deletes the word above the cursor and adds it to the kill ring. You
|
||||
can paste the contents of the kill ring with Control-y.
|
||||
</td></tr><tr><td>Control-q</td><td>
|
||||
Quotes the next input character, to prevent the normal processing of
|
||||
key handling to take place.
|
||||
</td></tr></tbody></table></p>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
|
||||
|
||||
@@ -420,6 +420,18 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_Toplevel_WillPresent_" data-uid="Terminal.Gui.Toplevel.WillPresent*"></a>
|
||||
<h4 id="Terminal_Gui_Toplevel_WillPresent" data-uid="Terminal.Gui.Toplevel.WillPresent">WillPresent()</h4>
|
||||
<div class="markdown level1 summary"><p>This method is invoked by Application.Begin as part of the Application.Run after
|
||||
the views have been laid out, and before the views are drawn for the first time.</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 WillPresent ();</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -84,6 +84,7 @@
|
||||
<div class="level3"><a class="xref" href="Terminal.Gui.Button.html">Button</a></div>
|
||||
<div class="level3"><a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a></div>
|
||||
<div class="level3"><a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a></div>
|
||||
<div class="level3"><a class="xref" href="Terminal.Gui.HexView.html">HexView</a></div>
|
||||
<div class="level3"><a class="xref" href="Terminal.Gui.Label.html">Label</a></div>
|
||||
<div class="level3"><a class="xref" href="Terminal.Gui.ListView.html">ListView</a></div>
|
||||
<div class="level3"><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></div>
|
||||
|
||||
@@ -98,6 +98,9 @@
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Running">Toplevel.Running</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_WillPresent">Toplevel.WillPresent()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
|
||||
</div>
|
||||
|
||||
@@ -76,11 +76,17 @@
|
||||
<a href="Mono.Terminal.html" name="" title="Mono.Terminal">Mono.Terminal</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="Mono.Terminal/Mono.Terminal.IMainLoopDriver.html" name="" title="IMainLoopDriver">IMainLoopDriver</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Mono.Terminal/Mono.Terminal.MainLoop.html" name="" title="MainLoop">MainLoop</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Mono.Terminal/Mono.Terminal.MainLoop.Condition.html" name="" title="MainLoop.Condition">MainLoop.Condition</a>
|
||||
<a href="Mono.Terminal/Mono.Terminal.UnixMainLoop.html" name="" title="UnixMainLoop">UnixMainLoop</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Mono.Terminal/Mono.Terminal.UnixMainLoop.Condition.html" name="" title="UnixMainLoop.Condition">UnixMainLoop.Condition</a>
|
||||
</li>
|
||||
</ul> </li>
|
||||
<li>
|
||||
@@ -130,6 +136,9 @@
|
||||
<li>
|
||||
<a href="Terminal.Gui/Terminal.Gui.FrameView.html" name="" title="FrameView">FrameView</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Terminal.Gui/Terminal.Gui.HexView.html" name="" title="HexView">HexView</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Terminal.Gui/Terminal.Gui.IListDataSource.html" name="" title="IListDataSource">IListDataSource</a>
|
||||
</li>
|
||||
|
||||
Reference in New Issue
Block a user