Table Of Contents

Previous topic

QXmlLocator

Next topic

QXmlSimpleReader

QXmlReader

Inheritance diagram of QXmlReader

Inherited by: QXmlSimpleReader

Detailed Description

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

This abstract class provides an interface for all of Qt’s XML readers. Currently there is only one implementation of a reader included in Qt’s XML module: PySide.QtXml.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 Qt naming conventions. 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 PySide.QtXml.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 ( PySide.QtXml.QXmlDTDHandler , PySide.QtXml.QXmlDeclHandler , PySide.QtXml.QXmlContentHandler , PySide.QtXml.QXmlEntityResolver , PySide.QtXml.QXmlErrorHandler and PySide.QtXml.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 PySide.QtXml.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 PySide.QtXml.QXmlReader.setFeature() and PySide.QtXml.QXmlReader.setProperty() respectively. You can set the reader to use your own subclasses with PySide.QtXml.QXmlReader.setEntityResolver() , PySide.QtXml.QXmlReader.setDTDHandler() , PySide.QtXml.QXmlReader.setContentHandler() , PySide.QtXml.QXmlReader.setErrorHandler() , PySide.QtXml.QXmlReader.setLexicalHandler() and PySide.QtXml.QXmlReader.setDeclHandler() . The parse itself is started with a call to PySide.QtXml.QXmlReader.parse() .

class PySide.QtXml.QXmlReader
PySide.QtXml.QXmlReader.DTDHandler()
Return type:PySide.QtXml.QXmlDTDHandler

Returns the DTD handler or 0 if none was set.

PySide.QtXml.QXmlReader.contentHandler()
Return type:PySide.QtXml.QXmlContentHandler

Returns the content handler or 0 if none was set.

PySide.QtXml.QXmlReader.declHandler()
Return type:PySide.QtXml.QXmlDeclHandler

Returns the declaration handler or 0 if none was set.

PySide.QtXml.QXmlReader.entityResolver()
Return type:PySide.QtXml.QXmlEntityResolver

Returns the entity resolver or 0 if none was set.

PySide.QtXml.QXmlReader.errorHandler()
Return type:PySide.QtXml.QXmlErrorHandler

Returns the error handler or 0 if none is set.

PySide.QtXml.QXmlReader.feature(name)
Parameters:name – unicode
Return type:PySequence

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.

PySide.QtXml.QXmlReader.hasFeature(name)
Parameters:name – unicode
Return type:PySide.QtCore.bool

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

PySide.QtXml.QXmlReader.hasProperty(name)
Parameters:name – unicode
Return type:PySide.QtCore.bool

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

PySide.QtXml.QXmlReader.lexicalHandler()
Return type:PySide.QtXml.QXmlLexicalHandler

Returns the lexical handler or 0 if none was set.

PySide.QtXml.QXmlReader.parse(input)
Parameters:inputPySide.QtXml.QXmlInputSource
Return type:PySide.QtCore.bool

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

PySide.QtXml.QXmlReader.parse(input)
Parameters:inputPySide.QtXml.QXmlInputSource
Return type:PySide.QtCore.bool

Parses the given input .

PySide.QtXml.QXmlReader.property(name)
Parameters:name – unicode
Return type:PySequence

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.

PySide.QtXml.QXmlReader.setContentHandler(handler)
Parameters:handlerPySide.QtXml.QXmlContentHandler

Sets the content handler to handler .

PySide.QtXml.QXmlReader.setDTDHandler(handler)
Parameters:handlerPySide.QtXml.QXmlDTDHandler

Sets the DTD handler to handler .

PySide.QtXml.QXmlReader.setDeclHandler(handler)
Parameters:handlerPySide.QtXml.QXmlDeclHandler

Sets the declaration handler to handler .

PySide.QtXml.QXmlReader.setEntityResolver(handler)
Parameters:handlerPySide.QtXml.QXmlEntityResolver

Sets the entity resolver to handler .

PySide.QtXml.QXmlReader.setErrorHandler(handler)
Parameters:handlerPySide.QtXml.QXmlErrorHandler

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

PySide.QtXml.QXmlReader.setFeature(name, value)
Parameters:
  • name – unicode
  • valuePySide.QtCore.bool

Sets the feature called name to the given value . If the reader doesn’t have the feature nothing happens.

PySide.QtXml.QXmlReader.setLexicalHandler(handler)
Parameters:handlerPySide.QtXml.QXmlLexicalHandler

Sets the lexical handler to handler .

PySide.QtXml.QXmlReader.setProperty(name, value)
Parameters:
  • name – unicode
  • valuevoid

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