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.

213 lines
10KB

  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.6"/>
  7. <title>DISTRHO Plugin Framework: ParameterEnumerationValue Struct 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.6 -->
  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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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="#pub-attribs">Public Attributes</a> &#124;
  86. <a href="structParameterEnumerationValue-members.html">List of all members</a> </div>
  87. <div class="headertitle">
  88. <div class="title">ParameterEnumerationValue Struct Reference<div class="ingroups"><a class="el" href="group__BasePluginStructs.html">Base Plugin Structs</a></div></div> </div>
  89. </div><!--header-->
  90. <div class="contents">
  91. <p><code>#include &lt;<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a>&gt;</code></p>
  92. <table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  94. Public Member Functions</h2></td></tr>
  95. <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>
  96. <tr class="separator:a169e558182f93aadd2e66819a981a3f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <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>
  98. <tr class="separator:aad073d95adfcd8ec01767490fbd69f68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table><table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  101. Public Attributes</h2></td></tr>
  102. <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>
  103. <tr class="separator:a292f282837daa791205027d998907ae9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="separator:aba1c51d5a2c99416c1dcf0a08345178d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table>
  107. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  108. <div class="textblock"><p><a class="el" href="structParameter.html">Parameter</a> enumeration value.<br/>
  109. A string representation of a plugin parameter value.<br/>
  110. Used together can be used to give meaning to parameter values, working as an enumeration. </p>
  111. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  112. <a class="anchor" id="a169e558182f93aadd2e66819a981a3f9"></a>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="mlabels">
  116. <tr>
  117. <td class="mlabels-left">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">ParameterEnumerationValue::ParameterEnumerationValue </td>
  121. <td>(</td>
  122. <td class="paramname"></td><td>)</td>
  123. <td></td>
  124. </tr>
  125. </table>
  126. </td>
  127. <td class="mlabels-right">
  128. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  129. </tr>
  130. </table>
  131. </div><div class="memdoc">
  132. <p>Default constructor, using 0.0 as value and empty label. </p>
  133. </div>
  134. </div>
  135. <a class="anchor" id="aad073d95adfcd8ec01767490fbd69f68"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="mlabels">
  139. <tr>
  140. <td class="mlabels-left">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">ParameterEnumerationValue::ParameterEnumerationValue </td>
  144. <td>(</td>
  145. <td class="paramtype">float&#160;</td>
  146. <td class="paramname"><em>v</em>, </td>
  147. </tr>
  148. <tr>
  149. <td class="paramkey"></td>
  150. <td></td>
  151. <td class="paramtype">const char *&#160;</td>
  152. <td class="paramname"><em>l</em>&#160;</td>
  153. </tr>
  154. <tr>
  155. <td></td>
  156. <td>)</td>
  157. <td></td><td></td>
  158. </tr>
  159. </table>
  160. </td>
  161. <td class="mlabels-right">
  162. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>Constructor using custom values. </p>
  167. </div>
  168. </div>
  169. <h2 class="groupheader">Member Data Documentation</h2>
  170. <a class="anchor" id="a292f282837daa791205027d998907ae9"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">float ParameterEnumerationValue::value</td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p><a class="el" href="structParameter.html">Parameter</a> value. </p>
  180. </div>
  181. </div>
  182. <a class="anchor" id="aba1c51d5a2c99416c1dcf0a08345178d"></a>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname"><a class="el" href="classString.html">String</a> ParameterEnumerationValue::label</td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p><a class="el" href="classString.html">String</a> representation of this value. </p>
  192. </div>
  193. </div>
  194. <hr/>The documentation for this struct was generated from the following file:<ul>
  195. <li>distrho/<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a></li>
  196. </ul>
  197. </div><!-- contents -->
  198. <!-- start footer part -->
  199. <hr class="footer"/><address class="footer"><small>
  200. Generated on Mon Jun 24 2019 11:54:44 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  201. <img class="footer" src="doxygen.png" alt="doxygen"/>
  202. </a> 1.8.6
  203. </small></address>
  204. </body>
  205. </html>