QXmlDeclHandler(3qt)

NAME
QXmlDeclHandler - Interface to report declaration content of XML data

SYNOPSIS
All the functions in this class are reentrant when Qt is built with thread support.</p>

#include <qxml.h>

Inherited by QXmlDefaultHandler.

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

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 the Introduction to SAX2.

See also QXmlDTDHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, QXmlLexicalHandler, and XML.

MEMBER FUNCTION DOCUMENTATION

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 QString::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 QString::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.

QString QXmlDeclHandler::errorString () [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 QString::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 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.

SEE ALSO
http://doc.trolltech.com/qxmldeclhandler.html http://www.trolltech.com/faq/tech.html

COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

AUTHOR
Generated automatically from the source code.

BUGS
If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you.

The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech.

If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qxmldeclhandler.3) and the Qt version (3.3.8).