/usr/share/doc/libjuce/apiref/classPropertiesFile.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 | <!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: PropertiesFile 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="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classPropertiesFile-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PropertiesFile Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Wrapper on a file that stores a list of key/value data pairs.
<a href="classPropertiesFile.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for PropertiesFile:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classPropertiesFile.png" usemap="#PropertiesFile_map" alt=""/>
<map id="PropertiesFile_map" name="PropertiesFile_map">
<area href="classPropertySet.html" title="A set of named property values, which can be strings, integers, floating point, etc. " alt="PropertySet" shape="rect" coords="0,0,125,24"/>
<area href="classChangeBroadcaster.html" title="Holds a list of ChangeListeners, and sends messages to them when instructed. " alt="ChangeBroadcaster" shape="rect" coords="135,0,260,24"/>
<area href="classTimer.html" title="Makes repeated callbacks to a virtual method at a specified time interval. " alt="Timer" shape="rect" coords="270,0,395,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPropertiesFile_1_1Options.html">Options</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac4d1ac9a6b624f7e0de7787de46dc05e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#ac4d1ac9a6b624f7e0de7787de46dc05e">StorageFormat</a> { <a class="el" href="classPropertiesFile.html#ac4d1ac9a6b624f7e0de7787de46dc05eadd1552fd266d926522dfa0e162de5328">storeAsBinary</a>,
<a class="el" href="classPropertiesFile.html#ac4d1ac9a6b624f7e0de7787de46dc05eab1ddcaf9fc8d45b4141749e325844f42">storeAsCompressedBinary</a>,
<a class="el" href="classPropertiesFile.html#ac4d1ac9a6b624f7e0de7787de46dc05eab0145370e12c4174bd36dc6ac6ccc147">storeAsXML</a>
}</td></tr>
<tr class="separator:ac4d1ac9a6b624f7e0de7787de46dc05e"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a8e47a02c7600f3758f600ed2376589a4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#a8e47a02c7600f3758f600ed2376589a4">PropertiesFile</a> (const <a class="el" href="structPropertiesFile_1_1Options.html">Options</a> &options)</td></tr>
<tr class="memdesc:a8e47a02c7600f3758f600ed2376589a4"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classPropertiesFile.html" title="Wrapper on a file that stores a list of key/value data pairs. ">PropertiesFile</a> object. <a href="#a8e47a02c7600f3758f600ed2376589a4">More...</a><br /></td></tr>
<tr class="separator:a8e47a02c7600f3758f600ed2376589a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf3dbec910950b70fe405cc51f7a10e6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#acf3dbec910950b70fe405cc51f7a10e6">PropertiesFile</a> (const <a class="el" href="classFile.html">File</a> &file, const <a class="el" href="structPropertiesFile_1_1Options.html">Options</a> &options)</td></tr>
<tr class="memdesc:acf3dbec910950b70fe405cc51f7a10e6"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classPropertiesFile.html" title="Wrapper on a file that stores a list of key/value data pairs. ">PropertiesFile</a> object. <a href="#acf3dbec910950b70fe405cc51f7a10e6">More...</a><br /></td></tr>
<tr class="separator:acf3dbec910950b70fe405cc51f7a10e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a449b6cc48f72e8d14c73dd4ac9964635"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#a449b6cc48f72e8d14c73dd4ac9964635">~PropertiesFile</a> ()</td></tr>
<tr class="memdesc:a449b6cc48f72e8d14c73dd4ac9964635"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a449b6cc48f72e8d14c73dd4ac9964635">More...</a><br /></td></tr>
<tr class="separator:a449b6cc48f72e8d14c73dd4ac9964635"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31ca79cdb1a4b7c9863d981c9b438904"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#a31ca79cdb1a4b7c9863d981c9b438904">isValidFile</a> () const noexcept</td></tr>
<tr class="memdesc:a31ca79cdb1a4b7c9863d981c9b438904"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this file was created from a valid (or non-existent) file. <a href="#a31ca79cdb1a4b7c9863d981c9b438904">More...</a><br /></td></tr>
<tr class="separator:a31ca79cdb1a4b7c9863d981c9b438904"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61b439f35faf3f1add5cdfdd49a85d49"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#a61b439f35faf3f1add5cdfdd49a85d49">saveIfNeeded</a> ()</td></tr>
<tr class="memdesc:a61b439f35faf3f1add5cdfdd49a85d49"><td class="mdescLeft"> </td><td class="mdescRight">This will flush all the values to disk if they've changed since the last time they were saved. <a href="#a61b439f35faf3f1add5cdfdd49a85d49">More...</a><br /></td></tr>
<tr class="separator:a61b439f35faf3f1add5cdfdd49a85d49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0c24e1809b203c8347ee07cfb599250"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#ad0c24e1809b203c8347ee07cfb599250">save</a> ()</td></tr>
<tr class="memdesc:ad0c24e1809b203c8347ee07cfb599250"><td class="mdescLeft"> </td><td class="mdescRight">This will force a write-to-disk of the current values, regardless of whether anything has changed since the last save. <a href="#ad0c24e1809b203c8347ee07cfb599250">More...</a><br /></td></tr>
<tr class="separator:ad0c24e1809b203c8347ee07cfb599250"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47742aee82eacbc1259a93df9b0d2ad4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#a47742aee82eacbc1259a93df9b0d2ad4">needsToBeSaved</a> () const</td></tr>
<tr class="memdesc:a47742aee82eacbc1259a93df9b0d2ad4"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the properties have been altered since the last time they were saved. <a href="#a47742aee82eacbc1259a93df9b0d2ad4">More...</a><br /></td></tr>
<tr class="separator:a47742aee82eacbc1259a93df9b0d2ad4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a205cb3e66cef5d064578dc22b8b205cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#a205cb3e66cef5d064578dc22b8b205cb">setNeedsToBeSaved</a> (bool <a class="el" href="classPropertiesFile.html#a47742aee82eacbc1259a93df9b0d2ad4">needsToBeSaved</a>)</td></tr>
<tr class="memdesc:a205cb3e66cef5d064578dc22b8b205cb"><td class="mdescLeft"> </td><td class="mdescRight">Explicitly sets the flag to indicate whether the file needs saving or not. <a href="#a205cb3e66cef5d064578dc22b8b205cb">More...</a><br /></td></tr>
<tr class="separator:a205cb3e66cef5d064578dc22b8b205cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb0e0d0ea6f6c820719ef8542440e846"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#abb0e0d0ea6f6c820719ef8542440e846">reload</a> ()</td></tr>
<tr class="memdesc:abb0e0d0ea6f6c820719ef8542440e846"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to reload the settings from the file. <a href="#abb0e0d0ea6f6c820719ef8542440e846">More...</a><br /></td></tr>
<tr class="separator:abb0e0d0ea6f6c820719ef8542440e846"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c42d4ae2b3c11517c8c734de5067815"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classFile.html">File</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#a8c42d4ae2b3c11517c8c734de5067815">getFile</a> () const noexcept</td></tr>
<tr class="memdesc:a8c42d4ae2b3c11517c8c734de5067815"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file that's being used. <a href="#a8c42d4ae2b3c11517c8c734de5067815">More...</a><br /></td></tr>
<tr class="separator:a8c42d4ae2b3c11517c8c734de5067815"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classPropertySet"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPropertySet')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classPropertySet.html">PropertySet</a></td></tr>
<tr class="memitem:a8e91a4cff9a69a96f7957c038b919870 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a8e91a4cff9a69a96f7957c038b919870">PropertySet</a> (bool ignoreCaseOfKeyNames=false)</td></tr>
<tr class="memdesc:a8e91a4cff9a69a96f7957c038b919870 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty <a class="el" href="classPropertySet.html" title="A set of named property values, which can be strings, integers, floating point, etc. ">PropertySet</a>. <a href="classPropertySet.html#a8e91a4cff9a69a96f7957c038b919870">More...</a><br /></td></tr>
<tr class="separator:a8e91a4cff9a69a96f7957c038b919870 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a85f11257e712b1fc4074a9e2dbc24e71 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a85f11257e712b1fc4074a9e2dbc24e71">PropertySet</a> (const <a class="el" href="classPropertySet.html">PropertySet</a> &other)</td></tr>
<tr class="memdesc:a85f11257e712b1fc4074a9e2dbc24e71 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of another <a class="el" href="classPropertySet.html" title="A set of named property values, which can be strings, integers, floating point, etc. ">PropertySet</a>. <a href="classPropertySet.html#a85f11257e712b1fc4074a9e2dbc24e71">More...</a><br /></td></tr>
<tr class="separator:a85f11257e712b1fc4074a9e2dbc24e71 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11163a300c9d6d483f073f9e004fe89b inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPropertySet.html">PropertySet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a11163a300c9d6d483f073f9e004fe89b">operator=</a> (const <a class="el" href="classPropertySet.html">PropertySet</a> &other)</td></tr>
<tr class="memdesc:a11163a300c9d6d483f073f9e004fe89b inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Copies another <a class="el" href="classPropertySet.html" title="A set of named property values, which can be strings, integers, floating point, etc. ">PropertySet</a> over this one. <a href="classPropertySet.html#a11163a300c9d6d483f073f9e004fe89b">More...</a><br /></td></tr>
<tr class="separator:a11163a300c9d6d483f073f9e004fe89b inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9243fb6fb5a71e6795f3bbda95f009e6 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a9243fb6fb5a71e6795f3bbda95f009e6">~PropertySet</a> ()</td></tr>
<tr class="memdesc:a9243fb6fb5a71e6795f3bbda95f009e6 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classPropertySet.html#a9243fb6fb5a71e6795f3bbda95f009e6">More...</a><br /></td></tr>
<tr class="separator:a9243fb6fb5a71e6795f3bbda95f009e6 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa005ac125096ad476021d347f56ff4c inherit pub_methods_classPropertySet"><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="classPropertySet.html#afa005ac125096ad476021d347f56ff4c">getValue</a> (<a class="el" href="classStringRef.html">StringRef</a> keyName, const <a class="el" href="classString.html">String</a> &defaultReturnValue=<a class="el" href="classString.html">String</a>()) const noexcept</td></tr>
<tr class="memdesc:afa005ac125096ad476021d347f56ff4c inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Returns one of the properties as a string. <a href="classPropertySet.html#afa005ac125096ad476021d347f56ff4c">More...</a><br /></td></tr>
<tr class="separator:afa005ac125096ad476021d347f56ff4c inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02ea38c1de947931c2112bd81eb73ba1 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a02ea38c1de947931c2112bd81eb73ba1">getIntValue</a> (<a class="el" href="classStringRef.html">StringRef</a> keyName, int defaultReturnValue=0) const noexcept</td></tr>
<tr class="memdesc:a02ea38c1de947931c2112bd81eb73ba1 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Returns one of the properties as an integer. <a href="classPropertySet.html#a02ea38c1de947931c2112bd81eb73ba1">More...</a><br /></td></tr>
<tr class="separator:a02ea38c1de947931c2112bd81eb73ba1 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae72eedbd509bfd112e8b5e214b9d66d inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#aae72eedbd509bfd112e8b5e214b9d66d">getDoubleValue</a> (<a class="el" href="classStringRef.html">StringRef</a> keyName, double defaultReturnValue=0.0) const noexcept</td></tr>
<tr class="memdesc:aae72eedbd509bfd112e8b5e214b9d66d inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Returns one of the properties as an double. <a href="classPropertySet.html#aae72eedbd509bfd112e8b5e214b9d66d">More...</a><br /></td></tr>
<tr class="separator:aae72eedbd509bfd112e8b5e214b9d66d inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5df72070f494ea3415361c43538bdac inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#aa5df72070f494ea3415361c43538bdac">getBoolValue</a> (<a class="el" href="classStringRef.html">StringRef</a> keyName, bool defaultReturnValue=false) const noexcept</td></tr>
<tr class="memdesc:aa5df72070f494ea3415361c43538bdac inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Returns one of the properties as an boolean. <a href="classPropertySet.html#aa5df72070f494ea3415361c43538bdac">More...</a><br /></td></tr>
<tr class="separator:aa5df72070f494ea3415361c43538bdac inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4dd64a37af3c650082da6e5ece173653 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXmlElement.html">XmlElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a4dd64a37af3c650082da6e5ece173653">getXmlValue</a> (<a class="el" href="classStringRef.html">StringRef</a> keyName) const</td></tr>
<tr class="memdesc:a4dd64a37af3c650082da6e5ece173653 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Returns one of the properties as an XML element. <a href="classPropertySet.html#a4dd64a37af3c650082da6e5ece173653">More...</a><br /></td></tr>
<tr class="separator:a4dd64a37af3c650082da6e5ece173653 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a696515de52c7310117e7914a02b58e57 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a696515de52c7310117e7914a02b58e57">setValue</a> (const <a class="el" href="classString.html">String</a> &keyName, const <a class="el" href="classvar.html">var</a> &value)</td></tr>
<tr class="memdesc:a696515de52c7310117e7914a02b58e57 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Sets a named property. <a href="classPropertySet.html#a696515de52c7310117e7914a02b58e57">More...</a><br /></td></tr>
<tr class="separator:a696515de52c7310117e7914a02b58e57 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64fb29cf07186f48e599afe7108f85e5 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a64fb29cf07186f48e599afe7108f85e5">setValue</a> (const <a class="el" href="classString.html">String</a> &keyName, const <a class="el" href="classXmlElement.html">XmlElement</a> *xml)</td></tr>
<tr class="memdesc:a64fb29cf07186f48e599afe7108f85e5 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Sets a named property to an XML element. <a href="classPropertySet.html#a64fb29cf07186f48e599afe7108f85e5">More...</a><br /></td></tr>
<tr class="separator:a64fb29cf07186f48e599afe7108f85e5 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a340892a4bda637623401fe97035c1eb5 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a340892a4bda637623401fe97035c1eb5">addAllPropertiesFrom</a> (const <a class="el" href="classPropertySet.html">PropertySet</a> &source)</td></tr>
<tr class="memdesc:a340892a4bda637623401fe97035c1eb5 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">This copies all the values from a source <a class="el" href="classPropertySet.html" title="A set of named property values, which can be strings, integers, floating point, etc. ">PropertySet</a> to this one. <a href="classPropertySet.html#a340892a4bda637623401fe97035c1eb5">More...</a><br /></td></tr>
<tr class="separator:a340892a4bda637623401fe97035c1eb5 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7240c496cbcba40f561d73aa32f40ce6 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a7240c496cbcba40f561d73aa32f40ce6">removeValue</a> (<a class="el" href="classStringRef.html">StringRef</a> keyName)</td></tr>
<tr class="memdesc:a7240c496cbcba40f561d73aa32f40ce6 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a property. <a href="classPropertySet.html#a7240c496cbcba40f561d73aa32f40ce6">More...</a><br /></td></tr>
<tr class="separator:a7240c496cbcba40f561d73aa32f40ce6 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e9e8acded2871bdb78f7ce404879c6b inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a8e9e8acded2871bdb78f7ce404879c6b">containsKey</a> (<a class="el" href="classStringRef.html">StringRef</a> keyName) const noexcept</td></tr>
<tr class="memdesc:a8e9e8acded2871bdb78f7ce404879c6b inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the properies include the given key. <a href="classPropertySet.html#a8e9e8acded2871bdb78f7ce404879c6b">More...</a><br /></td></tr>
<tr class="separator:a8e9e8acded2871bdb78f7ce404879c6b inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17bc35d7608a5dcce584d2eace3096d9 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a17bc35d7608a5dcce584d2eace3096d9">clear</a> ()</td></tr>
<tr class="memdesc:a17bc35d7608a5dcce584d2eace3096d9 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Removes all values. <a href="classPropertySet.html#a17bc35d7608a5dcce584d2eace3096d9">More...</a><br /></td></tr>
<tr class="separator:a17bc35d7608a5dcce584d2eace3096d9 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8323d944277335563739d934de3cc9d inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classStringPairArray.html">StringPairArray</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#ae8323d944277335563739d934de3cc9d">getAllProperties</a> () noexcept</td></tr>
<tr class="memdesc:ae8323d944277335563739d934de3cc9d inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Returns the keys/value pair array containing all the properties. <a href="classPropertySet.html#ae8323d944277335563739d934de3cc9d">More...</a><br /></td></tr>
<tr class="separator:ae8323d944277335563739d934de3cc9d inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b371714834842b485583c305f2d5602 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCriticalSection.html">CriticalSection</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a3b371714834842b485583c305f2d5602">getLock</a> () const noexcept</td></tr>
<tr class="memdesc:a3b371714834842b485583c305f2d5602 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Returns the lock used when reading or writing to this set. <a href="classPropertySet.html#a3b371714834842b485583c305f2d5602">More...</a><br /></td></tr>
<tr class="separator:a3b371714834842b485583c305f2d5602 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a911a7396412e5bb5e93dfcf56286e758 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXmlElement.html">XmlElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a911a7396412e5bb5e93dfcf56286e758">createXml</a> (const <a class="el" href="classString.html">String</a> &nodeName) const</td></tr>
<tr class="memdesc:a911a7396412e5bb5e93dfcf56286e758 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Returns an XML element which encapsulates all the items in this property set. <a href="classPropertySet.html#a911a7396412e5bb5e93dfcf56286e758">More...</a><br /></td></tr>
<tr class="separator:a911a7396412e5bb5e93dfcf56286e758 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb4db0338ee4d9d121427990306d8101 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#aeb4db0338ee4d9d121427990306d8101">restoreFromXml</a> (const <a class="el" href="classXmlElement.html">XmlElement</a> &xml)</td></tr>
<tr class="memdesc:aeb4db0338ee4d9d121427990306d8101 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Reloads a set of properties that were previously stored as XML. <a href="classPropertySet.html#aeb4db0338ee4d9d121427990306d8101">More...</a><br /></td></tr>
<tr class="separator:aeb4db0338ee4d9d121427990306d8101 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a624ae2f6c294510397957dd0dc2e1bd2 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a624ae2f6c294510397957dd0dc2e1bd2">setFallbackPropertySet</a> (<a class="el" href="classPropertySet.html">PropertySet</a> *fallbackProperties) noexcept</td></tr>
<tr class="memdesc:a624ae2f6c294510397957dd0dc2e1bd2 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Sets up a second PopertySet that will be used to look up any values that aren't set in this one. <a href="classPropertySet.html#a624ae2f6c294510397957dd0dc2e1bd2">More...</a><br /></td></tr>
<tr class="separator:a624ae2f6c294510397957dd0dc2e1bd2 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1fb12c22b6568c72ed6d46dd57927e87 inherit pub_methods_classPropertySet"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPropertySet.html">PropertySet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertySet.html#a1fb12c22b6568c72ed6d46dd57927e87">getFallbackPropertySet</a> () const noexcept</td></tr>
<tr class="memdesc:a1fb12c22b6568c72ed6d46dd57927e87 inherit pub_methods_classPropertySet"><td class="mdescLeft"> </td><td class="mdescRight">Returns the fallback property set. <a href="classPropertySet.html#a1fb12c22b6568c72ed6d46dd57927e87">More...</a><br /></td></tr>
<tr class="separator:a1fb12c22b6568c72ed6d46dd57927e87 inherit pub_methods_classPropertySet"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classChangeBroadcaster"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classChangeBroadcaster')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classChangeBroadcaster.html">ChangeBroadcaster</a></td></tr>
<tr class="memitem:a1c8ccfa186a47d58a05e7f1f1576c038 inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a1c8ccfa186a47d58a05e7f1f1576c038">ChangeBroadcaster</a> () noexcept</td></tr>
<tr class="memdesc:a1c8ccfa186a47d58a05e7f1f1576c038 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classChangeBroadcaster.html" title="Holds a list of ChangeListeners, and sends messages to them when instructed. ">ChangeBroadcaster</a>. <a href="classChangeBroadcaster.html#a1c8ccfa186a47d58a05e7f1f1576c038">More...</a><br /></td></tr>
<tr class="separator:a1c8ccfa186a47d58a05e7f1f1576c038 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b2f8465cc6c09c0583c8bdf56319742 inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a3b2f8465cc6c09c0583c8bdf56319742">~ChangeBroadcaster</a> ()</td></tr>
<tr class="memdesc:a3b2f8465cc6c09c0583c8bdf56319742 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classChangeBroadcaster.html#a3b2f8465cc6c09c0583c8bdf56319742">More...</a><br /></td></tr>
<tr class="separator:a3b2f8465cc6c09c0583c8bdf56319742 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad68416fe79a94cd5c99519bdea6c2a06 inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#ad68416fe79a94cd5c99519bdea6c2a06">addChangeListener</a> (<a class="el" href="classChangeListener.html">ChangeListener</a> *listener)</td></tr>
<tr class="memdesc:ad68416fe79a94cd5c99519bdea6c2a06 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Registers a listener to receive change callbacks from this broadcaster. <a href="classChangeBroadcaster.html#ad68416fe79a94cd5c99519bdea6c2a06">More...</a><br /></td></tr>
<tr class="separator:ad68416fe79a94cd5c99519bdea6c2a06 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae558a26c795278549a63e342bd5f1650 inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#ae558a26c795278549a63e342bd5f1650">removeChangeListener</a> (<a class="el" href="classChangeListener.html">ChangeListener</a> *listener)</td></tr>
<tr class="memdesc:ae558a26c795278549a63e342bd5f1650 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Unregisters a listener from the list. <a href="classChangeBroadcaster.html#ae558a26c795278549a63e342bd5f1650">More...</a><br /></td></tr>
<tr class="separator:ae558a26c795278549a63e342bd5f1650 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b9c150078318d419debc82e6f22ce58 inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a6b9c150078318d419debc82e6f22ce58">removeAllChangeListeners</a> ()</td></tr>
<tr class="memdesc:a6b9c150078318d419debc82e6f22ce58 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Removes all listeners from the list. <a href="classChangeBroadcaster.html#a6b9c150078318d419debc82e6f22ce58">More...</a><br /></td></tr>
<tr class="separator:a6b9c150078318d419debc82e6f22ce58 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10f01d1c0a7fde85355321985a682cbd inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a10f01d1c0a7fde85355321985a682cbd">sendChangeMessage</a> ()</td></tr>
<tr class="memdesc:a10f01d1c0a7fde85355321985a682cbd inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Causes an asynchronous change message to be sent to all the registered listeners. <a href="classChangeBroadcaster.html#a10f01d1c0a7fde85355321985a682cbd">More...</a><br /></td></tr>
<tr class="separator:a10f01d1c0a7fde85355321985a682cbd inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d16cd01b9af4bacb1716530af17f77b inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a5d16cd01b9af4bacb1716530af17f77b">sendSynchronousChangeMessage</a> ()</td></tr>
<tr class="memdesc:a5d16cd01b9af4bacb1716530af17f77b inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Sends a synchronous change message to all the registered listeners. <a href="classChangeBroadcaster.html#a5d16cd01b9af4bacb1716530af17f77b">More...</a><br /></td></tr>
<tr class="separator:a5d16cd01b9af4bacb1716530af17f77b inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78f62ecd57a016f8ba7a6ce55454947d inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a78f62ecd57a016f8ba7a6ce55454947d">dispatchPendingMessages</a> ()</td></tr>
<tr class="memdesc:a78f62ecd57a016f8ba7a6ce55454947d inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">If a change message has been sent but not yet dispatched, this will call <a class="el" href="classChangeBroadcaster.html#a5d16cd01b9af4bacb1716530af17f77b" title="Sends a synchronous change message to all the registered listeners. ">sendSynchronousChangeMessage()</a> to make the callback immediately. <a href="classChangeBroadcaster.html#a78f62ecd57a016f8ba7a6ce55454947d">More...</a><br /></td></tr>
<tr class="separator:a78f62ecd57a016f8ba7a6ce55454947d inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a02e12b829e5b30f6c41df04242541b9c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPropertiesFile.html#a02e12b829e5b30f6c41df04242541b9c">propertyChanged</a> () override</td></tr>
<tr class="separator:a02e12b829e5b30f6c41df04242541b9c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Wrapper on a file that stores a list of key/value data pairs. </p>
<p>Useful for storing application settings, etc. See the <a class="el" href="classPropertySet.html" title="A set of named property values, which can be strings, integers, floating point, etc. ">PropertySet</a> class for the interfaces that read and write values.</p>
<p>Not designed for very large amounts of data, as it keeps all the values in memory and writes them out to disk lazily when they are changed.</p>
<p>Because this class derives from <a class="el" href="classChangeBroadcaster.html" title="Holds a list of ChangeListeners, and sends messages to them when instructed. ">ChangeBroadcaster</a>, ChangeListeners can be registered with it, and these will be signalled when a value changes.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPropertySet.html" title="A set of named property values, which can be strings, integers, floating point, etc. ">PropertySet</a> </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ac4d1ac9a6b624f7e0de7787de46dc05e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4d1ac9a6b624f7e0de7787de46dc05e">§ </a></span>StorageFormat</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classPropertiesFile.html#ac4d1ac9a6b624f7e0de7787de46dc05e">PropertiesFile::StorageFormat</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac4d1ac9a6b624f7e0de7787de46dc05eadd1552fd266d926522dfa0e162de5328"></a>storeAsBinary </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac4d1ac9a6b624f7e0de7787de46dc05eab1ddcaf9fc8d45b4141749e325844f42"></a>storeAsCompressedBinary </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac4d1ac9a6b624f7e0de7787de46dc05eab0145370e12c4174bd36dc6ac6ccc147"></a>storeAsXML </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a8e47a02c7600f3758f600ed2376589a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e47a02c7600f3758f600ed2376589a4">§ </a></span>PropertiesFile() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">PropertiesFile::PropertiesFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPropertiesFile_1_1Options.html">Options</a> & </td>
<td class="paramname"><em>options</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classPropertiesFile.html" title="Wrapper on a file that stores a list of key/value data pairs. ">PropertiesFile</a> object. </p>
<p>The file used will be chosen by calling <a class="el" href="structPropertiesFile_1_1Options.html#a2e20c2c3ce5012d69cc70d4e38763c39" title="This can be called to suggest a file that should be used, based on the values in this structure...">PropertiesFile::Options::getDefaultFile()</a> for the options provided. To set the file explicitly, use the other constructor. </p>
</div>
</div>
<a id="acf3dbec910950b70fe405cc51f7a10e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf3dbec910950b70fe405cc51f7a10e6">§ </a></span>PropertiesFile() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PropertiesFile::PropertiesFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structPropertiesFile_1_1Options.html">Options</a> & </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classPropertiesFile.html" title="Wrapper on a file that stores a list of key/value data pairs. ">PropertiesFile</a> object. </p>
<p>Unlike the other constructor, this one allows you to explicitly set the file that you want to be used, rather than using the default one. </p>
</div>
</div>
<a id="a449b6cc48f72e8d14c73dd4ac9964635"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a449b6cc48f72e8d14c73dd4ac9964635">§ </a></span>~PropertiesFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PropertiesFile::~PropertiesFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>When deleted, the file will first call <a class="el" href="classPropertiesFile.html#a61b439f35faf3f1add5cdfdd49a85d49" title="This will flush all the values to disk if they've changed since the last time they were saved...">saveIfNeeded()</a> to flush any changes to disk. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a31ca79cdb1a4b7c9863d981c9b438904"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31ca79cdb1a4b7c9863d981c9b438904">§ </a></span>isValidFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PropertiesFile::isValidFile </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 true if this file was created from a valid (or non-existent) file. </p>
<p>If the file failed to load correctly because it was corrupt or had insufficient access, this will be false. </p>
</div>
</div>
<a id="a61b439f35faf3f1add5cdfdd49a85d49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61b439f35faf3f1add5cdfdd49a85d49">§ </a></span>saveIfNeeded()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PropertiesFile::saveIfNeeded </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This will flush all the values to disk if they've changed since the last time they were saved. </p>
<p>Returns false if it fails to write to the file for some reason (maybe because it's read-only or the directory doesn't exist or something).</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPropertiesFile.html#ad0c24e1809b203c8347ee07cfb599250" title="This will force a write-to-disk of the current values, regardless of whether anything has changed sin...">save</a> </dd></dl>
</div>
</div>
<a id="ad0c24e1809b203c8347ee07cfb599250"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0c24e1809b203c8347ee07cfb599250">§ </a></span>save()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PropertiesFile::save </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This will force a write-to-disk of the current values, regardless of whether anything has changed since the last save. </p>
<p>Returns false if it fails to write to the file for some reason (maybe because it's read-only or the directory doesn't exist or something).</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPropertiesFile.html#a61b439f35faf3f1add5cdfdd49a85d49" title="This will flush all the values to disk if they've changed since the last time they were saved...">saveIfNeeded</a> </dd></dl>
</div>
</div>
<a id="a47742aee82eacbc1259a93df9b0d2ad4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47742aee82eacbc1259a93df9b0d2ad4">§ </a></span>needsToBeSaved()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PropertiesFile::needsToBeSaved </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the properties have been altered since the last time they were saved. </p>
<p>The file is flagged as needing to be saved when you change a value, but you can explicitly set this flag with <a class="el" href="classPropertiesFile.html#a205cb3e66cef5d064578dc22b8b205cb" title="Explicitly sets the flag to indicate whether the file needs saving or not. ">setNeedsToBeSaved()</a>. </p>
</div>
</div>
<a id="a205cb3e66cef5d064578dc22b8b205cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a205cb3e66cef5d064578dc22b8b205cb">§ </a></span>setNeedsToBeSaved()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PropertiesFile::setNeedsToBeSaved </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>needsToBeSaved</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Explicitly sets the flag to indicate whether the file needs saving or not. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPropertiesFile.html#a47742aee82eacbc1259a93df9b0d2ad4" title="Returns true if the properties have been altered since the last time they were saved. ">needsToBeSaved</a> </dd></dl>
</div>
</div>
<a id="abb0e0d0ea6f6c820719ef8542440e846"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb0e0d0ea6f6c820719ef8542440e846">§ </a></span>reload()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PropertiesFile::reload </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to reload the settings from the file. </p>
</div>
</div>
<a id="a8c42d4ae2b3c11517c8c734de5067815"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c42d4ae2b3c11517c8c734de5067815">§ </a></span>getFile()</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="classFile.html">File</a>& PropertiesFile::getFile </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 the file that's being used. </p>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>.</p>
</div>
</div>
<a id="a02e12b829e5b30f6c41df04242541b9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02e12b829e5b30f6c41df04242541b9c">§ </a></span>propertyChanged()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PropertiesFile::propertyChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classPropertySet.html#a1f7586bf00529d3981f4576a44a6d4b0">PropertySet</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__PropertiesFile_8h.html">juce_PropertiesFile.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|