QVersitReader Class Reference

Member Function Documentation

QVersitReader::QVersitReader ()

Constructs a new reader.

QVersitReader::QVersitReader ( QIODevice * inputDevice )

Constructs a new reader that reads from inputDevice.

QVersitReader::QVersitReader ( const QByteArray & inputData )

Constructs a new reader that reads from inputData.

QVersitReader::~QVersitReader ()

Frees the memory used by the reader. Waits until a pending asynchronous reading has been completed.

void QVersitReader::cancel () [slot]

Attempts to asynchronously cancel the read request.

QTextCodec * QVersitReader::defaultCodec () const

Returns the codec the reader uses when parsing the input stream. If the codec is null, this denotes that the reader will try to detect the codec from the input.

See also setDefaultCodec().

QIODevice * QVersitReader::device () const

Returns the device used for reading input, or 0 if no device has been set (or if the input source was set with setData().

See also setDevice().

Error QVersitReader::error () const

Returns the error encountered by the last operation.

QList<QVersitDocument> QVersitReader::results () const

Returns the reading result. Even if there was an error or reading has not completed, a partial list of results may be returned.

void QVersitReader::resultsAvailable () [signal]

The signal is emitted by the reader as it reads from the device when it has made more Versit documents available.

void QVersitReader::setData ( const QByteArray & inputData )

Sets the data to read from to the byte array input source, inputData. This overrides any device set with setDevice().

void QVersitReader::setDefaultCodec ( QTextCodec * codec )

Sets codec as the codec for the reader to use when parsing the input stream to. This codec is not used for values where the CHARSET Versit parameter occurs. If the codec is null, this denotes that the reader will try to detect the codec from the input. The codec autodetection algorithm can detect UTF-8, UTF-16 or UTF-32. If the input is in some 8-bit codec, it will fall back to using the system locale's codec.

See also defaultCodec().

void QVersitReader::setDevice ( QIODevice * device )

Sets the device used for reading the input to be the given device. Does not take ownership of the device. This overrides any byte array input source set with setData().

The caller must ensure that device remains valid for the lifetime of this QVersitReader object.

See also device().

bool QVersitReader::startReading () [slot]

Starts reading the input asynchronously. Returns false if the input device has not been set or opened or if there is another asynchronous read operation already pending. Signal stateChanged() is emitted with parameter FinishedState when the reading has finished.

The device must be already open. The client is responsible for closing it when finished.

State QVersitReader::state () const

Returns the state of the reader.

void QVersitReader::stateChanged ( QVersitReader::State state ) [signal]

The signal is emitted by the reader when its state has changed (eg. when it has finished reading from the device). state is the new state of the reader.

bool QVersitReader::waitForFinished ( int msec = -1 )

If the state is ActiveState, blocks until the reader has finished reading or msec milliseconds has elapsed, returning true if it successfully finishes or is cancelled by the user. If msec is negative or zero, the function blocks until the writer has finished, regardless of how long it takes. If the state is FinishedState, returns true immediately. Otherwise, returns false immediately.