2
0

Terminal.Gui.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538
  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.56.7.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="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <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">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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. A static, singelton class provding the main application driver for Terminal.Gui apps.
  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.CellActivatedEventArgs.html">CellActivatedEventArgs</a></h4>
  97. <section>
  98. Defines the event arguments for <a class="xref" href="Terminal.Gui.TableView.html#Terminal_Gui_TableView_CellActivated">CellActivated</a> event
  99. </section>
  100. <h4><a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a></h4>
  101. <section>
  102. 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
  103. </section>
  104. <h4><a class="xref" href="Terminal.Gui.Clipboard.html">Clipboard</a></h4>
  105. <section>
  106. Provides cut, copy, and paste support for the clipboard.
  107. NOTE: Currently not implemented.
  108. </section>
  109. <h4><a class="xref" href="Terminal.Gui.Colors.html">Colors</a></h4>
  110. <section>
  111. The default <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>s for the application.
  112. </section>
  113. <h4><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></h4>
  114. <section>
  115. Color scheme definitions, they cover some common scenarios and are used
  116. 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
  117. views contained inside.
  118. </section>
  119. <h4><a class="xref" href="Terminal.Gui.ColumnStyle.html">ColumnStyle</a></h4>
  120. <section>
  121. Describes how to render a given column in a <a class="xref" href="Terminal.Gui.TableView.html">TableView</a> including <a class="xref" href="Terminal.Gui.ColumnStyle.html#Terminal_Gui_ColumnStyle_Alignment">Alignment</a>
  122. and textual representation of cells (e.g. date formats)
  123. <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
  124. </section>
  125. <h4><a class="xref" href="Terminal.Gui.ComboBox.html">ComboBox</a></h4>
  126. <section>
  127. ComboBox control
  128. </section>
  129. <h4><a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a></h4>
  130. <section>
  131. ConsoleDriver is an abstract class that defines the requirements for a console driver.
  132. 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.
  133. </section>
  134. <h4><a class="xref" href="Terminal.Gui.DateField.html">DateField</a></h4>
  135. <section>
  136. Simple Date editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  137. </section>
  138. <h4><a class="xref" href="Terminal.Gui.DateTimeEventArgs-1.html">DateTimeEventArgs&lt;T&gt;</a></h4>
  139. <section>
  140. Defines the event arguments for <a class="xref" href="Terminal.Gui.DateField.html#Terminal_Gui_DateField_DateChanged">DateChanged</a> and <a class="xref" href="Terminal.Gui.TimeField.html#Terminal_Gui_TimeField_TimeChanged">TimeChanged</a> events.
  141. </section>
  142. <h4><a class="xref" href="Terminal.Gui.DelegateTreeBuilder-1.html">DelegateTreeBuilder&lt;T&gt;</a></h4>
  143. <section>
  144. Implementation of <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a> that uses user defined functions
  145. </section>
  146. <h4><a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a></h4>
  147. <section>
  148. 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
  149. or more <a class="xref" href="Terminal.Gui.Button.html">Button</a>s. 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.
  150. </section>
  151. <h4><a class="xref" href="Terminal.Gui.Dim.html">Dim</a></h4>
  152. <section>
  153. Dim properties of a <a class="xref" href="Terminal.Gui.View.html">View</a> to control the position.
  154. </section>
  155. <h4><a class="xref" href="Terminal.Gui.FakeConsole.html">FakeConsole</a></h4>
  156. <section>
  157. </section>
  158. <h4><a class="xref" href="Terminal.Gui.FakeDriver.html">FakeDriver</a></h4>
  159. <section>
  160. Implements a mock ConsoleDriver for unit testing
  161. </section>
  162. <h4><a class="xref" href="Terminal.Gui.FakeMainLoop.html">FakeMainLoop</a></h4>
  163. <section>
  164. Mainloop intended to be used with the .NET System.Console API, and can
  165. be used on Windows and Unix, it is cross platform but lacks things like
  166. file descriptor monitoring.
  167. </section>
  168. <h4><a class="xref" href="Terminal.Gui.FileDialog.html">FileDialog</a></h4>
  169. <section>
  170. 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>
  171. </section>
  172. <h4><a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a></h4>
  173. <section>
  174. The FrameView is a container frame that draws a frame around the contents. It is similar to
  175. a GroupBox in Windows.
  176. </section>
  177. <h4><a class="xref" href="Terminal.Gui.HexView.html">HexView</a></h4>
  178. <section>
  179. An hex viewer and editor <a class="xref" href="Terminal.Gui.View.html">View</a> over a <span class="xref">System.IO.Stream</span>
  180. </section>
  181. <h4><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></h4>
  182. <section>
  183. Describes a keyboard event.
  184. </section>
  185. <h4><a class="xref" href="Terminal.Gui.KeyModifiers.html">KeyModifiers</a></h4>
  186. <section>
  187. Identifies the state of the &quot;shift&quot;-keys within a event.
  188. </section>
  189. <h4><a class="xref" href="Terminal.Gui.Label.html">Label</a></h4>
  190. <section>
  191. 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. Multi-line Labels support word wrap.
  192. </section>
  193. <h4><a class="xref" href="Terminal.Gui.ListView.html">ListView</a></h4>
  194. <section>
  195. 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.
  196. </section>
  197. <h4><a class="xref" href="Terminal.Gui.ListViewItemEventArgs.html">ListViewItemEventArgs</a></h4>
  198. <section>
  199. <span class="xref">System.EventArgs</span> for <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> events.
  200. </section>
  201. <h4><a class="xref" href="Terminal.Gui.ListWrapper.html">ListWrapper</a></h4>
  202. <section>
  203. 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>.
  204. </section>
  205. <h4><a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a></h4>
  206. <section>
  207. Simple main loop implementation that can be used to monitor
  208. file descriptor, run timers and idle handlers.
  209. </section>
  210. <h4><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></h4>
  211. <section>
  212. The MenuBar provides a menu for Terminal.Gui applications.
  213. </section>
  214. <h4><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a></h4>
  215. <section>
  216. 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.
  217. </section>
  218. <h4><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></h4>
  219. <section>
  220. 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.
  221. </section>
  222. <h4><a class="xref" href="Terminal.Gui.MessageBox.html">MessageBox</a></h4>
  223. <section>
  224. MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from.
  225. </section>
  226. <h4><a class="xref" href="Terminal.Gui.ObjectActivatedEventArgs-1.html">ObjectActivatedEventArgs&lt;T&gt;</a></h4>
  227. <section>
  228. Event args for the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ObjectActivated">ObjectActivated</a> event
  229. </section>
  230. <h4><a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a></h4>
  231. <section>
  232. The <a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a>provides an interactive dialog box for users to select files or directories.
  233. </section>
  234. <h4><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></h4>
  235. <section>
  236. 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
  237. relative to the ending dimension. Integer values are implicitly convertible to
  238. an absolute <a class="xref" href="Terminal.Gui.Pos.html">Pos</a>. These objects are created using the static methods Percent,
  239. AnchorEnd, and Center. The <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> objects can be combined with the addition and
  240. subtraction operators.
  241. </section>
  242. <h4><a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a></h4>
  243. <section>
  244. A Progress Bar view that can indicate progress of an activity visually.
  245. </section>
  246. <h4><a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a></h4>
  247. <section>
  248. <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
  249. </section>
  250. <h4><a class="xref" href="Terminal.Gui.RadioGroup.SelectedItemChangedArgs.html">RadioGroup.SelectedItemChangedArgs</a></h4>
  251. <section>
  252. Event arguments for the SelectedItemChagned event.
  253. </section>
  254. <h4><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></h4>
  255. <section>
  256. Responder base class implemented by objects that want to participate on keyboard and mouse input.
  257. </section>
  258. <h4><a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a></h4>
  259. <section>
  260. The <a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a> provides an interactive dialog box for users to pick a file to
  261. save.
  262. </section>
  263. <h4><a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a></h4>
  264. <section>
  265. ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical
  266. </section>
  267. <h4><a class="xref" href="Terminal.Gui.ScrollView.html">ScrollView</a></h4>
  268. <section>
  269. Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView.
  270. </section>
  271. <h4><a class="xref" href="Terminal.Gui.SelectedCellChangedEventArgs.html">SelectedCellChangedEventArgs</a></h4>
  272. <section>
  273. Defines the event arguments for <a class="xref" href="Terminal.Gui.TableView.html#Terminal_Gui_TableView_SelectedCellChanged">SelectedCellChanged</a>
  274. </section>
  275. <h4><a class="xref" href="Terminal.Gui.SelectionChangedEventArgs-1.html">SelectionChangedEventArgs&lt;T&gt;</a></h4>
  276. <section>
  277. Event arguments describing a change in selected object in a tree view
  278. </section>
  279. <h4><a class="xref" href="Terminal.Gui.ShortcutHelper.html">ShortcutHelper</a></h4>
  280. <section>
  281. Represents a helper to manipulate shortcut keys used on views.
  282. </section>
  283. <h4><a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a></h4>
  284. <section>
  285. 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.
  286. 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
  287. 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.
  288. So for each context must be a new instance of a statusbar.
  289. </section>
  290. <h4><a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a></h4>
  291. <section>
  292. <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.
  293. 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
  294. <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Shortcut">Shortcut</a> is pressed.
  295. 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.
  296. The colour of the <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Title">Title</a> will be changed after each ~.
  297. 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
  298. *Help* as <a class="xref" href="Terminal.Gui.ColorScheme.html#Terminal_Gui_ColorScheme_HotNormal">HotNormal</a>.
  299. </section>
  300. <h4><a class="xref" href="Terminal.Gui.TableSelection.html">TableSelection</a></h4>
  301. <section>
  302. Describes a selected region of the table
  303. </section>
  304. <h4><a class="xref" href="Terminal.Gui.TableStyle.html">TableStyle</a></h4>
  305. <section>
  306. Defines rendering options that affect how the table is displayed.
  307. <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
  308. </section>
  309. <h4><a class="xref" href="Terminal.Gui.TableView.html">TableView</a></h4>
  310. <section>
  311. View for tabular data based on a <span class="xref">System.Data.DataTable</span>.
  312. <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
  313. </section>
  314. <h4><a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a></h4>
  315. <section>
  316. An <span class="xref">System.EventArgs</span> which allows passing a cancelable new text value event.
  317. </section>
  318. <h4><a class="xref" href="Terminal.Gui.TextField.html">TextField</a></h4>
  319. <section>
  320. Single-line text entry <a class="xref" href="Terminal.Gui.View.html">View</a>
  321. </section>
  322. <h4><a class="xref" href="Terminal.Gui.TextFormatter.html">TextFormatter</a></h4>
  323. <section>
  324. Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap.
  325. </section>
  326. <h4><a class="xref" href="Terminal.Gui.TextView.html">TextView</a></h4>
  327. <section>
  328. Multi-line text editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  329. </section>
  330. <h4><a class="xref" href="Terminal.Gui.TimeField.html">TimeField</a></h4>
  331. <section>
  332. Time editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  333. </section>
  334. <h4><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></h4>
  335. <section>
  336. Toplevel views can be modally executed.
  337. </section>
  338. <h4><a class="xref" href="Terminal.Gui.TreeBuilder-1.html">TreeBuilder&lt;T&gt;</a></h4>
  339. <section>
  340. Abstract implementation of <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a>.
  341. </section>
  342. <h4><a class="xref" href="Terminal.Gui.TreeNode.html">TreeNode</a></h4>
  343. <section>
  344. Simple class for representing nodes, use with regular (non generic) <a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a>.
  345. </section>
  346. <h4><a class="xref" href="Terminal.Gui.TreeNodeBuilder.html">TreeNodeBuilder</a></h4>
  347. <section>
  348. <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a> implementation for <a class="xref" href="Terminal.Gui.ITreeNode.html">ITreeNode</a> objects
  349. </section>
  350. <h4><a class="xref" href="Terminal.Gui.TreeStyle.html">TreeStyle</a></h4>
  351. <section>
  352. Defines rendering options that affect how the tree is displayed
  353. </section>
  354. <h4><a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a></h4>
  355. <section>
  356. Convenience implementation of generic <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a> for any tree were all nodes
  357. implement <a class="xref" href="Terminal.Gui.ITreeNode.html">ITreeNode</a>.
  358. <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
  359. </section>
  360. <h4><a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a></h4>
  361. <section>
  362. Hierarchical tree view with expandable branches. Branch objects are dynamically determined
  363. when expanded using a user defined <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a>
  364. <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
  365. </section>
  366. <h4><a class="xref" href="Terminal.Gui.View.html">View</a></h4>
  367. <section>
  368. 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.
  369. </section>
  370. <h4><a class="xref" href="Terminal.Gui.View.FocusEventArgs.html">View.FocusEventArgs</a></h4>
  371. <section>
  372. Defines the event arguments for <span class="xref">Terminal.Gui.View.SetFocus(Terminal.Gui.View)</span>
  373. </section>
  374. <h4><a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html">View.KeyEventEventArgs</a></h4>
  375. <section>
  376. Defines the event arguments for <a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html#Terminal_Gui_View_KeyEventEventArgs_KeyEvent">KeyEvent</a>
  377. </section>
  378. <h4><a class="xref" href="Terminal.Gui.View.LayoutEventArgs.html">View.LayoutEventArgs</a></h4>
  379. <section>
  380. Event arguments for the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">LayoutComplete</a> event.
  381. </section>
  382. <h4><a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a></h4>
  383. <section>
  384. Specifies the event arguments for <a class="xref" href="Terminal.Gui.View.MouseEventArgs.html#Terminal_Gui_View_MouseEventArgs_MouseEvent">MouseEvent</a>
  385. </section>
  386. <h4><a class="xref" href="Terminal.Gui.Window.html">Window</a></h4>
  387. <section>
  388. A <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> <a class="xref" href="Terminal.Gui.View.html">View</a> that draws a border around its <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> with a <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Title">Title</a> at the top.
  389. </section>
  390. <h3 id="structs">Structs
  391. </h3>
  392. <h4><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></h4>
  393. <section>
  394. Attributes are used as elements that contain both a foreground and a background or platform specific features
  395. </section>
  396. <h4><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></h4>
  397. <section>
  398. Describes a mouse event
  399. </section>
  400. <h4><a class="xref" href="Terminal.Gui.Point.html">Point</a></h4>
  401. <section>
  402. Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.
  403. </section>
  404. <h4><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></h4>
  405. <section>
  406. Stores a set of four integers that represent the location and size of a rectangle
  407. </section>
  408. <h4><a class="xref" href="Terminal.Gui.Size.html">Size</a></h4>
  409. <section>
  410. Stores an ordered pair of integers, which specify a Height and Width.
  411. </section>
  412. <h3 id="interfaces">Interfaces
  413. </h3>
  414. <h4><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></h4>
  415. <section>
  416. 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>.
  417. </section>
  418. <h4><a class="xref" href="Terminal.Gui.IMainLoopDriver.html">IMainLoopDriver</a></h4>
  419. <section>
  420. Public interface to create your own platform specific main loop driver.
  421. </section>
  422. <h4><a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a></h4>
  423. <section>
  424. Interface for supplying data to a <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a> on demand as root level nodes
  425. are expanded by the user
  426. </section>
  427. <h4><a class="xref" href="Terminal.Gui.ITreeNode.html">ITreeNode</a></h4>
  428. <section>
  429. Interface to implement when you want the regular (non generic) <a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a>
  430. to automatically determine children for your class (without having to specify
  431. an <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a>)
  432. </section>
  433. <h4><a class="xref" href="Terminal.Gui.ITreeView.html">ITreeView</a></h4>
  434. <section>
  435. Interface for all non generic members of <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a>
  436. <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
  437. </section>
  438. <h3 id="enums">Enums
  439. </h3>
  440. <h4><a class="xref" href="Terminal.Gui.Color.html">Color</a></h4>
  441. <section>
  442. Basic colors that can be used to set the foreground and background colors in console applications.
  443. </section>
  444. <h4><a class="xref" href="Terminal.Gui.ConsoleDriver.DiagnosticFlags.html">ConsoleDriver.DiagnosticFlags</a></h4>
  445. <section>
  446. Enables diagnostic functions
  447. </section>
  448. <h4><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></h4>
  449. <section>
  450. Cursors Visibility that are displayed
  451. </section>
  452. <h4><a class="xref" href="Terminal.Gui.DisplayModeLayout.html">DisplayModeLayout</a></h4>
  453. <section>
  454. Used for choose the display mode of this <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a>
  455. </section>
  456. <h4><a class="xref" href="Terminal.Gui.Key.html">Key</a></h4>
  457. <section>
  458. The <a class="xref" href="Terminal.Gui.Key.html">Key</a> enumeration contains special encoding for some keys, but can also
  459. encode all the unicode values that can be passed.
  460. </section>
  461. <h4><a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a></h4>
  462. <section>
  463. Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the
  464. value from the Frame will be used, if the value is Computed, then the Frame
  465. will be updated from the X, Y Pos objects and the Width and Height Dim objects.
  466. </section>
  467. <h4><a class="xref" href="Terminal.Gui.MenuItemCheckStyle.html">MenuItemCheckStyle</a></h4>
  468. <section>
  469. Specifies how a <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> shows selection state.
  470. </section>
  471. <h4><a class="xref" href="Terminal.Gui.MouseFlags.html">MouseFlags</a></h4>
  472. <section>
  473. Mouse flags reported in <a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>.
  474. </section>
  475. <h4><a class="xref" href="Terminal.Gui.TextAlignment.html">TextAlignment</a></h4>
  476. <section>
  477. Text alignment enumeration, controls how text is displayed.
  478. </section>
  479. <h3 id="delegates">Delegates
  480. </h3>
  481. <h4><a class="xref" href="Terminal.Gui.AspectGetterDelegate-1.html">AspectGetterDelegate&lt;T&gt;</a></h4>
  482. <section>
  483. Delegates of this type are used to fetch string representations of user&apos;s model objects
  484. </section>
  485. </article>
  486. </div>
  487. <div class="hidden-sm col-md-2" role="complementary">
  488. <div class="sideaffix">
  489. <div class="contribution">
  490. <ul class="nav">
  491. </ul>
  492. </div>
  493. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  494. <h5>In This Article</h5>
  495. <div></div>
  496. </nav>
  497. </div>
  498. </div>
  499. </div>
  500. </div>
  501. <footer>
  502. <div class="grad-bottom"></div>
  503. <div class="footer">
  504. <div class="container">
  505. <span class="pull-right">
  506. <a href="#top">Back to top</a>
  507. </span>
  508. <span>Generated by <strong>DocFX</strong></span>
  509. </div>
  510. </div>
  511. </footer>
  512. </div>
  513. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  514. <script type="text/javascript" src="../../styles/docfx.js"></script>
  515. <script type="text/javascript" src="../../styles/main.js"></script>
  516. </body>
  517. </html>