• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 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
27namespace Akonadi {
28
29class CollectionFetchScope;
30class CollectionFetchJobPrivate;
31
53class AKONADI_EXPORT CollectionFetchJob : public Job
54{
55 Q_OBJECT
56
57public:
61 enum Type {
62 Base,
63 FirstLevel,
64 Recursive,
65 NonOverlappingRoots
66 };
67
84 explicit CollectionFetchJob(const Collection &collection, Type type = FirstLevel, QObject *parent = 0);
85
101 explicit CollectionFetchJob(const Collection::List &collections, QObject *parent = 0);
102
121 CollectionFetchJob(const Collection::List &collections, Type type, QObject *parent = 0);
122
130 explicit CollectionFetchJob(const QList<Collection::Id> &collections, Type type = Base, QObject *parent = 0);
131
135 virtual ~CollectionFetchJob();
136
140 Collection::List collections() const;
141
148 AKONADI_DEPRECATED void setResource(const QString &resource);
149
155 AKONADI_DEPRECATED void includeUnsubscribed(bool include = true);
156
164 AKONADI_DEPRECATED void includeStatistics(bool include = true);
165
178 void setFetchScope(const CollectionFetchScope &fetchScope);
179
193 CollectionFetchScope &fetchScope();
194
195Q_SIGNALS:
201 void collectionsReceived(const Akonadi::Collection::List &collections);
202
203protected:
204 virtual void doStart();
205 virtual void doHandleResponse(const QByteArray &tag, const QByteArray &data);
206
207protected Q_SLOTS:
208 //@cond PRIVATE
209 void slotResult(KJob *job);
210 //@endcond
211
212private:
213 Q_DECLARE_PRIVATE(CollectionFetchJob)
214
215 //@cond PRIVATE
216 Q_PRIVATE_SLOT(d_func(), void timeout())
217 Q_PRIVATE_SLOT(d_func(), void subJobCollectionReceived(const Akonadi::Collection::List &))
218 //@endcond
219};
220
221}
222
223#endif
Akonadi::CollectionFetchJob
Job that fetches collections from the Akonadi storage.
Definition: collectionfetchjob.h:54
Akonadi::CollectionFetchJob::Type
Type
Describes the type of fetch depth.
Definition: collectionfetchjob.h:61
Akonadi::CollectionFetchJob::Recursive
@ Recursive
List all sub-collections.
Definition: collectionfetchjob.h:64
Akonadi::CollectionFetchJob::FirstLevel
@ FirstLevel
Only list direct sub-collections of the base collection.
Definition: collectionfetchjob.h:63
Akonadi::CollectionFetchJob::Base
@ Base
Only fetch the base collection.
Definition: collectionfetchjob.h:62
Akonadi::CollectionFetchJob::collectionsReceived
void collectionsReceived(const Akonadi::Collection::List &collections)
This signal is emitted whenever the job has received collections.
Akonadi::CollectionFetchScope
Specifies which parts of a collection should be fetched from the Akonadi storage.
Definition: collectionfetchscope.h:69
Akonadi::Collection
Represents a collection of PIM items.
Definition: collection.h:76
Akonadi::Collection::List
QList< Collection > List
Describes a list of collections.
Definition: collection.h:81
Akonadi::Job
Base class for all actions in the Akonadi storage.
Definition: job.h:87
Akonadi::Job::List
QList< Job * > List
Describes a list of jobs.
Definition: job.h:97
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