Class CPrinterControl

class CPrinterControl : public CBase;

Description

Printer control interface.

This abstract base class acts as the interface between a CPrinterDevice object and the printer. It creates the context for, and controls the progress and termination of the print job.

Only those who need to add new printer drivers should write derived classes. After instantiation of such a class, using CPrinterDevice::CreateControlL(CPrinterPort *), the object can be accessed via the iControl member of CPrinterDevice.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CPrinterControl - Printer control interface.

Members

Defined in CPrinterControl:

• AbortPrint()Aborts the print process before it has completed.
• BandsPerPage()Gets the number of bands per page.
• CPrinterControl(CPrinterPort *)
• EMoreOnPageIndicates there is more to print on the current page.
• ENoMoreOnPageIndicates there is no more to print on the current page.
• ENotPrintingNot printing.
• EPrintingPrinting.
• QueueEndPrint(TRequestStatus &)Terminates the print process.
• QueueGetBand(TRequestStatus &,TBandAttributes &)Prints the next band on the page.
• TMoreOnPageFlags indicating whether there is more on the page to print.
• TStateState flags.
• iPrinterPortPrinter port.
• iStatePrinting state.
• ~CPrinterControl()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

See also:

• CPrinterDevicePrinter graphics device interface.

Related Topics

 » Symbian OS v9.4 » Examples » Graphics Device Interface example code » pdrstore: Creating a Printer Driver using pdr file

• pdrstore: Creating a Printer Driver using pdr files » Class summary

IMPORT_C ~CPrinterControl();

Description

Destructor.

It frees all resources owned by the object, prior to its destruction.

protected: IMPORT_C CPrinterControl(CPrinterPort *aPrinterPort);

Description

Parameters

CPrinterPort *aPrinterPort

virtual TInt BandsPerPage()=0;

Description

Gets the number of bands per page.

Return value

TInt The number of bands on each page.

virtual TMoreOnPage QueueGetBand(TRequestStatus &aStatus, TBandAttributes &aBand)=0;

Description

Prints the next band on the page.

This is an asynchronous function.

Parameters

TRequestStatus &aStatus Request status object. On successful completion contains KErrNone, otherwise another of the system-wide error codes. TBandAttributes &aBand On return, indicates the attributes of the band, including its height and width and whether or not the device will ignore one or other of graphics or text output. This information may be used by applications to draw more efficiently, or may be ignored

Return value

CPrinterControl::TMoreOnPage EMoreOnPage, if any unprinted bands remain on the current page. ENoMoreOnPage, if the current band is last on page.

virtual void QueueEndPrint(TRequestStatus &aStatus)=0;

Description

Terminates the print process.

This is an asynchronous function and is called when no more bands in the document remain to be printed.Note that all bands have been printed when no more pages or copies remain to be printed, and CPrinterControl::QueueGetBand(TRequestStatus &,TBandAttributes &) returns ENoMoreToPrint.

Parameters

TRequestStatus &aStatus Request status object. On successful completion contains KErrNone, otherwise another of the system-wide error codes.

virtual void AbortPrint()=0;

Description

Aborts the print process before it has completed.

This function should be called if CPrinterControl::QueueGetBand(TRequestStatus &,TBandAttributes &) reports an error.

TMoreOnPage

Description

Flags indicating whether there is more on the page to print.

EMoreOnPage Indicates there is more to print on the current page. ENoMoreOnPage Indicates there is no more to print on the current page.

protected: TState

Description

State flags.

ENotPrinting Not printing. EPrinting Printing.

protected: TState iState;

Description

Printing state.

protected: CPrinterPort * iPrinterPort;

Description

Printer port.