Terminal.Gui.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255
  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 Terminal.Gui
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Namespace Terminal.Gui
  11. ">
  12. <meta name="generator" content="docfx 2.18.2.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. <meta property="docfx:navrel" content="">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../index.html">
  33. <img id="logo" class="svg" src="../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="Terminal.Gui">
  63. <h1 id="Terminal_Gui" data-uid="Terminal.Gui">Namespace Terminal.Gui
  64. </h1>
  65. <div class="markdown level0 summary"></div>
  66. <div class="markdown level0 conceptual"></div>
  67. <div class="markdown level0 remarks"></div>
  68. <h3 id="classes">Classes
  69. </h3>
  70. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Application.html">Application</a></h4>
  71. <section><p>The application driver for gui.cs</p>
  72. </section>
  73. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Application.RunState.html">Application.RunState</a></h4>
  74. <section><p>Captures the execution state for the provided TopLevel view.</p>
  75. </section>
  76. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Button.html">Button</a></h4>
  77. <section><p>Button is a view that provides an item that invokes a callback when activated.</p>
  78. </section>
  79. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.CheckBox.html">CheckBox</a></h4>
  80. <section><p>The Checkbox View shows an on/off toggle that the user can set</p>
  81. </section>
  82. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Clipboard.html">Clipboard</a></h4>
  83. <section></section>
  84. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Colors.html">Colors</a></h4>
  85. <section><p>The default ColorSchemes for the application.</p>
  86. </section>
  87. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.ColorScheme.html">ColorScheme</a></h4>
  88. <section><p>Color scheme definitions, they cover some common scenarios and are used
  89. typically in toplevel containers to set the scheme that is used by all the
  90. views contained inside.</p>
  91. </section>
  92. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a></h4>
  93. <section><p>ConsoleDriver is an abstract class that defines the requirements for a console driver. One implementation if the CursesDriver, and another one uses the .NET Console one.</p>
  94. </section>
  95. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Dialog.html">Dialog</a></h4>
  96. <section><p>The dialog box is a window that by default is centered and contains one
  97. or more buttons.</p>
  98. </section>
  99. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Dim.html">Dim</a></h4>
  100. <section></section>
  101. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.FileDialog.html">FileDialog</a></h4>
  102. <section></section>
  103. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.FrameView.html">FrameView</a></h4>
  104. <section><p>The FrameView is a container frame that draws a frame around the contents</p>
  105. </section>
  106. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Label.html">Label</a></h4>
  107. <section><p>Label view, displays a string at a given position, can include multiple lines.</p>
  108. </section>
  109. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.ListView.html">ListView</a></h4>
  110. <section><p>ListView widget renders a list of data.</p>
  111. </section>
  112. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.MenuBar.html">MenuBar</a></h4>
  113. <section><p>A menu bar for your application.</p>
  114. </section>
  115. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.MenuBarItem.html">MenuBarItem</a></h4>
  116. <section><p>A menu bar item contains other menu items.</p>
  117. </section>
  118. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.MenuItem.html">MenuItem</a></h4>
  119. <section><p>A menu item has a title, an associated help text, and an action to execute on activation.</p>
  120. </section>
  121. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.MessageBox.html">MessageBox</a></h4>
  122. <section><p>Message box displays a modal message to the user, with a title, a message and a series of options that the user can choose from.</p>
  123. </section>
  124. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.OpenDialog.html">OpenDialog</a></h4>
  125. <section></section>
  126. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Pos.html">Pos</a></h4>
  127. <section><p>Describes a position which can be an absolute value, a percentage, centered, or
  128. relative to the ending dimension. Integer values are implicitly convertible to
  129. an absolute Pos. These objects are created using the static methods Percent,
  130. AnchorEnd and Center. The Pos objects can be combined with the addition and
  131. subtraction operators.</p>
  132. </section>
  133. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.ProgressBar.html">ProgressBar</a></h4>
  134. <section><p>Progress bar can indicate progress of an activity visually.</p>
  135. </section>
  136. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.RadioGroup.html">RadioGroup</a></h4>
  137. <section><p>Radio group shows a group of labels, only one of those can be selected at a given time</p>
  138. </section>
  139. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Responder.html">Responder</a></h4>
  140. <section></section>
  141. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.SaveDialog.html">SaveDialog</a></h4>
  142. <section></section>
  143. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.ScrollBarView.html">ScrollBarView</a></h4>
  144. <section><p>ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical</p>
  145. </section>
  146. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.ScrollView.html">ScrollView</a></h4>
  147. <section><p>Scrollviews are views that present a window into a virtual space where children views are added. Similar to the iOS UIScrollView.</p>
  148. </section>
  149. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.TextField.html">TextField</a></h4>
  150. <section><p>Text data entry widget</p>
  151. </section>
  152. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.TextView.html">TextView</a></h4>
  153. <section></section>
  154. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a></h4>
  155. <section><p>Toplevel views can be modally executed.</p>
  156. </section>
  157. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.View.html">View</a></h4>
  158. <section><p>View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.</p>
  159. </section>
  160. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Window.html">Window</a></h4>
  161. <section><p>A toplevel view that draws a frame around its region and has a &quot;ContentView&quot; subview where the contents are added.</p>
  162. </section>
  163. <h3 id="structs">Structs
  164. </h3>
  165. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Attribute.html">Attribute</a></h4>
  166. <section><p>Attributes are used as elements that contain both a foreground and a background or platform specific features</p>
  167. </section>
  168. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.KeyEvent.html">KeyEvent</a></h4>
  169. <section><p>Describes a keyboard event.</p>
  170. </section>
  171. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.MouseEvent.html">MouseEvent</a></h4>
  172. <section><p>Describes a mouse event</p>
  173. </section>
  174. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Point.html">Point</a></h4>
  175. <section><p>Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.</p>
  176. </section>
  177. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Rect.html">Rect</a></h4>
  178. <section><p>Stores a set of four integers that represent the location and size of a rectangle</p>
  179. </section>
  180. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Size.html">Size</a></h4>
  181. <section><p>Stores an ordered pair of integers, which specify a Height and Width.</p>
  182. </section>
  183. <h3 id="interfaces">Interfaces
  184. </h3>
  185. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.IListDataSource.html">IListDataSource</a></h4>
  186. <section><p>Implement this interface to provide your own custom rendering for a list.</p>
  187. </section>
  188. <h3 id="enums">Enums
  189. </h3>
  190. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Color.html">Color</a></h4>
  191. <section><p>Basic colors that can be used to set the foreground and background colors in console applications. These can only be</p>
  192. </section>
  193. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.Key.html">Key</a></h4>
  194. <section><p>The Key enumeration contains special encoding for some keys, but can also
  195. encode all the unicode values that can be passed.</p>
  196. </section>
  197. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.LayoutStyle.html">LayoutStyle</a></h4>
  198. <section><p>Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the
  199. value from the Frame will be used, if the value is Computer, then the Frame
  200. will be updated from the X, Y Pos objets and the Width and Heigh Dim objects.</p>
  201. </section>
  202. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.MouseFlags.html">MouseFlags</a></h4>
  203. <section><p>Mouse flags reported in MouseEvent.</p>
  204. </section>
  205. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.SpecialChar.html">SpecialChar</a></h4>
  206. <section><p>Special characters that can be drawn with Driver.AddSpecial.</p>
  207. </section>
  208. <h4><a class="xref" href="Terminal.Gui/Terminal.Gui.TextAlignment.html">TextAlignment</a></h4>
  209. <section><p>Text alignment enumeration, controls how text is displayed.</p>
  210. </section>
  211. </article>
  212. </div>
  213. <div class="hidden-sm col-md-2" role="complementary">
  214. <div class="sideaffix">
  215. <div class="contribution">
  216. <ul class="nav">
  217. </ul>
  218. </div>
  219. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  220. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  221. </nav>
  222. </div>
  223. </div>
  224. </div>
  225. </div>
  226. <footer>
  227. <div class="grad-bottom"></div>
  228. <div class="footer">
  229. <div class="container">
  230. <span class="pull-right">
  231. <a href="#top">Back to top</a>
  232. </span>
  233. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  234. </div>
  235. </div>
  236. </footer>
  237. </div>
  238. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  239. <script type="text/javascript" src="../styles/docfx.js"></script>
  240. <script type="text/javascript" src="../styles/main.js"></script>
  241. </body>
  242. </html>