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

akonadi

  • akonadi
specialcollections.h
1 /*
2  Copyright (c) 2009 Constantin Berzan <exit3219@gmail.com>
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_SPECIALCOLLECTIONS_H
21 #define AKONADI_SPECIALCOLLECTIONS_H
22 
23 #include "akonadi_export.h"
24 
25 #include <QtCore/QObject>
26 
27 #include "akonadi/collection.h"
28 #include <akonadi/item.h>
29 
30 class KCoreConfigSkeleton;
31 class KJob;
32 
33 namespace Akonadi {
34 
35 class AgentInstance;
36 class SpecialCollectionsPrivate;
37 
65 class AKONADI_EXPORT SpecialCollections : public QObject
66 {
67  Q_OBJECT
68 
69  public:
73  ~SpecialCollections();
74 
79  bool hasCollection( const QByteArray &type, const AgentInstance &instance ) const;
80 
85  Akonadi::Collection collection( const QByteArray &type, const AgentInstance &instance ) const;
86 
96  bool registerCollection( const QByteArray &type, const Akonadi::Collection &collection );
97 
106  static void setSpecialCollectionType(const QByteArray &type, const Akonadi::Collection &collection);
107 
112  bool hasDefaultCollection( const QByteArray &type ) const;
113 
118  Akonadi::Collection defaultCollection( const QByteArray &type ) const;
119 
120  Q_SIGNALS:
127  void collectionsChanged( const Akonadi::AgentInstance &instance );
128 
133  void defaultCollectionsChanged();
134 
135  protected:
142  explicit SpecialCollections( KCoreConfigSkeleton *config, QObject *parent = 0 );
143 
144  private:
145  //@cond PRIVATE
146  friend class SpecialCollectionsRequestJob;
147  friend class SpecialCollectionsRequestJobPrivate;
148  friend class SpecialCollectionsPrivate;
149 
150 #if 1 // TODO do this only if building tests:
151  friend class SpecialMailCollectionsTesting;
152  friend class LocalFoldersTest;
153 #endif
154 
155  SpecialCollectionsPrivate *const d;
156 
157  Q_PRIVATE_SLOT( d, void collectionRemoved( const Akonadi::Collection& ) )
158  Q_PRIVATE_SLOT( d, void collectionStatisticsChanged( Akonadi::Collection::Id, const Akonadi::CollectionStatistics& ) )
159  Q_PRIVATE_SLOT( d, void collectionFetchJobFinished( KJob* ) )
160  //@endcond
161 };
162 
163 } // namespace Akonadi
164 
165 #endif // AKONADI_SPECIALCOLLECTIONS_H
Akonadi::SpecialCollectionsPrivate
Definition: specialcollections_p.h:44
Akonadi::SpecialCollections
An interface to special collections.
Definition: specialcollections.h:65
Akonadi::CollectionStatistics
Provides statistics information of a Collection.
Definition: collectionstatistics.h:69
Akonadi::Collection
Represents a collection of PIM items.
Definition: collection.h:75
Akonadi::Entity::Id
qint64 Id
Describes the unique id type.
Definition: entity.h:64
Akonadi::SpecialMailCollectionsTesting
Definition: specialmailcollectionstesting_p.h:33
Akonadi::AgentInstance
A representation of an agent instance.
Definition: agentinstance.h:62
Akonadi::SpecialCollectionsRequestJob
A job to request SpecialCollections.
Definition: specialcollectionsrequestjob.h:54
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:03:19 by doxygen 1.8.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.11.3 API Reference

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