Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 15:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Miguel de Icaza
2018-02-20 23:08:22 -05:00
parent 46983d43bf
commit c3e45f7cbb
35 changed files with 227 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/Mono.Terminal.html
View File

@@ -83,7 +83,7 @@
<h3 id="enums">Enums
</h3>
<h4><a class="xref" href="Mono.Terminal/Mono.Terminal.MainLoop.Condition.html">MainLoop.Condition</a></h4>
<section><p>Condition on which to wake up from file descriptor activity</p>
<section><p>Condition on which to wake up from file descriptor activity. These match the Linux/BSD poll definitions.</p>
</section>
</article>
</div>

2
docs/api/Mono.Terminal/Mono.Terminal.MainLoop.Condition.html
View File

@@ -72,7 +72,7 @@
<h1 id="Mono_Terminal_MainLoop_Condition" data-uid="Mono.Terminal.MainLoop.Condition">Enum MainLoop.Condition
</h1>
<div class="markdown level0 summary"><p>Condition on which to wake up from file descriptor activity</p>
<div class="markdown level0 summary"><p>Condition on which to wake up from file descriptor activity. These match the Linux/BSD poll definitions.</p>
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="../Mono.Terminal.html">Mono.Terminal</a></h6>

4
docs/api/Mono.Terminal/Mono.Terminal.MainLoop.html
View File

@@ -87,6 +87,10 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class MainLoop</code></pre>
</div>
<h5 id="Mono_Terminal_MainLoop_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>Monitoring of file descriptors is only available on Unix, there
does not seem to be a way of supporting this on Windows.</p>
</div>
<h3 id="constructors">Constructors
</h3>

35
docs/api/Terminal.Gui/Terminal.Gui.Application.html
View File

@@ -280,7 +280,8 @@
<a id="Terminal_Gui_Application_Begin_" data-uid="Terminal.Gui.Application.Begin*"></a>
<h4 id="Terminal_Gui_Application_Begin_Terminal_Gui_Toplevel_" data-uid="Terminal.Gui.Application.Begin(Terminal.Gui.Toplevel)">Begin(Toplevel)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Building block API: Prepares the provided toplevel for execution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -299,7 +300,7 @@
<tr>
<td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
<td><span class="parametername">toplevel</span></td>
<td><p>To be added.</p>
<td><p>Toplevel to prepare execution for.</p>
</td>
</tr>
</tbody>
@@ -315,16 +316,25 @@
<tbody>
<tr>
<td></td>
<td><p>To be added.</p>
<td><p>The runstate handle that needs to be passed to the End() method upon completion.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Application_Begin_Terminal_Gui_Toplevel__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method prepares the provided toplevel for running with the focus,
it adds this to the list of toplevels, sets up the mainloop to process the
event, lays out the subviews, focuses the first element, and draws the
toplevel in the screen. This is usually followed by executing
the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RunLoop_Terminal_Gui_Application_RunState_System_Boolean_">RunLoop(Application+RunState, Boolean)</a> method, and then the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_End_Terminal_Gui_Application_RunState_">End(Application+RunState)</a> method upon termination which will
undo these changes.</p>
</div>
<a id="Terminal_Gui_Application_End_" data-uid="Terminal.Gui.Application.End*"></a>
<h4 id="Terminal_Gui_Application_End_Terminal_Gui_Application_RunState_" data-uid="Terminal.Gui.Application.End(Terminal.Gui.Application.RunState)">End(Application+RunState)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Building block API: completes the exection of a Toplevel that was started with Begin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -504,12 +514,23 @@
<p>
To make a toplevel stop execution, set the &quot;Running&quot;
property to false.
</p>
<p>
This is equivalent to calling Begin on the toplevel view, followed by RunLoop with the
returned value, and then calling end on the return value.
</p>
<p>
Alternatively, if your program needs to control the main loop and needs to
process events manually, you can invoke Begin to set things up manually and then
repeatedly call RunLoop with the wait parameter set to false. By doing this
the RunLoop method will only process any pending events, timers, idle handlers and
then return control immediately.
</p></div>
<a id="Terminal_Gui_Application_RunLoop_" data-uid="Terminal.Gui.Application.RunLoop*"></a>
<h4 id="Terminal_Gui_Application_RunLoop_Terminal_Gui_Application_RunState_System_Boolean_" data-uid="Terminal.Gui.Application.RunLoop(Terminal.Gui.Application.RunState,System.Boolean)">RunLoop(Application+RunState, Boolean)</h4>
<div class="markdown level1 summary"><p>Runs the main loop for the created dialog</p>
<div class="markdown level1 summary"><p>Building block API: Runs the main loop for the created dialog</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
@@ -529,13 +550,13 @@
<tr>
<td></td>
<td><span class="parametername">state</span></td>
<td><p>To be added.</p>
<td><p>The state returned by the Begin method.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">wait</span></td>
<td><p>To be added.</p>
<td><p>By default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events.</p>
</td>
</tr>
</tbody>

8
docs/api/Terminal.Gui/Terminal.Gui.Button.html
View File

