QDomDocument Class

QDomDocument doc("mydocument");
QFile file("mydocument.xml");
if (!file.open(QIODevice::ReadOnly))
    return;
if (!doc.setContent(&file)) {
    file.close();
    return;
}
file.close();

// print out the element names of all elements that are direct children
// of the outermost element.
QDomElement docElem = doc.documentElement();

QDomNode n = docElem.firstChild();
while(!n.isNull()) {
    QDomElement e = n.toElement(); // try to convert the node to an element.
    if(!e.isNull()) {
        cout << qPrintable(e.tagName()) << '\n'; // the node really is an element.
    }
    n = n.nextSibling();
}

// Here we append a new element to the end of the document
QDomElement elem = doc.createElement("img");
elem.setAttribute("src", "myimage.png");
docElem.appendChild(elem);

QDomDocument doc;
QDomElement root = doc.createElement("MyML");
doc.appendChild(root);

QDomElement tag = doc.createElement("Greeting");
root.appendChild(tag);

QDomText t = doc.createTextNode("Hello World");
tag.appendChild(t);

QString xml = doc.toString();

Documentation des fonctions membres

QDomDocument::QDomDocument()

Crée un document vide.

[explicit] QDomDocument::QDomDocument(const QDomDocumentType &doctype)

Crée un document de type « doctype ».

Voir également QDomImplementation::createDocumentType().

[explicit] QDomDocument::QDomDocument(const QString &name)

Crée un document et définit le nom du type de document sur « name ».

QDomDocument::QDomDocument(const QDomDocument &document)

Crée une copie de ` document`.

Les données de la copie sont partagées (copie superficielle) : la modification d'un nœud entraîne également la modification de l'autre. Si vous souhaitez effectuer une copie profonde, utilisez cloneNode().

[noexcept] QDomDocument::~QDomDocument()

Détruit l'objet et libère ses ressources.

QDomAttr QDomDocument::createAttribute(const QString &name)

Crée un nouvel attribut nommé « name » pouvant être inséré dans un élément, par exemple à l'aide de la fonction ` QDomElement::setAttributeNode()`.

Si « name » n'est pas un nom XML valide, le comportement de cette fonction est régi par QDomImplementation::InvalidDataPolicy.

Voir également createAttributeNS().

QDomAttr QDomDocument::createAttributeNS(const QString &nsURI, const QString &qName)

Crée un nouvel attribut prenant en charge les espaces de noms, pouvant être inséré dans un élément. Le nom de l'attribut est qName et l'URI de l'espace de noms est nsURI. Cette fonction attribue également les valeurs appropriées aux attributs QDomNode::prefix() et QDomNode::localName() (en fonction de qName).

Si qName n’est pas un nom XML valide, le comportement de cette fonction est régi par QDomImplementation::InvalidDataPolicy.

Voir également createAttribute().

QDomCDATASection QDomDocument::createCDATASection(const QString &value)

Crée une nouvelle section CDATA pour la chaîne « value », qui peut être insérée dans le document, par exemple à l'aide de la fonction ` QDomNode::appendChild()`.

Si value contient des caractères qui ne peuvent pas être stockés dans une section CDATA, le comportement de cette fonction est régi par QDomImplementation::InvalidDataPolicy.

Voir également QDomNode::appendChild(), QDomNode::insertBefore() et QDomNode::insertAfter().

QDomComment QDomDocument::createComment(const QString &value)

Crée un nouveau commentaire pour la chaîne « value » pouvant être inséré dans le document, par exemple à l'aide de la fonction ` QDomNode::appendChild()`.

Si value contient des caractères qui ne peuvent pas être stockés dans un commentaire XML, le comportement de cette fonction est régi par QDomImplementation::InvalidDataPolicy.

Voir également QDomNode::appendChild(), QDomNode::insertBefore() et QDomNode::insertAfter().

QDomDocumentFragment QDomDocument::createDocumentFragment()

Crée un nouveau fragment de document, qui peut servir à contenir des parties du document, par exemple lors de manipulations complexes de l'arborescence du document.

QDomElement QDomDocument::createElement(const QString &tagName)

Crée un nouvel élément nommé « tagName » pouvant être inséré dans l'arborescence DOM, par exemple à l'aide de la fonction QDomNode::appendChild().

Si « tagName » n'est pas un nom XML valide, le comportement de cette fonction est régi par QDomImplementation::InvalidDataPolicy.

