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.
388 Commits
7 Branches
52MB
Tree: e3626bbcdf
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e3626bbcdf'
${ noResults }
DPF/classUI.html

682 lines
30KB
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.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. 

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

  53. <div id="MSearchResultsWindow">

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

  55.         name="MSearchResults" id="MSearchResults">

  56. </iframe>

  57. </div>

  58. 

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

  60. <div class="header">

  61.   <div class="summary">

  62. <a href="#pub-methods">Public Member Functions</a> &#124;

  63. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;

  64. <a href="#pro-methods">Protected Member Functions</a> &#124;

  65. <a href="#friends">Friends</a> &#124;

  66. <a href="classUI-members.html">List of all members</a>  </div>

  67.   <div class="headertitle">

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

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

  70. <div class="contents">

  71. 

  72. <p><code>#include &lt;<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a>&gt;</code></p>

  73. <div class="dynheader">

  74. Inheritance diagram for UI:</div>

  75. <div class="dyncontent">

  76.  <div class="center">

  77.   <img src="classUI.png" usemap="#UI_map" alt=""/>

  78.   <map id="UI_map" name="UI_map">

  79. </map>

  80.  </div></div>

  81. <table class="memberdecls">

  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  83. Public Member Functions</h2></td></tr>

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

  85. <tr class="separator:ad3425075e4a23234a8568d1893b54f22"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  87. <tr class="separator:a47e7b6111faba049dfee4738d067cc42"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  89. <tr class="separator:a97d880182254652f94e7bed355370c07"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  91. <tr class="separator:a2efcd4f21af0470e91fb6a342d7667a0"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  93. <tr class="separator:a973db6e8805f0aa9be3457685564ab8a"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  95. <tr class="separator:abc94a38afa658849f3fdfd66cd8f5f51"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  97. <tr class="separator:a9d630b2b1696e01015d869a5b434eb6e"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  99. <tr class="separator:a0863a8f7ca7fc7e172e703c58518329f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  100. </table><table class="memberdecls">

  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>

  102. Static Public Member Functions</h2></td></tr>

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

  104. <tr class="separator:ab157329c83a4660dd059508dc8d041f5"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  106. <tr class="separator:a4630e30aec3f3e7dcfc353ef2807bf56"><td class="memSeparator" colspan="2">&#160;</td></tr>

  107. </table><table class="memberdecls">

  108. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>

  109. Protected Member Functions</h2></td></tr>

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

  111. <tr class="separator:ab3086d302a9685b25abf144ade3e88f6"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  113. <tr class="separator:a2f043dd1b2e179248a19918c5483cfae"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  115. <tr class="separator:a1bdc7e158d974e82f0535f1658d66575"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  117. <tr class="separator:ac3e98726ca71f95a1e6c867706ebd9be"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  119. <tr class="separator:af8de639088f3b2d42c266a2d2d6719da"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  121. <tr class="separator:a6d4697296129d3a6bc34fc810d6297ac"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  123. <tr class="separator:ab6861389e1bb01268a189dadbeb4fbcc"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  125. <tr class="separator:a8de15be030bbdf0eb81461349cb1cc77"><td class="memSeparator" colspan="2">&#160;</td></tr>

  126. </table><table class="memberdecls">

  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>

  128. Friends</h2></td></tr>

  129. <tr class="memitem:aaf9db2e4a604d26b79f28734659b7409"><td class="memItemLeft" align="right" valign="top"><a id="aaf9db2e4a604d26b79f28734659b7409"></a>

  130. class&#160;</td><td class="memItemRight" valign="bottom"><b>UIExporter</b></td></tr>

  131. <tr class="separator:aaf9db2e4a604d26b79f28734659b7409"><td class="memSeparator" colspan="2">&#160;</td></tr>

  132. <tr class="memitem:a09076cbeb5a44f946ba377c83859bfd3"><td class="memItemLeft" align="right" valign="top"><a id="a09076cbeb5a44f946ba377c83859bfd3"></a>

  133. class&#160;</td><td class="memItemRight" valign="bottom"><b>UIExporterWindow</b></td></tr>

  134. <tr class="separator:a09076cbeb5a44f946ba377c83859bfd3"><td class="memSeparator" colspan="2">&#160;</td></tr>

  135. </table>

  136. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

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

  138. <dl class="section note"><dt>Note</dt><dd>You must call setSize during construction,  Detailed information about this class. </dd></dl>

  139. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  140. <a id="ad3425075e4a23234a8568d1893b54f22"></a>

  141. <h2 class="memtitle"><span class="permalink"><a href="#ad3425075e4a23234a8568d1893b54f22">&#9670;&nbsp;</a></span>UI()</h2>

  142. 

  143. <div class="memitem">

  144. <div class="memproto">

  145.       <table class="memname">

  146.         <tr>

  147.           <td class="memname">UI::UI </td>

  148.           <td>(</td>

  149.           <td class="paramtype">uint&#160;</td>

  150.           <td class="paramname"><em>width</em> = <code>0</code>, </td>

  151.         </tr>

  152.         <tr>

  153.           <td class="paramkey"></td>

  154.           <td></td>

  155.           <td class="paramtype">uint&#160;</td>

  156.           <td class="paramname"><em>height</em> = <code>0</code>&#160;</td>

  157.         </tr>

  158.         <tr>

  159.           <td></td>

  160.           <td>)</td>

  161.           <td></td><td></td>

  162.         </tr>

  163.       </table>

  164. </div><div class="memdoc">

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

  166. 

  167. </div>

  168. </div>

  169. <a id="a47e7b6111faba049dfee4738d067cc42"></a>

  170. <h2 class="memtitle"><span class="permalink"><a href="#a47e7b6111faba049dfee4738d067cc42">&#9670;&nbsp;</a></span>~UI()</h2>

  171. 

  172. <div class="memitem">

  173. <div class="memproto">

  174. <table class="mlabels">

  175.   <tr>

  176.   <td class="mlabels-left">

  177.       <table class="memname">

  178.         <tr>

  179.           <td class="memname">virtual UI::~UI </td>

  180.           <td>(</td>

  181.           <td class="paramname"></td><td>)</td>

  182.           <td></td>

  183.         </tr>

  184.       </table>

  185.   </td>

  186.   <td class="mlabels-right">

  187. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>

  188.   </tr>

  189. </table>

  190. </div><div class="memdoc">

  191. <p>Destructor. </p>

  192. 

  193. </div>

  194. </div>

  195. <h2 class="groupheader">Member Function Documentation</h2>

  196. <a id="a97d880182254652f94e7bed355370c07"></a>

  197. <h2 class="memtitle"><span class="permalink"><a href="#a97d880182254652f94e7bed355370c07">&#9670;&nbsp;</a></span>getSampleRate()</h2>

  198. 

  199. <div class="memitem">

  200. <div class="memproto">

  201. <table class="mlabels">

  202.   <tr>

  203.   <td class="mlabels-left">

  204.       <table class="memname">

  205.         <tr>

  206.           <td class="memname">double UI::getSampleRate </td>

  207.           <td>(</td>

  208.           <td class="paramname"></td><td>)</td>

  209.           <td> const</td>

  210.         </tr>

  211.       </table>

  212.   </td>

  213.   <td class="mlabels-right">

  214. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  215.   </tr>

  216. </table>

  217. </div><div class="memdoc">

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

  219. 

  220. </div>

  221. </div>

  222. <a id="a2efcd4f21af0470e91fb6a342d7667a0"></a>

  223. <h2 class="memtitle"><span class="permalink"><a href="#a2efcd4f21af0470e91fb6a342d7667a0">&#9670;&nbsp;</a></span>editParameter()</h2>

  224. 

  225. <div class="memitem">

  226. <div class="memproto">

  227.       <table class="memname">

  228.         <tr>

  229.           <td class="memname">void UI::editParameter </td>

  230.           <td>(</td>

  231.           <td class="paramtype">uint32_t&#160;</td>

  232.           <td class="paramname"><em>index</em>, </td>

  233.         </tr>

  234.         <tr>

  235.           <td class="paramkey"></td>

  236.           <td></td>

  237.           <td class="paramtype">bool&#160;</td>

  238.           <td class="paramname"><em>started</em>&#160;</td>

  239.         </tr>

  240.         <tr>

  241.           <td></td>

  242.           <td>)</td>

  243.           <td></td><td></td>

  244.         </tr>

  245.       </table>

  246. </div><div class="memdoc">

  247. <p>editParameter.  Document this. </p>

  248. 

  249. </div>

  250. </div>

  251. <a id="a973db6e8805f0aa9be3457685564ab8a"></a>

  252. <h2 class="memtitle"><span class="permalink"><a href="#a973db6e8805f0aa9be3457685564ab8a">&#9670;&nbsp;</a></span>setParameterValue()</h2>

  253. 

  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">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">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>setParameterValue.  Document this. </p>

  277. 

  278. </div>

  279. </div>

  280. <a id="abc94a38afa658849f3fdfd66cd8f5f51"></a>

  281. <h2 class="memtitle"><span class="permalink"><a href="#abc94a38afa658849f3fdfd66cd8f5f51">&#9670;&nbsp;</a></span>setState()</h2>

  282. 

  283. <div class="memitem">

  284. <div class="memproto">

  285.       <table class="memname">

  286.         <tr>

  287.           <td class="memname">void UI::setState </td>

  288.           <td>(</td>

  289.           <td class="paramtype">const char *&#160;</td>

  290.           <td class="paramname"><em>key</em>, </td>

  291.         </tr>

  292.         <tr>

  293.           <td class="paramkey"></td>

  294.           <td></td>

  295.           <td class="paramtype">const char *&#160;</td>

  296.           <td class="paramname"><em>value</em>&#160;</td>

  297.         </tr>

  298.         <tr>

  299.           <td></td>

  300.           <td>)</td>

  301.           <td></td><td></td>

  302.         </tr>

  303.       </table>

  304. </div><div class="memdoc">

  305. <p>setState.  Document this. </p>

  306. 

  307. </div>

  308. </div>

  309. <a id="a9d630b2b1696e01015d869a5b434eb6e"></a>

  310. <h2 class="memtitle"><span class="permalink"><a href="#a9d630b2b1696e01015d869a5b434eb6e">&#9670;&nbsp;</a></span>sendNote()</h2>

  311. 

  312. <div class="memitem">

  313. <div class="memproto">

  314.       <table class="memname">

  315.         <tr>

  316.           <td class="memname">void UI::sendNote </td>

  317.           <td>(</td>

  318.           <td class="paramtype">uint8_t&#160;</td>

  319.           <td class="paramname"><em>channel</em>, </td>

  320.         </tr>

  321.         <tr>

  322.           <td class="paramkey"></td>

  323.           <td></td>

  324.           <td class="paramtype">uint8_t&#160;</td>

  325.           <td class="paramname"><em>note</em>, </td>

  326.         </tr>

  327.         <tr>

  328.           <td class="paramkey"></td>

  329.           <td></td>

  330.           <td class="paramtype">uint8_t&#160;</td>

  331.           <td class="paramname"><em>velocity</em>&#160;</td>

  332.         </tr>

  333.         <tr>

  334.           <td></td>

  335.           <td>)</td>

  336.           <td></td><td></td>

  337.         </tr>

  338.       </table>

  339. </div><div class="memdoc">

  340. <p>sendNote.  Document this. </p><dl class="section note"><dt>Note</dt><dd>Work in progress. Implemented for DSSI and LV2 formats. </dd></dl>

  341. 

  342. </div>

  343. </div>

  344. <a id="a0863a8f7ca7fc7e172e703c58518329f"></a>

  345. <h2 class="memtitle"><span class="permalink"><a href="#a0863a8f7ca7fc7e172e703c58518329f">&#9670;&nbsp;</a></span>getPluginInstancePointer()</h2>

  346. 

  347. <div class="memitem">

  348. <div class="memproto">

  349. <table class="mlabels">

  350.   <tr>

  351.   <td class="mlabels-left">

  352.       <table class="memname">

  353.         <tr>

  354.           <td class="memname">void* UI::getPluginInstancePointer </td>

  355.           <td>(</td>

  356.           <td class="paramname"></td><td>)</td>

  357.           <td> const</td>

  358.         </tr>

  359.       </table>

  360.   </td>

  361.   <td class="mlabels-right">

  362. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  363.   </tr>

  364. </table>

  365. </div><div class="memdoc">

  366. <p>getPluginInstancePointer.  Document this. </p>

  367. 

  368. </div>

  369. </div>

  370. <a id="ab157329c83a4660dd059508dc8d041f5"></a>

  371. <h2 class="memtitle"><span class="permalink"><a href="#ab157329c83a4660dd059508dc8d041f5">&#9670;&nbsp;</a></span>getNextBundlePath()</h2>

  372. 

  373. <div class="memitem">

  374. <div class="memproto">

  375. <table class="mlabels">

  376.   <tr>

  377.   <td class="mlabels-left">

  378.       <table class="memname">

  379.         <tr>

  380.           <td class="memname">static const char* UI::getNextBundlePath </td>

  381.           <td>(</td>

  382.           <td class="paramname"></td><td>)</td>

  383.           <td></td>

  384.         </tr>

  385.       </table>

  386.   </td>

  387.   <td class="mlabels-right">

  388. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>

  389.   </tr>

  390. </table>

  391. </div><div class="memdoc">

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

  393. 

  394. </div>

  395. </div>

  396. <a id="a4630e30aec3f3e7dcfc353ef2807bf56"></a>

  397. <h2 class="memtitle"><span class="permalink"><a href="#a4630e30aec3f3e7dcfc353ef2807bf56">&#9670;&nbsp;</a></span>getNextWindowId()</h2>

  398. 

  399. <div class="memitem">

  400. <div class="memproto">

  401. <table class="mlabels">

  402.   <tr>

  403.   <td class="mlabels-left">

  404.       <table class="memname">

  405.         <tr>

  406.           <td class="memname">static uintptr_t UI::getNextWindowId </td>

  407.           <td>(</td>

  408.           <td class="paramname"></td><td>)</td>

  409.           <td></td>

  410.         </tr>

  411.       </table>

  412.   </td>

  413.   <td class="mlabels-right">

  414. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>

  415.   </tr>

  416. </table>

  417. </div><div class="memdoc">

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

  419. 

  420. </div>

  421. </div>

  422. <a id="ab3086d302a9685b25abf144ade3e88f6"></a>

  423. <h2 class="memtitle"><span class="permalink"><a href="#ab3086d302a9685b25abf144ade3e88f6">&#9670;&nbsp;</a></span>parameterChanged()</h2>

  424. 

  425. <div class="memitem">

  426. <div class="memproto">

  427. <table class="mlabels">

  428.   <tr>

  429.   <td class="mlabels-left">

  430.       <table class="memname">

  431.         <tr>

  432.           <td class="memname">virtual void UI::parameterChanged </td>

  433.           <td>(</td>

  434.           <td class="paramtype">uint32_t&#160;</td>

  435.           <td class="paramname"><em>index</em>, </td>

  436.         </tr>

  437.         <tr>

  438.           <td class="paramkey"></td>

  439.           <td></td>

  440.           <td class="paramtype">float&#160;</td>

  441.           <td class="paramname"><em>value</em>&#160;</td>

  442.         </tr>

  443.         <tr>

  444.           <td></td>

  445.           <td>)</td>

  446.           <td></td><td></td>

  447.         </tr>

  448.       </table>

  449.   </td>

  450.   <td class="mlabels-right">

  451. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  452.   </tr>

  453. </table>

  454. </div><div class="memdoc">

  455. <p>A parameter has changed on the plugin side.<br />

  456. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about parameter changes. </p>

  457. 

  458. </div>

  459. </div>

  460. <a id="a2f043dd1b2e179248a19918c5483cfae"></a>

  461. <h2 class="memtitle"><span class="permalink"><a href="#a2f043dd1b2e179248a19918c5483cfae">&#9670;&nbsp;</a></span>programLoaded()</h2>

  462. 

  463. <div class="memitem">

  464. <div class="memproto">

  465. <table class="mlabels">

  466.   <tr>

  467.   <td class="mlabels-left">

  468.       <table class="memname">

  469.         <tr>

  470.           <td class="memname">virtual void UI::programLoaded </td>

  471.           <td>(</td>

  472.           <td class="paramtype">uint32_t&#160;</td>

  473.           <td class="paramname"><em>index</em></td><td>)</td>

  474.           <td></td>

  475.         </tr>

  476.       </table>

  477.   </td>

  478.   <td class="mlabels-right">

  479. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  480.   </tr>

  481. </table>

  482. </div><div class="memdoc">

  483. <p>A program has been loaded on the plugin side.<br />

  484. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about program changes. </p>

  485. 

  486. </div>

  487. </div>

  488. <a id="a1bdc7e158d974e82f0535f1658d66575"></a>

  489. <h2 class="memtitle"><span class="permalink"><a href="#a1bdc7e158d974e82f0535f1658d66575">&#9670;&nbsp;</a></span>stateChanged()</h2>

  490. 

  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::stateChanged </td>

  499.           <td>(</td>

  500.           <td class="paramtype">const char *&#160;</td>

  501.           <td class="paramname"><em>key</em>, </td>

  502.         </tr>

  503.         <tr>

  504.           <td class="paramkey"></td>

  505.           <td></td>

  506.           <td class="paramtype">const char *&#160;</td>

  507.           <td class="paramname"><em>value</em>&#160;</td>

  508.         </tr>

  509.         <tr>

  510.           <td></td>

  511.           <td>)</td>

  512.           <td></td><td></td>

  513.         </tr>

  514.       </table>

  515.   </td>

  516.   <td class="mlabels-right">

  517. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  518.   </tr>

  519. </table>

  520. </div><div class="memdoc">

  521. <p>A state has changed on the plugin side.<br />

  522. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about state changes. </p>

  523. 

  524. </div>

  525. </div>

  526. <a id="ac3e98726ca71f95a1e6c867706ebd9be"></a>

  527. <h2 class="memtitle"><span class="permalink"><a href="#ac3e98726ca71f95a1e6c867706ebd9be">&#9670;&nbsp;</a></span>sampleRateChanged()</h2>

  528. 

  529. <div class="memitem">

  530. <div class="memproto">

  531. <table class="mlabels">

  532.   <tr>

  533.   <td class="mlabels-left">

  534.       <table class="memname">

  535.         <tr>

  536.           <td class="memname">virtual void UI::sampleRateChanged </td>

  537.           <td>(</td>

  538.           <td class="paramtype">double&#160;</td>

  539.           <td class="paramname"><em>newSampleRate</em></td><td>)</td>

  540.           <td></td>

  541.         </tr>

  542.       </table>

  543.   </td>

  544.   <td class="mlabels-right">

  545. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  546.   </tr>

  547. </table>

  548. </div><div class="memdoc">

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

  550. 

  551. </div>

  552. </div>

  553. <a id="af8de639088f3b2d42c266a2d2d6719da"></a>

  554. <h2 class="memtitle"><span class="permalink"><a href="#af8de639088f3b2d42c266a2d2d6719da">&#9670;&nbsp;</a></span>uiIdle()</h2>

  555. 

  556. <div class="memitem">

  557. <div class="memproto">

  558. <table class="mlabels">

  559.   <tr>

  560.   <td class="mlabels-left">

  561.       <table class="memname">

  562.         <tr>

  563.           <td class="memname">virtual void UI::uiIdle </td>

  564.           <td>(</td>

  565.           <td class="paramname"></td><td>)</td>

  566.           <td></td>

  567.         </tr>

  568.       </table>

  569.   </td>

  570.   <td class="mlabels-right">

  571. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  572.   </tr>

  573. </table>

  574. </div><div class="memdoc">

  575. <p>uiIdle.  Document this. </p>

  576. 

  577. </div>

  578. </div>

  579. <a id="a6d4697296129d3a6bc34fc810d6297ac"></a>

  580. <h2 class="memtitle"><span class="permalink"><a href="#a6d4697296129d3a6bc34fc810d6297ac">&#9670;&nbsp;</a></span>uiFileBrowserSelected()</h2>

  581. 

  582. <div class="memitem">

  583. <div class="memproto">

  584. <table class="mlabels">

  585.   <tr>

  586.   <td class="mlabels-left">

  587.       <table class="memname">

  588.         <tr>

  589.           <td class="memname">virtual void UI::uiFileBrowserSelected </td>

  590.           <td>(</td>

  591.           <td class="paramtype">const char *&#160;</td>

  592.           <td class="paramname"><em>filename</em></td><td>)</td>

  593.           <td></td>

  594.         </tr>

  595.       </table>

  596.   </td>

  597.   <td class="mlabels-right">

  598. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  599.   </tr>

  600. </table>

  601. </div><div class="memdoc">

  602. <p>File browser selected function. </p><dl class="section see"><dt>See also</dt><dd>Window::fileBrowserSelected(const char*) </dd></dl>

  603. 

  604. </div>

  605. </div>

  606. <a id="ab6861389e1bb01268a189dadbeb4fbcc"></a>

  607. <h2 class="memtitle"><span class="permalink"><a href="#ab6861389e1bb01268a189dadbeb4fbcc">&#9670;&nbsp;</a></span>uiReshape()</h2>

  608. 

  609. <div class="memitem">

  610. <div class="memproto">

  611. <table class="mlabels">

  612.   <tr>

  613.   <td class="mlabels-left">

  614.       <table class="memname">

  615.         <tr>

  616.           <td class="memname">virtual void UI::uiReshape </td>

  617.           <td>(</td>

  618.           <td class="paramtype">uint&#160;</td>

  619.           <td class="paramname"><em>width</em>, </td>

  620.         </tr>

  621.         <tr>

  622.           <td class="paramkey"></td>

  623.           <td></td>

  624.           <td class="paramtype">uint&#160;</td>

  625.           <td class="paramname"><em>height</em>&#160;</td>

  626.         </tr>

  627.         <tr>

  628.           <td></td>

  629.           <td>)</td>

  630.           <td></td><td></td>

  631.         </tr>

  632.       </table>

  633.   </td>

  634.   <td class="mlabels-right">

  635. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  636.   </tr>

  637. </table>

  638. </div><div class="memdoc">

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

  640. 

  641. </div>

  642. </div>

  643. <a id="a8de15be030bbdf0eb81461349cb1cc77"></a>

  644. <h2 class="memtitle"><span class="permalink"><a href="#a8de15be030bbdf0eb81461349cb1cc77">&#9670;&nbsp;</a></span>onResize()</h2>

  645. 

  646. <div class="memitem">

  647. <div class="memproto">

  648. <table class="mlabels">

  649.   <tr>

  650.   <td class="mlabels-left">

  651.       <table class="memname">

  652.         <tr>

  653.           <td class="memname">void UI::onResize </td>

  654.           <td>(</td>

  655.           <td class="paramtype">const ResizeEvent &amp;&#160;</td>

  656.           <td class="paramname"><em>ev</em></td><td>)</td>

  657.           <td></td>

  658.         </tr>

  659.       </table>

  660.   </td>

  661.   <td class="mlabels-right">

  662. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span></span>  </td>

  663.   </tr>

  664. </table>

  665. </div><div class="memdoc">

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

  667. 

  668. </div>

  669. </div>

  670. <hr/>The documentation for this class was generated from the following file:<ul>

  671. <li>distrho/<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a></li>

  672. </ul>

  673. </div><!-- contents -->

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

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

  676. Generated on Mon Aug 13 2018 06:29:25 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  678. </a> 1.8.13

  679. </small></address>

  680. </body>

  681. </html>