com.trolltech.qt.xml
Interface QXmlLexicalHandlerInterface

All Superinterfaces:
QtJambiInterface
All Known Implementing Classes:
QXmlDefaultHandler, QXmlLexicalHandler

public interface QXmlLexicalHandlerInterface
extends QtJambiInterface

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

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 QXmlReader::setLexicalHandler().

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

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

See Also:
QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, to SAX2

Method Summary
 boolean comment(java.lang.String ch)
          The reader calls this function to report an XML comment anywhere in the document.
 boolean endCDATA()
          The reader calls this function to report the end of a CDATA section.
 boolean endDTD()
          The reader calls this function to report the end of a DTD declaration, if any.
 boolean endEntity(java.lang.String name)
          The reader calls this function to report the end of an entity called name.
 java.lang.String errorString()
          The reader calls this function to get an error string if any of the handler functions returns false.
 boolean startCDATA()
          The reader calls this function to report the start of a CDATA section.
 boolean startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
          The reader calls this function to report the start of a DTD declaration, if any.
 boolean startEntity(java.lang.String name)
          The reader calls this function to report the start of an entity called name.
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Method Detail

comment

boolean comment(java.lang.String ch)

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.


endCDATA

boolean endCDATA()

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.

See Also:
startCDATA, QXmlContentHandler::characters

endDTD

boolean endDTD()

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

endEntity

boolean endEntity(java.lang.String name)

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

For every startEntity call, there is a corresponding endEntity call. The calls to startEntity and endEntity 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, QXmlContentHandler::skippedEntity, QXmlSimpleReader::setFeature

errorString

java.lang.String errorString()

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


startCDATA

boolean startCDATA()

The reader calls this function to report the start of a CDATA section. The content of the CDATA section is reported through the QXmlContentHandler::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

startDTD

boolean startDTD(java.lang.String name,
                 java.lang.String publicId,
                 java.lang.String systemId)

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

startEntity

boolean startEntity(java.lang.String name)

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 QXmlContentHandler::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, QXmlSimpleReader::setFeature