Terminal.Gui.html 28 KB

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