QTextDocumentWriter Class Reference
^{^{[

QtGui

module]}}

The QTextDocumentWriter class provides a format-independent interface for writing a QTextDocument 到文件或其它设备。更多...

方法

__init__ ( self )
__init__ ( self , QIODevice device , QByteArray format )
__init__ ( self , QString fileName , QByteArray format = QByteArray())
QTextCodec codec ( self )
QIODevice device ( self )
QString fileName ( self )
QByteArray format ( self )
setCodec ( self , QTextCodec codec )
setDevice ( self , QIODevice device )
setFileName ( self , QString fileName )
setFormat ( self , QByteArray format )
bool write ( self , QTextDocument document )
bool write ( self , QTextDocumentFragment fragment )

Static Methods

list-of-QByteArray supportedDocumentFormats ()

详细描述

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

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 使用 setFormat () later.

调用 write () 到 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.

调用 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.

方法文档编制

QTextDocumentWriter.init ( self )

构造空 QTextDocumentWriter object. Before writing, you must call setFormat () to set a document format, then setDevice () 或 setFileName ().

QTextDocumentWriter.init ( self , QIODevice device , QByteArray format )

构造 QTextDocumentWriter object to write 到给定 device in the document format specified by format .

QTextDocumentWriter.init ( self , QString fileName , QByteArray format = QByteArray())

Constructs an QTextDocumentWriter object that will write to a file with the name fileName , using the document format specified by format 。若 format 不是 provided, QTextDocumentWriter will detect the document format by inspecting the extension of fileName .

QTextCodec QTextDocumentWriter.codec ( self )

Returns the codec that is currently assigned to the writer.

另请参阅 setCodec ().

QIODevice QTextDocumentWriter.device ( self )

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

另请参阅 setDevice ().

QString QTextDocumentWriter.fileName ( self )

若目前赋值设备是 QFile ，或者若 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.

另请参阅 setFileName () 和 setDevice ().

QByteArray QTextDocumentWriter.format ( self )

返回用于写文档的格式。

另请参阅 setFormat ().

QTextDocumentWriter.setCodec ( self , QTextCodec codec )

Sets the codec for this stream to codec . The codec is used for encoding any data that is written. By default, QTextDocumentWriter uses UTF-8.

另请参阅 codec ().

QTextDocumentWriter.setDevice ( self , QIODevice device )

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.

若设备尚未打开， QTextDocumentWriter will attempt to open the device in QIODevice.WriteOnly mode by calling open().

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

另请参阅 device () 和 setFileName ().

QTextDocumentWriter.setFileName ( self , QString fileName )

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

另请参阅 fileName () 和 setDevice ().

QTextDocumentWriter.setFormat ( self , QByteArray format )

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

         QTextDocumentWriter writer;
         writer.setFormat("odf"); // same as writer.setFormat("ODF");

可以调用 supportedDocumentFormats () for the full list of formats QTextDocumentWriter 支持。

另请参阅 format ().

list-of-QByteArray QTextDocumentWriter.supportedDocumentFormats ()

Returns the list of document formats supported by QTextDocumentWriter .

By default, Qt can write the following formats:

Format	描述
plaintext	纯文本
HTML	HyperText Markup Language
ODF	OpenDocument Format