QXmlStreamWriter Class

Documentation des fonctions membres

QXmlStreamWriter::QXmlStreamWriter()

Construit un rédacteur de flux.

Voir aussi setDevice().

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

Construit un rédacteur de flux qui écrit dans array. Cela revient à créer un rédacteur xml qui fonctionne sur un périphérique QBuffer qui, à son tour, fonctionne sur array.

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

Construit un rédacteur de flux qui écrit dans device;

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

Construit un rédacteur de flux qui écrit dans string.

[noexcept] QXmlStreamWriter::~QXmlStreamWriter()

Destructeur.

bool QXmlStreamWriter::autoFormatting() const

Renvoie true si le formatage automatique est activé, sinon false.

Voir également setAutoFormatting().

QIODevice *QXmlStreamWriter::device() const

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

Voir aussi setDevice().

[since 6.10] QXmlStreamWriter::Error QXmlStreamWriter::error() const

Renvoie l'état d'erreur actuel de l'auteur.

Si aucune erreur ne s'est produite, cette fonction renvoie QXmlStreamWriter::Error::None.

Cette fonction a été introduite dans Qt 6.10.

Voir aussi errorString(), raiseError(), et hasError().

[since 6.10] QString QXmlStreamWriter::errorString() const

Si une erreur s'est produite, il renvoie le message d'erreur associé.

Le message d'erreur est soit défini en interne par QXmlStreamWriter, soit fourni par l'utilisateur via raiseError(). Si aucune erreur ne s'est produite, cette fonction renvoie une chaîne de caractères nulle.

Cette fonction a été introduite dans Qt 6.10.

Voir aussi error(), raiseError(), et hasError().

bool QXmlStreamWriter::hasError() const

Renvoie true si une erreur s'est produite lors de l'écriture des données.

Si l'erreur est Error::IO, les écritures ultérieures dans le document sous-jacent QIODevice échoueront. Dans d'autres cas, des données malformées peuvent être écrites dans le document.

L'état d'erreur n'est jamais réinitialisé. Les écritures effectuées après l'apparition de l'erreur peuvent être ignorées, même si la condition d'erreur est levée.

Voir également error(), errorString() et raiseError().

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

Lance une erreur personnalisée avec l'adresse message.

Cette fonction permet d'indiquer manuellement qu'une erreur s'est produite pendant l'écriture, comme un échec de validation au niveau de l'application.

Cette fonction a été introduite dans Qt 6.10.

Voir aussi errorString(), error(), et hasError().

void QXmlStreamWriter::setAutoFormatting(bool enable)

Active le formatage automatique si enable est true, sinon le désactive.

La valeur par défaut est false.

Voir aussi autoFormatting().

void QXmlStreamWriter::setDevice(QIODevice *device)

Définit le périphérique actuel à device. Si vous voulez que le flux écrive dans un QByteArray, vous pouvez créer un périphérique QBuffer.

Voir aussi device().

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

Écrit un attribut avec name et value, préfixé pour l'espace de noms spécifié namespaceUri. Si l'espace de noms n'a pas encore été déclaré, QXmlStreamWriter génère une déclaration d'espace de noms.

Cette fonction ne peut être appelée qu'après writeStartElement(), avant que le contenu ne soit écrit, ou après writeEmptyElement().

void QXmlStreamWriter::writeAttribute(const QXmlStreamAttribute &attribute)

Écrit la page attribute.

Cette fonction ne peut être appelée qu'après writeStartElement(), avant que le contenu ne soit écrit, ou après writeEmptyElement().

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

Écrit un attribut avec qualifiedName et value.

Cette fonction ne peut être appelée qu'après writeStartElement(), avant que le contenu ne soit écrit, ou après writeEmptyElement().

void QXmlStreamWriter::writeAttributes(const QXmlStreamAttributes &attributes)

Écrit le vecteur d'attribut attributes. Si un espace de noms référencé dans un attribut n'a pas encore été déclaré, QXmlStreamWriter génère une déclaration d'espace de noms pour cet attribut.

Cette fonction ne peut être appelée qu'après writeStartElement(), avant l'écriture de tout contenu, ou après writeEmptyElement().

Voir aussi writeAttribute() et writeNamespace().

void QXmlStreamWriter::writeCDATA(QAnyStringView text)

Écrit text en tant que section CDATA. Si text contient la séquence de caractères interdite "]]> ", il est divisé en plusieurs sections CDATA.

Cette fonction existe principalement pour des raisons d'exhaustivité. Normalement, vous ne devriez pas avoir besoin de l'utiliser, car writeCharacters() échappe automatiquement tous les caractères qui ne font pas partie du contenu.

void QXmlStreamWriter::writeCharacters(QAnyStringView text)

