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.
373 Commits
6 Branches
58MB
Tree: 1bf6b55edf
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1bf6b55edf'
${ noResults }
DPF/DistrhoUI_8hpp_source.html

312 lines
38KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8"/>

  7. <title>DISTRHO Plugin Framework: distrho/DistrhoUI.hpp Source File</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/search.js"></script>

  13. <script type="text/javascript">

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  17. </head>

  18. <body>

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  20. <div id="titlearea">

  21. <table cellspacing="0" cellpadding="0">

  22.  <tbody>

  23.  <tr style="height: 56px;">

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">DISTRHO Plugin Framework

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

  32. <!-- end header part -->

  33. <!-- Generated by Doxygen 1.8.8 -->

  34. <script type="text/javascript">

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. </script>

  37.   <div id="navrow1" class="tabs">

  38.     <ul class="tablist">

  39.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  40.       <li><a href="modules.html"><span>Modules</span></a></li>

  41.       <li><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li class="current"><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

  47.                onmouseover="return searchBox.OnSearchSelectShow()"

  48.                onmouseout="return searchBox.OnSearchSelectHide()"

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61.   <div id="navrow2" class="tabs2">

  62.     <ul class="tablist">

  63.       <li><a href="files.html"><span>File&#160;List</span></a></li>

  64.     </ul>

  65.   </div>

  66. <!-- window showing the filter options -->

  67. <div id="MSearchSelectWindow"

  68.      onmouseover="return searchBox.OnSearchSelectShow()"

  69.      onmouseout="return searchBox.OnSearchSelectHide()"

  70.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  71. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  72. 

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

  74. <div id="MSearchResultsWindow">

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

  76.         name="MSearchResults" id="MSearchResults">

  77. </iframe>

  78. </div>

  79. 

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

  81.   <ul>

  82. <li class="navelem"><a class="el" href="dir_37257469cca17bab24b582e18a78eb75.html">distrho</a></li>  </ul>

  83. </div>

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

  85. <div class="header">

  86.   <div class="headertitle">

  87. <div class="title">DistrhoUI.hpp</div>  </div>

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

  89. <div class="contents">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  110. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &quot;src/DistrhoPluginChecks.h&quot;</span></div>

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

  112. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#if DISTRHO_UI_USE_NANOVG</span></div>

  113. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor"># include &quot;../dgl/NanoVG.hpp&quot;</span></div>

  114. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">typedef</span> DGL::NanoWidget UIWidget;</div>

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

  116. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor"># include &quot;../dgl/Widget.hpp&quot;</span></div>

  117. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">typedef</span> DGL::Widget UIWidget;</div>

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

  119. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>

  120. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;START_NAMESPACE_DISTRHO</div>

  121. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div>

  122. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>

  123. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"> * DPF UI */</span></div>

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

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

  126. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">   DPF UI class from where UI instances are created.</span></div>

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

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

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

  130. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">   must call setSize during construction,</span></div>

  131. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment"> */</span></div>

  132. <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classUI.html">   43</a></span>&#160;<span class="keyword">class </span><a class="code" href="classUI.html">UI</a> : <span class="keyword">public</span> UIWidget</div>

  133. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;{</div>

  134. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>

  135. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">   /**</span></div>

  136. <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">      UI class constructor.</span></div>

  137. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">      The UI should be initialized to a default state that matches the plugin side.</span></div>

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

  139. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <a class="code" href="classUI.html#ad3425075e4a23234a8568d1893b54f22">UI</a>(uint width = 0, uint height = 0);</div>

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

  141. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment">   /**</span></div>

  142. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment">      Destructor.</span></div>

  143. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">    */</span></div>

  144. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="classUI.html#a47e7b6111faba049dfee4738d067cc42">~UI</a>();</div>

  145. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div>

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

  147. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment">    * Host state */</span></div>

  148. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"></span></div>

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

  150. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">      Get the current sample rate used in plugin processing.</span></div>

  151. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">      @see d_sampleRateChanged(double)</span></div>

  152. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">    */</span></div>

  153. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keywordtype">double</span> <a class="code" href="classUI.html#ab6cbe4dcade92f7f49d4405e51ee639c">d_getSampleRate</a>() <span class="keyword">const</span> noexcept;</div>

  154. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"></span></div>

  155. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">   /**</span></div>

  156. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">      TODO: Document this.</span></div>

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

  158. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classUI.html#a768b898d1e063d5c0112197b99ccba99">d_editParameter</a>(<span class="keyword">const</span> uint32_t index, <span class="keyword">const</span> <span class="keywordtype">bool</span> started);</div>

  159. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment"></span></div>

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

  161. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment">      TODO: Document this.</span></div>

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

  163. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classUI.html#a310a08018194f82937ca92bed4e77f1f">d_setParameterValue</a>(<span class="keyword">const</span> uint32_t index, <span class="keyword">const</span> <span class="keywordtype">float</span> value);</div>

  164. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div>

  165. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span></div>

  166. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">   /**</span></div>

  167. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment">      TODO: Document this.</span></div>

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

  169. <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classUI.html#ac32cb7fd88c642eadebf64137acd910e">d_setState</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> key, <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> value);</div>

  170. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="preprocessor">#endif</span></div>

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

  172. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_IS_SYNTH</span></div>

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

  174. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">      TODO: Document this.</span></div>

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

  176. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classUI.html#a621c381126d8e2f0124199b82cdcd456">d_sendNote</a>(<span class="keyword">const</span> uint8_t channel, <span class="keyword">const</span> uint8_t note, <span class="keyword">const</span> uint8_t velocity);</div>

  177. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="preprocessor">#endif</span></div>

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

  179. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_DIRECT_ACCESS</span></div>

  180. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  181. <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment">    * Direct DSP access - DO NOT USE THIS UNLESS STRICTLY NECESSARY!! */</span></div>

  182. <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment"></span></div>

  183. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment">   /**</span></div>

  184. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment">      TODO: Document this.</span></div>

  185. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment">    */</span></div>

  186. <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    <span class="keywordtype">void</span>* <a class="code" href="classUI.html#a5393f505fc8702905c15c70c9fcf0d48">d_getPluginInstancePointer</a>() <span class="keyword">const</span> noexcept;</div>

  187. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="preprocessor">#endif</span></div>

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

  189. <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="keyword">protected</span>:</div>

  190. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  191. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment">    * DSP/Plugin Callbacks */</span></div>

  192. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"></span></div>

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

  194. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment">      A parameter has changed on the plugin side.</span></div>

  195. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment">      This is called by the host to inform the UI about parameter changes.</span></div>

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

  197. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classUI.html#a9599da33720f4648e9ce78cc18249b07">d_parameterChanged</a>(uint32_t index, <span class="keywordtype">float</span> value) = 0;</div>

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

  199. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_PROGRAMS</span></div>

  200. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment">   /**</span></div>

  201. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment">      The current program has changed on the plugin side.</span></div>

  202. <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment">      This is called by the host to inform the UI about program changes.</span></div>

  203. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">    */</span></div>

  204. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classUI.html#a7d703d2caff4765f270686b8428a2fa0">d_programChanged</a>(uint32_t index) = 0;</div>

  205. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="preprocessor">#endif</span></div>

  206. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;</div>

  207. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span></div>

  208. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment">   /**</span></div>

  209. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment">      A state has changed on the plugin side.</span></div>

  210. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment">      This is called by the host to inform the UI about state changes.</span></div>

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

  212. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classUI.html#a7f508ebffec7a5168b532ccb9d81df70">d_stateChanged</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value) = 0;</div>

  213. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="preprocessor">#endif</span></div>

  214. <div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;</div>

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

  216. <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment">    * DSP/Plugin Callbacks (optional) */</span></div>

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

  218. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment">   /**</span></div>

  219. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment">      Optional callback to inform the UI about a sample rate change on the plugin side.</span></div>

  220. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment">      @see d_getSampleRate()</span></div>

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

  222. <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classUI.html#a18f4b84a973405fc098e69047e0d1994">d_sampleRateChanged</a>(<span class="keywordtype">double</span> newSampleRate);</div>

  223. <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;</div>

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

  225. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">    * UI Callbacks (optional) */</span></div>

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

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

  228. <div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment">      TODO: Document this.</span></div>

  229. <div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment">    */</span></div>

  230. <div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="classUI.html#aa320b8d3e826394dad9f7c36692f9b6c">  141</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classUI.html#aa320b8d3e826394dad9f7c36692f9b6c">d_uiIdle</a>() {}</div>

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

  232. <div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment">   /**</span></div>

  233. <div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment">      File browser selected function.</span></div>

  234. <div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment">      @see Window::fileBrowserSelected(const char*)</span></div>

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

  236. <div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classUI.html#ab10300e34b40d6b447b1213813f474c0">d_uiFileBrowserSelected</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* filename);</div>

  237. <div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"></span></div>

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

  239. <div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment">      OpenGL window reshape function, called when parent window is resized.</span></div>

  240. <div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment">      You can reimplement this function for a custom OpenGL state.</span></div>

  241. <div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment">      @see Window::onReshape(uint,uint)</span></div>

  242. <div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment">    */</span></div>

  243. <div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classUI.html#aaf729415450434ad6690db93fd936bbf">d_uiReshape</a>(uint width, uint height);</div>

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

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

  246. <div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">    * UI Resize Handling, internal */</span></div>

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

  248. <div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment">   /**</span></div>

  249. <div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">      OpenGL widget resize function, called when the widget is resized.</span></div>

  250. <div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment">      This is overriden here so the host knows when the UI is resized by you.</span></div>

  251. <div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment">      @see Widget::onResize(const ResizeEvent&amp;)</span></div>

  252. <div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment">    */</span></div>

  253. <div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classUI.html#a8de15be030bbdf0eb81461349cb1cc77">onResize</a>(<span class="keyword">const</span> ResizeEvent&amp; ev) <span class="keyword">override</span>;</div>

  254. <div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;</div>

  255. <div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;    <span class="comment">// -------------------------------------------------------------------------------------------------------</span></div>

  256. <div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;</div>

  257. <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="keyword">private</span>:</div>

  258. <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;    <span class="keyword">struct </span>PrivateData;</div>

  259. <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    PrivateData* <span class="keyword">const</span> pData;</div>

  260. <div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span>UIExporter;</div>

  261. <div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span>UIExporterWindow;</div>

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

  263. <div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;    <span class="comment">// these should not be used</span></div>

  264. <div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;    <span class="keywordtype">void</span> setAbsoluteX(<span class="keywordtype">int</span>) const noexcept {}</div>

  265. <div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;    <span class="keywordtype">void</span> setAbsoluteY(<span class="keywordtype">int</span>) const noexcept {}</div>

  266. <div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;    <span class="keywordtype">void</span> setAbsolutePos(<span class="keywordtype">int</span>, <span class="keywordtype">int</span>) const noexcept {}</div>

  267. <div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;    <span class="keywordtype">void</span> setAbsolutePos(<span class="keyword">const</span> DGL::Point&lt;int&gt;&amp;) const noexcept {}</div>

  268. <div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;    <span class="keywordtype">void</span> setNeedsFullViewport(<span class="keywordtype">bool</span>) const noexcept {}</div>

  269. <div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;</div>

  270. <div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;    DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classUI.html">UI</a>)</div>

  271. <div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;};</div>

  272. <div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;</div>

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

  274. <div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="comment"> * Create UI, entry point */</span></div>

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

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

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

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

  279. <div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="keyword">extern</span> <a class="code" href="classUI.html">UI</a>* createUI();</div>

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

  281. <div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment">// -----------------------------------------------------------------------------------------------------------</span></div>

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

  283. <div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;END_NAMESPACE_DISTRHO</div>

  284. <div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;</div>

  285. <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="preprocessor">#endif // DISTRHO_UI_HPP_INCLUDED</span></div>

  286. <div class="ttc" id="classUI_html_a18f4b84a973405fc098e69047e0d1994"><div class="ttname"><a href="classUI.html#a18f4b84a973405fc098e69047e0d1994">UI::d_sampleRateChanged</a></div><div class="ttdeci">virtual void d_sampleRateChanged(double newSampleRate)</div></div>

  287. <div class="ttc" id="classUI_html_a8de15be030bbdf0eb81461349cb1cc77"><div class="ttname"><a href="classUI.html#a8de15be030bbdf0eb81461349cb1cc77">UI::onResize</a></div><div class="ttdeci">void onResize(const ResizeEvent &amp;ev) override</div></div>

  288. <div class="ttc" id="classUI_html_a47e7b6111faba049dfee4738d067cc42"><div class="ttname"><a href="classUI.html#a47e7b6111faba049dfee4738d067cc42">UI::~UI</a></div><div class="ttdeci">virtual ~UI()</div></div>

  289. <div class="ttc" id="classUI_html_a7f508ebffec7a5168b532ccb9d81df70"><div class="ttname"><a href="classUI.html#a7f508ebffec7a5168b532ccb9d81df70">UI::d_stateChanged</a></div><div class="ttdeci">virtual void d_stateChanged(const char *key, const char *value)=0</div></div>

  290. <div class="ttc" id="classUI_html_a5393f505fc8702905c15c70c9fcf0d48"><div class="ttname"><a href="classUI.html#a5393f505fc8702905c15c70c9fcf0d48">UI::d_getPluginInstancePointer</a></div><div class="ttdeci">void * d_getPluginInstancePointer() const noexcept</div></div>

  291. <div class="ttc" id="classUI_html_a9599da33720f4648e9ce78cc18249b07"><div class="ttname"><a href="classUI.html#a9599da33720f4648e9ce78cc18249b07">UI::d_parameterChanged</a></div><div class="ttdeci">virtual void d_parameterChanged(uint32_t index, float value)=0</div></div>

  292. <div class="ttc" id="classUI_html_ab10300e34b40d6b447b1213813f474c0"><div class="ttname"><a href="classUI.html#ab10300e34b40d6b447b1213813f474c0">UI::d_uiFileBrowserSelected</a></div><div class="ttdeci">virtual void d_uiFileBrowserSelected(const char *filename)</div></div>

  293. <div class="ttc" id="classUI_html_ac32cb7fd88c642eadebf64137acd910e"><div class="ttname"><a href="classUI.html#ac32cb7fd88c642eadebf64137acd910e">UI::d_setState</a></div><div class="ttdeci">void d_setState(const char *const key, const char *const value)</div></div>

  294. <div class="ttc" id="classUI_html_a7d703d2caff4765f270686b8428a2fa0"><div class="ttname"><a href="classUI.html#a7d703d2caff4765f270686b8428a2fa0">UI::d_programChanged</a></div><div class="ttdeci">virtual void d_programChanged(uint32_t index)=0</div></div>

  295. <div class="ttc" id="classUI_html_ad3425075e4a23234a8568d1893b54f22"><div class="ttname"><a href="classUI.html#ad3425075e4a23234a8568d1893b54f22">UI::UI</a></div><div class="ttdeci">UI(uint width=0, uint height=0)</div></div>

  296. <div class="ttc" id="classUI_html_aa320b8d3e826394dad9f7c36692f9b6c"><div class="ttname"><a href="classUI.html#aa320b8d3e826394dad9f7c36692f9b6c">UI::d_uiIdle</a></div><div class="ttdeci">virtual void d_uiIdle()</div><div class="ttdef"><b>Definition:</b> DistrhoUI.hpp:141</div></div>

  297. <div class="ttc" id="classUI_html_a621c381126d8e2f0124199b82cdcd456"><div class="ttname"><a href="classUI.html#a621c381126d8e2f0124199b82cdcd456">UI::d_sendNote</a></div><div class="ttdeci">void d_sendNote(const uint8_t channel, const uint8_t note, const uint8_t velocity)</div></div>

  298. <div class="ttc" id="classUI_html_a768b898d1e063d5c0112197b99ccba99"><div class="ttname"><a href="classUI.html#a768b898d1e063d5c0112197b99ccba99">UI::d_editParameter</a></div><div class="ttdeci">void d_editParameter(const uint32_t index, const bool started)</div></div>

  299. <div class="ttc" id="classUI_html"><div class="ttname"><a href="classUI.html">UI</a></div><div class="ttdef"><b>Definition:</b> DistrhoUI.hpp:43</div></div>

  300. <div class="ttc" id="classUI_html_ab6cbe4dcade92f7f49d4405e51ee639c"><div class="ttname"><a href="classUI.html#ab6cbe4dcade92f7f49d4405e51ee639c">UI::d_getSampleRate</a></div><div class="ttdeci">double d_getSampleRate() const noexcept</div></div>

  301. <div class="ttc" id="classUI_html_a310a08018194f82937ca92bed4e77f1f"><div class="ttname"><a href="classUI.html#a310a08018194f82937ca92bed4e77f1f">UI::d_setParameterValue</a></div><div class="ttdeci">void d_setParameterValue(const uint32_t index, const float value)</div></div>

  302. <div class="ttc" id="classUI_html_aaf729415450434ad6690db93fd936bbf"><div class="ttname"><a href="classUI.html#aaf729415450434ad6690db93fd936bbf">UI::d_uiReshape</a></div><div class="ttdeci">virtual void d_uiReshape(uint width, uint height)</div></div>

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

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

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

  306. Generated on Tue Apr 21 2015 15:18:54 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  307. <img class="footer" src="doxygen.png" alt="doxygen"/>

  308. </a> 1.8.8

  309. </small></address>

  310. </body>

  311. </html>