Home

QtLibxmlReader Class Reference

The QtLibxmlReader class is a SAX2 parser based on libxml2, with a QXmlReader interface. More...

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

#include <qtlibxmlreader.h>

List of all member functions.

Public Members

QtLibxmlReader ()
virtual ~QtLibxmlReader ()
bool feature ( const QString & name, bool * ok = 0 ) const
void setFeature ( const QString & name, bool value )
bool hasFeature ( const QString & name ) const
void * property ( const QString & name, bool * ok = 0 ) const
void setProperty ( const QString & name, void * value )
bool hasProperty ( const QString & name ) const
void setEntityResolver ( QXmlEntityResolver * )
QXmlEntityResolver * entityResolver () const
void setDTDHandler ( QXmlDTDHandler * handler )
QXmlDTDHandler * DTDHandler () const
void setContentHandler ( QXmlContentHandler * handler )
QXmlContentHandler * contentHandler () const
void setErrorHandler ( QXmlErrorHandler * handler )
QXmlErrorHandler * errorHandler () const
void setLexicalHandler ( QXmlLexicalHandler * handler )
QXmlLexicalHandler * lexicalHandler () const
void setDeclHandler ( QXmlDeclHandler * handler )
QXmlDeclHandler * declHandler () const
bool parse ( const QXmlInputSource & input ) (obsolete)
bool parse ( const QXmlInputSource * input ) (obsolete)
bool parse ( const QXmlInputSource * in, bool incremental )
bool parse ( const QString & uri )
virtual bool parseContinue ()

Detailed Description

The QtLibxmlReader class is a SAX2 parser based on libxml2, with a QXmlReader interface.

QtLibxmlReader is a SAX2 parser. Like QXmlSimpleReader, it inherits QXmlReader and therefore Qt's SAX API. Unlike QXmlSimpleReader, QtLibxmlReader uses libxml2 to do the actual parsing.

For an overview of differences between QtLibxmlReader and QXmlSimpleReader, see the overview.

For more information on Qt's SAX2 interface, see the documentation for QXmlReader and QtXmlSimpleReader.

Member Function Documentation

QtLibxmlReader::QtLibxmlReader ()

Constructs a QtLibxmlReader object.

QtLibxmlReader::~QtLibxmlReader () `[virtual]`

Destroys a QtLibxmlReader object.

QXmlDTDHandler * QtLibxmlReader::DTDHandler () const

Returns the DTD handler or 0 if none was set.

QXmlContentHandler * QtLibxmlReader::contentHandler () const

Returns the content handler or 0 if none was set.

QXmlDeclHandler * QtLibxmlReader::declHandler () const

Returns the declaration handler or 0 if none was set.

QXmlEntityResolver * QtLibxmlReader::entityResolver () const

Returns 0. QXmlEntityResolver is not supported.

Instead, if the NOENT feature is set, libxml2 loads external entities from the local filesystem, or from the network via HTTP or FTP. If the NOENT feature is not set, reports all entity references with QContentHandler::skippedEntity().

QXmlErrorHandler * QtLibxmlReader::errorHandler () const

Returns the error handler or 0 if none is set.

bool QtLibxmlReader::feature ( const QString & name, bool * ok = 0 ) const

If the reader has the feature called name, the feature's value is returned. If no such feature exists the return value is undefined.

If ok is not 0: *ok is set to TRUE if the reader has the feature called name; otherwise *ok is set to FALSE.

bool QtLibxmlReader::hasFeature ( const QString & name ) const

Returns TRUE if the reader has the feature called name; otherwise returns FALSE.

bool QtLibxmlReader::hasProperty ( const QString & name ) const

Returns TRUE if the reader has the property name; otherwise returns FALSE.

QXmlLexicalHandler * QtLibxmlReader::lexicalHandler () const

Returns the lexical handler or 0 if none was set.

bool QtLibxmlReader::parse ( const QXmlInputSource * in, bool incremental )

