akonadi
Akonadi::Monitor Class Reference
Monitors an item or collection for changes. More...
#include <monitor.h>

Signals | |
void | allMonitored (bool monitored) |
void | collectionAdded (const Akonadi::Collection &collection, const Akonadi::Collection &parent) |
void | collectionChanged (const Akonadi::Collection &collection) |
void | collectionMonitored (const Akonadi::Collection &collection, bool monitored) |
void | collectionRemoved (const Akonadi::Collection &collection) |
void | collectionStatisticsChanged (Akonadi::Collection::Id id, const Akonadi::CollectionStatistics &statistics) |
void | itemAdded (const Akonadi::Item &item, const Akonadi::Collection &collection) |
void | itemChanged (const Akonadi::Item &item, const QSet< QByteArray > &partIdentifiers) |
void | itemLinked (const Akonadi::Item &item, const Akonadi::Collection &collection) |
void | itemMonitored (const Akonadi::Item &item, bool monitored) |
void | itemMoved (const Akonadi::Item &item, const Akonadi::Collection &collectionSource, const Akonadi::Collection &collectionDestination) |
void | itemRemoved (const Akonadi::Item &item) |
void | itemUnlinked (const Akonadi::Item &item, const Akonadi::Collection &collection) |
void | mimeTypeMonitored (const QString &mimeType, bool monitored) |
void | resourceMonitored (const QByteArray &identifier, bool monitored) |
Public Member Functions | |
Collection::List | collectionsMonitored () const |
void | fetchCollection (bool enable) |
void | fetchCollectionStatistics (bool enable) |
void | ignoreSession (Session *session) |
bool | isAllMonitored () const |
ItemFetchScope & | itemFetchScope () |
QList< Item::Id > | itemsMonitored () const |
QStringList | mimeTypesMonitored () const |
Monitor (QObject *parent=0) | |
QList< QByteArray > | resourcesMonitored () const |
void | setAllMonitored (bool monitored=true) |
void | setCollectionMonitored (const Collection &collection, bool monitored=true) |
void | setItemFetchScope (const ItemFetchScope &fetchScope) |
void | setItemMonitored (const Item &item, bool monitored=true) |
void | setMimeTypeMonitored (const QString &mimetype, bool monitored=true) |
void | setResourceMonitored (const QByteArray &resource, bool monitored=true) |
virtual | ~Monitor () |
Detailed Description
Monitors an item or collection for changes.The Monitor emits signals if some of these objects are changed or removed or new ones are added to the Akonadi storage.
Optionally, the changed objects can be fetched automatically from the server. To enable this, see fetchCollection(), fetchItemMetaData(), fetchItemData().
- Todo:
- : distinguish between monitoring collection properties and collection content.
: special case for collection content counts changed
Definition at line 50 of file monitor.h.
Constructor & Destructor Documentation
Monitor::Monitor | ( | QObject * | parent = 0 |
) | [explicit] |
Creates a new monitor.
- Parameters:
-
parent The parent object.
Definition at line 39 of file monitor.cpp.
Monitor::~Monitor | ( | ) | [virtual] |
Member Function Documentation
void Akonadi::Monitor::allMonitored | ( | bool | monitored | ) | [signal] |
This signal is emitted if the Monitor starts or stops monitoring everything.
- Parameters:
-
monitored Whether everything is now being monitored or not.
- Since:
- 4.3
void Akonadi::Monitor::collectionAdded | ( | const Akonadi::Collection & | collection, | |
const Akonadi::Collection & | parent | |||
) | [signal] |
This signal is emitted if a new collection has been added to a monitored collection in the Akonadi storage.
- Parameters:
-
collection The new collection. parent The parent collection.
void Akonadi::Monitor::collectionChanged | ( | const Akonadi::Collection & | collection | ) | [signal] |
This signal is emitted if a monitored collection has been changed (properties or content) or has been reparented.
- Parameters:
-
collection The changed collection.
void Akonadi::Monitor::collectionMonitored | ( | const Akonadi::Collection & | collection, | |
bool | monitored | |||
) | [signal] |
This signal is emitted if the Monitor starts or stops monitoring collection
explicitly.
- Parameters:
-
collection The collection monitored Whether the collection is now being monitored or not.
- Since:
- 4.3
void Akonadi::Monitor::collectionRemoved | ( | const Akonadi::Collection & | collection | ) | [signal] |
This signal is emitted if a monitored collection has been removed from the Akonadi storage.
- Parameters:
-
collection The removed collection.
Collection::List Monitor::collectionsMonitored | ( | ) | const |
Returns the list of collections being monitored.
- Since:
- 4.3
Definition at line 131 of file monitor.cpp.
void Akonadi::Monitor::collectionStatisticsChanged | ( | Akonadi::Collection::Id | id, | |
const Akonadi::CollectionStatistics & | statistics | |||
) | [signal] |
This signal is emitted if the statistics information of a monitored collection has changed.
- Parameters:
-
id The collection identifier of the changed collection. statistics The updated collection statistics, invalid if automatic fetching of statistics changes is disabled.
void Monitor::fetchCollection | ( | bool | enable | ) |
Enables automatic fetching of changed collections from the Akonadi storage.
- Parameters:
-
enable true
enables automatic fetching,false
disables automatic fetching.
Definition at line 111 of file monitor.cpp.
void Monitor::fetchCollectionStatistics | ( | bool | enable | ) |
Enables automatic fetching of changed collection statistics information from the Akonadi storage.
- Parameters:
-
enable true
to enables automatic fetching,false
disables automatic fetching.
Definition at line 116 of file monitor.cpp.
void Monitor::ignoreSession | ( | Session * | session | ) |
Ignores all change notifications caused by the given session.
- Parameters:
-
session The session you want to ignore.
Definition at line 106 of file monitor.cpp.
bool Monitor::isAllMonitored | ( | ) | const |
Returns true if everything is being monitored.
- Since:
- 4.3
Definition at line 151 of file monitor.cpp.
void Akonadi::Monitor::itemAdded | ( | const Akonadi::Item & | item, | |
const Akonadi::Collection & | collection | |||
) | [signal] |
This signal is emitted if an item has been added to a monitored collection in the Akonadi storage.
- Parameters:
-
item The new item. collection The collection the item has been added to.
void Akonadi::Monitor::itemChanged | ( | const Akonadi::Item & | item, | |
const QSet< QByteArray > & | partIdentifiers | |||
) | [signal] |
This signal is emitted if a monitored item has changed, e.g.
item parts have been modified.
- Parameters:
-
item The changed item. partIdentifiers The identifiers of the item parts that has been changed.
ItemFetchScope & Monitor::itemFetchScope | ( | ) |
Returns the item fetch scope.
Since this returns a reference it can be used to conveniently modify the current scope in-place, i.e. by calling a method on the returned reference without storing it in a local variable. See the ItemFetchScope documentation for an example.
- Returns:
- a reference to the current item fetch scope
- See also:
- setItemFetchScope() for replacing the current item fetch scope
Definition at line 126 of file monitor.cpp.
void Akonadi::Monitor::itemLinked | ( | const Akonadi::Item & | item, | |
const Akonadi::Collection & | collection | |||
) | [signal] |
This signal is emitted if a reference to an item is added to a virtual collection.
- Parameters:
-
item The linked item. collection The collection the item is linked to.
- Since:
- 4.2
void Akonadi::Monitor::itemMonitored | ( | const Akonadi::Item & | item, | |
bool | monitored | |||
) | [signal] |
This signal is emitted if the Monitor starts or stops monitoring item
explicitly.
- Parameters:
-
item The item monitored Whether the item is now being monitored or not.
- Since:
- 4.3
void Akonadi::Monitor::itemMoved | ( | const Akonadi::Item & | item, | |
const Akonadi::Collection & | collectionSource, | |||
const Akonadi::Collection & | collectionDestination | |||
) | [signal] |
This signal is emitted if a monitored item has been moved between two collections.
- Parameters:
-
item The moved item. collectionSource The collection the item has been moved from. collectionDestination The collection the item has been moved to.
void Akonadi::Monitor::itemRemoved | ( | const Akonadi::Item & | item | ) | [signal] |
This signal is emitted if
- a monitored item has been removed from the Akonadi storage or
- a item has been removed from a monitored collection.
- Parameters:
-
item The removed item.
QList< Item::Id > Monitor::itemsMonitored | ( | ) | const |
void Akonadi::Monitor::itemUnlinked | ( | const Akonadi::Item & | item, | |
const Akonadi::Collection & | collection | |||
) | [signal] |
This signal is emitted if a reference to an item is removed from a virtual collection.
- Parameters:
-
item The unlinked item. collection The collection the item is unlinked from.
- Since:
- 4.2
void Akonadi::Monitor::mimeTypeMonitored | ( | const QString & | mimeType, | |
bool | monitored | |||
) | [signal] |
This signal is emitted if the Monitor starts or stops monitoring mimeType
explicitly.
- Parameters:
-
mimeType The mimeType. monitored Whether the mimeType is now being monitored or not.
- Since:
- 4.3
QStringList Monitor::mimeTypesMonitored | ( | ) | const |
void Akonadi::Monitor::resourceMonitored | ( | const QByteArray & | identifier, | |
bool | monitored | |||
) | [signal] |
This signal is emitted if the Monitor starts or stops monitoring the resource with the identifier identifier
explicitly.
- Parameters:
-
identifier The identifier of the resource. monitored Whether the resource is now being monitored or not.
- Since:
- 4.3
QList< QByteArray > Monitor::resourcesMonitored | ( | ) | const |
Returns the set of identifiers for resources being monitored.
- Since:
- 4.3
Definition at line 146 of file monitor.cpp.
void Akonadi::Monitor::setAllMonitored | ( | bool | monitored = true |
) |
void Monitor::setCollectionMonitored | ( | const Collection & | collection, | |
bool | monitored = true | |||
) |
Sets whether the specified collection shall be monitored for changes.
- Parameters:
-
collection The collection to monitor. If this collection is Collection::root(), all collections in the Akonadi storage will be monitored.
Definition at line 59 of file monitor.cpp.
void Monitor::setItemFetchScope | ( | const ItemFetchScope & | fetchScope | ) |
Sets the item fetch scope.
Controls how much of an item's data is fetched from the server, e.g. whether to fetch the full item payload or only meta data.
- Parameters:
-
fetchScope The new scope for item fetch operations.
- See also:
- itemFetchScope()
Definition at line 121 of file monitor.cpp.
void Monitor::setItemMonitored | ( | const Item & | item, | |
bool | monitored = true | |||
) |
Sets whether the specified item shall be monitored for changes.
- Parameters:
-
item The item to monitor.
Definition at line 69 of file monitor.cpp.
void Monitor::setMimeTypeMonitored | ( | const QString & | mimetype, | |
bool | monitored = true | |||
) |
Sets whether objects of the specified mime type shall be monitored for changes.
- Parameters:
-
mimetype The mime type to monitor.
Definition at line 89 of file monitor.cpp.
void Monitor::setResourceMonitored | ( | const QByteArray & | resource, | |
bool | monitored = true | |||
) |
Sets whether the specified resource shall be monitored for changes.
- Parameters:
-
resource The resource identifier.
Definition at line 79 of file monitor.cpp.
The documentation for this class was generated from the following files: