QXmlStreamWriter Class

     QXmlStreamWriter stream(&output);
     stream.setAutoFormatting(true);
     stream.writeStartDocument();
     ...
     stream.writeStartElement("bookmark");
     stream.writeAttribute("href", "http://qt-project.org/");
     stream.writeTextElement("title", "Qt Project");
     stream.writeEndElement(); // bookmark
     ...
     stream.writeEndDocument();

Member Function Documentation

QXmlStreamWriter::QXmlStreamWriter()

Constructs a stream writer.

See also setDevice().

[explicit] QXmlStreamWriter::QXmlStreamWriter(QIODevice *device)

Constructs a stream writer that writes into device;

[explicit] QXmlStreamWriter::QXmlStreamWriter(QByteArray *array)

Constructs a stream writer that writes into array. This is the same as creating an xml writer that operates on a QBuffer device which in turn operates on array.

[explicit] QXmlStreamWriter::QXmlStreamWriter(QString *string)

Constructs a stream writer that writes into string.

[noexcept] QXmlStreamWriter::~QXmlStreamWriter()

Destructor.

bool QXmlStreamWriter::autoFormatting() const

Returns true if auto formatting is enabled, otherwise false.

See also setAutoFormatting().

QIODevice *QXmlStreamWriter::device() const

Returns the current device associated with the QXmlStreamWriter, or nullptr if no device has been assigned.

See also setDevice().

bool QXmlStreamWriter::hasError() const

Returns true if writing failed.

This can happen if the stream failed to write to the underlying device or if the data to be written contained invalid characters.

The error status is never reset. Writes happening after the error occurred may be ignored, even if the error condition is cleared.

void QXmlStreamWriter::setAutoFormatting(bool enable)

Enables auto formatting if enable is true, otherwise disables it.

The default value is false.

See also autoFormatting().

void QXmlStreamWriter::setDevice(QIODevice *device)

Sets the current device to device. If you want the stream to write into a QByteArray, you can create a QBuffer device.

See also device().

void QXmlStreamWriter::writeAttribute(QAnyStringView namespaceUri, QAnyStringView name, QAnyStringView value)

Writes an attribute with name and value, prefixed for the specified namespaceUri. If the namespace has not been declared yet, QXmlStreamWriter will generate a namespace declaration for it.

This function can only be called after writeStartElement() before any content is written, or after writeEmptyElement().

void QXmlStreamWriter::writeAttribute(QAnyStringView qualifiedName, QAnyStringView value)

This is an overloaded function.

Writes an attribute with qualifiedName and value.

This function can only be called after writeStartElement() before any content is written, or after writeEmptyElement().

void QXmlStreamWriter::writeAttribute(const QXmlStreamAttribute &attribute)

This is an overloaded function.

Writes the attribute.

This function can only be called after writeStartElement() before any content is written, or after writeEmptyElement().

void QXmlStreamWriter::writeAttributes(const QXmlStreamAttributes &attributes)

Writes the attribute vector attributes. If a namespace referenced in an attribute not been declared yet, QXmlStreamWriter will generate a namespace declaration for it.

This function can only be called after writeStartElement() before any content is written, or after writeEmptyElement().

See also writeAttribute() and writeNamespace().

void QXmlStreamWriter::writeCDATA(QAnyStringView text)

Writes text as CDATA section. If text contains the forbidden character sequence "]]>", it is split into different CDATA sections.

This function mainly exists for completeness. Normally you should not need use it, because writeCharacters() automatically escapes all non-content characters.

void QXmlStreamWriter::writeCharacters(QAnyStringView text)

