All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATDibModelerUseItf Interface CATIDibPrintArea

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDibPrintArea

Interface used to manage a print area.
CATIDibPrintArea allows to set and get the print area coordinates. CATIDibPrintArea allows to set and get the activation (deactivation) of the print area

Method Index

o GetPrintArea(double*): Gets the printing area defined on an object.
o GetPrintAreaActivationState(CATBoolean*): Returns the activation state of the print area.
o SetPrintArea(double*): Sets the printing area defined on an object.
o SetPrintAreaActivationState(CATBoolean): Activates or deactivates the print area.

Methods

o GetPrintArea

public virtual GetPrintArea( oAreaData)

Gets the printing area defined on an object. Fills a table allocated by the caller.

Parameters:

double

* oAreaData [out] A four double table describing the parameter of the area box:

oAreaData[0] as the low x coordinate of the area.
oAreaData[1] as the low y coordinate of the area.
oAreaData[2] as the width of the area.
oAreaData[3] as the heigth of the area.
All the values in the table are given in mm.

All the values in the table are given in mm.

Returns:

Un HRESULT

S_OK: A print area is defined on the sheet and it is currently activated. The data were successfully retrieved.
S_FALSE: A print area is defined on the sheet and it is currently de-activated. The data were successfully retrieved.
E_FAIL: No print area is defined on this sheet.

o GetPrintAreaActivationState

public virtual GetPrintAreaActivationState( oActivate)

Returns the activation state of the print area.

Parameters:

out: CATBoolean oActivated [out] The activation state of the print area (TRUE means activated, FALSE means deactivated).

Returns:

Un HRESULT

S_OK: The print area activation state was succesfully retrieved.
E_FAIL: No activation state available.

o SetPrintArea

public virtual SetPrintArea( const iAreaData)

Sets the printing area defined on an object.

Parameters:

const

double * iAreaData [in] A four double table describing the parameters of the area box:

iAreaData[0] as the low x coordinate of the area.
iAreaData[1] as the low y coordinate of the area.
iAreaData[2] as the width of the area. The value must be strictly positive.
iAreaData[3] as the heigth of the area. The value must be strictly positive.
All the values in the table are given in mm.

Returns:

Un HRESULT

S_OK: The print area was successfully defined.
E_INVALIDARG: The input arguments do not match with specified.
E_FAIL: No print area could be defined.

o SetPrintAreaActivationState

public virtual SetPrintAreaActivationState( const iActivated)

Activates or deactivates the print area.

Parameters:

in: CATBoolean iActivated [in] The activation state of the print area (TRUE means activated, FALSE means deactivated).

Returns:

Un HRESULT

S_OK: The activation state could be valuated.
E_FAIL: No activation or deactivation possible.

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