← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gnustep-base/karmic

« back to all changes in this revision

Viewing changes to Documentation/gsdoc/NSDictionary.gsdoc

  • Committer: Bazaar Package Importer
  • Author(s): Eric Heintzmann
  • Date: 2005-04-17 00:14:38 UTC
  • mfrom: (1.2.1 upstream) (2.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050417001438-enf0y07c9tku85z1
Tags: 1.10.3-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Documentation/gsdoc/NSDictionary.gsdoc
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.6//EN" "http://www.gnustep.org/gsdoc-0_6_6.xml">
3
 
<gsdoc base="NSDictionary" prev="NSDeserializer" next="NSDirectoryEnumerator" up="Base">
4
 
  <head>
5
 
    <title>NSDictionary</title>
6
 
    <author name="Richard Frith-Macdonald">
7
 
      <email address="rfm@gnu.org"/>
8
 
      <url url="http://www.gnustep.org/developers/whoiswho.html"/>
9
 
    </author>
10
 
    <author name="Pierre-Yves Rivaille">
11
 
      <email address="pyhrr@altern.org"/>
12
 
      <url url="http://altern.org/pyhrr"/>
13
 
    </author>
14
 
    <version>$Revision: 1.10 $</version>
15
 
    <date>$Date: 2001/07/16 19:39:21 $</date>
16
 
  </head>
17
 
  <body>
18
 
    <chapter>
19
 
      <heading>NSDictionary</heading>
20
 
      <class name="NSDictionary" super="NSObject">
21
 
        <declared>Foundation/NSDictionary.h</declared>
22
 
        <conform>NSCoding, NSCopying, NSMutableCopying</conform>
23
 
          <desc>
24
 
 
25
 
 
26
 
          </desc>
27
 
        <method type="id" factory="yes">
28
 
          <sel>allocWithZone:</sel>
29
 
          <arg type="NSZone*">zone</arg>
30
 
          <desc>
31
 
          </desc>
32
 
        </method>
33
 
        <method type="id" factory="yes">
34
 
          <sel>dictionary</sel>
35
 
          <desc>
36
 
            Returns an empty dictionary.
37
 
          </desc>
38
 
        </method>
39
 
        <method type="id" factory="yes">
40
 
          <sel>dictionaryWithContentsOfFile:</sel>
41
 
          <arg type="NSString*">path</arg>
42
 
          <desc>
43
 
            Returns a dictionary using the file located at path. 
44
 
            The file must be a property list containing a dictionary as its root object.
45
 
          </desc>
46
 
        </method>
47
 
        <method type="id" factory="yes">
48
 
          <sel>dictionaryWithDictionary:</sel>
49
 
          <arg type="NSDictionary*">otherDictionary</arg>
50
 
          <desc>
51
 
            Returns a newly created dictionary with the keys and objects of otherDictionary.
52
 
            (The keys and objects are not copied.)
53
 
          </desc>
54
 
        </method>
55
 
        <method type="id" factory="yes">
56
 
          <sel>dictionaryWithObject:</sel>
57
 
          <arg type="id">anObject</arg>
58
 
          <sel>forKey:</sel>
59
 
          <arg type="id">aKey</arg>
60
 
          <desc>
61
 
            Returns a dictionary containing only one object (anObject) which is associated with aKey.
62
 
          </desc>
63
 
        </method>
64
 
        <method type="id" factory="yes">
65
 
          <sel>dictionaryWithObjects:</sel>
66
 
          <arg type="NSArray*">objects</arg>
67
 
          <sel>forKey:</sel>
68
 
          <arg type="NSArray*">keys</arg>
69
 
          <desc>
70
 
            Returns a dictionary created using the given objects and keys.
71
 
            The two arrays must have the same size.
72
 
            The n th element of the objects array is associated with the n th element of the keys array.
73
 
          </desc>
74
 
        </method>
75
 
        <method type="id" factory="yes">
76
 
          <sel>dictionaryWithObjects:</sel>
77
 
          <arg type="id*">objects</arg>
78
 
          <sel>forKeys:</sel>
79
 
          <arg type="id*">keys</arg>
80
 
          <sel>count:</sel>
81
 
          <arg type="unsigned int">count</arg>
82
 
          <desc>
83
 
            Returns a dictionary created using the C arrays objects and keys.
84
 
            The number of elements in both C arrays must be count.
85
 
          </desc>
86
 
        </method>
87
 
        <method type="id" factory="yes">
88
 
          <sel>dictionaryWithObjectsAndKeys:</sel>
89
 
          <arg type="id">object, ...</arg>
90
 
          <desc>
91
 
            Returns a dictionary created using the list given as argument.
92
 
            The list is alernately composed of objects and keys.
93
 
            Thus, the list's length must be pair.
94
 
          </desc>
95
 
        </method>
96
 
        <method type="NSArray*">
97
 
          <sel>allKeys</sel>
98
 
          <desc>
99
 
            Returns an array containing all the dictionary's keys.
100
 
          </desc>
101
 
        </method>
102
 
        <method type="NSArray*">
103
 
          <sel>allKeysForObject:</sel>
104
 
          <arg type="id">anObject</arg>
105
 
          <desc>
106
 
            Returns an array containing all the dictionary's keys that are associated with anObject.
107
 
          </desc>
108
 
        </method>
109
 
        <method type="NSArray*">
110
 
          <sel>allValues</sel>
111
 
          <desc>
112
 
            Returns an array containing all the dictionary's objects.
113
 
          </desc>
114
 
        </method>
115
 
        <method type="unsigned int">
116
 
          <sel>count</sel>
117
 
          <desc>
118
 
            Returns an unsigned integer which is the number of elements stored in the dictionary.
119
 
          </desc>
120
 
        </method>
121
 
        <method type="NSString*">
122
 
          <sel>descriptionInStringsFileFormat</sel>
123
 
          <desc>
124
 
            
125
 
          </desc>
126
 
        </method>
127
 
        <method type="NSString*">
128
 
          <sel>descriptionWithLocale:</sel>
129
 
          <arg type="NSDictionary*">locale</arg>
130
 
          <desc>
131
 
            
132
 
          </desc>
133
 
        </method>
134
 
        <method type="NSString*">
135
 
          <sel>descriptionWithLocale:</sel>
136
 
          <arg type="NSDictionary*">locale</arg>
137
 
          <desc>
138
 
            
139
 
          </desc>
140
 
        </method>
141
 
        <method type="NSString*">
142
 
          <sel>fileGroupOwnerAccountName</sel>
143
 
          <desc>
144
 
           
145
 
          </desc>
146
 
        </method>
147
 
        <method type="NSDate*">
148
 
          <sel>fileModificationDate</sel>
149
 
          <desc>
150
 
           
151
 
          </desc>
152
 
        </method>
153
 
        <method type="NSString*">
154
 
          <sel>fileOwnerAccountName</sel>
155
 
          <desc>
156
 
            
157
 
          </desc>
158
 
        </method>
159
 
        <method type="unsigned long">
160
 
          <sel>filePosixPermissions</sel>
161
 
          <desc>
162
 
            
163
 
          </desc>
164
 
        </method>
165
 
        <method type="unsigned long long">
166
 
          <sel>fileSize</sel>
167
 
          <desc>
168
 
           
169
 
          </desc>
170
 
        </method>
171
 
        <method type="unsigned long">
172
 
          <sel>fileSystemFileNumber</sel>
173
 
          <desc>
174
 
            
175
 
          </desc>
176
 
        </method>
177
 
        <method type="unsigned long">
178
 
          <sel>fileSystemNumber</sel>
179
 
          <desc>
180
 
            
181
 
          </desc>
182
 
        </method>
183
 
        <method type="NSString*">
184
 
          <sel>fileType</sel>
185
 
          <desc>
186
 
            
187
 
          </desc>
188
 
        </method>
189
 
        <method type="id">
190
 
          <sel>initWithContentsOfFile:</sel>
191
 
          <arg type="NSString*">path</arg>
192
 
          <desc>
193
 
            see dictionaryWithContentOfFile:
194
 
          </desc>
195
 
        </method>
196
 
        <method type="id">
197
 
          <sel>initWithDictionary:</sel>
198
 
          <arg type="NSDictionary*">otherDictionary</arg>
199
 
          <desc>
200
 
            See dictionaryWithDictionary: 
201
 
          </desc>
202
 
        </method>
203
 
        <method type="id">
204
 
          <sel>initWithObjects:</sel>
205
 
          <arg type="NSArray*">objects</arg>
206
 
          <desc>
207
 
            See <ref id="dictionaryWithObjects:">dictionaryWithObjects:</ref>            
208
 
          </desc>
209
 
        </method>
210
 
 
211
 
        <method type="id">
212
 
          <sel>initWithObjects:</sel>
213
 
          <arg type="id*">objects</arg>
214
 
          <sel>forKeys:</sel>
215
 
          <arg type="id*">keys</arg>
216
 
          <sel>count:</sel>
217
 
          <arg type="unsigned int">count</arg>
218
 
          <desc>
219
 
            see dictionaryWithObjects: forKeys: count:
220
 
          </desc>
221
 
        </method>
222
 
        <method type="id">
223
 
          <sel>initWithObjectsAndKeys:</sel>
224
 
          <arg type="id">object,</arg>
225
 
          <desc>
226
 
            see dictionaryWithObjectsAndKeys:
227
 
          </desc>
228
 
        </method>
229
 
        <method type="BOOL">
230
 
          <sel>isEqualToDictionary:</sel>
231
 
          <arg type="NSDictionary*">otherDictionary</arg>
232
 
          <desc>
233
 
            
234
 
          </desc>
235
 
        </method>
236
 
        <method type="NSEnumerator*">
237
 
          <sel>keyEnumerator</sel>
238
 
          <desc>
239
 
            Return an enumerator object containing all the keys of the dictionary.
240
 
          </desc>
241
 
        </method>
242
 
        <method type="NSArray*">
243
 
          <sel> keysSortedByValueUsingSelector:</sel>
244
 
          <arg type="SEL">comparator</arg>
245
 
          <desc>
246
 
            
247
 
          </desc>
248
 
        </method>
249
 
        <method type="NSEnumerator*">
250
 
          <sel>objectEnumerator</sel>
251
 
          <desc>
252
 
            Return an enumerator object containing all the keys of the dictionary.
253
 
          </desc>
254
 
        </method>
255
 
        <method type="id">
256
 
          <sel>objectForKey:</sel>
257
 
          <arg type="id">aKey</arg>
258
 
          <desc>
259
 
            Returns the first object which has aKey as key.
260
 
          </desc>
261
 
        </method>
262
 
        <method type="NSArray*">
263
 
          <sel>objectsForKeys:</sel>
264
 
          <arg type="NSArray*">keys</arg>
265
 
          <sel>notFoundMarker:</sel>
266
 
          <arg type="id">anObject</arg>
267
 
          <desc>
268
 
            
269
 
          </desc>
270
 
        </method>
271
 
        <method type="BOOL">
272
 
          <sel>writeToFile:</sel>
273
 
          <arg type="NSString*">path</arg>
274
 
          <sel>atomically:</sel>
275
 
          <arg type="BOOL">flag</arg>
276
 
          <desc>
277
 
            
278
 
          </desc>
279
 
        </method>
280
 
        <method type="BOOL">
281
 
          <sel>writeToURL:</sel>
282
 
          <arg type="NSURL*">url</arg>
283
 
          <sel>atomically:</sel>
284
 
          <arg type="BOOL">flag</arg>
285
 
          <desc>
286
 
            
287
 
          </desc>
288
 
        </method>
289
 
      </class>
290
 
    </chapter>
291
 
  </body>
292
 
</gsdoc>