QXmlStreamReader Class

QXmlStreamReader xml;
//...
while (!xml.atEnd()) {
    xml.readNext();
    //... do processing
}
if (xml.hasError()) {
    //... do error handling
}

Dokumentation zu den Mitgliedsfunktionen

QXmlStreamReader::QXmlStreamReader()

Erstellt einen Stream-Reader.

Siehe auch setDevice() und addData().

[explicit] QXmlStreamReader::QXmlStreamReader(QAnyStringView data)

Erstellt einen neuen Stream-Reader, der aus ` data` liest.

Siehe auch ` addData()`, ` clear()` und ` setDevice()`.

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

Erstellt einen neuen Stream-Reader, der aus device liest.

Siehe auch setDevice() und clear().

[explicit] QXmlStreamReader::QXmlStreamReader(const QByteArray &data)

Erstellt einen neuen Stream-Reader, der aus „ data “ liest.

Siehe auch addData(), clear() und setDevice().

[noexcept] QXmlStreamReader::~QXmlStreamReader()

Zerstört den Leser.

void QXmlStreamReader::addData(QAnyStringView data)

Fügt dem Reader weitere „ data “ hinzu. Diese Funktion führt keine Aktion aus, wenn der Reader über „ device()“ verfügt.

Siehe auch readNext() und clear().

void QXmlStreamReader::addData(const QByteArray &data)

Fügt dem Reader weitere „ data “ hinzu. Diese Funktion führt keine Aktion aus, wenn der Reader bereits über ein „ device()“ verfügt.

Siehe auch ` readNext()` und ` clear()`.

void QXmlStreamReader::addExtraNamespaceDeclaration(const QXmlStreamNamespaceDeclaration &extraNamespaceDeclaration)

Fügt einen „ extraNamespaceDeclaration “ hinzu. Die Deklaration gilt für die untergeordneten Elemente des aktuellen Elements oder – sollte die Funktion aufgerufen werden, bevor Elemente gelesen wurden – für das gesamte XML-Dokument.

Siehe auch namespaceDeclarations(), addExtraNamespaceDeclarations() und setNamespaceProcessing().

void QXmlStreamReader::addExtraNamespaceDeclarations(const QXmlStreamNamespaceDeclarations &extraNamespaceDeclarations)

Fügt einen Vektor von Deklarationen hinzu, die unter extraNamespaceDeclarations angegeben sind.

Siehe auch namespaceDeclarations() und addExtraNamespaceDeclaration().

bool QXmlStreamReader::atEnd() const

Gibt ` true ` zurück, wenn der Reader bis zum Ende des XML-Dokuments gelesen hat oder wenn ein ` error()` aufgetreten ist und das Lesen abgebrochen wurde. Andernfalls wird ` false` zurückgegeben.

Wenn atEnd() und hasError() „true“ zurückgeben und error() „ PrematureEndOfDocumentError “ zurückgibt, bedeutet dies, dass das XML bisher wohlgeformt ist, aber noch kein vollständiges XML-Dokument geparst wurde. Der nächste XML-Abschnitt kann mit ` addData()` hinzugefügt werden, wenn das XML aus einem ` QByteArray` gelesen wird, oder indem auf das Eintreffen weiterer Daten gewartet wird, wenn das XML aus einem ` QIODevice` gelesen wird. In beiden Fällen gibt `atEnd()` „false“ zurück, sobald weitere Daten verfügbar sind.

Siehe auch „ hasError()“, „ error()“, „ device()“ und „ QIODevice::atEnd()“.

QXmlStreamAttributes QXmlStreamReader::attributes() const

Gibt die Attribute eines ` StartElement` zurück.

qint64 QXmlStreamReader::characterOffset() const

Gibt den aktuellen Zeichenversatz zurück, beginnend bei 0.

Siehe auch lineNumber() und columnNumber().

void QXmlStreamReader::clear()

Entfernt alle „ device()“-Elemente oder Daten aus dem Reader und setzt dessen internen Zustand auf den Ausgangszustand zurück.

Siehe auch addData().

qint64 QXmlStreamReader::columnNumber() const

