All Frameworks Class Hierarchy This Framework Indexes Previous Next

AfrStandard CATTaskController

Usage: you must use this class as is. You should never derive it.

public class CATTaskController

Class to launch an interruptible task.
Role:This class enables the launching of a task associated with a dialog box in order to indicate the progression of the process. To do this, create an instance of this class and call the method.

See also:: ,

Constructor and Destructor Index

o CATTaskController(): Constructs a default task controller.
o ~CATTaskController()

Method Index

o Schedule(CATIProgressTask*,CATBoolean,void*,CATBoolean,CATBoolean,double,CATAfrProgressTaskInterruptMode): Launches the task.

o CATAfrProgressTaskInterruptMode: Interrupt mode.

Constructor and Destructor

o CATTaskController

public CATTaskController(

)

Constructs a default task controller.

o ~CATTaskController

public virtual ~CATTaskController(

)

Methods

o Schedule

public Schedule(	`iTask`,
	`iInterruptible`	`= TRUE`,
	`iUserData`	`= 0`,
	`iAutoFlushUI`	`= TRUE`,
	`HideProgressBar`	`= FALSE`,
	`iPnlHiddenTime`	`= 0`,
	`iInterruptMode`	`= CancelProgressTask` )

Launches the task.

Parameters:

iTask: Interface pointer on the object which implements
iInterruptible: If the task is interruptible (TRUE) an interrupt button is displayed in the dialog box; so that the end user can interrupt the task, otherwise the value is FALSE.
iUserData: This data is the input argument of the
iAutoFlushUI: If the boolean is TRUE, the dialog box will be automatically updated after each
HideProgressBar: If the boolean is TRUE the user gets an interrupt panel without progress bar.
iPnlHiddenTime: Time during which the task panel stays hidden.
iInterruptMode: Behavior of the interrupt button. Does not take sense if iInterruptible is set to FALSE.

Enumerated Types

o CATAfrProgressTaskInterruptMode

enum CATAfrProgressTaskInterruptMode {
  CancelProgressTask,
  StopProgressTask
}

Interrupt mode.
If the task is interruptible (iInterruptible argument of Schedule = TRUE), this enum lists the possible values of the interrupt button of the progress bar dialog.
CancelProgressTask will display a Cancel button. Use this value when you want the task to be undone if the user interrupts it.
StopProgressTask will display a Stop button. Use this value when you want the task to be stopped and the partial result to be kept if the user interrupts it.

This object is included in the file: CATTaskController.h
If needed, your Imakefile.mk should include the module: CATAfrProgressTask