All Frameworks Class Hierarchy This Framework Indexes Previous Next

PrintBase CATPrintParameters

Usage: you can derive this class.

public class CATPrintParameters

Class to create a CATPrintParameters object.

Role: This class aggregates print parameters such as paper format, margins, image position, image scale, image rotation, mapping to paper flag, print quality, printing offset, ...
Derive from this class and add new methods to manage others parameters using in an overridden .

Constructor and Destructor Index

o CATPrintParameters(): Constructs a CATPrintParameters object.
o CATPrintParameters(CATPrintParameters&): Copy constructor.
o ~CATPrintParameters()

Method Index

o GetArea(void): Returns the area printed.
o GetBackgroundColor(float&,float&,float&): Retrieves the background color.
o GetBanner(void): Returns the string banner.
o GetBannerPosition(void): Returns the banner postion.
o GetBannerSize(CATBoolean&,float&): Returns the banner size.
o GetColorMode(void): Returns the print color mode.
o GetConfidentialMessage(): Returns the confidential message if any
o GetCurrentForm(void): Returns the current format.
o GetCurrentForm(void): Returns the current format.
o GetDPI(void): Returns the Dot Per Inch (DPI).
o GetExpandedBanner(void): Returns the string banner with all keywords replaced by their value.
o GetGamma(void): Returns the gamma correction.
o GetImageFormatUse(void): Returns the use or not of image format as current format.
o GetImageTitleUse(void): Returns the use or not of the image title.
o GetLineCap(void): Returns the line cap.
o GetLineTypeSpecificationMode(void): Returns the line type specification mode.
o GetLineWidthSpecificationMode(void): Returns the line with specification mode.
o GetLogoFileName(void): Returns the path of the logo file name.
o GetLogoVisibility(void): Returns the logo visibility flag.
o GetMapToPaper(void): Returns the mapping to paper flag.
o GetMargins(float&,float&,float&,float&): Retrieves the margins.
o GetPosition(float&,float&): Retrieves the image position.
o GetQuality(void): Returns the print quality.
o GetRotation(void): Returns the image rotation.
o GetSaveWithImageReferentialKept(void): Returns the image referential mode.
o GetScale(void): Returns the image scale.
o GetStandard(void): Returns the standard used in the parameters.
o GetTextBlanking(void): Returns the use or not of blanking under texts.
o GetUseCustomQuality(void): Returns the use or not of the custom quality.
o GetVisuParameters(void): Returns the visualization parameters.
o GetWhitePixel(void): Returns the white pixel flag.
o IsBannerConfidential(): Returns the banner confidentiality
o SetArea(CATPrintArea): Sets the area printed.
o SetBackgroundColor(float,float,float): Sets the background color.
o SetBanner(CATUnicodeString&): Sets the string banner.
o SetBannerImageDescription(CATUnicodeString&): Sets the image description for updating the banner
o SetBannerPosition(CATPrintBannerPosition): Sets the banner postion.
o SetBannerSize(CATBoolean,float): Sets the banner size.
o SetColorMode(CATPrintColorMode): Sets the print color mode.
o SetCurrentForm(CATPrintForm&): Sets the current format.
o SetDPI(int): Sets the Dot Per Inch (DPI).
o SetGamma(float): Sets the gamma correction.
o SetImageFormatUse(CATBoolean): Sets the use of image format as current format.
o SetImageTitleUse(CATBoolean): Sets the use or not of the image title.
o SetLineCap(CATPrintLineCap): Sets the line cap.
o SetLineTypeSpecificationMode(CATPrintLineSpecification): Sets the line type specification mode.
o SetLineWidthSpecificationMode(CATPrintLineSpecification): Sets the line with specification mode.
o SetLogoFileName(CATString&): Sets the path of the logo file name.
o SetLogoVisibility(int): Sets the logo visibility flag.
o SetMapToPaper(int): Sets the mapping to paper flag.
o SetMargins(float,float,float,float): Sets the margins.
o SetPosition(float,float): Sets the image position.
o SetQuality(int): Sets the print quality.
o SetRotation(CATPrintRotation): Sets the image rotation.
o SetSaveWithImageReferentialKept(CATBoolean): Sets the image referential mode.
o SetScale(float): Sets the image scale.
o SetStandard(CATPrintStandard): Sets the standard used in the parameters.
o SetTextBlanking(CATBoolean): Sets the use of blanking under texts.
o SetUseCustomQuality(CATBoolean): Sets the use of the custom quality, the DPI will be used instead of the print quality.
o SetVisuParameters(CATPrintVisuParameters*): Sets the visualization parameters.
o SetWhitePixel(int): Sets the white pixel flag.

