Terminal.Gui.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375
  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.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="Terminal.Gui">
  73. <h1 id="Terminal_Gui" data-uid="Terminal.Gui" class="text-break">Namespace Terminal.Gui
  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="Terminal.Gui.Application.html">Application</a></h4>
  81. <section>
  82. The application driver for Terminal.Gui.
  83. </section>
  84. <h4><a class="xref" href="Terminal.Gui.Application.ResizedEventArgs.html">Application.ResizedEventArgs</a></h4>
  85. <section>
  86. Event arguments for the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Resized">Resized</a> event.
  87. </section>
  88. <h4><a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a></h4>
  89. <section>
  90. Captures the execution state for the provided <span class="xref">Terminal.Gui.Application.RunState.Toplevel</span> view.
  91. </section>
  92. <h4><a class="xref" href="Terminal.Gui.Button.html">Button</a></h4>
  93. <section>
  94. Button is a <a class="xref" href="Terminal.Gui.View.html">View</a> that provides an item that invokes an <span class="xref">System.Action</span> when activated by the user.
  95. </section>
  96. <h4><a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a></h4>
  97. <section>
  98. The <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> <a class="xref" href="Terminal.Gui.View.html">View</a> shows an on/off toggle that the user can set
  99. </section>
  100. <h4><a class="xref" href="Terminal.Gui.Clipboard.html">Clipboard</a></h4>
  101. <section>
  102. Provides cut, copy, and paste support for the clipboard.
  103. NOTE: Currently not implemented.
  104. </section>
  105. <h4><a class="xref" href="Terminal.Gui.Colors.html">Colors</a></h4>
  106. <section>
  107. The default <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>s for the application.
  108. </section>
  109. <h4><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></h4>
  110. <section>
  111. Color scheme definitions, they cover some common scenarios and are used
  112. typically in containers such as <a class="xref" href="Terminal.Gui.Window.html">Window</a> and <a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a> to set the scheme that is used by all the
  113. views contained inside.
  114. </section>
  115. <h4><a class="xref" href="Terminal.Gui.ComboBox.html">ComboBox</a></h4>
  116. <section>
  117. ComboBox control
  118. </section>
  119. <h4><a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a></h4>
  120. <section>
  121. ConsoleDriver is an abstract class that defines the requirements for a console driver.
  122. There are currently three implementations: <span class="xref">Terminal.Gui.CursesDriver</span> (for Unix and Mac), <span class="xref">Terminal.Gui.WindowsDriver</span>, and <span class="xref">Terminal.Gui.NetDriver</span> that uses the .NET Console API.
  123. </section>
  124. <h4><a class="xref" href="Terminal.Gui.DateField.html">DateField</a></h4>
  125. <section>
  126. Date editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  127. </section>
  128. <h4><a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a></h4>
  129. <section>
  130. The <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a> <a class="xref" href="Terminal.Gui.View.html">View</a> is a <a class="xref" href="Terminal.Gui.Window.html">Window</a> that by default is centered and contains one
  131. or more <a class="xref" href="Terminal.Gui.Button.html">Button</a>. It defaults to the <a class="xref" href="Terminal.Gui.Colors.html#Terminal_Gui_Colors_Dialog">Dialog</a> color scheme and has a 1 cell padding around the edges.
  132. </section>
  133. <h4><a class="xref" href="Terminal.Gui.Dim.html">Dim</a></h4>
  134. <section>
  135. Dim properties of a <a class="xref" href="Terminal.Gui.View.html">View</a> to control the position.
  136. </section>
  137. <h4><a class="xref" href="Terminal.Gui.FileDialog.html">FileDialog</a></h4>
  138. <section>
  139. Base class for the <a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a> and the <a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a>
  140. </section>
  141. <h4><a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a></h4>
  142. <section>
  143. The FrameView is a container frame that draws a frame around the contents. It is similar to
  144. a GroupBox in Windows.
  145. </section>
  146. <h4><a class="xref" href="Terminal.Gui.HexView.html">HexView</a></h4>
  147. <section>
  148. An hex viewer and editor <a class="xref" href="Terminal.Gui.View.html">View</a> over a <span class="xref">System.IO.Stream</span>
  149. </section>
  150. <h4><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></h4>
  151. <section>
  152. Describes a keyboard event.
  153. </section>
  154. <h4><a class="xref" href="Terminal.Gui.Label.html">Label</a></h4>
  155. <section>
  156. The Label <a class="xref" href="Terminal.Gui.View.html">View</a> displays a string at a given position and supports multiple lines separted by newline characters.
  157. </section>
  158. <h4><a class="xref" href="Terminal.Gui.ListView.html">ListView</a></h4>
  159. <section>
  160. ListView <a class="xref" href="Terminal.Gui.View.html">View</a> renders a scrollable list of data where each item can be activated to perform an action.
  161. </section>
  162. <h4><a class="xref" href="Terminal.Gui.ListViewItemEventArgs.html">ListViewItemEventArgs</a></h4>
  163. <section>
  164. <span class="xref">System.EventArgs</span> for <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> events.
  165. </section>
  166. <h4><a class="xref" href="Terminal.Gui.ListWrapper.html">ListWrapper</a></h4>
  167. <section>
  168. Implements an <a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a> that renders arbitrary <span class="xref">System.Collections.IList</span> instances for <a class="xref" href="Terminal.Gui.ListView.html">ListView</a>.
  169. </section>
  170. <h4><a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a></h4>
  171. <section>
  172. Simple main loop implementation that can be used to monitor
  173. file descriptor, run timers and idle handlers.
  174. </section>
  175. <h4><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></h4>
  176. <section>
  177. The MenuBar provides a menu for Terminal.Gui applications.
  178. </section>
  179. <h4><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a></h4>
  180. <section>
  181. A <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a> contains <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>s or <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>s.
  182. </section>
  183. <h4><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></h4>
  184. <section>
  185. A <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> has a title, an associated help text, and an action to execute on activation.
  186. </section>
  187. <h4><a class="xref" href="Terminal.Gui.MessageBox.html">MessageBox</a></h4>
  188. <section>
  189. MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from.
  190. </section>
  191. <h4><a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a></h4>
  192. <section>
  193. The <a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a>provides an interactive dialog box for users to select files or directories.
  194. </section>
  195. <h4><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></h4>
  196. <section>
  197. Describes the position of a <a class="xref" href="Terminal.Gui.View.html">View</a> which can be an absolute value, a percentage, centered, or
  198. relative to the ending dimension. Integer values are implicitly convertible to
  199. an absolute <a class="xref" href="Terminal.Gui.Pos.html">Pos</a>. These objects are created using the static methods Percent,
  200. AnchorEnd, and Center. The <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> objects can be combined with the addition and
  201. subtraction operators.
  202. </section>
  203. <h4><a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a></h4>
  204. <section>
  205. A Progress Bar view that can indicate progress of an activity visually.
  206. </section>
  207. <h4><a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a></h4>
  208. <section>
  209. <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> shows a group of radio labels, only one of those can be selected at a given time
  210. </section>
  211. <h4><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></h4>
  212. <section>
  213. Responder base class implemented by objects that want to participate on keyboard and mouse input.
  214. </section>
  215. <h4><a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a></h4>
  216. <section>
  217. The <a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a> provides an interactive dialog box for users to pick a file to
  218. save.
  219. </section>
  220. <h4><a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a></h4>
  221. <section>
  222. ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical
  223. </section>
  224. <h4><a class="xref" href="Terminal.Gui.ScrollView.html">ScrollView</a></h4>
  225. <section>
  226. Scrollviews are views that present a window into a virtual space where children views are added. Similar to the iOS UIScrollView.
  227. </section>
  228. <h4><a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a></h4>
  229. <section>
  230. A status bar is a <a class="xref" href="Terminal.Gui.View.html">View</a> that snaps to the bottom of a <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> displaying set of <a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a>s.
  231. The <a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a> should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will
  232. be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help.
  233. So for each context must be a new instance of a statusbar.
  234. </section>
  235. <h4><a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a></h4>
  236. <section>
  237. <a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a> objects are contained by <a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a> <a class="xref" href="Terminal.Gui.View.html">View</a>s.
  238. Each <a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a> has a title, a shortcut (hotkey), and an <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Action">Action</a> that will be invoked when the
  239. <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Shortcut">Shortcut</a> is pressed.
  240. The <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Shortcut">Shortcut</a> will be a global hotkey for the application in the current context of the screen.
  241. The colour of the <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Title">Title</a> will be changed after each ~.
  242. A <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Title">Title</a> set to `~F1~ Help` will render as *F1* using <a class="xref" href="Terminal.Gui.ColorScheme.html#Terminal_Gui_ColorScheme_HotNormal">HotNormal</a> and
  243. *Help* as <a class="xref" href="Terminal.Gui.ColorScheme.html#Terminal_Gui_ColorScheme_HotNormal">HotNormal</a>.
  244. </section>
  245. <h4><a class="xref" href="Terminal.Gui.TextField.html">TextField</a></h4>
  246. <section>
  247. Single-line text entry <a class="xref" href="Terminal.Gui.View.html">View</a>
  248. </section>
  249. <h4><a class="xref" href="Terminal.Gui.TextView.html">TextView</a></h4>
  250. <section>
  251. Multi-line text editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  252. </section>
  253. <h4><a class="xref" href="Terminal.Gui.TimeField.html">TimeField</a></h4>
  254. <section>
  255. Time editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  256. </section>
  257. <h4><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></h4>
  258. <section>
  259. Toplevel views can be modally executed.
  260. </section>
  261. <h4><a class="xref" href="Terminal.Gui.View.html">View</a></h4>
  262. <section>
  263. 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.
  264. </section>
  265. <h4><a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html">View.KeyEventEventArgs</a></h4>
  266. <section>
  267. Specifies the event arguments for <a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html#Terminal_Gui_View_KeyEventEventArgs_KeyEvent">KeyEvent</a>
  268. </section>
  269. <h4><a class="xref" href="Terminal.Gui.Window.html">Window</a></h4>
  270. <section>
  271. A <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> <a class="xref" href="Terminal.Gui.View.html">View</a> that draws a frame around its region and has a &quot;ContentView&quot; subview where the contents are added.
  272. </section>
  273. <h3 id="structs">Structs
  274. </h3>
  275. <h4><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></h4>
  276. <section>
  277. Attributes are used as elements that contain both a foreground and a background or platform specific features
  278. </section>
  279. <h4><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></h4>
  280. <section>
  281. Describes a mouse event
  282. </section>
  283. <h4><a class="xref" href="Terminal.Gui.Point.html">Point</a></h4>
  284. <section>
  285. Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.
  286. </section>
  287. <h4><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></h4>
  288. <section>
  289. Stores a set of four integers that represent the location and size of a rectangle
  290. </section>
  291. <h4><a class="xref" href="Terminal.Gui.Size.html">Size</a></h4>
  292. <section>
  293. Stores an ordered pair of integers, which specify a Height and Width.
  294. </section>
  295. <h3 id="interfaces">Interfaces
  296. </h3>
  297. <h4><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></h4>
  298. <section>
  299. Implement <a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a> to provide custom rendering for a <a class="xref" href="Terminal.Gui.ListView.html">ListView</a>.
  300. </section>
  301. <h4><a class="xref" href="Terminal.Gui.IMainLoopDriver.html">IMainLoopDriver</a></h4>
  302. <section>
  303. Public interface to create your own platform specific main loop driver.
  304. </section>
  305. <h3 id="enums">Enums
  306. </h3>
  307. <h4><a class="xref" href="Terminal.Gui.Color.html">Color</a></h4>
  308. <section>
  309. Basic colors that can be used to set the foreground and background colors in console applications. These can only be
  310. </section>
  311. <h4><a class="xref" href="Terminal.Gui.Key.html">Key</a></h4>
  312. <section>
  313. The <a class="xref" href="Terminal.Gui.Key.html">Key</a> enumeration contains special encoding for some keys, but can also
  314. encode all the unicode values that can be passed.
  315. </section>
  316. <h4><a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a></h4>
  317. <section>
  318. Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the
  319. value from the Frame will be used, if the value is Computer, then the Frame
  320. will be updated from the X, Y Pos objects and the Width and Height Dim objects.
  321. </section>
  322. <h4><a class="xref" href="Terminal.Gui.MouseFlags.html">MouseFlags</a></h4>
  323. <section>
  324. Mouse flags reported in <a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>.
  325. </section>
  326. <h4><a class="xref" href="Terminal.Gui.TextAlignment.html">TextAlignment</a></h4>
  327. <section>
  328. Text alignment enumeration, controls how text is displayed.
  329. </section>
  330. </article>
  331. </div>
  332. <div class="hidden-sm col-md-2" role="complementary">
  333. <div class="sideaffix">
  334. <div class="contribution">
  335. <ul class="nav">
  336. </ul>
  337. </div>
  338. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  339. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  340. </nav>
  341. </div>
  342. </div>
  343. </div>
  344. </div>
  345. <footer>
  346. <div class="grad-bottom"></div>
  347. <div class="footer">
  348. <div class="container">
  349. <span class="pull-right">
  350. <a href="#top">Back to top</a>
  351. </span>
  352. <span>Generated by <strong>DocFX</strong></span>
  353. </div>
  354. </div>
  355. </footer>
  356. </div>
  357. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  358. <script type="text/javascript" src="../../styles/docfx.js"></script>
  359. <script type="text/javascript" src="../../styles/main.js"></script>
  360. </body>
  361. </html>