Sign in Join
FPDoc Onlineexperiment

TPicture.Progress procedure

Member of TPictureprotectedIn unit Graphics

Monitors progress of a drawing process.

Declaration

pascal
procedure Progress(Sender: TObject; Stage: TProgressStage; 
 PercentDone: Byte; RedrawNow: Boolean; 
 const R: TRect; const Msg: string; 
 var DoContinue: Boolean); virtual

Arguments

Sender

Object for the notification.

Stage
PercentDone
RedrawNow
R
Msg
DoContinue

Description

Performs actions needed to monitor the progress of operations in the class instance.

The parameters identify the calling object, the action being performed, the completion percentage, whether the picture should be redraw. The DoContine variable parameter is updated in the event handler to indicate if the process is continued. False indicates an error condition where the process should be halted. It is set to True on entry.

Progress signals the OnProgress event handler (when assigned) using the parameters values as arguments.

No actions are performed in the method when OnProgress has not been assigned (contains Nil). In this scenario, DoContine returns True.

See TProgressEvent for more details on progress monitoring.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.