Layer

PDFL Library Layer

11 components164 items
61 Functions 47 Definitions 34 Typedefs 14 Structures 8 Enums

ASFileSys

2 items

Functions(2)

ASFileSysSetDefaultTempPath

PDFLProcs.h:148

Sets the default temporary path for the specified file system to the specified path name. The method copies the passed pathname object on success; the client is responsible for releasing the object when it is no longer needed, using ASFileSysReleasePath(). Pass a pathname of NULL to reset the default temporary path to the file system default.

Parameters
fileSys: ASFileSys

(May be NULL ) The file system in which to set the default temporary path.

pathName: ASPathName

The path name for the new default temporary path, or NULL to reset to the file system default.

Returns
ASBool

false if the path provided is not writable, true otherwise.

CosDoc

1 items

Definitions(1)

cosSaveWriteXref

PDFLExpT.h:2503
Value:0x20 /* write the xref (for Forms) */

Flags for CosDocSave saveFlags parameter. This is specific to the PDF Library.

General

48 items

Functions(23)

ASAtomGetCount

PDFLProcs.h:128

Gets the number of ASAtom objects that have been allocated. The maximum number of ASAtom objects is 0xFFFFFFFF . (This was a 16-bit value in Acrobat 4.x, and changed to a 32-bit value in Acrobat 5.0). ASAtom objects cannot be deleted or freed. Use this method to determine if it is necessary to re-initialize the library before creating more ASAtom objects.

Parameters
: void
Returns
ASInt32

The number of ASAtom objects currently allocated.

ASPurgeMemory

PDFLProcs.h:111

Attempts to free memory from the PDF Library caches. The caches in the PDF Library can grow in complex and unexpected ways. A client can manage memory use with the PDFLInit memory callbacks, or by explicitly calling this function after certain functions, such as PDDocClose(). To manage memory use with the memory callbacks, a client can call ASPurgeMemory() during the allocation callback if it is low on memory, or to limit the amount of memory used by the library. Use this approach only with extreme caution and extensive testing. The run-time memory requirements are very document-specific.

Parameters
amount: ASSize_t

The desired amount of memory to free.

Returns
ASSize_t

The approximate amount of memory freed.

AVExtensionMgrRegisterNotification

void AVExtensionMgrRegisterNotification(NSelector nsel, ASExtension owner, void *proc, void *clientData)
PDFLProcs.h:593

Registers a user-supplied procedure to call when the event of the specified type occurs. This is exactly the same as the AVAppRegisterNotification() method. All of the PD level notifications are available with the Adobe PDF Library.

Parameters
nsel: NSelector

Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidPrintPage() is PDDocDidPrintPageNSEL . Only the PD-level notifications are available with the Adobe PDF Library.

owner: ASExtension

Identifies the owner. For the Adobe PDF Library, if there is only one owner of the PDFEdit subsystem, owner should be zero. If there are multiple owners, each should specify a nonzero, non-negative owner. (A negative owner is reserved for the implementation).

proc: void *

A user-supplied callback to be called when the notification occurs. Its declaration depends on the notification type.

clientData: void *

A pointer to user-supplied data to pass to proc each time it is called.

Returns
void

AVExtensionMgrUnregisterNotification

void AVExtensionMgrUnregisterNotification(NSelector nsel, ASExtension owner, void *proc, void *clientData)
PDFLProcs.h:613

Unregisters a user-supplied procedure to call when the specified event occurs. This is exactly the same as the AVAppUnregisterNotification() method.

Parameters
nsel: NSelector

Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidOpen() is PDDocDidOpenNSEL .

owner: ASExtension

Identifies the owner with which the notification was registered.

proc: void *

A user-supplied callback with which the notification was registered.

clientData: void *

A pointer to user-supplied data that was used when the notification was registered.

Returns
void

PDFLGetFlags

PDFLProcs.h:719

