• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.13.3 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 
26 namespace Akonadi {
27 
28 class Collection;
29 class ItemFetchJobPrivate;
30 class ItemFetchScope;
31 
82 class AKONADI_EXPORT ItemFetchJob : public Job
83 {
84  Q_OBJECT
85  Q_FLAGS(DeliveryOptions)
86  public:
93  explicit ItemFetchJob( const Collection &collection, QObject *parent = 0 );
94 
106  explicit ItemFetchJob( const Item &item, QObject *parent = 0 );
107 
120  explicit ItemFetchJob( const Item::List &items, QObject *parent = 0 );
121 
126  explicit ItemFetchJob( const QList<Item::Id> &items, QObject *parent = 0 );
127 
131  virtual ~ItemFetchJob();
132 
139  Item::List items() const;
140 
145  void clearItems();
146 
158  void setFetchScope( ItemFetchScope &fetchScope ); // KDE5: remove
159 
172  void setFetchScope( const ItemFetchScope &fetchScope );
173 
186  ItemFetchScope &fetchScope();
187 
195  void setCollection( const Collection &collection );
196 
197  enum DeliveryOption {
198  ItemGetter = 0x1,
199  EmitItemsIndividually = 0x2,
200  EmitItemsInBatches = 0x4,
201  Default = ItemGetter | EmitItemsInBatches
202  };
203  Q_DECLARE_FLAGS(DeliveryOptions, DeliveryOption)
204 
205 
209  void setDeliveryOption( DeliveryOptions options );
210 
215  DeliveryOptions deliveryOptions() const;
216 
217  Q_SIGNALS:
227  void itemsReceived( const Akonadi::Item::List &items );
228 
229  protected:
230  virtual void doStart();
231  virtual void doHandleResponse( const QByteArray &tag, const QByteArray &data );
232 
233  private:
234  Q_DECLARE_PRIVATE( ItemFetchJob )
235 
236  //@cond PRIVATE
237  Q_PRIVATE_SLOT( d_func(), void selectDone( KJob* ) )
238  Q_PRIVATE_SLOT( d_func(), void timeout() )
239  //@endcond
240 };
241 
242 }
243 
244 Q_DECLARE_OPERATORS_FOR_FLAGS(Akonadi::ItemFetchJob::DeliveryOptions)
245 
246 #endif
Akonadi::Collection
Represents a collection of PIM items.
Definition: collection.h:75
Akonadi::Job
Base class for all actions in the Akonadi storage.
Definition: job.h:86
Akonadi::ItemFetchJob::DeliveryOption
DeliveryOption
Definition: itemfetchjob.h:197
Akonadi::ItemFetchScope
Specifies which parts of an item should be fetched from the Akonadi storage.
Definition: itemfetchscope.h:68
Akonadi::ItemFetchJob
Job that fetches items from the Akonadi storage.
Definition: itemfetchjob.h:82
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Mon Jul 21 2014 08:03:53 by doxygen 1.8.6 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.13.3 API Reference

Skip menu "kdepimlibs-4.13.3 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