TextDocument QML Type
Une enveloppe autour de TextEdit's backing QTextDocument. Plus...
| Import Statement: | import QtQuick |
| In C++: | QQuickTextDocument |
| Status: | Preliminary |
Ce type est en cours de développement et peut être modifié.
Propriétés
- errorString : string
(preliminary) - modified : bool
(preliminary) - source : url
(preliminary) - status : enumeration
(preliminary)
Méthodes
Description détaillée
Pour charger un texte dans le document, il faut définir la propriété source. Si l'utilisateur modifie ensuite le texte et souhaite enregistrer le même document, il doit appeler save() pour l'enregistrer à nouveau dans la même source (uniquement si it's a local file). Ou appelez saveAs() pour l'enregistrer dans un fichier différent.
Cette classe ne peut pas être instanciée dans QML, mais elle est disponible à partir de TextEdit::textDocument.
Note : Tous les chargements et sauvegardes sont effectués de manière synchrone pour l'instant. Cela peut bloquer l'interface utilisateur si source est un lecteur réseau lent. Cela pourrait être amélioré dans les prochaines versions de Qt.
Note : Cette API est considérée comme un aperçu technique et peut être modifiée dans les futures versions de Qt.
Documentation sur les propriétés
errorString : string [read-only, preliminary]
Cette propriété est en cours de développement et peut être modifiée.
Cette propriété contient une chaîne lisible par l'homme décrivant l'erreur qui s'est produite lors du chargement ou de l'enregistrement, le cas échéant ; sinon, une chaîne vide.
Cette propriété a été introduite dans Qt 6.7.
Voir aussi status, source, save(), et saveAs().
modified : bool [preliminary]
Cette propriété est en cours de développement et peut être modifiée.
Cette propriété indique si le document a été modifié par l'utilisateur depuis son dernier chargement ou enregistrement. Par défaut, cette propriété est false.
Comme pour QTextDocument::modified, vous pouvez définir la propriété modified : par exemple, définissez-la à false pour permettre de définir la propriété source à une URL différente (en supprimant ainsi les modifications apportées par l'utilisateur).
Cette propriété a été introduite dans Qt 6.7.
Voir aussi QTextDocument::modified.
source : url [preliminary]
Cette propriété est en cours de développement et peut être modifiée.
QQuickTextDocument peut gérer n'importe quel format de texte pris en charge par Qt, chargé à partir de n'importe quel schéma d'URL pris en charge par Qt.
L'URL peut être absolue ou relative à l'URL du composant.
La propriété source ne peut pas être modifiée tant que l'état du document modified est true. Si l'utilisateur a modifié le contenu du document, vous devez l'inviter à save() ou à annuler les modifications en définissant modified = false avant de définir la propriété source à une URL différente.
Cette propriété a été introduite dans Qt 6.7.
Voir aussi QTextDocumentWriter::supportedDocumentFormats().
status : enumeration [read-only, preliminary]
Cette propriété est en cours de développement et peut être modifiée.
Cette propriété indique l'état du chargement ou de l'enregistrement du document. Il peut s'agir de l'un des éléments suivants
| Constante | Description |
|---|---|
TextDocument.Null | Aucun fichier n'a été chargé |
TextDocument.Loading | La lecture de source a commencé |
TextDocument.Loaded | La lecture s'est terminée avec succès |
TextDocument.Saving | L'écriture du fichier a commencé après save() ou saveAs() |
TextDocument.Saved | L'écriture s'est terminée avec succès |
TextDocument.ReadError | Une erreur s'est produite lors de la lecture du fichier source |
TextDocument.WriteError | Une erreur s'est produite dans save() ou saveAs() |
TextDocument.NonLocalFileError | saveAs() a été appelé avec une URL pointant vers une ressource distante plutôt que vers un fichier local. |
Utilisez ce statut pour fournir une mise à jour ou répondre au changement de statut d'une manière ou d'une autre. Par exemple, vous pouvez
- Déclencher un changement d'état :
State { name: 'loaded' when: textEdit.textDocument.status == textEdit.textDocument.Loaded }
- implémenter un gestionnaire de signal
onStatusChanged:TextEdit { onStatusChanged: { if (textDocument.status === textDocument.Loaded) console.log('Loaded') } }
- se lier à la valeur de l'état :
TextEdit { id: edit width: 300 height: 200 textFormat: TextEdit.MarkdownText textDocument.source: "example.md" wrapMode: TextEdit.WordWrap Text { anchors { bottom: parent.bottom right: parent.right } color: edit.textDocument.status === TextDocument.Loaded ? "darkolivegreen" : "tomato" text: switch (edit.textDocument.status) { case TextDocument.Loading: return qsTr("Loading ") + edit.textDocument.source case TextDocument.Loaded: return qsTr("Loaded ") + edit.textDocument.source default: return edit.textDocument.errorString } } }
Cette propriété a été introduite dans Qt 6.7.
Voir aussi errorString, source, save(), et saveAs().
Documentation de la méthode
[preliminary] void save()
Cette méthode est en cours de développement et peut être modifiée.
Enregistre le contenu dans le même fichier et le même format que ceux spécifiés par source.
Remarque : Vous ne pouvez enregistrer que dans un fichier file on a mounted filesystem.
Cette méthode a été introduite dans Qt 6.7.
Voir aussi source et saveAs().
[preliminary] void saveAs(url url)
Cette méthode est en cours de développement et peut être modifiée.
Enregistre le contenu dans le fichier et le format spécifiés par url.
L'extension du fichier dans url spécifie le format du fichier (tel que déterminé par QMimeDatabase::mimeTypeForUrl()).
Remarque : Vous ne pouvez enregistrer que dans un fichier file on a mounted filesystem.
Cette méthode a été introduite dans Qt 6.7.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.