Qt Toolkit - QXmlLexicalHandler Class

| Classes - Annotated - Tree - Functions - Home - Structure

# QXmlLexicalHandler Class Reference
[ XML module ]

The QXmlLexicalHandler class provides an interface to report lexical content of XML data. More...

`#include <qxml.h>`

Inherited by QXmlDefaultHandler.

List of all member functions.

## Public Members

- virtual bool startDTD ( const QString & name, const QString & publicId, const QString & systemId )
- virtual bool endDTD ()
- virtual bool startCDATA ()
- virtual bool endCDATA ()
- virtual bool comment ( const QString & ch )
- virtual QString errorString ()

## Detailed Description

The QXmlLexicalHandler class provides an interface to report lexical content of XML data.

The events in the lexical handler apply to the entire document, not just to the document element, and all lexical handler events appear between the content handler's startDocument and endDocument events.

You can set the lexical handler with QXmlReader::setLexicalHandler().

This interface is designed after the SAX2 extension LexicalHandler. The functions startEntity() and endEntity() are not included though.

See also the Introduction to SAX2.

See also QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver and QXmlErrorHandler.

## Member Function Documentation

### bool QXmlLexicalHandler::comment ( const QString & ch ) `[virtual]`

The reader calls this function to report an XML comment anywhere in the document.

If this function returns FALSE the reader will stop parsing and will report an error. The reader will use the function errorString() to get the error message that will be used for reporting the error.

Reimplemented in QXmlDefaultHandler.

### bool QXmlLexicalHandler::endCDATA () `[virtual]`

The reader calls this function to report the end of a CDATA section.

If this function returns FALSE the reader will stop parsing and will report an error. The reader will use the function errorString() to get the error message that will be used for reporting the error.

See also startCDATA().

Reimplemented in QXmlDefaultHandler.

### bool QXmlLexicalHandler::endDTD () `[virtual]`

The reader calls this function to report the end of a DTD declaration, if any.

If this function returns FALSE the reader will stop parsing and will report an error. The reader will use the function errorString() to get the error message that will be used for reporting the error.

See also startDTD().

Reimplemented in QXmlDefaultHandler.

### QString QXmlLexicalHandler::errorString () `[virtual]`

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

### bool QXmlLexicalHandler::startCDATA () `[virtual]`

The reader calls this function to report the start of a CDATA section. The content of the CDATA section will be reported through the regular QXmlContentHandler::characters(). This function is intended only to report the boundary.

If this function returns FALSE the reader will stop parsing and will report an error. The reader will use the function errorString() to get the error message that will be used for reporting the error.

See also endCDATA().

Reimplemented in QXmlDefaultHandler.

### bool QXmlLexicalHandler::startDTD ( const QString & name, const QString & publicId, const QString & systemId ) `[virtual]`

The reader calls this function to report the start of a DTD declaration, if any.

All declarations reported through QXmlDTDHandler or QXmlDeclHandler appear between the startDTD() and endDTD() calls.

If this function returns FALSE the reader will stop parsing and will report an error. The reader will use the function errorString() to get the error message that will be used for reporting the error.

See also endDTD().

Reimplemented in QXmlDefaultHandler.

Search the documentation, FAQ, qt-interest archive and more (uses www.trolltech.com):

This file is part of the Qt toolkit, copyright © 1995-2000 Trolltech, all rights reserved.