1QXmlLexicalHandler(3qt)                                QXmlLexicalHandler(3qt)
2
3
4

NAME

6       QXmlLexicalHandler - Interface to report the lexical content of XML
7       data
8

SYNOPSIS

10       All the functions in this class are reentrant when Qt is built with
11       thread support.</p>
12
13       #include <qxml.h>
14
15       Inherited by QXmlDefaultHandler.
16
17   Public Members
18       virtual bool startDTD ( const QString & name, const QString & publicId,
19           const QString & systemId ) = 0
20       virtual bool endDTD () = 0
21       virtual bool startEntity ( const QString & name ) = 0
22       virtual bool endEntity ( const QString & name ) = 0
23       virtual bool startCDATA () = 0
24       virtual bool endCDATA () = 0
25       virtual bool comment ( const QString & ch ) = 0
26       virtual QString errorString () = 0
27

DESCRIPTION

29       The QXmlLexicalHandler class provides an interface to report the
30       lexical content of XML data.
31
32       The events in the lexical handler apply to the entire document, not
33       just to the document element, and all lexical handler events appear
34       between the content handler's startDocument and endDocument events.
35
36       You can set the lexical handler with QXmlReader::setLexicalHandler().
37
38       This interface's design is based on the the SAX2 extension
39       LexicalHandler.
40
41       The interface provides the startDTD(), endDTD(), startEntity(),
42       endEntity(), startCDATA(), endCDATA() and comment() functions.
43
44       See also the Introduction to SAX2.
45
46       See also QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler,
47       QXmlEntityResolver, QXmlErrorHandler, and XML.
48

MEMBER FUNCTION DOCUMENTATION

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

51       The reader calls this function to report an XML comment anywhere in the
52       document. It reports the text of the comment in ch.
53
54       If this function returns FALSE the reader stops parsing and reports an
55       error. The reader uses the function errorString() to get the error
56       message.
57

bool QXmlLexicalHandler::endCDATA () [pure virtual]

59       The reader calls this function to report the end of a CDATA section.
60
61       If this function returns FALSE the reader stops parsing and reports an
62       error. The reader uses the function errorString() to get the error
63       message.
64
65       See also startCDATA() and QXmlContentHandler::characters().
66

bool QXmlLexicalHandler::endDTD () [pure virtual]

68       The reader calls this function to report the end of a DTD declaration,
69       if any.
70
71       If this function returns FALSE the reader stops parsing and reports an
72       error. The reader uses the function errorString() to get the error
73       message.
74
75       See also startDTD().
76

bool QXmlLexicalHandler::endEntity ( const QString & name ) [pure virtual]

78       The reader calls this function to report the end of an entity called
79       name.
80
81       For every startEntity() call, there is a corresponding endEntity()
82       call. The calls to startEntity() and endEntity() are properly nested.
83
84       If this function returns FALSE the reader stops parsing and reports an
85       error. The reader uses the function errorString() to get the error
86       message.
87
88       See also startEntity(), QXmlContentHandler::skippedEntity(), and
89       QXmlSimpleReader::setFeature().
90

QString QXmlLexicalHandler::errorString () [pure virtual]

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

bool QXmlLexicalHandler::startCDATA () [pure virtual]

96       The reader calls this function to report the start of a CDATA section.
97       The content of the CDATA section is reported through the
98       QXmlContentHandler::characters() function. This function is intended
99       only to report the boundary.
100
101       If this function returns FALSE the reader stops parsing and reports an
102       error. The reader uses the function errorString() to get the error
103       message.
104
105       See also endCDATA().
106

bool QXmlLexicalHandler::startDTD ( const QString & name, const QString &

108       publicId, const QString & systemId ) [pure virtual]
109       The reader calls this function to report the start of a DTD
110       declaration, if any. It reports the name of the document type in name,
111       the public identifier in publicId and the system identifier in
112       systemId.
113
114       If the public identifier is missing, publicId is set to QString::null.
115       If the system identifier is missing, systemId is set to QString::null.
116       Note that it is not valid XML to have a public identifier but no system
117       identifier; in such cases a parse error will occur.
118
119       All declarations reported through QXmlDTDHandler or QXmlDeclHandler
120       appear between the startDTD() and endDTD() calls.
121
122       If this function returns FALSE the reader stops parsing and reports an
123       error. The reader uses the function errorString() to get the error
124       message.
125
126       See also endDTD().
127

bool QXmlLexicalHandler::startEntity ( const QString & name ) [pure virtual]

129       The reader calls this function to report the start of an entity called
130       name.
131
132       Note that if the entity is unknown, the reader reports it through
133       QXmlContentHandler::skippedEntity() and not through this function.
134
135       If this function returns FALSE the reader stops parsing and reports an
136       error. The reader uses the function errorString() to get the error
137       message.
138
139       See also endEntity() and QXmlSimpleReader::setFeature().
140
141

SEE ALSO

143       http://doc.trolltech.com/qxmllexicalhandler.html
144       http://www.trolltech.com/faq/tech.html
145
147       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
148       license file included in the distribution for a complete license
149       statement.
150

AUTHOR

152       Generated automatically from the source code.
153

BUGS

155       If you find a bug in Qt, please report it as described in
156       http://doc.trolltech.com/bughowto.html.  Good bug reports help us to
157       help you. Thank you.
158
159       The definitive Qt documentation is provided in HTML format; it is
160       located at $QTDIR/doc/html and can be read using Qt Assistant or with a
161       web browser. This man page is provided as a convenience for those users
162       who prefer man pages, although this format is not officially supported
163       by Trolltech.
164
165       If you find errors in this manual page, please report them to qt-
166       bugs@trolltech.com.  Please include the name of the manual page
167       (qxmllexicalhandler.3qt) and the Qt version (3.3.8).
168
169
170
171Trolltech AS                    2 February 2007        QXmlLexicalHandler(3qt)
Impressum