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.

218 lines
13KB

  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::ScrollEvent 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_1ScrollEvent.html">ScrollEvent</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_1ScrollEvent-members.html">List of all members</a> </div>
  70. <div class="headertitle">
  71. <div class="title">Widget::ScrollEvent 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::ScrollEvent:</div>
  77. <div class="dyncontent">
  78. <div class="center">
  79. <img src="structWidget_1_1ScrollEvent.png" usemap="#Widget::ScrollEvent_map" alt=""/>
  80. <map id="Widget::ScrollEvent_map" name="Widget::ScrollEvent_map">
  81. <area href="structWidget_1_1BaseEvent.html" alt="Widget::BaseEvent" shape="rect" coords="0,0,121,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:abee88b10b7b031ddcca1454e064a3cc3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1ScrollEvent.html#abee88b10b7b031ddcca1454e064a3cc3">ScrollEvent</a> () noexcept</td></tr>
  88. <tr class="separator:abee88b10b7b031ddcca1454e064a3cc3"><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:aea1e954d9e6aaee6b3f6131a1ca7aecf"><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_1ScrollEvent.html#aea1e954d9e6aaee6b3f6131a1ca7aecf">pos</a></td></tr>
  98. <tr class="separator:aea1e954d9e6aaee6b3f6131a1ca7aecf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:aa30ba4c1bc3c8973c5a99f315c089497"><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_1ScrollEvent.html#aa30ba4c1bc3c8973c5a99f315c089497">absolutePos</a></td></tr>
  100. <tr class="separator:aa30ba4c1bc3c8973c5a99f315c089497"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a5081893281d91c5f615cc066fb5fc3dc"><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_1ScrollEvent.html#a5081893281d91c5f615cc066fb5fc3dc">delta</a></td></tr>
  102. <tr class="separator:a5081893281d91c5f615cc066fb5fc3dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:aaf8500e819334defd632522858050e02"><td class="memItemLeft" align="right" valign="top">ScrollDirection&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1ScrollEvent.html#aaf8500e819334defd632522858050e02">direction</a></td></tr>
  104. <tr class="separator:aaf8500e819334defd632522858050e02"><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 scroll event.</p>
  115. <p>The scroll distance is expressed in "lines", an arbitrary unit that corresponds to a single tick of a detented mouse wheel. For example, <code>delta.y</code> = 1.0 scrolls 1 line up. Some systems and devices support finer resolution and/or higher values for fast scrolls, so programs should handle any value gracefully.</p>
  116. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classWidget.html#a0d78d28bd4a98c3a016a38091b2d4185">onScroll</a> </dd></dl>
  117. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  118. <a id="abee88b10b7b031ddcca1454e064a3cc3"></a>
  119. <h2 class="memtitle"><span class="permalink"><a href="#abee88b10b7b031ddcca1454e064a3cc3">&#9670;&nbsp;</a></span>ScrollEvent()</h2>
  120. <div class="memitem">
  121. <div class="memproto">
  122. <table class="mlabels">
  123. <tr>
  124. <td class="mlabels-left">
  125. <table class="memname">
  126. <tr>
  127. <td class="memname">Widget::ScrollEvent::ScrollEvent </td>
  128. <td>(</td>
  129. <td class="paramname"></td><td>)</td>
  130. <td></td>
  131. </tr>
  132. </table>
  133. </td>
  134. <td class="mlabels-right">
  135. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  136. </tr>
  137. </table>
  138. </div><div class="memdoc">
  139. <p>Constructor for default/null values </p>
  140. </div>
  141. </div>
  142. <h2 class="groupheader">Member Data Documentation</h2>
  143. <a id="aea1e954d9e6aaee6b3f6131a1ca7aecf"></a>
  144. <h2 class="memtitle"><span class="permalink"><a href="#aea1e954d9e6aaee6b3f6131a1ca7aecf">&#9670;&nbsp;</a></span>pos</h2>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="memname">
  148. <tr>
  149. <td class="memname"><a class="el" href="classPoint.html">Point</a>&lt;double&gt; Widget::ScrollEvent::pos</td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <p>The widget-relative coordinates of the pointer. </p>
  154. </div>
  155. </div>
  156. <a id="aa30ba4c1bc3c8973c5a99f315c089497"></a>
  157. <h2 class="memtitle"><span class="permalink"><a href="#aa30ba4c1bc3c8973c5a99f315c089497">&#9670;&nbsp;</a></span>absolutePos</h2>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname"><a class="el" href="classPoint.html">Point</a>&lt;double&gt; Widget::ScrollEvent::absolutePos</td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>The absolute coordinates of the pointer. </p>
  167. </div>
  168. </div>
  169. <a id="a5081893281d91c5f615cc066fb5fc3dc"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#a5081893281d91c5f615cc066fb5fc3dc">&#9670;&nbsp;</a></span>delta</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname"><a class="el" href="classPoint.html">Point</a>&lt;double&gt; Widget::ScrollEvent::delta</td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>The scroll distance. </p>
  180. </div>
  181. </div>
  182. <a id="aaf8500e819334defd632522858050e02"></a>
  183. <h2 class="memtitle"><span class="permalink"><a href="#aaf8500e819334defd632522858050e02">&#9670;&nbsp;</a></span>direction</h2>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">ScrollDirection Widget::ScrollEvent::direction</td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>The direction of the scroll or "smooth". </p>
  193. </div>
  194. </div>
  195. <hr/>The documentation for this struct was generated from the following file:<ul>
  196. <li>dgl/<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a></li>
  197. </ul>
  198. </div><!-- contents -->
  199. <!-- start footer part -->
  200. <hr class="footer"/><address class="footer"><small>
  201. 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
  202. </small></address>
  203. </body>
  204. </html>