UICatalog.html 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Namespace UICatalog
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Namespace UICatalog
  11. ">
  12. <meta name="generator" content="docfx 2.54.0.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../../">
  21. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="UICatalog">
  73. <h1 id="UICatalog" data-uid="UICatalog" class="text-break">Namespace UICatalog
  74. </h1>
  75. <div class="markdown level0 summary"></div>
  76. <div class="markdown level0 conceptual"></div>
  77. <div class="markdown level0 remarks"></div>
  78. <h3 id="classes">Classes
  79. </h3>
  80. <h4><a class="xref" href="UICatalog.Scenario.html">Scenario</a></h4>
  81. <section><p>Base class for each demo/scenario.</p>
  82. <p>
  83. To define a new scenario:
  84. <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>
  85. </p>
  86. <p>
  87. The UI Catalog program uses reflection to find all scenarios and adds them to the
  88. ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. /
  89. </p>
  90. </section>
  91. <h4><a class="xref" href="UICatalog.Scenario.ScenarioCategory.html">Scenario.ScenarioCategory</a></h4>
  92. <section><p>Defines the category names used to catagorize a <a class="xref" href="UICatalog.Scenario.html">Scenario</a></p>
  93. </section>
  94. <h4><a class="xref" href="UICatalog.Scenario.ScenarioMetadata.html">Scenario.ScenarioMetadata</a></h4>
  95. <section><p>Defines the metadata (Name and Description) for a <a class="xref" href="UICatalog.Scenario.html">Scenario</a></p>
  96. </section>
  97. <h4><a class="xref" href="UICatalog.UICatalogApp.html">UICatalogApp</a></h4>
  98. <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>
  99. </section>
  100. </article>
  101. </div>
  102. <div class="hidden-sm col-md-2" role="complementary">
  103. <div class="sideaffix">
  104. <div class="contribution">
  105. <ul class="nav">
  106. </ul>
  107. </div>
  108. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  109. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  110. </nav>
  111. </div>
  112. </div>
  113. </div>
  114. </div>
  115. <footer>
  116. <div class="grad-bottom"></div>
  117. <div class="footer">
  118. <div class="container">
  119. <span class="pull-right">
  120. <a href="#top">Back to top</a>
  121. </span>
  122. <span>Generated by <strong>DocFX</strong></span>
  123. </div>
  124. </div>
  125. </footer>
  126. </div>
  127. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  128. <script type="text/javascript" src="../../styles/docfx.js"></script>
  129. <script type="text/javascript" src="../../styles/main.js"></script>
  130. </body>
  131. </html>