Gets the flags set when the PDF Library was initialized. Currently kPDFLInitIgnoreDefaultDirectories , kPDFLInitIgnoreSystemFonts and kDontLoadPlugIns flags are supported. When kPDFLInitIgnoreDefaultDirectories flag is set, the initialization process does not search through the default font directories (currently Adobe font directories installed by some Adobe applications), but only searches for fonts in those directories specified in dirList . A default directory could appear as follows: C:\Program Files\Common Files\Adobe\PDFL\[ version number ]\Fonts C:\Program Files\Common Files\Adobe\PDFL\[ version number ]\CMaps When kPDFLInitIgnoreSystemFonts flag is set, the initialization process does not search through default System fonts also. When the kDontLoadPlugIns flag is set, plug-ins are ignored during initialization process.

Parameters
: void
Returns
ASUns32

The initialization flags value.

See Also

PDFLGetVersion

PDFLProcs.h:668

Gets the value of the Adobe PDF Library version (kPDFLVersion). The most significant 16 bits are the major version number; the least significant 16 bits are the minor version number. The major version number indicates whether any incompatible API changes have been made. The minor version number indicates that the API has changed, but in a compatible fashion. Obsolete in PDF Library 6.0. Use HFTGetVersion() instead.

Parameters
: void
Returns
ASUns32

Adobe PDF Library version (kPDFLVersion).

See Also

PDFLInit

ASInt32 PDFLInit(PDFLData data)
PDFInit.h:973

Initializes the Adobe PDF Library. This method must be called before any other Library calls can be made, printing or otherwise.

Parameters
data: PDFLData

Initialization data for Adobe PDF Library.

Returns
ASInt32

0 if initialization was successful, or an error code if it was not. Use ASGetErrorString() to convert any error code to a string.

PDFLTerm

void PDFLTerm(void)
PDFLProcs.h:678

Terminates the Adobe PDF Library. Call this method after you are completely done using the library. Call this once to terminate and release memory used by the library. After the library has been shut down, the process should terminate.

Parameters
: void
Returns
void
See Also

PDFLibraryRegisterNotification

void PDFLibraryRegisterNotification(NSelector nsel, ASExtension owner, void *proc, void *clientData)
PDFLProcs.h:62

Registers a user-supplied procedure to call when the specified event occurs. This is exactly the same as the AVAppRegisterNotification method. All of the PD level notifications are available with the Adobe PDF Library.

Parameters
nsel: NSelector

Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidPrintPage() is PDDocDidPrintPageNSEL . Only the PD-level notifications are available with the Adobe PDF Library.

owner: ASExtension

Identifies the owner. For the Adobe PDF Library, if there is only one owner of the PDFEdit subsystem, owner should be zero. If there are multiple owners, each should specify a nonzero, non-negative owner. (A negative owner is reserved for the implementation).

proc: void *

A user-supplied callback to be called when the notification occurs. Its declaration depends on the notification type.

clientData: void *

A pointer to user-supplied data to pass to proc each time it is called.

Returns
void

PDFLibraryRegisterNotificationEx

void PDFLibraryRegisterNotificationEx(NSelector nsel, ASExtension owner, void *proc, void *clientData, ASInt32 priority)
PDFLProcs.h:818

Registers a user-supplied procedure to call when the specified event occurs. Many notifications appear in Will/Did pairs (for example, AVDocWillPerformAction() and AVDocDidPerformAction()). It is possible that an operation may fail after the Will notification and before the Did notification. When this occurs, the Did notification is still broadcast, but the err parameter in the Did notification is nonzero, and represents the error that occurred. When err is nonzero, the other parameters are not necessarily valid. Always check err in a Did notification before using the other parameters. When calling AVAppUnregisterNotification() to un-register for a notification, you must pass the proc , clientData , and owner that were used when the notification was registered using AVAppRegisterNotification(). You must use the same callback that was used to register; you cannot use a newly created callback. To accomplish this, call ASCallbackCreateNotification() once before registering, and use the value returned from this call both to register and un-register; do not call ASCallbackCreateNotification() a second time when un-registering. You will then need to destroy the pointer to the callback using the ASCallbackDestroy() method.