Voir également createElementNS(), QDomNode::appendChild(), QDomNode::insertBefore() et QDomNode::insertAfter().

QDomElement QDomDocument::createElementNS(const QString &nsURI, const QString &qName)

Crée un nouvel élément prenant en charge les espaces de noms, pouvant être inséré dans l'arborescence DOM. Le nom de l'élément est qName et l'URI de l'espace de noms est nsURI. Cette fonction attribue également les valeurs appropriées aux propriétés QDomNode::prefix() et QDomNode::localName() (en fonction de qName).

Si qName est une chaîne vide, renvoie un élément nul, que la politique relative aux données non valides soit définie ou non.

Voir également createElement().

QDomEntityReference QDomDocument::createEntityReference(const QString &name)

Crée une nouvelle référence d'entité nommée « name » pouvant être insérée dans le document, par exemple à l'aide de la fonction ` QDomNode::appendChild()`.

Si « name » n’est pas un nom XML valide, le comportement de cette fonction est régi par « QDomImplementation::InvalidDataPolicy ».

Voir également QDomNode::appendChild(), QDomNode::insertBefore() et QDomNode::insertAfter().

QDomProcessingInstruction QDomDocument::createProcessingInstruction(const QString &target, const QString &data)

Crée une nouvelle instruction de traitement pouvant être insérée dans le document, par exemple à l'aide de la fonction ` QDomNode::appendChild()`. Cette fonction définit la cible de l'instruction de traitement sur ` target ` et les données sur ` data`.

Si ` target ` n'est pas un nom XML valide, ou si `data` contient des caractères qui ne peuvent pas apparaître dans une instruction de traitement, le comportement de cette fonction est régi par QDomImplementation::InvalidDataPolicy.

Voir également QDomNode::appendChild(), QDomNode::insertBefore() et QDomNode::insertAfter().

QDomText QDomDocument::createTextNode(const QString &value)

Crée un nœud de texte pour la chaîne « value » pouvant être inséré dans l'arborescence du document, par exemple à l'aide de la fonction ` QDomNode::appendChild()`.

Si value contient des caractères qui ne peuvent pas être stockés en tant que données de caractères d’un document XML (même sous forme de références de caractères), le comportement de cette fonction est régi par QDomImplementation::InvalidDataPolicy.

Voir également QDomNode::appendChild(), QDomNode::insertBefore() et QDomNode::insertAfter().

QDomDocumentType QDomDocument::doctype() const

Renvoie le type de ce document.

QDomElement QDomDocument::documentElement() const

Renvoie l'élément racine du document.

QDomElement QDomDocument::elementById(const QString &elementId)

Renvoie l'élément dont l'ID est égal à elementId. Si aucun élément portant cet ID n'a été trouvé, cette fonction renvoie un null element.

Étant donné que les classes QDomClasses ne savent pas quels attributs correspondent aux identifiants d'éléments, cette fonction renvoie toujours un ` null element`. Cela pourrait changer dans une version future.

QDomNodeList QDomDocument::elementsByTagName(const QString &tagname) const

Renvoie un objet de type ` QDomNodeList` contenant tous les éléments du document portant le nom « tagname ». L'ordre de la liste des nœuds correspond à l'ordre dans lequel ils sont rencontrés lors d'un parcours en pré-ordre de l'arborescence des éléments.

Voir également ` elementsByTagNameNS()` et ` QDomElement::elementsByTagName()`.

QDomNodeList QDomDocument::elementsByTagNameNS(const QString &nsURI, const QString &localName)

Renvoie un objet ` QDomNodeList ` contenant tous les éléments du document dont le nom local est ` localName ` et dont l'URI d'espace de noms est ` nsURI`. L'ordre de la liste des nœuds correspond à l'ordre dans lequel ils sont rencontrés lors d'un parcours en pré-ordre de l'arborescence des éléments.

Voir également elementsByTagName() et QDomElement::elementsByTagNameNS().

QDomImplementation QDomDocument::implementation() const

Renvoie un objet de type « QDomImplementation ».

QDomNode QDomDocument::importNode(const QDomNode &importedNode, bool deep)

Importe le nœud importedNode depuis un autre document vers ce document. importedNode reste dans le document d'origine ; cette fonction crée une copie pouvant être utilisée dans ce document.

Cette fonction renvoie le nœud importé qui appartient à ce document. Le nœud renvoyé n’a pas de parent. Il n’est pas possible d’importer les nœuds QDomDocument et QDomDocumentType. Dans ces cas-là, cette fonction renvoie un null node.