Constructor and Destructor

o CATPrintParameters

public CATPrintParameters(

)

Constructs a CATPrintParameters object.

o CATPrintParameters

public CATPrintParameters( const iParameters)

Copy constructor.

Parameters:

iParameters: The parameters to be copied.

o ~CATPrintParameters

public ~CATPrintParameters(

)

Methods

o GetArea

public GetArea( )

Returns the area printed.

Returns:: The area printed.

o GetBackgroundColor

public GetBackgroundColor(		`oRed`,
		`oGreen`,
		`oBlue`)

Retrieves the background color.

Parameters:

oRed: The red component of the background color.
oGreen: The green component of the background color.
oBlue: The blue component of the background color.

o GetBanner

public GetBanner( )

Returns the string banner.

Returns:: The string banner.

o GetBannerPosition

public GetBannerPosition( )

Returns the banner postion.

Returns:: The banner position.

o GetBannerSize

public GetBannerSize(		`oBannerSizeAvailability`,
		`oBannerSize`)

Returns the banner size.
Role: This method returns the banner size if it has been set by user.

Parameters:

oBannerSizeAvailability

Legal values

TRUE: the banner size is set to oBannerSize.
FALSE: the banner size is set to default value.

oBannerSize

The text height of the banner.

o GetColorMode

public GetColorMode( )

Returns the print color mode.

Returns:: The print color mode.

o GetConfidentialMessage

public GetConfidentialMessage(

)

Returns the confidential message if any

Returns:: The confidential string

o GetCurrentForm

public GetCurrentForm( )

Returns the current format.

Returns:: The current format.

o GetCurrentForm

public GetCurrentForm( )

Returns the current format.

Returns:: The current format.

o GetDPI

public GetDPI( )

Returns the Dot Per Inch (DPI).

Returns:: The DPI.

o GetExpandedBanner

public GetExpandedBanner( )

Returns the string banner with all keywords replaced by their value.

Returns:: The expanded string banner.

o GetGamma

public GetGamma( )

Returns the gamma correction.

Returns:: The gamma correction.

o GetImageFormatUse

public GetImageFormatUse( )

Returns the use or not of image format as current format.

Returns:: The use of the image format.

o GetImageTitleUse

public GetImageTitleUse( )

Returns the use or not of the image title. If the image title is saved into the generated file in case of save into a file, the method returns TRUE. If the image title is not saved into the generated file in case of save into a file, the method returns FALSE.

Returns:: The image title mode.

o GetLineCap

public GetLineCap( )

Returns the line cap.

Returns:: The line cap.

o GetLineTypeSpecificationMode

public GetLineTypeSpecificationMode( )

Returns the line type specification mode.

Returns:: The line type specification mode.

o GetLineWidthSpecificationMode

public GetLineWidthSpecificationMode( )

Returns the line with specification mode.

Returns:: The line with specification mode.

o GetLogoFileName

public GetLogoFileName( )

Returns the path of the logo file name.

Returns:: The path of the logo file name.

o GetLogoVisibility

public GetLogoVisibility( )

Returns the logo visibility flag.

Returns:: The logo visibility (1 if being seen, 0 either).

o GetMapToPaper

public GetMapToPaper( )

Returns the mapping to paper flag.

Returns:: The mapping to paper flag (1 if true, 0 either).

o GetMargins

public GetMargins(		`oLeftMargin`,
		`oRightMargin`,
		`oTopMargin`,
		`oBottomMargin`)

Retrieves the margins.

Parameters:

oLeftMargin: The left margin.
oRightMargin: The right margin.
oTopMargin: The top margin.
oBottomMargin: The bottom margin.