Parameters
nsel: NSelector

The notification type. It must be one of the notification selectors . The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for AVDocDidOpen() is AVDocDidOpenNSEL .

owner: ASExtension

The gExtensionID of the client registering the notification.

proc: void *

A user-supplied callback to call when the notification occurs. Its declaration depends on the notification type. Remember to use ASCallbackCreateNotification() to convert proc to a callback before passing it to AVAppRegisterNotification().

clientData: void *

A pointer to user-supplied data to pass to proc each time it is called.

priority: ASInt32

The callbacks are enumerated in priority order, starting with the highest priority.

Returns
void

PDFLibraryRegisterRNG

PDFLProcs.h:833

Registers a user-supplied random number generator. By default, the PDF Library obtains high-quality random values from the operating system (CryptGenRandom() on Windows, and /dev/random on Mac OS and many UNIX operating systems). This method allows an alternate handler to be used. The random numbers returned should be of high quality, and it is the responsibility of the developer to ensure this. A NULL parameter will reset to default behavior.

Parameters
clientRNG: PDFLClientRNGProc

A client-supplied function that supplies the strong random values.

Returns
void

PDFLibraryUnregisterNotification

void PDFLibraryUnregisterNotification(NSelector nsel, ASExtension owner, void *proc, void *clientData)
PDFLProcs.h:87

Unregisters a user-supplied procedure to call when the specified event occurs. This is exactly the same as the AVAppUnregisterNotification() method.

Parameters
nsel: NSelector

Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidOpen() is PDDocDidOpenNSEL .

owner: ASExtension

Identifies the owner. For the PDF Library, if there is only one owner of the PDFEdit subsystem, owner should be zero. If there are multiple owners, each should specify a nonzero, non-negative owner. (A negative owner is reserved for the implementation).

proc: void *

A user-supplied callback to be called when the notification occurs. Its declaration depends on the notification type. You must use the same callback that you called AVExtensionMgrRegisterNotification() with.

clientData: void *

A pointer to user-supplied data to pass to proc each time it is called.

Returns
void

Typedefs(17)

PDDoExtGStateProc

typedef ASBool(* PDDoExtGStateProc) (ASAtom egsKey, CosObj egsValue, PDPrintClient printClient))(ASAtom egsKey, CosObj egsValue, PDPrintClient printClient)
PDFLExpT.h:1812

A callback method that is called when an ExtGState object is encountered. This method is called for each key/value pair in the ExtGState object. If this method returns true , then the key/value will be emitted into the print job. If this method returns false , then nothing will be emitted for this key/value. If emitHalftones is false , then this method will not be called for the HT key.

See Also

PDFLClientRNGProc

typedef ASSize_t(* PDFLClientRNGProc) (ASSize_t len, ASUns8P buffer))(ASSize_t len, ASUns8P buffer)
PDFLExpT.h:106

A callback for PDFLibraryRegisterRNG(). It is called once to provide random data for encryption. Normally an operating system supplied source of highly random numbers is used ( /dev/urandom on Mac OS and Unix, CryptGenRandom() on Windows). For some supported Unix environments, the /dev/urandom device does not exist. While it is preferable to install this device, the PDFLibraryRegisterRNG() function is provided for the client to register an alternate source for strong random data.

Structures(1)

Definitions(7)

PDDoc

1 items

Functions(1)

PDDocPrintPages

PDFLProcs.h:186

Prints a range of pages from a document, controlled by a structure of data and callbacks. This low-level method should be avoided; use the higher-level PDFLPrintDoc() instead.

Parameters
client: PDPrintClient

Control structure for the operation, containing data and callback procedures.

Returns
void

PDFLPrint

32 items

Functions(3)

PDFLPrintDoc

void PDFLPrintDoc(PDDoc doc, PDFLPrintUserParams userParams)
PDFLProcs.h:743

