<?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/style.css" /> <script src="scripts/jquery.js" type="text/javascript"></script> <script src="scripts/functions.js" type="text/javascript"></script> <link rel="stylesheet" type="text/css" href="style/superfish.css" /> <link rel="stylesheet" type="text/css" href="style/narrow.css" /> <!--[if IE]> <meta name="MSSmartTagsPreventParsing" content="true"> <meta http-equiv="imagetoolbar" content="no"> <![endif]--> <!--[if lt IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie6.css"> <![endif]--> <!--[if IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie7.css"> <![endif]--> <!--[if IE 8]> <link rel="stylesheet" type="text/css" href="style/style_ie8.css"> <![endif]--> <script src="scripts/superfish.js" type="text/javascript"></script> <script src="scripts/narrow.js" type="text/javascript"></script> </head> <body class="" onload="CheckEmptyAndLoadList();"> <div class="header" id="qtdocheader"> <div class="content"> <div id="nav-logo"> <a href="index.html">Home</a></div> <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a> <div id="narrowsearch"></div> <div id="nav-topright"> <ul> <li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li> <li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li> <li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/"> DOC</a></li> <li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li> </ul> </div> <div id="shortCut"> <ul> <li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li> <li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li> </ul> </div> <ul class="sf-menu" id="narrowmenu"> <li><a href="#">API Lookup</a> <ul> <li><a href="classes.html">Class index</a></li> <li><a href="functions.html">Function index</a></li> <li><a href="modules.html">Modules</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="qtglobal.html">Global Declarations</a></li> <li><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </li> <li><a href="#">Qt Topics</a> <ul> <li><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li><a href="supported-platforms.html">Supported Platforms</a></li> <li><a href="technology-apis.html">Qt and Key Technologies</a></li> <li><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </li> <li><a href="#">Examples</a> <ul> <li><a href="all-examples.html">Examples</a></li> <li><a href="tutorials.html">Tutorials</a></li> <li><a href="demos.html">Demos</a></li> <li><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </li> </ul> </div> </div> <div class="wrapper"> <div class="hd"> <span></span> </div> <div class="bd group"> <div class="sidebar"> <div class="searchlabel"> Search index:</div> <div class="search" id="sidebarsearch"> <form id="qtdocsearch" action="" onsubmit="return false;"> <fieldset> <input type="text" name="searchstring" id="pageType" value="" /> <div id="resultdialog"> <a href="#" id="resultclose">Close</a> <p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p> <p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p> <ul id="resultlist" class="all"> </ul> </div> </fieldset> </form> </div> <div class="box first bottombar" id="lookup"> <h2 title="API Lookup"><span></span> API Lookup</h2> <div id="list001" class="list"> <ul id="ul001" > <li class="defaultLink"><a href="classes.html">Class index</a></li> <li class="defaultLink"><a href="functions.html">Function index</a></li> <li class="defaultLink"><a href="modules.html">Modules</a></li> <li class="defaultLink"><a href="namespaces.html">Namespaces</a></li> <li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li> <li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </div> </div> <div class="box bottombar" id="topics"> <h2 title="Qt Topics"><span></span> Qt Topics</h2> <div id="list002" class="list"> <ul id="ul002" > <li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li> <li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li> <li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </div> </div> <div class="box" id="examples"> <h2 title="Examples"><span></span> Examples</h2> <div id="list003" class="list"> <ul id="ul003"> <li class="defaultLink"><a href="all-examples.html">Examples</a></li> <li class="defaultLink"><a href="tutorials.html">Tutorials</a></li> <li class="defaultLink"><a href="demos.html">Demos</a></li> <li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </div> </div> </div> <div class="wrap"> <div class="toolbar"> <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 class="toolbuttons toolblock"> <ul> <li id="smallA" class="t_button">A</li> <li id="medA" class="t_button active">A</li> <li id="bigA" class="t_button">A</li> <li id="print" class="t_button"><a href="javascript:this.print();"> <span>Print</span></a></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> </div> </div> <div class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2013 Digia Plc 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> Digia, Qt and their respective logos are trademarks of Digia Plc 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> <script src="scripts/functions.js" type="text/javascript"></script> </body> </html>