Home · All Classes · All Functions ·

QVersitReader Class Reference

The QVersitReader class reads Versit documents such as vCards from a device. More...

    #include <QVersitReader>

This class is under development and is subject to change.

Inherits QObject.


Public Types

enum Error { NoError, UnspecifiedError, IOError, OutOfMemoryError, NotReadyError, ParseError }
enum State { InactiveState, ActiveState, CanceledState, FinishedState }

Public Functions

QVersitReader ()
~QVersitReader ()
void cancel ()
QTextCodec * defaultCodec () const
QIODevice * device () const
Error error () const
QList<QVersitDocument> results () const
void setDefaultCodec ( QTextCodec * codec )
void setDevice ( QIODevice * device )
bool startReading ()
State state () const
bool waitForFinished ( int msec = -1 )

Signals

void resultsAvailable ( QList<QVersitDocument> & results )
void stateChanged ( QVersitReader::State state )

Additional Inherited Members


Detailed Description

The QVersitReader class reads Versit documents such as vCards from a device.

QVersitReader concatenation of Versit documents such as vCards from a text stream and returns a list of QVersitDocument instances. QVersitReader supports reading from an abstract I/O device which can be for example a file or a memory buffer. The reading can be done asynchronously, and the waitForFinished() function can be used to make a blocking read.

See also QVersitDocument.


Member Type Documentation

enum QVersitReader::Error

This enum specifies an error that occurred during the most recent operation:

ConstantValueDescription
QVersitReader::NoError0The most recent operation was successful
QVersitReader::UnspecifiedError1The most recent operation failed for an undocumented reason
QVersitReader::IOError2The most recent operation failed because of a problem with the device
QVersitReader::OutOfMemoryError3The most recent operation failed due to running out of memory
QVersitReader::NotReadyError4The most recent operation failed because there is an operation in progress
QVersitReader::ParseError5The most recent operation failed because the input was malformed

enum QVersitReader::State

Enumerates the various states that a reader may be in at any given time

ConstantValueDescription
QVersitReader::InactiveState0Read operation not yet started
QVersitReader::ActiveState1Read operation started, not yet finished
QVersitReader::CanceledState2Read operation is finished due to cancellation
QVersitReader::FinishedState3Read operation successfully completed


Member Function Documentation

QVersitReader::QVersitReader ()

Constructs a new reader.

QVersitReader::~QVersitReader ()

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

void QVersitReader::cancel ()

Attempts to asynchronously cancel the read request.

QTextCodec * QVersitReader::defaultCodec () const

Returns the codec the reader uses when parsing the input stream.

See also setDefaultCodec().

QIODevice * QVersitReader::device () const

Returns the device used for reading input.

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 ( QList<QVersitDocument> & results )   [signal]

The signal is emitted by the reader as it reads from the device when it has made more Versit documents available. results is the complete list of documents read so far.

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.

See also defaultCodec().

void QVersitReader::setDevice ( QIODevice * device )

Sets the device used for reading the input to be the given device.

See also device().

bool QVersitReader::startReading ()

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.

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 the state is FinishedState, returns true immediately. Otherwise, returns false immediately.


Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.0.0