The QXmlStreamWriter class provides an XML writer with a simple streaming API. More...

#include <qxmlstream.h>

Public Member Functions
	QXmlStreamWriter ()

	QXmlStreamWriter (QIODevice *device)

	QXmlStreamWriter (QByteArray *array)

	QXmlStreamWriter (QString *string)

	~QXmlStreamWriter ()

void	setDevice (QIODevice *device)

QIODevice *	device () const

void	setAutoFormatting (bool)

bool	autoFormatting () const
	the auto-formatting flag of the stream writer. More...

void	setAutoFormattingIndent (int spacesOrTabs)

int	autoFormattingIndent () const
	the number of spaces or tabs used for indentation when auto-formatting is enabled. Positive numbers indicate spaces, negative numbers tabs. More...

void	writeAttribute (const QString &qualifiedName, const QString &value)

void	writeAttribute (const QString &namespaceUri, const QString &name, const QString &value)

void	writeAttribute (const QXmlStreamAttribute &attribute)

void	writeAttributes (const QXmlStreamAttributes &attributes)

void	writeCDATA (const QString &text)

void	writeCharacters (const QString &text)

void	writeComment (const QString &text)

void	writeDTD (const QString &dtd)

void	writeEmptyElement (const QString &qualifiedName)

void	writeEmptyElement (const QString &namespaceUri, const QString &name)

void	writeTextElement (const QString &qualifiedName, const QString &text)

void	writeTextElement (const QString &namespaceUri, const QString &name, const QString &text)

void	writeEndDocument ()

void	writeEndElement ()

void	writeEntityReference (const QString &name)

void	writeNamespace (const QString &namespaceUri, const QString &prefix=QString())

void	writeDefaultNamespace (const QString &namespaceUri)

void	writeProcessingInstruction (const QString &target, const QString &data=QString())

void	writeStartDocument ()

void	writeStartDocument (const QString &version)

void	writeStartDocument (const QString &version, bool standalone)

void	writeStartElement (const QString &qualifiedName)

void	writeStartElement (const QString &namespaceUri, const QString &name)

void	writeCurrentToken (const QXmlStreamReader &reader)

bool	hasError () const

Detailed Description

The QXmlStreamWriter class provides an XML writer with a simple streaming API.

\inmodule QtCore

Since: 4.3 \reentrant

QXmlStreamWriter is the counterpart to QXmlStreamReader for writing XML. Like its related class, it operates on a QIODevice specified with setDevice(). The API is simple and straightforward: for every XML token or event you want to write, the writer provides a specialized function.

You start a document with writeStartDocument() and end it with writeEndDocument(). This will implicitly close all remaining open tags.

Element tags are opened with writeStartElement() followed by writeAttribute() or writeAttributes(), element content, and then writeEndElement(). A shorter form writeEmptyElement() can be used to write empty elements, followed by writeAttributes().

Element content consists of either characters, entity references or nested elements. It is written with writeCharacters(), which also takes care of escaping all forbidden characters and character sequences, writeEntityReference(), or subsequent calls to writeStartElement(). A convenience method writeTextElement() can be used for writing terminal elements that contain nothing but text.

The following abridged code snippet shows the basic use of the class to write formatted XML with indentation:

\dots

QXmlStreamWriter takes care of prefixing namespaces, all you have to do is specify the namespaceUri 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 writeNamespace() or writeDefaultNamespace(). Alternatively, you can bypass the stream writer's namespace support and use overloaded methods that take a qualified name instead. The namespace http://www.w3.org/XML/1998/namespace is implicit and mapped to the prefix xml.

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 \l autoFormatting property, and customized with the \l autoFormattingIndent property.

Other functions are writeCDATA(), writeComment(), writeProcessingInstruction(), and writeDTD(). Chaining of XML streams is supported with writeCurrentToken().

QXmlStreamWriter always encodes XML in UTF-8.

If an error occurs while writing to the underlying device, hasError() starts returning true and subsequent writes are ignored.

The \l{QXmlStream Bookmarks Example} illustrates how to use a stream writer to write an XML bookmark file (XBEL) that was previously read in by a QXmlStreamReader.

Definition at line 343 of file qxmlstream.h.

Constructor & Destructor Documentation

◆ QXmlStreamWriter() [1/4]

QXmlStreamWriter::QXmlStreamWriter ( )

Constructs a stream writer.

See also: setDevice()

Definition at line 3089 of file qxmlstream.cpp.

◆ QXmlStreamWriter() [2/4]

