PD_Layer.General (Acrobat)

	Define
	_BASIC_EXP_T_
	fxDefaultPageDuration
	fxDefaultTransDuration
	IN
	include
	include
	kPDEmitEasternTileMarks Tile marks.
	kPDEmitNoMarks Nothing.
	kPDEmitSlug Emit information about the document, name, page number, and so on.
	kPDEmitWesternTileMarks Tile marks.
	MAX_PWCHARS
	name
	OUT
	PD_ALL_CAP
	PDEvenPagesOnly
	PD_FIXED_WIDTH
	PDFONTFLAGS_USEDBYFORM
	PD_FORCE_BOLD
	PD_ITALIC
	PDLastOneByteEncoding
	PDLastPage
	PDMetadataError
	_PDMetadataHFT_IS_BETA
	_PDMetadataHFT_LAST_BETA_COMPATIBLE_VERSION
	_PDMetadataHFT_LATEST_VERSION
	PDMetadataHFT_LATEST_VERSION
	PDMetadataHFTName
	PDMetadataHFT_VERSION_5
	PDMetadataHFT_VERSION_6
	PDMetadataHFT_VERSION_7
	PDMetadataHFT_VERSION_8
	PDMetadataNUMSELECTORS
	PDOddPagesOnly
	pdOpAddResource
	pdOpRemoveResource
	PD_PI
	PD_SCRIPT
	PD_SEGASCII
	PD_SEGBINARY
	PD_SEGEOF
	PD_SERIF
	PD_SMALL_CAP
	PD_STD_ENCODING
	PDUnicodeEncoding
	PEX1
	PEX1
	PEX2
	PEX2
	PSNAMESIZE
	_T_PDTHUMB__
	W_ACCENT An accent mark.
	W_CNTL A control code.
	W_COMMA A comma. Commas and periods are treated separately from other punctuation marks because they are used both as word punctuation marks and as delimiters in numbers, and need to be treated differently in the two cases.
	W_DIGIT A digit.
	W_END_PHRASE An end-of-phrase glyph (for example, ".", "?", "!", ":", and ";").
	WF_VERSION_2 The version used for Acrobat 3.x, 4.x.
	WF_VERSION_3 For Acrobat 5.0 without accessibility enabled.
	WF_VERSION_4 For Acrobat 5.0 with accessibility enabled.
	W_HYPHEN A hyphen.
	W_LETTER A lowercase letter.
	W_LIGATURE A ligature.
	W_PERIOD A period.
	W_PUNCTUATION A punctuation mark.
	W_SOFT_HYPHEN A hyphen that is only present because a word is broken across two lines of text.
	W_UNMAPPED A glyph that cannot be represented in the destination font encoding.
	W_UPPERCASE An uppercase letter.
	W_WHITE A white space glyph.
	W_WILD_CARD A wildcard glyph (for example, "*" and "?") that should not be treated as a normal punctuation mark.
	W_WORD_BREAK A glyph that acts as a delimiter between words.
	WXE_ADJACENT_TO_SPACE The character following the end of the word is a space (either an explicit space character encoded in a string, or one that appears implicitly because the drawing point was moved).
	WXE_ENC_MISSING
	WXE_ENC_NO_UCS
	WXE_ENCODING_WARNING
	WXE_ENC_UNMAPPED
	WXE_EXT_CHAR_OFFSETS
	WXE_FROM_ACTUALT
	WXE_FRONT_TAB
	WXE_HAS_DIGIT One or more characters in the word are digits.
	WXE_HAS_HYPHEN There is a hyphen in the word.
	WXE_HAS_LEADING_PUNC The first character in the word is a punctuation mark. If this bit is set, WXE_HAS_PUNCTUATION will also be set.
	WXE_HAS_LETTER The word contains a character between A-Z or a-z.
	WXE_HAS_LIGATURE The word contains a ligature.
	WXE_HAS_NONALPHANUM The word contains a character outside the range of A-Z, a-Z, 0-9.
	WXE_HAS_PUNCTUATION One or more characters in the word are punctuation marks. Other flag bits can be checked to test whether the punctuation was at the beginning of the word (WXE_HAS_LEADING_PUNC), the end of the word (WXE_HAS_TRAILING_PUNC), or elsewhere in the word.
	WXE_HAS_SOFT_HYPHEN There is a soft hyphen in the word.
	WXE_HAS_TRAILING_PUNC The last character in the word is a punctuation mark. If this bit is set, WXE_HAS_PUNCTUATION will also be set.
	WXE_HAS_UNMAPPED_CHAR One or more characters in the word cannot be represented in the output font encoding.
	WXE_HAS_UPPERCASE The word contains a character between A-Z.
	WXE_LAST_WORD_ON_LINE The word is at the end of the current text line (for example, the word is followed by a line break).
	WXE_PDF_ORDER
	WXE_RD_ORDER_SORT
	WXE_REVERSE_DIRECTION
	WXE_ROTATED The writing direction of the word is not in a multiple of 90 degrees, or the bounding box of the text is skewed. This flag indicates that the quads of the word should be used to specify the highlight area correctly.
	WXE_STREAM
	WXE_VERTICAL_FLOW The writing direction of the word is either 90 or 180 degrees. This flag ignores the page rotation parameter of the page dictionary. Therefore, if the page is rotated 90 degrees, this flag will be set on each word that appears horizonally on the screen.
	WXE_WBREAK_WORD WordAttributes
	WXE_WORD_IS_UNICODE
	WXE_XY_SORT

	Typedef
	HiliteEntry
	PDApplyRedactionParams
	PDApplyRedactionParamsRec
	PDChromaticity
	PDColorCal
	PDColorCalP
	PDColorConvertAction
	PDColorConvertActionEx
	PDColorConvertObjectAttributes
	PDColorConvertParams
	PDColorConvertParamsEx
	PDColorConvertSpaceType
	PDColorValue
	PDColorValueRec
	PDConstColorValue
	PDContent A pointer to a PDContent struct.
	PDDrawParams
	PDDrawParamsRec
	PDHostSepsPlate
	PDHostSepsPlateRec
	PDHostSepsSpec
	PDHostSepsSpecRec
	PDNavigator Opaque object representing a collection navigator dictionary.
	PDRedactParams
	PDRedactParamsRec
	PDResourceEnumMonitor A data structure containing callbacks used when enumerating the resources of a form with PDFormEnumResources() or PDPageEnumResources().
	PDResourceEnumMonitorRec
	PDResTree 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.

	Enumeration
	`PDCharSet` An enumerated data type that identifies the character set of a Type 1, Multiple Master Type 1, or TrueType font.
	`PDColorConvertActionType` Action types: these specify what to do when an object is matched.
	`PDColorConvertObjectAttributeFlags` Object attributes: these are arranged as a bitmap.
	`PDColorConvertSpaceTypeFlags` Color Space attributes: these are arranged as a bitmap.
	`PDColorSpace` An enumerated data type that specifies the color space in which a color value is specified (for example, RGB or grayscale).
	`PDEmitPlateFlags`
	`PDInkTypes` Ink types.
	`PDLayoutMode` A structure that defines the layout of a document. The layout can be set as the viewer's avpPageViewLayoutMode preference (set by AVAppSetPreference()) or in a view of a document by the pageViewLayoutMode field in AVDocViewDef (set by AVDocGetViewDef()).
	`PDMarksStyle`
	`PDRotate` Specifies page rotation, in degrees. It is used for routines that set or get the value of a page's Rotate key.
	`PDSaveFlags` Flags for the PDDocSave saveFlags parameter. All undefined flags should be set to zero.
	`PDSaveFlags2` More flags for the PDDocSave() saveFlags parameter (PDSaveFlags2). All undefined flags should be set to zero. The first three flags, PDSaveUncompressed, PDSaveCompressed, and PDSaveCompressStructureOnly, are mutually exclusive; they can all be off, but at most one can be on.

	Variable
	exportFilter
	gPDModelHFT
	gPDModelVersion
	importFilter
	monClientData Adds text annotations from sourceDoc to doc.
	numNotesP
	pdanArray
	unused4 Creates a document containing empty pages plus text annotations (notes) from sourceDoc. It does not create a new document if sourceDoc contains no notes.

	Structure
	_t_HiliteEntry A data structure representing a single entry (the starting location and length) in a highlight list.
	_t_PDApplyRedactionParams Parameters used for applying redaction marks.
	_t_PDChromaticity A data structure containing a monitor's chromaticity, for use in displaying device-independent color.
	_t_PDColorCal A data structure used to represent the characteristics of an output device; it is needed for device-independent color.
	_t_PDColorValueRec A data structure representing a color. The number of elements needed in the value field depends on the color space type (specified in the space field). See PDColorSpace for more information.
	_t_PDDrawParams Parameters used for optional-content drawing control. The parameters are the same as those passed to the original version of the method, with the addition of an optional-content context that determines what contents are visible. This structure is not available on Mac 64.
	_t_PDHostSepsPlateRec Used to specify per-plate options when doing separations.
	_t_PDHostSepsSpecRec Used to control the generation of separations from Acrobat.
	_t_PDRedactParams Parameters used to represent the properties for a redaction mark.
	_t_PDResourceEnumMonitor A data structure containing callbacks used when enumerating the resources of a form with PDFormEnumResources() or PDPageEnumResources().
	PDColorConvertActionRec Defines a color conversion action for a combination of attributes, color space/family, and rendering intent. If all three match, the actions in the action list will be executed for any given object.
	PDColorConvertActionRecEx Defines a color conversion action for a combination of attributes, color space/family, and rendering intent. If all three match, actions in the action list will be executed for any given object.
	PDColorConvertParamsRec The list of actions in PDColorConvertParams is analogous to the list of filters in most email clients: each object is compared against the selection criteria for each of the actions, in order, until a matching action is found. The action is then executed on the object. Note that actions do not chain, except in the case of aliased ink definitions.
	PDColorConvertParamsRecEx The list of actions in PDColorConvertParams is analogous to the list of filters in most email clients: each object is compared against the selection criteria for each of the actions, in order, until a matching action is found. The action is then executed on the object. Note that actions do not chain, except in the case of aliased ink definitions. This is the Extended structure, which supports additional elements in the PDColorConvertActionRecEx action.

	Callback
	PDAuthProc A callback used by PDDocOpen. It is called when an encrypted document is being opened to determine whether the user is authorized to open the file.
	PDAuthProcEx A callback used by PDDocOpenEx(). It is called when an encrypted document is opened, to determine whether the user is authorized to open the file.
	PDColorConvertReportProc
	PDGetDataProc A callback for PDXObjectGetData(). It is passed the XObject's data. Currently, the XObject's data is read 1 kB at a time and passed to this callback.
	PDImplicitMetadataProc Calculates implicit metadata. Clients that maintain metadata items that have to be recalculated should register for the PDDocCalculateMetadata() notification with this callback. The callback should obtain the metadata with which it is concerned, change it, and put the changed metadata back in the object from which it was obtained.
	PDLaunchActionProc (Optional) A callback for PDFileSpecHandler. It launches a specified file. It is called when the Acrobat viewer encounters a Launch (GoTo File) action. If this callback is NULL, no launch action is performed.
	PDResourceEnumColorSpaceProc A callback for PDResourceEnumMonitor. It is called for color space resources.
	PDResourceEnumFontProc A callback for PDResourceEnumMonitor. It is a procedure called for font resources.
	PDResourceEnumProcSetProc A callback for PDResourceEnumMonitor. It is a procedure called for ProcSet resources.
	PDResourceEnumXObjectProc A callback for PDResourceEnumMonitor. It is a procedure called for XObject resources.
	PDStringEnumProc A callback for PDTextEnum(). It is called once for each string in a text object.

	Method
	void PDApplyFunction(CosObj funcDict, const inVals, float outVals) Given a CosObj that represents a function, it applies the function to the supplied values.
	void PDApplyFunctionEx(CosObj funcDict, const inVals, const ASArraySize nInput, float outVals, const ASArraySize nOutput) Given a CosObj that represents a function, it applies the function to the supplied values.
	PDEElement PDColorConvertPDEElement(PDDoc doc, PDEElement elem, AC_Profile targetProfile, AC_RenderIntent intent, ASBool embed) Converts a PDEElement to the supplied color space.
	PDEElement PDColorConvertPDEElementEx(PDDoc doc, PDEElement elem, PDColorConvertParamsEx params) Converts a PDEElement to the supplied color space.
	void PDDrawCosObjToWindow(CosObj cosObj, void* window, void* displayContext, ASBool isDPS, ASFixedMatrix* matrix, ASFixedRect* updateRect, CancelProc cancelProc, void* cancelProcClientData) Draws the specified stream of PDF marking operators into the specified window. This method is used for platform-independent drawing of graphics and text. This API is not available on Mac 64.
	void PDDrawCosObjWithParams(CosObj cosObj, PDDrawParams params) Provides control over the rendering of contents, including both those parameters you would pass to PDDrawCosObjWithParams(), and an optional-content context that determines which contents are visible. This API is not available on Mac 64.
	ASUns32 PDDrawPageOrCosObjectToBuffer(PDPage pdPage, CosObj cosStreamObj, ASAtom csFamily, AC_Profile iccProfile, AC_RenderIntent* renderIntent, ASInt32 bitsPerComponent, ASCab flags, ASInt32 greekTextLevel, PDOCContext ocContext, const ASRealMatrix* matrix, const ASRealRect* destRect, const ASRealRect* updateRect, char* buffer, ASUns32 bufferSize, ASStatusMonitorProcs statusMonitor) PDDrawPageOrCosObjectToBuffer
	void PDEnumDocs(PDDocEnumProc proc, void* clientData) Enumerates the PDDoc objects that are currently open, calling a user-supplied procedure for each open document.
	PDAnnotHandler PDGetAnnotHandlerByName(ASAtom name) Gets the annotation handler that handles the specified annotation type.
	ASHostEncoding PDGetHostEncoding() Indicates what kind of host encoding a system uses. It allows you to determine whether a system is Roman or non-Roman. (Non-Roman is also known as CJK-capable, which means that it is capable of handling multi-byte character sets such as Chinese, Japanese, or Korean).
	ASUns8** PDGetPDFDocEncoding() Gets an array describing the differences between the platform's host encoding and PDFDocEncoding.
	ASInt32 PDHostMBLen(const char* cp) Gets the number of additional bytes required for the multi-byte character pointed to by cp. If cp points to a single-byte character, 0 is returned. This method makes it possible to determine the length of multi-byte character strings to allocate space for them.
	ASBool PDPrefGetBlackPointCompensation() Returns the black-point compensation flag.
	ASBool PDPrefGetColorCal(PDColorCalP colorCal) Gets the values to use for displaying the calibrated color and grayscale. These values are the chromaticity and gammas of the phosphors in the monitor.
	ASBool PDPrefGetUseOutputIntents() Returns the value of the Output Intent flag. When this flag is true, the system overrides the working space with the Output Intent, if it is present.
	void PDPrefSetBlackPointCompensation(ASBool kbpc) 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).
	ASBool PDPrefSetColorCal(PDColorCalP colorCal) Sets the values to use for displaying the calibrated color and grayscale. These values are the chromaticities and gammas of the phosphors in the monitor.
	void PDPrefSetUseOutputIntents(ASBool flag) Sets the Output Intent flag.
	void PDPrefSetWorkingCMYK(void* profile, ASUns32 profileLength) Sets the current CMYK working space to a given ICC profile. A CMYK working space in PDF is defined as a profile to substitute for a corresponding /DeviceCMYK space.
	void PDPrefSetWorkingGray(void* profile, ASUns32 profileLength) 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.
	void PDPrefSetWorkingRGB(void* profile, ASUns32 profileLength) Set the current RGB working space to a given ICC profile. An RGB working space in PDF is defined as a profile to substitute for a corresponding /DeviceRGB space.
	ASBool PDRedactionGetProps(PDAnnot redactionAnnot, PDRedactParams redactionProps) Retrieves a set of properties for a given redaction mark.
	ASBool PDRedactionSetProps(PDAnnot redactionAnnot, PDRedactParams redactionProps) Assigns a set of properties to a given redaction mark.
	void PDRegisterCryptHandler(PDCryptHandler handler, const char* pdfName, const char* userName) Registers a new security handler with the Acrobat viewer.
	void PDRegisterCryptHandlerEx(PDCryptHandler handler, const char* pdfName, const char* userName, void* clientData) Registers a new security handler with the Acrobat viewer. It is the same as PDRegisterCryptHandler() except that it accepts a client data parameter.
	void PDRegisterFileSpecHandler(ASFileSys contextFileSys, PDFileSpecHandler fileSpecHandler, void* fileSpecHandlerObj) Registers a new file specification handler with the Acrobat viewer. In version 3.0 and later of the Acrobat viewer, use the PDRegisterFileSpecHandlerByName method instead.
	void PDRegisterFileSpecHandlerByName(ASAtom specSysName, ASFileSys contextFileSys, PDFileSpecHandler fileSpecHandler, void* fileSpecHandlerObj) Registers a new file specification handler with the Acrobat viewer. The viewer calls the appropriate file specification handler when it encounters a file specification in a PDF file. The appropriate file specification handler is the one whose specSysName matches the value of the FS key in the file specification and whose contextFileSys matches the file system on which the PDF file resides.
	void PDSetHostEncoding(ASHostEncoding encoding, char* parseTable) For internal use only.
	void PDXlateToASText(const char* inHostString, ASInt32 inHostStringSize, ASText outPDFString) Returns an ASText object corresponding to a host encoded string.
	void PDXlateToHost(char* in, char* out, ASInt32 numBytes) Translates a string from PDFDocEncoding to host encoding. This method is useful when setting or retrieving displayed text that must be in PDFDocEncoding (or Unicode), such as text that appears in a text annotation or bookmark.
	ASInt32 PDXlateToHostASText(const ASText inPdfString, char* outHostString, ASInt32 outHostStringSize) Returns a host encoded string corresponding to an ASText object.
	ASInt32 PDXlateToHostEx(const char* inPdfStr, ASInt32 inPdfStrSize, char* outHostStr, ASInt32 outHostStrSize) Translates a string from Unicode or PDFDocEncoding to host encoding. This method is useful when setting or retrieving displayed text that might be in Unicode, such as text that appears in a text annotation or bookmark.
	void PDXlateToPDFDocEnc(char* in, char* out, ASInt32 numBytes) Translates a string from host encoding to PDFDocEncoding. This method is useful when setting or retrieving displayed text that must be in PDFDocEncoding (or Unicode), such as text that appears in a text annotation or bookmark.
	ASInt32 PDXlateToPDFDocEncEx(ASBool bUseUnicode, const char* inHostStr, ASInt32 inHostStrSize, char* outPDFStr, ASInt32 outPDFStrSize) Translates a string from host encoding to PDFDocEncoding or Unicode. This method is useful when using text that must be in PDFDocEncoding or Unicode, such as text in a text annotation, bookmark, or article title.

