Akonadi::TrashJob Class Reference

#include <trashjob.h>

Inheritance diagram for Akonadi::TrashJob:

Public Member Functions
	TrashJob (const Collection &collection, QObject *parent=nullptr)
	TrashJob (const Item &item, QObject *parent=nullptr)
	TrashJob (const Item::List &items, QObject *parent=nullptr)
void	deleteIfInTrash (bool enable)
Item::List	items () const
void	keepTrashInCollection (bool enable)
void	setTrashCollection (const Collection &trashcollection)
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=nullptr)
	~Job () override
QString	errorString () const final
void	start () override
Public Member Functions inherited from KCompositeJob
	KCompositeJob (QObject *parent=nullptr)
Public Member Functions inherited from KJob
	KJob (QObject *parent=nullptr)
Capabilities	capabilities () const
qint64	elapsedTime () const
int	error () const
QString	errorText () const
bool	exec ()
bool	isAutoDelete () const
bool	isFinishedNotificationHidden () const
bool	isStartedWithExec () const
bool	isSuspended () const
unsigned long	percent () const
Q_SCRIPTABLE qulonglong	processedAmount (Unit unit) const
void	setAutoDelete (bool autodelete)
void	setFinishedNotificationHidden (bool hide=true)
void	setUiDelegate (KJobUiDelegate *delegate)
Q_SCRIPTABLE qulonglong	totalAmount (Unit unit) const
KJobUiDelegate *	uiDelegate () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
void	doStart () override
Protected Member Functions inherited from Akonadi::Job
bool	addSubjob (KJob *job) override
virtual bool	doHandleResponse (qint64 tag, const Protocol::CommandPtr &response)
bool	doKill () override
void	emitWriteFinished ()
bool	removeSubjob (KJob *job) override
Protected Member Functions inherited from KCompositeJob
void	clearSubjobs ()
bool	hasSubjobs () const
const QList< KJob * > &	subjobs () const
Protected Member Functions inherited from KJob
virtual bool	doResume ()
virtual bool	doSuspend ()
void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)
void	emitResult ()
void	emitSpeed (unsigned long speed)
bool	isFinished () const
void	setCapabilities (Capabilities capabilities)
void	setError (int errorCode)
void	setErrorText (const QString &errorText)
void	setPercent (unsigned long percentage)
void	setProcessedAmount (Unit unit, qulonglong amount)
void	setProgressUnit (Unit unit)
void	setTotalAmount (Unit unit, qulonglong amount)
void	startElapsedTimer ()
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from Akonadi::Job
enum	Error {   ConnectionFailed = UserDefinedError , ProtocolVersionMismatch , UserCanceled , Unknown ,   UserError = UserDefinedError + 42 }
using	List = QList<Job *>
Public Types inherited from KJob
typedef QFlags< Capability >	Capabilities
enum	Capability
enum	Unit
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
Signals inherited from Akonadi::Job
void	aboutToStart (Akonadi::Job *job)
void	writeFinished (Akonadi::Job *job)
Signals inherited from KJob
void	description (KJob *job, const QString &title, const QPair< QString, QString > &field1=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< QString, QString >())
void	finished (KJob *job)
void	infoMessage (KJob *job, const QString &message)
void	percentChanged (KJob *job, unsigned long percent)
void	processedAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount)
void	processedSize (KJob *job, qulonglong size)
void	result (KJob *job)
void	resumed (KJob *job)
void	speed (KJob *job, unsigned long speed)
void	suspended (KJob *job)
void	totalAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount)
void	totalSize (KJob *job, qulonglong size)
void	warning (KJob *job, const QString &message)
Public Slots inherited from KJob
bool	kill (KJob::KillVerbosity verbosity=KJob::Quietly)
bool	resume ()
bool	suspend ()
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from KJob
	Bytes
	Directories
	Files
	Items
	Killable
	NoCapabilities
	Suspendable
	UnitsCount
Protected Slots inherited from Akonadi::Job
void	slotResult (KJob *job) override
Protected Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &message)
virtual void	slotResult (KJob *job)

Detailed Description

Job that moves items/collection to trash.

This job marks the given entities as trash and moves them to a given trash collection, if available.

Priorities of trash collections are the following:

1. keepTrashInCollection()
2. setTrashCollection()
3. configured collection in TrashSettings
4. 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 entities are not moved to trash -> no restore collection -If collection is deleted -> also subentities get collection.parentCollection as restore collection -If multiple items are deleted -> all items get their parentCollection as restore collection

Example:

const Akonadi::Item::List items = ...
 
TrashJob *job = new TrashJob( items );
connect( job, SIGNAL(result(KJob*)), this, SLOT(deletionResult(KJob*)) );

Author

Christian Mollekopf chrig.nosp@m.i_1@.nosp@m.fastm.nosp@m.ail..nosp@m.fm

Since

4.8

Definition at line 52 of file trashjob.h.

Constructor & Destructor Documentation

TrashJob() [1/3]

TrashJob::TrashJob ( const Item & item, QObject * parent = nullptr )

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 302 of file trashjob.cpp.

TrashJob() [2/3]

TrashJob::TrashJob ( const Item::List & items, QObject * parent = nullptr )

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 collection.

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 309 of file trashjob.cpp.

TrashJob() [3/3]

TrashJob::TrashJob ( const Collection & collection, QObject * parent = nullptr )

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 316 of file trashjob.cpp.

~TrashJob()

TrashJob::~TrashJob ( )

override

Definition at line 323 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 345 of file trashjob.cpp.

doStart()

void TrashJob::doStart ( )

overrideprotectedvirtual

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 351 of file trashjob.cpp.

items()

Item::List TrashJob::items ( ) const

nodiscard

Definition at line 327 of file trashjob.cpp.

keepTrashInCollection()

void TrashJob::keepTrashInCollection

(

bool

enable

)

Ignore configured Trash collections and keep all items local.

Definition at line 339 of file trashjob.cpp.

setTrashCollection()

void TrashJob::setTrashCollection

(

const Collection &

trashcollection

)

Moves all entities to the give collection.

Definition at line 333 of file trashjob.cpp.

---

The documentation for this class was generated from the following files:

• trashjob.h
• trashjob.cpp