Terminal.Gui.Toplevel.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782
  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>Class Toplevel
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Toplevel
  11. ">
  12. <meta name="generator" content="docfx 2.53.1.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../../">
  21. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Toplevel">
  73. <h1 id="Terminal_Gui_Toplevel" data-uid="Terminal.Gui.Toplevel" class="text-break">Class Toplevel
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Toplevel views can be modally executed.
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  83. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  84. <div class="level3"><span class="xref">Toplevel</span></div>
  85. <div class="level4"><a class="xref" href="Terminal.Gui.Window.html">Window</a></div>
  86. </div>
  87. <div classs="implements">
  88. <h5>Implements</h5>
  89. <div><span class="xref">System.Collections.IEnumerable</span></div>
  90. </div>
  91. <div class="inheritedMembers">
  92. <h5>Inherited Members</h5>
  93. <div>
  94. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  107. </div>
  108. <div>
  109. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  110. </div>
  111. <div>
  112. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  113. </div>
  114. <div>
  115. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  116. </div>
  117. <div>
  118. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  119. </div>
  120. <div>
  121. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  122. </div>
  123. <div>
  124. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  125. </div>
  126. <div>
  127. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  128. </div>
  129. <div>
  130. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  131. </div>
  132. <div>
  133. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  134. </div>
  135. <div>
  136. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  137. </div>
  138. <div>
  139. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  140. </div>
  141. <div>
  142. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  143. </div>
  144. <div>
  145. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  146. </div>
  147. <div>
  148. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  149. </div>
  150. <div>
  151. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  152. </div>
  153. <div>
  154. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  155. </div>
  156. <div>
  157. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  158. </div>
  159. <div>
  160. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  161. </div>
  162. <div>
  163. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  164. </div>
  165. <div>
  166. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  167. </div>
  168. <div>
  169. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  170. </div>
  171. <div>
  172. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  173. </div>
  174. <div>
  175. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  176. </div>
  177. <div>
  178. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  179. </div>
  180. <div>
  181. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  182. </div>
  183. <div>
  184. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  185. </div>
  186. <div>
  187. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_">View.DrawFrame(Rect, Int32, Boolean)</a>
  188. </div>
  189. <div>
  190. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_Terminal_Gui_Attribute_Terminal_Gui_Attribute_">View.DrawHotString(ustring, Attribute, Attribute)</a>
  191. </div>
  192. <div>
  193. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_System_Boolean_Terminal_Gui_ColorScheme_">View.DrawHotString(ustring, Boolean, ColorScheme)</a>
  194. </div>
  195. <div>
  196. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  197. </div>
  198. <div>
  199. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
  200. </div>
  201. <div>
  202. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  203. </div>
  204. <div>
  205. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  206. </div>
  207. <div>
  208. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
  209. </div>
  210. <div>
  211. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  212. </div>
  213. <div>
  214. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  215. </div>
  216. <div>
  217. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  218. </div>
  219. <div>
  220. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  221. </div>
  222. <div>
  223. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  224. </div>
  225. <div>
  226. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  227. </div>
  228. <div>
  229. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  230. </div>
  231. <div>
  232. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  233. </div>
  234. <div>
  235. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  236. </div>
  237. <div>
  238. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  239. </div>
  240. <div>
  241. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  242. </div>
  243. <div>
  244. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  245. </div>
  246. <div>
  247. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  248. </div>
  249. <div>
  250. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  251. </div>
  252. <div>
  253. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  254. </div>
  255. <div>
  256. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  257. </div>
  258. <div>
  259. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  260. </div>
  261. <div>
  262. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  263. </div>
  264. <div>
  265. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  266. </div>
  267. <div>
  268. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  269. </div>
  270. <div>
  271. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  272. </div>
  273. <div>
  274. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  275. </div>
  276. <div>
  277. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
  278. </div>
  279. <div>
  280. <span class="xref">System.Object.Equals(System.Object)</span>
  281. </div>
  282. <div>
  283. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  284. </div>
  285. <div>
  286. <span class="xref">System.Object.GetHashCode()</span>
  287. </div>
  288. <div>
  289. <span class="xref">System.Object.GetType()</span>
  290. </div>
  291. <div>
  292. <span class="xref">System.Object.MemberwiseClone()</span>
  293. </div>
  294. <div>
  295. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  296. </div>
  297. </div>
  298. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  299. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  300. <h5 id="Terminal_Gui_Toplevel_syntax">Syntax</h5>
  301. <div class="codewrapper">
  302. <pre><code class="lang-csharp hljs">public class Toplevel : View, IEnumerable</code></pre>
  303. </div>
  304. <h5 id="Terminal_Gui_Toplevel_remarks"><strong>Remarks</strong></h5>
  305. <div class="markdown level0 remarks">
  306. <p>
  307. Toplevels can be modally executing views, and they return control
  308. to the caller when the &quot;Running&quot; property is set to false, or
  309. by calling <span class="xref">Terminal.Gui.Application.RequestStop()</span>
  310. </p>
  311. <p>
  312. There will be a toplevel created for you on the first time use
  313. and can be accessed from the property <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Top">Top</a>,
  314. but new toplevels can be created and ran on top of it. To run, create the
  315. toplevel and then invoke <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Run">Run()</a> with the
  316. new toplevel.
  317. </p>
  318. <p>
  319. TopLevels can also opt-in to more sophisticated initialization
  320. by implementing <span class="xref">System.ComponentModel.ISupportInitialize</span>. When they do
  321. so, the <span class="xref">System.ComponentModel.ISupportInitialize.BeginInit</span> and
  322. <span class="xref">System.ComponentModel.ISupportInitialize.EndInit</span> methods will be called
  323. before running the view.
  324. If first-run-only initialization is preferred, the <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  325. can be implemented too, in which case the <span class="xref">System.ComponentModel.ISupportInitialize</span>
  326. methods will only be called if <span class="xref">System.ComponentModel.ISupportInitializeNotification.IsInitialized</span>
  327. is <span class="xref">false</span>. This allows proper View inheritance hierarchies
  328. to override base class layout code optimally by doing so only on first run,
  329. instead of on every run.
  330. </p>
  331. </div>
  332. <h3 id="constructors">Constructors
  333. </h3>
  334. <a id="Terminal_Gui_Toplevel__ctor_" data-uid="Terminal.Gui.Toplevel.#ctor*"></a>
  335. <h4 id="Terminal_Gui_Toplevel__ctor" data-uid="Terminal.Gui.Toplevel.#ctor">Toplevel()</h4>
  336. <div class="markdown level1 summary">
  337. Initializes a new instance of the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> class with Computed layout, defaulting to <span class="xref">async</span> full screen.
  338. </div>
  339. <div class="markdown level1 conceptual"></div>
  340. <h5 class="decalaration">Declaration</h5>
  341. <div class="codewrapper">
  342. <pre><code class="lang-csharp hljs">public Toplevel()</code></pre>
  343. </div>
  344. <a id="Terminal_Gui_Toplevel__ctor_" data-uid="Terminal.Gui.Toplevel.#ctor*"></a>
  345. <h4 id="Terminal_Gui_Toplevel__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Toplevel.#ctor(Terminal.Gui.Rect)">Toplevel(Rect)</h4>
  346. <div class="markdown level1 summary">
  347. Initializes a new instance of the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> class with the specified absolute layout.
  348. </div>
  349. <div class="markdown level1 conceptual"></div>
  350. <h5 class="decalaration">Declaration</h5>
  351. <div class="codewrapper">
  352. <pre><code class="lang-csharp hljs">public Toplevel(Rect frame)</code></pre>
  353. </div>
  354. <h5 class="parameters">Parameters</h5>
  355. <table class="table table-bordered table-striped table-condensed">
  356. <thead>
  357. <tr>
  358. <th>Type</th>
  359. <th>Name</th>
  360. <th>Description</th>
  361. </tr>
  362. </thead>
  363. <tbody>
  364. <tr>
  365. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  366. <td><span class="parametername">frame</span></td>
  367. <td>Frame.</td>
  368. </tr>
  369. </tbody>
  370. </table>
  371. <h3 id="properties">Properties
  372. </h3>
  373. <a id="Terminal_Gui_Toplevel_CanFocus_" data-uid="Terminal.Gui.Toplevel.CanFocus*"></a>
  374. <h4 id="Terminal_Gui_Toplevel_CanFocus" data-uid="Terminal.Gui.Toplevel.CanFocus">CanFocus</h4>
  375. <div class="markdown level1 summary">
  376. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> can focus.
  377. </div>
  378. <div class="markdown level1 conceptual"></div>
  379. <h5 class="decalaration">Declaration</h5>
  380. <div class="codewrapper">
  381. <pre><code class="lang-csharp hljs">public override bool CanFocus { get; }</code></pre>
  382. </div>
  383. <h5 class="propertyValue">Property Value</h5>
  384. <table class="table table-bordered table-striped table-condensed">
  385. <thead>
  386. <tr>
  387. <th>Type</th>
  388. <th>Description</th>
  389. </tr>
  390. </thead>
  391. <tbody>
  392. <tr>
  393. <td><span class="xref">System.Boolean</span></td>
  394. <td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
  395. </tr>
  396. </tbody>
  397. </table>
  398. <h5 class="overrides">Overrides</h5>
  399. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a></div>
  400. <a id="Terminal_Gui_Toplevel_MenuBar_" data-uid="Terminal.Gui.Toplevel.MenuBar*"></a>
  401. <h4 id="Terminal_Gui_Toplevel_MenuBar" data-uid="Terminal.Gui.Toplevel.MenuBar">MenuBar</h4>
  402. <div class="markdown level1 summary">
  403. Check id current toplevel has menu bar
  404. </div>
  405. <div class="markdown level1 conceptual"></div>
  406. <h5 class="decalaration">Declaration</h5>
  407. <div class="codewrapper">
  408. <pre><code class="lang-csharp hljs">public MenuBar MenuBar { get; set; }</code></pre>
  409. </div>
  410. <h5 class="propertyValue">Property Value</h5>
  411. <table class="table table-bordered table-striped table-condensed">
  412. <thead>
  413. <tr>
  414. <th>Type</th>
  415. <th>Description</th>
  416. </tr>
  417. </thead>
  418. <tbody>
  419. <tr>
  420. <td><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></td>
  421. <td></td>
  422. </tr>
  423. </tbody>
  424. </table>
  425. <a id="Terminal_Gui_Toplevel_Modal_" data-uid="Terminal.Gui.Toplevel.Modal*"></a>
  426. <h4 id="Terminal_Gui_Toplevel_Modal" data-uid="Terminal.Gui.Toplevel.Modal">Modal</h4>
  427. <div class="markdown level1 summary">
  428. Determines whether the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> is modal or not.
  429. Causes <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ProcessKey_Terminal_Gui_KeyEvent_">ProcessKey(KeyEvent)</a> to propagate keys upwards
  430. by default unless set to <span class="xref">true</span>.
  431. </div>
  432. <div class="markdown level1 conceptual"></div>
  433. <h5 class="decalaration">Declaration</h5>
  434. <div class="codewrapper">
  435. <pre><code class="lang-csharp hljs">public bool Modal { get; set; }</code></pre>
  436. </div>
  437. <h5 class="propertyValue">Property Value</h5>
  438. <table class="table table-bordered table-striped table-condensed">
  439. <thead>
  440. <tr>
  441. <th>Type</th>
  442. <th>Description</th>
  443. </tr>
  444. </thead>
  445. <tbody>
  446. <tr>
  447. <td><span class="xref">System.Boolean</span></td>
  448. <td></td>
  449. </tr>
  450. </tbody>
  451. </table>
  452. <a id="Terminal_Gui_Toplevel_Running_" data-uid="Terminal.Gui.Toplevel.Running*"></a>
  453. <h4 id="Terminal_Gui_Toplevel_Running" data-uid="Terminal.Gui.Toplevel.Running">Running</h4>
  454. <div class="markdown level1 summary">
  455. Gets or sets whether the Mainloop for this <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> is running or not. Setting
  456. this property to false will cause the MainLoop to exit.
  457. </div>
  458. <div class="markdown level1 conceptual"></div>
  459. <h5 class="decalaration">Declaration</h5>
  460. <div class="codewrapper">
  461. <pre><code class="lang-csharp hljs">public bool Running { get; set; }</code></pre>
  462. </div>
  463. <h5 class="propertyValue">Property Value</h5>
  464. <table class="table table-bordered table-striped table-condensed">
  465. <thead>
  466. <tr>
  467. <th>Type</th>
  468. <th>Description</th>
  469. </tr>
  470. </thead>
  471. <tbody>
  472. <tr>
  473. <td><span class="xref">System.Boolean</span></td>
  474. <td></td>
  475. </tr>
  476. </tbody>
  477. </table>
  478. <a id="Terminal_Gui_Toplevel_StatusBar_" data-uid="Terminal.Gui.Toplevel.StatusBar*"></a>
  479. <h4 id="Terminal_Gui_Toplevel_StatusBar" data-uid="Terminal.Gui.Toplevel.StatusBar">StatusBar</h4>
  480. <div class="markdown level1 summary">
  481. Check id current toplevel has status bar
  482. </div>
  483. <div class="markdown level1 conceptual"></div>
  484. <h5 class="decalaration">Declaration</h5>
  485. <div class="codewrapper">
  486. <pre><code class="lang-csharp hljs">public StatusBar StatusBar { get; set; }</code></pre>
  487. </div>
  488. <h5 class="propertyValue">Property Value</h5>
  489. <table class="table table-bordered table-striped table-condensed">
  490. <thead>
  491. <tr>
  492. <th>Type</th>
  493. <th>Description</th>
  494. </tr>
  495. </thead>
  496. <tbody>
  497. <tr>
  498. <td><a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a></td>
  499. <td></td>
  500. </tr>
  501. </tbody>
  502. </table>
  503. <h3 id="methods">Methods
  504. </h3>
  505. <a id="Terminal_Gui_Toplevel_Add_" data-uid="Terminal.Gui.Toplevel.Add*"></a>
  506. <h4 id="Terminal_Gui_Toplevel_Add_Terminal_Gui_View_" data-uid="Terminal.Gui.Toplevel.Add(Terminal.Gui.View)">Add(View)</h4>
  507. <div class="markdown level1 summary"></div>
  508. <div class="markdown level1 conceptual"></div>
  509. <h5 class="decalaration">Declaration</h5>
  510. <div class="codewrapper">
  511. <pre><code class="lang-csharp hljs">public override void Add(View view)</code></pre>
  512. </div>
  513. <h5 class="parameters">Parameters</h5>
  514. <table class="table table-bordered table-striped table-condensed">
  515. <thead>
  516. <tr>
  517. <th>Type</th>
  518. <th>Name</th>
  519. <th>Description</th>
  520. </tr>
  521. </thead>
  522. <tbody>
  523. <tr>
  524. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  525. <td><span class="parametername">view</span></td>
  526. <td></td>
  527. </tr>
  528. </tbody>
  529. </table>
  530. <h5 class="overrides">Overrides</h5>
  531. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a></div>
  532. <a id="Terminal_Gui_Toplevel_Create_" data-uid="Terminal.Gui.Toplevel.Create*"></a>
  533. <h4 id="Terminal_Gui_Toplevel_Create" data-uid="Terminal.Gui.Toplevel.Create">Create()</h4>
  534. <div class="markdown level1 summary">
  535. Convenience factory method that creates a new toplevel with the current terminal dimensions.
  536. </div>
  537. <div class="markdown level1 conceptual"></div>
  538. <h5 class="decalaration">Declaration</h5>
  539. <div class="codewrapper">
  540. <pre><code class="lang-csharp hljs">public static Toplevel Create()</code></pre>
  541. </div>
  542. <h5 class="returns">Returns</h5>
  543. <table class="table table-bordered table-striped table-condensed">
  544. <thead>
  545. <tr>
  546. <th>Type</th>
  547. <th>Description</th>
  548. </tr>
  549. </thead>
  550. <tbody>
  551. <tr>
  552. <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
  553. <td>The create.</td>
  554. </tr>
  555. </tbody>
  556. </table>
  557. <a id="Terminal_Gui_Toplevel_ProcessKey_" data-uid="Terminal.Gui.Toplevel.ProcessKey*"></a>
  558. <h4 id="Terminal_Gui_Toplevel_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Toplevel.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  559. <div class="markdown level1 summary"></div>
  560. <div class="markdown level1 conceptual"></div>
  561. <h5 class="decalaration">Declaration</h5>
  562. <div class="codewrapper">
  563. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent keyEvent)</code></pre>
  564. </div>
  565. <h5 class="parameters">Parameters</h5>
  566. <table class="table table-bordered table-striped table-condensed">
  567. <thead>
  568. <tr>
  569. <th>Type</th>
  570. <th>Name</th>
  571. <th>Description</th>
  572. </tr>
  573. </thead>
  574. <tbody>
  575. <tr>
  576. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  577. <td><span class="parametername">keyEvent</span></td>
  578. <td></td>
  579. </tr>
  580. </tbody>
  581. </table>
  582. <h5 class="returns">Returns</h5>
  583. <table class="table table-bordered table-striped table-condensed">
  584. <thead>
  585. <tr>
  586. <th>Type</th>
  587. <th>Description</th>
  588. </tr>
  589. </thead>
  590. <tbody>
  591. <tr>
  592. <td><span class="xref">System.Boolean</span></td>
  593. <td></td>
  594. </tr>
  595. </tbody>
  596. </table>
  597. <h5 class="overrides">Overrides</h5>
  598. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  599. <a id="Terminal_Gui_Toplevel_Redraw_" data-uid="Terminal.Gui.Toplevel.Redraw*"></a>
  600. <h4 id="Terminal_Gui_Toplevel_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Toplevel.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  601. <div class="markdown level1 summary"></div>
  602. <div class="markdown level1 conceptual"></div>
  603. <h5 class="decalaration">Declaration</h5>
  604. <div class="codewrapper">
  605. <pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
  606. </div>
  607. <h5 class="parameters">Parameters</h5>
  608. <table class="table table-bordered table-striped table-condensed">
  609. <thead>
  610. <tr>
  611. <th>Type</th>
  612. <th>Name</th>
  613. <th>Description</th>
  614. </tr>
  615. </thead>
  616. <tbody>
  617. <tr>
  618. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  619. <td><span class="parametername">region</span></td>
  620. <td></td>
  621. </tr>
  622. </tbody>
  623. </table>
  624. <h5 class="overrides">Overrides</h5>
  625. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  626. <a id="Terminal_Gui_Toplevel_Remove_" data-uid="Terminal.Gui.Toplevel.Remove*"></a>
  627. <h4 id="Terminal_Gui_Toplevel_Remove_Terminal_Gui_View_" data-uid="Terminal.Gui.Toplevel.Remove(Terminal.Gui.View)">Remove(View)</h4>
  628. <div class="markdown level1 summary"></div>
  629. <div class="markdown level1 conceptual"></div>
  630. <h5 class="decalaration">Declaration</h5>
  631. <div class="codewrapper">
  632. <pre><code class="lang-csharp hljs">public override void Remove(View view)</code></pre>
  633. </div>
  634. <h5 class="parameters">Parameters</h5>
  635. <table class="table table-bordered table-striped table-condensed">
  636. <thead>
  637. <tr>
  638. <th>Type</th>
  639. <th>Name</th>
  640. <th>Description</th>
  641. </tr>
  642. </thead>
  643. <tbody>
  644. <tr>
  645. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  646. <td><span class="parametername">view</span></td>
  647. <td></td>
  648. </tr>
  649. </tbody>
  650. </table>
  651. <h5 class="overrides">Overrides</h5>
  652. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a></div>
  653. <a id="Terminal_Gui_Toplevel_RemoveAll_" data-uid="Terminal.Gui.Toplevel.RemoveAll*"></a>
  654. <h4 id="Terminal_Gui_Toplevel_RemoveAll" data-uid="Terminal.Gui.Toplevel.RemoveAll">RemoveAll()</h4>
  655. <div class="markdown level1 summary"></div>
  656. <div class="markdown level1 conceptual"></div>
  657. <h5 class="decalaration">Declaration</h5>
  658. <div class="codewrapper">
  659. <pre><code class="lang-csharp hljs">public override void RemoveAll()</code></pre>
  660. </div>
  661. <h5 class="overrides">Overrides</h5>
  662. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a></div>
  663. <a id="Terminal_Gui_Toplevel_WillPresent_" data-uid="Terminal.Gui.Toplevel.WillPresent*"></a>
  664. <h4 id="Terminal_Gui_Toplevel_WillPresent" data-uid="Terminal.Gui.Toplevel.WillPresent">WillPresent()</h4>
  665. <div class="markdown level1 summary">
  666. This method is invoked by Application.Begin as part of the Application.Run after
  667. the views have been laid out, and before the views are drawn for the first time.
  668. </div>
  669. <div class="markdown level1 conceptual"></div>
  670. <h5 class="decalaration">Declaration</h5>
  671. <div class="codewrapper">
  672. <pre><code class="lang-csharp hljs">public virtual void WillPresent()</code></pre>
  673. </div>
  674. <h3 id="events">Events
  675. </h3>
  676. <h4 id="Terminal_Gui_Toplevel_Ready" data-uid="Terminal.Gui.Toplevel.Ready">Ready</h4>
  677. <div class="markdown level1 summary">
  678. Fired once the Toplevel&apos;s MainLoop has started it&apos;s first iteration.
  679. Subscribe to this event to perform tasks when the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> has been laid out and focus has been set.
  680. changes. A Ready event handler is a good place to finalize initialization after calling `<a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Run">Run()</a>(topLevel)`.
  681. </div>
  682. <div class="markdown level1 conceptual"></div>
  683. <h5 class="decalaration">Declaration</h5>
  684. <div class="codewrapper">
  685. <pre><code class="lang-csharp hljs">public event EventHandler Ready</code></pre>
  686. </div>
  687. <h5 class="eventType">Event Type</h5>
  688. <table class="table table-bordered table-striped table-condensed">
  689. <thead>
  690. <tr>
  691. <th>Type</th>
  692. <th>Description</th>
  693. </tr>
  694. </thead>
  695. <tbody>
  696. <tr>
  697. <td><span class="xref">System.EventHandler</span></td>
  698. <td></td>
  699. </tr>
  700. </tbody>
  701. </table>
  702. <h3 id="implements">Implements</h3>
  703. <div>
  704. <span class="xref">System.Collections.IEnumerable</span>
  705. </div>
  706. </article>
  707. </div>
  708. <div class="hidden-sm col-md-2" role="complementary">
  709. <div class="sideaffix">
  710. <div class="contribution">
  711. <ul class="nav">
  712. </ul>
  713. </div>
  714. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  715. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  716. </nav>
  717. </div>
  718. </div>
  719. </div>
  720. </div>
  721. <footer>
  722. <div class="grad-bottom"></div>
  723. <div class="footer">
  724. <div class="container">
  725. <span class="pull-right">
  726. <a href="#top">Back to top</a>
  727. </span>
  728. <span>Generated by <strong>DocFX</strong></span>
  729. </div>
  730. </div>
  731. </footer>
  732. </div>
  733. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  734. <script type="text/javascript" src="../../styles/docfx.js"></script>
  735. <script type="text/javascript" src="../../styles/main.js"></script>
  736. </body>
  737. </html>