Collapse all Symbian^3 Application Developer Library

MPbkBackgroundProcess Class Reference

class MPbkBackgroundProcess

Abstract process divided into steps.

Public Member Functions
	~MPbkBackgroundProcess ()
TInt	HandleStepError ( TInt )
TBool	IsProcessDone ()
void	ProcessCanceled ()
void	ProcessFinished ()
void	StepL ()
TInt	TotalNumberOfSteps ()

Constructor & Destructor Documentation

~MPbkBackgroundProcess()

~MPbkBackgroundProcess

(

)

[inline, virtual]

Virtual destructor.

Member Functions Documentation

HandleStepError(TInt)

TInt

HandleStepError

(

TInt

aError

)

[inline, virtual]

Handles an error (leave) occurred in StepL. Default implementation returns aError.

Parameters

TInt aError

code of the error that occurred.

IsProcessDone()

TBool

IsProcessDone

(

)

const [pure virtual]

Returns true when this process is done.

ProcessCanceled()

void

ProcessCanceled

(

)

[pure virtual]

Process cancelled.

ProcessFinished()

void

ProcessFinished

(

)

[inline, virtual]

Called back by the process driver when this process is finished.

StepL()

void

StepL

(

)

[pure virtual]

Executes one cycle of the process. Called by a process driver.

TotalNumberOfSteps()

TInt

TotalNumberOfSteps

(

)

[inline, virtual]

Returns the total number of steps in this process or -1 if not known.