gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-04-23 09:04:13 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added description for basic methods

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@6586 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Pierre-Yves Rivaille 2000-05-08 20:45:47 +00:00
parent 5fe85e54c3
commit 3b3ebb5940
2 changed files with 132 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
Documentation/gsdoc/NSDictionary.gsdoc
View file

@ -7,16 +7,22 @@
<email address="rfm@gnu.org"/>
<url url="http://www.gnustep.org/developers/whoiswho.html"/>
</author>
<version>0.1</version>
<date>28 February, 2000</date>
<author name="Pierre-Yves Rivaille">
<email address="pyhrr@altern.org"/>
<url url="http://altern.org/pyhrr"/>
</author>
<version>0.2</version>
<date>25 April, 2000</date>
</head>
<body>
<chapter>
<heading>NSDictionary</heading>
<class name="NSDictionary" super="NSObject">
<declared>Foundation/NSDictionary.h</declared>
<conform>NSCoding</conform>
<conform>NSCoding, NSCopying, NSMutableCopying</conform>
<desc>
</desc>
<method type="id" factory="yes">
<sel>allocWithZone:</sel>
@ -27,30 +33,43 @@
<method type="id" factory="yes">
<sel>dictionary</sel>
<desc>
Returns an empty dictionary.
</desc>
</method>
<method type="id" factory="yes">
<sel>dictionaryWithContentsOfFile:</sel>
<arg type="NSString*">path</arg>
<desc>
Returns a dictionary using the file located at path.
The file must be a property list containing a dictionary as its root object.
</desc>
</method>
<method type="id" factory="yes">
<sel>dictionaryWithDictionary:</sel>
<arg type="NSDictionary*">otherDictionary</arg>
<desc>
Returns a newly created dictionary with the keys and objects of otherDictionary.
(The keys and objects are not copied.)
</desc>
</method>
<method type="id" factory="yes">
<sel>dictionaryWithObject:</sel>
<arg type="id">anObject</arg>
<sel>forKey:</sel>
<arg type="id">aKey</arg>
<desc>
Returns a dictionary containing only one object (anObject) which is associated with aKey.
</desc>
</method>
<method type="id" factory="yes">
<sel>dictionaryWithObjects:</sel>
<arg type="NSArray*">objects</arg>
<sel>forKey:</sel>
<arg type="NSArray*">keys</arg>
<desc>
Returns a dictionary created using the given objects and keys.
The two arrays must have the same size.
The n th element of the objects array is associated with the n th element of the keys array.
</desc>
</method>
<method type="id" factory="yes">
@ -61,116 +80,134 @@
<sel>count:</sel>
<arg type="unsigned int">count</arg>
<desc>
Returns a dictionary created using the C arrays objects and keys.
The number of elements in both C arrays must be count.
</desc>
</method>
<method type="id" factory="yes">
<sel>dictionaryWithObjectsAndKeys:</sel>
<arg type="id">object,</arg>
<arg type="id">object, ...</arg>
<desc>
Returns a dictionary created using the list given as argument.
The list is alernately composed of objects and keys.
Thus, the list's length must be pair.
</desc>
</method>
<method type="NSArray*">
<sel>allKeys</sel>
<desc>
Returns an array containing all the dictionary's keys.
</desc>
</method>
<method type="NSArray*">
<sel>allKeysForObject:</sel>
<arg type="id">anObject</arg>
<desc>
Returns an array containing all the dictionary's keys that are associated with anObject.
</desc>
</method>
<method type="NSArray*">
<sel>allValues</sel>
<desc>
Returns an array containing all the dictionary's objects.
</desc>
</method>
<method type="unsigned int">
<sel>count</sel>
<desc>
Returns an unsigned integer which is the number of elements stored in the dictionary.
</desc>
</method>
<method type="NSString*">
<sel>descriptionInStringsFileFormat</sel>
<desc>
</desc>
</method>
<method type="NSString*">
<sel>descriptionWithLocale:</sel>
<arg type="NSDictionary*">locale</arg>
<desc>
</desc>
</method>
<method type="NSString*">
<sel>descriptionWithLocale:</sel>
<arg type="NSDictionary*">locale</arg>
<desc>
</desc>
</method>
<method type="NSString*">
<sel>fileGroupOwnerAccountName</sel>
<desc>
</desc>
</method>
<method type="NSDate*">
<sel>fileModificationDate</sel>
<desc>
</desc>
</method>
<method type="NSString*">
<sel>fileOwnerAccountName</sel>
<desc>
</desc>
</method>
<method type="unsigned long">
<sel>filePosixPermissions</sel>
<desc>
</desc>
</method>
<method type="unsigned long long">
<sel>fileSize</sel>
<desc>
</desc>
</method>
<method type="unsigned long">
<sel>fileSystemFileNumber</sel>
<desc>
</desc>
</method>
<method type="unsigned long">
<sel>fileSystemNumber</sel>
<desc>
</desc>
</method>
<method type="NSString*">
<sel>fileType</sel>
<desc>
</desc>
</method>
<method type="id">
<sel>initWithContentsOfFile:</sel>
<arg type="NSString*">path</arg>
<desc>
see dictionaryWithContentOfFile:
</desc>
</method>
<method type="id">
<sel>initWithDictionary:</sel>
<arg type="NSDictionary*">otherDictionary</arg>
<desc>
</desc>
</method>
<method type="id">
<sel>initWithDictionary:</sel>
<arg type="NSDictionary*">otherDictionary</arg>
<desc>
See dictionaryWithDictionary:
</desc>
</method>
<method type="id">
<sel>initWithObjects:</sel>
<arg type="NSArray*">objects</arg>
<desc>
See <ref id="dictionaryWithObjects:">dictionaryWithObjects:</ref>
</desc>
</method>
<method type="id">
<sel>initWithObjects:</sel>
<arg type="id*">objects</arg>
@ -179,40 +216,47 @@
<sel>count:</sel>
<arg type="unsigned int">count</arg>
<desc>
see dictionaryWithObjects: forKeys: count:
</desc>
</method>
<method type="id">
<sel>initWithObjectsAndKeys:</sel>
<arg type="id">object,</arg>
<desc>
see dictionaryWithObjectsAndKeys:
</desc>
</method>
<method type="BOOL">
<sel>isEqualToDictionary:</sel>
<arg type="NSDictionary*">otherDictionary</arg>
<desc>
</desc>
</method>
<method type="NSEnumerator*">
<sel>keyEnumerator</sel>
<desc>
Return an enumerator object containing all the keys of the dictionary.
</desc>
</method>
<method type="NSArray*">
<sel> keysSortedByValueUsingSelector:</sel>
<arg type="SEL">comparator</arg>
<desc>
</desc>
</method>
<method type="NSEnumerator*">
<sel>objectEnumerator</sel>
<desc>
Return an enumerator object containing all the keys of the dictionary.
</desc>
</method>
<method type="id">
<sel>objectForKey:</sel>
<arg type="id">aKey</arg>
<desc>
Returns the first object which has aKey as key.
</desc>
</method>
<method type="NSArray*">
@ -221,6 +265,7 @@
<sel>notFoundMarker:</sel>
<arg type="id">anObject</arg>
<desc>
</desc>
</method>
<method type="BOOL">
@ -229,6 +274,7 @@
<sel>atomically:</sel>
<arg type="BOOL">flag</arg>
<desc>
</desc>
</method>
</class>

