Terminal.Gui.MouseEvent.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433
  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 MouseEvent
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class MouseEvent
  11. ">
  12. <meta name="generator" content="docfx 2.59.4.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.MouseEvent">
  74. <h1 id="Terminal_Gui_MouseEvent" data-uid="Terminal.Gui.MouseEvent" class="text-break">Class MouseEvent
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Low-level construct that conveys the details of mouse events, such
  78. as coordinates and button state, from ConsoleDrivers up to <a class="xref" href="Terminal.Gui.Application.html">Application</a> and
  79. Views.
  80. </div>
  81. <div class="markdown level0 conceptual"></div>
  82. <div class="inheritance">
  83. <h5>Inheritance</h5>
  84. <div class="level0"><span class="xref">System.Object</span></div>
  85. <div class="level1"><span class="xref">MouseEvent</span></div>
  86. </div>
  87. <h5 id="Terminal_Gui_MouseEvent_remarks"><strong>Remarks</strong></h5>
  88. <div class="markdown level0 remarks">The <a class="xref" href="Terminal.Gui.Application.html">Application</a> class includes the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RootMouseEvent">RootMouseEvent</a>
  89. Action which takes a MouseEvent argument.</div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <span class="xref">System.Object.Equals(System.Object)</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.GetHashCode()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.GetType()</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Object.MemberwiseClone()</span>
  106. </div>
  107. <div>
  108. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  109. </div>
  110. </div>
  111. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  112. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  113. <h5 id="Terminal_Gui_MouseEvent_syntax">Syntax</h5>
  114. <div class="codewrapper">
  115. <pre><code class="lang-csharp hljs">public class MouseEvent</code></pre>
  116. </div>
  117. <h3 id="properties">Properties
  118. </h3>
  119. <span class="small pull-right mobile-hide">
  120. <span class="divider">|</span>
  121. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MouseEvent_Flags.md&amp;value=---%0Auid%3A%20Terminal.Gui.MouseEvent.Flags%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  122. </span>
  123. <span class="small pull-right mobile-hide">
  124. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Event.cs/#L790">View Source</a>
  125. </span>
  126. <a id="Terminal_Gui_MouseEvent_Flags_" data-uid="Terminal.Gui.MouseEvent.Flags*"></a>
  127. <h4 id="Terminal_Gui_MouseEvent_Flags" data-uid="Terminal.Gui.MouseEvent.Flags">Flags</h4>
  128. <div class="markdown level1 summary">
  129. Flags indicating the kind of mouse event that is being posted.
  130. </div>
  131. <div class="markdown level1 conceptual"></div>
  132. <h5 class="decalaration">Declaration</h5>
  133. <div class="codewrapper">
  134. <pre><code class="lang-csharp hljs">public MouseFlags Flags { get; set; }</code></pre>
  135. </div>
  136. <h5 class="propertyValue">Property Value</h5>
  137. <table class="table table-bordered table-striped table-condensed">
  138. <thead>
  139. <tr>
  140. <th>Type</th>
  141. <th>Description</th>
  142. </tr>
  143. </thead>
  144. <tbody>
  145. <tr>
  146. <td><a class="xref" href="Terminal.Gui.MouseFlags.html">MouseFlags</a></td>
  147. <td></td>
  148. </tr>
  149. </tbody>
  150. </table>
  151. <span class="small pull-right mobile-hide">
  152. <span class="divider">|</span>
  153. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MouseEvent_Handled.md&amp;value=---%0Auid%3A%20Terminal.Gui.MouseEvent.Handled%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  154. </span>
  155. <span class="small pull-right mobile-hide">
  156. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Event.cs/#L811">View Source</a>
  157. </span>
  158. <a id="Terminal_Gui_MouseEvent_Handled_" data-uid="Terminal.Gui.MouseEvent.Handled*"></a>
  159. <h4 id="Terminal_Gui_MouseEvent_Handled" data-uid="Terminal.Gui.MouseEvent.Handled">Handled</h4>
  160. <div class="markdown level1 summary">
  161. Indicates if the current mouse event has already been processed and the driver should stop notifying any other event subscriber.
  162. Its important to set this value to true specially when updating any View&apos;s layout from inside the subscriber method.
  163. </div>
  164. <div class="markdown level1 conceptual"></div>
  165. <h5 class="decalaration">Declaration</h5>
  166. <div class="codewrapper">
  167. <pre><code class="lang-csharp hljs">public bool Handled { get; set; }</code></pre>
  168. </div>
  169. <h5 class="propertyValue">Property Value</h5>
  170. <table class="table table-bordered table-striped table-condensed">
  171. <thead>
  172. <tr>
  173. <th>Type</th>
  174. <th>Description</th>
  175. </tr>
  176. </thead>
  177. <tbody>
  178. <tr>
  179. <td><span class="xref">System.Boolean</span></td>
  180. <td></td>
  181. </tr>
  182. </tbody>
  183. </table>
  184. <span class="small pull-right mobile-hide">
  185. <span class="divider">|</span>
  186. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MouseEvent_OfX.md&amp;value=---%0Auid%3A%20Terminal.Gui.MouseEvent.OfX%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  187. </span>
  188. <span class="small pull-right mobile-hide">
  189. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Event.cs/#L795">View Source</a>
  190. </span>
  191. <a id="Terminal_Gui_MouseEvent_OfX_" data-uid="Terminal.Gui.MouseEvent.OfX*"></a>
  192. <h4 id="Terminal_Gui_MouseEvent_OfX" data-uid="Terminal.Gui.MouseEvent.OfX">OfX</h4>
  193. <div class="markdown level1 summary">
  194. The offset X (column) location for the mouse event.
  195. </div>
  196. <div class="markdown level1 conceptual"></div>
  197. <h5 class="decalaration">Declaration</h5>
  198. <div class="codewrapper">
  199. <pre><code class="lang-csharp hljs">public int OfX { get; set; }</code></pre>
  200. </div>
  201. <h5 class="propertyValue">Property Value</h5>
  202. <table class="table table-bordered table-striped table-condensed">
  203. <thead>
  204. <tr>
  205. <th>Type</th>
  206. <th>Description</th>
  207. </tr>
  208. </thead>
  209. <tbody>
  210. <tr>
  211. <td><span class="xref">System.Int32</span></td>
  212. <td></td>
  213. </tr>
  214. </tbody>
  215. </table>
  216. <span class="small pull-right mobile-hide">
  217. <span class="divider">|</span>
  218. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MouseEvent_OfY.md&amp;value=---%0Auid%3A%20Terminal.Gui.MouseEvent.OfY%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  219. </span>
  220. <span class="small pull-right mobile-hide">
  221. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Event.cs/#L800">View Source</a>
  222. </span>
  223. <a id="Terminal_Gui_MouseEvent_OfY_" data-uid="Terminal.Gui.MouseEvent.OfY*"></a>
  224. <h4 id="Terminal_Gui_MouseEvent_OfY" data-uid="Terminal.Gui.MouseEvent.OfY">OfY</h4>
  225. <div class="markdown level1 summary">
  226. The offset Y (column) location for the mouse event.
  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 int OfY { get; set; }</code></pre>
  232. </div>
  233. <h5 class="propertyValue">Property Value</h5>
  234. <table class="table table-bordered table-striped table-condensed">
  235. <thead>
  236. <tr>
  237. <th>Type</th>
  238. <th>Description</th>
  239. </tr>
  240. </thead>
  241. <tbody>
  242. <tr>
  243. <td><span class="xref">System.Int32</span></td>
  244. <td></td>
  245. </tr>
  246. </tbody>
  247. </table>
  248. <span class="small pull-right mobile-hide">
  249. <span class="divider">|</span>
  250. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MouseEvent_View.md&amp;value=---%0Auid%3A%20Terminal.Gui.MouseEvent.View%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  251. </span>
  252. <span class="small pull-right mobile-hide">
  253. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Event.cs/#L805">View Source</a>
  254. </span>
  255. <a id="Terminal_Gui_MouseEvent_View_" data-uid="Terminal.Gui.MouseEvent.View*"></a>
  256. <h4 id="Terminal_Gui_MouseEvent_View" data-uid="Terminal.Gui.MouseEvent.View">View</h4>
  257. <div class="markdown level1 summary">
  258. The current view at the location for the mouse event.
  259. </div>
  260. <div class="markdown level1 conceptual"></div>
  261. <h5 class="decalaration">Declaration</h5>
  262. <div class="codewrapper">
  263. <pre><code class="lang-csharp hljs">public View View { get; set; }</code></pre>
  264. </div>
  265. <h5 class="propertyValue">Property Value</h5>
  266. <table class="table table-bordered table-striped table-condensed">
  267. <thead>
  268. <tr>
  269. <th>Type</th>
  270. <th>Description</th>
  271. </tr>
  272. </thead>
  273. <tbody>
  274. <tr>
  275. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  276. <td></td>
  277. </tr>
  278. </tbody>
  279. </table>
  280. <span class="small pull-right mobile-hide">
  281. <span class="divider">|</span>
  282. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MouseEvent_X.md&amp;value=---%0Auid%3A%20Terminal.Gui.MouseEvent.X%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  283. </span>
  284. <span class="small pull-right mobile-hide">
  285. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Event.cs/#L780">View Source</a>
  286. </span>
  287. <a id="Terminal_Gui_MouseEvent_X_" data-uid="Terminal.Gui.MouseEvent.X*"></a>
  288. <h4 id="Terminal_Gui_MouseEvent_X" data-uid="Terminal.Gui.MouseEvent.X">X</h4>
  289. <div class="markdown level1 summary">
  290. The X (column) location for the mouse event.
  291. </div>
  292. <div class="markdown level1 conceptual"></div>
  293. <h5 class="decalaration">Declaration</h5>
  294. <div class="codewrapper">
  295. <pre><code class="lang-csharp hljs">public int X { get; set; }</code></pre>
  296. </div>
  297. <h5 class="propertyValue">Property Value</h5>
  298. <table class="table table-bordered table-striped table-condensed">
  299. <thead>
  300. <tr>
  301. <th>Type</th>
  302. <th>Description</th>
  303. </tr>
  304. </thead>
  305. <tbody>
  306. <tr>
  307. <td><span class="xref">System.Int32</span></td>
  308. <td></td>
  309. </tr>
  310. </tbody>
  311. </table>
  312. <span class="small pull-right mobile-hide">
  313. <span class="divider">|</span>
  314. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MouseEvent_Y.md&amp;value=---%0Auid%3A%20Terminal.Gui.MouseEvent.Y%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  315. </span>
  316. <span class="small pull-right mobile-hide">
  317. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Event.cs/#L785">View Source</a>
  318. </span>
  319. <a id="Terminal_Gui_MouseEvent_Y_" data-uid="Terminal.Gui.MouseEvent.Y*"></a>
  320. <h4 id="Terminal_Gui_MouseEvent_Y" data-uid="Terminal.Gui.MouseEvent.Y">Y</h4>
  321. <div class="markdown level1 summary">
  322. The Y (column) location for the mouse event.
  323. </div>
  324. <div class="markdown level1 conceptual"></div>
  325. <h5 class="decalaration">Declaration</h5>
  326. <div class="codewrapper">
  327. <pre><code class="lang-csharp hljs">public int Y { get; set; }</code></pre>
  328. </div>
  329. <h5 class="propertyValue">Property Value</h5>
  330. <table class="table table-bordered table-striped table-condensed">
  331. <thead>
  332. <tr>
  333. <th>Type</th>
  334. <th>Description</th>
  335. </tr>
  336. </thead>
  337. <tbody>
  338. <tr>
  339. <td><span class="xref">System.Int32</span></td>
  340. <td></td>
  341. </tr>
  342. </tbody>
  343. </table>
  344. <h3 id="methods">Methods
  345. </h3>
  346. <span class="small pull-right mobile-hide">
  347. <span class="divider">|</span>
  348. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MouseEvent_ToString.md&amp;value=---%0Auid%3A%20Terminal.Gui.MouseEvent.ToString%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  349. </span>
  350. <span class="small pull-right mobile-hide">
  351. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Event.cs/#L817">View Source</a>
  352. </span>
  353. <a id="Terminal_Gui_MouseEvent_ToString_" data-uid="Terminal.Gui.MouseEvent.ToString*"></a>
  354. <h4 id="Terminal_Gui_MouseEvent_ToString" data-uid="Terminal.Gui.MouseEvent.ToString">ToString()</h4>
  355. <div class="markdown level1 summary">
  356. Returns a <span class="xref">System.String</span> that represents the current <a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>.
  357. </div>
  358. <div class="markdown level1 conceptual"></div>
  359. <h5 class="decalaration">Declaration</h5>
  360. <div class="codewrapper">
  361. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  362. </div>
  363. <h5 class="returns">Returns</h5>
  364. <table class="table table-bordered table-striped table-condensed">
  365. <thead>
  366. <tr>
  367. <th>Type</th>
  368. <th>Description</th>
  369. </tr>
  370. </thead>
  371. <tbody>
  372. <tr>
  373. <td><span class="xref">System.String</span></td>
  374. <td>A <span class="xref">System.String</span> that represents the current <a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>.</td>
  375. </tr>
  376. </tbody>
  377. </table>
  378. <h5 class="overrides">Overrides</h5>
  379. <div><span class="xref">System.Object.ToString()</span></div>
  380. </article>
  381. </div>
  382. <div class="hidden-sm col-md-2" role="complementary">
  383. <div class="sideaffix">
  384. <div class="contribution">
  385. <ul class="nav">
  386. <li>
  387. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MouseEvent.md&amp;value=---%0Auid%3A%20Terminal.Gui.MouseEvent%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
  388. </li>
  389. <li>
  390. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Event.cs/#L776" class="contribution-link">View Source</a>
  391. </li>
  392. </ul>
  393. </div>
  394. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  395. <h5>In This Article</h5>
  396. <div></div>
  397. </nav>
  398. </div>
  399. </div>
  400. </div>
  401. </div>
  402. <footer>
  403. <div class="grad-bottom"></div>
  404. <div class="footer">
  405. <div class="container">
  406. <span class="pull-right">
  407. <a href="#top">Back to top</a>
  408. </span>
  409. <span>Generated by <strong>DocFX</strong></span>
  410. </div>
  411. </div>
  412. </footer>
  413. </div>
  414. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  415. <script type="text/javascript" src="../../styles/docfx.js"></script>
  416. <script type="text/javascript" src="../../styles/main.js"></script>
  417. </body>
  418. </html>