QtXml.QXmlLexicalHandler Class Reference

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

Inheritance diagram for QtXml.QXmlLexicalHandler:

Collaboration diagram for QtXml.QXmlLexicalHandler:

Public Member Functions
	QXmlLexicalHandler ()
	QXmlLexicalHandler (IQXmlLexicalHandler copy)
virtual void	CreateProxy ()
abstract bool	Comment (string ch)
abstract bool	EndCDATA ()
abstract bool	EndDTD ()
abstract bool	EndEntity (string name)
abstract string	ErrorString ()
abstract bool	StartCDATA ()
abstract bool	StartDTD (string name, string publicId, string systemId)
abstract bool	StartEntity (string name)
new void	Dispose ()
Public Member Functions inherited from QtXml.IQXmlLexicalHandler
bool	Comment (string ch)
bool	EndCDATA ()
bool	EndDTD ()
bool	EndEntity (string name)
string	ErrorString ()
bool	StartCDATA ()
bool	StartDTD (string name, string publicId, string systemId)
bool	StartEntity (string name)

Protected Member Functions
	QXmlLexicalHandler (System.Type dummy)

Protected Attributes
SmokeInvocation	interceptor

Properties
virtual System.IntPtr	SmokeObject [get, set]

Detailed Description

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 SAX2 extension LexicalHandler.

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

See also QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, and Introduction to SAX2.

Constructor & Destructor Documentation

QtXml.QXmlLexicalHandler.QXmlLexicalHandler ( System.Type  dummy )

protected

QtXml.QXmlLexicalHandler.QXmlLexicalHandler

(

)

QtXml.QXmlLexicalHandler.QXmlLexicalHandler

(

IQXmlLexicalHandler

copy

)

Member Function Documentation

abstract bool QtXml.QXmlLexicalHandler.Comment ( string  ch )

pure virtual

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.

virtual void QtXml.QXmlLexicalHandler.CreateProxy ( )

virtual

new void QtXml.QXmlLexicalHandler.Dispose

(

)

abstract bool QtXml.QXmlLexicalHandler.EndCDATA ( )

pure virtual

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() and QXmlContentHandler::characters().

abstract bool QtXml.QXmlLexicalHandler.EndDTD ( )

pure virtual

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().

abstract bool QtXml.QXmlLexicalHandler.EndEntity ( string  name )

pure virtual

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(), and QXmlSimpleReader::setFeature().

abstract string QtXml.QXmlLexicalHandler.ErrorString ( )

pure virtual

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

abstract bool QtXml.QXmlLexicalHandler.StartCDATA ( )

pure virtual

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().

abstract bool QtXml.QXmlLexicalHandler.StartDTD ( string  name, string  publicId, string  systemId  )

pure virtual

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().

abstract bool QtXml.QXmlLexicalHandler.StartEntity ( string  name )

pure virtual

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() and QXmlSimpleReader::setFeature().

Member Data Documentation

SmokeInvocation QtXml.QXmlLexicalHandler.interceptor

protected

Property Documentation

virtual System.IntPtr QtXml.QXmlLexicalHandler.SmokeObject

getset