Defines Detail

_BASIC_EXP_T_

Product availability: All

Platform availability: All

Syntax


#define _BASIC_EXP_T_ 1

File: PDBasicExpT.h

Line: 23

_PDMetadataHFT_IS_BETA

Product availability: All

Platform availability: All

Syntax


#define _PDMetadataHFT_IS_BETA 0

File: PDMetadataCalls.h

Line: 91

_PDMetadataHFT_LAST_BETA_COMPATIBLE_VERSION

Product availability: All

Platform availability: All

Syntax


#define _PDMetadataHFT_LAST_BETA_COMPATIBLE_VERSION 0x00080000

File: PDMetadataCalls.h

Line: 90

_PDMetadataHFT_LATEST_VERSION

Product availability: All

Platform availability: All

Syntax


#define _PDMetadataHFT_LATEST_VERSION 0x00080000

File: PDMetadataCalls.h

Line: 89

_T_PDTHUMB__

Product availability: All

Platform availability: All

Syntax


#define _T_PDTHUMB__

File: PDBasicExpT.h

Line: 107

fxDefaultPageDuration

Product availability: All

Platform availability: All

Syntax


#define fxDefaultPageDuration -fixedOne

File: PDExpT.h

Line: 3936

fxDefaultTransDuration

Product availability: All

Platform availability: All

Syntax


#define fxDefaultTransDuration fixedOne

File: PDExpT.h

Line: 3937

Product availability: All

Platform availability: All

Syntax


#define IN

File: PDMetadataCalls.h

Line: 105

include

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define include h"

File: PDCalls.h

Line: 233

include

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define include h"

File: PDMetadataCalls.h

Line: 131

kPDEmitEasternTileMarks

Product availability: All

Platform availability: All

Syntax


#define kPDEmitEasternTileMarks 0x0002

Description

Tile marks.

File: PDExpT.h

Line: 6153

kPDEmitNoMarks

Product availability: All

Platform availability: All

Syntax


#define kPDEmitNoMarks 0

Description

Nothing.

File: PDExpT.h

Line: 6143

kPDEmitSlug

Product availability: All

Platform availability: All

Syntax


#define kPDEmitSlug 0x0004

Description

Emit information about the document, name, page number, and so on.

File: PDExpT.h

Line: 6158

kPDEmitWesternTileMarks

Product availability: All

Platform availability: All

Syntax


#define kPDEmitWesternTileMarks 0x0001

Description

Tile marks.

File: PDExpT.h

Line: 6148

MAX_PWCHARS

Product availability: All

Platform availability: All

Syntax


#define MAX_PWCHARS 255

File: PDExpT.h

Line: 4179

name

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define name ##SEL,

File: PDCalls.h

Line: 178

OUT

Product availability: All

Platform availability: All

Syntax


#define OUT

File: PDMetadataCalls.h

Line: 106

PD_ALL_CAP

Product availability: All

Platform availability: All

Syntax


#define PD_ALL_CAP 0x00010000

File: PDExpT.h

Line: 2191

PD_FIXED_WIDTH

Product availability: All

Platform availability: All

Syntax


#define PD_FIXED_WIDTH 0x00000001

File: PDExpT.h

Line: 2185

PD_FORCE_BOLD

Product availability: All

Platform availability: All

Syntax


#define PD_FORCE_BOLD 0x00040000

File: PDExpT.h

Line: 2193

PD_ITALIC

Product availability: All

Platform availability: All

Syntax


#define PD_ITALIC 0x00000040

File: PDExpT.h

Line: 2190

PD_PI

Product availability: All

Platform availability: All

Syntax


#define PD_PI 0x00000004

File: PDExpT.h

Line: 2187

PD_SCRIPT

Product availability: All

Platform availability: All

Syntax


#define PD_SCRIPT 0x00000008

File: PDExpT.h

Line: 2188

PD_SEGASCII

Product availability: All

Platform availability: All

Syntax


#define PD_SEGASCII ((ASUns8) 1)

File: PDExpT.h

Line: 2265

PD_SEGBINARY

Product availability: All

Platform availability: All

Syntax


#define PD_SEGBINARY ((ASUns8) 2)

File: PDExpT.h

Line: 2266

PD_SEGEOF

Product availability: All

Platform availability: All

Syntax


#define PD_SEGEOF ((ASUns8) 3)

File: PDExpT.h

Line: 2267

PD_SERIF

Product availability: All

Platform availability: All

Syntax


#define PD_SERIF 0x00000002

File: PDExpT.h

Line: 2186

PD_SMALL_CAP

Product availability: All

Platform availability: All

Syntax


#define PD_SMALL_CAP 0x00020000

File: PDExpT.h

Line: 2192

PD_STD_ENCODING

Product availability: All

Platform availability: All

Syntax


#define PD_STD_ENCODING 0x00000020

File: PDExpT.h

Line: 2189

PDEvenPagesOnly

Product availability: All

Platform availability: All

Syntax


#define PDEvenPagesOnly ((PDPageNumber) -5)

File: PDExpT.h

Line: 2100

PDFONTFLAGS_USEDBYFORM

Product availability: All

Platform availability: All

Syntax


#define PDFONTFLAGS_USEDBYFORM 0x00000001

File: PDExpT.h

Line: 2147

PDLastOneByteEncoding

Product availability: All

Platform availability: All

Syntax


#define PDLastOneByteEncoding PDLastKnownEncoding

File: PDExpT.h

Line: 2238

PDLastPage

Product availability: All

Platform availability: All

Syntax


#define PDLastPage ((PDPageNumber) -2)

File: PDExpT.h

Line: 2097

PDMetadataError

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDMetadataError ErrBuildCode(ErrAlways, ErrSysPDMetadata, e)

File: AcroErr.h

Line: 319

PDMetadataHFT_LATEST_VERSION

Product availability: All

Platform availability: All

Syntax


#define PDMetadataHFT_LATEST_VERSION  _PDMetadataHFT_LATEST_VERSION)

File: PDMetadataCalls.h

Line: 94

PDMetadataHFT_VERSION_5

Product availability: All

Platform availability: All

Syntax


#define PDMetadataHFT_VERSION_5 0x00050000

File: PDMetadataCalls.h

Line: 96

PDMetadataHFT_VERSION_6

Product availability: All

Platform availability: All

Syntax


#define PDMetadataHFT_VERSION_6 0x00060000

File: PDMetadataCalls.h

Line: 97

PDMetadataHFT_VERSION_7

Product availability: All

Platform availability: All

Syntax


#define PDMetadataHFT_VERSION_7 0x00070000

File: PDMetadataCalls.h

Line: 98

PDMetadataHFT_VERSION_8

Product availability: All

Platform availability: All

Syntax


#define PDMetadataHFT_VERSION_8 0x00080000

File: PDMetadataCalls.h

Line: 99

PDMetadataHFTName

Product availability: All

Platform availability: All

Syntax


#define PDMetadataHFTName "PDMetadata"

File: PDMetadataHFTVers.h

Line: 24

PDMetadataNUMSELECTORS

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDMetadataNUMSELECTORS (PDMetadataNUMSELECTORSplusOne - 1)

File: PDMetadataCalls.h

Line: 148

PDOddPagesOnly

Product availability: All

Platform availability: All

Syntax


#define PDOddPagesOnly ((PDPageNumber) -4)

File: PDExpT.h

Line: 2099

pdOpAddResource

Product availability: All

Platform availability: All

Syntax


#define pdOpAddResource pdOpAddResources

File: PDExpT.h

Line: 1019

pdOpRemoveResource

Product availability: All

Platform availability: All

Syntax


#define pdOpRemoveResource pdOpRemoveResources

File: PDExpT.h

Line: 1018

PDUnicodeEncoding

Product availability: All

Platform availability: All

Syntax


#define PDUnicodeEncoding PDLastKnownEncoding

File: PDExpT.h

Line: 2239

PEX1

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PEX1

File: PDMetadataCalls.h

Line: 117

PEX1

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PEX1 ACEX1

File: PDMetadataCalls.h

Line: 122

PEX2

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PEX2 ACCB2

File: PDMetadataCalls.h

Line: 118

PEX2

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PEX2 ACEX2

File: PDMetadataCalls.h

Line: 123

PSNAMESIZE

Product availability: All

Platform availability: All

Syntax


#define PSNAMESIZE 64

File: PDExpT.h

Line: 2180

W_ACCENT

Product availability: All

Platform availability: All

Syntax


#define W_ACCENT 0x800

Description

An accent mark.

File: PDExpT.h

Line: 3397

W_CNTL

Product availability: All

Platform availability: All

Syntax


#define W_CNTL 0x1

Description

A control code.

File: PDExpT.h

Line: 3338

W_COMMA

Product availability: All

Platform availability: All

Syntax


#define W_COMMA 0x200

Description

A comma. Commas and periods are treated separately from other punctuation marks because they are used both as word punctuation marks and as delimiters in numbers, and need to be treated differently in the two cases.

File: PDExpT.h

Line: 3387

W_DIGIT

Product availability: All

Platform availability: All

Syntax


#define W_DIGIT 0x8

Description

A digit.

File: PDExpT.h

Line: 3353

W_END_PHRASE

Product availability: All

Platform availability: All

Syntax


#define W_END_PHRASE 0x2000

Description

An end-of-phrase glyph (for example, ".", "?", "!", ":", and ";").

File: PDExpT.h

Line: 3407

W_HYPHEN

Product availability: All

Platform availability: All

Syntax


#define W_HYPHEN 0x20

Description

A hyphen.

File: PDExpT.h

Line: 3363

W_LETTER

Product availability: All

Platform availability: All

Syntax


#define W_LETTER 0x2

Description

A lowercase letter.

File: PDExpT.h

Line: 3343

W_LIGATURE

Product availability: All

Platform availability: All

Syntax


#define W_LIGATURE 0x80

Description

A ligature.

File: PDExpT.h

Line: 3373

W_PERIOD

Product availability: All

Platform availability: All

Syntax


#define W_PERIOD 0x400

Description

A period.

File: PDExpT.h

Line: 3392

W_PUNCTUATION

Product availability: All

Platform availability: All

Syntax


#define W_PUNCTUATION 0x10

Description

A punctuation mark.

File: PDExpT.h

Line: 3358

W_SOFT_HYPHEN

Product availability: All

Platform availability: All

Syntax


#define W_SOFT_HYPHEN 0x40

Description

A hyphen that is only present because a word is broken across two lines of text.

File: PDExpT.h

Line: 3368

W_UNMAPPED

Product availability: All

Platform availability: All

Syntax


#define W_UNMAPPED 0x1000

Description

A glyph that cannot be represented in the destination font encoding.

File: PDExpT.h

Line: 3402

W_UPPERCASE

Product availability: All

Platform availability: All

Syntax


#define W_UPPERCASE 0x4

Description

An uppercase letter.

File: PDExpT.h

Line: 3348

W_WHITE

Product availability: All

Platform availability: All

Syntax


#define W_WHITE 0x100

Description

A white space glyph.

File: PDExpT.h

Line: 3378

W_WILD_CARD

Product availability: All

Platform availability: All

Syntax


#define W_WILD_CARD 0x4000

Description

A wildcard glyph (for example, "*" and "?") that should not be treated as a normal punctuation mark.

File: PDExpT.h

Line: 3412

W_WORD_BREAK

Product availability: All

Platform availability: All

Syntax


#define W_WORD_BREAK 0x8000

Description

A glyph that acts as a delimiter between words.

See Also

GlyphNamesofWordSeparators

File: PDExpT.h

Line: 3418

WF_VERSION_2

Product availability: All

Platform availability: All

Syntax


#define WF_VERSION_2 2

Description

The version used for Acrobat 3.x, 4.x.

File: PDExpT.h

Line: 3566

WF_VERSION_3

Product availability: All

Platform availability: All

Syntax


#define WF_VERSION_3 3

Description

For Acrobat 5.0 without accessibility enabled.

File: PDExpT.h

Line: 3570

WF_VERSION_4

Product availability: All

Platform availability: All

Syntax


#define WF_VERSION_4 4

Description

For Acrobat 5.0 with accessibility enabled.

File: PDExpT.h

Line: 3574

WXE_ADJACENT_TO_SPACE

Product availability: All

Platform availability: All

Syntax


#define WXE_ADJACENT_TO_SPACE 0x800

Description

The character following the end of the word is a space (either an explicit space character encoded in a string, or one that appears implicitly because the drawing point was moved).

File: PDExpT.h

