Terminal.Gui.html 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708
  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.3.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
  18. <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../../">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../../index.html">
  35. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list">Search Results for <span></span></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="Terminal.Gui">
  74. <h1 id="Terminal_Gui" data-uid="Terminal.Gui" class="text-break">Namespace Terminal.Gui
  75. </h1>
  76. <div class="markdown level0 summary"></div>
  77. <div class="markdown level0 conceptual"></div>
  78. <div class="markdown level0 remarks"></div>
  79. <h3 id="classes">Classes
  80. </h3>
  81. <h4><a class="xref" href="Terminal.Gui.Application.html">Application</a></h4>
  82. <section>
  83. A static, singleton class providing the main application driver for Terminal.Gui apps.
  84. </section>
  85. <h4><a class="xref" href="Terminal.Gui.Application.ResizedEventArgs.html">Application.ResizedEventArgs</a></h4>
  86. <section>
  87. Event arguments for the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Resized">Resized</a> event.
  88. </section>
  89. <h4><a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a></h4>
  90. <section>
  91. Captures the execution state for the provided <a class="xref" href="Terminal.Gui.Application.RunState.html#Terminal_Gui_Application_RunState_Toplevel">Toplevel</a> view.
  92. </section>
  93. <h4><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></h4>
  94. <section>
  95. Attributes are used as elements that contain both a foreground and a background or platform specific features
  96. </section>
  97. <h4><a class="xref" href="Terminal.Gui.Autocomplete.html">Autocomplete</a></h4>
  98. <section>
  99. Renders an overlay on another view at a given point that allows selecting
  100. from a range of &apos;autocomplete&apos; options.
  101. </section>
  102. <h4><a class="xref" href="Terminal.Gui.Border.html">Border</a></h4>
  103. <section>
  104. Draws a border, background, or both around another element.
  105. </section>
  106. <h4><a class="xref" href="Terminal.Gui.Border.ToplevelContainer.html">Border.ToplevelContainer</a></h4>
  107. <section>
  108. 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.
  109. This is only a wrapper to get borders on a toplevel and is recommended using another
  110. derived, like <a class="xref" href="Terminal.Gui.Window.html">Window</a> where is possible to have borders with or without
  111. border line or spacing around.
  112. </section>
  113. <h4><a class="xref" href="Terminal.Gui.BorderStyle.html">BorderStyle</a></h4>
  114. <section>
  115. 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.
  116. </section>
  117. <h4><a class="xref" href="Terminal.Gui.Button.html">Button</a></h4>
  118. <section>
  119. 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.
  120. </section>
  121. <h4><a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a></h4>
  122. <section>
  123. 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
  124. </section>
  125. <h4><a class="xref" href="Terminal.Gui.Clipboard.html">Clipboard</a></h4>
  126. <section>
  127. Provides cut, copy, and paste support for the clipboard with OS interaction.
  128. </section>
  129. <h4><a class="xref" href="Terminal.Gui.ClipboardBase.html">ClipboardBase</a></h4>
  130. <section>
  131. Shared abstract class to enforce rules from the implementation of the <a class="xref" href="Terminal.Gui.IClipboard.html">IClipboard</a> interface.
  132. </section>
  133. <h4><a class="xref" href="Terminal.Gui.Color.html">Color</a></h4>
  134. <section>
  135. Basic colors that can be used to set the foreground and background colors in console applications.
  136. </section>
  137. <h4><a class="xref" href="Terminal.Gui.ColorPicker.html">ColorPicker</a></h4>
  138. <section>
  139. The <a class="xref" href="Terminal.Gui.ColorPicker.html">ColorPicker</a> <a class="xref" href="Terminal.Gui.View.html">View</a> Color picker.
  140. </section>
  141. <h4><a class="xref" href="Terminal.Gui.Colors.html">Colors</a></h4>
  142. <section>
  143. The default <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>s for the application.
  144. </section>
  145. <h4><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></h4>
  146. <section>
  147. Color scheme definitions, they cover some common scenarios and are used
  148. 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
  149. views contained inside.
  150. </section>
  151. <h4><a class="xref" href="Terminal.Gui.ComboBox.html">ComboBox</a></h4>
  152. <section>
  153. Provides a drop-down list of items the user can select from.
  154. </section>
  155. <h4><a class="xref" href="Terminal.Gui.Command.html">Command</a></h4>
  156. <section>
  157. 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.
  158. </section>
  159. <h4><a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a></h4>
  160. <section>
  161. ConsoleDriver is an abstract class that defines the requirements for a console driver.
  162. 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.
  163. </section>
  164. <h4><a class="xref" href="Terminal.Gui.ConsoleDriver.DiagnosticFlags.html">ConsoleDriver.DiagnosticFlags</a></h4>
  165. <section>
  166. Enables diagnostic functions
  167. </section>
  168. <h4><a class="xref" href="Terminal.Gui.ContextMenu.html">ContextMenu</a></h4>
  169. <section>
  170. A context menu window derived from <a class="xref" href="Terminal.Gui.ContextMenu.html#Terminal_Gui_ContextMenu_MenuBar">MenuBar</a> containing menu items
  171. which can be opened in any position.
  172. </section>
  173. <h4><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></h4>
  174. <section>
  175. Cursors Visibility that are displayed
  176. </section>
  177. <h4><a class="xref" href="Terminal.Gui.DateField.html">DateField</a></h4>
  178. <section>
  179. Simple Date editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  180. </section>
  181. <h4><a class="xref" href="Terminal.Gui.DateTimeEventArgs-1.html">DateTimeEventArgs&lt;T&gt;</a></h4>
  182. <section>
  183. 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.
  184. </section>
  185. <h4><a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a></h4>
  186. <section>
  187. 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
  188. 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.
  189. </section>
  190. <h4><a class="xref" href="Terminal.Gui.Dialog.ButtonAlignments.html">Dialog.ButtonAlignments</a></h4>
  191. <section>
  192. Determines the horizontal alignment of the Dialog buttons.
  193. </section>
  194. <h4><a class="xref" href="Terminal.Gui.Dim.html">Dim</a></h4>
  195. <section>
  196. Dim properties of a <a class="xref" href="Terminal.Gui.View.html">View</a> to control the position.
  197. </section>
  198. <h4><a class="xref" href="Terminal.Gui.DisplayModeLayout.html">DisplayModeLayout</a></h4>
  199. <section>
  200. Used for choose the display mode of this <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a>
  201. </section>
  202. <h4><a class="xref" href="Terminal.Gui.FakeConsole.html">FakeConsole</a></h4>
  203. <section>
  204. </section>
  205. <h4><a class="xref" href="Terminal.Gui.FakeDriver.html">FakeDriver</a></h4>
  206. <section>
  207. Implements a mock ConsoleDriver for unit testing
  208. </section>
  209. <h4><a class="xref" href="Terminal.Gui.FakeMainLoop.html">FakeMainLoop</a></h4>
  210. <section>
  211. Mainloop intended to be used with the .NET System.Console API, and can
  212. be used on Windows and Unix, it is cross platform but lacks things like
  213. file descriptor monitoring.
  214. </section>
  215. <h4><a class="xref" href="Terminal.Gui.FileDialog.html">FileDialog</a></h4>
  216. <section>
  217. 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>
  218. </section>
  219. <h4><a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a></h4>
  220. <section>
  221. The FrameView is a container frame that draws a frame around the contents. It is similar to
  222. a GroupBox in Windows.
  223. </section>
  224. <h4><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></h4>
  225. <section>
  226. Control for rendering graphs (bar, scatter etc)
  227. </section>
  228. <h4><a class="xref" href="Terminal.Gui.HexView.html">HexView</a></h4>
  229. <section>
  230. An hex viewer and editor <a class="xref" href="Terminal.Gui.View.html">View</a> over a <span class="xref">System.IO.Stream</span>
  231. </section>
  232. <h4><a class="xref" href="Terminal.Gui.HexView.HexViewEventArgs.html">HexView.HexViewEventArgs</a></h4>
  233. <section>
  234. Defines the event arguments for <a class="xref" href="Terminal.Gui.HexView.html#Terminal_Gui_HexView_PositionChanged">PositionChanged</a> event.
  235. </section>
  236. <h4><a class="xref" href="Terminal.Gui.Key.html">Key</a></h4>
  237. <section>
  238. The <a class="xref" href="Terminal.Gui.Key.html">Key</a> enumeration contains special encoding for some keys, but can also
  239. encode all the unicode values that can be passed.
  240. </section>
  241. <h4><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></h4>
  242. <section>
  243. Describes a keyboard event.
  244. </section>
  245. <h4><a class="xref" href="Terminal.Gui.KeyModifiers.html">KeyModifiers</a></h4>
  246. <section>
  247. Identifies the state of the &quot;shift&quot;-keys within a event.
  248. </section>
  249. <h4><a class="xref" href="Terminal.Gui.Label.html">Label</a></h4>
  250. <section>
  251. 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.
  252. Multi-line Labels support word wrap.
  253. </section>
  254. <h4><a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a></h4>
  255. <section>
  256. Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the
  257. value from the Frame will be used, if the value is Computed, then the Frame
  258. will be updated from the X, Y Pos objects and the Width and Height Dim objects.
  259. </section>
  260. <h4><a class="xref" href="Terminal.Gui.LineView.html">LineView</a></h4>
  261. <section>
  262. A straight line control either horizontal or vertical
  263. </section>
  264. <h4><a class="xref" href="Terminal.Gui.ListView.html">ListView</a></h4>
  265. <section>
  266. 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.
  267. </section>
  268. <h4><a class="xref" href="Terminal.Gui.ListViewItemEventArgs.html">ListViewItemEventArgs</a></h4>
  269. <section>
  270. <span class="xref">System.EventArgs</span> for <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> events.
  271. </section>
  272. <h4><a class="xref" href="Terminal.Gui.ListViewRowEventArgs.html">ListViewRowEventArgs</a></h4>
  273. <section>
  274. <span class="xref">System.EventArgs</span> used by the <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_RowRender">RowRender</a> event.
  275. </section>
  276. <h4><a class="xref" href="Terminal.Gui.ListWrapper.html">ListWrapper</a></h4>
  277. <section>
  278. 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>.
  279. </section>
  280. <h4><a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a></h4>
  281. <section>
  282. Simple main loop implementation that can be used to monitor
  283. file descriptor, run timers and idle handlers.
  284. </section>
  285. <h4><a class="xref" href="Terminal.Gui.MainLoop.Timeout.html">MainLoop.Timeout</a></h4>
  286. <section>
  287. Provides data for timers running manipulation.
  288. </section>
  289. <h4><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></h4>
  290. <section>
  291. Provides a menu bar with drop-down and cascading menus.
  292. </section>
  293. <h4><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a></h4>
  294. <section>
  295. 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.
  296. </section>
  297. <h4><a class="xref" href="Terminal.Gui.MenuClosingEventArgs.html">MenuClosingEventArgs</a></h4>
  298. <section>
  299. An <span class="xref">System.EventArgs</span> which allows passing a cancelable menu closing event.
  300. </section>
  301. <h4><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></h4>
  302. <section>
  303. 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.
  304. </section>
  305. <h4><a class="xref" href="Terminal.Gui.MenuItemCheckStyle.html">MenuItemCheckStyle</a></h4>
  306. <section>
  307. Specifies how a <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> shows selection state.
  308. </section>
  309. <h4><a class="xref" href="Terminal.Gui.MenuOpeningEventArgs.html">MenuOpeningEventArgs</a></h4>
  310. <section>
  311. 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>.
  312. </section>
  313. <h4><a class="xref" href="Terminal.Gui.MessageBox.html">MessageBox</a></h4>
  314. <section>
  315. MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from.
  316. </section>
  317. <h4><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></h4>
  318. <section>
  319. Describes a mouse event
  320. </section>
  321. <h4><a class="xref" href="Terminal.Gui.MouseFlags.html">MouseFlags</a></h4>
  322. <section>
  323. Mouse flags reported in <a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>.
  324. </section>
  325. <h4><a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a></h4>
  326. <section>
  327. The <a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a>provides an interactive dialog box for users to select files or directories.
  328. </section>
  329. <h4><a class="xref" href="Terminal.Gui.OpenDialog.OpenMode.html">OpenDialog.OpenMode</a></h4>
  330. <section>
  331. Determine which <span class="xref">System.IO</span> type to open.
  332. </section>
  333. <h4><a class="xref" href="Terminal.Gui.PanelView.html">PanelView</a></h4>
  334. <section>
  335. 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
  336. 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
  337. panel size, otherwise the panel will be resized based on the child and borders thickness sizes.
  338. </section>
  339. <h4><a class="xref" href="Terminal.Gui.Point.html">Point</a></h4>
  340. <section>
  341. Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.
  342. </section>
  343. <h4><a class="xref" href="Terminal.Gui.PointF.html">PointF</a></h4>
  344. <section>
  345. Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane.
  346. </section>
  347. <h4><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></h4>
  348. <section>
  349. 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
  350. relative to the ending dimension. Integer values are implicitly convertible to
  351. an absolute <a class="xref" href="Terminal.Gui.Pos.html">Pos</a>. These objects are created using the static methods Percent,
  352. AnchorEnd, and Center. The <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> objects can be combined with the addition and
  353. subtraction operators.
  354. </section>
  355. <h4><a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a></h4>
  356. <section>
  357. A Progress Bar view that can indicate progress of an activity visually.
  358. </section>
  359. <h4><a class="xref" href="Terminal.Gui.ProgressBarFormat.html">ProgressBarFormat</a></h4>
  360. <section>
  361. Specifies the format that a <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> uses to indicate the visual presentation.
  362. </section>
  363. <h4><a class="xref" href="Terminal.Gui.ProgressBarStyle.html">ProgressBarStyle</a></h4>
  364. <section>
  365. Specifies the style that a <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> uses to indicate the progress of an operation.
  366. </section>
  367. <h4><a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a></h4>
  368. <section>
  369. Displays a group of labels each with a selected indicator. Only one of those can be selected at a given time.
  370. </section>
  371. <h4><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></h4>
  372. <section>
  373. Stores a set of four integers that represent the location and size of a rectangle
  374. </section>
  375. <h4><a class="xref" href="Terminal.Gui.RectangleF.html">RectangleF</a></h4>
  376. <section>
  377. Stores the location and size of a rectangular region.
  378. </section>
  379. <h4><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></h4>
  380. <section>
  381. Responder base class implemented by objects that want to participate on keyboard and mouse input.
  382. </section>
  383. <h4><a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a></h4>
  384. <section>
  385. The <a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a> provides an interactive dialog box for users to pick a file to
  386. save.
  387. </section>
  388. <h4><a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a></h4>
  389. <section>
  390. ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical
  391. </section>
  392. <h4><a class="xref" href="Terminal.Gui.ScrollView.html">ScrollView</a></h4>
  393. <section>
  394. Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView.
  395. </section>
  396. <h4><a class="xref" href="Terminal.Gui.SelectedItemChangedArgs.html">SelectedItemChangedArgs</a></h4>
  397. <section>
  398. Event arguments for the SelectedItemChagned event.
  399. </section>
  400. <h4><a class="xref" href="Terminal.Gui.ShortcutHelper.html">ShortcutHelper</a></h4>
  401. <section>
  402. Represents a helper to manipulate shortcut keys used on views.
  403. </section>
  404. <h4><a class="xref" href="Terminal.Gui.Size.html">Size</a></h4>
  405. <section>
  406. Stores an ordered pair of integers, which specify a Height and Width.
  407. </section>
  408. <h4><a class="xref" href="Terminal.Gui.SizeF.html">SizeF</a></h4>
  409. <section>
  410. Represents the size of a rectangular region with an ordered pair of width and height.
  411. </section>
  412. <h4><a class="xref" href="Terminal.Gui.StackExtensions.html">StackExtensions</a></h4>
  413. <section>
  414. Extension of <span class="xref">System.Collections.Generic.Stack&lt;&gt;</span> helper to work with specific <span class="xref">System.Collections.Generic.IEqualityComparer&lt;&gt;</span>
  415. </section>
  416. <h4><a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a></h4>
  417. <section>
  418. 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.
  419. 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
  420. 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.
  421. So for each context must be a new instance of a statusbar.
  422. </section>
  423. <h4><a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a></h4>
  424. <section>
  425. <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.
  426. 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
  427. <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Shortcut">Shortcut</a> is pressed.
  428. 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.
  429. The colour of the <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Title">Title</a> will be changed after each ~.
  430. 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
  431. *Help* as <a class="xref" href="Terminal.Gui.ColorScheme.html#Terminal_Gui_ColorScheme_HotNormal">HotNormal</a>.
  432. </section>
  433. <h4><a class="xref" href="Terminal.Gui.TableView.html">TableView</a></h4>
  434. <section>
  435. View for tabular data based on a <span class="xref">System.Data.DataTable</span>.
  436. <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
  437. </section>
  438. <h4><a class="xref" href="Terminal.Gui.TableView.CellActivatedEventArgs.html">TableView.CellActivatedEventArgs</a></h4>
  439. <section>
  440. Defines the event arguments for <a class="xref" href="Terminal.Gui.TableView.html#Terminal_Gui_TableView_CellActivated">CellActivated</a> event
  441. </section>
  442. <h4><a class="xref" href="Terminal.Gui.TableView.CellColorGetterArgs.html">TableView.CellColorGetterArgs</a></h4>
  443. <section>
  444. Arguments for a <a class="xref" href="Terminal.Gui.TableView.CellColorGetterDelegate.html">TableView.CellColorGetterDelegate</a>. Describes a cell for which a rendering
  445. <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> is being sought
  446. </section>
  447. <h4><a class="xref" href="Terminal.Gui.TableView.CellColorGetterDelegate.html">TableView.CellColorGetterDelegate</a></h4>
  448. <section>
  449. Delegate for providing color to <a class="xref" href="Terminal.Gui.TableView.html">TableView</a> cells based on the value being rendered
  450. </section>
  451. <h4><a class="xref" href="Terminal.Gui.TableView.ColumnStyle.html">TableView.ColumnStyle</a></h4>
  452. <section>
  453. 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>
  454. and textual representation of cells (e.g. date formats)
  455. <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
  456. </section>
  457. <h4><a class="xref" href="Terminal.Gui.TableView.RowColorGetterArgs.html">TableView.RowColorGetterArgs</a></h4>
  458. <section>
  459. 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>
  460. for which <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> is sought.
  461. </section>
  462. <h4><a class="xref" href="Terminal.Gui.TableView.RowColorGetterDelegate.html">TableView.RowColorGetterDelegate</a></h4>
  463. <section>
  464. Delegate for providing color for a whole row of a <a class="xref" href="Terminal.Gui.TableView.html">TableView</a>
  465. </section>
  466. <h4><a class="xref" href="Terminal.Gui.TableView.SelectedCellChangedEventArgs.html">TableView.SelectedCellChangedEventArgs</a></h4>
  467. <section>
  468. Defines the event arguments for <a class="xref" href="Terminal.Gui.TableView.html#Terminal_Gui_TableView_SelectedCellChanged">SelectedCellChanged</a>
  469. </section>
  470. <h4><a class="xref" href="Terminal.Gui.TableView.TableSelection.html">TableView.TableSelection</a></h4>
  471. <section>
  472. Describes a selected region of the table
  473. </section>
  474. <h4><a class="xref" href="Terminal.Gui.TableView.TableStyle.html">TableView.TableStyle</a></h4>
  475. <section>
  476. Defines rendering options that affect how the table is displayed.
  477. <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
  478. </section>
  479. <h4><a class="xref" href="Terminal.Gui.TabView.html">TabView</a></h4>
  480. <section>
  481. Control that hosts multiple sub views, presenting a single one at once
  482. </section>
  483. <h4><a class="xref" href="Terminal.Gui.TabView.Tab.html">TabView.Tab</a></h4>
  484. <section>
  485. A single tab in a <a class="xref" href="Terminal.Gui.TabView.html">TabView</a>
  486. </section>
  487. <h4><a class="xref" href="Terminal.Gui.TabView.TabChangedEventArgs.html">TabView.TabChangedEventArgs</a></h4>
  488. <section>
  489. Describes a change in <a class="xref" href="Terminal.Gui.TabView.html#Terminal_Gui_TabView_SelectedTab">SelectedTab</a>
  490. </section>
  491. <h4><a class="xref" href="Terminal.Gui.TabView.TabStyle.html">TabView.TabStyle</a></h4>
  492. <section>
  493. Describes render stylistic selections of a <a class="xref" href="Terminal.Gui.TabView.html">TabView</a>
  494. </section>
  495. <h4><a class="xref" href="Terminal.Gui.TextAlignment.html">TextAlignment</a></h4>
  496. <section>
  497. Text alignment enumeration, controls how text is displayed.
  498. </section>
  499. <h4><a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a></h4>
  500. <section>
  501. An <span class="xref">System.EventArgs</span> which allows passing a cancelable new text value event.
  502. </section>
  503. <h4><a class="xref" href="Terminal.Gui.TextDirection.html">TextDirection</a></h4>
  504. <section>
  505. Text direction enumeration, controls how text is displayed.
  506. </section>
  507. <h4><a class="xref" href="Terminal.Gui.TextField.html">TextField</a></h4>
  508. <section>
  509. Single-line text entry <a class="xref" href="Terminal.Gui.View.html">View</a>
  510. </section>
  511. <h4><a class="xref" href="Terminal.Gui.TextFieldAutocomplete.html">TextFieldAutocomplete</a></h4>
  512. <section>
  513. Renders an overlay on another view at a given point that allows selecting
  514. from a range of &apos;autocomplete&apos; options.
  515. An implementation on a TextField.
  516. </section>
  517. <h4><a class="xref" href="Terminal.Gui.TextFormatter.html">TextFormatter</a></h4>
  518. <section>
  519. Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap.
  520. </section>
  521. <h4><a class="xref" href="Terminal.Gui.TextValidateField.html">TextValidateField</a></h4>
  522. <section>
  523. Text field that validates input through a <a class="xref" href="Terminal.Gui.TextValidateProviders.ITextValidateProvider.html">ITextValidateProvider</a>
  524. </section>
  525. <h4><a class="xref" href="Terminal.Gui.TextView.html">TextView</a></h4>
  526. <section>
  527. Multi-line text editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  528. </section>
  529. <h4><a class="xref" href="Terminal.Gui.TextViewAutocomplete.html">TextViewAutocomplete</a></h4>
  530. <section>
  531. Renders an overlay on another view at a given point that allows selecting
  532. from a range of &apos;autocomplete&apos; options.
  533. An implementation on a TextView.
  534. </section>
  535. <h4><a class="xref" href="Terminal.Gui.Thickness.html">Thickness</a></h4>
  536. <section>
  537. Describes the thickness of a frame around a rectangle. Four <span class="xref">System.Int32</span> values describe
  538. 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
  539. of the rectangle, respectively.
  540. </section>
  541. <h4><a class="xref" href="Terminal.Gui.TimeField.html">TimeField</a></h4>
  542. <section>
  543. Time editing <a class="xref" href="Terminal.Gui.View.html">View</a>
  544. </section>
  545. <h4><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></h4>
  546. <section>
  547. Toplevel views can be modally executed. They are used for both an application&apos;s main view (filling the entire screeN and
  548. for pop-up views such as <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a>, <a class="xref" href="Terminal.Gui.MessageBox.html">MessageBox</a>, and <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a>.
  549. </section>
  550. <h4><a class="xref" href="Terminal.Gui.ToplevelClosingEventArgs.html">ToplevelClosingEventArgs</a></h4>
  551. <section>
  552. <span class="xref">System.EventArgs</span> implementation for the <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Closing">Closing</a> event.
  553. </section>
  554. <h4><a class="xref" href="Terminal.Gui.ToplevelComparer.html">ToplevelComparer</a></h4>
  555. <section>
  556. Implements the <span class="xref">System.Collections.Generic.IComparer&lt;&gt;</span> to sort the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>
  557. from the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_MdiChildes">MdiChildes</a> if needed.
  558. </section>
  559. <h4><a class="xref" href="Terminal.Gui.ToplevelEqualityComparer.html">ToplevelEqualityComparer</a></h4>
  560. <section>
  561. Implements the <span class="xref">System.Collections.Generic.IEqualityComparer&lt;&gt;</span> for comparing two <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>s
  562. used by <a class="xref" href="Terminal.Gui.StackExtensions.html">StackExtensions</a>.
  563. </section>
  564. <h4><a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a></h4>
  565. <section>
  566. Convenience implementation of generic <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a> for any tree were all nodes
  567. implement <a class="xref" href="Terminal.Gui.Trees.ITreeNode.html">ITreeNode</a>.
  568. <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
  569. </section>
  570. <h4><a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a></h4>
  571. <section>
  572. Hierarchical tree view with expandable branches. Branch objects are dynamically determined
  573. when expanded using a user defined <a class="xref" href="Terminal.Gui.Trees.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a>
  574. <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
  575. </section>
  576. <h4><a class="xref" href="Terminal.Gui.VerticalTextAlignment.html">VerticalTextAlignment</a></h4>
  577. <section>
  578. Vertical text alignment enumeration, controls how text is displayed.
  579. </section>
  580. <h4><a class="xref" href="Terminal.Gui.View.html">View</a></h4>
  581. <section>
  582. 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.
  583. </section>
  584. <h4><a class="xref" href="Terminal.Gui.View.FocusEventArgs.html">View.FocusEventArgs</a></h4>
  585. <section>
  586. Defines the event arguments for <span class="xref">Terminal.Gui.View.SetFocus(Terminal.Gui.View)</span>
  587. </section>
  588. <h4><a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html">View.KeyEventEventArgs</a></h4>
  589. <section>
  590. Defines the event arguments for <a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html#Terminal_Gui_View_KeyEventEventArgs_KeyEvent">KeyEvent</a>
  591. </section>
  592. <h4><a class="xref" href="Terminal.Gui.View.LayoutEventArgs.html">View.LayoutEventArgs</a></h4>
  593. <section>
  594. Event arguments for the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">LayoutComplete</a> event.
  595. </section>
  596. <h4><a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a></h4>
  597. <section>
  598. Specifies the event arguments for <a class="xref" href="Terminal.Gui.View.MouseEventArgs.html#Terminal_Gui_View_MouseEventArgs_MouseEvent">MouseEvent</a>
  599. </section>
  600. <h4><a class="xref" href="Terminal.Gui.Window.html">Window</a></h4>
  601. <section>
  602. 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.
  603. </section>
  604. <h4><a class="xref" href="Terminal.Gui.Window.TitleEventArgs.html">Window.TitleEventArgs</a></h4>
  605. <section>
  606. An <span class="xref">System.EventArgs</span> which allows passing a cancelable new <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Title">Title</a> value event.
  607. </section>
  608. <h4><a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a></h4>
  609. <section>
  610. Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step (<a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a>) can host
  611. arbitrary <a class="xref" href="Terminal.Gui.View.html">View</a>s, much like a <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a>. Each step also has a pane for help text. Along the
  612. bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard.
  613. </section>
  614. <h4><a class="xref" href="Terminal.Gui.Wizard.StepChangeEventArgs.html">Wizard.StepChangeEventArgs</a></h4>
  615. <section>
  616. <span class="xref">System.EventArgs</span> for <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a> events.
  617. </section>
  618. <h4><a class="xref" href="Terminal.Gui.Wizard.WizardButtonEventArgs.html">Wizard.WizardButtonEventArgs</a></h4>
  619. <section>
  620. <span class="xref">System.EventArgs</span> for <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a> transition events.
  621. </section>
  622. <h4><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></h4>
  623. <section>
  624. Represents a basic step that is displayed in a <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a>. The <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a> view is divided horizontally in two. On the left is the
  625. content view where <a class="xref" href="Terminal.Gui.View.html">View</a>s can be added, On the right is the help for the step.
  626. Set <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html#Terminal_Gui_Wizard_WizardStep_HelpText">HelpText</a> to set the help text. If the help text is empty the help pane will not
  627. be shown.
  628. If there are no Views added to the WizardStep the <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html#Terminal_Gui_Wizard_WizardStep_HelpText">HelpText</a> (if not empty) will fill the wizard step.
  629. </section>
  630. <h4><a class="xref" href="Terminal.Gui.Wizard.WizardStep.TitleEventArgs.html">Wizard.WizardStep.TitleEventArgs</a></h4>
  631. <section>
  632. An <span class="xref">System.EventArgs</span> which allows passing a cancelable new <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html#Terminal_Gui_Wizard_WizardStep_Title">Title</a> value event.
  633. </section>
  634. <h3 id="interfaces">Interfaces
  635. </h3>
  636. <h4><a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a></h4>
  637. <section>
  638. Renders an overlay on another view at a given point that allows selecting
  639. from a range of &apos;autocomplete&apos; options.
  640. </section>
  641. <h4><a class="xref" href="Terminal.Gui.IClipboard.html">IClipboard</a></h4>
  642. <section>
  643. Definition to interact with the OS clipboard.
  644. </section>
  645. <h4><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></h4>
  646. <section>
  647. 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>.
  648. </section>
  649. <h4><a class="xref" href="Terminal.Gui.IMainLoopDriver.html">IMainLoopDriver</a></h4>
  650. <section>
  651. Public interface to create your own platform specific main loop driver.
  652. </section>
  653. <h4><a class="xref" href="Terminal.Gui.ITreeView.html">ITreeView</a></h4>
  654. <section>
  655. Interface for all non generic members of <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a>
  656. <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
  657. </section>
  658. </article>
  659. </div>
  660. <div class="hidden-sm col-md-2" role="complementary">
  661. <div class="sideaffix">
  662. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  663. <h5>In This Article</h5>
  664. <div></div>
  665. </nav>
  666. </div>
  667. </div>
  668. </div>
  669. </div>
  670. <footer>
  671. <div class="grad-bottom"></div>
  672. <div class="footer">
  673. <div class="container">
  674. <span class="pull-right">
  675. <a href="#top">Back to top</a>
  676. </span>
  677. <span>Generated by <strong>DocFX</strong></span>
  678. </div>
  679. </div>
  680. </footer>
  681. </div>
  682. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  683. <script type="text/javascript" src="../../styles/docfx.js"></script>
  684. <script type="text/javascript" src="../../styles/main.js"></script>
  685. </body>
  686. </html>