Public Member Functions | List of all members
QXmlLexicalHandler Class Referenceabstract

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

#include <qxml.h>

Inheritance diagram for QXmlLexicalHandler:
QXmlDefaultHandler BaseHandler< T > BaseHandler< AnchorHandler > BaseHandler< ChildNodeHandler > BaseHandler< CodeLineHandler > BaseHandler< CompoundHandler > BaseHandler< CopyHandler > BaseHandler< DocHandler > BaseHandler< DocInternalHandler > BaseHandler< DocSectionHandler > BaseHandler< DotFileHandler > BaseHandler< EdgeLabelHandler > BaseHandler< EMailHandler > BaseHandler< EntryHandler > BaseHandler< FormulaHandler > BaseHandler< GraphHandler > BaseHandler< HighlightHandler > BaseHandler< HRulerHandler > BaseHandler< ImageHandler > BaseHandler< IncludeHandler > BaseHandler< IndexEntryHandler > BaseHandler< ItemizedListHandler > BaseHandler< LineBreakHandler > BaseHandler< LinkedTextHandler > BaseHandler< LinkHandler > BaseHandler< ListItemHandler > BaseHandler< ListOfAllMembersHandler > BaseHandler< MainHandler > BaseHandler< MemberHandler > BaseHandler< NodeHandler > BaseHandler< OrderedListHandler > BaseHandler< ParagraphHandler > BaseHandler< ParameterHandler > BaseHandler< ParameterItemHandler > BaseHandler< ParameterListHandler > BaseHandler< ParamHandler > BaseHandler< ProgramListingHandler > BaseHandler< RefHandler > BaseHandler< RowHandler > BaseHandler< SectionHandler > BaseHandler< SimpleSectHandler > BaseHandler< SymbolHandler > BaseHandler< TableHandler > BaseHandler< TemplateParamListHandler > BaseHandler< TitleHandler > BaseHandler< TocItemHandler > BaseHandler< TocListHandler > BaseHandler< ULinkHandler > BaseHandler< VariableListEntryHandler > BaseHandler< VariableListHandler > BaseHandler< VerbatimHandler > LayoutParser TagFileParser XMLContentHandler

Public Member Functions

virtual ~QXmlLexicalHandler ()
 
virtual bool startDTD (const QString &name, const QString &publicId, const QString &systemId)=0
 
virtual bool endDTD ()=0
 
virtual bool startCDATA ()=0
 
virtual bool endCDATA ()=0
 
virtual bool comment (const QString &ch)=0
 
virtual QString errorString ()=0
 

Detailed Description

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

XML

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 is designed after the SAX2 extension LexicalHandler. The functions startEntity() and endEntity() are not included though.

See also the Introduction to SAX2.

See also
QXmlDTDHandler QXmlDeclHandler QXmlContentHandler QXmlEntityResolver QXmlErrorHandler

Definition at line 447 of file qxml.h.

Constructor & Destructor Documentation

virtual QXmlLexicalHandler::~QXmlLexicalHandler ( )
inlinevirtual

Definition at line 450 of file qxml.h.

450 {}

Member Function Documentation

bool QXmlLexicalHandler::comment ( const QString &  ch)
pure virtual

The reader calls this function to report an XML comment anywhere in the document.

If this function returns FALSE the reader will stop parsing and will report an error. The reader will use the function errorString() to get the error message that will be used for reporting the error.

Implemented in QXmlDefaultHandler.

bool QXmlLexicalHandler::endCDATA ( )
pure virtual

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

If this function returns FALSE the reader will stop parsing and will report an error. The reader will use the function errorString() to get the error message that will be used for reporting the error.

See also
startCDATA()

Implemented in QXmlDefaultHandler.

bool 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 will stop parsing and will report an error. The reader will use the function errorString() to get the error message that will be used for reporting the error.

See also
startDTD()

Implemented in QXmlDefaultHandler.

QString QXmlLexicalHandler::errorString ( )
pure virtual

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

Implemented in QXmlDefaultHandler.

bool QXmlLexicalHandler::startCDATA ( )
pure virtual

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

If this function returns FALSE the reader will stop parsing and will report an error. The reader will use the function errorString() to get the error message that will be used for reporting the error.

See also
endCDATA()

Implemented in QXmlDefaultHandler.

bool QXmlLexicalHandler::startDTD ( const QString &  name,
const QString &  publicId,
const QString &  systemId 
)
pure virtual

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

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

If this function returns FALSE the reader will stop parsing and will report an error. The reader will use the function errorString() to get the error message that will be used for reporting the error.

See also
endDTD()

Implemented in QXmlDefaultHandler.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11