Class MPrintProcessObserver

MPrintProcessObserver

Support

Supported from 5.0

Description

Print progress and status notification interface class.

The notification functions are called before, during and after a print or print preview operation, to give notification of its progress.

The print process observer will often be the GUI's standard print progress or print preview dialog.

An object of a class which implements this interface may be passed as a parameter to CPrintSetup::StartPrintL(), or to CPrintSetup::StartPreviewPrintL().

Defined in MPrintProcessObserver:
NotifyBandPrinted(), NotifyPrintEnded(), NotifyPrintStarted()

virtual void NotifyPrintStarted(TPrintParameters aPrintParams)=0;

Description

Notifies that a print or print preview operation is about to begin.

It may be used to display information about the document to be printed. It is called once, immediately before printing or print previewing begins.

When subclassing, add variables to store initialisation information as required.

Parameters

TPrintParameters aPrintParams The parameters for the print job.

virtual void NotifyBandPrinted(TInt aPercentageOfPagePrinted, TInt aCurrentPageNum, TInt aCurrentCopyNum)=0;

Description

Notifies that a band is about to be printed.

It may be used to display print progress information, including the current page number. It is called immediately before each band is printed.

Parameters

TInt aPercentageOfPagePrinted The percentage of the page that has been printed. TInt aCurrentPageNum The number of the page currently being printed. TInt aCurrentCopyNum The number of the copy currently being printed (if multiple copies are being printed).

virtual void NotifyPrintEnded(TInt anErrorCode)=0;

Description

Notifies that the print or print preview operation has completed.

It may be used to display information about how the operation completed, for example any errors that occurred. It is called once, immediately after the print job terminates.

Parameters

TInt anErrorCode KErrNone if the print job completed successfully, otherwise another of the system-wide error codes.