@@ -243,7 +243,7 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Button (string s);</code></pre>
<pre><code class="lang-csharp hljs">public Button (string text);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@@ -277,7 +277,7 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Button (string s, bool is_default);</code></pre>
<pre><code class="lang-csharp hljs">public Button (string text, bool is_default);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@@ -318,7 +318,7 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Button (int x, int y, string s);</code></pre>
<pre><code class="lang-csharp hljs">public Button (int x, int y, string text);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@@ -364,7 +364,7 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Button (int x, int y, string s, bool is_default);</code></pre>
<pre><code class="lang-csharp hljs">public Button (int x, int y, string text, bool is_default);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">

14
docs/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html
View File

@@ -657,7 +657,8 @@
<a id="Terminal_Gui_ConsoleDriver_DrawFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame*"></a>
<h4 id="Terminal_Gui_ConsoleDriver_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame(Terminal.Gui.Rect,System.Int32,System.Boolean)">DrawFrame(Rect, Int32, Boolean)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Draws a frame on the specified region with the specified padding around the frame.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -676,19 +677,19 @@
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">region</span></td>
<td><p>To be added.</p>
<td><p>Region where the frame will be drawn..</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">padding</span></td>
<td><p>To be added.</p>
<td><p>Padding to add on the sides.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">fill</span></td>
<td><p>To be added.</p>
<td><p>If set to <code>true</code> it will clear the contents with the current color, otherwise the contents will be left untouched.</p>
</td>
</tr>
</tbody>
@@ -833,7 +834,8 @@
<a id="Terminal_Gui_ConsoleDriver_SetAttribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute*"></a>
<h4 id="Terminal_Gui_ConsoleDriver_SetAttribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute(Terminal.Gui.Attribute)">SetAttribute(Attribute)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Selects the specified attribute as the attribute to use for future calls to AddRune, AddString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -852,7 +854,7 @@
<tr>
<td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
<td><span class="parametername">c</span></td>
<td><p>To be added.</p>
<td><p>C.</p>
</td>
</tr>
</tbody>

2
docs/api/Terminal.Gui/Terminal.Gui.FrameView.html
View File

@@ -364,7 +364,7 @@
<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.Gui.View view);</code></pre>
<pre><code class="lang-csharp hljs">public override void Remove (Terminal.Gui.View view);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">

20
docs/api/Terminal.Gui/Terminal.Gui.ListView.html
View File

@@ -226,6 +226,26 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ListView : Terminal.Gui.View</code></pre>
</div>
<h5 id="Terminal_Gui_ListView_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>
The ListView displays lists of data and allows the user to scroll through the data
and optionally mark elements of the list (controlled by the AllowsMark property).<br> </p>
<p>
The ListView can either render an arbitrary IList object (for example, arrays, List<t>
and other collections) which are drawn by drawing the string/ustring contents or the
result of calling ToString(). Alternatively, you can provide you own IListDataSource
object that gives you full control of what is rendered.
<p>
<p>
The ListView can display any object that implements the System.Collection.IList interface,
string values are converted into ustring values before rendering, and other values are
converted into ustrings by calling ToString() and then converting to ustring.
</p>
<p>
If you must change the contents of the ListView, set the Source property (when you are
providing your own rendering via the IListDataSource implementation) or call SetSource
when you are providing an IList.
</p></t></div>
<h3 id="constructors">Constructors
</h3>

8
docs/api/Terminal.Gui/Terminal.Gui.Responder.html
View File

@@ -163,7 +163,7 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual bool MouseEvent (Terminal.Gui.MouseEvent me);</code></pre>
<pre><code class="lang-csharp hljs">public virtual bool MouseEvent (Terminal.Gui.MouseEvent mouseEvent);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@@ -178,7 +178,7 @@
<tr>
<td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
<td><span class="parametername">me</span></td>
<td><p>Me.</p>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
@@ -211,7 +211,7 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual bool ProcessColdKey (Terminal.Gui.KeyEvent kb);</code></pre>
<pre><code class="lang-csharp hljs">public virtual bool ProcessColdKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@@ -333,7 +333,7 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual bool ProcessKey (Terminal.Gui.KeyEvent kb);</code></pre>
<pre><code class="lang-csharp hljs">public virtual bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">

2
docs/api/Terminal.Gui/Terminal.Gui.Toplevel.html
View File

@@ -363,7 +363,7 @@
<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.Gui.KeyEvent kb);</code></pre>
<pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">

6
docs/api/Terminal.Gui/Terminal.Gui.View.html
View File

@@ -1142,7 +1142,7 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
<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.Gui.KeyEvent kb);</code></pre>
<pre><code class="lang-csharp hljs">public override bool ProcessColdKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@@ -1186,7 +1186,7 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
<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.Gui.KeyEvent kb);</code></pre>
<pre><code class="lang-csharp hljs">public override bool ProcessHotKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@@ -1230,7 +1230,7 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
<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.Gui.KeyEvent kb);</code></pre>
<pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">

4
docs/api/Terminal.Gui/Terminal.Gui.Window.html
View File

@@ -441,7 +441,7 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.Gui.MouseEvent me);</code></pre>
<pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.Gui.MouseEvent mouseEvent);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@@ -514,7 +514,7 @@
<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.Gui.View view);</code></pre>
<pre><code class="lang-csharp hljs">public override void Remove (Terminal.Gui.View view);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">

2
docs/manifest.json
View File

File diff suppressed because one or more lines are too long