monitor.h

/*
    Copyright (c) 2006 - 2007 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_MONITOR_H
#define AKONADI_MONITOR_H

#include <akonadi/tag.h>
#include <akonadi/collection.h>
#include <akonadi/item.h>

#include <QtCore/QObject>

namespace Akonadi {

class CollectionFetchScope;
class CollectionStatistics;
class Item;
class ItemFetchScope;
class MonitorPrivate;
class Session;
class TagFetchScope;

class AKONADI_EXPORT Monitor : public QObject
{
    Q_OBJECT

public:
    enum Type {
        Collections = 1,
        Items,
        Tags
    };

    explicit Monitor(QObject *parent = 0);

    virtual ~Monitor();

    void setCollectionMonitored(const Collection &collection, bool monitored = true);

    void setItemMonitored(const Item &item, bool monitored = true);

    void setResourceMonitored(const QByteArray &resource, bool monitored = true);

    void setMimeTypeMonitored(const QString &mimetype, bool monitored = true);

    void setTagMonitored(const Tag &tag, bool monitored = true);

    void setTypeMonitored(Type type, bool monitored = true);

    void setAllMonitored(bool monitored = true);

    void ignoreSession(Session *session);

    void fetchCollection(bool enable);

    void fetchCollectionStatistics(bool enable);

    void setItemFetchScope(const ItemFetchScope &fetchScope);

    void fetchChangedOnly(bool enable);

    ItemFetchScope &itemFetchScope();

    void setCollectionFetchScope(const CollectionFetchScope &fetchScope);

    CollectionFetchScope &collectionFetchScope();

    void setTagFetchScope(const TagFetchScope &fetchScope);

    TagFetchScope &tagFetchScope();

    Collection::List collectionsMonitored() const;

    AKONADI_DEPRECATED QList<Item::Id> itemsMonitored() const;

    QVector<Item::Id> itemsMonitoredEx() const;

    int numItemsMonitored() const;

    QStringList mimeTypesMonitored() const;

    int numMimeTypesMonitored() const;

    QVector<Tag::Id> tagsMonitored() const;

    QVector<Type> typesMonitored() const;

    QList<QByteArray> resourcesMonitored() const;

    int numResourcesMonitored() const;

    bool isAllMonitored() const;

    void setSession(Akonadi::Session *session);

    Session *session() const;

    void setCollectionMoveTranslationEnabled(bool enabled);

Q_SIGNALS:
    void itemChanged(const Akonadi::Item &item, const QSet<QByteArray> &partIdentifiers);

    void itemsFlagsChanged(const Akonadi::Item::List &items, const QSet<QByteArray> &addedFlags,
                           const QSet<QByteArray> &removedFlags);

    void itemsTagsChanged(const Akonadi::Item::List &items, const QSet<Akonadi::Tag> &addedTags,
                          const QSet<Akonadi::Tag> &removedTags);

    void itemMoved(const Akonadi::Item &item, const Akonadi::Collection &collectionSource,
                   const Akonadi::Collection &collectionDestination);

    void itemsMoved(const Akonadi::Item::List &items, const Akonadi::Collection &collectionSource,
                    const Akonadi::Collection &collectionDestination);

    void itemAdded(const Akonadi::Item &item, const Akonadi::Collection &collection);

    void itemRemoved(const Akonadi::Item &item);

    void itemsRemoved(const Akonadi::Item::List &items);

    void itemLinked(const Akonadi::Item &item, const Akonadi::Collection &collection);

    void itemsLinked(const Akonadi::Item::List &items, const Akonadi::Collection &collection);

    void itemUnlinked(const Akonadi::Item &item, const Akonadi::Collection &collection);

    void itemsUnlinked(const Akonadi::Item::List &items, const Akonadi::Collection &collection);

    void collectionAdded(const Akonadi::Collection &collection, const Akonadi::Collection &parent);

    void collectionChanged(const Akonadi::Collection &collection);

    void collectionChanged(const Akonadi::Collection &collection, const QSet<QByteArray> &attributeNames);

    void collectionMoved(const Akonadi::Collection &collection, const Akonadi::Collection &source, const Akonadi::Collection &destination);

    void collectionRemoved(const Akonadi::Collection &collection);

    void collectionSubscribed(const Akonadi::Collection &collection, const Akonadi::Collection &parent);

    void collectionUnsubscribed(const Akonadi::Collection &collection);

    void collectionStatisticsChanged(Akonadi::Collection::Id id,
                                     const Akonadi::CollectionStatistics &statistics);

    void tagAdded(const Akonadi::Tag &tag);

    void tagChanged(const Akonadi::Tag &tag);

    void tagRemoved(const Akonadi::Tag &tag);

    void collectionMonitored(const Akonadi::Collection &collection, bool monitored);

    void itemMonitored(const Akonadi::Item &item, bool monitored);

    void resourceMonitored(const QByteArray &identifier, bool monitored);

    void mimeTypeMonitored(const QString &mimeType, bool monitored);

    void allMonitored(bool monitored);

    void tagMonitored(const Akonadi::Tag &tag, bool monitored);

    void typeMonitored(const Akonadi::Monitor::Type type, bool monitored);

protected:
    //@cond PRIVATE
    friend class EntityTreeModel;
    friend class EntityTreeModelPrivate;
    MonitorPrivate *d_ptr;
    explicit Monitor(MonitorPrivate *d, QObject *parent = 0);
    //@endcond

private:
    Q_DECLARE_PRIVATE(Monitor)

    //@cond PRIVATE
    Q_PRIVATE_SLOT(d_ptr, void slotSessionDestroyed(QObject *))
    Q_PRIVATE_SLOT(d_ptr, void slotStatisticsChangedFinished(KJob *))
    Q_PRIVATE_SLOT(d_ptr, void slotFlushRecentlyChangedCollections())
    Q_PRIVATE_SLOT(d_ptr, void slotNotify(const Akonadi::NotificationMessageV3::List &))
    Q_PRIVATE_SLOT(d_ptr, void dataAvailable())
    Q_PRIVATE_SLOT(d_ptr, void serverStateChanged(Akonadi::ServerManager::State))
    Q_PRIVATE_SLOT(d_ptr, void invalidateCollectionCache(qint64))
    Q_PRIVATE_SLOT(d_ptr, void invalidateItemCache(qint64))
    Q_PRIVATE_SLOT(d_ptr, void invalidateTagCache(qint64))

    friend class ResourceBasePrivate;
    //@endcond
};

}

#endif