Prints a PDF document or pages from a PDF document allowing the caller to specify options such as page size, rotation, and shrink-to-fit. Users of the PDFLPrintDoc() method do not have to create the PDPrintClient() callbacks. That detail is handled by the library.

Parameters
doc: PDDoc

The PDDoc for the document to print.

userParams: PDFLPrintUserParams

Parameters to control printing.

Returns
void

PDFLPrintDocEx

PDFLProcs.h:774

Prints a PDF document or pages from a PDF document allowing the caller to specify options such as page size, rotation, and shrink-to-fit. Users of the PDFLPrintDoc() method do not have to create the PDPrintClient() callbacks. That detail is handled by the library. Platform: (WIN_ENV)

Parameters
doc: PDDoc

The PDDoc for the document to print.

userParams: PDFLPrintUserParamsEx

Parameters to control printing.

Returns
void

Typedefs(10)

PDFLPrintCancelProc

typedef ASBool(* PDFLPrintCancelProc) (PDDoc pdDoc, void *clientData))(PDDoc pdDoc, void *clientData)
PDFLPrint.h:68

This is called once per page of a document being printed. In addition to giving the ability to cancel the print job, a developer can use this callback to return control briefly to an application to handle events, update UI elements, and so on. The library pauses printing until the return from this procedure, because it is single-threaded.

PDPrintGetFontEncodingMethodProc

typedef ASInt32(* PDPrintGetFontEncodingMethodProc) (PDFont fontP, PDPrintClient printClient))(PDFont fontP, PDPrintClient printClient)
PDFLExpT.h:1833

(Required for PostScript printing) A callback for PDPrintClient. It asks the client which encoding method should be used for the font. Method Description kPDDoReencode Use for Type 1 fonts and substituted fonts. kPDDoNothing Use for TrueType Windows font or built-in encoding font. kPDDoXlate Use for a TrueType custom font or font with Mac OS encoding.

See Also

Structures(9)

PDFLPrintUserParams

typedef struct _t_PDFLPrintUserParams* PDFLPrintUserParams
PDFLExpT.h:2486

Declare the type PDFLPrintUserParams, which is a pointer to a structure and is passed into PDFLPrintDoc. This structure is defined in , 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.

PDPrintClient

typedef struct _t_PDPrintClient* PDPrintClient
PDFLExpT.h:1548

A data structure used by PDDocPrintPages(). It contains methods to be implemented by the client. Unless otherwise indicated, methods may be NULL, indicating that they do nothing. The methods are called in the order listed in this structure.

Enums(8)

ALDImageColorType

PDFLExpT.h:1581

OPI 1.3 color type information.

Values
ALDImageColorType_Spot
—

Spot color type.

ALDImageColorType_Process
—

Process color type.

ALDImageColorType_Separation
—

Separation color type.

ALDImageColorType_Intrinsic
—

Intrinsic color type.

ImageInk

PDFLExpT.h:1663

OPI 2.0 image ink information.

Values
ImageInk_Registration
—

Image colorant registration value.

ImageInk_FullColor
—

Image colorant full color value.

ImageInk_Monochrome
—

Image colorant monochrome value

OPIversion

PDFLExpT.h:1571

OPI Types for PostScript printing.

Values
OPIv13
—

OPI version 1.3.

OPIv20
—

OPI version 2.0.

PDFLPrintProgressMarker

PDFLPrint.h:73

An enumeration of the various stages that might be involved in printing a PDF. For use with PDFLPrintProgressProc.

Values
kPDFLPrintProg_PopLastProgress
—
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
—

PDPrintTrapTypes

PDFLExpT.h:491
Values
kPDPrintTrapNone
—
kPDPrintTrapInRIP
—
Values
kPDPrintFlipNone
—
kPDPrintFlipX
—
kPDPrintFlipY
—
kPDPrintFlipXY
—

Definitions(2)

PDFont

8 items

Functions(6)

PDFontPSEmitGlyphsIncr

