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.

557 lines
24KB

  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.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: UI Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">DISTRHO Plugin Framework
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.13 -->
  33. <script type="text/javascript">
  34. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  35. </script>
  36. <script type="text/javascript" src="menudata.js"></script>
  37. <script type="text/javascript" src="menu.js"></script>
  38. <script type="text/javascript">
  39. $(function() {
  40. initMenu('',true,false,'search.php','Search');
  41. $(document).ready(function() { init_search(); });
  42. });
  43. </script>
  44. <div id="main-nav"></div>
  45. <!-- window showing the filter options -->
  46. <div id="MSearchSelectWindow"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. onkeydown="return searchBox.OnSearchSelectKey(event)">
  50. </div>
  51. <!-- iframe showing the search results (closed by default) -->
  52. <div id="MSearchResultsWindow">
  53. <iframe src="javascript:void(0)" frameborder="0"
  54. name="MSearchResults" id="MSearchResults">
  55. </iframe>
  56. </div>
  57. </div><!-- top -->
  58. <div class="header">
  59. <div class="summary">
  60. <a href="#pub-methods">Public Member Functions</a> &#124;
  61. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  62. <a href="#pro-methods">Protected Member Functions</a> &#124;
  63. <a href="#friends">Friends</a> &#124;
  64. <a href="classUI-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">UI Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__MainClasses.html">Main Classes</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p><code>#include &lt;<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a>&gt;</code></p>
  70. <div class="dynheader">
  71. Inheritance diagram for UI:</div>
  72. <div class="dyncontent">
  73. <div class="center">
  74. <img src="classUI.png" usemap="#UI_map" alt=""/>
  75. <map id="UI_map" name="UI_map">
  76. </map>
  77. </div></div>
  78. <table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  80. Public Member Functions</h2></td></tr>
  81. <tr class="memitem:ad3425075e4a23234a8568d1893b54f22"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ad3425075e4a23234a8568d1893b54f22">UI</a> (uint width=0, uint height=0)</td></tr>
  82. <tr class="separator:ad3425075e4a23234a8568d1893b54f22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a47e7b6111faba049dfee4738d067cc42"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a47e7b6111faba049dfee4738d067cc42">~UI</a> ()</td></tr>
  84. <tr class="separator:a47e7b6111faba049dfee4738d067cc42"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a97d880182254652f94e7bed355370c07"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a97d880182254652f94e7bed355370c07">getSampleRate</a> () const noexcept</td></tr>
  86. <tr class="separator:a97d880182254652f94e7bed355370c07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a2efcd4f21af0470e91fb6a342d7667a0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a2efcd4f21af0470e91fb6a342d7667a0">editParameter</a> (uint32_t index, bool started)</td></tr>
  88. <tr class="separator:a2efcd4f21af0470e91fb6a342d7667a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a973db6e8805f0aa9be3457685564ab8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a973db6e8805f0aa9be3457685564ab8a">setParameterValue</a> (uint32_t index, float value)</td></tr>
  90. <tr class="separator:a973db6e8805f0aa9be3457685564ab8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:abc94a38afa658849f3fdfd66cd8f5f51"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#abc94a38afa658849f3fdfd66cd8f5f51">setState</a> (const char *key, const char *value)</td></tr>
  92. <tr class="separator:abc94a38afa658849f3fdfd66cd8f5f51"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a9d630b2b1696e01015d869a5b434eb6e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a9d630b2b1696e01015d869a5b434eb6e">sendNote</a> (uint8_t channel, uint8_t note, uint8_t velocity)</td></tr>
  94. <tr class="separator:a9d630b2b1696e01015d869a5b434eb6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a0863a8f7ca7fc7e172e703c58518329f"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a0863a8f7ca7fc7e172e703c58518329f">getPluginInstancePointer</a> () const noexcept</td></tr>
  96. <tr class="separator:a0863a8f7ca7fc7e172e703c58518329f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table><table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  99. Static Public Member Functions</h2></td></tr>
  100. <tr class="memitem:ab157329c83a4660dd059508dc8d041f5"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ab157329c83a4660dd059508dc8d041f5">getNextBundlePath</a> () noexcept</td></tr>
  101. <tr class="separator:ab157329c83a4660dd059508dc8d041f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a4630e30aec3f3e7dcfc353ef2807bf56"><td class="memItemLeft" align="right" valign="top">static uintptr_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a4630e30aec3f3e7dcfc353ef2807bf56">getNextWindowId</a> () noexcept</td></tr>
  103. <tr class="separator:a4630e30aec3f3e7dcfc353ef2807bf56"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table><table class="memberdecls">
  105. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  106. Protected Member Functions</h2></td></tr>
  107. <tr class="memitem:ab3086d302a9685b25abf144ade3e88f6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ab3086d302a9685b25abf144ade3e88f6">parameterChanged</a> (uint32_t index, float value)=0</td></tr>
  108. <tr class="separator:ab3086d302a9685b25abf144ade3e88f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a2f043dd1b2e179248a19918c5483cfae"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a2f043dd1b2e179248a19918c5483cfae">programLoaded</a> (uint32_t index)=0</td></tr>
  110. <tr class="separator:a2f043dd1b2e179248a19918c5483cfae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a1bdc7e158d974e82f0535f1658d66575"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a1bdc7e158d974e82f0535f1658d66575">stateChanged</a> (const char *key, const char *value)=0</td></tr>
  112. <tr class="separator:a1bdc7e158d974e82f0535f1658d66575"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:ac3e98726ca71f95a1e6c867706ebd9be"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ac3e98726ca71f95a1e6c867706ebd9be">sampleRateChanged</a> (double newSampleRate)</td></tr>
  114. <tr class="separator:ac3e98726ca71f95a1e6c867706ebd9be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table><table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  117. Friends</h2></td></tr>
  118. <tr class="memitem:aaf9db2e4a604d26b79f28734659b7409"><td class="memItemLeft" align="right" valign="top"><a id="aaf9db2e4a604d26b79f28734659b7409"></a>
  119. class&#160;</td><td class="memItemRight" valign="bottom"><b>UIExporter</b></td></tr>
  120. <tr class="separator:aaf9db2e4a604d26b79f28734659b7409"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a09076cbeb5a44f946ba377c83859bfd3"><td class="memItemLeft" align="right" valign="top"><a id="a09076cbeb5a44f946ba377c83859bfd3"></a>
  122. class&#160;</td><td class="memItemRight" valign="bottom"><b>UIExporterWindow</b></td></tr>
  123. <tr class="separator:a09076cbeb5a44f946ba377c83859bfd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. </table>
  125. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  126. <div class="textblock"><p>DPF <a class="el" href="classUI.html">UI</a> class from where <a class="el" href="classUI.html">UI</a> instances are created.</p>
  127. <dl class="section note"><dt>Note</dt><dd>You must call setSize during construction, Detailed information about this class. </dd></dl>
  128. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  129. <a id="ad3425075e4a23234a8568d1893b54f22"></a>
  130. <h2 class="memtitle"><span class="permalink"><a href="#ad3425075e4a23234a8568d1893b54f22">&#9670;&nbsp;</a></span>UI()</h2>
  131. <div class="memitem">
  132. <div class="memproto">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">UI::UI </td>
  136. <td>(</td>
  137. <td class="paramtype">uint&#160;</td>
  138. <td class="paramname"><em>width</em> = <code>0</code>, </td>
  139. </tr>
  140. <tr>
  141. <td class="paramkey"></td>
  142. <td></td>
  143. <td class="paramtype">uint&#160;</td>
  144. <td class="paramname"><em>height</em> = <code>0</code>&#160;</td>
  145. </tr>
  146. <tr>
  147. <td></td>
  148. <td>)</td>
  149. <td></td><td></td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <p><a class="el" href="classUI.html">UI</a> class constructor. The <a class="el" href="classUI.html">UI</a> should be initialized to a default state that matches the plugin side. </p>
  154. </div>
  155. </div>
  156. <a id="a47e7b6111faba049dfee4738d067cc42"></a>
  157. <h2 class="memtitle"><span class="permalink"><a href="#a47e7b6111faba049dfee4738d067cc42">&#9670;&nbsp;</a></span>~UI()</h2>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="mlabels">
  161. <tr>
  162. <td class="mlabels-left">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">virtual UI::~UI </td>
  166. <td>(</td>
  167. <td class="paramname"></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </td>
  172. <td class="mlabels-right">
  173. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>Destructor. </p>
  178. </div>
  179. </div>
  180. <h2 class="groupheader">Member Function Documentation</h2>
  181. <a id="a97d880182254652f94e7bed355370c07"></a>
  182. <h2 class="memtitle"><span class="permalink"><a href="#a97d880182254652f94e7bed355370c07">&#9670;&nbsp;</a></span>getSampleRate()</h2>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="mlabels">
  186. <tr>
  187. <td class="mlabels-left">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">double UI::getSampleRate </td>
  191. <td>(</td>
  192. <td class="paramname"></td><td>)</td>
  193. <td> const</td>
  194. </tr>
  195. </table>
  196. </td>
  197. <td class="mlabels-right">
  198. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Get the current sample rate used in plugin processing. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classUI.html#ac3e98726ca71f95a1e6c867706ebd9be">sampleRateChanged(double)</a> </dd></dl>
  203. </div>
  204. </div>
  205. <a id="a2efcd4f21af0470e91fb6a342d7667a0"></a>
  206. <h2 class="memtitle"><span class="permalink"><a href="#a2efcd4f21af0470e91fb6a342d7667a0">&#9670;&nbsp;</a></span>editParameter()</h2>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">void UI::editParameter </td>
  212. <td>(</td>
  213. <td class="paramtype">uint32_t&#160;</td>
  214. <td class="paramname"><em>index</em>, </td>
  215. </tr>
  216. <tr>
  217. <td class="paramkey"></td>
  218. <td></td>
  219. <td class="paramtype">bool&#160;</td>
  220. <td class="paramname"><em>started</em>&#160;</td>
  221. </tr>
  222. <tr>
  223. <td></td>
  224. <td>)</td>
  225. <td></td><td></td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. <p>editParameter. Document this. </p>
  230. </div>
  231. </div>
  232. <a id="a973db6e8805f0aa9be3457685564ab8a"></a>
  233. <h2 class="memtitle"><span class="permalink"><a href="#a973db6e8805f0aa9be3457685564ab8a">&#9670;&nbsp;</a></span>setParameterValue()</h2>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">void UI::setParameterValue </td>
  239. <td>(</td>
  240. <td class="paramtype">uint32_t&#160;</td>
  241. <td class="paramname"><em>index</em>, </td>
  242. </tr>
  243. <tr>
  244. <td class="paramkey"></td>
  245. <td></td>
  246. <td class="paramtype">float&#160;</td>
  247. <td class="paramname"><em>value</em>&#160;</td>
  248. </tr>
  249. <tr>
  250. <td></td>
  251. <td>)</td>
  252. <td></td><td></td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. <p>setParameterValue. Document this. </p>
  257. </div>
  258. </div>
  259. <a id="abc94a38afa658849f3fdfd66cd8f5f51"></a>
  260. <h2 class="memtitle"><span class="permalink"><a href="#abc94a38afa658849f3fdfd66cd8f5f51">&#9670;&nbsp;</a></span>setState()</h2>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname">void UI::setState </td>
  266. <td>(</td>
  267. <td class="paramtype">const char *&#160;</td>
  268. <td class="paramname"><em>key</em>, </td>
  269. </tr>
  270. <tr>
  271. <td class="paramkey"></td>
  272. <td></td>
  273. <td class="paramtype">const char *&#160;</td>
  274. <td class="paramname"><em>value</em>&#160;</td>
  275. </tr>
  276. <tr>
  277. <td></td>
  278. <td>)</td>
  279. <td></td><td></td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <p>setState. Document this. </p>
  284. </div>
  285. </div>
  286. <a id="a9d630b2b1696e01015d869a5b434eb6e"></a>
  287. <h2 class="memtitle"><span class="permalink"><a href="#a9d630b2b1696e01015d869a5b434eb6e">&#9670;&nbsp;</a></span>sendNote()</h2>
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">void UI::sendNote </td>
  293. <td>(</td>
  294. <td class="paramtype">uint8_t&#160;</td>
  295. <td class="paramname"><em>channel</em>, </td>
  296. </tr>
  297. <tr>
  298. <td class="paramkey"></td>
  299. <td></td>
  300. <td class="paramtype">uint8_t&#160;</td>
  301. <td class="paramname"><em>note</em>, </td>
  302. </tr>
  303. <tr>
  304. <td class="paramkey"></td>
  305. <td></td>
  306. <td class="paramtype">uint8_t&#160;</td>
  307. <td class="paramname"><em>velocity</em>&#160;</td>
  308. </tr>
  309. <tr>
  310. <td></td>
  311. <td>)</td>
  312. <td></td><td></td>
  313. </tr>
  314. </table>
  315. </div><div class="memdoc">
  316. <p>sendNote. Document this. </p><dl class="section note"><dt>Note</dt><dd>Work in progress. Implemented for DSSI and LV2 formats. </dd></dl>
  317. </div>
  318. </div>
  319. <a id="a0863a8f7ca7fc7e172e703c58518329f"></a>
  320. <h2 class="memtitle"><span class="permalink"><a href="#a0863a8f7ca7fc7e172e703c58518329f">&#9670;&nbsp;</a></span>getPluginInstancePointer()</h2>
  321. <div class="memitem">
  322. <div class="memproto">
  323. <table class="mlabels">
  324. <tr>
  325. <td class="mlabels-left">
  326. <table class="memname">
  327. <tr>
  328. <td class="memname">void* UI::getPluginInstancePointer </td>
  329. <td>(</td>
  330. <td class="paramname"></td><td>)</td>
  331. <td> const</td>
  332. </tr>
  333. </table>
  334. </td>
  335. <td class="mlabels-right">
  336. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  337. </tr>
  338. </table>
  339. </div><div class="memdoc">
  340. <p>getPluginInstancePointer. Document this. </p>
  341. </div>
  342. </div>
  343. <a id="ab157329c83a4660dd059508dc8d041f5"></a>
  344. <h2 class="memtitle"><span class="permalink"><a href="#ab157329c83a4660dd059508dc8d041f5">&#9670;&nbsp;</a></span>getNextBundlePath()</h2>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="mlabels">
  348. <tr>
  349. <td class="mlabels-left">
  350. <table class="memname">
  351. <tr>
  352. <td class="memname">static const char* UI::getNextBundlePath </td>
  353. <td>(</td>
  354. <td class="paramname"></td><td>)</td>
  355. <td></td>
  356. </tr>
  357. </table>
  358. </td>
  359. <td class="mlabels-right">
  360. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
  361. </tr>
  362. </table>
  363. </div><div class="memdoc">
  364. <p>Get the bundle path that will be used for the next <a class="el" href="classUI.html">UI</a>. </p><dl class="section note"><dt>Note</dt><dd>: This function is only valid during <a class="el" href="group__EntryPoints.html#gaad0ced21537a067680729bee6a65d8c8">createUI()</a>, it will return null when called from anywhere else. </dd></dl>
  365. </div>
  366. </div>
  367. <a id="a4630e30aec3f3e7dcfc353ef2807bf56"></a>
  368. <h2 class="memtitle"><span class="permalink"><a href="#a4630e30aec3f3e7dcfc353ef2807bf56">&#9670;&nbsp;</a></span>getNextWindowId()</h2>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="mlabels">
  372. <tr>
  373. <td class="mlabels-left">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname">static uintptr_t UI::getNextWindowId </td>
  377. <td>(</td>
  378. <td class="paramname"></td><td>)</td>
  379. <td></td>
  380. </tr>
  381. </table>
  382. </td>
  383. <td class="mlabels-right">
  384. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <p>Get the <a class="el" href="classWindow.html">Window</a> Id that will be used for the next created window. </p><dl class="section note"><dt>Note</dt><dd>: This function is only valid during <a class="el" href="group__EntryPoints.html#gaad0ced21537a067680729bee6a65d8c8">createUI()</a>, it will return 0 when called from anywhere else. </dd></dl>
  389. </div>
  390. </div>
  391. <a id="ab3086d302a9685b25abf144ade3e88f6"></a>
  392. <h2 class="memtitle"><span class="permalink"><a href="#ab3086d302a9685b25abf144ade3e88f6">&#9670;&nbsp;</a></span>parameterChanged()</h2>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="mlabels">
  396. <tr>
  397. <td class="mlabels-left">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname">virtual void UI::parameterChanged </td>
  401. <td>(</td>
  402. <td class="paramtype">uint32_t&#160;</td>
  403. <td class="paramname"><em>index</em>, </td>
  404. </tr>
  405. <tr>
  406. <td class="paramkey"></td>
  407. <td></td>
  408. <td class="paramtype">float&#160;</td>
  409. <td class="paramname"><em>value</em>&#160;</td>
  410. </tr>
  411. <tr>
  412. <td></td>
  413. <td>)</td>
  414. <td></td><td></td>
  415. </tr>
  416. </table>
  417. </td>
  418. <td class="mlabels-right">
  419. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  420. </tr>
  421. </table>
  422. </div><div class="memdoc">
  423. <p>A parameter has changed on the plugin side.<br />
  424. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about parameter changes. </p>
  425. </div>
  426. </div>
  427. <a id="a2f043dd1b2e179248a19918c5483cfae"></a>
  428. <h2 class="memtitle"><span class="permalink"><a href="#a2f043dd1b2e179248a19918c5483cfae">&#9670;&nbsp;</a></span>programLoaded()</h2>
  429. <div class="memitem">
  430. <div class="memproto">
  431. <table class="mlabels">
  432. <tr>
  433. <td class="mlabels-left">
  434. <table class="memname">
  435. <tr>
  436. <td class="memname">virtual void UI::programLoaded </td>
  437. <td>(</td>
  438. <td class="paramtype">uint32_t&#160;</td>
  439. <td class="paramname"><em>index</em></td><td>)</td>
  440. <td></td>
  441. </tr>
  442. </table>
  443. </td>
  444. <td class="mlabels-right">
  445. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  446. </tr>
  447. </table>
  448. </div><div class="memdoc">
  449. <p>A program has been loaded on the plugin side.<br />
  450. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about program changes. </p>
  451. </div>
  452. </div>
  453. <a id="a1bdc7e158d974e82f0535f1658d66575"></a>
  454. <h2 class="memtitle"><span class="permalink"><a href="#a1bdc7e158d974e82f0535f1658d66575">&#9670;&nbsp;</a></span>stateChanged()</h2>
  455. <div class="memitem">
  456. <div class="memproto">
  457. <table class="mlabels">
  458. <tr>
  459. <td class="mlabels-left">
  460. <table class="memname">
  461. <tr>
  462. <td class="memname">virtual void UI::stateChanged </td>
  463. <td>(</td>
  464. <td class="paramtype">const char *&#160;</td>
  465. <td class="paramname"><em>key</em>, </td>
  466. </tr>
  467. <tr>
  468. <td class="paramkey"></td>
  469. <td></td>
  470. <td class="paramtype">const char *&#160;</td>
  471. <td class="paramname"><em>value</em>&#160;</td>
  472. </tr>
  473. <tr>
  474. <td></td>
  475. <td>)</td>
  476. <td></td><td></td>
  477. </tr>
  478. </table>
  479. </td>
  480. <td class="mlabels-right">
  481. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  482. </tr>
  483. </table>
  484. </div><div class="memdoc">
  485. <p>A state has changed on the plugin side.<br />
  486. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about state changes. </p>
  487. </div>
  488. </div>
  489. <a id="ac3e98726ca71f95a1e6c867706ebd9be"></a>
  490. <h2 class="memtitle"><span class="permalink"><a href="#ac3e98726ca71f95a1e6c867706ebd9be">&#9670;&nbsp;</a></span>sampleRateChanged()</h2>
  491. <div class="memitem">
  492. <div class="memproto">
  493. <table class="mlabels">
  494. <tr>
  495. <td class="mlabels-left">
  496. <table class="memname">
  497. <tr>
  498. <td class="memname">virtual void UI::sampleRateChanged </td>
  499. <td>(</td>
  500. <td class="paramtype">double&#160;</td>
  501. <td class="paramname"><em>newSampleRate</em></td><td>)</td>
  502. <td></td>
  503. </tr>
  504. </table>
  505. </td>
  506. <td class="mlabels-right">
  507. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  508. </tr>
  509. </table>
  510. </div><div class="memdoc">
  511. <p>Optional callback to inform the <a class="el" href="classUI.html">UI</a> about a sample rate change on the plugin side. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classUI.html#a97d880182254652f94e7bed355370c07">getSampleRate()</a> </dd></dl>
  512. </div>
  513. </div>
  514. <hr/>The documentation for this class was generated from the following file:<ul>
  515. <li>distrho/<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a></li>
  516. </ul>
  517. </div><!-- contents -->
  518. <!-- start footer part -->
  519. <hr class="footer"/><address class="footer"><small>
  520. Generated on Sun Apr 7 2019 05:47:58 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  521. <img class="footer" src="doxygen.png" alt="doxygen"/>
  522. </a> 1.8.13
  523. </small></address>
  524. </body>
  525. </html>