/usr/share/doc/libjuce/apiref/classFileSearchPath.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 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 | <!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: FileSearchPath 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="classFileSearchPath-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FileSearchPath Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Represents a set of folders that make up a search path.
<a href="classFileSearchPath.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:a37b486aaabdae9e71f69310bcd32de79"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#a37b486aaabdae9e71f69310bcd32de79">FileSearchPath</a> ()</td></tr>
<tr class="memdesc:a37b486aaabdae9e71f69310bcd32de79"><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty search path. <a href="#a37b486aaabdae9e71f69310bcd32de79">More...</a><br /></td></tr>
<tr class="separator:a37b486aaabdae9e71f69310bcd32de79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55b79d55adaa7a4635063088eb00dd2c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#a55b79d55adaa7a4635063088eb00dd2c">FileSearchPath</a> (const <a class="el" href="classString.html">String</a> &path)</td></tr>
<tr class="memdesc:a55b79d55adaa7a4635063088eb00dd2c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a search path from a string of pathnames. <a href="#a55b79d55adaa7a4635063088eb00dd2c">More...</a><br /></td></tr>
<tr class="separator:a55b79d55adaa7a4635063088eb00dd2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf195d380fc36f55aee083319546611e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#aaf195d380fc36f55aee083319546611e">FileSearchPath</a> (const <a class="el" href="classFileSearchPath.html">FileSearchPath</a> &)</td></tr>
<tr class="memdesc:aaf195d380fc36f55aee083319546611e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of another search path. <a href="#aaf195d380fc36f55aee083319546611e">More...</a><br /></td></tr>
<tr class="separator:aaf195d380fc36f55aee083319546611e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5d93b9e93c1e3d9ea54737bd10a28f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classFileSearchPath.html">FileSearchPath</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#ad5d93b9e93c1e3d9ea54737bd10a28f3">operator=</a> (const <a class="el" href="classFileSearchPath.html">FileSearchPath</a> &)</td></tr>
<tr class="memdesc:ad5d93b9e93c1e3d9ea54737bd10a28f3"><td class="mdescLeft"> </td><td class="mdescRight">Copies another search path. <a href="#ad5d93b9e93c1e3d9ea54737bd10a28f3">More...</a><br /></td></tr>
<tr class="separator:ad5d93b9e93c1e3d9ea54737bd10a28f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aefab78766a187af30986836b9ba1f70d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#aefab78766a187af30986836b9ba1f70d">~FileSearchPath</a> ()</td></tr>
<tr class="memdesc:aefab78766a187af30986836b9ba1f70d"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aefab78766a187af30986836b9ba1f70d">More...</a><br /></td></tr>
<tr class="separator:aefab78766a187af30986836b9ba1f70d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a663c28591c30e3f2f3c9ce07bdb680f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classFileSearchPath.html">FileSearchPath</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#a663c28591c30e3f2f3c9ce07bdb680f9">operator=</a> (const <a class="el" href="classString.html">String</a> &path)</td></tr>
<tr class="memdesc:a663c28591c30e3f2f3c9ce07bdb680f9"><td class="mdescLeft"> </td><td class="mdescRight">Uses a string containing a list of pathnames to re-initialise this list. <a href="#a663c28591c30e3f2f3c9ce07bdb680f9">More...</a><br /></td></tr>
<tr class="separator:a663c28591c30e3f2f3c9ce07bdb680f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd25b8de445d64fc29f30f7802b470f1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#afd25b8de445d64fc29f30f7802b470f1">getNumPaths</a> () const</td></tr>
<tr class="memdesc:afd25b8de445d64fc29f30f7802b470f1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of folders in this search path. <a href="#afd25b8de445d64fc29f30f7802b470f1">More...</a><br /></td></tr>
<tr class="separator:afd25b8de445d64fc29f30f7802b470f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a171b446c7a743310fd2818d730f6444d"><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="classFileSearchPath.html#a171b446c7a743310fd2818d730f6444d">operator[]</a> (int index) const</td></tr>
<tr class="memdesc:a171b446c7a743310fd2818d730f6444d"><td class="mdescLeft"> </td><td class="mdescRight">Returns one of the folders in this search path. <a href="#a171b446c7a743310fd2818d730f6444d">More...</a><br /></td></tr>
<tr class="separator:a171b446c7a743310fd2818d730f6444d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b2dacd5614579ccd6b95be62527dc04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#a5b2dacd5614579ccd6b95be62527dc04">toString</a> () const</td></tr>
<tr class="memdesc:a5b2dacd5614579ccd6b95be62527dc04"><td class="mdescLeft"> </td><td class="mdescRight">Returns the search path as a semicolon-separated list of directories. <a href="#a5b2dacd5614579ccd6b95be62527dc04">More...</a><br /></td></tr>
<tr class="separator:a5b2dacd5614579ccd6b95be62527dc04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a045b18e60858ac874c9fbf4b28c4f52f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#a045b18e60858ac874c9fbf4b28c4f52f">add</a> (const <a class="el" href="classFile.html">File</a> &directoryToAdd, int insertIndex=-1)</td></tr>
<tr class="memdesc:a045b18e60858ac874c9fbf4b28c4f52f"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new directory to the search path. <a href="#a045b18e60858ac874c9fbf4b28c4f52f">More...</a><br /></td></tr>
<tr class="separator:a045b18e60858ac874c9fbf4b28c4f52f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9866aba263d485fb846a8867f0aa7f8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#ac9866aba263d485fb846a8867f0aa7f8">addIfNotAlreadyThere</a> (const <a class="el" href="classFile.html">File</a> &directoryToAdd)</td></tr>
<tr class="memdesc:ac9866aba263d485fb846a8867f0aa7f8"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new directory to the search path if it's not already in there. <a href="#ac9866aba263d485fb846a8867f0aa7f8">More...</a><br /></td></tr>
<tr class="separator:ac9866aba263d485fb846a8867f0aa7f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad560bd8c08782e3eb0ead50ee2793161"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#ad560bd8c08782e3eb0ead50ee2793161">remove</a> (int indexToRemove)</td></tr>
<tr class="memdesc:ad560bd8c08782e3eb0ead50ee2793161"><td class="mdescLeft"> </td><td class="mdescRight">Removes a directory from the search path. <a href="#ad560bd8c08782e3eb0ead50ee2793161">More...</a><br /></td></tr>
<tr class="separator:ad560bd8c08782e3eb0ead50ee2793161"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba4ddf6a796bd97a7254f1019b3af9f5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#aba4ddf6a796bd97a7254f1019b3af9f5">addPath</a> (const <a class="el" href="classFileSearchPath.html">FileSearchPath</a> &)</td></tr>
<tr class="memdesc:aba4ddf6a796bd97a7254f1019b3af9f5"><td class="mdescLeft"> </td><td class="mdescRight">Merges another search path into this one. <a href="#aba4ddf6a796bd97a7254f1019b3af9f5">More...</a><br /></td></tr>
<tr class="separator:aba4ddf6a796bd97a7254f1019b3af9f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada0f0c385326ce152cf1b23c39b31516"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#ada0f0c385326ce152cf1b23c39b31516">removeRedundantPaths</a> ()</td></tr>
<tr class="memdesc:ada0f0c385326ce152cf1b23c39b31516"><td class="mdescLeft"> </td><td class="mdescRight">Removes any directories that are actually subdirectories of one of the other directories in the search path. <a href="#ada0f0c385326ce152cf1b23c39b31516">More...</a><br /></td></tr>
<tr class="separator:ada0f0c385326ce152cf1b23c39b31516"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a3170aadec6b3dd9b2d5c263f87b9bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#a9a3170aadec6b3dd9b2d5c263f87b9bf">removeNonExistentPaths</a> ()</td></tr>
<tr class="memdesc:a9a3170aadec6b3dd9b2d5c263f87b9bf"><td class="mdescLeft"> </td><td class="mdescRight">Removes any directories that don't actually exist. <a href="#a9a3170aadec6b3dd9b2d5c263f87b9bf">More...</a><br /></td></tr>
<tr class="separator:a9a3170aadec6b3dd9b2d5c263f87b9bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68580a1f306b974eb216e96a1df82753"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#a68580a1f306b974eb216e96a1df82753">findChildFiles</a> (<a class="el" href="classArray.html">Array</a>< <a class="el" href="classFile.html">File</a> > &results, int whatToLookFor, bool searchRecursively, const <a class="el" href="classString.html">String</a> &wildCardPattern="*") const</td></tr>
<tr class="memdesc:a68580a1f306b974eb216e96a1df82753"><td class="mdescLeft"> </td><td class="mdescRight">Searches the path for a wildcard. <a href="#a68580a1f306b974eb216e96a1df82753">More...</a><br /></td></tr>
<tr class="separator:a68580a1f306b974eb216e96a1df82753"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa469c750b772fb1493df850d73812b15"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileSearchPath.html#aa469c750b772fb1493df850d73812b15">isFileInPath</a> (const <a class="el" href="classFile.html">File</a> &fileToCheck, bool checkRecursively) const</td></tr>
<tr class="memdesc:aa469c750b772fb1493df850d73812b15"><td class="mdescLeft"> </td><td class="mdescRight">Finds out whether a file is inside one of the path's directories. <a href="#aa469c750b772fb1493df850d73812b15">More...</a><br /></td></tr>
<tr class="separator:aa469c750b772fb1493df850d73812b15"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a set of folders that make up a search path. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFile.html" title="Represents a local file or directory. ">File</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a37b486aaabdae9e71f69310bcd32de79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37b486aaabdae9e71f69310bcd32de79">§ </a></span>FileSearchPath() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileSearchPath::FileSearchPath </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an empty search path. </p>
</div>
</div>
<a id="a55b79d55adaa7a4635063088eb00dd2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55b79d55adaa7a4635063088eb00dd2c">§ </a></span>FileSearchPath() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileSearchPath::FileSearchPath </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a search path from a string of pathnames. </p>
<p>The path can be semicolon- or comma-separated, e.g. "/foo/bar;/foo/moose;/fish/moose"</p>
<p>The separate folders are tokenised and added to the search path. </p>
</div>
</div>
<a id="aaf195d380fc36f55aee083319546611e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf195d380fc36f55aee083319546611e">§ </a></span>FileSearchPath() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileSearchPath::FileSearchPath </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFileSearchPath.html">FileSearchPath</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a copy of another search path. </p>
</div>
</div>
<a id="aefab78766a187af30986836b9ba1f70d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefab78766a187af30986836b9ba1f70d">§ </a></span>~FileSearchPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileSearchPath::~FileSearchPath </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="ad5d93b9e93c1e3d9ea54737bd10a28f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5d93b9e93c1e3d9ea54737bd10a28f3">§ </a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classFileSearchPath.html">FileSearchPath</a>& FileSearchPath::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFileSearchPath.html">FileSearchPath</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies another search path. </p>
</div>
</div>
<a id="a663c28591c30e3f2f3c9ce07bdb680f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a663c28591c30e3f2f3c9ce07bdb680f9">§ </a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classFileSearchPath.html">FileSearchPath</a>& FileSearchPath::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uses a string containing a list of pathnames to re-initialise this list. </p>
<p>This search path is cleared and the semicolon- or comma-separated folders in this string are added instead. e.g. "/foo/bar;/foo/moose;/fish/moose" </p>
</div>
</div>
<a id="afd25b8de445d64fc29f30f7802b470f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd25b8de445d64fc29f30f7802b470f1">§ </a></span>getNumPaths()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FileSearchPath::getNumPaths </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of folders in this search path. </p>
<dl class="section see"><dt>See also</dt><dd>operator[] </dd></dl>
</div>
</div>
<a id="a171b446c7a743310fd2818d730f6444d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a171b446c7a743310fd2818d730f6444d">§ </a></span>operator[]()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classFile.html">File</a> FileSearchPath::operator[] </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns one of the folders in this search path. </p>
<p>The file returned isn't guaranteed to actually be a valid directory. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileSearchPath.html#afd25b8de445d64fc29f30f7802b470f1" title="Returns the number of folders in this search path. ">getNumPaths</a> </dd></dl>
</div>
</div>
<a id="a5b2dacd5614579ccd6b95be62527dc04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b2dacd5614579ccd6b95be62527dc04">§ </a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> FileSearchPath::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the search path as a semicolon-separated list of directories. </p>
</div>
</div>
<a id="a045b18e60858ac874c9fbf4b28c4f52f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a045b18e60858ac874c9fbf4b28c4f52f">§ </a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileSearchPath::add </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>directoryToAdd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>insertIndex</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new directory to the search path. </p>
<p>The new directory is added to the end of the list if the insertIndex parameter is less than zero, otherwise it is inserted at the given index. </p>
</div>
</div>
<a id="ac9866aba263d485fb846a8867f0aa7f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9866aba263d485fb846a8867f0aa7f8">§ </a></span>addIfNotAlreadyThere()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FileSearchPath::addIfNotAlreadyThere </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>directoryToAdd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new directory to the search path if it's not already in there. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the directory has been added, false otherwise. </dd></dl>
</div>
</div>
<a id="ad560bd8c08782e3eb0ead50ee2793161"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad560bd8c08782e3eb0ead50ee2793161">§ </a></span>remove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileSearchPath::remove </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>indexToRemove</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a directory from the search path. </p>
</div>
</div>
<a id="aba4ddf6a796bd97a7254f1019b3af9f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba4ddf6a796bd97a7254f1019b3af9f5">§ </a></span>addPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileSearchPath::addPath </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFileSearchPath.html">FileSearchPath</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Merges another search path into this one. </p>
<p>This will remove any duplicate directories. </p>
</div>
</div>
<a id="ada0f0c385326ce152cf1b23c39b31516"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada0f0c385326ce152cf1b23c39b31516">§ </a></span>removeRedundantPaths()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileSearchPath::removeRedundantPaths </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes any directories that are actually subdirectories of one of the other directories in the search path. </p>
<p>If the search is intended to be recursive, there's no point having nested folders in the search path, because they'll just get searched twice and you'll get duplicate results.</p>
<p>e.g. if the path is "c:\abc\de;c:\abc", this method will simplify it to "c:\abc" </p>
</div>
</div>
<a id="a9a3170aadec6b3dd9b2d5c263f87b9bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a3170aadec6b3dd9b2d5c263f87b9bf">§ </a></span>removeNonExistentPaths()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileSearchPath::removeNonExistentPaths </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes any directories that don't actually exist. </p>
</div>
</div>
<a id="a68580a1f306b974eb216e96a1df82753"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68580a1f306b974eb216e96a1df82753">§ </a></span>findChildFiles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FileSearchPath::findChildFiles </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classArray.html">Array</a>< <a class="el" href="classFile.html">File</a> > & </td>
<td class="paramname"><em>results</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>whatToLookFor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>searchRecursively</em>, </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>wildCardPattern</em> = <code>"*"</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Searches the path for a wildcard. </p>
<p>This will search all the directories in the search path in order, adding any matching files to the results array.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">results</td><td>an array to append the results to </td></tr>
<tr><td class="paramname">whatToLookFor</td><td>a value from the <a class="el" href="classFile.html#a2e3d1ed8a9022434f3ddb7d34b24198c" title="Used in file searching, to specify whether to return files, directories, or both. ...">File::TypesOfFileToFind</a> enum, specifying whether to return files, directories, or both. </td></tr>
<tr><td class="paramname">searchRecursively</td><td>whether to recursively search the subdirectories too </td></tr>
<tr><td class="paramname">wildCardPattern</td><td>a pattern to match against the filenames </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of files added to the array </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFile.html#ac7bd6757b80471ad413c7b1d2473722d" title="Searches inside a directory for files matching a wildcard pattern. ">File::findChildFiles</a> </dd></dl>
</div>
</div>
<a id="aa469c750b772fb1493df850d73812b15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa469c750b772fb1493df850d73812b15">§ </a></span>isFileInPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FileSearchPath::isFileInPath </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>fileToCheck</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>checkRecursively</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds out whether a file is inside one of the path's directories. </p>
<p>This will return true if the specified file is a child of one of the directories specified by this path. Note that this doesn't actually do any searching or check that the files exist - it just looks at the pathnames to work out whether the file would be inside a directory.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fileToCheck</td><td>the file to look for </td></tr>
<tr><td class="paramname">checkRecursively</td><td>if true, then this will return true if the file is inside a subfolder of one of the path's directories (at any depth). If false it will only return true if the file is actually a direct child of one of the directories. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFile.html#aa64c59bb5e4e640f43de0f27c346e766" title="Checks whether a file is somewhere inside a directory. ">File::isAChildOf</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__FileSearchPath_8h.html">juce_FileSearchPath.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|