QXmlLexicalHandler

The QXmlLexicalHandler class provides an interface to report the lexical content of XML data. More

Inheritance diagram of PySide2.QtXml.QXmlLexicalHandler

Detailed Description

The events in the lexical handler apply to the entire document, not just to the document element, and all lexical handler events appear between the content handler’s startDocument and endDocument events.

You can set the lexical handler with setLexicalHandler() .

This interface’s design is based on the SAX2 extension LexicalHandler.

The interface provides the startDTD() , endDTD() , startEntity() , endEntity() , startCDATA() , endCDATA() and comment() functions.

class QXmlLexicalHandler
PySide2.QtXml.QXmlLexicalHandler.comment(ch)
Parameters

ch – unicode

Return type

bool

The reader calls this function to report an XML comment anywhere in the document. It reports the text of the comment in ch .

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

PySide2.QtXml.QXmlLexicalHandler.endCDATA()
Return type

bool

The reader calls this function to report the end of a CDATA section.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

PySide2.QtXml.QXmlLexicalHandler.endDTD()
Return type

bool

The reader calls this function to report the end of a DTD declaration, if any.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

startDTD()

PySide2.QtXml.QXmlLexicalHandler.endEntity(name)
Parameters

name – unicode

Return type

bool

The reader calls this function to report the end of an entity called name .

For every startEntity() call, there is a corresponding call. The calls to startEntity() and are properly nested.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

startEntity() skippedEntity() setFeature()

PySide2.QtXml.QXmlLexicalHandler.errorString()
Return type

unicode

The reader calls this function to get an error string if any of the handler functions returns false .

PySide2.QtXml.QXmlLexicalHandler.startCDATA()
Return type

bool

The reader calls this function to report the start of a CDATA section. The content of the CDATA section is reported through the characters() function. This function is intended only to report the boundary.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

endCDATA()

PySide2.QtXml.QXmlLexicalHandler.startDTD(name, publicId, systemId)
Parameters
  • name – unicode

  • publicId – unicode

  • systemId – unicode

Return type

bool

The reader calls this function to report the start of a DTD declaration, if any. It reports the name of the document type in name , the public identifier in publicId and the system identifier in systemId .

If the public identifier is missing, publicId is set to an empty string. If the system identifier is missing, systemId is set to an empty string. Note that it is not valid XML to have a public identifier but no system identifier; in such cases a parse error will occur.

All declarations reported through QXmlDTDHandler or QXmlDeclHandler appear between the and endDTD() calls.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

endDTD()

PySide2.QtXml.QXmlLexicalHandler.startEntity(name)
Parameters

name – unicode

Return type

bool

The reader calls this function to report the start of an entity called name .

Note that if the entity is unknown, the reader reports it through skippedEntity() and not through this function.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

endEntity() setFeature()