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.

616 lines
26KB

  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.9.1"/>
  7. <title>DISTRHO Plugin Framework: UI Class Reference</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/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td style="padding-left: 0.5em;">
  26. <div id="projectname">DISTRHO Plugin Framework
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.9.1 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. </div><!-- top -->
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#pub-methods">Public Member Functions</a> &#124;
  86. <a href="#pro-methods">Protected Member Functions</a> &#124;
  87. <a href="#friends">Friends</a> &#124;
  88. <a href="classUI-members.html">List of all members</a> </div>
  89. <div class="headertitle">
  90. <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>
  91. </div><!--header-->
  92. <div class="contents">
  93. <p><code>#include &lt;<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a>&gt;</code></p>
  94. <div class="dynheader">
  95. Inheritance diagram for UI:</div>
  96. <div class="dyncontent">
  97. <div class="center">
  98. <img src="classUI.png" usemap="#UI_map" alt=""/>
  99. <map id="UI_map" name="UI_map">
  100. </map>
  101. </div></div>
  102. <table class="memberdecls">
  103. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  104. Public Member Functions</h2></td></tr>
  105. <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>
  106. <tr class="separator:ad3425075e4a23234a8568d1893b54f22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <tr class="separator:a47e7b6111faba049dfee4738d067cc42"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <tr class="separator:a97d880182254652f94e7bed355370c07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <tr class="separator:a2efcd4f21af0470e91fb6a342d7667a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:a973db6e8805f0aa9be3457685564ab8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <tr class="separator:abc94a38afa658849f3fdfd66cd8f5f51"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="separator:a9d630b2b1696e01015d869a5b434eb6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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>
  120. <tr class="separator:a0863a8f7ca7fc7e172e703c58518329f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  123. Protected Member Functions</h2></td></tr>
  124. <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>
  125. <tr class="separator:ab3086d302a9685b25abf144ade3e88f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="separator:a2f043dd1b2e179248a19918c5483cfae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="separator:a1bdc7e158d974e82f0535f1658d66575"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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>
  131. <tr class="separator:ac3e98726ca71f95a1e6c867706ebd9be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:af8de639088f3b2d42c266a2d2d6719da"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#af8de639088f3b2d42c266a2d2d6719da">uiIdle</a> ()</td></tr>
  133. <tr class="separator:af8de639088f3b2d42c266a2d2d6719da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a6d4697296129d3a6bc34fc810d6297ac"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a6d4697296129d3a6bc34fc810d6297ac">uiFileBrowserSelected</a> (const char *filename)</td></tr>
  135. <tr class="separator:a6d4697296129d3a6bc34fc810d6297ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:ab6861389e1bb01268a189dadbeb4fbcc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ab6861389e1bb01268a189dadbeb4fbcc">uiReshape</a> (uint width, uint height)</td></tr>
  137. <tr class="separator:ab6861389e1bb01268a189dadbeb4fbcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a8de15be030bbdf0eb81461349cb1cc77"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a8de15be030bbdf0eb81461349cb1cc77">onResize</a> (const ResizeEvent &amp;ev) override</td></tr>
  139. <tr class="separator:a8de15be030bbdf0eb81461349cb1cc77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. </table><table class="memberdecls">
  141. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  142. Friends</h2></td></tr>
  143. <tr class="memitem:aaf9db2e4a604d26b79f28734659b7409"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf9db2e4a604d26b79f28734659b7409"></a>
  144. class&#160;</td><td class="memItemRight" valign="bottom"><b>UIExporter</b></td></tr>
  145. <tr class="separator:aaf9db2e4a604d26b79f28734659b7409"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a09076cbeb5a44f946ba377c83859bfd3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09076cbeb5a44f946ba377c83859bfd3"></a>
  147. class&#160;</td><td class="memItemRight" valign="bottom"><b>UIExporterWindow</b></td></tr>
  148. <tr class="separator:a09076cbeb5a44f946ba377c83859bfd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. </table>
  150. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  151. <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>
  152. <p>TODO.</p>
  153. <p>must call setSize during construction, </p>
  154. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  155. <a class="anchor" id="ad3425075e4a23234a8568d1893b54f22"></a>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">UI::UI </td>
  161. <td>(</td>
  162. <td class="paramtype">uint&#160;</td>
  163. <td class="paramname"><em>width</em> = <code>0</code>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype">uint&#160;</td>
  169. <td class="paramname"><em>height</em> = <code>0</code>&#160;</td>
  170. </tr>
  171. <tr>
  172. <td></td>
  173. <td>)</td>
  174. <td></td><td></td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. <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>
  179. </div>
  180. </div>
  181. <a class="anchor" id="a47e7b6111faba049dfee4738d067cc42"></a>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="mlabels">
  185. <tr>
  186. <td class="mlabels-left">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">virtual UI::~UI </td>
  190. <td>(</td>
  191. <td class="paramname"></td><td>)</td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </td>
  196. <td class="mlabels-right">
  197. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>Destructor. </p>
  202. </div>
  203. </div>
  204. <h2 class="groupheader">Member Function Documentation</h2>
  205. <a class="anchor" id="a97d880182254652f94e7bed355370c07"></a>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="mlabels">
  209. <tr>
  210. <td class="mlabels-left">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">double UI::getSampleRate </td>
  214. <td>(</td>
  215. <td class="paramname"></td><td>)</td>
  216. <td> const</td>
  217. </tr>
  218. </table>
  219. </td>
  220. <td class="mlabels-right">
  221. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <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>
  226. </div>
  227. </div>
  228. <a class="anchor" id="a2efcd4f21af0470e91fb6a342d7667a0"></a>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">void UI::editParameter </td>
  234. <td>(</td>
  235. <td class="paramtype">uint32_t&#160;</td>
  236. <td class="paramname"><em>index</em>, </td>
  237. </tr>
  238. <tr>
  239. <td class="paramkey"></td>
  240. <td></td>
  241. <td class="paramtype">bool&#160;</td>
  242. <td class="paramname"><em>started</em>&#160;</td>
  243. </tr>
  244. <tr>
  245. <td></td>
  246. <td>)</td>
  247. <td></td><td></td>
  248. </tr>
  249. </table>
  250. </div><div class="memdoc">
  251. <p>TODO: Document this. </p>
  252. </div>
  253. </div>
  254. <a class="anchor" id="a973db6e8805f0aa9be3457685564ab8a"></a>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname">void UI::setParameterValue </td>
  260. <td>(</td>
  261. <td class="paramtype">uint32_t&#160;</td>
  262. <td class="paramname"><em>index</em>, </td>
  263. </tr>
  264. <tr>
  265. <td class="paramkey"></td>
  266. <td></td>
  267. <td class="paramtype">float&#160;</td>
  268. <td class="paramname"><em>value</em>&#160;</td>
  269. </tr>
  270. <tr>
  271. <td></td>
  272. <td>)</td>
  273. <td></td><td></td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. <p>TODO: Document this. </p>
  278. </div>
  279. </div>
  280. <a class="anchor" id="abc94a38afa658849f3fdfd66cd8f5f51"></a>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname">void UI::setState </td>
  286. <td>(</td>
  287. <td class="paramtype">const char *&#160;</td>
  288. <td class="paramname"><em>key</em>, </td>
  289. </tr>
  290. <tr>
  291. <td class="paramkey"></td>
  292. <td></td>
  293. <td class="paramtype">const char *&#160;</td>
  294. <td class="paramname"><em>value</em>&#160;</td>
  295. </tr>
  296. <tr>
  297. <td></td>
  298. <td>)</td>
  299. <td></td><td></td>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <p>TODO: Document this. </p>
  304. </div>
  305. </div>
  306. <a class="anchor" id="a9d630b2b1696e01015d869a5b434eb6e"></a>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">void UI::sendNote </td>
  312. <td>(</td>
  313. <td class="paramtype">uint8_t&#160;</td>
  314. <td class="paramname"><em>channel</em>, </td>
  315. </tr>
  316. <tr>
  317. <td class="paramkey"></td>
  318. <td></td>
  319. <td class="paramtype">uint8_t&#160;</td>
  320. <td class="paramname"><em>note</em>, </td>
  321. </tr>
  322. <tr>
  323. <td class="paramkey"></td>
  324. <td></td>
  325. <td class="paramtype">uint8_t&#160;</td>
  326. <td class="paramname"><em>velocity</em>&#160;</td>
  327. </tr>
  328. <tr>
  329. <td></td>
  330. <td>)</td>
  331. <td></td><td></td>
  332. </tr>
  333. </table>
  334. </div><div class="memdoc">
  335. <p>TODO: Document this. </p>
  336. </div>
  337. </div>
  338. <a class="anchor" id="a0863a8f7ca7fc7e172e703c58518329f"></a>
  339. <div class="memitem">
  340. <div class="memproto">
  341. <table class="mlabels">
  342. <tr>
  343. <td class="mlabels-left">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname">void* UI::getPluginInstancePointer </td>
  347. <td>(</td>
  348. <td class="paramname"></td><td>)</td>
  349. <td> const</td>
  350. </tr>
  351. </table>
  352. </td>
  353. <td class="mlabels-right">
  354. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  355. </tr>
  356. </table>
  357. </div><div class="memdoc">
  358. <p>TODO: Document this. </p>
  359. </div>
  360. </div>
  361. <a class="anchor" id="ab3086d302a9685b25abf144ade3e88f6"></a>
  362. <div class="memitem">
  363. <div class="memproto">
  364. <table class="mlabels">
  365. <tr>
  366. <td class="mlabels-left">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname">virtual void UI::parameterChanged </td>
  370. <td>(</td>
  371. <td class="paramtype">uint32_t&#160;</td>
  372. <td class="paramname"><em>index</em>, </td>
  373. </tr>
  374. <tr>
  375. <td class="paramkey"></td>
  376. <td></td>
  377. <td class="paramtype">float&#160;</td>
  378. <td class="paramname"><em>value</em>&#160;</td>
  379. </tr>
  380. <tr>
  381. <td></td>
  382. <td>)</td>
  383. <td></td><td></td>
  384. </tr>
  385. </table>
  386. </td>
  387. <td class="mlabels-right">
  388. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  389. </tr>
  390. </table>
  391. </div><div class="memdoc">
  392. <p>A parameter has changed on the plugin side.<br />
  393. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about parameter changes. </p>
  394. </div>
  395. </div>
  396. <a class="anchor" id="a2f043dd1b2e179248a19918c5483cfae"></a>
  397. <div class="memitem">
  398. <div class="memproto">
  399. <table class="mlabels">
  400. <tr>
  401. <td class="mlabels-left">
  402. <table class="memname">
  403. <tr>
  404. <td class="memname">virtual void UI::programLoaded </td>
  405. <td>(</td>
  406. <td class="paramtype">uint32_t&#160;</td>
  407. <td class="paramname"><em>index</em></td><td>)</td>
  408. <td></td>
  409. </tr>
  410. </table>
  411. </td>
  412. <td class="mlabels-right">
  413. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  414. </tr>
  415. </table>
  416. </div><div class="memdoc">
  417. <p>A program has been loaded on the plugin side.<br />
  418. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about program changes. </p>
  419. </div>
  420. </div>
  421. <a class="anchor" id="a1bdc7e158d974e82f0535f1658d66575"></a>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="mlabels">
  425. <tr>
  426. <td class="mlabels-left">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname">virtual void UI::stateChanged </td>
  430. <td>(</td>
  431. <td class="paramtype">const char *&#160;</td>
  432. <td class="paramname"><em>key</em>, </td>
  433. </tr>
  434. <tr>
  435. <td class="paramkey"></td>
  436. <td></td>
  437. <td class="paramtype">const char *&#160;</td>
  438. <td class="paramname"><em>value</em>&#160;</td>
  439. </tr>
  440. <tr>
  441. <td></td>
  442. <td>)</td>
  443. <td></td><td></td>
  444. </tr>
  445. </table>
  446. </td>
  447. <td class="mlabels-right">
  448. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  449. </tr>
  450. </table>
  451. </div><div class="memdoc">
  452. <p>A state has changed on the plugin side.<br />
  453. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about state changes. </p>
  454. </div>
  455. </div>
  456. <a class="anchor" id="ac3e98726ca71f95a1e6c867706ebd9be"></a>
  457. <div class="memitem">
  458. <div class="memproto">
  459. <table class="mlabels">
  460. <tr>
  461. <td class="mlabels-left">
  462. <table class="memname">
  463. <tr>
  464. <td class="memname">virtual void UI::sampleRateChanged </td>
  465. <td>(</td>
  466. <td class="paramtype">double&#160;</td>
  467. <td class="paramname"><em>newSampleRate</em></td><td>)</td>
  468. <td></td>
  469. </tr>
  470. </table>
  471. </td>
  472. <td class="mlabels-right">
  473. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  474. </tr>
  475. </table>
  476. </div><div class="memdoc">
  477. <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>
  478. </div>
  479. </div>
  480. <a class="anchor" id="af8de639088f3b2d42c266a2d2d6719da"></a>
  481. <div class="memitem">
  482. <div class="memproto">
  483. <table class="mlabels">
  484. <tr>
  485. <td class="mlabels-left">
  486. <table class="memname">
  487. <tr>
  488. <td class="memname">virtual void UI::uiIdle </td>
  489. <td>(</td>
  490. <td class="paramname"></td><td>)</td>
  491. <td></td>
  492. </tr>
  493. </table>
  494. </td>
  495. <td class="mlabels-right">
  496. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  497. </tr>
  498. </table>
  499. </div><div class="memdoc">
  500. <p>TODO: Document this. </p>
  501. </div>
  502. </div>
  503. <a class="anchor" id="a6d4697296129d3a6bc34fc810d6297ac"></a>
  504. <div class="memitem">
  505. <div class="memproto">
  506. <table class="mlabels">
  507. <tr>
  508. <td class="mlabels-left">
  509. <table class="memname">
  510. <tr>
  511. <td class="memname">virtual void UI::uiFileBrowserSelected </td>
  512. <td>(</td>
  513. <td class="paramtype">const char *&#160;</td>
  514. <td class="paramname"><em>filename</em></td><td>)</td>
  515. <td></td>
  516. </tr>
  517. </table>
  518. </td>
  519. <td class="mlabels-right">
  520. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  521. </tr>
  522. </table>
  523. </div><div class="memdoc">
  524. <p>File browser selected function. </p><dl class="section see"><dt>See also</dt><dd>Window::fileBrowserSelected(const char*) </dd></dl>
  525. </div>
  526. </div>
  527. <a class="anchor" id="ab6861389e1bb01268a189dadbeb4fbcc"></a>
  528. <div class="memitem">
  529. <div class="memproto">
  530. <table class="mlabels">
  531. <tr>
  532. <td class="mlabels-left">
  533. <table class="memname">
  534. <tr>
  535. <td class="memname">virtual void UI::uiReshape </td>
  536. <td>(</td>
  537. <td class="paramtype">uint&#160;</td>
  538. <td class="paramname"><em>width</em>, </td>
  539. </tr>
  540. <tr>
  541. <td class="paramkey"></td>
  542. <td></td>
  543. <td class="paramtype">uint&#160;</td>
  544. <td class="paramname"><em>height</em>&#160;</td>
  545. </tr>
  546. <tr>
  547. <td></td>
  548. <td>)</td>
  549. <td></td><td></td>
  550. </tr>
  551. </table>
  552. </td>
  553. <td class="mlabels-right">
  554. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  555. </tr>
  556. </table>
  557. </div><div class="memdoc">
  558. <p>OpenGL window reshape function, called when parent window is resized. You can reimplement this function for a custom OpenGL state. </p><dl class="section see"><dt>See also</dt><dd>Window::onReshape(uint,uint) </dd></dl>
  559. </div>
  560. </div>
  561. <a class="anchor" id="a8de15be030bbdf0eb81461349cb1cc77"></a>
  562. <div class="memitem">
  563. <div class="memproto">
  564. <table class="mlabels">
  565. <tr>
  566. <td class="mlabels-left">
  567. <table class="memname">
  568. <tr>
  569. <td class="memname">void UI::onResize </td>
  570. <td>(</td>
  571. <td class="paramtype">const ResizeEvent &amp;&#160;</td>
  572. <td class="paramname"><em>ev</em></td><td>)</td>
  573. <td></td>
  574. </tr>
  575. </table>
  576. </td>
  577. <td class="mlabels-right">
  578. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span></span> </td>
  579. </tr>
  580. </table>
  581. </div><div class="memdoc">
  582. <p>OpenGL widget resize function, called when the widget is resized. This is overriden here so the host knows when the <a class="el" href="classUI.html">UI</a> is resized by you. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWidget.html#acc0365ec4b9245bdffb8d0285be55dea">Widget::onResize(const ResizeEvent&amp;)</a> </dd></dl>
  583. </div>
  584. </div>
  585. <hr/>The documentation for this class was generated from the following file:<ul>
  586. <li>distrho/<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a></li>
  587. </ul>
  588. </div><!-- contents -->
  589. <!-- start footer part -->
  590. <hr class="footer"/><address class="footer"><small>
  591. Generated on Wed Jun 17 2015 11:36:22 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  592. <img class="footer" src="doxygen.png" alt="doxygen"/>
  593. </a> 1.8.9.1
  594. </small></address>
  595. </body>
  596. </html>