Line: 3502

WXE_ENC_MISSING

Product availability: All

Platform availability: All

Syntax


#define WXE_ENC_MISSING 0x02

File: PDExpT.h

Line: 3423

WXE_ENC_NO_UCS

Product availability: All

Platform availability: All

Syntax


#define WXE_ENC_NO_UCS 0x04

File: PDExpT.h

Line: 3424

WXE_ENC_UNMAPPED

Product availability: All

Platform availability: All

Syntax


#define WXE_ENC_UNMAPPED 0x01

File: PDExpT.h

Line: 3422

WXE_ENCODING_WARNING

Product availability: All

Platform availability: All

Syntax


#define WXE_ENCODING_WARNING 0x02

File: PDExpT.h

Line: 3536

WXE_EXT_CHAR_OFFSETS

Product availability: All

Platform availability: All

Syntax


#define WXE_EXT_CHAR_OFFSETS 0x10

File: PDExpT.h

Line: 3539

WXE_FROM_ACTUALT

Product availability: All

Platform availability: All

Syntax


#define WXE_FROM_ACTUALT 0x08

File: PDExpT.h

Line: 3425

WXE_FRONT_TAB

Product availability: All

Platform availability: All

Syntax


#define WXE_FRONT_TAB 0x01

File: PDExpT.h

Line: 3535

WXE_HAS_DIGIT

Product availability: All

Platform availability: All

Syntax


#define WXE_HAS_DIGIT 0x8

Description

One or more characters in the word are digits.

File: PDExpT.h

Line: 3448

WXE_HAS_HYPHEN

Product availability: All

Platform availability: All

Syntax


#define WXE_HAS_HYPHEN 0x20

Description

There is a hyphen in the word.

File: PDExpT.h

Line: 3464

WXE_HAS_LEADING_PUNC

Product availability: All

Platform availability: All

Syntax


#define WXE_HAS_LEADING_PUNC 0x100

Description

The first character in the word is a punctuation mark. If this bit is set, WXE_HAS_PUNCTUATION will also be set.

File: PDExpT.h

Line: 3481

WXE_HAS_LETTER

Product availability: All

Platform availability: All

Syntax


#define WXE_HAS_LETTER 0x2

Description

The word contains a character between A-Z or a-z.

File: PDExpT.h

Line: 3438

WXE_HAS_LIGATURE

Product availability: All

Platform availability: All

Syntax


#define WXE_HAS_LIGATURE 0x80

Description

The word contains a ligature.

File: PDExpT.h

Line: 3474

WXE_HAS_NONALPHANUM

Product availability: All

Platform availability: All

Syntax


#define WXE_HAS_NONALPHANUM 0X1

Description

The word contains a character outside the range of A-Z, a-Z, 0-9.

File: PDExpT.h

Line: 3433

WXE_HAS_PUNCTUATION

Product availability: All

Platform availability: All

Syntax


#define WXE_HAS_PUNCTUATION 0x10

Description

One or more characters in the word are punctuation marks. Other flag bits can be checked to test whether the punctuation was at the beginning of the word (WXE_HAS_LEADING_PUNC), the end of the word (WXE_HAS_TRAILING_PUNC), or elsewhere in the word.

File: PDExpT.h

Line: 3459

WXE_HAS_SOFT_HYPHEN

Product availability: All

Platform availability: All

Syntax


#define WXE_HAS_SOFT_HYPHEN 0x40

Description

There is a soft hyphen in the word.

File: PDExpT.h

Line: 3469

WXE_HAS_TRAILING_PUNC

Product availability: All

Platform availability: All

Syntax


#define WXE_HAS_TRAILING_PUNC 0x200

Description

The last character in the word is a punctuation mark. If this bit is set, WXE_HAS_PUNCTUATION will also be set.

File: PDExpT.h

Line: 3488

WXE_HAS_UNMAPPED_CHAR

Product availability: All

Platform availability: All

Syntax


#define WXE_HAS_UNMAPPED_CHAR 0x400

Description

One or more characters in the word cannot be represented in the output font encoding.

File: PDExpT.h

Line: 3494

WXE_HAS_UPPERCASE

Product availability: All

Platform availability: All

Syntax


#define WXE_HAS_UPPERCASE 0x4

Description

The word contains a character between A-Z.

File: PDExpT.h

Line: 3443

WXE_LAST_WORD_ON_LINE

Product availability: All

Platform availability: All

Syntax


#define WXE_LAST_WORD_ON_LINE 0x8000

Description

The word is at the end of the current text line (for example, the word is followed by a line break).

File: PDExpT.h

Line: 3532

WXE_PDF_ORDER

Product availability: All

Platform availability: All

Syntax


#define WXE_PDF_ORDER 0x2

File: PDExpT.h

Line: 3550

WXE_RD_ORDER_SORT

Product availability: All

Platform availability: All

Syntax


#define WXE_RD_ORDER_SORT 0x8

File: PDExpT.h

Line: 3558

WXE_REVERSE_DIRECTION

Product availability: All

Platform availability: All

Syntax


#define WXE_REVERSE_DIRECTION 0x04

File: PDExpT.h

Line: 3537

WXE_ROTATED

Product availability: All

Platform availability: All

Syntax


#define WXE_ROTATED 0x1000

Description

The writing direction of the word is not in a multiple of 90 degrees, or the bounding box of the text is skewed. This flag indicates that the quads of the word should be used to specify the highlight area correctly.

File: PDExpT.h

Line: 3512

WXE_STREAM

Product availability: All

Platform availability: All

Syntax


#define WXE_STREAM 0x1

File: PDExpT.h

Line: 3546

WXE_VERTICAL_FLOW

Product availability: All

Platform availability: All

Syntax


#define WXE_VERTICAL_FLOW 0x2000

Description

The writing direction of the word is either 90 or 180 degrees. This flag ignores the page rotation parameter of the page dictionary. Therefore, if the page is rotated 90 degrees, this flag will be set on each word that appears horizonally on the screen.

File: PDExpT.h

Line: 3521

WXE_WBREAK_WORD

Product availability: All

Platform availability: All

Syntax


#define WXE_WBREAK_WORD 0x4000

File: PDExpT.h

Line: 3526

WXE_WORD_IS_UNICODE

Product availability: All

Platform availability: All

Syntax


#define WXE_WORD_IS_UNICODE 0x08

File: PDExpT.h

Line: 3538

WXE_XY_SORT

Product availability: All

Platform availability: All

Syntax


#define WXE_XY_SORT 0x4

File: PDExpT.h

Line: 3554

Typedefs Detail

HiliteEntry

Product availability: All

Platform availability: All

Syntax

typedef _t_HiliteEntry HiliteEntry;

File: PDExpT.h

Line: 3051

PDApplyRedactionParams

Product availability: All

Platform availability: All

Syntax

typedef _t_PDApplyRedactionParams PDApplyRedactionParams;

File: PDExpT.h

Line: 6808

PDApplyRedactionParamsRec

Product availability: All

Platform availability: All

Syntax

typedef _t_PDApplyRedactionParams PDApplyRedactionParamsRec;

File: PDExpT.h

Line: 6808

PDChromaticity

Product availability: All

Platform availability: All

Syntax

typedef _t_PDChromaticity PDChromaticity;

File: PDExpT.h

Line: 3836

PDColorCal

Product availability: All

Platform availability: All

Syntax

typedef _t_PDColorCal PDColorCal;

File: PDExpT.h

Line: 3859

PDColorCalP

Product availability: All

Platform availability: All

Syntax

typedef _t_PDColorCal PDColorCalP;

File: PDExpT.h

Line: 3859

PDColorConvertAction

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDColorConvertActionRec PDColorConvertAction;

File: AcroColorExpT.h

Line: 1423

PDColorConvertActionEx

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDColorConvertActionRecEx PDColorConvertActionEx;

File: AcroColorExpT.h

Line: 1522

PDColorConvertObjectAttributes

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 PDColorConvertObjectAttributes;

File: AcroColorExpT.h

Line: 1294

PDColorConvertParams

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDColorConvertParamsRec PDColorConvertParams;

File: AcroColorExpT.h

Line: 1448

PDColorConvertParamsEx

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDColorConvertParamsRecEx PDColorConvertParamsEx;

File: AcroColorExpT.h

Line: 1552

PDColorConvertSpaceType

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 PDColorConvertSpaceType;

File: AcroColorExpT.h

Line: 1342

PDColorValue

Product availability: All

Platform availability: All

Syntax

typedef _t_PDColorValueRec PDColorValue;

File: PDExpT.h

Line: 951

PDColorValueRec

Product availability: All

Platform availability: All

Syntax

typedef _t_PDColorValueRec PDColorValueRec;

File: PDExpT.h

Line: 951

PDConstColorValue

Product availability: All

Platform availability: All

Syntax

typedef _t_PDColorValueRec PDConstColorValue;

File: PDExpT.h

Line: 953

PDContent

Product availability: All

Platform availability: All

Syntax

typedef struct _t_PDContent* PDContent;

A pointer to a PDContent struct.

File: PDBasicExpT.h

Line: 103

PDDrawParams

Product availability: All

Platform availability: All

Syntax

typedef _t_PDDrawParams PDDrawParams;

File: PDExpT.h

Line: 6332

PDDrawParamsRec

Product availability: All

Platform availability: All

Syntax

typedef _t_PDDrawParams PDDrawParamsRec;

File: PDExpT.h

Line: 6332

PDHostSepsPlate

Product availability: All

Platform availability: All

Syntax

typedef _t_PDHostSepsPlateRec PDHostSepsPlate;

File: PDExpT.h

Line: 5950

PDHostSepsPlateRec

Product availability: All

Platform availability: All

Syntax

typedef _t_PDHostSepsPlateRec PDHostSepsPlateRec;

File: PDExpT.h

Line: 5950

PDHostSepsSpec

Product availability: All

Platform availability: All

Syntax

typedef _t_PDHostSepsSpecRec PDHostSepsSpec;

File: PDExpT.h

Line: 6073

PDHostSepsSpecRec

Product availability: All

Platform availability: All

Syntax

typedef _t_PDHostSepsSpecRec PDHostSepsSpecRec;

File: PDExpT.h

Line: 6073

PDNavigator

Product availability: All

Platform availability: All

Syntax

typedef OPAQUE_64_BITS PDNavigator;

Opaque object representing a collection navigator dictionary.

File: PDExpT.h

Line: 6864

PDRedactParams

Product availability: All

Platform availability: All

Syntax

typedef _t_PDRedactParams PDRedactParams;

File: PDExpT.h

Line: 6768

PDRedactParamsRec

Product availability: All

Platform availability: All

Syntax

typedef _t_PDRedactParams PDRedactParamsRec;

File: PDExpT.h

Line: 6768

PDResourceEnumMonitor

Product availability: All

Platform availability: All

Syntax

typedef _t_PDResourceEnumMonitor PDResourceEnumMonitor;

A data structure containing callbacks used when enumerating the resources of a form with PDFormEnumResources() or PDPageEnumResources().

See Also

PDFormEnumResources

File: PDExpT.h

Line: 2653

PDResourceEnumMonitorRec

Product availability: All

Platform availability: All

Syntax

typedef _t_PDResourceEnumMonitor PDResourceEnumMonitorRec;

File: PDExpT.h

Line: 2676

PDResTree

Product availability: All

Platform availability: All

Syntax

typedef struct _t_PDResTree* PDResTree;

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.

File: PDBasicExpT.h

Line: 144

Enumeration Detail

PDCharSet

Product availability: All

Platform availability: All

Syntax

enum PDCharSet {

  PDUnknownCharSet = 0,


 


  PDStandardRomanCharSet = 1,


 


  PDAdobeExpertCharSet = 2,


 


  PDLastCharSet

}

File: PDExpT.h

Line: 2244

Elements

	PDUnknownCharSet	The font does not use Adobe standard encoding.

	PDStandardRomanCharSet	The font uses Adobe standard encoding. This is determined by the `"Uses Adobe Standard Encoding"` bit in the font descriptor.

	PDAdobeExpertCharSet	Currently unused.

PDColorConvertActionType

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDColorConvertActionType {

  kColorConvPreserve,


 


  kColorConvConvert,


 


  kColorConvDecalibrate,


 


  kColorConvDownConvert,


 


  kColorConvMaxEnum = 0xFFFFFFFFL

}

File: AcroColorExpT.h

Line: 1346

Elements

	kColorConvPreserve	Do nothing but handle ink aliases.

	kColorConvConvert	Convert to target space.

	kColorConvDecalibrate	Convert calibrated space to device space.

	kColorConvDownConvert	Convert NChannel space to DeviceN space.

	kColorConvMaxEnum	Maximum enum value.

PDColorConvertObjectAttributeFlags

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDColorConvertObjectAttributeFlags {

  kColorConvObj_Image = _FLG(0),


 


  kColorConvObj_JPEG = _FLG(1),


 


  kColorConvObj_JPEG2000 = _FLG(2),


 


  kColorConvObj_Lossy = _FLG(3),


 


  kColorConvObj_Lossless = _FLG(4),


 


  kColorConvObj_Text = _FLG(5),


 


  kColorConvObj_LineArt = _FLG(6),


 


  kColorConvObj_Shade = _FLG(7),


 


  kColorConvObj_Transparent = _FLG(8),


 


  kColorConvObj_Overprinting = _FLG(9),


 


  kColorConvObj_OverprintMode = _FLG(10),


 


  kColorConvObj_AnyObject = (_FLG(0)|_FLG(5)|_FLG(6)|_FLG(7)),


 


  kColorConvObj_MaxEnum = 0xFFFFFFFFL

}

File: AcroColorExpT.h

Line: 1253

Elements

	kColorConvObj_Image	Object is an image.

	kColorConvObj_JPEG	Object is a JPEG image.

	kColorConvObj_JPEG2000	Object is a JPEG2000 image.

	kColorConvObj_Lossy	Image is in a lossy space.

	kColorConvObj_Lossless	Image is in a non-lossy space.

	kColorConvObj_Text	Object is text.

	kColorConvObj_LineArt	Object is line-art (fill, stroke).

	kColorConvObj_Shade	Object is a smooth shade.

	kColorConvObj_Transparent	Object is not opaque.

	kColorConvObj_Overprinting	Object overprints.

	kColorConvObj_OverprintMode	Overprint mode (OPM) is set to `1`.

	kColorConvObj_AnyObject	Any object.

	kColorConvObj_MaxEnum	Maximum enum value.

PDColorConvertSpaceTypeFlags

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDColorConvertSpaceTypeFlags {

  kColorConvDeviceSpace = _FLG(0),


 


  kColorConvCalibratedSpace = _FLG(1),


 


  kColorConvAlternateSpace = _FLG(3),


 


  kColorConvBaseSpace = _FLG(4),


 


  kColorConvIndexedSpace = _FLG(5),


 


  kColorConvSeparationSpace = _FLG(6),


 


  kColorConvDeviceNSpace = _FLG(7),


 


  kColorConvNChannelSpace = _FLG(8),


 


  kColorConvRGBSpace = _FLG(9),


 


  kColorConvCMYKSpace = _FLG(10),


 


  kColorConvGraySpace = _FLG(11),


 


  kColorConvLabSpace = _FLG(12),


 


  kColorConvAnySpace = (_FLG(0)|_FLG(1)|_FLG(2)|_FLG(3)|_FLG(4)|_FLG(5)|_FLG(6)|_FLG(7)|_FLG(8)|_FLG(9)|_FLG(10)|_FLG(11)|_FLG(12)),


 


  kColorConvSpace_MaxEnum = 0xFFFFFFFFL

}

File: AcroColorExpT.h

Line: 1299

