|
@@ -437,7 +437,9 @@ Gets or sets the frame for the view. The frame is relative to the view'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"></div>
|
|
|
+ <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 conceptual"></div>
|
|
|
<h5 class="decalaration">Declaration</h5>
|
|
|
<div class="codewrapper">
|
|
@@ -454,7 +456,7 @@ Gets or sets the frame for the view. The frame is relative to the view's co
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
|
- <td></td>
|
|
|
+ <td><code>true</code> if has focus; otherwise, <code>false</code>.</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
@@ -1403,7 +1405,9 @@ 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" data-uid="Terminal.Gui.View.OnEnter">OnEnter()</h4>
|
|
|
- <div class="markdown level1 summary"></div>
|
|
|
+ <div class="markdown level1 summary">
|
|
|
+Method invoked when a view gets focus.
|
|
|
+</div>
|
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
<h5 class="decalaration">Declaration</h5>
|
|
|
<div class="codewrapper">
|
|
@@ -1420,7 +1424,7 @@ This method will be called before any subviews added with <a class="xref" href="
|
|
|
<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>
|
|
@@ -1518,7 +1522,9 @@ This method will be called before any subviews added with <a class="xref" href="
|
|
|
|
|
|
<a id="Terminal_Gui_View_OnLeave_" data-uid="Terminal.Gui.View.OnLeave*"></a>
|
|
|
<h4 id="Terminal_Gui_View_OnLeave" data-uid="Terminal.Gui.View.OnLeave">OnLeave()</h4>
|
|
|
- <div class="markdown level1 summary"></div>
|
|
|
+ <div class="markdown level1 summary">
|
|
|
+Method invoked when a view loses focus.
|
|
|
+</div>
|
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
<h5 class="decalaration">Declaration</h5>
|
|
|
<div class="codewrapper">
|
|
@@ -1535,7 +1541,7 @@ This method will be called before any subviews added with <a class="xref" href="
|
|
|
<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>
|
|
@@ -1545,7 +1551,9 @@ This method will be called before any subviews added with <a class="xref" href="
|
|
|
|
|
|
<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"></div>
|
|
|
+ <div class="markdown level1 summary">
|
|
|
+Method invoked when a mouse event is generated for the first time.
|
|
|
+</div>
|
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
<h5 class="decalaration">Declaration</h5>
|
|
|
<div class="codewrapper">
|
|
@@ -1579,7 +1587,7 @@ This method will be called before any subviews added with <a class="xref" href="
|
|
|
<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>
|
|
@@ -1633,7 +1641,9 @@ 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"></div>
|
|
|
+ <div class="markdown level1 summary">
|
|
|
+Method invoked when a mouse event is generated for the last time.
|
|
|
+</div>
|
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
<h5 class="decalaration">Declaration</h5>
|
|
|
<div class="codewrapper">
|
|
@@ -1667,7 +1677,7 @@ Method invoked when a mouse event is generated
|
|
|
<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>
|
|
@@ -1689,7 +1699,12 @@ 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"></div>
|
|
|
+ <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 conceptual"></div>
|
|
|
<h5 class="decalaration">Declaration</h5>
|
|
|
<div class="codewrapper">
|
|
@@ -1708,7 +1723,7 @@ Positions the cursor in the right position based on the currently focused view i
|
|
|
<tr>
|
|
|
<td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
|
|
|
<td><span class="parametername">keyEvent</span></td>
|
|
|
- <td></td>
|
|
|
+ <td>Contains the details about the key that produced the event.</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
@@ -1729,11 +1744,31 @@ Positions the cursor in the right position based on the currently focused view i
|
|
|
</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"></div>
|
|
|
+ <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 conceptual"></div>
|
|
|
<h5 class="decalaration">Declaration</h5>
|
|
|
<div class="codewrapper">
|
|
@@ -1773,11 +1808,31 @@ Positions the cursor in the right position based on the currently focused view i
|
|
|
</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 "o", 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"></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">
|
|
@@ -1796,7 +1851,7 @@ Positions the cursor in the right position based on the currently focused view i
|
|
|
<tr>
|
|
|
<td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
|
|
|
<td><span class="parametername">keyEvent</span></td>
|
|
|
- <td></td>
|
|
|
+ <td>Contains the details about the key that produced the event.</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
@@ -1817,6 +1872,25 @@ Positions the cursor in the right position based on the currently focused view i
|
|
|
</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>
|