akonadi
agentbase.h
224 virtual void collectionAdded(const Akonadi::Collection &collection, const Akonadi::Collection &parent);
289 virtual void collectionMoved(const Akonadi::Collection &collection, const Akonadi::Collection &collectionSource,
297 virtual void collectionChanged(const Akonadi::Collection &collection, const QSet<QByteArray> &changedAttributes);
324 virtual void itemsFlagsChanged(const Akonadi::Item::List &items, const QSet<QByteArray> &addedFlags, const QSet<QByteArray> &removedFlags);
340 virtual void itemsMoved(const Akonadi::Item::List &items, const Akonadi::Collection &sourceCollection,
349 virtual void itemsLinked(const Akonadi::Item::List &items, const Akonadi::Collection &collection);
357 virtual void itemsUnlinked(const Akonadi::Item::List &items, const Akonadi::Collection &collection);
404 virtual void itemsTagsChanged(const Akonadi::Item::List &items, const QSet<Akonadi::Tag> &addedTags, const QSet<Akonadi::Tag> &removedTags);
Definition agentbase_p.h:40
BC extension of Observer with support for monitoring item and collection moves.
Definition agentbase.h:246
virtual void itemUnlinked(const Akonadi::Item &item, const Akonadi::Collection &collection)
Reimplement to handle item unlinking.
Definition agentbase.cpp:146
virtual void itemMoved(const Akonadi::Item &item, const Akonadi::Collection &collectionSource, const Akonadi::Collection &collectionDestination)
Reimplement to handle item moves.
Definition agentbase.cpp:124
virtual void collectionChanged(const Akonadi::Collection &collection, const QSet< QByteArray > &changedAttributes)
Reimplement to handle changes to existing collections.
Definition agentbase.cpp:168
virtual void collectionMoved(const Akonadi::Collection &collection, const Akonadi::Collection &collectionSource, const Akonadi::Collection &collectionDestination)
Reimplement to handle collection moves.
Definition agentbase.cpp:158
virtual void itemLinked(const Akonadi::Item &item, const Akonadi::Collection &collection)
Reimplement to handle item linking.
Definition agentbase.cpp:134
BC extension of ObserverV2 with support for batch operations.
Definition agentbase.h:311
virtual void itemsFlagsChanged(const Akonadi::Item::List &items, const QSet< QByteArray > &addedFlags, const QSet< QByteArray > &removedFlags)
Reimplement to handle changes in flags of existing items.
Definition agentbase.cpp:174
virtual void itemsLinked(const Akonadi::Item::List &items, const Akonadi::Collection &collection)
Reimplement to handle batch notifications about items linking.
Definition agentbase.cpp:214
virtual void itemsRemoved(const Akonadi::Item::List &items)
Reimplement to handle batch notification about items deletion.
Definition agentbase.cpp:202
virtual void itemsUnlinked(const Akonadi::Item::List &items, const Akonadi::Collection &collection)
Reimplement to handle batch notifications about items unlinking.
Definition agentbase.cpp:227
virtual void itemsMoved(const Akonadi::Item::List &items, const Akonadi::Collection &sourceCollection, const Akonadi::Collection &destinationCollection)
Reimplement to handle batch notification about items move.
Definition agentbase.cpp:188
Observer that adds support for item tagging.
Definition agentbase.h:370
virtual void tagChanged(const Akonadi::Tag &tag)
Reimplement to handle tags changes.
Definition agentbase.cpp:252
virtual void itemsTagsChanged(const Akonadi::Item::List &items, const QSet< Akonadi::Tag > &addedTags, const QSet< Akonadi::Tag > &removedTags)
Reimplement to handle items tagging.
Definition agentbase.cpp:276
virtual void tagAdded(const Akonadi::Tag &tag)
Reimplement to handle tags additions.
Definition agentbase.cpp:240
virtual void tagRemoved(const Akonadi::Tag &tag)
Reimplement to handle tags removal.
Definition agentbase.cpp:264
The interface for reacting on monitored or replayed changes.
Definition agentbase.h:187
virtual void collectionAdded(const Akonadi::Collection &collection, const Akonadi::Collection &parent)
Reimplement to handle adding of new collections.
Definition agentbase.cpp:99
virtual void collectionChanged(const Akonadi::Collection &collection)
Reimplement to handle changes to existing collections.
Definition agentbase.cpp:108
virtual void collectionRemoved(const Akonadi::Collection &collection)
Reimplement to handle deletion of collections.
Definition agentbase.cpp:116
virtual void itemAdded(const Akonadi::Item &item, const Akonadi::Collection &collection)
Reimplement to handle adding of new items.
Definition agentbase.cpp:73
virtual void itemChanged(const Akonadi::Item &item, const QSet< QByteArray > &partIdentifiers)
Reimplement to handle changes to existing items.
Definition agentbase.cpp:82
virtual void itemRemoved(const Akonadi::Item &item)
Reimplement to handle deletion of items.
Definition agentbase.cpp:91
void warning(const QString &message)
This signal shall be used to report warnings.
void changeProcessed()
Marks the current change as processes and replays the next change if change recording is enabled (noo...
Definition agentbase.cpp:1169
void setOnline(bool state)
Sets whether the agent shall be online or not.
void configurationDialogAccepted()
This signal is emitted whenever the user has accepted the configuration dialog.
virtual void aboutToQuit()
This method is called whenever the agent application is about to quit.
void advancedStatus(const QVariantMap &status)
This signal should be emitted whenever the status of the agent has been changed.
void setTemporaryOffline(int makeOnlineInSeconds=300)
Sets the agent offline but will make it online again after a given time.
void onlineChanged(bool online)
Emitted when the online state changed.
virtual int status() const
This method returns the current status code of the agent.
void reloadConfiguration()
Emitted if another application has changed the agent's configuration remotely and called AgentInstanc...
static KComponentData componentData()
Returns the component data object for this agent instance.
Definition agentbase.cpp:1201
virtual QString progressMessage() const
This method returns an i18n'ed description of the current progress.
WId winIdForDialogs() const
This method returns the windows id, which should be used for dialogs.
virtual void configure(WId windowId)
This method is called whenever the agent shall show its configuration dialog to the user.
void setAgentName(const QString &name)
This method is used to set the name of the agent.
Definition agentbase.cpp:1136
ChangeRecorder * changeRecorder() const
Returns the Akonadi::ChangeRecorder object used for monitoring.
Definition agentbase.cpp:1175
void status(int status, const QString &message=QString())
This signal should be emitted whenever the status of the agent has been changed.
void percent(int progress)
This signal should be emitted whenever the progress of an action in the agent (e.g.
virtual void cleanup()
This method is called when the agent is removed from the system, so it can do some cleanup stuff.
void abortRequested()
Emitted when another application has remotely asked the agent to abort its current operation.
void setNeedsNetwork(bool needsNetwork)
Sets whether the agent needs network or not.
QString identifier() const
Returns the instance identifier of this agent.
Definition agentbase.cpp:1131
virtual void doSetOnline(bool online)
This method is called whenever the online status has changed.
virtual QString statusMessage() const
This method returns an i18n'ed description of the current status code.
virtual int progress() const
This method returns the current progress of the agent in percentage.
void agentNameChanged(const QString &name)
This signal is emitted whenever the name of the agent has changed.
static int init(int argc, char **argv)
Use this method in the main function of your agent application to initialize your agent subclass.
Definition agentbase.h:443
void error(const QString &message)
This signal shall be used to report errors.
void configurationDialogRejected()
This signal is emitted whenever the user has rejected the configuration dialog.
void registerObserver(Observer *observer)
Registers the given observer for reacting on monitored or recorded changes.
Definition agentbase.cpp:1061
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.