QTextDocumentWriter Class
La classe QTextDocumentWriter fournit une interface indépendante du format pour l'écriture d'un document QTextDocument dans des fichiers ou sur d'autres périphériques. Plus d'informations...
| En-tête : | #include <QTextDocumentWriter> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Gui)target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake : | QT += gui |
- Liste de tous les membres, y compris les membres hérités
- QTextDocumentWriter fait partie de Rich Text Processing APIs.
Fonctions publiques
| QTextDocumentWriter() | |
| QTextDocumentWriter(QIODevice *device, const QByteArray &format) | |
| QTextDocumentWriter(const QString &fileName, const QByteArray &format = QByteArray()) | |
| ~QTextDocumentWriter() | |
| QIODevice * | device() const |
| QString | fileName() const |
| QByteArray | format() const |
| void | setDevice(QIODevice *device) |
| void | setFileName(const QString &fileName) |
| void | setFormat(const QByteArray &format) |
| bool | write(const QTextDocument *document) |
| bool | write(const QTextDocumentFragment &fragment) |
Membres publics statiques
| QList<QByteArray> | supportedDocumentFormats() |
Description détaillée
Pour écrire un document, construisez un objet QTextDocumentWriter avec un nom de fichier ou un objet périphérique, et spécifiez le format du document à écrire. Vous pouvez construire un rédacteur et définir le format à l'aide de setFormat() ultérieurement.
Appelez write() pour écrire le document sur le périphérique. Si le document est écrit avec succès, cette fonction renvoie true. Toutefois, si une erreur survient lors de l'écriture du document, la fonction renvoie false.
Appelez supportedDocumentFormats() pour obtenir la liste des formats que QTextDocumentWriter peut écrire.
Étant donné que les capacités des formats de sortie pris en charge varient considérablement, le rédacteur produit simplement le sous-ensemble d'objets approprié pour chaque format. Il s'agit généralement du texte formaté et des images contenues dans un document.
Documentation des fonctions membres
QTextDocumentWriter::QTextDocumentWriter()
Construit un objet QTextDocumentWriter vide. Avant d'écrire, vous devez appeler setFormat() pour définir un format de document, puis setDevice() ou setFileName().
QTextDocumentWriter::QTextDocumentWriter(QIODevice *device, const QByteArray &format)
Construit un objet QTextDocumentWriter pour écrire sur le site device dans le format de document spécifié par format.
[explicit] QTextDocumentWriter::QTextDocumentWriter(const QString &fileName, const QByteArray &format = QByteArray())
Construit un objet QTextDocumentWriter qui écrira dans un fichier portant le nom fileName, en utilisant le format de document spécifié par format. Si format n'est pas fourni, QTextDocumentWriter détectera le format du document en inspectant l'extension de fileName.
[noexcept] QTextDocumentWriter::~QTextDocumentWriter()
Détruit l'objet QTextDocumentWriter.
QIODevice *QTextDocumentWriter::device() const
Renvoie le périphérique actuellement affecté, ou nullptr si aucun périphérique n'a été affecté.
Voir aussi setDevice().
QString QTextDocumentWriter::fileName() const
Si le périphérique actuellement assigné est un QFile, ou si setFileName() a été appelé, cette fonction renvoie le nom du fichier dans lequel il faut écrire. Dans tous les autres cas, elle renvoie une chaîne vide.
Voir aussi setFileName() et setDevice().
QByteArray QTextDocumentWriter::format() const
Renvoie le format utilisé pour l'écriture des documents.
Voir aussi setFormat().
void QTextDocumentWriter::setDevice(QIODevice *device)
Définit le périphérique de l'auteur à l'adresse device spécifiée. Si un périphérique a déjà été défini, l'ancien périphérique est supprimé, mais il reste inchangé.
Si le périphérique n'est pas déjà ouvert, QTextDocumentWriter tentera d'ouvrir le périphérique en mode WriteOnly en appelant open().
Remarque : cela ne fonctionnera pas pour certains dispositifs, tels que QProcess, QTcpSocket et QUdpSocket, pour lesquels une configuration est nécessaire avant que le dispositif puisse être ouvert.
Voir aussi device() et setFileName().
void QTextDocumentWriter::setFileName(const QString &fileName)
Définit le nom du fichier à écrire sur fileName. En interne, QTextDocumentWriter créera un fichier QFile et l'ouvrira en mode WriteOnly, et utilisera ce fichier lors de l'écriture du document.
Voir aussi fileName() et setDevice().
void QTextDocumentWriter::setFormat(const QByteArray &format)
Définit le format utilisé pour écrire des documents sur le site format spécifié. format est une chaîne de texte insensible à la casse. Par exemple, vous pouvez appeler () pour obtenir la liste complète des formats pris en charge par :
QTextDocumentWriter writer; writer.setFormat("odf"); // same as writer.setFormat("ODF");
Vous pouvez appeler supportedDocumentFormats() pour obtenir la liste complète des formats pris en charge par QTextDocumentWriter.
Voir également format().
[static] QList<QByteArray> QTextDocumentWriter::supportedDocumentFormats()
Retourne la liste des formats de documents pris en charge par QTextDocumentWriter.
Par défaut, Qt peut écrire les formats suivants :
| Format | Description |
|---|---|
| texte en clair | Texte brut |
| HTML | Langage de balisage hypertexte |
| markdown | Markdown (dialectes CommonMark ou GitHub) |
| ODF | Format OpenDocument |
Voir aussi setFormat().
bool QTextDocumentWriter::write(const QTextDocument *document)
Écrit le fichier document sur le périphérique ou le fichier assigné et renvoie true en cas de succès ; sinon, renvoie false.
bool QTextDocumentWriter::write(const QTextDocumentFragment &fragment)
Écrit le fragment de document spécifié par fragment sur le périphérique ou le fichier assigné et renvoie true en cas de succès ; sinon, renvoie false.
© 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.
