collectionfetchscope.h

/*
    Copyright (c) 2008 Kevin Krammer <kevin.krammer@gmx.at>
    Copyright (c) 2009 Volker Krause <vkrause@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef AKONADI_COLLECTIONFETCHSCOPE_H
#define AKONADI_COLLECTIONFETCHSCOPE_H

#include "akonadi_export.h"

#include <QtCore/QSharedDataPointer>

class QStringList;

namespace Akonadi {

class CollectionFetchScopePrivate;

class AKONADI_EXPORT CollectionFetchScope
{
public:
    enum AncestorRetrieval {
        None, 
        Parent, 
        All 
    };

    CollectionFetchScope();

    CollectionFetchScope(const CollectionFetchScope &other);

    ~CollectionFetchScope();

    CollectionFetchScope &operator=(const CollectionFetchScope &other);

    AKONADI_DEPRECATED bool includeUnubscribed() const;

    AKONADI_DEPRECATED bool includeUnsubscribed() const;

    AKONADI_DEPRECATED void setIncludeUnsubscribed(bool include);

    enum ListFilter {
        NoFilter, 
        Display,  
        Sync,     
        Index,    
        Enabled   
    };

    void setListFilter(ListFilter);

    ListFilter listFilter() const;

    bool includeStatistics() const;

    void setIncludeStatistics(bool include);

    QString resource() const;

    void setResource(const QString &resource);

    void setContentMimeTypes(const QStringList &mimeTypes);

    QStringList contentMimeTypes() const;

    void setAncestorRetrieval(AncestorRetrieval ancestorDepth);

    AncestorRetrieval ancestorRetrieval() const;

    bool isEmpty() const;

private:
    //@cond PRIVATE
    QSharedDataPointer<CollectionFetchScopePrivate> d;
    //@endcond
};

}

#endif