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.

198 lines
8.8KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: ParameterEnumerationValue Struct 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.9.1 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#pub-attribs">Public Attributes</a> &#124;
  65. <a href="structParameterEnumerationValue-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">ParameterEnumerationValue Struct Reference<div class="ingroups"><a class="el" href="group__BasePluginStructs.html">Base Plugin Structs</a></div></div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p><code>#include &lt;<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a>&gt;</code></p>
  71. <table class="memberdecls">
  72. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  73. Public Member Functions</h2></td></tr>
  74. <tr class="memitem:a169e558182f93aadd2e66819a981a3f9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValue.html#a169e558182f93aadd2e66819a981a3f9">ParameterEnumerationValue</a> () noexcept</td></tr>
  75. <tr class="separator:a169e558182f93aadd2e66819a981a3f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:aad073d95adfcd8ec01767490fbd69f68"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValue.html#aad073d95adfcd8ec01767490fbd69f68">ParameterEnumerationValue</a> (float v, const char *l) noexcept</td></tr>
  77. <tr class="separator:aad073d95adfcd8ec01767490fbd69f68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. </table><table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  80. Public Attributes</h2></td></tr>
  81. <tr class="memitem:a292f282837daa791205027d998907ae9"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValue.html#a292f282837daa791205027d998907ae9">value</a></td></tr>
  82. <tr class="separator:a292f282837daa791205027d998907ae9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:aba1c51d5a2c99416c1dcf0a08345178d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValue.html#aba1c51d5a2c99416c1dcf0a08345178d">label</a></td></tr>
  84. <tr class="separator:aba1c51d5a2c99416c1dcf0a08345178d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. </table>
  86. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  87. <div class="textblock"><p><a class="el" href="structParameter.html">Parameter</a> enumeration value.<br />
  88. A string representation of a plugin parameter value.<br />
  89. Used together can be used to give meaning to parameter values, working as an enumeration. </p>
  90. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  91. <a id="a169e558182f93aadd2e66819a981a3f9"></a>
  92. <h2 class="memtitle"><span class="permalink"><a href="#a169e558182f93aadd2e66819a981a3f9">&#9670;&nbsp;</a></span>ParameterEnumerationValue() <span class="overload">[1/2]</span></h2>
  93. <div class="memitem">
  94. <div class="memproto">
  95. <table class="mlabels">
  96. <tr>
  97. <td class="mlabels-left">
  98. <table class="memname">
  99. <tr>
  100. <td class="memname">ParameterEnumerationValue::ParameterEnumerationValue </td>
  101. <td>(</td>
  102. <td class="paramname"></td><td>)</td>
  103. <td></td>
  104. </tr>
  105. </table>
  106. </td>
  107. <td class="mlabels-right">
  108. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  109. </tr>
  110. </table>
  111. </div><div class="memdoc">
  112. <p>Default constructor, using 0.0 as value and empty label. </p>
  113. </div>
  114. </div>
  115. <a id="aad073d95adfcd8ec01767490fbd69f68"></a>
  116. <h2 class="memtitle"><span class="permalink"><a href="#aad073d95adfcd8ec01767490fbd69f68">&#9670;&nbsp;</a></span>ParameterEnumerationValue() <span class="overload">[2/2]</span></h2>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="mlabels">
  120. <tr>
  121. <td class="mlabels-left">
  122. <table class="memname">
  123. <tr>
  124. <td class="memname">ParameterEnumerationValue::ParameterEnumerationValue </td>
  125. <td>(</td>
  126. <td class="paramtype">float&#160;</td>
  127. <td class="paramname"><em>v</em>, </td>
  128. </tr>
  129. <tr>
  130. <td class="paramkey"></td>
  131. <td></td>
  132. <td class="paramtype">const char *&#160;</td>
  133. <td class="paramname"><em>l</em>&#160;</td>
  134. </tr>
  135. <tr>
  136. <td></td>
  137. <td>)</td>
  138. <td></td><td></td>
  139. </tr>
  140. </table>
  141. </td>
  142. <td class="mlabels-right">
  143. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <p>Constructor using custom values. </p>
  148. </div>
  149. </div>
  150. <h2 class="groupheader">Member Data Documentation</h2>
  151. <a id="a292f282837daa791205027d998907ae9"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a292f282837daa791205027d998907ae9">&#9670;&nbsp;</a></span>value</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">float ParameterEnumerationValue::value</td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p><a class="el" href="structParameter.html">Parameter</a> value. </p>
  162. </div>
  163. </div>
  164. <a id="aba1c51d5a2c99416c1dcf0a08345178d"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#aba1c51d5a2c99416c1dcf0a08345178d">&#9670;&nbsp;</a></span>label</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname"><a class="el" href="classString.html">String</a> ParameterEnumerationValue::label</td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p><a class="el" href="classString.html">String</a> representation of this value. </p>
  175. </div>
  176. </div>
  177. <hr/>The documentation for this struct was generated from the following file:<ul>
  178. <li>distrho/<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a></li>
  179. </ul>
  180. </div><!-- contents -->
  181. <!-- start footer part -->
  182. <hr class="footer"/><address class="footer"><small>
  183. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
  184. </small></address>
  185. </body>
  186. </html>