Usage of nsIDOMDocument Interface

 The nsIDOMWindow interface is the primary interface for a DOM
 window object. It represents a single window object that may
 contain child windows if the document in the window contains a
 HTML frameset document or if the document contains iframe elements.

 This interface is not officially defined by any standard bodies, it
 originates from the defacto DOM Level 0 standard.

 @status FROZEN


 Accessor for the document in this window.

readonly attribute nsIDOMDocument document

 document
 The document of the download manager frontend.

attribute nsIDOMDocument document

 The document where the drag was started, which will be null if the
 drag originated outside the application. Useful for determining if a drop
 originated in the same document.

readonly attribute nsIDOMDocument sourceDocument

 the DOM Document this editor is associated with, refcounted.

readonly attribute nsIDOMDocument document

 Retrieves the current DOM document for the frame, or lazily creates a
 blank document if there is none.  This attribute never returns null except
 for unexpected error situations.

readonly attribute nsIDOMDocument document

 The response to the request is parsed as if it were a
 text/xml stream. This attributes represents the response as
 a DOM Document object. NULL if the request is unsuccessful or
 has not yet been sent.

readonly attribute nsIDOMDocument responseXML

 The buffer is parsed into a DOM document.
 The charset is determined from the xml entity decl.

 @param buf The octet array data to be parsed
 @param bufLen Length (in bytes) of the data
 @param contentType The content type of the data (see parseFromStream)
 @returns The DOM document created as a result of parsing the 
          string

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

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

 Not accessible from web content.

 @param stream The byte stream whose contents are parsed
 @param charset The character set that was used to encode the byte
                stream. NULL if not specified.
 @param contentLength The number of bytes in the input stream.
 @param contentType The 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 parseFromStream(in nsIInputStream stream, in string charset, in long contentLength, in string contentType)

 The string passed in is parsed into a DOM document.

 @param str The UTF16 string to be parsed
 @param contentType The content type of the string (see parseFromStream)
 @returns The DOM document created as a result of parsing the 
          string

nsIDOMDocument parseFromString(in wstring str, in string contentType)

 Synchronously load the document from the specified channel.

 @param aChannel   The channel to load the document from.
 @param aLoaderPrincipal Principal of loading document. For security
                         checks null if no securitychecks should be done

 @returns The document loaded from the URI.

nsIDOMDocument loadDocument(in nsIChannel aChannel, in nsIPrincipal aLoaderPrincipal)

 Synchronously load an XML document from the specified
 channel. The channel must be possible to open synchronously.

 @param aChannel   The channel to load the document from.
 @param aLoaderPrincipal Principal of loading document. For security
                         checks null if no securitychecks should be done

 @returns The document loaded from the URI.

nsIDOMDocument loadLocalDocument(in nsIChannel aChannel, in nsIPrincipal aLoaderPrincipal)

 Transforms the node source applying the stylesheet given by the
 importStylesheet() function.

 @param source The node to be transformed
 @return Document The result of the transformation

 @exception nsIXSLTException

nsIDOMDocument transformToDocument(in nsIDOMNode source)

 This notification occurs in an editor during these events:
    * open of document (once rendered in window but before editable)
    * paste from clipboard
    * drop from mouse
    * insertion of html (such as with "cmd_insertHTML")
 It provides a hook so the above actions can be canceled or the data
 can be modified (using standard DOM APIs) or left untouched.  The data
 that results (if any) from all filter callbacks is what will be used
 for transaction purposes (undo/redo) except for the open event.

 The willDeleteSelection parameter is offered for filters who want to
 handle the insertion themselves and need to handle drag/drop correctly.
 The flag is true when the editor intends to delete the selection.

 Callers who want to cancel all insertion can simply set
 continueWithInsertion to PR_FALSE and return.
 Note: If cancellation occurs during the "open" event, the editor will
 still be available but will be empty.

 Callers who want to allow insertion of the data with no changes
 can simply set continueWithInsertion to PR_TRUE and return.

 Callers who want to modify the content (docFragment) being inserted are 
 responsible for updating contentStartNode, contentStartOffset, 
 contentEndNode, and contentEndOffset (if necessary).  
 Callers are responsible for freeing and addref'ing if they want to 
 completely replace any of the DOM nodes passed in.

 The location where insertion will occur should be considered an
 approximation since the editor may need to adjust it if it deletes
 the selection as part of the event and later determines that insertion
 point is an empty container which should also be removed (or in other
 scenarios such as -moz-user-select:none).

 In some scenarios the selection will be deleted.  If callers choose
 to adjust the insertion point, they should be careful that the insertion
 point is not in the current selection.

 The contentStartNode and contentEndNode are not necessarily
 immediate children of the docFragment.  Any nodes outside of the range
 set by contentStartNode and contentEndNode are for context from the
 source document.

 @param mimeType          the mimetype used for retrieving data
 @param contentSourceURL  location where docFragment came from
 @param sourceDocument      document where content came from (can be null)
 @param willDeleteSelection tells hook if selection will/should be deleted
 @param docFragment         fragment of node to be inserted
 @param contentStartNode    node under which content to be inserted begins
 @param contentStartOffset  start offset within contentStartNode
 @param contentEndNode      node under which content to be inserted ends
 @param contentEndOffset    ending offset withing contentEndNode
 @param insertionPointNode     location where insertion will occur
 @param insertionPointOffset   offset within node where insertion occurs
 @param continueWithInsertion  flag to cancel insertion (if desired)

