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.

243 lines
12KB

  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: FileBrowserOptions 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="#nested-classes">Classes</a> &#124;
  64. <a href="#pub-types">Public Types</a> &#124;
  65. <a href="#pub-methods">Public Member Functions</a> &#124;
  66. <a href="#pub-attribs">Public Attributes</a> &#124;
  67. <a href="structFileBrowserOptions-members.html">List of all members</a> </div>
  68. <div class="headertitle">
  69. <div class="title">FileBrowserOptions Struct Reference</div> </div>
  70. </div><!--header-->
  71. <div class="contents">
  72. <p><code>#include &lt;<a class="el" href="FileBrowserDialogImpl_8hpp_source.html">FileBrowserDialogImpl.hpp</a>&gt;</code></p>
  73. <table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  75. Classes</h2></td></tr>
  76. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFileBrowserOptions_1_1Buttons.html">Buttons</a></td></tr>
  77. <tr class="separator:"><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-types"></a>
  80. Public Types</h2></td></tr>
  81. <tr class="memitem:ac435c15f821601fa0a10fbd4707b5ab9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFileBrowserOptions.html#ac435c15f821601fa0a10fbd4707b5ab9">ButtonState</a> { <b>kButtonInvisible</b>
  82. , <b>kButtonVisibleUnchecked</b>
  83. , <b>kButtonVisibleChecked</b>
  84. }</td></tr>
  85. <tr class="separator:ac435c15f821601fa0a10fbd4707b5ab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. </table><table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  88. Public Member Functions</h2></td></tr>
  89. <tr class="memitem:afaad52af434db54ecc629ff68b194273"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFileBrowserOptions.html#afaad52af434db54ecc629ff68b194273">FileBrowserOptions</a> ()</td></tr>
  90. <tr class="separator:afaad52af434db54ecc629ff68b194273"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table><table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  93. Public Attributes</h2></td></tr>
  94. <tr class="memitem:a923166f4f4477b4491d3f47e05cfbdfe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFileBrowserOptions.html#a923166f4f4477b4491d3f47e05cfbdfe">saving</a></td></tr>
  95. <tr class="separator:a923166f4f4477b4491d3f47e05cfbdfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:acc05b9a39052fc84e4d50a62229091d8"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFileBrowserOptions.html#acc05b9a39052fc84e4d50a62229091d8">defaultName</a></td></tr>
  97. <tr class="separator:acc05b9a39052fc84e4d50a62229091d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a921fe62f9783fee2c01ddbaa0851e8b4"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFileBrowserOptions.html#a921fe62f9783fee2c01ddbaa0851e8b4">startDir</a></td></tr>
  99. <tr class="separator:a921fe62f9783fee2c01ddbaa0851e8b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a16d59d24e75eec2c6f9f3aebfe5464e7"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFileBrowserOptions.html#a16d59d24e75eec2c6f9f3aebfe5464e7">title</a></td></tr>
  101. <tr class="separator:a16d59d24e75eec2c6f9f3aebfe5464e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a5cd131b31f02ceff8b9ac5db6b40fc3a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFileBrowserOptions.html#a5cd131b31f02ceff8b9ac5db6b40fc3a">className</a></td></tr>
  103. <tr class="separator:a5cd131b31f02ceff8b9ac5db6b40fc3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a528a63962505a1416fed3b31553a5df8"><td class="memItemLeft" align="right" valign="top"><a id="a528a63962505a1416fed3b31553a5df8"></a>
  105. struct <a class="el" href="structFileBrowserOptions_1_1Buttons.html">FileBrowserOptions::Buttons</a>&#160;</td><td class="memItemRight" valign="bottom"><b>buttons</b></td></tr>
  106. <tr class="separator:a528a63962505a1416fed3b31553a5df8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table>
  108. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  109. <div class="textblock"><p>File browser options, for customizing the file browser dialog.<br />
  110. By default the file browser dialog will be work as "open file" in the current working directory. </p>
  111. </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  112. <a id="ac435c15f821601fa0a10fbd4707b5ab9"></a>
  113. <h2 class="memtitle"><span class="permalink"><a href="#ac435c15f821601fa0a10fbd4707b5ab9">&#9670;&nbsp;</a></span>ButtonState</h2>
  114. <div class="memitem">
  115. <div class="memproto">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname">enum <a class="el" href="structFileBrowserOptions.html#ac435c15f821601fa0a10fbd4707b5ab9">FileBrowserOptions::ButtonState</a></td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. <p>File browser button state. This allows to customize the behaviour of the file browse dialog buttons. Note these are merely hints, not all systems support them. </p>
  123. </div>
  124. </div>
  125. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  126. <a id="afaad52af434db54ecc629ff68b194273"></a>
  127. <h2 class="memtitle"><span class="permalink"><a href="#afaad52af434db54ecc629ff68b194273">&#9670;&nbsp;</a></span>FileBrowserOptions()</h2>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="mlabels">
  131. <tr>
  132. <td class="mlabels-left">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">FileBrowserOptions::FileBrowserOptions </td>
  136. <td>(</td>
  137. <td class="paramname"></td><td>)</td>
  138. <td></td>
  139. </tr>
  140. </table>
  141. </td>
  142. <td class="mlabels-right">
  143. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <p>Constructor for default values </p>
  148. </div>
  149. </div>
  150. <h2 class="groupheader">Member Data Documentation</h2>
  151. <a id="a923166f4f4477b4491d3f47e05cfbdfe"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a923166f4f4477b4491d3f47e05cfbdfe">&#9670;&nbsp;</a></span>saving</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">bool FileBrowserOptions::saving</td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Whether we are saving, opening files otherwise (default) </p>
  162. </div>
  163. </div>
  164. <a id="acc05b9a39052fc84e4d50a62229091d8"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#acc05b9a39052fc84e4d50a62229091d8">&#9670;&nbsp;</a></span>defaultName</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname">const char* FileBrowserOptions::defaultName</td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Default filename when saving, required in some platforms (basename without path separators) </p>
  175. </div>
  176. </div>
  177. <a id="a921fe62f9783fee2c01ddbaa0851e8b4"></a>
  178. <h2 class="memtitle"><span class="permalink"><a href="#a921fe62f9783fee2c01ddbaa0851e8b4">&#9670;&nbsp;</a></span>startDir</h2>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">const char* FileBrowserOptions::startDir</td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Start directory, uses current working directory if null </p>
  188. </div>
  189. </div>
  190. <a id="a16d59d24e75eec2c6f9f3aebfe5464e7"></a>
  191. <h2 class="memtitle"><span class="permalink"><a href="#a16d59d24e75eec2c6f9f3aebfe5464e7">&#9670;&nbsp;</a></span>title</h2>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">const char* FileBrowserOptions::title</td>
  197. </tr>
  198. </table>
  199. </div><div class="memdoc">
  200. <p>File browser dialog window title, uses "FileBrowser" if null </p>
  201. </div>
  202. </div>
  203. <a id="a5cd131b31f02ceff8b9ac5db6b40fc3a"></a>
  204. <h2 class="memtitle"><span class="permalink"><a href="#a5cd131b31f02ceff8b9ac5db6b40fc3a">&#9670;&nbsp;</a></span>className</h2>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">const char* FileBrowserOptions::className</td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>Class name of the matching <a class="el" href="classApplication.html">Application</a> instance that controls this dialog </p>
  214. </div>
  215. </div>
  216. <hr/>The documentation for this struct was generated from the following file:<ul>
  217. <li>distrho/extra/<a class="el" href="FileBrowserDialogImpl_8hpp_source.html">FileBrowserDialogImpl.hpp</a></li>
  218. </ul>
  219. </div><!-- contents -->
  220. <!-- start footer part -->
  221. <hr class="footer"/><address class="footer"><small>
  222. 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
  223. </small></address>
  224. </body>
  225. </html>