specialcollections.h

/*
    Copyright (c) 2009 Constantin Berzan <exit3219@gmail.com>

    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_SPECIALCOLLECTIONS_H
#define AKONADI_SPECIALCOLLECTIONS_H

#include "akonadi_export.h"

#include <QtCore/QObject>

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

class KCoreConfigSkeleton;
class KJob;

namespace Akonadi {

class AgentInstance;
class SpecialCollectionsPrivate;

class AKONADI_EXPORT SpecialCollections : public QObject
{
  Q_OBJECT

  public:
    ~SpecialCollections();

    bool hasCollection( const QByteArray &type, const AgentInstance &instance ) const;

    Akonadi::Collection collection( const QByteArray &type, const AgentInstance &instance ) const;

    bool registerCollection( const QByteArray &type, const Akonadi::Collection &collection );

    bool unregisterCollection( const Collection &collection );

    static void unsetSpecialCollection(const Akonadi::Collection &collection);

    static void setSpecialCollectionType(const QByteArray &type, const Akonadi::Collection &collection);

    bool hasDefaultCollection( const QByteArray &type ) const;

    Akonadi::Collection defaultCollection( const QByteArray &type ) const;

  Q_SIGNALS:
    void collectionsChanged( const Akonadi::AgentInstance &instance );

    void defaultCollectionsChanged();

  protected:
    explicit SpecialCollections( KCoreConfigSkeleton *config, QObject *parent = 0 );

  private:
    //@cond PRIVATE
    friend class SpecialCollectionsRequestJob;
    friend class SpecialCollectionsRequestJobPrivate;
    friend class SpecialCollectionsPrivate;

#if 1 // TODO do this only if building tests:
    friend class SpecialMailCollectionsTesting;
    friend class LocalFoldersTest;
#endif

    SpecialCollectionsPrivate *const d;

    Q_PRIVATE_SLOT( d, void collectionRemoved( const Akonadi::Collection& ) )
    Q_PRIVATE_SLOT( d, void collectionStatisticsChanged( Akonadi::Collection::Id, const Akonadi::CollectionStatistics& ) )
    Q_PRIVATE_SLOT( d, void collectionFetchJobFinished( KJob* ) )
    //@endcond
};

} // namespace Akonadi

#endif // AKONADI_SPECIALCOLLECTIONS_H