QXmlStreamReader Class

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

Documentation des fonctions membres

QXmlStreamReader::QXmlStreamReader()

Construit un lecteur de flux.

Voir aussi setDevice() et addData().

[explicit] QXmlStreamReader::QXmlStreamReader(QAnyStringView data)

Crée un nouveau lecteur de flux qui lit à partir de data.

Voir aussi addData(), clear() et setDevice().

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

Crée un nouveau lecteur de flux qui lit à partir de device.

Voir aussi setDevice() et clear().

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

Crée un nouveau lecteur de flux qui lit à partir de data.

Voir aussi addData(), clear() et setDevice().

[noexcept] QXmlStreamReader::~QXmlStreamReader()

Détruit le lecteur.

void QXmlStreamReader::addData(QAnyStringView data)

Ajoute plus de data pour que le lecteur puisse le lire. Cette fonction ne fait rien si le lecteur a un device().

Voir aussi readNext() et clear().

void QXmlStreamReader::addData(const QByteArray &data)

Ajoute plus de data pour que le lecteur puisse le lire. Cette fonction ne fait rien si le lecteur a un device().

Voir aussi readNext() et clear().

void QXmlStreamReader::addExtraNamespaceDeclaration(const QXmlStreamNamespaceDeclaration &extraNamespaceDeclaration)

Ajoute un extraNamespaceDeclaration. La déclaration sera valide pour les enfants de l'élément actuel, ou - si la fonction est appelée avant qu'aucun élément ne soit lu - pour l'ensemble du document XML.

Voir aussi namespaceDeclarations(), addExtraNamespaceDeclarations() et setNamespaceProcessing().

void QXmlStreamReader::addExtraNamespaceDeclarations(const QXmlStreamNamespaceDeclarations &extraNamespaceDeclarations)

Ajoute un vecteur de déclarations spécifié par extraNamespaceDeclarations.

Voir aussi namespaceDeclarations() et addExtraNamespaceDeclaration().

bool QXmlStreamReader::atEnd() const

Renvoie true si le lecteur a lu jusqu'à la fin du document XML, ou si un error() s'est produit et que la lecture a été interrompue. Sinon, il renvoie false.

Lorsque atEnd() et hasError() renvoient true et que error() renvoie PrematureEndOfDocumentError, cela signifie que le XML a été bien formé jusqu'à présent, mais qu'un document XML complet n'a pas été analysé. Le prochain morceau de XML peut être ajouté avec addData(), si le XML est lu à partir d'un QByteArray, ou en attendant que d'autres données arrivent si le XML est lu à partir d'un QIODevice. Dans tous les cas, atEnd() renverra faux une fois que d'autres données seront disponibles.

Voir également hasError(), error(), device() et QIODevice::atEnd().

QXmlStreamAttributes QXmlStreamReader::attributes() const

Renvoie les attributs d'un StartElement.

qint64 QXmlStreamReader::characterOffset() const

Renvoie le décalage actuel des caractères, en commençant par 0.

Voir aussi lineNumber() et columnNumber().

void QXmlStreamReader::clear()

Supprime toute device() ou donnée du lecteur et remet son état interne à l'état initial.

Voir également addData().

qint64 QXmlStreamReader::columnNumber() const

Renvoie le numéro de la colonne actuelle, en commençant par 0.

Voir aussi lineNumber() et characterOffset().

QIODevice *QXmlStreamReader::device() const

Renvoie le dispositif actuel associé à QXmlStreamReader, ou nullptr si aucun dispositif n'a été assigné.

Voir aussi setDevice().

QStringView QXmlStreamReader::documentEncoding() const

Si tokenType() est StartDocument, cette fonction renvoie la chaîne d'encodage spécifiée dans la déclaration XML. Sinon, elle renvoie une chaîne vide.

QStringView QXmlStreamReader::documentVersion() const

Si l'adresse tokenType() est StartDocument, cette fonction renvoie la chaîne de la version telle qu'elle est spécifiée dans la déclaration XML. Sinon, elle renvoie une chaîne vide.

