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

« back to all changes in this revision

Viewing changes to Documentation/gsdoc/NSNumber.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:
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="NSNumber" prev="NSNull" next="NSNumberFormatter" up="Base">
4
 
  <head>
5
 
    <title>NSNumber</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
 
    <version>$Revision: 1.10 $</version>
11
 
    <date>$Date: 2001/11/12 13:01:09 $</date>
12
 
  </head>
13
 
  <body>
14
 
    <chapter>
15
 
      <heading>NSNumber</heading>
16
 
      <class name="NSNumber" super="NSValue">
17
 
        <declared>Foundation/NSValue.h</declared>
18
 
        <conform>NSCoding</conform>
19
 
          <desc>
20
 
          </desc>
21
 
        <method type="NSNumber*" factory="yes">
22
 
          <sel>numberWithBool:</sel>
23
 
          <arg type="BOOL">value</arg>
24
 
          <desc>
25
 
          </desc>
26
 
        </method>
27
 
        <method type="NSNumber*" factory="yes">
28
 
          <sel>numberWithChar:</sel>
29
 
          <arg type="char">value</arg>
30
 
          <desc>
31
 
          </desc>
32
 
        </method>
33
 
        <method type="NSNumber*" factory="yes">
34
 
          <sel>numberWithDouble:</sel>
35
 
          <arg type="double">value</arg>
36
 
          <desc>
37
 
          </desc>
38
 
        </method>
39
 
        <method type="NSNumber*" factory="yes">
40
 
          <sel>numberWithFloat:</sel>
41
 
          <arg type="float">value</arg>
42
 
          <desc>
43
 
          </desc>
44
 
        </method>
45
 
        <method type="NSNumber*" factory="yes">
46
 
          <sel>numberWithInt:</sel>
47
 
          <arg type="int">value</arg>
48
 
          <desc>
49
 
          </desc>
50
 
        </method>
51
 
        <method type="NSNumber*" factory="yes">
52
 
          <sel>numberWithLong:</sel>
53
 
          <arg type="long int">value</arg>
54
 
          <desc>
55
 
          </desc>
56
 
        </method>
57
 
        <method type="NSNumber*" factory="yes">
58
 
          <sel>numberWithLongLong:</sel>
59
 
          <arg type="long long int">value</arg>
60
 
          <desc>
61
 
          </desc>
62
 
        </method>
63
 
        <method type="NSNumber*" factory="yes">
64
 
          <sel>numberWithShort:</sel>
65
 
          <arg type="short int">value</arg>
66
 
          <desc>
67
 
          </desc>
68
 
        </method>
69
 
        <method type="NSNumber*" factory="yes">
70
 
          <sel>numberWithUnsignedChar:</sel>
71
 
          <arg type="unsigned char">value</arg>
72
 
          <desc>
73
 
          </desc>
74
 
        </method>
75
 
        <method type="NSNumber*" factory="yes">
76
 
          <sel>numberWithUnsignedInt:</sel>
77
 
          <arg type="unsigned int">value</arg>
78
 
          <desc>
79
 
          </desc>
80
 
        </method>
81
 
        <method type="NSNumber*" factory="yes">
82
 
          <sel>numberWithUnsignedLong:</sel>
83
 
          <arg type="unsigned long int">value</arg>
84
 
          <desc>
85
 
          </desc>
86
 
        </method>
87
 
        <method type="NSNumber*" factory="yes">
88
 
          <sel>numberWithUnsignedLongLong:</sel>
89
 
          <arg type="unsigned long long int">value</arg>
90
 
          <desc>
91
 
          </desc>
92
 
        </method>
93
 
        <method type="NSNumber*" factory="yes">
94
 
          <sel>numberWithUnsignedShort:</sel>
95
 
          <arg type="unsigned short int">value</arg>
96
 
          <desc>
97
 
          </desc>
98
 
        </method>
99
 
        <method type="BOOL">
100
 
          <sel>boolValue</sel>
101
 
          <desc>
102
 
          </desc>
103
 
        </method>
104
 
        <method type="char">
105
 
          <sel>charValue</sel>
106
 
          <desc>
107
 
          </desc>
108
 
        </method>
109
 
        <method type="NSComparisonResult">
110
 
          <sel>compare:</sel>
111
 
          <arg type="NSNumber*">aNumber</arg>
112
 
          <desc>
113
 
          </desc>
114
 
        </method>
115
 
        <method type="NSDecimal">
116
 
          <sel>decimalValue</sel>
117
 
          <desc>
118
 
          </desc>
119
 
        </method>
120
 
        <method type="NSString*">
121
 
          <sel>description</sel>
122
 
          <desc>
123
 
            Invokes descriptionWithLocale: using nil locale.
124
 
          </desc>
125
 
        </method>
126
 
        <method type="NSString*">
127
 
          <sel>descriptionWithLocale:</sel>
128
 
          <arg type="NSDictionary*">aLocale</arg>
129
 
          <desc>
130
 
            <p>
131
 
              Produces a string representation of the number.  For a boolean
132
 
              this will be either 'true' or 'false'.  For other numbers the
133
 
              format is produced using the initWithFormat:locale:... method
134
 
              of NSString, and the format depends on the type of number as
135
 
              follows -
136
 
            </p>
137
 
            <deflist>
138
 
              <term>char</term>
139
 
              <desc>%i</desc>
140
 
              <term> short</term>
141
 
              <desc>%hi</desc>
142
 
              <term> int</term>
143
 
              <desc>%i</desc>
144
 
              <term> long</term>
145
 
              <desc>%li</desc>
146
 
              <term> long long</term>
147
 
              <desc>%li</desc>
148
 
              <term> unsigned char</term>
