1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the Qt Mobility Components.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef QVERSITCONTACTIMPORTER_H

    43 #define QVERSITCONTACTIMPORTER_H

    44 

    45 #include "qmobilityglobal.h"

    46 #include "qversitresourcehandler.h"

    47 

    48 #include <qcontact.h>

    49 

    50 #include <QList>

    51 

    52 QTM_BEGIN_NAMESPACE

    53 

    54 class QVersitDocument;

    55 class QVersitContactImporterPrivate;

    56 class QVersitProperty;

    57 

    58 class Q_VERSIT_EXPORT QVersitContactImporterPropertyHandler

    59 {

    60 public:

    61     virtual ~QVersitContactImporterPropertyHandler() {}

    62     virtual bool preProcessProperty(const QVersitDocument& document,

    63                                     const QVersitProperty& property,

    64                                     int contactIndex,

    65                                     QContact* contact) = 0;

    66     virtual bool postProcessProperty(const QVersitDocument& document,

    67                                      const QVersitProperty& property,

    68                                      bool alreadyProcessed,

    69                                      int contactIndex,

    70                                      QContact* contact) = 0;

    71 };

    72 

    73 class Q_VERSIT_EXPORT QVersitContactImporterPropertyHandlerV2

    74 {

    75 public:

    76     static QVersitContactImporterPropertyHandlerV2* createBackupHandler();

    77     virtual ~QVersitContactImporterPropertyHandlerV2() {}

    78     virtual void propertyProcessed(const QVersitDocument& document,

    79                                    const QVersitProperty& property,

    80                                    bool alreadyProcessed,

    81                                    const QContact& contact,

    82                                    QList<QContactDetail>* updatedDetails) = 0;

    83     virtual void documentProcessed(const QVersitDocument& document,

    84                                    QContact* contact) = 0;

    85     virtual int version() const { return 2; }

    86 };

    87 

    88 class Q_VERSIT_EXPORT QVersitContactImporter

    89 {

    90 public:

    91     enum Error {

    92         NoError = 0,

    93         InvalidDocumentError,

    94         EmptyDocumentError

    95     };

    96 

    97     QVersitContactImporter();

    98     ~QVersitContactImporter();

    99 

   100     bool importDocuments(const QList<QVersitDocument>& documents);

   101     QList<QContact> contacts() const;

   102     QMap<int, Error> errors() const;

   103 

   104     void setPropertyHandler(QVersitContactImporterPropertyHandlerV2* handler);

   105 

   106     void setResourceHandler(QVersitResourceHandler* handler);

   107     QVersitResourceHandler* resourceHandler() const;

   108 

   109     // Deprecated:

   110 

   111     QList<QContact> Q_DECL_DEPRECATED importContacts(const QList<QVersitDocument>& documents);

   112     void Q_DECL_DEPRECATED setPropertyHandler(QVersitContactImporterPropertyHandler* handler);

   113     /* deprecated and internal */

   114     Q_DECL_DEPRECATED QVersitContactImporterPropertyHandler* propertyHandler() const;

   115 

   116 private:

   117     QVersitContactImporterPrivate* d;

   118 };

   119 

   120 QTM_END_NAMESPACE

   121 

   122 #endif // QVERSITCONTACTIMPORTER_H

   123