Source

cappuccino-docs / cappuccino docs / cappuccino.org / learn / documentation / group__foundation.html

Full commit
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<!-- Mirrored from cappuccino.org/learn/documentation/group__foundation.html by HTTrack Website Copier/3.x [XR&CO'2006], Mon, 20 Sep 2010 02:19:59 GMT -->
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Cappuccino API: Foundation</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Foundation</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_array.html">CPArray</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A mutable array backed by a JavaScript Array.A mutable array class backed by a JavaScript Array. There is also a <a class="el" href="class_c_p_mutable_array.html">CPMutableArray</a> class, but it is just a child class of this class with an empty implementation. All mutable functionality is implemented directly in <a class="el" href="class_c_p_array.html" title="A mutable array backed by a JavaScript Array.A mutable array class backed by a JavaScript...">CPArray</a>.  <a href="class_c_p_array.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_attributed_string.html">CPAttributedString</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A mutable character string with attributes.  <a href="class_c_p_attributed_string.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_bundle.html">CPBundle</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Groups information about an application's code &amp; resources.  <a href="class_c_p_bundle.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_coder.html">CPCoder</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defines methods for use when archiving &amp; restoring (enc/decoding).  <a href="class_c_p_coder.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_counted_set.html">CPCountedSet</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An mutable collection which may contain a specific object numerous times.  <a href="class_c_p_counted_set.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_data.html">CPData</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A Cappuccino wrapper for any data type.  <a href="class_c_p_data.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_date.html">CPDate</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A representation of a single point in time.  <a href="class_c_p_date.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_dictionary.html">CPDictionary</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A mutable key-value pair collection.  <a href="class_c_p_dictionary.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_enumerator.html">CPEnumerator</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defines an interface for enumerators.  <a href="class_c_p_enumerator.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_exception.html">CPException</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to implement exception handling (creating &amp; raising).  <a href="class_c_p_exception.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_index_set.html">CPIndexSet</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A collection of unique integers.  <a href="class_c_p_index_set.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_invocation.html">CPInvocation</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An object representation of a message.  <a href="class_c_p_invocation.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_j_s_o_n_p_connection.html">CPJSONPConnection</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allows cross domain connections using JSONP protocol.  <a href="class_c_p_j_s_o_n_p_connection.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_keyed_archiver.html">CPKeyedArchiver</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implements keyed archiving of object graphs (e.g. for storing data).  <a href="class_c_p_keyed_archiver.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_keyed_unarchiver.html">CPKeyedUnarchiver</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unarchives objects created using <a class="el" href="class_c_p_keyed_archiver.html" title="Implements keyed archiving of object graphs (e.g. for storing data).">CPKeyedArchiver</a>.  <a href="class_c_p_keyed_unarchiver.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_notification.html">CPNotification</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A notification that can be posted to a <a class="el" href="class_c_p_notification_center.html" title="Sends messages (CPNotification) between objects.">CPNotificationCenter</a>.  <a href="class_c_p_notification.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_notification_center.html">CPNotificationCenter</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends messages (<a class="el" href="class_c_p_notification.html" title="A notification that can be posted to a CPNotificationCenter.">CPNotification</a>) between objects.  <a href="class_c_p_notification_center.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_null.html">CPNull</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An object representation of <code>nil</code>.  <a href="class_c_p_null.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_number.html">CPNumber</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A bridged object to native Javascript numbers.  <a href="class_c_p_number.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_object.html">CPObject</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The root class from which most classes are subclassed.  <a href="class_c_p_object.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_run_loop.html">CPRunLoop</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The main run loop for the application.  <a href="class_c_p_run_loop.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_set.html">CPSet</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An unordered collection of objects.  <a href="class_c_p_set.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_sort_descriptor.html">CPSortDescriptor</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds attributes necessary to describe how to sort a set of objects.  <a href="class_c_p_sort_descriptor.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_string.html">CPString</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An immutable string (collection of characters).  <a href="class_c_p_string.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_timer.html">CPTimer</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A timer object that can send a message after the given time interval.  <a href="class_c_p_timer.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_undo_manager.html">CPUndoManager</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A general mechanism for user action "undo".  <a href="class_c_p_undo_manager.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_u_r_l_connection.html">CPURLConnection</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides loading of a URL request.  <a href="class_c_p_u_r_l_connection.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_u_r_l_request.html">CPURLRequest</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Contains data obtained during a request made with <a class="el" href="class_c_p_u_r_l_connection.html" title="Provides loading of a URL request.">CPURLConnection</a>.  <a href="class_c_p_u_r_l_request.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_u_r_l_response.html">CPURLResponse</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protocol agnostic information about a request to a specifc URL.  <a href="class_c_p_u_r_l_response.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_p_value.html">CPValue</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A generic "value". Can be subclassed to hold specific data types.  <a href="class_c_p_value.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gae4d4352191524cc80edd4fb130b1495b">CPCopyRange</a> (aRange)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#ga7d819d9828769a45663309ccf26fa3d3">CPEmptyRange</a> (aRange)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#ga50f0abfcf83a9786a16a800bdd6e7241">CPEqualRanges</a> (lhsRange, rhsRange)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#ga75c00938ebca2b401aacd063802fdde4">CPIntersectionRange</a> (lhsRange, rhsRange)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#ga11d8b85f5a9d54a56c269d269745c671">CPLocationInRange</a> (aLocation, aRange)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#ga377fec0972facd19d72b8abcffcdb362">CPMakeRange</a> (location, length)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#ga757a5d0fb8e3fe1c64330c82e1fa7292">CPMakeRangeCopy</a> (aRange)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#ga9a9c6e53b2b0861cedbb77b5ab72e78f">CPMaxRange</a> (aRange)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#ga3ea8d8570e114b5293740ad51bf43457">CPRangeFromString</a> (aString)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#ga27da7cc6d5e82effc742767a75efbe87">CPRangeInRange</a> (lhsRange, rhsRange)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gafaa648e94284213e15f9a4b1ae1b7e0e">CPStringFromRange</a> (aRange)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gabba35730ec5375f5e23a78da6322f4c9">CPUnionRange</a> (lhsRange, rhsRange)</td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gae4d4352191524cc80edd4fb130b1495b"></a><!-- doxytag: member="CPRange.j::CPCopyRange" ref="gae4d4352191524cc80edd4fb130b1495b" args="(aRange)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPCopyRange </td>
          <td>(</td>
          <td class="paramtype">aRange&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Makes a copy of a CPRange. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aRange</em>&nbsp;</td><td>the CPRange to copy  CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CPRange the copy of the range </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00046">46</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
<a class="anchor" id="ga7d819d9828769a45663309ccf26fa3d3"></a><!-- doxytag: member="CPRange.j::CPEmptyRange" ref="ga7d819d9828769a45663309ccf26fa3d3" args="(aRange)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPEmptyRange </td>
          <td>(</td>
          <td class="paramtype">aRange&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Determines if a range is empty <code>length</code> is 0. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aRange</em>&nbsp;</td><td>the range to test  CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>YES if the range is empty </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00068">68</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
<a class="anchor" id="ga50f0abfcf83a9786a16a800bdd6e7241"></a><!-- doxytag: member="CPRange.j::CPEqualRanges" ref="ga50f0abfcf83a9786a16a800bdd6e7241" args="(lhsRange, rhsRange)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPEqualRanges </td>
          <td>(</td>
          <td class="paramtype">lhsRange&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">rhsRange&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Determines if two CPRanges are equal. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>lhsRange</em>&nbsp;</td><td>the first CPRange </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>rhsRange</em>&nbsp;</td><td>the second CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>BOOL <code>YES</code> if the two CPRanges are equal. </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00090">90</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
<a class="anchor" id="ga75c00938ebca2b401aacd063802fdde4"></a><!-- doxytag: member="CPRange.j::CPIntersectionRange" ref="ga75c00938ebca2b401aacd063802fdde4" args="(lhsRange, rhsRange)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPIntersectionRange </td>
          <td>(</td>
          <td class="paramtype">lhsRange&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">rhsRange&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a new CPRange that spans the common range of two CPRanges </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>lhsRange</em>&nbsp;</td><td>the first CPRange </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>rhsRange</em>&nbsp;</td><td>the second CPRange  CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CPRange the new CPRange </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00128">128</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
<a class="anchor" id="ga11d8b85f5a9d54a56c269d269745c671"></a><!-- doxytag: member="CPRange.j::CPLocationInRange" ref="ga11d8b85f5a9d54a56c269d269745c671" args="(aLocation, aRange)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPLocationInRange </td>
          <td>(</td>
          <td class="paramtype">aLocation&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">aRange&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Determines if a number is within a specified CPRange. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aLocation</em>&nbsp;</td><td>the number to check </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aRange</em>&nbsp;</td><td>the CPRange to check within  CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>BOOL <code>YES</code> if <code>aLocation</code> is within the range </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00102">102</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
<a class="anchor" id="ga377fec0972facd19d72b8abcffcdb362"></a><!-- doxytag: member="CPRange.j::CPMakeRange" ref="ga377fec0972facd19d72b8abcffcdb362" args="(location, length)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPMakeRange </td>
          <td>(</td>
          <td class="paramtype">location&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">length&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Makes a CPRange. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>location</em>&nbsp;</td><td>the location for new range </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the new range  CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CPRange the new range object </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00035">35</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
<a class="anchor" id="ga757a5d0fb8e3fe1c64330c82e1fa7292"></a><!-- doxytag: member="CPRange.j::CPMakeRangeCopy" ref="ga757a5d0fb8e3fe1c64330c82e1fa7292" args="(aRange)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPMakeRangeCopy </td>
          <td>(</td>
          <td class="paramtype">aRange&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Makes a copy of a CPRange. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aRange</em>&nbsp;</td><td>the CPRange to copy  CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CPRange the copy of the range </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00057">57</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
<a class="anchor" id="ga9a9c6e53b2b0861cedbb77b5ab72e78f"></a><!-- doxytag: member="CPRange.j::CPMaxRange" ref="ga9a9c6e53b2b0861cedbb77b5ab72e78f" args="(aRange)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPMaxRange </td>
          <td>(</td>
          <td class="paramtype">aRange&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Finds the range maximum. (<code>location</code> + length) </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aRange</em>&nbsp;</td><td>the range to calculate a maximum from  CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>int the range maximum </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00079">79</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
<a class="anchor" id="ga3ea8d8570e114b5293740ad51bf43457"></a><!-- doxytag: member="CPRange.j::CPRangeFromString" ref="ga3ea8d8570e114b5293740ad51bf43457" args="(aString)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPRangeFromString </td>
          <td>(</td>
          <td class="paramtype">aString&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a CPRange from the contents of a <a class="el" href="class_c_p_string.html" title="An immutable string (collection of characters).">CPString</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aString</em>&nbsp;</td><td>the string to create a CPRange from  CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CPRange the new range </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00166">166</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
<a class="anchor" id="ga27da7cc6d5e82effc742767a75efbe87"></a><!-- doxytag: member="CPRange.j::CPRangeInRange" ref="ga27da7cc6d5e82effc742767a75efbe87" args="(lhsRange, rhsRange)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPRangeInRange </td>
          <td>(</td>
          <td class="paramtype">lhsRange&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">rhsRange&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Checks if a range completely contains another range. In other words, if one range is the "super range" of another. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>lhsRange</em>&nbsp;</td><td>the containing range </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>rhsRange</em>&nbsp;</td><td>the range we are testing to see if lhsRange contains it  CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>BOOL whether or not lhsRange completely contains rhsRange </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00144">144</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
<a class="anchor" id="gafaa648e94284213e15f9a4b1ae1b7e0e"></a><!-- doxytag: member="CPRange.j::CPStringFromRange" ref="gafaa648e94284213e15f9a4b1ae1b7e0e" args="(aRange)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPStringFromRange </td>
          <td>(</td>
          <td class="paramtype">aRange&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns a string describing a range. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aRange</em>&nbsp;</td><td>the range to describe  CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="class_c_p_string.html" title="An immutable string (collection of characters).">CPString</a> a describing string </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00155">155</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
<a class="anchor" id="gabba35730ec5375f5e23a78da6322f4c9"></a><!-- doxytag: member="CPRange.j::CPUnionRange" ref="gabba35730ec5375f5e23a78da6322f4c9" args="(lhsRange, rhsRange)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CPUnionRange </td>
          <td>(</td>
          <td class="paramtype">lhsRange&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">rhsRange&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a new range with the minimum <code>location</code> and a <code>length</code> that extends to the maximum <code>length</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>lhsRange</em>&nbsp;</td><td>the first CPRange </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>rhsRange</em>&nbsp;</td><td>the second CPRange  CPRange </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CPRange the new CPRange </dd></dl>

<p>Definition at line <a class="el" href="_c_p_range_8j_source.html#l00115">115</a> of file <a class="el" href="_c_p_range_8j_source.html">CPRange.j</a>.</p>

</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Apr 6 10:33:04 2010 for Cappuccino API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

<!-- Mirrored from cappuccino.org/learn/documentation/group__foundation.html by HTTrack Website Copier/3.x [XR&CO'2006], Mon, 20 Sep 2010 02:19:59 GMT -->
</html>