All Frameworks Class Hierarchy This Framework Previous Next Indexes
PrintBase Interface CATIPrintableDrafting
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIPrintableDrafting
Usage: you can freely reimplement this interface.
interface CATIPrintableDrafting
Interface for printable objects.
Method Index
- o
CleanPrintableImage(void)
- Clean the printable object environment.
- o
CreatePrintableImage(int)
- Creates a CATPrintImage from the printable object.
- o
GetImageName(CATUnicodeString&)
- Gets print image name.
- o
GetImageSize(float&,float&,float&,float&)
- Gets print image size.
- o
GetPrintArea(double*)
- Retrieves a 2D print area defined on a sheet.
Methods
o CleanPrintableImage
public virtual HRESULT CleanPrintableImage( | void | )= 0 |
-
Clean the printable object environment.
- Returns:
- S_OK upon successful execution.
o CreatePrintableImage
public virtual CATPrintImage* CreatePrintableImage( | int | iClipToSheet | = 1 )= 0 |
-
Creates a CATPrintImage from the printable object.
- Parameters:
-
- iClipToSheet
- The state of the ClipToSheet button.
- 0
- The created image corresponds to the whole drafting document.
- 1
- The created image is restricted to the sheet size. Any object outside the sheet is discarded.
- 2
- The created image is restricted to the defined print drafting area.
- Returns:
- The image created.
o GetImageName
-
Gets print image name.
- Parameters:
-
- oImageName
- The image name.
- Returns:
- S_OK upon successful execution.
o GetImageSize
public virtual HRESULT GetImageSize( | float& | oX, |
| float& | oY, |
| float& | oWidth, |
| float& | oHeight)= 0 |
-
Gets print image size.
- Parameters:
-
- oX
- The x image position.
- oY
- The y image position.
- oWidth
- The width image.
- oHeight
- The height image.
- Returns:
- S_OK upon successful execution.
o GetPrintArea
public virtual HRESULT GetPrintArea( | double* | oAreaData)= 0 |
-
Retrieves a 2D print area defined on a sheet. Fills a table allocated by the caller.
Also communicates the activation state of the printing area.
- 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.
- 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.
This object is included in the file: CATIPrintableDrafting.h
If needed, your Imakefile.mk should include the module: CATPrintBase