Terminal.Gui.Button.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718
  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 Button
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Button
  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.Gui.Button">
  63. <h1 id="Terminal_Gui_Button" data-uid="Terminal.Gui.Button">Class Button
  64. </h1>
  65. <div class="markdown level0 summary"><p>Button is a view that provides an item that invokes a callback when activated.</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <div class="inheritance">
  69. <h5>Inheritance</h5>
  70. <div class="level0"><span class="xref">System.Object</span></div>
  71. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  72. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  73. <div class="level3"><span class="xref">Button</span></div>
  74. </div>
  75. <div class="inheritedMembers">
  76. <h5>Inherited Members</h5>
  77. <div>
  78. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
  79. </div>
  80. <div>
  81. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  82. </div>
  83. <div>
  84. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  85. </div>
  86. <div>
  87. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  88. </div>
  89. <div>
  90. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  109. </div>
  110. <div>
  111. <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>
  112. </div>
  113. <div>
  114. <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>
  115. </div>
  116. <div>
  117. <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>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  199. </div>
  200. <div>
  201. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  208. </div>
  209. </div>
  210. <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
  211. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  212. <h5 id="Terminal_Gui_Button_syntax">Syntax</h5>
  213. <div class="codewrapper">
  214. <pre><code class="lang-csharp hljs">public class Button : Terminal.Gui.View</code></pre>
  215. </div>
  216. <h5 id="Terminal_Gui_Button_remarks"><strong>Remarks</strong></h5>
  217. <div class="markdown level0 remarks"><p>
  218. Provides a button that can be clicked, or pressed with
  219. the enter key and processes hotkeys (the first uppercase
  220. letter in the button becomes the hotkey).
  221. </p>
  222. <p>
  223. If the button is configured as the default (IsDefault) the button
  224. will respond to the return key is no other view processes it, and
  225. turns this into a clicked event.
  226. </p></div>
  227. <h3 id="constructors">Constructors
  228. </h3>
  229. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  230. <h4 id="Terminal_Gui_Button__ctor_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.Button.#ctor(NStack.ustring,System.Boolean)">Button(ustring, Boolean)</h4>
  231. <div class="markdown level1 summary"><p>Public constructor, creates a button based on
  232. the given text at position 0,0</p>
  233. </div>
  234. <div class="markdown level1 conceptual"></div>
  235. <h5 class="decalaration">Declaration</h5>
  236. <div class="codewrapper">
  237. <pre><code class="lang-csharp hljs">public Button (NStack.ustring text, bool is_default = false);</code></pre>
  238. </div>
  239. <h5 class="parameters">Parameters</h5>
  240. <table class="table table-bordered table-striped table-condensed">
  241. <thead>
  242. <tr>
  243. <th>Type</th>
  244. <th>Name</th>
  245. <th>Description</th>
  246. </tr>
  247. </thead>
  248. <tbody>
  249. <tr>
  250. <td><span class="xref">NStack.ustring</span></td>
  251. <td><span class="parametername">text</span></td>
  252. <td><p>The button&#39;s text</p>
  253. </td>
  254. </tr>
  255. <tr>
  256. <td><span class="xref">System.Boolean</span></td>
  257. <td><span class="parametername">is_default</span></td>
  258. <td><p>If set, this makes the button the default button in the current view, which means that if the user presses return on a view that does not handle return, it will be treated as if he had clicked on the button</p>
  259. </td>
  260. </tr>
  261. </tbody>
  262. </table>
  263. <h5 id="Terminal_Gui_Button__ctor_NStack_ustring_System_Boolean__remarks">Remarks</h5>
  264. <div class="markdown level1 remarks"><p>The size of the button is computed based on the
  265. text length. This button is not a default button.</p>
  266. </div>
  267. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  268. <h4 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring_" data-uid="Terminal.Gui.Button.#ctor(System.Int32,System.Int32,NStack.ustring)">Button(Int32, Int32, ustring)</h4>
  269. <div class="markdown level1 summary"><p>Public constructor, creates a button based on
  270. the given text at the given position.</p>
  271. </div>
  272. <div class="markdown level1 conceptual"></div>
  273. <h5 class="decalaration">Declaration</h5>
  274. <div class="codewrapper">
  275. <pre><code class="lang-csharp hljs">public Button (int x, int y, NStack.ustring text);</code></pre>
  276. </div>
  277. <h5 class="parameters">Parameters</h5>
  278. <table class="table table-bordered table-striped table-condensed">
  279. <thead>
  280. <tr>
  281. <th>Type</th>
  282. <th>Name</th>
  283. <th>Description</th>
  284. </tr>
  285. </thead>
  286. <tbody>
  287. <tr>
  288. <td><span class="xref">System.Int32</span></td>
  289. <td><span class="parametername">x</span></td>
  290. <td><p>X position where the button will be shown.</p>
  291. </td>
  292. </tr>
  293. <tr>
  294. <td><span class="xref">System.Int32</span></td>
  295. <td><span class="parametername">y</span></td>
  296. <td><p>Y position where the button will be shown.</p>
  297. </td>
  298. </tr>
  299. <tr>
  300. <td><span class="xref">NStack.ustring</span></td>
  301. <td><span class="parametername">text</span></td>
  302. <td><p>The button&#39;s text</p>
  303. </td>
  304. </tr>
  305. </tbody>
  306. </table>
  307. <h5 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring__remarks">Remarks</h5>
  308. <div class="markdown level1 remarks"><p>The size of the button is computed based on the
  309. text length. This button is not a default button.</p>
  310. </div>
  311. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  312. <h4 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.Button.#ctor(System.Int32,System.Int32,NStack.ustring,System.Boolean)">Button(Int32, Int32, ustring, Boolean)</h4>
  313. <div class="markdown level1 summary"><p>Public constructor, creates a button based on
  314. the given text at the given position.</p>
  315. </div>
  316. <div class="markdown level1 conceptual"></div>
  317. <h5 class="decalaration">Declaration</h5>
  318. <div class="codewrapper">
  319. <pre><code class="lang-csharp hljs">public Button (int x, int y, NStack.ustring text, bool is_default);</code></pre>
  320. </div>
  321. <h5 class="parameters">Parameters</h5>
  322. <table class="table table-bordered table-striped table-condensed">
  323. <thead>
  324. <tr>
  325. <th>Type</th>
  326. <th>Name</th>
  327. <th>Description</th>
  328. </tr>
  329. </thead>
  330. <tbody>
  331. <tr>
  332. <td><span class="xref">System.Int32</span></td>
  333. <td><span class="parametername">x</span></td>
  334. <td><p>X position where the button will be shown.</p>
  335. </td>
  336. </tr>
  337. <tr>
  338. <td><span class="xref">System.Int32</span></td>
  339. <td><span class="parametername">y</span></td>
  340. <td><p>Y position where the button will be shown.</p>
  341. </td>
  342. </tr>
  343. <tr>
  344. <td><span class="xref">NStack.ustring</span></td>
  345. <td><span class="parametername">text</span></td>
  346. <td><p>The button&#39;s text</p>
  347. </td>
  348. </tr>
  349. <tr>
  350. <td><span class="xref">System.Boolean</span></td>
  351. <td><span class="parametername">is_default</span></td>
  352. <td><p>If set, this makes the button the default button in the current view, which means that if the user presses return on a view that does not handle return, it will be treated as if he had clicked on the button</p>
  353. </td>
  354. </tr>
  355. </tbody>
  356. </table>
  357. <h5 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean__remarks">Remarks</h5>
  358. <div class="markdown level1 remarks"><p>If the value for is_default is true, a special
  359. decoration is used, and the enter key on a
  360. dialog would implicitly activate this button.</p>
  361. </div>
  362. <h3 id="fields">Fields
  363. </h3>
  364. <h4 id="Terminal_Gui_Button_Clicked" data-uid="Terminal.Gui.Button.Clicked">Clicked</h4>
  365. <div class="markdown level1 summary"><p>Clicked event, raised when the button is clicked.</p>
  366. </div>
  367. <div class="markdown level1 conceptual"></div>
  368. <h5 class="decalaration">Declaration</h5>
  369. <div class="codewrapper">
  370. <pre><code class="lang-csharp hljs">public Action Clicked;</code></pre>
  371. </div>
  372. <h5 class="fieldValue">Field Value</h5>
  373. <table class="table table-bordered table-striped table-condensed">
  374. <thead>
  375. <tr>
  376. <th>Type</th>
  377. <th>Description</th>
  378. </tr>
  379. </thead>
  380. <tbody>
  381. <tr>
  382. <td><span class="xref">System.Action</span></td>
  383. <td><p>To be added.</p>
  384. </td>
  385. </tr>
  386. </tbody>
  387. </table>
  388. <h5 id="Terminal_Gui_Button_Clicked_remarks">Remarks</h5>
  389. <div class="markdown level1 remarks"><p>Client code can hook up to this event, it is
  390. raised when the button is activated either with
  391. the mouse or the keyboard.</p>
  392. </div>
  393. <h3 id="properties">Properties
  394. </h3>
  395. <a id="Terminal_Gui_Button_IsDefault_" data-uid="Terminal.Gui.Button.IsDefault*"></a>
  396. <h4 id="Terminal_Gui_Button_IsDefault" data-uid="Terminal.Gui.Button.IsDefault">IsDefault</h4>
  397. <div class="markdown level1 summary"><p>Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Button.html">Button</a> is the default action to activate on return on a dialog.</p>
  398. </div>
  399. <div class="markdown level1 conceptual"></div>
  400. <h5 class="decalaration">Declaration</h5>
  401. <div class="codewrapper">
  402. <pre><code class="lang-csharp hljs">public bool IsDefault { get; set; }</code></pre>
  403. </div>
  404. <h5 class="propertyValue">Property Value</h5>
  405. <table class="table table-bordered table-striped table-condensed">
  406. <thead>
  407. <tr>
  408. <th>Type</th>
  409. <th>Description</th>
  410. </tr>
  411. </thead>
  412. <tbody>
  413. <tr>
  414. <td><span class="xref">System.Boolean</span></td>
  415. <td><p><code>true</code> if is default; otherwise, <code>false</code>.</p>
  416. </td>
  417. </tr>
  418. </tbody>
  419. </table>
  420. <a id="Terminal_Gui_Button_Text_" data-uid="Terminal.Gui.Button.Text*"></a>
  421. <h4 id="Terminal_Gui_Button_Text" data-uid="Terminal.Gui.Button.Text">Text</h4>
  422. <div class="markdown level1 summary"><p>The text displayed by this widget.</p>
  423. </div>
  424. <div class="markdown level1 conceptual"></div>
  425. <h5 class="decalaration">Declaration</h5>
  426. <div class="codewrapper">
  427. <pre><code class="lang-csharp hljs">public NStack.ustring Text { get; set; }</code></pre>
  428. </div>
  429. <h5 class="propertyValue">Property Value</h5>
  430. <table class="table table-bordered table-striped table-condensed">
  431. <thead>
  432. <tr>
  433. <th>Type</th>
  434. <th>Description</th>
  435. </tr>
  436. </thead>
  437. <tbody>
  438. <tr>
  439. <td><span class="xref">NStack.ustring</span></td>
  440. <td><p>To be added.</p>
  441. </td>
  442. </tr>
  443. </tbody>
  444. </table>
  445. <h3 id="methods">Methods
  446. </h3>
  447. <a id="Terminal_Gui_Button_MouseEvent_" data-uid="Terminal.Gui.Button.MouseEvent*"></a>
  448. <h4 id="Terminal_Gui_Button_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Button.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  449. <div class="markdown level1 summary"></div>
  450. <div class="markdown level1 conceptual"></div>
  451. <h5 class="decalaration">Declaration</h5>
  452. <div class="codewrapper">
  453. <pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.Gui.MouseEvent me);</code></pre>
  454. </div>
  455. <h5 class="parameters">Parameters</h5>
  456. <table class="table table-bordered table-striped table-condensed">
  457. <thead>
  458. <tr>
  459. <th>Type</th>
  460. <th>Name</th>
  461. <th>Description</th>
  462. </tr>
  463. </thead>
  464. <tbody>
  465. <tr>
  466. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  467. <td><span class="parametername">me</span></td>
  468. <td><p>To be added.</p>
  469. </td>
  470. </tr>
  471. </tbody>
  472. </table>
  473. <h5 class="returns">Returns</h5>
  474. <table class="table table-bordered table-striped table-condensed">
  475. <thead>
  476. <tr>
  477. <th>Type</th>
  478. <th>Description</th>
  479. </tr>
  480. </thead>
  481. <tbody>
  482. <tr>
  483. <td><span class="xref">System.Boolean</span></td>
  484. <td><p>To be added.</p>
  485. </td>
  486. </tr>
  487. </tbody>
  488. </table>
  489. <a id="Terminal_Gui_Button_PositionCursor_" data-uid="Terminal.Gui.Button.PositionCursor*"></a>
  490. <h4 id="Terminal_Gui_Button_PositionCursor" data-uid="Terminal.Gui.Button.PositionCursor">PositionCursor()</h4>
  491. <div class="markdown level1 summary"></div>
  492. <div class="markdown level1 conceptual"></div>
  493. <h5 class="decalaration">Declaration</h5>
  494. <div class="codewrapper">
  495. <pre><code class="lang-csharp hljs">public override void PositionCursor ();</code></pre>
  496. </div>
  497. <a id="Terminal_Gui_Button_ProcessColdKey_" data-uid="Terminal.Gui.Button.ProcessColdKey*"></a>
  498. <h4 id="Terminal_Gui_Button_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
  499. <div class="markdown level1 summary"></div>
  500. <div class="markdown level1 conceptual"></div>
  501. <h5 class="decalaration">Declaration</h5>
  502. <div class="codewrapper">
  503. <pre><code class="lang-csharp hljs">public override bool ProcessColdKey (Terminal.Gui.KeyEvent kb);</code></pre>
  504. </div>
  505. <h5 class="parameters">Parameters</h5>
  506. <table class="table table-bordered table-striped table-condensed">
  507. <thead>
  508. <tr>
  509. <th>Type</th>
  510. <th>Name</th>
  511. <th>Description</th>
  512. </tr>
  513. </thead>
  514. <tbody>
  515. <tr>
  516. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  517. <td><span class="parametername">kb</span></td>
  518. <td><p>To be added.</p>
  519. </td>
  520. </tr>
  521. </tbody>
  522. </table>
  523. <h5 class="returns">Returns</h5>
  524. <table class="table table-bordered table-striped table-condensed">
  525. <thead>
  526. <tr>
  527. <th>Type</th>
  528. <th>Description</th>
  529. </tr>
  530. </thead>
  531. <tbody>
  532. <tr>
  533. <td><span class="xref">System.Boolean</span></td>
  534. <td><p>To be added.</p>
  535. </td>
  536. </tr>
  537. </tbody>
  538. </table>
  539. <a id="Terminal_Gui_Button_ProcessHotKey_" data-uid="Terminal.Gui.Button.ProcessHotKey*"></a>
  540. <h4 id="Terminal_Gui_Button_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  541. <div class="markdown level1 summary"></div>
  542. <div class="markdown level1 conceptual"></div>
  543. <h5 class="decalaration">Declaration</h5>
  544. <div class="codewrapper">
  545. <pre><code class="lang-csharp hljs">public override bool ProcessHotKey (Terminal.Gui.KeyEvent kb);</code></pre>
  546. </div>
  547. <h5 class="parameters">Parameters</h5>
  548. <table class="table table-bordered table-striped table-condensed">
  549. <thead>
  550. <tr>
  551. <th>Type</th>
  552. <th>Name</th>
  553. <th>Description</th>
  554. </tr>
  555. </thead>
  556. <tbody>
  557. <tr>
  558. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  559. <td><span class="parametername">kb</span></td>
  560. <td><p>To be added.</p>
  561. </td>
  562. </tr>
  563. </tbody>
  564. </table>
  565. <h5 class="returns">Returns</h5>
  566. <table class="table table-bordered table-striped table-condensed">
  567. <thead>
  568. <tr>
  569. <th>Type</th>
  570. <th>Description</th>
  571. </tr>
  572. </thead>
  573. <tbody>
  574. <tr>
  575. <td><span class="xref">System.Boolean</span></td>
  576. <td><p>To be added.</p>
  577. </td>
  578. </tr>
  579. </tbody>
  580. </table>
  581. <a id="Terminal_Gui_Button_ProcessKey_" data-uid="Terminal.Gui.Button.ProcessKey*"></a>
  582. <h4 id="Terminal_Gui_Button_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  583. <div class="markdown level1 summary"></div>
  584. <div class="markdown level1 conceptual"></div>
  585. <h5 class="decalaration">Declaration</h5>
  586. <div class="codewrapper">
  587. <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent kb);</code></pre>
  588. </div>
  589. <h5 class="parameters">Parameters</h5>
  590. <table class="table table-bordered table-striped table-condensed">
  591. <thead>
  592. <tr>
  593. <th>Type</th>
  594. <th>Name</th>
  595. <th>Description</th>
  596. </tr>
  597. </thead>
  598. <tbody>
  599. <tr>
  600. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  601. <td><span class="parametername">kb</span></td>
  602. <td><p>To be added.</p>
  603. </td>
  604. </tr>
  605. </tbody>
  606. </table>
  607. <h5 class="returns">Returns</h5>
  608. <table class="table table-bordered table-striped table-condensed">
  609. <thead>
  610. <tr>
  611. <th>Type</th>
  612. <th>Description</th>
  613. </tr>
  614. </thead>
  615. <tbody>
  616. <tr>
  617. <td><span class="xref">System.Boolean</span></td>
  618. <td><p>To be added.</p>
  619. </td>
  620. </tr>
  621. </tbody>
  622. </table>
  623. <a id="Terminal_Gui_Button_Redraw_" data-uid="Terminal.Gui.Button.Redraw*"></a>
  624. <h4 id="Terminal_Gui_Button_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Button.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  625. <div class="markdown level1 summary"></div>
  626. <div class="markdown level1 conceptual"></div>
  627. <h5 class="decalaration">Declaration</h5>
  628. <div class="codewrapper">
  629. <pre><code class="lang-csharp hljs">public override void Redraw (Terminal.Gui.Rect region);</code></pre>
  630. </div>
  631. <h5 class="parameters">Parameters</h5>
  632. <table class="table table-bordered table-striped table-condensed">
  633. <thead>
  634. <tr>
  635. <th>Type</th>
  636. <th>Name</th>
  637. <th>Description</th>
  638. </tr>
  639. </thead>
  640. <tbody>
  641. <tr>
  642. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  643. <td><span class="parametername">region</span></td>
  644. <td><p>To be added.</p>
  645. </td>
  646. </tr>
  647. </tbody>
  648. </table>
  649. </article>
  650. </div>
  651. <div class="hidden-sm col-md-2" role="complementary">
  652. <div class="sideaffix">
  653. <div class="contribution">
  654. <ul class="nav">
  655. </ul>
  656. </div>
  657. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  658. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  659. </nav>
  660. </div>
  661. </div>
  662. </div>
  663. </div>
  664. <footer>
  665. <div class="grad-bottom"></div>
  666. <div class="footer">
  667. <div class="container">
  668. <span class="pull-right">
  669. <a href="#top">Back to top</a>
  670. </span>
  671. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  672. </div>
  673. </div>
  674. </footer>
  675. </div>
  676. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  677. <script type="text/javascript" src="../../styles/docfx.js"></script>
  678. <script type="text/javascript" src="../../styles/main.js"></script>
  679. </body>
  680. </html>