com.trolltech.qt.gui
Class QTextDocumentWriter

java.lang.Object
  extended by com.trolltech.qt.internal.QSignalEmitterInternal
      extended by com.trolltech.qt.QSignalEmitter
          extended by com.trolltech.qt.QtJambiObject
              extended by com.trolltech.qt.gui.QTextDocumentWriter
All Implemented Interfaces:
QtJambiInterface

public class QTextDocumentWriter
extends QtJambiObject

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


Nested Class Summary
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.AbstractSignal, QSignalEmitter.PrivateSignal0, QSignalEmitter.PrivateSignal1, QSignalEmitter.PrivateSignal2, QSignalEmitter.PrivateSignal3, QSignalEmitter.PrivateSignal4, QSignalEmitter.PrivateSignal5, QSignalEmitter.PrivateSignal6, QSignalEmitter.PrivateSignal7, QSignalEmitter.PrivateSignal8, QSignalEmitter.PrivateSignal9, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal
 
Field Summary
 
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
currentSender
 
Constructor Summary
QTextDocumentWriter()
          Constructs an empty QTextDocumentWriter object.
QTextDocumentWriter(QIODevice device, QByteArray format)
          Constructs a QTextDocumentWriter object to write to the given device in the document format specified by format.
QTextDocumentWriter(java.lang.String fileName)
          Constructs an QTextDocumentWriter object that will write to a file with the name fileName, using the document format specified by format.
QTextDocumentWriter(java.lang.String fileName, QByteArray format)
          Constructs an QTextDocumentWriter object that will write to a file with the name fileName, using the document format specified by format.
 
Method Summary
 QTextCodec codec()
          Returns the codec that is currently assigned to the writer.
 QIODevice device()
          Returns the device currently assigned, or 0 if no device has been assigned.
 java.lang.String fileName()
          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.
 QByteArray format()
          Returns the format used for writing documents.
 void setCodec(QTextCodec codec)
          Sets the codec for this stream to codec.
 void setDevice(QIODevice device)
          Sets the writer's device to the device specified.
 void setFileName(java.lang.String fileName)
          Sets the name of the file to be written to fileName.
 void setFormat(QByteArray format)
          Sets the format used to write documents to the format specified.
static java.util.List supportedDocumentFormats()
          Returns the list of document formats supported by QTextDocumentWriter.
 boolean write(QTextDocument document)
          Writes the given document to the assigned device or file and returns true if successful; otherwise returns false.
 boolean write(QTextDocumentFragment fragment)
          Writes the document fragment specified by fragment to the assigned device or file and returns true if successful; otherwise returns false.
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
__qt_signalInitialization
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QTextDocumentWriter

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


QTextDocumentWriter

public QTextDocumentWriter(QIODevice device,
                           QByteArray format)
Constructs a QTextDocumentWriter object to write to the given device in the document format specified by format.


QTextDocumentWriter

public QTextDocumentWriter(java.lang.String fileName)
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.


QTextDocumentWriter

public QTextDocumentWriter(java.lang.String fileName,
                           QByteArray 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.

Method Detail

codec

public final QTextCodec codec()
Returns the codec that is currently assigned to the writer.

See also:
setCodec().


device

public final QIODevice device()
Returns the device currently assigned, or 0 if no device has been assigned.

See also:
setDevice().


fileName

public final java.lang.String fileName()
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(), and setDevice().


format

public final QByteArray format()
Returns the format used for writing documents.

See also:
setFormat().


setCodec

public final void setCodec(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.

See also:
codec().


setDevice

public final void setDevice(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.

If the device is not already open, QTextDocumentWriter will attempt to open the device in QIODevice::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(), and setFileName().


setFileName

public final void setFileName(java.lang.String fileName)
Sets the name of the file to be written to fileName. Internally, QTextDocumentWriter will create a QFile and open it in QIODevice::WriteOnly mode, and use this file when writing the document.

See also:
fileName(), and setDevice().


setFormat

public final void setFormat(QByteArray format)
Sets the format used to write documents to the format specified. format is a case insensitive text string. For example:

The following code example is written in c++.
        QTextDocumentWriter writer;
        writer.setFormat("odf"); // same as writer.setFormat("ODF");
You can call supportedDocumentFormats() for the full list of formats QTextDocumentWriter supports.

See also:
format().


write

public final boolean write(QTextDocument document)
Writes the given document to the assigned device or file and returns true if successful; otherwise returns false.


write

public final boolean write(QTextDocumentFragment fragment)
Writes the document fragment specified by fragment to the assigned device or file and returns true if successful; otherwise returns false.


supportedDocumentFormats

public static java.util.List supportedDocumentFormats()
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
ODF OpenDocument Format

See also:
setFormat().