1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qversitorganizerexporter.h"
#include "qversitorganizerexporter_p.h"
#include "qversitdocument.h"
#include "qversitproperty.h"
#include "qmobilityglobal.h"
QTM_USE_NAMESPACE
/*!
\class QVersitOrganizerExporter
\brief The QVersitOrganizerExporter class converts \l {QOrganizerItem}{QOrganizerItems} into
\l {QVersitDocument}{QVersitDocuments}.
\ingroup versit
\inmodule QtVersit
\since 1.1
This class is used to convert a list of \l {QOrganizerItem}{QOrganizerItems} (which may be stored
in a QOrganizerManager) into a QVersitDocument (which may be written to an I/O device using
QVersitReader. While multiple items are provided as input, a single QVersitDocument is produced
as output. Unless there is an error, there is a one-to-one mapping between organizer items
and sub-documents of the result.
*/
/*!
\class QVersitOrganizerExporterDetailHandler
\brief The QVersitOrganizerExporterDetailHandler class is an interface for specifying
custom export behaviour for certain organizer item details.
\ingroup versit-extension
\inmodule QtVersit
For general information on extending Qt Versit, see the document on \l{Versit Plugins}.
\sa QVersitOrganizerExporter
*/
/*!
\fn QVersitOrganizerExporterDetailHandler::~QVersitOrganizerExporterDetailHandler()
Frees any memory in use by this handler.
*/
/*!
\fn void QVersitOrganizerExporterDetailHandler::detailProcessed(const QOrganizerItem& item, const QOrganizerItemDetail& detail, const QVersitDocument& document, QSet<QString>* processedFields, QList<QVersitProperty>* toBeRemoved, QList<QVersitProperty>* toBeAdded)
Process \a detail and provide a list of updated \l{QVersitProperty}{QVersitProperties} by
modifying the \a toBeRemoved and \a toBeAdded lists.
This function is called on every QOrganizerItemDetail encountered during an export, after the
detail has been processed by the QVersitOrganizerExporter. An implementation of this function can
be made to provide support for QOrganizerItemDetails not supported by QVersitOrganizerExporter.
The supplied \a item is the container for the \a detail. \a processedFields contains a list of
fields in the \a detail that were considered by the QVersitOrganizerExporter or another handler in
processing the detail. \a document holds the state of the document before the detail was
processed by the exporter.
\a toBeRemoved and \a toBeAdded are initially filled with a list of properties that the exporter
will remove from and add to the document. These lists can be modified (by removing, modifying or
adding properties) by the handler to control the changes that will actually be made to the
document. If a property is to be modified in the document, the old version will appear in the
\a toBeRemoved list and the new version will appear in the \a toBeAdded list. When the handler
uses a field from the detail, it should update the processedFields set to reflect this to inform
later handlers that the field has already been processed.
After the handler returns control back to the exporter, the properties in the \a toBeRemoved
list will be removed and the properties in the \a toBeAdded list will be appended to the document.
*/
/*!
\fn void QVersitOrganizerExporterDetailHandler::itemProcessed(const QOrganizerItem& item, QVersitDocument* document)
Perform any final processing on the \a document generated by the \a item. This can be
implemented by the handler to clear any internal state before moving onto the next item.
This function is called after all QOrganizerItemDetails have been handled by the
QVersitOrganizerExporter.
*/
/*!
\enum QVersitOrganizerExporter::Error
This enum specifies an error that occurred during the most recent call to exportItems()
\value NoError The most recent operation was successful
\value EmptyOrganizerError One of the organizer items was empty
\value UnknownComponentTypeError One of the components in the iCalendar file is not supported
\value UnderspecifiedOccurrenceError An event or todo exception was found which did not specify both its parent and a specifier for which instance to override
*/
/*! Constructs a new exporter */
QVersitOrganizerExporter::QVersitOrganizerExporter()
: d(new QVersitOrganizerExporterPrivate)
{
}
/*!
* Constructs a new exporter for the given \a profile. The profile strings should be one of those
* defined by QVersitOrganizerHandlerFactory, or a value otherwise agreed to by a \l{Versit
* Plugins}{Versit plugin}.
*
* The profile determines which plugins will be loaded to supplement the exporter.
*/
QVersitOrganizerExporter::QVersitOrganizerExporter(const QString& profile)
: d(new QVersitOrganizerExporterPrivate(profile))
{
}
/*! Frees the memory used by the exporter */
QVersitOrganizerExporter::~QVersitOrganizerExporter()
{
delete d;
}
/*!
* Converts \a items into a QVersitDocument, using the format given by \a versitType.
* Returns true on success. If any of the items could not be exported, false is returned and
* errorMap() will return a list describing the errors that occurred. The successfully exported
* components will still be available via document().
*
* \sa document(), errorMap()
*/
bool QVersitOrganizerExporter::exportItems(
const QList<QOrganizerItem>& items,
QVersitDocument::VersitType versitType)
{
int itemIndex = 0;
d->mErrors.clear();
d->mResult.clear();
d->mResult.setType(versitType);
d->mResult.setComponentType(QLatin1String("VCALENDAR"));
bool ok = true;
QList<QVersitDocument> results;
foreach (const QOrganizerItem& item, items) {
QVersitDocument document;
document.setType(versitType);
QVersitOrganizerExporter::Error error;
if (d->exportItem(item, &document, &error)) {
results.append(document);
} else {
d->mErrors.insert(itemIndex, error);
ok = false;
}
itemIndex++;
}
d->mResult.setSubDocuments(results);
return ok;
}
/*!
* Returns the document exported in the most recent call to exportItems().
*
* \sa exportItems()
*/
QVersitDocument QVersitOrganizerExporter::document() const
{
return d->mResult;
}
/*!
* Returns the map of errors encountered in the most recent call to exportItems(). The key is
* the index into the input list of organizer items and the value is the error that occurred on that
* item.
*
* \sa exportItems()
*/
QMap<int, QVersitOrganizerExporter::Error> QVersitOrganizerExporter::errorMap() const
{
return d->mErrors;
}
/*!
* Sets \a handler to be the handler for processing QOrganizerItemDetails, or 0 to have no handler.
*
* Does not take ownership of the handler. The client should ensure the handler remains valid for
* the lifetime of the exporter.
*
* Only one detail handler can be set. If another detail handler was previously set, it will no
* longer be associated with the exporter.
*/
void QVersitOrganizerExporter::setDetailHandler(QVersitOrganizerExporterDetailHandler* handler)
{
d->mDetailHandler = handler;
}
|
