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
|
/*
Copyright (c) 2009 Tobias Koenig <tokoe@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library 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 Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_RECURSIVEITEMFETCHJOB_H
#define AKONADI_RECURSIVEITEMFETCHJOB_H
#include "akonadi_export.h"
#include <akonadi/item.h>
#include <kjob.h>
namespace Akonadi {
class Collection;
class ItemFetchScope;
/**
* @short Job that fetches all items of a collection recursive.
*
* This job takes a collection as argument and returns a list of
* all items that are part of the passed collection and its child
* collections. The items to fetch can be filtered by mime types and
* the parts of the items that shall be fetched can
* be specified via an ItemFetchScope.
*
* Example:
*
* @code
*
* // Assume the following Akonadi storage tree structure:
* //
* // Root Collection
* // |
* // +- Contacts
* // | |
* // | +- Private
* // | |
* // | `- Business
* // |
* // `- Events
* //
* // Collection 'Contacts' has the ID 15, then the following code
* // returns all contact items from 'Contacts', 'Private' and 'Business'.
*
* const Akonadi::Collection contactsCollection( 15 );
* const QStringList mimeTypes = QStringList() << KABC::Addressee::mimeType();
*
* Akonadi::RecursiveItemFetchJob *job = new Akonadi::RecursiveItemFetchJob( contactsCollection, mimeTypes );
* job->fetchScope().fetchFullPayload();
* connect( job, SIGNAL( result( KJob* ) ), this, SLOT( fetchResult( KJob* ) ) );
*
* job->start();
*
* ...
*
* MyClass::fetchResult( KJob *job )
* {
* Akonadi::RecursiveItemFetchJob *fetchJob = qobject_cast<Akonadi::RecursiveItemFetchJob*>( job );
* const Akonadi::Item::List items = fetchJob->items();
* // do something with the items
* }
*
* @endcode
*
* @author Tobias Koenig <tokoe@kde.org>
* @since 4.6
*/
class AKONADI_EXPORT RecursiveItemFetchJob : public KJob
{
Q_OBJECT
public:
/**
* Creates a new recursive item fetch job.
*
* @param collection The collection that shall be fetched recursive.
* @param mimeTypes The list of mime types that will be used for filtering.
* @param parent The parent object.
*/
explicit RecursiveItemFetchJob( const Akonadi::Collection &collection,
const QStringList &mimeTypes,
QObject *parent = 0 );
/**
* Destroys the recursive item fetch job.
*/
~RecursiveItemFetchJob();
/**
* Sets the item fetch scope.
*
* The ItemFetchScope controls how much of an item's data is fetched
* from the server, e.g. whether to fetch the full item payload or
* only meta data.
*
* @param fetchScope The new scope for item fetch operations.
*
* @see fetchScope()
*/
void setFetchScope( const Akonadi::ItemFetchScope &fetchScope );
/**
* Returns the item fetch scope.
*
* Since this returns a reference it can be used to conveniently modify the
* current scope in-place, i.e. by calling a method on the returned reference
* without storing it in a local variable. See the ItemFetchScope documentation
* for an example.
*
* @return a reference to the current item fetch scope
*
* @see setFetchScope() for replacing the current item fetch scope
*/
Akonadi::ItemFetchScope &fetchScope();
/**
* Returns the list of fetched items.
*/
Akonadi::Item::List items() const;
/**
* Starts the recursive item fetch job.
*/
virtual void start();
private:
//@cond PRIVATE
class Private;
Private* const d;
Q_PRIVATE_SLOT( d, void collectionFetchResult( KJob* ) )
Q_PRIVATE_SLOT( d, void itemFetchResult( KJob* ) )
//@endcond
};
}
#endif
|