TQXmlDeclHandler Class

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# TQXmlDeclHandler Class Reference
[XML module]

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

All the functions in this class are reentrant when TQt is built with thread support.

`#include <ntqxml.h>`

Inherited by TQXmlDefaultHandler.

List of all member functions.

## Public Members

- virtual bool attributeDecl ( const TQString & eName, const TQString & aName, const TQString & type, const TQString & valueDefault, const TQString & value ) = 0
- virtual bool internalEntityDecl ( const TQString & name, const TQString & value ) = 0
- virtual bool externalEntityDecl ( const TQString & name, const TQString & publicId, const TQString & systemId ) = 0
- virtual TQString errorString () = 0

## Detailed Description

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

You can set the declaration handler with TQXmlReader::setDeclHandler().

This interface is based on the SAX2 extension DeclHandler.

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

See also the Introduction to SAX2.

See also TQXmlDTDHandler, TQXmlContentHandler, TQXmlEntityResolver, TQXmlErrorHandler, TQXmlLexicalHandler, and XML.

## Member Function Documentation

### bool TQXmlDeclHandler::attributeDecl ( const TQString & eName, const TQString & aName, const TQString & type, const TQString & valueDefault, const TQString & 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 TQString::null (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 TQString::null.

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

### TQString TQXmlDeclHandler::errorString ()`[pure virtual]`

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

### bool TQXmlDeclHandler::externalEntityDecl ( const TQString & name, const TQString & publicId, const TQString & 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 TQString::null 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 TQXmlDeclHandler::internalEntityDecl ( const TQString & name, const TQString & 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.

This file is part of the TQt toolkit. Copyright © 1995-2007 Trolltech. All Rights Reserved.