Back to index

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

#include <nsILoggingSink.h>

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

List of all members.

Public Member Functions

NS_IMETHOD SetOutputStream (PRFileDesc *aStream, PRBool autoDelete=PR_FALSE)=0
NS_IMETHOD SetTitle (const nsString &aValue)=0
 This method gets called by the parser when it encounters a title tag and wants to set the document title in the sink.
NS_IMETHOD OpenHTML (const nsIParserNode &aNode)=0
 This method is used to open the outer HTML container.
NS_IMETHOD CloseHTML ()=0
 This method is used to close the outer HTML container.
NS_IMETHOD OpenHead (const nsIParserNode &aNode)=0
 This method is used to open the only HEAD container.
NS_IMETHOD CloseHead ()=0
 This method is used to close the only HEAD container.
NS_IMETHOD OpenBody (const nsIParserNode &aNode)=0
 This method is used to open the main BODY container.
NS_IMETHOD CloseBody ()=0
 This method is used to close the main BODY container.
NS_IMETHOD OpenForm (const nsIParserNode &aNode)=0
 This method is used to open a new FORM container.
NS_IMETHOD CloseForm ()=0
 This method is used to close the outer FORM container.
NS_IMETHOD OpenMap (const nsIParserNode &aNode)=0
 This method is used to open a new MAP container.
NS_IMETHOD CloseMap ()=0
 This method is used to close the MAP container.
NS_IMETHOD OpenFrameset (const nsIParserNode &aNode)=0
 This method is used to open the FRAMESET container.
NS_IMETHOD CloseFrameset ()=0
 This method is used to close the FRAMESET container.
NS_IMETHOD BeginContext (PRInt32 aPosition)=0
 This gets called when handling illegal contents, especially in dealing with tables.
NS_IMETHOD EndContext (PRInt32 aPosition)=0
 This method terminates any new context that got created by BeginContext and switches back to the main context.
NS_IMETHOD IsEnabled (PRInt32 aTag, PRBool *aReturn)=0
 01/09/2003 harishd
NS_IMETHOD WillProcessTokens (void)=0
 This method is called when parser is about to begin synchronously processing a chunk of tokens.
NS_IMETHOD DidProcessTokens ()=0
 This method is called when parser has completed processing a chunk of tokens.
NS_IMETHOD WillProcessAToken (void)=0
 This method is called when parser is about to process a single token.
NS_IMETHOD DidProcessAToken (void)=0
 This method is called when parser has completed the processing for a single token.
NS_IMETHOD OpenContainer (const nsIParserNode &aNode)=0
 This method is used to open a generic container in the sink.
NS_IMETHOD CloseContainer (const nsHTMLTag aTag)=0
 This method gets called by the parser when a close container tag has been consumed and needs to be closed.
NS_IMETHOD AddHeadContent (const nsIParserNode &aNode)=0
 This gets called by the parser to contents to the head container.
NS_IMETHOD AddLeaf (const nsIParserNode &aNode)=0
 This gets called by the parser when you want to add a leaf node to the current container in the content model.
NS_IMETHOD AddComment (const nsIParserNode &aNode)=0
 This gets called by the parser when you want to add a leaf node to the current container in the content model.
NS_IMETHOD AddProcessingInstruction (const nsIParserNode &aNode)=0
 This gets called by the parser when you want to add a leaf node to the current container in the content model.
NS_IMETHOD AddDocTypeDecl (const nsIParserNode &aNode)=0
 This method is called by the parser when it encounters a document type declaration.
NS_IMETHOD NotifyTagObservers (nsIParserNode *aNode)=0
 This gets called by the parser to notify observers of the tag.
 NS_IMETHOD_ (PRBool) IsFormOnStack()=0
 Call this method to determnine if a FORM is on the sink's stack.
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

Definition at line 48 of file nsILoggingSink.h.


Member Function Documentation

NS_IMETHOD nsIHTMLContentSink::AddComment ( const nsIParserNode aNode) [pure virtual, inherited]

This gets called by the parser when you want to add a leaf node to the current container in the content model.

4/1/98 gess

Parameters:
nsIParserNodereference to parser node interface

Implemented in nsHTMLParanoidFragmentSink, HTMLContentSink, nsHTMLFragmentContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, RobotSink, and nsLoggingSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::AddDocTypeDecl ( const nsIParserNode aNode) [pure virtual, inherited]

This method is called by the parser when it encounters a document type declaration.

XXX Should the parser also part the internal subset?

Parameters:
nsIParserNodereference to parser node interface

Implemented in HTMLContentSink, nsHTMLFragmentContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, RobotSink, and nsLoggingSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::AddHeadContent ( const nsIParserNode aNode) [pure virtual, inherited]

This gets called by the parser to contents to the head container.

Implemented in HTMLContentSink, nsHTMLFragmentContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, RobotSink, and nsLoggingSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::AddLeaf ( const nsIParserNode aNode) [pure virtual, inherited]

This gets called by the parser when you want to add a leaf node to the current container in the content model.

4/1/98 gess

Parameters:
nsIParserNodereference to parser node interface

Implemented in nsHTMLParanoidFragmentSink, HTMLContentSink, nsHTMLFragmentContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, RobotSink, and nsLoggingSink.

Here is the caller graph for this function:

This gets called by the parser when you want to add a leaf node to the current container in the content model.

4/1/98 gess

Parameters:
nsIParserNodereference to parser node interface

Implemented in nsHTMLParanoidFragmentSink, HTMLContentSink, nsHTMLFragmentContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, RobotSink, and nsLoggingSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::BeginContext ( PRInt32  aPosition) [pure virtual, inherited]

This gets called when handling illegal contents, especially in dealing with tables.

This method creates a new context.

04/04/99 harishd

