Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

SAXEmitter Class Reference

An emitter of SAX events. More...

#include <saxemitter.h>

Inheritance diagram for SAXEmitter:

SAXBase List of all members.

Public Methods

 SAXEmitter (void)
 A constructor. More...

 SAXEmitter (SAXReceptor *receptor)
 A constructor. More...

virtual void setSAXReceptor (SAXReceptor *receptor)
 Set SAX receptor. More...

virtual void reportError (void)
 Report parser error messages. More...

virtual void startElement (void *userData, const XmlChar *name, const XmlChar **atts)
 Start element handler. More...

virtual void endElement (void *userData, const XmlChar *name)
 End element handler. More...

virtual void characterData (void *userData, const XmlChar *data, int length)
 Character data handler. More...

virtual void processingInstruction (void *userData, const XmlChar *target, const XmlChar *data)
 Processing instruction handler. More...

virtual void comment (void *userData, const XmlChar *data)
 Comment handler. More...

virtual void startCDATASection (void *userData)
 Start CDATA section handler. More...

virtual void endCDATASection (void *userData)
 End CDATA section handler. More...

virtual void defaultHandler (void *userData, const XmlChar *data, int length)
 Default handler. More...

virtual int unknownEncoding (void *unknownEncodingData, const XmlChar *name, XML_Encoding *info)
 Unknown encoding handler. More...

virtual void xmlDecl (void *userData, const XmlChar *version, const XmlChar *encoding, int standalone)
 XML declaration handler. More...

virtual void startDoctypeDecl (void *userData, const XmlChar *doctypeName, const XmlChar *systemId, const XmlChar *publicId, int hasInternalSubset)
 Start doctype handler. More...

virtual void endDoctypeDecl (void *userData)
 End doctype handler. More...

virtual void entityDecl (void *userData, const XmlChar *entityName, int isParameterEntity, const XmlChar *value, int valueLength, const XmlChar *base, const XmlChar *systemId, const XmlChar *publicId, const XmlChar *notationName)
 Entity declaration handler. More...

virtual void notationDecl (void *userData, const XmlChar *notationName, const XmlChar *base, const XmlChar *systemId, const XmlChar *publicId)
 Notation declaration handler. More...


Protected Attributes

SAXReceptor * saxReceptor
 Pointer to the SAX receptor.

Detailed Description

An emitter of SAX events.

The SAX emitter sends SAX events to registered SAX receptor. For example, if you call the startElement method of the emitter, it calls the startElement method of the receptor.

Definition at line 46 of file saxemitter.h.

Constructor & Destructor Documentation

SAXEmitter::SAXEmitter (  void    ) 
 

A constructor.

Initialization is performed.

Definition at line 64 of file saxemitter.cpp.

References saxReceptor.

SAXEmitter::SAXEmitter (  SAXReceptor *    receptor ) 
 

A constructor.

Initialization is performed. Also, the saxReceptor if set.

Parameters:
receptor  Pointer to the SAX receptor.

Definition at line 76 of file saxemitter.cpp.

References saxReceptor.

Member Function Documentation

void SAXEmitter::characterData (  void *    userData,
const XmlChar *    data,
int    length
)  [virtual]
 

Character data handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.
data  Character data.
length  Length of the data.

Reimplemented from SAXBase.

Definition at line 144 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR, and XmlChar.

void SAXEmitter::comment (  void *    userData,
const XmlChar *    data
)  [virtual]
 

Comment handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.
data  Data of the comment.

Reimplemented from SAXBase.

Definition at line 174 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR, and XmlChar.

void SAXEmitter::defaultHandler (  void *    userData,
const XmlChar *    data,
int    length
)  [virtual]
 

Default handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.
data  The default data.
length  The length of the default data.

Reimplemented from SAXBase.

Definition at line 210 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR, and XmlChar.

void SAXEmitter::endCDATASection (  void *    userData )  [virtual]
 

End CDATA section handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.

Reimplemented from SAXBase.

Definition at line 197 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR.

void SAXEmitter::endDoctypeDecl (  void *    userData )  [virtual]
 

End doctype handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.

Reimplemented from SAXBase.

Definition at line 275 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR.

