QTextDocumentWriter

The QTextDocumentWriter class provides a format-independent interface for writing a QTextDocument to files or other devices. More…

New in version 4.5.

Synopsis

Functions

• def device ()

• def fileName ()

• def format ()

• def setDevice (device)

• def setFileName (fileName)

• def setFormat (format)

• def write (document)

• def write (fragment)

Static functions

• def supportedDocumentFormats ()

Detailed Description

To write a document, construct a QTextDocumentWriter object with either a file name or a device object, and specify the document format to be written. You can construct a writer and set the format using setFormat() later.

Call write() to write the document to the device. If the document is successfully written, this function returns true. However, if an error occurs when writing the document, it will return false.

Call supportedDocumentFormats() for a list of formats that QTextDocumentWriter can write.

Since the capabilities of the supported output formats vary considerably, the writer simply outputs the appropriate subset of objects for each format. This typically includes the formatted text and images contained in a document.

class PySide6.QtGui.QTextDocumentWriter

PySide6.QtGui.QTextDocumentWriter(device, format)

PySide6.QtGui.QTextDocumentWriter(fileName[, format=QByteArray()])

Parameters

• fileName – str

• device – PySide6.QtCore.QIODevice

• format – PySide6.QtCore.QByteArray

Constructs an empty QTextDocumentWriter object. Before writing, you must call setFormat() to set a document format, then setDevice() or setFileName() .

Constructs a QTextDocumentWriter object to write to the given device in the document format specified by format.

Constructs an QTextDocumentWriter object that will write to a file with the name fileName, using the document format specified by format. If format is not provided, QTextDocumentWriter will detect the document format by inspecting the extension of fileName.

PySide6.QtGui.QTextDocumentWriter.device()

Return type

PySide6.QtCore.QIODevice

Returns the device currently assigned, or None if no device has been assigned.

See also

setDevice()

PySide6.QtGui.QTextDocumentWriter.fileName()

Return type

str

If the currently assigned device is a QFile , or if setFileName() has been called, this function returns the name of the file to be written to. In all other cases, it returns an empty string.

See also

setFileName() setDevice()

PySide6.QtGui.QTextDocumentWriter.format()

Return type

PySide6.QtCore.QByteArray

Returns the format used for writing documents.

See also

setFormat()

PySide6.QtGui.QTextDocumentWriter.setDevice(device)

Parameters

device – PySide6.QtCore.QIODevice

Sets the writer’s device to the device specified. If a device has already been set, the old device is removed but otherwise left unchanged.

If the device is not already open, QTextDocumentWriter will attempt to open the device in WriteOnly mode by calling open().

Note

This will not work for certain devices, such as QProcess , QTcpSocket and QUdpSocket , where some configuration is required before the device can be opened.

See also

device() setFileName()

PySide6.QtGui.QTextDocumentWriter.setFileName(fileName)

Parameters

fileName – str

Sets the name of the file to be written to fileName. Internally, QTextDocumentWriter will create a QFile and open it in WriteOnly mode, and use this file when writing the document.

See also

fileName() setDevice()

PySide6.QtGui.QTextDocumentWriter.setFormat(format)

Parameters

format – PySide6.QtCore.QByteArray

Sets the format used to write documents to the format specified. format is a case insensitive text string. For example:

writer = QTextDocumentWriter()
writer.setFormat("odf") # same as writer.setFormat("ODF")

You can call supportedDocumentFormats() for the full list of formats QTextDocumentWriter supports.

See also

format()

static PySide6.QtGui.QTextDocumentWriter.supportedDocumentFormats()

Return type

Returns the list of document formats supported by QTextDocumentWriter .

By default, Qt can write the following formats:

Format	Description
plaintext	Plain text
HTML	HyperText Markup Language
markdown	Markdown (CommonMark or GitHub dialects)
ODF	OpenDocument Format

See also

setFormat()

PySide6.QtGui.QTextDocumentWriter.write(document)

Parameters

document – PySide6.QtGui.QTextDocument

Return type

bool

Writes the given document to the assigned device or file and returns true if successful; otherwise returns false.

PySide6.QtGui.QTextDocumentWriter.write(fragment)

Parameters

fragment – PySide6.QtGui.QTextDocumentFragment

Return type

bool

Writes the document fragment specified by fragment to the assigned device or file and returns true if successful; otherwise returns false.