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.

176 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: KnobEventHandler Class 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><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#nested-classes">Classes</a> &#124;
  64. <a href="#pub-types">Public Types</a> &#124;
  65. <a href="#pub-methods">Public Member Functions</a> &#124;
  66. <a href="#pro-methods">Protected Member Functions</a> &#124;
  67. <a href="classKnobEventHandler-members.html">List of all members</a> </div>
  68. <div class="headertitle">
  69. <div class="title">KnobEventHandler Class Reference</div> </div>
  70. </div><!--header-->
  71. <div class="contents">
  72. <div class="dynheader">
  73. Inheritance diagram for KnobEventHandler:</div>
  74. <div class="dyncontent">
  75. <div class="center">
  76. <img src="classKnobEventHandler.png" usemap="#KnobEventHandler_map" alt=""/>
  77. <map id="KnobEventHandler_map" name="KnobEventHandler_map">
  78. <area href="classImageBaseKnob.html" alt="ImageBaseKnob&lt; ImageType &gt;" shape="rect" coords="0,56,187,80"/>
  79. </map>
  80. </div></div>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  83. Classes</h2></td></tr>
  84. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKnobEventHandler_1_1Callback.html">Callback</a></td></tr>
  85. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. </table><table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  88. Public Types</h2></td></tr>
  89. <tr class="memitem:af36be885045fea73f06c0ffd94c8667b"><td class="memItemLeft" align="right" valign="top"><a id="af36be885045fea73f06c0ffd94c8667b"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>Orientation</b> { <b>Horizontal</b>
  90. , <b>Vertical</b>
  91. , <b>Both</b>
  92. }</td></tr>
  93. <tr class="separator:af36be885045fea73f06c0ffd94c8667b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a59cb5b018c4e2bf768a526847dd8b03a"><td class="memItemLeft" align="right" valign="top"><a id="a59cb5b018c4e2bf768a526847dd8b03a"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>State</b> { <b>kKnobStateDefault</b> = 0x0
  95. , <b>kKnobStateHover</b> = 0x1
  96. , <b>kKnobStateDragging</b> = 0x2
  97. , <b>kKnobStateDraggingHover</b> = kKnobStateDragging|kKnobStateHover
  98. }</td></tr>
  99. <tr class="separator:a59cb5b018c4e2bf768a526847dd8b03a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. </table><table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  102. Public Member Functions</h2></td></tr>
  103. <tr class="memitem:abdb261193909efeb572b3886fff94cfa"><td class="memItemLeft" align="right" valign="top"><a id="abdb261193909efeb572b3886fff94cfa"></a>
  104. &#160;</td><td class="memItemRight" valign="bottom"><b>KnobEventHandler</b> (<a class="el" href="classSubWidget.html">SubWidget</a> *self)</td></tr>
  105. <tr class="separator:abdb261193909efeb572b3886fff94cfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a09e82bea5e0a5fbc9287add5eafbee52"><td class="memItemLeft" align="right" valign="top"><a id="a09e82bea5e0a5fbc9287add5eafbee52"></a>
  107. &#160;</td><td class="memItemRight" valign="bottom"><b>KnobEventHandler</b> (<a class="el" href="classSubWidget.html">SubWidget</a> *self, const <a class="el" href="classKnobEventHandler.html">KnobEventHandler</a> &amp;other)</td></tr>
  108. <tr class="separator:a09e82bea5e0a5fbc9287add5eafbee52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:af1bdfef866690043c22bfc5e372b63fb"><td class="memItemLeft" align="right" valign="top"><a id="af1bdfef866690043c22bfc5e372b63fb"></a>
  110. <a class="el" href="classKnobEventHandler.html">KnobEventHandler</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classKnobEventHandler.html">KnobEventHandler</a> &amp;other)</td></tr>
  111. <tr class="separator:af1bdfef866690043c22bfc5e372b63fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a9d05e274c5c00ace8f6eb3a4479244fd"><td class="memItemLeft" align="right" valign="top"><a id="a9d05e274c5c00ace8f6eb3a4479244fd"></a>
  113. bool&#160;</td><td class="memItemRight" valign="bottom"><b>isInteger</b> () const noexcept</td></tr>
  114. <tr class="separator:a9d05e274c5c00ace8f6eb3a4479244fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a6893d9a9584697ff32478e30da88313d"><td class="memItemLeft" align="right" valign="top"><a id="a6893d9a9584697ff32478e30da88313d"></a>
  116. float&#160;</td><td class="memItemRight" valign="bottom"><b>getValue</b> () const noexcept</td></tr>
  117. <tr class="separator:a6893d9a9584697ff32478e30da88313d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:afd416c8b662fdefaa2a01185fa65951e"><td class="memItemLeft" align="right" valign="top"><a id="afd416c8b662fdefaa2a01185fa65951e"></a>
  119. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>setValue</b> (float value, bool sendCallback=false) noexcept</td></tr>
  120. <tr class="separator:afd416c8b662fdefaa2a01185fa65951e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a98018fe6d99413faa2cba6efc82ba017"><td class="memItemLeft" align="right" valign="top"><a id="a98018fe6d99413faa2cba6efc82ba017"></a>
  122. float&#160;</td><td class="memItemRight" valign="bottom"><b>getNormalizedValue</b> () const noexcept</td></tr>
  123. <tr class="separator:a98018fe6d99413faa2cba6efc82ba017"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a202669527510c566466d0276d11bbb94"><td class="memItemLeft" align="right" valign="top"><a id="a202669527510c566466d0276d11bbb94"></a>
  125. void&#160;</td><td class="memItemRight" valign="bottom"><b>setDefault</b> (float def) noexcept</td></tr>
  126. <tr class="separator:a202669527510c566466d0276d11bbb94"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:aa743a38f3b1c93cf6f318c1871ace8a9"><td class="memItemLeft" align="right" valign="top"><a id="aa743a38f3b1c93cf6f318c1871ace8a9"></a>
  128. void&#160;</td><td class="memItemRight" valign="bottom"><b>setRange</b> (float min, float max) noexcept</td></tr>
  129. <tr class="separator:aa743a38f3b1c93cf6f318c1871ace8a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:ac83d1cac770a825a9e82a6e09cfaaf8d"><td class="memItemLeft" align="right" valign="top"><a id="ac83d1cac770a825a9e82a6e09cfaaf8d"></a>
  131. void&#160;</td><td class="memItemRight" valign="bottom"><b>setStep</b> (float step) noexcept</td></tr>
  132. <tr class="separator:ac83d1cac770a825a9e82a6e09cfaaf8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a85bd3d1675da6e9231a86a2f52279fe5"><td class="memItemLeft" align="right" valign="top"><a id="a85bd3d1675da6e9231a86a2f52279fe5"></a>
  134. void&#160;</td><td class="memItemRight" valign="bottom"><b>setUsingLogScale</b> (bool yesNo) noexcept</td></tr>
  135. <tr class="separator:a85bd3d1675da6e9231a86a2f52279fe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a76483d33ca5ca9c43487afd0c7ec75ae"><td class="memItemLeft" align="right" valign="top"><a id="a76483d33ca5ca9c43487afd0c7ec75ae"></a>
  137. Orientation&#160;</td><td class="memItemRight" valign="bottom"><b>getOrientation</b> () const noexcept</td></tr>
  138. <tr class="separator:a76483d33ca5ca9c43487afd0c7ec75ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:ad73c424127debc58b11da34b0cf3e97d"><td class="memItemLeft" align="right" valign="top"><a id="ad73c424127debc58b11da34b0cf3e97d"></a>
  140. void&#160;</td><td class="memItemRight" valign="bottom"><b>setOrientation</b> (Orientation orientation) noexcept</td></tr>
  141. <tr class="separator:ad73c424127debc58b11da34b0cf3e97d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:ad1f62081621e86bba31d67713a7b1ef3"><td class="memItemLeft" align="right" valign="top"><a id="ad1f62081621e86bba31d67713a7b1ef3"></a>
  143. void&#160;</td><td class="memItemRight" valign="bottom"><b>setCallback</b> (<a class="el" href="classKnobEventHandler_1_1Callback.html">Callback</a> *callback) noexcept</td></tr>
  144. <tr class="separator:ad1f62081621e86bba31d67713a7b1ef3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a864c2ac2aa0900ad2c57436d56e633b3"><td class="memItemLeft" align="right" valign="top"><a id="a864c2ac2aa0900ad2c57436d56e633b3"></a>
  146. void&#160;</td><td class="memItemRight" valign="bottom"><b>setMouseDeceleration</b> (float accel) noexcept</td></tr>
  147. <tr class="separator:a864c2ac2aa0900ad2c57436d56e633b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a4b9e78243c3985cde7ee710dcc19a24b"><td class="memItemLeft" align="right" valign="top"><a id="a4b9e78243c3985cde7ee710dcc19a24b"></a>
  149. bool&#160;</td><td class="memItemRight" valign="bottom"><b>mouseEvent</b> (const <a class="el" href="structWidget_1_1MouseEvent.html">Widget::MouseEvent</a> &amp;ev, double scaleFactor=1.0)</td></tr>
  150. <tr class="separator:a4b9e78243c3985cde7ee710dcc19a24b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:ac1ea07135937daa099b6a24cea5f1646"><td class="memItemLeft" align="right" valign="top"><a id="ac1ea07135937daa099b6a24cea5f1646"></a>
  152. bool&#160;</td><td class="memItemRight" valign="bottom"><b>motionEvent</b> (const <a class="el" href="structWidget_1_1MotionEvent.html">Widget::MotionEvent</a> &amp;ev, double scaleFactor=1.0)</td></tr>
  153. <tr class="separator:ac1ea07135937daa099b6a24cea5f1646"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a3e13f425988eaf4b6691a734a253f44c"><td class="memItemLeft" align="right" valign="top"><a id="a3e13f425988eaf4b6691a734a253f44c"></a>
  155. bool&#160;</td><td class="memItemRight" valign="bottom"><b>scrollEvent</b> (const <a class="el" href="structWidget_1_1ScrollEvent.html">Widget::ScrollEvent</a> &amp;ev)</td></tr>
  156. <tr class="separator:a3e13f425988eaf4b6691a734a253f44c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. </table><table class="memberdecls">
  158. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  159. Protected Member Functions</h2></td></tr>
  160. <tr class="memitem:a8338ad3badd61ed5dbb2dccf0cadcc8a"><td class="memItemLeft" align="right" valign="top"><a id="a8338ad3badd61ed5dbb2dccf0cadcc8a"></a>
  161. <a class="el" href="structState.html">State</a>&#160;</td><td class="memItemRight" valign="bottom"><b>getState</b> () const noexcept</td></tr>
  162. <tr class="separator:a8338ad3badd61ed5dbb2dccf0cadcc8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. </table>
  164. <hr/>The documentation for this class was generated from the following file:<ul>
  165. <li>dgl/<a class="el" href="EventHandlers_8hpp_source.html">EventHandlers.hpp</a></li>
  166. </ul>
  167. </div><!-- contents -->
  168. <!-- start footer part -->
  169. <hr class="footer"/><address class="footer"><small>
  170. 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
  171. </small></address>
  172. </body>
  173. </html>