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

tweaked api docs; adjusted enum name to match LayoutStyle

Browse Source
This commit is contained in:
Charlie Kindel
2020-06-07 00:09:07 -06:00
parent eb15c82367
commit 1b5549bc07
17 changed files with 1119 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

237
docs/api/Terminal.Gui/Terminal.Gui.ColorScheme.html
View File

@@ -94,17 +94,15 @@ views contained inside.
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">ColorScheme</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IEquatable</span>&lt;<a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>&gt;</div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
@@ -122,7 +120,7 @@ views contained inside.
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_ColorScheme_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ColorScheme</code></pre>
<pre><code class="lang-csharp hljs">public class ColorScheme : IEquatable&lt;ColorScheme&gt;</code></pre>
</div>
<h3 id="properties">Properties
</h3>
@@ -261,6 +259,231 @@ The default color for text, when the view is not focused.
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Terminal_Gui_ColorScheme_Equals_" data-uid="Terminal.Gui.ColorScheme.Equals*"></a>
<h4 id="Terminal_Gui_ColorScheme_Equals_System_Object_" data-uid="Terminal.Gui.ColorScheme.Equals(System.Object)">Equals(Object)</h4>
<div class="markdown level1 summary">
Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for equality.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool Equals(object obj)</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.Object</span></td>
<td><span class="parametername">obj</span></td>
<td></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><span class="xref">System.Boolean</span></td>
<td>true if the two objects are equal</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.Object.Equals(System.Object)</span></div>
<a id="Terminal_Gui_ColorScheme_Equals_" data-uid="Terminal.Gui.ColorScheme.Equals*"></a>
<h4 id="Terminal_Gui_ColorScheme_Equals_Terminal_Gui_ColorScheme_" data-uid="Terminal.Gui.ColorScheme.Equals(Terminal.Gui.ColorScheme)">Equals(ColorScheme)</h4>
<div class="markdown level1 summary">
Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for equality.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Equals(ColorScheme other)</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><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
<td><span class="parametername">other</span></td>
<td></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><span class="xref">System.Boolean</span></td>
<td>true if the two objects are equal</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_ColorScheme_GetHashCode_" data-uid="Terminal.Gui.ColorScheme.GetHashCode*"></a>
<h4 id="Terminal_Gui_ColorScheme_GetHashCode" data-uid="Terminal.Gui.ColorScheme.GetHashCode">GetHashCode()</h4>
<div class="markdown level1 summary">
Returns a hashcode for this instance.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
</div>
<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><span class="xref">System.Int32</span></td>
<td>hashcode for this instance</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.Object.GetHashCode()</span></div>
<h3 id="operators">Operators
</h3>
<a id="Terminal_Gui_ColorScheme_op_Equality_" data-uid="Terminal.Gui.ColorScheme.op_Equality*"></a>
<h4 id="Terminal_Gui_ColorScheme_op_Equality_Terminal_Gui_ColorScheme_Terminal_Gui_ColorScheme_" data-uid="Terminal.Gui.ColorScheme.op_Equality(Terminal.Gui.ColorScheme,Terminal.Gui.ColorScheme)">Equality(ColorScheme, ColorScheme)</h4>
<div class="markdown level1 summary">
Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for equality.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool operator ==(ColorScheme left, ColorScheme right)</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><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
<td><span class="parametername">left</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
<td><span class="parametername">right</span></td>
<td></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><span class="xref">System.Boolean</span></td>
<td><code>true</code> if the two objects are equivalent</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_ColorScheme_op_Inequality_" data-uid="Terminal.Gui.ColorScheme.op_Inequality*"></a>
<h4 id="Terminal_Gui_ColorScheme_op_Inequality_Terminal_Gui_ColorScheme_Terminal_Gui_ColorScheme_" data-uid="Terminal.Gui.ColorScheme.op_Inequality(Terminal.Gui.ColorScheme,Terminal.Gui.ColorScheme)">Inequality(ColorScheme, ColorScheme)</h4>
<div class="markdown level1 summary">
Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for inequality.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool operator !=(ColorScheme left, ColorScheme right)</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><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
<td><span class="parametername">left</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
<td><span class="parametername">right</span></td>
<td></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><span class="xref">System.Boolean</span></td>
<td><code>true</code> if the two objects are not equivalent</td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IEquatable&lt;T&gt;</span>
</div>
</article>
</div>

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

@@ -116,6 +116,12 @@ A <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a> contains
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_IsEnabled">MenuItem.IsEnabled()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Checked">MenuItem.Checked</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_CheckType">MenuItem.CheckType</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_GetMenuItem">MenuItem.GetMenuItem()</a>
</div>

162
docs/api/Terminal.Gui/Terminal.Gui.MenuItem.MenuItemCheckType.html Normal file
View File

@@ -0,0 +1,162 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Enum MenuItem.MenuItemCheckType
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Enum MenuItem.MenuItemCheckType
">
<meta name="generator" content="docfx 2.54.0.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Terminal.Gui.MenuItem.MenuItemCheckType">
<h1 id="Terminal_Gui_MenuItem_MenuItemCheckType" data-uid="Terminal.Gui.MenuItem.MenuItemCheckType" class="text-break">Enum MenuItem.MenuItemCheckType
</h1>
<div class="markdown level0 summary">
Specifies how a <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> shows selection state.
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_MenuItem_MenuItemCheckType_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Flags]
public enum MenuItemCheckType : uint</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<thead>
<tbody>
<tr>
<td id="Terminal_Gui_MenuItem_MenuItemCheckType_Checked">Checked</td>
<td>
The menu item will indicate checked/un-checked state (see <a class="xref" href="Terminal.Gui.MenuItem.MenuItemCheckType.html#Terminal_Gui_MenuItem_MenuItemCheckType_Checked">Checked</a>.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MenuItem_MenuItemCheckType_NoCheck">NoCheck</td>
<td>
The menu item will be shown normally, with no check indicator.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MenuItem_MenuItemCheckType_Radio">Radio</td>
<td>
The menu item is part of a menu radio group (see <a class="xref" href="Terminal.Gui.MenuItem.MenuItemCheckType.html#Terminal_Gui_MenuItem_MenuItemCheckType_Checked">Checked</a> and will indicate selected state.
</td>
</tr>
</tbody>
</thead></thead></table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>

54
docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html
View File

@@ -329,6 +329,60 @@ Gets or sets the action to be invoked if the menu can be triggered
</table>
<a id="Terminal_Gui_MenuItem_Checked_" data-uid="Terminal.Gui.MenuItem.Checked*"></a>
<h4 id="Terminal_Gui_MenuItem_Checked" data-uid="Terminal.Gui.MenuItem.Checked">Checked</h4>
<div class="markdown level1 summary">
Sets or gets whether the <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> shows a check indicator or not. See <a class="xref" href="Terminal.Gui.MenuItemCheckStyle.html">MenuItemCheckStyle</a>.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Checked { get; set; }</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">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_MenuItem_CheckType_" data-uid="Terminal.Gui.MenuItem.CheckType*"></a>
<h4 id="Terminal_Gui_MenuItem_CheckType" data-uid="Terminal.Gui.MenuItem.CheckType">CheckType</h4>
<div class="markdown level1 summary">
Sets or gets the type selection indicator the menu item will be displayed with.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MenuItemCheckStyle CheckType { get; set; }</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="Terminal.Gui.MenuItemCheckStyle.html">MenuItemCheckStyle</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_MenuItem_Help_" data-uid="Terminal.Gui.MenuItem.Help*"></a>
<h4 id="Terminal_Gui_MenuItem_Help" data-uid="Terminal.Gui.MenuItem.Help">Help</h4>
<div class="markdown level1 summary">

162
docs/api/Terminal.Gui/Terminal.Gui.MenuItemCheckStyle.html Normal file
View File

@@ -0,0 +1,162 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Enum MenuItemCheckStyle
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Enum MenuItemCheckStyle
">
<meta name="generator" content="docfx 2.54.0.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Terminal.Gui.MenuItemCheckStyle">
<h1 id="Terminal_Gui_MenuItemCheckStyle" data-uid="Terminal.Gui.MenuItemCheckStyle" class="text-break">Enum MenuItemCheckStyle
</h1>
<div class="markdown level0 summary">
Specifies how a <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> shows selection state.
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_MenuItemCheckStyle_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Flags]
public enum MenuItemCheckStyle</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<thead>
<tbody>
<tr>
<td id="Terminal_Gui_MenuItemCheckStyle_Checked">Checked</td>
<td>
The menu item will indicate checked/un-checked state (see <a class="xref" href="Terminal.Gui.MenuItemCheckStyle.html#Terminal_Gui_MenuItemCheckStyle_Checked">Checked</a>.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MenuItemCheckStyle_NoCheck">NoCheck</td>
<td>
The menu item will be shown normally, with no check indicator.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MenuItemCheckStyle_Radio">Radio</td>
<td>
The menu item is part of a menu radio group (see <a class="xref" href="Terminal.Gui.MenuItemCheckStyle.html#Terminal_Gui_MenuItemCheckStyle_Checked">Checked</a> and will indicate selected state.
</td>
</tr>
</tbody>
</thead></thead></table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>

162
docs/api/Terminal.Gui/Terminal.Gui.MenuItemCheckType.html Normal file
View File

@@ -0,0 +1,162 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Enum MenuItemCheckType
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Enum MenuItemCheckType
">
<meta name="generator" content="docfx 2.54.0.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Terminal.Gui.MenuItemCheckType">
<h1 id="Terminal_Gui_MenuItemCheckType" data-uid="Terminal.Gui.MenuItemCheckType" class="text-break">Enum MenuItemCheckType
</h1>
<div class="markdown level0 summary">
Specifies how a <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> shows selection state.
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_MenuItemCheckType_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Flags]
public enum MenuItemCheckType : uint</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<thead>
<tbody>
<tr>
<td id="Terminal_Gui_MenuItemCheckType_Checked">Checked</td>
<td>
The menu item will indicate checked/un-checked state (see <a class="xref" href="Terminal.Gui.MenuItemCheckType.html#Terminal_Gui_MenuItemCheckType_Checked">Checked</a>.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MenuItemCheckType_NoCheck">NoCheck</td>
<td>
The menu item will be shown normally, with no check indicator.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MenuItemCheckType_Radio">Radio</td>
<td>
The menu item is part of a menu radio group (see <a class="xref" href="Terminal.Gui.MenuItemCheckType.html#Terminal_Gui_MenuItemCheckType_Checked">Checked</a> and will indicate selected state.
</td>
</tr>
</tbody>
</thead></thead></table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>

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

@@ -348,6 +348,10 @@ encode all the unicode values that can be passed.
Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the
value from the Frame will be used, if the value is Computed, then the Frame
will be updated from the X, Y Pos objects and the Width and Height Dim objects.
</section>
<h4><a class="xref" href="Terminal.Gui.MenuItemCheckStyle.html">MenuItemCheckStyle</a></h4>
<section>
Specifies how a <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> shows selection state.
</section>
<h4><a class="xref" href="Terminal.Gui.MouseFlags.html">MouseFlags</a></h4>
<section>

3
docs/api/Terminal.Gui/toc.html
View File

@@ -116,6 +116,9 @@
<li>
<a href="Terminal.Gui.MenuItem.html" name="" title="MenuItem">MenuItem</a>
</li>
<li>
<a href="Terminal.Gui.MenuItemCheckStyle.html" name="" title="MenuItemCheckStyle">MenuItemCheckStyle</a>
</li>
<li>
<a href="Terminal.Gui.MessageBox.html" name="" title="MessageBox">MessageBox</a>
</li>

19
docs/api/UICatalog/UICatalog.Scenario.html
View File

@@ -86,7 +86,7 @@
<div class="markdown level0 summary"><p>Base class for each demo/scenario.</p>
<p>
To define a new scenario:
<ol><li>Create a new <code>.cs</code> file in the <cs>Scenarios</cs> directory that derives from <a class="xref" href="UICatalog.Scenario.html">Scenario</a>.</li><li>Annotate the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> derived class with a <see cref="!:Scenario.ScenarioMetaData"></see> attribute specifying the scenario&apos;s name and description.</li><li>Add one or more <a class="xref" href="UICatalog.Scenario.ScenarioCategory.html">Scenario.ScenarioCategory</a> attributes to the class specifying which categories the sceanrio belongs to. If you don&apos;t specify a category the sceanrio will show up in &quot;All&quot;.</li><li>Implement the <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Setup">Setup()</a> override which will be called when a user selects the scenario to run.</li><li>Optionally, implement the <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Init_Terminal_Gui_Toplevel_">Init(Toplevel)</a> and/or <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Run">Run()</a> overrides to provide a custom implementation.</li></ol>
<ol><li>Create a new <code>.cs</code> file in the <cs>Scenarios</cs> directory that derives from <a class="xref" href="UICatalog.Scenario.html">Scenario</a>.</li><li>Annotate the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> derived class with a <see cref="!:Scenario.ScenarioMetaData"></see> attribute specifying the scenario&apos;s name and description.</li><li>Add one or more <a class="xref" href="UICatalog.Scenario.ScenarioCategory.html">Scenario.ScenarioCategory</a> attributes to the class specifying which categories the sceanrio belongs to. If you don&apos;t specify a category the sceanrio will show up in &quot;All&quot;.</li><li>Implement the <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Setup">Setup()</a> override which will be called when a user selects the scenario to run.</li><li>Optionally, implement the <see cref="!:Init(Toplevel)"></see> and/or <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Run">Run()</a> overrides to provide a custom implementation.</li></ol>
</p>
<p>
The UI Catalog program uses reflection to find all scenarios and adds them to the
@@ -325,16 +325,16 @@ namespace UICatalog {
<a id="UICatalog_Scenario_Init_" data-uid="UICatalog.Scenario.Init*"></a>
<h4 id="UICatalog_Scenario_Init_Terminal_Gui_Toplevel_" data-uid="UICatalog.Scenario.Init(Terminal.Gui.Toplevel)">Init(Toplevel)</h4>
<h4 id="UICatalog_Scenario_Init_Terminal_Gui_Toplevel_Terminal_Gui_ColorScheme_" data-uid="UICatalog.Scenario.Init(Terminal.Gui.Toplevel,Terminal.Gui.ColorScheme)">Init(Toplevel, ColorScheme)</h4>
<div class="markdown level1 summary"><p>Helper that provides the default <a class="xref" href="../Terminal.Gui/Terminal.Gui.Window.html">Window</a> implementation with a frame and
label showing the name of the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> and logic to exit back to
the Scenario picker UI.
Override <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Init_Terminal_Gui_Toplevel_">Init(Toplevel)</a> to provide any <a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a> behavior needed.</p>
Override <see cref="!:Init(Toplevel)"></see> to provide any <a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a> behavior needed.</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 Init(Toplevel top)</code></pre>
<pre><code class="lang-csharp hljs">public virtual void Init(Toplevel top, ColorScheme colorScheme)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@@ -349,11 +349,18 @@ Override <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Init_T
<tr>
<td><a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a></td>
<td><span class="parametername">top</span></td>
<td></td>
<td><p>The Toplevel created by the UI Catalog host.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="../Terminal.Gui/Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
<td><span class="parametername">colorScheme</span></td>
<td><p>The colorscheme to use.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="UICatalog_Scenario_Init_Terminal_Gui_Toplevel__remarks">Remarks</h5>
<h5 id="UICatalog_Scenario_Init_Terminal_Gui_Toplevel_Terminal_Gui_ColorScheme__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>
Thg base implementation calls <a class="xref" href="../Terminal.Gui/Terminal.Gui.Application.html#Terminal_Gui_Application_Init">Init()</a>, sets <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Top">Top</a> to the passed in <a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a>, creates a <a class="xref" href="../Terminal.Gui/Terminal.Gui.Window.html">Window</a> for <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Win">Win</a> and adds it to <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Top">Top</a>.
</p>

2
docs/api/UICatalog/UICatalog.html
View File

@@ -91,7 +91,7 @@
<section><p>Base class for each demo/scenario.</p>
<p>
To define a new scenario:
<ol><li>Create a new <code>.cs</code> file in the <cs>Scenarios</cs> directory that derives from <a class="xref" href="UICatalog.Scenario.html">Scenario</a>.</li><li>Annotate the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> derived class with a <see cref="!:Scenario.ScenarioMetaData"></see> attribute specifying the scenario&apos;s name and description.</li><li>Add one or more <a class="xref" href="UICatalog.Scenario.ScenarioCategory.html">Scenario.ScenarioCategory</a> attributes to the class specifying which categories the sceanrio belongs to. If you don&apos;t specify a category the sceanrio will show up in &quot;All&quot;.</li><li>Implement the <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Setup">Setup()</a> override which will be called when a user selects the scenario to run.</li><li>Optionally, implement the <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Init_Terminal_Gui_Toplevel_">Init(Toplevel)</a> and/or <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Run">Run()</a> overrides to provide a custom implementation.</li></ol>
<ol><li>Create a new <code>.cs</code> file in the <cs>Scenarios</cs> directory that derives from <a class="xref" href="UICatalog.Scenario.html">Scenario</a>.</li><li>Annotate the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> derived class with a <see cref="!:Scenario.ScenarioMetaData"></see> attribute specifying the scenario&apos;s name and description.</li><li>Add one or more <a class="xref" href="UICatalog.Scenario.ScenarioCategory.html">Scenario.ScenarioCategory</a> attributes to the class specifying which categories the sceanrio belongs to. If you don&apos;t specify a category the sceanrio will show up in &quot;All&quot;.</li><li>Implement the <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Setup">Setup()</a> override which will be called when a user selects the scenario to run.</li><li>Optionally, implement the <see cref="!:Init(Toplevel)"></see> and/or <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Run">Run()</a> overrides to provide a custom implementation.</li></ol>
</p>
<p>
The UI Catalog program uses reflection to find all scenarios and adds them to the