QTM_USE_NAMESPACE

  \class QVersitContactImporterPropertyHandler

  \preliminary

  \brief The QVersitContactImporterPropertyHandler class is an interface for clients wishing to

  implement custom import behaviour for versit properties

  \sa QVersitContactImporter

 */

/*!

 * \fn QVersitContactImporterPropertyHandler::~QVersitContactImporterPropertyHandler()

 * Frees any memory in use by this handler.

 */

/*!

 * \fn virtual bool QVersitContactImporterPropertyHandler::preProcessProperty(const QVersitDocument& document, const QVersitProperty& property, int contactIndex, QContact* contact) = 0;

 * Process \a property and update \a contact with the corresponding QContactDetail(s).

 * \a document provides the context within which the property was found.

 * \a contactIndex specifies the position that \a contact will take in the list returned by

 * \l QVersitContactImporter::importContacts().

 *

 * Returns true if the property has been handled and requires no further processing, false

 * otherwise.

 *

 * This function is called on every QVersitProperty encountered during an import.  Supply this

 * function and return true to implement custom import behaviour.

 */

/*!

 * \fn virtual bool QVersitContactImporterPropertyHandler::postProcessProperty(const QVersitDocument& document, const QVersitProperty& property, bool alreadyProcessed, int contactIndex, QContact* contact) = 0;

 * Process \a property and update \a contact with the corresponding QContactDetail(s).

 * \a document provides the context within which the property was found.

 * \a contactIndex specifies the position that \a contact will take in the list returned by

 * \l QVersitContactImporter::importContacts().

 * \a alreadyProcessed is true if the detail has already been processed either by

 * \l preProcessProperty() or by QVersitContactImporter itself.

 *

 * Returns true if the property has been handled, false otherwise.

 *

 * This function is called on every QVersitProperty encountered during an import.  This can be

 * used to implement support for QVersitProperties not supported by QVersitContactImporter.

 */

/*!

 * \class QVersitContactImporter

 * \preliminary

 * \brief The QVersitContactImporter class creates QContacts from QVersitDocuments.

 *

 * \ingroup versit

 *

 * A \l QVersitResourceHandler is associated with the importer to supply the behaviour for saving

 * files to persistent storage.  By default, this is set to a \l QVersitDefaultResourceHandler,

 * which does not save files to persistent storage.  Note that although avatars found in vCards

 * are not saved to disk by default, the importer does set the pixmap of the contact detail to the

 * image.  If a full-sized avatar image needs to be persisted, a custom QVersitResourceHandler

 * should be supplied which implements this.

 *

 * By associating a QVersitContactImporterPropertyHandler with the importer using

 * setPropertyHandler(), the client can pass in a handler to override the processing of properties

 * and/or handle properties that QVersitContactImporter doesn't support.

 *

 * An example property handler that logs unknown properties:

 * \snippet ../../doc/src/snippets/qtversitdocsample/qtversitdocsample.cpp Property handler

 *

 * An example usage of QVersitContactImporter

 * \snippet ../../doc/src/snippets/qtversitdocsample/qtversitdocsample.cpp Import example

 *

 * \sa QVersitDocument, QVersitReader, QVersitContactImporterPropertyHandler

 * Converts \a documents into a corresponding list of QContacts.

QList<QContact> QVersitContactImporter::importContacts(const QList<QVersitDocument>& documents)

    QList<QContact> list;

    int i = 0;

    foreach (QVersitDocument document, documents) {

        list.append(d->importContact(document, i));

        i++;

    }

    return list;

 * Sets \a handler to be the handler for processing QVersitProperties, or 0 to have no handler.

 */

void QVersitContactImporter::setPropertyHandler(QVersitContactImporterPropertyHandler* handler)

{

    d->mPropertyHandler = handler;

}

/*!

 * Gets the handler for processing QVersitProperties.

QVersitContactImporterPropertyHandler* QVersitContactImporter::propertyHandler() const

    return d->mPropertyHandler;

}

/*!

 * Sets \a handler to be the handler to save files with, or 0 to have no handler.

 */

void QVersitContactImporter::setResourceHandler(QVersitResourceHandler* handler)

{

    d->mResourceHandler = handler;

 * Returns the associated resource handler.

QVersitResourceHandler* QVersitContactImporter::resourceHandler() const

    return d->mResourceHandler;

/*! \internal */

void QVersitContactImporter::setImagePath(const QString& path)

    Q_UNUSED(path)

}

/*! \internal */

QString QVersitContactImporter::imagePath() const

{

    return QString();

/*! \internal */

void QVersitContactImporter::setAudioClipPath(const QString& path)

    Q_UNUSED(path)

}

/*! \internal */

QString QVersitContactImporter::audioClipPath() const

{

    return QString();

/*! \internal */

QContact QVersitContactImporter::importContact(const QVersitDocument& versitDocument)

{

    QList<QVersitDocument> list;

    list.append(versitDocument);

    return importContacts(list).first();

}

/*! \internal */

    return QList<QVersitProperty>();