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

akonadi

  • akonadi
collectionfetchjob.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_COLLECTIONFETCHJOB_H
21 #define AKONADI_COLLECTIONFETCHJOB_H
22 
23 #include "akonadi_export.h"
24 #include <akonadi/collection.h>
25 #include <akonadi/job.h>
26 
27 namespace Akonadi {
28 
29 class CollectionFetchScope;
30 class CollectionFetchJobPrivate;
31 
53 class AKONADI_EXPORT CollectionFetchJob : public Job
54 {
55  Q_OBJECT
56 
57  public:
61  enum Type
62  {
63  Base,
64  FirstLevel,
65  Recursive,
66  NonOverlappingRoots
67  };
68 
81  explicit CollectionFetchJob( const Collection &collection, Type type = FirstLevel, QObject *parent = 0 );
82 
91  explicit CollectionFetchJob( const Collection::List &collections, QObject *parent = 0 );
92 
104  CollectionFetchJob( const Collection::List &collections, Type type, QObject *parent = 0 );
105 
110  explicit CollectionFetchJob( const QList<Collection::Id> &collections, Type type = Base, QObject *parent = 0 );
111 
115  virtual ~CollectionFetchJob();
116 
120  Collection::List collections() const;
121 
128  KDE_DEPRECATED void setResource( const QString &resource );
129 
134  KDE_DEPRECATED void includeUnsubscribed( bool include = true );
135 
142  KDE_DEPRECATED void includeStatistics( bool include = true );
143 
156  void setFetchScope( const CollectionFetchScope &fetchScope );
157 
171  CollectionFetchScope &fetchScope();
172 
173  Q_SIGNALS:
179  void collectionsReceived( const Akonadi::Collection::List &collections );
180 
181  protected:
182  virtual void doStart();
183  virtual void doHandleResponse( const QByteArray &tag, const QByteArray &data );
184 
185  protected Q_SLOTS:
186  //@cond PRIVATE
187  void slotResult( KJob* job );
188  //@endcond
189 
190  private:
191  Q_DECLARE_PRIVATE( CollectionFetchJob )
192 
193  //@cond PRIVATE
194  Q_PRIVATE_SLOT( d_func(), void timeout() )
195  Q_PRIVATE_SLOT( d_func(), void subJobCollectionReceived(const Akonadi::Collection::List &) )
196  //@endcond
197 };
198 
199 }
200 
201 #endif
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Sep 24 2012 09:06:25 by doxygen 1.8.1.1 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.9.1 API Reference

Skip menu "kdepimlibs-4.9.1 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • 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