DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

216 lines
12KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: Widget::MouseEvent Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">DISTRHO Plugin Framework
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.9.1 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. <div id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><a class="el" href="classWidget.html">Widget</a></li><li class="navelem"><a class="el" href="structWidget_1_1MouseEvent.html">MouseEvent</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="summary">
  67. <a href="#pub-methods">Public Member Functions</a> &#124;
  68. <a href="#pub-attribs">Public Attributes</a> &#124;
  69. <a href="structWidget_1_1MouseEvent-members.html">List of all members</a> </div>
  70. <div class="headertitle">
  71. <div class="title">Widget::MouseEvent Struct Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p><code>#include &lt;<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a>&gt;</code></p>
  75. <div class="dynheader">
  76. Inheritance diagram for Widget::MouseEvent:</div>
  77. <div class="dyncontent">
  78. <div class="center">
  79. <img src="structWidget_1_1MouseEvent.png" usemap="#Widget::MouseEvent_map" alt=""/>
  80. <map id="Widget::MouseEvent_map" name="Widget::MouseEvent_map">
  81. <area href="structWidget_1_1BaseEvent.html" alt="Widget::BaseEvent" shape="rect" coords="0,0,126,24"/>
  82. </map>
  83. </div></div>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  86. Public Member Functions</h2></td></tr>
  87. <tr class="memitem:aa37fee8a593c62c53e4ca5c67ad9278f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1MouseEvent.html#aa37fee8a593c62c53e4ca5c67ad9278f">MouseEvent</a> () noexcept</td></tr>
  88. <tr class="separator:aa37fee8a593c62c53e4ca5c67ad9278f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="inherit_header pub_methods_structWidget_1_1BaseEvent"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structWidget_1_1BaseEvent')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structWidget_1_1BaseEvent.html">Widget::BaseEvent</a></td></tr>
  90. <tr class="memitem:a18c1114caca474cadefd9a13e2d9c693 inherit pub_methods_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1BaseEvent.html#a18c1114caca474cadefd9a13e2d9c693">BaseEvent</a> () noexcept</td></tr>
  91. <tr class="separator:a18c1114caca474cadefd9a13e2d9c693 inherit pub_methods_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a58da172316b49f6d79b879b74ce5792a inherit pub_methods_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1BaseEvent.html#a58da172316b49f6d79b879b74ce5792a">~BaseEvent</a> () noexcept</td></tr>
  93. <tr class="separator:a58da172316b49f6d79b879b74ce5792a inherit pub_methods_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. </table><table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  96. Public Attributes</h2></td></tr>
  97. <tr class="memitem:ab6471d00c229719e1dd821f78ed4bdef"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1MouseEvent.html#ab6471d00c229719e1dd821f78ed4bdef">button</a></td></tr>
  98. <tr class="separator:ab6471d00c229719e1dd821f78ed4bdef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ab65f0309f44fab0bf329b4ade9b53fcb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1MouseEvent.html#ab65f0309f44fab0bf329b4ade9b53fcb">press</a></td></tr>
  100. <tr class="separator:ab65f0309f44fab0bf329b4ade9b53fcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a11c6d85adf87424c392d866579149770"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPoint.html">Point</a>&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1MouseEvent.html#a11c6d85adf87424c392d866579149770">pos</a></td></tr>
  102. <tr class="separator:a11c6d85adf87424c392d866579149770"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ae80ebc0ab59ed2e06a63743d8c963651"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPoint.html">Point</a>&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1MouseEvent.html#ae80ebc0ab59ed2e06a63743d8c963651">absolutePos</a></td></tr>
  104. <tr class="separator:ae80ebc0ab59ed2e06a63743d8c963651"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="inherit_header pub_attribs_structWidget_1_1BaseEvent"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structWidget_1_1BaseEvent')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structWidget_1_1BaseEvent.html">Widget::BaseEvent</a></td></tr>
  106. <tr class="memitem:a227a57d145561c7d07596a702f20d448 inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1BaseEvent.html#a227a57d145561c7d07596a702f20d448">mod</a></td></tr>
  107. <tr class="separator:a227a57d145561c7d07596a702f20d448 inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ae134a6bdbd16a59218b5b4f0ee3a154c inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1BaseEvent.html#ae134a6bdbd16a59218b5b4f0ee3a154c">flags</a></td></tr>
  109. <tr class="separator:ae134a6bdbd16a59218b5b4f0ee3a154c inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a52bcdb90972ffb30a223d358e64f723f inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1BaseEvent.html#a52bcdb90972ffb30a223d358e64f723f">time</a></td></tr>
  111. <tr class="separator:a52bcdb90972ffb30a223d358e64f723f inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table>
  113. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  114. <div class="textblock"><p>Mouse press or release event. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWidget.html#a097ec1d56a06bdc9e0a4e54880def378">onMouse</a> </dd></dl>
  115. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  116. <a id="aa37fee8a593c62c53e4ca5c67ad9278f"></a>
  117. <h2 class="memtitle"><span class="permalink"><a href="#aa37fee8a593c62c53e4ca5c67ad9278f">&#9670;&nbsp;</a></span>MouseEvent()</h2>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="mlabels">
  121. <tr>
  122. <td class="mlabels-left">
  123. <table class="memname">
  124. <tr>
  125. <td class="memname">Widget::MouseEvent::MouseEvent </td>
  126. <td>(</td>
  127. <td class="paramname"></td><td>)</td>
  128. <td></td>
  129. </tr>
  130. </table>
  131. </td>
  132. <td class="mlabels-right">
  133. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. <p>Constructor for default/null values </p>
  138. </div>
  139. </div>
  140. <h2 class="groupheader">Member Data Documentation</h2>
  141. <a id="ab6471d00c229719e1dd821f78ed4bdef"></a>
  142. <h2 class="memtitle"><span class="permalink"><a href="#ab6471d00c229719e1dd821f78ed4bdef">&#9670;&nbsp;</a></span>button</h2>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">uint Widget::MouseEvent::button</td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. <p>The button number starting from 1. </p><dl class="section see"><dt>See also</dt><dd>MouseButton </dd></dl>
  152. </div>
  153. </div>
  154. <a id="ab65f0309f44fab0bf329b4ade9b53fcb"></a>
  155. <h2 class="memtitle"><span class="permalink"><a href="#ab65f0309f44fab0bf329b4ade9b53fcb">&#9670;&nbsp;</a></span>press</h2>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">bool Widget::MouseEvent::press</td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>True if the button was pressed, false if released. </p>
  165. </div>
  166. </div>
  167. <a id="a11c6d85adf87424c392d866579149770"></a>
  168. <h2 class="memtitle"><span class="permalink"><a href="#a11c6d85adf87424c392d866579149770">&#9670;&nbsp;</a></span>pos</h2>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname"><a class="el" href="classPoint.html">Point</a>&lt;double&gt; Widget::MouseEvent::pos</td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>The widget-relative coordinates of the pointer. </p>
  178. </div>
  179. </div>
  180. <a id="ae80ebc0ab59ed2e06a63743d8c963651"></a>
  181. <h2 class="memtitle"><span class="permalink"><a href="#ae80ebc0ab59ed2e06a63743d8c963651">&#9670;&nbsp;</a></span>absolutePos</h2>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname"><a class="el" href="classPoint.html">Point</a>&lt;double&gt; Widget::MouseEvent::absolutePos</td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>The absolute coordinates of the pointer. </p>
  191. </div>
  192. </div>
  193. <hr/>The documentation for this struct was generated from the following file:<ul>
  194. <li>dgl/<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a></li>
  195. </ul>
  196. </div><!-- contents -->
  197. <!-- start footer part -->
  198. <hr class="footer"/><address class="footer"><small>
  199. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
  200. </small></address>
  201. </body>
  202. </html>