void notifyOfInsertion(in AString mimeType, in nsIURL contentSourceURL, in nsIDOMDocument sourceDocument, in PRBool willDeleteSelection, inout nsIDOMNode docFragment, inout nsIDOMNode contentStartNode, inout long contentStartOffset, inout nsIDOMNode contentEndNode, inout long contentEndOffset, inout nsIDOMNode insertionPointNode, inout long insertionPointOffset, out boolean continueWithInsertion)

 Initialize with a pointer to the document and the mime type.
 @param aDocument Document to encode.
 @param aMimeType MimeType to use. May also be set by SetMimeType.
 @param aFlags Flags to use while encoding. May also be set by SetFlags.

void init(in nsIDOMDocument aDocument, in AString aMimeType, in unsigned long aFlags)

 Init is to tell the implementation of nsIEditor to begin its services
 @param aDoc          The dom document interface being observed
 @param aPresShell    TEMP: The presentation shell displaying the document.
                      Once events can tell us from what pres shell
                      they originated, this will no longer be
                      necessary, and the editor will no longer be
                      linked to a single pres shell.
 @param aRoot         This is the root of the editable section of this
                      document. If it is null then we get root
                      from document body.
 @param aSelCon       this should be used to get the selection location
 @param aFlags        A bitmask of flags for specifying the behavior
                      of the editor.

[noscript] void init(in nsIDOMDocument doc, in nsIPresShellPtr shell, in nsIContent aRoot, in nsISelectionController aSelCon, in unsigned long aFlags)

 Evaluate a FIXptr expression.

 @param aDocument   The document in which to evaluate.
 @param aExpression The FIXptr expression string to evaluate.
 @return            The result.

nsIDOMRange evaluate(in nsIDOMDocument aDocument, in DOMString aExpression)

 Insert some HTML source, interpreting
 the string argument according to the given context.

 @param aInputString   the string to be inserted
 @param aContextStr    Context of insertion
 @param aInfoStr       Related info to aInputString 
 @param aFlavor        Transferable flavor, can be ""
 @param aSourceDoc          document where input was dragged from (may be null)
 @param aDestinationNode    location for insertion (such as when dropped)
 @param aDestinationOffset  used with aDestNode to determine insert location
 @param aDeleteSelection    used with aDestNode during drag&drop 
 @param aCollapseSelection  used with aDestNode during drag&drop

void insertHTMLWithContext(in AString aInputString, in AString aContextStr, in AString aInfoStr, in AString aFlavor, in nsIDOMDocument aSourceDoc, in nsIDOMNode aDestinationNode, in long aDestinationOffset, in boolean aDeleteSelection)

 Install the microsummary generator in the given XML definition.

 @param   xmlDefinition
          an nsIDOMDocument XML document defining the generator

 @returns the newly-installed nsIMicrosummaryGenerator object

nsIMicrosummaryGenerator installGenerator(in nsIDOMDocument xmlDefinition)

 Schedule a cache update for a manifest when the document finishes
 loading.

void scheduleOnDocumentStop(in nsIURI aManifestURI, in nsIURI aDocumentURI, in nsIDOMDocument aDocument)

 Serializes this update object into a DOM Element
 @param   updates
          The document to serialize into
 @returns The DOM Element created by the serialization process

nsIDOMElement serialize(in nsIDOMDocument updates)

 Serializes this patch object into a DOM Element
 @param   updates
          The document to serialize into
 @returns The DOM Element created by the serialization process

nsIDOMElement serialize(in nsIDOMDocument updates)

 Save the specified DOM document to file and optionally all linked files
 (e.g. images, CSS, JS & subframes). Do not call this method until the
 document has finished loading!

 @param aDocument          Document to save to file. Some implementations of
                           this interface may also support <CODE>nsnull</CODE>
                           to imply the currently loaded document.
 @param aFile              Target local file. This may be a nsILocalFile object or an
                           nsIURI object with a file scheme or a scheme that
                           supports uploading (e.g. ftp).
 @param aDataPath          Path to directory where URIs linked to the document
                           are saved or nsnull if no linked URIs should be saved.
                           This may be a nsILocalFile object or an nsIURI object
                           with a file scheme.
 @param aOutputContentType The desired MIME type format to save the 
                           document and all subdocuments into or nsnull to use
                           the default behaviour.
 @param aEncodingFlags     Flags to pass to the encoder.
 @param aWrapColumn        For text documents, indicates the desired width to
                           wrap text at. Parameter is ignored if wrapping is not
                           specified by the encoding flags.

 @see nsILocalFile
 @see nsIURI

 @return NS_OK Operation has been started.
 @return NS_ERROR_INVALID_ARG One or more arguments was invalid.

void saveDocument(in nsIDOMDocument aDocument, in nsISupports aFile, in nsISupports aDataPath, in string aOutputContentType, in unsigned long aEncodingFlags, in unsigned long aWrapColumn)

 Evaluate an XPointer expression.

 @param aDocument   The document in which to evaluate.
 @param aExpression The XPointer expression string to evaluate.
 @return            The result.

nsIXPointerResult evaluate(in nsIDOMDocument aDocument, in DOMString aExpression)

 Evaluate.

 @param aDocument The document in which to resolve the XPointer.
 @param aContext  The XPointer context in which to process aData.
 @param aData     The data in the scheme that needs to be resolved.
 @return          The result of the evaluation.

nsIXPointerResult evaluate(in nsIDOMDocument aDocument, in nsIXPointerSchemeContext aContext, in DOMString aData)

 Transforms the node source applying the stylesheet given by
 the importStylesheet() function. The owner document of the output node
 owns the returned document fragment.

 @param source The node to be transformed
 @param output This document is used to generate the output
 @return DocumentFragment The result of the transformation

 @exception nsIXSLTException

nsIDOMDocumentFragment transformToFragment(in nsIDOMNode source, in nsIDOMDocument output)