kde-playground/kdepimlibs/akonadi/specialcollectionsdiscoveryjob.h
2015-04-14 21:49:29 +00:00

77 lines
2.2 KiB
C++

/*
Copyright (c) 2013 David Faure <faure@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_SPECIALCOLLECTIONSDISCOVERYJOB_H
#define AKONADI_SPECIALCOLLECTIONSDISCOVERYJOB_H
#include "akonadi_export.h"
#include <kcompositejob.h>
#include <akonadi/collection.h>
#include <akonadi/specialcollections.h>
namespace Akonadi {
class SpecialCollectionsDiscoveryJobPrivate;
/**
* @short A job to discover all SpecialCollections.
*
* The collections get registered into SpecialCollections.
*
* This class is not meant to be used directly but as a base class for type
* specific special collection request jobs.
*
* @author David Faure <faure@kde.org>
* @since 4.11
*/
class AKONADI_EXPORT SpecialCollectionsDiscoveryJob : public KCompositeJob
{
Q_OBJECT
public:
/**
* Destroys the special collections request job.
*/
~SpecialCollectionsDiscoveryJob();
virtual void start();
protected:
/**
* Creates a new special collections request job.
*
* @param collections The SpecialCollections object that shall be used.
* @param parent The parent object.
*/
explicit SpecialCollectionsDiscoveryJob(SpecialCollections *collections, const QStringList &mimeTypes, QObject *parent = 0);
/* reimpl */
virtual void slotResult(KJob *job);
private:
//@cond PRIVATE
SpecialCollectionsDiscoveryJobPrivate *const d;
//@endcond
};
} // namespace Akonadi
#endif // AKONADI_SPECIALCOLLECTIONSDISCOVERYJOB_H