Writes text. The characters "<", "&", and """ are escaped as entity references "&lt;", "&amp;, and "&quot;". To avoid the forbidden sequence "]]>", ">" is also escaped as "&gt;".

See also writeEntityReference().

void QXmlStreamWriter::writeComment(QAnyStringView text)

Writes text as XML comment, where text must not contain the forbidden sequence -- or end with -. Note that XML does not provide any way to escape - in a comment.

void QXmlStreamWriter::writeCurrentToken(const QXmlStreamReader &reader)

Writes the current state of the reader. All possible valid states are supported.

The purpose of this function is to support chained processing of XML data.

See also QXmlStreamReader::tokenType().

void QXmlStreamWriter::writeDTD(QAnyStringView dtd)

Writes a DTD section. The dtd represents the entire doctypedecl production from the XML 1.0 specification.

void QXmlStreamWriter::writeDefaultNamespace(QAnyStringView namespaceUri)

Writes a default namespace declaration for namespaceUri.

If writeStartElement() or writeEmptyElement() was called, the declaration applies to the current element; otherwise it applies to the next child element.

Note that the namespaces http://www.w3.org/XML/1998/namespace (bound to xmlns) and http://www.w3.org/2000/xmlns/ (bound to xml) by definition cannot be declared as default.

void QXmlStreamWriter::writeEmptyElement(QAnyStringView namespaceUri, QAnyStringView name)

Writes an empty element with name, prefixed for the specified namespaceUri. If the namespace has not been declared, QXmlStreamWriter will generate a namespace declaration for it. Subsequent calls to writeAttribute() will add attributes to this element.

See also writeNamespace().

void QXmlStreamWriter::writeEmptyElement(QAnyStringView qualifiedName)

This is an overloaded function.

Writes an empty element with qualified name qualifiedName. Subsequent calls to writeAttribute() will add attributes to this element.

void QXmlStreamWriter::writeEndDocument()

Closes all remaining open start elements and writes a newline.

See also writeStartDocument().

void QXmlStreamWriter::writeEndElement()

Closes the previous start element.

See also writeStartElement().

void QXmlStreamWriter::writeEntityReference(QAnyStringView name)

Writes the entity reference name to the stream, as "&name;".

void QXmlStreamWriter::writeNamespace(QAnyStringView namespaceUri, QAnyStringView prefix = {})

Writes a namespace declaration for namespaceUri with prefix. If prefix is empty, QXmlStreamWriter assigns a unique prefix consisting of the letter 'n' followed by a number.

If writeStartElement() or writeEmptyElement() was called, the declaration applies to the current element; otherwise it applies to the next child element.

Note that the prefix xml is both predefined and reserved for http://www.w3.org/XML/1998/namespace, which in turn cannot be bound to any other prefix. The prefix xmlns and its URI http://www.w3.org/2000/xmlns/ are used for the namespace mechanism itself and thus completely forbidden in declarations.

void QXmlStreamWriter::writeProcessingInstruction(QAnyStringView target, QAnyStringView data = {})

Writes an XML processing instruction with target and data, where data must not contain the sequence "?>".

void QXmlStreamWriter::writeStartDocument(QAnyStringView version)

Writes a document start with the XML version number version.

See also writeEndDocument().

void QXmlStreamWriter::writeStartDocument()

This is an overloaded function.

Writes a document start with XML version number "1.0".

See also writeEndDocument().

void QXmlStreamWriter::writeStartDocument(QAnyStringView version, bool standalone)

Writes a document start with the XML version number version and a standalone attribute standalone.

See also writeEndDocument().

void QXmlStreamWriter::writeStartElement(QAnyStringView namespaceUri, QAnyStringView name)

Writes a start element with name, prefixed for the specified namespaceUri. If the namespace has not been declared yet, QXmlStreamWriter will generate a namespace declaration for it. Subsequent calls to writeAttribute() will add attributes to this element.

See also writeNamespace(), writeEndElement(), and writeEmptyElement().

void QXmlStreamWriter::writeStartElement(QAnyStringView qualifiedName)

This is an overloaded function.

Writes a start element with qualifiedName. Subsequent calls to writeAttribute() will add attributes to this element.

See also writeEndElement() and writeEmptyElement().

void QXmlStreamWriter::writeTextElement(QAnyStringView namespaceUri, QAnyStringView name, QAnyStringView text)

Writes a text element with name, prefixed for the specified namespaceUri, and text. If the namespace has not been declared, QXmlStreamWriter will generate a namespace declaration for it.

This is a convenience function equivalent to:

         writeStartElement(namespaceUri, name);
         writeCharacters(text);
         writeEndElement();

void QXmlStreamWriter::writeTextElement(QAnyStringView qualifiedName, QAnyStringView text)

This is an overloaded function.

Writes a text element with qualifiedName and text.

This is a convenience function equivalent to:

         writeStartElement(qualifiedName);
         writeCharacters(text);
         writeEndElement();