Terminal.Gui.Responder.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866
  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 Responder
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Responder
  11. ">
  12. <meta name="generator" content="docfx 2.58.5.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.Responder">
  73. <h1 id="Terminal_Gui_Responder" data-uid="Terminal.Gui.Responder" class="text-break">Class Responder
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Responder base class implemented by objects that want to participate on keyboard and mouse input.
  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"><span class="xref">Responder</span></div>
  83. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  84. </div>
  85. <div classs="implements">
  86. <h5>Implements</h5>
  87. <div><span class="xref">System.IDisposable</span></div>
  88. </div>
  89. <div class="inheritedMembers">
  90. <h5>Inherited Members</h5>
  91. <div>
  92. <span class="xref">System.Object.Equals(System.Object)</span>
  93. </div>
  94. <div>
  95. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  96. </div>
  97. <div>
  98. <span class="xref">System.Object.GetHashCode()</span>
  99. </div>
  100. <div>
  101. <span class="xref">System.Object.GetType()</span>
  102. </div>
  103. <div>
  104. <span class="xref">System.Object.MemberwiseClone()</span>
  105. </div>
  106. <div>
  107. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  108. </div>
  109. <div>
  110. <span class="xref">System.Object.ToString()</span>
  111. </div>
  112. </div>
  113. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  114. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  115. <h5 id="Terminal_Gui_Responder_syntax">Syntax</h5>
  116. <div class="codewrapper">
  117. <pre><code class="lang-csharp hljs">public class Responder : IDisposable</code></pre>
  118. </div>
  119. <h3 id="properties">Properties
  120. </h3>
  121. <a id="Terminal_Gui_Responder_CanFocus_" data-uid="Terminal.Gui.Responder.CanFocus*"></a>
  122. <h4 id="Terminal_Gui_Responder_CanFocus" data-uid="Terminal.Gui.Responder.CanFocus">CanFocus</h4>
  123. <div class="markdown level1 summary">
  124. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> can focus.
  125. </div>
  126. <div class="markdown level1 conceptual"></div>
  127. <h5 class="decalaration">Declaration</h5>
  128. <div class="codewrapper">
  129. <pre><code class="lang-csharp hljs">public virtual bool CanFocus { get; set; }</code></pre>
  130. </div>
  131. <h5 class="propertyValue">Property Value</h5>
  132. <table class="table table-bordered table-striped table-condensed">
  133. <thead>
  134. <tr>
  135. <th>Type</th>
  136. <th>Description</th>
  137. </tr>
  138. </thead>
  139. <tbody>
  140. <tr>
  141. <td><span class="xref">System.Boolean</span></td>
  142. <td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. <a id="Terminal_Gui_Responder_Enabled_" data-uid="Terminal.Gui.Responder.Enabled*"></a>
  147. <h4 id="Terminal_Gui_Responder_Enabled" data-uid="Terminal.Gui.Responder.Enabled">Enabled</h4>
  148. <div class="markdown level1 summary">
  149. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> can respond to user interaction.
  150. </div>
  151. <div class="markdown level1 conceptual"></div>
  152. <h5 class="decalaration">Declaration</h5>
  153. <div class="codewrapper">
  154. <pre><code class="lang-csharp hljs">public virtual bool Enabled { get; set; }</code></pre>
  155. </div>
  156. <h5 class="propertyValue">Property Value</h5>
  157. <table class="table table-bordered table-striped table-condensed">
  158. <thead>
  159. <tr>
  160. <th>Type</th>
  161. <th>Description</th>
  162. </tr>
  163. </thead>
  164. <tbody>
  165. <tr>
  166. <td><span class="xref">System.Boolean</span></td>
  167. <td></td>
  168. </tr>
  169. </tbody>
  170. </table>
  171. <a id="Terminal_Gui_Responder_HasFocus_" data-uid="Terminal.Gui.Responder.HasFocus*"></a>
  172. <h4 id="Terminal_Gui_Responder_HasFocus" data-uid="Terminal.Gui.Responder.HasFocus">HasFocus</h4>
  173. <div class="markdown level1 summary">
  174. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> has focus.
  175. </div>
  176. <div class="markdown level1 conceptual"></div>
  177. <h5 class="decalaration">Declaration</h5>
  178. <div class="codewrapper">
  179. <pre><code class="lang-csharp hljs">public virtual bool HasFocus { get; }</code></pre>
  180. </div>
  181. <h5 class="propertyValue">Property Value</h5>
  182. <table class="table table-bordered table-striped table-condensed">
  183. <thead>
  184. <tr>
  185. <th>Type</th>
  186. <th>Description</th>
  187. </tr>
  188. </thead>
  189. <tbody>
  190. <tr>
  191. <td><span class="xref">System.Boolean</span></td>
  192. <td><code>true</code> if has focus; otherwise, <code>false</code>.</td>
  193. </tr>
  194. </tbody>
  195. </table>
  196. <a id="Terminal_Gui_Responder_Visible_" data-uid="Terminal.Gui.Responder.Visible*"></a>
  197. <h4 id="Terminal_Gui_Responder_Visible" data-uid="Terminal.Gui.Responder.Visible">Visible</h4>
  198. <div class="markdown level1 summary">
  199. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> and all its child controls are displayed.
  200. </div>
  201. <div class="markdown level1 conceptual"></div>
  202. <h5 class="decalaration">Declaration</h5>
  203. <div class="codewrapper">
  204. <pre><code class="lang-csharp hljs">public virtual bool Visible { get; set; }</code></pre>
  205. </div>
  206. <h5 class="propertyValue">Property Value</h5>
  207. <table class="table table-bordered table-striped table-condensed">
  208. <thead>
  209. <tr>
  210. <th>Type</th>
  211. <th>Description</th>
  212. </tr>
  213. </thead>
  214. <tbody>
  215. <tr>
  216. <td><span class="xref">System.Boolean</span></td>
  217. <td></td>
  218. </tr>
  219. </tbody>
  220. </table>
  221. <h3 id="methods">Methods
  222. </h3>
  223. <a id="Terminal_Gui_Responder_Dispose_" data-uid="Terminal.Gui.Responder.Dispose*"></a>
  224. <h4 id="Terminal_Gui_Responder_Dispose" data-uid="Terminal.Gui.Responder.Dispose">Dispose()</h4>
  225. <div class="markdown level1 summary">
  226. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resource.
  227. </div>
  228. <div class="markdown level1 conceptual"></div>
  229. <h5 class="decalaration">Declaration</h5>
  230. <div class="codewrapper">
  231. <pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
  232. </div>
  233. <a id="Terminal_Gui_Responder_Dispose_" data-uid="Terminal.Gui.Responder.Dispose*"></a>
  234. <h4 id="Terminal_Gui_Responder_Dispose_System_Boolean_" data-uid="Terminal.Gui.Responder.Dispose(System.Boolean)">Dispose(Boolean)</h4>
  235. <div class="markdown level1 summary">
  236. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  237. </div>
  238. <div class="markdown level1 conceptual"></div>
  239. <h5 class="decalaration">Declaration</h5>
  240. <div class="codewrapper">
  241. <pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
  242. </div>
  243. <h5 class="parameters">Parameters</h5>
  244. <table class="table table-bordered table-striped table-condensed">
  245. <thead>
  246. <tr>
  247. <th>Type</th>
  248. <th>Name</th>
  249. <th>Description</th>
  250. </tr>
  251. </thead>
  252. <tbody>
  253. <tr>
  254. <td><span class="xref">System.Boolean</span></td>
  255. <td><span class="parametername">disposing</span></td>
  256. <td></td>
  257. </tr>
  258. </tbody>
  259. </table>
  260. <h5 id="Terminal_Gui_Responder_Dispose_System_Boolean__remarks">Remarks</h5>
  261. <div class="markdown level1 remarks">
  262. If disposing equals true, the method has been called directly
  263. or indirectly by a user&apos;s code. Managed and unmanaged resources
  264. can be disposed.
  265. If disposing equals false, the method has been called by the
  266. runtime from inside the finalizer and you should not reference
  267. other objects. Only unmanaged resources can be disposed.
  268. </div>
  269. <a id="Terminal_Gui_Responder_MouseEvent_" data-uid="Terminal.Gui.Responder.MouseEvent*"></a>
  270. <h4 id="Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Responder.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  271. <div class="markdown level1 summary">
  272. Method invoked when a mouse event is generated
  273. </div>
  274. <div class="markdown level1 conceptual"></div>
  275. <h5 class="decalaration">Declaration</h5>
  276. <div class="codewrapper">
  277. <pre><code class="lang-csharp hljs">public virtual bool MouseEvent(MouseEvent mouseEvent)</code></pre>
  278. </div>
  279. <h5 class="parameters">Parameters</h5>
  280. <table class="table table-bordered table-striped table-condensed">
  281. <thead>
  282. <tr>
  283. <th>Type</th>
  284. <th>Name</th>
  285. <th>Description</th>
  286. </tr>
  287. </thead>
  288. <tbody>
  289. <tr>
  290. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  291. <td><span class="parametername">mouseEvent</span></td>
  292. <td>Contains the details about the mouse event.</td>
  293. </tr>
  294. </tbody>
  295. </table>
  296. <h5 class="returns">Returns</h5>
  297. <table class="table table-bordered table-striped table-condensed">
  298. <thead>
  299. <tr>
  300. <th>Type</th>
  301. <th>Description</th>
  302. </tr>
  303. </thead>
  304. <tbody>
  305. <tr>
  306. <td><span class="xref">System.Boolean</span></td>
  307. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  308. </tr>
  309. </tbody>
  310. </table>
  311. <a id="Terminal_Gui_Responder_OnCanFocusChanged_" data-uid="Terminal.Gui.Responder.OnCanFocusChanged*"></a>
  312. <h4 id="Terminal_Gui_Responder_OnCanFocusChanged" data-uid="Terminal.Gui.Responder.OnCanFocusChanged">OnCanFocusChanged()</h4>
  313. <div class="markdown level1 summary">
  314. Method invoked when the <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">CanFocus</a> property from a view is changed.
  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 virtual void OnCanFocusChanged()</code></pre>
  320. </div>
  321. <a id="Terminal_Gui_Responder_OnEnabledChanged_" data-uid="Terminal.Gui.Responder.OnEnabledChanged*"></a>
  322. <h4 id="Terminal_Gui_Responder_OnEnabledChanged" data-uid="Terminal.Gui.Responder.OnEnabledChanged">OnEnabledChanged()</h4>
  323. <div class="markdown level1 summary">
  324. Method invoked when the <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Enabled">Enabled</a> property from a view is changed.
  325. </div>
  326. <div class="markdown level1 conceptual"></div>
  327. <h5 class="decalaration">Declaration</h5>
  328. <div class="codewrapper">
  329. <pre><code class="lang-csharp hljs">public virtual void OnEnabledChanged()</code></pre>
  330. </div>
  331. <a id="Terminal_Gui_Responder_OnEnter_" data-uid="Terminal.Gui.Responder.OnEnter*"></a>
  332. <h4 id="Terminal_Gui_Responder_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.Responder.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  333. <div class="markdown level1 summary">
  334. Method invoked when a view gets focus.
  335. </div>
  336. <div class="markdown level1 conceptual"></div>
  337. <h5 class="decalaration">Declaration</h5>
  338. <div class="codewrapper">
  339. <pre><code class="lang-csharp hljs">public virtual bool OnEnter(View view)</code></pre>
  340. </div>
  341. <h5 class="parameters">Parameters</h5>
  342. <table class="table table-bordered table-striped table-condensed">
  343. <thead>
  344. <tr>
  345. <th>Type</th>
  346. <th>Name</th>
  347. <th>Description</th>
  348. </tr>
  349. </thead>
  350. <tbody>
  351. <tr>
  352. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  353. <td><span class="parametername">view</span></td>
  354. <td>The view that is losing focus.</td>
  355. </tr>
  356. </tbody>
  357. </table>
  358. <h5 class="returns">Returns</h5>
  359. <table class="table table-bordered table-striped table-condensed">
  360. <thead>
  361. <tr>
  362. <th>Type</th>
  363. <th>Description</th>
  364. </tr>
  365. </thead>
  366. <tbody>
  367. <tr>
  368. <td><span class="xref">System.Boolean</span></td>
  369. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  370. </tr>
  371. </tbody>
  372. </table>
  373. <a id="Terminal_Gui_Responder_OnKeyDown_" data-uid="Terminal.Gui.Responder.OnKeyDown*"></a>
  374. <h4 id="Terminal_Gui_Responder_OnKeyDown_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Responder.OnKeyDown(Terminal.Gui.KeyEvent)">OnKeyDown(KeyEvent)</h4>
  375. <div class="markdown level1 summary">
  376. Method invoked when a key is pressed.
  377. </div>
  378. <div class="markdown level1 conceptual"></div>
  379. <h5 class="decalaration">Declaration</h5>
  380. <div class="codewrapper">
  381. <pre><code class="lang-csharp hljs">public virtual bool OnKeyDown(KeyEvent keyEvent)</code></pre>
  382. </div>
  383. <h5 class="parameters">Parameters</h5>
  384. <table class="table table-bordered table-striped table-condensed">
  385. <thead>
  386. <tr>
  387. <th>Type</th>
  388. <th>Name</th>
  389. <th>Description</th>
  390. </tr>
  391. </thead>
  392. <tbody>
  393. <tr>
  394. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  395. <td><span class="parametername">keyEvent</span></td>
  396. <td>Contains the details about the key that produced the event.</td>
  397. </tr>
  398. </tbody>
  399. </table>
  400. <h5 class="returns">Returns</h5>
  401. <table class="table table-bordered table-striped table-condensed">
  402. <thead>
  403. <tr>
  404. <th>Type</th>
  405. <th>Description</th>
  406. </tr>
  407. </thead>
  408. <tbody>
  409. <tr>
  410. <td><span class="xref">System.Boolean</span></td>
  411. <td>true if the event was handled</td>
  412. </tr>
  413. </tbody>
  414. </table>
  415. <a id="Terminal_Gui_Responder_OnKeyUp_" data-uid="Terminal.Gui.Responder.OnKeyUp*"></a>
  416. <h4 id="Terminal_Gui_Responder_OnKeyUp_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Responder.OnKeyUp(Terminal.Gui.KeyEvent)">OnKeyUp(KeyEvent)</h4>
  417. <div class="markdown level1 summary">
  418. Method invoked when a key is released.
  419. </div>
  420. <div class="markdown level1 conceptual"></div>
  421. <h5 class="decalaration">Declaration</h5>
  422. <div class="codewrapper">
  423. <pre><code class="lang-csharp hljs">public virtual bool OnKeyUp(KeyEvent keyEvent)</code></pre>
  424. </div>
  425. <h5 class="parameters">Parameters</h5>
  426. <table class="table table-bordered table-striped table-condensed">
  427. <thead>
  428. <tr>
  429. <th>Type</th>
  430. <th>Name</th>
  431. <th>Description</th>
  432. </tr>
  433. </thead>
  434. <tbody>
  435. <tr>
  436. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  437. <td><span class="parametername">keyEvent</span></td>
  438. <td>Contains the details about the key that produced the event.</td>
  439. </tr>
  440. </tbody>
  441. </table>
  442. <h5 class="returns">Returns</h5>
  443. <table class="table table-bordered table-striped table-condensed">
  444. <thead>
  445. <tr>
  446. <th>Type</th>
  447. <th>Description</th>
  448. </tr>
  449. </thead>
  450. <tbody>
  451. <tr>
  452. <td><span class="xref">System.Boolean</span></td>
  453. <td>true if the event was handled</td>
  454. </tr>
  455. </tbody>
  456. </table>
  457. <a id="Terminal_Gui_Responder_OnLeave_" data-uid="Terminal.Gui.Responder.OnLeave*"></a>
  458. <h4 id="Terminal_Gui_Responder_OnLeave_Terminal_Gui_View_" data-uid="Terminal.Gui.Responder.OnLeave(Terminal.Gui.View)">OnLeave(View)</h4>
  459. <div class="markdown level1 summary">
  460. Method invoked when a view loses focus.
  461. </div>
  462. <div class="markdown level1 conceptual"></div>
  463. <h5 class="decalaration">Declaration</h5>
  464. <div class="codewrapper">
  465. <pre><code class="lang-csharp hljs">public virtual bool OnLeave(View view)</code></pre>
  466. </div>
  467. <h5 class="parameters">Parameters</h5>
  468. <table class="table table-bordered table-striped table-condensed">
  469. <thead>
  470. <tr>
  471. <th>Type</th>
  472. <th>Name</th>
  473. <th>Description</th>
  474. </tr>
  475. </thead>
  476. <tbody>
  477. <tr>
  478. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  479. <td><span class="parametername">view</span></td>
  480. <td>The view that is getting focus.</td>
  481. </tr>
  482. </tbody>
  483. </table>
  484. <h5 class="returns">Returns</h5>
  485. <table class="table table-bordered table-striped table-condensed">
  486. <thead>
  487. <tr>
  488. <th>Type</th>
  489. <th>Description</th>
  490. </tr>
  491. </thead>
  492. <tbody>
  493. <tr>
  494. <td><span class="xref">System.Boolean</span></td>
  495. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  496. </tr>
  497. </tbody>
  498. </table>
  499. <a id="Terminal_Gui_Responder_OnMouseEnter_" data-uid="Terminal.Gui.Responder.OnMouseEnter*"></a>
  500. <h4 id="Terminal_Gui_Responder_OnMouseEnter_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Responder.OnMouseEnter(Terminal.Gui.MouseEvent)">OnMouseEnter(MouseEvent)</h4>
  501. <div class="markdown level1 summary">
  502. Method invoked when a mouse event is generated for the first time.
  503. </div>
  504. <div class="markdown level1 conceptual"></div>
  505. <h5 class="decalaration">Declaration</h5>
  506. <div class="codewrapper">
  507. <pre><code class="lang-csharp hljs">public virtual bool OnMouseEnter(MouseEvent mouseEvent)</code></pre>
  508. </div>
  509. <h5 class="parameters">Parameters</h5>
  510. <table class="table table-bordered table-striped table-condensed">
  511. <thead>
  512. <tr>
  513. <th>Type</th>
  514. <th>Name</th>
  515. <th>Description</th>
  516. </tr>
  517. </thead>
  518. <tbody>
  519. <tr>
  520. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  521. <td><span class="parametername">mouseEvent</span></td>
  522. <td></td>
  523. </tr>
  524. </tbody>
  525. </table>
  526. <h5 class="returns">Returns</h5>
  527. <table class="table table-bordered table-striped table-condensed">
  528. <thead>
  529. <tr>
  530. <th>Type</th>
  531. <th>Description</th>
  532. </tr>
  533. </thead>
  534. <tbody>
  535. <tr>
  536. <td><span class="xref">System.Boolean</span></td>
  537. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  538. </tr>
  539. </tbody>
  540. </table>
  541. <a id="Terminal_Gui_Responder_OnMouseLeave_" data-uid="Terminal.Gui.Responder.OnMouseLeave*"></a>
  542. <h4 id="Terminal_Gui_Responder_OnMouseLeave_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Responder.OnMouseLeave(Terminal.Gui.MouseEvent)">OnMouseLeave(MouseEvent)</h4>
  543. <div class="markdown level1 summary">
  544. Method invoked when a mouse event is generated for the last time.
  545. </div>
  546. <div class="markdown level1 conceptual"></div>
  547. <h5 class="decalaration">Declaration</h5>
  548. <div class="codewrapper">
  549. <pre><code class="lang-csharp hljs">public virtual bool OnMouseLeave(MouseEvent mouseEvent)</code></pre>
  550. </div>
  551. <h5 class="parameters">Parameters</h5>
  552. <table class="table table-bordered table-striped table-condensed">
  553. <thead>
  554. <tr>
  555. <th>Type</th>
  556. <th>Name</th>
  557. <th>Description</th>
  558. </tr>
  559. </thead>
  560. <tbody>
  561. <tr>
  562. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  563. <td><span class="parametername">mouseEvent</span></td>
  564. <td></td>
  565. </tr>
  566. </tbody>
  567. </table>
  568. <h5 class="returns">Returns</h5>
  569. <table class="table table-bordered table-striped table-condensed">
  570. <thead>
  571. <tr>
  572. <th>Type</th>
  573. <th>Description</th>
  574. </tr>
  575. </thead>
  576. <tbody>
  577. <tr>
  578. <td><span class="xref">System.Boolean</span></td>
  579. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  580. </tr>
  581. </tbody>
  582. </table>
  583. <a id="Terminal_Gui_Responder_OnVisibleChanged_" data-uid="Terminal.Gui.Responder.OnVisibleChanged*"></a>
  584. <h4 id="Terminal_Gui_Responder_OnVisibleChanged" data-uid="Terminal.Gui.Responder.OnVisibleChanged">OnVisibleChanged()</h4>
  585. <div class="markdown level1 summary">
  586. Method invoked when the <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Visible">Visible</a> property from a view is changed.
  587. </div>
  588. <div class="markdown level1 conceptual"></div>
  589. <h5 class="decalaration">Declaration</h5>
  590. <div class="codewrapper">
  591. <pre><code class="lang-csharp hljs">public virtual void OnVisibleChanged()</code></pre>
  592. </div>
  593. <a id="Terminal_Gui_Responder_ProcessColdKey_" data-uid="Terminal.Gui.Responder.ProcessColdKey*"></a>
  594. <h4 id="Terminal_Gui_Responder_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Responder.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
  595. <div class="markdown level1 summary">
  596. This method can be overwritten by views that
  597. want to provide accelerator functionality
  598. (Alt-key for example), but without
  599. interefering with normal ProcessKey behavior.
  600. </div>
  601. <div class="markdown level1 conceptual"></div>
  602. <h5 class="decalaration">Declaration</h5>
  603. <div class="codewrapper">
  604. <pre><code class="lang-csharp hljs">public virtual bool ProcessColdKey(KeyEvent keyEvent)</code></pre>
  605. </div>
  606. <h5 class="parameters">Parameters</h5>
  607. <table class="table table-bordered table-striped table-condensed">
  608. <thead>
  609. <tr>
  610. <th>Type</th>
  611. <th>Name</th>
  612. <th>Description</th>
  613. </tr>
  614. </thead>
  615. <tbody>
  616. <tr>
  617. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  618. <td><span class="parametername">keyEvent</span></td>
  619. <td>Contains the details about the key that produced the event.</td>
  620. </tr>
  621. </tbody>
  622. </table>
  623. <h5 class="returns">Returns</h5>
  624. <table class="table table-bordered table-striped table-condensed">
  625. <thead>
  626. <tr>
  627. <th>Type</th>
  628. <th>Description</th>
  629. </tr>
  630. </thead>
  631. <tbody>
  632. <tr>
  633. <td><span class="xref">System.Boolean</span></td>
  634. <td></td>
  635. </tr>
  636. </tbody>
  637. </table>
  638. <h5 id="Terminal_Gui_Responder_ProcessColdKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  639. <div class="markdown level1 remarks">
  640. <p>
  641. After keys are sent to the subviews on the
  642. current view, all the view are
  643. processed and the key is passed to the views
  644. to allow some of them to process the keystroke
  645. as a cold-key. </p>
  646. <p>
  647. This functionality is used, for example, by
  648. default buttons to act on the enter key.
  649. Processing this as a hot-key would prevent
  650. non-default buttons from consuming the enter
  651. keypress when they have the focus.
  652. </p>
  653. </div>
  654. <a id="Terminal_Gui_Responder_ProcessHotKey_" data-uid="Terminal.Gui.Responder.ProcessHotKey*"></a>
  655. <h4 id="Terminal_Gui_Responder_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Responder.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  656. <div class="markdown level1 summary">
  657. This method can be overwritten by view that
  658. want to provide accelerator functionality
  659. (Alt-key for example).
  660. </div>
  661. <div class="markdown level1 conceptual"></div>
  662. <h5 class="decalaration">Declaration</h5>
  663. <div class="codewrapper">
  664. <pre><code class="lang-csharp hljs">public virtual bool ProcessHotKey(KeyEvent kb)</code></pre>
  665. </div>
  666. <h5 class="parameters">Parameters</h5>
  667. <table class="table table-bordered table-striped table-condensed">
  668. <thead>
  669. <tr>
  670. <th>Type</th>
  671. <th>Name</th>
  672. <th>Description</th>
  673. </tr>
  674. </thead>
  675. <tbody>
  676. <tr>
  677. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  678. <td><span class="parametername">kb</span></td>
  679. <td></td>
  680. </tr>
  681. </tbody>
  682. </table>
  683. <h5 class="returns">Returns</h5>
  684. <table class="table table-bordered table-striped table-condensed">
  685. <thead>
  686. <tr>
  687. <th>Type</th>
  688. <th>Description</th>
  689. </tr>
  690. </thead>
  691. <tbody>
  692. <tr>
  693. <td><span class="xref">System.Boolean</span></td>
  694. <td></td>
  695. </tr>
  696. </tbody>
  697. </table>
  698. <h5 id="Terminal_Gui_Responder_ProcessHotKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  699. <div class="markdown level1 remarks">
  700. <p>
  701. Before keys are sent to the subview on the
  702. current view, all the views are
  703. processed and the key is passed to the widgets
  704. to allow some of them to process the keystroke
  705. as a hot-key. </p>
  706. <p>
  707. For example, if you implement a button that
  708. has a hotkey ok &quot;o&quot;, you would catch the
  709. combination Alt-o here. If the event is
  710. caught, you must return true to stop the
  711. keystroke from being dispatched to other
  712. views.
  713. </p>
  714. </div>
  715. <a id="Terminal_Gui_Responder_ProcessKey_" data-uid="Terminal.Gui.Responder.ProcessKey*"></a>
  716. <h4 id="Terminal_Gui_Responder_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Responder.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  717. <div class="markdown level1 summary">
  718. If the view is focused, gives the view a
  719. chance to process the keystroke.
  720. </div>
  721. <div class="markdown level1 conceptual"></div>
  722. <h5 class="decalaration">Declaration</h5>
  723. <div class="codewrapper">
  724. <pre><code class="lang-csharp hljs">public virtual bool ProcessKey(KeyEvent keyEvent)</code></pre>
  725. </div>
  726. <h5 class="parameters">Parameters</h5>
  727. <table class="table table-bordered table-striped table-condensed">
  728. <thead>
  729. <tr>
  730. <th>Type</th>
  731. <th>Name</th>
  732. <th>Description</th>
  733. </tr>
  734. </thead>
  735. <tbody>
  736. <tr>
  737. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  738. <td><span class="parametername">keyEvent</span></td>
  739. <td>Contains the details about the key that produced the event.</td>
  740. </tr>
  741. </tbody>
  742. </table>
  743. <h5 class="returns">Returns</h5>
  744. <table class="table table-bordered table-striped table-condensed">
  745. <thead>
  746. <tr>
  747. <th>Type</th>
  748. <th>Description</th>
  749. </tr>
  750. </thead>
  751. <tbody>
  752. <tr>
  753. <td><span class="xref">System.Boolean</span></td>
  754. <td></td>
  755. </tr>
  756. </tbody>
  757. </table>
  758. <h5 id="Terminal_Gui_Responder_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  759. <div class="markdown level1 remarks">
  760. <p>
  761. Views can override this method if they are
  762. interested in processing the given keystroke.
  763. If they consume the keystroke, they must
  764. return true to stop the keystroke from being
  765. processed by other widgets or consumed by the
  766. widget engine. If they return false, the
  767. keystroke will be passed using the ProcessColdKey
  768. method to other views to process.
  769. </p>
  770. <p>
  771. The View implementation does nothing but return false,
  772. so it is not necessary to call base.ProcessKey if you
  773. derive directly from View, but you should if you derive
  774. other View subclasses.
  775. </p>
  776. </div>
  777. <h3 id="implements">Implements</h3>
  778. <div>
  779. <span class="xref">System.IDisposable</span>
  780. </div>
  781. </article>
  782. </div>
  783. <div class="hidden-sm col-md-2" role="complementary">
  784. <div class="sideaffix">
  785. <div class="contribution">
  786. <ul class="nav">
  787. </ul>
  788. </div>
  789. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  790. <h5>In This Article</h5>
  791. <div></div>
  792. </nav>
  793. </div>
  794. </div>
  795. </div>
  796. </div>
  797. <footer>
  798. <div class="grad-bottom"></div>
  799. <div class="footer">
  800. <div class="container">
  801. <span class="pull-right">
  802. <a href="#top">Back to top</a>
  803. </span>
  804. <span>Generated by <strong>DocFX</strong></span>
  805. </div>
  806. </div>
  807. </footer>
  808. </div>
  809. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  810. <script type="text/javascript" src="../../styles/docfx.js"></script>
  811. <script type="text/javascript" src="../../styles/main.js"></script>
  812. </body>
  813. </html>