akonadi
Akonadi::SpecialCollectionsRequestJob Class Reference
A job to request SpecialCollections. More...
#include <specialcollectionsrequestjob.h>

Public Member Functions | |
~SpecialCollectionsRequestJob () | |
Collection | collection () const |
void | requestCollection (const QByteArray &type, const AgentInstance &instance) |
void | requestDefaultCollection (const QByteArray &type) |
Protected Member Functions | |
SpecialCollectionsRequestJob (SpecialCollections *collections, QObject *parent=0) | |
virtual void | doStart () |
void | setDefaultResourceOptions (const QVariantMap &options) |
void | setDefaultResourceType (const QString &type) |
void | setIconForTypeMap (const QMap< QByteArray, QString > &map) |
void | setNameForTypeMap (const QMap< QByteArray, QString > &map) |
void | setTypes (const QList< QByteArray > &types) |
virtual void | slotResult (KJob *job) |
Detailed Description
A job to request SpecialCollections.
Use this job to request the SpecialCollections you need. You can request both default SpecialCollections and SpecialCollections in a given resource. The default SpecialCollections resource is created when the first default SpecialCollection is requested, but if a SpecialCollection in a custom resource is requested, this job expects that resource to exist already.
If the folders you requested already exist, this job simply succeeds. Otherwise, it creates the required collections and registers them with SpecialCollections.
This class is not meant to be used directly but as a base class for type specific special collection request jobs.
- Since:
- 4.4
Definition at line 54 of file specialcollectionsrequestjob.h.
Constructor & Destructor Documentation
SpecialCollectionsRequestJob::~SpecialCollectionsRequestJob | ( | ) |
Destroys the special collections request job.
Definition at line 283 of file specialcollectionsrequestjob.cpp.
SpecialCollectionsRequestJob::SpecialCollectionsRequestJob | ( | SpecialCollections * | collections, | |
QObject * | parent = 0 | |||
) | [explicit, protected] |
Creates a new special collections request job.
- Parameters:
-
collections The SpecialCollections object that shall be used. parent The parent object.
Definition at line 277 of file specialcollectionsrequestjob.cpp.
Member Function Documentation
Collection SpecialCollectionsRequestJob::collection | ( | ) | const |
Returns the requested collection.
Definition at line 307 of file specialcollectionsrequestjob.cpp.
void SpecialCollectionsRequestJob::doStart | ( | ) | [protected, virtual] |
This method must be reimplemented in the concrete jobs.
It will be called after the job has been started and a connection to the Akonadi backend has been established.
Reimplemented from Akonadi::TransactionSequence.
Definition at line 340 of file specialcollectionsrequestjob.cpp.
void SpecialCollectionsRequestJob::requestCollection | ( | const QByteArray & | type, | |
const AgentInstance & | instance | |||
) |
Requests a special collection of the given type
in the given resource instance
.
Definition at line 295 of file specialcollectionsrequestjob.cpp.
void SpecialCollectionsRequestJob::requestDefaultCollection | ( | const QByteArray & | type | ) |
Requests a special collection of the given type
in the default resource.
Definition at line 288 of file specialcollectionsrequestjob.cpp.
void SpecialCollectionsRequestJob::setDefaultResourceOptions | ( | const QVariantMap & | options | ) | [protected] |
Sets the configuration options
that shall be applied to the new resource that is created if the requested special collection does not exist yet.
Definition at line 320 of file specialcollectionsrequestjob.cpp.
void SpecialCollectionsRequestJob::setDefaultResourceType | ( | const QString & | type | ) | [protected] |
Sets the type
of the resource that shall be created if the requested special collection does not exist yet.
Definition at line 315 of file specialcollectionsrequestjob.cpp.
void SpecialCollectionsRequestJob::setIconForTypeMap | ( | const QMap< QByteArray, QString > & | map | ) | [protected] |
Sets the map
of special collection types to icon names.
Definition at line 335 of file specialcollectionsrequestjob.cpp.
void SpecialCollectionsRequestJob::setNameForTypeMap | ( | const QMap< QByteArray, QString > & | map | ) | [protected] |
Sets the map
of special collection types to display names.
Definition at line 330 of file specialcollectionsrequestjob.cpp.
void SpecialCollectionsRequestJob::setTypes | ( | const QList< QByteArray > & | types | ) | [protected] |
Sets the list of well known special collection types
.
Definition at line 325 of file specialcollectionsrequestjob.cpp.
The documentation for this class was generated from the following files: