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.

218 lines
30KB

  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: distrho/extra/FileBrowserDialogImpl.hpp Source File</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 id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><a class="el" href="dir_37257469cca17bab24b582e18a78eb75.html">distrho</a></li><li class="navelem"><a class="el" href="dir_b1be46be7d80596b116b2b4ac973f2f0.html">extra</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="headertitle">
  67. <div class="title">FileBrowserDialogImpl.hpp</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
  71. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
  72. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright (C) 2012-2022 Filipe Coelho &lt;falktx@falktx.com&gt;</span></div>
  73. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  74. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
  75. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
  76. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>
  77. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
  78. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
  79. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
  80. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
  81. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
  82. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
  83. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
  84. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></div>
  85. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
  86. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#if !defined(DISTRHO_FILE_BROWSER_DIALOG_HPP_INCLUDED) &amp;&amp; !defined(DGL_FILE_BROWSER_DIALOG_HPP_INCLUDED)</span></div>
  87. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"># error bad include</span></div>
  88. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#endif</span></div>
  89. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
  90. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
  91. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">// File Browser Dialog stuff</span></div>
  92. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
  93. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">struct </span><a class="code" href="structFileBrowserData.html">FileBrowserData</a>;</div>
  94. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">typedef</span> <a class="code" href="structFileBrowserData.html">FileBrowserData</a>* <a class="code" href="structFileBrowserData.html">FileBrowserHandle</a>;</div>
  95. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
  96. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
  97. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"></span> </div>
  98. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment">/**</span></div>
  99. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> File browser options, for customizing the file browser dialog.@n</span></div>
  100. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> By default the file browser dialog will be work as &quot;open file&quot; in the current working directory.</span></div>
  101. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">*/</span></div>
  102. <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structFileBrowserOptions.html"> 33</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structFileBrowserOptions.html">FileBrowserOptions</a> {<span class="comment"></span></div>
  103. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> /** Whether we are saving, opening files otherwise (default) */</span></div>
  104. <div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structFileBrowserOptions.html#a923166f4f4477b4491d3f47e05cfbdfe"> 35</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structFileBrowserOptions.html#a923166f4f4477b4491d3f47e05cfbdfe">saving</a>;</div>
  105. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"></span> </div>
  106. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"> /** Default filename when saving, required in some platforms (basename without path separators) */</span></div>
  107. <div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structFileBrowserOptions.html#acc05b9a39052fc84e4d50a62229091d8"> 38</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structFileBrowserOptions.html#acc05b9a39052fc84e4d50a62229091d8">defaultName</a>;</div>
  108. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"></span> </div>
  109. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> /** Start directory, uses current working directory if null */</span></div>
  110. <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structFileBrowserOptions.html#a921fe62f9783fee2c01ddbaa0851e8b4"> 41</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structFileBrowserOptions.html#a921fe62f9783fee2c01ddbaa0851e8b4">startDir</a>;</div>
  111. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"></span> </div>
  112. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"> /** File browser dialog window title, uses &quot;FileBrowser&quot; if null */</span></div>
  113. <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structFileBrowserOptions.html#a16d59d24e75eec2c6f9f3aebfe5464e7"> 44</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structFileBrowserOptions.html#a16d59d24e75eec2c6f9f3aebfe5464e7">title</a>;</div>
  114. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"></span> </div>
  115. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> /** Class name of the matching Application instance that controls this dialog */</span></div>
  116. <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structFileBrowserOptions.html#a5cd131b31f02ceff8b9ac5db6b40fc3a"> 47</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structFileBrowserOptions.html#a5cd131b31f02ceff8b9ac5db6b40fc3a">className</a>;</div>
  117. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
  118. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// TODO file filter</span></div>
  119. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"></span> </div>
  120. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> /**</span></div>
  121. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> File browser button state.</span></div>
  122. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> This allows to customize the behaviour of the file browse dialog buttons.</span></div>
  123. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"> Note these are merely hints, not all systems support them.</span></div>
  124. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment"> */</span></div>
  125. <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structFileBrowserOptions.html#ac435c15f821601fa0a10fbd4707b5ab9"> 56</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="structFileBrowserOptions.html#ac435c15f821601fa0a10fbd4707b5ab9">ButtonState</a> {</div>
  126. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; kButtonInvisible,</div>
  127. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; kButtonVisibleUnchecked,</div>
  128. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; kButtonVisibleChecked,</div>
  129. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; };</div>
  130. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment"></span> </div>
  131. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="comment"> /**</span></div>
  132. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment"> File browser buttons.</span></div>
  133. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment"> */</span></div>
  134. <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structFileBrowserOptions_1_1Buttons.html"> 65</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structFileBrowserOptions_1_1Buttons.html">Buttons</a> {<span class="comment"></span></div>
  135. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"> /** Whether to list all files vs only those with matching file extension */</span></div>
  136. <div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="structFileBrowserOptions_1_1Buttons.html#ac8174fbcf8d85ef5abece32114c234d5"> 67</a></span>&#160; <a class="code" href="structFileBrowserOptions.html#ac435c15f821601fa0a10fbd4707b5ab9">ButtonState</a> <a class="code" href="structFileBrowserOptions_1_1Buttons.html#ac8174fbcf8d85ef5abece32114c234d5">listAllFiles</a>;<span class="comment"></span></div>
  137. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment"> /** Whether to show hidden files */</span></div>
  138. <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="structFileBrowserOptions_1_1Buttons.html#a43b25f4cece01eb8dd8d89a10e921dfc"> 69</a></span>&#160; <a class="code" href="structFileBrowserOptions.html#ac435c15f821601fa0a10fbd4707b5ab9">ButtonState</a> <a class="code" href="structFileBrowserOptions_1_1Buttons.html#a43b25f4cece01eb8dd8d89a10e921dfc">showHidden</a>;<span class="comment"></span></div>
  139. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment"> /** Whether to show list of places (bookmarks) */</span></div>
  140. <div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structFileBrowserOptions_1_1Buttons.html#ac2df440c203fb3b1a3be012283427d5b"> 71</a></span>&#160; <a class="code" href="structFileBrowserOptions.html#ac435c15f821601fa0a10fbd4707b5ab9">ButtonState</a> <a class="code" href="structFileBrowserOptions_1_1Buttons.html#ac2df440c203fb3b1a3be012283427d5b">showPlaces</a>;</div>
  141. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"></span> </div>
  142. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment"> /** Constructor for default values */</span></div>
  143. <div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="structFileBrowserOptions_1_1Buttons.html#ac63aae50a8d713ac6de337cc8739c870"> 74</a></span>&#160; <a class="code" href="structFileBrowserOptions_1_1Buttons.html#ac63aae50a8d713ac6de337cc8739c870">Buttons</a>()</div>
  144. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; : <a class="code" href="structFileBrowserOptions_1_1Buttons.html#ac8174fbcf8d85ef5abece32114c234d5">listAllFiles</a>(kButtonVisibleChecked),</div>
  145. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="structFileBrowserOptions_1_1Buttons.html#a43b25f4cece01eb8dd8d89a10e921dfc">showHidden</a>(kButtonVisibleUnchecked),</div>
  146. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="structFileBrowserOptions_1_1Buttons.html#ac2df440c203fb3b1a3be012283427d5b">showPlaces</a>(kButtonVisibleChecked) {}</div>
  147. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; } buttons;</div>
  148. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="comment"></span> </div>
  149. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="comment"> /** Constructor for default values */</span></div>
  150. <div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="structFileBrowserOptions.html#afaad52af434db54ecc629ff68b194273"> 81</a></span>&#160; <a class="code" href="structFileBrowserOptions.html#afaad52af434db54ecc629ff68b194273">FileBrowserOptions</a>()</div>
  151. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; : <a class="code" href="structFileBrowserOptions.html#a923166f4f4477b4491d3f47e05cfbdfe">saving</a>(false),</div>
  152. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <a class="code" href="structFileBrowserOptions.html#acc05b9a39052fc84e4d50a62229091d8">defaultName</a>(nullptr),</div>
  153. <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <a class="code" href="structFileBrowserOptions.html#a921fe62f9783fee2c01ddbaa0851e8b4">startDir</a>(nullptr),</div>
  154. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <a class="code" href="structFileBrowserOptions.html#a16d59d24e75eec2c6f9f3aebfe5464e7">title</a>(nullptr),</div>
  155. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <a class="code" href="structFileBrowserOptions.html#a5cd131b31f02ceff8b9ac5db6b40fc3a">className</a>(nullptr),</div>
  156. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; buttons() {}</div>
  157. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;};</div>
  158. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
  159. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
  160. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="comment"></span> </div>
  161. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="comment">/**</span></div>
  162. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="comment"> Create a new file browser dialog.</span></div>
  163. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="comment"></span> </div>
  164. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<span class="comment"> @p isEmbed: Whether the window this dialog belongs to is an embed/child window (needed to close dialog on Windows)</span></div>
  165. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="comment"> @p windowId: The native window id to attach this dialog to as transient parent (X11 Window, HWND or NSView*)</span></div>
  166. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="comment"> @p scaleFactor: Scale factor to use (only used on X11)</span></div>
  167. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="comment"> @p options: Extra options, optional</span></div>
  168. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="comment"> By default the file browser dialog will work as &quot;open file&quot; in the current working directory.</span></div>
  169. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="comment">*/</span></div>
  170. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<a class="code" href="structFileBrowserData.html">FileBrowserHandle</a> fileBrowserCreate(<span class="keywordtype">bool</span> isEmbed,</div>
  171. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; uintptr_t windowId,</div>
  172. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordtype">double</span> scaleFactor,</div>
  173. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keyword">const</span> <a class="code" href="structFileBrowserOptions.html">FileBrowserOptions</a>&amp; options = <a class="code" href="structFileBrowserOptions.html">FileBrowserOptions</a>());</div>
  174. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="comment"></span> </div>
  175. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="comment">/**</span></div>
  176. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment"> Idle the file browser dialog handle.@n</span></div>
  177. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment"> Returns true if dialog was closed (with or without a file selection),</span></div>
  178. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment"> in which case this idle function must not be called anymore for this handle.</span></div>
  179. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"> You can then call fileBrowserGetPath to know the selected file (or null if cancelled).</span></div>
  180. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="comment">*/</span></div>
  181. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="keywordtype">bool</span> fileBrowserIdle(<span class="keyword">const</span> <a class="code" href="structFileBrowserData.html">FileBrowserHandle</a> handle);</div>
  182. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment"></span> </div>
  183. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="comment">/**</span></div>
  184. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="comment"> Close and free the file browser dialog, handle must not be used afterwards.</span></div>
  185. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="comment">*/</span></div>
  186. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="keywordtype">void</span> fileBrowserClose(<span class="keyword">const</span> <a class="code" href="structFileBrowserData.html">FileBrowserHandle</a> handle);</div>
  187. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="comment"></span> </div>
  188. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="comment">/**</span></div>
  189. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;<span class="comment"> Get the path chosen by the user or null.@n</span></div>
  190. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="comment"> Should only be called after fileBrowserIdle returns true.</span></div>
  191. <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="comment">*/</span></div>
  192. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<span class="keyword">const</span> <span class="keywordtype">char</span>* fileBrowserGetPath(<span class="keyword">const</span> <a class="code" href="structFileBrowserData.html">FileBrowserHandle</a> handle);</div>
  193. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
  194. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
  195. <div class="ttc" id="astructFileBrowserData_html"><div class="ttname"><a href="structFileBrowserData.html">FileBrowserData</a></div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.cpp:190</div></div>
  196. <div class="ttc" id="astructFileBrowserOptions_1_1Buttons_html"><div class="ttname"><a href="structFileBrowserOptions_1_1Buttons.html">FileBrowserOptions::Buttons</a></div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:65</div></div>
  197. <div class="ttc" id="astructFileBrowserOptions_1_1Buttons_html_a43b25f4cece01eb8dd8d89a10e921dfc"><div class="ttname"><a href="structFileBrowserOptions_1_1Buttons.html#a43b25f4cece01eb8dd8d89a10e921dfc">FileBrowserOptions::Buttons::showHidden</a></div><div class="ttdeci">ButtonState showHidden</div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:69</div></div>
  198. <div class="ttc" id="astructFileBrowserOptions_1_1Buttons_html_ac2df440c203fb3b1a3be012283427d5b"><div class="ttname"><a href="structFileBrowserOptions_1_1Buttons.html#ac2df440c203fb3b1a3be012283427d5b">FileBrowserOptions::Buttons::showPlaces</a></div><div class="ttdeci">ButtonState showPlaces</div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:71</div></div>
  199. <div class="ttc" id="astructFileBrowserOptions_1_1Buttons_html_ac63aae50a8d713ac6de337cc8739c870"><div class="ttname"><a href="structFileBrowserOptions_1_1Buttons.html#ac63aae50a8d713ac6de337cc8739c870">FileBrowserOptions::Buttons::Buttons</a></div><div class="ttdeci">Buttons()</div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:74</div></div>
  200. <div class="ttc" id="astructFileBrowserOptions_1_1Buttons_html_ac8174fbcf8d85ef5abece32114c234d5"><div class="ttname"><a href="structFileBrowserOptions_1_1Buttons.html#ac8174fbcf8d85ef5abece32114c234d5">FileBrowserOptions::Buttons::listAllFiles</a></div><div class="ttdeci">ButtonState listAllFiles</div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:67</div></div>
  201. <div class="ttc" id="astructFileBrowserOptions_html"><div class="ttname"><a href="structFileBrowserOptions.html">FileBrowserOptions</a></div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:33</div></div>
  202. <div class="ttc" id="astructFileBrowserOptions_html_a16d59d24e75eec2c6f9f3aebfe5464e7"><div class="ttname"><a href="structFileBrowserOptions.html#a16d59d24e75eec2c6f9f3aebfe5464e7">FileBrowserOptions::title</a></div><div class="ttdeci">const char * title</div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:44</div></div>
  203. <div class="ttc" id="astructFileBrowserOptions_html_a5cd131b31f02ceff8b9ac5db6b40fc3a"><div class="ttname"><a href="structFileBrowserOptions.html#a5cd131b31f02ceff8b9ac5db6b40fc3a">FileBrowserOptions::className</a></div><div class="ttdeci">const char * className</div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:47</div></div>
  204. <div class="ttc" id="astructFileBrowserOptions_html_a921fe62f9783fee2c01ddbaa0851e8b4"><div class="ttname"><a href="structFileBrowserOptions.html#a921fe62f9783fee2c01ddbaa0851e8b4">FileBrowserOptions::startDir</a></div><div class="ttdeci">const char * startDir</div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:41</div></div>
  205. <div class="ttc" id="astructFileBrowserOptions_html_a923166f4f4477b4491d3f47e05cfbdfe"><div class="ttname"><a href="structFileBrowserOptions.html#a923166f4f4477b4491d3f47e05cfbdfe">FileBrowserOptions::saving</a></div><div class="ttdeci">bool saving</div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:35</div></div>
  206. <div class="ttc" id="astructFileBrowserOptions_html_ac435c15f821601fa0a10fbd4707b5ab9"><div class="ttname"><a href="structFileBrowserOptions.html#ac435c15f821601fa0a10fbd4707b5ab9">FileBrowserOptions::ButtonState</a></div><div class="ttdeci">ButtonState</div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:56</div></div>
  207. <div class="ttc" id="astructFileBrowserOptions_html_acc05b9a39052fc84e4d50a62229091d8"><div class="ttname"><a href="structFileBrowserOptions.html#acc05b9a39052fc84e4d50a62229091d8">FileBrowserOptions::defaultName</a></div><div class="ttdeci">const char * defaultName</div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:38</div></div>
  208. <div class="ttc" id="astructFileBrowserOptions_html_afaad52af434db54ecc629ff68b194273"><div class="ttname"><a href="structFileBrowserOptions.html#afaad52af434db54ecc629ff68b194273">FileBrowserOptions::FileBrowserOptions</a></div><div class="ttdeci">FileBrowserOptions()</div><div class="ttdef"><b>Definition:</b> FileBrowserDialogImpl.hpp:81</div></div>
  209. </div><!-- fragment --></div><!-- contents -->
  210. <!-- start footer part -->
  211. <hr class="footer"/><address class="footer"><small>
  212. 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
  213. </small></address>
  214. </body>
  215. </html>