QXmlStreamReader Class

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

Dokumentation der Mitgliedsfunktionen

QXmlStreamReader::QXmlStreamReader()

Konstruiert einen Stream-Reader.

Siehe auch setDevice() und addData().

[explicit] QXmlStreamReader::QXmlStreamReader(QAnyStringView data)

Erzeugt einen neuen Stream-Reader, der von data liest.

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

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

Erzeugt einen neuen Stream-Reader, der von device liest.

Siehe auch setDevice() und clear().

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

Dies ist eine überladene Funktion.

Erzeugt einen neuen Stream-Reader, der von data liest.

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

[noexcept] QXmlStreamReader::~QXmlStreamReader()

Zerstört das Lesegerät.

void QXmlStreamReader::addData(QAnyStringView data)

Fügt weitere data für den Leser hinzu. Diese Funktion macht nichts, wenn der Leser eine device() hat.

Siehe auch readNext() und clear().

void QXmlStreamReader::addData(const QByteArray &data)

Dies ist eine überladene Funktion.

Fügt weitere data für den Leser hinzu, die er lesen kann. Diese Funktion bewirkt nichts, wenn der Leser eine device() hat.

Siehe auch readNext() und clear().

void QXmlStreamReader::addExtraNamespaceDeclaration(const QXmlStreamNamespaceDeclaration &extraNamespaceDeclaration)

Fügt ein extraNamespaceDeclaration hinzu. Die Deklaration gilt für die Kinder des aktuellen Elements oder - falls die Funktion aufgerufen wird, bevor irgendwelche Elemente gelesen werden - 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, der durch extraNamespaceDeclarations angegeben wird.

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-Dokument bisher wohlgeformt wurde, aber noch kein vollständiges XML-Dokument geparst wurde. Das nächste XML-Stück kann mit addData() hinzugefügt werden, wenn das XML von einem QByteArray gelesen wird, oder durch Warten auf weitere Daten, wenn das XML von 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 einer StartElement zurück.

qint64 QXmlStreamReader::characterOffset() const

Gibt den aktuellen Zeichenoffset zurück, beginnend mit 0.

Siehe auch lineNumber() und columnNumber().

void QXmlStreamReader::clear()

Entfernt alle device() oder Daten aus dem Lesegerät 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 dem QXmlStreamReader zugeordnet ist, oder nullptr, wenn kein Gerät zugewiesen wurde.

Siehe auch setDevice().

QStringView QXmlStreamReader::documentEncoding() const

Wenn tokenType() StartDocument ist, gibt diese Funktion die in der XML-Deklaration angegebene Kodierungszeichenfolge zurück. Andernfalls wird eine leere Zeichenkette zurückgegeben.

QStringView QXmlStreamReader::documentVersion() const

Wenn tokenType() StartDocument ist, gibt diese Funktion die in der XML-Deklaration angegebene Versionszeichenfolge zurück. Andernfalls wird eine leere Zeichenkette zurückgegeben.

QStringView QXmlStreamReader::dtdName() const

Wenn tokenType() DTD ist, gibt diese Funktion den Namen der DTD zurück. Andernfalls wird eine leere Zeichenkette zurückgegeben.

QStringView QXmlStreamReader::dtdPublicId() const

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

QStringView QXmlStreamReader::dtdSystemId() const

Wenn tokenType() DTD ist, gibt diese Funktion den Systemidentifikator der DTD zurück. Andernfalls wird eine leere Zeichenkette zurückgegeben.

QXmlStreamEntityDeclarations QXmlStreamReader::entityDeclarations() const

