Qt Documentation

Qt 5.9
Qt XML
C++ Classes
QXmlDefaultHandler

QXmlDefaultHandler Class

The QXmlDefaultHandler class provides a default implementation of all the XML handler classes. More...

Header:	#include <QXmlDefaultHandler>
qmake:	QT += xml
Inherits:	QXmlContentHandler, QXmlErrorHandler, QXmlDTDHandler, QXmlEntityResolver, QXmlLexicalHandler, and QXmlDeclHandler

List of all members, including inherited members

Note: All functions in this class are reentrant.

Public Functions

	QXmlDefaultHandler()
virtual	~QXmlDefaultHandler()

Reimplemented Public Functions

virtual bool	attributeDecl(const QString &eName, const QString &aName, const QString &type, const QString &valueDefault, const QString &value)
virtual bool	characters(const QString &ch)
virtual bool	comment(const QString &ch)
virtual bool	endCDATA()
virtual bool	endDTD()
virtual bool	endDocument()
virtual bool	endElement(const QString &namespaceURI, const QString &localName, const QString &qName)
virtual bool	endEntity(const QString &name)
virtual bool	endPrefixMapping(const QString &prefix)
virtual bool	error(const QXmlParseException &exception)
virtual QString	errorString() const
virtual bool	externalEntityDecl(const QString &name, const QString &publicId, const QString &systemId)
virtual bool	fatalError(const QXmlParseException &exception)
virtual bool	ignorableWhitespace(const QString &ch)
virtual bool	internalEntityDecl(const QString &name, const QString &value)
virtual bool	notationDecl(const QString &name, const QString &publicId, const QString &systemId)
virtual bool	processingInstruction(const QString &target, const QString &data)
virtual bool	resolveEntity(const QString &publicId, const QString &systemId, QXmlInputSource &ret*)
virtual void	setDocumentLocator(QXmlLocator *locator)
virtual bool	skippedEntity(const QString &name)
virtual bool	startCDATA()
virtual bool	startDTD(const QString &name, const QString &publicId, const QString &systemId)
virtual bool	startDocument()
virtual bool	startElement(const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts)
virtual bool	startEntity(const QString &name)
virtual bool	startPrefixMapping(const QString &prefix, const QString &uri)
virtual bool	unparsedEntityDecl(const QString &name, const QString &publicId, const QString &systemId, const QString &notationName)
virtual bool	warning(const QXmlParseException &exception)

12 public functions inherited from QXmlContentHandler
4 public functions inherited from QXmlErrorHandler
3 public functions inherited from QXmlDTDHandler
2 public functions inherited from QXmlEntityResolver
8 public functions inherited from QXmlLexicalHandler
4 public functions inherited from QXmlDeclHandler

Detailed Description

The QXmlDefaultHandler class provides a default implementation of all the XML handler classes.

This class gathers together the features of the specialized handler classes, making it a convenient starting point when implementing custom handlers for subclasses of QXmlReader, particularly QXmlSimpleReader. The virtual functions from each of the base classes are reimplemented in this class, providing sensible default behavior for many common cases. By subclassing this class, and overriding these functions, you can concentrate on implementing the parts of the handler relevant to your application.

The XML reader must be told which handler to use for different kinds of events during parsing. This means that, although QXmlDefaultHandler provides default implementations of functions inherited from all its base classes, we can still use specialized handlers for particular kinds of events.

For example, QXmlDefaultHandler subclasses both QXmlContentHandler and QXmlErrorHandler, so by subclassing it we can use the same handler for both of the following reader functions:

    xmlReader.setContentHandler(handler);
    xmlReader.setErrorHandler(handler);

Since the reader will inform the handler of parsing errors, it is necessary to reimplement QXmlErrorHandler::fatalError() if, for example, we want to stop parsing when such an error occurs:

bool Handler::fatalError (const QXmlParseException & exception)
{
    qWarning() << "Fatal error on line" << exception.lineNumber()
               << ", column" << exception.columnNumber() << ':'
               << exception.message();

    return false;
}

The above function returns false, which tells the reader to stop parsing. To continue to use the same reader, it is necessary to create a new handler instance, and set up the reader to use it in the manner described above.

It is useful to examine some of the functions inherited by QXmlDefaultHandler, and consider why they might be reimplemented in a custom handler. Custom handlers will typically reimplement QXmlContentHandler::startDocument() to prepare the handler for new content. Document elements and the text within them can be processed by reimplementing QXmlContentHandler::startElement(), QXmlContentHandler::endElement(), and QXmlContentHandler::characters(). You may want to reimplement QXmlContentHandler::endDocument() to perform some finalization or validation on the content once the document has been read completely.

Member Function Documentation

QXmlDefaultHandler::QXmlDefaultHandler()

Constructs a handler for use with subclasses of QXmlReader.