<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qxmlformatter.cpp -->
<title>QXmlFormatter Class | Qt XML Patterns 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtxmlpatterns-index.html">Qt XML Patterns</a></td><td ><a href="qtxmlpatterns-module.html">C++ Classes</a></td><td >QXmlFormatter</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<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="#reimplemented-public-functions">Reimplemented Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QXmlFormatter Class</h1>
<!-- $$$QXmlFormatter-brief -->
<p>The <a href="qxmlformatter.html">QXmlFormatter</a> 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 -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QXmlFormatter></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += xmlpatterns</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.4</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qxmlserializer.html">QXmlSerializer</a></td></tr></table></div><ul>
<li><a href="qxmlformatter-members.html">List of all members, including inherited members</a></li>
</ul>
<p><b>Note:</b> All functions in this class are reentrant.</p>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><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></div>
<a name="reimplemented-public-functions"></a>
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
<div class="table"><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></div>
<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 id="details">Detailed Description</h2>
<p>The <a href="qxmlformatter.html">QXmlFormatter</a> 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><a href="qxmlformatter.html">QXmlFormatter</a> 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, <a href="qxmlformatter.html">QXmlFormatter</a> 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><a href="qxmlformatter.html">QXmlFormatter</a> 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 <a href="qxmlformatter.html">QXmlFormatter</a> 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 <a href="qxmlformatter.html">QXmlFormatter</a> 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 <a href="qxmlformatter.html">QXmlFormatter</a> 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 <a href="qxmlformatter.html">QXmlFormatter</a> 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 <a href="qxmlformatter.html">QXmlFormatter</a> 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"><a href="qxmlformatter.html#QXmlFormatter">QXmlFormatter</a></span> formatter(query<span class="operator">,</span> myOutputDevice);
formatter<span class="operator">.</span>setIndentationDepth(<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" id="QXmlFormatter"><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">QIODevice</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" id="atomicValue"><a name="atomicValue"></a><code>[virtual] </code><span class="type">void</span> QXmlFormatter::<span class="name">atomicValue</span>(const <span class="type">QVariant</span> &<i>value</i>)</h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#atomicValue">QAbstractXmlReceiver::atomicValue</a>().</p>
<!-- @@@atomicValue -->
<!-- $$$attribute[overload1]$$$attributeconstQXmlName&constQStringRef& -->
<h3 class="fn" id="attribute"><a name="attribute"></a><code>[virtual] </code><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">QStringRef</span> &<i>value</i>)</h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#attribute">QAbstractXmlReceiver::attribute</a>().</p>
<!-- @@@attribute -->
<!-- $$$characters[overload1]$$$charactersconstQStringRef& -->
<h3 class="fn" id="characters"><a name="characters"></a><code>[virtual] </code><span class="type">void</span> QXmlFormatter::<span class="name">characters</span>(const <span class="type">QStringRef</span> &<i>value</i>)</h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#characters">QAbstractXmlReceiver::characters</a>().</p>
<!-- @@@characters -->
<!-- $$$comment[overload1]$$$commentconstQString& -->
<h3 class="fn" id="comment"><a name="comment"></a><code>[virtual] </code><span class="type">void</span> QXmlFormatter::<span class="name">comment</span>(const <span class="type">QString</span> &<i>value</i>)</h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#comment">QAbstractXmlReceiver::comment</a>().</p>
<!-- @@@comment -->
<!-- $$$endDocument[overload1]$$$endDocument -->
<h3 class="fn" id="endDocument"><a name="endDocument"></a><code>[virtual] </code><span class="type">void</span> QXmlFormatter::<span class="name">endDocument</span>()</h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#endDocument">QAbstractXmlReceiver::endDocument</a>().</p>
<!-- @@@endDocument -->
<!-- $$$endElement[overload1]$$$endElement -->
<h3 class="fn" id="endElement"><a name="endElement"></a><code>[virtual] </code><span class="type">void</span> QXmlFormatter::<span class="name">endElement</span>()</h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#endElement">QAbstractXmlReceiver::endElement</a>().</p>
<!-- @@@endElement -->
<!-- $$$endOfSequence[overload1]$$$endOfSequence -->
<h3 class="fn" id="endOfSequence"><a name="endOfSequence"></a><code>[virtual] </code><span class="type">void</span> QXmlFormatter::<span class="name">endOfSequence</span>()</h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#endOfSequence">QAbstractXmlReceiver::endOfSequence</a>().</p>
<!-- @@@endOfSequence -->
<!-- $$$indentationDepth[overload1]$$$indentationDepth -->
<h3 class="fn" id="indentationDepth"><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" id="processingInstruction"><a name="processingInstruction"></a><code>[virtual] </code><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">QString</span> &<i>value</i>)</h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#processingInstruction">QAbstractXmlReceiver::processingInstruction</a>().</p>
<!-- @@@processingInstruction -->
<!-- $$$setIndentationDepth[overload1]$$$setIndentationDepthint -->
<h3 class="fn" id="setIndentationDepth"><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" id="startDocument"><a name="startDocument"></a><code>[virtual] </code><span class="type">void</span> QXmlFormatter::<span class="name">startDocument</span>()</h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#startDocument">QAbstractXmlReceiver::startDocument</a>().</p>
<!-- @@@startDocument -->
<!-- $$$startElement[overload1]$$$startElementconstQXmlName& -->
<h3 class="fn" id="startElement"><a name="startElement"></a><code>[virtual] </code><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>)</h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#startElement">QAbstractXmlReceiver::startElement</a>().</p>
<!-- @@@startElement -->
<!-- $$$startOfSequence[overload1]$$$startOfSequence -->
<h3 class="fn" id="startOfSequence"><a name="startOfSequence"></a><code>[virtual] </code><span class="type">void</span> QXmlFormatter::<span class="name">startOfSequence</span>()</h3>
<p>Reimplemented from <a href="qabstractxmlreceiver.html#startOfSequence">QAbstractXmlReceiver::startOfSequence</a>().</p>
<!-- @@@startOfSequence -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> 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.<br> 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. </p>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
9026c9fecbedd778b04292bd6f2d9049
>
files
>
83
