Fix 1130 broken links (#1131)

* fixed table & treeview docs

* regen docs

* relnote
This commit is contained in:
Charlie Kindel
2021-03-09 12:36:37 -07:00
committed by GitHub
parent 1cf2ce1985
commit 4da9ad0e89
51 changed files with 586 additions and 1511 deletions

View File

@@ -84,7 +84,9 @@
<h1 id="Terminal_Gui_TableView" data-uid="Terminal.Gui.TableView" class="text-break">Class TableView
</h1>
<div class="markdown level0 summary">
View for tabular data based on a <span class="xref">System.Data.DataTable</span>
View for tabular data based on a <span class="xref">System.Data.DataTable</span>.
<a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
@@ -1056,9 +1058,7 @@ Returns true if the given cell is selected either because it is the active cell
<a id="Terminal_Gui_TableView_MouseEvent_" data-uid="Terminal.Gui.TableView.MouseEvent*"></a>
<h4 id="Terminal_Gui_TableView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TableView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
<div class="markdown level1 summary">
Method invoked when a mouse event is generated
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -1092,7 +1092,7 @@ Method invoked when a mouse event is generated
<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>
@@ -1174,10 +1174,7 @@ Positions the cursor in the area of the screen in which the start of the active
<a id="Terminal_Gui_TableView_ProcessKey_" data-uid="Terminal.Gui.TableView.ProcessKey*"></a>
<h4 id="Terminal_Gui_TableView_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TableView.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">
@@ -1196,7 +1193,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>
@@ -1217,32 +1214,11 @@ chance to process the keystroke.
</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_TableView_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_TableView_Redraw_" data-uid="Terminal.Gui.TableView.Redraw*"></a>
<h4 id="Terminal_Gui_TableView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TableView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
<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 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@@ -1261,26 +1237,12 @@ Redraws this view and its subviews; only redraws the views that have been flagge
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">bounds</span></td>
<td>The bounds (view-relative region) to redraw.</td>
<td></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_TableView_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_TableView_ScreenToCell_" data-uid="Terminal.Gui.TableView.ScreenToCell*"></a>