Gibt die aktuelle Spaltennummer zurück, beginnend mit 0.

Siehe auch lineNumber() und characterOffset().

QIODevice *QXmlStreamReader::device() const

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

Siehe auch setDevice().

QStringView QXmlStreamReader::documentEncoding() const

Wenn der Parameter „ tokenType()“ den Wert „ StartDocument “ hat, gibt diese Funktion die in der XML-Deklaration angegebene Kodierungszeichenfolge zurück. Andernfalls wird eine leere Zeichenfolge zurückgegeben.

QStringView QXmlStreamReader::documentVersion() const

Wenn der Parameter „ tokenType()“ den Wert „ StartDocument “ hat, gibt diese Funktion die in der XML-Deklaration angegebene Versionszeichenfolge zurück. Andernfalls wird eine leere Zeichenfolge zurückgegeben.

QStringView QXmlStreamReader::dtdName() const

Wenn der Parameter „ tokenType()“ den Wert „ DTD “ hat, gibt diese Funktion den Namen der DTD zurück. Andernfalls wird eine leere Zeichenkette zurückgegeben.

QStringView QXmlStreamReader::dtdPublicId() const

Wenn die Funktion „ tokenType()“ den Wert „ DTD “ zurückgibt, gibt diese Funktion den öffentlichen Bezeichner der DTD zurück. Andernfalls wird eine leere Zeichenkette zurückgegeben.

QStringView QXmlStreamReader::dtdSystemId() const

Wenn der Wert von „ tokenType()“ „ DTD “ lautet, gibt diese Funktion die Systemkennung der DTD zurück. Andernfalls wird eine leere Zeichenkette zurückgegeben.

QXmlStreamEntityDeclarations QXmlStreamReader::entityDeclarations() const

Wenn der tokenType() den Wert „ DTD “ hat, gibt diese Funktion die unparsierten (externen) Entitätsdeklarationen der DTD zurück. Andernfalls wird ein leerer Vektor zurückgegeben.

Die Klasse „ QXmlStreamEntityDeclarations “ ist als „ QList “ von „ QXmlStreamEntityDeclaration “ definiert.

int QXmlStreamReader::entityExpansionLimit() const

Gibt die maximale Zeichenanzahl zurück, auf die sich eine einzelne Entität ausdehnen darf. Wenn eine einzelne Entität über die angegebene Grenze hinauswächst, gilt das Dokument als nicht wohlgeformt.

Siehe auch setEntityExpansionLimit.

QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const

Gibt den Entity-Resolver zurück oder „ nullptr “, falls kein Entity-Resolver vorhanden ist.

Siehe auch setEntityResolver().

QXmlStreamReader::Error QXmlStreamReader::error() const

Gibt den Typ des aktuellen Fehlers zurück oder „ NoError “, wenn kein Fehler aufgetreten ist.

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

QString QXmlStreamReader::errorString() const

Gibt die Fehlermeldung zurück, die mit ` raiseError()` festgelegt wurde.

Siehe auch „ error()“, „ lineNumber()“, „ columnNumber()“ und „ characterOffset()“.

bool QXmlStreamReader::hasError() const

Gibt „ true “ zurück, wenn ein Fehler aufgetreten ist, andernfalls „ false “.

Siehe auch errorString() und error().

[since 6.6] bool QXmlStreamReader::hasStandaloneDeclaration() const

Gibt „ true “ zurück, wenn dieses Dokument eine explizite Standalone-Deklaration enthält (kann „yes“ oder „no“ lauten); andernfalls wird „ false “ zurückgegeben;

Wenn keine XML-Deklaration geparst wurde, gibt diese Funktion „ false “ zurück.

Diese Funktion wurde in Qt 6.6 eingeführt.

Siehe auch ` isStandaloneDocument()`.

bool QXmlStreamReader::isCDATA() const

Gibt „ true “ zurück, wenn der Reader Zeichen meldet, die aus einem CDATA-Abschnitt stammen; andernfalls wird „ false “ zurückgegeben.

Siehe auch isCharacters() und text().

bool QXmlStreamReader::isCharacters() const

Gibt „ true “ zurück, wenn „ tokenType()“ gleich „ Characters “ ist; andernfalls wird „ false “ zurückgegeben.

