QTextDocumentWriter Class
La clase QTextDocumentWriter ofrece una interfaz independiente del formato para escribir un documento de texto ( QTextDocument ) en archivos u otros dispositivos. Más información...
| Encabezado: | #include <QTextDocumentWriter> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
- Lista de todos los miembros, incluidos los miembros heredados
- QTextDocumentWriter forma parte de las API de procesamiento de texto enriquecido.
Funciones públicas
| 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) |
Miembros públicos estáticos
| QList<QByteArray> | supportedDocumentFormats() |
Descripción detallada
Para escribir un documento, cree un objeto QTextDocumentWriter con un nombre de archivo o un objeto de dispositivo, y especifique el formato del documento que se va a escribir. Puede crear un escritor y establecer el formato utilizando setFormat() posteriormente.
Llama a ` write()` para escribir el documento en el dispositivo. Si el documento se escribe correctamente, esta función devuelve ` true`. Sin embargo, si se produce un error al escribir el documento, devolverá `false`.
Llama a supportedDocumentFormats() para obtener una lista de los formatos en los que QTextDocumentWriter puede escribir.
Dado que las capacidades de los formatos de salida compatibles varían considerablemente, el escritor simplemente genera el subconjunto adecuado de objetos para cada formato. Esto suele incluir el texto formateado y las imágenes contenidas en un documento.
Documentación de las funciones miembro
QTextDocumentWriter::QTextDocumentWriter()
Crea un objeto QTextDocumentWriter vacío. Antes de escribir, debes llamar a ` setFormat()` para establecer el formato del documento y, a continuación, a ` setDevice()` o ` setFileName()`.
QTextDocumentWriter::QTextDocumentWriter(QIODevice *device, const QByteArray &format)
Crea un objeto `QTextDocumentWriter` para escribir en el ` device ` indicado, en el formato de documento especificado por ` format`.
[explicit] QTextDocumentWriter::QTextDocumentWriter(const QString &fileName, const QByteArray &format = QByteArray())
Crea un objeto `QTextDocumentWriter` que escribirá en un archivo con el nombre ` fileName`, utilizando el formato de documento especificado por ` format`. Si no se proporciona ` format `, `QTextDocumentWriter` detectará el formato de documento analizando la extensión de ` fileName`.
[noexcept] QTextDocumentWriter::~QTextDocumentWriter()
Elimina el objeto « QTextDocumentWriter ».
QIODevice *QTextDocumentWriter::device() const
Devuelve el dispositivo asignado actualmente o « nullptr » si no se ha asignado ningún dispositivo.
Véase también setDevice().
QString QTextDocumentWriter::fileName() const
Si el dispositivo asignado actualmente es un ` QFile`, o si se ha llamado a ` setFileName()`, esta función devuelve el nombre del archivo en el que se va a escribir. En todos los demás casos, devuelve una cadena vacía.
Véanse también setFileName() y setDevice().
QByteArray QTextDocumentWriter::format() const
Devuelve el formato utilizado para escribir documentos.
Véase también setFormat().
void QTextDocumentWriter::setDevice(QIODevice *device)
Establece el dispositivo del escritor en el « device » especificado. Si ya se ha establecido un dispositivo, el dispositivo anterior se elimina, pero por lo demás no se modifica.
Si el dispositivo aún no está abierto, QTextDocumentWriter intentará abrirlo en modo « WriteOnly » llamando a la función open().
Nota: Esto no funcionará con determinados dispositivos, como QProcess, QTcpSocket y QUdpSocket, en los que se requiere cierta configuración antes de que se pueda abrir el dispositivo.
Véase también device() y setFileName().
void QTextDocumentWriter::setFileName(const QString &fileName)
Establece el nombre del archivo en el que se va a escribir: fileName. Internamente, QTextDocumentWriter creará un archivo QFile, lo abrirá en modo WriteOnly y utilizará este archivo al escribir el documento.
Véanse también fileName() y setDevice().
void QTextDocumentWriter::setFormat(const QByteArray &format)
Establece el formato que se utiliza para escribir documentos en el format especificado. format es una cadena de texto que no distingue entre mayúsculas y minúsculas. Por ejemplo:
QTextDocumentWriter writer;
writer.setFormat("odf"); // same as writer.setFormat("ODF");Puedes llamar a supportedDocumentFormats() para obtener la lista completa de formatos que admite QTextDocumentWriter.
Véase también format().
[static] QList<QByteArray> QTextDocumentWriter::supportedDocumentFormats()
Devuelve la lista de formatos de documento compatibles con QTextDocumentWriter.
De forma predeterminada, Qt puede escribir en los siguientes formatos:
| Formato | Descripción |
|---|---|
| texto sin formato | Texto sin formato |
| HTML | Lenguaje de marcado hipertextual |
| Markdown | Markdown (dialectos CommonMark o GitHub) |
| ODF | Formato OpenDocument |
Véase también setFormat().
bool QTextDocumentWriter::write(const QTextDocument *document)
Escribe el « document » indicado en el dispositivo o archivo asignado y devuelve « true » si la operación se realiza con éxito; en caso contrario, devuelve « false ».
bool QTextDocumentWriter::write(const QTextDocumentFragment &fragment)
Escribe el fragmento de documento especificado por ` fragment ` en el dispositivo o archivo asignado y devuelve ` true ` si la operación se realiza correctamente; en caso contrario, devuelve ` 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.