ASBool PDFontPSEmitGlyphsIncr(ASStm stm, PDFont fontP, PDPrintStrP srcStr, PDPrintStrP dstStr, ASUns32 *srcBytesUsedP, ASUns32 *dstBytesUsedP, ASUns32 *glyphCount, ASUns16 *fontIndexP, PDPrintClient printClient)
PDFLProcs.h:407

Emit glyphs incrementally. This is the default EmitGlyphsIncr callback procedure for the PDPrintClient structure.

Parameters
stm: ASStm

The stream.

fontP: PDFont

The font.

srcStr: PDPrintStrP

The source string.

dstStr: PDPrintStrP

The destination string.

srcBytesUsedP: ASUns32 *

The source bytes used.

dstBytesUsedP: ASUns32 *

The destination bytes used.

glyphCount: ASUns32 *

The number of glyphs.

fontIndexP: ASUns16 *

The font index.

printClient: PDPrintClient

The control structure.

Returns
ASBool

true if successful, false otherwise.

PDFontStreamPS

PDFLProcs.h:250

Emits a font into a specified stream. The font is in a format suitable for downloading to a PostScript VM. For example, a TrueType font is converted into a Type 1 or Type 42 font. It is meant for use in the EmitFont callback for PDDocPrintPages().

Parameters
fontP: PDFont

The font to emit.

stm: ASStm

The ASStm into which the font is emitted.

context: PDFontDownloadContext

A context created by PDFontDownloadContextCreate.

Returns
ASBool

true if successful, false otherwise.

PDFontWasFauxed

PDFLProcs.h:312

Tests whether the specified font is embedded in the PDF file or is installed in the user's system. If this is the case, the correct font can be used for display and printing. If the font is not embedded or installed, the Acrobat viewer has used a Multiple Master font to create a substitute font, called a faux font.

Parameters
font: PDFont

The font to test.

Returns
ASBool

true if the font has been substituted, false otherwise.

Typedefs(1)

Structures(1)

PDFontDownloadContext

3 items

Functions(2)

PDFontDownloadContextCreate

PDFLProcs.h:265

Creates a font download context object. This object keeps track of the fonts downloaded during a print job and whether substitution fonts have already been downloaded. It also tracks the font download parameters, such as binaryOK and 'emit TrueType as Type 42' . It is meant for use in the PDFontStreamPS() method.

Parameters
client: PDPrintClient

The client record to pass to PDDocPrintPages().

Returns
PDFontDownloadContext

The newly-created context.

Structures(1)

PDPage

47 items

Functions(6)

PDPageDrawContentsPlacedToWindow

void PDPageDrawContentsPlacedToWindow(PDPage page, void *window, void *displayContext, ASBool isDPS, ASFixedMatrix *matrix, ASFixedRect *updateRect, CancelProc cancelProc, void *cancelProcClientData)
PDFLProcs.h:230

Draws the page to the window or display context. The window and display context are implementation-dependent.

This method is the same as PDPageDrawContentsToWindow(), except that it raises an exception if the pdPermCopy (see PDPerms) permission is not set in the document.

Platform: ((!MAC_PLATFORM || !AS_ARCH_64BIT)) && ((!MAC_PLATFORM))

Parameters
page: PDPage
window: void *
displayContext: void *
isDPS: ASBool
matrix: ASFixedMatrix *
updateRect: ASFixedRect *
cancelProc: CancelProc
cancelProcClientData: void *
Returns
void

PDPageDrawContentsPlacedWithParams

void PDPageDrawContentsPlacedWithParams(PDPage page, PDDrawParams params)
PDFLProcs.h:522

Draws the page to the window or display context. The window and display context are implementation-dependent. This method is the same as PDPageDrawContentsToWindow(), except that it raises an exception if the pdPermCopy (see PDPerms) permission is not set in the document. This method is also like PDPageDrawContentsPlacedToWindow(), only passing in a PDDrawParams structure which lets the clients specify their own PDOCContext. Platform: ((!MAC_PLATFORM || !AS_ARCH_64BIT)) && ((!MAC_PLATFORM))

