Terminal.Gui.Toplevel.html 31 KB

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