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

akonadi

  • akonadi
itemfetchscope.h
1 /*
2  Copyright (c) 2008 Kevin Krammer <kevin.krammer@gmx.at>
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 ITEMFETCHSCOPE_H
21 #define ITEMFETCHSCOPE_H
22 
23 #include "akonadi_export.h"
24 
25 #include <QtCore/QSharedDataPointer>
26 
27 class QStringList;
28 template <typename T> class QSet;
29 
30 namespace Akonadi {
31 
32 class ItemFetchScopePrivate;
33 
67 class AKONADI_EXPORT ItemFetchScope
68 {
69  public:
74  enum AncestorRetrieval {
75  None,
76  Parent,
77  All
78  };
79 
86  ItemFetchScope();
87 
91  ItemFetchScope( const ItemFetchScope &other );
92 
96  ~ItemFetchScope();
97 
101  ItemFetchScope &operator=( const ItemFetchScope &other );
102 
108  QSet<QByteArray> payloadParts() const;
109 
117  void fetchPayloadPart( const QByteArray &part, bool fetch = true );
118 
124  bool fullPayload() const;
125 
132  void fetchFullPayload( bool fetch = true );
133 
141  QSet<QByteArray> attributes() const;
142 
149  void fetchAttribute( const QByteArray &type, bool fetch = true );
150 
156  template <typename T> inline void fetchAttribute( bool fetch = true )
157  {
158  T dummy;
159  fetchAttribute( dummy.type(), fetch );
160  }
161 
167  bool allAttributes() const;
168 
175  void fetchAllAttributes( bool fetch = true );
176 
183  bool cacheOnly() const;
184 
192  void setCacheOnly( bool cacheOnly );
193 
201  void setAncestorRetrieval( AncestorRetrieval ancestorDepth );
202 
209  AncestorRetrieval ancestorRetrieval() const;
210 
218  void setFetchModificationTime( bool retrieveMtime );
219 
226  bool fetchModificationTime() const;
227 
239  void setIgnoreRetrievalErrors( bool enabled );
240 
247  bool ignoreRetrievalErrors() const;
248 
252  bool isEmpty() const;
253 
254  private:
255  //@cond PRIVATE
256  QSharedDataPointer<ItemFetchScopePrivate> d;
257  //@endcond
258 };
259 
260 }
261 
262 #endif
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:27:38 by doxygen 1.8.3.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.10.5 API Reference

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