QXmlReader

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

Inheritance diagram of PySide2.QtXml.QXmlReader

Inherited by: QXmlSimpleReader

Detailed Description

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: 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 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

class QXmlReader
PySide2.QtXml.QXmlReader.DTDHandler()
Return type

QXmlDTDHandler

Returns the DTD handler or 0 if none was set.

See also

setDTDHandler()

PySide2.QtXml.QXmlReader.contentHandler()
Return type

QXmlContentHandler

Returns the content handler or 0 if none was set.

PySide2.QtXml.QXmlReader.declHandler()
Return type

QXmlDeclHandler

Returns the declaration handler or 0 if none was set.

See also

setDeclHandler()

PySide2.QtXml.QXmlReader.entityResolver()
Return type

QXmlEntityResolver

Returns the entity resolver or 0 if none was set.

PySide2.QtXml.QXmlReader.errorHandler()
Return type

QXmlErrorHandler

Returns the error handler or 0 if none is set.

PySide2.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.

PySide2.QtXml.QXmlReader.hasFeature(name)
Parameters

name – unicode

Return type

bool

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

PySide2.QtXml.QXmlReader.hasProperty(name)
Parameters

name – unicode

Return type

bool

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

PySide2.QtXml.QXmlReader.lexicalHandler()
Return type

QXmlLexicalHandler

Returns the lexical handler or 0 if none was set.

PySide2.QtXml.QXmlReader.parse(input)
Parameters

inputQXmlInputSource

Return type

bool

PySide2.QtXml.QXmlReader.parse(input)
Parameters

inputQXmlInputSource

Return type

bool

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

PySide2.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.

PySide2.QtXml.QXmlReader.setContentHandler(handler)
Parameters

handlerQXmlContentHandler

Sets the content handler to handler .

See also

contentHandler()

PySide2.QtXml.QXmlReader.setDTDHandler(handler)
Parameters

handlerQXmlDTDHandler

Sets the DTD handler to handler .

See also

DTDHandler()

PySide2.QtXml.QXmlReader.setDeclHandler(handler)
Parameters

handlerQXmlDeclHandler

Sets the declaration handler to handler .

See also

declHandler()

PySide2.QtXml.QXmlReader.setEntityResolver(handler)
Parameters

handlerQXmlEntityResolver

Sets the entity resolver to handler .

See also

entityResolver()

PySide2.QtXml.QXmlReader.setErrorHandler(handler)
Parameters

handlerQXmlErrorHandler

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

See also

errorHandler()

PySide2.QtXml.QXmlReader.setFeature(name, value)
Parameters
  • name – unicode

  • valuebool

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

PySide2.QtXml.QXmlReader.setLexicalHandler(handler)
Parameters

handlerQXmlLexicalHandler

Sets the lexical handler to handler .

See also

lexicalHandler()

PySide2.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.