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
113
114
115
116
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qxml.cpp -->
<title>Qt 4.8: QXmlDeclHandler Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtxml.html">QtXml</a></li>
<li>QXmlDeclHandler</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QXmlDeclHandler Class Reference</h1>
<!-- $$$QXmlDeclHandler-brief -->
<p>The QXmlDeclHandler class provides an interface to report declaration content of XML data. <a href="#details">More...</a></p>
<!-- @@@QXmlDeclHandler -->
<pre class="cpp"> <span class="preprocessor">#include <QXmlDeclHandler></span></pre><p><b>Inherited by: </b><a href="qxmldefaulthandler.html">QXmlDefaultHandler</a>.</p>
<p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<ul>
<li><a href="qxmldeclhandler-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qxmldeclhandler.html#dtor.QXmlDeclHandler">~QXmlDeclHandler</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qxmldeclhandler.html#attributeDecl">attributeDecl</a></b> ( const QString & <i>eName</i>, const QString & <i>aName</i>, const QString & <i>type</i>, const QString & <i>valueDefault</i>, const QString & <i>value</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qxmldeclhandler.html#errorString">errorString</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qxmldeclhandler.html#externalEntityDecl">externalEntityDecl</a></b> ( const QString & <i>name</i>, const QString & <i>publicId</i>, const QString & <i>systemId</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qxmldeclhandler.html#internalEntityDecl">internalEntityDecl</a></b> ( const QString & <i>name</i>, const QString & <i>value</i> ) = 0</td></tr>
</table>
<a name="details"></a>
<!-- $$$QXmlDeclHandler-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QXmlDeclHandler class provides an interface to report declaration content of XML data.</p>
<p>You can set the declaration handler with <a href="qxmlreader.html#setDeclHandler">QXmlReader::setDeclHandler</a>().</p>
<p>This interface is based on the SAX2 extension DeclHandler.</p>
<p>The interface provides <a href="qxmldeclhandler.html#attributeDecl">attributeDecl</a>(), <a href="qxmldeclhandler.html#internalEntityDecl">internalEntityDecl</a>() and <a href="qxmldeclhandler.html#externalEntityDecl">externalEntityDecl</a>() functions.</p>
</div>
<p><b>See also </b><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-sax.html#introduction-to-sax2">Introduction to SAX2</a>.</p>
<!-- @@@QXmlDeclHandler -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$~QXmlDeclHandler[overload1]$$$~QXmlDeclHandler -->
<h3 class="fn"><a name="dtor.QXmlDeclHandler"></a>QXmlDeclHandler::<span class="name">~QXmlDeclHandler</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the declaration handler.</p>
<!-- @@@~QXmlDeclHandler -->
<!-- $$$attributeDecl[overload1]$$$attributeDeclconstQString&constQString&constQString&constQString&constQString& -->
<h3 class="fn"><a name="attributeDecl"></a><span class="type">bool</span> QXmlDeclHandler::<span class="name">attributeDecl</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>eName</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>aName</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>type</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>valueDefault</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>value</i> )<tt> [pure virtual]</tt></h3>
<p>The reader calls this function to report an attribute type declaration. Only the effective (first) declaration for an attribute is reported.</p>
<p>The reader passes the name of the associated element in <i>eName</i> and the name of the attribute in <i>aName</i>. It passes a string that represents the attribute type in <i>type</i> and a string that represents the attribute default in <i>valueDefault</i>. This string is one of "#IMPLIED", "#REQUIRED", "#FIXED" or an empty string (if none of the others applies). The reader passes the attribute's default value in <i>value</i>. If no default value is specified in the XML file, <i>value</i> is an empty string.</p>
<p>If this function returns false the reader stops parsing and reports an error. The reader uses the function <a href="qxmldeclhandler.html#errorString">errorString</a>() to get the error message.</p>
<!-- @@@attributeDecl -->
<!-- $$$errorString[overload1]$$$errorString -->
<h3 class="fn"><a name="errorString"></a><span class="type"><a href="qstring.html">QString</a></span> QXmlDeclHandler::<span class="name">errorString</span> () const<tt> [pure virtual]</tt></h3>
<p>The reader calls this function to get an error string if any of the handler functions returns false.</p>
<!-- @@@errorString -->
<!-- $$$externalEntityDecl[overload1]$$$externalEntityDeclconstQString&constQString&constQString& -->
<h3 class="fn"><a name="externalEntityDecl"></a><span class="type">bool</span> QXmlDeclHandler::<span class="name">externalEntityDecl</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>publicId</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>systemId</i> )<tt> [pure virtual]</tt></h3>
<p>The reader calls this function to report a parsed external entity declaration. Only the effective (first) declaration for each entity is reported.</p>
<p>The reader passes the name of the entity in <i>name</i>, the public identifier in <i>publicId</i> and the system identifier in <i>systemId</i>. If there is no public identifier specified, it passes an empty string in <i>publicId</i>.</p>
<p>If this function returns false the reader stops parsing and reports an error. The reader uses the function <a href="qxmldeclhandler.html#errorString">errorString</a>() to get the error message.</p>
<!-- @@@externalEntityDecl -->
<!-- $$$internalEntityDecl[overload1]$$$internalEntityDeclconstQString&constQString& -->
<h3 class="fn"><a name="internalEntityDecl"></a><span class="type">bool</span> QXmlDeclHandler::<span class="name">internalEntityDecl</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>value</i> )<tt> [pure virtual]</tt></h3>
<p>The reader calls this function to report an internal entity declaration. Only the effective (first) declaration is reported.</p>
<p>The reader passes the name of the entity in <i>name</i> and the value of the entity in <i>value</i>.</p>
<p>If this function returns false the reader stops parsing and reports an error. The reader uses the function <a href="qxmldeclhandler.html#errorString">errorString</a>() to get the error message.</p>
<!-- @@@internalEntityDecl -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
