Terminal.Gui.Window.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791
  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 Window
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Window
  11. ">
  12. <meta name="generator" content="docfx 2.54.0.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <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"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Window">
  73. <h1 id="Terminal_Gui_Window" data-uid="Terminal.Gui.Window" class="text-break">Class Window
  74. </h1>
  75. <div class="markdown level0 summary">
  76. A <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> <a class="xref" href="Terminal.Gui.View.html">View</a> that draws a border around its <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> with a <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Title">Title</a> at the top.
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  83. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  84. <div class="level3"><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></div>
  85. <div class="level4"><span class="xref">Window</span></div>
  86. <div class="level5"><a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a></div>
  87. </div>
  88. <div classs="implements">
  89. <h5>Implements</h5>
  90. <div><span class="xref">System.Collections.IEnumerable</span></div>
  91. </div>
  92. <div class="inheritedMembers">
  93. <h5>Inherited Members</h5>
  94. <div>
  95. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Running">Toplevel.Running</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Ready">Toplevel.Ready</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Create">Toplevel.Create()</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_CanFocus">Toplevel.CanFocus</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Modal">Toplevel.Modal</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_MenuBar">Toplevel.MenuBar</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_StatusBar">Toplevel.StatusBar</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ProcessKey_Terminal_Gui_KeyEvent_">Toplevel.ProcessKey(KeyEvent)</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_WillPresent">Toplevel.WillPresent()</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  216. </div>
  217. <div>
  218. <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>
  219. </div>
  220. <div>
  221. <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>
  222. </div>
  223. <div>
  224. <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>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  237. </div>
  238. <div>
  239. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
  240. </div>
  241. <div>
  242. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  243. </div>
  244. <div>
  245. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  318. </div>
  319. <div>
  320. <span class="xref">System.Object.Equals(System.Object)</span>
  321. </div>
  322. <div>
  323. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  324. </div>
  325. <div>
  326. <span class="xref">System.Object.GetHashCode()</span>
  327. </div>
  328. <div>
  329. <span class="xref">System.Object.GetType()</span>
  330. </div>
  331. <div>
  332. <span class="xref">System.Object.MemberwiseClone()</span>
  333. </div>
  334. <div>
  335. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  336. </div>
  337. </div>
  338. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  339. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  340. <h5 id="Terminal_Gui_Window_syntax">Syntax</h5>
  341. <div class="codewrapper">
  342. <pre><code class="lang-csharp hljs">public class Window : Toplevel, IEnumerable</code></pre>
  343. </div>
  344. <h5 id="Terminal_Gui_Window_remarks"><strong>Remarks</strong></h5>
  345. <div class="markdown level0 remarks">
  346. The &apos;client area&apos; of a <a class="xref" href="Terminal.Gui.Window.html">Window</a> is a rectangle deflated by one or more rows/columns from <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a>. A this time there is no
  347. API to determine this rectangle.
  348. </div>
  349. <h3 id="constructors">Constructors
  350. </h3>
  351. <a id="Terminal_Gui_Window__ctor_" data-uid="Terminal.Gui.Window.#ctor*"></a>
  352. <h4 id="Terminal_Gui_Window__ctor_NStack_ustring_" data-uid="Terminal.Gui.Window.#ctor(NStack.ustring)">Window(ustring)</h4>
  353. <div class="markdown level1 summary">
  354. Initializes a new instance of the <a class="xref" href="Terminal.Gui.Window.html">Window</a> class with an optional title.
  355. </div>
  356. <div class="markdown level1 conceptual"></div>
  357. <h5 class="decalaration">Declaration</h5>
  358. <div class="codewrapper">
  359. <pre><code class="lang-csharp hljs">public Window(ustring title = null)</code></pre>
  360. </div>
  361. <h5 class="parameters">Parameters</h5>
  362. <table class="table table-bordered table-striped table-condensed">
  363. <thead>
  364. <tr>
  365. <th>Type</th>
  366. <th>Name</th>
  367. <th>Description</th>
  368. </tr>
  369. </thead>
  370. <tbody>
  371. <tr>
  372. <td><span class="xref">NStack.ustring</span></td>
  373. <td><span class="parametername">title</span></td>
  374. <td>Title.</td>
  375. </tr>
  376. </tbody>
  377. </table>
  378. <h5 id="Terminal_Gui_Window__ctor_NStack_ustring__remarks">Remarks</h5>
  379. <div class="markdown level1 remarks">
  380. This constructor intitalize a View with a <a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a> of <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
  381. Use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">X</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">Y</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a>, and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> properties to dynamically control the size and location of the view.
  382. </div>
  383. <a id="Terminal_Gui_Window__ctor_" data-uid="Terminal.Gui.Window.#ctor*"></a>
  384. <h4 id="Terminal_Gui_Window__ctor_NStack_ustring_System_Int32_" data-uid="Terminal.Gui.Window.#ctor(NStack.ustring,System.Int32)">Window(ustring, Int32)</h4>
  385. <div class="markdown level1 summary">
  386. Initializes a new instance of the <a class="xref" href="Terminal.Gui.Window.html">Window</a> with the specified frame for its location, with the specified border,
  387. and an optional title.
  388. </div>
  389. <div class="markdown level1 conceptual"></div>
  390. <h5 class="decalaration">Declaration</h5>
  391. <div class="codewrapper">
  392. <pre><code class="lang-csharp hljs">public Window(ustring title = null, int padding = 0)</code></pre>
  393. </div>
  394. <h5 class="parameters">Parameters</h5>
  395. <table class="table table-bordered table-striped table-condensed">
  396. <thead>
  397. <tr>
  398. <th>Type</th>
  399. <th>Name</th>
  400. <th>Description</th>
  401. </tr>
  402. </thead>
  403. <tbody>
  404. <tr>
  405. <td><span class="xref">NStack.ustring</span></td>
  406. <td><span class="parametername">title</span></td>
  407. <td>Title.</td>
  408. </tr>
  409. <tr>
  410. <td><span class="xref">System.Int32</span></td>
  411. <td><span class="parametername">padding</span></td>
  412. <td>Number of characters to use for padding of the drawn frame.</td>
  413. </tr>
  414. </tbody>
  415. </table>
  416. <h5 id="Terminal_Gui_Window__ctor_NStack_ustring_System_Int32__remarks">Remarks</h5>
  417. <div class="markdown level1 remarks">
  418. This constructor intitalize a View with a <a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a> of <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
  419. Use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">X</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">Y</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a>, and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> properties to dynamically control the size and location of the view.
  420. </div>
  421. <a id="Terminal_Gui_Window__ctor_" data-uid="Terminal.Gui.Window.#ctor*"></a>
  422. <h4 id="Terminal_Gui_Window__ctor_Terminal_Gui_Rect_NStack_ustring_" data-uid="Terminal.Gui.Window.#ctor(Terminal.Gui.Rect,NStack.ustring)">Window(Rect, ustring)</h4>
  423. <div class="markdown level1 summary">
  424. Initializes a new instance of the <a class="xref" href="Terminal.Gui.Window.html">Window</a> class with an optional title using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> positioning.
  425. </div>
  426. <div class="markdown level1 conceptual"></div>
  427. <h5 class="decalaration">Declaration</h5>
  428. <div class="codewrapper">
  429. <pre><code class="lang-csharp hljs">public Window(Rect frame, ustring title = null)</code></pre>
  430. </div>
  431. <h5 class="parameters">Parameters</h5>
  432. <table class="table table-bordered table-striped table-condensed">
  433. <thead>
  434. <tr>
  435. <th>Type</th>
  436. <th>Name</th>
  437. <th>Description</th>
  438. </tr>
  439. </thead>
  440. <tbody>
  441. <tr>
  442. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  443. <td><span class="parametername">frame</span></td>
  444. <td>Superview-relatie rectangle specifying the location and size</td>
  445. </tr>
  446. <tr>
  447. <td><span class="xref">NStack.ustring</span></td>
  448. <td><span class="parametername">title</span></td>
  449. <td>Title</td>
  450. </tr>
  451. </tbody>
  452. </table>
  453. <h5 id="Terminal_Gui_Window__ctor_Terminal_Gui_Rect_NStack_ustring__remarks">Remarks</h5>
  454. <div class="markdown level1 remarks">
  455. This constructor intitalizes a Window with a <a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a> of <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a>. Use constructors
  456. that do not take <code>Rect</code> parameters to initialize a Window with <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
  457. </div>
  458. <a id="Terminal_Gui_Window__ctor_" data-uid="Terminal.Gui.Window.#ctor*"></a>
  459. <h4 id="Terminal_Gui_Window__ctor_Terminal_Gui_Rect_NStack_ustring_System_Int32_" data-uid="Terminal.Gui.Window.#ctor(Terminal.Gui.Rect,NStack.ustring,System.Int32)">Window(Rect, ustring, Int32)</h4>
  460. <div class="markdown level1 summary">
  461. Initializes a new instance of the <a class="xref" href="Terminal.Gui.Window.html">Window</a> with the specified frame for its location, with the specified border,
  462. and an optional title.
  463. </div>
  464. <div class="markdown level1 conceptual"></div>
  465. <h5 class="decalaration">Declaration</h5>
  466. <div class="codewrapper">
  467. <pre><code class="lang-csharp hljs">public Window(Rect frame, ustring title = null, int padding = 0)</code></pre>
  468. </div>
  469. <h5 class="parameters">Parameters</h5>
  470. <table class="table table-bordered table-striped table-condensed">
  471. <thead>
  472. <tr>
  473. <th>Type</th>
  474. <th>Name</th>
  475. <th>Description</th>
  476. </tr>
  477. </thead>
  478. <tbody>
  479. <tr>
  480. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  481. <td><span class="parametername">frame</span></td>
  482. <td>Superview-relatie rectangle specifying the location and size</td>
  483. </tr>
  484. <tr>
  485. <td><span class="xref">NStack.ustring</span></td>
  486. <td><span class="parametername">title</span></td>
  487. <td>Title</td>
  488. </tr>
  489. <tr>
  490. <td><span class="xref">System.Int32</span></td>
  491. <td><span class="parametername">padding</span></td>
  492. <td>Number of characters to use for padding of the drawn frame.</td>
  493. </tr>
  494. </tbody>
  495. </table>
  496. <h5 id="Terminal_Gui_Window__ctor_Terminal_Gui_Rect_NStack_ustring_System_Int32__remarks">Remarks</h5>
  497. <div class="markdown level1 remarks">
  498. This constructor intitalizes a Window with a <a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a> of <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a>. Use constructors
  499. that do not take <code>Rect</code> parameters to initialize a Window with <a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a> of <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>
  500. </div>
  501. <h3 id="properties">Properties
  502. </h3>
  503. <a id="Terminal_Gui_Window_Title_" data-uid="Terminal.Gui.Window.Title*"></a>
  504. <h4 id="Terminal_Gui_Window_Title" data-uid="Terminal.Gui.Window.Title">Title</h4>
  505. <div class="markdown level1 summary">
  506. The title to be displayed for this window.
  507. </div>
  508. <div class="markdown level1 conceptual"></div>
  509. <h5 class="decalaration">Declaration</h5>
  510. <div class="codewrapper">
  511. <pre><code class="lang-csharp hljs">public ustring Title { get; set; }</code></pre>
  512. </div>
  513. <h5 class="propertyValue">Property Value</h5>
  514. <table class="table table-bordered table-striped table-condensed">
  515. <thead>
  516. <tr>
  517. <th>Type</th>
  518. <th>Description</th>
  519. </tr>
  520. </thead>
  521. <tbody>
  522. <tr>
  523. <td><span class="xref">NStack.ustring</span></td>
  524. <td>The title</td>
  525. </tr>
  526. </tbody>
  527. </table>
  528. <h3 id="methods">Methods
  529. </h3>
  530. <a id="Terminal_Gui_Window_Add_" data-uid="Terminal.Gui.Window.Add*"></a>
  531. <h4 id="Terminal_Gui_Window_Add_Terminal_Gui_View_" data-uid="Terminal.Gui.Window.Add(Terminal.Gui.View)">Add(View)</h4>
  532. <div class="markdown level1 summary">
  533. Adds a subview (child) to this view.
  534. </div>
  535. <div class="markdown level1 conceptual"></div>
  536. <h5 class="decalaration">Declaration</h5>
  537. <div class="codewrapper">
  538. <pre><code class="lang-csharp hljs">public override void Add(View view)</code></pre>
  539. </div>
  540. <h5 class="parameters">Parameters</h5>
  541. <table class="table table-bordered table-striped table-condensed">
  542. <thead>
  543. <tr>
  544. <th>Type</th>
  545. <th>Name</th>
  546. <th>Description</th>
  547. </tr>
  548. </thead>
  549. <tbody>
  550. <tr>
  551. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  552. <td><span class="parametername">view</span></td>
  553. <td></td>
  554. </tr>
  555. </tbody>
  556. </table>
  557. <h5 class="overrides">Overrides</h5>
  558. <div><a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Add_Terminal_Gui_View_">Toplevel.Add(View)</a></div>
  559. <h5 id="Terminal_Gui_Window_Add_Terminal_Gui_View__remarks">Remarks</h5>
  560. <div class="markdown level1 remarks">
  561. 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>
  562. </div>
  563. <a id="Terminal_Gui_Window_GetEnumerator_" data-uid="Terminal.Gui.Window.GetEnumerator*"></a>
  564. <h4 id="Terminal_Gui_Window_GetEnumerator" data-uid="Terminal.Gui.Window.GetEnumerator">GetEnumerator()</h4>
  565. <div class="markdown level1 summary">
  566. Enumerates the various <a class="xref" href="Terminal.Gui.View.html">View</a>s in the embedded <span class="xref">Terminal.Gui.Window.ContentView</span>.
  567. </div>
  568. <div class="markdown level1 conceptual"></div>
  569. <h5 class="decalaration">Declaration</h5>
  570. <div class="codewrapper">
  571. <pre><code class="lang-csharp hljs">public IEnumerator GetEnumerator()</code></pre>
  572. </div>
  573. <h5 class="returns">Returns</h5>
  574. <table class="table table-bordered table-striped table-condensed">
  575. <thead>
  576. <tr>
  577. <th>Type</th>
  578. <th>Description</th>
  579. </tr>
  580. </thead>
  581. <tbody>
  582. <tr>
  583. <td><span class="xref">System.Collections.IEnumerator</span></td>
  584. <td>The enumerator.</td>
  585. </tr>
  586. </tbody>
  587. </table>
  588. <a id="Terminal_Gui_Window_MouseEvent_" data-uid="Terminal.Gui.Window.MouseEvent*"></a>
  589. <h4 id="Terminal_Gui_Window_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Window.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  590. <div class="markdown level1 summary">
  591. Method invoked when a mouse event is generated
  592. </div>
  593. <div class="markdown level1 conceptual"></div>
  594. <h5 class="decalaration">Declaration</h5>
  595. <div class="codewrapper">
  596. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent mouseEvent)</code></pre>
  597. </div>
  598. <h5 class="parameters">Parameters</h5>
  599. <table class="table table-bordered table-striped table-condensed">
  600. <thead>
  601. <tr>
  602. <th>Type</th>
  603. <th>Name</th>
  604. <th>Description</th>
  605. </tr>
  606. </thead>
  607. <tbody>
  608. <tr>
  609. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  610. <td><span class="parametername">mouseEvent</span></td>
  611. <td>Contains the details about the mouse event.</td>
  612. </tr>
  613. </tbody>
  614. </table>
  615. <h5 class="returns">Returns</h5>
  616. <table class="table table-bordered table-striped table-condensed">
  617. <thead>
  618. <tr>
  619. <th>Type</th>
  620. <th>Description</th>
  621. </tr>
  622. </thead>
  623. <tbody>
  624. <tr>
  625. <td><span class="xref">System.Boolean</span></td>
  626. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  627. </tr>
  628. </tbody>
  629. </table>
  630. <h5 class="overrides">Overrides</h5>
  631. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  632. <a id="Terminal_Gui_Window_Redraw_" data-uid="Terminal.Gui.Window.Redraw*"></a>
  633. <h4 id="Terminal_Gui_Window_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Window.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  634. <div class="markdown level1 summary">
  635. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  636. </div>
  637. <div class="markdown level1 conceptual"></div>
  638. <h5 class="decalaration">Declaration</h5>
  639. <div class="codewrapper">
  640. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  641. </div>
  642. <h5 class="parameters">Parameters</h5>
  643. <table class="table table-bordered table-striped table-condensed">
  644. <thead>
  645. <tr>
  646. <th>Type</th>
  647. <th>Name</th>
  648. <th>Description</th>
  649. </tr>
  650. </thead>
  651. <tbody>
  652. <tr>
  653. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  654. <td><span class="parametername">bounds</span></td>
  655. <td>The bounds (view-relative region) to redraw.</td>
  656. </tr>
  657. </tbody>
  658. </table>
  659. <h5 class="overrides">Overrides</h5>
  660. <div><a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Redraw_Terminal_Gui_Rect_">Toplevel.Redraw(Rect)</a></div>
  661. <h5 id="Terminal_Gui_Window_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  662. <div class="markdown level1 remarks">
  663. <p>
  664. 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).
  665. </p>
  666. <p>
  667. Views should set the color that they want to use on entry, as otherwise this will inherit
  668. the last color that was set globaly on the driver.
  669. </p>
  670. <p>
  671. 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
  672. larger than the <code>region</code> parameter.
  673. </p>
  674. </div>
  675. <a id="Terminal_Gui_Window_Remove_" data-uid="Terminal.Gui.Window.Remove*"></a>
  676. <h4 id="Terminal_Gui_Window_Remove_Terminal_Gui_View_" data-uid="Terminal.Gui.Window.Remove(Terminal.Gui.View)">Remove(View)</h4>
  677. <div class="markdown level1 summary">
  678. 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.
  679. </div>
  680. <div class="markdown level1 conceptual"></div>
  681. <h5 class="decalaration">Declaration</h5>
  682. <div class="codewrapper">
  683. <pre><code class="lang-csharp hljs">public override void Remove(View view)</code></pre>
  684. </div>
  685. <h5 class="parameters">Parameters</h5>
  686. <table class="table table-bordered table-striped table-condensed">
  687. <thead>
  688. <tr>
  689. <th>Type</th>
  690. <th>Name</th>
  691. <th>Description</th>
  692. </tr>
  693. </thead>
  694. <tbody>
  695. <tr>
  696. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  697. <td><span class="parametername">view</span></td>
  698. <td></td>
  699. </tr>
  700. </tbody>
  701. </table>
  702. <h5 class="overrides">Overrides</h5>
  703. <div><a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Remove_Terminal_Gui_View_">Toplevel.Remove(View)</a></div>
  704. <h5 id="Terminal_Gui_Window_Remove_Terminal_Gui_View__remarks">Remarks</h5>
  705. <div class="markdown level1 remarks">
  706. </div>
  707. <a id="Terminal_Gui_Window_RemoveAll_" data-uid="Terminal.Gui.Window.RemoveAll*"></a>
  708. <h4 id="Terminal_Gui_Window_RemoveAll" data-uid="Terminal.Gui.Window.RemoveAll">RemoveAll()</h4>
  709. <div class="markdown level1 summary">
  710. 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.
  711. </div>
  712. <div class="markdown level1 conceptual"></div>
  713. <h5 class="decalaration">Declaration</h5>
  714. <div class="codewrapper">
  715. <pre><code class="lang-csharp hljs">public override void RemoveAll()</code></pre>
  716. </div>
  717. <h5 class="overrides">Overrides</h5>
  718. <div><a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_RemoveAll">Toplevel.RemoveAll()</a></div>
  719. <h3 id="implements">Implements</h3>
  720. <div>
  721. <span class="xref">System.Collections.IEnumerable</span>
  722. </div>
  723. </article>
  724. </div>
  725. <div class="hidden-sm col-md-2" role="complementary">
  726. <div class="sideaffix">
  727. <div class="contribution">
  728. <ul class="nav">
  729. </ul>
  730. </div>
  731. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  732. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  733. </nav>
  734. </div>
  735. </div>
  736. </div>
  737. </div>
  738. <footer>
  739. <div class="grad-bottom"></div>
  740. <div class="footer">
  741. <div class="container">
  742. <span class="pull-right">
  743. <a href="#top">Back to top</a>
  744. </span>
  745. <span>Generated by <strong>DocFX</strong></span>
  746. </div>
  747. </div>
  748. </footer>
  749. </div>
  750. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  751. <script type="text/javascript" src="../../styles/docfx.js"></script>
  752. <script type="text/javascript" src="../../styles/main.js"></script>
  753. </body>
  754. </html>