QStringView QXmlStreamReader::dtdName() const

Si l'adresse tokenType() est DTD, cette fonction renvoie le nom de la DTD. Sinon, elle renvoie une chaîne vide.

QStringView QXmlStreamReader::dtdPublicId() const

Si l'adresse tokenType() est DTD, cette fonction renvoie l'identifiant public de la DTD. Sinon, elle renvoie une chaîne vide.

QStringView QXmlStreamReader::dtdSystemId() const

Si l'adresse tokenType() est DTD, cette fonction renvoie l'identifiant système de la DTD. Sinon, elle renvoie une chaîne vide.

QXmlStreamEntityDeclarations QXmlStreamReader::entityDeclarations() const

Si tokenType() est DTD, cette fonction renvoie les déclarations d'entités (externes) non analysées de la DTD. Sinon, elle renvoie un vecteur vide.

La classe QXmlStreamEntityDeclarations est définie comme étant une QList de QXmlStreamEntityDeclaration.

int QXmlStreamReader::entityExpansionLimit() const

Renvoie la quantité maximale de caractères qu'une seule entité peut contenir. Si une seule entité dépasse la limite donnée, le document n'est pas considéré comme bien formé.

Voir aussi setEntityExpansionLimit.

QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const

Renvoie le résolveur d'entités, ou nullptr s'il n'y a pas de résolveur d'entités.

Voir aussi setEntityResolver().

QXmlStreamReader::Error QXmlStreamReader::error() const

Renvoie le type de l'erreur en cours, ou NoError si aucune erreur ne s'est produite.

Voir aussi errorString() et raiseError().

QString QXmlStreamReader::errorString() const

Renvoie le message d'erreur qui a été défini avec raiseError().

Voir aussi error(), lineNumber(), columnNumber() et characterOffset().

bool QXmlStreamReader::hasError() const

Renvoie true si une erreur s'est produite, sinon false.

Voir aussi errorString() et error().

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

Renvoie true si ce document possède une déclaration autonome explicite (peut être "oui" ou "non") ; sinon, renvoie false;

Si aucune déclaration XML n'a été analysée, cette fonction renvoie false.

Cette fonction a été introduite dans Qt 6.6.

Voir aussi isStandaloneDocument().

bool QXmlStreamReader::isCDATA() const

Renvoie true si le lecteur signale des caractères provenant d'une section CDATA ; sinon, renvoie false.

Voir aussi isCharacters() et text().

bool QXmlStreamReader::isCharacters() const

Renvoie true si tokenType() est égal à Characters; sinon, renvoie false.

Voir aussi isWhitespace() et isCDATA().

bool QXmlStreamReader::isComment() const

Renvoie true si tokenType() est égal à Comment; sinon, renvoie false.

bool QXmlStreamReader::isDTD() const

Renvoie true si tokenType() est égal à DTD; sinon, renvoie false.

bool QXmlStreamReader::isEndDocument() const

Renvoie true si tokenType() est égal à EndDocument; sinon, renvoie false.

bool QXmlStreamReader::isEndElement() const

Renvoie true si tokenType() est égal à EndElement; sinon, renvoie false.

bool QXmlStreamReader::isEntityReference() const

Renvoie true si tokenType() est égal à EntityReference; sinon, renvoie false.

bool QXmlStreamReader::isProcessingInstruction() const

Renvoie true si tokenType() est égal à ProcessingInstruction; sinon, renvoie false.

bool QXmlStreamReader::isStandaloneDocument() const

Renvoie true si ce document a été déclaré autonome dans la déclaration XML ; sinon, renvoie false.

Si aucune déclaration XML n'a été analysée, cette fonction renvoie false.

Voir aussi hasStandaloneDeclaration().

bool QXmlStreamReader::isStartDocument() const

Renvoie true si tokenType() est égal à StartDocument; sinon, renvoie false.

bool QXmlStreamReader::isStartElement() const

Renvoie true si tokenType() est égal à StartElement; sinon, renvoie false.

bool QXmlStreamReader::isWhitespace() const

