![]() System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/share/doc/gnustep-base-doc/Base/Reference/ |
Upload File : |
<!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>NSXMLDocument class documentation</title> </head> <body> <font face="serif"> <a href="Base.html">Up</a> <br /> <h1><a name="title$NSXMLDocument">NSXMLDocument class documentation</a></h1> <h3>Authors</h3> <dl> <dt>Generated by Debian</dt> <dd> </dd> </dl> <div> </div> <h1><a name="001000000000"> Software documentation for the NSXMLDocument class </a></h1> <h2><a name="class$NSXMLDocument">NSXMLDocument</a> : <a rel="gsdoc" href="NSXMLNode.html#class$NSXMLNode">NSXMLNode</a></h2> <blockquote class="declared"> <dl> <dt><b>Declared in:</b></dt> <dd>Foundation/NSXMLDocument.h</dd> </dl> </blockquote> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> An XMLDocument encapsulates an entire document. This must contain a single element node. </div> <b>Method summary</b> <ul> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument+replacementClassForClass$">+replacementClassForClass:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-DTD">-DTD</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-MIMEType">-MIMEType</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-XMLData">-XMLData</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-XMLDataWithOptions$">-XMLDataWithOptions:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-addChild$">-addChild:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-characterEncoding">-characterEncoding</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-documentContentKind">-documentContentKind</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-initWithContentsOfURL$options$error$">-initWithContentsOfURL:options:error:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-initWithData$options$error$">-initWithData:options:error:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-initWithRootElement$">-initWithRootElement:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-initWithXMLString$options$error$">-initWithXMLString:options:error:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-insertChild$atIndex$">-insertChild:atIndex:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-insertChildren$atIndex$">-insertChildren:atIndex:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-isStandalone">-isStandalone</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-objectByApplyingXSLT$arguments$error$">-objectByApplyingXSLT:arguments:error:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-objectByApplyingXSLTAtURL$arguments$error$">-objectByApplyingXSLTAtURL:arguments:error:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-objectByApplyingXSLTString$arguments$error$">-objectByApplyingXSLTString:arguments:error:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-removeChildAtIndex$">-removeChildAtIndex:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-replaceChildAtIndex$withNode$">-replaceChildAtIndex:withNode:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-rootElement">-rootElement</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-setCharacterEncoding$">-setCharacterEncoding:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-setChildren$">-setChildren:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-setDTD$">-setDTD:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-setDocumentContentKind$">-setDocumentContentKind:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-setMIMEType$">-setMIMEType:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-setRootElement$">-setRootElement:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-setStandalone$">-setStandalone:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-setVersion$">-setVersion:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-validateAndReturnError$">-validateAndReturnError:</a></li> <li><a rel="gsdoc" href="NSXMLDocument.html#method$NSXMLDocument-version">-version</a></li> </ul> <hr width="50%" align="left" /> <div class="method"> <h3><a name="method$NSXMLDocument+replacementClassForClass$">replacementClassForClass: </a></h3> + (Class) <b>replacementClassForClass:</b> (Class)cls;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> <em>Description forthcoming.</em> </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-DTD">DTD </a></h3> - (<a rel="gsdoc" href="NSXMLDTD.html#class$NSXMLDTD">NSXMLDTD</a>*) <b>DTD</b>;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Returns the DTD set for the receiver. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-MIMEType">MIMEType </a></h3> - (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>MIMEType</b>;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Returns the document MIME type.. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-XMLData">XMLData </a></h3> - (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*) <b>XMLData</b>;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Outputs XML data using <a rel="gsdoc" href="#method$NSXMLDocument-XMLDataWithOptions$"> -XMLDataWithOptions: </a> with NSXMLNodeOptionsNone. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-XMLDataWithOptions$">XMLDataWithOptions: </a></h3> - (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*) <b>XMLDataWithOptions:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)theOptions;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Outputs the reciever encoded using the specified options. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-addChild$">addChild: </a></h3> - (void) <b>addChild:</b> (<a rel="gsdoc" href="NSXMLNode.html#class$NSXMLNode">NSXMLNode</a>*)child;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Adds <var>child</var> after existing children. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-characterEncoding">characterEncoding </a></h3> - (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>characterEncoding</b>;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Returns the IANA character encoding, or <code>nil</code> if none is set. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-documentContentKind">documentContentKind </a></h3> - (<a rel="gsdoc" href="TypesAndConstants.html#type$NSXMLDocumentContentKind">NSXMLDocumentContentKind</a>) <b>documentContentKind</b>;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Returns the kind of document. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-initWithContentsOfURL$options$error$">initWithContentsOfURL: options: error: </a></h3> - (id) <b>initWithContentsOfURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)url<b> options:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)mask<b> error:</b> (<a rel="gsdoc" href="NSError.html#class$NSError">NSError</a>**)error;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Initialise using the data downloaded from the spplied <var>url</var>. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-initWithData$options$error$">initWithData: options: error: </a></h3> - (id) <b>initWithData:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)data<b> options:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)mask<b> error:</b> (<a rel="gsdoc" href="NSError.html#class$NSError">NSError</a>**)error;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> This is a designated initialiser for the class.<br /> <div class="desc"> Returns a document created from <var>data</var>. <br /> Parse errors are returned in <var>error</var> . </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-initWithRootElement$">initWithRootElement: </a></h3> - (id) <b>initWithRootElement:</b> (<a rel="gsdoc" href="NSXMLElement.html#class$NSXMLElement">NSXMLElement</a>*)element;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Returns a document with a single child, the root <var>element</var>. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-initWithXMLString$options$error$">initWithXMLString: options: error: </a></h3> - (id) <b>initWithXMLString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)string<b> options:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)mask<b> error:</b> (<a rel="gsdoc" href="NSError.html#class$NSError">NSError</a>**)error;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="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. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-insertChild$atIndex$">insertChild: atIndex: </a></h3> - (void) <b>insertChild:</b> (<a rel="gsdoc" href="NSXMLNode.html#class$NSXMLNode">NSXMLNode</a>*)child<b> atIndex:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)index;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Inserts <var>child</var> at <var>index</var>. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-insertChildren$atIndex$">insertChildren: atIndex: </a></h3> - (void) <b>insertChildren:</b> (<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>*)children<b> atIndex:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)index;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Inserts a number of <var>children</var> at the <var>index</var>. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-isStandalone">isStandalone </a></h3> - (BOOL) <b>isStandalone</b>;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Returns <code>NO</code> if the receiver depends upon an external DTD, otherwise returns <code>YES</code>. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-objectByApplyingXSLT$arguments$error$">objectByApplyingXSLT: arguments: error: </a></h3> - (id) <b>objectByApplyingXSLT:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)xslt<b> arguments:</b> (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*)arguments<b> error:</b> (<a rel="gsdoc" href="NSError.html#class$NSError">NSError</a>**)error;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Returns a new document created by applying <var>xslt</var> (with a set of key/value pairs) to the receiver. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-objectByApplyingXSLTAtURL$arguments$error$">objectByApplyingXSLTAtURL: arguments: error: </a></h3> - (id) <b>objectByApplyingXSLTAtURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)xsltURL<b> arguments:</b> (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*)arguments<b> error:</b> (<a rel="gsdoc" href="NSError.html#class$NSError">NSError</a>**)error;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="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. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-objectByApplyingXSLTString$arguments$error$">objectByApplyingXSLTString: arguments: error: </a></h3> - (id) <b>objectByApplyingXSLTString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)xslt<b> arguments:</b> (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*)arguments<b> error:</b> (<a rel="gsdoc" href="NSError.html#class$NSError">NSError</a>**)error;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Returns a new document created by applying <var>xslt</var> (with a set of key/value pairs) to the receiver. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-removeChildAtIndex$">removeChildAtIndex: </a></h3> - (void) <b>removeChildAtIndex:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)index;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Removes the child at the <var>index</var>. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-replaceChildAtIndex$withNode$">replaceChildAtIndex: withNode: </a></h3> - (void) <b>replaceChildAtIndex:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)index<b> withNode:</b> (<a rel="gsdoc" href="NSXMLNode.html#class$NSXMLNode">NSXMLNode</a>*)theNode;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Replacs the child at the specified <var>index</var> . </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-rootElement">rootElement </a></h3> - (<a rel="gsdoc" href="NSXMLElement.html#class$NSXMLElement">NSXMLElement</a>*) <b>rootElement</b>;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Returns the root object of the receiver. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-setCharacterEncoding$">setCharacterEncoding: </a></h3> - (void) <b>setCharacterEncoding:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)encoding;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Sets the character <var>encoding</var> to an IANA characterset type. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-setChildren$">setChildren: </a></h3> - (void) <b>setChildren:</b> (<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>*)children;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Replaces all existing child nodes with the ones in the array. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-setDTD$">setDTD: </a></h3> - (void) <b>setDTD:</b> (<a rel="gsdoc" href="NSXMLDTD.html#class$NSXMLDTD">NSXMLDTD</a>*)documentTypeDeclaration;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Sets the DTD of the receiver. If this is set then the DTD will be output when the document is. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-setDocumentContentKind$">setDocumentContentKind: </a></h3> - (void) <b>setDocumentContentKind:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSXMLDocumentContentKind">NSXMLDocumentContentKind</a>)theContentKind;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Sets the kind of document. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-setMIMEType$">setMIMEType: </a></h3> - (void) <b>setMIMEType:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)theMIMEType;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Sets the document MIME type (usually text/xml). </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-setRootElement$">setRootElement: </a></h3> - (void) <b>setRootElement:</b> (<a rel="gsdoc" href="NSXMLNode.html#class$NSXMLNode">NSXMLNode</a>*)root;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Sets the <var>root</var> object of the receiver, removing any children which were previously set. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-setStandalone$">setStandalone: </a></h3> - (void) <b>setStandalone:</b> (BOOL)standalone;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="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. </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-setVersion$">setVersion: </a></h3> - (void) <b>setVersion:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)version;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Sets the XML <var>version</var> <br /> Permitted values ar '1.0' or '1,1' </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-validateAndReturnError$">validateAndReturnError: </a></h3> - (BOOL) <b>validateAndReturnError:</b> (<a rel="gsdoc" href="NSError.html#class$NSError">NSError</a>**)error;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> <em>Description forthcoming.</em> </div> <hr width="25%" align="left" /> </div> <div class="method"> <h3><a name="method$NSXMLDocument-version">version </a></h3> - (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>version</b>;<br /> <div class="availability"> <b>Availability:</b> OpenStep</div> <br /> <div class="desc"> Returns the XML version or <code>nil</code> if none is set. </div> <hr width="25%" align="left" /> </div> <br /> <a href="Base.html">Up</a> </font> </body> </html>