/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSXMLDocument.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 | <?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="NSXMLDocument" up="Base">
<head>
<title>NSXMLDocument class documentation</title>
<author name="Generated by Debian"></author>
</head>
<body>
<front><contents /></front>
<chapter>
<heading>
Software documentation for the NSXMLDocument class
</heading>
<class name="NSXMLDocument" super="NSXMLNode" ovadd="1.0.0">
<declared>Foundation/NSXMLDocument.h</declared>
<desc>
An XMLDocument encapsulates an entire document. This must
contain a single element node.
</desc>
<method type="Class" factory="yes" ovadd="1.0.0">
<sel>replacementClassForClass:</sel>
<arg type="Class">cls</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="NSXMLDTD*" ovadd="1.0.0">
<sel>DTD</sel>
<desc>
Returns the DTD set for the receiver.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>MIMEType</sel>
<desc>
Returns the document MIME type..
</desc>
</method>
<method type="NSData*" ovadd="1.0.0">
<sel>XMLData</sel>
<desc>
Outputs XML data using
<ref type="method" id="-XMLDataWithOptions:">
-XMLDataWithOptions:
</ref>
with NSXMLNodeOptionsNone.
</desc>
</method>
<method type="NSData*" ovadd="1.0.0">
<sel>XMLDataWithOptions:</sel>
<arg type="NSUInteger">theOptions</arg>
<desc>
Outputs the reciever encoded using the specified
options.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>addChild:</sel>
<arg type="NSXMLNode*">child</arg>
<desc>
Adds <var>child</var> after existing children.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>characterEncoding</sel>
<desc>
Returns the IANA character encoding, or
<code>nil</code> if none is set.
</desc>
</method>
<method type="NSXMLDocumentContentKind" ovadd="1.0.0">
<sel>documentContentKind</sel>
<desc>
Returns the kind of document.
</desc>
</method>
<method type="id" ovadd="1.0.0">
<sel>initWithContentsOfURL:</sel>
<arg type="NSURL*">url</arg>
<sel>options:</sel>
<arg type="NSUInteger">mask</arg>
<sel>error:</sel>
<arg type="NSError**">error</arg>
<desc>
Initialise using the data downloaded from the
spplied <var>url</var>.
</desc>
</method>
<method type="id" init="yes" ovadd="1.0.0">
<sel>initWithData:</sel>
<arg type="NSData*">data</arg>
<sel>options:</sel>
<arg type="NSUInteger">mask</arg>
<sel>error:</sel>
<arg type="NSError**">error</arg>
<desc>
Returns a document created from <var>data</var>.
<br /> Parse errors are returned in <var>error</var>
.
</desc>
</method>
<method type="id" ovadd="1.0.0">
<sel>initWithRootElement:</sel>
<arg type="NSXMLElement*">element</arg>
<desc>
Returns a document with a single child, the root
<var>element</var>.
</desc>
</method>
<method type="id" ovadd="1.0.0">
<sel>initWithXMLString:</sel>
<arg type="NSString*">string</arg>
<sel>options:</sel>
<arg type="NSUInteger">mask</arg>
<sel>error:</sel>
<arg type="NSError**">error</arg>
<desc>
Initialises the receiver by creating a document
from XML (or HTML if the HTMLTidy option is set).
Parse errors are returned in the <var>error</var>
argument.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>insertChild:</sel>
<arg type="NSXMLNode*">child</arg>
<sel>atIndex:</sel>
<arg type="NSUInteger">index</arg>
<desc>
Inserts <var>child</var> at <var>index</var>.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>insertChildren:</sel>
<arg type="NSArray*">children</arg>
<sel>atIndex:</sel>
<arg type="NSUInteger">index</arg>
<desc>
Inserts a number of <var>children</var> at the
<var>index</var>.
</desc>
</method>
<method type="BOOL" ovadd="1.0.0">
<sel>isStandalone</sel>
<desc>
Returns <code>NO</code> if the receiver depends
upon an external DTD, otherwise returns
<code>YES</code>.
</desc>
</method>
<method type="id" ovadd="1.0.0">
<sel>objectByApplyingXSLT:</sel>
<arg type="NSData*">xslt</arg>
<sel>arguments:</sel>
<arg type="NSDictionary*">arguments</arg>
<sel>error:</sel>
<arg type="NSError**">error</arg>
<desc>
Returns a new document created by applying
<var>xslt</var> (with a set of key/value pairs) to
the receiver.
</desc>
</method>
<method type="id" ovadd="1.0.0">
<sel>objectByApplyingXSLTAtURL:</sel>
<arg type="NSURL*">xsltURL</arg>
<sel>arguments:</sel>
<arg type="NSDictionary*">arguments</arg>
<sel>error:</sel>
<arg type="NSError**">error</arg>
<desc>
Downloads XSLT from <var>xsltURL</var>, and then
returns a new document created by applying it (with
a set of key/value pairs) to the receiver.
</desc>
</method>
<method type="id" ovadd="1.0.0">
<sel>objectByApplyingXSLTString:</sel>
<arg type="NSString*">xslt</arg>
<sel>arguments:</sel>
<arg type="NSDictionary*">arguments</arg>
<sel>error:</sel>
<arg type="NSError**">error</arg>
<desc>
Returns a new document created by applying
<var>xslt</var> (with a set of key/value pairs) to
the receiver.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>removeChildAtIndex:</sel>
<arg type="NSUInteger">index</arg>
<desc>
Removes the child at the <var>index</var>.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>replaceChildAtIndex:</sel>
<arg type="NSUInteger">index</arg>
<sel>withNode:</sel>
<arg type="NSXMLNode*">theNode</arg>
<desc>
Replacs the child at the specified <var>index</var>
.
</desc>
</method>
<method type="NSXMLElement*" ovadd="1.0.0">
<sel>rootElement</sel>
<desc>
Returns the root object of the receiver.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setCharacterEncoding:</sel>
<arg type="NSString*">encoding</arg>
<desc>
Sets the character <var>encoding</var> to an IANA
characterset type.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setChildren:</sel>
<arg type="NSArray*">children</arg>
<desc>
Replaces all existing child nodes with the ones in
the array.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setDTD:</sel>
<arg type="NSXMLDTD*">documentTypeDeclaration</arg>
<desc>
Sets the DTD of the receiver. If this is set then the
DTD will be output when the document is.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setDocumentContentKind:</sel>
<arg type="NSXMLDocumentContentKind">theContentKind</arg>
<desc>
Sets the kind of document.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setMIMEType:</sel>
<arg type="NSString*">theMIMEType</arg>
<desc>
Sets the document MIME type (usually text/xml).
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setRootElement:</sel>
<arg type="NSXMLNode*">root</arg>
<desc>
Sets the <var>root</var> object of the receiver,
removing any children which were previously set.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setStandalone:</sel>
<arg type="BOOL">standalone</arg>
<desc>
Sets whether the receiver is a document which requires
an external DTD. <br /> If this is set then the
<var>standalone</var> declaration will appear if the
document is output.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setVersion:</sel>
<arg type="NSString*">version</arg>
<desc>
Sets the XML <var>version</var> <br /> Permitted
values ar '1.0' or '1,1'
</desc>
</method>
<method type="BOOL" ovadd="1.0.0">
<sel>validateAndReturnError:</sel>
<arg type="NSError**">error</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>version</sel>
<desc>
Returns the XML version or <code>nil</code> if none
is set.
</desc>
</method>
</class>
</chapter>
</body>
</gsdoc>
|