Qt Toolkit - QXmlReader Class

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

# QXmlReader Class Reference
[ XML module ]

The QXmlReader class provides an interface for XML readers (i.e. parsers). More...

`#include <qxml.h>`

Inherited by QXmlSimpleReader.

List of all member functions.

## Public Members

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

## Detailed Description

The QXmlReader class provides an interface for XML readers (i.e. parsers).

This abstract class describes an interface for all XML readers in Qt. At the moment there is only one implementation of a reader included in the XML module of Qt (QXmlSimpleReader). In future releases there might be more readers with different properties available (e.g. a validating parser).

The design of the XML classes follow the SAX2 java interface. It was adopted to fit into the Qt naming conventions; so it should be very easy for anybody who has worked with SAX2 to get started with the Qt XML classes.

All readers use the class QXmlInputSource to read the input document from. Since you are normally interested in certain contents of the XML document, the reader reports those contents through special handler classes (QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler and QXmlLexicalHandler).

You have to subclass these classes. Since the handler classes describe only interfaces you must implement all functions; there is a class (QXmlDefaultHandler) to make this easier; it implements a default behaviour (do nothing) for all functions.

For getting started see also the "Quick start".

See also QXmlSimpleReader.

## Member Function Documentation

### QXmlDTDHandler* QXmlReader::DTDHandler () const `[virtual]`

Returns the DTD handler or 0 if none was set.

See also setDTDHandler().

Reimplemented in QXmlSimpleReader.

### QXmlContentHandler* QXmlReader::contentHandler () const `[virtual]`

Returns the content handler or 0 if none was set.

See also setContentHandler().

Reimplemented in QXmlSimpleReader.

### QXmlDeclHandler* QXmlReader::declHandler () const `[virtual]`

Returns the declaration handler or 0 if none was set.

See also setDeclHandler().

Reimplemented in QXmlSimpleReader.

### QXmlEntityResolver* QXmlReader::entityResolver () const `[virtual]`

Returns the entity resolver or 0 if none was set.

See also setEntityResolver().

Reimplemented in QXmlSimpleReader.

### QXmlErrorHandler* QXmlReader::errorHandler () const `[virtual]`

Returns the error handler or 0 if none was set

See also setErrorHandler().

Reimplemented in QXmlSimpleReader.

### bool QXmlReader::feature ( const QString & name, bool * ok = 0 ) const `[virtual]`

If the reader has the feature name, this function returns the value of the feature.

If the reader has not the feature name, the return value may be anything.

If ok is not 0, then ok is set to TRUE if the reader has the feature name, otherwise ok is set to FALSE.

See also setFeature() and hasFeature().

Reimplemented in QXmlSimpleReader.

### bool QXmlReader::hasFeature ( const QString & name ) const `[virtual]`

Returns `TRUE` if the reader has the feature name, otherwise FALSE.

See also feature() and setFeature().

Reimplemented in QXmlSimpleReader.

### bool QXmlReader::hasProperty ( const QString & name ) const `[virtual]`

Returns TRUE if the reader has the property name, otherwise FALSE.

See also property() and setProperty().

Reimplemented in QXmlSimpleReader.

### QXmlLexicalHandler* QXmlReader::lexicalHandler () const `[virtual]`

Returns the lexical handler or 0 if none was set.

See also setLexicalHandler().

Reimplemented in QXmlSimpleReader.

### bool QXmlReader::parse ( const QXmlInputSource & input ) `[virtual]`

Parses the XML document input. Returns TRUE if the parsing was successful, otherwise FALSE.

Reimplemented in QXmlSimpleReader.

### void* QXmlReader::property ( const QString & name, bool * ok = 0 ) const `[virtual]`

If the reader has the property name, this function returns the value of the property.

If the reader has not the property name, the return value is 0.

If ok is not 0, then ok is set to TRUE if the reader has the property name, otherwise ok is set to FALSE.

See also setProperty() and hasProperty().

Reimplemented in QXmlSimpleReader.

### void QXmlReader::setContentHandler ( QXmlContentHandler * handler ) `[virtual]`

Sets the content handler to handler.

See also contentHandler().

Reimplemented in QXmlSimpleReader.

### void QXmlReader::setDTDHandler ( QXmlDTDHandler * handler ) `[virtual]`

Sets the DTD handler to handler.

See also DTDHandler().

Reimplemented in QXmlSimpleReader.

### void QXmlReader::setDeclHandler ( QXmlDeclHandler * handler ) `[virtual]`

Sets the declaration handler to handler.

See also declHandler().

Reimplemented in QXmlSimpleReader.

### void QXmlReader::setEntityResolver ( QXmlEntityResolver * handler ) `[virtual]`

Sets the entity resolver to handler.

See also entityResolver().

Reimplemented in QXmlSimpleReader.

### void QXmlReader::setErrorHandler ( QXmlErrorHandler * handler ) `[virtual]`

Sets the error handler to handler.

See also errorHandler().

Reimplemented in QXmlSimpleReader.

### void QXmlReader::setFeature ( const QString & name, bool value ) `[virtual]`

Sets the feature name to value. If the reader has not the feature name, this value is ignored.

See also feature() and hasFeature().

Reimplemented in QXmlSimpleReader.

### void QXmlReader::setLexicalHandler ( QXmlLexicalHandler * handler ) `[virtual]`

Sets the lexical handler to handler.

See also lexicalHandler().

Reimplemented in QXmlSimpleReader.

### void QXmlReader::setProperty ( const QString & name, void * value ) `[virtual]`

Sets the property name to value. If the reader has not the property name, this value is ignored.

See also property() and hasProperty().

Reimplemented in QXmlSimpleReader.

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.