Parameters
page: PDPage

The page to render.

params: PDDrawParams

Allows clients to specify their own PDOCContext.

Returns
void

PDPageDrawContentsToMemory

ASInt32 PDPageDrawContentsToMemory(PDPage page, ASUns32 flags, ASFixedMatrix *matrix, ASFixedRect *updateRect, ASUns32 smoothFlags, ASAtom csAtom, ASInt32 bpc, ASFixedRect *destRect, char *buffer, ASInt32 bufferSize, CancelProc cancelProc, void *cancelProcData)
PDFLProcs.h:499

Superseded by PDPageDrawContentsToMemoryEx() in Acrobat 10.0. Renders a page to memory. The width of the image is calculated as follows:

width = abs(ASFixedRoundToInt16(destRect.right) - ASFixedRoundToInt16(destRect.left));

width = ((((width * bpc * nComps)+31) / 32) * 4) * 8 / (bpc * nComps);

nComps = 1 for DeviceGray, 3 for DeviceRGB, 4 for DeviceCMYK

bpc = bits per component

Parameters
page: PDPage
flags: ASUns32
matrix: ASFixedMatrix *

A pointer to the matrix to be concatenated onto the default page matrix. It must not be NULL .

updateRect: ASFixedRect *

A pointer to the rectangle to draw, defined in user space coordinates. Any objects outside of updateRect will not be drawn. All objects are drawn if updateRect is NULL .

smoothFlags: ASUns32

A bit field of PDPageDrawSmoothFlags(). It must be an OR of the following flags:

kPDPageDrawSmoothText

kPDPageDrawSmoothLineArt

kPDPageDrawSmoothImage

kPDPageDrawSmoothBicubicImage

kPDPageImageResampleBicubic

kPDPageImageResampleLinear

kPDPageImageAntiAlias

kPDPageDrawSmoothAATextDDR

kPDPageDrawSmoothAATextPreview

csAtom: ASAtom

The color space in which the bitmap data is represented. It must be one of DeviceGray, DeviceRGB, or DeviceCMYK.

bpc: ASInt32

The number of bits per color component in the bitmap data. 8 is the only valid value for DeviceCMYK and DeviceRGB color spaces. 1 and 8 are valid for DeviceGray.

destRect: ASFixedRect *

A pointer to the rectangle of the bitmap. It is defined in device space coordinates. It must not be NULL .

buffer: char *

A pointer to the bitmap data. If it is NULL , this function returns the size of the buffer needed for the bitmap.

bufferSize: ASInt32

The size of the buffer.

cancelProc: CancelProc

A method to call to check whether drawing should be cancelled. If the method returns true , drawing is stopped, nothing is erased, and the buffer contains whatever was drawn up to the current state.

cancelProcData: void *

User-supplied data to pass to cancelProc each time it is called.

Returns
ASInt32

The size of the bitmap in bytes.

PDPageDrawContentsToMemoryEx

ASUns32 PDPageDrawContentsToMemoryEx(PDPage page, ASCab flags, ASDoubleMatrix *matrix, ASDoubleRect *updateRect, ASAtom csAtom, ASInt32 bpc, ASDoubleRect *destRect, char *buffer, ASUns32 bufferSize, CancelProc cancelProc, void *cancelProcData)
PDFLProcs.h:931

Supersedes PDPageDrawContentsToMemory() in Acrobat 10.0. Renders a page to memory. It uses double precision input parameters. The width of the image is calculated as follows: width = abs(ROUND(destRect.right) - ROUND(destRect.left)); width = ((((width * bpc * nComps)+31) / 32) * 4) * 8 / (bpc * nComps); nComps = 1 for DeviceGray, 3 for DeviceRGB, 4 for DeviceCMYK bpc = bits per component where, ROUND() rounds off double precision values to nearest Int32 value.

Parameters
page: PDPage

The page to render.

flags: ASCab

ASCab used for passing PDPageDrawFlagsStr and PDPageDrawSmoothFlagsStr.

