Up
Authors
- Generated by root
-
- Declared in:
- Foundation/NSXMLDocument.h
Availability: OpenStep
An XMLDocument encapsulates an entire document. This must
contain a single element node.
Instance Variables
Method summary
+ (Class)
replacementClassForClass: (Class)cls;
Availability: OpenStep
Description forthcoming.
- (
NSXMLDTD*)
DTD;
Availability: OpenStep
Returns the DTD set for the receiver.
- (
NSString*)
MIMEType;
Availability: OpenStep
Returns the document MIME type..
- (
NSData*)
XMLData;
Availability: OpenStep
- (
NSData*)
XMLDataWithOptions: (
NSUInteger)options;
Availability: OpenStep
Outputs the reciever encoded using the specified
options.
- (void)
addChild: (
NSXMLNode*)child;
Availability: OpenStep
Adds child after existing children.
- (
NSString*)
characterEncoding;
Availability: OpenStep
Returns the IANA character encoding, or
nil
if none is set.
- (id)
initWithContentsOfURL: (
NSURL*)url
options: (
NSUInteger)mask
error: (
NSError**)error;
Availability: OpenStep
Initialise using the data downloaded from the
spplied url.
- (id)
initWithData: (
NSData*)data
options: (
NSUInteger)mask
error: (
NSError**)error;
Availability: OpenStep
This is a designated initialiser for the class.
Returns a document created from data.
Parse errors are returned in error
.
- (id)
initWithRootElement: (
NSXMLElement*)element;
Availability: OpenStep
Returns a document with a single child, the root
element.
- (id)
initWithXMLString: (
NSString*)string
options: (
NSUInteger)mask
error: (
NSError**)error;
Availability: OpenStep
Initialises the receiver by creating a document
from XML (or HTML if the HTMLTidy option is set).
Parse errors are returned in the error
argument.
- (void)
insertChild: (
NSXMLNode*)child
atIndex: (
NSUInteger)index;
Availability: OpenStep
Inserts child at index.
- (void)
insertChildren: (
NSArray*)children
atIndex: (
NSUInteger)index;
Availability: OpenStep
Inserts a number of children at the
index.
- (BOOL)
isStandalone;
Availability: OpenStep
Returns NO
if the receiver depends
upon an external DTD, otherwise returns
YES
.
- (id)
objectByApplyingXSLT: (
NSData*)xslt
arguments: (
NSDictionary*)arguments
error: (
NSError**)error;
Availability: OpenStep
Returns a new document created by applying
xslt (with a set of key/value pairs) to
the receiver.
- (id)
objectByApplyingXSLTAtURL: (
NSURL*)xsltURL
arguments: (
NSDictionary*)argument
error: (
NSError**)error;
Availability: OpenStep
Downloads XSLT from xsltURL, and then
returns a new document created by applying it (with
a set of key/value pairs) to the receiver.
- (id)
objectByApplyingXSLTString: (
NSString*)xslt
arguments: (
NSDictionary*)arguments
error: (
NSError**)error;
Availability: OpenStep
Returns a new document created by applying
xslt (with a set of key/value pairs) to
the receiver.
- (void)
removeChildAtIndex: (
NSUInteger)index;
Availability: OpenStep
Removes the child at the index.
- (void)
replaceChildAtIndex: (
NSUInteger)index
withNode: (
NSXMLNode*)node;
Availability: OpenStep
Replacs the child at the specified index
.
- (
NSXMLElement*)
rootElement;
Availability: OpenStep
Returns the root object of the receiver.
- (void)
setCharacterEncoding: (
NSString*)encoding;
Availability: OpenStep
Sets the character encoding to an IANA
characterset type.
- (void)
setChildren: (
NSArray*)children;
Availability: OpenStep
Replaces all existing child nodes with the ones in
the array.
- (void)
setDTD: (
NSXMLDTD*)documentTypeDeclaration;
Availability: OpenStep
Sets the DTD of the receiver. If this is set then the
DTD will be output when the document is.
- (void)
setMIMEType: (
NSString*)MIMEType;
Availability: OpenStep
Sets the document MIME type (usually text/xml).
- (void)
setRootElement: (
NSXMLNode*)root;
Availability: OpenStep
Sets the root object of the receiver,
removing any children which were previously set.
- (void)
setStandalone: (BOOL)standalone;
Availability: OpenStep
Sets whether the receiver is a document which requires
an external DTD.
If this is set then the
standalone declaration will appear if the
document is output.
- (void)
setVersion: (
NSString*)version;
Availability: OpenStep
Sets the XML version
Permitted
values ar '1.0' or '1,1'
- (BOOL)
validateAndReturnError: (
NSError**)error;
Availability: OpenStep
Description forthcoming.
- (
NSString*)
version;
Availability: OpenStep
Returns the XML version or nil
if none
is set.
Instance Variables for NSXMLDocument Class
@protected NSString* _MIMEType;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSString* _URI;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSArray* _children;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected BOOL _childrenHaveMutated;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSXMLDocumentContentKind _contentKind;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSXMLDTD* _docType;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSString* _encoding;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSUInteger _fidelityMask;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSXMLElement* _rootElement;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected BOOL _standalone;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected uint8_t _unused;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSString* _version;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
Up