o GetPosition

public GetPosition(		`oX`,
		`oY`)

Retrieves the image position.

Parameters:

oX: The x coordinate of the image.
oY: The y coordinate of the image.

o GetQuality

public GetQuality( )

Returns the print quality.

Returns:: The print quality (between 0 to 100).

o GetRotation

public GetRotation( )

Returns the image rotation.

Returns:: The image rotation.

o GetSaveWithImageReferentialKept

public GetSaveWithImageReferentialKept( )

Returns the image referential mode. If the image referential is kept with vectorial save, the method returns TRUE. If the vectorial save sets the image referential as the left bottom corner, the method returns FALSE.

Returns:: The image referential mode.

o GetScale

public GetScale( )

Returns the image scale.

Returns:: The image scale.

o GetStandard

public GetStandard( )

Returns the standard used in the parameters.

Returns:: The standard used.

o GetTextBlanking

public GetTextBlanking( )

Returns the use or not of blanking under texts.

Returns:: The use of text blanking.

o GetUseCustomQuality

public GetUseCustomQuality( )

Returns the use or not of the custom quality.

Returns:: The use of the custom quality.

o GetVisuParameters

public GetVisuParameters( )

Returns the visualization parameters.

Returns:: The visualization parameters.

o GetWhitePixel

public GetWhitePixel( )

Returns the white pixel flag.

Returns:: The white pixel flag (1 if printing in black, 0 either).

o IsBannerConfidential

public IsBannerConfidential(

)

Returns the banner confidentiality

Returns:: TRUE if a confidential message is available

o SetArea

public SetArea( iArea)

Sets the area printed.

Parameters:

iArea: Legal values: The default is CATPRINT_WHOLE_DOCUMENT.

o SetBackgroundColor

public SetBackgroundColor(		`iRed`,
		`iGreen`,
		`iBlue`)

Sets the background color.

Parameters:

iRed: The red component of the background color.
Legal values: The default is 1.
iGreen: The green component of the background color.
Legal values: The default is 1.
iBlue: The blue component of the background color.
Legal values: The default is 1.

o SetBanner

public SetBanner( const iBanner)

Sets the string banner.

Parameters:

iBanner: The string banner.
Legal values: The default is : Printed by $USER on $DATE $TIME

o SetBannerImageDescription

public SetBannerImageDescription( const iImageDescription)

Sets the image description for updating the banner

Parameters:

iImageDescription: The image description

o SetBannerPosition

public SetBannerPosition( iPosition)

Sets the banner postion.

Parameters:

iPosition: The banner position.
Legal values: The default is CATPRINT_NONE.

o SetBannerSize

public SetBannerSize(		`iBannerSizeAvailability`,
		`iBannerSize`	`=2.0`)

Sets the banner size.

Parameters:

iBannerSizeAvailability

Legal values

TRUE: the banner size is set to iBannerSize.
FALSE: the banner size is set to default value.

iBannerSize

The text height of the banner.

o SetColorMode

public SetColorMode( colorMode)

Sets the print color mode.

Parameters:

iColorMode: The print color mode.
Legal values: The default is CATPRINTRGB.

o SetCurrentForm

public SetCurrentForm( const iForm)

Sets the current format.

Parameters:

iForm: The current format.
Legal values: The default is A4 ISO.

o SetDPI

public SetDPI( iDpi)

Sets the Dot Per Inch (DPI).

Parameters:

iDpi: The DPI.
Legal values: The default is 150 dpi.

o SetGamma

public SetGamma( iGamma)

Sets the gamma correction.

Parameters:

iGamma: The gamma correction (positive float).
Legal values: The default is 1.

o SetImageFormatUse

public SetImageFormatUse( iImageFormatUse)

Sets the use of image format as current format.

Parameters:

iUseCustomQuality: Legal values: The default is FALSE.

o SetImageTitleUse

public SetImageTitleUse( iImageTitleUse)

Sets the use or not of the image title. If iImageTitleUse is set to TRUE, the image title is saved into the generated file in case of save into a file. If iImageTitleUse is set to FALSE, the image title is not saved into the generated file in case of save into a file.

Parameters:

