/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSPointerArray.gsdoc 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 | <?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.4//EN" "http://www.gnustep.org/gsdoc-1_0_4.dtd">
<gsdoc base="NSPointerArray" up="Base">
<head>
<title>NSPointerArray class documentation</title>
<author name="Richard Frith-Macdonald">
<email address="rfm@gnu.org">
rfm@gnu.org
</email>
</author>
<copy>2009 Free Software Foundation, Inc.</copy>
</head>
<body>
<front><contents /></front>
<chapter>
<heading>
Software documentation for the NSPointerArray class
</heading>
<class name="NSPointerArray" super="NSObject" ovadd="10.5.0">
<declared>Foundation/NSPointerArray.h</declared>
<conform>NSCopying</conform>
<conform>NSCoding</conform>
<desc>
An NSPointerArray acts like a standard mutable array
except that it can contain <code>nil</code> and even
non-object values. <br /> The count can also be
set causing the array to shrink (discarding items) or
grow (adding nil/zero items).
</desc>
<method type="id" factory="yes" ovadd="10.5.0">
<sel>pointerArrayWithOptions:</sel>
<arg type="NSPointerFunctionsOptions">options</arg>
<desc>
Allocate an instance, initialise using
initWithOptions: and return it
autoreleased.
</desc>
</method>
<method type="id" factory="yes" ovadd="10.5.0">
<sel>pointerArrayWithPointerFunctions:</sel>
<arg type="NSPointerFunctions*">functions</arg>
<desc>
Allocate an instance, initialise using
initWithPointerFunctions: and
return it autoreleased.
</desc>
</method>
<method type="id" factory="yes" ovadd="10.5.0">
<sel>strongObjectsPointerArray</sel>
<desc>
Returns a new pointer array for storing strong
(retained) references to objects.
</desc>
</method>
<method type="id" factory="yes" ovadd="10.5.0">
<sel>weakObjectsPointerArray</sel>
<desc>
Returns a new pointer array for storing zeroing
weak references to objects.
</desc>
</method>
<method type="void" ovadd="10.5.0">
<sel>addPointer:</sel>
<arg type="void*">pointer</arg>
<desc>
Adds an item at the end of the array.
</desc>
</method>
<method type="void" ovadd="10.5.0">
<sel>compact</sel>
<desc>
Removes all nil/zero items from the array.
</desc>
</method>
<method type="NSUInteger" ovadd="10.5.0">
<sel>count</sel>
<desc>
Returns the number of items in the array.
</desc>
</method>
<method type="id" ovadd="10.5.0">
<sel>initWithOptions:</sel>
<arg type="NSPointerFunctionsOptions">options</arg>
<desc>
Initialises the receiver with the specified
<var>options</var>.
</desc>
</method>
<method type="id" ovadd="10.5.0">
<sel>initWithPointerFunctions:</sel>
<arg type="NSPointerFunctions*">functions</arg>
<desc>
Initialises the receiver using the supplied
object.
</desc>
</method>
<method type="void" ovadd="10.5.0">
<sel>insertPointer:</sel>
<arg type="void*">pointer</arg>
<sel>atIndex:</sel>
<arg type="NSUInteger">index</arg>
<desc>
Inserts an item at the specified <var>index</var>
causing all higher indexed items to be adjusted
upwards. <br /> WARNING... the Apple documented
(and implemented in MacOS-X 10.5) behavior is to raise
an exception if <var>index</var> is the same as the
count of items in the array. This is insane... for
arrays, data and strings you can insert at the end
of an object to append to it, so the behavior of this
class in MacOS is inconsistent and must be considered
buggy.
</desc>
</method>
<method type="void*" ovadd="10.5.0">
<sel>pointerAtIndex:</sel>
<arg type="NSUInteger">index</arg>
<desc>
Returns the item at the given <var>index</var> or
raises an exception if <var>index</var> is out of
range.
</desc>
</method>
<method type="NSPointerFunctions*" ovadd="10.5.0">
<sel>pointerFunctions</sel>
<desc>
Returns an autorelease NSPointerFunctions instance
giving the functions in use by the receiver.
</desc>
</method>
<method type="void" ovadd="10.5.0">
<sel>removePointerAtIndex:</sel>
<arg type="NSUInteger">index</arg>
<desc>
Removes the item at the specified <var>index</var>,
adjusting the positions of all higher indexed
items.
</desc>
</method>
<method type="void" ovadd="10.5.0">
<sel>replacePointerAtIndex:</sel>
<arg type="NSUInteger">index</arg>
<sel>withPointer:</sel>
<arg type="void*">item</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="void" ovadd="10.5.0">
<sel>setCount:</sel>
<arg type="NSUInteger">count</arg>
<desc>
Sets the number of items in the receiver. Adds
nil/zero items to pad the end of the array, or
removes extraneous items from the end.
</desc>
</method>
</class>
</chapter>
<chapter>
<heading>
Software documentation for the
NSPointerArray(NSArrayConveniences)
category
</heading>
<category name="NSArrayConveniences" class="NSPointerArray" ovadd="10.5.0">
<declared>Foundation/NSPointerArray.h</declared>
<desc>
<em>Description forthcoming.</em>
</desc>
<method type="id" factory="yes" ovadd="10.5.0">
<sel>pointerArrayWithStrongObjects</sel>
<desc>
Creates an instance configured to hold objects and
prevent them from being garbage collected.
</desc>
</method>
<method type="id" factory="yes" ovadd="10.5.0">
<sel>pointerArrayWithWeakObjects</sel>
<desc>
Creates an instance configured to hold objects,
allowing them to be garbage collected and replaced
by <code>nil</code> if/when they are collected.
</desc>
</method>
<method type="NSArray*" ovadd="10.5.0">
<sel>allObjects</sel>
<desc>
Returns an array containing all the non-nil objects
from the receiver.
</desc>
</method>
</category>
</chapter>
</body>
</gsdoc>
|