CPrinterControl Class Reference

Printer control interface. More...

#include <gdi.h>

Inheritance diagram for CPrinterControl:

Public Types
enum	TMoreOnPage { EMoreOnPage , ENoMoreOnPage }
	Flags indicating whether there is more on the page to print. More...

Public Member Functions
IMPORT_C	~CPrinterControl ()
	Destructor.
virtual TInt	BandsPerPage ()=0
	Gets the number of bands per page.
virtual TMoreOnPage	QueueGetBand (TRequestStatus &aStatus, TBandAttributes &aBand)=0
	Prints the next band on the page.
virtual void	QueueEndPrint (TRequestStatus &aStatus)=0
	Terminates the print process.
virtual void	AbortPrint ()=0
	Aborts the print process before it has completed.
Public Member Functions inherited from CBase
	CBase ()
	Default constructor.
virtual IMPORT_C	~CBase ()
	Virtual destructor.
TAny *	operator new (TUint aSize, TAny *aBase) __NO_THROW
	Initialises the object to binary zeroes.
TAny *	operator new (TUint aSize) __NO_THROW
	Allocates the object from the heap and then initialises its contents to binary zeroes.
TAny *	operator new (TUint aSize, TLeave)
	Allocates the object from the heap and then initialises its contents to binary zeroes.
TAny *	operator new (TUint aSize, TUint aExtraSize) __NO_THROW
	Allocates the object from the heap and then initialises its contents to binary zeroes.
TAny *	operator new (TUint aSize, TLeave, TUint aExtraSize)
	Allocates the object from the heap and then initialises its contents to binary zeroes.

Protected Types
enum	TState { ENotPrinting , EPrinting }
	State flags. More...

Protected Member Functions
IMPORT_C	CPrinterControl (CPrinterPort *aPrinterPort)
Protected Member Functions inherited from CBase
virtual IMPORT_C TInt	Extension_ (TUint aExtensionId, TAny *&a0, TAny *a1)
	Extension function.

Protected Attributes
TState	iState
	Printing state.
CPrinterPort *	iPrinterPort
	Printer port.

Additional Inherited Members
Static Public Member Functions inherited from CBase
static IMPORT_C void	Delete (CBase *aPtr)
	Deletes the specified object.

Detailed 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(), the object can be accessed via the iControl member of CPrinterDevice.

See also

CPrinterDevice

API status

Published to all clients. Released API.

Definition at line 3906 of file gdi.h.

Member Enumeration Documentation

TMoreOnPage

enum CPrinterControl::TMoreOnPage

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

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

Definition at line 3910 of file gdi.h.

TState

enum CPrinterControl::TState

protected

State flags.

Enumerator
ENotPrinting	Not printing.
EPrinting	Printing.

Definition at line 3959 of file gdi.h.

Constructor & Destructor Documentation

~CPrinterControl()

IMPORT_C CPrinterControl::~CPrinterControl

(

)

Destructor.

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

(generated from Symbian Developer Library)

CPrinterControl()

IMPORT_C CPrinterControl::CPrinterControl ( CPrinterPort *  aPrinterPort )

protected

Member Function Documentation

AbortPrint()

virtual void CPrinterControl::AbortPrint ( )

pure virtual

Aborts the print process before it has completed.

This function should be called if QueueGetBand() reports an error.

BandsPerPage()

virtual TInt CPrinterControl::BandsPerPage ( )

pure virtual

Gets the number of bands per page.

Returns

The number of bands on each page.

QueueEndPrint()

virtual void CPrinterControl::QueueEndPrint ( TRequestStatus &  aStatus )

pure virtual

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 QueueGetBand() returns ENoMoreToPrint.

Parameters

aStatus

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

QueueGetBand()

virtual TMoreOnPage CPrinterControl::QueueGetBand ( TRequestStatus &  aStatus, TBandAttributes &  aBand  )

pure virtual

Prints the next band on the page.

This is an asynchronous function.

Parameters

aStatus	Request status object. On successful completion contains KErrNone, otherwise another of the system-wide error codes.
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

Returns

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

Member Data Documentation

iPrinterPort

CPrinterPort* CPrinterControl::iPrinterPort

protected

Printer port.

Definition at line 3969 of file gdi.h.

iState

TState CPrinterControl::iState

protected

Printing state.

Definition at line 3967 of file gdi.h.

---

The documentation for this class was generated from the following files:

• gdi.h
• gdi.h.dox