Renvoie true si le lecteur signale des caractères constitués uniquement d'espaces blancs ; sinon, renvoie false.

Voir aussi isCharacters() et text().

qint64 QXmlStreamReader::lineNumber() const

Renvoie le numéro de ligne actuel, en commençant par 1.

Voir aussi columnNumber() et characterOffset().

QStringView QXmlStreamReader::name() const

Renvoie le nom local d'un StartElement, EndElement, ou d'un EntityReference.

Voir aussi namespaceUri() et qualifiedName().

QXmlStreamNamespaceDeclarations QXmlStreamReader::namespaceDeclarations() const

Si tokenType() est StartElement, cette fonction renvoie les déclarations d'espace de noms de l'élément. Sinon, elle renvoie un vecteur vide.

La classe QXmlStreamNamespaceDeclarations est définie comme étant un QList de QXmlStreamNamespaceDeclaration.

Voir aussi addExtraNamespaceDeclaration() et addExtraNamespaceDeclarations().

QStringView QXmlStreamReader::namespaceUri() const

Renvoie le namespaceUri d'un StartElement ou d'un EndElement.

Voir aussi name() et qualifiedName().

QXmlStreamNotationDeclarations QXmlStreamReader::notationDeclarations() const

Si tokenType() est DTD, cette fonction renvoie les déclarations de notation de la DTD. Sinon, elle renvoie un vecteur vide.

La classe QXmlStreamNotationDeclarations est définie comme étant une QList de QXmlStreamNotationDeclaration.

QStringView QXmlStreamReader::prefix() const

Renvoie le préfixe d'un StartElement ou d'un EndElement.

Voir aussi name() et qualifiedName().

QStringView QXmlStreamReader::processingInstructionData() const

Renvoie les données d'un site ProcessingInstruction.

QStringView QXmlStreamReader::processingInstructionTarget() const

Renvoie la cible d'un ProcessingInstruction.

QStringView QXmlStreamReader::qualifiedName() const

Renvoie le nom qualifié d'un StartElement ou d'un EndElement;

Un nom qualifié est le nom brut d'un élément dans les données XML. Il se compose du préfixe de l'espace de noms, suivi de deux points, puis du nom local de l'élément. Étant donné que le préfixe de l'espace de noms n'est pas unique (le même préfixe peut pointer vers différents espaces de noms et des préfixes différents peuvent pointer vers le même espace de noms), vous ne devez pas utiliser qualifiedName(), mais le nom résolu namespaceUri() et le nom local de l'attribut name().

Voir également name(), prefix() et namespaceUri().

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

Lance une erreur personnalisée avec une erreur optionnelle message.

Voir aussi error() et errorString().

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

Fonction de commodité à appeler dans le cas où un StartElement a été lu. Lit jusqu'au EndElement correspondant et renvoie tout le texte entre les deux. En l'absence d'erreur, l'élément courant (voir tokenType()) après avoir appelé cette fonction est EndElement.

La fonction concatène text() lorsqu'elle lit les jetons Characters ou EntityReference, mais ignore ProcessingInstruction et Comment. Si le jeton courant n'est pas StartElement, une chaîne vide est renvoyée.

Le behaviour définit ce qui se passe au cas où quelque chose d'autre est lu avant d'atteindre le EndElement. La fonction peut inclure le texte des éléments enfants (utile par exemple pour le HTML), ignorer les éléments enfants ou lever un UnexpectedElementError et renvoyer ce qui a été lu jusqu'à présent (par défaut).

QXmlStreamReader::TokenType QXmlStreamReader::readNext()

Lit le jeton suivant et renvoie son type.

À une exception près, lorsqu'un error() est signalé par readNext(), il n'est plus possible de poursuivre la lecture du flux XML. Ensuite, atEnd() renvoie true, hasError() renvoie true, et cette fonction renvoie QXmlStreamReader::Invalid.

