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

akonadi

  • akonadi
collectionfetchscope.h
1/*
2 Copyright (c) 2008 Kevin Krammer <kevin.krammer@gmx.at>
3 Copyright (c) 2009 Volker Krause <vkrause@kde.org>
4
5 This library is free software; you can redistribute it and/or modify it
6 under the terms of the GNU Library General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or (at your
8 option) any later version.
9
10 This library is distributed in the hope that it will be useful, but WITHOUT
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13 License for more details.
14
15 You should have received a copy of the GNU Library General Public License
16 along with this library; see the file COPYING.LIB. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18 02110-1301, USA.
19*/
20
21#ifndef AKONADI_COLLECTIONFETCHSCOPE_H
22#define AKONADI_COLLECTIONFETCHSCOPE_H
23
24#include "akonadi_export.h"
25
26#include <QtCore/QSharedDataPointer>
27
28class QStringList;
29
30namespace Akonadi {
31
32class CollectionFetchScopePrivate;
33
68class AKONADI_EXPORT CollectionFetchScope
69{
70public:
74 enum AncestorRetrieval {
75 None,
76 Parent,
77 All
78 };
79
86 CollectionFetchScope();
87
91 CollectionFetchScope(const CollectionFetchScope &other);
92
96 ~CollectionFetchScope();
97
101 CollectionFetchScope &operator=(const CollectionFetchScope &other);
102
108 AKONADI_DEPRECATED bool includeUnubscribed() const;
109
117 AKONADI_DEPRECATED bool includeUnsubscribed() const;
118
125 AKONADI_DEPRECATED void setIncludeUnsubscribed(bool include);
126
132 enum ListFilter {
133 NoFilter,
134 Display,
135 Sync,
136 Index,
137 Enabled
138 };
139
147 void setListFilter(ListFilter);
148
155 ListFilter listFilter() const;
156
162 bool includeStatistics() const;
163
169 void setIncludeStatistics(bool include);
170
176 QString resource() const;
177
184 void setResource(const QString &resource);
185
192 void setContentMimeTypes(const QStringList &mimeTypes);
193
199 QStringList contentMimeTypes() const;
200
210 void setAncestorRetrieval(AncestorRetrieval ancestorDepth);
211
217 AncestorRetrieval ancestorRetrieval() const;
218
222 bool isEmpty() const;
223
224private:
225 //@cond PRIVATE
226 QSharedDataPointer<CollectionFetchScopePrivate> d;
227 //@endcond
228};
229
230}
231
232#endif
Akonadi::CollectionFetchScope
Specifies which parts of a collection should be fetched from the Akonadi storage.
Definition: collectionfetchscope.h:69
Akonadi::CollectionFetchScope::ListFilter
ListFilter
Describes the list filter.
Definition: collectionfetchscope.h:132
Akonadi::CollectionFetchScope::NoFilter
@ NoFilter
No filtering, retrieve all collections.
Definition: collectionfetchscope.h:133
Akonadi::CollectionFetchScope::Index
@ Index
Only retrieve collections for indxing, taking the local preference and enabled into account.
Definition: collectionfetchscope.h:136
Akonadi::CollectionFetchScope::Display
@ Display
Only retrieve collections for display, taking the local preference and enabled into account.
Definition: collectionfetchscope.h:134
Akonadi::CollectionFetchScope::Sync
@ Sync
Only retrieve collections for synchronization, taking the local preference and enabled into account.
Definition: collectionfetchscope.h:135
Akonadi::CollectionFetchScope::AncestorRetrieval
AncestorRetrieval
Describes the ancestor retrieval depth.
Definition: collectionfetchscope.h:74
Akonadi::CollectionFetchScope::Parent
@ Parent
Only retrieve the immediate parent collection.
Definition: collectionfetchscope.h:76
Akonadi::CollectionFetchScope::None
@ None
No ancestor retrieval at all (the default)
Definition: collectionfetchscope.h:75
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