Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2026-01-01 16:59:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

Version 1.0 (#1227)

Browse Source 
* tweaked version # for v1.0.0-beta.10

* tweaked version # for v1.0.0-beta.11

* Updated readme and revision history for 1.0

* tweaked rel notes

* Regenerated docs for v1.0.0.0

* updating build docs

* updating docs

* updated readme

* updated readme

* more docs

* more docs

* Refactored for clarity

* tweaks

* updated info on versioning

* merged with main. updated relnotes

* updated api docs

* updated README to point to new docs

* adjusting publish workflow

* adjusting publish workflow2

* adjusting publish workflow 3

* adjusting publish workflow 4

* adjusting publish workflow 5

* final fix to yaml

* code coverage docs

* regenerated api docs

* Updated relnotes for v1.0.0-rc.9

* fixed spelling and grammar

* rel notes for v1.0.0-rc.10

* relnotes for v1.0.0-rc.11

* relnotes for v1.0.0-rc.12

* v1.0.0-rc.13

* relnotes, readme, api doc regen

* updated sample.gif
This commit is contained in:
Charlie Kindel
2021-04-28 09:09:51 -07:00
committed by GitHub
parent 028e7e5bf2
commit 19b438ca74
67 changed files with 13621 additions and 1921 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -96,6 +96,7 @@ View is the base class for all views on the screen and represents a visible elem
<div class="level3"><a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a></div>
<div class="level3"><a class="xref" href="Terminal.Gui.ComboBox.html">ComboBox</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.GraphView.html">GraphView</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>
@@ -108,7 +109,7 @@ View is the base class for all views on the screen and represents a visible elem
<div class="level3"><a class="xref" href="Terminal.Gui.TableView.html">TableView</a></div>
<div class="level3"><a class="xref" href="Terminal.Gui.TabView.html">TabView</a></div>
<div class="level3"><a class="xref" href="Terminal.Gui.TextField.html">TextField</a></div>
<div class="level3"><a class="xref" href="Terminal.Gui.TextValidateField-1.html">TextValidateField&lt;T&gt;</a></div>
<div class="level3"><a class="xref" href="Terminal.Gui.TextValidateField.html">TextValidateField</a></div>
<div class="level3"><a class="xref" href="Terminal.Gui.TextView.html">TextView</a></div>
<div class="level3"><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></div>
<div class="level3"><a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a></div>
@@ -500,9 +501,7 @@ control for tasks such as drawing on the surface of the control.
<a id="Terminal_Gui_View_CanFocus_" data-uid="Terminal.Gui.View.CanFocus*"></a>
<h4 id="Terminal_Gui_View_CanFocus" data-uid="Terminal.Gui.View.CanFocus">CanFocus</h4>
<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 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -519,7 +518,7 @@ Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
<td></td>
</tr>
</tbody>
</table>
@@ -678,9 +677,7 @@ Gets or sets the frame for the view. The frame is relative to the view&apos;s co
<a id="Terminal_Gui_View_HasFocus_" data-uid="Terminal.Gui.View.HasFocus*"></a>
<h4 id="Terminal_Gui_View_HasFocus" data-uid="Terminal.Gui.View.HasFocus">HasFocus</h4>
<div class="markdown level1 summary">
Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> has focus.
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -697,7 +694,7 @@ Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><code>true</code> if has focus; otherwise, <code>false</code>.</td>
<td></td>
</tr>
</tbody>
</table>
@@ -1732,9 +1729,7 @@ Sets the <a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a
<a id="Terminal_Gui_View_Dispose_" data-uid="Terminal.Gui.View.Dispose*"></a>
<h4 id="Terminal_Gui_View_Dispose_System_Boolean_" data-uid="Terminal.Gui.View.Dispose(System.Boolean)">Dispose(Boolean)</h4>
<div class="markdown level1 summary">
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -1759,15 +1754,6 @@ Performs application-defined tasks associated with freeing, releasing, or resett
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose_System_Boolean_">Responder.Dispose(Boolean)</a></div>
<h5 id="Terminal_Gui_View_Dispose_System_Boolean__remarks">Remarks</h5>
<div class="markdown level1 remarks">
If disposing equals true, the method has been called directly
or indirectly by a user&apos;s code. Managed and unmanaged resources
can be disposed.
If disposing equals false, the method has been called by the
runtime from inside the finalizer and you should not reference
other objects. Only unmanaged resources can be disposed.
</div>
<a id="Terminal_Gui_View_DrawFrame_" data-uid="Terminal.Gui.View.DrawFrame*"></a>
@@ -2197,9 +2183,7 @@ This method will be called before any subviews added with <a class="xref" href="
<a id="Terminal_Gui_View_OnEnter_" data-uid="Terminal.Gui.View.OnEnter*"></a>
<h4 id="Terminal_Gui_View_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.View.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
<div class="markdown level1 summary">
Method invoked when a view gets focus.
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -2218,7 +2202,7 @@ Method invoked when a view gets focus.
<tr>
<td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
<td><span class="parametername">view</span></td>
<td>The view that is losing focus.</td>
<td></td>
</tr>
</tbody>
</table>
@@ -2233,7 +2217,7 @@ Method invoked when a view gets focus.
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
<td></td>
</tr>
</tbody>
</table>
@@ -2331,9 +2315,7 @@ Method invoked when a view gets focus.
<a id="Terminal_Gui_View_OnLeave_" data-uid="Terminal.Gui.View.OnLeave*"></a>
<h4 id="Terminal_Gui_View_OnLeave_Terminal_Gui_View_" data-uid="Terminal.Gui.View.OnLeave(Terminal.Gui.View)">OnLeave(View)</h4>
<div class="markdown level1 summary">
Method invoked when a view loses focus.
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -2352,7 +2334,7 @@ Method invoked when a view loses focus.
<tr>
<td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
<td><span class="parametername">view</span></td>
<td>The view that is getting focus.</td>
<td></td>
</tr>
</tbody>
</table>
@@ -2367,7 +2349,7 @@ Method invoked when a view loses focus.
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
<td></td>
</tr>
</tbody>
</table>
@@ -2406,9 +2388,7 @@ Invokes the MouseClick event.
<a id="Terminal_Gui_View_OnMouseEnter_" data-uid="Terminal.Gui.View.OnMouseEnter*"></a>
<h4 id="Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.View.OnMouseEnter(Terminal.Gui.MouseEvent)">OnMouseEnter(MouseEvent)</h4>
<div class="markdown level1 summary">
Method invoked when a mouse event is generated for the first time.
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -2442,7 +2422,7 @@ Method invoked when a mouse event is generated for the first time.
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
<td></td>
</tr>
</tbody>
</table>
@@ -2496,9 +2476,7 @@ Method invoked when a mouse event is generated
<a id="Terminal_Gui_View_OnMouseLeave_" data-uid="Terminal.Gui.View.OnMouseLeave*"></a>
<h4 id="Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.View.OnMouseLeave(Terminal.Gui.MouseEvent)">OnMouseLeave(MouseEvent)</h4>
<div class="markdown level1 summary">
Method invoked when a mouse event is generated for the last time.
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -2532,7 +2510,7 @@ Method invoked when a mouse event is generated for the last time.
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
<td></td>
</tr>
</tbody>
</table>
@@ -2583,12 +2561,7 @@ Positions the cursor in the right position based on the currently focused view i
<a id="Terminal_Gui_View_ProcessColdKey_" data-uid="Terminal.Gui.View.ProcessColdKey*"></a>
<h4 id="Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
<div class="markdown level1 summary">
This method can be overwritten by views that
want to provide accelerator functionality
(Alt-key for example), but without
interefering with normal ProcessKey behavior.
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -2607,7 +2580,7 @@ interefering with normal ProcessKey behavior.
<tr>
<td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
<td><span class="parametername">keyEvent</span></td>
<td>Contains the details about the key that produced the event.</td>
<td></td>
</tr>
</tbody>
</table>
@@ -2628,31 +2601,11 @@ interefering with normal ProcessKey behavior.
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_ProcessColdKey_Terminal_Gui_KeyEvent_">Responder.ProcessColdKey(KeyEvent)</a></div>
<h5 id="Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
<div class="markdown level1 remarks">
<p>
After keys are sent to the subviews on the
current view, all the view are
processed and the key is passed to the views
to allow some of them to process the keystroke
as a cold-key. </p>
<p>
This functionality is used, for example, by
default buttons to act on the enter key.
Processing this as a hot-key would prevent
non-default buttons from consuming the enter
keypress when they have the focus.
</p>
</div>
<a id="Terminal_Gui_View_ProcessHotKey_" data-uid="Terminal.Gui.View.ProcessHotKey*"></a>
<h4 id="Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
<div class="markdown level1 summary">
This method can be overwritten by view that
want to provide accelerator functionality
(Alt-key for example).
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -2692,31 +2645,11 @@ want to provide accelerator functionality
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_ProcessHotKey_Terminal_Gui_KeyEvent_">Responder.ProcessHotKey(KeyEvent)</a></div>
<h5 id="Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
<div class="markdown level1 remarks">
<p>
Before keys are sent to the subview on the
current view, all the views are
processed and the key is passed to the widgets
to allow some of them to process the keystroke
as a hot-key. </p>
<p>
For example, if you implement a button that
has a hotkey ok &quot;o&quot;, you would catch the
combination Alt-o here. If the event is
caught, you must return true to stop the
keystroke from being dispatched to other
views.
</p>
</div>
<a id="Terminal_Gui_View_ProcessKey_" data-uid="Terminal.Gui.View.ProcessKey*"></a>
<h4 id="Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
<div class="markdown level1 summary">
If the view is focused, gives the view a
chance to process the keystroke.
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -2735,7 +2668,7 @@ chance to process the keystroke.
<tr>
<td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
<td><span class="parametername">keyEvent</span></td>
<td>Contains the details about the key that produced the event.</td>
<td></td>
</tr>
</tbody>
</table>
@@ -2756,25 +2689,6 @@ chance to process the keystroke.
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_ProcessKey_Terminal_Gui_KeyEvent_">Responder.ProcessKey(KeyEvent)</a></div>
<h5 id="Terminal_Gui_View_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_View_Redraw_" data-uid="Terminal.Gui.View.Redraw*"></a>