Siehe auch isWhitespace() und isCDATA().

bool QXmlStreamReader::isComment() const

Gibt „ true “ zurück, wenn „ tokenType()“ gleich „ Comment “ ist; andernfalls wird „ false “ zurückgegeben.

bool QXmlStreamReader::isDTD() const

Gibt „ true “ zurück, wenn „ tokenType()“ gleich „ DTD “ ist; andernfalls wird „ false “ zurückgegeben.

bool QXmlStreamReader::isEndDocument() const

Gibt „ true “ zurück, wenn „ tokenType()“ gleich „ EndDocument “ ist; andernfalls wird „ false “ zurückgegeben.

bool QXmlStreamReader::isEndElement() const

Gibt „ true “ zurück, wenn „ tokenType()“ gleich „ EndElement “ ist; andernfalls wird „ false “ zurückgegeben.

bool QXmlStreamReader::isEntityReference() const

Gibt „ true “ zurück, wenn „ tokenType()“ gleich „ EntityReference “ ist; andernfalls wird „ false “ zurückgegeben.

bool QXmlStreamReader::isProcessingInstruction() const

Gibt „ true “ zurück, wenn „ tokenType()“ gleich „ ProcessingInstruction “ ist; andernfalls wird „ false “ zurückgegeben.

bool QXmlStreamReader::isStandaloneDocument() const

Gibt „ true “ zurück, wenn dieses Dokument in der XML-Deklaration als eigenständiges Dokument deklariert wurde; andernfalls wird „ false “ zurückgegeben.

Wenn keine XML-Deklaration geparst wurde, gibt diese Funktion „ false “ zurück.

Siehe auch hasStandaloneDeclaration().

bool QXmlStreamReader::isStartDocument() const

Gibt „ true “ zurück, wenn „ tokenType()“ gleich „ StartDocument “ ist; andernfalls wird „ false “ zurückgegeben.

bool QXmlStreamReader::isStartElement() const

Gibt „ true “ zurück, wenn „ tokenType()“ gleich „ StartElement “ ist; andernfalls wird „ false “ zurückgegeben.

bool QXmlStreamReader::isWhitespace() const

Gibt „ true “ zurück, wenn der Reader Zeichen meldet, die ausschließlich aus Leerzeichen bestehen; andernfalls wird „ false “ zurückgegeben.

Siehe auch isCharacters() und text().

qint64 QXmlStreamReader::lineNumber() const

Gibt die aktuelle Zeilennummer zurück, beginnend mit 1.

Siehe auch columnNumber() und characterOffset().

QStringView QXmlStreamReader::name() const

Gibt den lokalen Namen eines „ StartElement “, „ EndElement “ oder „ EntityReference “ zurück.

Siehe auch namespaceUri() und qualifiedName().

QXmlStreamNamespaceDeclarations QXmlStreamReader::namespaceDeclarations() const

Wenn der tokenType() den Wert „ StartElement “ hat, gibt diese Funktion die Namespace-Deklarationen des Elements zurück. Andernfalls wird ein leerer Vektor zurückgegeben.

Die Klasse ` QXmlStreamNamespaceDeclarations ` ist als ` QList ` von ` QXmlStreamNamespaceDeclaration` definiert.

Siehe auch „ addExtraNamespaceDeclaration()“ und „ addExtraNamespaceDeclarations()“.

QStringView QXmlStreamReader::namespaceUri() const

Gibt den namespaceUri eines „ StartElement “ oder „ EndElement “ zurück.

Siehe auch name() und qualifiedName().

QXmlStreamNotationDeclarations QXmlStreamReader::notationDeclarations() const

Wenn der tokenType() den Wert „ DTD “ hat, gibt diese Funktion die Notationsdeklarationen der DTD zurück. Andernfalls wird ein leerer Vektor zurückgegeben.

Die Klasse „ QXmlStreamNotationDeclarations “ ist als „ QList “ von „ QXmlStreamNotationDeclaration “ definiert.

QStringView QXmlStreamReader::prefix() const

Gibt das Präfix eines StartElement oder EndElement zurück.