Elements

	kColorConvDeviceSpace	Device color space.

	kColorConvCalibratedSpace	Calibrated color space.

	kColorConvAlternateSpace	Alternate color space.

	kColorConvBaseSpace	Base of an indexed space.

	kColorConvIndexedSpace	Indexed color space.

	kColorConvSeparationSpace	Separation color space.

	kColorConvDeviceNSpace	DeviceN color space.

	kColorConvNChannelSpace	NChannel color space.

	kColorConvRGBSpace	RGB color space. This should only be set if either Device space (unless Lab) or Calibrated space is set.

	kColorConvCMYKSpace	CMYK color space. This should only be set if either Device space (unless Lab) or Calibrated space is set.

	kColorConvGraySpace	Gray color space. This should only be set if either Device space (unless Lab) or Calibrated space is set.

	kColorConvLabSpace	Lab color space.

	kColorConvAnySpace	Any color space.

	kColorConvSpace_MaxEnum	Maximum enum value.

PDColorSpace

Product availability: All

Platform availability: All

Syntax

enum PDColorSpace {

  PDDeviceGray,


 


  PDDeviceRGB,


 


  PDDeviceCMYK

}

File: PDExpT.h

Line: 908

Elements

	PDDeviceGray	Grayscale. It requires one value entry to specify the color.

	PDDeviceRGB	Red-Green-Blue color specification. It requires three value entries to specify the color.

	PDDeviceCMYK	Cyan-Magenta-Yellow-Black color specification. It requires four value entries to specify the color.

PDEmitPlateFlags

Product availability: All

Platform availability: All

Syntax

enum PDEmitPlateFlags {

  kEmitPlate,


 


  kDontEmitPlate,


 


  kConvertToProcess

}

File: PDExpT.h

Line: 5796

PDInkTypes

Product availability: All

Platform availability: All

Syntax

enum PDInkTypes {

  kNormal,


 


  kTransparent,


 


  kOpaqueInk,


 


  kOpaqueIgnore

}

File: PDExpT.h

Line: 5815

PDLayoutMode

Product availability: All

Platform availability: All

Syntax

enum PDLayoutMode {

  PDLayoutDontCare,


 


  PDLayoutSinglePage,


 


  PDLayoutOneColumn,


 


  PDLayoutTwoColumnLeft,


 


  PDLayoutTwoColumnRight,


 


  PDLayoutTwoPageLeft,


 


  PDLayoutTwoPageRight

}

File: PDExpT.h

Line: 1978

Elements

	PDLayoutDontCare	(Default) Use the user preference when opening the file, as specified in the `avpPageViewLayoutMode` preference, set by AVAppSetPreference().

	PDLayoutSinglePage	Use single-page mode, as in pre-Acrobat 3.0 viewers.

	PDLayoutOneColumn	Use one-column continuous mode.

	PDLayoutTwoColumnLeft	Use two-column continuous mode with the first page on the left.

	PDLayoutTwoColumnRight	Use two-column continuous mode with the first page on the right.

PDMarksStyle

Product availability: All

Platform availability: All

Syntax

enum PDMarksStyle {

  kPDDefaultMarkType = 0,


 


  kPDInDesignJ1MarkType,


 


  kPDInDesignJ2MarkType,


 


  kPDIllustratorMarkType,


 


  kPDIllustratorJ,


 


  kPDQuarkXPress

}

File: PDExpT.h

Line: 5826

Elements

	kPDDefaultMarkType	No flags means InDesign style printer marks.

PDRotate

Product availability: All

Platform availability: All

Syntax

enum PDRotate {

  pdRotate0 = 0,


 


  pdRotate90 = 90,


 


  pdRotate180 = 180,


 


  pdRotate270 = 270

}

See Also

PDPageGetRotate
PDPageSetRotate

File: PDExpT.h

Line: 2387

PDSaveFlags

Product availability: All

Platform availability: All

Syntax

enum PDSaveFlags {

  PDSaveIncremental = 0x00,


 


  PDSaveFull = 0x01,


 


  PDSaveCopy = 0x02,


 


  PDSaveLinearized = 0x04,


 


  PDSaveWithPSHeader = 0x08,


 


  PDSaveBinaryOK = 0x10,


 


  PDSaveCollectGarbage = 0x20,


 


  PDSaveForceIncremental = 0x40,


 


  PDSaveKeepModDate = 0x80,


 


  PDSaveLeaveOpen = 0x100

}

See Also

PDDocSave
PDSaveFlags2

File: PDExpT.h

Line: 1440

Elements

	PDSaveIncremental	Save only those portions of the document that have changed. This is provided only as the opposite of `PDSaveFull`, since there is no bit value of `0`.

	PDSaveFull	Save the entire document. Plug-ins that set `PDSaveFull` are also encouraged to set `PDSaveCollectGarbage`.

	PDSaveCopy	Save a copy of the document (the PDDoc continues to use the old file). This flag is ignored if `PDSaveFull` is off.

	PDSaveLinearized	Write the PDF file in a format that is optimized for page-served remote (network) access (linearized). This flag is ignored if `PDSaveFull` is off. Prior to Acrobat 7, linearizing a file caused Cos objects to be invalidated, which required that some plug-ins use notifications to release and re-acquire objects. Acrobat 7 onwards, Cos objects are no longer invalidated after a linearized save.

	PDSaveWithPSHeader	(Obsolete. In effect, it is always off). Write a PostScript header as part of the saved file.

	PDSaveBinaryOK	(Obsolete. In effect, it is always on). It is okay to store binary data in the PDF file.

	PDSaveCollectGarbage	Remove unreferenced objects, often reducing file size. Plug-ins are encouraged to use this flag. This flag is ignored if `PDSaveFull` is off.

	PDSaveForceIncremental	Perform an incremental save even if the save is to a different file or the document's version number has changed.

	PDSaveKeepModDate	Do not update ModDate in InfoDict.

	PDSaveLeaveOpen	Leave the file open after the save (do not Close the file)

PDSaveFlags2

Product availability: All

Platform availability: All

Syntax

enum PDSaveFlags2 {

  PDSaveUncompressed = 1 << 0,


 


  PDSaveCompressed = 1 << 1,


 


  PDSaveCompressStructureOnly = 1 << 2,


 


  PDSaveRemoveASCIIFilters = 1 << 3,


 


  PDSaveAddFlate = 1 << 4,


 


  PDSaveReplaceLZW = 1 << 5,


 


  PDSaveOptimizeXObjects = 1 << 6,


 


  PDSaveOptimizeContentStreams = 1 << 7,


 


  PDSaveOptimizeFonts = 1 << 8,


 


  PDSaveOptimizeMarkedJBIG2Dictionaries = 1 << 9,


 


  PDSaveEnsure7bitASCII = 1 << 10,


 


  PDSaveAutoSave = 1 << 11,


 


  PDSaveOverrideCollections = 1 << 12

}

See Also

PDDocSave
PDSaveFlagsThis enumeration defines the flags used in the saveFlags2 bitfield of the PDDocSaveParams structure passed to PDDocSaveWithParams(). These flags are an extension to those defined by the PDSaveFlags enumeration, which are stored in the saveFlags bitfield of the PDDocSaveParams structure.
PDDocSaveWithParams
PDDocInsertPages
PDDocSaveParams
PDSaveFlags

File: PDExpT.h

Line: 1503

Elements

	PDSaveUncompressed	Do not use object streams when saving the document (decompress all objects). The result is compatible with all versions of PDF and Acrobat. This flag is ignored if `PDSaveFull` is off.

	PDSaveCompressed	Compress objects, without restrictions about which objects to compress. The result is compatible only with PDF 1.5 (Acrobat 6) or later. This flag is ignored if `PDSaveFull` is off.

	PDSaveCompressStructureOnly	Compress only those objects that are related to logical structure (for example, tagged PDF). The result is compatible with any version of PDF or Acrobat, but the compressed objects are usable only in PDF 1.5 (Acrobat 6). This flag is ignored if `PDSaveFull` is off.

	PDSaveRemoveASCIIFilters	Remove ASCII85 filters from all streams. This flag is ignored if `PDSaveFull` is off.

	PDSaveAddFlate	Encode any unencoded stream with Flate, except for metadata streams, which are never encoded, and for streams that would be larger if encoded. This flag is ignored if `PDSaveFull` is off.

	PDSaveReplaceLZW	Replace all LZW filters with FlateEncode filters. This flag is ignored if `PDSaveFull` is off.

	PDSaveOptimizeXObjects	Merge identical forms and images, as determined by an MD5 hash of their contents (it causes OptimizeXObjects() to be called).

	PDSaveOptimizeContentStreams	Look for common initial sub-sequences among content streams (the sequences of marking operators), and generate substreams that can be shared (it causes OptimizeGraphics() to be called).

	PDSaveOptimizeFonts	Merge identical font descriptors and encodings. Does not merge the top-level font dictionary (it causes OptimizeFonts() to be called).

	PDSaveOptimizeMarkedJBIG2Dictionaries	Delete symbols specific to deleted images from JBIG2 dictionaries that could not be processed at the time of image deletion. It is currently only effective after deleting pages or extracting pages (it causes OptimizeMarkedJBIG2Dictionaries() to be called).

	PDSaveEnsure7bitASCII	(Obsolete. In effect, it is always off).

	PDSaveAutoSave	The `PDSaveAutoSave` flag is used to indicate that the save that occurred is an auto-save event. It is only set when an auto-save occurs. It is a read-only flag.

	PDSaveOverrideCollections	The `PDSaveOverrideCollections` flag controls whether `CosObjCollection` objects set up prior to saving are honored when doing a non-linearized save. Linearized save always uses its own rules for assigning objects to collections and object streams, so this flag is only used when the `PDSaveLinearized` flag is off. Furthermore, it is only used if either the `PDSaveCompressed` or `PDSaveCompressStructureOnly` flags is set. If this flag is set, the `PDDocSave` will remove all `CosObj` objects from their `CosObjCollection` objects and reassign objects to `CosObjCollection` objects (and object streams) using its own partitioning algorithms. If the flag is not set, the partitioning algorithms will preserve `CosObj` objects' existing membership in collections.

Variables Detail

exportFilter

Product availability: Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

voidPDDocWillExportAnnotCallback exportFilter;

File: PDProcs.h

Line: 6692

gPDModelHFT

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

HFT gPDModelHFT;

File: PDCalls.h

Line: 252

gPDModelVersion

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASUns32 gPDModelVersion;

File: PDCalls.h

Line: 253

importFilter

Product availability: Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

voidPDDocWillImportAnnotCallback importFilter;

File: PDProcs.h

Line: 6662

monClientData

Product availability: Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void* monClientData;

Adds text annotations from sourceDoc to doc.

It raises an exception if the given object has the wrong Cos type. It also raises exceptions if storage is exhausted or file access fails.

Notifications

PDDocDidImportAnnots
PDDocWillImportAnnots
PDDocDidImportAnnots
PDDocWillImportAnnots

Since

PI_PDMODEL_VERSION >= 0x00040000Adds text annotations (notes) from sourceDoc to doc.It raises an exception if the given object has the wrong Cos type. Also raises exceptions if storage is exhausted or file access fails.
PI_PDMODEL_VERSION >= 0x00040000

File: PDProcs.h

Line: 6661

numNotesP

Product availability: Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

voidPDDocWillExportAnnotCallbackASInt32* numNotesP;

File: PDProcs.h

Line: 6693

pdanArray

Product availability: Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

voidPDDocWillExportAnnotCallbackPDAnnotArray pdanArray;

File: PDProcs.h

Line: 8018

unused4

Product availability: Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void* unused4;

Creates a document containing empty pages plus text annotations (notes) from sourceDoc. It does not create a new document if sourceDoc contains no notes.

Notifications

PDDocWillExportAnnots
PDDocDidExportAnnots
PDDocWillExportAnnots
PDDocDidExportAnnots

Since

PI_PDMODEL_VERSION >= 0x00040000Like PDDocExportNotes(), but the caller provides the list of annotations to export. This is useful in scenarios when it may be inappropriate to use PDDocExportNotes() and look for annotations on every page. This is an especially important consideration when in a browser.
PI_PDMODEL_VERSION >= 0x00050000

File: PDProcs.h

Line: 6691

Structure Detail

_t_HiliteEntry

Product availability: All

Platform availability: All

Syntax

struct _t_HiliteEntry {

  PDCharOffset offset;  


 


  PDCharOffset length;  

}

A data structure representing a single entry (the starting location and length) in a highlight list.

File: PDExpT.h

Line: 3046

_t_PDApplyRedactionParams

Product availability: All

Platform availability: All

Syntax

struct _t_PDApplyRedactionParams {

  ASUns32 size;  


 


  PDAnnot redactionAnnots;  


 


  ASUns32 redactionCount;  


 


  ASBool keepMarks;  


 


  ASStatusMonitorProcs statusProcs;  


 


  ASText progressText;  


 


  ASInt32 progressDuration;  

}

Parameters used for applying redaction marks.

See Also

PDDocApplyRedactions

File: PDExpT.h

Line: 6775

Elements

	size	The size of the data structure.

	redactionAnnots	A pointer to a set of redaction annotations representing the redaction marks to be applied. If `NULL`, then all redaction marks present in the document should be applied.

	redactionCount	The number of redaction marks in `redactionAnnots`. This value is ignored if `redactionAnnots` is `NULL`.

	keepMarks	A boolean value indicating that the redaction marks themselves should be not removed.

	statusProcs	A set of callbacks for providing feedback to the caller. It may be `NULL`.

	progressText	The text to be displayed for the progress monitor in `statusProcs`. It may be `NULL`. This value is ignored if `statusProcs` is `NULL`.

	progressDuration	The amount that the current value for the progress monitor in `statusProcs` should be incremented during the application process. If it is less than or equal to `0`, then `beginOperation` will be called, an unspecified positive duration will be set, the current value will be incremented up to that duration, and `endOperation` will be called. This value is ignored if `statusProcs` is `NULL`.

_t_PDChromaticity

Product availability: All

Platform availability: All

Syntax

struct _t_PDChromaticity {

  ASFixed x;  


 


  ASFixed y;  

}

A data structure containing a monitor's chromaticity, for use in displaying device-independent color.

x and y are the two values needed to specify the chromaticity.

File: PDExpT.h

Line: 3829

Elements

	x	The x-axis component of the monitor's chromaticity. It must be in [0,1). `x + y` must be less than or equal to 1.

	y	The y-axis component of the monitor's chromaticity. It must be in (0,1]. `x + y` must be less than or equal 1.

_t_PDColorCal

Product availability: All

Platform availability: All

Syntax

struct _t_PDColorCal {

  PDChromaticity whiteChrom;  


 


  PDChromaticity redChrom;  


 


  PDChromaticity greenChrom;  


 


  PDChromaticity blueChrom;  


 


  ASFixed redGamma;  


 


  ASFixed greenGamma;  


 


  ASFixed blueGamma;  

}

A data structure used to represent the characteristics of an output device; it is needed for device-independent color.

See Also

PDPrefGetColorCal
PDPrefSetColorCal

File: PDExpT.h

Line: 3844

_t_PDColorValueRec

Product availability: All

Platform availability: All

Syntax

struct _t_PDColorValueRec {

  PDColorSpace space;  


 


  ASFixed value[4];  

}

A data structure representing a color. The number of elements needed in the value field depends on the color space type (specified in the space field). See PDColorSpace for more information.

File: PDExpT.h

Line: 944

_t_PDDrawParams

Product availability: All

Platform availability: All

Syntax

struct _t_PDDrawParams {

  ASUns32 size;  


 


  void* window;  


 


  void* displayContext;  


 


  ASFixedMatrix matrix;  


 


  ASUns32 flags;  


 


  ASFixedRect updateRect;  


 