Écrit text. Les caractères "<", "&" et """ sont convertis en références d'entités "&lt ;", "&amp ;" et "&quot ;". Pour éviter la séquence interdite "]]>", ">" est également échappé en tant que "&gt ;".

Voir aussi writeEntityReference().

void QXmlStreamWriter::writeComment(QAnyStringView text)

Écrit text en tant que commentaire XML, où text ne doit pas contenir la séquence interdite -- ou se terminer par -. Notez que XML ne fournit aucun moyen d'échapper à - dans un commentaire.

void QXmlStreamWriter::writeCurrentToken(const QXmlStreamReader &reader)

Écrit l'état actuel du site reader. Tous les états valides possibles sont pris en charge.

L'objectif de cette fonction est de prendre en charge le traitement en chaîne des données XML.

Voir également QXmlStreamReader::tokenType().

void QXmlStreamWriter::writeDTD(QAnyStringView dtd)

Écrit une section DTD. Le site dtd représente l'ensemble de la production doctypedecl de la spécification XML 1.0.

void QXmlStreamWriter::writeDefaultNamespace(QAnyStringView namespaceUri)

Écrit une déclaration d'espace de noms par défaut pour namespaceUri.

Si writeStartElement() ou writeEmptyElement() a été appelé, la déclaration s'applique à l'élément actuel ; sinon, elle s'applique à l'élément enfant suivant.

Notez que les espaces de noms http://www.w3.org/XML/1998/namespace (lié à xmlns) et http://www.w3.org/2000/xmlns/ (lié à xml) ne peuvent pas, par définition, être déclarés par défaut.

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

Écrit un élément vide avec name, préfixé pour l'espace de noms spécifié namespaceUri. Si l'espace de noms n'a pas été déclaré, QXmlStreamWriter génère une déclaration d'espace de noms. Les appels ultérieurs à writeAttribute() ajouteront des attributs à cet élément.

Voir aussi writeNamespace().

void QXmlStreamWriter::writeEmptyElement(QAnyStringView qualifiedName)

Écrit un élément vide avec le nom qualifié qualifiedName. Les appels ultérieurs à writeAttribute() ajouteront des attributs à cet élément.

void QXmlStreamWriter::writeEndDocument()

Ferme tous les éléments de départ encore ouverts et écrit une nouvelle ligne.

Voir également writeStartDocument().

void QXmlStreamWriter::writeEndElement()

Ferme l'élément de départ précédent.

Voir également writeStartElement().

void QXmlStreamWriter::writeEntityReference(QAnyStringView name)

Écrit la référence de l'entité name dans le flux, sous la forme "&name;".

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

Rédige une déclaration d'espace de noms pour namespaceUri avec prefix. Si prefix est vide, QXmlStreamWriter attribue un préfixe unique composé de la lettre "n" suivie d'un nombre.

Si writeStartElement() ou writeEmptyElement() a été appelé, la déclaration s'applique à l'élément actuel ; sinon, elle s'applique à l'élément enfant suivant.

Notez que le préfixe xml est à la fois prédéfini et réservé à http://www.w3.org/XML/1998/namespace, qui à son tour ne peut être lié à aucun autre préfixe. Le préfixe xmlns et son URI http://www.w3.org/2000/xmlns/ sont utilisés pour le mécanisme de l'espace de noms lui-même et sont donc totalement interdits dans les déclarations.

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

Écrit une instruction de traitement XML avec target et data, où data ne doit pas contenir la séquence "?>".

void QXmlStreamWriter::writeStartDocument(QAnyStringView version)

Écrit un début de document avec le numéro de version XML version.

Voir aussi writeEndDocument().

void QXmlStreamWriter::writeStartDocument(QAnyStringView version, bool standalone)

Écrit un début de document avec le numéro de version XML version et un attribut autonome standalone.

Voir aussi writeEndDocument().

void QXmlStreamWriter::writeStartDocument()

Écrit un début de document avec le numéro de version XML "1.0".

Voir aussi writeEndDocument().

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

Écrit un élément de départ avec name, préfixé pour l'espace de noms spécifié namespaceUri. Si l'espace de noms n'a pas encore été déclaré, QXmlStreamWriter génère une déclaration d'espace de noms. Les appels ultérieurs à writeAttribute() ajouteront des attributs à cet élément.

Voir également writeNamespace(), writeEndElement() et writeEmptyElement().

void QXmlStreamWriter::writeStartElement(QAnyStringView qualifiedName)

Écrit un élément de départ avec qualifiedName. Les appels ultérieurs à writeAttribute() ajouteront des attributs à cet élément.

Voir également writeEndElement() et writeEmptyElement().

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

Écrit un élément de texte avec name, préfixé pour les éléments spécifiés namespaceUri, et text. Si l'espace de noms n'a pas été déclaré, QXmlStreamWriter générera une déclaration d'espace de noms pour lui.

Il s'agit d'une fonction de commodité équivalente à :

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

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

Écrit un élément de texte avec qualifiedName et text.

Il s'agit d'une fonction de commodité équivalente à :

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