QTM_USE_NAMESPACE

  \class QVersitContactExporterDetailHandler

  \preliminary

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

  implement custom export behaviour for certain contact details.

  \sa QVersitContactExporter

 */

/*!

 * \fn virtual QVersitContactExporterDetailHandler::~QVersitContactExporterDetailHandler()

 * Frees any memory in use by this handler.

 */

/*!

 * \fn virtual bool QVersitContactExporterDetailHandler::preProcessDetail(const QContact& contact, const QContactDetail& detail, QVersitDocument* document) = 0;

 * Process \a detail and update \a document with the corresponding QVersitProperty(s).

 * \a contact provides the context within which the detail was found.

 *

 * Returns true if the detail has been handled and requires no furthur processing, false otherwise.

 *

 * This function is called on every QContactDetail encountered during an export.  Supply this

 * function and return true to implement custom export behaviour.

/*!

 * \fn virtual bool QVersitContactExporterDetailHandler::postProcessDetail(const QContact& contact, const QContactDetail& detail, bool alreadyProcessed, QVersitDocument* document) = 0;

 * Process \a detail and update \a document with the corresponding QVersitProperty(s).

 * \a contact provides the context within which the detail was found.

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

 * \l preProcessDetail() or by QVersitContactExporter itself.

 *

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

 *

 * This function is called on every \l QContactDetail encountered during an export.  This can be

 * used to implement support for QContactDetails not supported by QVersitContactExporter.

 */

 * \class QVersitContactExporter

 * \preliminary

 * \brief The QVersitContactExporter class converts \l {QContact}{QContacts} into

 * \l {QVersitDocument}{QVersitDocuments}.

 * \ingroup versit

 *

 * A \l QVersitResourceHandler is associated with the exporter to supply the behaviour for loading

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

 * which supports basic resource loading from the file system.  An alternative resource handler

 * can be specified with setResourceHandler().

 *

 * By associating a \l QVersitContactExporterDetailHandler with the exporter using

 * setDetailHandler(), the client can pass in a handler to override the processing of details and/or

 * handle details that QVersitContactExporter doesn't support.

 *

 * An example detail handler that logs unknown properties:

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

 *

 * An example usage of QVersitContactExporter

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

 *

 * \sa QVersitDocument, QVersitProperty, QVersitContactExporterDetailHandler, QVersitResourceHandler

    delete d;

}

/*!

 * Converts \a contacts into a list of corresponding QVersitDocuments, using the format given by

 * \a versitType.

 */

QList<QVersitDocument> QVersitContactExporter::exportContacts(

    const QList<QContact>& contacts,

    QVersitDocument::VersitType versitType)

{

    QList<QVersitDocument> list;

    foreach (QContact contact, contacts) {

        QVersitDocument versitDocument;

        versitDocument.setType(versitType);

        d->exportContact(contact, versitDocument);

        list.append(versitDocument);

    }

    return list;

}

/*!

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

 */

void QVersitContactExporter::setDetailHandler(QVersitContactExporterDetailHandler* handler)

{

    d->mDetailHandler = handler;

 * Gets the handler for processing QContactDetails.

QVersitContactExporterDetailHandler* QVersitContactExporter::detailHandler() const

    return d->mDetailHandler;

}

/*!

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

 */

void QVersitContactExporter::setResourceHandler(QVersitResourceHandler* handler)

{

    d->mResourceHandler = handler;

 * Returns the associated resource handler.

QVersitResourceHandler* QVersitContactExporter::resourceHandler() const

{

    return d->mResourceHandler;

}

/*! \internal */

QVersitDocument QVersitContactExporter::exportContact(const QContact& contact,

                                                      QVersitDocument::VersitType versitType)

{

    QList<QContact> list;

    list.append(contact);

    return exportContacts(list, versitType).first();

}

/*! \internal */

    return QList<QContactDetail>();