InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ISAXDTDHandler Class Referenceabstract

#include <ISAXDTDHandler.h>

Inheritance diagram for ISAXDTDHandler:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISAXDTDHANDLER }
 

Public Member Functions

virtual void NotationDecl (const PMString &name, const PMString &publicID, const PMString &systemID)=0
 
virtual void UnparsedEntityDecl (const PMString &name, const PMString &publicID, const PMString &systemID, const PMString &notationName)=0
 
virtual void ResetDocType ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Basic handler for entity/notation declarations

If a SAX client needs information about notations and unparsed entities, then the client implements this interface and passes it to the parser using the ParseStream method of ISAXService. The parser uses the instance to report notation and unparsed entity declarations to the application.

The SAX parser may report these events in any order, regardless of the order in which the notations and unparsed entities were declared; however, all DTD events must be reported after the document handler's startDocument event, and before the first startElement event.

It is up to the application to copy the information for future use (perhaps in a hash table or object tree). If the application encounters attributes of type "NOTATION", "ENTITY", or "ENTITIES", it can use the information that it obtained through this interface to find the entity and/or notation corresponding with the attribute value.

See Also
CAXESAX2Parser::setDTDHandler

Member Function Documentation

virtual void ISAXDTDHandler::NotationDecl (const PMStringname,
const PMStringpublicID,
const PMStringsystemID 
)
pure virtual

Notation declaration notification

It is up to the client to copy the notation for later reference, if necessary.

Parameters
nameThe notation name.
publicIDThe notation's public identifier, or null if none was given.
systemIDThe notation's system identifier, or null if none was given.
See Also
UnparsedEntityDecl
ISAXAttributes
virtual void ISAXDTDHandler::ResetDocType ()
pure virtual

Reset handler

This method helps in reseting the DTD object implementation defaults each time the DTD is begun.

virtual void ISAXDTDHandler::UnparsedEntityDecl (const PMStringname,
const PMStringpublicID,
const PMStringsystemID,
const PMStringnotationName 
)
pure virtual

Unparsed entity notification

Note that the notation name corresponds to a notation reported by the notationDecl() event. It is up to the application to copy the entity for later reference, if necessary.

Parameters
nameThe notation name.
publicIDThe notation's public identifier, or null if none was given.
systemIDThe notation's system identifier, or null if none was given.
notationNameThe name of the associated notation.
See Also
NotationDecl
ISAXAttributes