/usr/share/doc/libjuce/apiref/classApplicationProperties.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 | <!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: ApplicationProperties 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="classApplicationProperties-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ApplicationProperties Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Manages a collection of properties.
<a href="classApplicationProperties.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:aca8eb83646fdaf5fe87360738fb20bbf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApplicationProperties.html#aca8eb83646fdaf5fe87360738fb20bbf">ApplicationProperties</a> ()</td></tr>
<tr class="memdesc:aca8eb83646fdaf5fe87360738fb20bbf"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classApplicationProperties.html" title="Manages a collection of properties. ">ApplicationProperties</a> object. <a href="#aca8eb83646fdaf5fe87360738fb20bbf">More...</a><br /></td></tr>
<tr class="separator:aca8eb83646fdaf5fe87360738fb20bbf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0b5bcee64fb881459536ae91f98df9f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApplicationProperties.html#ad0b5bcee64fb881459536ae91f98df9f">~ApplicationProperties</a> ()</td></tr>
<tr class="memdesc:ad0b5bcee64fb881459536ae91f98df9f"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ad0b5bcee64fb881459536ae91f98df9f">More...</a><br /></td></tr>
<tr class="separator:ad0b5bcee64fb881459536ae91f98df9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8f0b0ee2ece06a23d36996eaa1a7107"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApplicationProperties.html#ab8f0b0ee2ece06a23d36996eaa1a7107">setStorageParameters</a> (const <a class="el" href="structPropertiesFile_1_1Options.html">PropertiesFile::Options</a> &options)</td></tr>
<tr class="memdesc:ab8f0b0ee2ece06a23d36996eaa1a7107"><td class="mdescLeft"> </td><td class="mdescRight">Gives the object the information it needs to create the appropriate properties files. <a href="#ab8f0b0ee2ece06a23d36996eaa1a7107">More...</a><br /></td></tr>
<tr class="separator:ab8f0b0ee2ece06a23d36996eaa1a7107"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10b2a0a9c4dab480f40e3d80bb02d85b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structPropertiesFile_1_1Options.html">PropertiesFile::Options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classApplicationProperties.html#a10b2a0a9c4dab480f40e3d80bb02d85b">getStorageParameters</a> () const noexcept</td></tr>
<tr class="memdesc:a10b2a0a9c4dab480f40e3d80bb02d85b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current storage parameters. <a href="#a10b2a0a9c4dab480f40e3d80bb02d85b">More...</a><br /></td></tr>
<tr class="separator:a10b2a0a9c4dab480f40e3d80bb02d85b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b7ea2bc0531fc2b5db6aed82d753905"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPropertiesFile.html">PropertiesFile</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classApplicationProperties.html#a5b7ea2bc0531fc2b5db6aed82d753905">getUserSettings</a> ()</td></tr>
<tr class="memdesc:a5b7ea2bc0531fc2b5db6aed82d753905"><td class="mdescLeft"> </td><td class="mdescRight">Returns the user settings file. <a href="#a5b7ea2bc0531fc2b5db6aed82d753905">More...</a><br /></td></tr>
<tr class="separator:a5b7ea2bc0531fc2b5db6aed82d753905"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66aa5855d6c127e6ada14ad86a6926a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPropertiesFile.html">PropertiesFile</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classApplicationProperties.html#a66aa5855d6c127e6ada14ad86a6926a5">getCommonSettings</a> (bool returnUserPropsIfReadOnly)</td></tr>
<tr class="memdesc:a66aa5855d6c127e6ada14ad86a6926a5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the common settings file. <a href="#a66aa5855d6c127e6ada14ad86a6926a5">More...</a><br /></td></tr>
<tr class="separator:a66aa5855d6c127e6ada14ad86a6926a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff18ff76ec1447a771769fb3bd905623"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApplicationProperties.html#aff18ff76ec1447a771769fb3bd905623">saveIfNeeded</a> ()</td></tr>
<tr class="memdesc:aff18ff76ec1447a771769fb3bd905623"><td class="mdescLeft"> </td><td class="mdescRight">Saves both files if they need to be saved. <a href="#aff18ff76ec1447a771769fb3bd905623">More...</a><br /></td></tr>
<tr class="separator:aff18ff76ec1447a771769fb3bd905623"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f0c75ea625bf1cca3ef8fe9f66687af"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApplicationProperties.html#a5f0c75ea625bf1cca3ef8fe9f66687af">closeFiles</a> ()</td></tr>
<tr class="memdesc:a5f0c75ea625bf1cca3ef8fe9f66687af"><td class="mdescLeft"> </td><td class="mdescRight">Flushes and closes both files if they are open. <a href="#a5f0c75ea625bf1cca3ef8fe9f66687af">More...</a><br /></td></tr>
<tr class="separator:a5f0c75ea625bf1cca3ef8fe9f66687af"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Manages a collection of properties. </p>
<p>This is a slightly higher-level wrapper for managing <a class="el" href="classPropertiesFile.html" title="Wrapper on a file that stores a list of key/value data pairs. ">PropertiesFile</a> objects.</p>
<p>It holds two different <a class="el" href="classPropertiesFile.html" title="Wrapper on a file that stores a list of key/value data pairs. ">PropertiesFile</a> objects internally, one for user-specific settings (stored in your user directory), and one for settings that are common to all users (stored in a folder accessible to all users).</p>
<p>The class manages the creation of these files on-demand, allowing access via the <a class="el" href="classApplicationProperties.html#a5b7ea2bc0531fc2b5db6aed82d753905" title="Returns the user settings file. ">getUserSettings()</a> and <a class="el" href="classApplicationProperties.html#a66aa5855d6c127e6ada14ad86a6926a5" title="Returns the common settings file. ">getCommonSettings()</a> methods.</p>
<p>After creating an instance of an <a class="el" href="classApplicationProperties.html" title="Manages a collection of properties. ">ApplicationProperties</a> object, you should first of all call <a class="el" href="classApplicationProperties.html#ab8f0b0ee2ece06a23d36996eaa1a7107" title="Gives the object the information it needs to create the appropriate properties files. ">setStorageParameters()</a> to tell it the parameters to use to create its files.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPropertiesFile.html" title="Wrapper on a file that stores a list of key/value data pairs. ">PropertiesFile</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aca8eb83646fdaf5fe87360738fb20bbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca8eb83646fdaf5fe87360738fb20bbf">§ </a></span>ApplicationProperties()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ApplicationProperties::ApplicationProperties </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an <a class="el" href="classApplicationProperties.html" title="Manages a collection of properties. ">ApplicationProperties</a> object. </p>
<p>Before using it, you must call <a class="el" href="classApplicationProperties.html#ab8f0b0ee2ece06a23d36996eaa1a7107" title="Gives the object the information it needs to create the appropriate properties files. ">setStorageParameters()</a> to give it the info it needs to create the property files. </p>
</div>
</div>
<a id="ad0b5bcee64fb881459536ae91f98df9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0b5bcee64fb881459536ae91f98df9f">§ </a></span>~ApplicationProperties()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ApplicationProperties::~ApplicationProperties </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="ab8f0b0ee2ece06a23d36996eaa1a7107"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8f0b0ee2ece06a23d36996eaa1a7107">§ </a></span>setStorageParameters()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ApplicationProperties::setStorageParameters </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPropertiesFile_1_1Options.html">PropertiesFile::Options</a> & </td>
<td class="paramname"><em>options</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gives the object the information it needs to create the appropriate properties files. </p>
<p>See the <a class="el" href="structPropertiesFile_1_1Options.html">PropertiesFile::Options</a> class for details about what options you need to set. </p>
</div>
</div>
<a id="a10b2a0a9c4dab480f40e3d80bb02d85b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10b2a0a9c4dab480f40e3d80bb02d85b">§ </a></span>getStorageParameters()</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="structPropertiesFile_1_1Options.html">PropertiesFile::Options</a>& ApplicationProperties::getStorageParameters </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 current storage parameters. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classApplicationProperties.html#ab8f0b0ee2ece06a23d36996eaa1a7107" title="Gives the object the information it needs to create the appropriate properties files. ">setStorageParameters</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>
<a id="a5b7ea2bc0531fc2b5db6aed82d753905"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b7ea2bc0531fc2b5db6aed82d753905">§ </a></span>getUserSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPropertiesFile.html">PropertiesFile</a>* ApplicationProperties::getUserSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the user settings file. </p>
<p>The first time this is called, it will create and load the properties file.</p>
<p>Note that when you search the user <a class="el" href="classPropertiesFile.html" title="Wrapper on a file that stores a list of key/value data pairs. ">PropertiesFile</a> for a value that it doesn't contain, the common settings are used as a second-chance place to look. This is done via the <a class="el" href="classPropertySet.html#a624ae2f6c294510397957dd0dc2e1bd2" title="Sets up a second PopertySet that will be used to look up any values that aren't set in this one...">PropertySet::setFallbackPropertySet()</a> method - by default the common settings are set to the fallback for the user settings.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classApplicationProperties.html#a66aa5855d6c127e6ada14ad86a6926a5" title="Returns the common settings file. ">getCommonSettings</a> </dd></dl>
</div>
</div>
<a id="a66aa5855d6c127e6ada14ad86a6926a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66aa5855d6c127e6ada14ad86a6926a5">§ </a></span>getCommonSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPropertiesFile.html">PropertiesFile</a>* ApplicationProperties::getCommonSettings </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>returnUserPropsIfReadOnly</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the common settings file. </p>
<p>The first time this is called, it will create and load the properties file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">returnUserPropsIfReadOnly</td><td>if this is true, and the common properties file is read-only (e.g. because the user doesn't have permission to write to shared files), then this will return the user settings instead, (like <a class="el" href="classApplicationProperties.html#a5b7ea2bc0531fc2b5db6aed82d753905" title="Returns the user settings file. ">getUserSettings()</a> would do). This is handy if you'd like to write a value to the common settings, but if that's no possible, then you'd rather write to the user settings than none at all. If returnUserPropsIfReadOnly is false, this method will always return the common settings, even if any changes to them can't be saved. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classApplicationProperties.html#a5b7ea2bc0531fc2b5db6aed82d753905" title="Returns the user settings file. ">getUserSettings</a> </dd></dl>
</div>
</div>
<a id="aff18ff76ec1447a771769fb3bd905623"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff18ff76ec1447a771769fb3bd905623">§ </a></span>saveIfNeeded()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ApplicationProperties::saveIfNeeded </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Saves both files if they need to be saved. </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...">PropertiesFile::saveIfNeeded</a> </dd></dl>
</div>
</div>
<a id="a5f0c75ea625bf1cca3ef8fe9f66687af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f0c75ea625bf1cca3ef8fe9f66687af">§ </a></span>closeFiles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ApplicationProperties::closeFiles </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flushes and closes both files if they are open. </p>
<p>This flushes any pending changes to disk with <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...">PropertiesFile::saveIfNeeded()</a> and closes both files. They will then be re-opened the next time <a class="el" href="classApplicationProperties.html#a5b7ea2bc0531fc2b5db6aed82d753905" title="Returns the user settings file. ">getUserSettings()</a> or <a class="el" href="classApplicationProperties.html#a66aa5855d6c127e6ada14ad86a6926a5" title="Returns the common settings file. ">getCommonSettings()</a> is called. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ApplicationProperties_8h.html">juce_ApplicationProperties.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|