Reads an XML document from in and parses it. Returns FALSE if the parsing detects an error; otherwise returns TRUE.

Incremental parsing is not supported. If incremental is TRUE, prints a warning message and returns FALSE.

bool QtLibxmlReader::parse ( const QXmlInputSource & input )

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.

bool QtLibxmlReader::parse ( const QXmlInputSource * input )

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.

bool QtLibxmlReader::parse ( const QString & uri )

Reads an XML document from uri and parses it. uri may be a file name, or a HTTP or FTP url. Returns FALSE if the parsing detects an error; otherwise returns TRUE.

This function does not use QXmlInputSource. Instead, uri is passed directly to libxml2. This has several advantages:

QXmlInputSource reads the whole document into memory. This function, on the other hand, parses the document in chunks.
QXmlInputSource converts the document to UTF-16, which is then converted to UTF-8 by libxml2. This function converts directly from the document's encoding to UTF-8.

bool QtLibxmlReader::parseContinue () `[virtual]`

Prints a warning message and returns FALSE. Incremental parsing is not supported.

void * QtLibxmlReader::property ( const QString & name, bool * ok = 0 ) const

If the reader has the property name, this function returns the value of the property; otherwise the return value is undefined.

If ok is not 0: if the reader has the name property *ok is set to TRUE; otherwise *ok is set to FALSE.

See also setProperty() and hasProperty().

void QtLibxmlReader::setContentHandler ( QXmlContentHandler * handler )

Sets the content handler to handler.

void QtLibxmlReader::setDTDHandler ( QXmlDTDHandler * handler )

Sets the DTD handler to handler.

void QtLibxmlReader::setDeclHandler ( QXmlDeclHandler * handler )

Sets the declaration handler to handler.

void QtLibxmlReader::setEntityResolver ( QXmlEntityResolver * )

Does nothing. QXmlEntityResolver is not supported.

void QtLibxmlReader::setErrorHandler ( QXmlErrorHandler * handler )

Sets the error handler to handler. Clears the error handler if handler is 0.

void QtLibxmlReader::setFeature ( const QString & name, bool value )

Sets the state of the feature name to value:

If the feature is not recognized, it is ignored.

The following features are supported:

Feature Notes

http://trolltech.com/xml/features/LIBXML2_NOENT If this feature is TRUE, QXmlContentHandler::skippedEntity() is not called for external entity references. Instead, the parser replaces them with their replacement text. QtLibxmlReader can load external entities from the local filesystem, or from the network via HTTP or FTP. If this feature is FALSE (the default), all external entity references are reported with QXmlContentHandler::skippedEntity(). In either case, internal entities are replaced and undefined entities are reported with QXmlErrorHandler::error().

http://trolltech.com/xml/features/LIBXML2_RECOVER If this feature is TRUE, the parser continues parsing after QXmlErrorHandler::error(). If this feature is FALSE (the default), the parser stops after QXmlErrorHandler::error().

Feature	Notes
http://trolltech.com/xml/features/LIBXML2_NOENT	If this feature is `TRUE`, `QXmlContentHandler::skippedEntity()` is not called for external entity references. Instead, the parser replaces them with their replacement text. `QtLibxmlReader` can load external entities from the local filesystem, or from the network via HTTP or FTP. If this feature is `FALSE` (the default), all external entity references are reported with `QXmlContentHandler::skippedEntity()`. In either case, internal entities are replaced and undefined entities are reported with `QXmlErrorHandler::error()`.
http://trolltech.com/xml/features/LIBXML2_RECOVER	If this feature is `TRUE`, the parser continues parsing after `QXmlErrorHandler::error()`. If this feature is `FALSE` (the default), the parser stops after `QXmlErrorHandler::error()`.

void QtLibxmlReader::setLexicalHandler ( QXmlLexicalHandler * handler )

Sets the lexical handler to handler.

void QtLibxmlReader::setProperty ( const QString & name, void * value )

Sets the property name to value. If the reader doesn't have the property nothing happens.