CopperSpice API  1.7.2
QXmlReader Class Referenceabstract

The QXmlReader class provides an interface for XML readers. More...

Inheritance diagram for QXmlReader:
QXmlSimpleReader

Public Methods

virtual ~QXmlReader ()
 
virtual QXmlContentHandlercontentHandler () const = 0
 
virtual QXmlDeclHandlerdeclHandler () const = 0
 
virtual QXmlDTDHandlerDTDHandler () const = 0
 
virtual QXmlEntityResolverentityResolver () const = 0
 
virtual QXmlErrorHandlererrorHandler () const = 0
 
virtual bool feature (const QString &name, bool *ok=nullptr) const = 0
 
virtual bool hasFeature (const QString &name) const = 0
 
virtual bool hasProperty (const QString &name) const = 0
 
virtual QXmlLexicalHandlerlexicalHandler () const = 0
 
virtual bool parse (const QXmlInputSource &input) = 0
 
virtual bool parse (const QXmlInputSource *input) = 0
 
virtual void * property (const QString &name, bool *ok=nullptr) const = 0
 
virtual void setContentHandler (QXmlContentHandler *handler) = 0
 
virtual void setDeclHandler (QXmlDeclHandler *handler) = 0
 
virtual void setDTDHandler (QXmlDTDHandler *handler) = 0
 
virtual void setEntityResolver (QXmlEntityResolver *handler) = 0
 
virtual void setErrorHandler (QXmlErrorHandler *handler) = 0
 
virtual void setFeature (const QString &name, bool value) = 0
 
virtual void setLexicalHandler (QXmlLexicalHandler *handler) = 0
 
virtual void setProperty (const QString &name, void *value) = 0
 

Detailed Description

The QXmlReader class provides an interface for XML readers.

This abstract class provides an interface for all of the CopperSpice XML readers. Currently there is only one implementation of a reader included in the CopperSpice XML library, QXmlSimpleReader. In future releases there might be more readers with different properties available (e.g. a validating parser).

The design of the XML classes follows the SAX2 Java interface, with the names adapted to fit CopperSpice naming conventions. It should be very easy for anybody who has worked with SAX2 to get started with the CopperSpice XML classes.

All readers use the class QXmlInputSource to read the input document. Since you are normally interested in particular content in the XML document, the reader reports the content through special handler classes (QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler and QXmlLexicalHandler), which you must subclass, if you want to process the contents.

Since the handler classes only describe interfaces you must implement all the functions. We provide the QXmlDefaultHandler class to make this easier: it implements a default behavior (do nothing) for all functions, so you can subclass it and just implement the functions you are interested in.

Features and properties of the reader can be set with setFeature() and setProperty() respectively. You can set the reader to use your own subclasses with setEntityResolver(), setDTDHandler(), setContentHandler(), setErrorHandler(), setLexicalHandler() and setDeclHandler(). The parse itself is started with a call to parse().

See also
QXmlSimpleReader

Constructor & Destructor Documentation

QXmlReader::~QXmlReader ( )
inlinevirtual

Destroys the reader.

Method Documentation

QXmlContentHandler * QXmlReader::contentHandler ( ) const
pure virtual

Returns the content handler or 0 if none was set.

See also
setContentHandler()

Implemented in QXmlSimpleReader.

QXmlDeclHandler * QXmlReader::declHandler ( ) const
pure virtual

Returns the declaration handler or 0 if none was set.

See also
setDeclHandler()

Implemented in QXmlSimpleReader.

QXmlDTDHandler * QXmlReader::DTDHandler ( ) const
pure virtual

Returns the DTD handler or 0 if none was set.

See also
setDTDHandler()

Implemented in QXmlSimpleReader.

QXmlEntityResolver * QXmlReader::entityResolver ( ) const
pure virtual

Returns the entity resolver or 0 if none was set.

See also
setEntityResolver()

Implemented in QXmlSimpleReader.

QXmlErrorHandler * QXmlReader::errorHandler ( ) const
pure virtual

Returns the error handler or 0 if none is set.

See also
setErrorHandler()

Implemented in QXmlSimpleReader.

bool QXmlReader::feature ( const QString name,
bool *  ok = nullptr 
) const
pure virtual

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.

See also
setFeature(), hasFeature()

Implemented in QXmlSimpleReader.

bool QXmlReader::hasFeature ( const QString name) const
pure virtual

Returns true if the reader has the feature called name, otherwise returns false.

See also
feature(), setFeature()

Implemented in QXmlSimpleReader.

bool QXmlReader::hasProperty ( const QString name) const
pure virtual

Returns true if the reader has the property name, otherwise returns false.

See also
property(), setProperty()

Implemented in QXmlSimpleReader.

QXmlLexicalHandler * QXmlReader::lexicalHandler ( ) const
pure virtual

Returns the lexical handler or 0 if none was set.

See also
setLexicalHandler()

Implemented in QXmlSimpleReader.

bool QXmlReader::parse ( const QXmlInputSource input)
deprecatedpure virtual
Deprecated:
Parses the given input.

Implemented in QXmlSimpleReader.

bool QXmlReader::parse ( const QXmlInputSource input)
pure virtual

Reads an XML document from input and parses it. Returns true if the parsing was successful, otherwise returns false.

Implemented in QXmlSimpleReader.

void * QXmlReader::property ( const QString name,
bool *  ok = nullptr 
) const
pure virtual

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(), hasProperty()

Implemented in QXmlSimpleReader.

void QXmlReader::setContentHandler ( QXmlContentHandler handler)
pure virtual

Sets the content handler to handler.

See also
contentHandler()

Implemented in QXmlSimpleReader.

void QXmlReader::setDeclHandler ( QXmlDeclHandler handler)
pure virtual

Sets the declaration handler to handler.

See also
declHandler()

Implemented in QXmlSimpleReader.

void QXmlReader::setDTDHandler ( QXmlDTDHandler handler)
pure virtual

Sets the DTD handler to handler.

See also
DTDHandler()

Implemented in QXmlSimpleReader.

void QXmlReader::setEntityResolver ( QXmlEntityResolver handler)
pure virtual

Sets the entity resolver to handler.

See also
entityResolver()

Implemented in QXmlSimpleReader.

void QXmlReader::setErrorHandler ( QXmlErrorHandler handler)
pure virtual

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

See also
errorHandler()

Implemented in QXmlSimpleReader.

void QXmlReader::setFeature ( const QString name,
bool  value 
)
pure virtual

Sets the feature called name to the given value. If the reader does not have the feature nothing happens.

See also
feature(), hasFeature()

Implemented in QXmlSimpleReader.

void QXmlReader::setLexicalHandler ( QXmlLexicalHandler handler)
pure virtual

Sets the lexical handler to handler.

See also
lexicalHandler()

Implemented in QXmlSimpleReader.

void QXmlReader::setProperty ( const QString name,
void *  value 
)
pure virtual

Sets the property name to value. If the reader does not have the property nothing happens.

See also
property(), hasProperty()

Implemented in QXmlSimpleReader.