QXmlStreamReader Class

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

Documentation des fonctions membres

QXmlStreamReader::QXmlStreamReader()

Crée un lecteur de flux.

Voir également setDevice() et addData().

[explicit] QXmlStreamReader::QXmlStreamReader(QAnyStringView data)

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

Voir également addData(), clear() et setDevice().

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

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

Voir également setDevice() et clear().

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

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

Voir également addData(), clear() et setDevice().

[noexcept] QXmlStreamReader::~QXmlStreamReader()

Cela perturbe le lecteur.

void QXmlStreamReader::addData(QAnyStringView data)

Ajoute davantage d'data s à l'intention du lecteur. Cette fonction ne fait rien si le lecteur dispose d'une instance de ` device()`.

Voir également readNext() et clear().

void QXmlStreamReader::addData(const QByteArray &data)

Ajoute davantage d'data s à l'intention du lecteur. Cette fonction ne fait rien si le lecteur dispose d'un objet ` device()`.

Voir également readNext() et clear().

void QXmlStreamReader::addExtraNamespaceDeclaration(const QXmlStreamNamespaceDeclaration &extraNamespaceDeclaration)

Ajoute une déclaration ` extraNamespaceDeclaration`. Cette déclaration s'appliquera aux enfants de l'élément courant ou, si la fonction est appelée avant la lecture de tout élément, à l'ensemble du document XML.

Voir également namespaceDeclarations(), addExtraNamespaceDeclarations() et setNamespaceProcessing().

void QXmlStreamReader::addExtraNamespaceDeclarations(const QXmlStreamNamespaceDeclarations &extraNamespaceDeclarations)

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

Voir également namespaceDeclarations() et addExtraNamespaceDeclaration().

bool QXmlStreamReader::atEnd() const

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

Lorsque atEnd() et hasError() renvoient true et que error() renvoie PrematureEndOfDocumentError, cela signifie que le XML est bien formé jusqu’à présent, mais qu’aucun document XML complet n’a encore été analysé. Le bloc d’XML suivant peut être ajouté à l’aide de ` addData()` si l’XML est lu à partir d’un ` QByteArray`, ou en attendant l’arrivée de nouvelles données si l’XML est lu à partir d’un ` QIODevice`. Dans les deux cas, `atEnd()` renverra `false` dès que de nouvelles données seront disponibles.

Voir également les méthodes ` hasError()`, ` error()`, ` device()` et ` QIODevice::atEnd()`.

QXmlStreamAttributes QXmlStreamReader::attributes() const

Renvoie les attributs d'un objet ` StartElement`.

qint64 QXmlStreamReader::characterOffset() const

Renvoie l'index du caractère courant, en partant de 0.

Voir également lineNumber() et columnNumber().

void QXmlStreamReader::clear()

Supprime toute commande « device » () ou toute donnée du lecteur et rétablit son état interne à son état initial.

Voir aussi addData().

qint64 QXmlStreamReader::columnNumber() const

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

Voir également lineNumber() et characterOffset().

QIODevice *QXmlStreamReader::device() const

Renvoie le périphérique actuel associé à l'QXmlStreamReader, ou nullptr si aucun périphérique n'a été attribué.

Voir également setDevice().

QStringView QXmlStreamReader::documentEncoding() const

Si la fonction ` tokenType()` a pour valeur ` StartDocument`, cette fonction renvoie la chaîne d'encodage telle qu'elle est spécifiée dans la déclaration XML. Dans le cas contraire, elle renvoie une chaîne vide.

QStringView QXmlStreamReader::documentVersion() const

Si l'tokenType() est StartDocument, cette fonction renvoie la chaîne de 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'tokenType() est DTD, cette fonction renvoie le nom de la DTD. Sinon, elle renvoie une chaîne vide.

QStringView QXmlStreamReader::dtdPublicId() const

Si l'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'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 l'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 le nombre maximal de caractères auquel une entité unique peut s'étendre. Si une entité unique dépasse la limite indiquée, le document n'est pas considéré comme bien formé.

Voir également setEntityExpansionLimit.

QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const

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

Voir également setEntityResolver().

QXmlStreamReader::Error QXmlStreamReader::error() const

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

Voir également errorString() et raiseError().

QString QXmlStreamReader::errorString() const

Renvoie le message d'erreur défini à l'aide de la fonction raiseError().

Voir également error(), lineNumber(), columnNumber() et characterOffset().

bool QXmlStreamReader::hasError() const

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

Voir également errorString() et error().

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

Renvoie « true » si ce document comporte une déclaration explicite « standalone » (pouvant prendre la valeur « yes » ou « no ») ; 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 également isStandaloneDocument().

bool QXmlStreamReader::isCDATA() const

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

Voir également isCharacters() et text().

bool QXmlStreamReader::isCharacters() const

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

Voir également 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é « standalone » dans la déclaration XML ; sinon, renvoie « false ».

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

Voir également 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 composés uniquement d'espaces ; sinon, renvoie « false ».

Voir également isCharacters() et text().

qint64 QXmlStreamReader::lineNumber() const

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

Voir également columnNumber() et characterOffset().

QStringView QXmlStreamReader::name() const

Renvoie le nom local d'une instance de ` StartElement`, ` EndElement` ou ` 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 une ` QList ` de ` QXmlStreamNamespaceDeclaration`.