Siehe auch name() und qualifiedName().

QStringView QXmlStreamReader::processingInstructionData() const

Gibt die Daten eines ` ProcessingInstruction` zurück.

QStringView QXmlStreamReader::processingInstructionTarget() const

Gibt das Ziel eines ` ProcessingInstruction` zurück.

QStringView QXmlStreamReader::qualifiedName() const

Gibt den qualifizierten Namen eines StartElement oder EndElement zurück;

Ein qualifizierter Name ist der Rohname eines Elements in den XML-Daten. Er besteht aus dem Namespace-Präfix, gefolgt von einem Doppelpunkt und dem lokalen Namen des Elements. Da das Namespace-Präfix nicht eindeutig ist (dasselbe Präfix kann auf verschiedene Namespaces verweisen und verschiedene Präfixe können auf denselben Namespace verweisen), sollten Sie nicht `qualifiedName()` verwenden, sondern die aufgelöste Form ` namespaceUri()` und den lokalen Namen des Attributs ` name()`.

Siehe auch ` name()`, ` prefix()` und ` namespaceUri()`.

void QXmlStreamReader::raiseError(const QString &message = QString())

Löst einen benutzerdefinierten Fehler mit einem optionalen Fehler message aus.

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

QString QXmlStreamReader::readElementText(QXmlStreamReader::ReadElementTextBehaviour behaviour = ErrorOnUnexpectedElement)

Hilfsfunktion, die aufgerufen wird, wenn ein „ StartElement “ gelesen wurde. Liest bis zum entsprechenden „ EndElement “ und gibt den gesamten dazwischenliegenden Text zurück. Wenn kein Fehler auftritt, lautet das aktuelle Token (siehe „ tokenType()“) nach dem Aufruf dieser Funktion „ EndElement “.

Die Funktion fügt ` text()` an, wenn sie entweder die Tokens ` Characters ` oder ` EntityReference ` liest, überspringt jedoch ` ProcessingInstruction ` und ` Comment`. Ist das aktuelle Token nicht ` StartElement`, wird eine leere Zeichenkette zurückgegeben.

Die Ausnahme „ behaviour “ definiert, was geschieht, falls etwas anderes gelesen wird, bevor „ EndElement “ erreicht wird. Die Funktion kann den Text aus untergeordneten Elementen einbeziehen (nützlich beispielsweise für HTML), untergeordnete Elemente ignorieren oder eine „ UnexpectedElementError “-Ausnahme auslösen und das bisher Gelesene zurückgeben (Standard).

QXmlStreamReader::TokenType QXmlStreamReader::readNext()

Liest das nächste Token und gibt dessen Typ zurück.

Mit einer Ausnahme gilt: Sobald von `readNext()` ein ` error()` gemeldet wird, ist ein weiteres Lesen des XML-Stroms nicht mehr möglich. Dann gibt ` atEnd()` ` true` zurück, ` hasError()` gibt ` true` zurück und diese Funktion gibt ` QXmlStreamReader::Invalid` zurück.

Eine Ausnahme bildet der Fall, in dem ` error()` den Wert ` PrematureEndOfDocumentError` zurückgibt. Dieser Fehler wird gemeldet, wenn das Ende eines ansonsten wohlgeformten XML-Blocks erreicht wird, dieser Block jedoch kein vollständiges XML-Dokument darstellt. In diesem Fall kann das Parsen fortgesetzt werden, indem „ addData()“ aufgerufen wird, um den nächsten XML-Abschnitt hinzuzufügen, wenn der Stream aus einem „ QByteArray “ gelesen wird, oder indem auf das Eintreffen weiterer Daten gewartet wird, wenn der Stream aus einem „ device()“ gelesen wird.

Siehe auch tokenType() und tokenString().

bool QXmlStreamReader::readNextStartElement()

Liest bis zum nächsten Startelement innerhalb des aktuellen Elements. Gibt „ true “ zurück, wenn ein Startelement erreicht wurde. Wenn das Endelement erreicht wurde oder ein Fehler aufgetreten ist, wird „false“ zurückgegeben.

