Terminal.Dialog.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395
  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 Dialog
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Dialog
  11. ">
  12. <meta name="generator" content="docfx 2.18.2.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="">
  18. <meta property="docfx:tocrel" content="../toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="Terminal.Dialog">
  63. <h1 id="Terminal_Dialog" data-uid="Terminal.Dialog">Class Dialog
  64. </h1>
  65. <div class="markdown level0 summary"><p>The dialog box is a window that by default is centered and contains one
  66. or more buttons.</p>
  67. </div>
  68. <div class="markdown level0 conceptual"></div>
  69. <div class="inheritance">
  70. <h5>Inheritance</h5>
  71. <div class="level0"><span class="xref">System.Object</span></div>
  72. <div class="level1"><a class="xref" href="Terminal.Responder.html">Responder</a></div>
  73. <div class="level2"><a class="xref" href="Terminal.View.html">View</a></div>
  74. <div class="level3"><a class="xref" href="Terminal.Toplevel.html">Toplevel</a></div>
  75. <div class="level4"><a class="xref" href="Terminal.Window.html">Window</a></div>
  76. <div class="level5"><span class="xref">Dialog</span></div>
  77. </div>
  78. <div class="inheritedMembers">
  79. <h5>Inherited Members</h5>
  80. <div>
  81. <a class="xref" href="Terminal.Responder.html#Terminal_Responder_MouseEvent_Terminal_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
  82. </div>
  83. <div>
  84. <a class="xref" href="Terminal.Toplevel.html#Terminal_Toplevel_CanFocus">Toplevel.CanFocus</a>
  85. </div>
  86. <div>
  87. <a class="xref" href="Terminal.Toplevel.html#Terminal_Toplevel_Create">Toplevel.Create()</a>
  88. </div>
  89. <div>
  90. <a class="xref" href="Terminal.Toplevel.html#Terminal_Toplevel_Running">Toplevel.Running</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="Terminal.View.html#Terminal_View_Add_Terminal_View___">View.Add(View[])</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="Terminal.View.html#Terminal_View_AddCh_System_Int32_System_Int32_System_Int32_">View.AddCh(Int32, Int32, Int32)</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.View.html#Terminal_View_Bounds">View.Bounds</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.View.html#Terminal_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.View.html#Terminal_View_Clear">View.Clear()</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.View.html#Terminal_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.View.html#Terminal_View_ColorScheme">View.ColorScheme</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.View.html#Terminal_View_DrawFrame_Terminal_Rect_System_Boolean_">View.DrawFrame(Rect, Boolean)</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.View.html#Terminal_View_DrawHotString_System_String_System_Boolean_Terminal_ColorScheme_">View.DrawHotString(String, Boolean, ColorScheme)</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.View.html#Terminal_View_DrawHotString_System_String_Terminal_Attribute_Terminal_Attribute_">View.DrawHotString(String, Attribute, Attribute)</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.View.html#Terminal_View_Driver">View.Driver</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.View.html#Terminal_View_EnsureFocus">View.EnsureFocus()</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.View.html#Terminal_View_Focused">View.Focused</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.View.html#Terminal_View_FocusFirst">View.FocusFirst()</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.View.html#Terminal_View_FocusLast">View.FocusLast()</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.View.html#Terminal_View_FocusNext">View.FocusNext()</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.View.html#Terminal_View_FocusPrev">View.FocusPrev()</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.View.html#Terminal_View_Frame">View.Frame</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.View.html#Terminal_View_HasFocus">View.HasFocus</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.View.html#Terminal_View_Id">View.Id</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.View.html#Terminal_View_MostFocused">View.MostFocused</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.View.html#Terminal_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.View.html#Terminal_View_PositionCursor">View.PositionCursor()</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.View.html#Terminal_View_ProcessColdKey_Terminal_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.View.html#Terminal_View_ProcessHotKey_Terminal_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.View.html#Terminal_View_Remove_Terminal_View_">View.Remove(View)</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.View.html#Terminal_View_RemoveAll">View.RemoveAll()</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.View.html#Terminal_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.View.html#Terminal_View_SetFocus_Terminal_View_">View.SetFocus(View)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.View.html#Terminal_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.View.html#Terminal_View_SetNeedsDisplay_Terminal_Rect_">View.SetNeedsDisplay(Rect)</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.View.html#Terminal_View_Subviews">View.Subviews</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.View.html#Terminal_View_SuperView">View.SuperView</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.View.html#Terminal_View_ToString">View.ToString()</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.View.html#Terminal_View_WantMousePositionReports">View.WantMousePositionReports</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Window.html#Terminal_Window_Add_Terminal_View_">Window.Add(View)</a>
  199. </div>
  200. <div>
  201. <a class="xref" href="Terminal.Window.html#Terminal_Window_GetEnumerator">Window.GetEnumerator()</a>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Window.html#Terminal_Window_Redraw_Terminal_Rect_">Window.Redraw(Rect)</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Window.html#Terminal_Window_Title">Window.Title</a>
  208. </div>
  209. </div>
  210. <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.html">Terminal</a></h6>
  211. <h6><strong>Assembly</strong>: Terminal.dll</h6>
  212. <h5 id="Terminal_Dialog_syntax">Syntax</h5>
  213. <div class="codewrapper">
  214. <pre><code class="lang-csharp hljs">public class Dialog : Terminal.Window</code></pre>
  215. </div>
  216. <h3 id="constructors">Constructors
  217. </h3>
  218. <a id="Terminal_Dialog__ctor_" data-uid="Terminal.Dialog.#ctor*"></a>
  219. <h4 id="Terminal_Dialog__ctor_System_String_System_Int32_System_Int32_Terminal_Button___" data-uid="Terminal.Dialog.#ctor(System.String,System.Int32,System.Int32,Terminal.Button[])">Dialog(String, Int32, Int32, Button[])</h4>
  220. <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Terminal.Dialog.html">Dialog</a> class with an optional set of buttons to display</p>
  221. </div>
  222. <div class="markdown level1 conceptual"></div>
  223. <h5 class="decalaration">Declaration</h5>
  224. <div class="codewrapper">
  225. <pre><code class="lang-csharp hljs">public Dialog (string title, int width, int height, Terminal.Button[] buttons);</code></pre>
  226. </div>
  227. <h5 class="parameters">Parameters</h5>
  228. <table class="table table-bordered table-striped table-condensed">
  229. <thead>
  230. <tr>
  231. <th>Type</th>
  232. <th>Name</th>
  233. <th>Description</th>
  234. </tr>
  235. </thead>
  236. <tbody>
  237. <tr>
  238. <td><span class="xref">System.String</span></td>
  239. <td><span class="parametername">title</span></td>
  240. <td><p>Title for the dialog.</p>
  241. </td>
  242. </tr>
  243. <tr>
  244. <td><span class="xref">System.Int32</span></td>
  245. <td><span class="parametername">width</span></td>
  246. <td><p>Width for the dialog.</p>
  247. </td>
  248. </tr>
  249. <tr>
  250. <td><span class="xref">System.Int32</span></td>
  251. <td><span class="parametername">height</span></td>
  252. <td><p>Height for the dialog.</p>
  253. </td>
  254. </tr>
  255. <tr>
  256. <td><a class="xref" href="Terminal.Button.html">Button</a>[]</td>
  257. <td><span class="parametername">buttons</span></td>
  258. <td><p>Optional buttons to lay out at the bottom of the dialog.</p>
  259. </td>
  260. </tr>
  261. </tbody>
  262. </table>
  263. <h3 id="methods">Methods
  264. </h3>
  265. <a id="Terminal_Dialog_AddButton_" data-uid="Terminal.Dialog.AddButton*"></a>
  266. <h4 id="Terminal_Dialog_AddButton_Terminal_Button_" data-uid="Terminal.Dialog.AddButton(Terminal.Button)">AddButton(Button)</h4>
  267. <div class="markdown level1 summary"><p>Adds a button to the dialog, its layout will be controled by the dialog</p>
  268. </div>
  269. <div class="markdown level1 conceptual"></div>
  270. <h5 class="decalaration">Declaration</h5>
  271. <div class="codewrapper">
  272. <pre><code class="lang-csharp hljs">public void AddButton (Terminal.Button button);</code></pre>
  273. </div>
  274. <h5 class="parameters">Parameters</h5>
  275. <table class="table table-bordered table-striped table-condensed">
  276. <thead>
  277. <tr>
  278. <th>Type</th>
  279. <th>Name</th>
  280. <th>Description</th>
  281. </tr>
  282. </thead>
  283. <tbody>
  284. <tr>
  285. <td><a class="xref" href="Terminal.Button.html">Button</a></td>
  286. <td><span class="parametername">button</span></td>
  287. <td><p>Button to add.</p>
  288. </td>
  289. </tr>
  290. </tbody>
  291. </table>
  292. <a id="Terminal_Dialog_LayoutSubviews_" data-uid="Terminal.Dialog.LayoutSubviews*"></a>
  293. <h4 id="Terminal_Dialog_LayoutSubviews" data-uid="Terminal.Dialog.LayoutSubviews">LayoutSubviews()</h4>
  294. <div class="markdown level1 summary"></div>
  295. <div class="markdown level1 conceptual"></div>
  296. <h5 class="decalaration">Declaration</h5>
  297. <div class="codewrapper">
  298. <pre><code class="lang-csharp hljs">public override void LayoutSubviews ();</code></pre>
  299. </div>
  300. <a id="Terminal_Dialog_ProcessKey_" data-uid="Terminal.Dialog.ProcessKey*"></a>
  301. <h4 id="Terminal_Dialog_ProcessKey_Terminal_KeyEvent_" data-uid="Terminal.Dialog.ProcessKey(Terminal.KeyEvent)">ProcessKey(KeyEvent)</h4>
  302. <div class="markdown level1 summary"></div>
  303. <div class="markdown level1 conceptual"></div>
  304. <h5 class="decalaration">Declaration</h5>
  305. <div class="codewrapper">
  306. <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.KeyEvent kb);</code></pre>
  307. </div>
  308. <h5 class="parameters">Parameters</h5>
  309. <table class="table table-bordered table-striped table-condensed">
  310. <thead>
  311. <tr>
  312. <th>Type</th>
  313. <th>Name</th>
  314. <th>Description</th>
  315. </tr>
  316. </thead>
  317. <tbody>
  318. <tr>
  319. <td><a class="xref" href="Terminal.KeyEvent.html">KeyEvent</a></td>
  320. <td><span class="parametername">kb</span></td>
  321. <td><p>To be added.</p>
  322. </td>
  323. </tr>
  324. </tbody>
  325. </table>
  326. <h5 class="returns">Returns</h5>
  327. <table class="table table-bordered table-striped table-condensed">
  328. <thead>
  329. <tr>
  330. <th>Type</th>
  331. <th>Description</th>
  332. </tr>
  333. </thead>
  334. <tbody>
  335. <tr>
  336. <td><span class="xref">System.Boolean</span></td>
  337. <td><p>To be added.</p>
  338. </td>
  339. </tr>
  340. </tbody>
  341. </table>
  342. </article>
  343. </div>
  344. <div class="hidden-sm col-md-2" role="complementary">
  345. <div class="sideaffix">
  346. <div class="contribution">
  347. <ul class="nav">
  348. </ul>
  349. </div>
  350. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  351. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  352. </nav>
  353. </div>
  354. </div>
  355. </div>
  356. </div>
  357. <footer>
  358. <div class="grad-bottom"></div>
  359. <div class="footer">
  360. <div class="container">
  361. <span class="pull-right">
  362. <a href="#top">Back to top</a>
  363. </span>
  364. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  365. </div>
  366. </div>
  367. </footer>
  368. </div>
  369. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  370. <script type="text/javascript" src="../../styles/docfx.js"></script>
  371. <script type="text/javascript" src="../../styles/main.js"></script>
  372. </body>
  373. </html>