DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
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.
412 Commits
6 Branches
54MB
Tree: ab8e200b4f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'ab8e200b4f'
${ noResults }
DPF/Base_8hpp_source.html

319 lines
36KB
Raw Blame History 

  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: dgl/Base.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.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. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. <div id="nav-path" class="navpath">

  63.   <ul>

  64. <li class="navelem"><a class="el" href="dir_99893ac99dd47c2a73745483a12a725f.html">dgl</a></li>  </ul>

  65. </div>

  66. </div><!-- top -->

  67. <div class="header">

  68.   <div class="headertitle">

  69. <div class="title">Base.hpp</div>  </div>

  70. </div><!--header-->

  71. <div class="contents">

  72. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>

  73. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>

  74. <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright (C) 2012-2022 Filipe Coelho &lt;falktx@falktx.com&gt;</span></div>

  75. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>

  76. <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>

  77. <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>

  78. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>

  79. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>

  80. <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>

  81. <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>

  82. <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>

  83. <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>

  84. <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>

  85. <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>

  86. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>

  87. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160; </div>

  88. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef DGL_BASE_HPP_INCLUDED</span></div>

  89. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define DGL_BASE_HPP_INCLUDED</span></div>

  90. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160; </div>

  91. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;../distrho/extra/LeakDetector.hpp&quot;</span></div>

  92. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &quot;../distrho/extra/ScopedPointer.hpp&quot;</span></div>

  93. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160; </div>

  94. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>

  95. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">// Define namespace</span></div>

  96. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160; </div>

  97. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#ifndef DGL_NAMESPACE</span></div>

  98. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor"># define DGL_NAMESPACE DGL</span></div>

  99. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#endif</span></div>

  100. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160; </div>

  101. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#define START_NAMESPACE_DGL namespace DGL_NAMESPACE {</span></div>

  102. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#define END_NAMESPACE_DGL }</span></div>

  103. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#define USE_NAMESPACE_DGL using namespace DGL_NAMESPACE;</span></div>

  104. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160; </div>

  105. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;START_NAMESPACE_DGL</div>

  106. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160; </div>

  107. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>

  108. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">// Base DGL enums</span></div>

  109. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment"></span> </div>

  110. <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">/**</span></div>

  111. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment">   Keyboard modifier flags.</span></div>

  112. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"> */</span></div>

  113. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="keyword">enum</span> Modifier {</div>

  114. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    kModifierShift   = 1u &lt;&lt; 0u, <span class="comment">///&lt; Shift key</span></div>

  115. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    kModifierControl = 1u &lt;&lt; 1u, <span class="comment">///&lt; Control key</span></div>

  116. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    kModifierAlt     = 1u &lt;&lt; 2u, <span class="comment">///&lt; Alt/Option key</span></div>

  117. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    kModifierSuper   = 1u &lt;&lt; 3u  <span class="comment">///&lt; Mod4/Command/Windows key</span></div>

  118. <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;};</div>

  119. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"></span> </div>

  120. <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment">/**</span></div>

  121. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">   Keyboard key codepoints.</span></div>

  122. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment"></span> </div>

  123. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment">   All keys are identified by a Unicode code point in Widget::KeyboardEvent::key.</span></div>

  124. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment">   This enumeration defines constants for special keys that do not have a standard</span></div>

  125. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">   code point, and some convenience constants for control characters.</span></div>

  126. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">   Note that all keys are handled in the same way, this enumeration is just for</span></div>

  127. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">   convenience when writing hard-coded key bindings.</span></div>

  128. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"></span> </div>

  129. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment">   Keys that do not have a standard code point use values in the Private Use</span></div>

  130. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment">   Area in the Basic Multilingual Plane (`U+E000` to `U+F8FF`).</span></div>

  131. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment">   Applications must take care to not interpret these values beyond key detection,</span></div>

  132. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">   the mapping used here is arbitrary and specific to DPF.</span></div>

  133. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment"> */</span></div>

  134. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="keyword">enum</span> Key {</div>

  135. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="comment">// Convenience symbols for ASCII control characters</span></div>

  136. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    kKeyBackspace = 0x08,</div>

  137. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    kKeyEscape    = 0x1B,</div>

  138. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    kKeyDelete    = 0x7F,</div>

  139. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </div>

  140. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="comment">// Backwards compatibility with old DPF</span></div>

  141. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    kCharBackspace DISTRHO_DEPRECATED_BY(<span class="stringliteral">&quot;kKeyBackspace&quot;</span>) = kKeyBackspace,</div>

  142. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    kCharEscape    DISTRHO_DEPRECATED_BY(<span class="stringliteral">&quot;kKeyEscape&quot;</span>) = kKeyEscape,</div>

  143. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    kCharDelete    DISTRHO_DEPRECATED_BY(<span class="stringliteral">&quot;kKeyDelete&quot;</span>) = kKeyDelete,</div>

  144. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160; </div>

  145. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <span class="comment">// Unicode Private Use Area</span></div>

  146. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    kKeyF1 = 0xE000,</div>

  147. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    kKeyF2,</div>

  148. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    kKeyF3,</div>

  149. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    kKeyF4,</div>

  150. <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    kKeyF5,</div>

  151. <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    kKeyF6,</div>

  152. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    kKeyF7,</div>

  153. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    kKeyF8,</div>

  154. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    kKeyF9,</div>

  155. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    kKeyF10,</div>

  156. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    kKeyF11,</div>

  157. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    kKeyF12,</div>

  158. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    kKeyLeft,</div>

  159. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    kKeyUp,</div>

  160. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    kKeyRight,</div>

  161. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    kKeyDown,</div>

  162. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    kKeyPageUp,</div>

  163. <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    kKeyPageDown,</div>

  164. <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    kKeyHome,</div>

  165. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    kKeyEnd,</div>

  166. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    kKeyInsert,</div>

  167. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    kKeyShift,</div>

  168. <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    kKeyShiftL = kKeyShift,</div>

  169. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    kKeyShiftR,</div>

  170. <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    kKeyControl,</div>

  171. <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    kKeyControlL = kKeyControl,</div>

  172. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    kKeyControlR,</div>

  173. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    kKeyAlt,</div>

  174. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    kKeyAltL = kKeyAlt,</div>

  175. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    kKeyAltR,</div>

  176. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;    kKeySuper,</div>

  177. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;    kKeySuperL = kKeySuper,</div>

  178. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    kKeySuperR,</div>

  179. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    kKeyMenu,</div>

  180. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;    kKeyCapsLock,</div>

  181. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    kKeyScrollLock,</div>

  182. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    kKeyNumLock,</div>

  183. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;    kKeyPrintScreen,</div>

  184. <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;    kKeyPause</div>

  185. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;};</div>

  186. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment"></span> </div>

  187. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment">/**</span></div>

  188. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment">   Common flags for all events.</span></div>

  189. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment"> */</span></div>

  190. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="keyword">enum</span> EventFlag {</div>

  191. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;    kFlagSendEvent = 1, <span class="comment">///&lt; Event is synthetic</span></div>

  192. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    kFlagIsHint    = 2  <span class="comment">///&lt; Event is a hint (not direct user input)</span></div>

  193. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;};</div>

  194. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment"></span> </div>

  195. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment">/**</span></div>

  196. <div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment">   Reason for a crossing event.</span></div>

  197. <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"> */</span></div>

  198. <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="keyword">enum</span> CrossingMode {</div>

  199. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    kCrossingNormal, <span class="comment">///&lt; Crossing due to pointer motion</span></div>

  200. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;    kCrossingGrab,   <span class="comment">///&lt; Crossing due to a grab</span></div>

  201. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;    kCrossingUngrab  <span class="comment">///&lt; Crossing due to a grab release</span></div>

  202. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;};</div>

  203. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"></span> </div>

  204. <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment">/**</span></div>

  205. <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment">   A mouse button.</span></div>

  206. <div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"></span> </div>

  207. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">   Mouse button numbers start from 1, and are ordered: primary, secondary, middle.</span></div>

  208. <div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment">   So, on a typical right-handed mouse, the button numbers are:</span></div>

  209. <div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"></span> </div>

  210. <div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment">   Left: 1</span></div>

  211. <div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment">   Right: 2</span></div>

  212. <div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment">   Middle (often a wheel): 3</span></div>

  213. <div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment"></span> </div>

  214. <div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment">   Higher button numbers are reported in the same order they are represented on the system.</span></div>

  215. <div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment">   There is no universal standard here, but buttons 4 and 5 are typically a pair of buttons or a rocker,</span></div>

  216. <div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment">   which are usually bound to &quot;back&quot; and &quot;forward&quot; operations.</span></div>

  217. <div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"></span> </div>

  218. <div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment">   Note that these numbers may differ from those used on the underlying</span></div>

  219. <div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment">   platform, since they are manipulated to provide a consistent portable API.</span></div>

  220. <div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment">*/</span></div>

  221. <div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="keyword">enum</span> MouseButton {</div>

  222. <div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;    kMouseButtonLeft = 1,</div>

  223. <div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;    kMouseButtonRight,</div>

  224. <div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;    kMouseButtonMiddle,</div>

  225. <div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;};</div>

  226. <div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment"></span> </div>

  227. <div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment">/**</span></div>

  228. <div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">   A mouse cursor type.</span></div>

  229. <div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment"></span> </div>

  230. <div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment">   This is a portable subset of mouse cursors that exist on X11, MacOS, and Windows.</span></div>

  231. <div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">*/</span></div>

  232. <div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="keyword">enum</span> MouseCursor {</div>

  233. <div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;    kMouseCursorArrow,       <span class="comment">///&lt; Default pointing arrow</span></div>

  234. <div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;    kMouseCursorCaret,       <span class="comment">///&lt; Caret (I-Beam) for text entry</span></div>

  235. <div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    kMouseCursorCrosshair,   <span class="comment">///&lt; Cross-hair</span></div>

  236. <div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;    kMouseCursorHand,        <span class="comment">///&lt; Hand with a pointing finger</span></div>

  237. <div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;    kMouseCursorNotAllowed,  <span class="comment">///&lt; Operation not allowed</span></div>

  238. <div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;    kMouseCursorLeftRight,   <span class="comment">///&lt; Left/right arrow for horizontal resize</span></div>

  239. <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;    kMouseCursorUpDown,      <span class="comment">///&lt; Up/down arrow for vertical resize</span></div>

  240. <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;    kMouseCursorDiagonal,    <span class="comment">///&lt; Top-left to bottom-right arrow for diagonal resize</span></div>

  241. <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    kMouseCursorAntiDiagonal <span class="comment">///&lt; Bottom-left to top-right arrow for diagonal resize</span></div>

  242. <div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;};</div>

  243. <div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment"></span> </div>

  244. <div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment">/**</span></div>

  245. <div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment">   Scroll direction.</span></div>

  246. <div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="comment"></span> </div>

  247. <div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="comment">   Describes the direction of a scroll event along with whether the scroll is a &quot;smooth&quot; scroll.</span></div>

  248. <div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;<span class="comment">   The discrete directions are for devices like mouse wheels with constrained axes,</span></div>

  249. <div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="comment">   while a smooth scroll is for those with arbitrary scroll direction freedom, like some touchpads.</span></div>

  250. <div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment">*/</span></div>

  251. <div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="keyword">enum</span> ScrollDirection {</div>

  252. <div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;    kScrollUp,    <span class="comment">///&lt; Scroll up</span></div>

  253. <div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;    kScrollDown,  <span class="comment">///&lt; Scroll down</span></div>

  254. <div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;    kScrollLeft,  <span class="comment">///&lt; Scroll left</span></div>

  255. <div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;    kScrollRight, <span class="comment">///&lt; Scroll right</span></div>

  256. <div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;    kScrollSmooth <span class="comment">///&lt; Smooth scroll in any direction</span></div>

  257. <div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;};</div>

  258. <div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="comment"></span> </div>

  259. <div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="comment">/**</span></div>

  260. <div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment">   A clipboard data offer.</span></div>

  261. <div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment">   @see Window::onClipboardDataOffer</span></div>

  262. <div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="comment">*/</span></div>

  263. <div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="structClipboardDataOffer.html">  192</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structClipboardDataOffer.html">ClipboardDataOffer</a> {<span class="comment"></span></div>

  264. <div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment">   /**</span></div>

  265. <div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment">      The id of this data offer.</span></div>

  266. <div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment">      @note The value 0 is reserved for null/invalid.</span></div>

  267. <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment">    */</span></div>

  268. <div class="line"><a name="l00197"></a><span class="lineno"><a class="line" href="structClipboardDataOffer.html#a573b30efdf1eee418f7388c9713dfddc">  197</a></span>&#160;    uint32_t <a class="code" href="structClipboardDataOffer.html#a573b30efdf1eee418f7388c9713dfddc">id</a>;</div>

  269. <div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment"></span> </div>

  270. <div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment">   /**</span></div>

  271. <div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;<span class="comment">      The type of this data offer.</span></div>

  272. <div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="comment">      Usually a MIME type, but may also be another platform-specific type identifier.</span></div>

  273. <div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;<span class="comment">    */</span></div>

  274. <div class="line"><a name="l00203"></a><span class="lineno"><a class="line" href="structClipboardDataOffer.html#a23d607737b1fffbb003b885da5a5ca66">  203</a></span>&#160;    <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structClipboardDataOffer.html#a23d607737b1fffbb003b885da5a5ca66">type</a>;</div>

  275. <div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;};</div>

  276. <div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160; </div>

  277. <div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>

  278. <div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;<span class="comment">// Base DGL classes</span></div>

  279. <div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;<span class="comment"></span> </div>

  280. <div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;<span class="comment">/**</span></div>

  281. <div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;<span class="comment">   Graphics context, definition depends on build type.</span></div>

  282. <div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;<span class="comment"> */</span></div>

  283. <div class="line"><a name="l00212"></a><span class="lineno"><a class="line" href="structGraphicsContext.html">  212</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structGraphicsContext.html">GraphicsContext</a> {};</div>

  284. <div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;<span class="comment"></span> </div>

  285. <div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;<span class="comment">/**</span></div>

  286. <div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;<span class="comment">   Idle callback.</span></div>

  287. <div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;<span class="comment"> */</span></div>

  288. <div class="line"><a name="l00217"></a><span class="lineno"><a class="line" href="structIdleCallback.html">  217</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structIdleCallback.html">IdleCallback</a></div>

  289. <div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;{</div>

  290. <div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="structIdleCallback.html">IdleCallback</a>() {}</div>

  291. <div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> idleCallback() = 0;</div>

  292. <div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;};</div>

  293. <div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160; </div>

  294. <div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>

  295. <div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160; </div>

  296. <div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;END_NAMESPACE_DGL</div>

  297. <div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160; </div>

  298. <div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="preprocessor">#ifndef DONT_SET_USING_DGL_NAMESPACE</span></div>

  299. <div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;  <span class="comment">// If your code uses a lot of DGL classes, then this will obviously save you</span></div>

  300. <div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;  <span class="comment">// a lot of typing, but can be disabled by setting DONT_SET_USING_DGL_NAMESPACE.</span></div>

  301. <div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;  <span class="keyword">using namespace </span>DGL_NAMESPACE;</div>

  302. <div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;<span class="preprocessor">#endif</span></div>

  303. <div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160; </div>

  304. <div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>

  305. <div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160; </div>

  306. <div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// DGL_BASE_HPP_INCLUDED</span></div>

  307. <div class="ttc" id="astructClipboardDataOffer_html"><div class="ttname"><a href="structClipboardDataOffer.html">ClipboardDataOffer</a></div><div class="ttdef"><b>Definition:</b> Base.hpp:192</div></div>

  308. <div class="ttc" id="astructClipboardDataOffer_html_a23d607737b1fffbb003b885da5a5ca66"><div class="ttname"><a href="structClipboardDataOffer.html#a23d607737b1fffbb003b885da5a5ca66">ClipboardDataOffer::type</a></div><div class="ttdeci">const char * type</div><div class="ttdef"><b>Definition:</b> Base.hpp:203</div></div>

  309. <div class="ttc" id="astructClipboardDataOffer_html_a573b30efdf1eee418f7388c9713dfddc"><div class="ttname"><a href="structClipboardDataOffer.html#a573b30efdf1eee418f7388c9713dfddc">ClipboardDataOffer::id</a></div><div class="ttdeci">uint32_t id</div><div class="ttdef"><b>Definition:</b> Base.hpp:197</div></div>

  310. <div class="ttc" id="astructGraphicsContext_html"><div class="ttname"><a href="structGraphicsContext.html">GraphicsContext</a></div><div class="ttdef"><b>Definition:</b> Base.hpp:212</div></div>

  311. <div class="ttc" id="astructIdleCallback_html"><div class="ttname"><a href="structIdleCallback.html">IdleCallback</a></div><div class="ttdef"><b>Definition:</b> Base.hpp:218</div></div>

  312. </div><!-- fragment --></div><!-- contents -->

  313. <!-- start footer part -->

  314. <hr class="footer"/><address class="footer"><small>

  315. Generated on Wed Jul 27 2022 00:46:18 for DISTRHO Plugin Framework 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

  316. </small></address>

  317. </body>

  318. </html>