QXmlStreamWriter::QXmlStreamWriter ( QIODevice * device )

explicit

Constructs a stream writer that writes into device;

Definition at line 3097 of file qxmlstream.cpp.

Here is the call graph for this function:

◆ QXmlStreamWriter() [3/4]

QXmlStreamWriter::QXmlStreamWriter ( QByteArray * array )

explicit

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.

Definition at line 3108 of file qxmlstream.cpp.

◆ QXmlStreamWriter() [4/4]

QXmlStreamWriter::QXmlStreamWriter ( QString * string )

explicit

Constructs a stream writer that writes into string.

Definition at line 3121 of file qxmlstream.cpp.

◆ ~QXmlStreamWriter()

QXmlStreamWriter::~QXmlStreamWriter ( )

Destructor.

Definition at line 3131 of file qxmlstream.cpp.

Member Function Documentation

◆ autoFormatting()

bool QXmlStreamWriter::autoFormatting ( ) const

the auto-formatting flag of the stream writer.

Since: 4.4

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 \l autoFormattingIndent property.

By default, auto-formatting is disabled.

Since: 4.4

Returns true if auto formatting is enabled, otherwise false.

Definition at line 3202 of file qxmlstream.cpp.

◆ autoFormattingIndent()

int QXmlStreamWriter::autoFormattingIndent ( ) const

the number of spaces or tabs used for indentation when auto-formatting is enabled. Positive numbers indicate spaces, negative numbers tabs.

Since: 4.4

The default indentation is 4.

See also: autoFormatting

Definition at line 3228 of file qxmlstream.cpp.

◆ device()

QIODevice * QXmlStreamWriter::device ( ) const

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

See also: setDevice()

Definition at line 3161 of file qxmlstream.cpp.

Here is the caller graph for this function:

◆ hasError()

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.

Definition at line 3243 of file qxmlstream.cpp.

◆ setAutoFormatting()

void QXmlStreamWriter::setAutoFormatting ( bool enable )

Since: 4.4

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

The default value is false.

Definition at line 3191 of file qxmlstream.cpp.

Here is the caller graph for this function:

◆ setAutoFormattingIndent()

void QXmlStreamWriter::setAutoFormattingIndent ( int spacesOrTabs )

Definition at line 3222 of file qxmlstream.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDevice()

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()

Definition at line 3142 of file qxmlstream.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeAttribute() [1/3]

