Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIDOMParser Interface Reference

The nsIDOMParser interface is a non-SAX interface that can be used to parse a string or byte stream containing XML or HTML content to a DOM document. More...

import "nsIDOMParser.idl";

Inheritance diagram for nsIDOMParser:
Inheritance graph
[legend]
Collaboration diagram for nsIDOMParser:
Collaboration graph
[legend]

List of all members.

Public Member Functions

nsIDOMDocument parseFromString (in wstring str, in string contentType)
 The string passed in is parsed into a DOM document.
nsIDOMDocument parseFromBuffer ([const, array, size_is(bufLen)] in octet buf, in PRUint32 bufLen, in string contentType)
 The buffer is parsed into a DOM document.
nsIDOMDocument parseFromStream (in nsIInputStream stream, in string charset, in long contentLength, in string contentType)
 The byte stream passed in is parsed into a DOM document.

Public Attributes

attribute nsIURI baseURI
 Set/Get the baseURI, may be needed when called from native code.

Detailed Description

The nsIDOMParser interface is a non-SAX interface that can be used to parse a string or byte stream containing XML or HTML content to a DOM document.

Parsing is always synchronous - a document is always returned from the parsing methods. This is as opposed to loading and parsing with the XMLHttpRequest interface, which can be used for asynchronous (callback-based) loading.

Definition at line 54 of file nsIDOMParser.idl.


Member Function Documentation

nsIDOMDocument nsIDOMParser::parseFromBuffer ( [const, array, size_is(bufLen)] in octet  buf,
in PRUint32  bufLen,
in string  contentType 
)

The buffer is parsed into a DOM document.

The charset is determined from the xml entity decl.

Parameters:
bufThe octet array data to be parsed
bufLenLength (in bytes) of the data
contentTypeThe content type of the data (see parseFromStream)
Returns:
The DOM document created as a result of parsing the string
nsIDOMDocument nsIDOMParser::parseFromStream ( in nsIInputStream  stream,
in string  charset,
in long  contentLength,
in string  contentType 
)

The byte stream passed in is parsed into a DOM document.

Not accessible from web content.

Parameters:
streamThe byte stream whose contents are parsed
charsetThe character set that was used to encode the byte stream. NULL if not specified.
contentLengthThe number of bytes in the input stream.
contentTypeThe content type of the string - either text/xml, application/xml, or application/xhtml+xml. Must not be NULL.
Returns:
The DOM document created as a result of parsing the stream
nsIDOMDocument nsIDOMParser::parseFromString ( in wstring  str,
in string  contentType 
)

The string passed in is parsed into a DOM document.

Parameters:
strThe UTF16 string to be parsed
contentTypeThe content type of the string (see parseFromStream)
Returns:
The DOM document created as a result of parsing the string

Member Data Documentation

Set/Get the baseURI, may be needed when called from native code.

Definition at line 101 of file nsIDOMParser.idl.


The documentation for this interface was generated from the following file: