MailCommon::FolderJob Class Reference

#include <folderjob.h>

Inheritance diagram for MailCommon::FolderJob:

Signals
void	finished ()
void	result (FolderJob *job)

Public Member Functions
	FolderJob (QObject *parent=nullptr)
int	error () const
bool	isCancellable () const
virtual void	kill ()
void	setCancellable (bool b)
void	start ()
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
virtual void	execute ()=0
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)

Protected Attributes
bool	mCancellable = false
int	mErrorCode = 0
Akonadi::Collection	mSrcFolder
bool	mStarted = false

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
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)

Detailed Description

The FolderJob class.

Definition at line 18 of file folderjob.h.

Constructor & Destructor Documentation

FolderJob()

FolderJob::FolderJob ( QObject * parent = nullptr )

explicit

Definition at line 15 of file folderjob.cpp.

~FolderJob()

FolderJob::~FolderJob ( )

override

Definition at line 21 of file folderjob.cpp.

Member Function Documentation

error()

int FolderJob::error ( ) const

nodiscard

Returns

the error code of the job. This must only be called from the slot connected to the finished() signal.

Definition at line 43 of file folderjob.cpp.

execute()

virtual void MailCommon::FolderJob::execute ( )

protectedpure virtual

Has to be reimplemented.

It's called by the start() method. Should start the processing of the specified job function.

finished

void MailCommon::FolderJob::finished ( )

signal

Emitted when the job finishes all processing.

isCancellable()

bool FolderJob::isCancellable ( ) const

nodiscard

Returns

true if this job can be canceled, e.g. to exit the application

Definition at line 48 of file folderjob.cpp.

kill()

void FolderJob::kill ( )

virtual

Interrupt the job.

Note that the finished() and result() signal will be emitted, unless you called setPassiveDestructor(true) before. This kills the job, don't use it afterwards.

Definition at line 37 of file folderjob.cpp.

result

void MailCommon::FolderJob::result ( FolderJob * job )

signal

Emitted when the job finishes all processing.

More convenient signal than finished(), since it provides a pointer to the job. This signal is emitted by the FolderJob destructor => do NOT downcast the job to a subclass!

setCancellable()

void FolderJob::setCancellable

(

bool

b

)

Call this to change the "cancellable" property of this job.

By default, tListMessages, tGetMessage, tGetFolder and tCheckUidValidity are cancellable, the others are not. But when copying, a non-cancellable tGetMessage is needed.

Definition at line 53 of file folderjob.cpp.

start()

void FolderJob::start

(

)

Start the job.

Definition at line 28 of file folderjob.cpp.

Member Data Documentation

mCancellable

bool MailCommon::FolderJob::mCancellable = false

protected

Definition at line 83 of file folderjob.h.

mErrorCode

int MailCommon::FolderJob::mErrorCode = 0

protected

Definition at line 80 of file folderjob.h.

mSrcFolder

Akonadi::Collection MailCommon::FolderJob::mSrcFolder

protected

Definition at line 79 of file folderjob.h.

mStarted

bool MailCommon::FolderJob::mStarted = false

protected

Definition at line 82 of file folderjob.h.

---

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

• folderjob.h
• folderjob.cpp