/usr/share/doc/libjuce/apiref/classFileChooser.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: FileChooser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classFileChooser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FileChooser Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Creates a dialog box to choose a file or directory to load or save.
<a href="classFileChooser.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af8529e1ff1b0356734fcfcce139b92d1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileChooser.html#af8529e1ff1b0356734fcfcce139b92d1">FileChooser</a> (const <a class="el" href="classString.html">String</a> &dialogBoxTitle, const <a class="el" href="classFile.html">File</a> &initialFileOrDirectory=<a class="el" href="classFile.html">File</a>(), const <a class="el" href="classString.html">String</a> &filePatternsAllowed=<a class="el" href="classString.html">String</a>(), bool useOSNativeDialogBox=true, bool treatFilePackagesAsDirectories=false)</td></tr>
<tr class="memdesc:af8529e1ff1b0356734fcfcce139b92d1"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classFileChooser.html" title="Creates a dialog box to choose a file or directory to load or save. ">FileChooser</a>. <a href="#af8529e1ff1b0356734fcfcce139b92d1">More...</a><br /></td></tr>
<tr class="separator:af8529e1ff1b0356734fcfcce139b92d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67c94ae24fad94cf464d1283f33175d4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileChooser.html#a67c94ae24fad94cf464d1283f33175d4">~FileChooser</a> ()</td></tr>
<tr class="memdesc:a67c94ae24fad94cf464d1283f33175d4"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a67c94ae24fad94cf464d1283f33175d4">More...</a><br /></td></tr>
<tr class="separator:a67c94ae24fad94cf464d1283f33175d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a546ef74bcd139b67a90e4459cd591d21"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileChooser.html#a546ef74bcd139b67a90e4459cd591d21">browseForFileToOpen</a> (<a class="el" href="classFilePreviewComponent.html">FilePreviewComponent</a> *previewComponent=nullptr)</td></tr>
<tr class="memdesc:a546ef74bcd139b67a90e4459cd591d21"><td class="mdescLeft"> </td><td class="mdescRight">Shows a dialog box to choose a file to open. <a href="#a546ef74bcd139b67a90e4459cd591d21">More...</a><br /></td></tr>
<tr class="separator:a546ef74bcd139b67a90e4459cd591d21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5088972374f57336e534539f404e517e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileChooser.html#a5088972374f57336e534539f404e517e">browseForMultipleFilesToOpen</a> (<a class="el" href="classFilePreviewComponent.html">FilePreviewComponent</a> *previewComponent=nullptr)</td></tr>
<tr class="memdesc:a5088972374f57336e534539f404e517e"><td class="mdescLeft"> </td><td class="mdescRight">Same as browseForFileToOpen, but allows the user to select multiple files. <a href="#a5088972374f57336e534539f404e517e">More...</a><br /></td></tr>
<tr class="separator:a5088972374f57336e534539f404e517e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ccbbb48aefc471ea70c34f9ab18fcd1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileChooser.html#a1ccbbb48aefc471ea70c34f9ab18fcd1">browseForFileToSave</a> (bool warnAboutOverwritingExistingFiles)</td></tr>
<tr class="memdesc:a1ccbbb48aefc471ea70c34f9ab18fcd1"><td class="mdescLeft"> </td><td class="mdescRight">Shows a dialog box to choose a file to save. <a href="#a1ccbbb48aefc471ea70c34f9ab18fcd1">More...</a><br /></td></tr>
<tr class="separator:a1ccbbb48aefc471ea70c34f9ab18fcd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afdbce2d962f0c6c117d897e9e8687116"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileChooser.html#afdbce2d962f0c6c117d897e9e8687116">browseForDirectory</a> ()</td></tr>
<tr class="memdesc:afdbce2d962f0c6c117d897e9e8687116"><td class="mdescLeft"> </td><td class="mdescRight">Shows a dialog box to choose a directory. <a href="#afdbce2d962f0c6c117d897e9e8687116">More...</a><br /></td></tr>
<tr class="separator:afdbce2d962f0c6c117d897e9e8687116"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add78111ba95fce8ad0f3ab22a0338b30"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileChooser.html#add78111ba95fce8ad0f3ab22a0338b30">browseForMultipleFilesOrDirectories</a> (<a class="el" href="classFilePreviewComponent.html">FilePreviewComponent</a> *previewComponent=nullptr)</td></tr>
<tr class="memdesc:add78111ba95fce8ad0f3ab22a0338b30"><td class="mdescLeft"> </td><td class="mdescRight">Same as browseForFileToOpen, but allows the user to select multiple files and directories. <a href="#add78111ba95fce8ad0f3ab22a0338b30">More...</a><br /></td></tr>
<tr class="separator:add78111ba95fce8ad0f3ab22a0338b30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2510d29a867b3f9f5adfa90e17c88068"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileChooser.html#a2510d29a867b3f9f5adfa90e17c88068">showDialog</a> (int flags, <a class="el" href="classFilePreviewComponent.html">FilePreviewComponent</a> *previewComponent)</td></tr>
<tr class="memdesc:a2510d29a867b3f9f5adfa90e17c88068"><td class="mdescLeft"> </td><td class="mdescRight">Runs a dialog box for the given set of option flags. <a href="#a2510d29a867b3f9f5adfa90e17c88068">More...</a><br /></td></tr>
<tr class="separator:a2510d29a867b3f9f5adfa90e17c88068"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ece12c12985b388f4fe988cbccfade6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classFile.html">File</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileChooser.html#a0ece12c12985b388f4fe988cbccfade6">getResult</a> () const</td></tr>
<tr class="memdesc:a0ece12c12985b388f4fe988cbccfade6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last file that was chosen by one of the browseFor methods. <a href="#a0ece12c12985b388f4fe988cbccfade6">More...</a><br /></td></tr>
<tr class="separator:a0ece12c12985b388f4fe988cbccfade6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d8bd26e64a0af0b8d97c6ac2cabc1e2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classArray.html">Array</a>< <a class="el" href="classFile.html">File</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileChooser.html#a3d8bd26e64a0af0b8d97c6ac2cabc1e2">getResults</a> () const noexcept</td></tr>
<tr class="memdesc:a3d8bd26e64a0af0b8d97c6ac2cabc1e2"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of all the files that were chosen during the last call to a browse method. <a href="#a3d8bd26e64a0af0b8d97c6ac2cabc1e2">More...</a><br /></td></tr>
<tr class="separator:a3d8bd26e64a0af0b8d97c6ac2cabc1e2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Creates a dialog box to choose a file or directory to load or save. </p>
<p>To use a <a class="el" href="classFileChooser.html" title="Creates a dialog box to choose a file or directory to load or save. ">FileChooser</a>:</p><ul>
<li>create one (as a local stack variable is the neatest way)</li>
<li>call one of its browseFor.. methods</li>
<li>if this returns true, the user has selected a file, so you can retrieve it with the <a class="el" href="classFileChooser.html#a0ece12c12985b388f4fe988cbccfade6" title="Returns the last file that was chosen by one of the browseFor methods. ">getResult()</a> method.</li>
</ul>
<p>e.g.</p><div class="fragment"><div class="line"><span class="keywordtype">void</span> loadMooseFile()</div><div class="line">{</div><div class="line"> <a class="code" href="classFileChooser.html">FileChooser</a> myChooser (<span class="stringliteral">"Please select the moose you want to load..."</span>,</div><div class="line"> <a class="code" href="classFile.html#a2a4396bc0e6f8b0430f6f54d029899e5">File::getSpecialLocation</a> (<a class="code" href="classFile.html#a3e19cafabb03c5838160263a6e76313da8620eabc38cfbd921a52d10157463c5e">File::userHomeDirectory</a>),</div><div class="line"> <span class="stringliteral">"*.moose"</span>);</div><div class="line"></div><div class="line"> <span class="keywordflow">if</span> (myChooser.browseForFileToOpen())</div><div class="line"> {</div><div class="line"> <a class="code" href="classFile.html">File</a> mooseFile (myChooser.getResult());</div><div class="line"></div><div class="line"> loadMoose (mooseFile);</div><div class="line"> }</div><div class="line">}</div></div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="af8529e1ff1b0356734fcfcce139b92d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8529e1ff1b0356734fcfcce139b92d1">§ </a></span>FileChooser()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileChooser::FileChooser </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>dialogBoxTitle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>initialFileOrDirectory</em> = <code><a class="el" href="classFile.html">File</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>filePatternsAllowed</em> = <code><a class="el" href="classString.html">String</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>useOSNativeDialogBox</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>treatFilePackagesAsDirectories</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classFileChooser.html" title="Creates a dialog box to choose a file or directory to load or save. ">FileChooser</a>. </p>
<p>After creating one of these, use one of the browseFor... methods to display it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dialogBoxTitle</td><td>a text string to display in the dialog box to tell the user what's going on </td></tr>
<tr><td class="paramname">initialFileOrDirectory</td><td>the file or directory that should be selected when the dialog box opens. If this parameter is set to <a class="el" href="classFile.html" title="Represents a local file or directory. ">File()</a>, a sensible default directory will be used instead. </td></tr>
<tr><td class="paramname">filePatternsAllowed</td><td>a set of file patterns to specify which files can be selected - each pattern should be separated by a comma or semi-colon, e.g. "*" or "*.jpg;*.gif". An empty string means that all files are allowed </td></tr>
<tr><td class="paramname">useOSNativeDialogBox</td><td>if true, then a native dialog box will be used if possible; if false, then a Juce-based browser dialog box will always be used </td></tr>
<tr><td class="paramname">treatFilePackagesAsDirectories</td><td>if true, then the file chooser will allow the selection of files inside packages when invoked on OS X and when using native dialog boxes.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileChooser.html#a546ef74bcd139b67a90e4459cd591d21" title="Shows a dialog box to choose a file to open. ">browseForFileToOpen</a>, <a class="el" href="classFileChooser.html#a1ccbbb48aefc471ea70c34f9ab18fcd1" title="Shows a dialog box to choose a file to save. ">browseForFileToSave</a>, <a class="el" href="classFileChooser.html#afdbce2d962f0c6c117d897e9e8687116" title="Shows a dialog box to choose a directory. ">browseForDirectory</a> </dd></dl>
</div>
</div>
<a id="a67c94ae24fad94cf464d1283f33175d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67c94ae24fad94cf464d1283f33175d4">§ </a></span>~FileChooser()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileChooser::~FileChooser </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a546ef74bcd139b67a90e4459cd591d21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a546ef74bcd139b67a90e4459cd591d21">§ </a></span>browseForFileToOpen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FileChooser::browseForFileToOpen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classFilePreviewComponent.html">FilePreviewComponent</a> * </td>
<td class="paramname"><em>previewComponent</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows a dialog box to choose a file to open. </p>
<p>This will display the dialog box modally, using an "open file" mode, so that it won't allow non-existent files or directories to be chosen.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">previewComponent</td><td>an optional component to display inside the dialog box to show special info about the files that the user is browsing. The component will not be deleted by this object, so the caller must take care of it. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the user selected a file, in which case, use the <a class="el" href="classFileChooser.html#a0ece12c12985b388f4fe988cbccfade6" title="Returns the last file that was chosen by one of the browseFor methods. ">getResult()</a> method to find out what it was. Returns false if they cancelled instead. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileChooser.html#a1ccbbb48aefc471ea70c34f9ab18fcd1" title="Shows a dialog box to choose a file to save. ">browseForFileToSave</a>, <a class="el" href="classFileChooser.html#afdbce2d962f0c6c117d897e9e8687116" title="Shows a dialog box to choose a directory. ">browseForDirectory</a> </dd></dl>
<p>Referenced by <a class="el" href="classStandalonePluginHolder.html#ab55d4cd652306a2a344be38464a48358">StandalonePluginHolder::askUserToLoadState()</a>.</p>
</div>
</div>
<a id="a5088972374f57336e534539f404e517e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5088972374f57336e534539f404e517e">§ </a></span>browseForMultipleFilesToOpen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FileChooser::browseForMultipleFilesToOpen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classFilePreviewComponent.html">FilePreviewComponent</a> * </td>
<td class="paramname"><em>previewComponent</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Same as browseForFileToOpen, but allows the user to select multiple files. </p>
<p>The files that are returned can be obtained by calling <a class="el" href="classFileChooser.html#a3d8bd26e64a0af0b8d97c6ac2cabc1e2" title="Returns a list of all the files that were chosen during the last call to a browse method...">getResults()</a>. See <a class="el" href="classFileChooser.html#a546ef74bcd139b67a90e4459cd591d21" title="Shows a dialog box to choose a file to open. ">browseForFileToOpen()</a> for more info about the behaviour of this method. </p>
</div>
</div>
<a id="a1ccbbb48aefc471ea70c34f9ab18fcd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ccbbb48aefc471ea70c34f9ab18fcd1">§ </a></span>browseForFileToSave()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FileChooser::browseForFileToSave </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>warnAboutOverwritingExistingFiles</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows a dialog box to choose a file to save. </p>
<p>This will display the dialog box modally, using an "save file" mode, so it will allow non-existent files to be chosen, but not directories.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">warnAboutOverwritingExistingFiles</td><td>if true, the dialog box will ask the user if they're sure they want to overwrite a file that already exists </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the user chose a file and pressed 'ok', in which case, use the <a class="el" href="classFileChooser.html#a0ece12c12985b388f4fe988cbccfade6" title="Returns the last file that was chosen by one of the browseFor methods. ">getResult()</a> method to find out what the file was. Returns false if they cancelled instead. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileChooser.html#a546ef74bcd139b67a90e4459cd591d21" title="Shows a dialog box to choose a file to open. ">browseForFileToOpen</a>, <a class="el" href="classFileChooser.html#afdbce2d962f0c6c117d897e9e8687116" title="Shows a dialog box to choose a directory. ">browseForDirectory</a> </dd></dl>
<p>Referenced by <a class="el" href="classStandalonePluginHolder.html#ac28981bbac45dbae6c1fdf617a824c17">StandalonePluginHolder::askUserToSaveState()</a>.</p>
</div>
</div>
<a id="afdbce2d962f0c6c117d897e9e8687116"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdbce2d962f0c6c117d897e9e8687116">§ </a></span>browseForDirectory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FileChooser::browseForDirectory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows a dialog box to choose a directory. </p>
<p>This will display the dialog box modally, using an "open directory" mode, so it will only allow directories to be returned, not files.</p>
<dl class="section return"><dt>Returns</dt><dd>true if the user chose a directory and pressed 'ok', in which case, use the <a class="el" href="classFileChooser.html#a0ece12c12985b388f4fe988cbccfade6" title="Returns the last file that was chosen by one of the browseFor methods. ">getResult()</a> method to find out what they chose. Returns false if they cancelled instead. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileChooser.html#a546ef74bcd139b67a90e4459cd591d21" title="Shows a dialog box to choose a file to open. ">browseForFileToOpen</a>, <a class="el" href="classFileChooser.html#a1ccbbb48aefc471ea70c34f9ab18fcd1" title="Shows a dialog box to choose a file to save. ">browseForFileToSave</a> </dd></dl>
</div>
</div>
<a id="add78111ba95fce8ad0f3ab22a0338b30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add78111ba95fce8ad0f3ab22a0338b30">§ </a></span>browseForMultipleFilesOrDirectories()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FileChooser::browseForMultipleFilesOrDirectories </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classFilePreviewComponent.html">FilePreviewComponent</a> * </td>
<td class="paramname"><em>previewComponent</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Same as browseForFileToOpen, but allows the user to select multiple files and directories. </p>
<p>The files that are returned can be obtained by calling <a class="el" href="classFileChooser.html#a3d8bd26e64a0af0b8d97c6ac2cabc1e2" title="Returns a list of all the files that were chosen during the last call to a browse method...">getResults()</a>. See <a class="el" href="classFileChooser.html#a546ef74bcd139b67a90e4459cd591d21" title="Shows a dialog box to choose a file to open. ">browseForFileToOpen()</a> for more info about the behaviour of this method. </p>
</div>
</div>
<a id="a2510d29a867b3f9f5adfa90e17c88068"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2510d29a867b3f9f5adfa90e17c88068">§ </a></span>showDialog()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FileChooser::showDialog </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFilePreviewComponent.html">FilePreviewComponent</a> * </td>
<td class="paramname"><em>previewComponent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Runs a dialog box for the given set of option flags. </p>
<p>The flag values used are those in <a class="el" href="classFileBrowserComponent.html#a32888a950cc0e51c8e1350f53bea43d6" title="Various options for the browser. ">FileBrowserComponent::FileChooserFlags</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>true if the user chose a directory and pressed 'ok', in which case, use the <a class="el" href="classFileChooser.html#a0ece12c12985b388f4fe988cbccfade6" title="Returns the last file that was chosen by one of the browseFor methods. ">getResult()</a> method to find out what they chose. Returns false if they cancelled instead. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileBrowserComponent.html#a32888a950cc0e51c8e1350f53bea43d6" title="Various options for the browser. ">FileBrowserComponent::FileChooserFlags</a> </dd></dl>
</div>
</div>
<a id="a0ece12c12985b388f4fe988cbccfade6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ece12c12985b388f4fe988cbccfade6">§ </a></span>getResult()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classFile.html">File</a> FileChooser::getResult </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the last file that was chosen by one of the browseFor methods. </p>
<p>After calling the appropriate browseFor... method, this method lets you find out what file or directory they chose.</p>
<p>Note that the file returned is only valid if the browse method returned true (i.e. if the user pressed 'ok' rather than cancelling).</p>
<p>If you're using a multiple-file select, then use the <a class="el" href="classFileChooser.html#a3d8bd26e64a0af0b8d97c6ac2cabc1e2" title="Returns a list of all the files that were chosen during the last call to a browse method...">getResults()</a> method instead, to obtain the list of all files chosen.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileChooser.html#a3d8bd26e64a0af0b8d97c6ac2cabc1e2" title="Returns a list of all the files that were chosen during the last call to a browse method...">getResults</a> </dd></dl>
<p>Referenced by <a class="el" href="classStandalonePluginHolder.html#ab55d4cd652306a2a344be38464a48358">StandalonePluginHolder::askUserToLoadState()</a>, <a class="el" href="classStandalonePluginHolder.html#ac28981bbac45dbae6c1fdf617a824c17">StandalonePluginHolder::askUserToSaveState()</a>, and <a class="el" href="classStandalonePluginHolder.html#a51b7121cdd9169e12d633fd09930ad86">StandalonePluginHolder::setLastFile()</a>.</p>
</div>
</div>
<a id="a3d8bd26e64a0af0b8d97c6ac2cabc1e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d8bd26e64a0af0b8d97c6ac2cabc1e2">§ </a></span>getResults()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classArray.html">Array</a><<a class="el" href="classFile.html">File</a>>& FileChooser::getResults </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a list of all the files that were chosen during the last call to a browse method. </p>
<p>This array may be empty if no files were chosen, or can contain multiple entries if multiple files were chosen.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileChooser.html#a0ece12c12985b388f4fe988cbccfade6" title="Returns the last file that was chosen by one of the browseFor methods. ">getResult</a> </dd></dl>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__FileChooser_8h.html">juce_FileChooser.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|