Akonadi::SpecialCollectionsRequestJob

#include <specialcollectionsrequestjob.h>

Inheritance diagram for Akonadi::SpecialCollectionsRequestJob:

[legend]

Public Member Functions
	~SpecialCollectionsRequestJob () override

Collection	collection () const

void	requestCollection (const QByteArray &type, const AgentInstance &instance)

void	requestDefaultCollection (const QByteArray &type)

Public Member Functions inherited from Akonadi::TransactionSequence
	TransactionSequence (QObject *parent=nullptr)

	~TransactionSequence () override

void	commit ()

void	rollback ()

void	setAutomaticCommittingEnabled (bool enable)

void	setIgnoreJobFailure (KJob *job)

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
	SpecialCollectionsRequestJob (SpecialCollections collections, QObject parent=nullptr)

void	doStart () override

void	setDefaultResourceOptions (const QVariantMap &options)

void	setDefaultResourceType (const QString &type)

void	setIconForTypeMap (const QMap< QByteArray, QString > &map)

void	setNameForTypeMap (const QMap< QByteArray, QString > &map)

void	setTypes (const QList< QByteArray > &types)

void	slotResult (KJob *job) override

Protected Member Functions inherited from Akonadi::TransactionSequence
bool	addSubjob (KJob *job) override

void	doStart () override

Protected Member Functions inherited from Akonadi::Job
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::TransactionSequence
void	slotResult (KJob *job) override

Protected Slots inherited from Akonadi::Job
void	slotResult (KJob *job) override

Protected Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &message)

Detailed Description

A job to request SpecialCollections.

Use this job to request the SpecialCollections you need. You can request both default SpecialCollections and SpecialCollections in a given resource. The default SpecialCollections resource is created when the first default SpecialCollection is requested, but if a SpecialCollection in a custom resource is requested, this job expects that resource to exist already.

If the folders you requested already exist, this job simply succeeds. Otherwise, it creates the required collections and registers them with SpecialCollections.

This class is not meant to be used directly but as a base class for type specific special collection request jobs.

Author: Constantin Berzan exit3.nosp@m.219@.nosp@m.gmail.nosp@m..com

Since: 4.4

Definition at line 41 of file specialcollectionsrequestjob.h.

Constructor & Destructor Documentation

◆ ~SpecialCollectionsRequestJob()

SpecialCollectionsRequestJob::~SpecialCollectionsRequestJob ( )

overridedefault

Destroys the special collections request job.

◆ SpecialCollectionsRequestJob()

SpecialCollectionsRequestJob::SpecialCollectionsRequestJob	(	SpecialCollections *	collections,
		QObject *	parent = nullptr )

explicitprotected

Creates a new special collections request job.

Parameters

collections	The SpecialCollections object that shall be used.
parent	The parent object.

Definition at line 260 of file specialcollectionsrequestjob.cpp.

Member Function Documentation

◆ collection()

Akonadi::Collection SpecialCollectionsRequestJob::collection ( ) const

nodiscard

Returns the requested collection.

Definition at line 283 of file specialcollectionsrequestjob.cpp.

◆ doStart()

void SpecialCollectionsRequestJob::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 317 of file specialcollectionsrequestjob.cpp.

◆ requestCollection()

void SpecialCollectionsRequestJob::requestCollection	(	const QByteArray &	type,
		const AgentInstance &	instance )

Requests a special collection of the given type in the given resource instance.

Definition at line 276 of file specialcollectionsrequestjob.cpp.

◆ requestDefaultCollection()

void SpecialCollectionsRequestJob::requestDefaultCollection ( const QByteArray & type )

Requests a special collection of the given type in the default resource.

Definition at line 269 of file specialcollectionsrequestjob.cpp.

◆ setDefaultResourceOptions()

void SpecialCollectionsRequestJob::setDefaultResourceOptions ( const QVariantMap & options )

protected

Sets the configuration options that shall be applied to the new resource that is created if the requested special collection does not exist yet.

Definition at line 297 of file specialcollectionsrequestjob.cpp.

◆ setDefaultResourceType()

void SpecialCollectionsRequestJob::setDefaultResourceType ( const QString & type )

protected

Sets the type of the resource that shall be created if the requested special collection does not exist yet.

Definition at line 292 of file specialcollectionsrequestjob.cpp.

◆ setIconForTypeMap()

void SpecialCollectionsRequestJob::setIconForTypeMap ( const QMap< QByteArray, QString > & map )

protected

Sets the map of special collection types to icon names.

Definition at line 312 of file specialcollectionsrequestjob.cpp.

◆ setNameForTypeMap()

void SpecialCollectionsRequestJob::setNameForTypeMap ( const QMap< QByteArray, QString > & map )

protected

Sets the map of special collection types to display names.

Definition at line 307 of file specialcollectionsrequestjob.cpp.

◆ setTypes()

void SpecialCollectionsRequestJob::setTypes ( const QList< QByteArray > & types )

protected

Sets the list of well known special collection types.

Definition at line 302 of file specialcollectionsrequestjob.cpp.

◆ slotResult()

void SpecialCollectionsRequestJob::slotResult ( KJob * job )

overrideprotectedvirtual

Reimplemented from KCompositeJob.

Definition at line 330 of file specialcollectionsrequestjob.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Akonadi

Akonadi::SpecialCollectionsRequestJob

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~SpecialCollectionsRequestJob()

◆ SpecialCollectionsRequestJob()

Member Function Documentation

◆ collection()

◆ doStart()

◆ requestCollection()

◆ requestDefaultCollection()

◆ setDefaultResourceOptions()

◆ setDefaultResourceType()

◆ setIconForTypeMap()

◆ setNameForTypeMap()

◆ setTypes()

◆ slotResult()