<?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" /> <!-- qxmlserializer.cpp --> <title>Qt 4.8: QXmlSerializer 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="qtxmlpatterns.html">QtXmlPatterns</a></li> <li>QXmlSerializer</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">QXmlSerializer Class Reference</h1> <!-- $$$QXmlSerializer-brief --> <p>The QXmlSerializer class is an implementation of <a href="qabstractxmlreceiver.html">QAbstractXmlReceiver</a> for transforming <a href="xmlprocessing.html">XQuery</a> output into unformatted XML. <a href="#details">More...</a></p> <!-- @@@QXmlSerializer --> <pre class="cpp"> <span class="preprocessor">#include <QXmlSerializer></span></pre><p><b>Inherits: </b><a href="qabstractxmlreceiver.html">QAbstractXmlReceiver</a>.</p> <p><b>Inherited by: </b><a href="qxmlformatter.html">QXmlFormatter</a>.</p> <p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p> <p>This class was introduced in Qt 4.4.</p> <ul> <li><a href="qxmlserializer-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"> </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#QXmlSerializer">QXmlSerializer</a></b> ( const QXmlQuery & <i>query</i>, QIODevice * <i>outputDevice</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> const QTextCodec * </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#codec">codec</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QIODevice * </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#outputDevice">outputDevice</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#setCodec">setCodec</a></b> ( const QTextCodec * <i>outputCodec</i> )</td></tr> </table> <a name="reimplemented-public-functions"></a> <h2>Reimplemented Public Functions</h2> <table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#atomicValue">atomicValue</a></b> ( const QVariant & <i>value</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#attribute">attribute</a></b> ( const QXmlName & <i>name</i>, const QStringRef & <i>value</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#characters">characters</a></b> ( const QStringRef & <i>value</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#comment">comment</a></b> ( const QString & <i>value</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#endDocument">endDocument</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#endElement">endElement</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#endOfSequence">endOfSequence</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#namespaceBinding">namespaceBinding</a></b> ( const QXmlName & <i>nb</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#processingInstruction">processingInstruction</a></b> ( const QXmlName & <i>name</i>, const QString & <i>value</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#startDocument">startDocument</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#startElement">startElement</a></b> ( const QXmlName & <i>name</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlserializer.html#startOfSequence">startOfSequence</a></b> ()</td></tr> </table> <ul> <li class="fn">12 public functions inherited from <a href="qabstractxmlreceiver.html#public-functions">QAbstractXmlReceiver</a></li> </ul> <a name="details"></a> <!-- $$$QXmlSerializer-description --> <div class="descr"> <h2>Detailed Description</h2> <p>The QXmlSerializer class is an implementation of <a href="qabstractxmlreceiver.html">QAbstractXmlReceiver</a> for transforming <a href="xmlprocessing.html">XQuery</a> output into unformatted XML.</p> <p>QXmlSerializer translates an <a href="qabstractxmlreceiver.html#xquery-sequence">XQuery sequence</a>, usually the output of an <a href="qxmlquery.html">QXmlQuery</a>, into XML. Consider the example:</p> <pre class="cpp"> <span class="type"><a href="qxmlquery.html">QXmlQuery</a></span> query; query<span class="operator">.</span>setQuery(<span class="string">"doc('index.html')/html/body/p[1]"</span>); <span class="type">QXmlSerializer</span> serializer(query<span class="operator">,</span> myOutputDevice); query<span class="operator">.</span>evaluateTo(<span class="operator">&</span>serializer);</pre> <p>First it constructs a <a href="qxmlquery.html">query</a> that gets the first paragraph from document <tt>index.html</tt>. Then it constructs an instance of this class with the <a href="qxmlquery.html">query</a> and <a href="qiodevice.html">myOutputDevice</a>. Finally, it <a href="qxmlquery.html#evaluateTo">evaluates</a> the <a href="qxmlquery.html">query</a>, producing an ordered sequence of calls to the serializer's callback functions. The sequence of callbacks transforms the query output to XML and writes it to <a href="qiodevice.html">myOutputDevice</a>.</p> <p>QXmlSerializer will:</p> <ul> <li>Declare namespaces when needed,</li> <li>Use appropriate escaping, when characters can't be represented in the XML,</li> <li>Handle line endings appropriately,</li> <li>Report errors, when it can't serialize the content, e.g., when asked to serialize an attribute that is a top-level node, or when more than one top-level element is encountered.</li> </ul> <p>If an error occurs during serialization, result is undefined unless the serializer is driven through a call to <a href="qxmlquery.html#evaluateTo">QXmlQuery::evaluateTo</a>().</p> <p>If the generated XML should be indented and formatted for reading, use <a href="qxmlformatter.html">QXmlFormatter</a>.</p> </div> <p><b>See also </b><a href="http://www.w3.org/TR/xslt-xquery-serialization/">XSLT 2.0 and XQuery 1.0 Serialization</a> and <a href="qxmlformatter.html">QXmlFormatter</a>.</p> <!-- @@@QXmlSerializer --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QXmlSerializer[overload1]$$$QXmlSerializerconstQXmlQuery&QIODevice* --> <h3 class="fn"><a name="QXmlSerializer"></a>QXmlSerializer::<span class="name">QXmlSerializer</span> ( const <span class="type"><a href="qxmlquery.html">QXmlQuery</a></span> & <i>query</i>, <span class="type"><a href="qiodevice.html">QIODevice</a></span> * <i>outputDevice</i> )</h3> <p>Constructs a serializer that uses the name pool and message handler in <i>query</i>, and writes the output to <i>outputDevice</i>.</p> <p><i>outputDevice</i> must be a valid, non-null device that is open in write mode, otherwise behavior is undefined.</p> <p><i>outputDevice</i> must not be opened with <a href="qiodevice.html#OpenModeFlag-enum">QIODevice::Text</a> because it will cause the output to be incorrect. This class will ensure line endings are serialized as according with the XML specification. <a href="qxmlserializer.html">QXmlSerializer</a> does not take ownership of <i>outputDevice</i>.</p> <!-- @@@QXmlSerializer --> <!-- $$$atomicValue[overload1]$$$atomicValueconstQVariant& --> <h3 class="fn"><a name="atomicValue"></a><span class="type">void</span> QXmlSerializer::<span class="name">atomicValue</span> ( const <span class="type"><a href="qvariant.html">QVariant</a></span> & <i>value</i> )<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#atomicValue">QAbstractXmlReceiver::atomicValue</a>().</p> <!-- @@@atomicValue --> <!-- $$$attribute[overload1]$$$attributeconstQXmlName&constQStringRef& --> <h3 class="fn"><a name="attribute"></a><span class="type">void</span> QXmlSerializer::<span class="name">attribute</span> ( const <span class="type"><a href="qxmlname.html">QXmlName</a></span> & <i>name</i>, const <span class="type"><a href="qstringref.html">QStringRef</a></span> & <i>value</i> )<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#attribute">QAbstractXmlReceiver::attribute</a>().</p> <!-- @@@attribute --> <!-- $$$characters[overload1]$$$charactersconstQStringRef& --> <h3 class="fn"><a name="characters"></a><span class="type">void</span> QXmlSerializer::<span class="name">characters</span> ( const <span class="type"><a href="qstringref.html">QStringRef</a></span> & <i>value</i> )<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#characters">QAbstractXmlReceiver::characters</a>().</p> <!-- @@@characters --> <!-- $$$codec[overload1]$$$codec --> <h3 class="fn"><a name="codec"></a>const <span class="type"><a href="qtextcodec.html">QTextCodec</a></span> * QXmlSerializer::<span class="name">codec</span> () const</h3> <p>Returns the codec being used by the serializer for encoding its XML output.</p> <p><b>See also </b><a href="qxmlserializer.html#setCodec">setCodec</a>().</p> <!-- @@@codec --> <!-- $$$comment[overload1]$$$commentconstQString& --> <h3 class="fn"><a name="comment"></a><span class="type">void</span> QXmlSerializer::<span class="name">comment</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>value</i> )<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#comment">QAbstractXmlReceiver::comment</a>().</p> <!-- @@@comment --> <!-- $$$endDocument[overload1]$$$endDocument --> <h3 class="fn"><a name="endDocument"></a><span class="type">void</span> QXmlSerializer::<span class="name">endDocument</span> ()<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#endDocument">QAbstractXmlReceiver::endDocument</a>().</p> <!-- @@@endDocument --> <!-- $$$endElement[overload1]$$$endElement --> <h3 class="fn"><a name="endElement"></a><span class="type">void</span> QXmlSerializer::<span class="name">endElement</span> ()<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#endElement">QAbstractXmlReceiver::endElement</a>().</p> <!-- @@@endElement --> <!-- $$$endOfSequence[overload1]$$$endOfSequence --> <h3 class="fn"><a name="endOfSequence"></a><span class="type">void</span> QXmlSerializer::<span class="name">endOfSequence</span> ()<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#endOfSequence">QAbstractXmlReceiver::endOfSequence</a>().</p> <!-- @@@endOfSequence --> <!-- $$$namespaceBinding[overload1]$$$namespaceBindingconstQXmlName& --> <h3 class="fn"><a name="namespaceBinding"></a><span class="type">void</span> QXmlSerializer::<span class="name">namespaceBinding</span> ( const <span class="type"><a href="qxmlname.html">QXmlName</a></span> & <i>nb</i> )<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#namespaceBinding">QAbstractXmlReceiver::namespaceBinding</a>().</p> <!-- @@@namespaceBinding --> <!-- $$$outputDevice[overload1]$$$outputDevice --> <h3 class="fn"><a name="outputDevice"></a><span class="type"><a href="qiodevice.html">QIODevice</a></span> * QXmlSerializer::<span class="name">outputDevice</span> () const</h3> <p>Returns a pointer to the output device. There is no corresponding function to <i>set</i> the output device, because the output device must be passed to the constructor. The serializer does not take ownership of its IO device.</p> <!-- @@@outputDevice --> <!-- $$$processingInstruction[overload1]$$$processingInstructionconstQXmlName&constQString& --> <h3 class="fn"><a name="processingInstruction"></a><span class="type">void</span> QXmlSerializer::<span class="name">processingInstruction</span> ( const <span class="type"><a href="qxmlname.html">QXmlName</a></span> & <i>name</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>value</i> )<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#processingInstruction">QAbstractXmlReceiver::processingInstruction</a>().</p> <!-- @@@processingInstruction --> <!-- $$$setCodec[overload1]$$$setCodecconstQTextCodec* --> <h3 class="fn"><a name="setCodec"></a><span class="type">void</span> QXmlSerializer::<span class="name">setCodec</span> ( const <span class="type"><a href="qtextcodec.html">QTextCodec</a></span> * <i>outputCodec</i> )</h3> <p>Sets the codec the serializer will use for encoding its XML output. The output codec is set to <i>outputCodec</i>. By default, the output codec is set to the one for <tt>UTF-8</tt>. The serializer does not take ownership of the codec.</p> <p><b>See also </b><a href="qxmlserializer.html#codec">codec</a>().</p> <!-- @@@setCodec --> <!-- $$$startDocument[overload1]$$$startDocument --> <h3 class="fn"><a name="startDocument"></a><span class="type">void</span> QXmlSerializer::<span class="name">startDocument</span> ()<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#startDocument">QAbstractXmlReceiver::startDocument</a>().</p> <!-- @@@startDocument --> <!-- $$$startElement[overload1]$$$startElementconstQXmlName& --> <h3 class="fn"><a name="startElement"></a><span class="type">void</span> QXmlSerializer::<span class="name">startElement</span> ( const <span class="type"><a href="qxmlname.html">QXmlName</a></span> & <i>name</i> )<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#startElement">QAbstractXmlReceiver::startElement</a>().</p> <!-- @@@startElement --> <!-- $$$startOfSequence[overload1]$$$startOfSequence --> <h3 class="fn"><a name="startOfSequence"></a><span class="type">void</span> QXmlSerializer::<span class="name">startOfSequence</span> ()<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstractxmlreceiver.html#startOfSequence">QAbstractXmlReceiver::startOfSequence</a>().</p> <!-- @@@startOfSequence --> </div> </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>