Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIXMLContentSink Class Reference

This interface represents a content sink for generic XML files. More...

#include <nsIXMLContentSink.h>

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

List of all members.

Public Member Functions

NS_IMETHOD WillBuildModel (void)=0
 This method gets called when the parser begins the process of building the content model via the content sink.
NS_IMETHOD DidBuildModel ()=0
 This method gets called when the parser concludes the process of building the content model via the content sink.
NS_IMETHOD WillInterrupt (void)=0
 This method gets called when the parser gets i/o blocked, and wants to notify the sink that it may be a while before more data is available.
NS_IMETHOD WillResume (void)=0
 This method gets called when the parser i/o gets unblocked, and we're about to start dumping content again to the sink.
NS_IMETHOD SetParser (nsIParser *aParser)=0
 This method gets called by the parser so that the content sink can retain a reference to the parser.
virtual void FlushPendingNotifications (mozFlushType aType)=0
 Flush content so that the content model is in sync with the state of the sink.
NS_IMETHOD SetDocumentCharset (nsACString &aCharset)=0
 Set the document character set.
virtual nsISupports * GetTarget ()=0
 Returns the target object (often a document object) into which the content built by this content sink is being added, if any (IOW, may return null).

Detailed Description

This interface represents a content sink for generic XML files.

The goal of this sink is to deal with XML documents that do not have pre-built semantics, though it may also be implemented for cases in which semantics are hard-wired.

The expectation is that the parser has already performed well-formedness and validity checking.

XXX The expectation is that entity expansion will be done by the sink itself. This would require, however, that the sink has the ability to query the parser for entity replacement text.

XXX This interface does not contain a mechanism for the sink to get specific schema/DTD information from the parser. This information may be necessary for entity expansion. It is also necessary for building the DOM portions that relate to the schema.

XXX This interface does not deal with the presence of an external subset. It seems possible that this could be dealt with completely at the parser level.

Definition at line 75 of file nsIXMLContentSink.h.


Member Function Documentation

NS_IMETHOD nsIContentSink::DidBuildModel ( ) [pure virtual, inherited]

This method gets called when the parser concludes the process of building the content model via the content sink.

5/7/98 gess

Implemented in HTMLContentSink, RDFContentSinkImpl, XULContentSinkImpl, txStylesheetSink, RobotSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsXMLFragmentContentSink, nsHTMLFragmentContentSink, nsXMLContentSink, nsSAXXMLReader, nsLoadSaveContentSink, and nsLoggingSink.

Here is the caller graph for this function:

virtual void nsIContentSink::FlushPendingNotifications ( mozFlushType  aType) [pure virtual, inherited]

Flush content so that the content model is in sync with the state of the sink.

Parameters:
aTypethe type of flush to perform

Implemented in HTMLContentSink, RDFContentSinkImpl, XULContentSinkImpl, txStylesheetSink, mozSanitizingHTMLSerializer, RobotSink, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsSAXXMLReader, nsXMLContentSink, nsLoadSaveContentSink, and nsLoggingSink.

virtual nsISupports* nsIContentSink::GetTarget ( ) [pure virtual, inherited]

Returns the target object (often a document object) into which the content built by this content sink is being added, if any (IOW, may return null).

Implemented in HTMLContentSink, RDFContentSinkImpl, XULContentSinkImpl, txStylesheetSink, mozSanitizingHTMLSerializer, RobotSink, nsPlainTextSerializer, nsSAXXMLReader, nsHTMLFragmentContentSink, nsXMLFragmentContentSink, nsXMLContentSink, and nsLoggingSink.

NS_IMETHOD nsIContentSink::SetDocumentCharset ( nsACString &  aCharset) [pure virtual, inherited]
NS_IMETHOD nsIContentSink::SetParser ( nsIParser aParser) [pure virtual, inherited]

This method gets called by the parser so that the content sink can retain a reference to the parser.

The expectation is that the content sink will drop the reference when it gets the DidBuildModel notification i.e. when parsing is done.

Implemented in HTMLContentSink, RDFContentSinkImpl, XULContentSinkImpl, txStylesheetSink, RobotSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsXMLContentSink, nsLoadSaveContentSink, nsSAXXMLReader, and nsLoggingSink.

Here is the caller graph for this function:

NS_IMETHOD nsIContentSink::WillBuildModel ( void  ) [pure virtual, inherited]

This method gets called when the parser begins the process of building the content model via the content sink.

5/7/98 gess

Implemented in HTMLContentSink, RDFContentSinkImpl, XULContentSinkImpl, txStylesheetSink, RobotSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsXMLFragmentContentSink, nsHTMLFragmentContentSink, nsXMLContentSink, nsSAXXMLReader, nsLoadSaveContentSink, and nsLoggingSink.

Here is the caller graph for this function:

NS_IMETHOD nsIContentSink::WillInterrupt ( void  ) [pure virtual, inherited]

This method gets called when the parser gets i/o blocked, and wants to notify the sink that it may be a while before more data is available.

5/7/98 gess

Implemented in HTMLContentSink, RDFContentSinkImpl, XULContentSinkImpl, txStylesheetSink, RobotSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsXMLContentSink, nsSAXXMLReader, nsLoadSaveContentSink, and nsLoggingSink.

Here is the caller graph for this function:

NS_IMETHOD nsIContentSink::WillResume ( void  ) [pure virtual, inherited]

This method gets called when the parser i/o gets unblocked, and we're about to start dumping content again to the sink.

5/7/98 gess

Implemented in HTMLContentSink, RDFContentSinkImpl, XULContentSinkImpl, txStylesheetSink, RobotSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsXMLContentSink, nsSAXXMLReader, nsLoadSaveContentSink, and nsLoggingSink.

Here is the caller graph for this function:


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