Qyoto  4.0.7
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties
QtXml.QXmlLexicalHandler Class Referenceabstract

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)
  More...
 
abstract bool EndCDATA ()
  More...
 
abstract bool EndDTD ()
  More...
 
abstract bool EndEntity (string name)
  More...
 
abstract bool StartCDATA ()
  More...
 
abstract bool StartDTD (string name, string publicId, string systemId)
  More...
 
abstract bool StartEntity (string name)
  More...
 
new void Dispose ()
 

Protected Member Functions

 QXmlLexicalHandler (System.Type dummy)
 

Protected Attributes

SmokeInvocation interceptor
 

Properties

virtual string ErrorString [get]
  More...
 
virtual System.IntPtr SmokeObject [get, set]
 
- Properties inherited from QtXml.IQXmlLexicalHandler
System.String ErrorString [get]
  More...
 

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

Here is the call graph for this function:

QtXml.QXmlLexicalHandler.QXmlLexicalHandler ( IQXmlLexicalHandler  copy)

Here is the call graph for this function:

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.

Implements QtXml.IQXmlLexicalHandler.

virtual void QtXml.QXmlLexicalHandler.CreateProxy ( )
virtual

Here is the caller graph for this function:

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

Implements QtXml.IQXmlLexicalHandler.

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

Implements QtXml.IQXmlLexicalHandler.

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

Implements QtXml.IQXmlLexicalHandler.

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

Implements QtXml.IQXmlLexicalHandler.

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

Implements QtXml.IQXmlLexicalHandler.

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

Implements QtXml.IQXmlLexicalHandler.

Member Data Documentation

SmokeInvocation QtXml.QXmlLexicalHandler.interceptor
protected

Property Documentation

virtual string QtXml.QXmlLexicalHandler.ErrorString
get

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

virtual System.IntPtr QtXml.QXmlLexicalHandler.SmokeObject
getset