  CancelProc cancelProc;  


 


  void* cancelProcClientData;  


 


  PDOCContext clientOCContext;  

}

Parameters used for optional-content drawing control. The parameters are the same as those passed to the original version of the method, with the addition of an optional-content context that determines what contents are visible. This structure is not available on Mac 64.

File: PDExpT.h

Line: 6279

Elements

	size	The size of the data structure.

	window	A pointer to a platform-dependent window object (`HWND` on Windows`WindowPtr`, or `CWindowPtr` on Mac OS). On Windows, to draw into an offscreen `DC`, pass `NULL` for `window`. On Mac OS, to draw into an offscreen `GWorld`, pass `NULL` in window and pass the `GWorldPtr` in `displayContext`.

	displayContext	A platform-dependent display context structure (`HDC` on Windows, `GWorldPtr` on Mac OS). On Mac OS, `displayContext` is ignored if `window` is non-`NULL`.

	matrix	A pointer to the matrix to concatenate onto the default page matrix. It is useful for converting from page to window coordinates and for scaling.

	flags	See above. The only value you should use is `0`.

	updateRect	A rectangle represented by the coordinates of its four sides.

	cancelProc	A procedure called periodically to check for the user's cancelling of the drawing operation. The default cancel procedure can be obtained using AVAppGetCancelProc(). It may be `NULL`, in which case no cancel procedure is used.

	cancelProcClientData	A pointer to user-supplied data to pass to `cancelProc` each time it is called. It should be `NULL` if `cancelProc` is `NULL`.

	clientOCContext	An optional-content context that determines what contents are visible. `NULL` uses the document's optional-content context, as returned by `PDDocGetOCContext(pddoc)`, which is equivalent to calling the version of the method without optional content parameters. This context is copied and the copy is used in drawing. This allows a client to change its copy of the context without raising an exception.

_t_PDHostSepsPlateRec

Product availability: All

Platform availability: All

Syntax

struct _t_PDHostSepsPlateRec {

  ASSize_t size;  


 


  ASAtom colorantName;  


 


  ASUns8 whatToDo;  


 


  ASUns32 wasColorSet;  


 


  ASStm epsStm;  


 


  ASFile file;  


 


  ASPathName path;  


 


  float frequency;  


 


  float angle;  


 


  ASUns8 inkType;  


 


  ASInt32 trapSequence;  


 


  float density;  


 


  ASAtom alias;  

}

Used to specify per-plate options when doing separations.

File: PDExpT.h

Line: 5897

Elements

	size	The size of the structure. It must be set to `sizeof(PDHostSepsPlateRec)`.

	colorantName	The name of the colorant from the Separation or DeviceN colorspace, or a spot or process color name (Cyan, Magenta, Yellow, Black).

	whatToDo	How to handle the colorant. Its value can be: kEmitPlate kDontEmitPlate kConvertToProcess

	wasColorSet	Set internally. It is used to determine whether marks were made on this plate to aid in blank detection.

	epsStm	Set internally. It is the stream into which Acrobat emits PostScript for this plate. It is `NULL` if `whatToDo` is not set to kEmitPlate.

	file	Set internally. It is used only when separating documents, to close the file afterward.

	path	Set internally. It is used only when separating documents, to reopen the stream on the next page.

	frequency	The frequency for this ink. Set it to `-1` to use the default value.

	angle	The angle for this ink. Set it `-1` to use the default value.

	inkType	The ink type for this ink.

	trapSequence	The trap sequence for this ink.

	density	The neutral density for this ink.

	alias	Alias this spot to another.

_t_PDHostSepsSpecRec

Product availability: All

Platform availability: All

Syntax

struct _t_PDHostSepsSpecRec {

  ASSize_t size;  


 


  ASUns32 psLevel;  


 


  ASBool binaryOK;  


 


  ASBool emitAnnots;  


 


  ASBool emitHalftones;  


 


  ASBool emitTransferFuncs;  


 


  ASBool emitSeparableImagesOnly;  


 


  ASBool suppressCJKSubstitution;  


 


  ASEnum8 emitFontOption;  


 


  ASBool TTasT42;  


 


  ASBool printerHasFarEastFonts;  


 


  ASUns32 transparencyLevel;  


 


  ASBool useCMYKWorkingColorspace;  


 


  char destProfile[256];  


 


  ASBool convertToProcessUsingOPP;  


 


  ASUns32 numPlates;  


 


  PDHostSepsPlate plates;  


 


  PDOCContext ocContext;  


 


  ASBool applyOCGPrintOverrides;  


 


  ASBool negative;  


 


  ASEnum8 mirrorprint;  


 


  ASUns32 whichMarks;  


 


  ASBool western;  


 


  ASBool doInRipTrapping;  


 


  ASInt32 marksStyle;  


 


  ASInt32 trapType;  


 


  ASPathName customMarksPath;  

}

Used to control the generation of separations from Acrobat.

File: PDExpT.h

Line: 5953

Elements

size

The size of the structure. It must be set to sizeof(PDHostSepsSpecRec).

psLevel

The PostScript printing level. 2 means emit as level 2, 3 means level 3.

It is used if the emitToPrinter or emitToFile print parameter is true.

binaryOK

true if a binary channel to the printer is supported, false otherwise.

It is used if the emitToPrinter or emitToFile print parameter is true.

emitAnnots

When true, emit annotations.

emitHalftones

When true, emit halftones.

emitTransferFuncs

When true, emit transfer functions.

emitSeparableImagesOnly

When true, emit separable images only.

suppressCJKSubstitution

When true, suppress CJK substitution.

emitFontOption

Font output options. Its values can be:

Value	Description
`kHSEmitFontNoFonts`	Embed no fonts.
`kHSEmitFontEmbeddedFonts`	Emit all embedded fonts.
`kHSEmitFontAllFonts`	Emit all fonts.

TTasT42

When true, send TrueType fonts as TrueType fonts (level 3 and most level 2 PS printers). When false, convert TrueType to T1 (typically desirable only for Level 1 PS where no TrueType handling is present).

printerHasFarEastFonts

true means do not include Far East fonts.

transparencyLevel

The transparency level, which can be 0-100.

useCMYKWorkingColorspace

When true, color manage DeviceCMYK. When false, pass it directly onto the process plates.

destProfile

The profile description of a valid CMYK profile, such as the strings seen in the color management preferences in Acrobat (for example, "U.S. Web Coated (SWOP) v2").

convertToProcessUsingOPP

When true, use the overprint preview (OPP) for converting to process, which better simulates what would happen if the spot ink were really used.

numPlates

The number of items in the plates array.

plates

A list of the colorant names and what to do with them for separations.

ocContext

The optional-content context to use for visibility state information, or NULL to use the document's current states in the default context.

applyOCGPrintOverrides

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.

negative

When true, invert the plate.

mirrorprint

One of the following constants:

Constant	Value
`kPDPrintFlipNone`	`0x01`
`kPDPrintFlipX`	`0x02`
`kPDPrintFlipY`	`0x04`
`kPDPrintFlipXY`	`0x08`

Mirroring is done in the PostScript output stream.

whichMarks

A page mark indication. It is a bit-wise OR of the PDPageMarkFlags values.

western

When true, use the western style for page marks.

_t_PDRedactParams

Product availability: All

Platform availability: All

Syntax

struct _t_PDRedactParams {

  ASUns32 size;  


 


  ASInt32 pageNum;  


 


  ASFixedQuad redactQuads;  


 


  ASUns32 numQuads;  


 


  PDColorValueRec colorVal;  


 


  ASText overlayText;  


 


  PDHorizAlign horizAlign;  

}

Parameters used to represent the properties for a redaction mark.

File: PDExpT.h

Line: 6738

Elements

	size	The size of the data structure.

	pageNum	The page number where this redaction mark is found.

	redactQuads	An array of `ASFixedQuad` objects representing the regions on the page to be redacted.

	numQuads	The length of the array specified by `redactQuad`.

	colorVal	The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

	overlayText	The overlay text to be used when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

	horizAlign	The horizontal alignment to be used for the overlay text when generating the replacement form for this redaction mark.

_t_PDResourceEnumMonitor

Product availability: All

Platform availability: All

Syntax

struct _t_PDResourceEnumMonitor {

  ASSize_t size;  


 


  PDResourceEnumFontProc EnumFont;  


 


  PDResourceEnumXObjectProc EnumXObject;  


 


  PDResourceEnumProcSetProc EnumProcSet;  


 


  PDResourceEnumColorSpaceProc EnumColorSpace;  

}

A data structure containing callbacks used when enumerating the resources of a form with PDFormEnumResources() or PDPageEnumResources().

See Also

PDFormEnumResources

File: PDExpT.h

Line: 2665

Elements

	size	The size of the data structure. It must be set to `sizeof(PDResourceEnumMonitorRec)`.

PDColorConvertActionRec

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDColorConvertActionRec {

  PDColorConvertObjectAttributes mMatchAttributesAll;  


 


  PDColorConvertObjectAttributes mMatchAttributesAny;  


 


  PDColorConvertSpaceType mMatchSpaceTypeAll;  


 


  PDColorConvertSpaceType mMatchSpaceTypeAny;  


 


  AC_RenderIntent mMatchIntent;  


 


  PDColorConvertActionType mAction;  


 


  AC_RenderIntent mConvertIntent;  


 


  AC_Profile mConvertProfile;  


 


  ASBool mEmbed;  


 


  ASBool mPreserveBlack;  


 


  ASBool mUseBlackPointCompensation;  


 


  ASAtom mColorantName;  


 


  ASAtom mAlias;  


 


  ASBool mIsProcessColor;  


 


  void* mInternal;  

}

Defines a color conversion action for a combination of attributes, color space/family, and rendering intent. If all three match, the actions in the action list will be executed for any given object.

File: AcroColorExpT.h

Line: 1370

Elements

	mMatchAttributesAll	Object attribute. The flags must all match for a match.

	mMatchAttributesAny	Object attribute. The flags will allow any match.

	mMatchSpaceTypeAll	Type of color space. The flags must all match for a match.

	mMatchSpaceTypeAny	Type of color space. The flags will allow any match.

	mMatchIntent	The rendering intent of the object. If this is `AC_UseProfileIntent`, this action applies to any intent.

	mAction	Defines the action, indicating what to do when an object matches this record.

	mConvertIntent	If converting, use this intent to override the object's intent for performing color conversion. `AC_UseProfileIntent` means that the intent of the object must not be overridden.

	mConvertProfile	The target profile for the conversion. If the output intent is embedded, this should be the output intent profile.

	mEmbed	If `true`, embed the target profile. If `false` the resulting color is Device, if possible.

	mPreserveBlack	If `true`, perform a black-preserving transform when converting.

	mUseBlackPointCompensation	If `true`, turn on black point compensation for color conversions.

	mColorantName	For ink actions (which describe a single colorant, whether used in Separation or DeviceN, and which are not matched using the above matching fields) this describes the colorant of the ink.

	mAlias	Ink alias; this only applies to ink actions.

	mIsProcessColor	`true` if this ink is a process ink.

	mInternal	For internal use.

PDColorConvertActionRecEx

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDColorConvertActionRecEx {

  ASSize_t mSize;  


 


  PDColorConvertObjectAttributes mMatchAttributesAll;  


 


  PDColorConvertObjectAttributes mMatchAttributesAny;  


 


  PDColorConvertSpaceType mMatchSpaceTypeAll;  


 


  PDColorConvertSpaceType mMatchSpaceTypeAny;  


 


  AC_RenderIntent mMatchIntent;  


 


  double mMatchMinFontSize;  


 


  double mMatchMaxFontSize;  


 


  PDColorConvertActionType mAction;  


 


  AC_RenderIntent mConvertIntent;  


 


  AC_Profile mConvertProfile;  


 


  ASBool mEmbed;  


 


  ASBool mPreserveBlack;  


 


  ASBool mPromoteGrayToCMYK;  


 


  ASBool mUseBlackPointCompensation;  


 


  ASAtom mColorantName;  


 


  ASAtom mAlias;  


 


  ASBool mIsProcessColor;  


 


  ASBool mPreserveCMYKPrimaries;  


 


  void* mInternal;  

}

Defines a color conversion action for a combination of attributes, color space/family, and rendering intent. If all three match, actions in the action list will be executed for any given object.

File: AcroColorExpT.h

Line: 1458

Elements

	mSize	The size (in bytes) of this structure.

	mMatchAttributesAll	The object attributes. The flags must all match for a match.

	mMatchAttributesAny	The object attributes. The flags will allow any match.

	mMatchSpaceTypeAll	The type of color space. The flags must all match for a match.

	mMatchSpaceTypeAny	The type of color space. The flags will allow any match.

	mMatchIntent	The rendering intent of the object. If this is `AC_UseProfileIntent`, this action applies to any intent.

	mMatchMinFontSize	The font size to match for text objects.

	mAction	Defines the action, specifying what to do when an object matches this record.

	mConvertIntent	If converting, use this intent to override the object's intent for performing color conversion. `AC_UseProfileIntent` means that the intent of the object must not be overridden.

	mConvertProfile	The target profile for the conversion. If the output intent is embedded, this should be the output intent profile.

	mEmbed	If `true`, embed the target profile. If `false`, the resulting color is Device, if possible.

	mPreserveBlack	If `true`, perform a black-preserving transform when converting.

	mPromoteGrayToCMYK	If `true`, promote DeviceGray objects to DeviceCMYK with `K = 1.0 - gray value`.

	mUseBlackPointCompensation	If `true`, turn on black point compensation for color conversions.

	mColorantName	For ink actions (which describe a single colorant, whether used in Separation or DeviceN, and which are not matched using the above matching fields) this describes the colorant of the ink.

	mAlias	Ink alias; this only applies to ink actions.

	mIsProcessColor	`true` if this ink is a process ink.

	mPreserveCMYKPrimaries	If `true`, use a primary-preserving CMYK to CMYK transform.

	mInternal	For internal use.

PDColorConvertParamsRec

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDColorConvertParamsRec {

  ASInt32 mNumActions;  


 


  PDColorConvertAction mActions;  


 


  ASInt32 mNumInks;  


 


  PDColorConvertAction mInks;  

}

The list of actions in PDColorConvertParams is analogous to the list of filters in most email clients: each object is compared against the selection criteria for each of the actions, in order, until a matching action is found. The action is then executed on the object. Note that actions do not chain, except in the case of aliased ink definitions.

File: AcroColorExpT.h

Line: 1435

Elements

	mNumActions	The number of color conversion actions.

	mActions	The actions, arranged sequentially in memory.

	mNumInks	The number of specific inks supplied.

	mInks	The list of ink actions, arranged sequentially in memory.

PDColorConvertParamsRecEx

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDColorConvertParamsRecEx {

  ASSize_t mSize;  


 


  ASInt32 mNumActions;  


 


  PDColorConvertActionEx mActions;  


 


  ASInt32 mNumInks;  


 


  PDColorConvertActionEx mInks;  

}

File: AcroColorExpT.h

Line: 1536

Elements

	mSize	The size of this data structure.

	mNumActions	The number of color conversion actions.

	mActions	The actions, arranged sequentially in memory.

	mNumInks	The number of specific inks supplied.

	mInks	The list of ink actions, arranged sequentially in memory.

Callbacks Detail

PDAuthProc

Product availability: All

Platform availability: All

Syntax

ASBool (*PDAuthProc)(PDDoc pdDoc)

A callback used by PDDocOpen. It is called when an encrypted document is being opened to determine whether the user is authorized to open the file.

This callback implements whatever authorization strategy you choose and calls the callbacks of the appropriate security handler (the one that was used to secure the document) to obtain and check authorization data.