Das aktuelle Element ist das Element, das dem zuletzt geparsten Startelement entspricht, für das noch kein passendes Endelement erreicht wurde. Wenn der Parser das Endelement erreicht hat, wird das übergeordnete Element zum aktuellen Element.

Dies ist eine Komfortfunktion für den Fall, dass Sie sich ausschließlich mit dem Parsen von XML-Elementen befassen. Das QXmlStream-Beispiel „Bookmarks“ nutzt diese Funktion ausgiebig.

Siehe auch „ readNext()“.

[since 6.10] QString QXmlStreamReader::readRawInnerData()

Liest den rohen XML-Inhalt des aktuellen Elements aus und gibt ihn zurück. Diese Funktion ist nützlich, um den vollständigen Inhalt eines Elements abzurufen, einschließlich verschachtelter Tags, Text, Kommentare, Verarbeitungsanweisungen, CDATA-Abschnitte und anderer Markups – unter Beibehaltung der ursprünglichen XML-Struktur.

Das aktuelle Element ist das Element, das dem zuletzt geparsten Startelement entspricht, für das noch kein passendes Endelement erreicht wurde. Wenn der Parser das Endelement erreicht hat, wird das übergeordnete Element zum aktuellen Element.

Diese Funktion wurde in Qt 6.10 eingeführt.

void QXmlStreamReader::setDevice(QIODevice *device)

Setzt das aktuelle Gerät auf „ device “. Durch das Festlegen des Geräts wird der Stream in seinen Ausgangszustand zurückgesetzt.

Siehe auch „ device()“ und „ clear()“.

void QXmlStreamReader::setEntityExpansionLimit(int limit)

Legt die maximale Zeichenanzahl fest, auf die eine einzelne Entität erweitert werden darf ( limit). Wenn eine einzelne Entität über die angegebene Grenze hinaus erweitert wird, gilt das Dokument als nicht wohlgeformt.

Diese Begrenzung dient dazu, DoS-Angriffe beim Laden unbekannter XML-Dokumente zu verhindern, bei denen eine rekursive Entitätsausweitung andernfalls den gesamten verfügbaren Speicher belasten könnte.

Der Standardwert für diese Eigenschaft beträgt 4096 Zeichen.

Der Mindestwert beträgt eins (1), um die integrierten XML-Entitäten (< usw.) zu unterstützen.

Siehe auch entityExpansionLimit.

void QXmlStreamReader::setEntityResolver(QXmlStreamEntityResolver *resolver)

Erzeugt aus resolver das neue entityResolver().

Der Stream-Reader übernimmt nicht die Verantwortung für den Resolver. Es liegt in der Verantwortung des Aufrufers, sicherzustellen, dass der Resolver während der gesamten Lebensdauer des Stream-Reader-Objekts gültig ist oder bis ein anderer Resolver oder ein anderes ` nullptr ` festgelegt wird.

Siehe auch ` entityResolver()` ().

void QXmlStreamReader::skipCurrentElement()

Liest bis zum Ende des aktuellen Elements und überspringt dabei alle untergeordneten Knoten. Diese Funktion ist nützlich, um unbekannte Elemente zu überspringen.

Das aktuelle Element ist das Element, das mit dem zuletzt geparsten Startelement übereinstimmt und für das noch kein passendes Endelement erreicht wurde. Wenn der Parser das Endelement erreicht hat, wird das übergeordnete Element zum aktuellen Element.

QStringView QXmlStreamReader::text() const

Gibt den Text von Characters, Comment, DTD oder EntityReference zurück.

QString QXmlStreamReader::tokenString() const

Gibt das aktuelle Token des Readers als Zeichenkette zurück.

Siehe auch ` tokenType()`.

QXmlStreamReader::TokenType QXmlStreamReader::tokenType() const

Gibt den Typ des aktuellen Tokens zurück.

Das aktuelle Token kann auch mit den Hilfsfunktionen ` isStartDocument()`, ` isEndDocument()`, ` isStartElement()`, ` isEndElement()`, ` isCharacters()`, ` isComment()`, ` isDTD()`, ` isEntityReference()` und ` isProcessingInstruction()` abgefragt werden.

Siehe auch tokenString().