~chris.gagnon/+junk/qtpim-coverage

« back to all changes in this revision

Viewing changes to src/versitorganizer/qversitorganizerexporter.h

  • Committer: chris.gagnon
  • Date: 2013-12-10 23:09:37 UTC
  • Revision ID: chris.gagnon@canonical.com-20131210230937-2akf1ft1edcttk87
first post

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/****************************************************************************
 
2
**
 
3
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
 
4
** Contact: http://www.qt-project.org/legal
 
5
**
 
6
** This file is part of the QtVersitOrganizer module of the Qt Toolkit.
 
7
**
 
8
** $QT_BEGIN_LICENSE:LGPL$
 
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 Digia.  For licensing terms and
 
14
** conditions see http://qt.digia.com/licensing.  For further information
 
15
** use the contact form at http://qt.digia.com/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 as published by the Free Software
 
20
** Foundation and appearing in the file LICENSE.LGPL included in the
 
21
** packaging of this file.  Please review the following information to
 
22
** ensure the GNU Lesser General Public License version 2.1 requirements
 
23
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 
24
**
 
25
** In addition, as a special exception, Digia gives you certain additional
 
26
** rights.  These rights are described in the Digia Qt LGPL Exception
 
27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
 
28
**
 
29
** GNU General Public License Usage
 
30
** Alternatively, this file may be used under the terms of the GNU
 
31
** General Public License version 3.0 as published by the Free Software
 
32
** Foundation and appearing in the file LICENSE.GPL included in the
 
33
** packaging of this file.  Please review the following information to
 
34
** ensure the GNU General Public License version 3.0 requirements will be
 
35
** met: http://www.gnu.org/copyleft/gpl.html.
 
36
**
 
37
**
 
38
** $QT_END_LICENSE$
 
39
**
 
40
****************************************************************************/
 
41
 
 
42
#ifndef QVERSITORGANIZEREXPORTER_H
 
43
#define QVERSITORGANIZEREXPORTER_H
 
44
 
 
45
#include <qversitorganizerglobal.h>
 
46
#include <qversitdocument.h>
 
47
 
 
48
#include <qorganizeritem.h>
 
49
 
 
50
QT_BEGIN_NAMESPACE_ORGANIZER
 
51
class QOrganizerItem;
 
52
class QOrganizerItemDetail;
 
53
QT_END_NAMESPACE_ORGANIZER
 
54
 
 
55
QT_BEGIN_NAMESPACE_VERSIT
 
56
class QVersitDocument;
 
57
class QVersitProperty;
 
58
QT_END_NAMESPACE_VERSIT
 
59
 
 
60
QTORGANIZER_USE_NAMESPACE
 
61
QTVERSIT_USE_NAMESPACE
 
62
 
 
63
QT_BEGIN_NAMESPACE_VERSITORGANIZER
 
64
 
 
65
class QVersitOrganizerExporterPrivate;
 
66
 
 
67
class Q_VERSIT_ORGANIZER_EXPORT QVersitOrganizerExporterDetailHandler
 
68
{
 
69
public:
 
70
    virtual ~QVersitOrganizerExporterDetailHandler() {}
 
71
    virtual void detailProcessed(const QOrganizerItem& item,
 
72
                                 const QOrganizerItemDetail& detail,
 
73
                                 const QVersitDocument& document,
 
74
                                 QSet<int>* processedFields,
 
75
                                 QList<QVersitProperty>* toBeRemoved,
 
76
                                 QList<QVersitProperty>* toBeAdded) = 0;
 
77
    virtual void itemProcessed(const QOrganizerItem& item,
 
78
                               QVersitDocument* document) = 0;
 
79
};
 
80
 
 
81
class Q_VERSIT_ORGANIZER_EXPORT QVersitOrganizerExporter
 
82
{
 
83
public:
 
84
    enum Error {
 
85
        NoError = 0,
 
86
        EmptyOrganizerError,
 
87
        UnknownComponentTypeError,
 
88
        UnderspecifiedOccurrenceError
 
89
    };
 
90
 
 
91
    QVersitOrganizerExporter();
 
92
    explicit QVersitOrganizerExporter(const QString& profile);
 
93
    ~QVersitOrganizerExporter();
 
94
 
 
95
    bool exportItems(const QList<QOrganizerItem>& items,
 
96
            QVersitDocument::VersitType versitType = QVersitDocument::ICalendar20Type);
 
97
    QVersitDocument document() const;
 
98
    QMap<int, Error> errorMap() const;
 
99
 
 
100
    void setDetailHandler(QVersitOrganizerExporterDetailHandler* handler);
 
101
 
 
102
private:
 
103
    QVersitOrganizerExporterPrivate* d;
 
104
};
 
105
 
 
106
QT_END_NAMESPACE_VERSITORGANIZER
 
107
 
 
108
#endif // QVERSITORGANIZEREXPORTER_H