void SAXEmitter::endElement (  void *    userData,
const XmlChar *    name
)  [virtual]
 

End element handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.
name  Name of the element.

Reimplemented from SAXBase.

Definition at line 127 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR, and XmlChar.

Referenced by ElementModeler::followEdge, and ElementModeler::moveForward.

void SAXEmitter::entityDecl (  void *    userData,
const XmlChar *    entityName,
int    isParameterEntity,
const XmlChar *    value,
int    valueLength,
const XmlChar *    base,
const XmlChar *    systemId,
const XmlChar *    publicId,
const XmlChar *    notationName
)  [virtual]
 

Entity declaration handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.
entityName  The name of the entity.
isParameterEntity  Is the entity a parameter entity?
value  The value of the entity.
valueLength  The length of the value.
base  The base.
systemId  The system id.
publicId  The public id.
notationName  The name of the notation.

Reimplemented from SAXBase.

Definition at line 294 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR, and XmlChar.

void SAXEmitter::notationDecl (  void *    userData,
const XmlChar *    notationName,
const XmlChar *    base,
const XmlChar *    systemId,
const XmlChar *    publicId
)  [virtual]
 

Notation declaration handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.
notationName  The name of the notation.
base  The base.
systemId  The system id.
publicId  The public id.

Reimplemented from SAXBase.

Definition at line 318 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR, and XmlChar.

void SAXEmitter::processingInstruction (  void *    userData,
const XmlChar *    target,
const XmlChar *    data
)  [virtual]
 

Processing instruction handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.
target  Target of the instruction.
data  Data of the instruction.

Reimplemented from SAXBase.

Definition at line 160 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR, and XmlChar.

void SAXEmitter::reportError (  void    )  [virtual]
 

Report parser error messages.

Used for reporting error messages generated by Expat.

Reimplemented from SAXBase.

Definition at line 100 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR.

void SAXEmitter::setSAXReceptor (  SAXReceptor *    receptor )  [virtual]
 

Set SAX receptor.

Sets the SAX receptor.

Parameters:
receptor  Pointer to the SAX receptor.

Definition at line 88 of file saxemitter.cpp.

References saxReceptor.

void SAXEmitter::startCDATASection (  void *    userData )  [virtual]
 

Start CDATA section handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.

Reimplemented from SAXBase.

Definition at line 186 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR.

void SAXEmitter::startDoctypeDecl (  void *    userData,
const XmlChar *    doctypeName,
const XmlChar *    systemId,
const XmlChar *    publicId,
int    hasInternalSubset
)  [virtual]
 

Start doctype handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.
doctypeName  The name of the doctype.
systemId  The system id.
publicId  The public id.
hasInternalSubset  Has the DTD an internal subset?

Reimplemented from SAXBase.

Definition at line 259 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR, and XmlChar.

void SAXEmitter::startElement (  void *    userData,
const XmlChar *    name,
const XmlChar **    attr
)  [virtual]
 

Start element handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.
name  Name of the element.
attr  An array of attributes

Reimplemented from SAXBase.

Definition at line 114 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR, and XmlChar.

int SAXEmitter::unknownEncoding (  void *    unknownEncodingData,
const XmlChar *    name,
XML_Encoding *    info
)  [virtual]
 

Unknown encoding handler.

Calls the corresponding method of the SAX receptor.

Parameters:
unknownEncodingData  The data structure describing the unknown encoding.
name  The name of the encoding.
info  The information about the encoding.

Reimplemented from SAXBase.

Definition at line 225 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR_RETURN, and XmlChar.

void SAXEmitter::xmlDecl (  void *    userData,
const XmlChar *    version,
const XmlChar *    encoding,
int    standalone
)  [virtual]
 

XML declaration handler.

Calls the corresponding method of the SAX receptor.

Parameters:
userData  Pointer to the user data structure.
version  The XML version string.
encoding  The encoding of the XML document.
standalone  Is the document standalone?.

Reimplemented from SAXBase.

Definition at line 241 of file saxemitter.cpp.

References SAFE_CALL_RECEPTOR, and XmlChar.

The documentation for this class was generated from the following files:
Generated on Wed Feb 5 10:43:06 2003 for Exalt by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002