Qt 4.7: QXmlDeclHandler Class Reference

Qt Reference Documentation

# QXmlDeclHandler Class Reference

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

     #include <QXmlDeclHandler>

Inherited by: QXmlDefaultHandler.

Note: All functions in this class are reentrant.

- List of all members, including inherited members

## Public Functions

virtual | ~QXmlDeclHandler ()
virtual bool | attributeDecl ( const QString & eName, const QString & aName, const QString & type, const QString & valueDefault, const QString & value ) = 0
virtual QString | errorString () const = 0
virtual bool | externalEntityDecl ( const QString & name, const QString & publicId, const QString & systemId ) = 0
virtual bool | internalEntityDecl ( const QString & name, const QString & value ) = 0

## 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.

See also QXmlDTDHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, QXmlLexicalHandler, and Introduction to SAX2.

## Member Function Documentation

### QXmlDeclHandler::~QXmlDeclHandler ()`[virtual]`

Destroys the declaration handler.

### bool QXmlDeclHandler::attributeDecl ( const QString & eName, const QString & aName, const QString & type, const QString & valueDefault, const QString & value )`[pure virtual]`

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 () const`[pure virtual]`

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

### bool QXmlDeclHandler::externalEntityDecl ( const QString & name, const QString & publicId, const QString & systemId )`[pure virtual]`

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.

### bool QXmlDeclHandler::internalEntityDecl ( const QString & name, const QString & value )`[pure virtual]`

The reader calls this function to report an internal entity declaration. Only the effective (first) declaration is reported.

The reader passes the name of the entity in name and the value of the entity in value.

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