Wenn tokenType() DTD ist, gibt diese Funktion die unparsed (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 Anzahl von Zeichen zurück, die ein einzelnes Element umfassen kann. Wenn ein einzelnes Element über das angegebene Limit hinausgeht, wird das Dokument als nicht wohlgeformt betrachtet.

Siehe auch setEntityExpansionLimit.

QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const

Gibt den Entitätsauflöser zurück, oder nullptr, wenn es keinen Entitätsauflöser gibt.

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() gesetzt 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 hat (kann 'ja' oder 'nein' sein); andernfalls false;

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 Leser 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ändig 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 Leser Zeichen meldet, die nur 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 eines EntityReference zurück.

Siehe auch namespaceUri() und qualifiedName().

QXmlStreamNamespaceDeclarations QXmlStreamReader::namespaceDeclarations() const

Wenn tokenType() StartElement ist, 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 die NamespaceUri eines StartElement oder EndElement zurück.

Siehe auch name() und qualifiedName().

QXmlStreamNotationDeclarations QXmlStreamReader::notationDeclarations() const

Wenn tokenType() DTD ist, 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 einer ProcessingInstruction zurück.

QStringView QXmlStreamReader::processingInstructionTarget() const

Gibt das Ziel einer ProcessingInstruction zurück.

QStringView QXmlStreamReader::qualifiedName() const

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

Ein qualifizierter Name ist der rohe Name eines Elements in den XML-Daten. Er besteht aus dem Namespace-Präfix, gefolgt von einem Doppelpunkt, gefolgt von dem lokalen Namen des Elements. Da der Namespace-Präfix nicht eindeutig ist (derselbe Präfix kann auf verschiedene Namespaces verweisen und verschiedene Präfixe können auf denselben Namespace verweisen), sollten Sie nicht qualifiedName() verwenden, sondern den aufgelösten 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)

Convenience-Funktion, die aufgerufen wird, wenn eine StartElement gelesen wurde. Liest bis zum entsprechenden EndElement und gibt den gesamten dazwischen liegenden Text zurück. Wenn kein Fehler auftritt, ist das aktuelle Token (siehe tokenType()) nach dem Aufruf dieser Funktion EndElement.

Die Funktion verkettet text(), wenn sie entweder Characters oder EntityReference liest, überspringt aber ProcessingInstruction und Comment. Wenn das aktuelle Token nicht StartElement ist, wird ein leerer String zurückgegeben.

behaviour legt fest, was passiert, wenn etwas anderes gelesen wird, bevor EndElement erreicht wird. Die Funktion kann den Text von untergeordneten Elementen einschließen (nützlich z. B. für HTML), untergeordnete Elemente ignorieren oder UnexpectedElementError auslösen und das zurückgeben, was bisher gelesen wurde (Standard).

QXmlStreamReader::TokenType QXmlStreamReader::readNext()

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

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

Die Ausnahme ist, wenn error() PrematureEndOfDocumentError zurückgibt. Dieser Fehler wird gemeldet, wenn das Ende eines ansonsten wohlgeformten XML-Blocks erreicht ist, der Block aber kein vollständiges XML-Dokument darstellt. In diesem Fall kann das Parsen wieder aufgenommen werden, indem addData() aufgerufen wird, um das nächste XML-Stück hinzuzufügen, wenn der Stream von einem QByteArray gelesen wird, oder indem auf weitere Daten gewartet wird, wenn der Stream von 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, zu dem noch kein passendes Endelement erreicht wurde. Wenn der Parser das Endelement erreicht hat, wird das aktuelle Element zum Elternelement.

Dies ist eine praktische Funktion, wenn Sie sich nur mit dem Parsen von XML-Elementen beschäftigen. Das QXmlStream Bookmarks Beispiel macht ausgiebig Gebrauch von dieser Funktion.

Siehe auch readNext().

void QXmlStreamReader::setDevice(QIODevice *device)

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

Siehe auch device() und clear().

void QXmlStreamReader::setEntityExpansionLimit(int limit)

Setzt die maximale Anzahl von Zeichen, die eine einzelne Entität umfassen darf, auf limit. Wenn eine einzelne Entität über das angegebene Limit hinaus expandiert, wird das Dokument nicht als wohlgeformt angesehen.

Der Grenzwert dient dazu, DoS-Angriffe beim Laden unbekannter XML-Dokumente zu verhindern, bei denen die rekursive Entity-Expansion ansonsten den gesamten verfügbaren Speicher erschöpfen könnte.

Der Standardwert für diese Eigenschaft ist 4096 Zeichen.

Siehe auch entityExpansionLimit.

void QXmlStreamReader::setEntityResolver(QXmlStreamEntityResolver *resolver)

Macht aus resolver den neuen entityResolver().

Der Stream-Reader übernimmt nicht das Eigentum am 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 nullptr gesetzt wird.

Siehe auch entityResolver().

void QXmlStreamReader::skipCurrentElement()

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

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

QStringView QXmlStreamReader::text() const

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

QString QXmlStreamReader::tokenString() const

Gibt das aktuelle Token des Lesers als String 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 Komfortfunktionen isStartDocument(), isEndDocument(), isStartElement(), isEndElement(), isCharacters(), isComment(), isDTD(), isEntityReference() und isProcessingInstruction() abgefragt werden.

Siehe auch tokenString().