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 ()

Protected Member Functions
virtual void	execute ()=0

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

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