Home · All Classes · Modules

QXmlDefaultHandler Class Reference
[QtXml module]

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

Inherits QXmlContentHandler, QXmlErrorHandler, QXmlDTDHandler, QXmlEntityResolver, QXmlLexicalHandler and QXmlDeclHandler.

Methods

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.

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

Method Documentation

QXmlDefaultHandler.__init__ (self)

Constructs a handler for use with subclasses of QXmlReader.

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

bool QXmlDefaultHandler.characters (self, QString ch)

bool QXmlDefaultHandler.comment (self, QString ch)

bool QXmlDefaultHandler.endCDATA (self)

bool QXmlDefaultHandler.endDocument (self)

bool QXmlDefaultHandler.endDTD (self)

bool QXmlDefaultHandler.endElement (self, QString namespaceURI, QString localName, QString qName)

bool QXmlDefaultHandler.endEntity (self, QString name)

bool QXmlDefaultHandler.endPrefixMapping (self, QString prefix)

bool QXmlDefaultHandler.error (self, QXmlParseException exception)

QString QXmlDefaultHandler.errorString (self)

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

bool QXmlDefaultHandler.fatalError (self, QXmlParseException exception)

bool QXmlDefaultHandler.ignorableWhitespace (self, QString ch)

bool QXmlDefaultHandler.internalEntityDecl (self, QString name, QString value)

bool QXmlDefaultHandler.notationDecl (self, QString name, QString publicId, QString systemId)

bool QXmlDefaultHandler.processingInstruction (self, QString target, QString data)

(bool, QXmlInputSource ret) QXmlDefaultHandler.resolveEntity (self, QString publicId, QString systemId)

QXmlDefaultHandler.setDocumentLocator (self, QXmlLocator locator)

bool QXmlDefaultHandler.skippedEntity (self, QString name)

bool QXmlDefaultHandler.startCDATA (self)

bool QXmlDefaultHandler.startDocument (self)

bool QXmlDefaultHandler.startDTD (self, QString name, QString publicId, QString systemId)

bool QXmlDefaultHandler.startElement (self, QString namespaceURI, QString localName, QString qName, QXmlAttributes atts)

bool QXmlDefaultHandler.startEntity (self, QString name)

bool QXmlDefaultHandler.startPrefixMapping (self, QString prefix, QString uri)

bool QXmlDefaultHandler.unparsedEntityDecl (self, QString name, QString publicId, QString systemId, QString notationName)

bool QXmlDefaultHandler.warning (self, QXmlParseException exception)

PyQt 4.3.1 for X11Copyright © Riverbank Computing Ltd and Trolltech AS 2007Qt 4.3.0