149
 
              <desc>%u</desc>
150
 
              <term> unsigned short</term>
151
 
              <desc>%hu</desc>
152
 
              <term> unsigned int</term>
153
 
              <desc>%u</desc>
154
 
              <term> unsigned long</term>
155
 
              <desc>%lu</desc>
156
 
              <term> unsigned long long</term>
157
 
              <desc>%lu</desc>
158
 
              <term> float</term>
159
 
              <desc>%0.7g</desc>
160
 
              <term> double</term>
161
 
              <desc>%0.16g</desc>
162
 
            </deflist>
163
 
          </desc>
164
 
        </method>
165
 
        <method type="double">
166
 
          <sel>doubleValue</sel>
167
 
          <desc>
168
 
          </desc>
169
 
        </method>
170
 
        <method type="float">
171
 
          <sel>floatValue</sel>
172
 
          <desc>
173
 
          </desc>
174
 
        </method>
175
 
        <method type="id">
176
 
          <sel>initWithBool:</sel>
177
 
          <arg type="BOOL">value</arg>
178
 
          <desc>
179
 
          </desc>
180
 
        </method>
181
 
        <method type="id">
182
 
          <sel>initWithChar:</sel>
183
 
          <arg type="char">value</arg>
184
 
          <desc>
185
 
          </desc>
186
 
        </method>
187
 
        <method type="id">
188
 
          <sel>initWithDouble:</sel>
189
 
          <arg type="double">value</arg>
190
 
          <desc>
191
 
          </desc>
192
 
        </method>
193
 
        <method type="id">
194
 
          <sel>initWithFloat:</sel>
195
 
          <arg type="float">value</arg>
196
 
          <desc>
197
 
          </desc>
198
 
        </method>
199
 
        <method type="id">
200
 
          <sel>initWithInt:</sel>
201
 
          <arg type="int">value</arg>
202
 
          <desc>
203
 
          </desc>
204
 
        </method>
205
 
        <method type="id">
206
 
          <sel>initWithLong:</sel>
207
 
          <arg type="long int">value</arg>
208
 
          <desc>
209
 
          </desc>
210
 
        </method>
211
 
        <method type="id">
212
 
          <sel>initWithLongLong:</sel>
213
 
          <arg type="long long int">value</arg>
214
 
          <desc>
215
 
          </desc>
216
 
        </method>
217
 
        <method type="id">
218
 
          <sel>initWithShort:</sel>
219
 
          <arg type="short int">value</arg>
220
 
          <desc>
221
 
          </desc>
222
 
        </method>
223
 
        <method type="id">
224
 
          <sel>initWithUnsignedChar:</sel>
225
 
          <arg type="unsigned char">value</arg>
226
 
          <desc>
227
 
          </desc>
228
 
        </method>
229
 
        <method type="id">
230
 
          <sel>initWithUnsignedInt:</sel>
231
 
          <arg type="unsigned int">value</arg>
232
 
          <desc>
233
 
          </desc>
234
 
        </method>
235
 
        <method type="id">
236
 
          <sel>initWithUnsignedLong:</sel>
237
 
          <arg type="unsigned long int">value</arg>
238
 
          <desc>
239
 
          </desc>
240
 
        </method>
241
 
        <method type="id">
242
 
          <sel>initWithUnsignedLongLong:</sel>
243
 
          <arg type="unsigned long long int">value</arg>
244
 
          <desc>
245
 
          </desc>
246
 
        </method>
247
 
        <method type="id">
248
 
          <sel>initWithUnsignedShort:</sel>
249
 
          <arg type="unsigned short int">value</arg>
250
 
          <desc>
251
 
          </desc>
252
 
        </method>
253
 
        <method type="int">
254
 
          <sel>intValue</sel>
255
 
          <desc>
256
 
          </desc>
257
 
        </method>
258
 
        <method type="BOOL">
259
 
          <sel>isEqualToNumber:</sel>
260
 
          <arg type="NSNumber*">aNumber</arg>
261
 
          <desc>
262
 
          </desc>
263
 
        </method>
264
 
        <method type="long long int">
265
 
          <sel>longLongValue</sel>
266
 
          <desc>
267
 
          </desc>
268
 
        </method>
269
 
        <method type="long int">
270
 
          <sel>longValue</sel>
271
 
          <desc>
272
 
          </desc>
273
 
        </method>
274
 
        <method type="short int">
275
 
          <sel>shortValue</sel>
276
 
          <desc>
277
 
          </desc>
278
 
        </method>
279
 
        <method type="NSString*">
280
 
          <sel>stringValue</sel>
281
 
          <desc>
282
 
            Expivalent to descriptionWithLocale: using a nil locale.
283
 
          </desc>
284
 
        </method>
285
 
        <method type="unsigned char">
286
 
          <sel>unsignedCharValue</sel>
287
 
          <desc>
288
 
          </desc>
289
 
        </method>
290
 
        <method type="unsigned int">
291
 
          <sel>unsignedIntValue</sel>
292
 
          <desc>
293
 
          </desc>
294
 
        </method>
295
 
        <method type="unsigned long long int">
296
 
          <sel>unsignedLongLongValue</sel>
297
 
          <desc>
298
 
          </desc>
299
 
        </method>
300
 
        <method type="unsigned long int">
301
 
          <sel>unsignedLongValue</sel>
302
 
          <desc>
303
 
          </desc>
304
 
        </method>
305
 
        <method type="unsigned short int">
306
 
          <sel>unsignedShortValue</sel>
307
 
          <desc>
308
 
          </desc>
309
 
        </method>
310
 
      </class>
311
 
    </chapter>
312
 
  </body>
313
 
</gsdoc>