| 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:1596 -->
|
|---|
| 3 | <html>
|
|---|
| 4 | <head>
|
|---|
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|---|
| 6 | <title>QXmlEntityResolver Class</title>
|
|---|
| 7 | <style type="text/css"><!--
|
|---|
| 8 | fn { margin-left: 1cm; text-indent: -1cm; }
|
|---|
| 9 | a:link { color: #004faf; text-decoration: none }
|
|---|
| 10 | a:visited { color: #672967; text-decoration: none }
|
|---|
| 11 | body { 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 Classes</font></a>
|
|---|
| 23 | | <a href="mainclasses.html">
|
|---|
| 24 | <font color="#004faf">Main 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 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>QXmlEntityResolver Class Reference<br><small>[<a href="xml.html">XML module</a>]</small></h1>
|
|---|
| 33 |
|
|---|
| 34 | <p>The QXmlEntityResolver class provides an interface to
|
|---|
| 35 | resolve external entities contained 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 <<a href="qxml-h.html">qxml.h</a>></tt>
|
|---|
| 39 | <p>Inherited by <a href="qxmldefaulthandler.html">QXmlDefaultHandler</a>.
|
|---|
| 40 | <p><a href="qxmlentityresolver-members.html">List of all member functions.</a>
|
|---|
| 41 | <h2>Public Members</h2>
|
|---|
| 42 | <ul>
|
|---|
| 43 | <li class=fn>virtual bool <a href="#resolveEntity"><b>resolveEntity</b></a> ( const QString & publicId, const QString & systemId, QXmlInputSource *& ret ) = 0</li>
|
|---|
| 44 | <li class=fn>virtual QString <a href="#errorString"><b>errorString</b></a> () = 0</li>
|
|---|
| 45 | </ul>
|
|---|
| 46 | <hr><a name="details"></a><h2>Detailed Description</h2>
|
|---|
| 47 |
|
|---|
| 48 |
|
|---|
| 49 |
|
|---|
| 50 | The QXmlEntityResolver class provides an interface to
|
|---|
| 51 | resolve external entities contained in XML data.
|
|---|
| 52 |
|
|---|
| 53 | <p>
|
|---|
| 54 |
|
|---|
| 55 | <p> If an application needs to implement customized handling for
|
|---|
| 56 | external entities, it must implement this interface, i.e.
|
|---|
| 57 | <a href="#resolveEntity">resolveEntity</a>(), and register it with
|
|---|
| 58 | <a href="qxmlreader.html#setEntityResolver">QXmlReader::setEntityResolver</a>().
|
|---|
| 59 | <p> See also the <a href="xml.html#sax2Intro">Introduction to SAX2</a>.
|
|---|
| 60 | <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>.
|
|---|
| 61 |
|
|---|
| 62 | <hr><h2>Member Function Documentation</h2>
|
|---|
| 63 | <h3 class=fn><a href="qstring.html">QString</a> <a name="errorString"></a>QXmlEntityResolver::errorString ()<tt> [pure virtual]</tt>
|
|---|
| 64 | </h3>
|
|---|
| 65 |
|
|---|
| 66 | <p> The reader calls this function to get an error string if any of
|
|---|
| 67 | the handler functions returns FALSE.
|
|---|
| 68 |
|
|---|
| 69 | <h3 class=fn>bool <a name="resolveEntity"></a>QXmlEntityResolver::resolveEntity ( const <a href="qstring.html">QString</a> & publicId, const <a href="qstring.html">QString</a> & systemId, <a href="qxmlinputsource.html">QXmlInputSource</a> *& ret )<tt> [pure virtual]</tt>
|
|---|
| 70 | </h3>
|
|---|
| 71 |
|
|---|
| 72 | <p> The reader calls this function before it opens any external
|
|---|
| 73 | entity, except the top-level document entity. The application may
|
|---|
| 74 | request the reader to resolve the entity itself (<em>ret</em> is 0) or
|
|---|
| 75 | to use an entirely different input source (<em>ret</em> points to the
|
|---|
| 76 | input source).
|
|---|
| 77 | <p> The reader deletes the input source <em>ret</em> when it no longer needs
|
|---|
| 78 | it, so you should allocate it on the heap with <tt>new</tt>.
|
|---|
| 79 | <p> The argument <em>publicId</em> is the public identifier of the external
|
|---|
| 80 | entity, <em>systemId</em> is the system identifier of the external
|
|---|
| 81 | entity and <em>ret</em> is the return value of this function. If <em>ret</em>
|
|---|
| 82 | is 0 the reader should resolve the entity itself, if it is
|
|---|
| 83 | non-zero it must point to an input source which the reader uses
|
|---|
| 84 | instead.
|
|---|
| 85 | <p> If this function returns FALSE the reader stops parsing and
|
|---|
| 86 | reports an error. The reader uses the function <a href="#errorString">errorString</a>() to
|
|---|
| 87 | get the error message.
|
|---|
| 88 |
|
|---|
| 89 | <!-- eof -->
|
|---|
| 90 | <hr><p>
|
|---|
| 91 | This file is part of the <a href="index.html">Qt toolkit</a>.
|
|---|
| 92 | Copyright © 1995-2007
|
|---|
| 93 | <a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
|
|---|
| 94 | <table width=100% cellspacing=0 border=0><tr>
|
|---|
| 95 | <td>Copyright © 2007
|
|---|
| 96 | <a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
|
|---|
| 97 | <td align=right><div align=right>Qt 3.3.8</div>
|
|---|
| 98 | </table></div></address></body>
|
|---|
| 99 | </html>
|
|---|
