Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIExtendedExpatSink Interface Reference

This interface provides notification of syntax-level events. More...

import "nsIExtendedExpatSink.idl";

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

List of all members.

Public Member Functions

void handleStartDTD (in wstring aDoctypeName, in wstring aSysid, in wstring aPubid)
 Called at the beginning of the DTD, before any entity or notation events.
void handleStartNamespaceDecl (in wstring aPrefix, in wstring aUri)
 Called when a prefix mapping starts to be in-scope, before any startElement events.
void handleEndNamespaceDecl (in wstring aPrefix)
 Called when a prefix mapping is no longer in-scope, after any endElement events.
void handleNotationDecl (in wstring aNotationName, in wstring aSysid, in wstring aPubid)
 This is called for a declaration of notation.
void handleUnparsedEntityDecl (in wstring aName, in wstring aSysid, in wstring aPubid, in wstring aNotationName)
 This is called for a declaration of an unparsed (NDATA) entity.
void HandleStartElement (in wstring aName,[array, size_is(aAttsCount)] in wstring aAtts, in unsigned long aAttsCount, in long aIndex, in unsigned long aLineNumber)
 Called to handle the opening tag of an element.
void HandleEndElement (in wstring aName)
 Called to handle the closing tag of an element.
void HandleComment (in wstring aCommentText)
 Called to handle a comment.
void HandleCDataSection ([size_is(aLength)] in wstring aData, in unsigned long aLength)
 Called to handle a CDATA section.
void HandleDoctypeDecl (in AString aSubset, in AString aName, in AString aSystemId, in AString aPublicId, in nsISupports aCatalogData)
 Called to handle the doctype declaration.
void HandleCharacterData ([size_is(aLength)] in wstring aData, in unsigned long aLength)
 Called to handle character data.
void HandleProcessingInstruction (in wstring aTarget, in wstring aData)
 Called to handle a processing instruction.
void HandleXMLDeclaration (in wstring aVersion, in wstring aEncoding, in long aStandalone)
 Handle the XML Declaration.
void ReportError (in wstring aErrorText, in wstring aSourceText)

Detailed Description

This interface provides notification of syntax-level events.

Definition at line 44 of file nsIExtendedExpatSink.idl.


Member Function Documentation

void nsIExpatSink::HandleCDataSection ( [size_is(aLength)] in wstring  aData,
in unsigned long  aLength 
) [inherited]

Called to handle a CDATA section.

Parameters:
aDatathe text in the CDATA section. This is null-terminated.
aLengththe length of the aData string
void nsIExpatSink::HandleCharacterData ( [size_is(aLength)] in wstring  aData,
in unsigned long  aLength 
) [inherited]

Called to handle character data.

Note that this does NOT get called for the contents of CDATA sections.

Parameters:
aDatathe data to handle. aData is NOT NULL-TERMINATED.
aLengththe length of the aData string
void nsIExpatSink::HandleComment ( in wstring  aCommentText) [inherited]

Called to handle a comment.

Parameters:
aCommentTextthe text of the comment (not including the "<!--" and "-->")
void nsIExpatSink::HandleDoctypeDecl ( in AString  aSubset,
in AString  aName,
in AString  aSystemId,
in AString  aPublicId,
in nsISupports  aCatalogData 
) [inherited]

Called to handle the doctype declaration.

void nsIExpatSink::HandleEndElement ( in wstring  aName) [inherited]

Called to handle the closing tag of an element.

Parameters:
aNamethe fully qualified tagname of the element

Called when a prefix mapping is no longer in-scope, after any endElement events.

Parameters:
aPrefixThe prefix that was being mapped. This is the empty string when a default mapping scope ends.
void nsIExtendedExpatSink::handleNotationDecl ( in wstring  aNotationName,
in wstring  aSysid,
in wstring  aPubid 
)

This is called for a declaration of notation.

The base argument is whatever was set by XML_SetBase. aNotationName will never be null. The other arguments can be.

Parameters:
aNotationNameThe notation name.
aSysIdThe notation's system identifier, or null if none was given.
aPubIdThe notation's pubilc identifier, or null if none was given.
void nsIExpatSink::HandleProcessingInstruction ( in wstring  aTarget,
in wstring  aData 
) [inherited]

Called to handle a processing instruction.

Parameters:
aTargetthe PI target (e.g. xml-stylesheet)
aDataall the rest of the data in the PI
void nsIExtendedExpatSink::handleStartDTD ( in wstring  aDoctypeName,
in wstring  aSysid,
in wstring  aPubid 
)

Called at the beginning of the DTD, before any entity or notation events.

Parameters:
aDoctypeNameThe document type name.
aSysidThe declared system identifier for the external DTD subset, or null if none was declared.
aPubidThe declared public identifier for the external DTD subset, or null if none was declared.
void nsIExpatSink::HandleStartElement ( in wstring  aName,
[array, size_is(aAttsCount)] in wstring  aAtts,
in unsigned long  aAttsCount,
in long  aIndex,
in unsigned long  aLineNumber 
) [inherited]

Called to handle the opening tag of an element.

Parameters:
aNamethe fully qualified tagname of the element
aAttsthe array of attribute names and values. There are aAttsCount/2 names and aAttsCount/2 values, so the total number of elements in the array is aAttsCount. The names and values alternate. Thus, if we number attributes starting with 0, aAtts[2*k] is the name of the k-th attribute and aAtts[2*k+1] is the value of that attribute Both explicitly specified attributes and attributes that are defined to have default values in a DTD are present in aAtts.
aAttsCountthe number of elements in aAtts.
aIndexIf the element has an attribute of type ID, then aAtts[aIndex] is the name of that attribute. Otherwise, aIndex is -1
aLineNumberthe line number of the start tag in the data stream.
void nsIExtendedExpatSink::handleStartNamespaceDecl ( in wstring  aPrefix,
in wstring  aUri 
)

Called when a prefix mapping starts to be in-scope, before any startElement events.

Parameters:
aPrefixThe Namespace prefix being declared. An empty string is used for the default element namespace, which has no prefix.
aUriThe Namespace URI the prefix is mapped to.
void nsIExtendedExpatSink::handleUnparsedEntityDecl ( in wstring  aName,
in wstring  aSysid,
in wstring  aPubid,
in wstring  aNotationName 
)

This is called for a declaration of an unparsed (NDATA) entity.

aName, aSysid and aNotationName arguments will never be null. The other arguments may be.

Parameters:
aNameThe unparsed entity's name.
aSysIdThe notation's system identifier.
aPubIdThe notation's pubilc identifier, or null if none was given.
aNotationNameThe name of the associated notation.
void nsIExpatSink::HandleXMLDeclaration ( in wstring  aVersion,
in wstring  aEncoding,
in long  aStandalone 
) [inherited]

Handle the XML Declaration.

Parameters:
aVersionThe version string, can be null if not specified.
aEncodingThe encoding string, can be null if not specified.
aStandalone-1, 0, or 1 indicating respectively that there was no standalone parameter in the declaration, that it was given as no, or that it was given as yes.
void nsIExpatSink::ReportError ( in wstring  aErrorText,
in wstring  aSourceText 
) [inherited]

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