<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qxmlstream.cpp -->
<title>QXmlStreamWriter Class | Qt Core 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="qtcore-index.html">Qt Core</a></td><td ><a href="qtcore-module.html">C++ Classes</a></td><td >QXmlStreamWriter</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="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">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">QXmlStreamWriter Class</h1>
<!-- $$$QXmlStreamWriter-brief -->
<p>The <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> class provides an XML writer with a simple streaming API. <a href="#details">More...</a></p>
<!-- @@@QXmlStreamWriter -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QXmlStreamWriter></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += core</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.3</td></tr></table></div><ul>
<li><a href="qxmlstreamwriter-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="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qxmlstreamwriter.html#autoFormatting-prop">autoFormatting</a></b> : bool</li>
<li class="fn"><b><a href="qxmlstreamwriter.html#autoFormattingIndent-prop">autoFormattingIndent</a></b> : int</li>
</ul>
<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="qxmlstreamwriter.html#QXmlStreamWriter">QXmlStreamWriter</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#QXmlStreamWriter-1">QXmlStreamWriter</a></b>(QIODevice *<i>device</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#QXmlStreamWriter-2">QXmlStreamWriter</a></b>(QByteArray *<i>array</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#QXmlStreamWriter-3">QXmlStreamWriter</a></b>(QString *<i>string</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#dtor.QXmlStreamWriter">~QXmlStreamWriter</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#autoFormatting">autoFormatting</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#autoFormattingIndent-prop">autoFormattingIndent</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextCodec *</td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#codec">codec</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QIODevice *</td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#device">device</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#hasError">hasError</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#setAutoFormatting">setAutoFormatting</a></b>(bool <i>enable</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#autoFormattingIndent-prop">setAutoFormattingIndent</a></b>(int <i>spacesOrTabs</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#setCodec">setCodec</a></b>(QTextCodec *<i>codec</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#setCodec-1">setCodec</a></b>(const char *<i>codecName</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#setDevice">setDevice</a></b>(QIODevice *<i>device</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeAttribute">writeAttribute</a></b>(const QString &<i>namespaceUri</i>, const QString &<i>name</i>, const QString &<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeAttribute-1">writeAttribute</a></b>(const QString &<i>qualifiedName</i>, const QString &<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeAttribute-2">writeAttribute</a></b>(const QXmlStreamAttribute &<i>attribute</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeAttributes">writeAttributes</a></b>(const QXmlStreamAttributes &<i>attributes</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeCDATA">writeCDATA</a></b>(const QString &<i>text</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeCharacters">writeCharacters</a></b>(const QString &<i>text</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeComment">writeComment</a></b>(const QString &<i>text</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeCurrentToken">writeCurrentToken</a></b>(const QXmlStreamReader &<i>reader</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeDTD">writeDTD</a></b>(const QString &<i>dtd</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeDefaultNamespace">writeDefaultNamespace</a></b>(const QString &<i>namespaceUri</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeEmptyElement">writeEmptyElement</a></b>(const QString &<i>namespaceUri</i>, const QString &<i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeEmptyElement-1">writeEmptyElement</a></b>(const QString &<i>qualifiedName</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeEndDocument">writeEndDocument</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeEndElement">writeEndElement</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeEntityReference">writeEntityReference</a></b>(const QString &<i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeNamespace">writeNamespace</a></b>(const QString &<i>namespaceUri</i>, const QString &<i>prefix</i> = QString())</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeProcessingInstruction">writeProcessingInstruction</a></b>(const QString &<i>target</i>, const QString &<i>data</i> = QString())</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeStartDocument">writeStartDocument</a></b>(const QString &<i>version</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeStartDocument-1">writeStartDocument</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeStartDocument-2">writeStartDocument</a></b>(const QString &<i>version</i>, bool <i>standalone</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeStartElement">writeStartElement</a></b>(const QString &<i>namespaceUri</i>, const QString &<i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeStartElement-1">writeStartElement</a></b>(const QString &<i>qualifiedName</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeTextElement">writeTextElement</a></b>(const QString &<i>namespaceUri</i>, const QString &<i>name</i>, const QString &<i>text</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qxmlstreamwriter.html#writeTextElement-1">writeTextElement</a></b>(const QString &<i>qualifiedName</i>, const QString &<i>text</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QXmlStreamWriter-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> class provides an XML writer with a simple streaming API.</p>
<p><a href="qxmlstreamwriter.html">QXmlStreamWriter</a> is the counterpart to <a href="qxmlstreamreader.html">QXmlStreamReader</a> for writing XML. Like its related class, it operates on a <a href="qiodevice.html">QIODevice</a> specified with <a href="qxmlstreamwriter.html#setDevice">setDevice</a>(). The API is simple and straightforward: for every XML token or event you want to write, the writer provides a specialized function.</p>
<p>You start a document with <a href="qxmlstreamwriter.html#writeStartDocument-1">writeStartDocument</a>() and end it with <a href="qxmlstreamwriter.html#writeEndDocument">writeEndDocument</a>(). This will implicitly close all remaining open tags.</p>
<p>Element tags are opened with <a href="qxmlstreamwriter.html#writeStartElement">writeStartElement</a>() 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#writeEndElement">writeEndElement</a>(). A shorter form <a href="qxmlstreamwriter.html#writeEmptyElement">writeEmptyElement</a>() can be used to write empty elements, followed by <a href="qxmlstreamwriter.html#writeAttributes">writeAttributes</a>().</p>
<p>Element content consists of either characters, entity references or nested elements. It is written with <a href="qxmlstreamwriter.html#writeCharacters">writeCharacters</a>(), which 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>(). A convenience method <a href="qxmlstreamwriter.html#writeTextElement">writeTextElement</a>() can be used for writing terminal elements that contain nothing but text.</p>
<p>The following abridged code snippet shows the basic use of the class to write formatted XML with indentation:</p>
<pre class="cpp">
<span class="type"><a href="qxmlstreamwriter.html#QXmlStreamWriter">QXmlStreamWriter</a></span> stream(<span class="operator">&</span>output);
stream<span class="operator">.</span>setAutoFormatting(<span class="keyword">true</span>);
stream<span class="operator">.</span>writeStartDocument();
...
stream<span class="operator">.</span>writeStartElement(<span class="string">"bookmark"</span>);
stream<span class="operator">.</span>writeAttribute(<span class="string">"href"</span><span class="operator">,</span> <span class="string">"http://qt-project.org/"</span>);
stream<span class="operator">.</span>writeTextElement(<span class="string">"title"</span><span class="operator">,</span> <span class="string">"Qt Project"</span>);
stream<span class="operator">.</span>writeEndElement(); <span class="comment">// bookmark</span>
...
stream<span class="operator">.</span>writeEndDocument();
</pre>
<p><a href="qxmlstreamwriter.html">QXmlStreamWriter</a> takes care of prefixing namespaces, all you have to do is specify the <code>namespaceUri</code> when writing elements or attributes. If you must conform to certain prefixes, you can force the writer to use them by declaring the namespaces manually with either <a href="qxmlstreamwriter.html#writeNamespace">writeNamespace</a>() or <a href="qxmlstreamwriter.html#writeDefaultNamespace">writeDefaultNamespace</a>(). Alternatively, you can bypass the stream writer's namespace support and use overloaded methods that take a qualified name instead. The namespace <i>http://www.w3.org/XML/1998/namespace</i> is implicit and mapped to the prefix <i>xml</i>.</p>
<p>The stream writer can automatically format the generated XML data by adding line-breaks and indentation to empty sections between elements, making the XML data more readable for humans and easier to work with for most source code management systems. The feature can be turned on with the <a href="qxmlstreamwriter.html#autoFormatting-prop">autoFormatting</a> property, and customized with the <a href="qxmlstreamwriter.html#autoFormattingIndent-prop">autoFormattingIndent</a> property.</p>
<p>Other functions are <a href="qxmlstreamwriter.html#writeCDATA">writeCDATA</a>(), <a href="qxmlstreamwriter.html#writeComment">writeComment</a>(), <a href="qxmlstreamwriter.html#writeProcessingInstruction">writeProcessingInstruction</a>(), and <a href="qxmlstreamwriter.html#writeDTD">writeDTD</a>(). Chaining of XML streams is supported with <a href="qxmlstreamwriter.html#writeCurrentToken">writeCurrentToken</a>().</p>
<p>By default, <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> encodes XML in UTF-8. Different encodings can be enforced using <a href="qxmlstreamwriter.html#setCodec">setCodec</a>().</p>
<p>If an error occurs while writing to the underlying device, <a href="qxmlstreamwriter.html#hasError">hasError</a>() starts returning true and subsequent writes are ignored.</p>
<p>The <a href="../qtxml/qtxml-streambookmarks-example.html">QXmlStream Bookmarks Example</a> illustrates how to use a stream writer to write an XML bookmark file (XBEL) that was previously read in by a <a href="qxmlstreamreader.html">QXmlStreamReader</a>.</p>
</div>
<!-- @@@QXmlStreamWriter -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$autoFormatting-prop$$$autoFormatting$$$setAutoFormattingbool -->
<h3 class="fn" id="autoFormatting-prop"><a name="autoFormatting-prop"></a><span class="name">autoFormatting</span> : <span class="type">bool</span></h3>
<p>The auto-formatting flag of the stream writer</p>
<p>This property controls whether or not the stream writer automatically formats the generated XML data. If enabled, the writer automatically adds line-breaks and indentation to empty sections between elements (ignorable whitespace). The main purpose of auto-formatting is to split the data into several lines, and to increase readability for a human reader. The indentation depth can be controlled through the <a href="qxmlstreamwriter.html#autoFormattingIndent-prop">autoFormattingIndent</a> property.</p>
<p>By default, auto-formatting is disabled.</p>
<p>This property was introduced in Qt 4.4.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qxmlstreamwriter.html#autoFormatting">autoFormatting</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qxmlstreamwriter.html#setAutoFormatting">setAutoFormatting</a></b></span>(bool <i>enable</i>)</td></tr>
</table></div>
<!-- @@@autoFormatting -->
<!-- $$$autoFormattingIndent-prop$$$autoFormattingIndent$$$setAutoFormattingIndentint -->
<h3 class="fn" id="autoFormattingIndent-prop"><a name="autoFormattingIndent-prop"></a><span class="name">autoFormattingIndent</span> : <span class="type">int</span></h3>
<p>This property holds the number of spaces or tabs used for indentation when auto-formatting is enabled. Positive numbers indicate spaces, negative numbers tabs.</p>
<p>The default indentation is 4.</p>
<p>This property was introduced in Qt 4.4.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>autoFormattingIndent</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAutoFormattingIndent</b></span>(int <i>spacesOrTabs</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qxmlstreamwriter.html#autoFormatting-prop">autoFormatting</a>.</p>
<!-- @@@autoFormattingIndent -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QXmlStreamWriter[overload1]$$$QXmlStreamWriter -->
<h3 class="fn" id="QXmlStreamWriter"><a name="QXmlStreamWriter"></a>QXmlStreamWriter::<span class="name">QXmlStreamWriter</span>()</h3>
<p>Constructs a stream writer.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#setDevice">setDevice</a>().</p>
<!-- @@@QXmlStreamWriter -->
<!-- $$$QXmlStreamWriter$$$QXmlStreamWriterQIODevice* -->
<h3 class="fn" id="QXmlStreamWriter-1"><a name="QXmlStreamWriter-1"></a>QXmlStreamWriter::<span class="name">QXmlStreamWriter</span>(<span class="type"><a href="qiodevice.html">QIODevice</a></span> *<i>device</i>)</h3>
<p>Constructs a stream writer that writes into <i>device</i>;</p>
<!-- @@@QXmlStreamWriter -->
<!-- $$$QXmlStreamWriter$$$QXmlStreamWriterQByteArray* -->
<h3 class="fn" id="QXmlStreamWriter-2"><a name="QXmlStreamWriter-2"></a>QXmlStreamWriter::<span class="name">QXmlStreamWriter</span>(<span class="type"><a href="qbytearray.html">QByteArray</a></span> *<i>array</i>)</h3>
<p>Constructs a stream writer that writes into <i>array</i>. This is the same as creating an xml writer that operates on a <a href="qbuffer.html">QBuffer</a> device which in turn operates on <i>array</i>.</p>
<!-- @@@QXmlStreamWriter -->
<!-- $$$QXmlStreamWriter$$$QXmlStreamWriterQString* -->
<h3 class="fn" id="QXmlStreamWriter-3"><a name="QXmlStreamWriter-3"></a>QXmlStreamWriter::<span class="name">QXmlStreamWriter</span>(<span class="type"><a href="qstring.html">QString</a></span> *<i>string</i>)</h3>
<p>Constructs a stream writer that writes into <i>string</i>.</p>
<!-- @@@QXmlStreamWriter -->
<!-- $$$~QXmlStreamWriter[overload1]$$$~QXmlStreamWriter -->
<h3 class="fn" id="dtor.QXmlStreamWriter"><a name="dtor.QXmlStreamWriter"></a>QXmlStreamWriter::<span class="name">~QXmlStreamWriter</span>()</h3>
<p>Destructor.</p>
<!-- @@@~QXmlStreamWriter -->
<!-- $$$autoFormatting -->
<h3 class="fn" id="autoFormatting"><a name="autoFormatting"></a><span class="type">bool</span> QXmlStreamWriter::<span class="name">autoFormatting</span>() const</h3>
<p>Returns <code>true</code> if auto formattting is enabled, otherwise <code>false</code>.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>Note:</b> Getter function for property <a href="qxmlstreamwriter.html#autoFormatting-prop">autoFormatting</a>. </p><p><b>See also </b><a href="qxmlstreamwriter.html#setAutoFormatting">setAutoFormatting</a>().</p>
<!-- @@@autoFormatting -->
<!-- $$$codec[overload1]$$$codec -->
<h3 class="fn" id="codec"><a name="codec"></a><span class="type"><a href="qtextcodec.html">QTextCodec</a></span> *QXmlStreamWriter::<span class="name">codec</span>() const</h3>
<p>Returns the codec that is currently assigned to the stream.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#setCodec">setCodec</a>().</p>
<!-- @@@codec -->
<!-- $$$device[overload1]$$$device -->
<h3 class="fn" id="device"><a name="device"></a><span class="type"><a href="qiodevice.html">QIODevice</a></span> *QXmlStreamWriter::<span class="name">device</span>() const</h3>
<p>Returns the current device associated with the <a href="qxmlstreamwriter.html">QXmlStreamWriter</a>, or 0 if no device has been assigned.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#setDevice">setDevice</a>().</p>
<!-- @@@device -->
<!-- $$$hasError[overload1]$$$hasError -->
<h3 class="fn" id="hasError"><a name="hasError"></a><span class="type">bool</span> QXmlStreamWriter::<span class="name">hasError</span>() const</h3>
<p>Returns <code>true</code> if the stream failed to write to the underlying device.</p>
<p>The error status is never reset. Writes happening after the error occurred are ignored, even if the error condition is cleared.</p>
<!-- @@@hasError -->
<!-- $$$setAutoFormatting -->
<h3 class="fn" id="setAutoFormatting"><a name="setAutoFormatting"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">setAutoFormatting</span>(<span class="type">bool</span> <i>enable</i>)</h3>
<p>Enables auto formatting if <i>enable</i> is <code>true</code>, otherwise disables it.</p>
<p>The default value is <code>false</code>.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>Note:</b> Setter function for property <a href="qxmlstreamwriter.html#autoFormatting-prop">autoFormatting</a>. </p><p><b>See also </b><a href="qxmlstreamwriter.html#autoFormatting">autoFormatting</a>().</p>
<!-- @@@setAutoFormatting -->
<!-- $$$setCodec[overload1]$$$setCodecQTextCodec* -->
<h3 class="fn" id="setCodec"><a name="setCodec"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">setCodec</span>(<span class="type"><a href="qtextcodec.html">QTextCodec</a></span> *<i>codec</i>)</h3>
<p>Sets the codec for this stream to <i>codec</i>. The codec is used for encoding any data that is written. By default, <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> uses UTF-8.</p>
<p>The encoding information is stored in the initial xml tag which gets written when you call <a href="qxmlstreamwriter.html#writeStartDocument-1">writeStartDocument</a>(). Call this function before calling <a href="qxmlstreamwriter.html#writeStartDocument-1">writeStartDocument</a>().</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#codec">codec</a>().</p>
<!-- @@@setCodec -->
<!-- $$$setCodec$$$setCodecconstchar* -->
<h3 class="fn" id="setCodec-1"><a name="setCodec-1"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">setCodec</span>(const <span class="type">char</span> *<i>codecName</i>)</h3>
<p>Sets the codec for this stream to the <a href="qtextcodec.html">QTextCodec</a> for the encoding specified by <i>codecName</i>. Common values for <code>codecName</code> include "ISO 8859-1", "UTF-8", and "UTF-16". If the encoding isn't recognized, nothing happens.</p>
<p><b>See also </b><a href="qtextcodec.html#codecForName">QTextCodec::codecForName</a>().</p>
<!-- @@@setCodec -->
<!-- $$$setDevice[overload1]$$$setDeviceQIODevice* -->
<h3 class="fn" id="setDevice"><a name="setDevice"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">setDevice</span>(<span class="type"><a href="qiodevice.html">QIODevice</a></span> *<i>device</i>)</h3>
<p>Sets the current device to <i>device</i>. If you want the stream to write into a <a href="qbytearray.html">QByteArray</a>, you can create a <a href="qbuffer.html">QBuffer</a> device.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#device">device</a>().</p>
<!-- @@@setDevice -->
<!-- $$$writeAttribute[overload1]$$$writeAttributeconstQString&constQString&constQString& -->
<h3 class="fn" id="writeAttribute"><a name="writeAttribute"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeAttribute</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>namespaceUri</i>, 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>)</h3>
<p>Writes an attribute with <i>name</i> and <i>value</i>, prefixed for the specified <i>namespaceUri</i>. If the namespace has not been declared yet, <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> will generate a namespace declaration for it.</p>
<p>This function can only be called after <a href="qxmlstreamwriter.html#writeStartElement">writeStartElement</a>() before any content is written, or after <a href="qxmlstreamwriter.html#writeEmptyElement">writeEmptyElement</a>().</p>
<!-- @@@writeAttribute -->
<!-- $$$writeAttribute$$$writeAttributeconstQString&constQString& -->
<h3 class="fn" id="writeAttribute-1"><a name="writeAttribute-1"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeAttribute</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>qualifiedName</i>, const <span class="type"><a href="qstring.html">QString</a></span> &<i>value</i>)</h3>
<p>This is an overloaded function.</p>
<p>Writes an attribute with <i>qualifiedName</i> and <i>value</i>.</p>
<p>This function can only be called after <a href="qxmlstreamwriter.html#writeStartElement">writeStartElement</a>() before any content is written, or after <a href="qxmlstreamwriter.html#writeEmptyElement">writeEmptyElement</a>().</p>
<!-- @@@writeAttribute -->
<!-- $$$writeAttribute$$$writeAttributeconstQXmlStreamAttribute& -->
<h3 class="fn" id="writeAttribute-2"><a name="writeAttribute-2"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeAttribute</span>(const <span class="type"><a href="qxmlstreamattribute.html">QXmlStreamAttribute</a></span> &<i>attribute</i>)</h3>
<p>This is an overloaded function.</p>
<p>Writes the <i>attribute</i>.</p>
<p>This function can only be called after <a href="qxmlstreamwriter.html#writeStartElement">writeStartElement</a>() before any content is written, or after <a href="qxmlstreamwriter.html#writeEmptyElement">writeEmptyElement</a>().</p>
<!-- @@@writeAttribute -->
<!-- $$$writeAttributes[overload1]$$$writeAttributesconstQXmlStreamAttributes& -->
<h3 class="fn" id="writeAttributes"><a name="writeAttributes"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeAttributes</span>(const <span class="type"><a href="qxmlstreamattributes.html">QXmlStreamAttributes</a></span> &<i>attributes</i>)</h3>
<p>Writes the attribute vector <i>attributes</i>. If a namespace referenced in an attribute not been declared yet, <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> will generate a namespace declaration for it.</p>
<p>This function can only be called after <a href="qxmlstreamwriter.html#writeStartElement">writeStartElement</a>() before any content is written, or after <a href="qxmlstreamwriter.html#writeEmptyElement">writeEmptyElement</a>().</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#writeAttribute">writeAttribute</a>() and <a href="qxmlstreamwriter.html#writeNamespace">writeNamespace</a>().</p>
<!-- @@@writeAttributes -->
<!-- $$$writeCDATA[overload1]$$$writeCDATAconstQString& -->
<h3 class="fn" id="writeCDATA"><a name="writeCDATA"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeCDATA</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>text</i>)</h3>
<p>Writes <i>text</i> as CDATA section. If <i>text</i> contains the forbidden character sequence "]]>", it is split into different CDATA sections.</p>
<p>This function mainly exists for completeness. Normally you should not need use it, because <a href="qxmlstreamwriter.html#writeCharacters">writeCharacters</a>() automatically escapes all non-content characters.</p>
<!-- @@@writeCDATA -->
<!-- $$$writeCharacters[overload1]$$$writeCharactersconstQString& -->
<h3 class="fn" id="writeCharacters"><a name="writeCharacters"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeCharacters</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>text</i>)</h3>
<p>Writes <i>text</i>. The characters "<", "&", and """ are escaped as entity references "&lt;", "&amp;, and "&quot;". To avoid the forbidden sequence "]]>", ">" is also escaped as "&gt;".</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#writeEntityReference">writeEntityReference</a>().</p>
<!-- @@@writeCharacters -->
<!-- $$$writeComment[overload1]$$$writeCommentconstQString& -->
<h3 class="fn" id="writeComment"><a name="writeComment"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeComment</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>text</i>)</h3>
<p>Writes <i>text</i> as XML comment, where <i>text</i> must not contain the forbidden sequence "--" or end with "-". Note that XML does not provide any way to escape "-" in a comment.</p>
<!-- @@@writeComment -->
<!-- $$$writeCurrentToken[overload1]$$$writeCurrentTokenconstQXmlStreamReader& -->
<h3 class="fn" id="writeCurrentToken"><a name="writeCurrentToken"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeCurrentToken</span>(const <span class="type"><a href="qxmlstreamreader.html">QXmlStreamReader</a></span> &<i>reader</i>)</h3>
<p>Writes the current state of the <i>reader</i>. All possible valid states are supported.</p>
<p>The purpose of this function is to support chained processing of XML data.</p>
<p><b>See also </b><a href="qxmlstreamreader.html#tokenType">QXmlStreamReader::tokenType</a>().</p>
<!-- @@@writeCurrentToken -->
<!-- $$$writeDTD[overload1]$$$writeDTDconstQString& -->
<h3 class="fn" id="writeDTD"><a name="writeDTD"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeDTD</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>dtd</i>)</h3>
<p>Writes a DTD section. The <i>dtd</i> represents the entire doctypedecl production from the XML 1.0 specification.</p>
<!-- @@@writeDTD -->
<!-- $$$writeDefaultNamespace[overload1]$$$writeDefaultNamespaceconstQString& -->
<h3 class="fn" id="writeDefaultNamespace"><a name="writeDefaultNamespace"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeDefaultNamespace</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>namespaceUri</i>)</h3>
<p>Writes a default namespace declaration for <i>namespaceUri</i>.</p>
<p>If <a href="qxmlstreamwriter.html#writeStartElement">writeStartElement</a>() or <a href="qxmlstreamwriter.html#writeEmptyElement">writeEmptyElement</a>() was called, the declaration applies to the current element; otherwise it applies to the next child element.</p>
<p>Note that the namespaces <i>http://www.w3.org/XML/1998/namespace</i> (bound to <i>xmlns</i>) and <i>http://www.w3.org/2000/xmlns/</i> (bound to <i>xml</i>) by definition cannot be declared as default.</p>
<!-- @@@writeDefaultNamespace -->
<!-- $$$writeEmptyElement[overload1]$$$writeEmptyElementconstQString&constQString& -->
<h3 class="fn" id="writeEmptyElement"><a name="writeEmptyElement"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeEmptyElement</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>namespaceUri</i>, const <span class="type"><a href="qstring.html">QString</a></span> &<i>name</i>)</h3>
<p>Writes an empty element with <i>name</i>, prefixed for the specified <i>namespaceUri</i>. If the namespace has not been declared, <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> will generate a namespace declaration for it. Subsequent calls to <a href="qxmlstreamwriter.html#writeAttribute">writeAttribute</a>() will add attributes to this element.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#writeNamespace">writeNamespace</a>().</p>
<!-- @@@writeEmptyElement -->
<!-- $$$writeEmptyElement$$$writeEmptyElementconstQString& -->
<h3 class="fn" id="writeEmptyElement-1"><a name="writeEmptyElement-1"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeEmptyElement</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>qualifiedName</i>)</h3>
<p>This is an overloaded function.</p>
<p>Writes an empty element with qualified name <i>qualifiedName</i>. Subsequent calls to <a href="qxmlstreamwriter.html#writeAttribute">writeAttribute</a>() will add attributes to this element.</p>
<!-- @@@writeEmptyElement -->
<!-- $$$writeEndDocument[overload1]$$$writeEndDocument -->
<h3 class="fn" id="writeEndDocument"><a name="writeEndDocument"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeEndDocument</span>()</h3>
<p>Closes all remaining open start elements and writes a newline.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#writeStartDocument-1">writeStartDocument</a>().</p>
<!-- @@@writeEndDocument -->
<!-- $$$writeEndElement[overload1]$$$writeEndElement -->
<h3 class="fn" id="writeEndElement"><a name="writeEndElement"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeEndElement</span>()</h3>
<p>Closes the previous start element.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#writeStartElement">writeStartElement</a>().</p>
<!-- @@@writeEndElement -->
<!-- $$$writeEntityReference[overload1]$$$writeEntityReferenceconstQString& -->
<h3 class="fn" id="writeEntityReference"><a name="writeEntityReference"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeEntityReference</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>name</i>)</h3>
<p>Writes the entity reference <i>name</i> to the stream, as "&<i>name</i>;".</p>
<!-- @@@writeEntityReference -->
<!-- $$$writeNamespace[overload1]$$$writeNamespaceconstQString&constQString& -->
<h3 class="fn" id="writeNamespace"><a name="writeNamespace"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeNamespace</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>namespaceUri</i>, const <span class="type"><a href="qstring.html">QString</a></span> &<i>prefix</i> = QString())</h3>
<p>Writes a namespace declaration for <i>namespaceUri</i> with <i>prefix</i>. If <i>prefix</i> is empty, <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> assigns a unique prefix consisting of the letter 'n' followed by a number.</p>
<p>If <a href="qxmlstreamwriter.html#writeStartElement">writeStartElement</a>() or <a href="qxmlstreamwriter.html#writeEmptyElement">writeEmptyElement</a>() was called, the declaration applies to the current element; otherwise it applies to the next child element.</p>
<p>Note that the prefix <i>xml</i> is both predefined and reserved for <i>http://www.w3.org/XML/1998/namespace</i>, which in turn cannot be bound to any other prefix. The prefix <i>xmlns</i> and its URI <i>http://www.w3.org/2000/xmlns/</i> are used for the namespace mechanism itself and thus completely forbidden in declarations.</p>
<!-- @@@writeNamespace -->
<!-- $$$writeProcessingInstruction[overload1]$$$writeProcessingInstructionconstQString&constQString& -->
<h3 class="fn" id="writeProcessingInstruction"><a name="writeProcessingInstruction"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeProcessingInstruction</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>target</i>, const <span class="type"><a href="qstring.html">QString</a></span> &<i>data</i> = QString())</h3>
<p>Writes an XML processing instruction with <i>target</i> and <i>data</i>, where <i>data</i> must not contain the sequence "?>".</p>
<!-- @@@writeProcessingInstruction -->
<!-- $$$writeStartDocument[overload1]$$$writeStartDocumentconstQString& -->
<h3 class="fn" id="writeStartDocument"><a name="writeStartDocument"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeStartDocument</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>version</i>)</h3>
<p>Writes a document start with the XML version number <i>version</i>.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#writeEndDocument">writeEndDocument</a>().</p>
<!-- @@@writeStartDocument -->
<!-- $$$writeStartDocument$$$writeStartDocument -->
<h3 class="fn" id="writeStartDocument-1"><a name="writeStartDocument-1"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeStartDocument</span>()</h3>
<p>This is an overloaded function.</p>
<p>Writes a document start with XML version number "1.0". This also writes the encoding information.</p>
<p>This function was introduced in Qt 4.5.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#writeEndDocument">writeEndDocument</a>() and <a href="qxmlstreamwriter.html#setCodec">setCodec</a>().</p>
<!-- @@@writeStartDocument -->
<!-- $$$writeStartDocument$$$writeStartDocumentconstQString&bool -->
<h3 class="fn" id="writeStartDocument-2"><a name="writeStartDocument-2"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeStartDocument</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>version</i>, <span class="type">bool</span> <i>standalone</i>)</h3>
<p>Writes a document start with the XML version number <i>version</i> and a standalone attribute <i>standalone</i>.</p>
<p>This function was introduced in Qt 4.5.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#writeEndDocument">writeEndDocument</a>().</p>
<!-- @@@writeStartDocument -->
<!-- $$$writeStartElement[overload1]$$$writeStartElementconstQString&constQString& -->
<h3 class="fn" id="writeStartElement"><a name="writeStartElement"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeStartElement</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>namespaceUri</i>, const <span class="type"><a href="qstring.html">QString</a></span> &<i>name</i>)</h3>
<p>Writes a start element with <i>name</i>, prefixed for the specified <i>namespaceUri</i>. If the namespace has not been declared yet, <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> will generate a namespace declaration for it. Subsequent calls to <a href="qxmlstreamwriter.html#writeAttribute">writeAttribute</a>() will add attributes to this element.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#writeNamespace">writeNamespace</a>(), <a href="qxmlstreamwriter.html#writeEndElement">writeEndElement</a>(), and <a href="qxmlstreamwriter.html#writeEmptyElement">writeEmptyElement</a>().</p>
<!-- @@@writeStartElement -->
<!-- $$$writeStartElement$$$writeStartElementconstQString& -->
<h3 class="fn" id="writeStartElement-1"><a name="writeStartElement-1"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeStartElement</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>qualifiedName</i>)</h3>
<p>This is an overloaded function.</p>
<p>Writes a start element with <i>qualifiedName</i>. Subsequent calls to <a href="qxmlstreamwriter.html#writeAttribute">writeAttribute</a>() will add attributes to this element.</p>
<p><b>See also </b><a href="qxmlstreamwriter.html#writeEndElement">writeEndElement</a>() and <a href="qxmlstreamwriter.html#writeEmptyElement">writeEmptyElement</a>().</p>
<!-- @@@writeStartElement -->
<!-- $$$writeTextElement[overload1]$$$writeTextElementconstQString&constQString&constQString& -->
<h3 class="fn" id="writeTextElement"><a name="writeTextElement"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeTextElement</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>namespaceUri</i>, 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>text</i>)</h3>
<p>Writes a text element with <i>name</i>, prefixed for the specified <i>namespaceUri</i>, and <i>text</i>. If the namespace has not been declared, <a href="qxmlstreamwriter.html">QXmlStreamWriter</a> will generate a namespace declaration for it.</p>
<p>This is a convenience function equivalent to:</p>
<pre class="cpp">
writeStartElement(namespaceUri<span class="operator">,</span> name);
writeCharacters(text);
writeEndElement();
</pre>
<!-- @@@writeTextElement -->
<!-- $$$writeTextElement$$$writeTextElementconstQString&constQString& -->
<h3 class="fn" id="writeTextElement-1"><a name="writeTextElement-1"></a><span class="type">void</span> QXmlStreamWriter::<span class="name">writeTextElement</span>(const <span class="type"><a href="qstring.html">QString</a></span> &<i>qualifiedName</i>, const <span class="type"><a href="qstring.html">QString</a></span> &<i>text</i>)</h3>
<p>This is an overloaded function.</p>
<p>Writes a text element with <i>qualifiedName</i> and <i>text</i>.</p>
<p>This is a convenience function equivalent to:</p>
<pre class="cpp">
writeStartElement(qualifiedName);
writeCharacters(text);
writeEndElement();
</pre>
<!-- @@@writeTextElement -->
</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
>
armv5tl
>
media
>
core-updates
>
by-pkgid
>
768f7d9f703884aa2562bf0a651086df
>
files
>
884
