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

Updated docs; regeneraged docs (#1881)

Browse Source
This commit is contained in:
Tig Kindel
2022-07-22 20:07:29 -04:00
committed by GitHub
parent ec0822401a
commit fc9e84a429
253 changed files with 23875 additions and 20547 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -90,25 +90,13 @@
<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 <a class="xref" href="UICatalog.Scenario.ScenarioMetadata.html">Scenario.ScenarioMetadata</a> 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 scenario belongs to. If you don&apos;t specify a category the scenario 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_Terminal_Gui_ColorScheme_">Init(Toplevel, ColorScheme)</a> 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>
<section></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>
<section></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>
<section></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>
<section></section>
</article>
</div>