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.

163 lines
15KB

  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.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: dgl/EventHandlers.hpp Source File</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.8.17 -->
  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');
  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="dir_99893ac99dd47c2a73745483a12a725f.html">dgl</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="headertitle">
  67. <div class="title">EventHandlers.hpp</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
  71. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
  72. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright (C) 2012-2021 Filipe Coelho &lt;falktx@falktx.com&gt;</span></div>
  73. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  74. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
  75. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
  76. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>
  77. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
  78. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
  79. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
  80. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
  81. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
  82. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
  83. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
  84. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></div>
  85. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
  86. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef DGL_EVENT_HANDLERS_HPP_INCLUDED</span></div>
  87. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define DGL_EVENT_HANDLERS_HPP_INCLUDED</span></div>
  88. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
  89. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;Widget.hpp&quot;</span></div>
  90. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
  91. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;START_NAMESPACE_DGL</div>
  92. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
  93. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
  94. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
  95. <div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classButtonEventHandler.html"> 26</a></span>&#160;<span class="keyword">class </span><a class="code" href="classButtonEventHandler.html">ButtonEventHandler</a></div>
  96. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;{</div>
  97. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">public</span>:</div>
  98. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">enum</span> State {</div>
  99. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; kButtonStateDefault = 0x0,</div>
  100. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; kButtonStateHover = 0x1,</div>
  101. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; kButtonStateActive = 0x2,</div>
  102. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; kButtonStateActiveHover = kButtonStateActive|kButtonStateHover</div>
  103. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; };</div>
  104. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
  105. <div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classButtonEventHandler_1_1Callback.html"> 36</a></span>&#160; <span class="keyword">class </span><a class="code" href="classButtonEventHandler_1_1Callback.html">Callback</a></div>
  106. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; {</div>
  107. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">public</span>:</div>
  108. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classButtonEventHandler_1_1Callback.html">Callback</a>() {}</div>
  109. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> buttonClicked(<a class="code" href="classSubWidget.html">SubWidget</a>* widget, <span class="keywordtype">int</span> button) = 0;</div>
  110. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; };</div>
  111. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
  112. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classButtonEventHandler.html">ButtonEventHandler</a>(<a class="code" href="classSubWidget.html">SubWidget</a>* <span class="keyword">self</span>);</div>
  113. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; ~<a class="code" href="classButtonEventHandler.html">ButtonEventHandler</a>();</div>
  114. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
  115. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">bool</span> isActive() noexcept;</div>
  116. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> setActive(<span class="keywordtype">bool</span> active, <span class="keywordtype">bool</span> sendCallback) noexcept;</div>
  117. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
  118. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">bool</span> isChecked() const noexcept;</div>
  119. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">void</span> setChecked(<span class="keywordtype">bool</span> checked, <span class="keywordtype">bool</span> sendCallback) noexcept;</div>
  120. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
  121. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">bool</span> isCheckable() const noexcept;</div>
  122. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">void</span> setCheckable(<span class="keywordtype">bool</span> checkable) noexcept;</div>
  123. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
  124. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">void</span> setCallback(<a class="code" href="classButtonEventHandler_1_1Callback.html">Callback</a>* callback) noexcept;</div>
  125. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
  126. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">bool</span> mouseEvent(const <a class="code" href="classWidget.html">Widget</a>::MouseEvent&amp; ev);</div>
  127. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">bool</span> motionEvent(const <a class="code" href="classWidget.html">Widget</a>::MotionEvent&amp; ev);</div>
  128. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
  129. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;protected:</div>
  130. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; State getState() const noexcept;</div>
  131. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> clearState() noexcept;</div>
  132. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
  133. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; virtual <span class="keywordtype">void</span> stateChanged(State state, State oldState);</div>
  134. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
  135. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;private:</div>
  136. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; struct PrivateData;</div>
  137. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; PrivateData* const pData;</div>
  138. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
  139. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classButtonEventHandler.html">ButtonEventHandler</a>)</div>
  140. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;};</div>
  141. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
  142. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
  143. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
  144. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;END_NAMESPACE_DGL</div>
  145. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
  146. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="preprocessor">#endif // DGL_EVENT_HANDLERS_HPP_INCLUDED</span></div>
  147. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
  148. </div><!-- fragment --></div><!-- contents -->
  149. <div class="ttc" id="aclassButtonEventHandler_1_1Callback_html"><div class="ttname"><a href="classButtonEventHandler_1_1Callback.html">ButtonEventHandler::Callback</a></div><div class="ttdef"><b>Definition:</b> EventHandlers.hpp:36</div></div>
  150. <div class="ttc" id="aclassSubWidget_html"><div class="ttname"><a href="classSubWidget.html">SubWidget</a></div><div class="ttdef"><b>Definition:</b> SubWidget.hpp:39</div></div>
  151. <div class="ttc" id="aclassButtonEventHandler_html"><div class="ttname"><a href="classButtonEventHandler.html">ButtonEventHandler</a></div><div class="ttdef"><b>Definition:</b> EventHandlers.hpp:26</div></div>
  152. <div class="ttc" id="aclassWidget_html"><div class="ttname"><a href="classWidget.html">Widget</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:53</div></div>
  153. <!-- start footer part -->
  154. <hr class="footer"/><address class="footer"><small>
  155. Generated on Tue Jun 15 2021 12:29:15 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  156. <img class="footer" src="doxygen.png" alt="doxygen"/>
  157. </a> 1.8.17
  158. </small></address>
  159. </body>
  160. </html>