113
Documentation/gsdoc/NSDictionary.html
View file

@ -10,35 +10,39 @@
<dl>
<dt><a href="http://www.gnustep.org/developers/whoiswho.html">Richard Frith-Macdonald</a>
<dd>
<dt><a href="http://altern.org/pyhrr">Pierre-Yves Rivaille</a>
<dd>
</dl>
<p>Version: 0.1</p>
<p>Date: 28 February, 2000</p>
<p>Version: 0.2</p>
<p>Date: 25 April, 2000</p>
<h2><a name="cont-0">NSDictionary</a></h2>
<h2><a name="NSDictionary">NSDictionary</a></h2>
<p><b>Declared in:</b> Foundation/NSDictionary.h</p>
<p><b>Inherits from:</b> NSObject</p>
<p><b>Conforms to:</b> NSCoding
<p><b>Conforms to:</b> NSCoding, NSCopying, NSMutableCopying
</p>
<hr>
<ul>
<li><a href="NSDictionary.html#method-0">+allocWithZone:</a>
<li><a href="NSDictionary.html#method-1">+dictionary</a>
<li><a href="NSDictionary.html#method-2">+dictionaryWithContentsOfFile:</a>
<li><a href="NSDictionary.html#method-3">+dictionaryWithDictionary:</a>
<li><a href="NSDictionary.html#method-4">+dictionaryWithObject:</a>
<li><a href="NSDictionary.html#method-5">+dictionaryWithObjects:</a>
<li><a href="NSDictionary.html#method-4">+dictionaryWithObject:forKey:</a>
<li><a href="NSDictionary.html#method-5">+dictionaryWithObjects:forKey:</a>
<li><a href="NSDictionary.html#method-6">+dictionaryWithObjects:forKeys:count:</a>
<li><a href="NSDictionary.html#method-7">+dictionaryWithObjectsAndKeys:</a>
<li><a href="NSDictionary.html#method-31">- keysSortedByValueUsingSelector:</a>
<li><a href="NSDictionary.html#method-30">- keysSortedByValueUsingSelector:</a>
<li><a href="NSDictionary.html#method-8">-allKeys</a>
<li><a href="NSDictionary.html#method-9">-allKeysForObject:</a>
<li><a href="NSDictionary.html#method-10">-allValues</a>
<li><a href="NSDictionary.html#method-11">-count</a>
<li><a href="NSDictionary.html#method-12">-descriptionInStringsFileFormat</a>
<li><a href="NSDictionary.html#method-13">-descriptionWithLocale:</a>
<li><a href="NSDictionary.html#method-14">-descriptionWithLocale:</a>
<li><a href="NSDictionary.html#method-13">-descriptionWithLocale:</a>
<li><a href="NSDictionary.html#method-15">-fileGroupOwnerAccountName</a>
<li><a href="NSDictionary.html#method-16">-fileModificationDate</a>
<li><a href="NSDictionary.html#method-17">-fileOwnerAccountName</a>
@ -48,17 +52,16 @@
<li><a href="NSDictionary.html#method-21">-fileSystemNumber</a>
<li><a href="NSDictionary.html#method-22">-fileType</a>
<li><a href="NSDictionary.html#method-23">-initWithContentsOfFile:</a>
<li><a href="NSDictionary.html#method-25">-initWithDictionary:</a>
<li><a href="NSDictionary.html#method-24">-initWithDictionary:</a>
<li><a href="NSDictionary.html#method-26">-initWithObjects:</a>
<li><a href="NSDictionary.html#method-27">-initWithObjects:forKeys:count:</a>
<li><a href="NSDictionary.html#method-28">-initWithObjectsAndKeys:</a>
<li><a href="NSDictionary.html#method-29">-isEqualToDictionary:</a>
<li><a href="NSDictionary.html#method-30">-keyEnumerator</a>
<li><a href="NSDictionary.html#method-32">-objectEnumerator</a>
<li><a href="NSDictionary.html#method-33">-objectForKey:</a>
<li><a href="NSDictionary.html#method-34">-objectsForKeys:notFoundMarker:</a>
<li><a href="NSDictionary.html#method-35">-writeToFile:atomically:</a>
<li><a href="NSDictionary.html#method-25">-initWithObjects:</a>
<li><a href="NSDictionary.html#method-26">-initWithObjects:forKeys:count:</a>
<li><a href="NSDictionary.html#method-27">-initWithObjectsAndKeys:</a>
<li><a href="NSDictionary.html#method-28">-isEqualToDictionary:</a>
<li><a href="NSDictionary.html#method-29">-keyEnumerator</a>
<li><a href="NSDictionary.html#method-31">-objectEnumerator</a>
<li><a href="NSDictionary.html#method-32">-objectForKey:</a>
<li><a href="NSDictionary.html#method-33">-objectsForKeys:notFoundMarker:</a>
<li><a href="NSDictionary.html#method-34">-writeToFile:atomically:</a>
</ul>
<hr>
<h2><a name="method-0">allocWithZone:</a></h2>
@ -69,176 +72,212 @@
<h2><a name="method-1">dictionary</a></h2>
+ (id) <b>dictionary</b><br>
Returns an empty dictionary.
<hr>
<h2><a name="method-2">dictionaryWithContentsOfFile:</a></h2>
+ (id) <b>dictionaryWithContentsOfFile:</b> (NSString*)path<br>
Returns a dictionary using the file located at path.
The file must be a property list containing a dictionary as its root object.
<hr>
<h2><a name="method-3">dictionaryWithDictionary:</a></h2>
+ (id) <b>dictionaryWithDictionary:</b> (NSDictionary*)otherDictionary<br>
Returns a newly created dictionary with the keys and objects of otherDictionary.
(The keys and objects are not copied.)
<hr>
<h2><a name="method-4">dictionaryWithObject:</a></h2>
+ (id) <b>dictionaryWithObject:</b> (id)anObject<br>
<h2><a name="method-4">dictionaryWithObject:forKey:</a></h2>
+ (id) <b>dictionaryWithObject:</b> (id)anObject <b>forKey:</b> (id)aKey<br>
Returns a dictionary containing only one object (anObject) which is associated with aKey.
<hr>
<h2><a name="method-5">dictionaryWithObjects:</a></h2>
+ (id) <b>dictionaryWithObjects:</b> (NSArray*)objects<br>
<h2><a name="method-5">dictionaryWithObjects:forKey:</a></h2>
+ (id) <b>dictionaryWithObjects:</b> (NSArray*)objects <b>forKey:</b> (NSArray*)keys<br>
Returns a dictionary created using the given objects and keys.
The two arrays must have the same size.
The n th element of the objects array is associated with the n th element of the keys array.
<hr>
<h2><a name="method-6">dictionaryWithObjects:forKeys:count:</a></h2>
+ (id) <b>dictionaryWithObjects:</b> (id*)objects <b>forKeys:</b> (id*)keys <b>count:</b> (unsigned int)count<br>
Returns a dictionary created using the C arrays objects and keys.
The number of elements in both C arrays must be count.
<hr>
<h2><a name="method-7">dictionaryWithObjectsAndKeys:</a></h2>
+ (id) <b>dictionaryWithObjectsAndKeys:</b> (id)object,<br>
+ (id) <b>dictionaryWithObjectsAndKeys:</b> (id)object, ...<br>
Returns a dictionary created using the list given as argument.
The list is alernately composed of objects and keys.
Thus, the list's length must be pair.
<hr>
<h2><a name="method-8">allKeys</a></h2>
- (NSArray*) <b>allKeys</b><br>
Returns an array containing all the dictionary's keys.
<hr>
<h2><a name="method-9">allKeysForObject:</a></h2>
- (NSArray*) <b>allKeysForObject:</b> (id)anObject<br>
Returns an array containing all the dictionary's keys that are associated with anObject.
<hr>
<h2><a name="method-10">allValues</a></h2>
- (NSArray*) <b>allValues</b><br>
Returns an array containing all the dictionary's objects.
<hr>
<h2><a name="method-11">count</a></h2>
- (unsigned int) <b>count</b><br>
Returns an unsigned integer which is the number of elements stored in the dictionary.
<hr>
<h2><a name="method-12">descriptionInStringsFileFormat</a></h2>
- (NSString*) <b>descriptionInStringsFileFormat</b><br>
<hr>
<h2><a name="method-13">descriptionWithLocale:</a></h2>
- (NSString*) <b>descriptionWithLocale:</b> (NSDictionary*)locale<br>
<hr>
<h2><a name="method-14">descriptionWithLocale:</a></h2>
- (NSString*) <b>descriptionWithLocale:</b> (NSDictionary*)locale<br>
<hr>
<h2><a name="method-15">fileGroupOwnerAccountName</a></h2>
- (NSString*) <b>fileGroupOwnerAccountName</b><br>
<hr>
<h2><a name="method-16">fileModificationDate</a></h2>
- (NSDate*) <b>fileModificationDate</b><br>
<hr>
<h2><a name="method-17">fileOwnerAccountName</a></h2>
- (NSString*) <b>fileOwnerAccountName</b><br>
<hr>
<h2><a name="method-18">filePosixPermissions</a></h2>
- (unsigned long) <b>filePosixPermissions</b><br>
<hr>
<h2><a name="method-19">fileSize</a></h2>
- (unsigned long long) <b>fileSize</b><br>
<hr>
<h2><a name="method-20">fileSystemFileNumber</a></h2>
- (unsigned long) <b>fileSystemFileNumber</b><br>
<hr>
<h2><a name="method-21">fileSystemNumber</a></h2>
- (unsigned long) <b>fileSystemNumber</b><br>
<hr>
<h2><a name="method-22">fileType</a></h2>
- (NSString*) <b>fileType</b><br>
<hr>
<h2><a name="method-23">initWithContentsOfFile:</a></h2>
- (id) <b>initWithContentsOfFile:</b> (NSString*)path<br>
see dictionaryWithContentOfFile:
<hr>
<h2><a name="method-24">initWithDictionary:</a></h2>
- (id) <b>initWithDictionary:</b> (NSDictionary*)otherDictionary<br>
See dictionaryWithDictionary:
<hr>
<h2><a name="method-25">initWithDictionary:</a></h2>
- (id) <b>initWithDictionary:</b> (NSDictionary*)otherDictionary<br>
<hr>
<h2><a name="method-26">initWithObjects:</a></h2>
<h2><a name="method-25">initWithObjects:</a></h2>
- (id) <b>initWithObjects:</b> (NSArray*)objects<br>
See <a href="#dictionaryWithObjects:">dictionaryWithObjects:</a>
<hr>
<h2><a name="method-27">initWithObjects:forKeys:count:</a></h2>
<h2><a name="method-26">initWithObjects:forKeys:count:</a></h2>
- (id) <b>initWithObjects:</b> (id*)objects <b>forKeys:</b> (id*)keys <b>count:</b> (unsigned int)count<br>
see dictionaryWithObjects: forKeys: count:
<hr>
<h2><a name="method-28">initWithObjectsAndKeys:</a></h2>
<h2><a name="method-27">initWithObjectsAndKeys:</a></h2>
- (id) <b>initWithObjectsAndKeys:</b> (id)object,<br>
see dictionaryWithObjectsAndKeys:
<hr>
<h2><a name="method-29">isEqualToDictionary:</a></h2>
<h2><a name="method-28">isEqualToDictionary:</a></h2>
- (BOOL) <b>isEqualToDictionary:</b> (NSDictionary*)otherDictionary<br>
<hr>
<h2><a name="method-30">keyEnumerator</a></h2>
<h2><a name="method-29">keyEnumerator</a></h2>
- (NSEnumerator*) <b>keyEnumerator</b><br>
Return an enumerator object containing all the keys of the dictionary.
<hr>
<h2><a name="method-31"> keysSortedByValueUsingSelector:</a></h2>
<h2><a name="method-30"> keysSortedByValueUsingSelector:</a></h2>
- (NSArray*) <b> keysSortedByValueUsingSelector:</b> (SEL)comparator<br>
<hr>
<h2><a name="method-32">objectEnumerator</a></h2>
<h2><a name="method-31">objectEnumerator</a></h2>
- (NSEnumerator*) <b>objectEnumerator</b><br>
Return an enumerator object containing all the keys of the dictionary.
<hr>
<h2><a name="method-33">objectForKey:</a></h2>
<h2><a name="method-32">objectForKey:</a></h2>
- (id) <b>objectForKey:</b> (id)aKey<br>
Returns the first object which has aKey as key.
<hr>
<h2><a name="method-34">objectsForKeys:notFoundMarker:</a></h2>
<h2><a name="method-33">objectsForKeys:notFoundMarker:</a></h2>
- (NSArray*) <b>objectsForKeys:</b> (NSArray*)keys <b>notFoundMarker:</b> (id)anObject<br>
<hr>
<h2><a name="method-35">writeToFile:atomically:</a></h2>
<h2><a name="method-34">writeToFile:atomically:</a></h2>
- (BOOL) <b>writeToFile:</b> (NSString*)path <b>atomically:</b> (BOOL)flag<br>
<hr>
</body>