/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSProxy.html is in gnustep-base-doc 1.25.1-2ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>NSProxy class reference</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSProxy">NSProxy class reference</a></h1>
<h3>Authors</h3>
<dl>
<dt>Richard Frith-Macdonald (<a href="mailto:richard@brainstorm.co.uk"><code>richard@brainstorm.co.uk</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Copyright:</b> (C) 1997 Free Software Foundation, Inc.</p>
<div>
</div>
<h1><a name="001000000000">
Software documentation for the NSProxy class
</a></h1>
<h2><a name="class$NSProxy">NSProxy</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSProxy.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd><a rel="gsdoc" href="NSObject.html#protocol$(NSObject)">NSObject</a></dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
The NSProxy class provides a basic implementation of a
class whose instances are used to <em>stand in</em>
for other objects. <br /> The class provides the most
basic methods of NSObject, and expects messages for
other methods to be forwarded to the <em>real</em>
object represented by the proxy. You must subclass
NSProxy to implement
<a rel="gsdoc" href="#method$NSProxy-forwardInvocation$">
-forwardInvocation:
</a>
to these <em>real</em> objects.
</p>
<p>
</p>
<p>
Note that <code>NSProxy</code> is a different sort of
class than others in the GNUstep Base library in that
it is the only example of a root class besides
<a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a>
. Thus, it implements the <code>NSObject</code>
protocol but is not a subclass of NSObject.
</p>
<p>
</div>
<hr width="50%" align="left" />
<a href="#_NSProxy_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+alloc">+alloc</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+allocWithZone$">+allocWithZone:</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+autorelease">+autorelease</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+class">+class</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+description">+description</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+isKindOfClass$">+isKindOfClass:</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+isMemberOfClass$">+isMemberOfClass:</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+load">+load</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+release">+release</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+respondsToSelector$">+respondsToSelector:</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+retain">+retain</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy+retainCount">+retainCount</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-autorelease">-autorelease</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-class">-class</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-conformsToProtocol$">-conformsToProtocol:</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-dealloc">-dealloc</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-description">-description</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-forwardInvocation$">-forwardInvocation:</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-hash">-hash</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-init">-init</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-isEqual$">-isEqual:</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-isKindOfClass$">-isKindOfClass:</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-isMemberOfClass$">-isMemberOfClass:</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-isProxy">-isProxy</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-methodSignatureForSelector$">-methodSignatureForSelector:</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-release">-release</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-respondsToSelector$">-respondsToSelector:</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-retain">-retain</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-retainCount">-retainCount</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-self">-self</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-superclass">-superclass</a></li>
<li><a rel="gsdoc" href="NSProxy.html#method$NSProxy-zone">-zone</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSProxy+alloc">alloc </a></h3>
+ (id) <b>alloc</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Allocates and returns an NSProxy instance in the
default zone.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy+allocWithZone$">allocWithZone: </a></h3>
+ (id) <b>allocWithZone:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSZone">NSZone</a>*)z;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Allocates and returns an NSProxy instance in the
specified zone <var>z</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy+autorelease">autorelease </a></h3>
+ (id) <b>autorelease</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy+class">class </a></h3>
+ (Class) <b>class</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy+description">description </a></h3>
+ (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>description</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns a string describing the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy+isKindOfClass$">isKindOfClass: </a></h3>
+ (BOOL) <b>isKindOfClass:</b> (Class)aClass;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns <code>NO</code>... the NSProxy class cannot
be an instance of any class.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy+isMemberOfClass$">isMemberOfClass: </a></h3>
+ (BOOL) <b>isMemberOfClass:</b> (Class)aClass;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns <code>YES</code> if <var>aClass</var> is
identical to the receiver, <code>NO</code>
otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy+load">load </a></h3>
+ (void) <b>load</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> A dummy method...
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy+release">release </a></h3>
+ (oneway void) <b>release</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> A dummy method to ensure that the class can
safely be held in containers.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy+respondsToSelector$">respondsToSelector: </a></h3>
+ (BOOL) <b>respondsToSelector:</b> (SEL)aSelector;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns <code>YES</code> if the receiver responds
to <var>aSelector</var>, <code>NO</code> otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy+retain">retain </a></h3>
+ (id) <b>retain</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy+retainCount">retainCount </a></h3>
+ (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>retainCount</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the maximum <strong>unsigned</strong>
integer value.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-autorelease">autorelease </a></h3>
- (id) <b>autorelease</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Adds the receiver to the current autorelease pool and
returns self.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-class">class </a></h3>
- (Class) <b>class</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the class of the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-conformsToProtocol$">conformsToProtocol: </a></h3>
- (BOOL) <b>conformsToProtocol:</b> (Protocol*)aProtocol;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Calls the
<a rel="gsdoc" href="#method$NSProxy-forwardInvocation$">
-forwardInvocation:
</a>
method to determine if the 'real' object referred to
by the proxy conforms to <var>aProtocol</var>. Returns
the result. <br /> NB. The default operation of
<a rel="gsdoc" href="#method$NSProxy-forwardInvocation$">
-forwardInvocation:
</a>
is to raise an exception.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-dealloc">dealloc </a></h3>
- (void) <b>dealloc</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Frees the memory used by the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-description">description </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>description</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns a text description of the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-forwardInvocation$">forwardInvocation: </a></h3>
- (void) <b>forwardInvocation:</b> (<a rel="gsdoc" href="NSInvocation.html#class$NSInvocation">NSInvocation</a>*)anInvocation;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Raises an <code>NSInvalidArgumentException</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-hash">hash </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>hash</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the address of the receiver... so it can be
stored in a dictionary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-init">init </a></h3>
- (id) <b>init</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
This is a designated initialiser for the class.<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Initialises the receiver and returns the
resulting instance.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-isEqual$">isEqual: </a></h3>
- (BOOL) <b>isEqual:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Tests for pointer equality with <var>anObject</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-isKindOfClass$">isKindOfClass: </a></h3>
- (BOOL) <b>isKindOfClass:</b> (Class)aClass;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Calls the
<a rel="gsdoc" href="#method$NSProxy-forwardInvocation$">
-forwardInvocation:
</a>
method to determine if the 'real' object referred to
by the proxy is an instance of the specified class.
Returns the result. <br /> NB. The default
operation of
<a rel="gsdoc" href="#method$NSProxy-forwardInvocation$">
-forwardInvocation:
</a>
is to raise an exception.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-isMemberOfClass$">isMemberOfClass: </a></h3>
- (BOOL) <b>isMemberOfClass:</b> (Class)aClass;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Calls the
<a rel="gsdoc" href="#method$NSProxy-forwardInvocation$">
-forwardInvocation:
</a>
method to determine if the 'real' object referred to
by the proxy is an instance of the specified class.
Returns the result. <br /> NB. The default
operation of
<a rel="gsdoc" href="#method$NSProxy-forwardInvocation$">
-forwardInvocation:
</a>
is to raise an exception.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-isProxy">isProxy </a></h3>
- (BOOL) <b>isProxy</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns <code>YES</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-methodSignatureForSelector$">methodSignatureForSelector: </a></h3>
- (<a rel="gsdoc" href="NSMethodSignature.html#class$NSMethodSignature">NSMethodSignature</a>*) <b>methodSignatureForSelector:</b> (SEL)aSelector;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
If we respond to the method directly, create and return
a method signature. Otherwise raise an exception.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-release">release </a></h3>
- (oneway void) <b>release</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Decrement the retain count for the receiver...
deallocate if it would become negative.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-respondsToSelector$">respondsToSelector: </a></h3>
- (BOOL) <b>respondsToSelector:</b> (SEL)aSelector;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
If we respond to the method directly, return
<code>YES</code>, otherwise forward this request to
the object we are acting as a proxy for.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-retain">retain </a></h3>
- (id) <b>retain</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Increment the retain count for the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-retainCount">retainCount </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>retainCount</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Return the retain count for the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-self">self </a></h3>
- (id) <b>self</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-superclass">superclass </a></h3>
- (Class) <b>superclass</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the superclass of the receiver's class.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProxy-zone">zone </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSZone">NSZone</a>*) <b>zone</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the zone in which the receiver was
allocated.
</div>
<hr width="25%" align="left" />
</div>
<a name="_NSProxy_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for NSProxy Class</h2>
<h3><a name="ivariable$NSProxy*isa">isa</a></h3>
@public Class <b>isa</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
|