Terminal.Gui.Toplevel.html 80 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868
  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.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. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.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. They are used for both an application&apos;s main view (filling the entire screeN and
  77. 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>.
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  84. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  85. <div class="level3"><span class="xref">Toplevel</span></div>
  86. <div class="level4"><a class="xref" href="Terminal.Gui.Border.ToplevelContainer.html">Border.ToplevelContainer</a></div>
  87. <div class="level4"><a class="xref" href="Terminal.Gui.Window.html">Window</a></div>
  88. </div>
  89. <div class="implements">
  90. <h5>Implements</h5>
  91. <div><span class="xref">System.IDisposable</span></div>
  92. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  93. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  94. </div>
  95. <div class="inheritedMembers">
  96. <h5>Inherited Members</h5>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(Size)</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  150. </div>
  151. <div>
  152. <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>
  153. </div>
  154. <div>
  155. <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>
  156. </div>
  157. <div>
  158. <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>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(Int32, Int32, Boolean)</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command_">View.AddKeyBinding(Key, Command)</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command_">View.ClearKeybinding(Command)</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddCommand_Terminal_Gui_Command_System_Func_System_Nullable_System_Boolean___">View.AddCommand(Command, Func&lt;Nullable&lt;Boolean&gt;&gt;)</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command_">View.GetKeyFromCommand(Command)</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  237. </div>
  238. <div>
  239. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  240. </div>
  241. <div>
  242. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  243. </div>
  244. <div>
  245. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(Boolean)</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnCanFocusChanged">View.OnCanFocusChanged()</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  327. </div>
  328. <div>
  329. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  330. </div>
  331. <div>
  332. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  333. </div>
  334. <div>
  335. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  336. </div>
  337. <div>
  338. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  339. </div>
  340. <div>
  341. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  342. </div>
  343. <div>
  344. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  345. </div>
  346. <div>
  347. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  348. </div>
  349. <div>
  350. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  351. </div>
  352. <div>
  353. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  354. </div>
  355. <div>
  356. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  357. </div>
  358. <div>
  359. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  360. </div>
  361. <div>
  362. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  363. </div>
  364. <div>
  365. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  366. </div>
  367. <div>
  368. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  369. </div>
  370. <div>
  371. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
  372. </div>
  373. <div>
  374. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
  375. </div>
  376. <div>
  377. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  378. </div>
  379. <div>
  380. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  381. </div>
  382. <div>
  383. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  384. </div>
  385. <div>
  386. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  387. </div>
  388. <div>
  389. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  390. </div>
  391. <div>
  392. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  393. </div>
  394. <div>
  395. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  396. </div>
  397. <div>
  398. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
  399. </div>
  400. <div>
  401. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  402. </div>
  403. <div>
  404. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  405. </div>
  406. <div>
  407. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
  408. </div>
  409. <div>
  410. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  411. </div>
  412. <div>
  413. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
  414. </div>
  415. <div>
  416. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
  417. </div>
  418. <div>
  419. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  420. </div>
  421. <div>
  422. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Border">View.Border</a>
  423. </div>
  424. <div>
  425. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  426. </div>
  427. <div>
  428. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  429. </div>
  430. <div>
  431. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  432. </div>
  433. <div>
  434. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  435. </div>
  436. <div>
  437. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  438. </div>
  439. <div>
  440. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  441. </div>
  442. <div>
  443. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  444. </div>
  445. <div>
  446. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
  447. </div>
  448. <div>
  449. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
  450. </div>
  451. <div>
  452. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
  453. </div>
  454. <div>
  455. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
  456. </div>
  457. <div>
  458. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  459. </div>
  460. <div>
  461. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
  462. </div>
  463. <div>
  464. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  465. </div>
  466. <div>
  467. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  468. </div>
  469. <div>
  470. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  471. </div>
  472. <div>
  473. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  474. </div>
  475. <div>
  476. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  477. </div>
  478. <div>
  479. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  480. </div>
  481. <div>
  482. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  483. </div>
  484. </div>
  485. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  486. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  487. <h5 id="Terminal_Gui_Toplevel_syntax">Syntax</h5>
  488. <div class="codewrapper">
  489. <pre><code class="lang-csharp hljs">public class Toplevel : View</code></pre>
  490. </div>
  491. <h5 id="Terminal_Gui_Toplevel_remarks"><strong>Remarks</strong></h5>
  492. <div class="markdown level0 remarks">
  493. <p>
  494. Toplevels can be modally executing views, started by calling <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Run_Terminal_Gui_Toplevel_System_Func_System_Exception_System_Boolean__">Run(Toplevel, Func&lt;Exception, Boolean&gt;)</a>.
  495. They return control to the caller when <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RequestStop_Terminal_Gui_Toplevel_">RequestStop(Toplevel)</a> has
  496. been called (which sets the <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Running">Running</a> property to <code>false</code>).
  497. </p>
  498. <p>
  499. A Toplevel is created when an application initializes Terminal.Gui by calling <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Init_Terminal_Gui_ConsoleDriver_Terminal_Gui_IMainLoopDriver_">Init(ConsoleDriver, IMainLoopDriver)</a>.
  500. The application Toplevel can be accessed via <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Top">Top</a>. Additional Toplevels can be created
  501. and run (e.g. <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a>s. To run a Toplevel, create the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> and
  502. call <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Run_Terminal_Gui_Toplevel_System_Func_System_Exception_System_Boolean__">Run(Toplevel, Func&lt;Exception, Boolean&gt;)</a>.
  503. </p>
  504. <p>
  505. Toplevels can also opt-in to more sophisticated initialization
  506. by implementing <span class="xref">System.ComponentModel.ISupportInitialize</span>. When they do
  507. so, the <span class="xref">System.ComponentModel.ISupportInitialize.BeginInit</span> and
  508. <span class="xref">System.ComponentModel.ISupportInitialize.EndInit</span> methods will be called
  509. before running the view.
  510. If first-run-only initialization is preferred, the <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  511. can be implemented too, in which case the <span class="xref">System.ComponentModel.ISupportInitialize</span>
  512. methods will only be called if <span class="xref">System.ComponentModel.ISupportInitializeNotification.IsInitialized</span>
  513. is <span class="xref">false</span>. This allows proper <a class="xref" href="Terminal.Gui.View.html">View</a> inheritance hierarchies
  514. to override base class layout code optimally by doing so only on first run,
  515. instead of on every run.
  516. </p>
  517. </div>
  518. <h3 id="constructors">Constructors
  519. </h3>
  520. <a id="Terminal_Gui_Toplevel__ctor_" data-uid="Terminal.Gui.Toplevel.#ctor*"></a>
  521. <h4 id="Terminal_Gui_Toplevel__ctor" data-uid="Terminal.Gui.Toplevel.#ctor">Toplevel()</h4>
  522. <div class="markdown level1 summary">
  523. Initializes a new instance of the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> class with <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout,
  524. defaulting to full screen.
  525. </div>
  526. <div class="markdown level1 conceptual"></div>
  527. <h5 class="decalaration">Declaration</h5>
  528. <div class="codewrapper">
  529. <pre><code class="lang-csharp hljs">public Toplevel()</code></pre>
  530. </div>
  531. <a id="Terminal_Gui_Toplevel__ctor_" data-uid="Terminal.Gui.Toplevel.#ctor*"></a>
  532. <h4 id="Terminal_Gui_Toplevel__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Toplevel.#ctor(Terminal.Gui.Rect)">Toplevel(Rect)</h4>
  533. <div class="markdown level1 summary">
  534. Initializes a new instance of the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> class with the specified <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
  535. </div>
  536. <div class="markdown level1 conceptual"></div>
  537. <h5 class="decalaration">Declaration</h5>
  538. <div class="codewrapper">
  539. <pre><code class="lang-csharp hljs">public Toplevel(Rect frame)</code></pre>
  540. </div>
  541. <h5 class="parameters">Parameters</h5>
  542. <table class="table table-bordered table-striped table-condensed">
  543. <thead>
  544. <tr>
  545. <th>Type</th>
  546. <th>Name</th>
  547. <th>Description</th>
  548. </tr>
  549. </thead>
  550. <tbody>
  551. <tr>
  552. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  553. <td><span class="parametername">frame</span></td>
  554. <td>A superview-relative rectangle specifying the location and size for the new Toplevel</td>
  555. </tr>
  556. </tbody>
  557. </table>
  558. <h3 id="properties">Properties
  559. </h3>
  560. <a id="Terminal_Gui_Toplevel_CanFocus_" data-uid="Terminal.Gui.Toplevel.CanFocus*"></a>
  561. <h4 id="Terminal_Gui_Toplevel_CanFocus" data-uid="Terminal.Gui.Toplevel.CanFocus">CanFocus</h4>
  562. <div class="markdown level1 summary">
  563. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> can focus.
  564. </div>
  565. <div class="markdown level1 conceptual"></div>
  566. <h5 class="decalaration">Declaration</h5>
  567. <div class="codewrapper">
  568. <pre><code class="lang-csharp hljs">public override bool CanFocus { get; }</code></pre>
  569. </div>
  570. <h5 class="propertyValue">Property Value</h5>
  571. <table class="table table-bordered table-striped table-condensed">
  572. <thead>
  573. <tr>
  574. <th>Type</th>
  575. <th>Description</th>
  576. </tr>
  577. </thead>
  578. <tbody>
  579. <tr>
  580. <td><span class="xref">System.Boolean</span></td>
  581. <td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
  582. </tr>
  583. </tbody>
  584. </table>
  585. <h5 class="overrides">Overrides</h5>
  586. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a></div>
  587. <a id="Terminal_Gui_Toplevel_IsMdiChild_" data-uid="Terminal.Gui.Toplevel.IsMdiChild*"></a>
  588. <h4 id="Terminal_Gui_Toplevel_IsMdiChild" data-uid="Terminal.Gui.Toplevel.IsMdiChild">IsMdiChild</h4>
  589. <div class="markdown level1 summary">
  590. Gets or sets if this Toplevel is a Mdi child.
  591. </div>
  592. <div class="markdown level1 conceptual"></div>
  593. <h5 class="decalaration">Declaration</h5>
  594. <div class="codewrapper">
  595. <pre><code class="lang-csharp hljs">public bool IsMdiChild { get; }</code></pre>
  596. </div>
  597. <h5 class="propertyValue">Property Value</h5>
  598. <table class="table table-bordered table-striped table-condensed">
  599. <thead>
  600. <tr>
  601. <th>Type</th>
  602. <th>Description</th>
  603. </tr>
  604. </thead>
  605. <tbody>
  606. <tr>
  607. <td><span class="xref">System.Boolean</span></td>
  608. <td></td>
  609. </tr>
  610. </tbody>
  611. </table>
  612. <a id="Terminal_Gui_Toplevel_IsMdiContainer_" data-uid="Terminal.Gui.Toplevel.IsMdiContainer*"></a>
  613. <h4 id="Terminal_Gui_Toplevel_IsMdiContainer" data-uid="Terminal.Gui.Toplevel.IsMdiContainer">IsMdiContainer</h4>
  614. <div class="markdown level1 summary">
  615. Gets or sets if this Toplevel is a Mdi container.
  616. </div>
  617. <div class="markdown level1 conceptual"></div>
  618. <h5 class="decalaration">Declaration</h5>
  619. <div class="codewrapper">
  620. <pre><code class="lang-csharp hljs">public bool IsMdiContainer { get; set; }</code></pre>
  621. </div>
  622. <h5 class="propertyValue">Property Value</h5>
  623. <table class="table table-bordered table-striped table-condensed">
  624. <thead>
  625. <tr>
  626. <th>Type</th>
  627. <th>Description</th>
  628. </tr>
  629. </thead>
  630. <tbody>
  631. <tr>
  632. <td><span class="xref">System.Boolean</span></td>
  633. <td></td>
  634. </tr>
  635. </tbody>
  636. </table>
  637. <a id="Terminal_Gui_Toplevel_MenuBar_" data-uid="Terminal.Gui.Toplevel.MenuBar*"></a>
  638. <h4 id="Terminal_Gui_Toplevel_MenuBar" data-uid="Terminal.Gui.Toplevel.MenuBar">MenuBar</h4>
  639. <div class="markdown level1 summary">
  640. Gets or sets the menu for this Toplevel.
  641. </div>
  642. <div class="markdown level1 conceptual"></div>
  643. <h5 class="decalaration">Declaration</h5>
  644. <div class="codewrapper">
  645. <pre><code class="lang-csharp hljs">public virtual MenuBar MenuBar { get; set; }</code></pre>
  646. </div>
  647. <h5 class="propertyValue">Property Value</h5>
  648. <table class="table table-bordered table-striped table-condensed">
  649. <thead>
  650. <tr>
  651. <th>Type</th>
  652. <th>Description</th>
  653. </tr>
  654. </thead>
  655. <tbody>
  656. <tr>
  657. <td><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></td>
  658. <td></td>
  659. </tr>
  660. </tbody>
  661. </table>
  662. <a id="Terminal_Gui_Toplevel_Modal_" data-uid="Terminal.Gui.Toplevel.Modal*"></a>
  663. <h4 id="Terminal_Gui_Toplevel_Modal" data-uid="Terminal.Gui.Toplevel.Modal">Modal</h4>
  664. <div class="markdown level1 summary">
  665. Determines whether the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> is modal or not.
  666. If set to <code>false</code> (the default):
  667. <ul><li><a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ProcessKey_Terminal_Gui_KeyEvent_">ProcessKey(KeyEvent)</a> events will propagate keys upwards.</li><li>The Toplevel will act as an embedded view (not a modal/pop-up).</li></ul>
  668. If set to <code>true</code>:
  669. <ul><li><a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ProcessKey_Terminal_Gui_KeyEvent_">ProcessKey(KeyEvent)</a> events will NOT propogate keys upwards.</li><li>The Toplevel will and look like a modal (pop-up) (e.g. see <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a>.</li></ul>
  670. </div>
  671. <div class="markdown level1 conceptual"></div>
  672. <h5 class="decalaration">Declaration</h5>
  673. <div class="codewrapper">
  674. <pre><code class="lang-csharp hljs">public bool Modal { get; set; }</code></pre>
  675. </div>
  676. <h5 class="propertyValue">Property Value</h5>
  677. <table class="table table-bordered table-striped table-condensed">
  678. <thead>
  679. <tr>
  680. <th>Type</th>
  681. <th>Description</th>
  682. </tr>
  683. </thead>
  684. <tbody>
  685. <tr>
  686. <td><span class="xref">System.Boolean</span></td>
  687. <td></td>
  688. </tr>
  689. </tbody>
  690. </table>
  691. <a id="Terminal_Gui_Toplevel_Running_" data-uid="Terminal.Gui.Toplevel.Running*"></a>
  692. <h4 id="Terminal_Gui_Toplevel_Running" data-uid="Terminal.Gui.Toplevel.Running">Running</h4>
  693. <div class="markdown level1 summary">
  694. Gets or sets whether the <a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a> for this <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> is running or not.
  695. </div>
  696. <div class="markdown level1 conceptual"></div>
  697. <h5 class="decalaration">Declaration</h5>
  698. <div class="codewrapper">
  699. <pre><code class="lang-csharp hljs">public bool Running { get; set; }</code></pre>
  700. </div>
  701. <h5 class="propertyValue">Property Value</h5>
  702. <table class="table table-bordered table-striped table-condensed">
  703. <thead>
  704. <tr>
  705. <th>Type</th>
  706. <th>Description</th>
  707. </tr>
  708. </thead>
  709. <tbody>
  710. <tr>
  711. <td><span class="xref">System.Boolean</span></td>
  712. <td></td>
  713. </tr>
  714. </tbody>
  715. </table>
  716. <h5 id="Terminal_Gui_Toplevel_Running_remarks">Remarks</h5>
  717. <div class="markdown level1 remarks">
  718. Setting this property directly is discouraged. Use <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RequestStop_Terminal_Gui_Toplevel_">RequestStop(Toplevel)</a> instead.
  719. </div>
  720. <a id="Terminal_Gui_Toplevel_StatusBar_" data-uid="Terminal.Gui.Toplevel.StatusBar*"></a>
  721. <h4 id="Terminal_Gui_Toplevel_StatusBar" data-uid="Terminal.Gui.Toplevel.StatusBar">StatusBar</h4>
  722. <div class="markdown level1 summary">
  723. Gets or sets the status bar for this Toplevel.
  724. </div>
  725. <div class="markdown level1 conceptual"></div>
  726. <h5 class="decalaration">Declaration</h5>
  727. <div class="codewrapper">
  728. <pre><code class="lang-csharp hljs">public virtual StatusBar StatusBar { get; set; }</code></pre>
  729. </div>
  730. <h5 class="propertyValue">Property Value</h5>
  731. <table class="table table-bordered table-striped table-condensed">
  732. <thead>
  733. <tr>
  734. <th>Type</th>
  735. <th>Description</th>
  736. </tr>
  737. </thead>
  738. <tbody>
  739. <tr>
  740. <td><a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a></td>
  741. <td></td>
  742. </tr>
  743. </tbody>
  744. </table>
  745. <h3 id="methods">Methods
  746. </h3>
  747. <a id="Terminal_Gui_Toplevel_Add_" data-uid="Terminal.Gui.Toplevel.Add*"></a>
  748. <h4 id="Terminal_Gui_Toplevel_Add_Terminal_Gui_View_" data-uid="Terminal.Gui.Toplevel.Add(Terminal.Gui.View)">Add(View)</h4>
  749. <div class="markdown level1 summary">
  750. Adds a subview (child) to this view.
  751. </div>
  752. <div class="markdown level1 conceptual"></div>
  753. <h5 class="decalaration">Declaration</h5>
  754. <div class="codewrapper">
  755. <pre><code class="lang-csharp hljs">public override void Add(View view)</code></pre>
  756. </div>
  757. <h5 class="parameters">Parameters</h5>
  758. <table class="table table-bordered table-striped table-condensed">
  759. <thead>
  760. <tr>
  761. <th>Type</th>
  762. <th>Name</th>
  763. <th>Description</th>
  764. </tr>
  765. </thead>
  766. <tbody>
  767. <tr>
  768. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  769. <td><span class="parametername">view</span></td>
  770. <td></td>
  771. </tr>
  772. </tbody>
  773. </table>
  774. <h5 class="overrides">Overrides</h5>
  775. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a></div>
  776. <h5 id="Terminal_Gui_Toplevel_Add_Terminal_Gui_View__remarks">Remarks</h5>
  777. <div class="markdown level1 remarks">
  778. The Views that have been added to this view can be retrieved via the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">Subviews</a> property. See also <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">Remove(View)</a> <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">RemoveAll()</a>
  779. </div>
  780. <a id="Terminal_Gui_Toplevel_Create_" data-uid="Terminal.Gui.Toplevel.Create*"></a>
  781. <h4 id="Terminal_Gui_Toplevel_Create" data-uid="Terminal.Gui.Toplevel.Create">Create()</h4>
  782. <div class="markdown level1 summary">
  783. Convenience factory method that creates a new Toplevel with the current terminal dimensions.
  784. </div>
  785. <div class="markdown level1 conceptual"></div>
  786. <h5 class="decalaration">Declaration</h5>
  787. <div class="codewrapper">
  788. <pre><code class="lang-csharp hljs">public static Toplevel Create()</code></pre>
  789. </div>
  790. <h5 class="returns">Returns</h5>
  791. <table class="table table-bordered table-striped table-condensed">
  792. <thead>
  793. <tr>
  794. <th>Type</th>
  795. <th>Description</th>
  796. </tr>
  797. </thead>
  798. <tbody>
  799. <tr>
  800. <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
  801. <td>The created Toplevel.</td>
  802. </tr>
  803. </tbody>
  804. </table>
  805. <a id="Terminal_Gui_Toplevel_GetTopMdiChild_" data-uid="Terminal.Gui.Toplevel.GetTopMdiChild*"></a>
  806. <h4 id="Terminal_Gui_Toplevel_GetTopMdiChild_System_Type_System_String___" data-uid="Terminal.Gui.Toplevel.GetTopMdiChild(System.Type,System.String[])">GetTopMdiChild(Type, String[])</h4>
  807. <div class="markdown level1 summary">
  808. Gets the current visible Toplevel Mdi child that matches the arguments pattern.
  809. </div>
  810. <div class="markdown level1 conceptual"></div>
  811. <h5 class="decalaration">Declaration</h5>
  812. <div class="codewrapper">
  813. <pre><code class="lang-csharp hljs">public View GetTopMdiChild(Type type = null, string[] exclude = null)</code></pre>
  814. </div>
  815. <h5 class="parameters">Parameters</h5>
  816. <table class="table table-bordered table-striped table-condensed">
  817. <thead>
  818. <tr>
  819. <th>Type</th>
  820. <th>Name</th>
  821. <th>Description</th>
  822. </tr>
  823. </thead>
  824. <tbody>
  825. <tr>
  826. <td><span class="xref">System.Type</span></td>
  827. <td><span class="parametername">type</span></td>
  828. <td>The type.</td>
  829. </tr>
  830. <tr>
  831. <td><span class="xref">System.String</span>[]</td>
  832. <td><span class="parametername">exclude</span></td>
  833. <td>The strings to exclude.</td>
  834. </tr>
  835. </tbody>
  836. </table>
  837. <h5 class="returns">Returns</h5>
  838. <table class="table table-bordered table-striped table-condensed">
  839. <thead>
  840. <tr>
  841. <th>Type</th>
  842. <th>Description</th>
  843. </tr>
  844. </thead>
  845. <tbody>
  846. <tr>
  847. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  848. <td>The matched view.</td>
  849. </tr>
  850. </tbody>
  851. </table>
  852. <a id="Terminal_Gui_Toplevel_MouseEvent_" data-uid="Terminal.Gui.Toplevel.MouseEvent*"></a>
  853. <h4 id="Terminal_Gui_Toplevel_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Toplevel.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  854. <div class="markdown level1 summary">
  855. Method invoked when a mouse event is generated
  856. </div>
  857. <div class="markdown level1 conceptual"></div>
  858. <h5 class="decalaration">Declaration</h5>
  859. <div class="codewrapper">
  860. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent mouseEvent)</code></pre>
  861. </div>
  862. <h5 class="parameters">Parameters</h5>
  863. <table class="table table-bordered table-striped table-condensed">
  864. <thead>
  865. <tr>
  866. <th>Type</th>
  867. <th>Name</th>
  868. <th>Description</th>
  869. </tr>
  870. </thead>
  871. <tbody>
  872. <tr>
  873. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  874. <td><span class="parametername">mouseEvent</span></td>
  875. <td>Contains the details about the mouse event.</td>
  876. </tr>
  877. </tbody>
  878. </table>
  879. <h5 class="returns">Returns</h5>
  880. <table class="table table-bordered table-striped table-condensed">
  881. <thead>
  882. <tr>
  883. <th>Type</th>
  884. <th>Description</th>
  885. </tr>
  886. </thead>
  887. <tbody>
  888. <tr>
  889. <td><span class="xref">System.Boolean</span></td>
  890. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  891. </tr>
  892. </tbody>
  893. </table>
  894. <h5 class="overrides">Overrides</h5>
  895. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  896. <a id="Terminal_Gui_Toplevel_MoveNext_" data-uid="Terminal.Gui.Toplevel.MoveNext*"></a>
  897. <h4 id="Terminal_Gui_Toplevel_MoveNext" data-uid="Terminal.Gui.Toplevel.MoveNext">MoveNext()</h4>
  898. <div class="markdown level1 summary">
  899. Move to the next Mdi child from the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_MdiTop">MdiTop</a>.
  900. </div>
  901. <div class="markdown level1 conceptual"></div>
  902. <h5 class="decalaration">Declaration</h5>
  903. <div class="codewrapper">
  904. <pre><code class="lang-csharp hljs">public virtual void MoveNext()</code></pre>
  905. </div>
  906. <a id="Terminal_Gui_Toplevel_MovePrevious_" data-uid="Terminal.Gui.Toplevel.MovePrevious*"></a>
  907. <h4 id="Terminal_Gui_Toplevel_MovePrevious" data-uid="Terminal.Gui.Toplevel.MovePrevious">MovePrevious()</h4>
  908. <div class="markdown level1 summary">
  909. Move to the previous Mdi child from the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_MdiTop">MdiTop</a>.
  910. </div>
  911. <div class="markdown level1 conceptual"></div>
  912. <h5 class="decalaration">Declaration</h5>
  913. <div class="codewrapper">
  914. <pre><code class="lang-csharp hljs">public virtual void MovePrevious()</code></pre>
  915. </div>
  916. <a id="Terminal_Gui_Toplevel_OnAlternateBackwardKeyChanged_" data-uid="Terminal.Gui.Toplevel.OnAlternateBackwardKeyChanged*"></a>
  917. <h4 id="Terminal_Gui_Toplevel_OnAlternateBackwardKeyChanged_Terminal_Gui_Key_" data-uid="Terminal.Gui.Toplevel.OnAlternateBackwardKeyChanged(Terminal.Gui.Key)">OnAlternateBackwardKeyChanged(Key)</h4>
  918. <div class="markdown level1 summary">
  919. Virtual method to invoke the <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_AlternateBackwardKeyChanged">AlternateBackwardKeyChanged</a> event.
  920. </div>
  921. <div class="markdown level1 conceptual"></div>
  922. <h5 class="decalaration">Declaration</h5>
  923. <div class="codewrapper">
  924. <pre><code class="lang-csharp hljs">public virtual void OnAlternateBackwardKeyChanged(Key oldKey)</code></pre>
  925. </div>
  926. <h5 class="parameters">Parameters</h5>
  927. <table class="table table-bordered table-striped table-condensed">
  928. <thead>
  929. <tr>
  930. <th>Type</th>
  931. <th>Name</th>
  932. <th>Description</th>
  933. </tr>
  934. </thead>
  935. <tbody>
  936. <tr>
  937. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  938. <td><span class="parametername">oldKey</span></td>
  939. <td></td>
  940. </tr>
  941. </tbody>
  942. </table>
  943. <a id="Terminal_Gui_Toplevel_OnAlternateForwardKeyChanged_" data-uid="Terminal.Gui.Toplevel.OnAlternateForwardKeyChanged*"></a>
  944. <h4 id="Terminal_Gui_Toplevel_OnAlternateForwardKeyChanged_Terminal_Gui_Key_" data-uid="Terminal.Gui.Toplevel.OnAlternateForwardKeyChanged(Terminal.Gui.Key)">OnAlternateForwardKeyChanged(Key)</h4>
  945. <div class="markdown level1 summary">
  946. Virtual method to invoke the <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_AlternateForwardKeyChanged">AlternateForwardKeyChanged</a> event.
  947. </div>
  948. <div class="markdown level1 conceptual"></div>
  949. <h5 class="decalaration">Declaration</h5>
  950. <div class="codewrapper">
  951. <pre><code class="lang-csharp hljs">public virtual void OnAlternateForwardKeyChanged(Key oldKey)</code></pre>
  952. </div>
  953. <h5 class="parameters">Parameters</h5>
  954. <table class="table table-bordered table-striped table-condensed">
  955. <thead>
  956. <tr>
  957. <th>Type</th>
  958. <th>Name</th>
  959. <th>Description</th>
  960. </tr>
  961. </thead>
  962. <tbody>
  963. <tr>
  964. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  965. <td><span class="parametername">oldKey</span></td>
  966. <td></td>
  967. </tr>
  968. </tbody>
  969. </table>
  970. <a id="Terminal_Gui_Toplevel_OnKeyDown_" data-uid="Terminal.Gui.Toplevel.OnKeyDown*"></a>
  971. <h4 id="Terminal_Gui_Toplevel_OnKeyDown_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Toplevel.OnKeyDown(Terminal.Gui.KeyEvent)">OnKeyDown(KeyEvent)</h4>
  972. <div class="markdown level1 summary">
  973. Method invoked when a key is pressed.
  974. </div>
  975. <div class="markdown level1 conceptual"></div>
  976. <h5 class="decalaration">Declaration</h5>
  977. <div class="codewrapper">
  978. <pre><code class="lang-csharp hljs">public override bool OnKeyDown(KeyEvent keyEvent)</code></pre>
  979. </div>
  980. <h5 class="parameters">Parameters</h5>
  981. <table class="table table-bordered table-striped table-condensed">
  982. <thead>
  983. <tr>
  984. <th>Type</th>
  985. <th>Name</th>
  986. <th>Description</th>
  987. </tr>
  988. </thead>
  989. <tbody>
  990. <tr>
  991. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  992. <td><span class="parametername">keyEvent</span></td>
  993. <td>Contains the details about the key that produced the event.</td>
  994. </tr>
  995. </tbody>
  996. </table>
  997. <h5 class="returns">Returns</h5>
  998. <table class="table table-bordered table-striped table-condensed">
  999. <thead>
  1000. <tr>
  1001. <th>Type</th>
  1002. <th>Description</th>
  1003. </tr>
  1004. </thead>
  1005. <tbody>
  1006. <tr>
  1007. <td><span class="xref">System.Boolean</span></td>
  1008. <td>true if the event was handled</td>
  1009. </tr>
  1010. </tbody>
  1011. </table>
  1012. <h5 class="overrides">Overrides</h5>
  1013. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a></div>
  1014. <a id="Terminal_Gui_Toplevel_OnKeyUp_" data-uid="Terminal.Gui.Toplevel.OnKeyUp*"></a>
  1015. <h4 id="Terminal_Gui_Toplevel_OnKeyUp_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Toplevel.OnKeyUp(Terminal.Gui.KeyEvent)">OnKeyUp(KeyEvent)</h4>
  1016. <div class="markdown level1 summary">
  1017. Method invoked when a key is released.
  1018. </div>
  1019. <div class="markdown level1 conceptual"></div>
  1020. <h5 class="decalaration">Declaration</h5>
  1021. <div class="codewrapper">
  1022. <pre><code class="lang-csharp hljs">public override bool OnKeyUp(KeyEvent keyEvent)</code></pre>
  1023. </div>
  1024. <h5 class="parameters">Parameters</h5>
  1025. <table class="table table-bordered table-striped table-condensed">
  1026. <thead>
  1027. <tr>
  1028. <th>Type</th>
  1029. <th>Name</th>
  1030. <th>Description</th>
  1031. </tr>
  1032. </thead>
  1033. <tbody>
  1034. <tr>
  1035. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1036. <td><span class="parametername">keyEvent</span></td>
  1037. <td>Contains the details about the key that produced the event.</td>
  1038. </tr>
  1039. </tbody>
  1040. </table>
  1041. <h5 class="returns">Returns</h5>
  1042. <table class="table table-bordered table-striped table-condensed">
  1043. <thead>
  1044. <tr>
  1045. <th>Type</th>
  1046. <th>Description</th>
  1047. </tr>
  1048. </thead>
  1049. <tbody>
  1050. <tr>
  1051. <td><span class="xref">System.Boolean</span></td>
  1052. <td>true if the event was handled</td>
  1053. </tr>
  1054. </tbody>
  1055. </table>
  1056. <h5 class="overrides">Overrides</h5>
  1057. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a></div>
  1058. <a id="Terminal_Gui_Toplevel_OnLoaded_" data-uid="Terminal.Gui.Toplevel.OnLoaded*"></a>
  1059. <h4 id="Terminal_Gui_Toplevel_OnLoaded" data-uid="Terminal.Gui.Toplevel.OnLoaded">OnLoaded()</h4>
  1060. <div class="markdown level1 summary">
  1061. Called from <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Begin_Terminal_Gui_Toplevel_">Begin(Toplevel)</a> before the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> redraws for the first time.
  1062. </div>
  1063. <div class="markdown level1 conceptual"></div>
  1064. <h5 class="decalaration">Declaration</h5>
  1065. <div class="codewrapper">
  1066. <pre><code class="lang-csharp hljs">public virtual void OnLoaded()</code></pre>
  1067. </div>
  1068. <a id="Terminal_Gui_Toplevel_OnQuitKeyChanged_" data-uid="Terminal.Gui.Toplevel.OnQuitKeyChanged*"></a>
  1069. <h4 id="Terminal_Gui_Toplevel_OnQuitKeyChanged_Terminal_Gui_Key_" data-uid="Terminal.Gui.Toplevel.OnQuitKeyChanged(Terminal.Gui.Key)">OnQuitKeyChanged(Key)</h4>
  1070. <div class="markdown level1 summary">
  1071. Virtual method to invoke the <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_QuitKeyChanged">QuitKeyChanged</a> event.
  1072. </div>
  1073. <div class="markdown level1 conceptual"></div>
  1074. <h5 class="decalaration">Declaration</h5>
  1075. <div class="codewrapper">
  1076. <pre><code class="lang-csharp hljs">public virtual void OnQuitKeyChanged(Key oldKey)</code></pre>
  1077. </div>
  1078. <h5 class="parameters">Parameters</h5>
  1079. <table class="table table-bordered table-striped table-condensed">
  1080. <thead>
  1081. <tr>
  1082. <th>Type</th>
  1083. <th>Name</th>
  1084. <th>Description</th>
  1085. </tr>
  1086. </thead>
  1087. <tbody>
  1088. <tr>
  1089. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  1090. <td><span class="parametername">oldKey</span></td>
  1091. <td></td>
  1092. </tr>
  1093. </tbody>
  1094. </table>
  1095. <a id="Terminal_Gui_Toplevel_PositionCursor_" data-uid="Terminal.Gui.Toplevel.PositionCursor*"></a>
  1096. <h4 id="Terminal_Gui_Toplevel_PositionCursor" data-uid="Terminal.Gui.Toplevel.PositionCursor">PositionCursor()</h4>
  1097. <div class="markdown level1 summary">
  1098. Positions the cursor in the right position based on the currently focused view in the chain.
  1099. </div>
  1100. <div class="markdown level1 conceptual"></div>
  1101. <h5 class="decalaration">Declaration</h5>
  1102. <div class="codewrapper">
  1103. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  1104. </div>
  1105. <h5 class="overrides">Overrides</h5>
  1106. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  1107. <a id="Terminal_Gui_Toplevel_PositionToplevel_" data-uid="Terminal.Gui.Toplevel.PositionToplevel*"></a>
  1108. <h4 id="Terminal_Gui_Toplevel_PositionToplevel_Terminal_Gui_Toplevel_" data-uid="Terminal.Gui.Toplevel.PositionToplevel(Terminal.Gui.Toplevel)">PositionToplevel(Toplevel)</h4>
  1109. <div class="markdown level1 summary">
  1110. Virtual method enabling implementation of specific positions for inherited <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> views.
  1111. </div>
  1112. <div class="markdown level1 conceptual"></div>
  1113. <h5 class="decalaration">Declaration</h5>
  1114. <div class="codewrapper">
  1115. <pre><code class="lang-csharp hljs">public virtual void PositionToplevel(Toplevel top)</code></pre>
  1116. </div>
  1117. <h5 class="parameters">Parameters</h5>
  1118. <table class="table table-bordered table-striped table-condensed">
  1119. <thead>
  1120. <tr>
  1121. <th>Type</th>
  1122. <th>Name</th>
  1123. <th>Description</th>
  1124. </tr>
  1125. </thead>
  1126. <tbody>
  1127. <tr>
  1128. <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
  1129. <td><span class="parametername">top</span></td>
  1130. <td>The toplevel.</td>
  1131. </tr>
  1132. </tbody>
  1133. </table>
  1134. <a id="Terminal_Gui_Toplevel_ProcessColdKey_" data-uid="Terminal.Gui.Toplevel.ProcessColdKey*"></a>
  1135. <h4 id="Terminal_Gui_Toplevel_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Toplevel.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
  1136. <div class="markdown level1 summary">
  1137. This method can be overwritten by views that
  1138. want to provide accelerator functionality
  1139. (Alt-key for example), but without
  1140. interefering with normal ProcessKey behavior.
  1141. </div>
  1142. <div class="markdown level1 conceptual"></div>
  1143. <h5 class="decalaration">Declaration</h5>
  1144. <div class="codewrapper">
  1145. <pre><code class="lang-csharp hljs">public override bool ProcessColdKey(KeyEvent keyEvent)</code></pre>
  1146. </div>
  1147. <h5 class="parameters">Parameters</h5>
  1148. <table class="table table-bordered table-striped table-condensed">
  1149. <thead>
  1150. <tr>
  1151. <th>Type</th>
  1152. <th>Name</th>
  1153. <th>Description</th>
  1154. </tr>
  1155. </thead>
  1156. <tbody>
  1157. <tr>
  1158. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1159. <td><span class="parametername">keyEvent</span></td>
  1160. <td>Contains the details about the key that produced the event.</td>
  1161. </tr>
  1162. </tbody>
  1163. </table>
  1164. <h5 class="returns">Returns</h5>
  1165. <table class="table table-bordered table-striped table-condensed">
  1166. <thead>
  1167. <tr>
  1168. <th>Type</th>
  1169. <th>Description</th>
  1170. </tr>
  1171. </thead>
  1172. <tbody>
  1173. <tr>
  1174. <td><span class="xref">System.Boolean</span></td>
  1175. <td></td>
  1176. </tr>
  1177. </tbody>
  1178. </table>
  1179. <h5 class="overrides">Overrides</h5>
  1180. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a></div>
  1181. <h5 id="Terminal_Gui_Toplevel_ProcessColdKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  1182. <div class="markdown level1 remarks">
  1183. <p>
  1184. After keys are sent to the subviews on the
  1185. current view, all the view are
  1186. processed and the key is passed to the views
  1187. to allow some of them to process the keystroke
  1188. as a cold-key. </p>
  1189. <p>
  1190. This functionality is used, for example, by
  1191. default buttons to act on the enter key.
  1192. Processing this as a hot-key would prevent
  1193. non-default buttons from consuming the enter
  1194. keypress when they have the focus.
  1195. </p>
  1196. </div>
  1197. <a id="Terminal_Gui_Toplevel_ProcessKey_" data-uid="Terminal.Gui.Toplevel.ProcessKey*"></a>
  1198. <h4 id="Terminal_Gui_Toplevel_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Toplevel.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  1199. <div class="markdown level1 summary">
  1200. If the view is focused, gives the view a
  1201. chance to process the keystroke.
  1202. </div>
  1203. <div class="markdown level1 conceptual"></div>
  1204. <h5 class="decalaration">Declaration</h5>
  1205. <div class="codewrapper">
  1206. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent keyEvent)</code></pre>
  1207. </div>
  1208. <h5 class="parameters">Parameters</h5>
  1209. <table class="table table-bordered table-striped table-condensed">
  1210. <thead>
  1211. <tr>
  1212. <th>Type</th>
  1213. <th>Name</th>
  1214. <th>Description</th>
  1215. </tr>
  1216. </thead>
  1217. <tbody>
  1218. <tr>
  1219. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1220. <td><span class="parametername">keyEvent</span></td>
  1221. <td>Contains the details about the key that produced the event.</td>
  1222. </tr>
  1223. </tbody>
  1224. </table>
  1225. <h5 class="returns">Returns</h5>
  1226. <table class="table table-bordered table-striped table-condensed">
  1227. <thead>
  1228. <tr>
  1229. <th>Type</th>
  1230. <th>Description</th>
  1231. </tr>
  1232. </thead>
  1233. <tbody>
  1234. <tr>
  1235. <td><span class="xref">System.Boolean</span></td>
  1236. <td></td>
  1237. </tr>
  1238. </tbody>
  1239. </table>
  1240. <h5 class="overrides">Overrides</h5>
  1241. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  1242. <h5 id="Terminal_Gui_Toplevel_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  1243. <div class="markdown level1 remarks">
  1244. <p>
  1245. Views can override this method if they are
  1246. interested in processing the given keystroke.
  1247. If they consume the keystroke, they must
  1248. return true to stop the keystroke from being
  1249. processed by other widgets or consumed by the
  1250. widget engine. If they return false, the
  1251. keystroke will be passed using the ProcessColdKey
  1252. method to other views to process.
  1253. </p>
  1254. <p>
  1255. The View implementation does nothing but return false,
  1256. so it is not necessary to call base.ProcessKey if you
  1257. derive directly from View, but you should if you derive
  1258. other View subclasses.
  1259. </p>
  1260. </div>
  1261. <a id="Terminal_Gui_Toplevel_Redraw_" data-uid="Terminal.Gui.Toplevel.Redraw*"></a>
  1262. <h4 id="Terminal_Gui_Toplevel_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Toplevel.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  1263. <div class="markdown level1 summary">
  1264. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  1265. </div>
  1266. <div class="markdown level1 conceptual"></div>
  1267. <h5 class="decalaration">Declaration</h5>
  1268. <div class="codewrapper">
  1269. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  1270. </div>
  1271. <h5 class="parameters">Parameters</h5>
  1272. <table class="table table-bordered table-striped table-condensed">
  1273. <thead>
  1274. <tr>
  1275. <th>Type</th>
  1276. <th>Name</th>
  1277. <th>Description</th>
  1278. </tr>
  1279. </thead>
  1280. <tbody>
  1281. <tr>
  1282. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1283. <td><span class="parametername">bounds</span></td>
  1284. <td>The bounds (view-relative region) to redraw.</td>
  1285. </tr>
  1286. </tbody>
  1287. </table>
  1288. <h5 class="overrides">Overrides</h5>
  1289. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  1290. <h5 id="Terminal_Gui_Toplevel_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  1291. <div class="markdown level1 remarks">
  1292. <p>
  1293. Always use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> (view-relative) when calling <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a>, NOT <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> (superview-relative).
  1294. </p>
  1295. <p>
  1296. Views should set the color that they want to use on entry, as otherwise this will inherit
  1297. the last color that was set globally on the driver.
  1298. </p>
  1299. <p>
  1300. Overrides of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a> must ensure they do not set <code>Driver.Clip</code> to a clip region
  1301. larger than the <code>region</code> parameter.
  1302. </p>
  1303. </div>
  1304. <a id="Terminal_Gui_Toplevel_Remove_" data-uid="Terminal.Gui.Toplevel.Remove*"></a>
  1305. <h4 id="Terminal_Gui_Toplevel_Remove_Terminal_Gui_View_" data-uid="Terminal.Gui.Toplevel.Remove(Terminal.Gui.View)">Remove(View)</h4>
  1306. <div class="markdown level1 summary">
  1307. Removes a subview added via <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> or <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">Add(View[])</a> from this View.
  1308. </div>
  1309. <div class="markdown level1 conceptual"></div>
  1310. <h5 class="decalaration">Declaration</h5>
  1311. <div class="codewrapper">
  1312. <pre><code class="lang-csharp hljs">public override void Remove(View view)</code></pre>
  1313. </div>
  1314. <h5 class="parameters">Parameters</h5>
  1315. <table class="table table-bordered table-striped table-condensed">
  1316. <thead>
  1317. <tr>
  1318. <th>Type</th>
  1319. <th>Name</th>
  1320. <th>Description</th>
  1321. </tr>
  1322. </thead>
  1323. <tbody>
  1324. <tr>
  1325. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1326. <td><span class="parametername">view</span></td>
  1327. <td></td>
  1328. </tr>
  1329. </tbody>
  1330. </table>
  1331. <h5 class="overrides">Overrides</h5>
  1332. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a></div>
  1333. <h5 id="Terminal_Gui_Toplevel_Remove_Terminal_Gui_View__remarks">Remarks</h5>
  1334. <div class="markdown level1 remarks">
  1335. </div>
  1336. <a id="Terminal_Gui_Toplevel_RemoveAll_" data-uid="Terminal.Gui.Toplevel.RemoveAll*"></a>
  1337. <h4 id="Terminal_Gui_Toplevel_RemoveAll" data-uid="Terminal.Gui.Toplevel.RemoveAll">RemoveAll()</h4>
  1338. <div class="markdown level1 summary">
  1339. Removes all subviews (children) added via <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> or <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">Add(View[])</a> from this View.
  1340. </div>
  1341. <div class="markdown level1 conceptual"></div>
  1342. <h5 class="decalaration">Declaration</h5>
  1343. <div class="codewrapper">
  1344. <pre><code class="lang-csharp hljs">public override void RemoveAll()</code></pre>
  1345. </div>
  1346. <h5 class="overrides">Overrides</h5>
  1347. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a></div>
  1348. <a id="Terminal_Gui_Toplevel_RequestStop_" data-uid="Terminal.Gui.Toplevel.RequestStop*"></a>
  1349. <h4 id="Terminal_Gui_Toplevel_RequestStop" data-uid="Terminal.Gui.Toplevel.RequestStop">RequestStop()</h4>
  1350. <div class="markdown level1 summary">
  1351. Stops and closes this <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>. If this Toplevel is the top-most Toplevel,
  1352. <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RequestStop_Terminal_Gui_Toplevel_">RequestStop(Toplevel)</a> will be called, causing the application to exit.
  1353. </div>
  1354. <div class="markdown level1 conceptual"></div>
  1355. <h5 class="decalaration">Declaration</h5>
  1356. <div class="codewrapper">
  1357. <pre><code class="lang-csharp hljs">public virtual void RequestStop()</code></pre>
  1358. </div>
  1359. <a id="Terminal_Gui_Toplevel_RequestStop_" data-uid="Terminal.Gui.Toplevel.RequestStop*"></a>
  1360. <h4 id="Terminal_Gui_Toplevel_RequestStop_Terminal_Gui_Toplevel_" data-uid="Terminal.Gui.Toplevel.RequestStop(Terminal.Gui.Toplevel)">RequestStop(Toplevel)</h4>
  1361. <div class="markdown level1 summary">
  1362. Stops and closes the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> specified by <code data-dev-comment-type="paramref" class="paramref">top</code>. If <code data-dev-comment-type="paramref" class="paramref">top</code> is the top-most Toplevel,
  1363. <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RequestStop_Terminal_Gui_Toplevel_">RequestStop(Toplevel)</a> will be called, causing the application to exit.
  1364. </div>
  1365. <div class="markdown level1 conceptual"></div>
  1366. <h5 class="decalaration">Declaration</h5>
  1367. <div class="codewrapper">
  1368. <pre><code class="lang-csharp hljs">public virtual void RequestStop(Toplevel top)</code></pre>
  1369. </div>
  1370. <h5 class="parameters">Parameters</h5>
  1371. <table class="table table-bordered table-striped table-condensed">
  1372. <thead>
  1373. <tr>
  1374. <th>Type</th>
  1375. <th>Name</th>
  1376. <th>Description</th>
  1377. </tr>
  1378. </thead>
  1379. <tbody>
  1380. <tr>
  1381. <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
  1382. <td><span class="parametername">top</span></td>
  1383. <td>The toplevel to request stop.</td>
  1384. </tr>
  1385. </tbody>
  1386. </table>
  1387. <a id="Terminal_Gui_Toplevel_ShowChild_" data-uid="Terminal.Gui.Toplevel.ShowChild*"></a>
  1388. <h4 id="Terminal_Gui_Toplevel_ShowChild_Terminal_Gui_Toplevel_" data-uid="Terminal.Gui.Toplevel.ShowChild(Terminal.Gui.Toplevel)">ShowChild(Toplevel)</h4>
  1389. <div class="markdown level1 summary">
  1390. Shows the Mdi child indicated by <code data-dev-comment-type="paramref" class="paramref">top</code>, setting it as <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Current">Current</a>.
  1391. </div>
  1392. <div class="markdown level1 conceptual"></div>
  1393. <h5 class="decalaration">Declaration</h5>
  1394. <div class="codewrapper">
  1395. <pre><code class="lang-csharp hljs">public virtual bool ShowChild(Toplevel top = null)</code></pre>
  1396. </div>
  1397. <h5 class="parameters">Parameters</h5>
  1398. <table class="table table-bordered table-striped table-condensed">
  1399. <thead>
  1400. <tr>
  1401. <th>Type</th>
  1402. <th>Name</th>
  1403. <th>Description</th>
  1404. </tr>
  1405. </thead>
  1406. <tbody>
  1407. <tr>
  1408. <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
  1409. <td><span class="parametername">top</span></td>
  1410. <td>The Toplevel.</td>
  1411. </tr>
  1412. </tbody>
  1413. </table>
  1414. <h5 class="returns">Returns</h5>
  1415. <table class="table table-bordered table-striped table-condensed">
  1416. <thead>
  1417. <tr>
  1418. <th>Type</th>
  1419. <th>Description</th>
  1420. </tr>
  1421. </thead>
  1422. <tbody>
  1423. <tr>
  1424. <td><span class="xref">System.Boolean</span></td>
  1425. <td><code>true</code> if the toplevel can be shown or <code>false</code> if not.</td>
  1426. </tr>
  1427. </tbody>
  1428. </table>
  1429. <a id="Terminal_Gui_Toplevel_WillPresent_" data-uid="Terminal.Gui.Toplevel.WillPresent*"></a>
  1430. <h4 id="Terminal_Gui_Toplevel_WillPresent" data-uid="Terminal.Gui.Toplevel.WillPresent">WillPresent()</h4>
  1431. <div class="markdown level1 summary">
  1432. Invoked by <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Begin_Terminal_Gui_Toplevel_">Begin(Toplevel)</a> as part of <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Run_Terminal_Gui_Toplevel_System_Func_System_Exception_System_Boolean__">Run(Toplevel, Func&lt;Exception, Boolean&gt;)</a>
  1433. after the views have been laid out, and before the views are drawn for the first time.
  1434. </div>
  1435. <div class="markdown level1 conceptual"></div>
  1436. <h5 class="decalaration">Declaration</h5>
  1437. <div class="codewrapper">
  1438. <pre><code class="lang-csharp hljs">public virtual void WillPresent()</code></pre>
  1439. </div>
  1440. <h3 id="events">Events
  1441. </h3>
  1442. <h4 id="Terminal_Gui_Toplevel_Activate" data-uid="Terminal.Gui.Toplevel.Activate">Activate</h4>
  1443. <div class="markdown level1 summary">
  1444. Invoked when the Toplevel <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> becomes the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Current">Current</a> Toplevel.
  1445. </div>
  1446. <div class="markdown level1 conceptual"></div>
  1447. <h5 class="decalaration">Declaration</h5>
  1448. <div class="codewrapper">
  1449. <pre><code class="lang-csharp hljs">public event Action&lt;Toplevel&gt; Activate</code></pre>
  1450. </div>
  1451. <h5 class="eventType">Event Type</h5>
  1452. <table class="table table-bordered table-striped table-condensed">
  1453. <thead>
  1454. <tr>
  1455. <th>Type</th>
  1456. <th>Description</th>
  1457. </tr>
  1458. </thead>
  1459. <tbody>
  1460. <tr>
  1461. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>&gt;</td>
  1462. <td></td>
  1463. </tr>
  1464. </tbody>
  1465. </table>
  1466. <h4 id="Terminal_Gui_Toplevel_AllChildClosed" data-uid="Terminal.Gui.Toplevel.AllChildClosed">AllChildClosed</h4>
  1467. <div class="markdown level1 summary">
  1468. Invoked when the last child of the Toplevel <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> is closed from
  1469. by <span class="xref">Terminal.Gui.Application.End(Terminal.Gui.View)</span>.
  1470. </div>
  1471. <div class="markdown level1 conceptual"></div>
  1472. <h5 class="decalaration">Declaration</h5>
  1473. <div class="codewrapper">
  1474. <pre><code class="lang-csharp hljs">public event Action AllChildClosed</code></pre>
  1475. </div>
  1476. <h5 class="eventType">Event Type</h5>
  1477. <table class="table table-bordered table-striped table-condensed">
  1478. <thead>
  1479. <tr>
  1480. <th>Type</th>
  1481. <th>Description</th>
  1482. </tr>
  1483. </thead>
  1484. <tbody>
  1485. <tr>
  1486. <td><span class="xref">System.Action</span></td>
  1487. <td></td>
  1488. </tr>
  1489. </tbody>
  1490. </table>
  1491. <h4 id="Terminal_Gui_Toplevel_AlternateBackwardKeyChanged" data-uid="Terminal.Gui.Toplevel.AlternateBackwardKeyChanged">AlternateBackwardKeyChanged</h4>
  1492. <div class="markdown level1 summary">
  1493. Invoked when the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_AlternateBackwardKey">AlternateBackwardKey</a> is changed.
  1494. </div>
  1495. <div class="markdown level1 conceptual"></div>
  1496. <h5 class="decalaration">Declaration</h5>
  1497. <div class="codewrapper">
  1498. <pre><code class="lang-csharp hljs">public event Action&lt;Key&gt; AlternateBackwardKeyChanged</code></pre>
  1499. </div>
  1500. <h5 class="eventType">Event Type</h5>
  1501. <table class="table table-bordered table-striped table-condensed">
  1502. <thead>
  1503. <tr>
  1504. <th>Type</th>
  1505. <th>Description</th>
  1506. </tr>
  1507. </thead>
  1508. <tbody>
  1509. <tr>
  1510. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Key.html">Key</a>&gt;</td>
  1511. <td></td>
  1512. </tr>
  1513. </tbody>
  1514. </table>
  1515. <h4 id="Terminal_Gui_Toplevel_AlternateForwardKeyChanged" data-uid="Terminal.Gui.Toplevel.AlternateForwardKeyChanged">AlternateForwardKeyChanged</h4>
  1516. <div class="markdown level1 summary">
  1517. Invoked when the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_AlternateForwardKey">AlternateForwardKey</a> is changed.
  1518. </div>
  1519. <div class="markdown level1 conceptual"></div>
  1520. <h5 class="decalaration">Declaration</h5>
  1521. <div class="codewrapper">
  1522. <pre><code class="lang-csharp hljs">public event Action&lt;Key&gt; AlternateForwardKeyChanged</code></pre>
  1523. </div>
  1524. <h5 class="eventType">Event Type</h5>
  1525. <table class="table table-bordered table-striped table-condensed">
  1526. <thead>
  1527. <tr>
  1528. <th>Type</th>
  1529. <th>Description</th>
  1530. </tr>
  1531. </thead>
  1532. <tbody>
  1533. <tr>
  1534. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Key.html">Key</a>&gt;</td>
  1535. <td></td>
  1536. </tr>
  1537. </tbody>
  1538. </table>
  1539. <h4 id="Terminal_Gui_Toplevel_ChildClosed" data-uid="Terminal.Gui.Toplevel.ChildClosed">ChildClosed</h4>
  1540. <div class="markdown level1 summary">
  1541. Invoked when a child of the Toplevel <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> is closed by
  1542. <span class="xref">Terminal.Gui.Application.End(Terminal.Gui.View)</span>.
  1543. </div>
  1544. <div class="markdown level1 conceptual"></div>
  1545. <h5 class="decalaration">Declaration</h5>
  1546. <div class="codewrapper">
  1547. <pre><code class="lang-csharp hljs">public event Action&lt;Toplevel&gt; ChildClosed</code></pre>
  1548. </div>
  1549. <h5 class="eventType">Event Type</h5>
  1550. <table class="table table-bordered table-striped table-condensed">
  1551. <thead>
  1552. <tr>
  1553. <th>Type</th>
  1554. <th>Description</th>
  1555. </tr>
  1556. </thead>
  1557. <tbody>
  1558. <tr>
  1559. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>&gt;</td>
  1560. <td></td>
  1561. </tr>
  1562. </tbody>
  1563. </table>
  1564. <h4 id="Terminal_Gui_Toplevel_ChildLoaded" data-uid="Terminal.Gui.Toplevel.ChildLoaded">ChildLoaded</h4>
  1565. <div class="markdown level1 summary">
  1566. Invoked when a child Toplevel&apos;s <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> has been loaded.
  1567. </div>
  1568. <div class="markdown level1 conceptual"></div>
  1569. <h5 class="decalaration">Declaration</h5>
  1570. <div class="codewrapper">
  1571. <pre><code class="lang-csharp hljs">public event Action&lt;Toplevel&gt; ChildLoaded</code></pre>
  1572. </div>
  1573. <h5 class="eventType">Event Type</h5>
  1574. <table class="table table-bordered table-striped table-condensed">
  1575. <thead>
  1576. <tr>
  1577. <th>Type</th>
  1578. <th>Description</th>
  1579. </tr>
  1580. </thead>
  1581. <tbody>
  1582. <tr>
  1583. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>&gt;</td>
  1584. <td></td>
  1585. </tr>
  1586. </tbody>
  1587. </table>
  1588. <h4 id="Terminal_Gui_Toplevel_ChildUnloaded" data-uid="Terminal.Gui.Toplevel.ChildUnloaded">ChildUnloaded</h4>
  1589. <div class="markdown level1 summary">
  1590. Invoked when a cjhild Toplevel&apos;s <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> has been unloaded.
  1591. </div>
  1592. <div class="markdown level1 conceptual"></div>
  1593. <h5 class="decalaration">Declaration</h5>
  1594. <div class="codewrapper">
  1595. <pre><code class="lang-csharp hljs">public event Action&lt;Toplevel&gt; ChildUnloaded</code></pre>
  1596. </div>
  1597. <h5 class="eventType">Event Type</h5>
  1598. <table class="table table-bordered table-striped table-condensed">
  1599. <thead>
  1600. <tr>
  1601. <th>Type</th>
  1602. <th>Description</th>
  1603. </tr>
  1604. </thead>
  1605. <tbody>
  1606. <tr>
  1607. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>&gt;</td>
  1608. <td></td>
  1609. </tr>
  1610. </tbody>
  1611. </table>
  1612. <h4 id="Terminal_Gui_Toplevel_Closed" data-uid="Terminal.Gui.Toplevel.Closed">Closed</h4>
  1613. <div class="markdown level1 summary">
  1614. Invoked when the Toplevel&apos;s <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> is closed by <span class="xref">Terminal.Gui.Application.End(Terminal.Gui.View)</span>.
  1615. </div>
  1616. <div class="markdown level1 conceptual"></div>
  1617. <h5 class="decalaration">Declaration</h5>
  1618. <div class="codewrapper">
  1619. <pre><code class="lang-csharp hljs">public event Action&lt;Toplevel&gt; Closed</code></pre>
  1620. </div>
  1621. <h5 class="eventType">Event Type</h5>
  1622. <table class="table table-bordered table-striped table-condensed">
  1623. <thead>
  1624. <tr>
  1625. <th>Type</th>
  1626. <th>Description</th>
  1627. </tr>
  1628. </thead>
  1629. <tbody>
  1630. <tr>
  1631. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>&gt;</td>
  1632. <td></td>
  1633. </tr>
  1634. </tbody>
  1635. </table>
  1636. <h4 id="Terminal_Gui_Toplevel_Closing" data-uid="Terminal.Gui.Toplevel.Closing">Closing</h4>
  1637. <div class="markdown level1 summary">
  1638. Invoked when the Toplevel&apos;s <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> is being closed by
  1639. <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RequestStop_Terminal_Gui_Toplevel_">RequestStop(Toplevel)</a>.
  1640. </div>
  1641. <div class="markdown level1 conceptual"></div>
  1642. <h5 class="decalaration">Declaration</h5>
  1643. <div class="codewrapper">
  1644. <pre><code class="lang-csharp hljs">public event Action&lt;ToplevelClosingEventArgs&gt; Closing</code></pre>
  1645. </div>
  1646. <h5 class="eventType">Event Type</h5>
  1647. <table class="table table-bordered table-striped table-condensed">
  1648. <thead>
  1649. <tr>
  1650. <th>Type</th>
  1651. <th>Description</th>
  1652. </tr>
  1653. </thead>
  1654. <tbody>
  1655. <tr>
  1656. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.ToplevelClosingEventArgs.html">ToplevelClosingEventArgs</a>&gt;</td>
  1657. <td></td>
  1658. </tr>
  1659. </tbody>
  1660. </table>
  1661. <h4 id="Terminal_Gui_Toplevel_Deactivate" data-uid="Terminal.Gui.Toplevel.Deactivate">Deactivate</h4>
  1662. <div class="markdown level1 summary">
  1663. Invoked when the Toplevel<a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> ceases to be the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Current">Current</a> Toplevel.
  1664. </div>
  1665. <div class="markdown level1 conceptual"></div>
  1666. <h5 class="decalaration">Declaration</h5>
  1667. <div class="codewrapper">
  1668. <pre><code class="lang-csharp hljs">public event Action&lt;Toplevel&gt; Deactivate</code></pre>
  1669. </div>
  1670. <h5 class="eventType">Event Type</h5>
  1671. <table class="table table-bordered table-striped table-condensed">
  1672. <thead>
  1673. <tr>
  1674. <th>Type</th>
  1675. <th>Description</th>
  1676. </tr>
  1677. </thead>
  1678. <tbody>
  1679. <tr>
  1680. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>&gt;</td>
  1681. <td></td>
  1682. </tr>
  1683. </tbody>
  1684. </table>
  1685. <h4 id="Terminal_Gui_Toplevel_Loaded" data-uid="Terminal.Gui.Toplevel.Loaded">Loaded</h4>
  1686. <div class="markdown level1 summary">
  1687. Invoked when the Toplevel <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> has begin loaded.
  1688. A Loaded event handler is a good place to finalize initialization before calling
  1689. <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RunLoop_Terminal_Gui_Application_RunState_System_Boolean_">RunLoop(Application.RunState, Boolean)</a>.
  1690. </div>
  1691. <div class="markdown level1 conceptual"></div>
  1692. <h5 class="decalaration">Declaration</h5>
  1693. <div class="codewrapper">
  1694. <pre><code class="lang-csharp hljs">public event Action Loaded</code></pre>
  1695. </div>
  1696. <h5 class="eventType">Event Type</h5>
  1697. <table class="table table-bordered table-striped table-condensed">
  1698. <thead>
  1699. <tr>
  1700. <th>Type</th>
  1701. <th>Description</th>
  1702. </tr>
  1703. </thead>
  1704. <tbody>
  1705. <tr>
  1706. <td><span class="xref">System.Action</span></td>
  1707. <td></td>
  1708. </tr>
  1709. </tbody>
  1710. </table>
  1711. <h4 id="Terminal_Gui_Toplevel_QuitKeyChanged" data-uid="Terminal.Gui.Toplevel.QuitKeyChanged">QuitKeyChanged</h4>
  1712. <div class="markdown level1 summary">
  1713. Invoked when the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_QuitKey">QuitKey</a> is changed.
  1714. </div>
  1715. <div class="markdown level1 conceptual"></div>
  1716. <h5 class="decalaration">Declaration</h5>
  1717. <div class="codewrapper">
  1718. <pre><code class="lang-csharp hljs">public event Action&lt;Key&gt; QuitKeyChanged</code></pre>
  1719. </div>
  1720. <h5 class="eventType">Event Type</h5>
  1721. <table class="table table-bordered table-striped table-condensed">
  1722. <thead>
  1723. <tr>
  1724. <th>Type</th>
  1725. <th>Description</th>
  1726. </tr>
  1727. </thead>
  1728. <tbody>
  1729. <tr>
  1730. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Key.html">Key</a>&gt;</td>
  1731. <td></td>
  1732. </tr>
  1733. </tbody>
  1734. </table>
  1735. <h4 id="Terminal_Gui_Toplevel_Ready" data-uid="Terminal.Gui.Toplevel.Ready">Ready</h4>
  1736. <div class="markdown level1 summary">
  1737. Invoked when the Toplevel <a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a> has started it&apos;s first iteration.
  1738. 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.
  1739. changes.
  1740. <p>A Ready event handler is a good place to finalize initialization after calling
  1741. <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Run_System_Func_System_Exception_System_Boolean__">Run(Func&lt;Exception, Boolean&gt;)</a> on this Toplevel.</p>
  1742. </div>
  1743. <div class="markdown level1 conceptual"></div>
  1744. <h5 class="decalaration">Declaration</h5>
  1745. <div class="codewrapper">
  1746. <pre><code class="lang-csharp hljs">public event Action Ready</code></pre>
  1747. </div>
  1748. <h5 class="eventType">Event Type</h5>
  1749. <table class="table table-bordered table-striped table-condensed">
  1750. <thead>
  1751. <tr>
  1752. <th>Type</th>
  1753. <th>Description</th>
  1754. </tr>
  1755. </thead>
  1756. <tbody>
  1757. <tr>
  1758. <td><span class="xref">System.Action</span></td>
  1759. <td></td>
  1760. </tr>
  1761. </tbody>
  1762. </table>
  1763. <h4 id="Terminal_Gui_Toplevel_Resized" data-uid="Terminal.Gui.Toplevel.Resized">Resized</h4>
  1764. <div class="markdown level1 summary">
  1765. Invoked when the terminal has been resized. The new <a class="xref" href="Terminal.Gui.Size.html">Size</a> of the terminal is provided.
  1766. </div>
  1767. <div class="markdown level1 conceptual"></div>
  1768. <h5 class="decalaration">Declaration</h5>
  1769. <div class="codewrapper">
  1770. <pre><code class="lang-csharp hljs">public event Action&lt;Size&gt; Resized</code></pre>
  1771. </div>
  1772. <h5 class="eventType">Event Type</h5>
  1773. <table class="table table-bordered table-striped table-condensed">
  1774. <thead>
  1775. <tr>
  1776. <th>Type</th>
  1777. <th>Description</th>
  1778. </tr>
  1779. </thead>
  1780. <tbody>
  1781. <tr>
  1782. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Size.html">Size</a>&gt;</td>
  1783. <td></td>
  1784. </tr>
  1785. </tbody>
  1786. </table>
  1787. <h4 id="Terminal_Gui_Toplevel_Unloaded" data-uid="Terminal.Gui.Toplevel.Unloaded">Unloaded</h4>
  1788. <div class="markdown level1 summary">
  1789. Invoked when the Toplevel <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> has been unloaded.
  1790. A Unloaded event handler is a good place to dispose objects after calling <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_End_Terminal_Gui_Application_RunState_">End(Application.RunState)</a>.
  1791. </div>
  1792. <div class="markdown level1 conceptual"></div>
  1793. <h5 class="decalaration">Declaration</h5>
  1794. <div class="codewrapper">
  1795. <pre><code class="lang-csharp hljs">public event Action Unloaded</code></pre>
  1796. </div>
  1797. <h5 class="eventType">Event Type</h5>
  1798. <table class="table table-bordered table-striped table-condensed">
  1799. <thead>
  1800. <tr>
  1801. <th>Type</th>
  1802. <th>Description</th>
  1803. </tr>
  1804. </thead>
  1805. <tbody>
  1806. <tr>
  1807. <td><span class="xref">System.Action</span></td>
  1808. <td></td>
  1809. </tr>
  1810. </tbody>
  1811. </table>
  1812. <h3 id="implements">Implements</h3>
  1813. <div>
  1814. <span class="xref">System.IDisposable</span>
  1815. </div>
  1816. <div>
  1817. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  1818. </div>
  1819. <div>
  1820. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  1821. </div>
  1822. </article>
  1823. </div>
  1824. <div class="hidden-sm col-md-2" role="complementary">
  1825. <div class="sideaffix">
  1826. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1827. <h5>In This Article</h5>
  1828. <div></div>
  1829. </nav>
  1830. </div>
  1831. </div>
  1832. </div>
  1833. </div>
  1834. <footer>
  1835. <div class="grad-bottom"></div>
  1836. <div class="footer">
  1837. <div class="container">
  1838. <span class="pull-right">
  1839. <a href="#top">Back to top</a>
  1840. </span>
  1841. <span>Generated by <strong>DocFX</strong></span>
  1842. </div>
  1843. </div>
  1844. </footer>
  1845. </div>
  1846. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1847. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1848. <script type="text/javascript" src="../../styles/main.js"></script>
  1849. </body>
  1850. </html>