All Frameworks Class Hierarchy This Framework Indexes Previous Next

PrintBase Interface CATIPrintables

Usage: you can freely reimplement this interface.

interface CATIPrintables

Interface for printable objects.
This interface is used for the multidocuments printing. The implementation of this interface allows to use the print dialog window for multidocuments.

Method Index

o CleanPrintableImage(void): Clean the printable object environment.
o CreatePrintableImages(int,int): Creates a CATPrintImage from the printable object.
o GetCurrentImageNumber(int&): Gets the current image number.
o GetImageName(int,CATUnicodeString&): Gets the print image name.
o GetImagesNumber(int&): Gets the count of images in the document.

Methods

o CleanPrintableImage

public virtual CleanPrintableImage( )

Clean the printable object environment. This method can only be implemented in V5R8.

o CreatePrintableImages

public virtual CreatePrintableImages(		`iImageNumber`,
		`iIsWholeDocumentMode`	`= 0`)

Creates a CATPrintImage from the printable object.

Parameters:

iImageNumber: The number of the image to be printed.
iIsWholeDocumentMode: The IsWholeDocumentMode parameter decides to print the whole document or the display.

Returns:

The image created.

o GetCurrentImageNumber

public virtual GetCurrentImageNumber( iCurrentImageNumber)

Gets the current image number.

Parameters:

iCurrentImageNumber: The number of the current image.

o GetImageName

public virtual GetImageName(		`iImageNumber`,
		`oImageName`)

Gets the print image name.

Parameters:

iImageNumber: The number of the image to be printed.
oImageName: The name of the image to be printed.

o GetImagesNumber

public virtual GetImagesNumber( oImagesNumber)

Gets the count of images in the document.

Parameters:

oImagesNumber: The count of images in the document.

This object is included in the file: CATIPrintables.h
If needed, your Imakefile.mk should include the module: CATPrintBase