QXmlStreamWriter Class

Documentation des fonctions membres

QXmlStreamWriter::QXmlStreamWriter()

Crée un objet d'écriture de flux.

Voir également ` setDevice()`.

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

Crée un rédacteur de flux qui écrit dans array. Cela revient à créer un rédacteur XML fonctionnant sur un périphérique QBuffer, lui-même fonctionnant sur array.

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

Crée un enregistreur de flux qui écrit dans device;

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

Crée un éditeur de flux qui écrit dans string.

[noexcept] QXmlStreamWriter::~QXmlStreamWriter()

Destructeur.

bool QXmlStreamWriter::autoFormatting() const

Renvoie « true » si la mise en forme automatique est activée, sinon « false ».

Voir aussi ` setAutoFormatting()`.

QIODevice *QXmlStreamWriter::device() const

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

Voir également setDevice().

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

Renvoie l'état d'erreur actuel du rédacteur.

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

Cette fonction a été introduite dans Qt 6.10.

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

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

Si une erreur s'est produite, 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 vide.

Cette fonction a été introduite dans Qt 6.10.

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

bool QXmlStreamWriter::hasError() const

Renvoie « true » si une erreur s'est produite lors de la tentative d'écriture des données.

Si l'erreur est de type « Error::IO », les écritures suivantes sur le document sous-jacent ( QIODevice ) échoueront. Dans les autres cas, des données mal formées peuvent être écrites dans le document.

Le statut d’erreur n’est jamais réinitialisé. Les écritures effectuées après la survenue de l’erreur peuvent être ignorées, même si la condition d’erreur a été levée.

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

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

Déclenche une erreur personnalisée avec l'message on fournie.

Cette fonction sert à signaler manuellement qu'une erreur s'est produite lors de l'écriture, par exemple un échec de validation au niveau de l'application.

Cette fonction a été introduite dans Qt 6.10.

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

void QXmlStreamWriter::setAutoFormatting(bool enable)

Active la mise en forme automatique si enable est true; dans le cas contraire, elle la désactive.

La valeur par défaut est false.

Voir aussi autoFormatting().

void QXmlStreamWriter::setDevice(QIODevice *device)

Définit le périphérique actuel sur device. Si vous souhaitez que le flux s'écrive dans un fichier QByteArray, vous pouvez créer un périphérique QBuffer.

Voir également device().

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

Écrit un attribut en utilisant « name » et « value », préfixés par l'namespaceUri spécifié. Si l'espace de noms n'a pas encore été déclaré, « QXmlStreamWriter » générera une déclaration d'espace de noms pour celui-ci.

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

void QXmlStreamWriter::writeAttribute(const QXmlStreamAttribute &attribute)

Écrit la fonction attribute.

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

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

Écrit un attribut à l'aide de ` qualifiedName ` et ` value`.

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

void QXmlStreamWriter::writeAttributes(const QXmlStreamAttributes &attributes)

Écrit le vecteur d’attributs attributes. Si un espace de noms référencé dans un attribut n’a pas encore été déclaré, QXmlStreamWriter générera une déclaration d’espace de noms pour celui-ci.

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

Voir également writeAttribute() et writeNamespace().

void QXmlStreamWriter::writeCDATA(QAnyStringView text)

Écrit text sous forme de section CDATA. Si text contient la séquence de caractères interdite « ]]> », il est divisé en plusieurs sections CDATA.

Cette fonction est principalement fournie par souci d'exhaustivité. En règle générale, vous ne devriez pas avoir besoin de l'utiliser, car writeCharacters() échappe automatiquement tous les caractères non-contenu.

void QXmlStreamWriter::writeCharacters(QAnyStringView text)

Écrit text. Les caractères « < », « & » et « » sont échappés sous forme de références d'entité « &lt; », « &amp; » et « &quot; ». Pour éviter la séquence interdite « ]]> », le caractère « > » est également échappé sous la forme « &gt; ».

Voir également writeEntityReference().

void QXmlStreamWriter::writeComment(QAnyStringView text)

Écrit text sous forme de commentaire XML, où text ne doit pas contenir la séquence interdite -- ni se terminer par -. Notez que le langage XML ne propose aucun moyen d'échapper à - dans un commentaire.

void QXmlStreamWriter::writeCurrentToken(const QXmlStreamReader &reader)

Enregistre l'état actuel de l'reader. Tous les états valides possibles sont pris en charge.

Cette fonction a pour but 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. La chaîne « dtd » correspond à l'intégralité de la règle de production « doctypedecl » issue 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 la méthode writeStartElement() ou writeEmptyElement() a été appelée, la déclaration s'applique à l'élément courant ; 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, par définition, pas être déclarés comme espaces de noms par défaut.

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

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

Voir également writeNamespace().

void QXmlStreamWriter::writeEmptyElement(QAnyStringView qualifiedName)

Crée un élément vide portant le nom qualifié « qualifiedName ». Les appels suivants à la fonction ` writeAttribute()` ajouteront des attributs à cet élément.

void QXmlStreamWriter::writeEndDocument()

Ferme tous les éléments d'ouverture restants et insère un saut de ligne.

Voir aussi writeStartDocument().

void QXmlStreamWriter::writeEndElement()

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

Voir aussi writeStartElement().

void QXmlStreamWriter::writeEntityReference(QAnyStringView name)

Écrit la référence d'entité name dans le flux, sous la forme « &name; ».

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

Écrit 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 courant ; 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 ne peut lui-même ê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 d’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 document commençant par le numéro de version XML version.

Voir également writeEndDocument().

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

Écrit un document commençant par le numéro de version XML « version » et comportant un attribut « standalone » « standalone ».

Voir également writeEndDocument().

void QXmlStreamWriter::writeStartDocument()

Écrit un document commençant par le numéro de version XML « 1.0 ».

Voir également writeEndDocument().

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

Écrit un élément de départ avec name, préfixé par l'namespaceUri spécifié. Si l'espace de noms n'a pas encore été déclaré, QXmlStreamWriter générera une déclaration d'espace de noms pour celui-ci. Les appels suivants à 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 suivants à 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 l'name, préfixé par l'namespaceUri spécifié, et l'text. Si l'espace de noms n'a pas été déclaré, QXmlStreamWriter générera une déclaration d'espace de noms pour celui-ci.

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 pratique équivalente à :

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