KDE API Referenceakonadi
#include <specialcollections.h>
Signals | |
| void | collectionsChanged (const Akonadi::AgentInstance &instance) |
| void | defaultCollectionsChanged () |
Public Member Functions | |
| ~SpecialCollections () | |
| Akonadi::Collection | collection (const QByteArray &type, const AgentInstance &instance) const |
| Akonadi::Collection | defaultCollection (const QByteArray &type) const |
| bool | hasCollection (const QByteArray &type, const AgentInstance &instance) const |
| bool | hasDefaultCollection (const QByteArray &type) const |
| bool | registerCollection (const QByteArray &type, const Akonadi::Collection &collection) |
| bool | unregisterCollection (const Collection &collection) |
Static Public Member Functions | |
| static void | setSpecialCollectionType (const QByteArray &type, const Akonadi::Collection &collection) |
| static void | unsetSpecialCollection (const Akonadi::Collection &collection) |
Protected Member Functions | |
| SpecialCollections (KCoreConfigSkeleton *config, QObject *parent=0) | |
Detailed Description
An interface to special collections.
This class is the central interface to special collections like inbox or outbox in a mail resource or recent contacts in a contacts resource. The class is not meant to be used directly, but to inherit the a type specific special collections class from it (e.g. SpecialMailCollections).
To check whether a special collection is available, simply use the hasCollection() and hasDefaultCollection() methods. Available special collections are accessible through the collection() and defaultCollection() methods.
To create a special collection, use a SpecialCollectionsRequestJob. This will create the special collections you request and automatically register them with SpecialCollections, so that it now knows they are available.
This class monitors all special collections known to it, and removes it from the known list if they are deleted. Note that this class does not automatically rebuild the collections that disappeared.
The defaultCollectionsChanged() and collectionsChanged() signals are emitted when the special collections for a resource change (i.e. some became available or some become unavailable).
- Since
- 4.4
Definition at line 65 of file specialcollections.h.
Constructor & Destructor Documentation
| SpecialCollections::~SpecialCollections | ( | ) |
Destroys the special collections object.
Definition at line 189 of file specialcollections.cpp.
|
explicitprotected |
Creates a new special collections object.
- Parameters
-
config The configuration skeleton that provides the default resource id. parent The parent object.
Definition at line 183 of file specialcollections.cpp.
Member Function Documentation
| Akonadi::Collection SpecialCollections::collection | ( | const QByteArray & | type, |
| const AgentInstance & | instance | ||
| ) | const |
Returns the special collection of the given type in the given agent instance, or an invalid collection if such a collection is unknown.
Definition at line 199 of file specialcollections.cpp.
|
signal |
Emitted when the special collections for a resource have been changed (for example, some become available, or some become unavailable).
- Parameters
-
instance The instance of the resource the collection belongs to.
| Akonadi::Collection SpecialCollections::defaultCollection | ( | const QByteArray & | type | ) | const |
Returns the special collection of given type in the default resource, or an invalid collection if such a collection is unknown.
Definition at line 277 of file specialcollections.cpp.
|
signal |
Emitted when the special collections for the default resource have been changed (for example, some become available, or some become unavailable).
| bool SpecialCollections::hasCollection | ( | const QByteArray & | type, |
| const AgentInstance & | instance | ||
| ) | const |
Returns whether the given agent instance has a special collection of the given type.
Definition at line 194 of file specialcollections.cpp.
| bool SpecialCollections::hasDefaultCollection | ( | const QByteArray & | type | ) | const |
Returns whether the default resource has a special collection of the given type.
Definition at line 272 of file specialcollections.cpp.
| bool SpecialCollections::registerCollection | ( | const QByteArray & | type, |
| const Akonadi::Collection & | collection | ||
| ) |
Registers the given collection as a special collection with the given type.
- Parameters
-
type the special type of collectioncollection the given collection to register The collection must be owned by a valid resource. Registering a new collection of a previously registered type forgets the old collection.
Definition at line 244 of file specialcollections.cpp.
|
static |
Sets the special collection attribute which marks collection as being a special collection of type type.
This is typically used by configuration dialog for resources, when the user can choose a specific special collection (ex: IMAP trash).
- Since
- 4.11
Definition at line 204 of file specialcollections.cpp.
| bool SpecialCollections::unregisterCollection | ( | const Collection & | collection | ) |
Unregisters the given collection as a spec ial collection.
- Parameters
-
type the special type of collection
- Since
- 4.12
Definition at line 223 of file specialcollections.cpp.
|
static |
unsets the special collection attribute which marks collection as being a special collection.
- Since
- 4.12
Definition at line 214 of file specialcollections.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:00:29 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