Parameters:
aPosition- The position from where the new context begins.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, RobotSink, nsLoggingSink, and nsHTMLFragmentContentSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::CloseBody ( ) [pure virtual, inherited]

This method is used to close the main BODY container.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::CloseContainer ( const nsHTMLTag  aTag) [pure virtual, inherited]

This method gets called by the parser when a close container tag has been consumed and needs to be closed.

Parameters:
aTag- The tag to be closed.

Implemented in nsHTMLParanoidFragmentSink, HTMLContentSink, nsHTMLFragmentContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, RobotSink, and nsLoggingSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::CloseForm ( ) [pure virtual, inherited]

This method is used to close the outer FORM container.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::CloseFrameset ( ) [pure virtual, inherited]

This method is used to close the FRAMESET container.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::CloseHead ( ) [pure virtual, inherited]

This method is used to close the only HEAD container.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::CloseHTML ( ) [pure virtual, inherited]

This method is used to close the outer HTML container.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::CloseMap ( ) [pure virtual, inherited]

This method is used to close the MAP container.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

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:

NS_IMETHOD nsIHTMLContentSink::DidProcessAToken ( void  ) [pure virtual, inherited]

This method is called when parser has completed the processing for a single token.

Returns:
NS_OK if processing should not be interrupted NS_ERROR_HTMLPARSER_INTERRUPTED if the parsing should be interrupted

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, RobotSink, and nsLoggingSink.

NS_IMETHOD nsIHTMLContentSink::DidProcessTokens ( ) [pure virtual, inherited]

This method is called when parser has completed processing a chunk of tokens.

The processing of the tokens may be interrupted by returning NS_ERROR_HTMLPARSER_INTERRUPTED from DidProcessAToken.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, RobotSink, and nsLoggingSink.

NS_IMETHOD nsIHTMLContentSink::EndContext ( PRInt32  aPosition) [pure virtual, inherited]

This method terminates any new context that got created by BeginContext and switches back to the main context.

04/04/99 harishd

Parameters:
aPosition- Validates the end of a context.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, RobotSink, nsLoggingSink, and nsHTMLFragmentContentSink.

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 nsIHTMLContentSink::IsEnabled ( PRInt32  aTag,
PRBool aReturn 
) [pure virtual, inherited]

01/09/2003 harishd

Parameters:
aTag- Check if this tag is enabled or not.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

NS_IMETHOD nsIHTMLContentSink::NotifyTagObservers ( nsIParserNode aNode) [pure virtual, inherited]

This gets called by the parser to notify observers of the tag.

Parameters:
aErrorResultthe error code

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, RobotSink, and nsLoggingSink.

Here is the caller graph for this function:

nsIHTMLContentSink::NS_IMETHOD_ ( PRBool  ) [pure virtual, inherited]

Call this method to determnine if a FORM is on the sink's stack.

Returns:
PR_TRUE if found else PR_FALSE

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

NS_IMETHOD nsIHTMLContentSink::OpenBody ( const nsIParserNode aNode) [pure virtual, inherited]

This method is used to open the main BODY container.

4/1/98 gess

Parameters:
nsIParserNodereference to parser node interface

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::OpenContainer ( const nsIParserNode aNode) [pure virtual, inherited]

This method is used to open a generic container in the sink.

4/1/98 gess

Parameters:
nsIParserNodereference to parser node interface

Implemented in nsHTMLParanoidFragmentSink, HTMLContentSink, nsHTMLFragmentContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, RobotSink, and nsLoggingSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::OpenForm ( const nsIParserNode aNode) [pure virtual, inherited]

This method is used to open a new FORM container.

4/1/98 gess

Parameters:
nsIParserNodereference to parser node interface

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::OpenFrameset ( const nsIParserNode aNode) [pure virtual, inherited]

This method is used to open the FRAMESET container.

4/1/98 gess

Parameters:
nsIParserNodereference to parser node interface

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::OpenHead ( const nsIParserNode aNode) [pure virtual, inherited]

This method is used to open the only HEAD container.

4/1/98 gess

Parameters:
nsIParserNodereference to parser node interface

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::OpenHTML ( const nsIParserNode aNode) [pure virtual, inherited]

This method is used to open the outer HTML container.

4/1/98 gess

Parameters:
nsIParserNodereference to parser node interface

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

NS_IMETHOD nsIHTMLContentSink::OpenMap ( const nsIParserNode aNode) [pure virtual, inherited]

This method is used to open a new MAP container.

4/1/98 gess

Parameters:
nsIParserNodereference to parser node interface

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

Here is the caller graph for this function:

NS_IMETHOD nsIContentSink::SetDocumentCharset ( nsACString &  aCharset) [pure virtual, inherited]
NS_IMETHOD nsILoggingSink::SetOutputStream ( PRFileDesc aStream,
PRBool  autoDelete = PR_FALSE 
) [pure virtual]

Implemented in nsLoggingSink.

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 nsIHTMLContentSink::SetTitle ( const nsString aValue) [pure virtual, inherited]

This method gets called by the parser when it encounters a title tag and wants to set the document title in the sink.

4/1/98 gess

Parameters:
nsStringreference to new title value

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, nsLoggingSink, and RobotSink.

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 nsIHTMLContentSink::WillProcessAToken ( void  ) [pure virtual, inherited]

This method is called when parser is about to process a single token.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, RobotSink, and nsLoggingSink.

NS_IMETHOD nsIHTMLContentSink::WillProcessTokens ( void  ) [pure virtual, inherited]

This method is called when parser is about to begin synchronously processing a chunk of tokens.

Implemented in HTMLContentSink, mozSanitizingHTMLSerializer, nsPlainTextSerializer, nsHTMLFragmentContentSink, RobotSink, and nsLoggingSink.

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: