summaryrefslogtreecommitdiffstats
path: root/doc/html/qxmlentityresolver.html
blob: fa86e753d59ddbbcf54f308a33d55684ed33dbed (plain)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/xml/qxml.cpp:1596 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QXmlEntityResolver Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QXmlEntityResolver Class Reference<br><small>[<a href="xml.html">XML module</a>]</small></h1>

<p>The QXmlEntityResolver class provides an interface to
resolve external entities contained in XML data.
<a href="#details">More...</a>
<p>All the functions in this class are <a href="threads.html#reentrant">reentrant</a> when Qt is built with thread support.</p>
<p><tt>#include &lt;<a href="qxml-h.html">qxml.h</a>&gt;</tt>
<p>Inherited by <a href="qxmldefaulthandler.html">QXmlDefaultHandler</a>.
<p><a href="qxmlentityresolver-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn>virtual bool <a href="#resolveEntity"><b>resolveEntity</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;publicId, const&nbsp;QString&nbsp;&amp;&nbsp;systemId, QXmlInputSource&nbsp;*&amp;&nbsp;ret ) = 0</li>
<li class=fn>virtual QString <a href="#errorString"><b>errorString</b></a> () = 0</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>



The QXmlEntityResolver class provides an interface to
resolve external entities contained in XML data.

<p> 

<p> If an application needs to implement customized handling for
external entities, it must implement this interface, i.e.
<a href="#resolveEntity">resolveEntity</a>(), and register it with
<a href="qxmlreader.html#setEntityResolver">QXmlReader::setEntityResolver</a>().
<p> See also the <a href="xml.html#sax2Intro">Introduction to SAX2</a>.
<p> <p>See also <a href="qxmldtdhandler.html">QXmlDTDHandler</a>, <a href="qxmldeclhandler.html">QXmlDeclHandler</a>, <a href="qxmlcontenthandler.html">QXmlContentHandler</a>, <a href="qxmlerrorhandler.html">QXmlErrorHandler</a>, <a href="qxmllexicalhandler.html">QXmlLexicalHandler</a>, and <a href="xml-tools.html">XML</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a href="qstring.html">QString</a> <a name="errorString"></a>QXmlEntityResolver::errorString ()<tt> [pure virtual]</tt>
</h3>

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

<h3 class=fn>bool <a name="resolveEntity"></a>QXmlEntityResolver::resolveEntity ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;publicId, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;systemId, <a href="qxmlinputsource.html">QXmlInputSource</a>&nbsp;*&amp;&nbsp;ret )<tt> [pure virtual]</tt>
</h3>

<p> The reader calls this function before it opens any external
entity, except the top-level document entity. The application may
request the reader to resolve the entity itself (<em>ret</em> is 0) or
to use an entirely different input source (<em>ret</em> points to the
input source).
<p> The reader deletes the input source <em>ret</em> when it no longer needs
it, so you should allocate it on the heap with <tt>new</tt>.
<p> The argument <em>publicId</em> is the public identifier of the external
entity, <em>systemId</em> is the system identifier of the external
entity and <em>ret</em> is the return value of this function. If <em>ret</em>
is 0 the reader should resolve the entity itself, if it is
non-zero it must point to an input source which the reader uses
instead.
<p> If this function returns FALSE the reader stops parsing and
reports an error. The reader uses the function <a href="#errorString">errorString</a>() to
get the error message.

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<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 &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>