Terminal.Gui.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671
  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.59.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="../../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, singleton class providing 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.Autocomplete.html">Autocomplete</a></h4>
  93. <section>
  94. Renders an overlay on another view at a given point that allows selecting
  95. from a range of &apos;autocomplete&apos; options.
  96. </section>
  97. <h4><a class="xref" href="Terminal.Gui.Border.html">Border</a></h4>
  98. <section>
  99. Draws a border, background, or both around another element.
  100. </section>
  101. <h4><a class="xref" href="Terminal.Gui.Border.ToplevelContainer.html">Border.ToplevelContainer</a></h4>
  102. <section>
  103. A sealed <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> derived class to implement <a class="xref" href="Terminal.Gui.Border.ToplevelContainer.html#Terminal_Gui_Border_ToplevelContainer_Border">Border</a> feature.
  104. This is only a wrapper to get borders on a toplevel and is recommended using another
  105. derived, like <a class="xref" href="Terminal.Gui.Window.html">Window</a> where is possible to have borders with or without
  106. border line or spacing around.
  107. </section>
  108. <h4><a class="xref" href="Terminal.Gui.Button.html">Button</a></h4>
  109. <section>
  110. 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.
  111. </section>
  112. <h4><a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a></h4>
  113. <section>
  114. 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
  115. </section>
  116. <h4><a class="xref" href="Terminal.Gui.Clipboard.html">Clipboard</a></h4>
  117. <section>
  118. Provides cut, copy, and paste support for the clipboard with OS interaction.
  119. </section>
  120. <h4><a class="xref" href="Terminal.Gui.ClipboardBase.html">ClipboardBase</a></h4>
  121. <section>
  122. Shared abstract class to enforce rules from the implementation of the <a class="xref" href="Terminal.Gui.IClipboard.html">IClipboard</a> interface.
  123. </section>
  124. <h4><a class="xref" href="Terminal.Gui.ColorPicker.html">ColorPicker</a></h4>
  125. <section>
  126. The <a class="xref" href="Terminal.Gui.ColorPicker.html">ColorPicker</a> <a class="xref" href="Terminal.Gui.View.html">View</a> Color picker.
  127. </section>
  128. <h4><a class="xref" href="Terminal.Gui.Colors.html">Colors</a></h4>
  129. <section>
  130. The default <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>s for the application.
  131. </section>
  132. <h4><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></h4>
  133. <section>
  134. Color scheme definitions, they cover some common scenarios and are used
  135. 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
  136. views contained inside.
  137. </section>
  138. <h4><a class="xref" href="Terminal.Gui.ComboBox.html">ComboBox</a></h4>
  139. <section>
  140. ComboBox control
  141. </section>
  142. <h4><a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a></h4>
  143. <section>
  144. ConsoleDriver is an abstract class that defines the requirements for a console driver.
  145. 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.
  146. </section>
  147. <h4><a class="xref" href="Terminal.Gui.ContextMenu.html">ContextMenu</a></h4>
  148. <section>
  149. A context menu window derived from <a class="xref" href="Terminal.Gui.ContextMenu.html#Terminal_Gui_ContextMenu_MenuBar">MenuBar</a> containing menu items
  150. which can be opened in any position.
  151. </section>
  152. <h4><a class="xref" href="Terminal.Gui.DateField.html">DateField</a></h4>
  153. <section>
  154. Simple Date editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  155. </section>
  156. <h4><a class="xref" href="Terminal.Gui.DateTimeEventArgs-1.html">DateTimeEventArgs&lt;T&gt;</a></h4>
  157. <section>
  158. 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.
  159. </section>
  160. <h4><a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a></h4>
  161. <section>
  162. 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
  163. 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.
  164. </section>
  165. <h4><a class="xref" href="Terminal.Gui.Dim.html">Dim</a></h4>
  166. <section>
  167. Dim properties of a <a class="xref" href="Terminal.Gui.View.html">View</a> to control the position.
  168. </section>
  169. <h4><a class="xref" href="Terminal.Gui.FakeConsole.html">FakeConsole</a></h4>
  170. <section>
  171. </section>
  172. <h4><a class="xref" href="Terminal.Gui.FakeDriver.html">FakeDriver</a></h4>
  173. <section>
  174. Implements a mock ConsoleDriver for unit testing
  175. </section>
  176. <h4><a class="xref" href="Terminal.Gui.FakeMainLoop.html">FakeMainLoop</a></h4>
  177. <section>
  178. Mainloop intended to be used with the .NET System.Console API, and can
  179. be used on Windows and Unix, it is cross platform but lacks things like
  180. file descriptor monitoring.
  181. </section>
  182. <h4><a class="xref" href="Terminal.Gui.FileDialog.html">FileDialog</a></h4>
  183. <section>
  184. 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>
  185. </section>
  186. <h4><a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a></h4>
  187. <section>
  188. The FrameView is a container frame that draws a frame around the contents. It is similar to
  189. a GroupBox in Windows.
  190. </section>
  191. <h4><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></h4>
  192. <section>
  193. Control for rendering graphs (bar, scatter etc)
  194. </section>
  195. <h4><a class="xref" href="Terminal.Gui.HexView.html">HexView</a></h4>
  196. <section>
  197. An hex viewer and editor <a class="xref" href="Terminal.Gui.View.html">View</a> over a <span class="xref">System.IO.Stream</span>
  198. </section>
  199. <h4><a class="xref" href="Terminal.Gui.HexView.HexViewEventArgs.html">HexView.HexViewEventArgs</a></h4>
  200. <section>
  201. Defines the event arguments for <a class="xref" href="Terminal.Gui.HexView.html#Terminal_Gui_HexView_PositionChanged">PositionChanged</a> event.
  202. </section>
  203. <h4><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></h4>
  204. <section>
  205. Describes a keyboard event.
  206. </section>
  207. <h4><a class="xref" href="Terminal.Gui.KeyModifiers.html">KeyModifiers</a></h4>
  208. <section>
  209. Identifies the state of the &quot;shift&quot;-keys within a event.
  210. </section>
  211. <h4><a class="xref" href="Terminal.Gui.Label.html">Label</a></h4>
  212. <section>
  213. The Label <a class="xref" href="Terminal.Gui.View.html">View</a> displays a string at a given position and supports multiple lines separated by newline characters.
  214. Multi-line Labels support word wrap.
  215. </section>
  216. <h4><a class="xref" href="Terminal.Gui.LineView.html">LineView</a></h4>
  217. <section>
  218. A straight line control either horizontal or vertical
  219. </section>
  220. <h4><a class="xref" href="Terminal.Gui.ListView.html">ListView</a></h4>
  221. <section>
  222. 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.
  223. </section>
  224. <h4><a class="xref" href="Terminal.Gui.ListViewItemEventArgs.html">ListViewItemEventArgs</a></h4>
  225. <section>
  226. <span class="xref">System.EventArgs</span> for <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> events.
  227. </section>
  228. <h4><a class="xref" href="Terminal.Gui.ListViewRowEventArgs.html">ListViewRowEventArgs</a></h4>
  229. <section>
  230. <span class="xref">System.EventArgs</span> used by the <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_RowRender">RowRender</a> event.
  231. </section>
  232. <h4><a class="xref" href="Terminal.Gui.ListWrapper.html">ListWrapper</a></h4>
  233. <section>
  234. 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>.
  235. </section>
  236. <h4><a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a></h4>
  237. <section>
  238. Simple main loop implementation that can be used to monitor
  239. file descriptor, run timers and idle handlers.
  240. </section>
  241. <h4><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></h4>
  242. <section>
  243. The MenuBar provides a menu for Terminal.Gui applications.
  244. </section>
  245. <h4><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a></h4>
  246. <section>
  247. 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.
  248. </section>
  249. <h4><a class="xref" href="Terminal.Gui.MenuClosingEventArgs.html">MenuClosingEventArgs</a></h4>
  250. <section>
  251. An <span class="xref">System.EventArgs</span> which allows passing a cancelable menu closing event.
  252. </section>
  253. <h4><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></h4>
  254. <section>
  255. 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.
  256. </section>
  257. <h4><a class="xref" href="Terminal.Gui.MenuOpeningEventArgs.html">MenuOpeningEventArgs</a></h4>
  258. <section>
  259. An <span class="xref">System.EventArgs</span> which allows passing a cancelable menu opening event or replacing with a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.
  260. </section>
  261. <h4><a class="xref" href="Terminal.Gui.MessageBox.html">MessageBox</a></h4>
  262. <section>
  263. MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from.
  264. </section>
  265. <h4><a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a></h4>
  266. <section>
  267. The <a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a>provides an interactive dialog box for users to select files or directories.
  268. </section>
  269. <h4><a class="xref" href="Terminal.Gui.PanelView.html">PanelView</a></h4>
  270. <section>
  271. A container for single <a class="xref" href="Terminal.Gui.PanelView.html#Terminal_Gui_PanelView_Child">Child</a> that will allow to drawn <a class="xref" href="Terminal.Gui.PanelView.html#Terminal_Gui_PanelView_Border">Border</a> in
  272. two ways. If <a class="xref" href="Terminal.Gui.PanelView.html#Terminal_Gui_PanelView_UsePanelFrame">UsePanelFrame</a> the borders and the child will be accommodated in the available
  273. panel size, otherwise the panel will be resized based on the child and borders thickness sizes.
  274. </section>
  275. <h4><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></h4>
  276. <section>
  277. 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
  278. relative to the ending dimension. Integer values are implicitly convertible to
  279. an absolute <a class="xref" href="Terminal.Gui.Pos.html">Pos</a>. These objects are created using the static methods Percent,
  280. AnchorEnd, and Center. The <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> objects can be combined with the addition and
  281. subtraction operators.
  282. </section>
  283. <h4><a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a></h4>
  284. <section>
  285. A Progress Bar view that can indicate progress of an activity visually.
  286. </section>
  287. <h4><a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a></h4>
  288. <section>
  289. <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
  290. </section>
  291. <h4><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></h4>
  292. <section>
  293. Responder base class implemented by objects that want to participate on keyboard and mouse input.
  294. </section>
  295. <h4><a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a></h4>
  296. <section>
  297. The <a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a> provides an interactive dialog box for users to pick a file to
  298. save.
  299. </section>
  300. <h4><a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a></h4>
  301. <section>
  302. ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical
  303. </section>
  304. <h4><a class="xref" href="Terminal.Gui.ScrollView.html">ScrollView</a></h4>
  305. <section>
  306. Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView.
  307. </section>
  308. <h4><a class="xref" href="Terminal.Gui.SelectedItemChangedArgs.html">SelectedItemChangedArgs</a></h4>
  309. <section>
  310. Event arguments for the SelectedItemChagned event.
  311. </section>
  312. <h4><a class="xref" href="Terminal.Gui.ShortcutHelper.html">ShortcutHelper</a></h4>
  313. <section>
  314. Represents a helper to manipulate shortcut keys used on views.
  315. </section>
  316. <h4><a class="xref" href="Terminal.Gui.StackExtensions.html">StackExtensions</a></h4>
  317. <section>
  318. Extension of <span class="xref">System.Collections.Generic.Stack&lt;T&gt;</span> helper to work with specific <span class="xref">System.Collections.Generic.IEqualityComparer&lt;T&gt;</span>
  319. </section>
  320. <h4><a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a></h4>
  321. <section>
  322. 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.
  323. 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
  324. 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.
  325. So for each context must be a new instance of a statusbar.
  326. </section>
  327. <h4><a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a></h4>
  328. <section>
  329. <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.
  330. 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
  331. <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Shortcut">Shortcut</a> is pressed.
  332. 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.
  333. The colour of the <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Title">Title</a> will be changed after each ~.
  334. 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
  335. *Help* as <a class="xref" href="Terminal.Gui.ColorScheme.html#Terminal_Gui_ColorScheme_HotNormal">HotNormal</a>.
  336. </section>
  337. <h4><a class="xref" href="Terminal.Gui.TableView.html">TableView</a></h4>
  338. <section>
  339. View for tabular data based on a <span class="xref">System.Data.DataTable</span>.
  340. <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
  341. </section>
  342. <h4><a class="xref" href="Terminal.Gui.TableView.CellActivatedEventArgs.html">TableView.CellActivatedEventArgs</a></h4>
  343. <section>
  344. Defines the event arguments for <a class="xref" href="Terminal.Gui.TableView.html#Terminal_Gui_TableView_CellActivated">CellActivated</a> event
  345. </section>
  346. <h4><a class="xref" href="Terminal.Gui.TableView.CellColorGetterArgs.html">TableView.CellColorGetterArgs</a></h4>
  347. <section>
  348. Arguments for a <a class="xref" href="Terminal.Gui.TableView.CellColorGetterDelegate.html">TableView.CellColorGetterDelegate</a>. Describes a cell for which a rendering
  349. <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> is being sought
  350. </section>
  351. <h4><a class="xref" href="Terminal.Gui.TableView.ColumnStyle.html">TableView.ColumnStyle</a></h4>
  352. <section>
  353. 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>
  354. and textual representation of cells (e.g. date formats)
  355. <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
  356. </section>
  357. <h4><a class="xref" href="Terminal.Gui.TableView.RowColorGetterArgs.html">TableView.RowColorGetterArgs</a></h4>
  358. <section>
  359. Arguments for <a class="xref" href="Terminal.Gui.TableView.RowColorGetterDelegate.html">TableView.RowColorGetterDelegate</a>. Describes a row of data in a <span class="xref">System.Data.DataTable</span>
  360. for which <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> is sought.
  361. </section>
  362. <h4><a class="xref" href="Terminal.Gui.TableView.SelectedCellChangedEventArgs.html">TableView.SelectedCellChangedEventArgs</a></h4>
  363. <section>
  364. Defines the event arguments for <a class="xref" href="Terminal.Gui.TableView.html#Terminal_Gui_TableView_SelectedCellChanged">SelectedCellChanged</a>
  365. </section>
  366. <h4><a class="xref" href="Terminal.Gui.TableView.TableSelection.html">TableView.TableSelection</a></h4>
  367. <section>
  368. Describes a selected region of the table
  369. </section>
  370. <h4><a class="xref" href="Terminal.Gui.TableView.TableStyle.html">TableView.TableStyle</a></h4>
  371. <section>
  372. Defines rendering options that affect how the table is displayed.
  373. <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
  374. </section>
  375. <h4><a class="xref" href="Terminal.Gui.TabView.html">TabView</a></h4>
  376. <section>
  377. Control that hosts multiple sub views, presenting a single one at once
  378. </section>
  379. <h4><a class="xref" href="Terminal.Gui.TabView.Tab.html">TabView.Tab</a></h4>
  380. <section>
  381. A single tab in a <a class="xref" href="Terminal.Gui.TabView.html">TabView</a>
  382. </section>
  383. <h4><a class="xref" href="Terminal.Gui.TabView.TabChangedEventArgs.html">TabView.TabChangedEventArgs</a></h4>
  384. <section>
  385. Describes a change in <a class="xref" href="Terminal.Gui.TabView.html#Terminal_Gui_TabView_SelectedTab">SelectedTab</a>
  386. </section>
  387. <h4><a class="xref" href="Terminal.Gui.TabView.TabStyle.html">TabView.TabStyle</a></h4>
  388. <section>
  389. Describes render stylistic selections of a <a class="xref" href="Terminal.Gui.TabView.html">TabView</a>
  390. </section>
  391. <h4><a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a></h4>
  392. <section>
  393. An <span class="xref">System.EventArgs</span> which allows passing a cancelable new text value event.
  394. </section>
  395. <h4><a class="xref" href="Terminal.Gui.TextField.html">TextField</a></h4>
  396. <section>
  397. Single-line text entry <a class="xref" href="Terminal.Gui.View.html">View</a>
  398. </section>
  399. <h4><a class="xref" href="Terminal.Gui.TextFieldAutocomplete.html">TextFieldAutocomplete</a></h4>
  400. <section>
  401. Renders an overlay on another view at a given point that allows selecting
  402. from a range of &apos;autocomplete&apos; options.
  403. An implementation on a TextField.
  404. </section>
  405. <h4><a class="xref" href="Terminal.Gui.TextFormatter.html">TextFormatter</a></h4>
  406. <section>
  407. Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap.
  408. </section>
  409. <h4><a class="xref" href="Terminal.Gui.TextValidateField.html">TextValidateField</a></h4>
  410. <section>
  411. Text field that validates input through a <a class="xref" href="Terminal.Gui.TextValidateProviders.ITextValidateProvider.html">ITextValidateProvider</a>
  412. </section>
  413. <h4><a class="xref" href="Terminal.Gui.TextView.html">TextView</a></h4>
  414. <section>
  415. Multi-line text editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  416. </section>
  417. <h4><a class="xref" href="Terminal.Gui.TextViewAutocomplete.html">TextViewAutocomplete</a></h4>
  418. <section>
  419. Renders an overlay on another view at a given point that allows selecting
  420. from a range of &apos;autocomplete&apos; options.
  421. An implementation on a TextView.
  422. </section>
  423. <h4><a class="xref" href="Terminal.Gui.TimeField.html">TimeField</a></h4>
  424. <section>
  425. Time editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  426. </section>
  427. <h4><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></h4>
  428. <section>
  429. Toplevel views can be modally executed.
  430. </section>
  431. <h4><a class="xref" href="Terminal.Gui.ToplevelClosingEventArgs.html">ToplevelClosingEventArgs</a></h4>
  432. <section>
  433. <span class="xref">System.EventArgs</span> implementation for the <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Closing">Closing</a> event.
  434. </section>
  435. <h4><a class="xref" href="Terminal.Gui.ToplevelComparer.html">ToplevelComparer</a></h4>
  436. <section>
  437. Implements the <span class="xref">System.Collections.Generic.IComparer&lt;T&gt;</span> to sort the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> from the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_MdiChildes">MdiChildes</a> if needed.
  438. </section>
  439. <h4><a class="xref" href="Terminal.Gui.ToplevelEqualityComparer.html">ToplevelEqualityComparer</a></h4>
  440. <section>
  441. Implements the <span class="xref">System.Collections.Generic.IEqualityComparer&lt;T&gt;</span> to comparing two <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> used by <a class="xref" href="Terminal.Gui.StackExtensions.html">StackExtensions</a>.
  442. </section>
  443. <h4><a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a></h4>
  444. <section>
  445. Convenience implementation of generic <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a> for any tree were all nodes
  446. implement <a class="xref" href="Terminal.Gui.Trees.ITreeNode.html">ITreeNode</a>.
  447. <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
  448. </section>
  449. <h4><a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a></h4>
  450. <section>
  451. Hierarchical tree view with expandable branches. Branch objects are dynamically determined
  452. when expanded using a user defined <a class="xref" href="Terminal.Gui.Trees.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a>
  453. <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
  454. </section>
  455. <h4><a class="xref" href="Terminal.Gui.View.html">View</a></h4>
  456. <section>
  457. 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.
  458. </section>
  459. <h4><a class="xref" href="Terminal.Gui.View.FocusEventArgs.html">View.FocusEventArgs</a></h4>
  460. <section>
  461. Defines the event arguments for <span class="xref">Terminal.Gui.View.SetFocus(Terminal.Gui.View)</span>
  462. </section>
  463. <h4><a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html">View.KeyEventEventArgs</a></h4>
  464. <section>
  465. Defines the event arguments for <a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html#Terminal_Gui_View_KeyEventEventArgs_KeyEvent">KeyEvent</a>
  466. </section>
  467. <h4><a class="xref" href="Terminal.Gui.View.LayoutEventArgs.html">View.LayoutEventArgs</a></h4>
  468. <section>
  469. Event arguments for the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">LayoutComplete</a> event.
  470. </section>
  471. <h4><a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a></h4>
  472. <section>
  473. Specifies the event arguments for <a class="xref" href="Terminal.Gui.View.MouseEventArgs.html#Terminal_Gui_View_MouseEventArgs_MouseEvent">MouseEvent</a>
  474. </section>
  475. <h4><a class="xref" href="Terminal.Gui.Window.html">Window</a></h4>
  476. <section>
  477. 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.
  478. </section>
  479. <h3 id="structs">Structs
  480. </h3>
  481. <h4><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></h4>
  482. <section>
  483. Attributes are used as elements that contain both a foreground and a background or platform specific features
  484. </section>
  485. <h4><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></h4>
  486. <section>
  487. Describes a mouse event
  488. </section>
  489. <h4><a class="xref" href="Terminal.Gui.Point.html">Point</a></h4>
  490. <section>
  491. Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.
  492. </section>
  493. <h4><a class="xref" href="Terminal.Gui.PointF.html">PointF</a></h4>
  494. <section>
  495. Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane.
  496. </section>
  497. <h4><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></h4>
  498. <section>
  499. Stores a set of four integers that represent the location and size of a rectangle
  500. </section>
  501. <h4><a class="xref" href="Terminal.Gui.RectangleF.html">RectangleF</a></h4>
  502. <section>
  503. Stores the location and size of a rectangular region.
  504. </section>
  505. <h4><a class="xref" href="Terminal.Gui.Size.html">Size</a></h4>
  506. <section>
  507. Stores an ordered pair of integers, which specify a Height and Width.
  508. </section>
  509. <h4><a class="xref" href="Terminal.Gui.SizeF.html">SizeF</a></h4>
  510. <section>
  511. Represents the size of a rectangular region with an ordered pair of width and height.
  512. </section>
  513. <h4><a class="xref" href="Terminal.Gui.Thickness.html">Thickness</a></h4>
  514. <section>
  515. Describes the thickness of a frame around a rectangle. Four <span class="xref">System.Int32</span> values describe
  516. the <a class="xref" href="Terminal.Gui.Thickness.html#Terminal_Gui_Thickness_Left">Left</a>, <a class="xref" href="Terminal.Gui.Thickness.html#Terminal_Gui_Thickness_Top">Top</a>, <a class="xref" href="Terminal.Gui.Thickness.html#Terminal_Gui_Thickness_Right">Right</a>, and <a class="xref" href="Terminal.Gui.Thickness.html#Terminal_Gui_Thickness_Bottom">Bottom</a> sides
  517. of the rectangle, respectively.
  518. </section>
  519. <h3 id="interfaces">Interfaces
  520. </h3>
  521. <h4><a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a></h4>
  522. <section>
  523. Renders an overlay on another view at a given point that allows selecting
  524. from a range of &apos;autocomplete&apos; options.
  525. </section>
  526. <h4><a class="xref" href="Terminal.Gui.IClipboard.html">IClipboard</a></h4>
  527. <section>
  528. Definition to interact with the OS clipboard.
  529. </section>
  530. <h4><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></h4>
  531. <section>
  532. 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>.
  533. </section>
  534. <h4><a class="xref" href="Terminal.Gui.IMainLoopDriver.html">IMainLoopDriver</a></h4>
  535. <section>
  536. Public interface to create your own platform specific main loop driver.
  537. </section>
  538. <h4><a class="xref" href="Terminal.Gui.ITreeView.html">ITreeView</a></h4>
  539. <section>
  540. Interface for all non generic members of <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a>
  541. <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
  542. </section>
  543. <h3 id="enums">Enums
  544. </h3>
  545. <h4><a class="xref" href="Terminal.Gui.BorderStyle.html">BorderStyle</a></h4>
  546. <section>
  547. Specifies the border style for a <a class="xref" href="Terminal.Gui.View.html">View</a> and to be used by the <a class="xref" href="Terminal.Gui.Border.html">Border</a> class.
  548. </section>
  549. <h4><a class="xref" href="Terminal.Gui.Color.html">Color</a></h4>
  550. <section>
  551. Basic colors that can be used to set the foreground and background colors in console applications.
  552. </section>
  553. <h4><a class="xref" href="Terminal.Gui.Command.html">Command</a></h4>
  554. <section>
  555. Actions which can be performed by the application or bound to keys in a <a class="xref" href="Terminal.Gui.View.html">View</a> control.
  556. </section>
  557. <h4><a class="xref" href="Terminal.Gui.ConsoleDriver.DiagnosticFlags.html">ConsoleDriver.DiagnosticFlags</a></h4>
  558. <section>
  559. Enables diagnostic functions
  560. </section>
  561. <h4><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></h4>
  562. <section>
  563. Cursors Visibility that are displayed
  564. </section>
  565. <h4><a class="xref" href="Terminal.Gui.DisplayModeLayout.html">DisplayModeLayout</a></h4>
  566. <section>
  567. Used for choose the display mode of this <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a>
  568. </section>
  569. <h4><a class="xref" href="Terminal.Gui.Key.html">Key</a></h4>
  570. <section>
  571. The <a class="xref" href="Terminal.Gui.Key.html">Key</a> enumeration contains special encoding for some keys, but can also
  572. encode all the unicode values that can be passed.
  573. </section>
  574. <h4><a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a></h4>
  575. <section>
  576. Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the
  577. value from the Frame will be used, if the value is Computed, then the Frame
  578. will be updated from the X, Y Pos objects and the Width and Height Dim objects.
  579. </section>
  580. <h4><a class="xref" href="Terminal.Gui.MenuItemCheckStyle.html">MenuItemCheckStyle</a></h4>
  581. <section>
  582. Specifies how a <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> shows selection state.
  583. </section>
  584. <h4><a class="xref" href="Terminal.Gui.MouseFlags.html">MouseFlags</a></h4>
  585. <section>
  586. Mouse flags reported in <a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>.
  587. </section>
  588. <h4><a class="xref" href="Terminal.Gui.OpenDialog.OpenMode.html">OpenDialog.OpenMode</a></h4>
  589. <section>
  590. Determine which <span class="xref">System.IO</span> type to open.
  591. </section>
  592. <h4><a class="xref" href="Terminal.Gui.ProgressBarFormat.html">ProgressBarFormat</a></h4>
  593. <section>
  594. Specifies the format that a <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> uses to indicate the visual presentation.
  595. </section>
  596. <h4><a class="xref" href="Terminal.Gui.ProgressBarStyle.html">ProgressBarStyle</a></h4>
  597. <section>
  598. Specifies the style that a <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> uses to indicate the progress of an operation.
  599. </section>
  600. <h4><a class="xref" href="Terminal.Gui.TextAlignment.html">TextAlignment</a></h4>
  601. <section>
  602. Text alignment enumeration, controls how text is displayed.
  603. </section>
  604. <h4><a class="xref" href="Terminal.Gui.TextDirection.html">TextDirection</a></h4>
  605. <section>
  606. Text direction enumeration, controls how text is displayed.
  607. </section>
  608. <h4><a class="xref" href="Terminal.Gui.VerticalTextAlignment.html">VerticalTextAlignment</a></h4>
  609. <section>
  610. Vertical text alignment enumeration, controls how text is displayed.
  611. </section>
  612. <h3 id="delegates">Delegates
  613. </h3>
  614. <h4><a class="xref" href="Terminal.Gui.TableView.CellColorGetterDelegate.html">TableView.CellColorGetterDelegate</a></h4>
  615. <section>
  616. Delegate for providing color to <a class="xref" href="Terminal.Gui.TableView.html">TableView</a> cells based on the value being rendered
  617. </section>
  618. <h4><a class="xref" href="Terminal.Gui.TableView.RowColorGetterDelegate.html">TableView.RowColorGetterDelegate</a></h4>
  619. <section>
  620. Delegate for providing color for a whole row of a <a class="xref" href="Terminal.Gui.TableView.html">TableView</a>
  621. </section>
  622. </article>
  623. </div>
  624. <div class="hidden-sm col-md-2" role="complementary">
  625. <div class="sideaffix">
  626. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  627. <h5>In This Article</h5>
  628. <div></div>
  629. </nav>
  630. </div>
  631. </div>
  632. </div>
  633. </div>
  634. <footer>
  635. <div class="grad-bottom"></div>
  636. <div class="footer">
  637. <div class="container">
  638. <span class="pull-right">
  639. <a href="#top">Back to top</a>
  640. </span>
  641. <span>Generated by <strong>DocFX</strong></span>
  642. </div>
  643. </div>
  644. </footer>
  645. </div>
  646. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  647. <script type="text/javascript" src="../../styles/docfx.js"></script>
  648. <script type="text/javascript" src="../../styles/main.js"></script>
  649. </body>
  650. </html>