2000-02-28 16:30:00 +00:00
|
|
|
<?xml version="1.0"?>
|
2000-07-04 19:53:39 +00:00
|
|
|
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.6//EN" "http://www.gnustep.org/gsdoc-0_6_6.xml">
|
|
|
|
|
<gsdoc base="NSDictionary" prev="NSDeserializer" next="NSDirectoryEnumerator" up="Base">
|
2000-02-28 16:30:00 +00:00
|
|
|
<head>
|
|
|
|
|
<title>NSDictionary</title>
|
|
|
|
|
<author name="Richard Frith-Macdonald">
|
|
|
|
|
<email address="rfm@gnu.org"/>
|
|
|
|
|
<url url="http://www.gnustep.org/developers/whoiswho.html"/>
|
|
|
|
|
</author>
|
2000-05-08 20:45:47 +00:00
|
|
|
<author name="Pierre-Yves Rivaille">
|
|
|
|
|
<email address="pyhrr@altern.org"/>
|
|
|
|
|
<url url="http://altern.org/pyhrr"/>
|
|
|
|
|
</author>
|
2001-03-03 09:56:29 +00:00
|
|
|
<version>$Revision$>/version>
|
|
|
|
|
<date>$Date$</date>
|
2000-02-28 16:30:00 +00:00
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<chapter>
|
|
|
|
|
<heading>NSDictionary</heading>
|
|
|
|
|
<class name="NSDictionary" super="NSObject">
|
|
|
|
|
<declared>Foundation/NSDictionary.h</declared>
|
2000-05-08 20:45:47 +00:00
|
|
|
<conform>NSCoding, NSCopying, NSMutableCopying</conform>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
|
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
<method type="id" factory="yes">
|
|
|
|
|
<sel>allocWithZone:</sel>
|
|
|
|
|
<arg type="NSZone*">zone</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id" factory="yes">
|
|
|
|
|
<sel>dictionary</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Returns an empty dictionary.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id" factory="yes">
|
|
|
|
|
<sel>dictionaryWithContentsOfFile:</sel>
|
|
|
|
|
<arg type="NSString*">path</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Returns a dictionary using the file located at path.
|
|
|
|
|
The file must be a property list containing a dictionary as its root object.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id" factory="yes">
|
|
|
|
|
<sel>dictionaryWithDictionary:</sel>
|
|
|
|
|
<arg type="NSDictionary*">otherDictionary</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Returns a newly created dictionary with the keys and objects of otherDictionary.
|
|
|
|
|
(The keys and objects are not copied.)
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id" factory="yes">
|
|
|
|
|
<sel>dictionaryWithObject:</sel>
|
|
|
|
|
<arg type="id">anObject</arg>
|
2000-05-08 20:45:47 +00:00
|
|
|
<sel>forKey:</sel>
|
|
|
|
|
<arg type="id">aKey</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Returns a dictionary containing only one object (anObject) which is associated with aKey.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id" factory="yes">
|
|
|
|
|
<sel>dictionaryWithObjects:</sel>
|
|
|
|
|
<arg type="NSArray*">objects</arg>
|
2000-05-08 20:45:47 +00:00
|
|
|
<sel>forKey:</sel>
|
|
|
|
|
<arg type="NSArray*">keys</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
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.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id" factory="yes">
|
|
|
|
|
<sel>dictionaryWithObjects:</sel>
|
|
|
|
|
<arg type="id*">objects</arg>
|
|
|
|
|
<sel>forKeys:</sel>
|
|
|
|
|
<arg type="id*">keys</arg>
|
|
|
|
|
<sel>count:</sel>
|
|
|
|
|
<arg type="unsigned int">count</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Returns a dictionary created using the C arrays objects and keys.
|
|
|
|
|
The number of elements in both C arrays must be count.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id" factory="yes">
|
|
|
|
|
<sel>dictionaryWithObjectsAndKeys:</sel>
|
2000-05-08 20:45:47 +00:00
|
|
|
<arg type="id">object, ...</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
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.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSArray*">
|
|
|
|
|
<sel>allKeys</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Returns an array containing all the dictionary's keys.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSArray*">
|
|
|
|
|
<sel>allKeysForObject:</sel>
|
|
|
|
|
<arg type="id">anObject</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Returns an array containing all the dictionary's keys that are associated with anObject.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSArray*">
|
|
|
|
|
<sel>allValues</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Returns an array containing all the dictionary's objects.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="unsigned int">
|
|
|
|
|
<sel>count</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Returns an unsigned integer which is the number of elements stored in the dictionary.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSString*">
|
|
|
|
|
<sel>descriptionInStringsFileFormat</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSString*">
|
|
|
|
|
<sel>descriptionWithLocale:</sel>
|
|
|
|
|
<arg type="NSDictionary*">locale</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSString*">
|
|
|
|
|
<sel>descriptionWithLocale:</sel>
|
|
|
|
|
<arg type="NSDictionary*">locale</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSString*">
|
|
|
|
|
<sel>fileGroupOwnerAccountName</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSDate*">
|
|
|
|
|
<sel>fileModificationDate</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSString*">
|
|
|
|
|
<sel>fileOwnerAccountName</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
2000-02-29 11:06:47 +00:00
|
|
|
<method type="unsigned long">
|
2000-02-29 11:01:41 +00:00
|
|
|
<sel>filePosixPermissions</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
2000-02-29 11:06:47 +00:00
|
|
|
<method type="unsigned long long">
|
2000-02-29 11:01:41 +00:00
|
|
|
<sel>fileSize</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
2000-02-29 11:06:47 +00:00
|
|
|
<method type="unsigned long">
|
2000-02-29 11:01:41 +00:00
|
|
|
<sel>fileSystemFileNumber</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
2000-02-29 11:06:47 +00:00
|
|
|
<method type="unsigned long">
|
2000-02-29 11:01:41 +00:00
|
|
|
<sel>fileSystemNumber</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSString*">
|
|
|
|
|
<sel>fileType</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithContentsOfFile:</sel>
|
|
|
|
|
<arg type="NSString*">path</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
see dictionaryWithContentOfFile:
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithDictionary:</sel>
|
|
|
|
|
<arg type="NSDictionary*">otherDictionary</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
See dictionaryWithDictionary:
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithObjects:</sel>
|
|
|
|
|
<arg type="NSArray*">objects</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
See <ref id="dictionaryWithObjects:">dictionaryWithObjects:</ref>
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithObjects:</sel>
|
|
|
|
|
<arg type="id*">objects</arg>
|
|
|
|
|
<sel>forKeys:</sel>
|
|
|
|
|
<arg type="id*">keys</arg>
|
|
|
|
|
<sel>count:</sel>
|
|
|
|
|
<arg type="unsigned int">count</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
see dictionaryWithObjects: forKeys: count:
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithObjectsAndKeys:</sel>
|
|
|
|
|
<arg type="id">object,</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
see dictionaryWithObjectsAndKeys:
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>isEqualToDictionary:</sel>
|
|
|
|
|
<arg type="NSDictionary*">otherDictionary</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSEnumerator*">
|
|
|
|
|
<sel>keyEnumerator</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Return an enumerator object containing all the keys of the dictionary.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSArray*">
|
|
|
|
|
<sel> keysSortedByValueUsingSelector:</sel>
|
|
|
|
|
<arg type="SEL">comparator</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSEnumerator*">
|
|
|
|
|
<sel>objectEnumerator</sel>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Return an enumerator object containing all the keys of the dictionary.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>objectForKey:</sel>
|
|
|
|
|
<arg type="id">aKey</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
Returns the first object which has aKey as key.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSArray*">
|
|
|
|
|
<sel>objectsForKeys:</sel>
|
|
|
|
|
<arg type="NSArray*">keys</arg>
|
|
|
|
|
<sel>notFoundMarker:</sel>
|
|
|
|
|
<arg type="id">anObject</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>writeToFile:</sel>
|
|
|
|
|
<arg type="NSString*">path</arg>
|
|
|
|
|
<sel>atomically:</sel>
|
|
|
|
|
<arg type="BOOL">flag</arg>
|
|
|
|
|
<desc>
|
2000-05-08 20:45:47 +00:00
|
|
|
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
2000-02-28 18:30:41 +00:00
|
|
|
</method>
|
2000-02-28 16:30:00 +00:00
|
|
|
</class>
|
|
|
|
|
</chapter>
|
|
|
|
|
</body>
|
|
|
|
|
</gsdoc>
|
