<?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" />
<!-- qxmlformatter.cpp -->
<title>Qt 4.8: QXmlFormatter 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>QXmlFormatter</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">QXmlFormatter Class Reference</h1>
<!-- $$$QXmlFormatter-brief -->
<p>The QXmlFormatter class is an implementation of <a href="qxmlserializer.html">QXmlSerializer</a> for transforming <a href="xmlprocessing.html">XQuery</a> output into formatted XML. <a href="#details">More...</a></p>
<!-- @@@QXmlFormatter -->
<pre class="cpp"> <span class="preprocessor">#include <QXmlFormatter></span></pre><p><b>Inherits: </b><a href="qxmlserializer.html">QXmlSerializer</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="qxmlformatter-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="qxmlformatter.html#QXmlFormatter">QXmlFormatter</a></b> ( const QXmlQuery & <i>query</i>, QIODevice * <i>outputDevice</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qxmlformatter.html#indentationDepth">indentationDepth</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlformatter.html#setIndentationDepth">setIndentationDepth</a></b> ( int <i>depth</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="qxmlformatter.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="qxmlformatter.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="qxmlformatter.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="qxmlformatter.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="qxmlformatter.html#endDocument">endDocument</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlformatter.html#endElement">endElement</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlformatter.html#endOfSequence">endOfSequence</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlformatter.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="qxmlformatter.html#startDocument">startDocument</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qxmlformatter.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="qxmlformatter.html#startOfSequence">startOfSequence</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">15 public functions inherited from <a href="qxmlserializer.html#public-functions">QXmlSerializer</a></li>
<li class="fn">12 public functions inherited from <a href="qabstractxmlreceiver.html#public-functions">QAbstractXmlReceiver</a></li>
</ul>
<a name="details"></a>
<!-- $$$QXmlFormatter-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QXmlFormatter class is an implementation of <a href="qxmlserializer.html">QXmlSerializer</a> for transforming <a href="xmlprocessing.html">XQuery</a> output into formatted XML.</p>
<p>QXmlFormatter is a subclass of <a href="qxmlserializer.html">QXmlSerializer</a> that formats the XML output to make it easier for humans to read.</p>
<p><a href="qxmlserializer.html">QXmlSerializer</a> outputs XML without adding unnecessary whitespace. In particular, it does not add <i>newlines</i> and indentation. To make the XML output easier to read, QXmlFormatter adds <i>newlines</i> and indentation by adding, removing, and modifying <a href="qabstractxmlreceiver.html#xquery-sequence">sequence nodes</a> that only consist of whitespace. It also modifies whitespace in other places where it is not significant; e.g., between attributes and in the document prologue.</p>
<p>For example, where the base class <a href="qxmlserializer.html">QXmlSerializer</a> would output this:</p>
<pre class="cpp"> <a><b/><c/><p>Some Text</p></a></pre>
<p>QXmlFormatter outputs this:</p>
<pre class="cpp"> <a>
<b/>
<c/>
<p>Some Text</p>
</a></pre>
<p>If you just want to serialize your XML in a human-readable format, use QXmlFormatter as it is. The default indentation level is 4 spaces, but you can set your own indentation value <a href="qxmlformatter.html#setIndentationDepth">setIndentationDepth</a>().</p>
<p>The <i>newlines</i> and indentation added by QXmlFormatter are suitable for common formats, such as XHTML, SVG, or Docbook, where whitespace is not significant. However, if your XML will be used as input where whitespace is significant, then you must write your own subclass of <a href="qxmlserializer.html">QXmlSerializer</a> or <a href="qabstractxmlreceiver.html">QAbstractXmlReceiver</a>.</p>
<p>Note that using QXmlFormatter instead of <a href="qxmlserializer.html">QXmlSerializer</a> will increase computational overhead and document storage size due to the insertion of whitespace.</p>
<p>Note also that the indentation style used by QXmlFormatter remains loosely defined and may change in future versions of Qt. If a specific indentation style is required then either use the base class <a href="qxmlserializer.html">QXmlSerializer</a> directly, or write your own subclass of <a href="qxmlserializer.html">QXmlSerializer</a> or <a href="qabstractxmlreceiver.html">QAbstractXmlReceiver</a>. Alternatively, you can subclass QXmlFormatter and reimplement the callbacks there.</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">QXmlFormatter</span> formatter(query<span class="operator">,</span> myOutputDevice);
formatter<span class="operator">.</span><a href="qxmlformatter.html#setIndentationDepth">setIndentationDepth</a>(<span class="number">2</span>);
query<span class="operator">.</span>evaluateTo(<span class="operator">&</span>formatter);</pre>
</div>
<!-- @@@QXmlFormatter -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QXmlFormatter[overload1]$$$QXmlFormatterconstQXmlQuery&QIODevice* -->
<h3 class="fn"><a name="QXmlFormatter"></a>QXmlFormatter::<span class="name">QXmlFormatter</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 formatter that uses the name pool and message handler in <i>query</i>, and writes the result to <i>outputDevice</i> as formatted XML.</p>
<p><i>outputDevice</i> is passed directly to <a href="qxmlserializer.html">QXmlSerializer</a>'s constructor.</p>
<p><b>See also </b><a href="qxmlserializer.html">QXmlSerializer</a>.</p>
<!-- @@@QXmlFormatter -->
<!-- $$$atomicValue[overload1]$$$atomicValueconstQVariant& -->
<h3 class="fn"><a name="atomicValue"></a><span class="type">void</span> QXmlFormatter::<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> QXmlFormatter::<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> QXmlFormatter::<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 -->
<!-- $$$comment[overload1]$$$commentconstQString& -->
<h3 class="fn"><a name="comment"></a><span class="type">void</span> QXmlFormatter::<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> QXmlFormatter::<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> QXmlFormatter::<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> QXmlFormatter::<span class="name">endOfSequence</span> ()<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#endOfSequence">QAbstractXmlReceiver::endOfSequence</a>().</p>
<!-- @@@endOfSequence -->
<!-- $$$indentationDepth[overload1]$$$indentationDepth -->
<h3 class="fn"><a name="indentationDepth"></a><span class="type">int</span> QXmlFormatter::<span class="name">indentationDepth</span> () const</h3>
<p>Returns the number of spaces <a href="qxmlformatter.html">QXmlFormatter</a> will output for each indentation level. The default is four.</p>
<p><b>See also </b><a href="qxmlformatter.html#setIndentationDepth">setIndentationDepth</a>().</p>
<!-- @@@indentationDepth -->
<!-- $$$processingInstruction[overload1]$$$processingInstructionconstQXmlName&constQString& -->
<h3 class="fn"><a name="processingInstruction"></a><span class="type">void</span> QXmlFormatter::<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 -->
<!-- $$$setIndentationDepth[overload1]$$$setIndentationDepthint -->
<h3 class="fn"><a name="setIndentationDepth"></a><span class="type">void</span> QXmlFormatter::<span class="name">setIndentationDepth</span> ( <span class="type">int</span> <i>depth</i> )</h3>
<p>Sets <i>depth</i> to be the number of spaces <a href="qxmlformatter.html">QXmlFormatter</a> will output for level of indentation. The default is four.</p>
<p><b>See also </b><a href="qxmlformatter.html#indentationDepth">indentationDepth</a>().</p>
<!-- @@@setIndentationDepth -->
<!-- $$$startDocument[overload1]$$$startDocument -->
<h3 class="fn"><a name="startDocument"></a><span class="type">void</span> QXmlFormatter::<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> QXmlFormatter::<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> QXmlFormatter::<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>