iImageTitleMode: Legal values: The default is FALSE.

o SetLineCap

public SetLineCap( iLineCap)

Sets the line cap.

Parameters:

iLineCap: The line cap.
Legal values: The default is CATPRINT_FLAT.

o SetLineTypeSpecificationMode

public SetLineTypeSpecificationMode( iLtSpec)

Sets the line type specification mode.

Parameters:

iLtSpec: The line type specification mode.
Legal values: The default is CATPRINT_ABSOLUTE.

o SetLineWidthSpecificationMode

public SetLineWidthSpecificationMode( iLwSpec)

Sets the line with specification mode.

Parameters:

iLwSpec: The line with specification mode.
Legal values: The default is CATPRINT_ABSOLUTE.

o SetLogoFileName

public SetLogoFileName( const iPath)

Sets the path of the logo file name.

Parameters:

iPath: The path of the logo file name.
Legal values: The default is blank path.

o SetLogoVisibility

public SetLogoVisibility( iFlag)

Sets the logo visibility flag.

Parameters:

iFlag: The logo visibility.
Legal values: 1 if being seen, 0 either. The default is 0.

o SetMapToPaper

public SetMapToPaper( iMapToPaper)

Sets the mapping to paper flag.

Parameters:

iMapToPaper: The mapping to paper flag.
Legal values: 1 if true, 0 either. The default is 0.

o SetMargins

public SetMargins(		`iLeftMargin`,
		`iRightMargin`,
		`iTopMargin`,
		`iBottomMargin`)

Sets the margins.

Parameters:

iLeftMargin: The left margin.
Legal values: The default is 10 mm.
iRightMargin: The right margin.
Legal values: The default is 10 mm.
iTopMargin: The top margin.
Legal values: The default is 10 mm.
iBottomMargin: The bottom margin.
Legal values: The default is 10 mm.

o SetPosition

public SetPosition(		`iX`,
		`iY`)

Sets the image position.

Parameters:

iX: The x coordinate of the image.
Legal values: The default is 0.
iY: The y coordinate of the image.
Legal values: The default is 0.

o SetQuality

public SetQuality( iQuality)

Sets the print quality.

Parameters:

iQuality: The print quality
Legal values: between 0 to 100. The default is the minimum = 0.

o SetRotation

public SetRotation( iRotation)

Sets the image rotation.

Parameters:

The: image rotation.
Legal values: The default is CATPRINTCCW_0.

o SetSaveWithImageReferentialKept

public SetSaveWithImageReferentialKept( iImageReferentialKept)

Sets the image referential mode. If iImageReferentialKept is set to TRUE, the image referential is kept with vectorial save. If iImageReferentialKept is set to FALSE, the vectorial save sets the image referential as the left bottom corner.

Parameters:

iImageReferentialKept: Legal values: The default is FALSE.

o SetScale

public SetScale( iScale)

Sets the image scale.

Parameters:

The: image scale. It must be a positive float.
Legal values: The default is 1.

o SetStandard

public SetStandard( std)

Sets the standard used in the parameters.

Parameters:

iStandard: The standard used.
Legal values: The default is CATPRINT_ISO.

o SetTextBlanking

public SetTextBlanking( iTextBlanking)

Sets the use of blanking under texts.

Parameters:

iTextBlanking: Legal values: The default is FALSE.

o SetUseCustomQuality

public SetUseCustomQuality( iUseCustomQuality)

Sets the use of the custom quality, the DPI will be used instead of the print quality.

Parameters:

iUseCustomQuality: Legal values: The default is FALSE.

o SetVisuParameters

public SetVisuParameters( iVisuParameters)

Sets the visualization parameters.

Parameters:

iVisuParameters: Legal values: The default is CATPRINT_WHOLE_DOCUMENT.

o SetWhitePixel

public SetWhitePixel( iWhitePixel)

Sets the white pixel flag.

Parameters:

iWhitePixel: The white pixel flag.
Legal values: 1 if printing in black, 0 either. The default is 1.

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

PrintBase writeClassCharacteristic(); CATPrintParameters

Constructor and Destructor Index

Method Index

Constructor and Destructor

Methods

PrintBase CATPrintParameters