QXmlStreamWriter Class

Dokumentation zu den Mitgliedsfunktionen

QXmlStreamWriter::QXmlStreamWriter()

Erstellt einen Stream-Writer.

Siehe auch ` setDevice()`.

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

Erstellt einen Stream-Writer, der in „ array “ schreibt. Dies entspricht der Erstellung eines XML-Writers, der auf einem „ QBuffer “-Gerät arbeitet, das wiederum auf „ array “ arbeitet.

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

Erstellt einen Stream-Writer, der in „ device “ schreibt;

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

Erstellt einen Stream-Writer, der in „ string “ schreibt.

[noexcept] QXmlStreamWriter::~QXmlStreamWriter()

Destruktor.

bool QXmlStreamWriter::autoFormatting() const

Gibt „ true “ zurück, wenn die automatische Formatierung aktiviert ist, andernfalls „ false “.

Siehe auch „ setAutoFormatting()“.

QIODevice *QXmlStreamWriter::device() const

Gibt das aktuelle Gerät zurück, das der „ QXmlStreamWriter “ zugeordnet ist, oder „ nullptr “, falls kein Gerät zugewiesen wurde.

Siehe auch setDevice().

[since 6.10] QXmlStreamWriter::Error QXmlStreamWriter::error() const

Gibt den aktuellen Fehlerstatus des Writers zurück.

Wenn kein Fehler aufgetreten ist, gibt diese Funktion „ QXmlStreamWriter::Error::None “ zurück.

Diese Funktion wurde in Qt 6.10 eingeführt.

Siehe auch „ errorString()“, „ raiseError()“ und „ hasError()“.

[since 6.10] QString QXmlStreamWriter::errorString() const

Wenn ein Fehler aufgetreten ist, wird die zugehörige Fehlermeldung zurückgegeben.

Die Fehlermeldung wird entweder intern von ` QXmlStreamWriter ` gesetzt oder vom Benutzer über ` raiseError()` bereitgestellt. Wenn kein Fehler aufgetreten ist, gibt diese Funktion eine leere Zeichenkette zurück.

Diese Funktion wurde in Qt 6.10 eingeführt.

Siehe auch error(), raiseError() und hasError().

bool QXmlStreamWriter::hasError() const

Gibt „ true “ zurück, wenn beim Versuch, Daten zu schreiben, ein Fehler aufgetreten ist.

Wenn der Fehler „ Error::IO “ lautet, schlagen nachfolgende Schreibvorgänge in das zugrunde liegende Dokument „ QIODevice “ fehl. In anderen Fällen werden möglicherweise fehlerhafte Daten in das Dokument geschrieben.

Der Fehlerstatus wird niemals zurückgesetzt. Schreibvorgänge, die nach dem Auftreten des Fehlers erfolgen, werden möglicherweise ignoriert, selbst wenn die Fehlerbedingung behoben wurde.

Siehe auch „ error()“, „ errorString()“ und „ raiseError()“.

[since 6.10] void QXmlStreamWriter::raiseError(QAnyStringView message)

Löst einen benutzerdefinierten Fehler mit dem angegebenen „ message “ aus.

Diese Funktion dient dazu, manuell anzuzeigen, dass beim Schreiben ein Fehler aufgetreten ist, beispielsweise ein Validierungsfehler auf Anwendungsebene.

Diese Funktion wurde in Qt 6.10 eingeführt.

Siehe auch ` errorString()`, ` error()` und ` hasError()`.

void QXmlStreamWriter::setAutoFormatting(bool enable)

Aktiviert die automatische Formatierung, wenn „ enable “ auf „ true “ gesetzt ist; andernfalls wird sie deaktiviert.

Der Standardwert ist „ false “.

Siehe auch „ autoFormatting()“.

void QXmlStreamWriter::setDevice(QIODevice *device)

Legt das aktuelle Gerät auf „ device “ fest. Wenn der Stream in ein „ QByteArray “ schreiben soll, können Sie ein „ QBuffer “-Gerät erstellen.

Siehe auch device().

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

