/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSXMLNode.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 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 | <?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="NSXMLNode" up="Base">
<head>
<title>NSXMLNode class documentation</title>
<author name="Generated by Debian"></author>
</head>
<body>
<front><contents /></front>
<chapter>
<heading>
Software documentation for the NSXMLNode class
</heading>
<class name="NSXMLNode" super="NSObject" ovadd="1.0.0">
<declared>Foundation/NSXMLNode.h</declared>
<conform>NSCopying</conform>
<desc>
The most primitive unit in an XML document.
</desc>
<ivariable type="GSInternal*" name="_internal" validity="public" ovadd="1.0.0">
<desc>
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</desc>
</ivariable>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>DTDNodeWithXMLString:</sel>
<arg type="NSString*">string</arg>
<desc>
Creates and returns a DTD node from the supplied
<var>string</var>. The node might describe element,
attribute, entity, or notation.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>attributeWithName:</sel>
<arg type="NSString*">name</arg>
<sel>URI:</sel>
<arg type="NSString*">URI</arg>
<sel>stringValue:</sel>
<arg type="NSString*">stringValue</arg>
<desc>
Creates and returns an attribute node with the
specified (fully qualified) <var>name</var>,
namespace <var>URI</var>, and value.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>attributeWithName:</sel>
<arg type="NSString*">name</arg>
<sel>stringValue:</sel>
<arg type="NSString*">stringValue</arg>
<desc>
Creates and returns an attribute node with the
specified <var>name</var> and value.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>commentWithStringValue:</sel>
<arg type="NSString*">stringValue</arg>
<desc>
Creates and returns a comment node with the
supplied text.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>document</sel>
<desc>
Creates and returns an empty document...
convenience method.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>documentWithRootElement:</sel>
<arg type="NSXMLElement*">element</arg>
<desc>
Creates and returns a new document intialised with
the supplied root node.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>elementWithName:</sel>
<arg type="NSString*">name</arg>
<desc>
Creates and returns a node node with the specified
<var>name</var>.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>elementWithName:</sel>
<arg type="NSString*">name</arg>
<sel>URI:</sel>
<arg type="NSString*">URI</arg>
<desc>
Creates and returns a node with the supplied (fully
qualified <var>name</var>) an namespace
<var>URI</var>.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>elementWithName:</sel>
<arg type="NSString*">name</arg>
<sel>children:</sel>
<arg type="NSArray*">children</arg>
<sel>attributes:</sel>
<arg type="NSArray*">attributes</arg>
<desc>
Creates and returns a node containing the supplied
child nodes and with the attribute nodes from the
supplied array.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>elementWithName:</sel>
<arg type="NSString*">name</arg>
<sel>stringValue:</sel>
<arg type="NSString*">string</arg>
<desc>
Creates and returns a node with the pecified
<var>name</var> and with a single text node
(containing <var>string</var>) as its content.
</desc>
</method>
<method type="NSString*" factory="yes" ovadd="1.0.0">
<sel>localNameForName:</sel>
<arg type="NSString*">name</arg>
<desc>
Strips any leading namespace prefix from
<var>name</var> and returns the result.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>namespaceWithName:</sel>
<arg type="NSString*">name</arg>
<sel>stringValue:</sel>
<arg type="NSString*">stringValue</arg>
<desc>
Creates and returns a node mapping the supplkied
namespace <var>name</var> to the string value
(URI).
</desc>
</method>
<method type="NSXMLNode*" factory="yes" ovadd="1.0.0">
<sel>predefinedNamespaceForPrefix:</sel>
<arg type="NSString*">name</arg>
<desc>
Returns the namespace node corresponding to a
predefined namespace names (one of xml, xs, or
xsi)
</desc>
</method>
<method type="NSString*" factory="yes" ovadd="1.0.0">
<sel>prefixForName:</sel>
<arg type="NSString*">name</arg>
<desc>
Returns the namespace prefix of <var>name</var>.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>processingInstructionWithName:</sel>
<arg type="NSString*">name</arg>
<sel>stringValue:</sel>
<arg type="NSString*">stringValue</arg>
<desc>
Creates and return a processinc insruction node
with th specified <var>name</var> and textual value.
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>textWithStringValue:</sel>
<arg type="NSString*">stringValue</arg>
<desc>
Creates and returns a simple text node.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>URI</sel>
<desc>
Returns the URI of the receiver.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>XMLString</sel>
<desc>
Returns the text of the receiver as XML (ie in the
form it would have in an XML document).
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>XMLStringWithOptions:</sel>
<arg type="NSUInteger">theOptions</arg>
<desc>
Returns the text of the receiver as XML (ie in the
form it would have in an XML document), with the
specified options controlling it.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>XPath</sel>
<desc>
Returns the XPath string to access the receiver
with the document.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>canonicalXMLStringPreservingComments:</sel>
<arg type="BOOL">comments</arg>
<desc>
Returns the canonical form (see
http://www.w3.org/TR/xml-c14n)
of the receiveri as <strong>long</strong> as the
NSXMLNodePreserveWhitespace has
been set. If the option as not been set, return the
same without white space preserved.
</desc>
</method>
<method type="NSXMLNode*" ovadd="1.0.0">
<sel>childAtIndex:</sel>
<arg type="NSUInteger">index</arg>
<desc>
Returns the child node if the receiver at the
specified <var>index</var>.
</desc>
</method>
<method type="NSUInteger" ovadd="1.0.0">
<sel>childCount</sel>
<desc>
Returns the number of immediate child nodes of the
receiver. <br /> This method is more efficient
than getting the array of children and counting it.
</desc>
</method>
<method type="NSArray*" ovadd="1.0.0">
<sel>children</sel>
<desc>
Returns n array containing the immediate child
nodes of the receiver.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>detach</sel>
<desc>
Detaches the receiver from its parent node.
</desc>
</method>
<method type="NSUInteger" ovadd="1.0.0">
<sel>index</sel>
<desc>
Return the index of the receiver within its parent
node.
</desc>
</method>
<method type="id" ovadd="1.0.0">
<sel>initWithKind:</sel>
<arg type="NSXMLNodeKind">theKind</arg>
<desc>
Initialises the receiver as a specific kind of
node. <br /> Calls
<ref type="method" id="-initWithKind:options:">
-initWithKind:options:
</ref>
using NSXMLNodeOptionsNone and returns the result.
</desc>
</method>
<method type="id" init="yes" ovadd="1.0.0">
<sel>initWithKind:</sel>
<arg type="NSXMLNodeKind">theKind</arg>
<sel>options:</sel>
<arg type="NSUInteger">theOptions</arg>
<desc>
Initialises the receiver as the specified kind
of node and with the specified options.
</desc>
</method>
<method type="NSXMLNodeKind" ovadd="1.0.0">
<sel>kind</sel>
<desc>
Returns the kind of node represented by the
receiver.
</desc>
</method>
<method type="NSUInteger" ovadd="1.0.0">
<sel>level</sel>
<desc>
Return the level of the receiver within the tree of
nodes. <br /> A document or a node which is not
inside another is at level 0.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>localName</sel>
<desc>
Returns the name of the receiver without any
namespace prefix.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>name</sel>
<desc>
Returns the name of the receiver.
</desc>
</method>
<method type="NSXMLNode*" ovadd="1.0.0">
<sel>nextNode</sel>
<desc>
Returns the next node in the tree.
</desc>
</method>
<method type="NSXMLNode*" ovadd="1.0.0">
<sel>nextSibling</sel>
<desc>
Returns the next sibling of the receiver
</desc>
</method>
<method type="NSArray*" ovadd="1.0.0">
<sel>nodesForXPath:</sel>
<arg type="NSString*">anxpath</arg>
<sel>error:</sel>
<arg type="NSError**">error</arg>
<desc>
Returns the nodes resulting from applying xpath to
the receiver. <br /> Before using xpath on a tree, you
must call the
<ref type="method" id="-normalizeAdjacentTextNodesPreservingCDATA:">-normalizeAdjacentTextNodesPreservingCDATA:</ref> with <code>NO</code> as the argument, in order to avoid problems where the xpath syntax cannot cope with multiple text nodes.
</desc>
</method>
<method type="id" ovadd="1.0.0">
<sel>objectValue</sel>
<desc>
Returns the object value of the receiver (as set
using -setObjectValue:) or <code>nil</code> if there
is none.
</desc>
</method>
<method type="NSArray*" ovadd="1.0.0">
<sel>objectsForXQuery:</sel>
<arg type="NSString*">xquery</arg>
<sel>constants:</sel>
<arg type="NSDictionary*">constants</arg>
<sel>error:</sel>
<arg type="NSError**">error</arg>
<desc>
Returns the data resulting from calling the query
on the receiver. <br /> Before using xpath on a tree,
you must call the
<ref type="method" id="-normalizeAdjacentTextNodesPreservingCDATA:">-normalizeAdjacentTextNodesPreservingCDATA:</ref> with <code>NO</code> as the argument, in order to avoid problems where the xpath syntax cannot cope with multiple text nodes. <br /> The value of <var>constants</var> is a dictionary of <var>constants</var> declared to be "external" in the query. <br /> The resulting array amy contain array, data, date, number, string, and URL objects as well as nodes.
</desc>
</method>
<method type="NSArray*" ovadd="1.0.0">
<sel>objectsForXQuery:</sel>
<arg type="NSString*">xquery</arg>
<sel>error:</sel>
<arg type="NSError**">error</arg>
<desc>
Returns the data resulting from calling the query
on the receiver. <br /> The same as
objectsForXQuery:constants:error:
without the constants.
</desc>
</method>
<method type="NSXMLNode*" ovadd="1.0.0">
<sel>parent</sel>
<desc>
Returns the parent node of the receiver or
<code>nil</code> if the receiver is not within
another node.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>prefix</sel>
<desc>
Returns the namepsace prefix for the receiver or
<code>nil</code> if there is no namespace prefix.
</desc>
</method>
<method type="NSXMLNode*" ovadd="1.0.0">
<sel>previousNode</sel>
<desc>
Returns the previous node in the tree... stepping
through the tree backwards.
</desc>
</method>
<method type="NSXMLNode*" ovadd="1.0.0">
<sel>previousSibling</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="NSXMLDocument*" ovadd="1.0.0">
<sel>rootDocument</sel>
<desc>
Returns the document containing the receiver, or
<code>nil</code> if the receiver does not lie within
a document.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setName:</sel>
<arg type="NSString*">name</arg>
<desc>
Sets the <var>name</var> of the receiver.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setObjectValue:</sel>
<arg type="id">value</arg>
<desc>
Sets the content of the receiver, removing any
existing children (including comments and
processing instructions). <br /> For an element
node, this sets text contetn within the node.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setStringValue:</sel>
<arg type="NSString*">string</arg>
<desc>
Sets the content of the receiver to be the supplied
<var>string</var> value... which involves removing
existing content, comments, and processing
instructions. <br /> If the receiver is an
element node, this creates a text node containing
the <var>string</var> value as the sole child of the
receiver.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setStringValue:</sel>
<arg type="NSString*">string</arg>
<sel>resolvingEntities:</sel>
<arg type="BOOL">resolve</arg>
<desc>
Sets the <var>string</var> content of the receiver.
<br /> if the <var>resolve</var> flag is
<code>YES</code> then any entities which can be
resolved are replaced by the resolved versions.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setURI:</sel>
<arg type="NSString*">URI</arg>
<desc>
Sets the <var>URI</var> of the receiver.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>stringValue</sel>
<desc>
Returns the string value of the receiver. For kinds
of node which have direct string content, this simply
returns that content. For elements this recursively
traverses the children of the receiver appending
the text of each child to a single string result.
</desc>
</method>
</class>
</chapter>
</body>
</gsdoc>
|