• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • akonadi
itemfetchjob.h
1/*
2 Copyright (c) 2006 - 2007 Volker Krause <vkrause@kde.org>
3
4 This library is free software; you can redistribute it and/or modify it
5 under the terms of the GNU Library General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or (at your
7 option) any later version.
8
9 This library is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to the
16 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 02110-1301, USA.
18*/
19
20#ifndef AKONADI_ITEMFETCHJOB_H
21#define AKONADI_ITEMFETCHJOB_H
22
23#include <akonadi/item.h>
24#include <akonadi/job.h>
25
26namespace Akonadi {
27
28class Collection;
29class ItemFetchJobPrivate;
30class ItemFetchScope;
31
82class AKONADI_EXPORT ItemFetchJob : public Job
83{
84 Q_OBJECT
85 Q_FLAGS(DeliveryOptions)
86public:
93 explicit ItemFetchJob(const Collection &collection, QObject *parent = 0);
94
111 explicit ItemFetchJob(const Item &item, QObject *parent = 0);
112
130 explicit ItemFetchJob(const Item::List &items, QObject *parent = 0);
131
136 explicit ItemFetchJob(const QList<Item::Id> &items, QObject *parent = 0);
137
138
147 explicit ItemFetchJob(const Tag &tag, QObject *parent = 0);
148
152 virtual ~ItemFetchJob();
153
162 Item::List items() const;
163
168 void clearItems();
169
181 void setFetchScope(ItemFetchScope &fetchScope); // KDE5: remove
182
195 void setFetchScope(const ItemFetchScope &fetchScope);
196
209 ItemFetchScope &fetchScope();
210
220 void setCollection(const Collection &collection);
221
222 enum DeliveryOption {
223 ItemGetter = 0x1,
224 EmitItemsIndividually = 0x2,
225 EmitItemsInBatches = 0x4,
226 Default = ItemGetter | EmitItemsInBatches
227 };
228 Q_DECLARE_FLAGS(DeliveryOptions, DeliveryOption)
229
230
234 void setDeliveryOption(DeliveryOptions options);
235
240 DeliveryOptions deliveryOptions() const;
241
247 int count() const;
248
249Q_SIGNALS:
259 void itemsReceived(const Akonadi::Item::List &items);
260
261protected:
262 virtual void doStart();
263 virtual void doHandleResponse(const QByteArray &tag, const QByteArray &data);
264
265private:
266 Q_DECLARE_PRIVATE(ItemFetchJob)
267
268 //@cond PRIVATE
269 Q_PRIVATE_SLOT(d_func(), void timeout())
270 //@endcond
271};
272
273}
274
275Q_DECLARE_OPERATORS_FOR_FLAGS(Akonadi::ItemFetchJob::DeliveryOptions)
276
277#endif
Akonadi::Collection
Represents a collection of PIM items.
Definition: collection.h:76
Akonadi::ItemFetchJob
Job that fetches items from the Akonadi storage.
Definition: itemfetchjob.h:83
Akonadi::ItemFetchJob::ItemFetchJob
ItemFetchJob(const Item::List &items, QObject *parent=0)
Creates a new item fetch job that retrieves the specified items.
Akonadi::ItemFetchJob::ItemFetchJob
ItemFetchJob(const QList< Item::Id > &items, QObject *parent=0)
Convenience ctor equivalent to ItemFetchJob(const Item::List &items, QObject *parent = 0)
Akonadi::ItemFetchJob::itemsReceived
void itemsReceived(const Akonadi::Item::List &items)
This signal is emitted whenever new items have been fetched completely.
Akonadi::ItemFetchJob::DeliveryOption
DeliveryOption
Definition: itemfetchjob.h:222
Akonadi::ItemFetchScope
Specifies which parts of an item should be fetched from the Akonadi storage.
Definition: itemfetchscope.h:70
Akonadi::Job
Base class for all actions in the Akonadi storage.
Definition: job.h:87
Akonadi::Tag
An Akonadi Tag.
Definition: tag.h:44
Akonadi
FreeBusyManager::Singleton.
Definition: actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal