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.

612 lines
27KB

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