MailCommon::FolderJob Class Reference

#include <folderjob.h>

Inheritance diagram for MailCommon::FolderJob:

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

Public Member Functions
	FolderJob ()
virtual	~FolderJob ()
int	error () const
bool	isCancellable () const
virtual void	kill ()
void	setCancellable (bool b)
void	start ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Member Functions
virtual void	execute ()=0
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
bool	mCancellable
int	mErrorCode
Akonadi::Collection	mSrcFolder
bool	mStarted

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
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)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Definition at line 38 of file folderjob.h.

Constructor & Destructor Documentation

MailCommon::FolderJob::FolderJob

(

)

Definition at line 38 of file folderjob.cpp.

MailCommon::FolderJob::~FolderJob ( )

virtual

Definition at line 44 of file folderjob.cpp.

Member Function Documentation

int MailCommon::FolderJob::error ( ) const

inline

Returns

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

Definition at line 63 of file folderjob.h.

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.

Implemented in MailCommon::ExpireJob.

void MailCommon::FolderJob::finished ( )

signal

Emitted when the job finishes all processing.

bool MailCommon::FolderJob::isCancellable ( ) const

inline

Returns

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

Definition at line 71 of file folderjob.h.

void MailCommon::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.

Reimplemented in MailCommon::ExpireJob.

Definition at line 60 of file folderjob.cpp.

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!

void MailCommon::FolderJob::setCancellable ( bool  b )

inline

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 82 of file folderjob.h.

void MailCommon::FolderJob::start

(

)

Start the job.

Definition at line 51 of file folderjob.cpp.

Member Data Documentation

bool MailCommon::FolderJob::mCancellable

protected

Definition at line 112 of file folderjob.h.

int MailCommon::FolderJob::mErrorCode

protected

Definition at line 109 of file folderjob.h.

Akonadi::Collection MailCommon::FolderJob::mSrcFolder

protected

Definition at line 108 of file folderjob.h.

bool MailCommon::FolderJob::mStarted

protected

Definition at line 111 of file folderjob.h.

---

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

• folderjob.h
• folderjob.cpp