matrix: ASDoubleMatrix *

A pointer to double matrix to be concatenated onto the default page matrix. It must not be NULL .

updateRect: ASDoubleRect *

A pointer to the double rectangle to draw, defined in user space coordinates.

csAtom: ASAtom

The color space in which the bitmap data is represented.

bpc: ASInt32

The number of bits per color component in the bitmap data.

destRect: ASDoubleRect *

A pointer to double rectangle of the bitmap. It is defined in device space coordinates. It must not be NULL .

buffer: char *

A pointer to the bitmap data. If it is NULL , this function returns the size of the buffer needed for the bitmap.

bufferSize: ASUns32

The size of the buffer.

cancelProc: CancelProc

A method to call to check whether drawing should be cancelled.

cancelProcData: void *

User-supplied data to pass to cancelProc each time it is called.

Returns
ASUns32

The size of the bitmap in bytes.

PDPageGetSize

void PDPageGetSize(PDPage page, ASFixed *width, ASFixed *height)
PDFLProcs.h:284

Returns the width and height of the page, which could be rotated or defaulted.

Parameters
page: PDPage

The page whose size is being obtained.

width: ASFixed *

(Filled by the method) The width of the page.

height: ASFixed *

(Filled by the method) The height of the page.

Returns
void

Definitions(37)

kPDPageNoDitherStr

PDFLExpT.h:1355
Value:"NoDither" /* disable dithering when rendering image */

PDPref

19 items

Functions(18)

PDPrefSetAntialiasLevel

void PDPrefSetAntialiasLevel(ASUns32 antialiasPixelLevel)
PDFLProcs.h:342

Sets the default smooth text and smooth images global flags for subsequent rendering methods. If the function PDPageDrawContentsToMemory() is used for drawing, the smoothFlags value passed to that function supersedes the preference value for the duration of the call.

Parameters
antialiasPixelLevel: ASUns32

The antialias level, in pixels. It is an OR of the following flags:

kPDPrefAASmoothText

kPDPrefAASmoothLineArt

kPDPrefAASmoothImage

Returns
void

PDPrefSetBlackPointCompensation

PDFLProcs.h:372

Sets the black-point compensation flag, which controls whether to adjust for differences in black points when converting colors between color spaces. When enabled, the full dynamic range of the source space is mapped into the full dynamic range of the destination space. When disabled, the dynamic range of the source space is simulated in the destination space (which can result in blocked or gray shadows).

Parameters
kbpc: ASBool

true to enable black-point compensation, false otherwise.

Returns
void

None.

PDPrefSetGreekLevel

void PDPrefSetGreekLevel(ASInt16 greekPixelLevel)
PDFLProcs.h:322

Sets the greek level . The greek level is a text height below which text characters are not rendered. Instead, text-like glyphs that have no meaning but look good at very small size are used. This is known as greeking .

Parameters
greekPixelLevel: ASInt16

The greek level, in pixels.

Returns
void

PDPrefSetWorkingGray

void PDPrefSetWorkingGray(void *profile, ASUns32 profileLength)
PDFLProcs.h:651

Sets the current gray working space to a given ICC profile. A gray working space in PDF is defined as a profile to substitute for a corresponding /DeviceGray space. When rendering with overprint preview, the gray substitution is suppressed, to avoid converting grayscale to "rich black."

Parameters
profile: void *

A pointer to a buffer containing the ICC color profile.

profileLength: ASUns32

The length in bytes of the profile.

Returns
void

Typedefs(1)

PDTextSelect

1 items

Structures(1)

PDResTree

typedef struct _t_PDResTree* PDResTree
PDBasicExpT.h:155

A selection of text on a single page that may contain more than one disjoint group of words. A text selection is specified by one or more ranges of text, with each range containing the word numbers of the selected words. Each range specifies a start and end word, where "start" is the first of a series of selected words and "end" is the first word not in the series.

pdflattener

2 items

Typedefs(1)

Structures(1)