void QXmlStreamWriter::writeAttribute	(	const QString &	namespaceUri,
		const QString &	name,
		const QString &	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().

Definition at line 3277 of file qxmlstream.cpp.

Here is the call graph for this function:

◆ writeAttribute() [2/3]

void QXmlStreamWriter::writeAttribute	(	const QString &	qualifiedName,
		const QString &	value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Writes an attribute with qualifiedName and value.

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

Definition at line 3257 of file qxmlstream.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeAttribute() [3/3]

void QXmlStreamWriter::writeAttribute ( const QXmlStreamAttribute & attribute )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Writes the attribute.

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

Definition at line 3302 of file qxmlstream.cpp.

Here is the call graph for this function:

◆ writeAttributes()

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(), writeNamespace()

Definition at line 3323 of file qxmlstream.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeCDATA()

void QXmlStreamWriter::writeCDATA ( const QString & 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.

Definition at line 3341 of file qxmlstream.cpp.

Here is the caller graph for this function:

◆ writeCharacters()

void QXmlStreamWriter::writeCharacters ( const QString & text )

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

See also: writeEntityReference()

Definition at line 3359 of file qxmlstream.cpp.

Here is the caller graph for this function:

◆ writeComment()

void QXmlStreamWriter::writeComment ( const QString & 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.

Definition at line 3371 of file qxmlstream.cpp.

Here is the caller graph for this function:

◆ writeCurrentToken()

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()

Definition at line 3712 of file qxmlstream.cpp.

Here is the call graph for this function:

◆ writeDefaultNamespace()

void QXmlStreamWriter::writeDefaultNamespace ( const QString & 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.

Definition at line 3569 of file qxmlstream.cpp.

Here is the call graph for this function:

◆ writeDTD()

void QXmlStreamWriter::writeDTD ( const QString & dtd )

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

Definition at line 3387 of file qxmlstream.cpp.

Here is the caller graph for this function:

◆ writeEmptyElement() [1/2]

void QXmlStreamWriter::writeEmptyElement	(	const QString &	namespaceUri,
		const QString &	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()

Definition at line 3420 of file qxmlstream.cpp.

◆ writeEmptyElement() [2/2]

void QXmlStreamWriter::writeEmptyElement ( const QString & qualifiedName )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Writes an empty element with qualified name qualifiedName. Subsequent calls to writeAttribute() will add attributes to this element.

Definition at line 3404 of file qxmlstream.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeEndDocument()

void QXmlStreamWriter::writeEndDocument ( )

Closes all remaining open start elements and writes a newline.

See also: writeStartDocument()

Definition at line 3467 of file qxmlstream.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeEndElement()

void QXmlStreamWriter::writeEndElement ( )

Closes the previous start element.

See also: writeStartElement()

Definition at line 3480 of file qxmlstream.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeEntityReference()

void QXmlStreamWriter::writeEntityReference ( const QString & name )

Writes the entity reference name to the stream, as "&\a{name};".

Definition at line 3516 of file qxmlstream.cpp.

Here is the caller graph for this function:

◆ writeNamespace()

void QXmlStreamWriter::writeNamespace	(	const QString &	namespaceUri,
		const QString &	prefix = `QString()`
	)

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.

Definition at line 3541 of file qxmlstream.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeProcessingInstruction()

void QXmlStreamWriter::writeProcessingInstruction	(	const QString &	target,
		const QString &	data = `QString()`
	)

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

Definition at line 3586 of file qxmlstream.cpp.

Here is the caller graph for this function:

◆ writeStartDocument() [1/3]

void QXmlStreamWriter::writeStartDocument ( )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

See also: writeEndDocument()

Since: 4.5

Definition at line 3610 of file qxmlstream.cpp.

Here is the caller graph for this function:

◆ writeStartDocument() [2/3]

void QXmlStreamWriter::writeStartDocument ( const QString & version )

Writes a document start with the XML version number version.

See also: writeEndDocument()

Definition at line 3621 of file qxmlstream.cpp.

◆ writeStartDocument() [3/3]

void QXmlStreamWriter::writeStartDocument	(	const QString &	version,
		bool	standalone
	)

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

See also: writeEndDocument()

Since: 4.5

Definition at line 3638 of file qxmlstream.cpp.

◆ writeStartElement() [1/2]

void QXmlStreamWriter::writeStartElement	(	const QString &	namespaceUri,
		const QString &	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(), writeEmptyElement()

Definition at line 3676 of file qxmlstream.cpp.

◆ writeStartElement() [2/2]

void QXmlStreamWriter::writeStartElement ( const QString & qualifiedName )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

See also: writeEndElement(), writeEmptyElement()

Definition at line 3660 of file qxmlstream.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeTextElement() [1/2]

void QXmlStreamWriter::writeTextElement	(	const QString &	namespaceUri,
		const QString &	name,
		const QString &	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:

Definition at line 3454 of file qxmlstream.cpp.

Here is the call graph for this function:

◆ writeTextElement() [2/2]

void QXmlStreamWriter::writeTextElement	(	const QString &	qualifiedName,
		const QString &	text
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Writes a text element with qualifiedName and text.

This is a convenience function equivalent to:

Definition at line 3437 of file qxmlstream.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

The documentation for this class was generated from the following files:

src/corelib/serialization/qxmlstream.h
src/corelib/serialization/qxmlstream.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QXmlStreamWriter() [1/4]

◆ QXmlStreamWriter() [2/4]

◆ QXmlStreamWriter() [3/4]

◆ QXmlStreamWriter() [4/4]

◆ ~QXmlStreamWriter()

Member Function Documentation

◆ autoFormatting()

◆ autoFormattingIndent()

◆ device()

◆ hasError()

◆ setAutoFormatting()

◆ setAutoFormattingIndent()

◆ setDevice()

◆ writeAttribute() [1/3]

◆ writeAttribute() [2/3]

◆ writeAttribute() [3/3]

◆ writeAttributes()

◆ writeCDATA()

◆ writeCharacters()

◆ writeComment()

◆ writeCurrentToken()

◆ writeDefaultNamespace()

◆ writeDTD()

◆ writeEmptyElement() [1/2]

◆ writeEmptyElement() [2/2]

◆ writeEndDocument()

◆ writeEndElement()

◆ writeEntityReference()

◆ writeNamespace()

◆ writeProcessingInstruction()

◆ writeStartDocument() [1/3]

◆ writeStartDocument() [2/3]

◆ writeStartDocument() [3/3]

◆ writeStartElement() [1/2]

◆ writeStartElement() [2/2]

◆ writeTextElement() [1/2]

◆ writeTextElement() [2/2]