|
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.9.1"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>DISTRHO Plugin Framework: dgl/Base.hpp Source File</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">DISTRHO Plugin Framework
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.1 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
-
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
-
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="dir_99893ac99dd47c2a73745483a12a725f.html">dgl</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">Base.hpp</div> </div>
- </div><!--header-->
- <div class="contents">
- <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
- <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
- <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2012-2024 Filipe Coelho <falktx@falktx.com></span></div>
- <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
- <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
- <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
- <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * permission notice appear in all copies.</span></div>
- <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
- <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
- <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
- <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
- <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
- <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
- <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
- <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
- <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef DGL_BASE_HPP_INCLUDED</span></div>
- <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define DGL_BASE_HPP_INCLUDED</span></div>
- <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
- <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "../distrho/extra/LeakDetector.hpp"</span></div>
- <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "../distrho/extra/ScopedPointer.hpp"</span></div>
- <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
- <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// Define namespace</span></div>
- <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
- <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef DGL_NAMESPACE</span></div>
- <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"># define DGL_NAMESPACE DGL</span></div>
- <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#endif</span></div>
- <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
- <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define START_NAMESPACE_DGL namespace DGL_NAMESPACE {</span></div>
- <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define END_NAMESPACE_DGL }</span></div>
- <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define USE_NAMESPACE_DGL using namespace DGL_NAMESPACE;</span></div>
- <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
- <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> START_NAMESPACE_DGL</div>
- <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
- <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// Base DGL enums</span></div>
- <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> Keyboard modifier flags.</span></div>
- <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">enum</span> Modifier {</div>
- <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  kModifierShift = 1U << 0U, <span class="comment">///< Shift key</span></div>
- <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  kModifierControl = 1U << 1U, <span class="comment">///< Control key</span></div>
- <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  kModifierAlt = 1U << 2U, <span class="comment">///< Alt/Option key</span></div>
- <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  kModifierSuper = 1U << 3U, <span class="comment">///< Mod4/Command/Windows key</span></div>
- <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  kModifierNumLock = 1U << 4U, <span class="comment">///< Num lock enabled</span></div>
- <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  kModifierScrollLock = 1U << 5U, <span class="comment">///< Scroll lock enabled</span></div>
- <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  kModifierCapsLock = 1U << 6U, <span class="comment">///< Caps lock enabled</span></div>
- <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> };</div>
- <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> Keyboard key codepoints.</span></div>
- <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> All keys are identified by a Unicode code point in Widget::KeyboardEvent::key.</span></div>
- <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> This enumeration defines constants for special keys that do not have a standard</span></div>
- <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> code point, and some convenience constants for control characters.</span></div>
- <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> Note that all keys are handled in the same way, this enumeration is just for</span></div>
- <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> convenience when writing hard-coded key bindings.</span></div>
- <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> Keys that do not have a standard code point use values in the Private Use</span></div>
- <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> Area in the Basic Multilingual Plane (`U+E000` to `U+F8FF`).</span></div>
- <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> Applications must take care to not interpret these values beyond key detection,</span></div>
- <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> the mapping used here is arbitrary and specific to DPF.</span></div>
- <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">enum</span> Key {</div>
- <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// Convenience symbols for ASCII control characters</span></div>
- <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  kKeyBackspace = 0x00000008U, <span class="comment">///< Backspace</span></div>
- <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  kKeyTab = 0x00000009U, <span class="comment">///< Tab</span></div>
- <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  kKeyEnter = 0x0000000DU, <span class="comment">///< Enter</span></div>
- <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  kKeyEscape = 0x0000001BU, <span class="comment">///< Escape</span></div>
- <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  kKeyDelete = 0x0000007FU, <span class="comment">///< Delete</span></div>
- <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  kKeySpace = 0x00000020U, <span class="comment">///< Space</span></div>
- <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
- <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// Unicode Private Use Area</span></div>
- <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  kKeyF1 = 0x0000E000U, <span class="comment">///< F1</span></div>
- <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  kKeyF2, <span class="comment">///< F2</span></div>
- <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  kKeyF3, <span class="comment">///< F3</span></div>
- <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  kKeyF4, <span class="comment">///< F4</span></div>
- <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  kKeyF5, <span class="comment">///< F5</span></div>
- <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  kKeyF6, <span class="comment">///< F6</span></div>
- <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  kKeyF7, <span class="comment">///< F7</span></div>
- <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  kKeyF8, <span class="comment">///< F8</span></div>
- <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  kKeyF9, <span class="comment">///< F9</span></div>
- <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  kKeyF10, <span class="comment">///< F10</span></div>
- <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  kKeyF11, <span class="comment">///< F11</span></div>
- <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  kKeyF12, <span class="comment">///< F12</span></div>
- <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  kKeyPageUp = 0xE031, <span class="comment">///< Page Up</span></div>
- <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  kKeyPageDown, <span class="comment">///< Page Down</span></div>
- <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  kKeyEnd, <span class="comment">///< End</span></div>
- <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  kKeyHome, <span class="comment">///< Home</span></div>
- <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  kKeyLeft, <span class="comment">///< Left</span></div>
- <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  kKeyUp, <span class="comment">///< Up</span></div>
- <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  kKeyRight, <span class="comment">///< Right</span></div>
- <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  kKeyDown, <span class="comment">///< Down</span></div>
- <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  kKeyPrintScreen = 0xE041U, <span class="comment">///< Print Screen</span></div>
- <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  kKeyInsert, <span class="comment">///< Insert</span></div>
- <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  kKeyPause, <span class="comment">///< Pause/Break</span></div>
- <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  kKeyMenu, <span class="comment">///< Menu</span></div>
- <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  kKeyNumLock, <span class="comment">///< Num Lock</span></div>
- <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  kKeyScrollLock, <span class="comment">///< Scroll Lock</span></div>
- <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  kKeyCapsLock, <span class="comment">///< Caps Lock</span></div>
- <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  kKeyShiftL = 0xE051U, <span class="comment">///< Left Shift,</span></div>
- <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  kKeyShiftR, <span class="comment">///< Right Shift</span></div>
- <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  kKeyControlL, <span class="comment">///< Left Control</span></div>
- <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  kKeyControlR, <span class="comment">///< Right Control</span></div>
- <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  kKeyAltL, <span class="comment">///< Left Alt</span></div>
- <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  kKeyAltR, <span class="comment">///< Right Alt / AltGr</span></div>
- <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  kKeySuperL, <span class="comment">///< Left Super</span></div>
- <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  kKeySuperR, <span class="comment">///< Right Super</span></div>
- <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  kKeyPad0 = 0xE060U, <span class="comment">///< Keypad 0</span></div>
- <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  kKeyPad1, <span class="comment">///< Keypad 1</span></div>
- <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  kKeyPad2, <span class="comment">///< Keypad 2</span></div>
- <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  kKeyPad3, <span class="comment">///< Keypad 3</span></div>
- <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  kKeyPad4, <span class="comment">///< Keypad 4</span></div>
- <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  kKeyPad5, <span class="comment">///< Keypad 5</span></div>
- <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  kKeyPad6, <span class="comment">///< Keypad 6</span></div>
- <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  kKeyPad7, <span class="comment">///< Keypad 7</span></div>
- <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  kKeyPad8, <span class="comment">///< Keypad 8</span></div>
- <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  kKeyPad9, <span class="comment">///< Keypad 9</span></div>
- <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  kKeyPadEnter, <span class="comment">///< Keypad Enter</span></div>
- <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  kKeyPadPageUp = 0xE071U, <span class="comment">///< Keypad Page Up</span></div>
- <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  kKeyPadPageDown, <span class="comment">///< Keypad Page Down</span></div>
- <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  kKeyPadEnd, <span class="comment">///< Keypad End</span></div>
- <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  kKeyPadHome, <span class="comment">///< Keypad Home</span></div>
- <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  kKeyPadLeft, <span class="comment">///< Keypad Left</span></div>
- <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  kKeyPadUp, <span class="comment">///< Keypad Up</span></div>
- <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  kKeyPadRight, <span class="comment">///< Keypad Right</span></div>
- <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  kKeyPadDown, <span class="comment">///< Keypad Down</span></div>
- <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  kKeyPadClear = 0xE09DU, <span class="comment">///< Keypad Clear/Begin</span></div>
- <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  kKeyPadInsert, <span class="comment">///< Keypad Insert</span></div>
- <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  kKeyPadDelete, <span class="comment">///< Keypad Delete</span></div>
- <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  kKeyPadEqual, <span class="comment">///< Keypad Equal</span></div>
- <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  kKeyPadMultiply = 0xE0AAU, <span class="comment">///< Keypad Multiply</span></div>
- <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  kKeyPadAdd, <span class="comment">///< Keypad Add</span></div>
- <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  kKeyPadSeparator, <span class="comment">///< Keypad Separator</span></div>
- <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  kKeyPadSubtract, <span class="comment">///< Keypad Subtract</span></div>
- <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  kKeyPadDecimal, <span class="comment">///< Keypad Decimal</span></div>
- <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  kKeyPadDivide, <span class="comment">///< Keypad Divide</span></div>
- <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  </div>
- <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="comment">// Backwards compatibility with old DPF</span></div>
- <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  kCharBackspace DISTRHO_DEPRECATED_BY(<span class="stringliteral">"kKeyBackspace"</span>) = kKeyBackspace,</div>
- <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  kCharEscape DISTRHO_DEPRECATED_BY(<span class="stringliteral">"kKeyEscape"</span>) = kKeyEscape,</div>
- <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  kCharDelete DISTRHO_DEPRECATED_BY(<span class="stringliteral">"kKeyDelete"</span>) = kKeyDelete,</div>
- <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div>
- <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  kKeyShift DISTRHO_DEPRECATED_BY(<span class="stringliteral">"kKeyShiftL"</span>) = kKeyShiftL,</div>
- <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  kKeyControl DISTRHO_DEPRECATED_BY(<span class="stringliteral">"kKeyControlL"</span>) = kKeyControlL,</div>
- <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  kKeyAlt DISTRHO_DEPRECATED_BY(<span class="stringliteral">"kKeyAltL"</span>) = kKeyAltL,</div>
- <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  kKeySuper DISTRHO_DEPRECATED_BY(<span class="stringliteral">"kKeySuperL"</span>) = kKeySuperL,</div>
- <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> };</div>
- <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> Common flags for all events.</span></div>
- <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="keyword">enum</span> EventFlag {</div>
- <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  kFlagSendEvent = 1, <span class="comment">///< Event is synthetic</span></div>
- <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  kFlagIsHint = 2, <span class="comment">///< Event is a hint (not direct user input)</span></div>
- <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> };</div>
- <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> Reason for a crossing event.</span></div>
- <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="keyword">enum</span> CrossingMode {</div>
- <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  kCrossingNormal, <span class="comment">///< Crossing due to pointer motion</span></div>
- <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  kCrossingGrab, <span class="comment">///< Crossing due to a grab</span></div>
- <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  kCrossingUngrab, <span class="comment">///< Crossing due to a grab release</span></div>
- <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> };</div>
- <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> A mouse button.</span></div>
- <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> Mouse button numbers start from 1, and are ordered: primary, secondary, middle.</span></div>
- <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> So, on a typical right-handed mouse, the button numbers are:</span></div>
- <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> Left: 1</span></div>
- <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> Right: 2</span></div>
- <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> Middle (often a wheel): 3</span></div>
- <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> Higher button numbers are reported in the same order they are represented on the system.</span></div>
- <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <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>
- <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> which are usually bound to "back" and "forward" operations.</span></div>
- <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> Note that these numbers may differ from those used on the underlying</span></div>
- <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> platform, since they are manipulated to provide a consistent portable API.</span></div>
- <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="keyword">enum</span> MouseButton {</div>
- <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  kMouseButtonLeft = 1,</div>
- <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  kMouseButtonRight,</div>
- <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  kMouseButtonMiddle,</div>
- <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> };</div>
- <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> A mouse cursor type.</span></div>
- <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> This is a portable subset of mouse cursors that exist on X11, MacOS, and Windows.</span></div>
- <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="keyword">enum</span> MouseCursor {</div>
- <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  kMouseCursorArrow, <span class="comment">///< Default pointing arrow</span></div>
- <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  kMouseCursorCaret, <span class="comment">///< Caret (I-Beam) for text entry</span></div>
- <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  kMouseCursorCrosshair, <span class="comment">///< Cross-hair</span></div>
- <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  kMouseCursorHand, <span class="comment">///< Hand with a pointing finger</span></div>
- <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  kMouseCursorNotAllowed, <span class="comment">///< Operation not allowed</span></div>
- <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  kMouseCursorLeftRight, <span class="comment">///< Left/right arrow for horizontal resize</span></div>
- <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  kMouseCursorUpDown, <span class="comment">///< Up/down arrow for vertical resize</span></div>
- <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  kMouseCursorUpLeftDownRight, <span class="comment">///< Diagonal arrow for down/right resize</span></div>
- <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  kMouseCursorUpRightDownLeft, <span class="comment">///< Diagonal arrow for down/left resize</span></div>
- <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  kMouseCursorAllScroll, <span class="comment">///< Omnidirectional "arrow" for scrolling</span></div>
- <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  </div>
- <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="comment">// Backwards compatibility with old DPF</span></div>
- <div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  kMouseCursorDiagonal DISTRHO_DEPRECATED_BY(<span class="stringliteral">"kMouseCursorUpLeftDownRight"</span>) = kMouseCursorUpLeftDownRight,</div>
- <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  kMouseCursorAntiDiagonal DISTRHO_DEPRECATED_BY(<span class="stringliteral">"kMouseCursorUpRightDownLeft"</span>) = kMouseCursorUpRightDownLeft,</div>
- <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> };</div>
- <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> Scroll direction.</span></div>
- <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> Describes the direction of a scroll event along with whether the scroll is a "smooth" scroll.</span></div>
- <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> The discrete directions are for devices like mouse wheels with constrained axes,</span></div>
- <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> while a smooth scroll is for those with arbitrary scroll direction freedom, like some touchpads.</span></div>
- <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="keyword">enum</span> ScrollDirection {</div>
- <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  kScrollUp, <span class="comment">///< Scroll up</span></div>
- <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  kScrollDown, <span class="comment">///< Scroll down</span></div>
- <div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  kScrollLeft, <span class="comment">///< Scroll left</span></div>
- <div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  kScrollRight, <span class="comment">///< Scroll right</span></div>
- <div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  kScrollSmooth, <span class="comment">///< Smooth scroll in any direction</span></div>
- <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> };</div>
- <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> A clipboard data offer.</span></div>
- <div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> @see Window::onClipboardDataOffer</span></div>
- <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00233"></a><span class="lineno"><a class="line" href="structClipboardDataOffer.html"> 233</a></span> <span class="keyword">struct </span><a class="code" href="structClipboardDataOffer.html">ClipboardDataOffer</a> {<span class="comment"></span></div>
- <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> The id of this data offer.</span></div>
- <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> @note The value 0 is reserved for null/invalid.</span></div>
- <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00238"></a><span class="lineno"><a class="line" href="structClipboardDataOffer.html#a573b30efdf1eee418f7388c9713dfddc"> 238</a></span>  uint32_t <a class="code" href="structClipboardDataOffer.html#a573b30efdf1eee418f7388c9713dfddc">id</a>;</div>
- <div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> The type of this data offer.</span></div>
- <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> Usually a MIME type, but may also be another platform-specific type identifier.</span></div>
- <div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00244"></a><span class="lineno"><a class="line" href="structClipboardDataOffer.html#a23d607737b1fffbb003b885da5a5ca66"> 244</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structClipboardDataOffer.html#a23d607737b1fffbb003b885da5a5ca66">type</a>;</div>
- <div class="line"><a name="l00245"></a><span class="lineno"> 245</span> };</div>
- <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  </div>
- <div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment">// Base DGL classes</span></div>
- <div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> Graphics context, definition depends on build type.</span></div>
- <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00253"></a><span class="lineno"><a class="line" href="structGraphicsContext.html"> 253</a></span> <span class="keyword">struct </span><a class="code" href="structGraphicsContext.html">GraphicsContext</a> {};</div>
- <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> Idle callback.</span></div>
- <div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00258"></a><span class="lineno"><a class="line" href="structIdleCallback.html"> 258</a></span> <span class="keyword">struct </span><a class="code" href="structIdleCallback.html">IdleCallback</a></div>
- <div class="line"><a name="l00259"></a><span class="lineno"> 259</span> {</div>
- <div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keyword">virtual</span> ~<a class="code" href="structIdleCallback.html">IdleCallback</a>() {}</div>
- <div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> idleCallback() = 0;</div>
- <div class="line"><a name="l00262"></a><span class="lineno"> 262</span> };</div>
- <div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  </div>
- <div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  </div>
- <div class="line"><a name="l00266"></a><span class="lineno"> 266</span> END_NAMESPACE_DGL</div>
- <div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  </div>
- <div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="preprocessor">#ifndef DONT_SET_USING_DGL_NAMESPACE</span></div>
- <div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  <span class="comment">// If your code uses a lot of DGL classes, then this will obviously save you</span></div>
- <div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="comment">// a lot of typing, but can be disabled by setting DONT_SET_USING_DGL_NAMESPACE.</span></div>
- <div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <span class="keyword">using namespace </span>DGL_NAMESPACE;</div>
- <div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="preprocessor">#endif</span></div>
- <div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  </div>
- <div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  </div>
- <div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="preprocessor">#endif </span><span class="comment">// DGL_BASE_HPP_INCLUDED</span></div>
- <div class="ttc" id="astructClipboardDataOffer_html"><div class="ttname"><a href="structClipboardDataOffer.html">ClipboardDataOffer</a></div><div class="ttdef"><b>Definition:</b> Base.hpp:233</div></div>
- <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:244</div></div>
- <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:238</div></div>
- <div class="ttc" id="astructGraphicsContext_html"><div class="ttname"><a href="structGraphicsContext.html">GraphicsContext</a></div><div class="ttdef"><b>Definition:</b> Base.hpp:253</div></div>
- <div class="ttc" id="astructIdleCallback_html"><div class="ttname"><a href="structIdleCallback.html">IdleCallback</a></div><div class="ttdef"><b>Definition:</b> Base.hpp:259</div></div>
- </div><!-- fragment --></div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
- </small></address>
- </body>
- </html>
|