Si ` importedNode ` est un ` null node`, un nœud nul est renvoyé.

Si deep est vrai, cette fonction importe non seulement le nœud importedNode mais aussi l'ensemble de son sous-arbre ; s'il est faux, seul le importedNode est importé. L'argument deep n'a aucun effet sur les nœuds QDomAttr et QDomEntityReference, car les descendants des nœuds QDomAttr sont toujours importés et ceux des nœuds QDomEntityReference ne le sont jamais.

Le comportement de cette fonction varie légèrement selon les types de nœuds :

Voir également QDomElement::setAttribute(), QDomNode::insertBefore(), QDomNode::insertAfter(), QDomNode::replaceChild(), QDomNode::removeChild() et QDomNode::appendChild().

QDomNode::NodeType QDomDocument::nodeType() const

Renvoie « DocumentNode ».

Cette fonction analyse le document XML à partir d'un tableau d'octets data, d'une vue de chaîne text, d'un objet IO device ou d'un flux reader, puis l'affecte au contenu du document. Elle tente de détecter l'encodage du document, conformément à la spécification XML. Elle renvoie le résultat de l'analyse dans ParseResult, qui est explicitement converti en bool.

Vous pouvez utiliser le paramètre options pour spécifier différentes options d’analyse, par exemple pour activer le traitement des espaces de noms, etc.

Par défaut, le traitement des espaces de noms est désactivé. S’il est désactivé, l’analyseur n’effectue aucun traitement des espaces de noms lors de la lecture du fichier XML. Les fonctions QDomNode::prefix(), QDomNode::localName() et QDomNode::namespaceURI() renvoient une chaîne vide.

Si le traitement des espaces de noms est activé via l’ options e « parse », l’analyseur reconnaît les espaces de noms dans le fichier XML et attribue les valeurs appropriées au nom de préfixe, au nom local et à l’URI de l’espace de noms. Les fonctions QDomNode::prefix(), QDomNode::localName() et QDomNode::namespaceURI() renvoient une chaîne de caractères pour tous les éléments et attributs, et renvoient une chaîne vide si l’élément ou l’attribut n’a pas de préfixe.

Les nœuds de texte composés uniquement d’espaces sont supprimés et n’apparaîtront pas dans l’ QDomDocument. Depuis Qt 6.5, il est possible de passer QDomDocument::ParseOption::PreserveSpacingOnlyNodes en tant qu’option d’analyse, afin de spécifier que les nœuds de texte composés uniquement d’espaces doivent être conservés.

Les références d'entités sont traitées comme suit :

• Les références aux entités générales internes et aux entités de caractères présentes dans le contenu sont incluses. Le résultat est un nœud ` QDomText ` dans lequel les références sont remplacées par leurs valeurs d’entité correspondantes.
• Les références aux entités paramétriques présentes dans le sous-ensemble interne sont incluses. Le résultat est un nœud ` QDomDocumentType ` contenant les déclarations d’entités et de notation, les références étant remplacées par leurs valeurs d’entité correspondantes.
• Toute référence à une entité analysée générale qui n’est pas définie dans le sous-ensemble interne et qui apparaît dans le contenu est représentée sous la forme d’un nœud « QDomEntityReference ».
• Toute référence d’entité analysée qui n’est pas définie dans le sous-ensemble interne et qui apparaît en dehors du contenu est remplacée par une chaîne vide.
• Toute référence d’entité non analysée est remplacée par une chaîne vide.

Ces fonctions ont été introduites dans Qt 6.5.

Voir également ParseResult et ParseOptions.

QByteArray QDomDocument::toByteArray(int indent = 1) const

Convertit le document analysé en sa représentation textuelle et renvoie un objet ` QByteArray ` contenant les données encodées en UTF-8.

Cette fonction utilise ` indent ` comme valeur pour l'espacement des sous-éléments.

Voir également toString().

QString QDomDocument::toString(int indent = 1) const

Convertit le document analysé en sa représentation textuelle.

Cette fonction utilise ` indent ` comme valeur d'espacement pour l'indentation des sous-éléments.

Si indent vaut -1, aucun espace n'est ajouté.

QDomDocument &QDomDocument::operator=(const QDomDocument &other)

Attribue la méthode ` other ` à ce document DOM.

Les données de la copie sont partagées (copie superficielle) : la modification d'un nœud entraîne également la modification de l'autre. Si vous souhaitez effectuer une copie profonde, utilisez la méthode cloneNode().