The PDAuthProc() must call the security handler's PDCryptGetAuthDataProc() to obtain whatever authorization data is needed (such as a password), then call PDDocAuthorize() (which is mostly a call to the security handler's PDCryptAuthorizeProc()) to determine whether this data authorizes access to the file (for example, it verifies if the user provided the correct password). The PDAuthProc() must also free the authorization data by calling the security handler's PDCryptFreeAuthDataProc() (or ASfree(), if the handler does not have a PDCryptFreeAuthDataProc()).

For Acrobat 3.0 and earlier, the correct way to obtain the security handler in a PDAuthProc() is to call PDDocGetNewCryptHandler(), relying on the fact that it returns the security handler if the document has no new security handler, and the fact that at the time the file is opened, it cannot yet have a new security handler (in the future, one or more new methods may be added to make this procedure more straightforward). The Acrobat viewer's built-in authorization procedure works according to the following algorithm:

Call the security handler's PDCryptAuthorizeProc() with NULL authorization data to automatically handle the case where no authorization data is needed (for example, the file has a NULL password).

If PDCryptAuthorizeProc() returns true, open the file.

If PDCryptAuthorizeProc() returns false then Loop for i = 1 to 3 {Call the security handler's PDCryptGetAuthDataProc(). If PDCryptGetAuthDataProc returns true { Call PDDocAuthorize().

If it returns true (authorized) call the security handler's PDCryptFreeAuthDataProc(). Exit the loop and return from PDAuthProc().} Call the security handler's PDCryptFreeAuthDataProc().}

If it failed to get authorization after three attempts, display a dialog box indicating that user is not authorized to open the file. }return from PDAuthProc().

See Also

PDDocAuthorize
PDDocOpen
PDDocOpenEx

File: PDExpT.h

Line: 1255

PDAuthProcEx

Product availability: All

Platform availability: All

Syntax

ASBool (*PDAuthProcEx)(PDDoc pdDoc, void *clientData)

A callback used by PDDocOpenEx(). It is called when an encrypted document is opened, to determine whether the user is authorized to open the file.

The PDAuthProcEx() should obtain the authorization data (usually a password) and call PDDocAuthorize(). PDDocAuthorize() in turn calls the document encryption handler's Authorize function, which returns the permissions that the authorization data enables. PDDocAuthorize() adds these permissions to those currently allowed, and returns the new set of allowed permissions.

See Also

PDDocAuthorize
PDDocOpen
PDDocOpenEx

File: PDExpT.h

Line: 1287

PDColorConvertReportProc

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*PDColorConvertReportProc)(PDColorConvertObjectAttributes objectType, PDColorConvertSpaceType colorSpaceType, PDColorConvertActionType action, PDCompletionCode completionCode, PDReasonCode reasonCode, void *userData)

File: AcroColorExpT.h

Line: 1585

PDGetDataProc

Product availability: All

Platform availability: All

Syntax

ASBool (*PDGetDataProc)(char *data, ASUns32 lenData, void *clientData)

A callback for PDXObjectGetData(). It is passed the XObject's data. Currently, the XObject's data is read 1 kB at a time and passed to this callback.

See Also

PDXObjectGetData

File: PDExpT.h

Line: 3031

PDImplicitMetadataProc

Product availability: All

Platform availability: All

Syntax

void (*PDImplicitMetadataProc)(PDDoc pdDoc, void *data)

Calculates implicit metadata. Clients that maintain metadata items that have to be recalculated should register for the PDDocCalculateMetadata() notification with this callback. The callback should obtain the metadata with which it is concerned, change it, and put the changed metadata back in the object from which it was obtained.

Notifications

PDDocCalculateMetadata

File: PDMetadataExpT.h

Line: 43

PDLaunchActionProc

Product availability: All

Platform availability: All

Syntax

ASBool (*PDLaunchActionProc)(void *fileSpecHandlerObj, PDDoc pdDoc, PDAction pdAction)

(Optional) A callback for PDFileSpecHandler. It launches a specified file. It is called when the Acrobat viewer encounters a Launch (GoTo File) action. If this callback is NULL, no launch action is performed.

File: PDExpT.h

Line: 1170

PDResourceEnumColorSpaceProc

Product availability: All

Platform availability: All

Syntax

ASBool (*PDResourceEnumColorSpaceProc)(char *name, CosObj colorSpace, void *clientData)

A callback for PDResourceEnumMonitor. It is called for color space resources.

See Also

PDFormEnumResources

File: PDExpT.h

Line: 2640

PDResourceEnumFontProc

Product availability: All

Platform availability: All

Syntax

ASBool (*PDResourceEnumFontProc)(PDFont font, char *name, void *clientData)

A callback for PDResourceEnumMonitor. It is a procedure called for font resources.

See Also

PDFormEnumResources

File: PDExpT.h

Line: 2600

PDResourceEnumProcSetProc

Product availability: All

Platform availability: All

Syntax

ASBool (*PDResourceEnumProcSetProc)(char *name, void *clientData)

A callback for PDResourceEnumMonitor. It is a procedure called for ProcSet resources.

See Also

PDFormEnumResources

File: PDExpT.h

Line: 2626

PDResourceEnumXObjectProc

Product availability: All

Platform availability: All

Syntax

ASBool (*PDResourceEnumXObjectProc)(PDXObject xObject, char *name, void *clientData)

A callback for PDResourceEnumMonitor. It is a procedure called for XObject resources.

See Also

PDFormEnumResources

File: PDExpT.h

Line: 2613

PDStringEnumProc

Product availability: All

Platform availability: All

Syntax

ASBool (*PDStringEnumProc)(PDFont font, char *string, ASInt32 stringLen, ASFixed delta, void *clientData)

A callback for PDTextEnum(). It is called once for each string in a text object.

See Also

PDTextEnum

File: PDExpT.h

Line: 2987

Method Detail

PDApplyFunction

()

Product availability: All

Platform availability: All

Syntax





void PDApplyFunction(CosObj funcDict, const  inVals, float outVals)

Given a CosObj that represents a function, it applies the function to the supplied values.

It raises an error if the CosObj is malformed.

Parameters

	`funcDict` —	The CosObj representing a function.

	`inVals` —	Input values.

	`outVals` —	Output values.

Exceptions

genErrBadParm is raised if the CosObj is not a function dictionary.

Since

PI_PDMODEL_VERSION >= 0x00050000

File: PDProcs.h

Line: 7520

PDApplyFunctionEx

()

Product availability: All

Platform availability: All

Syntax





void PDApplyFunctionEx(CosObj funcDict, const  inVals, const ASArraySize nInput, float outVals, const ASArraySize nOutput)

Given a CosObj that represents a function, it applies the function to the supplied values.

It raises an error if the CosObj is malformed.

Parameters

	`funcDict` —	The CosObj representing a function.

	`inVals` —	Input values.

	`nInput` —	Number of input values.

	`outVals` —	Output values.

	`nOutput` —	Number of output values.

Exceptions

genErrBadParm is raised if the CosObj is not a function dictionary or the number of i/o do not match with that of the function.

Since

PI_PDMODEL_VERSION >= 0x00100000

File: PDProcs.h

Line: 12582

PDColorConvertPDEElement

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEElement PDColorConvertPDEElement(PDDoc doc, PDEElement elem, AC_Profile targetProfile, AC_RenderIntent intent, ASBool embed)

Converts a PDEElement to the supplied color space.

Parameters

	`doc` —	The document in which the element is located.

	`elem` —	The element to convert.

	`targetProfile` —	The ICC profile to which the color should be converted.

	`intent` —	The rendering intent to use for the conversion. AC_UseProfileIntent can be passed in order to use the default intent. (Note that it is not actually using the profile intent, but is using the current intent in the PDF graphics state).

	`embed` —	If `true`, embed the color space and make the object calibrated. If it is `false` and the target profile is CMYK, RGB, or Gray, the colors space of the resulting object, after conversion, will be DeviceCMYK, DeviceRGB, or DeviceGray, respectively.

Returns

See Also

PDColorConvertPDEElementEx

File: AcroColorProcs.h

Line: 974

PDColorConvertPDEElementEx

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEElement PDColorConvertPDEElementEx(PDDoc doc, PDEElement elem, PDColorConvertParamsEx params)

Converts a PDEElement to the supplied color space.

Parameters

	`doc` —	The document in which the element is located.

	`elem` —	The element to convert.

	`params` —	The parameters block that describes how color conversions are to be performed.

Returns

See Also

PDColorConvertPDEElement

File: AcroColorProcs.h

Line: 1121

PDDrawCosObjToWindow

()

Product availability: All

Platform availability: All

Syntax





void PDDrawCosObjToWindow(CosObj cosObj, void* window, void* displayContext, ASBool isDPS, ASFixedMatrix* matrix, ASFixedRect* updateRect, CancelProc cancelProc, void* cancelProcClientData)

Draws the specified stream of PDF marking operators into the specified window. This method is used for platform-independent drawing of graphics and text. This API is not available on Mac 64.

This method changes the current page's CTM and zoom factor, and dirties the file.

Parameters

	`cosObj` —	The stream Cos object to draw into the window. This stream can be created using CosNewStream(). The stream's dictionary must contain a Resources key whose value is a dictionary specifying all the resources needed to draw the Cos object (including a ProcSet entry). Its structure and contents are the same as for the Resources dictionary for a Page object. See Section 3.7.2 in the PDF Reference for a description of a Page object's Resources dictionary. The stream's data is a sequence of PDF marking operators. See Appendix A in the PDF Reference for a description of these operators. A pseudocode example of the stream object is: `<< /Length 1000 /Filter` `[...filters...] /Resources <<` `/ProcSet [ /PDF /Text ]` `/Font <</F5 6 0 R /F9 12 0 R>> >>` `>>` `stream` `...stream data...` `endstream`

	`window` —	A pointer to a platform-dependent window object (`HWND` on Windows, `WindowPtr` or `CWindowPtr` on Mac OS). On Windows, to draw into an offscreen `DC`, pass `NULL` for `window`. On Mac OS, to draw into an off screen `GWorld`, pass `NULL` in window and pass the `GWorld`Ptr in displayContext.

	`displayContext` —	A pointer to a platform-dependent display context structure (`hDC` on Windows, `GWorldPtr` on Mac OS). On Mac OS, `displayContext` is ignored if `windows` is non-`NULL`.

	`isDPS` —	Currently unused. Always set it to `false`.

	`matrix` —	A pointer to a matrix to concatenate onto the default page matrix. It is useful for scaling and for converting from page to window coordinates.

	`updateRect` —	A pointer to a rectangle, specified in user space coordinates. Any objects outside of `updateRect` will not be drawn. All objects are drawn if `updateRect` is `NULL`.

	`cancelProc` —	A procedure called periodically to check for the user's cancelling of the drawing operation. The default cancel proc can be obtained using AVAppGetCancelProc(). It may be `NULL`, in which case no cancel proc is used.

	`cancelProcClientData` —	A pointer to user-supplied data to pass to `cancelProc` each time it is called. It should be `NULL` if `cancelProc` is `NULL`.

Since

PI_PDMODEL_VERSION >= 0x00020001

File: PDProcs.h

Line: 5422

PDDrawCosObjWithParams

()

Product availability: All

Platform availability: All

Syntax





void PDDrawCosObjWithParams(CosObj cosObj, PDDrawParams params)

Provides control over the rendering of contents, including both those parameters you would pass to PDDrawCosObjWithParams(), and an optional-content context that determines which contents are visible. This API is not available on Mac 64.

Parameters

	`cosObj` —	The object to draw.

	`params` —	The parameters with which to draw the object, including the optional-content context to use for content visibility.

See Also

PDDrawCosObjToWindow
PDPageEnumContents

Exceptions

pdPErrUnableToCreateRasterPort

Since

PI_PDMODEL_VERSION >= 0x00060000

File: PDProcs.h

Line: 10394

PDDrawPageOrCosObjectToBuffer

()

Product availability: All

Platform availability: All

Syntax





ASUns32 PDDrawPageOrCosObjectToBuffer(PDPage pdPage, CosObj cosStreamObj, ASAtom csFamily, AC_Profile iccProfile, AC_RenderIntent* renderIntent, ASInt32 bitsPerComponent, ASCab flags, ASInt32 greekTextLevel, PDOCContext ocContext, const ASRealMatrix* matrix, const ASRealRect* destRect, const ASRealRect* updateRect, char* buffer, ASUns32 bufferSize, ASStatusMonitorProcs statusMonitor)

PDDrawPageOrCosObjectToBuffer

It is designed to provide a rich conversion path between a a CosObject (e.g., a FormXObject) or a PDPage and its rendered equivalent. The user may provide an output color profile. The client must also indicate the color space to work in.

Renders a CosObj or PDPage to the buffer.

IMPORTANT: The buffer is padded to be 32-bit aligned; the width of the image in samples should be calculated as follows:

width = ceil(params->destRect:xMax) - floor(params->destRect:xMin)); width = ((((width * bpc * nComps)+31) / 32) * 4) * 8 / (bpc * nComps); nComps = 1 for DeviceGray, 3 for DeviceRGB, 4 for DeviceCMYK bpc = params->bitsPerComponent, see PDRenderParams. ceil(x) = the smallest integer that is greater than or equal to x; floor(x) = the largest integer that is less than or equal to x; Examples: floor(2.8) = 2.000000, floor(-2.8) = -3.000000 ceil(2.8) = 3.000000, ceil(-2.8) = -2.000000

Parameters

	`pdPage` —	The page to render; it should be NULL if a valid cosStreamObj is passed as the second parameter

	`cosStreamObj` —	The stream Cos Object to render, this parameter is used only if it is not NULL CosObj. This stream can be created using CosNewStream. The streams dictionary may contain a Resources dictionary specifying all the resources needed to draw the Cos object. Its structure and contents are the same as for the Resources dictionary for a Page object. If pageP is non-NULL, this parameter should be CosNewNull()

	`csFamily` —	The color space Family in which the bitmap data is represented. It must be one of DeviceGray, DeviceRGB, or DeviceCMYK. This parameter must be consistent with iccProfile.

	`iccProfile` —	A Color Profile of the same family as CSFamily ASAtom. This is the destination profile the contents will be drawn to. If it is NULL, the working color space matching the csFamily will be used, unless the flags parameter below sets option to not substitute working spaces, in which case the uncalibrated color space of csFamily type will be used.

	`renderIntent` —	It is used only if an ICCProfile is not NULL. If renderIntent is not set, default rendering intent is AC_RelColorimetric

	`bitsPerComponent` —	The number of bits per color component in the bitmap data. 8 is the only valid value for CMYK and RGB color space families. 1, 8, and 24 are valid for Gray color space family

	`flags` —	ASCab field used for passing drawing flags; All possible flags are listed in PDExpT.h for in groups PDPageDrawFlagsStr and PDPageDrawSmoothsFlagsStr

	`greekTextLevel` —	Size in points below which text is greeked

	`ocContext` —	An optional-content context that determines what contents are visible. NULL uses the document's optional-content context, as returned by PDDocGetOCContext(pddoc). This context is copied and the copy is used in drawing. This allows a client to change its copy of the context without raising an exception

	`matrix` —	Pointer to the matrix to be concatenated onto the default matrix to map from default user space to the resulting bitmap's image space. For example, if the page is to be rendered at 144 pixels/inch, the Matrix should be [2 0 0 2 0 0]. If NULL, API will do nothing and return 0

	`destRect` —	Pointer to the rectangle of the bitmap. Defined in device space coordinates. In the rectangle, destRect.left is xMin, destRect.right is xMax, destRect.bottom is yMin, and destRect.top is yMax. If NULL, API will do nothing and return 0

	`updateRect` —	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 all entries in updateRect are 0.0. In the rectangle, updateRect.left is xMin, updateRect.right is xMax, updateRect.bottom is yMin, and updateRect.top is yMax. If NULL, API will do nothing and return 0

	`buffer` —	Pointer to the bitmap data. If NULL, this function returns the size of buffer needed for the bitmap

	`bufferSize` —	The size of the buffer

	`statusMonitor` —	Only the cancelProc is in use for now. statusMonitor->cancelProc A method to call to check whether drawing should be canceled. If the method returns true, drawing is stopped; nothing is erased, and the buffer contains whatever was drawn up to the current state. statusMonitor->cancelProcClientData User-supplied data to pass to CancelProc each time it is called (about every 0.5 second.)

