<?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" />
<!-- xml-processing.qdoc -->
<title>Qt 4.8: XML Streaming</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>XML Streaming</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">
<link rel="prev" href="xml-namespaces.html" />
<link rel="next" href="xml-sax.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="xml-namespaces.html">An Introduction to Namespaces</a>
<a class="nextPage" href="xml-sax.html">The SAX interface</a>
</p><p/>
<h1 class="title">XML Streaming</h1>
<span class="subtitle"></span>
<!-- $$$xml-streaming.html-description -->
<div class="descr"> <a name="details"></a>
<p>Since version 4.3, Qt provides two new classes for reading and writing XML: <a href="qxmlstreamreader.html">QXmlStreamReader</a> and <a href="qxmlstreamwriter.html">QXmlStreamWriter</a>.</p>
<p>The <a href="qxmlstreamreader.html">QXmlStreamReader</a> and <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> are two new classes provided in Qt 4.3 and later. A stream reader reports an XML document as a stream of tokens. This differs from SAX as SAX applications provide handlers to receive XML events from the parser whereas the <a href="qxmlstreamreader.html">QXmlStreamReader</a> drives the loop, pulling tokens from the reader when they are needed. This pulling approach makes it possible to build recursive descent parsers, allowing XML parsing code to be split into different methods or classes.</p>
<p><a href="qxmlstreamreader.html">QXmlStreamReader</a> is a well-formed XML 1.0 parser that excludes external parsed entities. Hence, data provided by the stream reader adheres to the W3C's criteria for well-formed XML, as long as no error occurs. Otherwise, functions such as <a href="qxmlstreamreader.html#atEnd">atEnd()</a>, <a href="qxmlstreamreader.html#error">error()</a> and <a href="qxmlstreamreader.html#hasError">hasError()</a> can be used to check and view the errors.</p>
<p>An example of <a href="qxmlstreamreader.html">QXmlStreamReader</a> implementation would be the <tt>XbelReader</tt> in <a href="xml-streambookmarks.html">QXmlStream Bookmarks Example</a>, which is a subclass of <a href="qxmlstreamreader.html">QXmlStreamReader</a>. The constructor takes <i>treeWidget</i> as a parameter and the class has Xbel specific functions:</p>
<pre class="cpp"> XbelReader(<span class="type"><a href="qtreewidget.html">QTreeWidget</a></span> <span class="operator">*</span>treeWidget);
...
<span class="type">void</span> readXBEL();
<span class="type">void</span> readTitle(<span class="type"><a href="qtreewidgetitem.html">QTreeWidgetItem</a></span> <span class="operator">*</span>item);
<span class="type">void</span> readSeparator(<span class="type"><a href="qtreewidgetitem.html">QTreeWidgetItem</a></span> <span class="operator">*</span>item);
<span class="type">void</span> readFolder(<span class="type"><a href="qtreewidgetitem.html">QTreeWidgetItem</a></span> <span class="operator">*</span>item);
<span class="type">void</span> readBookmark(<span class="type"><a href="qtreewidgetitem.html">QTreeWidgetItem</a></span> <span class="operator">*</span>item);
<span class="type"><a href="qtreewidgetitem.html">QTreeWidgetItem</a></span> <span class="operator">*</span>createChildItem(<span class="type"><a href="qtreewidgetitem.html">QTreeWidgetItem</a></span> <span class="operator">*</span>item);
<span class="type"><a href="qxmlstreamreader.html">QXmlStreamReader</a></span> xml;
<span class="type"><a href="qtreewidget.html">QTreeWidget</a></span> <span class="operator">*</span>treeWidget;
...</pre>
<p>The <tt>read()</tt> function accepts a <a href="qiodevice.html">QIODevice</a> and sets it with <a href="qxmlstreamreader.html#setDevice">setDevice()</a>. The <a href="qxmlstreamreader.html#raiseError">raiseError()</a> function is used to display a custom error message, inidicating that the file's version is incorrect.</p>
<pre class="cpp"> <span class="type">bool</span> XbelReader<span class="operator">::</span>read(<span class="type"><a href="qiodevice.html">QIODevice</a></span> <span class="operator">*</span>device)
{
xml<span class="operator">.</span>setDevice(device);
<span class="keyword">if</span> (xml<span class="operator">.</span>readNextStartElement()) {
<span class="keyword">if</span> (xml<span class="operator">.</span>name() <span class="operator">=</span><span class="operator">=</span> <span class="string">"xbel"</span> <span class="operator">&</span><span class="operator">&</span> xml<span class="operator">.</span>attributes()<span class="operator">.</span>value(<span class="string">"version"</span>) <span class="operator">=</span><span class="operator">=</span> <span class="string">"1.0"</span>)
readXBEL();
<span class="keyword">else</span>
xml<span class="operator">.</span>raiseError(<span class="type"><a href="qobject.html">QObject</a></span><span class="operator">::</span>tr(<span class="string">"The file is not an XBEL version 1.0 file."</span>));
}
<span class="keyword">return</span> <span class="operator">!</span>xml<span class="operator">.</span>error();
}</pre>
<p>The pendent to <a href="qxmlstreamreader.html">QXmlStreamReader</a> is <a href="qxmlstreamwriter.html">QXmlStreamWriter</a>, which provides an XML writer with a simple streaming API. <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> operates on a <a href="qiodevice.html">QIODevice</a> and has specialised functions for all XML tokens or events you want to write, such as <a href="qxmlstreamwriter.html#writeDTD">writeDTD()</a>, <a href="qxmlstreamwriter.html#writeCharacters">writeCharacters()</a>, <a href="qxmlstreamwriter.html#writeComment">writeComment()</a> and so on.</p>
<p>To write XML document with <a href="qxmlstreamwriter.html">QXmlStreamWriter</a>, you start a document with the <a href="qxmlstreamwriter.html#writeStartDocument">writeStartDocument()</a> function and end it with <a href="qxmlstreamwriter.html#writeEndDocument">writeEndDocument()</a>, which implicitly closes all remaining open tags. Element tags are opened with <a href="qxmlstreamwriter.html#writeStartDocument">writeStartDocument()</a> and followed by <a href="qxmlstreamwriter.html#writeAttribute">writeAttribute()</a> or <a href="qxmlstreamwriter.html#writeAttributes">writeAttributes()</a>, element content, and then <a href="qxmlstreamwriter.html#writeEndDocument">writeEndDocument()</a>. Also, <a href="qxmlstreamwriter.html#writeEmptyElement">writeEmptyElement()</a> can be used to write empty elements.</p>
<p>Element content comprises characters, entity references or nested elements. Content can be written with <a href="qxmlstreamwriter.html#writeCharacters">writeCharacters()</a>, a function that also takes care of escaping all forbidden characters and character sequences, <a href="qxmlstreamwriter.html#writeEntityReference">writeEntityReference()</a>, or subsequent calls to <a href="qxmlstreamwriter.html#writeStartElement">writeStartElement()</a>.</p>
<p>The <tt>XbelWriter</tt> class from <a href="xml-streambookmarks.html">QXmlStream Bookmarks Example</a> is a subclass of <a href="qxmlstreamwriter.html">QXmlStreamWriter</a>. Its <tt>writeFile()</tt> function illustrates the core functions of <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> mentioned above:</p>
<pre class="cpp"> <span class="type">bool</span> XbelWriter<span class="operator">::</span>writeFile(<span class="type"><a href="qiodevice.html">QIODevice</a></span> <span class="operator">*</span>device)
{
xml<span class="operator">.</span>setDevice(device);
xml<span class="operator">.</span>writeStartDocument();
xml<span class="operator">.</span>writeDTD(<span class="string">"<!DOCTYPE xbel>"</span>);
xml<span class="operator">.</span>writeStartElement(<span class="string">"xbel"</span>);
xml<span class="operator">.</span>writeAttribute(<span class="string">"version"</span><span class="operator">,</span> <span class="string">"1.0"</span>);
<span class="keyword">for</span> (<span class="type">int</span> i <span class="operator">=</span> <span class="number">0</span>; i <span class="operator"><</span> treeWidget<span class="operator">-</span><span class="operator">></span>topLevelItemCount(); <span class="operator">+</span><span class="operator">+</span>i)
writeItem(treeWidget<span class="operator">-</span><span class="operator">></span>topLevelItem(i));
xml<span class="operator">.</span>writeEndDocument();
<span class="keyword">return</span> <span class="keyword">true</span>;
}</pre>
</div>
<!-- @@@xml-streaming.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="xml-namespaces.html">An Introduction to Namespaces</a>
<a class="nextPage" href="xml-sax.html">The SAX interface</a>
</p>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
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>
Qt and respective logos are trademarks of The Qt Company Ltd
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>
