source: trunk/doc/html/qxmlerrorhandler.html

Last change on this file was 190, checked in by rudi, 14 years ago

reference documentation added

File size: 5.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/xml/qxml.cpp:1456 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QXmlErrorHandler Class</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QXmlErrorHandler Class Reference<br><small>[<a href="xml.html">XML module</a>]</small></h1>
33
34<p>The QXmlErrorHandler class provides an interface to report
35errors in XML data.
36<a href="#details">More...</a>
37<p>All the functions in this class are <a href="threads.html#reentrant">reentrant</a> when Qt is built with thread support.</p>
38<p><tt>#include &lt;<a href="qxml-h.html">qxml.h</a>&gt;</tt>
39<p>Inherited by <a href="qxmldefaulthandler.html">QXmlDefaultHandler</a>.
40<p><a href="qxmlerrorhandler-members.html">List of all member functions.</a>
41<h2>Public Members</h2>
42<ul>
43<li class=fn>virtual bool <a href="#warning"><b>warning</b></a> ( const&nbsp;QXmlParseException&nbsp;&amp;&nbsp;exception ) = 0</li>
44<li class=fn>virtual bool <a href="#error"><b>error</b></a> ( const&nbsp;QXmlParseException&nbsp;&amp;&nbsp;exception ) = 0</li>
45<li class=fn>virtual bool <a href="#fatalError"><b>fatalError</b></a> ( const&nbsp;QXmlParseException&nbsp;&amp;&nbsp;exception ) = 0</li>
46<li class=fn>virtual QString <a href="#errorString"><b>errorString</b></a> () = 0</li>
47</ul>
48<hr><a name="details"></a><h2>Detailed Description</h2>
49
50
51
52The QXmlErrorHandler class provides an interface to report
53errors in XML data.
54
55<p>
56
57<p> If you want your application to report errors to the user or to
58perform customized error handling, you should subclass this class.
59<p> You can set the error handler with <a href="qxmlreader.html#setErrorHandler">QXmlReader::setErrorHandler</a>().
60<p> Errors can be reported using <a href="#warning">warning</a>(), <a href="#error">error</a>() and <a href="#fatalError">fatalError</a>(),
61with the error text being reported with <a href="#errorString">errorString</a>().
62<p> See also the <a href="xml.html#sax2Intro">Introduction to SAX2</a>.
63<p> <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>, <a href="qxmllexicalhandler.html">QXmlLexicalHandler</a>, and <a href="xml-tools.html">XML</a>.
64
65<hr><h2>Member Function Documentation</h2>
66<h3 class=fn>bool <a name="error"></a>QXmlErrorHandler::error ( const&nbsp;<a href="qxmlparseexception.html">QXmlParseException</a>&nbsp;&amp;&nbsp;exception )<tt> [pure virtual]</tt>
67</h3>
68
69<p> A reader might use this function to report a recoverable error. A
70recoverable error corresponds to the definiton of "error" in
71section 1.2 of the XML 1.0 specification. Details of the error are
72stored in <em>exception</em>.
73<p> The reader must continue to provide normal parsing events after
74invoking this function.
75<p> If this function returns FALSE the reader stops parsing and
76reports an error. The reader uses the function <a href="#errorString">errorString</a>() to
77get the error message.
78
79<h3 class=fn><a href="qstring.html">QString</a> <a name="errorString"></a>QXmlErrorHandler::errorString ()<tt> [pure virtual]</tt>
80</h3>
81
82<p> The reader calls this function to get an error string if any of
83the handler functions returns FALSE.
84
85<h3 class=fn>bool <a name="fatalError"></a>QXmlErrorHandler::fatalError ( const&nbsp;<a href="qxmlparseexception.html">QXmlParseException</a>&nbsp;&amp;&nbsp;exception )<tt> [pure virtual]</tt>
86</h3>
87
88<p> A reader must use this function to report a non-recoverable error.
89Details of the error are stored in <em>exception</em>.
90<p> If this function returns TRUE the reader might try to go on
91parsing and reporting further errors; but no regular parsing
92events are reported.
93
94<h3 class=fn>bool <a name="warning"></a>QXmlErrorHandler::warning ( const&nbsp;<a href="qxmlparseexception.html">QXmlParseException</a>&nbsp;&amp;&nbsp;exception )<tt> [pure virtual]</tt>
95</h3>
96
97<p> A reader might use this function to report a warning. Warnings are
98conditions that are not errors or fatal errors as defined by the
99XML 1.0 specification. Details of the warning are stored in <em>exception</em>.
100<p> If this function returns FALSE the reader stops parsing and
101reports an error. The reader uses the function <a href="#errorString">errorString</a>() to
102get the error message.
103
104<!-- eof -->
105<hr><p>
106This file is part of the <a href="index.html">Qt toolkit</a>.
107Copyright &copy; 1995-2007
108<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
109<table width=100% cellspacing=0 border=0><tr>
110<td>Copyright &copy; 2007
111<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
112<td align=right><div align=right>Qt 3.3.8</div>
113</table></div></address></body>
114</html>
Note: See TracBrowser for help on using the repository browser.