specialcollectionsrequestjob.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_SPECIALCOLLECTIONSREQUESTJOB_H
#define AKONADI_SPECIALCOLLECTIONSREQUESTJOB_H

#include "akonadi_export.h"

#include <akonadi/collection.h>
#include <akonadi/specialcollections.h>
#include <akonadi/transactionsequence.h>

#include <QtCore/QVariant>

namespace Akonadi {

class SpecialCollectionsRequestJobPrivate;

class AKONADI_EXPORT SpecialCollectionsRequestJob : public TransactionSequence
{
  Q_OBJECT

  public:

    ~SpecialCollectionsRequestJob();

    void requestDefaultCollection( const QByteArray &type );

    void requestCollection( const QByteArray &type, const AgentInstance &instance );

    Collection collection() const;

  protected:
    explicit SpecialCollectionsRequestJob( SpecialCollections *collections, QObject *parent = 0 );

    void setDefaultResourceType( const QString &type );

    void setDefaultResourceOptions( const QVariantMap &options );

    void setTypes( const QList<QByteArray> &types );

    void setNameForTypeMap( const QMap<QByteArray, QString> &map );

    void setIconForTypeMap( const QMap<QByteArray, QString> &map );

    /* reimpl */
    virtual void doStart();
    /* reimpl */
    virtual void slotResult( KJob *job );

  private:
    //@cond PRIVATE
    friend class SpecialCollectionsRequestJobPrivate;
    friend class DefaultResourceJobPrivate;

    SpecialCollectionsRequestJobPrivate *const d;

    Q_PRIVATE_SLOT( d, void lockResult( KJob* ) )
    Q_PRIVATE_SLOT( d, void releaseLock() )
    Q_PRIVATE_SLOT( d, void resourceScanResult( KJob* ) )
    Q_PRIVATE_SLOT( d, void collectionCreateResult( KJob* ) )
    //@endcond
};

} // namespace Akonadi

#endif // AKONADI_SPECIALCOLLECTIONSREQUESTJOB_H