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
|
/*
* annotationjobs.h
*
* Copyright (c) 2004 David Faure <faure@kde.org>
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* In addition, as a special exception, the copyright holders give
* permission to link the code of this program with any edition of
* the Qt library by Trolltech AS, Norway (or with modified versions
* of Qt that use the same license as Qt), and distribute linked
* combinations including the two. You must obey the GNU General
* Public License in all respects for all of the code used other than
* Qt. If you modify this file, you may extend this exception to
* your version of the file, but you are not obligated to do so. If
* you do not wish to do so, delete this exception statement from
* your version.
*/
#ifndef ANNOTATIONJOBS_H
#define ANNOTATIONJOBS_H
#include <kio/job.h>
#include <qvaluevector.h>
namespace KMail {
/// One entry in the annotation list: attribute name and attribute value
struct AnnotationAttribute {
AnnotationAttribute() {} // for QValueVector
AnnotationAttribute( const QString& e, const QString& n, const QString& v )
: entry( e ), name( n ), value( v ) {}
QString entry; // e.g. /comment
QString name; // e.g. value.shared
QString value;
};
typedef QValueVector<AnnotationAttribute> AnnotationList;
/**
* This namespace contains functions that return jobs for annotation operations.
*
* The current implementation is tied to IMAP.
* If someone wants to extend this to other protocols, turn the namespace into a class
* and use virtual methods.
*/
namespace AnnotationJobs {
/**
* Set an annotation entry (note that it can have multiple attributes)
* @param slave Slave object the job should be assigned to
* @param url URL for the annotation
* @param entry the name of the annotation entry
* @param attributes attribute name+value pairs
*/
KIO::SimpleJob* setAnnotation( KIO::Slave* slave, const KURL& url, const QString& entry,
const QMap<QString,QString>& attributes );
class MultiSetAnnotationJob;
/**
* Set multiple annotation entries
*/
MultiSetAnnotationJob* multiSetAnnotation( KIO::Slave* slave, const KURL& url, const AnnotationList& annotations );
class GetAnnotationJob;
/**
* Get an annotation entry
* @param slave Slave object the job should be assigned to
* @param url URL for the annotation
* @param entry the name of the annotation entry
* @param attributes attribute names
*/
GetAnnotationJob* getAnnotation( KIO::Slave* slave, const KURL& url, const QString& entry,
const QStringList& attributes );
class MultiGetAnnotationJob;
/**
* Get multiple annotation entries
* Currently we assume we want to get the "value" for each, to simplify the data structure.
*/
MultiGetAnnotationJob* multiGetAnnotation( KIO::Slave* slave, const KURL& url, const QStringList& entries );
class MultiUrlGetAnnotationJob;
/**
* Get annotation entries for multiple folders.
* @param paths The paths to get the annotation for
* @param annotation The annotation to get
*/
MultiUrlGetAnnotationJob* multiUrlGetAnnotation( KIO::Slave* slave,
const KURL& baseUrl,
const QStringList& paths,
const QString& annotation );
/// for getAnnotation()
class GetAnnotationJob : public KIO::SimpleJob
{
Q_OBJECT
public:
GetAnnotationJob( const KURL& url, const QString& entry, const QByteArray &packedArgs,
bool showProgressInfo );
const AnnotationList& annotations() const { return mAnnotations; }
protected slots:
void slotInfoMessage( KIO::Job*, const QString& );
private:
AnnotationList mAnnotations;
QString mEntry;
};
/// for multiGetAnnotation
class MultiGetAnnotationJob : public KIO::Job
{
Q_OBJECT
public:
MultiGetAnnotationJob( KIO::Slave* slave, const KURL& url, const QStringList& entries, bool showProgressInfo );
signals:
// Emitted when a given annotation was found - or not found
void annotationResult( const QString& entry, const QString& value, bool found );
protected slots:
virtual void slotStart();
virtual void slotResult( KIO::Job *job );
private:
KIO::Slave* mSlave;
const KURL mUrl;
const QStringList mEntryList;
QStringList::const_iterator mEntryListIterator;
};
/// for multiUrlGetAnnotation
class MultiUrlGetAnnotationJob : public KIO::Job
{
Q_OBJECT
public:
MultiUrlGetAnnotationJob( KIO::Slave* slave, const KURL& baseUrl,
const QStringList& paths, const QString& annotation );
QMap<QString, QString> annotations() const;
protected slots:
virtual void slotStart();
virtual void slotResult( KIO::Job *job );
private:
KIO::Slave* mSlave;
const KURL mUrl;
const QStringList mPathList;
QStringList::const_iterator mPathListIterator;
QString mAnnotation;
QMap<QString, QString> mAnnotations;
};
/// for multiSetAnnotation
class MultiSetAnnotationJob : public KIO::Job
{
Q_OBJECT
public:
MultiSetAnnotationJob( KIO::Slave* slave, const KURL& url, const AnnotationList& annotations, bool showProgressInfo );
signals:
// Emitted when a given annotation was successfully changed
void annotationChanged( const QString& entry, const QString& attribute, const QString& value );
protected slots:
virtual void slotStart();
virtual void slotResult( KIO::Job *job );
private:
KIO::Slave* mSlave;
const KURL mUrl;
const AnnotationList mAnnotationList;
AnnotationList::const_iterator mAnnotationListIterator;
};
} // AnnotationJobs namespace
} // KMail namespace
#endif /* ANNOTATIONJOBS_H */
|