Returns

The size of the bitmap in bytes.

Since

PI_PDMODEL_VERSION >= 0x000C0000

File: PDProcs.h

Line: 12724

PDEnumDocs

()

Product availability: All

Platform availability: All

Syntax





void PDEnumDocs(PDDocEnumProc proc, void* clientData)

Enumerates the PDDoc objects that are currently open, calling a user-supplied procedure for each open document.

Parameters

	`proc` —	IN/OUT A user-supplied callback to call for each open PDDoc. Enumeration halts if `proc` returns `false`.

	`clientData` —	IN/OUT A pointer to user-supplied data to pass to `proc` each time it is called.

See Also

AVAppEnumDocs
PDDocOpen

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h

Line: 1184

PDGetAnnotHandlerByName

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDAnnotHandler PDGetAnnotHandlerByName(ASAtom name)

Gets the annotation handler that handles the specified annotation type.

Parameters

name —

IN/OUT The name of the requested annotation handler. The character string for the name can be converted to an ASAtom using ASAtomFromString().

Returns

The annotation handler that services annotations of type name. It returns the default annotation handler if no handler services the specified annotation type.

Since

PI_PDMODEL_VERSION >= 0x00040000

File: PDProcs.h

Line: 6757

PDGetHostEncoding

()

Product availability: All

Platform availability: All

Syntax





ASHostEncoding PDGetHostEncoding()

Indicates what kind of host encoding a system uses. It allows you to determine whether a system is Roman or non-Roman. (Non-Roman is also known as CJK-capable, which means that it is capable of handling multi-byte character sets such as Chinese, Japanese, or Korean).

For non-Roman systems, the host encoding may be a variety of encodings, which are defined by a CMap (character map). See Section 5.6.4 in the PDF Reference for a list of predefined CMaps.

Use PDGetHostEncoding() to determine if a system's host encoding is Roman.

Returns

0 for a Roman system, nonzero for a non-Roman system (a structure that depends on the host encoding). Users should simply test whether this value is 0.

Since

PI_PDMODEL_VERSION >= 0x00020003

File: PDProcs.h

Line: 6414

PDGetPDFDocEncoding

()

Product availability: All

Platform availability: All

Syntax





ASUns8 PDGetPDFDocEncoding()

Gets an array describing the differences between the platform's host encoding and PDFDocEncoding.

For non-Roman systems, the host encoding may be a variety of encodings, which are defined by a CMap (character map). See Section 5.6.4 in the PDF Reference for a list of predefined CMaps.

Use PDGetHostEncoding() to determine whether a system's host encoding is Roman.

Returns

An array containing 256 elements. Each element corresponds to a code point in the PDFDocEncoding, and is either NULL or a pointer to a string.

If the element is NULL, the code point refers to the same glyph in both host encoding and PDFDocEncoding. If the element is non-NULL, it points to a string containing the glyph name for the code point.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h

Line: 2848

PDHostMBLen

()

Product availability: All

Platform availability: All

Syntax





ASInt32 PDHostMBLen(const char* cp)

Gets the number of additional bytes required for the multi-byte character pointed to by cp. If cp points to a single-byte character, 0 is returned. This method makes it possible to determine the length of multi-byte character strings to allocate space for them.

This function is similar to the ANSI-C code:

mblen(cp, MB_LEN_MAX) - 1

or the Windows function:

IsDBCSLeadByte(cp)

Parameters

cp —

The character to examine.

Returns

The number of bytes in the multi-byte character.

Since

PI_PDMODEL_VERSION >= 0x00020003

File: PDProcs.h

Line: 6384

PDPrefGetBlackPointCompensation

()

Product availability: All

Platform availability: All

Syntax





ASBool PDPrefGetBlackPointCompensation()

Returns the black-point compensation flag.

Returns

true if black-point compensation is done.

See Also

PDPrefSetBlackPointCompensation

File: PDProcs.h

Line: 11762

PDPrefGetColorCal

()

Product availability: All

Platform availability: All

Syntax





ASBool PDPrefGetColorCal(PDColorCalP colorCal)

Gets the values to use for displaying the calibrated color and grayscale. These values are the chromaticity and gammas of the phosphors in the monitor.

These values are used for rendering if calibrated color is enabled by the preferences file item avpDoCalibratedColor (see AVAppGetPreference()).

Parameters

colorCal —

IN/OUT (Filled by the method) A pointer to a structure that contains the color calibration information. For RGB devices, the red, green, and blue chromaticity and gammas are used; for grayscale, whiteChrom and greenGamma are used. You must allocate storage for the colorCal data structure and pass a pointer to the memory you allocated.

Returns

Always returns true.

See Also

PDPrefSetColorCal
AVAppGetPreference

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h

Line: 5308

PDPrefGetUseOutputIntents

()

Product availability: All

Platform availability: All

Syntax





ASBool PDPrefGetUseOutputIntents()

Returns the value of the Output Intent flag. When this flag is true, the system overrides the working space with the Output Intent, if it is present.

Returns

The Output Intent flag value.

See Also

PDPrefSetUseOutputIntents

File: PDProcs.h

Line: 11741

PDPrefSetBlackPointCompensation

()

Product availability: All

Platform availability: All

Syntax





void PDPrefSetBlackPointCompensation(ASBool kbpc)

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 —

true to enable black-point compensation, false otherwise.

See Also

PDPrefGetBlackPointCompensation

File: PDProcs.h

Line: 11755

PDPrefSetColorCal

()

Product availability: All

Platform availability: All

Syntax





ASBool PDPrefSetColorCal(PDColorCalP colorCal)

Sets the values to use for displaying the calibrated color and grayscale. These values are the chromaticities and gammas of the phosphors in the monitor.

These values do not necessarily correspond to the monitor being used; it is the responsibility of the client that sets these values to provide the correct values.

These values are used for rendering if calibrated color is enabled by the preferences file item avpDoCalibratedColor (see AVAppSetPreference()).

Parameters

colorCal —

A pointer to a structure that contains the color calibration information. For RGB devices, the red, green, and blue chromaticities and gammas are used; for grayscale, whiteChrom and greenGamma are used.

Returns

true if the values were successfully set and installed for the currently active display device, false otherwise.

See Also

PDPrefGetColorCal
AVAppSetPreference

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h

Line: 5285

PDPrefSetUseOutputIntents

()

Product availability: All

Platform availability: All

Syntax





void PDPrefSetUseOutputIntents(ASBool flag)

Sets the Output Intent flag.

Parameters

flag —

When true, use Output Intent to override a working space if it is present.

See Also

PDPrefGetUseOutputIntents

File: PDProcs.h

Line: 11731

PDPrefSetWorkingCMYK

()

Product availability: All

Platform availability: All

Syntax





void PDPrefSetWorkingCMYK(void* profile, ASUns32 profileLength)

Sets the current CMYK working space to a given ICC profile. A CMYK working space in PDF is defined as a profile to substitute for a corresponding /DeviceCMYK space.

Parameters

	`profile` —	A pointer to a buffer containing the ICC color profile.

	`profileLength` —	The length in bytes of the profile.

File: PDProcs.h

Line: 11786

PDPrefSetWorkingGray

()

Product availability: All

Platform availability: All

Syntax





