1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtVersit module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL21$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 2.1 or version 3 as published by the Free
20** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22** following information to ensure the GNU Lesser General Public License
23** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25**
26** As a special exception, The Qt Company gives you certain additional
27** rights. These rights are described in The Qt Company LGPL Exception
28** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29**
30** $QT_END_LICENSE$
31**
32****************************************************************************/
33
34#ifndef QVERSITCONTACTEXPORTER_H
35#define QVERSITCONTACTEXPORTER_H
36
37#include <QtCore/qlist.h>
38#include <QtCore/qmap.h>
39
40#include <QtContacts/qcontact.h>
41
42#include <QtVersit/qversitresourcehandler.h>
43#include <QtVersit/qversitdocument.h>
44
45QT_BEGIN_NAMESPACE_CONTACTS
46class QContactDetail;
47QT_END_NAMESPACE_CONTACTS
48
49QTCONTACTS_USE_NAMESPACE
50
51QT_BEGIN_NAMESPACE_VERSIT
52
53class QVersitContactExporterPrivate;
54
55class Q_VERSIT_EXPORT QVersitContactExporterDetailHandler
56{
57public:
58 virtual ~QVersitContactExporterDetailHandler() {}
59 virtual bool preProcessDetail(const QContact& contact,
60 const QContactDetail& detail,
61 QVersitDocument* document) = 0;
62 virtual bool postProcessDetail(const QContact& contact,
63 const QContactDetail& detail,
64 bool alreadyProcessed,
65 QVersitDocument* document) = 0;
66
67};
68
69class Q_VERSIT_EXPORT QVersitContactExporterDetailHandlerV2
70{
71public:
72 virtual ~QVersitContactExporterDetailHandlerV2() {}
73
74 virtual void detailProcessed(const QContact& contact,
75 const QContactDetail& detail,
76 const QVersitDocument& document,
77 QSet<int>* processedFields,
78 QList<QVersitProperty>* toBeRemoved,
79 QList<QVersitProperty>* toBeAdded) = 0;
80 virtual void contactProcessed(const QContact& contact,
81 QVersitDocument* document) = 0;
82};
83
84class Q_VERSIT_EXPORT QVersitContactExporter
85{
86public:
87 enum Error {
88 NoError = 0,
89 EmptyContactError,
90 NoNameError
91 };
92
93 QVersitContactExporter();
94 explicit QVersitContactExporter(const QString& profile);
95 explicit QVersitContactExporter(const QStringList& profile);
96 ~QVersitContactExporter();
97
98 bool exportContacts(const QList<QTCONTACTS_PREPEND_NAMESPACE(QContact)>& contacts,
99 QVersitDocument::VersitType versitType = QVersitDocument::VCard30Type);
100 QList<QVersitDocument> documents() const;
101 QMap<int, Error> errorMap() const;
102
103 void setDetailHandler(QVersitContactExporterDetailHandlerV2* handler);
104
105 void setResourceHandler(QVersitResourceHandler* handler);
106 QVersitResourceHandler* resourceHandler() const;
107
108 /* deprecated */
109 QMap<int, Error> errors() const;
110 void setDetailHandler(QVersitContactExporterDetailHandler* handler);
111 QVersitContactExporterDetailHandler* detailHandler() const;
112
113private:
114 QVersitContactExporterPrivate* d;
115};
116
117QT_END_NAMESPACE_VERSIT
118
119#endif // QVERSITCONTACTEXPORTER_H
120

source code of qtpim/src/versit/qversitcontactexporter.h