QXmlStreamWriter Class

Dokumentation der Mitgliedsfunktionen

QXmlStreamWriter::QXmlStreamWriter()

Konstruiert einen Stream-Writer.

Siehe auch setDevice().

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

Konstruiert einen Stream-Writer, der in array schreibt. Dies ist dasselbe wie das Erstellen eines xml-Writers, der auf einem QBuffer -Gerät arbeitet, das wiederum auf array arbeitet.

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

Konstruiert einen Stream-Writer, der in device schreibt;

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

Konstruiert einen Stream-Writer, der in string schreibt.

[noexcept] QXmlStreamWriter::~QXmlStreamWriter()

Zerstörer.

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 mit QXmlStreamWriter verbunden ist, oder nullptr, wenn 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(const QString &message), 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 einen Null-String zurück.

Diese Funktion wurde in Qt 6.10 eingeführt.

Siehe auch error(), raiseError(const QString &message), 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 QIODevice fehl. In anderen Fällen werden möglicherweise fehlerhafte Daten in das Dokument geschrieben.

Der Fehlerstatus wird nie zurückgesetzt. Schreibvorgänge, die nach dem Auftreten des Fehlers erfolgen, können ignoriert werden, selbst wenn die Fehlerbedingung gelöscht wird.

Siehe auch error(), errorString(), und raiseError(const QString &message).

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

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

Diese Funktion dient zur manuellen Anzeige, dass ein Fehler während des Schreibens aufgetreten ist, wie z.B. 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 gleich true ist, andernfalls wird sie deaktiviert.

Der Standardwert ist false.

Siehe auch autoFormatting().

void QXmlStreamWriter::setDevice(QIODevice *device)

Setzt das aktuelle Gerät auf device. Wenn Sie möchten, dass der Stream in ein QByteArray schreibt, können Sie ein QBuffer Gerät erstellen.

Siehe auch device().

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

Schreibt ein Attribut mit name und value, das dem angegebenen namespaceUri vorangestellt wird. Wenn der Namespace noch nicht deklariert wurde, erzeugt QXmlStreamWriter eine Namespace-Deklaration für ihn.

Diese Funktion kann nur nach writeStartElement() aufgerufen werden, bevor irgendein Inhalt geschrieben wird, oder nach writeEmptyElement().

void QXmlStreamWriter::writeAttribute(const QXmlStreamAttribute &attribute)

Schreibt die attribute.

Diese Funktion kann nur nach writeStartElement() aufgerufen werden, bevor ein Inhalt geschrieben wird, oder nach writeEmptyElement().

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

Schreibt ein Attribut mit qualifiedName und value.

Diese Funktion kann nur nach writeStartElement() aufgerufen werden, bevor irgendein Inhalt geschrieben wird, oder nach writeEmptyElement().

void QXmlStreamWriter::writeAttributes(const QXmlStreamAttributes &attributes)

Schreibt den Attributvektor attributes. Wenn ein Namespace, auf den in einem Attribut verwiesen wird, noch nicht deklariert wurde, erzeugt QXmlStreamWriter eine Namespace-Deklaration für ihn.

Diese Funktion kann nur nach writeStartElement() aufgerufen werden, bevor irgendein Inhalt geschrieben wird, oder nach writeEmptyElement().

Siehe auch writeAttribute() und writeNamespace().

void QXmlStreamWriter::writeCDATA(QAnyStringView text)

Schreibt text als CDATA-Abschnitt. Wenn text die verbotene Zeichenfolge "]]>" enthält, wird es in verschiedene CDATA-Abschnitte aufgeteilt.

Diese Funktion ist nur der Vollständigkeit halber vorhanden. Normalerweise sollten Sie sie nicht benötigen, da writeCharacters() automatisch alle Zeichen, die nicht zum Inhalt gehören, umgeht.

void QXmlStreamWriter::writeCharacters(QAnyStringView text)

Es wird text geschrieben. Die Zeichen "<", "&" und """ werden als Entitätsreferenzen "&lt;", "&amp; und "&quot;" maskiert. Um die verbotene Sequenz "]]>" zu vermeiden, wird ">" auch als "&gt;" entschlüsselt.

Siehe auch writeEntityReference().

void QXmlStreamWriter::writeComment(QAnyStringView text)

Schreibt text als XML-Kommentar, wobei text nicht die verbotene Sequenz -- enthalten oder mit - enden darf. Beachten Sie, dass XML keine Möglichkeit bietet, - in einem Kommentar zu entschlüsseln.

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 ist die Unterstützung der verketteten Verarbeitung von XML-Daten.

Siehe auch QXmlStreamReader::tokenType().

void QXmlStreamWriter::writeDTD(QAnyStringView dtd)

Schreibt einen DTD-Abschnitt. Die dtd repräsentiert die gesamte doctypedecl-Produktion aus der XML 1.0-Spezifikation.

void QXmlStreamWriter::writeDefaultNamespace(QAnyStringView namespaceUri)

Schreibt eine Standard-Namensraumdeklaration für namespaceUri.

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

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 name, das für den angegebenen namespaceUri vorangestellt wird. Wenn der Namespace nicht deklariert wurde, erzeugt QXmlStreamWriter eine Namespace-Deklaration für ihn. Nachfolgende Aufrufe von writeAttribute() fügen Attribute zu diesem Element hinzu.

Siehe auch writeNamespace().

void QXmlStreamWriter::writeEmptyElement(QAnyStringView qualifiedName)

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

void QXmlStreamWriter::writeEndDocument()

Schließt alle verbleibenden offenen Startelemente und schreibt einen Zeilenumbruch.

Siehe auch writeStartDocument().

void QXmlStreamWriter::writeEndElement()

Schließt das vorherige Startelement.

Siehe auch writeStartElement().

void QXmlStreamWriter::writeEntityReference(QAnyStringView name)

Schreibt die Entity-Referenz name in den Stream, als "&name;".

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

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

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

Beachten Sie, dass das Präfix xml sowohl vordefiniert als auch für http://www.w3.org/XML/1998/namespace reserviert ist, das seinerseits an kein anderes Präfix gebunden werden kann. Das Präfix xmlns und sein URI http://www.w3.org/2000/xmlns/ werden für den Namespace-Mechanismus selbst verwendet und sind daher in Deklarationen komplett verboten.

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

Schreibt eine XML-Verarbeitungsanweisung mit target und data, wobei data nicht die Sequenz "?>" 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 einen Dokumentanfang mit der XML-Versionsnummer version und einem eigenständigen Attribut standalone.

Siehe auch writeEndDocument().

void QXmlStreamWriter::writeStartDocument()

Schreibt ein Dokument mit der XML-Versionsnummer "1.0".

Siehe auch writeEndDocument().

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

Schreibt ein Startelement mit name, das dem angegebenen namespaceUri vorangestellt wird. Wenn der Namespace noch nicht deklariert wurde, erzeugt QXmlStreamWriter eine Namespace-Deklaration für ihn. Nachfolgende Aufrufe von writeAttribute() fügen Attribute zu diesem Element hinzu.

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

void QXmlStreamWriter::writeStartElement(QAnyStringView qualifiedName)

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

Siehe auch writeEndElement() und writeEmptyElement().

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

Schreibt ein Textelement mit name, mit dem Präfix für den angegebenen namespaceUri und text. Wenn der Namensraum nicht deklariert wurde, erzeugt QXmlStreamWriter eine Namensraumdeklaration für ihn.

Dies ist eine Komfortfunktion, die äquivalent zu ist:

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

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

Schreibt ein Textelement mit qualifiedName und text.

Dies ist eine Komfortfunktion, die äquivalent zu ist:

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