1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Qt Toolkit - QXmlLexicalHandler Class</title><style type="text/css"><!--
h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }body { background: white; color: black; }
--></style>
</head><body bgcolor="#ffffff">
<table width="100%">
<tr><td><a href="index.html">
<img width="100" height="100" src="qtlogo.png"
alt="Home" border="0"><img width="100"
height="100" src="face.png" alt="Home" border="0">
</a><td valign=top><div align=right><img src="dochead.png" width="472" height="27"><br>
<a href="classes.html"><b>Classes</b></a>
-<a href="annotated.html">Annotated</a>
- <a href="hierarchy.html">Tree</a>
-<a href="functions.html">Functions</a>
-<a href="index.html">Home</a>
-<a href="topicals.html"><b>Structure</b></a>
</div>
</table>
<h1 align=center>QXmlLexicalHandler Class Reference<br><small>[ <a href="xml.html">XML module</a> ]</small></h1><br clear="all">
<p>
The QXmlLexicalHandler class provides an interface to report lexical content of XML data.
<a href="#details">More...</a>
<p>
<code>#include <<a href="qxml-h.html">qxml.h</a>></code>
<p>Inherited by <a href="qxmldefaulthandler.html">QXmlDefaultHandler</a>.
<p><a href="qxmllexicalhandler-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li><div class="fn">virtualbool<a href="#6ad19a"><b>startDTD</b></a>(constQString&name, constQString&publicId, constQString&systemId)</div>
<li><div class="fn">virtualbool<a href="#5553c4"><b>endDTD</b></a>()</div>
<li><div class="fn">virtualbool<a href="#eae48d"><b>startCDATA</b></a>()</div>
<li><div class="fn">virtualbool<a href="#c054be"><b>endCDATA</b></a>()</div>
<li><div class="fn">virtualbool<a href="#6c8a01"><b>comment</b></a>(constQString&ch)</div>
<li><div class="fn">virtualQString<a href="#c18dfa"><b>errorString</b></a>()</div>
</ul>
<hr><h2><a name="details"></a>Detailed Description</h2>
The QXmlLexicalHandler class provides an interface to report lexical content of XML data.
<p>
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.
<p>You can set the lexical handler with <a href="qxmlreader.html#3367d5">QXmlReader::setLexicalHandler</a>().
<p>This interface is designed after the SAX2 extension LexicalHandler. The
functions startEntity() and endEntity() are not included though.
<p>See also the <a href="xml.html#introSAX2">Introduction to SAX2</a>.
<p>See also <a href="qxmldtdhandler.html">QXmlDTDHandler</a>, <a href="qxmldeclhandler.html">QXmlDeclHandler</a>, <a href="qxmlcontenthandler.html">QXmlContentHandler</a>, <a href="qxmlentityresolver.html">QXmlEntityResolver</a> and <a href="qxmlerrorhandler.html">QXmlErrorHandler</a>.
<hr><h2>Member Function Documentation</h2>
<h3 class="fn">bool<a name="6c8a01"></a>QXmlLexicalHandler::comment(const<a href="qstring.html">QString</a>&ch) <code>[virtual]</code></h3>
<p>The reader calls this function to report an XML comment anywhere in the
document.
<p>If this function returns FALSE the reader will stop parsing and will report
an error. The reader will use the function <a href="#c18dfa">errorString</a>() to get the error
message that will be used for reporting the error.
<p>Reimplemented in <a href="qxmldefaulthandler.html#77f678">QXmlDefaultHandler</a>.
<h3 class="fn">bool<a name="c054be"></a>QXmlLexicalHandler::endCDATA() <code>[virtual]</code></h3>
<p>The reader calls this function to report the end of a CDATA section.
<p>If this function returns FALSE the reader will stop parsing and will report
an error. The reader will use the function <a href="#c18dfa">errorString</a>() to get the error
message that will be used for reporting the error.
<p>See also <a href="#eae48d">startCDATA</a>().
<p>Reimplemented in <a href="qxmldefaulthandler.html#a37c6c">QXmlDefaultHandler</a>.
<h3 class="fn">bool<a name="5553c4"></a>QXmlLexicalHandler::endDTD() <code>[virtual]</code></h3>
<p>The reader calls this function to report the end of a DTD declaration, if
any.
<p>If this function returns FALSE the reader will stop parsing and will report
an error. The reader will use the function <a href="#c18dfa">errorString</a>() to get the error
message that will be used for reporting the error.
<p>See also <a href="#6ad19a">startDTD</a>().
<p>Reimplemented in <a href="qxmldefaulthandler.html#b7f820">QXmlDefaultHandler</a>.
<h3 class="fn"><a href="qstring.html">QString</a><a name="c18dfa"></a>QXmlLexicalHandler::errorString() <code>[virtual]</code></h3>
<p>The reader calls this function to get an error string if any of the handler
functions returns FALSE to him.
<h3 class="fn">bool<a name="eae48d"></a>QXmlLexicalHandler::startCDATA() <code>[virtual]</code></h3>
<p>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
<a href="qxmlcontenthandler.html#d96698">QXmlContentHandler::characters</a>(). This function is intended only to report
the boundary.
<p>If this function returns FALSE the reader will stop parsing and will report
an error. The reader will use the function <a href="#c18dfa">errorString</a>() to get the error
message that will be used for reporting the error.
<p>See also <a href="#c054be">endCDATA</a>().
<p>Reimplemented in <a href="qxmldefaulthandler.html#7b96e2">QXmlDefaultHandler</a>.
<h3 class="fn">bool<a name="6ad19a"></a>QXmlLexicalHandler::startDTD(const<a href="qstring.html">QString</a>&name, const<a href="qstring.html">QString</a>&publicId, const<a href="qstring.html">QString</a>&systemId) <code>[virtual]</code></h3>
<p>The reader calls this function to report the start of a DTD declaration, if
any.
<p>All declarations reported through <a href="qxmldtdhandler.html">QXmlDTDHandler</a> or <a href="qxmldeclhandler.html">QXmlDeclHandler</a> appear
between the startDTD() and <a href="#5553c4">endDTD</a>() calls.
<p>If this function returns FALSE the reader will stop parsing and will report
an error. The reader will use the function <a href="#c18dfa">errorString</a>() to get the error
message that will be used for reporting the error.
<p>See also <a href="#5553c4">endDTD</a>().
<p>Reimplemented in <a href="qxmldefaulthandler.html#b5520b">QXmlDefaultHandler</a>.
<hr><p>
Search the documentation, FAQ, qt-interest archive and more (uses
<a href="http://www.trolltech.com">www.trolltech.com</a>):<br>
<form method=post action="http://www.trolltech.com/search.cgi">
<input type=hidden name="version" value="2.3.1"><nobr>
<input size="50" name="search"><input type=submit value="Search">
</nobr></form><hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>,
copyright © 1995-2000
<a href="http://www.trolltech.com">Trolltech</a>, all rights reserved.<p><address><hr><div align="center">
<table width="100%" cellspacing="0" border="0"><tr>
<td>Copyright 2000 Trolltech<td><a href="http://www.trolltech.com/trademarks.html">Trademarks</a>
<td align="right"><div align="right">Qt version 2.3.1</div>
</table></div></address></body></html>
|