akonadi
collectionfetchjob.h
00001 /* 00002 Copyright (c) 2006 - 2007 Volker Krause <vkrause@kde.org> 00003 00004 This library is free software; you can redistribute it and/or modify it 00005 under the terms of the GNU Library General Public License as published by 00006 the Free Software Foundation; either version 2 of the License, or (at your 00007 option) any later version. 00008 00009 This library is distributed in the hope that it will be useful, but WITHOUT 00010 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00011 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public 00012 License for more details. 00013 00014 You should have received a copy of the GNU Library General Public License 00015 along with this library; see the file COPYING.LIB. If not, write to the 00016 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 00017 02110-1301, USA. 00018 */ 00019 00020 #ifndef AKONADI_COLLECTIONFETCHJOB_H 00021 #define AKONADI_COLLECTIONFETCHJOB_H 00022 00023 #include "akonadi_export.h" 00024 #include <akonadi/collection.h> 00025 #include <akonadi/job.h> 00026 00027 namespace Akonadi { 00028 00029 class CollectionFetchScope; 00030 class CollectionFetchJobPrivate; 00031 00053 class AKONADI_EXPORT CollectionFetchJob : public Job 00054 { 00055 Q_OBJECT 00056 00057 public: 00061 enum Type 00062 { 00063 Base, 00064 FirstLevel, 00065 Recursive, 00066 NonOverlappingRoots 00067 }; 00068 00081 explicit CollectionFetchJob( const Collection &collection, Type type = FirstLevel, QObject *parent = 0 ); 00082 00091 explicit CollectionFetchJob( const Collection::List &collections, QObject *parent = 0 ); 00092 00104 CollectionFetchJob( const Collection::List &collections, Type type, QObject *parent = 0 ); 00105 00109 virtual ~CollectionFetchJob(); 00110 00114 Collection::List collections() const; 00115 00122 KDE_DEPRECATED void setResource( const QString &resource ); 00123 00128 KDE_DEPRECATED void includeUnsubscribed( bool include = true ); 00129 00136 KDE_DEPRECATED void includeStatistics( bool include = true ); 00137 00150 void setFetchScope( const CollectionFetchScope &fetchScope ); 00151 00165 CollectionFetchScope &fetchScope(); 00166 00167 Q_SIGNALS: 00173 void collectionsReceived( const Akonadi::Collection::List &collections ); 00174 00175 protected: 00176 virtual void doStart(); 00177 virtual void doHandleResponse( const QByteArray &tag, const QByteArray &data ); 00178 00179 protected Q_SLOTS: 00180 //@cond PRIVATE 00181 void slotResult( KJob* job ); 00182 //@endcond 00183 00184 private: 00185 Q_DECLARE_PRIVATE( CollectionFetchJob ) 00186 00187 //@cond PRIVATE 00188 Q_PRIVATE_SLOT( d_func(), void timeout() ) 00189 Q_PRIVATE_SLOT( d_func(), void subJobCollectionReceived(const Akonadi::Collection::List &) ) 00190 //@endcond 00191 }; 00192 00193 } 00194 00195 #endif