Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIDTD Class Reference

#include <nsIDTD.h>

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

List of all members.

Public Member Functions

 NS_IMETHOD_ (const nsIID &) GetMostDerivedIID(void) const =0
NS_IMETHOD CreateNewInstance (nsIDTD **aInstancePtrResult)=0
 Call this method if you want the DTD to construct a clone of itself.
 NS_IMETHOD_ (eAutoDetectResult) CanParse(CParserContext &aParserContext)=0
 This method is called to determine if the given DTD can parse a document in a given source-type.
NS_IMETHOD WillBuildModel (const CParserContext &aParserContext, nsITokenizer *aTokenizer, nsIContentSink *aSink)=0
NS_IMETHOD DidBuildModel (nsresult anErrorCode, PRBool aNotifySink, nsIParser *aParser, nsIContentSink *aSink)=0
 Called by the parser after the parsing process has concluded gess5/18/98.
NS_IMETHOD BuildModel (nsIParser *aParser, nsITokenizer *aTokenizer, nsITokenObserver *anObserver, nsIContentSink *aSink)=0
 Called by the parser after the parsing process has concluded gess5/18/98.
NS_IMETHOD HandleToken (CToken *aToken, nsIParser *aParser)=0
 Called during model building phase of parse process.
NS_IMETHOD WillResumeParse (nsIContentSink *aSink)=0
 If the parse process gets interrupted midway, this method is called by the parser prior to resuming the process.
NS_IMETHOD WillInterruptParse (nsIContentSink *aSink)=0
 If the parse process gets interrupted, this method is called by the parser to notify the DTD that interruption will occur.
 NS_IMETHOD_ (PRBool) CanContain(PRInt32 aParent
 This method is called to determine whether or not a tag of one type can contain a tag of another type.
 NS_IMETHOD_ (PRBool) IsContainer(PRInt32 aTag) const =0
 This method gets called to determine whether a given tag is itself a container.
 NS_IMETHOD_ (void) Terminate()=0
 Use this id you want to stop the building content model --------------[ Sets DTD to STOP mode ]---------------- It's recommended to use this method in accordance with the parser's terminate() method.
 NS_IMETHOD_ (PRInt32) GetType()=0
NS_IMETHOD CollectSkippedContent (PRInt32 aTag, nsAString &aContent, PRInt32 &aLineNo)=0

Public Attributes

PRInt32 aChild const = 0

Detailed Description

Definition at line 87 of file nsIDTD.h.


Member Function Documentation

NS_IMETHOD nsIDTD::BuildModel ( nsIParser aParser,
nsITokenizer aTokenizer,
nsITokenObserver anObserver,
nsIContentSink aSink 
) [pure virtual]

Called by the parser after the parsing process has concluded gess5/18/98.

Parameters:
anErrorCode- contains error code resulting from parse process
Returns:

Here is the caller graph for this function:

NS_IMETHOD nsIDTD::CollectSkippedContent ( PRInt32  aTag,
nsAString &  aContent,
PRInt32 aLineNo 
) [pure virtual]

Here is the caller graph for this function:

NS_IMETHOD nsIDTD::CreateNewInstance ( nsIDTD **  aInstancePtrResult) [pure virtual]

Call this method if you want the DTD to construct a clone of itself.

gess7/23/98

Parameters:
@return

Here is the caller graph for this function:

NS_IMETHOD nsIDTD::DidBuildModel ( nsresult  anErrorCode,
PRBool  aNotifySink,
nsIParser aParser,
nsIContentSink aSink 
) [pure virtual]

Called by the parser after the parsing process has concluded gess5/18/98.

Parameters:
anErrorCode- contains error code resulting from parse process
Returns:

Here is the caller graph for this function:

NS_IMETHOD nsIDTD::HandleToken ( CToken aToken,
nsIParser aParser 
) [pure virtual]

Called during model building phase of parse process.

Each token created during the parse phase is stored in a deque (in the parser) and are passed to this method so that the DTD can process the token. Ultimately, the DTD will transform given token into calls onto a contentsink. gess 3/25/98

Parameters:
aToken-- token object to be put into content model
Returns:
error code (usually 0)

Here is the caller graph for this function:

nsIDTD::NS_IMETHOD_ ( const nsIID ) const [pure virtual]
nsIDTD::NS_IMETHOD_ ( eAutoDetectResult  ) [pure virtual]

This method is called to determine if the given DTD can parse a document in a given source-type.

NOTE: Parsing always assumes that the end result will involve storing the result in the main content model.

Parameters:
aParserContext-- the context for this document (knows the content type, document type, parser command, etc).
Returns:
eUnknownDetect if you don't know how to parse it, eValidDetect if you do, but someone may have a better idea, ePrimaryDetect if you think you know best

This method is called to determine whether or not a tag of one type can contain a tag of another type.

gess 3/25/98

Parameters:
aParent-- int tag of parent container
aChild-- int tag of child container
Returns:
PR_TRUE if parent can contain child
nsIDTD::NS_IMETHOD_ ( PRBool  ) const [pure virtual]

This method gets called to determine whether a given tag is itself a container.

gess 3/25/98

Parameters:
aTag-- tag to test for containership
Returns:
PR_TRUE if given tag can contain other tags
nsIDTD::NS_IMETHOD_ ( void  ) [pure virtual]

Use this id you want to stop the building content model --------------[ Sets DTD to STOP mode ]---------------- It's recommended to use this method in accordance with the parser's terminate() method.

harishd 07/22/99

Parameters:
@return
nsIDTD::NS_IMETHOD_ ( PRInt32  ) [pure virtual]
NS_IMETHOD nsIDTD::WillBuildModel ( const CParserContext aParserContext,
nsITokenizer aTokenizer,
nsIContentSink aSink 
) [pure virtual]

Here is the caller graph for this function:

If the parse process gets interrupted, this method is called by the parser to notify the DTD that interruption will occur.

gess5/18/98

Returns:
ignored

Here is the caller graph for this function:

NS_IMETHOD nsIDTD::WillResumeParse ( nsIContentSink aSink) [pure virtual]

If the parse process gets interrupted midway, this method is called by the parser prior to resuming the process.

gess5/18/98

Returns:
ignored

Here is the caller graph for this function:


Member Data Documentation

PRInt32 aChild nsIDTD::const = 0

Definition at line 178 of file nsIDTD.h.


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