mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 16:27:55 +01:00
168 lines
7.7 KiB
HTML
168 lines
7.7 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Namespace UICatalog
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Namespace UICatalog
|
|
">
|
|
<meta name="generator" content="docfx 2.56.2.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="UICatalog">
|
|
|
|
<h1 id="UICatalog" data-uid="UICatalog" class="text-break">Namespace UICatalog
|
|
</h1>
|
|
<div class="markdown level0 summary"></div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="markdown level0 remarks"></div>
|
|
<h3 id="classes">Classes
|
|
</h3>
|
|
<h4><a class="xref" href="UICatalog.Binding.html">Binding</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="UICatalog.DynamicMenuBarDetails.html">DynamicMenuBarDetails</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="UICatalog.DynamicMenuBarSample.html">DynamicMenuBarSample</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="UICatalog.DynamicMenuItem.html">DynamicMenuItem</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="UICatalog.DynamicMenuItemList.html">DynamicMenuItemList</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="UICatalog.DynamicMenuItemModel.html">DynamicMenuItemModel</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="UICatalog.ListWrapperConverter.html">ListWrapperConverter</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="UICatalog.NumberToWords.html">NumberToWords</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="UICatalog.Scenario.html">Scenario</a></h4>
|
|
<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'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't specify a category the sceanrio will show up in "All".</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
|
|
ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. /
|
|
</p>
|
|
</section>
|
|
<h4><a class="xref" href="UICatalog.Scenario.ScenarioCategory.html">Scenario.ScenarioCategory</a></h4>
|
|
<section><p>Defines the category names used to catagorize a <a class="xref" href="UICatalog.Scenario.html">Scenario</a></p>
|
|
</section>
|
|
<h4><a class="xref" href="UICatalog.Scenario.ScenarioMetadata.html">Scenario.ScenarioMetadata</a></h4>
|
|
<section><p>Defines the metadata (Name and Description) for a <a class="xref" href="UICatalog.Scenario.html">Scenario</a></p>
|
|
</section>
|
|
<h4><a class="xref" href="UICatalog.UICatalogApp.html">UICatalogApp</a></h4>
|
|
<section><p>UI Catalog is a comprehensive sample app and scenario library for <a class="xref" href="../Terminal.Gui/Terminal.Gui.html">Terminal.Gui</a></p>
|
|
</section>
|
|
<h4><a class="xref" href="UICatalog.UStringValueConverter.html">UStringValueConverter</a></h4>
|
|
<section></section>
|
|
<h3 id="interfaces">Interfaces
|
|
</h3>
|
|
<h4><a class="xref" href="UICatalog.IValueConverter.html">IValueConverter</a></h4>
|
|
<section></section>
|
|
</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>
|