Home · All Classes · Modules

QXmlDeclHandler Class Reference
^{^{[QtXml module]}}

The QXmlDeclHandler class provides an interface to report declaration content of XML data. More...

Inherited by QXmlDefaultHandler.

Methods

__init__ (self)
__init__ (self, QXmlDeclHandler)
bool attributeDecl (self, QString eName, QString aName, QString type, QString valueDefault, QString value)
QString errorString (self)
bool externalEntityDecl (self, QString name, QString publicId, QString systemId)
bool internalEntityDecl (self, QString name, QString value)

Detailed Description

The QXmlDeclHandler class provides an interface to report declaration content of XML data.

You can set the declaration handler with QXmlReader.setDeclHandler().

This interface is based on the SAX2 extension DeclHandler.

The interface provides attributeDecl(), internalEntityDecl() and externalEntityDecl() functions.

Method Documentation

QXmlDeclHandler.init (self)

QXmlDeclHandler.init (self, QXmlDeclHandler)

bool QXmlDeclHandler.attributeDecl (self, QString eName, QString aName, QString type, QString valueDefault, QString value)

This method is abstract and should be reimplemented in any sub-class.

The reader calls this function to report an attribute type declaration. Only the effective (first) declaration for an attribute is reported.

The reader passes the name of the associated element in eName and the name of the attribute in aName. It passes a string that represents the attribute type in type and a string that represents the attribute default in valueDefault. This string is one of "#IMPLIED", "#REQUIRED", "#FIXED" or an empty string (if none of the others applies). The reader passes the attribute's default value in value. If no default value is specified in the XML file, value is an empty string.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

QString QXmlDeclHandler.errorString (self)

This method is abstract and should be reimplemented in any sub-class.

The reader calls this function to get an error string if any of the handler functions returns false.

bool QXmlDeclHandler.externalEntityDecl (self, QString name, QString publicId, QString systemId)

This method is abstract and should be reimplemented in any sub-class.

The reader calls this function to report a parsed external entity declaration. Only the effective (first) declaration for each entity is reported.

The reader passes the name of the entity in name, the public identifier in publicId and the system identifier in systemId. If there is no public identifier specified, it passes an empty string in publicId.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.