Class CGridPrinter

class CGridPrinter : public CBase, public MPageRegionPrinter;

Description

Handles printing and print preview functionality for grid.

Derivation

• MPageRegionPrinter - Interface for printing in bands.
• CBase - Base class for all classes to be instantiated on the heap.

• CGridPrinter - Handles printing and print preview functionality for grid.

Members

Defined in CGridPrinter:

• GridLay()Gets the grid layout used by this printing object.
• NewL(CGridLay *,CGridLabelImg *,CGridCellImg *,TZoomFactor *)Creates a new grid printer object.
• PaginateL()Paginates the grid.
• PrintBandL(CGraphicsDevice *,TInt,const TBandAttributes &)Prints a band.
• SetPageSizeInTwipsL(const TSize &)Sets the size of the page.
• SetRealPrintingDeviceMap(const MGraphicsDeviceMap *)Supplies the object that deals with the mapping between twips and device-specifi...
• SetTopLeftMargin(const TPoint &)Sets the top left margin.
• ~CGridPrinter()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...

IMPORT_C static CGridPrinter* NewL(CGridLay *aGridLay, CGridLabelImg *aPrintLabelImg, CGridCellImg *aPrintCellImg, TZoomFactor *aZoomFactor);

Description

Creates a new grid printer object.

Parameters

CGridLay *aGridLay A pointer to an object that controls the layout of rows and columns. CGridLabelImg *aPrintLabelImg A pointer to an object that draws a grid cell's label. CGridCellImg *aPrintCellImg A pointer to an object that draws the contents of a single cell. TZoomFactor *aZoomFactor A pointer to the zoom factor object.

Return value

CGridPrinter *

See also:

• CGridLay::ConstructL(CGridLay *,CGridImg *)A second-phase constructor, taking an existing grid layout object, that construc...

IMPORT_C virtual ~CGridPrinter();

Description

Destructor.

Frees resources before destruction of the object.

inline void SetRealPrintingDeviceMap(const MGraphicsDeviceMap *aGraphicsDeviceMap);

Description

Supplies the object that deals with the mapping between twips and device-specific units for a specific printer.

Parameters

const MGraphicsDeviceMap *aGraphicsDeviceMap The interface object for mapping between twips and device-specific units.

IMPORT_C void SetTopLeftMargin(const TPoint &aTlMarginInTwips);

Description

Sets the top left margin.

Parameters

const TPoint &aTlMarginInTwips The top left margin, in twips.

IMPORT_C void SetPageSizeInTwipsL(const TSize &aSizeInTwips);

Description

Sets the size of the page.

Parameters

const TSize &aSizeInTwips The size of the page, in twips.

IMPORT_C void PaginateL();

Description

Paginates the grid.

inline CGridLay& GridLay();

Description

Gets the grid layout used by this printing object.

Note that this is not the same object passed to CGridPrinter::NewL(CGridLay *,CGridLabelImg *,CGridCellImg *,TZoomFactor *). Internally, the class creates its own CGridLay object from the information supplied in the CGridLay object passed to CGridPrinter::NewL(CGridLay *,CGridLabelImg *,CGridCellImg *,TZoomFactor *).

Return value

CGridLay & The grid layout object.

IMPORT_C virtual void PrintBandL(CGraphicsDevice *aDevice, TInt aPageNo, const TBandAttributes &aBandInPixels);

Description

Prints a band.

The function implements MPageRegionPrinter::PrintBandL(CGraphicsDevice *,TInt,const TBandAttributes &).

!For Now

Parameters

CGraphicsDevice *aDevice Pointer to the graphics device representing the printer TInt aPageNo The number of the page containing the band to be printed. const TBandAttributes &aBandInPixels Attributes of the band to be printed.