#define kPDPrintUseCropBox
(
(
ASUns16
)
~
0
-
1
)
#define kPDPrintUseMediaBox
(
(
ASUns16
)
~
0
)
ALDImageColorType_Spot | Spot color type.
|
ALDImageColorType_Process | Process color type.
|
ALDImageColorType_Separation | Separation color type.
|
ALDImageColorType_Intrinsic | Intrinsic color type.
|
ImageInk_Registration | Image colorant registration value.
|
ImageInk_FullColor | Image colorant full color value.
|
ImageInk_Monochrome | Image colorant monochrome value
|
PDInclusion.
kIncludeOncePerDoc | Include the resource only once per file.
|
kIncludeOnEveryPage | Include the resource on every page in the file.
|
kIncludeNever | Never include the resource.
|
kIncludeWhenNeeded | When needed.
|
kIncludeByRange |
OPIv13 | OPI version 1.3.
|
OPIv20 | OPI version 2.0.
|
Value options for PDDuplexEnum.
kPDDuplexOff | Respect whatever duplex option was selected in printer preferences.
|
kPDDuplexOnTumbleShort | Duplex on short edge.
|
kPDDuplexOnTumbleLong | Duplex on long edge.
|
kPDDuplexForceSimplex | Force simplex printing, ignoring the printer preferences.
|
kPDFLPrintProg_PopLastProgress = 0 | |
kPDFLPrintProg_PushCompilingDocumentResources | |
kPDFLPrintProg_PushCompilingPageResources | |
kPDFLPrintProg_PushStreamingDocumentFont | |
kPDFLPrintProg_PushStreamingDocumentResource | |
kPDFLPrintProg_PushStreamingPageFont | |
kPDFLPrintProg_PushStreamingPageResource | |
kPDFLPrintProg_PushStreamingPageContent | |
kPDFLPrintProg_PushStreamingPageEpilogue | |
kPDFLPrintProg_PushStreamingDocumentEpilogue | |
kPDFLPrintProg_PushStreamingDocumentProcset | |
kPDFLPrintProg_PushStreamingPageSeparation | |
kPDFLPrintProg_PushStreamingPageImage | |
kPDFLPrintProg_PushStreamingPageImageOPI | |
kPDFLPrintProg_PushStreamingPageCSA | |
kPDFLPrintProg_PushStreamingPageCRD | |
kPDFLPrintProg_PushStreamingPageGradient | |
kPDFLPrintProg_PushOnHostTrapBeginPage | |
kPDFLPrintProg_SetOnHostTrapProgressPercent | |
kPDFLPrintProg_StreamingPageImageProgressPercent | |
kPDFLPrintProg_PushBeginStreamingTraps | |
kPDFLPrintProg_SetStreamingTrapPercent |
PDFarEastFont.
PDPDFarEastFont_Download_All | Download all CJK fonts to the printer.
|
PDPDFarEastFont_Download_None | Download only embedded fonts to the printer.
|
PDPDFarEastFont_Print_As_Image | GDI/QuickDraw on PS option. PS Level 1 should use this to print CJK.
|
kPDSingleByteFont = 0x0001 | A fLag to indicate that the font uses a single byte encoding.
|
PDPrintTrapType.
kPDPrintTrapNone = 0x01 | |
kPDPrintTrapInRIP = 0x04 |
PDPrintWhatAnnot.
PDPrintWhatAnnot_NoExtras = 0x01 | |
PDPrintWhatAnnot_TrapAnnots = 0x02 | |
PDPrintWhatAnnot_PrinterMarks = 0x04 |
PDPrintWhatFlip.
kPDPrintFlipNone = 0x01 | |
kPDPrintFlipX = 0x02 | |
kPDPrintFlipY = 0x04 | |
kPDPrintFlipXY = 0x08 |
kPRPrintSuppressXMP = 1 |
For value options see PDDuplexOOptions.
typedef
ASEnum8
PDDuplexEnum
;
typedef
struct
_t_PDFLPrintUserCallbacks
*
PDFLPrintUserCallbacks
;
PDFLPrint.h
, but it is complex and platform-specific. This declaration avoids the need to include the platform specific details into files that just need a decaration of this pointer. typedef
struct
_t_PDFLPrintUserParams
*
PDFLPrintUserParams
;
typedef
struct
_t_PDFLPrintUserParamsEx
*
PDFLPrintUserParamsEx
;
For value options see PDPDFarEastFont_Download_Options.
typedef
ASEnum8
PDFarEastFont
;
For value options see IncludeOptions.
typedef
ASEnum8
PDInclusion
;
For value options see PDOutput_Options.
typedef
ASEnum8
PDOutputType
;
NULL
, indicating that they do nothing. The methods are called in the order listed in this structure. typedef
struct
_t_PDPrintClient
*
PDPrintClient
;
typedef
struct
_t_PDPrintController
*
PDPrintController
;
PDIStyles.
typedef
ASInt32
PDPrintMarkStyles
;
PDPrintTrapTypes.
typedef
ASEnum8
PDPrintTrapType
;
PDPrintWhatAnnot_Options.
typedef
ASEnum8
PDPrintWhatAnnot
;
PDPrintWhatFlipOptions.
typedef
ASEnum8
PDPrintWhatFlip
;
typedef
struct
_t_PPDFeatures
PPDFeaturesRec
,
*
PPDFeaturesP
;
ASBool
PDFLPrintCancelProc(
PDDoc
pdDoc
,
void
*
clientData
);
pdDoc | The document being printed.
|
clientData | A pointer to the client data that was passed in the PDFLPrintUserParamsRec with the call to PDFLPrintDoc.
|
ASBool
PDFLPrintProgressProc(
ASInt32
pageNum
,
ASInt32
totalPages
,
float
current
,
const
char
*
name
,
ASInt32
/* it's a PDFLPrintProgressMarker or PDFLFlattenProgressMarker (see PDFLPrint.h) */
stage
,
void
*
progMonClientData
);
pageNum | the current page
|
totalPages | |
current | |
name | |
stage | a PDFLPrintProgressMarker value.
|
progMonClientData | IN/OUT User-supplied data that was passed in the call to whatever API method required the progress monitor.
|
NULL
, the default is to assume that any font can be emitted. ASBool
PDPrintCanEmitFontProc(
PDFont
fontP
,
PDPrintClient
printClient
);
fontP | The font to check.
|
printClient | The PDPrintClient from which this is invoked.
|
ASBool
PDPrintEmitFontProc(
ASStm
stm
,
PDFont
fontP
,
PDPrintClient
printClient
,
ASUns32
flags
);
stm | The PostScript print stream for the current page.
|
fontP | The font to emit.
|
printClient | The PDPrintClient from which this is invoked.
|
flags | Print flags.
|
ASInt32
PDPrintGetFontEncodingMethodProc(
PDFont
fontP
,
PDPrintClient
printClient
);
fontP | The font whose encoding method is determined.
|
printClient | The PDPrintClient from which this is invoked.
|
Method
| Description
|
---|---|
Use for Type 1 fonts and substituted fonts.
| |
Use for TrueType Windows font or built-in encoding font.
| |
Use for a TrueType custom font or font with Mac OS encoding.
|
| |
Image ink type.
| |
|
| |||||||||
TIFF ASCII tags.
| |||||||||
| Image color.
| ||||||||
Image color type.
| |||||||||
float aldImageCropFixed [ 4 ] ; | The portion of the image to be used.
| ||||||||
The portion of the image to be used (
[left top right bottom] ). REQUIRED. | |||||||||
Included image dimensions.
[width height] REQUIRED. /Size in PDF. | |||||||||
REQUIRED. Image file name.
| |||||||||
Changes to the brightness or contrast of the image.
| |||||||||
Length of the GrayMap array (
2 , 16 , or 256 ). | |||||||||
char * aldImageID ; | Image identifier.
| ||||||||
float aldImagePosition [ 8 ] ; | The location on the page of the cropped image (
[llx lly ulx uly urx ury lrx lry] . REQUIRED. | ||||||||
float aldImageResolution [ 2 ] ; | Image resolution (
[horiz vert] ). | ||||||||
float aldImageTint ; | The concentration of the color in which the image is to be rendered.
| ||||||||
Specifies whether white pixels in the image are to be treated as transparent.
| |||||||||
Specifies the number of samples per pixel and bits per sample in the image (
[samplesPerPixel bitsPerSample] ). | |||||||||
char * aldObjectComments ; | A human-readable comment, typically containing instructions or suggestions to the operator of the OPI server on how to handle the image.
| ||||||||
| Since most parameters are optional, we indicate which were specified. It is required that all unspecified pointer-fields be
NULL , so that error-handlers know exactly which ones to free. | ||||||||
|
| |||||||
float imageCropRect [ 4 ] ; | The portion of the image to be used (
[left top right bottom] ). OPTIONAL. | ||||||
float imageDimensions [ 2 ] ; | The dimensions of the included image (
[width height] ). OPTIONAL. | ||||||
The external file containing the image. The following values are required if
REQUIRED. | |||||||
The colorants to be applied to the image.
| |||||||
Included image dimensions.
| |||||||
float includedImageQuality ; | The quality of the included image.
| ||||||
char * mainImage ; | The path name of the file containing the full-resolution image.
| ||||||
| |||||||
|
| |
OPI version (
1.3 or 2.0 ). | |
OPI 1.3 or 2.0 dictionary.
| |
|
Note: All fields in the PDPrintParams structure apply to PostScript file creation. PDPrintParams are ignored when printing to non-PostScript devices.
| |
The size of the data structure. It must be set to
sizeof(PDPrintParams) . | |
Ranges of pages to print. Use
NULL to print the entire document. | |
The number of ranges of pages to print in ranges. The default value is
0 . | |
true if the page is to be rotated to fit the printer's orientation and centered in the printer's page size; false otherwise.The default value is false . Rotation and centering ( true ) only occur, however, if the page contents are too wide to fit on a narrow page (or vice versa) and the page contents are less than an inch smaller than the target page in one direction. | |
Print the document, the document and comments, or document form fields only.
| |
Annotation flags which modify PDPrintWhat to enable Pro product behavior.
| |
PostScript level:
1 , 2 , or 3 . The default value is 2 . | |
Print PostScript or EPS with or without a preview.
| |
Embed the base fonts. The default value is kIncludeNever.
| |
Embed fonts that are embedded in the PDF file. This overrides the
incType1Fonts , incTrueTypeFonts , and incCIDFonts fields. The default value is kIncludeOncePerDoc. | |
Embed Type 1 fonts. The default value is kIncludeOncePerDoc.
| |
Embed Type 3 fonts. The default value is kIncludeOnEveryPage.
| |
Embed TrueType fonts. The default value is kIncludeOncePerDoc.
| |
Embed CID fonts. The default value is kIncludeOncePerDoc.
| |
Include Procsets in the file. The default value is kIncludeOncePerDoc.
| |
Include all other types of resources in the file. The default value is kIncludeOncePerDoc.
| |
The amount of VM available for font downloading at the document level. It is ignored if it is less than or equal to
0 . | |
Emit save and restore
showpage in PostScript files. The default value is true . | |
Emit TrueType fonts before any other fonts. The default value is
false . | |
(PostScript level 2 only) Set the page size on each page. Use the media box for outputting to PostScript files, use the crop box for EPS files. Default is
false . | |
Write DSC (Document Structuring Conventions) comments. The default value is
true . | |
If procsets are included, also include init/term code. The default value is
true . | |
Emit images for Level-1 separations. The default value is
false . | |
Add
SubFileDecode filter to work around stream problems [ false ]. The SubFileDecode filter will always be emitted when you print as binary. | |
If including TrueType fonts, convert to Type 42 fonts instead of Type 1 fonts. The default value is
false . This parameter is valid only for the Export to PS workflow and not for printing to a printer. | |
float scale ; | The document-wide scale factor.
100.0 = full size. The default value is 100 . |
If an Image resource uses an external stream, emit code that points to the external file. The default value is
false . | |
Preserve any halftone screening in the PDF file. The default value is
false . | |
Emit PostScript XObjects into the PostScript stream [
false ]. | |
If emitting EPS, include only CMYK and gray images.
| |
When emitting the extended graphics state, include the device-dependent parameters (overprint, black generation, undercolor removal, transfer, halftone, halftone phase, smoothness, flatness, rendering intent) in addition to the device-independent parameters (font, line width, line cap, line join, miter limit, dash pattern). If this flag is
false , only the device-independent parameters will be emitted. This flag overrides emitHalftones ; if this is false , then halftones are not emitted. [true] | |
If all zeroes, it is ignored. Otherwise, it is used for
%%BoundingBox DSC comment and in centerCropBox calculations and for setpagedevice . The default value is [0 0 0 0] . | |
Used when printing with system fonts. The default value is
false . | |
Emit a concat at the beginning of each page so that the page is properly rotated. Used when emitting EPS. The default value is
false . | |
If set to
true , reverse the order of page output. | |
Temporary crop box to represent the selected region.
| |
Emit page clip.
| |
Emit transfer.
| |
Emit black generation.
| |
Emit undercolor removal.
| |
GDI to PS or download CJK fonts.
PDPDFarEastFont_Print_As_Image will not be honored. | |
If
true , do not perform CJK substitution on the printer. This will work only when farEastFontOpt is PDPDFarEastFont_Download_None . | |
Do not emit CSAs for 4-component (CMYK) colors. This will take precedence over the
hostbasedCM settings. | |
For separator, do host-based color management.
| |
The output color space when
hostBased color management is true . | |
Sets the duplex mode if the device supports duplex printing. The default value is
kPDDuplexOff . | |
Determines whether to tile none, all, or only large pages.
| |
If non-
NULL , tiling is desired with these parameters. | |
Enable the auto-rotating behavior from past versions of Acrobat.
| |
Do
hostBased color management using the destination profile. The default is false , which means doing CSA generation for profiles instead of converting all colors on the host. | |
char destProfile [ 256 ] ; | If
hostBasedCM color management is true , use this profile. It should be the name of the profile like "U.S. Web Coated (SWOP) v2" and not the name of the file. |
An ASAtom representing the device color space (DeviceGray, DeviceRGB, and so on).
| |
true means try to save VM when printing to PostScript. | |
Do the overprint preview operation.
| |
When
true , suppress OPP for pages that do not contain spot colors | |
If
true , do it fast; false means PostScript code must be page-independent. If it is set to true , font downloads are forced from kIncludeOnEveryPage to kIncludeOncePerDoc. | |
If
true , do not set rendering intent in PostScript stream due to broken non-default CRDs. | |
If
true , store all possible resources in VM. | |
DPI for bitmaps. The default is
300 . This will only work when you set useFullResolutionJP2KData to false ; it should not be less then 50 . | |
DPI for gradients interior to the object (not edges). It can generally be lower than the
bitmapResolution . The default is 150 . | |
The transparency level. The range is
0-100 . | |
The optional-content context to use for visibility state information, or
NULL to use the document's current states in the default context. | |
Print-specific visiblity state settings are always applied from the optional-content group. applyOCGPrintOverrides is no longer honored. It is always considered as true whatever may be the value passed to it.
| |
Determines whether to use the maximum available JPEG2000 resolution.
| |
When
true , it requests that separations, one sheet per ink, be generated in the RIP (printer). It is available only in Acrobat Professional. | |
Page mark indication. It is a bit-wise It applies to print separations, which are available only in Acrobat Professional. | |
When
true , use western style for page marks. It applies to print separations, which are available only in Acrobat Professional. Obsoleted by markStyle below. | |
When
true , print using proofing settings. | |
char proofProfile [ 256 ] ; | Description string for the proofing profile.
|
Proofing settings: simulate ink black.
| |
Proofing settings: simulate paper white.
| |
When
true , emit execform calls when emitting Form XObjects. | |
A structure containing parameters that control tile flattening.
| |
When
true , invert the plate. | |
One of the following constants:
Mirroring is done in the PostScript output stream. | |
Enables collation for the viewer.
| |
Honors the flatness settings over
gstate flatness. | |
| |
This parameter is obsolete from PDFL 10.0. When this is set, emit TrueType fonts as CIDType2 instead of as CIDFontType0.
| |
Specify the style to use for page marks. The
PDPrintMarkStyles enum contains possible styles. It applies to print separations, which are available only in Acrobat Pro. | |
float lineWidth ; | The line weight to use for printer marks.
|
If
markStyle == -1 , this should be a valid file name pointing to a valid.mrk file for custom printer marks. | |
AGMPrintInterface * pAGMPI ; | The AGMP interface pointer. This should not be set by PDF Library SDK clients.
|
void * pAGMPI ; | |
Disable flattening of the PDF file; transparency data will be ignored. Also note the preprocessor define below.
| |
convert Gray to K (any Gray to CMYK (0,0,0,K))
| |
Provide a means for all 4 page rotations to be tiling-exercised at once.
| |
|
| |
char * str ; | The string.
|
Byte length.
| |
Displacements.
| |
The number of glyphs.
| |
Flags. Reserved for internal use.
| |
|
| |
Used for giving information to and from the user.
| |
(pts)
| |
(pts)
| |
Unprintable left edge (pts).
| |
Unprintable bottom edge (pts).
| |
The amount tile indented within the imageable area (pts).
| |
The clockwise rotation angle in degrees for tile.
| |
The optional label string template has 6 parameters it can fill in. If it is
NULL , the label template "$DOC$ $DATE$ $TIME$ $PAGE$ ($ROW$, $COL$)" is used. | |
double driverScale ; | The scale selected by the user in the Print Setup or Printer Properties dialog box.
|
double tileScale ; | The scale for tiled pages.
|
|
| |
|
Used to control printing with PDFLPrintDoc.
To print to a PostScript file, set emitToFile
to true
, fill in printParams
, and create a writeable stream.
To print to a printer, set emitToPrinter
to true
, fill in printParams
, and optionally fill in the command.
Note: UNIX supports only PostScript to a file or printer, as controlled by the (mutually exclusive) emitToFile
and emitToPrinter
parameters.
| |
Size of the data structure. Must be set to sizeof(PDFLPrintUserParamsRec).
| |
PDPrintParams structure. Used for both creating a PostScript file and printing to a printer.
| |
Create a PostScript file. You set either this parameter or emitToPrinter, but not both.
| |
Writable ASStm that points to a file stream or proc stream. It applies to both a PostScript printer and a file.
| |
Width of paper in points. The default value is 612. Applies to a PostScript printer.
| |
Height of paper in points. The default value is 792. Applies to a PostScript printer.
| |
Number of fonts that should not be downloaded. Applies to both a PostScript printer and a file.
| |
char * * dontEmitList ; | List of fonts (T1, TrueType, CID) that should not be downloaded. Applies to both a PostScript printer and a file.
|
Output PDF file to a PostScript printer. Set either this parameter or
emitToFile , but not both. | |
char * command ; | Optional command line arguments. It is used only if
emitToPrinter is true . For example, "lp" or "lpr" applies to a PostScript printer. |
Optional PDFLPrintCancelProc. It applies to both a a PostScript printer and a file.
| |
void * clientData ; | Optional pointer to data passed to
cancelProc . Applies to both a PostScript printer and a file. |
int startResult ; | Spooler ID from StartDoc
|
Optional pointer to structure containing pointers to user callback functions
| |
int nCopies ; | (Optional) Number of copies to print. It applies to a PostScript file.
|
Optional pointer to a structure where you can add additional PPD features like staple, input tray, output tray, duplex mode etc. for output to PostScript file. For more details, see
_t_PPDFeatures | |
(Optional)The name and path of the PPD file from which the PPD features will be emitted to a PostScript file. Use this field alongwith
PPDFeaturesP PPDFeatures . For more details, see _t_PPDFeatures . | |
void * progressClientData ; | |
int transQuality ; | Transparency flattening quality control.
1 is fastest; 5 is best. It applies to a printer. The default is 3 . |
|
Used to control printing with PDFLPrintDoc.
See PDFLPrint.h for details about printing on specific platforms.
To print to a PostScript file, set emitToFile
to true
, fill in printParams
, and create a writeable stream.
To print to a printer, set emitToPrinter
to true
, fill in printParams
, and optionally fill in the command.
Note: UNIX supports only PostScript to a file or printer, as controlled by the mutually exclusive emitToFile
and emitToPrinter
parameters.
| |
Size of the data structure. Must be set to sizeof(PDFLPrintUserParamsRec).
| |
Create a PostScript file. You set either this parameter or emitToPrinter, but not both.
| |
PDPrintParams structure. It is used for both creating a PostScript file and printing to a printer.
| |
Writable ASStm that points to file stm or proc stm. It applies to both a PostScript printer and a file.
| |
Width of paper in points. The default value is 612. It applies to a PostScript printer.
| |
Height of paper in points. The default value is 792. It applies to a PostScript printer.
| |
Number of fonts that should not be downloaded. It applies to both a PostScript printer and a file.
| |
char * * dontEmitList ; | List of fonts (T1, TT, CID) that should not be downloaded. It applies to both a PostScript printer and a file.
|
Output PDF file to a PostScript printer. Set either this parameter or
emitToFile , but not both. | |
char * inFileName ; |
Deprecated. Use the Unicode version
Used for the Windows DOCINFO structure ( |
char * outFileName ; |
Deprecated. Use the Unicode version
Used for the Windows DOCINFO structure ( |
char * deviceName ; |
Deprecated. Use the Unicode version
The name of the device on which to print (for example, |
char * driverName ; |
Deprecated. Use the Unicode version
The name of the driver (for example, |
char * portName ; |
Deprecated. Use the Unicode version
The name of the port (for example, |
DEVMODEA * pDevMode ; |
Deprecated. Use the Unicode version
(Optional) Allows you to pass a DEVMODE structure in if you have one.
If you do not pass in your own DEVMODE structure, PDFL creates its own by calling OpenPrinter(), DocumentProperties(), and ClosePrinter().
PDFL never calls SetPrinter() and has no facility to offer the features provided by SetPrinter() (for example, pause/resume, deleting jobs, changing printer status, etc.). DocumentProperties() is called only in the case where the client does not provide a DEVMODE. |
int startPage ; | Page to start printing with, using zero-based numbering. It applies to a printer.
|
int endPage ; | Page on which to finish printing. It applies to a printer.
|
int shrinkToFit ; | 1 turns on shrink to fit, 0 turns it off. It applies to a PostScript printer. |
int printAnnots ; | 1 turns on printing annotations, 0 turns it off. It applies to a printer. |
int psLevel ; | PostScript level. It applies to a PostScript printer.
|
int nCopies ; | Number of copies to print. It applies to a printer and to a PostScript file.
|
int binaryOK ; | 1 turns on binary data, 0 turns it off. It applies to a PostScript printer. |
int emitHalftones ; | 1 turns on emit half-tones, 0 turns it off. It applies to a PostScript printer. |
int reverse ; | 1 reverses print order, 0 does regular order. It applies to a printer. |
int farEastFontOpt ; | One of PDFarEastFont.The default value is PDPDFarEastFont_Download_All. It applies to a PostScript printer.
PDPDFarEastFont_Print_As_Image will not be honored. |
int transQuality ; | Transparency flattening quality control.
1 is fastest; 5 is best. It applies to a printer. The default is 3 . |
int doOPP ; | 1 uses OverPrint Preview, 0 does not. It applies to a printer. The default is 0 . |
Optional PDFLPrintCancelProc. It applies to both a PostScript printer and a file.
| |
void * clientData ; | Optional pointer to data passed to
cancelProc . It applies to both a PostScript printer and a file. |
int startResult ; | Spooler ID from StartDoc().
|
Used for the Windows DOCINFO structure (
lpszDocName ) that points to a NULL -terminated string that specifying the name of the document. In case of printing/exporting to Postscript, this field sets the Title DSC comment in the generated Postscript file. inFileNameW has precedence over the deprecated inFileName. If neither is provided, the Title DSC comment is filled with the name of pdf document. | |
The name of the device to print to (for example,
"Distiller Assistant v3.01" ). Available devices can be found in the Windows Registry at HKEY_CURRENT_USER\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Devices . It applies to a printer. | |
The name of the driver (for example,
"winspool" ). See the registry key for deviceName . It applies to the printer. | |
The name of the port (for example,
"Ne00" ). See the registry key for deviceName . It applies to the printer. | |
DEVMODEW * pDevModeW ; |
(Optional) Allows you to pass a DEVMODE structure in if you have one.
If you do not pass in your own DEVMODE structure, PDFL creates its own by calling
PDFL never calls |
HDC pDC ; | (Optional) Allows you to pass a DeviceContext structure. If you do not pass in your own DeviceContext structure PDFL creates its own. |
Optional pointer to structure containing pointers to user callback functions
| |
Optional value used for Postscript printing that allows printing with the code path used by the nonps printer instead of the code used by the PS printer
| |
HDC hDC ; | Optional device handle used to allow the device handle used in the user's sample with StartDoc and EndDoc to be passed to the library to be used in StartPage and EndPage.
|
Optional pointer to a structure where you can add additional PPD features like staple, input tray, output tray, duplex mode etc. for output to PostScript file. For more details, see
_t_PPDFeatures | |
(Optional)The name and path of the PPD file from which the PPD features will be emitted to a PostScript file. Use this field alongwith
PPDFeaturesP PPDFeatures . For more details, see _t_PPDFeatures . | |
void * progressClientData ; | |
Force the use of the paper size provided in the PDFLPrintUserParamsRec paperWidth and paperHeight parameters instead of searching for best fit size provided by printer. PDPrintParamsRec setPageSize must also be set for this option.
| |
|
Used to control printing with PDFLPrintDoc.
To print to a PostScript file, set emitToFile
to true, fill in printParams
, and create a writeable stream.
To print to a printer, set emitToPrinter
to true
, fill in printParams
, and optionally fill in the command.
Note: UNIX supports only PostScript to a file or printer, as controlled by the (mutually exclusive) emitToFile
and emitToPrinter
parameters.
| |
Size of the data structure. It must be set to
sizeof(PDFLPrintUserParamsRec) . | |
Create a PostScript file. Set either this parameter or
emitToPrinter , but not both. | |
PDPrintParams structure. It is used both for creating a PostScript file and printing to a printer.
| |
Writable ASStm that points to a file stream or proc stream. It applies to both a PostScript printer and a file.
| |
Width of paper in points. The default value is
612 . It applies to a PostScript printer. | |
Height of paper in points. The default value is
792 . It applies to a PostScript printer. | |
Number of fonts that should not be downloaded. It applies to both a PostScript printer and a file.
| |
char * * dontEmitList ; | List of fonts (T1, TrueType, CID) that should not be downloaded. It applies to both a PostScript printer and a file.
|
Output a PDF file to a PostScript printer. Set either this parameter or
emitToFile , but not both. | |
void * printRecord ; | DO NOT USE: Classic (non-Carbon) printing is no longer supported.
|
PMPrintSession printSession ; | Carbon print session- may be
NULL . It applies to a printer. |
PMPrintSettings printSettings ; | Carbon print settings- may be
NULL . It applies to a printer. |
PMPageFormat pageFormat ; | Carbon page format- may be
NULL . It applies to a printer. |
Optional PDFLPrintCancelProc. It applies to both a PostScript printer and a file.
| |
void * clientData ; | Optional pointer to data passed to
cancelProc . It applies to both a PostScript printer and a file. |
int startPage ; | The page on which to start printing, using zero-based numbering. It applies to a printer.
|
int endPage ; | The page on which to finish printing. It applies to a printer.
|
int shrinkToFit ; | 1 turns on shrink to fit, 0 turns it off. It applies to a PostScript printer. |
int printAnnots ; | 1 turns on printing annots, 0 turns it off. It applies to a printer. |
int psLevel ; | PostScript level. It applies to a PostScript printer.
|
int nCopies ; | The number of copies to print. It applies to a printer and to a PostScript file.
|
int binaryOK ; | 1 turns on binary data, 0 turns it off. It applies to a PostScript printer. |
int emitHalftones ; | 1 turns on emit half-tones, 0 turns them off. It applies to a PostScript printer. |
int reverse ; | 1 reverses print order, 0 does regular order. It applies to a printer. |
int doOPP ; | 1 uses OverPrint Preview, 0 does not. It applies to a printer. The default is 0 . |
Optional pointer to structure containing pointers to user callback functions
| |
Optional pointer to a structure where you can add additional PPD features like staple, input tray, output tray, duplex mode etc. for output to PostScript file. For more details, see
_t_PPDFeatures | |
(Optional)The name and path of the PPD file from which the PPD features will be emitted to a PostScript file. Use this field alongwith
PPDFeaturesP PPDFeatures . For more details, see _t_PPDFeatures . | |
void * progressClientData ; | |
int transQuality ; | Transparency flattening quality control.
1 is fastest; 5 is best. It applies to a printer. The default is 3 . |
|
Used to control printing with PDFLPrintDoc.
See PDFLPrint.h for details about printing on specific platforms.
To print to a PostScript file, set emitToFile
to true
, fill in printParams
, and create a writeable stream.
To print to a printer, set emitToPrinter
to true
, fill in printParams
, and optionally fill in the command.
Note: UNIX supports only PostScript to a file or printer, as controlled by the mutually exclusive emitToFile
and emitToPrinter
parameters.
| |
Size of the data structure. Must be set to sizeof(PDFLPrintUserParamsRec).
| |
Create a PostScript file. You set either this parameter or emitToPrinter, but not both.
| |
PDPrintParams structure. It is used for both creating a PostScript file and printing to a printer.
| |
Writable ASStm that points to file stm or proc stm. It applies to both a PostScript printer and a file.
| |
Width of paper in points. The default value is 612. It applies to a PostScript printer.
| |
Height of paper in points. The default value is 792. It applies to a PostScript printer.
| |
Number of fonts that should not be downloaded. It applies to both a PostScript printer and a file.
| |
char * * dontEmitList ; | List of fonts (T1, TT, CID) that should not be downloaded. It applies to both a PostScript printer and a file.
|
Output PDF file to a PostScript printer. Set either this parameter or
emitToFile , but not both. | |
char * inFileName ; |
Deprecated. Use the Unicode version
Used for the Windows DOCINFO structure ( |
char * outFileName ; |
Deprecated. Use the Unicode version
Used for the Windows DOCINFO structure ( |
char * deviceName ; |
Deprecated. Use the Unicode version
The name of the device on which to print (for example, |
char * driverName ; |
Deprecated. Use the Unicode version
The name of the driver (for example, |
char * portName ; |
Deprecated. Use the Unicode version
The name of the port (for example, |
DEVMODEA * pDevMode ; |
Deprecated. Use the Unicode version
(Optional) Allows you to pass a DEVMODE structure in if you have one.
If you do not pass in your own DEVMODE structure, PDFL creates its own by calling OpenPrinter(), DocumentProperties(), and ClosePrinter().
PDFL never calls SetPrinter() and has no facility to offer the features provided by SetPrinter() (for example, pause/resume, deleting jobs, changing printer status, etc.). DocumentProperties() is called only in the case where the client does not provide a DEVMODE. |
int startPage ; | Page to start printing with, using zero-based numbering. It applies to a printer.
|
int endPage ; | Page on which to finish printing. It applies to a printer.
|
int shrinkToFit ; | 1 turns on shrink to fit, 0 turns it off. It applies to a PostScript printer. |
int printAnnots ; | 1 turns on printing annotations, 0 turns it off. It applies to a printer. |
int psLevel ; | PostScript level. It applies to a PostScript printer.
|
int nCopies ; | Number of copies to print. It applies to a printer and to a PostScript file.
|
int binaryOK ; | 1 turns on binary data, 0 turns it off. It applies to a PostScript printer. |
int emitHalftones ; | 1 turns on emit half-tones, 0 turns it off. It applies to a PostScript printer. |
int reverse ; | 1 reverses print order, 0 does regular order. It applies to a printer. |
int farEastFontOpt ; | One of PDFarEastFont.The default value is PDPDFarEastFont_Download_All. It applies to a PostScript printer.
PDPDFarEastFont_Print_As_Image will not be honored. |
int transQuality ; | Transparency flattening quality control.
1 is fastest; 5 is best. It applies to a printer. The default is 3 . |
int doOPP ; | 1 uses OverPrint Preview, 0 does not. It applies to a printer. The default is 0 . |
Optional PDFLPrintCancelProc. It applies to both a PostScript printer and a file.
| |
void * clientData ; | Optional pointer to data passed to
cancelProc . It applies to both a PostScript printer and a file. |
int startResult ; | Spooler ID from StartDoc().
|
Used for the Windows DOCINFO structure (
lpszDocName ) that points to a NULL -terminated string that specifying the name of the document. In case of printing/exporting to Postscript, this field sets the Title DSC comment in the generated Postscript file. inFileNameW has precedence over the deprecated inFileName. If neither is provided, the Title DSC comment is filled with the name of pdf document. | |
The name of the device to print to (for example,
"Distiller Assistant v3.01" ). Available devices can be found in the Windows Registry at HKEY_CURRENT_USER\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Devices . It applies to a printer. | |
The name of the driver (for example,
"winspool" ). See the registry key for deviceName . It applies to the printer. | |
The name of the port (for example,
"Ne00" ). See the registry key for deviceName . It applies to the printer. | |
DEVMODEW * pDevModeW ; |
(Optional) Allows you to pass a DEVMODE structure in if you have one.
If you do not pass in your own DEVMODE structure, PDFL creates its own by calling
PDFL never calls |
HDC pDC ; | (Optional) Allows you to pass a DeviceContext structure. If you do not pass in your own DeviceContext structure PDFL creates its own. |
Optional pointer to structure containing pointers to user callback functions
| |
Optional value used for Postscript printing that allows printing with the code path used by the nonps printer instead of the code used by the PS printer
| |
HDC hDC ; | Optional device handle used to allow the device handle used in the user's sample with StartDoc and EndDoc to be passed to the library to be used in StartPage and EndPage.
|
Optional pointer to a structure where you can add additional PPD features like staple, input tray, output tray, duplex mode etc. for output to PostScript file. For more details, see
_t_PPDFeatures | |
(Optional)The name and path of the PPD file from which the PPD features will be emitted to a PostScript file. Use this field alongwith
PPDFeaturesP PPDFeatures . For more details, see _t_PPDFeatures . | |
void * progressClientData ; | |
Force the use of the paper size provided in the PDFLPrintUserParamsRec paperWidth and paperHeight parameters instead of searching for best fit size provided by printer. PDPrintParamsRec setPageSize must also be set for this option.
| |
|
NULL
, indicating that they do nothing. The methods are called in the order listed in this structure.
| |
The size of the structure.
| |
The document to print.
| |
A control structure describing how to print the document.
| |
ACCBPROTO1 void ( ACCBPROTO2 * DocBegin ) ( const PDPageRange ranges [ ] , ASInt32 numRanges , ASStm stm , const PDResTree docTree , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. Begin processing a document for printing.
|
ACCBPROTO1 ASBool ( ACCBPROTO2 * DocSetup ) ( const PDPageRange ranges [ ] , ASInt32 numRanges , ASStm prologStm , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. Set up a document for printing.
|
(Optional) A callback for PDPrintClient. End the setup for printing a document. One task that might be performed here is to broadcast a notification for each range of pages that will be printed, as in this pseudo code:
| |
(Optional) A callback for PDPrintClient. It is called once for each page printed. A client can use this notification to update the page number in the message pane, for example. | |
ACCBPROTO1 void ( ACCBPROTO2 * PageBegin ) ( ASStm stm , ASInt32 pageNum , const PDResTree pageTree , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. It is called before a page begins printing.
|
ACCBPROTO1 ASBool ( ACCBPROTO2 * BeforePageSetup ) ( ASStm stm , ASInt32 pageNum , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. It is called before a page is printed to set it up. (And before the %%BeginpageSetup DCS)
|
(Optional) A callback for PDPrintClient. It is called before a page is printed to set it up.
| |
ACCBPROTO1 void ( ACCBPROTO2 * PageSetupPostResource ) ( ASStm stm , ASInt32 pageNum , PDPrintClient printClient ) | A callback for PDPrintClient. PageSetupPostResource() is called from PDPrintPageBegin() after the resource tree has been processed (all fonts and other resources emitted into the PostScript stream).
|
(Optional) A callback for PDPrintClient. It mirrors PageSetup; PageCleanup is called before we clean our dictionaries.
| |
ACCBPROTO1 void ( ACCBPROTO2 * EmitPageContents ) ( ASStm stm , ASInt32 pageNum , PDPage pdPage , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. It emits the page contents for printing. It broadcasts a notification that the page has been printed:
There is a default callback for PostScript printing. |
ACCBPROTO1 void ( ACCBPROTO2 * PageEnd ) ( ASStm stm , ASInt32 pageNum , ASBool veryLastPage , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. It is called after a page has printed. It broadcasts a notification that the page has printed:
|
ACCBPROTO1 void ( ACCBPROTO2 * DocEnd ) ( ASStm stm , PDPrintClient printClient , PDPrintController controller ) | In order for the Mac platform to emit color comments, the controller needs to be passed to the
DocEnd client callback. The client then calls PDPrintFillColorUsageBuf() to fill in the data for the injection point used by the print manager to emit the custom color comments. |
(Optional) A callback for PDPrintClient. It ends processing a document for printing.
| |
This routine is called to ask the client what encoding method should be used for the font. This cannot be
NULL for PostScript printing. | |
(Optional) A callback for PDPrintClient. It asks the client what the VM usage is for the font.
| |
ACCBPROTO1 void ( ACCBPROTO2 * EmitPSFontBegin ) ( ASStm stm , PDFont fontP , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. It is called before a font is emitted (outside DSC comments).
|
(Optional) A callback for PDPrintClient. It is called after a font is emitted (outside DSC comments).
| |
ACCBPROTO1 ASBool ( ACCBPROTO2 * EmitPSFontEncodingBegin ) ( ASStm stm , PDFont fontP , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. It is called before a font encoding is emitted.
|
ACCBPROTO1 void ( ACCBPROTO2 * EmitPSFontEncodingEnd ) ( ASStm stm , PDFont fontP , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. It is called after a font encoding is emitted.
|
ACCBPROTO1 void ( ACCBPROTO2 * EmitPSResourceBegin ) ( ASStm stm , ASAtom resType , const char * resName , CosObj resObj , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. It is called before a PostScript resource is emitted.
|
ACCBPROTO1 void ( ACCBPROTO2 * EmitPSResourceEnd ) ( ASStm stm , ASAtom resType , const char * resName , CosObj resObj , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. It is called after a PostScript resource is emitted.
|
A callback for PDPrintClient.
ShouldCancel is called at least once per page. It should return true if the print job should be cancelled (typically, the user hit a key combination to cancel printing). | |
A callback for PDPrintClient.
CancelPrintJob is called to actually cause the print job to be cancelled. It should stop further printing and preferably should remove the incomplete print job. | |
ACCBPROTO1 ASInt32 ( ACCBPROTO2 * FlushString ) ( char * data , ASInt32 nData , PDPrintClient printClient ) | (Required) A callback for PDPrintClient. It is called when the ASStm buffer is full. Buffered data should be sent to the printer, driver, file, or other destination. Not used for non-PostScript printing.
|
ACCBPROTO1 ASInt32 ( ACCBPROTO2 * EmitPrologString ) ( const char * s , ASInt32 nData , PDPrintClient printClient ) | (Optional) A callback for PDPrintClient. It emits a prolog string. It defaults to a method that calls FlushString(). |
This routine is called to determine whether a font can be emitted into the print job. This is used to determine whether a font is a document-included resource. It is only used for PostScript. OPTIONAL: The default is to assume that any font can be emitted. | |
REQUIRED. This routine is called to emit a font. For Type0 fonts that require font substition, this routine may emit multiple font definitions. The caller can get the list of fonts used by calling GetFontComponentList().
| |
ACCBPROTO1 ASBool ( ACCBPROTO2 * UndefineFont ) ( ASStm stm , PDFont fontP , ASBool vmUndefine , PDPrintClient client ) | (Required) UndefineFont() is called to remove the font from the list of fonts that have been downloaded and to undefine the font from PostScript VM. It may be called during a page, at the end of the page, or between pages. After this routine is called, if the font is required again, the EmitFont() routine will be called.
|
(Optional) A callback for PDPrintClient. EmitFontProcSet() is called while emitting the document prolog. It should emit any procsets required to download the font. The routine will be called once for each font in the document. However, each procset only needs to be downloaded once per document.
| |
ACCBPROTO1 ASBool ( ACCBPROTO2 * EmitGlyphsIncr ) ( ASStm stm , PDFont fontP , PDPrintStrP srcStr , PDPrintStrP dstStr , ASUns32 * srcBytesUsed , ASUns32 * dstBytesUsed , ASUns32 * glyphCount , ASUns16 * fontIndex , PDPrintClient printClient ) | A callback for PDPrintClient. It emits glyphs incrementally.
|
ACCBPROTO1 void ( ACCBPROTO2 * GetComponentFontList ) ( PDFont fontP , PDPrintFontArrayP fontList , PDPrintClient printClient ) | (Required) A callback for PDPrintClient. GetComponentFontList() is called to get the list of component font names used for substitution. For fonts that do not require substitution or are substituted by only one font, the list returned should only have one element. For a Type 0 font that requires several fonts for font substitution, the list will have multiple fonts. The font names returned are the names used by the font definitions downloaded to PostScript. The font definitions themselves are downloaded by a call to the EmitFont() routine.
|
(Required) A callback for PDPrintClient. FlushIncrGlyphList() is called to flush the list of glyphs that have been incrementally download since the calls to EmitFont or the last call of FlushIncrGlyphList. This routine will be called if the caller generates PostScript code that would flush glyphs procedures that have been downloaded to the PostScript interpreter. For example, if at the beginning of each page, a save is executed and then at the end of a page, a restore is executed, any glyph procedures downloaded after the beginning of the page will be removed when the restore is executed. The call to FlushIncrGlyphList() indicates that all the glyphs need to be redownloaded, by calls to EmitGlyphsIncr(). | |
(Optional) A callback for PDPrintClient. If this method is supplied, then during PostScript printing, it will be called when a form or image containing an OPI dictionary is encountered. If it returns
true , then the client is presumed to have taken care of the entire form or image, and PDFL will emit nothing. Otherwise, PDFL will generate OPI comments based on the dictionary. | |
ACCBPROTO1 ASUns32 ( ACCBPROTO2 * DataSourceString ) ( PDFileSpec f , char * buf , ASUns32 bufSize , void * clientData ) | (Optional) If this method is supplied, and the The DataSource is used thus:
where |
The current page, starting at
1 . | |
void * clientData ; | Data for the client's use. This data is passed to the
OPIhandler and DataSourceString methods. |
void * fontDownloadContext ; | For the client's use to hold a font download context for the EmitFontProcSet.
|
The amount of virtual memory used. It is incremented by routines that download fonts and resources.
| |
Optional. If
ProgressMonitor , then during PostScript printing, it will be called when page uses the flattener to print. | |
void * progMonClientData ; | |
For use in the Exchange product, when emitting the time/date of the print job (the
PageInfo mark for separations), this callback takes an ASText object and the client side fills in the timeDate with a localized representation of the current date and time. This could be called from the Tiling code as well. | |
Pro product only.
| |
ACCBPROTO1 void ( ACCBPROTO2 * GetClientPaperSize ) ( PDPrintClient printClient , ASFixed * height , ASFixed * width , ASBool * custom ) | For internal use of PDFL. SDK clients must set this parameter to
NULL . |
Output stream for creating postscript file.
| |
|
| |
Size of the data structure. It must be set to
sizeof(PPDFeaturesRec) . | |
Optional. Specifies the Input Tray of the printer. For eg. Upper
| |
Optional. Specifies the Onput Tray of the printer. For eg. Left
| |
Optional. Specifies the Duplex mode. For eg. DuplexTumble
| |
Optional. Specifies the location for stapling. For eg. SinglePortrait. Either
StapleLocation should be used or both StapleX and StapleY to specify the location for stapling. | |
Optional. Specifies the StapleX. For eg. Left. Also read the comment on
StapleLocation | |
Optional. Specifies the StapleY. For eg. Top. Also read the comment on
StapleLocation | |
Optional. Specifies the orientation of the stapling. For eg. 45
| |
Optional. Specifies when to staple. For eg. EndOfPage
| |
|
| |
The tag number
| |
Tag text list.
| |
For OPI 1.3, the
TextList contains only one element. | |
|
| |
char * name ; | Name of the colorant.
|
float level ; | Concentration of the colorant.
|
Pointer to next list element.
| |
|
TIFFASCIITagList
.
| |
char * name ; | Tag name.
|
Pointer to next list element.
| |
|
Note: Users of the PDFLPrintDoc() method do not have to create the PDPrintClient() callbacks. That detail is handled by the library.
void
PDFLPrintDoc(
PDDoc
doc
,
PDFLPrintUserParams
userParams
);
doc | The PDDoc for the document to print.
|
userParams | Parameters to control printing.
|
Note: Users of the PDFLPrintDoc() method do not have to create the PDPrintClient() callbacks. That detail is handled by the library.
void
PDFLPrintDocEx(
PDDoc
doc
,
PDFLPrintUserParamsEx
userParams
);
doc | The PDDoc for the document to print.
|
userParams | Parameters to control printing.
|
void
PDFLPrintPDF(
PDDoc
pdDoc
,
ASPathName
pathName
,
PDPrintParams
psParams
);