akonadi
#include <trashjob.h>

Public Member Functions | |
TrashJob (const Collection &collection, QObject *parent=0) | |
TrashJob (const Item &item, QObject *parent=0) | |
TrashJob (const Item::List &items, QObject *parent=0) | |
void | deleteIfInTrash (bool enable) |
Item::List | items () const |
void | keepTrashInCollection (bool enable) |
void | setTrashCollection (const Collection &trashcollection) |
![]() | |
Job (QObject *parent=0) | |
virtual | ~Job () |
virtual QString | errorString () const |
void | start () |
Protected Member Functions | |
virtual void | doStart () |
![]() | |
virtual bool | addSubjob (KJob *job) |
virtual void | doHandleResponse (const QByteArray &tag, const QByteArray &data) |
virtual bool | doKill () |
virtual void | doStart ()=0 |
void | emitWriteFinished () |
virtual bool | removeSubjob (KJob *job) |
Additional Inherited Members | |
![]() | |
enum | Error { ConnectionFailed = UserDefinedError , ProtocolVersionMismatch , UserCanceled , Unknown , UserError = UserDefinedError + 42 } |
typedef QList< Job * > | List |
![]() | |
void | aboutToStart (Akonadi::Job *job) |
void | writeFinished (Akonadi::Job *job) |
![]() | |
virtual void | slotResult (KJob *job) |
Detailed Description
Job that moves items/collection to trash.
This job marks the given entites as trash and moves them to a given trash collection, if available.
Priorities of trash collections are the following:
- keepTrashInCollection()
- setTrashCollection()
- configured collection in TrashSettings
- keep in collection if nothing is configured
If the item is already marked as trash, it will be deleted instead only if deleteIfInTrash() is set. The entity is marked as trash with the EntityDeletedAttribute.
The restore collection in the EntityDeletedAttribute is set the following way: -If entites are not moved to trash -> no restore collection -If collection is deleted -> also subentites get collection.parentCollection as restore collection -If multiple items are deleted -> all items get their parentCollection as restore collection
Example:
- Since
- 4.8
Definition at line 66 of file trashjob.h.
Constructor & Destructor Documentation
◆ TrashJob() [1/3]
|
explicit |
Creates a new trash job that marks item
as trash, and moves it to the configured trash collection.
If keepTrashInCollection
is set, the item will not be moved to the configured trash collection.
- Parameters
-
item The item to mark as trash. parent The parent object.
Definition at line 297 of file trashjob.cpp.
◆ TrashJob() [2/3]
|
explicit |
Creates a new trash job that marks all items in the list items
as trash, and moves it to the configured trash collection.
The items can be in different collections/resources and will still be moved to the correct trash colleciton.
If keepTrashInCollection
is set, the item will not be moved to the configured trash collection.
- Parameters
-
items The items to mark as trash. parent The parent object.
Definition at line 304 of file trashjob.cpp.
◆ TrashJob() [3/3]
|
explicit |
Creates a new trash job that marks collection
as trash, and moves it to the configured trash collection.
The subentities of the collection are also marked as trash.
If keepTrashInCollection
is set, the item will not be moved to the configured trash collection.
- Parameters
-
collection The collection to mark as trash. parent The parent object.
Definition at line 311 of file trashjob.cpp.
◆ ~TrashJob()
TrashJob::~TrashJob | ( | ) |
Definition at line 318 of file trashjob.cpp.
Member Function Documentation
◆ deleteIfInTrash()
void TrashJob::deleteIfInTrash | ( | bool | enable | ) |
Delete Items which are already in trash, instead of ignoring them.
Definition at line 340 of file trashjob.cpp.
◆ doStart()
|
protectedvirtual |
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.
Implements Akonadi::Job.
Definition at line 346 of file trashjob.cpp.
◆ items()
Item::List TrashJob::items | ( | ) | const |
Definition at line 322 of file trashjob.cpp.
◆ keepTrashInCollection()
void TrashJob::keepTrashInCollection | ( | bool | enable | ) |
Ignore configured Trash collections and keep all items local.
Definition at line 334 of file trashjob.cpp.
◆ setTrashCollection()
void TrashJob::setTrashCollection | ( | const Collection & | trashcollection | ) |
Moves all entities to the give collection.
Definition at line 328 of file trashjob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.