Voir également addExtraNamespaceDeclaration() et addExtraNamespaceDeclarations().

QStringView QXmlStreamReader::namespaceUri() const

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

Voir également name() et qualifiedName().

QXmlStreamNotationDeclarations QXmlStreamReader::notationDeclarations() const

Si l'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 également name() et qualifiedName().

QStringView QXmlStreamReader::processingInstructionData() const

Renvoie les données d'un objet ` ProcessingInstruction`.

QStringView QXmlStreamReader::processingInstructionTarget() const

Renvoie la cible d'une opération « ProcessingInstruction ».

QStringView QXmlStreamReader::qualifiedName() const

Renvoie le nom qualifié d'un élément StartElement ou 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 d’un deux-points, puis du nom local de l’élément. Étant donné que le préfixe d’espace de noms n’est pas unique (un même préfixe peut désigner différents espaces de noms et différents préfixes peuvent désigner le même espace de noms), vous ne devez pas utiliser la fonction `qualifiedName()`, mais plutôt la fonction ` namespaceUri()` (qui renvoie le nom résolu) et la fonction ` name()` (qui renvoie le nom local de l’attribut).

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

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

Déclenche une erreur personnalisée avec une message d'erreur facultative.

Voir également error() et errorString().

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

Fonction pratique à appeler lorsqu’un fichier « StartElement » a été lu. Elle lit le contenu jusqu’à la balise « EndElement » correspondante et renvoie tout le texte situé entre ces deux balises. En l’absence d’erreur, le token actuel (voir tokenType()) après l’appel de cette fonction est EndElement.

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

L’exception behaviour définit ce qui se passe si un autre élément est lu avant d’atteindre EndElement. La fonction peut inclure le texte des éléments enfants (utile par exemple pour le HTML), ignorer les éléments enfants, ou lever une 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, dès lors qu’une exception ` error()` est signalée par `readNext()`, il n’est plus possible de poursuivre la lecture du flux XML. Dans ce cas, ` atEnd()` renvoie ` true`, ` hasError()` renvoie ` true` et cette fonction renvoie ` QXmlStreamReader::Invalid`.

La seule exception se produit lorsque ` error()` renvoie ` PrematureEndOfDocumentError`. Cette erreur est signalée lorsque la fin d’un bloc XML par ailleurs bien formé est atteinte, mais que ce bloc ne représente pas un document XML complet. Dans ce cas, l’analyse peut être reprise en appelant ` addData()` pour ajouter le fragment XML suivant, lorsque le flux est lu à partir d’un ` QByteArray`, ou en attendant l’arrivée de nouvelles données lorsque le flux est lu à partir d’un ` device()`.

Voir également tokenType() et tokenString().

bool QXmlStreamReader::readNextStartElement()

Lit jusqu’à l’élément de début suivant à l’intérieur de l’élément courant. Renvoie « true » lorsqu’un élément de début a été atteint. Lorsque l’élément de fin a été atteint, ou lorsqu’une erreur s’est produite, la valeur « false » est renvoyée.

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

Il s’agit d’une fonction pratique lorsque vous vous intéressez uniquement à l’analyse des éléments XML. L’exemple « QXmlStream Bookmarks » utilise largement cette fonction.

Voir également ` readNext()`.

[since 6.10] QString QXmlStreamReader::readRawInnerData()

Lit et renvoie le contenu XML brut interne de l'élément courant. Cette fonction est utile pour récupérer l'intégralité du contenu intégré à un élément, y compris les balises imbriquées, le texte, les commentaires, les instructions de traitement, les sections CDATA et autres balises, tout en conservant la structure XML d'origine.

L'élément courant est l'élément correspondant à l'élément de début analysé le plus récemment et pour lequel l'élément de fin correspondant n'a pas encore été atteint. Lorsque l'analyseur a atteint l'élément de fin, 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 sur device. La définition de ce périphérique réinitialise le flux à son état initial.

Voir également device() et clear().

void QXmlStreamReader::setEntityExpansionLimit(int limit)

Définit le nombre maximal de caractères auquel une entité peut se développer à l'adresse limit. Si une entité dépasse la limite indiquée, le document n'est pas considéré comme bien formé.

Cette limite vise à prévenir les attaques par déni de service (DoS) lors du chargement de documents XML inconnus, dans lesquels le développement récursif des entités pourrait autrement épuiser toute la mémoire disponible.

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

La valeur minimale est un (1), afin de prendre en charge les entités XML intégrées (<, etc.).

Voir également entityExpansionLimit.

void QXmlStreamReader::setEntityResolver(QXmlStreamEntityResolver *resolver)

Crée un nouvel objet « entityResolver » ( resolver ).

Le lecteur de flux ne prend pas possession 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 une autre instance de ` nullptr ` soit défini(e).

Voir également entityResolver().

void QXmlStreamReader::skipCurrentElement()

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

L'élément courant est l'élément correspondant à l'élément de début analysé le plus récemment, pour lequel aucun élément de fin correspondant n'a encore été atteint. Lorsque l'analyseur a atteint l'élément de fin, 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 token 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 pratiques suivantes : isStartDocument(), isEndDocument(), isStartElement(), isEndElement(), isCharacters(), isComment(), isDTD(), isEntityReference() et isProcessingInstruction().

Voir également tokenString().