Terminal.Gui.Responder.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750
  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.59.3.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
  18. <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../../">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../../index.html">
  35. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list">Search Results for <span></span></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Responder">
  74. <h1 id="Terminal_Gui_Responder" data-uid="Terminal.Gui.Responder" class="text-break">Class Responder
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Responder base class implemented by objects that want to participate on keyboard and mouse input.
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><span class="xref">Responder</span></div>
  84. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  85. </div>
  86. <div class="implements">
  87. <h5>Implements</h5>
  88. <div><span class="xref">System.IDisposable</span></div>
  89. </div>
  90. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  91. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  92. <h5 id="Terminal_Gui_Responder_syntax">Syntax</h5>
  93. <div class="codewrapper">
  94. <pre><code class="lang-csharp hljs">public class Responder : Object</code></pre>
  95. </div>
  96. <h3 id="constructors">Constructors
  97. </h3>
  98. <a id="Terminal_Gui_Responder__ctor_" data-uid="Terminal.Gui.Responder.#ctor*"></a>
  99. <h4 id="Terminal_Gui_Responder__ctor" data-uid="Terminal.Gui.Responder.#ctor">Responder()</h4>
  100. <div class="markdown level1 summary"></div>
  101. <div class="markdown level1 conceptual"></div>
  102. <h5 class="decalaration">Declaration</h5>
  103. <div class="codewrapper">
  104. <pre><code class="lang-csharp hljs">public Responder()</code></pre>
  105. </div>
  106. <h3 id="properties">Properties
  107. </h3>
  108. <a id="Terminal_Gui_Responder_CanFocus_" data-uid="Terminal.Gui.Responder.CanFocus*"></a>
  109. <h4 id="Terminal_Gui_Responder_CanFocus" data-uid="Terminal.Gui.Responder.CanFocus">CanFocus</h4>
  110. <div class="markdown level1 summary">
  111. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> can focus.
  112. </div>
  113. <div class="markdown level1 conceptual"></div>
  114. <h5 class="decalaration">Declaration</h5>
  115. <div class="codewrapper">
  116. <pre><code class="lang-csharp hljs">public virtual bool CanFocus { get; set; }</code></pre>
  117. </div>
  118. <h5 class="propertyValue">Property Value</h5>
  119. <table class="table table-bordered table-striped table-condensed">
  120. <thead>
  121. <tr>
  122. <th>Type</th>
  123. <th>Description</th>
  124. </tr>
  125. </thead>
  126. <tbody>
  127. <tr>
  128. <td><span class="xref">System.Boolean</span></td>
  129. <td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
  130. </tr>
  131. </tbody>
  132. </table>
  133. <a id="Terminal_Gui_Responder_Enabled_" data-uid="Terminal.Gui.Responder.Enabled*"></a>
  134. <h4 id="Terminal_Gui_Responder_Enabled" data-uid="Terminal.Gui.Responder.Enabled">Enabled</h4>
  135. <div class="markdown level1 summary">
  136. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> can respond to user interaction.
  137. </div>
  138. <div class="markdown level1 conceptual"></div>
  139. <h5 class="decalaration">Declaration</h5>
  140. <div class="codewrapper">
  141. <pre><code class="lang-csharp hljs">public virtual bool Enabled { get; set; }</code></pre>
  142. </div>
  143. <h5 class="propertyValue">Property Value</h5>
  144. <table class="table table-bordered table-striped table-condensed">
  145. <thead>
  146. <tr>
  147. <th>Type</th>
  148. <th>Description</th>
  149. </tr>
  150. </thead>
  151. <tbody>
  152. <tr>
  153. <td><span class="xref">System.Boolean</span></td>
  154. <td></td>
  155. </tr>
  156. </tbody>
  157. </table>
  158. <a id="Terminal_Gui_Responder_HasFocus_" data-uid="Terminal.Gui.Responder.HasFocus*"></a>
  159. <h4 id="Terminal_Gui_Responder_HasFocus" data-uid="Terminal.Gui.Responder.HasFocus">HasFocus</h4>
  160. <div class="markdown level1 summary">
  161. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> has focus.
  162. </div>
  163. <div class="markdown level1 conceptual"></div>
  164. <h5 class="decalaration">Declaration</h5>
  165. <div class="codewrapper">
  166. <pre><code class="lang-csharp hljs">public virtual bool HasFocus { get; }</code></pre>
  167. </div>
  168. <h5 class="propertyValue">Property Value</h5>
  169. <table class="table table-bordered table-striped table-condensed">
  170. <thead>
  171. <tr>
  172. <th>Type</th>
  173. <th>Description</th>
  174. </tr>
  175. </thead>
  176. <tbody>
  177. <tr>
  178. <td><span class="xref">System.Boolean</span></td>
  179. <td><code>true</code> if has focus; otherwise, <code>false</code>.</td>
  180. </tr>
  181. </tbody>
  182. </table>
  183. <a id="Terminal_Gui_Responder_Visible_" data-uid="Terminal.Gui.Responder.Visible*"></a>
  184. <h4 id="Terminal_Gui_Responder_Visible" data-uid="Terminal.Gui.Responder.Visible">Visible</h4>
  185. <div class="markdown level1 summary">
  186. 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.
  187. </div>
  188. <div class="markdown level1 conceptual"></div>
  189. <h5 class="decalaration">Declaration</h5>
  190. <div class="codewrapper">
  191. <pre><code class="lang-csharp hljs">public virtual bool Visible { get; set; }</code></pre>
  192. </div>
  193. <h5 class="propertyValue">Property Value</h5>
  194. <table class="table table-bordered table-striped table-condensed">
  195. <thead>
  196. <tr>
  197. <th>Type</th>
  198. <th>Description</th>
  199. </tr>
  200. </thead>
  201. <tbody>
  202. <tr>
  203. <td><span class="xref">System.Boolean</span></td>
  204. <td></td>
  205. </tr>
  206. </tbody>
  207. </table>
  208. <h3 id="methods">Methods
  209. </h3>
  210. <a id="Terminal_Gui_Responder_Dispose_" data-uid="Terminal.Gui.Responder.Dispose*"></a>
  211. <h4 id="Terminal_Gui_Responder_Dispose" data-uid="Terminal.Gui.Responder.Dispose">Dispose()</h4>
  212. <div class="markdown level1 summary">
  213. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resource.
  214. </div>
  215. <div class="markdown level1 conceptual"></div>
  216. <h5 class="decalaration">Declaration</h5>
  217. <div class="codewrapper">
  218. <pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
  219. </div>
  220. <a id="Terminal_Gui_Responder_Dispose_" data-uid="Terminal.Gui.Responder.Dispose*"></a>
  221. <h4 id="Terminal_Gui_Responder_Dispose_System_Boolean_" data-uid="Terminal.Gui.Responder.Dispose(System.Boolean)">Dispose(Boolean)</h4>
  222. <div class="markdown level1 summary">
  223. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  224. </div>
  225. <div class="markdown level1 conceptual"></div>
  226. <h5 class="decalaration">Declaration</h5>
  227. <div class="codewrapper">
  228. <pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
  229. </div>
  230. <h5 class="parameters">Parameters</h5>
  231. <table class="table table-bordered table-striped table-condensed">
  232. <thead>
  233. <tr>
  234. <th>Type</th>
  235. <th>Name</th>
  236. <th>Description</th>
  237. </tr>
  238. </thead>
  239. <tbody>
  240. <tr>
  241. <td><span class="xref">System.Boolean</span></td>
  242. <td><span class="parametername">disposing</span></td>
  243. <td></td>
  244. </tr>
  245. </tbody>
  246. </table>
  247. <a id="Terminal_Gui_Responder_MouseEvent_" data-uid="Terminal.Gui.Responder.MouseEvent*"></a>
  248. <h4 id="Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Responder.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  249. <div class="markdown level1 summary">
  250. Method invoked when a mouse event is generated
  251. </div>
  252. <div class="markdown level1 conceptual"></div>
  253. <h5 class="decalaration">Declaration</h5>
  254. <div class="codewrapper">
  255. <pre><code class="lang-csharp hljs">public virtual bool MouseEvent(MouseEvent mouseEvent)</code></pre>
  256. </div>
  257. <h5 class="parameters">Parameters</h5>
  258. <table class="table table-bordered table-striped table-condensed">
  259. <thead>
  260. <tr>
  261. <th>Type</th>
  262. <th>Name</th>
  263. <th>Description</th>
  264. </tr>
  265. </thead>
  266. <tbody>
  267. <tr>
  268. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  269. <td><span class="parametername">mouseEvent</span></td>
  270. <td>Contains the details about the mouse event.</td>
  271. </tr>
  272. </tbody>
  273. </table>
  274. <h5 class="returns">Returns</h5>
  275. <table class="table table-bordered table-striped table-condensed">
  276. <thead>
  277. <tr>
  278. <th>Type</th>
  279. <th>Description</th>
  280. </tr>
  281. </thead>
  282. <tbody>
  283. <tr>
  284. <td><span class="xref">System.Boolean</span></td>
  285. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  286. </tr>
  287. </tbody>
  288. </table>
  289. <a id="Terminal_Gui_Responder_OnCanFocusChanged_" data-uid="Terminal.Gui.Responder.OnCanFocusChanged*"></a>
  290. <h4 id="Terminal_Gui_Responder_OnCanFocusChanged" data-uid="Terminal.Gui.Responder.OnCanFocusChanged">OnCanFocusChanged()</h4>
  291. <div class="markdown level1 summary">
  292. Method invoked when the <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">CanFocus</a> property from a view is changed.
  293. </div>
  294. <div class="markdown level1 conceptual"></div>
  295. <h5 class="decalaration">Declaration</h5>
  296. <div class="codewrapper">
  297. <pre><code class="lang-csharp hljs">public virtual void OnCanFocusChanged()</code></pre>
  298. </div>
  299. <a id="Terminal_Gui_Responder_OnEnabledChanged_" data-uid="Terminal.Gui.Responder.OnEnabledChanged*"></a>
  300. <h4 id="Terminal_Gui_Responder_OnEnabledChanged" data-uid="Terminal.Gui.Responder.OnEnabledChanged">OnEnabledChanged()</h4>
  301. <div class="markdown level1 summary">
  302. Method invoked when the <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Enabled">Enabled</a> property from a view is changed.
  303. </div>
  304. <div class="markdown level1 conceptual"></div>
  305. <h5 class="decalaration">Declaration</h5>
  306. <div class="codewrapper">
  307. <pre><code class="lang-csharp hljs">public virtual void OnEnabledChanged()</code></pre>
  308. </div>
  309. <a id="Terminal_Gui_Responder_OnEnter_" data-uid="Terminal.Gui.Responder.OnEnter*"></a>
  310. <h4 id="Terminal_Gui_Responder_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.Responder.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  311. <div class="markdown level1 summary">
  312. Method invoked when a view gets focus.
  313. </div>
  314. <div class="markdown level1 conceptual"></div>
  315. <h5 class="decalaration">Declaration</h5>
  316. <div class="codewrapper">
  317. <pre><code class="lang-csharp hljs">public virtual bool OnEnter(View view)</code></pre>
  318. </div>
  319. <h5 class="parameters">Parameters</h5>
  320. <table class="table table-bordered table-striped table-condensed">
  321. <thead>
  322. <tr>
  323. <th>Type</th>
  324. <th>Name</th>
  325. <th>Description</th>
  326. </tr>
  327. </thead>
  328. <tbody>
  329. <tr>
  330. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  331. <td><span class="parametername">view</span></td>
  332. <td>The view that is losing focus.</td>
  333. </tr>
  334. </tbody>
  335. </table>
  336. <h5 class="returns">Returns</h5>
  337. <table class="table table-bordered table-striped table-condensed">
  338. <thead>
  339. <tr>
  340. <th>Type</th>
  341. <th>Description</th>
  342. </tr>
  343. </thead>
  344. <tbody>
  345. <tr>
  346. <td><span class="xref">System.Boolean</span></td>
  347. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  348. </tr>
  349. </tbody>
  350. </table>
  351. <a id="Terminal_Gui_Responder_OnKeyDown_" data-uid="Terminal.Gui.Responder.OnKeyDown*"></a>
  352. <h4 id="Terminal_Gui_Responder_OnKeyDown_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Responder.OnKeyDown(Terminal.Gui.KeyEvent)">OnKeyDown(KeyEvent)</h4>
  353. <div class="markdown level1 summary">
  354. Method invoked when a key is pressed.
  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 virtual bool OnKeyDown(KeyEvent keyEvent)</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><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  373. <td><span class="parametername">keyEvent</span></td>
  374. <td>Contains the details about the key that produced the event.</td>
  375. </tr>
  376. </tbody>
  377. </table>
  378. <h5 class="returns">Returns</h5>
  379. <table class="table table-bordered table-striped table-condensed">
  380. <thead>
  381. <tr>
  382. <th>Type</th>
  383. <th>Description</th>
  384. </tr>
  385. </thead>
  386. <tbody>
  387. <tr>
  388. <td><span class="xref">System.Boolean</span></td>
  389. <td>true if the event was handled</td>
  390. </tr>
  391. </tbody>
  392. </table>
  393. <a id="Terminal_Gui_Responder_OnKeyUp_" data-uid="Terminal.Gui.Responder.OnKeyUp*"></a>
  394. <h4 id="Terminal_Gui_Responder_OnKeyUp_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Responder.OnKeyUp(Terminal.Gui.KeyEvent)">OnKeyUp(KeyEvent)</h4>
  395. <div class="markdown level1 summary">
  396. Method invoked when a key is released.
  397. </div>
  398. <div class="markdown level1 conceptual"></div>
  399. <h5 class="decalaration">Declaration</h5>
  400. <div class="codewrapper">
  401. <pre><code class="lang-csharp hljs">public virtual bool OnKeyUp(KeyEvent keyEvent)</code></pre>
  402. </div>
  403. <h5 class="parameters">Parameters</h5>
  404. <table class="table table-bordered table-striped table-condensed">
  405. <thead>
  406. <tr>
  407. <th>Type</th>
  408. <th>Name</th>
  409. <th>Description</th>
  410. </tr>
  411. </thead>
  412. <tbody>
  413. <tr>
  414. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  415. <td><span class="parametername">keyEvent</span></td>
  416. <td>Contains the details about the key that produced the event.</td>
  417. </tr>
  418. </tbody>
  419. </table>
  420. <h5 class="returns">Returns</h5>
  421. <table class="table table-bordered table-striped table-condensed">
  422. <thead>
  423. <tr>
  424. <th>Type</th>
  425. <th>Description</th>
  426. </tr>
  427. </thead>
  428. <tbody>
  429. <tr>
  430. <td><span class="xref">System.Boolean</span></td>
  431. <td>true if the event was handled</td>
  432. </tr>
  433. </tbody>
  434. </table>
  435. <a id="Terminal_Gui_Responder_OnLeave_" data-uid="Terminal.Gui.Responder.OnLeave*"></a>
  436. <h4 id="Terminal_Gui_Responder_OnLeave_Terminal_Gui_View_" data-uid="Terminal.Gui.Responder.OnLeave(Terminal.Gui.View)">OnLeave(View)</h4>
  437. <div class="markdown level1 summary">
  438. Method invoked when a view loses focus.
  439. </div>
  440. <div class="markdown level1 conceptual"></div>
  441. <h5 class="decalaration">Declaration</h5>
  442. <div class="codewrapper">
  443. <pre><code class="lang-csharp hljs">public virtual bool OnLeave(View view)</code></pre>
  444. </div>
  445. <h5 class="parameters">Parameters</h5>
  446. <table class="table table-bordered table-striped table-condensed">
  447. <thead>
  448. <tr>
  449. <th>Type</th>
  450. <th>Name</th>
  451. <th>Description</th>
  452. </tr>
  453. </thead>
  454. <tbody>
  455. <tr>
  456. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  457. <td><span class="parametername">view</span></td>
  458. <td>The view that is getting focus.</td>
  459. </tr>
  460. </tbody>
  461. </table>
  462. <h5 class="returns">Returns</h5>
  463. <table class="table table-bordered table-striped table-condensed">
  464. <thead>
  465. <tr>
  466. <th>Type</th>
  467. <th>Description</th>
  468. </tr>
  469. </thead>
  470. <tbody>
  471. <tr>
  472. <td><span class="xref">System.Boolean</span></td>
  473. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  474. </tr>
  475. </tbody>
  476. </table>
  477. <a id="Terminal_Gui_Responder_OnMouseEnter_" data-uid="Terminal.Gui.Responder.OnMouseEnter*"></a>
  478. <h4 id="Terminal_Gui_Responder_OnMouseEnter_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Responder.OnMouseEnter(Terminal.Gui.MouseEvent)">OnMouseEnter(MouseEvent)</h4>
  479. <div class="markdown level1 summary">
  480. Method invoked when a mouse event is generated for the first time.
  481. </div>
  482. <div class="markdown level1 conceptual"></div>
  483. <h5 class="decalaration">Declaration</h5>
  484. <div class="codewrapper">
  485. <pre><code class="lang-csharp hljs">public virtual bool OnMouseEnter(MouseEvent mouseEvent)</code></pre>
  486. </div>
  487. <h5 class="parameters">Parameters</h5>
  488. <table class="table table-bordered table-striped table-condensed">
  489. <thead>
  490. <tr>
  491. <th>Type</th>
  492. <th>Name</th>
  493. <th>Description</th>
  494. </tr>
  495. </thead>
  496. <tbody>
  497. <tr>
  498. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  499. <td><span class="parametername">mouseEvent</span></td>
  500. <td></td>
  501. </tr>
  502. </tbody>
  503. </table>
  504. <h5 class="returns">Returns</h5>
  505. <table class="table table-bordered table-striped table-condensed">
  506. <thead>
  507. <tr>
  508. <th>Type</th>
  509. <th>Description</th>
  510. </tr>
  511. </thead>
  512. <tbody>
  513. <tr>
  514. <td><span class="xref">System.Boolean</span></td>
  515. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  516. </tr>
  517. </tbody>
  518. </table>
  519. <a id="Terminal_Gui_Responder_OnMouseLeave_" data-uid="Terminal.Gui.Responder.OnMouseLeave*"></a>
  520. <h4 id="Terminal_Gui_Responder_OnMouseLeave_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Responder.OnMouseLeave(Terminal.Gui.MouseEvent)">OnMouseLeave(MouseEvent)</h4>
  521. <div class="markdown level1 summary">
  522. Method invoked when a mouse event is generated for the last time.
  523. </div>
  524. <div class="markdown level1 conceptual"></div>
  525. <h5 class="decalaration">Declaration</h5>
  526. <div class="codewrapper">
  527. <pre><code class="lang-csharp hljs">public virtual bool OnMouseLeave(MouseEvent mouseEvent)</code></pre>
  528. </div>
  529. <h5 class="parameters">Parameters</h5>
  530. <table class="table table-bordered table-striped table-condensed">
  531. <thead>
  532. <tr>
  533. <th>Type</th>
  534. <th>Name</th>
  535. <th>Description</th>
  536. </tr>
  537. </thead>
  538. <tbody>
  539. <tr>
  540. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  541. <td><span class="parametername">mouseEvent</span></td>
  542. <td></td>
  543. </tr>
  544. </tbody>
  545. </table>
  546. <h5 class="returns">Returns</h5>
  547. <table class="table table-bordered table-striped table-condensed">
  548. <thead>
  549. <tr>
  550. <th>Type</th>
  551. <th>Description</th>
  552. </tr>
  553. </thead>
  554. <tbody>
  555. <tr>
  556. <td><span class="xref">System.Boolean</span></td>
  557. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  558. </tr>
  559. </tbody>
  560. </table>
  561. <a id="Terminal_Gui_Responder_OnVisibleChanged_" data-uid="Terminal.Gui.Responder.OnVisibleChanged*"></a>
  562. <h4 id="Terminal_Gui_Responder_OnVisibleChanged" data-uid="Terminal.Gui.Responder.OnVisibleChanged">OnVisibleChanged()</h4>
  563. <div class="markdown level1 summary">
  564. Method invoked when the <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Visible">Visible</a> property from a view is changed.
  565. </div>
  566. <div class="markdown level1 conceptual"></div>
  567. <h5 class="decalaration">Declaration</h5>
  568. <div class="codewrapper">
  569. <pre><code class="lang-csharp hljs">public virtual void OnVisibleChanged()</code></pre>
  570. </div>
  571. <a id="Terminal_Gui_Responder_ProcessColdKey_" data-uid="Terminal.Gui.Responder.ProcessColdKey*"></a>
  572. <h4 id="Terminal_Gui_Responder_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Responder.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
  573. <div class="markdown level1 summary">
  574. This method can be overwritten by views that
  575. want to provide accelerator functionality
  576. (Alt-key for example), but without
  577. interefering with normal ProcessKey behavior.
  578. </div>
  579. <div class="markdown level1 conceptual"></div>
  580. <h5 class="decalaration">Declaration</h5>
  581. <div class="codewrapper">
  582. <pre><code class="lang-csharp hljs">public virtual bool ProcessColdKey(KeyEvent keyEvent)</code></pre>
  583. </div>
  584. <h5 class="parameters">Parameters</h5>
  585. <table class="table table-bordered table-striped table-condensed">
  586. <thead>
  587. <tr>
  588. <th>Type</th>
  589. <th>Name</th>
  590. <th>Description</th>
  591. </tr>
  592. </thead>
  593. <tbody>
  594. <tr>
  595. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  596. <td><span class="parametername">keyEvent</span></td>
  597. <td>Contains the details about the key that produced the event.</td>
  598. </tr>
  599. </tbody>
  600. </table>
  601. <h5 class="returns">Returns</h5>
  602. <table class="table table-bordered table-striped table-condensed">
  603. <thead>
  604. <tr>
  605. <th>Type</th>
  606. <th>Description</th>
  607. </tr>
  608. </thead>
  609. <tbody>
  610. <tr>
  611. <td><span class="xref">System.Boolean</span></td>
  612. <td></td>
  613. </tr>
  614. </tbody>
  615. </table>
  616. <a id="Terminal_Gui_Responder_ProcessHotKey_" data-uid="Terminal.Gui.Responder.ProcessHotKey*"></a>
  617. <h4 id="Terminal_Gui_Responder_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Responder.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  618. <div class="markdown level1 summary">
  619. This method can be overwritten by view that
  620. want to provide accelerator functionality
  621. (Alt-key for example).
  622. </div>
  623. <div class="markdown level1 conceptual"></div>
  624. <h5 class="decalaration">Declaration</h5>
  625. <div class="codewrapper">
  626. <pre><code class="lang-csharp hljs">public virtual bool ProcessHotKey(KeyEvent kb)</code></pre>
  627. </div>
  628. <h5 class="parameters">Parameters</h5>
  629. <table class="table table-bordered table-striped table-condensed">
  630. <thead>
  631. <tr>
  632. <th>Type</th>
  633. <th>Name</th>
  634. <th>Description</th>
  635. </tr>
  636. </thead>
  637. <tbody>
  638. <tr>
  639. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  640. <td><span class="parametername">kb</span></td>
  641. <td></td>
  642. </tr>
  643. </tbody>
  644. </table>
  645. <h5 class="returns">Returns</h5>
  646. <table class="table table-bordered table-striped table-condensed">
  647. <thead>
  648. <tr>
  649. <th>Type</th>
  650. <th>Description</th>
  651. </tr>
  652. </thead>
  653. <tbody>
  654. <tr>
  655. <td><span class="xref">System.Boolean</span></td>
  656. <td></td>
  657. </tr>
  658. </tbody>
  659. </table>
  660. <a id="Terminal_Gui_Responder_ProcessKey_" data-uid="Terminal.Gui.Responder.ProcessKey*"></a>
  661. <h4 id="Terminal_Gui_Responder_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Responder.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  662. <div class="markdown level1 summary">
  663. If the view is focused, gives the view a
  664. chance to process the keystroke.
  665. </div>
  666. <div class="markdown level1 conceptual"></div>
  667. <h5 class="decalaration">Declaration</h5>
  668. <div class="codewrapper">
  669. <pre><code class="lang-csharp hljs">public virtual bool ProcessKey(KeyEvent keyEvent)</code></pre>
  670. </div>
  671. <h5 class="parameters">Parameters</h5>
  672. <table class="table table-bordered table-striped table-condensed">
  673. <thead>
  674. <tr>
  675. <th>Type</th>
  676. <th>Name</th>
  677. <th>Description</th>
  678. </tr>
  679. </thead>
  680. <tbody>
  681. <tr>
  682. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  683. <td><span class="parametername">keyEvent</span></td>
  684. <td>Contains the details about the key that produced the event.</td>
  685. </tr>
  686. </tbody>
  687. </table>
  688. <h5 class="returns">Returns</h5>
  689. <table class="table table-bordered table-striped table-condensed">
  690. <thead>
  691. <tr>
  692. <th>Type</th>
  693. <th>Description</th>
  694. </tr>
  695. </thead>
  696. <tbody>
  697. <tr>
  698. <td><span class="xref">System.Boolean</span></td>
  699. <td></td>
  700. </tr>
  701. </tbody>
  702. </table>
  703. <h3 id="implements">Implements</h3>
  704. <div>
  705. <span class="xref">System.IDisposable</span>
  706. </div>
  707. </article>
  708. </div>
  709. <div class="hidden-sm col-md-2" role="complementary">
  710. <div class="sideaffix">
  711. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  712. <h5>In This Article</h5>
  713. <div></div>
  714. </nav>
  715. </div>
  716. </div>
  717. </div>
  718. </div>
  719. <footer>
  720. <div class="grad-bottom"></div>
  721. <div class="footer">
  722. <div class="container">
  723. <span class="pull-right">
  724. <a href="#top">Back to top</a>
  725. </span>
  726. <span>Generated by <strong>DocFX</strong></span>
  727. </div>
  728. </div>
  729. </footer>
  730. </div>
  731. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  732. <script type="text/javascript" src="../../styles/docfx.js"></script>
  733. <script type="text/javascript" src="../../styles/main.js"></script>
  734. </body>
  735. </html>