Regenerated user defaults doc

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@9288 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2001-03-03 16:47:58 +00:00
parent 363034a2f3
commit daa5154b88

View file

@ -74,7 +74,7 @@
<p>
The <em>Languages</em> default value is used to set up the
The <em>NSLanguages</em> default value is used to set up the
constants for localization. GNUstep will also look for the
<code>LANGUAGES</code> environment variable if it is not set
in the defaults system. If it exists, it consists of an
@ -88,7 +88,7 @@
As a special extension, on systems that support locales
(e.g. GNU/Linux and Solaris), GNUstep will use information
from the user specified locale, if the <em>Languages</em>
from the user specified locale, if the <em>NSLanguages</em>
default value is not found. Typically the locale is
specified in the environment with the <code>LANG</code>
environment variable.
@ -101,184 +101,205 @@
<h2>Methods </h2>
<ul>
<li><a href ="NSUserDefaults.html#method-0">+standardUserDefaults</a>
<li><a href ="NSUserDefaults.html#method-1">-arrayForKey:</a>
<li><a href ="NSUserDefaults.html#method-2">-boolForKey:</a>
<li><a href ="NSUserDefaults.html#method-3">-dataForKey:</a>
<li><a href ="NSUserDefaults.html#method-4">-dictionaryForKey:</a>
<li><a href ="NSUserDefaults.html#method-5">-dictionaryRepresentation</a>
<li><a href ="NSUserDefaults.html#method-6">-floatForKey:</a>
<li><a href ="NSUserDefaults.html#method-7">-init</a>
<li><a href ="NSUserDefaults.html#method-8">-initWithUser:</a>
<li><a href ="NSUserDefaults.html#method-9">-integerForKey:</a>
<li><a href ="NSUserDefaults.html#method-10">-objectForKey:</a>
<li><a href ="NSUserDefaults.html#method-11">-persistentDomainForName:</a>
<li><a href ="NSUserDefaults.html#method-12">-persistentDomainNames</a>
<li><a href ="NSUserDefaults.html#method-13">-registerDefaults:</a>
<li><a href ="NSUserDefaults.html#method-14">-removeObjectForKey:</a>
<li><a href ="NSUserDefaults.html#method-15">-removePersistentDomainForName:</a>
<li><a href ="NSUserDefaults.html#method-16">-removeVolatileDomainForName:</a>
<li><a href ="NSUserDefaults.html#method-17">-searchList</a>
<li><a href ="NSUserDefaults.html#method-18">-setBool:forKey:</a>
<li><a href ="NSUserDefaults.html#method-19">-setFloat:forKey:</a>
<li><a href ="NSUserDefaults.html#method-20">-setInteger:forKey:</a>
<li><a href ="NSUserDefaults.html#method-21">-setObject:forKey:</a>
<li><a href ="NSUserDefaults.html#method-22">-setPersistentDomain:forName:</a>
<li><a href ="NSUserDefaults.html#method-23">-setSearchList:</a>
<li><a href ="NSUserDefaults.html#method-24">-setVolatileDomain:forName:</a>
<li><a href ="NSUserDefaults.html#method-25">-stringArrayForKey:</a>
<li><a href ="NSUserDefaults.html#method-26">-stringForKey:</a>
<li><a href ="NSUserDefaults.html#method-27">-synchronize</a>
<li><a href ="NSUserDefaults.html#method-28">-volatileDomainForName:</a>
<li><a href ="NSUserDefaults.html#method-29">-volatileDomainNames</a>
<li><a href ="NSUserDefaults.html#method-1">+userLanguages</a>
<li><a href ="NSUserDefaults.html#method-2">-arrayForKey:</a>
<li><a href ="NSUserDefaults.html#method-3">-boolForKey:</a>
<li><a href ="NSUserDefaults.html#method-4">-dataForKey:</a>
<li><a href ="NSUserDefaults.html#method-5">-dictionaryForKey:</a>
<li><a href ="NSUserDefaults.html#method-6">-dictionaryRepresentation</a>
<li><a href ="NSUserDefaults.html#method-7">-floatForKey:</a>
<li><a href ="NSUserDefaults.html#method-8">-init</a>
<li><a href ="NSUserDefaults.html#method-9">-initWithUser:</a>
<li><a href ="NSUserDefaults.html#method-10">-integerForKey:</a>
<li><a href ="NSUserDefaults.html#method-11">-objectForKey:</a>
<li><a href ="NSUserDefaults.html#method-12">-persistentDomainForName:</a>
<li><a href ="NSUserDefaults.html#method-13">-persistentDomainNames</a>
<li><a href ="NSUserDefaults.html#method-14">-registerDefaults:</a>
<li><a href ="NSUserDefaults.html#method-15">-removeObjectForKey:</a>
<li><a href ="NSUserDefaults.html#method-16">-removePersistentDomainForName:</a>
<li><a href ="NSUserDefaults.html#method-17">-removeVolatileDomainForName:</a>
<li><a href ="NSUserDefaults.html#method-18">-searchList</a>
<li><a href ="NSUserDefaults.html#method-19">-setBool:forKey:</a>
<li><a href ="NSUserDefaults.html#method-20">-setFloat:forKey:</a>
<li><a href ="NSUserDefaults.html#method-21">-setInteger:forKey:</a>
<li><a href ="NSUserDefaults.html#method-22">-setObject:forKey:</a>
<li><a href ="NSUserDefaults.html#method-23">-setPersistentDomain:forName:</a>
<li><a href ="NSUserDefaults.html#method-24">-setSearchList:</a>
<li><a href ="NSUserDefaults.html#method-25">-setVolatileDomain:forName:</a>
<li><a href ="NSUserDefaults.html#method-26">-stringArrayForKey:</a>
<li><a href ="NSUserDefaults.html#method-27">-stringForKey:</a>
<li><a href ="NSUserDefaults.html#method-28">-synchronize</a>
<li><a href ="NSUserDefaults.html#method-29">-volatileDomainForName:</a>
<li><a href ="NSUserDefaults.html#method-30">-volatileDomainNames</a>
</ul>
<hr><h2>Class Methods </h2>
<h3><a name ="method-0">standardUserDefaults</a></h3>
+ (NSUserDefaults*) <b>standardUserDefaults</b>;<br>
Returns a shared instance of the class containing the standard
defaults for the process.
<hr>
<h3><a name ="method-1">userLanguages</a></h3>
+ (NSArray*) <b>userLanguages</b>;<br>
Standards: GNUstep NotMacOS-X NotOpenStep<br>
Returns the array of user languages preferences. Uses the
<em>NSLanguages</em> user default if available, otherwise
tries to infer setup from operating system information etc
(in particular, uses the <em>LANGUAGES</em> environment variable).
<hr>
<hr><h2>Instances Methods </h2>
<h3><a name ="method-1">arrayForKey:</a></h3>
<h3><a name ="method-2">arrayForKey:</a></h3>
- (NSArray*) <b>arrayForKey:</b> (NSString*)defaultName;<br>
Looks up a value for a specified default, checks that it is
an array. Returns nil if it is not.
<hr>
<h3><a name ="method-2">boolForKey:</a></h3>
<h3><a name ="method-3">boolForKey:</a></h3>
- (BOOL) <b>boolForKey:</b> (NSString*)defaultName;<br>
Looks up a value for a specified default, checks that it is
a boolean. Returns NO if it is not present.
<hr>
<h3><a name ="method-3">dataForKey:</a></h3>
<h3><a name ="method-4">dataForKey:</a></h3>
- (NSData*) <b>dataForKey:</b> (NSString*)defaultName;<br>
Looks up a value for a specified default, checks that it is
an NSData object. Returns nil if it is not.
<hr>
<h3><a name ="method-4">dictionaryForKey:</a></h3>
<h3><a name ="method-5">dictionaryForKey:</a></h3>
- (NSDictionary*) <b>dictionaryForKey:</b> (NSString*)defaultName;<br>
Looks up a value for a specified default, checks that it is
an NSDictionary object. Returns nil if it is not.
<hr>
<h3><a name ="method-5">dictionaryRepresentation</a></h3>
<h3><a name ="method-6">dictionaryRepresentation</a></h3>
- (NSDictionary*) <b>dictionaryRepresentation</b>;<br>
<hr>
<h3><a name ="method-6">floatForKey:</a></h3>
<h3><a name ="method-7">floatForKey:</a></h3>
- (float) <b>floatForKey:</b> (NSString*)defaultName;<br>
<hr>
<h3><a name ="method-7">init</a></h3>
<h3><a name ="method-8">init</a></h3>
- (id) <b>init</b>;<br>
<hr>
<h3><a name ="method-8">initWithUser:</a></h3>
<h3><a name ="method-9">initWithUser:</a></h3>
- (id) <b>initWithUser:</b> (NSString*)username;<br>
<hr>
<h3><a name ="method-9">integerForKey:</a></h3>
<h3><a name ="method-10">integerForKey:</a></h3>
- (int) <b>integerForKey:</b> (NSString*)defaultName;<br>
<hr>
<h3><a name ="method-10">objectForKey:</a></h3>
<h3><a name ="method-11">objectForKey:</a></h3>
- (id) <b>objectForKey:</b> (NSString*)defaultName;<br>
<hr>
<h3><a name ="method-11">persistentDomainForName:</a></h3>
<h3><a name ="method-12">persistentDomainForName:</a></h3>
- (NSDictionary*) <b>persistentDomainForName:</b> (NSString*)domainName;<br>
<hr>
<h3><a name ="method-12">persistentDomainNames</a></h3>
<h3><a name ="method-13">persistentDomainNames</a></h3>
- (NSArray*) <b>persistentDomainNames</b>;<br>
<hr>
<h3><a name ="method-13">registerDefaults:</a></h3>
<h3><a name ="method-14">registerDefaults:</a></h3>
- (void) <b>registerDefaults:</b> (NSDictionary*)dictionary;<br>
<hr>
<h3><a name ="method-14">removeObjectForKey:</a></h3>
<h3><a name ="method-15">removeObjectForKey:</a></h3>
- (void) <b>removeObjectForKey:</b> (NSString*)defaultName;<br>
<hr>
<h3><a name ="method-15">removePersistentDomainForName:</a></h3>
<h3><a name ="method-16">removePersistentDomainForName:</a></h3>
- (void) <b>removePersistentDomainForName:</b> (NSString*)domainName;<br>
<hr>
<h3><a name ="method-16">removeVolatileDomainForName:</a></h3>
<h3><a name ="method-17">removeVolatileDomainForName:</a></h3>
- (void) <b>removeVolatileDomainForName:</b> (NSString*)domainName;<br>
<hr>
<h3><a name ="method-17">searchList</a></h3>
<h3><a name ="method-18">searchList</a></h3>
- (NSArray*) <b>searchList</b>;<br>
<hr>
<h3><a name ="method-18">setBool:forKey:</a></h3>
<h3><a name ="method-19">setBool:forKey:</a></h3>
- (void) <b>setBool:</b> (BOOL)value <b>forKey:</b> (NSString*)defaultName;<br>
<hr>
<h3><a name ="method-19">setFloat:forKey:</a></h3>
<h3><a name ="method-20">setFloat:forKey:</a></h3>
- (void) <b>setFloat:</b> (float)value <b>forKey:</b> (NSString*)defaultName;<br>
<hr>
<h3><a name ="method-20">setInteger:forKey:</a></h3>
<h3><a name ="method-21">setInteger:forKey:</a></h3>
- (void) <b>setInteger:</b> (int)value <b>forKey:</b> (NSString*)defaultName;<br>
<hr>
<h3><a name ="method-21">setObject:forKey:</a></h3>
<h3><a name ="method-22">setObject:forKey:</a></h3>
- (void) <b>setObject:</b> (id)value <b>forKey:</b> (NSString*)defaultName;<br>
<hr>
<h3><a name ="method-22">setPersistentDomain:forName:</a></h3>
<h3><a name ="method-23">setPersistentDomain:forName:</a></h3>
- (void) <b>setPersistentDomain:</b> (NSDictionary*)domain <b>forName:</b> (NSString*)domainName;<br>
<hr>
<h3><a name ="method-23">setSearchList:</a></h3>
<h3><a name ="method-24">setSearchList:</a></h3>
- (void) <b>setSearchList:</b> (NSArray*)array;<br>
<hr>
<h3><a name ="method-24">setVolatileDomain:forName:</a></h3>
<h3><a name ="method-25">setVolatileDomain:forName:</a></h3>
- (void) <b>setVolatileDomain:</b> (NSDictionary*)domain <b>forName:</b> (NSString*)domainName;<br>
<hr>
<h3><a name ="method-25">stringArrayForKey:</a></h3>
<h3><a name ="method-26">stringArrayForKey:</a></h3>
- (NSArray*) <b>stringArrayForKey:</b> (NSString*)defaultName;<br>
<hr>
<h3><a name ="method-26">stringForKey:</a></h3>
<h3><a name ="method-27">stringForKey:</a></h3>
- (NSString*) <b>stringForKey:</b> (NSString*)defaultName;<br>
<hr>
<h3><a name ="method-27">synchronize</a></h3>
<h3><a name ="method-28">synchronize</a></h3>
- (BOOL) <b>synchronize</b>;<br>
<hr>
<h3><a name ="method-28">volatileDomainForName:</a></h3>
<h3><a name ="method-29">volatileDomainForName:</a></h3>
- (NSDictionary*) <b>volatileDomainForName:</b> (NSString*)domainName;<br>
<hr>
<h3><a name ="method-29">volatileDomainNames</a></h3>
<h3><a name ="method-30">volatileDomainNames</a></h3>
- (NSArray*) <b>volatileDomainNames</b>;<br>