akonadi
collectionfetchscope.h
00001 /* 00002 Copyright (c) 2008 Kevin Krammer <kevin.krammer@gmx.at> 00003 Copyright (c) 2009 Volker Krause <vkrause@kde.org> 00004 00005 This library is free software; you can redistribute it and/or modify it 00006 under the terms of the GNU Library General Public License as published by 00007 the Free Software Foundation; either version 2 of the License, or (at your 00008 option) any later version. 00009 00010 This library is distributed in the hope that it will be useful, but WITHOUT 00011 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00012 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public 00013 License for more details. 00014 00015 You should have received a copy of the GNU Library General Public License 00016 along with this library; see the file COPYING.LIB. If not, write to the 00017 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 00018 02110-1301, USA. 00019 */ 00020 00021 #ifndef AKONADI_COLLECTIONFETCHSCOPE_H 00022 #define AKONADI_COLLECTIONFETCHSCOPE_H 00023 00024 #include "akonadi_export.h" 00025 00026 #include <QtCore/QSharedDataPointer> 00027 00028 class QStringList; 00029 00030 namespace Akonadi { 00031 00032 class CollectionFetchScopePrivate; 00033 00066 class AKONADI_EXPORT CollectionFetchScope 00067 { 00068 public: 00072 enum AncestorRetrieval { 00073 None, 00074 Parent, 00075 All 00076 }; 00077 00084 CollectionFetchScope(); 00085 00089 CollectionFetchScope( const CollectionFetchScope &other ); 00090 00094 ~CollectionFetchScope(); 00095 00099 CollectionFetchScope &operator=( const CollectionFetchScope &other ); 00100 00106 KDE_DEPRECATED bool includeUnubscribed() const; 00107 00114 bool includeUnsubscribed() const; 00115 00121 void setIncludeUnsubscribed( bool include ); 00122 00128 bool includeStatistics() const; 00129 00135 void setIncludeStatistics( bool include ); 00136 00142 QString resource() const; 00143 00150 void setResource( const QString &resource ); 00151 00158 void setContentMimeTypes( const QStringList &mimeTypes ); 00159 00165 QStringList contentMimeTypes() const; 00166 00176 void setAncestorRetrieval( AncestorRetrieval ancestorDepth ); 00177 00183 AncestorRetrieval ancestorRetrieval() const; 00184 00188 bool isEmpty() const; 00189 00190 private: 00191 //@cond PRIVATE 00192 QSharedDataPointer<CollectionFetchScopePrivate> d; 00193 //@endcond 00194 }; 00195 00196 } 00197 00198 #endif