L'exception est lorsque error() renvoie PrematureEndOfDocumentError. Cette erreur est signalée lorsque la fin d'un morceau de XML par ailleurs bien formé est atteinte, mais que le morceau ne représente pas un document XML complet. Dans ce cas, l'analyse peut être reprise en appelant addData() pour ajouter le prochain morceau de XML, lorsque le flux est lu à partir d'un QByteArray, ou en attendant que d'autres données arrivent lorsque le flux est lu à partir d'un device().

Voir également tokenType() et tokenString().

bool QXmlStreamReader::readNextStartElement()

Lit jusqu'au prochain élément de départ à l'intérieur de l'élément actuel. Retourne true lorsqu'un élément de départ a été atteint. Lorsque l'élément de fin a été atteint, ou lorsqu'une erreur s'est produite, false est renvoyé.

L'élément courant est l'élément correspondant à l'élément de départ le plus récemment analysé et dont l'élément de fin correspondant n'a pas encore été atteint. Lorsque l'analyseur syntaxique a atteint l'élément final, l'élément courant devient l'élément parent.

Il s'agit d'une fonction de commodité pour les cas où vous n'êtes concerné que par l'analyse des éléments XML. L'exemple des signets QXmlStream fait un usage intensif de cette fonction.

Voir également readNext().

[since 6.10] QString QXmlStreamReader::readRawInnerData()

Lit et renvoie le contenu XML interne brut de l'élément actuel. Cette fonction est utile pour récupérer le contenu complet intégré dans un élément, y compris les balises imbriquées, le texte, les commentaires, les instructions de traitement, les sections CDATA et d'autres balises - en préservant la structure XML d'origine.

L'élément actuel est l'élément correspondant à l'élément de départ le plus récemment analysé et dont l'élément final correspondant n'a pas encore été atteint. Lorsque l'analyseur syntaxique a atteint l'élément final, l'élément courant devient l'élément parent.

Cette fonction a été introduite dans Qt 6.10.

void QXmlStreamReader::setDevice(QIODevice *device)

Définit le périphérique actuel à device. La définition du périphérique réinitialise le flux à son état initial.

Voir aussi device() et clear().

void QXmlStreamReader::setEntityExpansionLimit(int limit)

Fixe la quantité maximale de caractères qu'une entité unique est autorisée à développer à limit. Si une entité unique se développe au-delà de la limite donnée, le document n'est pas considéré comme bien formé.

Cette limite a pour but de prévenir les attaques DoS lors du chargement de documents XML inconnus dans lesquels l'expansion récursive des entités pourrait épuiser toute la mémoire disponible.

La valeur par défaut de cette propriété est de 4096 caractères.

Voir aussi entityExpansionLimit.

void QXmlStreamReader::setEntityResolver(QXmlStreamEntityResolver *resolver)

Fait de resolver le nouveau entityResolver().

Le lecteur de flux n'est pas propriétaire du résolveur. Il incombe à l'appelant de s'assurer que le résolveur est valide pendant toute la durée de vie de l'objet lecteur de flux, ou jusqu'à ce qu'un autre résolveur ou nullptr soit défini.

Voir également entityResolver().

void QXmlStreamReader::skipCurrentElement()

Lit jusqu'à la fin de l'élément courant, en ignorant les nœuds enfants. Cette fonction est utile pour sauter des éléments inconnus.

L'élément courant est l'élément correspondant à l'élément de départ le plus récemment analysé et dont l'élément final correspondant n'a pas encore été atteint. Lorsque l'analyseur syntaxique a atteint l'élément final, l'élément courant devient l'élément parent.

QStringView QXmlStreamReader::text() const

Renvoie le texte de Characters, Comment, DTD, ou EntityReference.

QString QXmlStreamReader::tokenString() const

Renvoie le jeton actuel du lecteur sous forme de chaîne de caractères.

Voir aussi tokenType().

QXmlStreamReader::TokenType QXmlStreamReader::tokenType() const

Renvoie le type du jeton actuel.

Le jeton actuel peut également être interrogé à l'aide des fonctions de commodité isStartDocument(), isEndDocument(), isStartElement(), isEndElement(), isCharacters(), isComment(), isDTD(), isEntityReference() et isProcessingInstruction().

Voir également tokenString().