void PDPrefSetWorkingGray(void* profile, ASUns32 profileLength)

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` —	A pointer to a buffer containing the ICC color profile.

	`profileLength` —	The length in bytes of the profile.

File: PDProcs.h

Line: 11800

PDPrefSetWorkingRGB

()

Product availability: All

Platform availability: All

Syntax





void PDPrefSetWorkingRGB(void* profile, ASUns32 profileLength)

Set the current RGB working space to a given ICC profile. An RGB working space in PDF is defined as a profile to substitute for a corresponding /DeviceRGB space.

Parameters

	`profile` —	A pointer to a buffer containing the ICC color profile.

	`profileLength` —	The length in bytes of the profile.

File: PDProcs.h

Line: 11774

PDRedactionGetProps

()

Product availability: All

Platform availability: All

Syntax





ASBool PDRedactionGetProps(PDAnnot redactionAnnot, PDRedactParams redactionProps)

Retrieves a set of properties for a given redaction mark.

Parameters

	`redactionAnnot` —	IN The redaction mark whose properties are to be returned.

	`redactionProps` —	OUT The set of properties to be filled by this method.

Returns

true if the properties were successfully returned, false otherwise.

Exceptions

pdErrBadAnnotation

File: PDProcs.h

Line: 11842

PDRedactionSetProps

()

Product availability: All

Platform availability: All

Syntax





ASBool PDRedactionSetProps(PDAnnot redactionAnnot, PDRedactParams redactionProps)

Assigns a set of properties to a given redaction mark.

Parameters

	`redactionAnnot` —	IN/OUT The redaction mark whose properties are to be assigned.

	`redactionProps` —	IN The set of properties to be assigned by this method.

Returns

true if the properties were successfully assigned, false otherwise.

Exceptions

pdErrBadAnnotation

File: PDProcs.h

Line: 11854

PDRegisterCryptHandler

()

Product availability: All

Platform availability: All

Syntax





void PDRegisterCryptHandler(PDCryptHandler handler, const char* pdfName, const char* userName)

Registers a new security handler with the Acrobat viewer.

Parameters

	`handler` —	A pointer to a structure that contains the security handler's callback functions. This structure must not be freed after calling PDRegisterCryptHandler().

	`pdfName` —	The name of the security handler as it will appear in the PDF file. This name is also used by PDDocSetNewCryptHandler(). Storage for this name can be freed after PDRegisterCryptHandler() has been called.

	`userName` —	The name of the security handler as it will be shown in menus. This name can be localized into different languages. Storage for this name can be freed after PDRegisterCryptHandler() has been called.

Exceptions

genErrBadParm is raised if the security handler's size field is incorrect.
ErrSysPDSEdit is raised if either pdfName or userName are already in use by a registered security handler.
genErrNoMemory is raised is memory is exhausted. Other exceptions may be raised as well.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h

Line: 2569

PDRegisterCryptHandlerEx

()

Product availability: All

Platform availability: All

Syntax





void PDRegisterCryptHandlerEx(PDCryptHandler handler, const char* pdfName, const char* userName, void* clientData)

Registers a new security handler with the Acrobat viewer. It is the same as PDRegisterCryptHandler() except that it accepts a client data parameter.

Parameters

	`handler` —	A pointer to a structure that contains the security handler's callback functions. This structure must not be freed after calling PDRegisterCryptHandlerEx().

	`pdfName` —	The name of the security handler as it will appear in the PDF file. This name is also used by PDDocSetNewCryptHandler(). Storage for this name can be freed after PDRegisterCryptHandlerEx() has been called.

	`userName` —	The name of the security handler as it will be shown in menus. This name can be localized to different languages. Storage for this name can be freed after PDRegisterCryptHandlerEx() has been called.

	`clientData` —	A pointer to user-supplied data to store with the handler.

Exceptions

genErrBadParm is raised if the security handler's size field is incorrect.
ErrSysPDSEdit is raised if either pdfName or userName are already in use by a registered security handler.
genErrNoMemory is raised is memory is exhausted.

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h

Line: 6032

PDRegisterFileSpecHandler

()

Product availability: All

Platform availability: All

Syntax





void PDRegisterFileSpecHandler(ASFileSys contextFileSys, PDFileSpecHandler fileSpecHandler, void* fileSpecHandlerObj)

Registers a new file specification handler with the Acrobat viewer. In version 3.0 and later of the Acrobat viewer, use the PDRegisterFileSpecHandlerByName method instead.

Parameters

	`contextFileSys` —	The file system that specifies the context in which the file specification handler is used. This is the file system on which the PDF document resides. It is sometimes necessary to use different file specification handlers depending on the file system in which the document is open. For example, when a document is opened in a web browser, the Acrobat viewer may use the browser's HTTP stack when it needs to use HTTP. When a document is opened outside of the browser, however, the Acrobat viewer must use a different HTTP stack.

	`fileSpecHandler` —	A pointer to a structure that contains the handler's callbacks. This structure must not be freed after calling PDRegisterFileSpecHandler().

	`fileSpecHandlerObj` —	A pointer to user-supplied data to pass to the file specification handler's callbacks each time they are called.

See Also

PDRegisterFileSpecHandlerByName

Exceptions

genErrNoMemory

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h

Line: 5239

PDRegisterFileSpecHandlerByName

()

Product availability: All

Platform availability: All

Syntax





void PDRegisterFileSpecHandlerByName(ASAtom specSysName, ASFileSys contextFileSys, PDFileSpecHandler fileSpecHandler, void* fileSpecHandlerObj)

Registers a new file specification handler with the Acrobat viewer. The viewer calls the appropriate file specification handler when it encounters a file specification in a PDF file. The appropriate file specification handler is the one whose specSysName matches the value of the FS key in the file specification and whose contextFileSys matches the file system on which the PDF file resides.

The file specification handler's file system, (passed as the fileSys field of fileSpecHandler), is used to obtain data from, or write data to, the file referred to by the file specification.

Parameters

	`specSysName` —	The name (as an ASAtom) of a file system with which this file specification works.

	`contextFileSys` —	The file system that specifies the context in which the file specification handler is used. This is the file system on which the PDF document resides. It is sometimes necessary to use different file specification handlers depending on the file system in which the document is open. For example, when a document is opened in a web broswer, the Acrobat viewer may use the browser's HTTP stack when it needs to use HTTP. When a document is opened outside of the browser, however, the Acrobat viewer must use a different HTTP stack.

	`fileSpecHandler` —	A pointer to a structure that contains the handler's callbacks. This structure must not be freed after calling PDRegisterFileSpecHandlerByName().

	`fileSpecHandlerObj` —	A pointer to user-supplied data to pass to the file specification handler's callbacks each time they are called.

See Also

PDRegisterFileSpecHandler

Exceptions

genErrNoMemory

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h

Line: 5534

PDSetHostEncoding

()

Product availability: All

Platform availability: All

Syntax





void PDSetHostEncoding(ASHostEncoding encoding, char* parseTable)

For internal use only.

Parameters

	`encoding`

	`parseTable`

Since

PI_PDMODEL_VERSION >= 0x00060000

File: PDProcs.h

Line: 10737

PDXlateToASText

()

Product availability: All

Platform availability: All

Syntax





void PDXlateToASText(const char* inHostString, ASInt32 inHostStringSize, ASText outPDFString)

Returns an ASText object corresponding to a host encoded string.

Parameters

	`inHostString` —	A pointer to the string to translate (it may point to the same memory as `outPDFString`, allowing strings to translate in place).

	`inHostStringSize` —	The number of bytes in the string to translate.

	`outPDFString` —	(Filled by the method) The text object corresponding to `inHostStringSize`. The client must pass a valid ASText object title. The routine does not allocate it.

Since

PI_PDMODEL_VERSION >= 0x00080000

File: PDProcs.h

Line: 11613

PDXlateToHost

()

Product availability: All

Platform availability: All

Syntax





void PDXlateToHost(char* in, char* out, ASInt32 numBytes)

Translates a string from PDFDocEncoding to host encoding. This method is useful when setting or retrieving displayed text that must be in PDFDocEncoding (or Unicode), such as text that appears in a text annotation or bookmark.

A character that cannot be converted to the destination encoding is replaced with a space.

Host encoding is a platform-dependent encoding for the host machine. For non-UNIX Roman systems, it is MacRomanEncoding on Mac OS and WinAnsiEncoding on Windows. On UNIX (except HP-UX) Roman systems, it is ISO8859-1 (ISO Latin-1); for HP-UX, it is HP-ROMAN8. See Appendix D in the PDF Reference for descriptions of MacRomanEncoding, WinAnsiEncoding, and PDFDocEncoding.

For non-Roman systems, the host encoding may be a variety of encodings, which are defined by a CMap (character map). See Section 5.6.4 in the PDF Reference for a list of predefined CMaps.

Use PDGetHostEncoding() to determine if a system's host encoding is Roman. For non-Roman systems, use PDXlateToHostEx().

In general, PDXlateToHostEx() can be called instead of PDXlateToHost() since PDXlateToHostEx() works for any host encoding.

Parameters

	`in` —	The string to translate (it may point to the same memory as `out`, allowing strings to translate in place).

	`out` —	(Filled by the method) The translated string (it may point to the same memory as `in`).

	`numBytes` —	The number of bytes in the string to translate.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h

Line: 2654

PDXlateToHostASText

()

Product availability: All

Platform availability: All

Syntax





ASInt32 PDXlateToHostASText(const ASText inPdfString, char* outHostString, ASInt32 outHostStringSize)

Returns a host encoded string corresponding to an ASText object.

Parameters

	`inPdfString` —	The text object.

	`outHostString` —	(Filled by the method) A pointer to the translated string.

	`outHostStringSize` —	The length of the `outHostString` buffer, in bytes.

Returns

The number of bytes in the translated string outHostString.

Since

PI_PDMODEL_VERSION >= 0x00080000

File: PDProcs.h

Line: 11591

PDXlateToHostEx

()

Product availability: All

Platform availability: All

Syntax





ASInt32 PDXlateToHostEx(const char* inPdfStr, ASInt32 inPdfStrSize, char* outHostStr, ASInt32 outHostStrSize)

Translates a string from Unicode or PDFDocEncoding to host encoding. This method is useful when setting or retrieving displayed text that might be in Unicode, such as text that appears in a text annotation or bookmark.

A character that cannot be converted to the destination encoding is replaced with a space.

Host encoding is a platform-dependent encoding for the host machine. For non-UNIX Roman systems, it is WinAnsiEncoding on Windows and MacRomanEncoding on Mac OS. On UNIX (except HP-UX) Roman systems, it is ISO8859-1 (ISO Latin-1); for HP-UX, it is HP-ROMAN8. See Appendix D in the PDF Reference for descriptions of WinAnsiEncoding, MacRomanEncoding, and PDFDocEncoding. For non-Roman systems, the host encoding may be a variety of encodings, which are defined by a CMap (character map). See Section 5.6.4 in the PDF Reference for information on CMaps.

For non-Roman systems, use PDXlatetoHostEx(). Use PDGetHostEncoding() to determine whether the host encoding for a system is Roman.

In general, PDXlatetoHostEx() operates in the same way as PDXlateToHost() but requires an extra argument, since the sizes of the input and translated strings may differ. This method can be called instead of PDXlateToHost(), and must be called for multi-byte character set systems.

Parameters

	`inPdfStr` —	IN/OUT A pointer to the string to translate (it may point to the same memory as `outHostStr`, allowing strings to translate in place).

	`inPdfStrSize` —	IN/OUT The length of `inPdfStr` in bytes.

	`outHostStr` —	IN/OUT (Filled by the method) A pointer to the translated string (it may point to the same memory as `inPdfStr`).

	`outHostStrSize` —	IN/OUT The length of the `outHostStr` buffer in bytes.

Returns

The number of bytes in the translated string outHostStr.

Since

PI_PDMODEL_VERSION >= 0x00020003

File: PDProcs.h

Line: 6310

PDXlateToPDFDocEnc

()

Product availability: All

Platform availability: All

Syntax





void PDXlateToPDFDocEnc(char* in, char* out, ASInt32 numBytes)

Translates a string from host encoding to PDFDocEncoding. This method is useful when setting or retrieving displayed text that must be in PDFDocEncoding (or Unicode), such as text that appears in a text annotation or bookmark.

A character that cannot be converted to the destination encoding is replaced with a space. For example, PDXlateToPDFDocEnc() converts '\n' to a space character ('\r' is present in PDFDocEncoding and is left unchanged).

For non-Roman systems, the host encoding may be a variety of encodings, which are defined by a CMap (character map). See Section 5.6.4 in the PDF Reference for a list of predefined CMaps. Use PDGetHostEncoding() to determine if a system's host encoding is Roman. For non-Roman systems, use PDXlateToPDFDocEncEx().

In general, PDXlateToPDFDocEncEx() can be called instead of PDXlateToPDFDocEnc(), since PDXlateToPDFDocEncEx() works for PDFDocEncoding or Unicode.

Parameters

	`in` —	The string to translate (it may point to the same memory as `out`, allowing strings to translate in place).

	`out` —	(Filled by the method) The translated string (it may point to the same memory as `in`).

	`numBytes` —	The number of bytes in the string to translate.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h

Line: 2612

PDXlateToPDFDocEncEx

()

Product availability: All

Platform availability: All

Syntax





ASInt32 PDXlateToPDFDocEncEx(ASBool bUseUnicode, const char* inHostStr, ASInt32 inHostStrSize, char* outPDFStr, ASInt32 outPDFStrSize)

Translates a string from host encoding to PDFDocEncoding or Unicode. This method is useful when using text that must be in PDFDocEncoding or Unicode, such as text in a text annotation, bookmark, or article title.

A character that cannot be converted to the destination encoding is replaced with a space. For example, PDXlateToPDFDocEncEx() converts '\n' to a space character ('\r' is present in PDFDocEncoding and is left unchanged).

For non-Roman systems, the host encoding may be a variety of encodings, which are defined by a CMap (character map). See Section 5.6.4 in the PDF Reference for a list of predefined CMaps.

For non-Roman systems, use PDXlateToPDFDocEncEx(). You can use PDGetHostEncoding() to determine whether a system's host encoding is Roman.

In general, PDXlateToPDFDocEncEx() can be called instead of PDXlateToPDFDocEnc() since PDXlateToPDFDocEncEx() works for PDFDocEncoding or Unicode.

Parameters

	`bUseUnicode` —	If `true`, translate the string to Unicode; otherwise use `PDFDocEncoding`.

	`inHostStr` —	A pointer to the string to translate (it may point to the same memory as `outPDFStr`, allowing strings to translate in place).

	`inHostStrSize` —	The number of bytes in the string to translate.

	`outPDFStr` —	(Filled by the method) A pointer to the translated string (it may point to the same memory as `inHostStr`).

	`outPDFStrSize` —	The length of the `outPDFStr` buffer, in bytes.

Returns

The number of bytes in the translated string outPDFStr.

Since

PI_PDMODEL_VERSION >= 0x00020003

File: PDProcs.h

Line: 6363

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
General	Defines \| Typedefs \| Enumerations \| Variables \| Structures \| Callbacks \| Methods

	PDUnknownCharSet = 0,

	PDStandardRomanCharSet = 1,

	PDAdobeExpertCharSet = 2,

	PDLastCharSet

	kColorConvPreserve,

	kColorConvConvert,

	kColorConvDecalibrate,

	kColorConvDownConvert,

	kColorConvMaxEnum = 0xFFFFFFFFL

	kColorConvObj_Image = _FLG(0),

	kColorConvObj_JPEG = _FLG(1),

	kColorConvObj_JPEG2000 = _FLG(2),

	kColorConvObj_Lossy = _FLG(3),

	kColorConvObj_Lossless = _FLG(4),

	kColorConvObj_Text = _FLG(5),

	kColorConvObj_LineArt = _FLG(6),

	kColorConvObj_Shade = _FLG(7),

	kColorConvObj_Transparent = _FLG(8),

	kColorConvObj_Overprinting = _FLG(9),

	kColorConvObj_OverprintMode = _FLG(10),

	kColorConvObj_AnyObject = (_FLG(0)\|_FLG(5)\|_FLG(6)\|_FLG(7)),

	kColorConvObj_MaxEnum = 0xFFFFFFFFL

	kColorConvDeviceSpace = _FLG(0),

	kColorConvCalibratedSpace = _FLG(1),

	kColorConvAlternateSpace = _FLG(3),

	kColorConvBaseSpace = _FLG(4),

	kColorConvIndexedSpace = _FLG(5),

	kColorConvSeparationSpace = _FLG(6),

	kColorConvDeviceNSpace = _FLG(7),

	kColorConvNChannelSpace = _FLG(8),

	kColorConvRGBSpace = _FLG(9),

	kColorConvCMYKSpace = _FLG(10),

	kColorConvGraySpace = _FLG(11),

	kColorConvLabSpace = _FLG(12),

	kColorConvAnySpace = (_FLG(0)\|_FLG(1)\|_FLG(2)\|_FLG(3)\|_FLG(4)\|_FLG(5)\|_FLG(6)\|_FLG(7)\|_FLG(8)\|_FLG(9)\|_FLG(10)\|_FLG(11)\|_FLG(12)),

	kColorConvSpace_MaxEnum = 0xFFFFFFFFL

	kNormal,

	kTransparent,

	kOpaqueInk,

	kOpaqueIgnore

	PDLayoutDontCare,

	PDLayoutSinglePage,

	PDLayoutOneColumn,

	PDLayoutTwoColumnLeft,

	PDLayoutTwoColumnRight,

	PDLayoutTwoPageLeft,

	PDLayoutTwoPageRight

	kPDDefaultMarkType = 0,

	kPDInDesignJ1MarkType,

	kPDInDesignJ2MarkType,

	kPDIllustratorMarkType,

	kPDIllustratorJ,

	kPDQuarkXPress

	pdRotate0 = 0,

	pdRotate90 = 90,

	pdRotate180 = 180,

	pdRotate270 = 270

	PDSaveIncremental = 0x00,

	PDSaveFull = 0x01,

	PDSaveCopy = 0x02,

	PDSaveLinearized = 0x04,

	PDSaveWithPSHeader = 0x08,

	PDSaveBinaryOK = 0x10,

	PDSaveCollectGarbage = 0x20,

	PDSaveForceIncremental = 0x40,

	PDSaveKeepModDate = 0x80,

	PDSaveLeaveOpen = 0x100

	PDSaveUncompressed = 1 << 0,

	PDSaveCompressed = 1 << 1,

	PDSaveCompressStructureOnly = 1 << 2,

	PDSaveRemoveASCIIFilters = 1 << 3,

	PDSaveAddFlate = 1 << 4,

	PDSaveReplaceLZW = 1 << 5,

	PDSaveOptimizeXObjects = 1 << 6,

	PDSaveOptimizeContentStreams = 1 << 7,

	PDSaveOptimizeFonts = 1 << 8,

	PDSaveOptimizeMarkedJBIG2Dictionaries = 1 << 9,

	PDSaveEnsure7bitASCII = 1 << 10,

	PDSaveAutoSave = 1 << 11,

	PDSaveOverrideCollections = 1 << 12

	ASUns32 size;

	PDAnnot redactionAnnots;

	ASUns32 redactionCount;

	ASBool keepMarks;

	ASStatusMonitorProcs statusProcs;

	ASText progressText;

	ASInt32 progressDuration;

	PDChromaticity whiteChrom;

	PDChromaticity redChrom;

	PDChromaticity greenChrom;

	PDChromaticity blueChrom;

	ASFixed redGamma;

	ASFixed greenGamma;

	ASFixed blueGamma;

	ASUns32 size;

	void* window;

	void* displayContext;

	ASFixedMatrix matrix;

	ASUns32 flags;

	ASFixedRect updateRect;

	CancelProc cancelProc;

	void* cancelProcClientData;

	PDOCContext clientOCContext;

	ASSize_t size;

	ASAtom colorantName;

	ASUns8 whatToDo;

	ASUns32 wasColorSet;

	ASStm epsStm;

	ASFile file;

	ASPathName path;

	float frequency;

	float angle;

	ASUns8 inkType;

	ASInt32 trapSequence;

	float density;

	ASAtom alias;

Layer	PD_Layer
Object	General

	ASSize_t size;

	ASUns32 psLevel;

	ASBool binaryOK;

	ASBool emitAnnots;

	ASBool emitHalftones;

	ASBool emitTransferFuncs;

	ASBool emitSeparableImagesOnly;

	ASBool suppressCJKSubstitution;

	ASEnum8 emitFontOption;

	ASBool TTasT42;

	ASBool printerHasFarEastFonts;

	ASUns32 transparencyLevel;

	ASBool useCMYKWorkingColorspace;

	char destProfile[256];

	ASBool convertToProcessUsingOPP;

	ASUns32 numPlates;

	PDHostSepsPlate plates;

	PDOCContext ocContext;

	ASBool applyOCGPrintOverrides;

	ASBool negative;

	ASEnum8 mirrorprint;

	ASUns32 whichMarks;

	ASBool western;

	ASBool doInRipTrapping;

	ASInt32 marksStyle;

	ASInt32 trapType;

	ASPathName customMarksPath;

	ASUns32 size;

	ASInt32 pageNum;

	ASFixedQuad redactQuads;

	ASUns32 numQuads;

	PDColorValueRec colorVal;

	ASText overlayText;

	PDHorizAlign horizAlign;

	ASSize_t size;

	PDResourceEnumFontProc EnumFont;

	PDResourceEnumXObjectProc EnumXObject;

	PDResourceEnumProcSetProc EnumProcSet;

	PDResourceEnumColorSpaceProc EnumColorSpace;

	PDColorConvertObjectAttributes mMatchAttributesAll;

	PDColorConvertObjectAttributes mMatchAttributesAny;

	PDColorConvertSpaceType mMatchSpaceTypeAll;

	PDColorConvertSpaceType mMatchSpaceTypeAny;

	AC_RenderIntent mMatchIntent;

	PDColorConvertActionType mAction;

	AC_RenderIntent mConvertIntent;

	AC_Profile mConvertProfile;

	ASBool mEmbed;

	ASBool mPreserveBlack;

	ASBool mUseBlackPointCompensation;

	ASAtom mColorantName;

	ASAtom mAlias;

	ASBool mIsProcessColor;

	void* mInternal;

	ASSize_t mSize;

	PDColorConvertObjectAttributes mMatchAttributesAll;

	PDColorConvertObjectAttributes mMatchAttributesAny;

	PDColorConvertSpaceType mMatchSpaceTypeAll;

	PDColorConvertSpaceType mMatchSpaceTypeAny;

	AC_RenderIntent mMatchIntent;

	double mMatchMinFontSize;

	double mMatchMaxFontSize;

	PDColorConvertActionType mAction;

	AC_RenderIntent mConvertIntent;

	AC_Profile mConvertProfile;

	ASBool mEmbed;

	ASBool mPreserveBlack;

	ASBool mPromoteGrayToCMYK;

	ASBool mUseBlackPointCompensation;

	ASAtom mColorantName;

	ASAtom mAlias;

	ASBool mIsProcessColor;

	ASBool mPreserveCMYKPrimaries;

	void* mInternal;

	ASInt32 mNumActions;

	PDColorConvertAction mActions;

	ASInt32 mNumInks;

	PDColorConvertAction mInks;

	ASSize_t mSize;

	ASInt32 mNumActions;

	PDColorConvertActionEx mActions;

	ASInt32 mNumInks;

	PDColorConvertActionEx mInks;