| 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:1801 -->
|
|---|
| 3 | <html>
|
|---|
| 4 | <head>
|
|---|
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|---|
| 6 | <title>QXmlDeclHandler 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>QXmlDeclHandler Class Reference<br><small>[<a href="xml.html">XML module</a>]</small></h1>
|
|---|
| 33 |
|
|---|
| 34 | <p>The QXmlDeclHandler class provides an interface to report declaration
|
|---|
| 35 | content of 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="qxmldeclhandler-members.html">List of all member functions.</a>
|
|---|
| 41 | <h2>Public Members</h2>
|
|---|
| 42 | <ul>
|
|---|
| 43 | <li class=fn>virtual bool <a href="#attributeDecl"><b>attributeDecl</b></a> ( const QString & eName, const QString & aName, const QString & type, const QString & valueDefault, const QString & value ) = 0</li>
|
|---|
| 44 | <li class=fn>virtual bool <a href="#internalEntityDecl"><b>internalEntityDecl</b></a> ( const QString & name, const QString & value ) = 0</li>
|
|---|
| 45 | <li class=fn>virtual bool <a href="#externalEntityDecl"><b>externalEntityDecl</b></a> ( const QString & name, const QString & publicId, const QString & systemId ) = 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 |
|
|---|
| 52 | The QXmlDeclHandler class provides an interface to report declaration
|
|---|
| 53 | content of XML data.
|
|---|
| 54 |
|
|---|
| 55 | <p>
|
|---|
| 56 |
|
|---|
| 57 | <p> You can set the declaration handler with
|
|---|
| 58 | <a href="qxmlreader.html#setDeclHandler">QXmlReader::setDeclHandler</a>().
|
|---|
| 59 | <p> This interface is based on the SAX2 extension DeclHandler.
|
|---|
| 60 | <p> The interface provides <a href="#attributeDecl">attributeDecl</a>(), <a href="#internalEntityDecl">internalEntityDecl</a>() and
|
|---|
| 61 | <a href="#externalEntityDecl">externalEntityDecl</a>() functions.
|
|---|
| 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="qxmlcontenthandler.html">QXmlContentHandler</a>, <a href="qxmlentityresolver.html">QXmlEntityResolver</a>, <a href="qxmlerrorhandler.html">QXmlErrorHandler</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="attributeDecl"></a>QXmlDeclHandler::attributeDecl ( const <a href="qstring.html">QString</a> & eName, const <a href="qstring.html">QString</a> & aName, const <a href="qstring.html">QString</a> & type, const <a href="qstring.html">QString</a> & valueDefault, const <a href="qstring.html">QString</a> & value )<tt> [pure virtual]</tt>
|
|---|
| 67 | </h3>
|
|---|
| 68 |
|
|---|
| 69 | <p> The reader calls this function to report an attribute type
|
|---|
| 70 | declaration. Only the effective (first) declaration for an
|
|---|
| 71 | attribute is reported.
|
|---|
| 72 | <p> The reader passes the name of the associated element in <em>eName</em>
|
|---|
| 73 | and the name of the attribute in <em>aName</em>. It passes a string that
|
|---|
| 74 | represents the attribute type in <em>type</em> and a string that
|
|---|
| 75 | represents the attribute default in <em>valueDefault</em>. This string
|
|---|
| 76 | is one of "#IMPLIED", "#REQUIRED", "#FIXED" or <a href="qstring.html#QString-null">QString::null</a> (if
|
|---|
| 77 | none of the others applies). The reader passes the attribute's
|
|---|
| 78 | default value in <em>value</em>. If no default value is specified in the
|
|---|
| 79 | XML file, <em>value</em> is QString::null.
|
|---|
| 80 | <p> If this function returns FALSE the reader stops parsing and
|
|---|
| 81 | reports an error. The reader uses the function <a href="#errorString">errorString</a>() to
|
|---|
| 82 | get the error message.
|
|---|
| 83 |
|
|---|
| 84 | <h3 class=fn><a href="qstring.html">QString</a> <a name="errorString"></a>QXmlDeclHandler::errorString ()<tt> [pure virtual]</tt>
|
|---|
| 85 | </h3>
|
|---|
| 86 |
|
|---|
| 87 | <p> The reader calls this function to get an error string if any of
|
|---|
| 88 | the handler functions returns FALSE.
|
|---|
| 89 |
|
|---|
| 90 | <h3 class=fn>bool <a name="externalEntityDecl"></a>QXmlDeclHandler::externalEntityDecl ( const <a href="qstring.html">QString</a> & name, const <a href="qstring.html">QString</a> & publicId, const <a href="qstring.html">QString</a> & systemId )<tt> [pure virtual]</tt>
|
|---|
| 91 | </h3>
|
|---|
| 92 |
|
|---|
| 93 | <p> The reader calls this function to report a parsed external entity
|
|---|
| 94 | declaration. Only the effective (first) declaration for each
|
|---|
| 95 | entity is reported.
|
|---|
| 96 | <p> The reader passes the name of the entity in <em>name</em>, the public
|
|---|
| 97 | identifier in <em>publicId</em> and the system identifier in <em>systemId</em>. If there is no public identifier specified, it passes
|
|---|
| 98 | <a href="qstring.html#QString-null">QString::null</a> in <em>publicId</em>.
|
|---|
| 99 | <p> If this function returns FALSE the reader stops parsing and
|
|---|
| 100 | reports an error. The reader uses the function <a href="#errorString">errorString</a>() to
|
|---|
| 101 | get the error message.
|
|---|
| 102 |
|
|---|
| 103 | <h3 class=fn>bool <a name="internalEntityDecl"></a>QXmlDeclHandler::internalEntityDecl ( const <a href="qstring.html">QString</a> & name, const <a href="qstring.html">QString</a> & value )<tt> [pure virtual]</tt>
|
|---|
| 104 | </h3>
|
|---|
| 105 |
|
|---|
| 106 | <p> The reader calls this function to report an internal entity
|
|---|
| 107 | declaration. Only the effective (first) declaration is reported.
|
|---|
| 108 | <p> The reader passes the name of the entity in <em>name</em> and the value
|
|---|
| 109 | of the entity in <em>value</em>.
|
|---|
| 110 | <p> If this function returns FALSE the reader stops parsing and
|
|---|
| 111 | reports an error. The reader uses the function <a href="#errorString">errorString</a>() to
|
|---|
| 112 | get the error message.
|
|---|
| 113 |
|
|---|
| 114 | <!-- eof -->
|
|---|
| 115 | <hr><p>
|
|---|
| 116 | This file is part of the <a href="index.html">Qt toolkit</a>.
|
|---|
| 117 | Copyright © 1995-2007
|
|---|
| 118 | <a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
|
|---|
| 119 | <table width=100% cellspacing=0 border=0><tr>
|
|---|
| 120 | <td>Copyright © 2007
|
|---|
| 121 | <a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
|
|---|
| 122 | <td align=right><div align=right>Qt 3.3.8</div>
|
|---|
| 123 | </table></div></address></body>
|
|---|
| 124 | </html>
|
|---|