Schreibt ein Attribut mit den Präfixen „ name “ und „ value “ für den angegebenen namespaceUri. Falls der Namensraum noch nicht deklariert wurde, generiert QXmlStreamWriter eine Namensraumdeklaration dafür.

Diese Funktion kann nur nach dem Aufruf von ` writeStartElement()` – bevor Inhalte geschrieben werden – oder nach dem Aufruf von ` writeEmptyElement()` aufgerufen werden.

void QXmlStreamWriter::writeAttribute(const QXmlStreamAttribute &attribute)

Schreibt die Funktion „ attribute “.

Diese Funktion kann nur nach ` writeStartElement()` aufgerufen werden, bevor Inhalte geschrieben werden, oder nach ` writeEmptyElement()`.

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

Schreibt ein Attribut mit „ qualifiedName “ und „ value “.

Diese Funktion kann nur nach dem Aufruf von ` writeStartElement()` – bevor Inhalte geschrieben werden – oder nach dem Aufruf von ` writeEmptyElement()` aufgerufen werden.

void QXmlStreamWriter::writeAttributes(const QXmlStreamAttributes &attributes)

Schreibt den Attributvektor „ attributes “. Wenn ein in einem Attribut referenzierter Namensraum noch nicht deklariert wurde, generiert „ QXmlStreamWriter “ eine Namensraumdeklaration dafür.

Diese Funktion kann nur nach dem Aufruf von ` writeStartElement()` – bevor Inhalte geschrieben werden – oder nach dem Aufruf von ` writeEmptyElement()` aufgerufen werden.

Siehe auch writeAttribute() und writeNamespace().

void QXmlStreamWriter::writeCDATA(QAnyStringView text)

Schreibt „ text “ als CDATA-Abschnitt. Wenn „ text “ die unzulässige Zeichenfolge „]]>“ enthält, wird sie in verschiedene CDATA-Abschnitte aufgeteilt.

Diese Funktion dient hauptsächlich der Vollständigkeit. Normalerweise sollten Sie sie nicht benötigen, da writeCharacters() alle Zeichen, die kein Inhalt sind, automatisch escapt.

void QXmlStreamWriter::writeCharacters(QAnyStringView text)

Schreibt text. Die Zeichen „<“, „&“ und „““ werden als Entitätsreferenzen „&lt;“, „&amp;“ und „&quot;“ maskiert. Um die unzulässige Zeichenfolge „]]>“ zu vermeiden, wird „>“ ebenfalls als „&gt;“ maskiert.

Siehe auch writeEntityReference().

void QXmlStreamWriter::writeComment(QAnyStringView text)

Schreibt „ text “ als XML-Kommentar, wobei „ text “ weder die verbotene Sequenz „ -- “ enthalten noch mit „ - “ enden darf. Beachten Sie, dass XML keine Möglichkeit bietet, „ - “ in einem Kommentar zu escapen.

void QXmlStreamWriter::writeCurrentToken(const QXmlStreamReader &reader)

Schreibt den aktuellen Zustand des „ reader “ . Alle möglichen gültigen Zustände werden unterstützt.

Der Zweck dieser Funktion besteht darin, die verkettete Verarbeitung von XML-Daten zu unterstützen.

Siehe auch QXmlStreamReader::tokenType().

void QXmlStreamWriter::writeDTD(QAnyStringView dtd)

Schreibt einen DTD-Abschnitt. Die Zeichenfolge „ dtd “ steht für die gesamte „doctypedecl“-Regel aus der XML 1.0-Spezifikation.

void QXmlStreamWriter::writeDefaultNamespace(QAnyStringView namespaceUri)

Schreibt eine Standard-Namespace-Deklaration für „ namespaceUri “ .

Wurde „ writeStartElement()“ oder „ writeEmptyElement()“ aufgerufen, gilt die Deklaration für das aktuelle Element; andernfalls gilt sie für das nächste untergeordnete Element.

Beachten Sie, dass die Namespaces „http://www.w3.org/XML/1998/namespace“ (gebunden an „xmlns“) und „http://www.w3.org/2000/xmlns/“ (gebunden an „xml“) per Definition nicht als Standard deklariert werden können.

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

Schreibt ein leeres Element mit dem Präfix name für den angegebenen namespaceUri. Wenn der Namespace noch nicht deklariert wurde, generiert QXmlStreamWriter eine Namespace-Deklaration dafür. Nachfolgende Aufrufe von writeAttribute() fügen diesem Element Attribute hinzu.

Siehe auch ` writeNamespace()`.

void QXmlStreamWriter::writeEmptyElement(QAnyStringView qualifiedName)

Schreibt ein leeres Element mit dem qualifizierten Namen „ qualifiedName “. Nachfolgende Aufrufe von „ writeAttribute()“ fügen diesem Element Attribute hinzu.

void QXmlStreamWriter::writeEndDocument()

Schließt alle verbleibenden offenen Startelemente und schreibt ein Zeilenende.

Siehe auch ` writeStartDocument()`.

void QXmlStreamWriter::writeEndElement()

Schließt das vorherige Start-Element.

Siehe auch „ writeStartElement()“.

void QXmlStreamWriter::writeEntityReference(QAnyStringView name)

Schreibt die Entitätsreferenz name als „&name;“ in den Stream.

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

Schreibt eine Namespace-Deklaration für namespaceUri mit prefix. Ist prefix leer, weist QXmlStreamWriter ein eindeutiges Präfix zu, das aus dem Buchstaben „n“ gefolgt von einer Zahl besteht.

Wurden writeStartElement() oder writeEmptyElement() aufgerufen, gilt die Deklaration für das aktuelle Element; andernfalls gilt sie für das nächste untergeordnete Element.

Beachten Sie, dass das Präfix „xml“ sowohl vordefiniert als auch für „http://www.w3.org/XML/1998/namespace“ reserviert ist, das wiederum nicht an ein anderes Präfix gebunden werden kann. Das Präfix „xmlns“ und dessen URI http://www.w3.org/2000/xmlns/ werden für den Namensraummechanismus selbst verwendet und sind daher in Deklarationen vollständig verboten.

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

Schreibt eine XML-Verarbeitungsanweisung mit target und data, wobei data die Zeichenfolge „?>“ nicht enthalten darf.

void QXmlStreamWriter::writeStartDocument(QAnyStringView version)

Schreibt ein Dokument, das mit der XML-Versionsnummer „ version “ beginnt.

Siehe auch ` writeEndDocument()`.

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

Schreibt ein Dokument, das mit der XML-Versionsnummer „ version “ und dem Attribut „ standalone “ beginnt.

Siehe auch writeEndDocument().

void QXmlStreamWriter::writeStartDocument()

Schreibt ein Dokument, das mit der XML-Versionsnummer „1.0“ beginnt.

Siehe auch writeEndDocument().

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

Schreibt ein Startelement mit dem Präfix „ name “ für den angegebenen namespaceUri. Falls der Namespace noch nicht deklariert wurde, generiert QXmlStreamWriter eine Namespace-Deklaration dafür. Nachfolgende Aufrufe von writeAttribute() fügen diesem Element Attribute hinzu.

Siehe auch writeNamespace(), writeEndElement() und writeEmptyElement().

void QXmlStreamWriter::writeStartElement(QAnyStringView qualifiedName)

Schreibt ein Startelement mit qualifiedName. Nachfolgende Aufrufe von writeAttribute() fügen diesem Element Attribute hinzu.

Siehe auch ` writeEndElement()` und ` writeEmptyElement()`.

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

Schreibt ein Textelement mit dem Präfix „ name “ für den angegebenen namespaceUri und text. Falls der Namensraum noch nicht deklariert wurde, generiert QXmlStreamWriter eine Namensraumdeklaration dafür.

Dies ist eine Komfortfunktion, die folgendem entspricht:

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

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

Schreibt ein Textelement mit den Werten „ qualifiedName “ und „ text “.

Dies ist eine Komfortfunktion, die folgendem entspricht:

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