LayerAV_Layer
ObjectGeneral

General AV layer objects.



Define Summary
 Define
 ACCB2 (Windows)
 ACEX1 (Macintosh)
 ACEX1 (UNIX)
 ACEX1 (Windows)
 ACEX2 (Macintosh)
 ACEX2 (UNIX)
 ACEX2 (Windows)
 ACROBAT (UNIX)
 AcroCallback
 AcroViewError
 _AcroViewHFT_IS_BETA
 _AcroViewHFT_LAST_BETA_COMPATIBLE_VERSION
 _AcroViewHFT_LATEST_VERSION
 AcroViewHFT_LATEST_VERSION
 AcroViewHFT_VERSION_10
 AcroViewHFT_VERSION_11
 AcroViewHFT_VERSION_11_6
 AcroViewHFT_VERSION_12
 AcroViewHFT_VERSION_12_3
 AcroViewHFT_VERSION_2
 AcroViewHFT_VERSION_2_1
 AcroViewHFT_VERSION_2_2
 AcroViewHFT_VERSION_2_3
 AcroViewHFT_VERSION_4
 AcroViewHFT_VERSION_4_5
 AcroViewHFT_VERSION_5
 AcroViewHFT_VERSION_5_1
 AcroViewHFT_VERSION_6
 AcroViewHFT_VERSION_7
 AcroViewHFT_VERSION_8
 AcroViewHFT_VERSION_9
 ANNOT_CLIP_TEXT_SELECTION
Set this bit of flags to prevent the standard text selection tool from inverting your annotation.
 ANNOT_WANTS_SHIFT_KEY
Set this bit of flags to prevent the standard "shift-key ignores annotations" behavior.
 APPEND_MENU
 APPEND_MENUITEM
 ARROW_CURSOR
cursorID
 AV_ANNOT_POPUPISREADONLY
 AV_ANNOT_SHOW_OFFSCREEN_INDICATOR
 AV_ANNOT_SUPPORTS_REPLIES
 AV_ANNOT_SUPPRESS_POPUP
 AV_CAPS
KeyStates
 AVCB1 (UNIX)
 AVCB2 (UNIX)
 AV_COMMAND
KeyStates
 AV_CONTROL
KeyStates
 AVEXPORT (UNIX)
 AVEXPORTCDECL (UNIX)
 AVEXPORTDATA (UNIX)
 AVEXPORTDATA1 (UNIX)
 AVEXPORTDATA2 (UNIX)
 AVEXPORTPRIV (UNIX)
 AV_EXTENDED
This value can mean right-Alt, right-Ctrl or Enter on enhanced keyboards.
 AVICON_DONT_CACHE
Flags returned by AVIconHandler->getFlags().
 AVIMPORTDATA1 (UNIX)
 AVIMPORTDATA2 (UNIX)
 AV_INVERTED
This value means that the cursor is inverted, or the eraser side of a pen input device is being used.
 AVNUMSELECTORS
 AV_OPTION
KeyStates
 AVP
 AV_PENINUSE
The pen is used as input device.
 AV_PREFERENCES
 AVPS_MAC_ROMAN_ENC
Encoding identifiers (for TE).
 AVPSTR
 AVPS_WIN_ANSI_ENC
 AVPVOIDP
 AVS
 AV_SHIFT
KeyStates
 AVSIMPLESEL_TYPE
 AV_SPACE
KeyStates
 AVTRIGGER_CLOSE
 AVTRIGGER_HIDE
 AVTRIGGER_MOUSEUP
 AVTRIGGER_OPEN
 AVTRIGGER_SHOW
 AVTRIGGERTYPE_ANNOT
 AVTRIGGERTYPE_BOOKMARK
 AVTRIGGERTYPE_DEST
 AVTRIGGERTYPE_DOC
 AVTRIGGERTYPE_LINK
 AVTRIGGERTYPE_PAGE
 AVU
 AVX
 BAR_IBEAM_CURSOR
cursorID
 BOX_IBEAM_CURSOR
cursorID
 CALL_REPLACED_PROC
Calls the previous implementation of a replaced method (that is, the code that would have been executed before the method was replaced using REPLACE).
 CAN_EDIT
 CAN_SELECT_GRAPHICS
 COPYPAGE_CURSOR
cursorID
 COPYPAGES_CURSOR
cursorID
 CROPTOOL_CURSOR
cursorID
 CROPTOOL_SCISSORS_CURSOR
cursorID
 CROSSHAIR_3D_CURSOR
cursorID
 CROSSHAIR_ADD_CURSOR
cursorID
 CROSSHAIR_CURSOR
cursorID
 CROSSHAIR_SUBTRACT_CURSOR
cursorID
 DECLARE_MULTIAWAREAVROUTINE
 DefineMDSysErr (UNIX)
 DefineMDSysErr (Windows)
 DoNotScroll_F
 DoNotSpellCheck_F
 DRAGLEFTRIGHT_CURSOR
cursorID
 DRAGUPDOWN_CURSOR
cursorID
 EXTERNAL_AVPROCS_USER
 EXTERNAL_PDPROCS_USER
 FDF_FILEFILTERREC_UNIQUEID
 FIST_CURSOR
cursorID
 FIXED_DEFINED (UNIX)
 FontSvrError
 GetMethod_F
 GROW_4WAY_CURSOR
cursorID
 GROWBOTTOMLEFT_CURSOR
cursorID
 GROW_CURSOR
cursorID
 GROWLEFTRIGHT_CURSOR
cursorID
 GROWTOPBOTTOM_CURSOR
cursorID
 GROWTOPLEFT_CURSOR
cursorID
 HAND_CURSOR
cursorID
 HAND_THREAD_BEGIN_CURSOR
cursorID
 HAND_THREAD_CURSOR
cursorID
 HAND_THREAD_END_CURSOR
cursorID
 HAND_THREAD_UP_CURSOR
cursorID
 HAND_THREAD_UP_END_CURSOR
cursorID
 HIDDEN_CURSOR
cursorID
 HIGHLIGHT_CURSOR
cursorID
 HIGHLIGHTTEXT_CURSOR
cursorID
 IBEAM_3D_CURSOR
cursorID
 IBEAM_CURSOR
cursorID
 ifdef (Windows)
 include
 kAcrobatCreatorCode
Acrobat creator code.
 kAVBleedMarks
Emit bleed marks.
 kAVColorBarMarks
Emit color bar marks.
 kAVCropMarks
Emit crop marks.
 kAVEasternStyleMarks
Emit Eastern style marks (the default is Western style).
 kAVEmitBBoxClip
(New for 5.0) Emits a clip to the BoundingBox for EPS.
 kAVEmitCJKTTAsType2
Emit CJK TrueType fonts as CID Type 2 fonts.
 kAVEmitFlatness
Provide control over the emission of the setflat operator.
 kAVEmitFormFieldsOnly
Emit only form fields; this takes precedence over kAVSuppressAnnots.
 kAVEmitFormsAsPSForms
When emitting forms, use the execform operator.
 kAVEmitHalftones
Emit the halftones specified in the document.
 kAVEmitPostScriptXObjects
(PostScript only) Include the PostScript XObjects' content in the output.
 kAVEmitSeparableImagesOnly
Raise an error on images that cannot be represented in EPS files, following the separation conventions in Technical Note # 5044, Color Separation Conventions for PostScript Language Programs.
 kAVEmitStampsOnly
Emit document and stamp annotations only.
 kAVMaxJP2KRes
When emitting JPEG2000 images, use the maximum available resolution.
 kAVOptimizeForSpeed
(New for 5.0) (PostScript only) If set, PostScript is optimized for speed, otherwise pages must be independent.
 kAVPageInfoMarks
Emit page information marks.
 kAVPrintersMarks
Emit the printer's mark annotations, even if suppress annotations is on. The default is off.
 kAVSaveVM
(New for 5.0) Attempt to reduce the amount of VM used on PostScript printers.
 kAVSetPageSize
(New for 5.0) Enable setPageSize(), choose the paper tray by PDF page size.
 kAVSilent
(New for 5.0) When printing via the Windows Dynamic Data Exchange (DDE), alerts are not generated; false is returned.
 kAVSimulateInkBlack
Soft proofing: simulate ink black and paper white when doing soft proofing.
 kAVSimulatePaperWhite
EmitFlags
 kAVSuppressAnnots
(New for 5.0) Do not emit text annotations.
 kAVSuppressBG
Do not emit the BlackGeneration in the document.
 kAVSuppressCenter
(New for 5.0) Do not center the page.
 kAVSuppressCJKFontSubst
If the field is set, calls to AVDocPrintPagesWithParams() generate PostScript that suppresses printer-based font substitution for CJK fonts.
 kAVSuppressCropClip
Do not emit the cropbox page clip.
 kAVSuppressRotate
(New for 5.0) Do not rotate the page.
 kAVSuppressTransfer
Do not emit the transfer functions in the document.
 kAVSuppressUCR
Do not emit the UnderColorRemovals in the document.
 kAVTaskKeyButtonDefaultUserVisible
 kAVTaskKeyButtonOrder
 kAVTaskKeyDoesWork
 kAVTaskKeyHowToPanelName
 kAVTaskKeyToolBarName
 kAVTrapAnnots
Emit TrapNet annots, even if suppress annotations is on.
 kAVTrimMarks
Emit trim marks.
 kEPSTypeCode
EPS file.
 kFDFTypeCode
Forms data format.
 kIsUIMirrored
Key name for "enable UI Mirroring options"
 kKeyPrefsIntlDigitsUI
Key name for "enable Digits UI".
 kKeyPrefsIntlNationalDigits
Key name for "Current Keyboard Mode for Digits".
 kKeyPrefsIntlParagraphDir
Key name for paragraph direction.
 kKeyPrefsIntlRTLUI
Key name for "enable Right to left Options".
 kKeyPrefsIntlTargetLanguage
Key name for Target Language on Re-Launch.
 kKeyPrefsTouchUpComplexScript
Key name for "enable direction switching for PDFEdit(content editing) context menu"
 kKeyPrefsTouchUpHindiDigit
Key name for "enable Hindi digit option for PDFEdit(content editing)"
 kKeyPrefsTouchUpLigature
Key name for "enable Ligature option for PDFEdit(content editing)"
 kKeyPrefsTouchUpParagraphDirection
Key name for "enable default paragraph direction for PDFEdit(content editing)"
 kMaxLanguageNameLen
 kPDFStateSetAll
 kPDFTypeCode
Portable document format (PDF).
 kPrintDefaultDPI
EmitFlags
 kPrintDefaultGradDPI
EmitFlags
 kPrinterSpecNameLen (Macintosh)
 kPrinterSpecNameLen (Windows)
 kPrinterSpecUnicodeNameLen (Windows)
 kPrintMaxDPI
EmitFlags
 kPrintMaxGradDPI
EmitFlags
 kPrintMinDPI
EmitFlags
 kPrintMinGradDPI
EmitFlags
 kPrintUserNoteLen
 kSectionPrefsIntl
International section name.
 LINK_CURSOR
cursorID
 LINK_LAYER
Links live at this level.
 LOUPE_CURSOR
cursorID
 MDAPPERR (UNIX)
 MDERRINC (UNIX)
 MDSYSERR (UNIX)
 MDSYSERR (Windows)
 MEASURECLOSE_CURSOR
cursorID
 MEASURE_CURSOR
cursorID
 MOVE_3D_CURSOR
cursorID
 MOVE_CURSOR
cursorID
 MOVEPAGE_CURSOR
cursorID
 MOVEPAGES_CURSOR
cursorID
 MULTI_TASKS (UNIX)
 name
 NEXTPAGE_CURSOR
cursorID
 NOP_CURSOR
cursorID
 NO_SHORTCUT
 NOTE_3D_CURSOR
cursorID
 NOTE_LAYER
Closed notes live here, with open notes just above.
 PAGEVIEW_UPDATE_PAGENUM
The page number has changed.
 PAGEVIEW_UPDATE_PAGESIZE
A new view has been created.
 PAGEVIEW_UPDATE_SCROLL
The view has been scrolled.
 PAGEVIEW_UPDATE_ZOOM
The zoom has been changed.
 PDACTION_DESC_BUF_SIZE
 PDFEditError
 PDFEditNUMSELECTORS
 PDFEditPrivateHFTName
 PDFEditReadNUMSELECTORS
 PDF_FILEFILTERREC_UNIQUEID
 PDFXError
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PREPEND_MENU
 PREPEND_MENUITEM
 PREVPAGE_CURSOR
cursorID
 REPLACEPAGE_CURSOR
cursorID
 REPLACEPAGES_CURSOR
cursorID
 SELECTOBJECT_CURSOR
cursorID
 STICKYNOTE_CURSOR
cursorID
 TABLE_CURSOR
cursorID
 TEXTMARQUEE_3D_CURSOR
cursorID
 THREAD_CONNECT_CURSOR
cursorID
 THREAD_CURSOR
cursorID
 THREAD_END_CURSOR
cursorID
 TOOLBUTTON_EXTERNAL
Indicates that the toolbar button is visible only in the toolbar of an external application (such as a web browser).
 TOOLBUTTON_INTERNAL
Indicates that the toolbar button is visible only in the viewer's toolbar.
 TOUCHUPOBJ_CURSOR
cursorID
 UNSIGNEDCHARS (Macintosh)
 UNSIGNEDCHARS (UNIX)
 UNSIGNEDCHARS (Windows)
 USE_NAMED_IDLE_PROCS
 USE_NAMED_LATE_INIT_PROCS
 USE_NULLDOC (UNIX)
 VERTBEAMNOBAR_CURSOR
cursorID
 VERT_IBEAM_CURSOR
cursorID
 WAIT_CURSOR
cursorID
 WORD_ALIGN (UNIX)
 WORD_ALIGN (Windows)
 WORDFINDER_CURSOR
cursorID
 X11X (UNIX)
 ZOOM_DRAG_CURSOR
cursorID
 ZOOM_IN_CURSOR
cursorID
 ZOOM_MAX_CURSOR
cursorID
 ZOOM_OUT_CURSOR
cursorID
Typedef Summary
 Typedef
 ADMWindowRef
 ASPlatformPrinterSpec (Macintosh)
 ASPlatformPrinterSpec (UNIX)
 ASPlatformPrinterSpec (Windows)
 ASPlatformPrinterSpecRec (Macintosh)
 ASPlatformPrinterSpecRec (UNIX)
 ASPlatformPrinterSpecRec (Windows)
 AVAdjustCursorParams
 AVAdjustCursorParamsRec
 AVArraySize
An array size value for AV methods.
 AVAuxDataHandler
 AVAuxDataHandlerRec
 AVBatchContext
Placeholder only. Not currently implemented.
 AVBufferSize
The number of bytes.
 AVClickParams
 AVClickParamsRec
 AVCursor
A data structure representing the cursor.
 AVCursorID
Uses 0+ for valid values.
 AVDestInfo
 AVDestInfoRec
 AVDevCoord
An AVDevCoord contains an x or y coordinate in the page view's device space.
 AVDevRect
A data structure representing a rectangle (a quadrilateral having only horizontal and vertical sides) in a page view's device space.
 AVDevRectP
 AVDevSize
A size in the page view's device space.
 AVDragRectParams
 AVDragRectParamsRec
 AVDragTypeEx
AVDragType or -1 for err.
 AVExtensionInfo
 AVExtensionInfoEx
 AVExtensionInfoRec
 AVExtensionInfoRecEx
 AVFileDescRec
 AVFileFilterRec
 AVFilterIndex
A filter index value for AV methods. It uses 0+ for valid values, -1 for all others.
 AVFlagBits16
A flag-bits value for use in callback procedures.
 AVFlagBits32
A flag-bits value for use in callback procedures.
 AVIcon
 AVIconBundle
 AVIconBundle6
 AVIconBundleIconRef (Macintosh)
AVIcon
 AVIconBundleIconRef (UNIX)
AVIcon
 AVIconBundleIconRef (Windows)
AVIcon
 AVIconBundleRec
 AVIconBundleRec6
An icon bundle allows you to gather up multiple icons and present them to Acrobat as a single AVIcon. For example, when creating a toolbar button you can pass in an icon bundle specifying both gray and color icons; the gray icon will be used to draw the button in its normal state, the color icon will be used to draw the button when the pointer is over it. The format for icon bundles is platform-specific (primarily since the format for AVIcons is platform-specific). On Windows the icons are specified using HICONs, not HBITMAPs. On Mac OS, they are IconSuiteRef resources. The tags at the front are there so the implementation can determine with certainty that the information passed in is an icon bundle and not an Acrobat 4-compatible AVIcon.
 AVIconData
 AVIconDataRec
 AVIconHandler
 AVIconHandlerRec
 AVIconID
An icon on a menu item or toolbar button.
 AVIconType
Not used.
 AVKeyCode
A key code value for use in key-down callback procedures.
 AVMouseEventCode
Not used.
 AVNotificationData
 AVOpenSaveDialogOutParams
 AVOpenSaveDialogParams
 AVPageIndex
A page index value for use in an AVDoc view definition. It uses 0+ for valid values, -1 for invalid or non-applicable values.
 AVPixelOffset
A pixel offset value for use in an AVDoc view definition.
 AVPlatformWindowRef
 AVPoint
 AVPriority
A signed int for historical reasons.
 AVScreenCoord
An x or y coordinate in the screen space. (0,0) is at the top left of the main monitor.
 AVScreenRect
A data structure representing a rectangle (a quadrilateral having only horizontal and vertical sides) in a screen's coordinate space.
 AVSDKDependentInteger
 AVSimpleSelObj
 AVSimpleSelProcs
 AVSimpleSelProcsRec
 AVStatusItem
 AVStatusMonitorProcs
 AVStatusMonitorProcsRec
 AVStructNode
An opaque object representing a node in a document structure tree.
 AVTArraySize
The number of items (not the number of bytes) in an array, for use in page view methods.
 AVTBufferSize
The number of bytes in a buffer, for use in page view methods.
 AVTCount
A click-number value for use in page view callback procedures.
 AVTFlagBits
A flag-bits value for use in page view methods.
 AVTFlagBits16
A flag-bits value for use in tool button methods.
 AVTransHandler
A data structure containing callbacks that implement a transition handler. The callbacks implement the transition handler functions.
 AVTransHandlerRec
 AVTransitionPort
 AVTransitionPortRec
 AVTSmallArraySize
An array size value for use in page view methods.
 AVTVersionNumPart
A version number part.
 AVVersionNumPart
A version-number part.
 AVVersionParams
 AVZoomType (Windows)
 DrawContextType
 ExternalDocServerCreationData
 ExternalDocServerCreationDataRec
 ExternalDocWindowData (Macintosh)
 ExternalDocWindowData (UNIX)
 ExternalDocWindowData (Windows)
 ExternalDocWindowDataRec (Macintosh)
 ExternalDocWindowRefData (Macintosh)
 ExternalDocWindowRefDataRec (Macintosh)
 PDFind
 PDFlatten
 PDFolder
An opaque object representing a collection folder dictionary. Folders are used to provide grouping for files in a portable collection.
 PDFOptFlattenTransparencyOptions
 PDFOptFlattenTransparencyOptionsRec
 PDFOptImageOptions
 PDFOptImageOptionsRec
 PDFOptParams
 PDFOptParamsRec
 WinPort (Windows)
 WinPortRec (Windows)
Enumeration Summary
 Enumeration
  _t_AVZoomType (Windows)
Constants that specify the zoom strategy that Acrobat is to follow.
  _t_DrawContextType
constants for requesting Draw Context type for AVPageViewAcquireDrawContext
  AVAccessColorPolicy
Definitions specifying the manner in which the background and text colors are chosen when viewing a document.
  AVAccessReadOrder
Content reading orders used for accessibility support. kAVAccessInferredReadOrder, kAVAccessTBLRReadOrder, and kAVAccessWordyReadOrder can be used as values for the Reading Order preference. kAVAccessTaggedReadOrder and kAVAccessUndefinedReadOrder are used internally for managing the states of documents.
  AVBookletBinding
Booklet printing binding direction (used by AVDocPrintNupData() in the AVDocPrintParams structure).
  AVBookletDuplexMode
Booklet printing page duplex printing subset mode.
  AVBookmarkFilter
Constants used to define the set of bookmarks retrieved by AVDocGetBookmarks(). More than one constant can be passed into the API by OR'ing them.
  AVColorForcing
Constants that specify color forcing values for AVDocPrintOverrideData, used in AVDocPrintParams.
  AVDragType
Enumerates the commands for moving and changing the size of a rectangle.
  AVEmitAllFontsOptions
The new EmitFont enumeration covers all font types, not just Type 1.
  AVEmitFileOptions
  AVEmitType1FontsOptions
The following enumeration is deprecated. It is maintained solely for backward compatibility.
  AVFavToolFlags
  AVFullScreenMonitor
Describes the preferred monitor to use when going full-screen on a multi-monitor system.
  AVHowToTopicSortKey
  AVIconColorFormat
AVIcon
  AVIconDataFormat
Constants that specify a data format for an AVIconBundle6.
  AVIdentity
An enumerated data type used to identify the properties of a user's identity.
  AVInfoPanelUpdateType
Constants for use with AVPageViewUpdateInfoPanel().
  AVMarksStyleType
  AVMouseEvent
Constants identifying mouse events in AVMouseInfoRec.event.
  AVnUpPageOrder
N-up printing page order for AVDocPrintNupData (used by AVDocPrintParams).
  AVOpenSaveDialogFlags
An enumerated list of open and save dialog box flags.
  AVPageSize
Constants that specify page size types for AVDocPrintParams, introduced in Acrobat 6.0. If the pageSize field is not set, the old field shrinkToFit is used instead.
  AVPrefsType (Macintosh, UNIX)
  AVPrefsType (Windows)
A structure containing values that specify the Acrobat viewer's preferences settings. It can contain up to 255 entries. It contains bit-flag ASUns32 constants for use with AVDocPrintParams().
  AVPrintDuplexType
  AVPrintTrapType
  AVRasterizeFlags
Constants that specify rasterization methods to use for printing. These are used in AVDocPrintRasterizeData(), which is used in AVDocPrintParams.
  AVResourcePolicy
Font and resource policy values for AVDocPrintParams.
  AVSpecialCategory
Categories of special folders on the system. Used with folder types to locate folders. Note that some combinations of AVSpecialCategory and AVSpecialFolder are not valid. See AVSpecialError for a list of valid combinations.
  AVSpecialError
Operation status codes for the special folder methods.
  AVSpecialFolder
Special folder types on the system. It is used with folder categories to locate folders. Note that some combinations of AVSpecialCategory and AVSpecialFolder are not valid. See AVSpecialError for a list of valid combinations.
  AVTaskOrderNumbers
This enumerates the order of the built-in task buttons.
  AVTileMark
Constants that specify tile marking styles for AVDocPrintTileData(), used in AVDocPrintParams.
  AVUseValue
Constants that determine whether to let Acrobat decide whether to use a feature or force Acrobat to use or not to use the feature. It is used in AVDocPrintOverrideData(), which is used in AVDocPrintParams.
  AVZoomType (Macintosh, UNIX)
  kAVParagraphDirection
Describes the paragraph direction.
  PDFarEastFont
CJK font related option for PostScript printing.
  PDFindFlags
Passed to PDFindText().
  PDFlattenTilingMode
Support for tiled flattening
  PDFOptCompressionAlgo
RDR
  PDFOptCompressionQlty
RDR
  PDFOptDownsamplingAlgo
RDR
  PDFOptObjectCompression
RDR
  PDFOptPDFVersion
RDR
Variable Summary
 Variable
 gUnixHFT (UNIX)
 gUnixVersion (UNIX)
Structure Summary
 Structure
 _AVExtensionInfoRec
A data structure containing information about a client loaded by the viewer.
 _AVExtensionInfoRecEx
A newer version of AVExtensionInfo. This supports the new version format. Use pVersionParams to access version related information. For everything else, use the pExtensionInfo member which points to the same content as obtained using the older AVExtensionAcquireInfo API.
 _t_ASPlatformPrinterSpec (Macintosh)
 _t_ASPlatformPrinterSpec (UNIX)
 _t_ASPlatformPrinterSpec (Windows)
A data structure representing a platform specification for a printer. It is used in AVDocPrintParams.
 _t_AVAdjustCursorParams
Parameters that describe where and how a cursor event occurred, for the use of cursor handling callback procedures.
 _t_AVAuxDataHandler
A data structure containing callbacks and data representing an auxiliary data handler. NULL values are acceptable; in such cases default behavior is used.
 _t_AVClickParams
Parameters that describe where and how a mouse click occurred, for the use of click-handling callback procedures.
 _t_AVDestInfo
A data structure representing a destination in a PDF document. An AVDestInfo carries all the information that a PDViewDestination can. It is used for ensuring that cross-document links in external windows act as expected, so a client can go to a destination without building it via PDViewDestCreate(), which does not work on read-only documents.
 _t_AVDragRectParams
The parameters for AVPageViewDragRectSnappedEx(), which supersedes AVPageViewDragRectSnapped() in Acrobat 6.0. In addition to the parameters allowed by the earlier method, the new version allows you to specify your own drawing procedure.
 _t_AVFileDescRec
A structure to handle file types and/or extensions in open and save dialog boxes.
 _t_AVFileFilterRec
A structure to hold a series of file type descriptors that form a file filter for an open or save dialog box.
 _t_AVIconBundleRec
An icon bundle allows you to gather up multiple icons and present them to Acrobat as a single AVIcon. For example, when creating a toolbar button you can pass in an icon bundle specifying both gray and color icons; the gray icon will be used to draw the button in its normal state, and the color icon will be used to draw the button when the pointer is over it.
 _t_AVIconBundleRec6
An icon bundle allows you to gather up multiple icons and present them to Acrobat as a single AVIcon. For example, when creating a toolbar button you can pass in an icon bundle specifying both gray and color icons; the gray icon will be used to draw the button in its normal state, the color icon will be used to draw the button when the pointer is over it. The format for icon bundles is platform-specific (primarily since the format for AVIcon objects is platform-specific). On Windows the icons are specified using HICONs, not HBITMAPs. On Mac OS, they are IconSuiteRef resources. The tags at the front are there so the implementation can determine with certainty that the information passed in is an icon bundle and not an Acrobat 4-compatible AVIcon.
 _t_AVIconData
A data record for an AVIconBundle6.
 _t_AVIconHandlerRec
AVIcon
 _t_AVPoint
 _t_AVSimpleSelProcs
 _t_AVStatusMonitorProcs
A structure that contains a progress monitor, a cancel procedure, and an error report procedure.
 _t_AVTransHandler
A data structure containing callbacks that implement a transition handler. The callbacks implement the transition handler functions.
 _t_AVTransitionPort
A platform-dependent data structure for a transition.
 _t_ExternalDocServerCreationData
Data for an AVDoc in an external window. It is a platform-dependent structure used in AVDocOpenParams when opening an AVDoc with AVDocOpenFromASFileWithParamString(), AVDocOpenFromASFileWithParams(), or AVDocOpenFromPDDocWithParams().
 _t_ExternalDocWindowData (Macintosh)
Data for an AVDoc in an external window. It is a platform-dependent structure used in ExternalDocServerCreationData when opening an AVDoc with AVDocOpenFromASFileWithParamString(), AVDocOpenFromASFileWithParams(), or AVDocOpenFromPDDocWithParams().
 _t_ExternalDocWindowRefData (Macintosh)
(Mac OS only) Data for an external window. A platform-dependent structure used in ExternalDocWindowData when opening an AVDoc with AVDocOpenFromASFileWithParamString(), AVDocOpenFromASFileWithParams(), or AVDocOpenFromPDDocWithParams().
 _t_PDFOptFlattenTransparencyOptions
Transparency flattening options
 _t_PDFOptImageOptions
Image optimization options
 _t_PDFOptParams
RDR
 _t_WinPort (Windows)
The HWND is that of the document window's AVPageView region (the portion of the window in which the PDF file's pages are drawn).
 AVInkValue
An ink value for use in color separation methods.
 AVNotificationDataRec
 AVOpenSaveDialogOutParamsRec
A structure defining the output parameters related to a file save dialog box. It is used for AVAppSaveDialogEx().
 AVOpenSaveDialogParamsRec
A structure defining the properties and callbacks related to a file open/save dialog box. It is used for AVAppOpenDialog(), AVAppSaveDialog(), and AVAppChooseFolderDialog().
 AVVersionParamsRec
 ExecProcData
 PDFlattenRec
Controls tile flattening. It is primarily of interest to resource limited (embedded) systems developers.
Callback Summary
 Callback
 AVAuxDataPerformProc
(Optional) A callback for AVAuxDataHandler. It is called to process auxiliary data sent to the AVDoc using AVDocSendAuxData(). This callback must process the data appropriately for whatever auxDataType is sent.
 AVCmdHandlerInitProc
Initialize the command handler. It is called once for each command handler registered.
 AVCmdHandlerTermProc
Terminate the handler. It is called once for each handler registered when Acrobat shuts down. It is called before clients are unloaded.
 AVComputeEnabledProc
A callback that is used to determine whether a menu item, toolbar button, or tool is enabled. If used for a tool, it is one of the optional callbacks for AVTool.
 AVComputeMarkedProc
A callback that is used to determine whether a menu item or toolbar button is marked (a marked menu item has a check mark next to it, and a marked toolbar button appears selected). It is called before the menu item or toolbar button is displayed. If it returns false, the menu item of toolbar button is not marked; otherwise it is marked.
 AVComputeTooltipProc
A callback that is used to get the mega-tooltip help text for a toolbar button.
 AVComputeVisibleProc
A callback that is used to determine whether a toolbar button, menu item, or HowTo panel is visible when its parent is opened. It is called before the item is displayed. If it returns true, the item is visible; otherwise it is not visible.
 AVContextMenuAdditionProc
Called after a context menu has been created but before it is shown to the user. The callback can add menu items to or remove menu items from the menu. The client must register the callback using AVAppRegisterForContextMenuAddition().
 AVCustomNotificationProc
 AVExecuteProc
A callback that is called whenever a menu item or toolbar button is executed. It implements whatever the menu item or toolbar button does (for example, opening a file or initiating a search).
 AVIconHandlerGetFlagsProc
A callback for AVIconHandler. It returns the flags value for the icon.
 AVIconHandlerMeasureProc
A callback for AVIconHandler that retrieves the measurements of the icon. All icons in the bundle are assumed to be the same size.
 AVIconHandlerOpenStmProc
A callback for AVIconHandler. It opens a stream so that a drawing function can read the data contained in the icon set.
 AVIconHandlerReleaseProc
A callback for AVIconHandler. It releases the icon object.
 AVIconHandlerResizeProc
A callback for AVIconHandler. Creates a new icon with resized dimensions.
 AVIdleProc
A callback that is called periodically when the Acrobat viewer is otherwise idle.
 AVNotifyTooltipProc
A callback that is called whenever the mouse hovers long enough to display the tooltip text. It returns text that is displayed in the tooltip.
 AVOpenSaveDialogSettingsComputeEnabledProc
A client can provide this optional callback if you wish to control whether the settings button in the open or save dialog box is enabled or disabled. If you do not provide this callback function, then the state of the settings button, enabled or disabled, will be determined by whether the conversion handler has a settings proc.
 AVOpenSaveDialogSettingsExecuteProc
A client provides this optional callback to decide what action is taken when the user clicks on the settings button. The function is called back with the currently selected filter.
 AVSelectionEnumProc
A user-supplied callback that is passed in the call to AVDocEnumSelection. It is called once for each 'item' in the selection.
 AVSelectionPageRangeEnumProc
A user-supplied callback that is passed in the call to AVDocSelectionEnumPageRanges(). It is called once for each page in the selection, and consecutive pages are grouped into a single page range.
 AVSetFocusProc
Callback in ExternalDocServerCreationData to return focus to the browser displaying the document.
 AVSetMessageProc
(Unused) Callback in ExternalDocServerCreationData for opening PDF files in external windows.
 AVSimpleSelDataDestroyProc
 AVSimpleSelDeHiliteProc
 AVSimpleSelHiliteProc
 AVTextCopyProc
A callback for AVDocGetPageText(). Text is passed to it in the specified format.
 AVTransHandlerCompleteTransDictProc
A callback for AVTransHandler. This method is called after the user has selected a distinct transition. The transition handler must fill in any dictionary items necessary to create the effect specified by the uiName passed in. For example, if the Wipe transition handler is passed a uiName of "Wipe Left", it would set the Dir key in transDict to the value 180.
 AVTransHandlerDoPropertiesProc
A callback for AVTransHandler. This method is called when the user clicks the button in the transition settings dialog box. This allows the transition to bring up its own custom dialog box allowing the user to further specify the desired transition effect.
 AVTransHandlerEnumProc
A callback for AVAppEnumTransHandlers. It is called once for each transition handler.
 AVTransHandlerExecuteProc
A callback for AVTransHandler. It executes the specified transition. The transition handler is responsible for copying the pixels specified by srcTP to the location specified by dstTP. In the process, the handler can create any visual effect you desire, as long as the source pixels are eventually copied over the destination pixels in the end.
 AVTransHandlerGetBiDirEnabledProc
A callback for AVTransHandler.
 AVTransHandlerGetButtonTextProc
A callback for AVTransHandler. It gets a localized string that appears in the button on the transition settings dialog box. If AVTransHandlerGetButtonTextProc() is NULL or the string it returns is empty, no button will appear.
 AVTransHandlerGetInstructionsProc
(Unused) A callback for AVTransHandler.
 AVTransHandlerGetItemDirectionUINameProc
A callback for AVTransHandler.
 AVTransHandlerGetItemNameProc
Returns the canonical name for the item. It should return ASAtomNull if the item number is invalid. This was added in Acrobat 5.0 so that different transitions could be handled in a language-independent manner. If this call is not implemented, then it is acceptable to generate a synthetic name from the transition type and the item index. For example, the "Glitter" trans handler should return a canonical name such as "GlitterDown". If this call is not implemented, then the name will be the trans handler type "Glitter", plus a period, plus the item number (for example, "Glitter.0").
 AVTransHandlerGetItemUINameProc
A callback for AVTransHandler.
 AVTransHandlerGetNameProc
 AVTransHandlerGetSmoothActionEnabledProc
A callback for AVTransHandler.
 AVTransHandlerGetStringOneTextProc
A callback for AVTransHandler. Gets a localized string that appears above the button on the transition settings dialog box.
 AVTransHandlerGetStringTwoTextProc
A callback for AVTransHandler. It gets a localized string that appears below the button on the transition settings dialog box.
 AVTransHandlerGetTypeProc
A callback for AVTransHandler. It gets the transition type serviced by this handler. The handler for a given transition is found by comparing the result of PDTransGetSubtype() to the value returned by the registered transition handler's AVTransHandlerGetTypeProc() callbacks.
 AVTransHandlerGetUINameProc
A callback for AVTransHandler. It retrieves the user interface name for an existing PDTrans. For example, if the transition type is 'Wipe' and the direction is 180, AVTransHandlerGetUINameProc() would return "Wipe Left", localized.
 AVTransHandlerInitTransDictProc
A callback for AVTransHandler. This method should set default values in the transition dictionary, transDict.
 CrossDocLinkProc
A callback in ExternalDocServerCreationData. It is called when a cross-document link is clicked in an AVDoc in an external application's window.
 CrossDocLinkWithDestProc
A callback in ExternalDocServerCreationData. It is called when a cross-document link is clicked in an AVDoc in an external application's window.
 DoClickProcType
A callback for AVTool. It handles mouse clicks when the tool is active. For Mac OS, this handles button or option-button mouse clicks. For Windows, this handles right or left button mouse clicks.
 DoKeyDownProcType
A callback for AVTool. It handles key presses when the tool is active.
 DoLeaveProcType
A callback for AVTool. It is called when the tool leaves the page view (when the cursor is moved out of the page view).
 ExternalFilePermissionProc
 GetSelectionServerProcType
A callback for AVTool. It gets the selection server associated with the tool, if any.
 GetTypeProcType
A callback for AVTool. It returns the tool's name.
 HandleMouseWheelScrollProc
A callback for AVTool. Handles mouse wheel scroll events when the tool is active.
 IsPersistentProcType
A callback for AVTool. It indicates whether the tool should stay active after it has been used or is a one-shot tool.
 PDFindTranslateStringProc
PDFindTranslateStringProc() is passed to PDFindText().
 PluginExecProc
Method Summary
 Method
 
 
ASInt32 AVAcquireSpecialFilePathName(AVSpecialCategory cat, AVSpecialFolder fld, const char* cFile, ASFileSys* asfs, ASPathName* asp)
In Acrobat 6.0, this method is superseded by AVAcquireSpecialFilePathNameWithASText().
 
Obtains the path name for a file in a special folder. It is the caller's responsibility to release the ASPathName. This method may be used even if the associated file does not exist.
 
Obtains the path name of a special folder. This method cannot be used to obtain the ASPathName of a folder that does not exist. It is the caller's responsibility to release the ASPathName.
 
Releases the memory associated with a destination.
 
AVExtensionInfo AVExtensionAcquireInfo(AVArraySize nIndex)
Fills an AVExtensionInfoRec structure with some information about a client. It is the caller's responsibility to release the memory associated with the contents of the returned structure by calling AVExtensionReleaseInfo().
 
AVExtensionInfoEx AVExtensionAcquireInfoEx(AVArraySize nIndex)
Fills an AVExtensionInfoRecEx structure with some information about a client. It extends the AVExtensionInfoRec API which does not support new versioning scheme. Similar to AVExtensionAcquireInfo, it is the caller's responsibility to release the memory associated with the contents of the returned structure by calling AVExtensionReleaseInfoEx().
 
Returns the number of clients loaded by Acrobat.
 
Releases the memory associated with the contents of info.
 
Releases the memory associated with the contents of info.
 
ASBool AVGetOptimizerParamsForPreset(ASText presetName, AVDoc avDoc, PDFOptParams pdfOptParams)
This method can be used to obtain a PDFOptParamsRec structure populated with the values corresponding to a PDF Optimizer preset.
 
ASInt32 AVGetOptimizerPresets(ASText** pPresetNames)
This method fills the parameter with names of all PDF Optimizer presets that are available to the caller.
 
AVIcon AVIconCreateFromPDF(PDDoc pdDoc, ASInt32 pageNum, ASInt32 width, ASInt32 height)
Creates dynamically scalable icon from PDF.
 
Gets the value of a particular aspect of the active user's identity. Valid keys are login name, name, corporation and email.
 
Sets the value of a particular aspect of the active user's identity.
 
void AVLegacyToolBarAddButton(AVToolBar toolBar, AVToolButton button, ASBool before, AVToolButton otherButton)
Inserts a button into a toolbar. Call AVLegacyToolBarUpdateButtonStates() after adding a button to update the toolbar.
 
Inserts a button into a toolbar.
 
void AVLegacyToolBarEnumButtons(AVToolBar toolBar, AVToolButtonEnumProc enumProc, void* clientData)
Calls enumProc once for each toolbar button in the specified toolbar.
 
AVToolButton AVLegacyToolBarGetButtonByName(AVToolBar toolBar, ASAtom buttonName)
Gets the toolbar button that has the specified name.
 
Gets the number of buttons in toolbar.
 
ASBool AVLegacyToolBarIsRoomFor(AVToolBar toolBar, AVTCount nButtons, AVTCount nSeparators)
Tests whether there is room in a toolbar for an additional specified number of buttons and separators.
 
AVToolBar AVLegacyToolBarNew(const char* name, const char* title)
Creates a new named toolbar. AVAppRegisterToolBarPosition() must be called after creating the new toolbar to position it relative to other toolbars.
 
Creates a new sub-toolbar for use as a toolbar button flyout.
 
AVToolBar AVLegacyToolBarNewWithASText(const char* name, ASConstText title)
Creates a new named toolbar. AVAppRegisterToolBarPosition() must be called after creating the new toolbar to position it relative to other toolbars.
 
Forces a redraw of toolbar. Call this method when a toolbar button is added or removed, or one of the buttons changes state.
 
Adds the specified AVIcon to the AVToolbutton object's animation list.
 
Removes the specified button from the toolbar and destroys the button. Call AVLegacyToolBarUpdateButtonStates() after removing a button to update the toolbar.
 
Executes the AVExecuteProc() associated with button, if it exists. This AVExecuteProc() is set by AVLegacyToolButtonSetExecuteProc(). It does nothing if AVLegacyToolButtonIsEnabled() for the button returns false.
 
Returns the count of animation icons associated with this tool button.
 
Gets the period in seconds of how often to flip the tool button animation icons.
 
Gets the flyout attached to a toolbar button. A flyout is a sub-toolbar attached to a toolbar button.
 
Gets the icon associated with the specified AVToolButton.
 
Gets the label text associated with the specified AVToolButton and its priority value. The priority determines the preference order in which labels are shown when a toolbar is too short to hold all of the button labels. If the priority is less than kAVButtonPriorityOnExtraLow, the label text is not shown at all unless the user forces all labels to be shown using the General preferences panel.
 
Gets the menu attached to a toolbar button.
 
Gets the ASAtom corresponding to the name of the specified toolbar button.
 
Indicates whether the tool button animation list is flipping.
 
Tests whether a toolbar button is enabled.
 
Tests whether the specified button is marked.
 
Tests whether a toolbar button is a separator or a normal button.
 
AVToolButton AVLegacyToolButtonNew(ASAtom name, AVIcon icon, ASBool longOnly, ASBool isSeparator)
Creates a toolbar button with the specified name, icon and long-menus state. It can also be used to create a separator with the specified name.
 
Removes the specified button from the toolbar, but does not destroy the button. Call AVLegacyToolBarUpdateButtonStates() after removing a button to update the toolbar.
 
Removes all icons from the tool button animation list.
 
Sets the period in seconds of how often to flip the tool button animation icons.
 
Sets the AVComputeEnabledProc() associated with a toolbar button. This routine determines whether the button can be selected.
 
Sets the AVComputeMarkedProc() associated with a toolbar button. A marked button appears pressed on the screen.
 
Sets the AVComputeTooltipProc() associated with a toolbar button. This routine determines the text displayed in the mega-tooltip.
 
Sets the AVComputeVisibleProc() associated with a toolbar button. This routine determines whether the button is visible when its parent toolbar is visible.
 
void AVLegacyToolButtonSetExecuteProc(AVToolButton button, AVExecuteProc proc, void* clientData)
Sets the user-supplied procedure to call to actually perform the button's intended function.
 
Indicates that the specified toolbar button should be displayed in toolbars contained in external windows, such as in a web browser.
 
Attaches a sub-toolbar or flyout to a toolbar button. A copy of the button is attached to the front of the toolbar. A click-hold pops up the flyout and allow the user to select a different button.
 
void AVLegacyToolButtonSetHelpText(AVToolButton button, const char* text)
Sets the text to show in tooltips. This text is shown when the cursor is held over a toolbar button for a period of time.
 
Sets the text to show in tooltips. This text is shown when the cursor is held over a toolbar button for a period of time.
 
Sets a new icon for a toolbar button.
 
Sets the label text associated with the specified AVToolButton and its priority value. The priority determines the preference order in which labels are shown when a toolbar is too short to hold all of the button labels. If the priority is less than kAVButtonPriorityOnExtraLow, the label text is not shown at all unless the user forces all labels to be shown using the General preference panel.
 
Attaches a menu to a toolbar button.
 
Sets a new icon for a toolbar button to display in menus and other UI elements generated from the button that are too small to display the button's normal icon.
 
Sets the AVNotifyTooltipProc() associated with a toolbar button. This routine is called before text is displayed in the tooltip.
 
Starts flipping icons for specified button.
 
Stops flipping icons for specified button.
 
*name AVROUTINE(newlev , name )
 
ASBool AVUtilGetBaseNameAndExtensionByPathName(ASFileSys fileSys, ASPathName pathName, AVTArraySize numAddExt, const char*const * addExt, char** baseName, char** baseExt)
Parses a path name to obtain the base file name and extension for a particular file. The function enumerates all registered convertToPDF and convertFromPDF handlers to find a matching extension for the file passed in. This function allocates memory for the file name and extension. It is the caller's responsibility to free the memory allocated by the method.
 
ASBool AVUtilGetBaseNameAndExtensionByString(char* fileName, AVTArraySize numAddExt, const char*const * addExt, char** baseName, char** baseExt)
Parses a file name string to obtain the base file name path and extension for a particular file. The function enumerates all registered convertToPDF and convertFromPDF handlers to find a matching extension for the file passed in. This function allocates memory for the file name and extension. It is the caller's responsibility to free the memory allocated by the method.
 
ASBool AVUtilGetBaseNameAndExtensionEx(const ASFileSys fileSys, const ASPathName pathName, const ASText fileName, ASInt32 numAddExt, const char*const * addExt, ASText baseName, char** baseExt)
Parses a path name to obtain the base file name and extension for a particular file. The function enumerates all registered convertToPDF and convertFromPDF handlers to find a matching extension for the file passed in. This function allocates memory for the file name and extension. It is the caller's responsibility to free the memory allocated by the method.
 
ASInt32 DoObjFound(ConsultantAgent* pAgent, CosObj Obj, const PDFObjType* pObjTypeHierarchy, const iSizeObjHierarchy, ConsStack Stack, CosObj* pObjRet)
A callback called when an object is found.
 
ASInt32 DoObjIDFound(ConsultantAgent* pAgent, CosObj Obj, const PDFObjType* pObjTypeHierarchy, const iSizeObjHierarchy, ConsStack Stack, CosObj* pObjRet)
 
Functions that do not depend on the class' this pointer being present. So, these can be called from C or from an HFT. Hence, they require an active agent as a parameter.
 
ResFileRefNum GetAcroPluginResourceMap()
 
Validates PKCS7 Detached Sigantures for Protected View
 
ASBool GetRequestedHFT(const char* table, ASUns32 requiredVer, ASUns32* resultingVer, HFT* resultHFT)
 
ASBool GetRequestedHFT(const char* table, ASUns32 requiredVer, ASUns32* resultingVer, HFT* resultHFT)
 
ASBool IsChecked()
 
Gets the creation date of the folder.
 
Gets the description of the folder.
 
Gets the description of the folder as styled text, in XML Text Layout Format.
 
ASBool PDFolderGetFieldDate(PDFolder folder, ASAtom fieldID, ASTimeRec* date)
Gets the value of the specified date field in the folder.
 
ASBool PDFolderGetFieldNumber(PDFolder folder, ASAtom fieldID, float* number)
Gets the value of the specified numeric field in the folder.
 
ASBool PDFolderGetFieldStyle(PDFolder folder, ASAtom fieldID, ASCab styles)
Gets the style dictionary for the specified field in the folder
 
ASBool PDFolderGetFieldStyledText(PDFolder attachment, ASAtom fieldID, ASText text)
Gets the value of the specified text field in the folder as styled text, in XML Text Layout Format.
 
ASBool PDFolderGetFieldText(PDFolder folder, ASAtom fieldID, ASText text)
Gets the value of the specified text field in the folder.
 
Gets the first child of a folder.
 
ASInt32 PDFolderGetID(PDFolder folder)
Gets the ID number of a folder.
 
ASBool PDFolderGetModDate(PDFolder folder, ASTimeRec* date)
Gets the modification date of the folder.
 
void PDFolderGetName(PDFolder folder, ASText name)
Gets the name of a folder.
 
Gets the next sibling of a folder.
 
PDFolder PDFolderGetParent(PDFolder folder)
Gets the parent of the specified folder.
 
Gets the path of the folder.
 
ASBool PDFolderIsValid(PDFolder folder)
Determines if a PDFolder is valid.
 
void PDFolderSetCreationDate(PDFolder folder, const ASTimeRec* date)
Sets the creation date of the folder.
 
Sets the description of the folder. Removes a styled version if present.
 
Sets the description of the folder using styled text. Keeps the non-styled description in sync. with the styled version.
 
void PDFolderSetFieldDate(PDFolder folder, ASAtom fieldID, const ASTimeRec* date)
Sets the specified date field in the folder.
 
void PDFolderSetFieldNumber(PDFolder folder, ASAtom fieldID, float number)
Sets the specified numeric field in the folder.
 
void PDFolderSetFieldStyle(PDFolder folder, ASAtom fieldID, ASConstCab styles)
Sets the style dictionary for the specified field in the folder.
 
Sets the specified text field in the folder
 
void PDFolderSetFieldText(PDFolder folder, ASAtom fieldID, ASConstText text)
Sets the specified text field in the folder.
 
void PDFolderSetModDate(PDFolder folder, const ASTimeRec* date)
Sets the modification date of the folder.
 
void PDFolderSetName(PDFolder folder, ASConstText folderName)
Sets the name of a folder.
 
void PDFolderSetParent(PDFolder folder, PDFolder parent)
Sets the parent of the specified folder.
Defines Detail
_AcroViewHFT_IS_BETA 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _AcroViewHFT_IS_BETA 1

File: AVVers.h
Line: 4
_AcroViewHFT_LAST_BETA_COMPATIBLE_VERSION 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _AcroViewHFT_LAST_BETA_COMPATIBLE_VERSION 0x000B0000

File: AVVers.h
Line: 3
_AcroViewHFT_LATEST_VERSION 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _AcroViewHFT_LATEST_VERSION 0x000C0003

File: AVVers.h
Line: 2
ACCB2 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

#define ACCB2 __loadds

File: WinPltfm.h
Line: 107
ACEX1 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

#define ACEX1

File: MacPlatform.h
Line: 37
ACEX1 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define ACEX1

File: UnixPlatform.h
Line: 114
ACEX1 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

#define ACEX1 AVEX1

File: WinPltfm.h
Line: 123
ACEX2 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

#define ACEX2

File: MacPlatform.h
Line: 38
ACEX2 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define ACEX2

File: UnixPlatform.h
Line: 115
ACEX2 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

#define ACEX2

File: WinPltfm.h
Line: 124
ACROBAT 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define ACROBAT 1

File: UnixPlatform.h
Line: 149
AcroCallback 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroCallback type ACCB2

File: AF_ExpT.h
Line: 37
AcroViewError 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewError ErrBuildCode(ErrAlways, ErrSysAcroView, e)

File: AcroErr.h
Line: 304
AcroViewHFT_LATEST_VERSION 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_LATEST_VERSION _AcroViewHFT_LATEST_VERSION)

File: AVVers.h
Line: 7
AcroViewHFT_VERSION_10 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_10 0x000A0000

File: AVVers.h
Line: 21
AcroViewHFT_VERSION_11 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_11 0x000B0000

File: AVVers.h
Line: 22
AcroViewHFT_VERSION_11_6 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_11_6 0x000B0006

File: AVVers.h
Line: 23
AcroViewHFT_VERSION_12 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_12 0x000C0000

File: AVVers.h
Line: 24
AcroViewHFT_VERSION_12_3 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_12_3 AcroViewHFT_LATEST_VERSION

File: AVCalls.h
Line: 88
AcroViewHFT_VERSION_2 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_2 0x00020000

File: AVVers.h
Line: 9
AcroViewHFT_VERSION_2_1 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_2_1 0x00020001

File: AVVers.h
Line: 10
AcroViewHFT_VERSION_2_2 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_2_2 0x00020002

File: AVVers.h
Line: 11
AcroViewHFT_VERSION_2_3 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_2_3 0x00020003

File: AVVers.h
Line: 12
AcroViewHFT_VERSION_4 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_4 0x00040000

File: AVVers.h
Line: 13
AcroViewHFT_VERSION_4_5 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_4_5 0x00040005

File: AVVers.h
Line: 14
AcroViewHFT_VERSION_5 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_5 0x00050000

File: AVVers.h
Line: 15
AcroViewHFT_VERSION_5_1 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_5_1 0x00050001

File: AVVers.h
Line: 16
AcroViewHFT_VERSION_6 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_6 0x00060000

File: AVVers.h
Line: 17
AcroViewHFT_VERSION_7 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_7 0x00070000

File: AVVers.h
Line: 18
AcroViewHFT_VERSION_8 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_8 0x00080000

File: AVVers.h
Line: 19
AcroViewHFT_VERSION_9 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AcroViewHFT_VERSION_9 0x00090000

File: AVVers.h
Line: 20
ANNOT_CLIP_TEXT_SELECTION 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ANNOT_CLIP_TEXT_SELECTION 0x0001

Description

Set this bit of flags to prevent the standard text selection tool from inverting your annotation.


File: AVExpT.h
Line: 2983
ANNOT_WANTS_SHIFT_KEY 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ANNOT_WANTS_SHIFT_KEY 0x0002

Description

Set this bit of flags to prevent the standard "shift-key ignores annotations" behavior.


File: AVExpT.h
Line: 2985
APPEND_MENU 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define APPEND_MENU (9999)

File: AVExpT.h
Line: 1354
APPEND_MENUITEM 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define APPEND_MENUITEM (9999)

File: AVExpT.h
Line: 1350
ARROW_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ARROW_CURSOR 0

File: AVExpT.h
Line: 4210
AV_ANNOT_POPUPISREADONLY 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_ANNOT_POPUPISREADONLY 0x0001

File: AVExpT.h
Line: 2967
AV_ANNOT_SHOW_OFFSCREEN_INDICATOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_ANNOT_SHOW_OFFSCREEN_INDICATOR 0x0002

File: AVExpT.h
Line: 2968
AV_ANNOT_SUPPORTS_REPLIES 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_ANNOT_SUPPORTS_REPLIES 0x0004

File: AVExpT.h
Line: 2969
AV_ANNOT_SUPPRESS_POPUP 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_ANNOT_SUPPRESS_POPUP 0x0008

File: AVExpT.h
Line: 2970
AV_CAPS 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_CAPS 128

File: AVExpT.h
Line: 4420
AV_COMMAND 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_COMMAND 4

File: AVExpT.h
Line: 4401
AV_CONTROL 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_CONTROL 2

File: AVExpT.h
Line: 4398
AV_EXTENDED 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_EXTENDED 16

Description

This value can mean right-Alt, right-Ctrl or Enter on enhanced keyboards.


File: AVExpT.h
Line: 4409
AV_INVERTED 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_INVERTED 32

Description

This value means that the cursor is inverted, or the eraser side of a pen input device is being used.


File: AVExpT.h
Line: 4414
AV_OPTION 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_OPTION 8

File: AVExpT.h
Line: 4404
AV_PENINUSE 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_PENINUSE 256

Description

The pen is used as input device.


File: AVExpT.h
Line: 4425
AV_PREFERENCES 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_PREFERENCES

File: AVPrefsD.h
Line: 221
AV_SHIFT 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_SHIFT 1

File: AVExpT.h
Line: 4395
AV_SPACE 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AV_SPACE 64

File: AVExpT.h
Line: 4417
AVCB1 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define AVCB1

File: UnixPlatform.h
Line: 111
AVCB2 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define AVCB2

File: UnixPlatform.h
Line: 112
AVEXPORT 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define AVEXPORT

File: UnixPlatform.h
Line: 105
AVEXPORTCDECL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define AVEXPORTCDECL

File: UnixPlatform.h
Line: 106
AVEXPORTDATA 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define AVEXPORTDATA

File: UnixPlatform.h
Line: 107
AVEXPORTDATA1 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define AVEXPORTDATA1

File: UnixPlatform.h
Line: 125
AVEXPORTDATA2 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define AVEXPORTDATA2

File: UnixPlatform.h
Line: 126
AVEXPORTPRIV 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define AVEXPORTPRIV

File: UnixPlatform.h
Line: 108
AVICON_DONT_CACHE 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVICON_DONT_CACHE 1

Description

Flags returned by AVIconHandler->getFlags().


File: AVExpT.h
Line: 556
AVIMPORTDATA1 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define AVIMPORTDATA1

File: UnixPlatform.h
Line: 127
AVIMPORTDATA2 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define AVIMPORTDATA2

File: UnixPlatform.h
Line: 128
AVNUMSELECTORS 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVNUMSELECTORS (AVNUMSELECTORSplusOne - 1)

File: AVCalls.h
Line: 223
AVP 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVP a,

File: AVExpT.h
Line: 105
AVPS_MAC_ROMAN_ENC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVPS_MAC_ROMAN_ENC 101

Description

Encoding identifiers (for TE).


File: PDFLExpT.h
Line: 1609
AVPS_WIN_ANSI_ENC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVPS_WIN_ANSI_ENC 102

File: PDFLExpT.h
Line: 1611
AVPSTR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVPSTR a,

File: AVExpT.h
Line: 109
AVPVOIDP 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVPVOIDP a,

File: AVExpT.h
Line: 108
AVS 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVS AVP

File: AVExpT.h
Line: 107
AVSIMPLESEL_TYPE 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVSIMPLESEL_TYPE "SimpleSelectHub"

File: AVExpT.h
Line: 9718
AVTRIGGER_CLOSE 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVTRIGGER_CLOSE ASAtomFromString("Close")

File: AVExpT.h
Line: 5758
AVTRIGGER_HIDE 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVTRIGGER_HIDE ASAtomFromString("Hide")

File: AVExpT.h
Line: 5760
AVTRIGGER_MOUSEUP 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVTRIGGER_MOUSEUP ASAtomFromString("Mouse Up")

File: AVExpT.h
Line: 5756
AVTRIGGER_OPEN 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVTRIGGER_OPEN ASAtomFromString("Open")

File: AVExpT.h
Line: 5757
AVTRIGGER_SHOW 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVTRIGGER_SHOW ASAtomFromString("Show")

File: AVExpT.h
Line: 5759
AVTRIGGERTYPE_ANNOT 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVTRIGGERTYPE_ANNOT ASAtomFromString("Annot")

File: AVExpT.h
Line: 5754
AVTRIGGERTYPE_BOOKMARK 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVTRIGGERTYPE_BOOKMARK ASAtomFromString("Bookmark")

File: AVExpT.h
Line: 5755
AVTRIGGERTYPE_DEST 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVTRIGGERTYPE_DEST ASAtomFromString("Dest")

File: AVExpT.h
Line: 5751
AVTRIGGERTYPE_DOC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVTRIGGERTYPE_DOC ASAtomFromString("Doc")

File: AVExpT.h
Line: 5750
AVTRIGGERTYPE_LINK 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVTRIGGERTYPE_LINK ASAtomFromString("Link")

File: AVExpT.h
Line: 5753
AVTRIGGERTYPE_PAGE 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVTRIGGERTYPE_PAGE ASAtomFromString("Page")

File: AVExpT.h
Line: 5752
AVU 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVU avpUnused##c,

File: AVExpT.h
Line: 111
AVX 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVX AVP

File: AVExpT.h
Line: 106
BAR_IBEAM_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define BAR_IBEAM_CURSOR 1011

File: AVExpT.h
Line: 4255
BOX_IBEAM_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define BOX_IBEAM_CURSOR 1001

File: AVExpT.h
Line: 4234
CALL_REPLACED_PROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CALL_REPLACED_PROC (*((sel##PROTO)(HFTGetReplacedEntry((hft), sel, (oldProc)))))

Description

Calls the previous implementation of a replaced method (that is, the code that would have been executed before the method was replaced using REPLACE).

See Also


File: PICommon.h
Line: 94
CAN_EDIT 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CAN_EDIT 1

File: AVCalls.h
Line: 91
CAN_SELECT_GRAPHICS 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CAN_SELECT_GRAPHICS 1

File: AVCalls.h
Line: 110
COPYPAGE_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define COPYPAGE_CURSOR 1113

File: AVExpT.h
Line: 4270
COPYPAGES_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define COPYPAGES_CURSOR 1115

File: AVExpT.h
Line: 4276
CROPTOOL_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CROPTOOL_CURSOR 36

File: AVExpT.h
Line: 4225
CROPTOOL_SCISSORS_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CROPTOOL_SCISSORS_CURSOR 37

File: AVExpT.h
Line: 4228
CROSSHAIR_3D_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CROSSHAIR_3D_CURSOR 1308

File: AVExpT.h
Line: 4366
CROSSHAIR_ADD_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CROSSHAIR_ADD_CURSOR 1306

File: AVExpT.h
Line: 4360
CROSSHAIR_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CROSSHAIR_CURSOR 1000

File: AVExpT.h
Line: 4231
CROSSHAIR_SUBTRACT_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CROSSHAIR_SUBTRACT_CURSOR 1307

File: AVExpT.h
Line: 4363
DECLARE_MULTIAWAREAVROUTINE 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define DECLARE_MULTIAWAREAVROUTINE DECLARE_MULTIAVROUTINE

File: AVCalls.h
Line: 312
DefineMDSysErr 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define DefineMDSysErr mdErrName = unixErrNum,

File: UnixPlatform.h
Line: 154
DefineMDSysErr 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

#define DefineMDSysErr mdName = mdNum,

File: WinPltfm.h
Line: 22
DoNotScroll_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define DoNotScroll_F ((AFPDFieldFlags_t)0x00800000)

File: AF_ExpT.h
Line: 169
DoNotSpellCheck_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define DoNotSpellCheck_F ((AFPDFieldFlags_t)0x00400000)

File: AF_ExpT.h
Line: 168
DRAGLEFTRIGHT_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define DRAGLEFTRIGHT_CURSOR 1214

File: AVExpT.h
Line: 4330
DRAGUPDOWN_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define DRAGUPDOWN_CURSOR 1215

File: AVExpT.h
Line: 4333
EXTERNAL_AVPROCS_USER 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define EXTERNAL_AVPROCS_USER 1

File: AVCalls.h
Line: 105
EXTERNAL_PDPROCS_USER 
Product availability: All
Platform availability: All

Syntax

#define EXTERNAL_PDPROCS_USER 1

File: PDCalls.h
Line: 120
FDF_FILEFILTERREC_UNIQUEID 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define FDF_FILEFILTERREC_UNIQUEID fdf"

File: AVExpT.h
Line: 8214
FIST_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define FIST_CURSOR 1012

File: AVExpT.h
Line: 4258
FIXED_DEFINED 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define FIXED_DEFINED 0

File: UnixPlatform.h
Line: 89
FontSvrError 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define FontSvrError ErrBuildCode(ErrAlways, ErrSysFontSvr, e)

File: AcroErr.h
Line: 307
GetMethod_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define GetMethod_F ((ActionFlags_t)0x0008)

File: AF_ExpT.h
Line: 584
GROW_4WAY_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define GROW_4WAY_CURSOR 1217

File: AVExpT.h
Line: 4339
GROW_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define GROW_CURSOR 1008

File: AVExpT.h
Line: 4252
GROWBOTTOMLEFT_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define GROWBOTTOMLEFT_CURSOR 1205

File: AVExpT.h
Line: 4303
GROWLEFTRIGHT_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define GROWLEFTRIGHT_CURSOR 33

File: AVExpT.h
Line: 4216
GROWTOPBOTTOM_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define GROWTOPBOTTOM_CURSOR 35

File: AVExpT.h
Line: 4222
GROWTOPLEFT_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define GROWTOPLEFT_CURSOR 1204

File: AVExpT.h
Line: 4300
HAND_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define HAND_CURSOR 1002

File: AVExpT.h
Line: 4237
HAND_THREAD_BEGIN_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define HAND_THREAD_BEGIN_CURSOR 1210

File: AVExpT.h
Line: 4318
HAND_THREAD_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define HAND_THREAD_CURSOR 1202

File: AVExpT.h
Line: 4294
HAND_THREAD_END_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define HAND_THREAD_END_CURSOR 1208

File: AVExpT.h
Line: 4312
HAND_THREAD_UP_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define HAND_THREAD_UP_CURSOR 1207

File: AVExpT.h
Line: 4309
HAND_THREAD_UP_END_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define HAND_THREAD_UP_END_CURSOR 1209

File: AVExpT.h
Line: 4315
HIDDEN_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define HIDDEN_CURSOR 1203

File: AVExpT.h
Line: 4297
HIGHLIGHT_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define HIGHLIGHT_CURSOR 34

File: AVExpT.h
Line: 4219
HIGHLIGHTTEXT_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define HIGHLIGHTTEXT_CURSOR 1317

File: AVExpT.h
Line: 4390
IBEAM_3D_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define IBEAM_3D_CURSOR 1310

File: AVExpT.h
Line: 4372
IBEAM_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define IBEAM_CURSOR 1

File: AVExpT.h
Line: 4213
ifdef 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

#define ifdef _WIN32

File: WinPltfm.h
Line: 121
include 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define include h"

File: AVCalls.h
Line: 262
kAcrobatCreatorCode 
Product availability: All
Platform availability: All

Syntax

#define kAcrobatCreatorCode ASFourCharCode('CARO')

Description

Acrobat creator code.


File: ASExpT.h
Line: 1610
kAVBleedMarks 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVBleedMarks 0x00000004

Description

Emit bleed marks.


File: AVExpT.h
Line: 6490
kAVColorBarMarks 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVColorBarMarks 0x00000010

Description

Emit color bar marks.


File: AVExpT.h
Line: 6498
kAVCropMarks 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVCropMarks 0x00000001

Description

Emit crop marks.


File: AVExpT.h
Line: 6482
kAVEasternStyleMarks 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVEasternStyleMarks 0x00000040

Description

Emit Eastern style marks (the default is Western style).


File: AVExpT.h
Line: 6508
kAVEmitBBoxClip 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVEmitBBoxClip 0x00004000

Description

(New for 5.0) Emits a clip to the BoundingBox for EPS.


File: AVExpT.h
Line: 6380
kAVEmitCJKTTAsType2 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVEmitCJKTTAsType2 0x08000000

Description

Emit CJK TrueType fonts as CID Type 2 fonts.


File: AVExpT.h
Line: 6440
kAVEmitFlatness 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVEmitFlatness 0x04000000

Description

Provide control over the emission of the setflat operator.


File: AVExpT.h
Line: 6435
kAVEmitFormFieldsOnly 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVEmitFormFieldsOnly 0x00100000

Description

Emit only form fields; this takes precedence over kAVSuppressAnnots.


File: AVExpT.h
Line: 6405
kAVEmitFormsAsPSForms 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVEmitFormsAsPSForms 0x00400000

Description

When emitting forms, use the execform operator.


File: AVExpT.h
Line: 6415
kAVEmitHalftones 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVEmitHalftones 0x00000001

Description

Emit the halftones specified in the document.


File: AVExpT.h
Line: 6306
kAVEmitPostScriptXObjects 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVEmitPostScriptXObjects 0x00080000

Description

(PostScript only) Include the PostScript XObjects' content in the output.


File: AVExpT.h
Line: 6400
kAVEmitSeparableImagesOnly 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVEmitSeparableImagesOnly 0x00000002

Description

Raise an error on images that cannot be represented in EPS files, following the separation conventions in Technical Note # 5044, Color Separation Conventions for PostScript Language Programs.


File: AVExpT.h
Line: 6314
kAVEmitStampsOnly 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVEmitStampsOnly 0x40000000

Description

Emit document and stamp annotations only.


File: AVExpT.h
Line: 6454
kAVMaxJP2KRes 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVMaxJP2KRes 0x00800000

Description

When emitting JPEG2000 images, use the maximum available resolution.


File: AVExpT.h
Line: 6420
kAVOptimizeForSpeed 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVOptimizeForSpeed 0x00001000

Description

(New for 5.0) (PostScript only) If set, PostScript is optimized for speed, otherwise pages must be independent.


File: AVExpT.h
Line: 6370
kAVPageInfoMarks 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVPageInfoMarks 0x00000020

Description

Emit page information marks.


File: AVExpT.h
Line: 6502
kAVPrintersMarks 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVPrintersMarks 0x02000000

Description

Emit the printer's mark annotations, even if suppress annotations is on. The default is off.


File: AVExpT.h
Line: 6430
kAVSaveVM 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSaveVM 0x00000800

Description

(New for 5.0) Attempt to reduce the amount of VM used on PostScript printers.


File: AVExpT.h
Line: 6365
kAVSetPageSize 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSetPageSize 0x00000400

Description

(New for 5.0) Enable setPageSize(), choose the paper tray by PDF page size.


File: AVExpT.h
Line: 6360
kAVSilent 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSilent 0x00002000

Description

(New for 5.0) When printing via the Windows Dynamic Data Exchange (DDE), alerts are not generated; false is returned.


File: AVExpT.h
Line: 6375
kAVSimulateInkBlack 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSimulateInkBlack 0x10000000

Description

Soft proofing: simulate ink black and paper white when doing soft proofing.


File: AVExpT.h
Line: 6445
kAVSimulatePaperWhite 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSimulatePaperWhite 0x20000000

File: AVExpT.h
Line: 6449
kAVSuppressAnnots 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSuppressAnnots 0x00000200

Description

(New for 5.0) Do not emit text annotations.


File: AVExpT.h
Line: 6355
kAVSuppressBG 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSuppressBG 0x00000010

Description

Do not emit the BlackGeneration in the document.


File: AVExpT.h
Line: 6329
kAVSuppressCenter 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSuppressCenter 0x00000100

Description

(New for 5.0) Do not center the page.


File: AVExpT.h
Line: 6350
kAVSuppressCJKFontSubst 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSuppressCJKFontSubst 0x00000040

Description

If the field is set, calls to AVDocPrintPagesWithParams() generate PostScript that suppresses printer-based font substitution for CJK fonts.


File: AVExpT.h
Line: 6340
kAVSuppressCropClip 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSuppressCropClip 0x00000004

Description

Do not emit the cropbox page clip.


File: AVExpT.h
Line: 6319
kAVSuppressRotate 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSuppressRotate 0x00000080

Description

(New for 5.0) Do not rotate the page.


File: AVExpT.h
Line: 6345
kAVSuppressTransfer 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSuppressTransfer 0x00000008

Description

Do not emit the transfer functions in the document.


File: AVExpT.h
Line: 6324
kAVSuppressUCR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVSuppressUCR 0x00000020

Description

Do not emit the UnderColorRemovals in the document.


File: AVExpT.h
Line: 6334
kAVTaskKeyButtonDefaultUserVisible 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVTaskKeyButtonDefaultUserVisible ButtonDefaultUserVisible"

File: AVExpT.h
Line: 9975
kAVTaskKeyButtonOrder 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVTaskKeyButtonOrder ButtonOrder"

File: AVExpT.h
Line: 9973
kAVTaskKeyDoesWork 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVTaskKeyDoesWork DoesWork"

File: AVExpT.h
Line: 9972
kAVTaskKeyHowToPanelName 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVTaskKeyHowToPanelName HowToPanel"

File: AVExpT.h
Line: 9974
kAVTaskKeyToolBarName 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVTaskKeyToolBarName Toolbar"

File: AVExpT.h
Line: 9971
kAVTrapAnnots 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVTrapAnnots 0x01000000

Description

Emit TrapNet annots, even if suppress annotations is on.


File: AVExpT.h
Line: 6425
kAVTrimMarks 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAVTrimMarks 0x00000002

Description

Emit trim marks.


File: AVExpT.h
Line: 6486
kEPSTypeCode 
Product availability: All
Platform availability: All

Syntax

#define kEPSTypeCode ASFourCharCode('EPSF')

Description

EPS file.


File: ASExpT.h
Line: 1759
kFDFTypeCode 
Product availability: All
Platform availability: All

Syntax

#define kFDFTypeCode ASFourCharCode('FDF ')

Description

Forms data format.


File: ASExpT.h
Line: 1637
kIsUIMirrored 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kIsUIMirrored "IsUIMirrored"

Description

Key name for "enable UI Mirroring options"


File: AVExpT.h
Line: 10174
kKeyPrefsIntlDigitsUI 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kKeyPrefsIntlDigitsUI "DigitsUI"

Description

Key name for "enable Digits UI".


File: AVExpT.h
Line: 10170
kKeyPrefsIntlNationalDigits 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kKeyPrefsIntlNationalDigits "National"

Description

Key name for "Current Keyboard Mode for Digits".


File: AVExpT.h
Line: 10172
kKeyPrefsIntlParagraphDir 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kKeyPrefsIntlParagraphDir "ParaDir"

Description

Key name for paragraph direction.


File: AVExpT.h
Line: 10166
kKeyPrefsIntlRTLUI 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kKeyPrefsIntlRTLUI "RTLUI"

Description

Key name for "enable Right to left Options".


File: AVExpT.h
Line: 10168
kKeyPrefsIntlTargetLanguage 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kKeyPrefsIntlTargetLanguage "IntlTargetLanguage"

Description

Key name for Target Language on Re-Launch.


File: AVExpT.h
Line: 10164
kKeyPrefsTouchUpComplexScript 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kKeyPrefsTouchUpComplexScript "ComplexScript"

Description

Key name for "enable direction switching for PDFEdit(content editing) context menu"


File: AVExpT.h
Line: 10176
kKeyPrefsTouchUpHindiDigit 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kKeyPrefsTouchUpHindiDigit "HindiDigit"

Description

Key name for "enable Hindi digit option for PDFEdit(content editing)"


File: AVExpT.h
Line: 10180
kKeyPrefsTouchUpLigature 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kKeyPrefsTouchUpLigature "Ligature"

Description

Key name for "enable Ligature option for PDFEdit(content editing)"


File: AVExpT.h
Line: 10182
kKeyPrefsTouchUpParagraphDirection 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kKeyPrefsTouchUpParagraphDirection "ParagraphDirection"

Description

Key name for "enable default paragraph direction for PDFEdit(content editing)"


File: AVExpT.h
Line: 10178
kMaxLanguageNameLen 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kMaxLanguageNameLen 27

File: AVExpT.h
Line: 10112
kPDFStateSetAll 
Product availability: All
Platform availability: All

Syntax

#define kPDFStateSetAll ((ASUns32) -1)

File: PEExpT.h
Line: 631
kPDFTypeCode 
Product availability: All
Platform availability: All

Syntax

#define kPDFTypeCode ASFourCharCode('PDF ')

Description

Portable document format (PDF).


File: ASExpT.h
Line: 1632
kPrintDefaultDPI 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPrintDefaultDPI 1200

File: AVExpT.h
Line: 6609
kPrintDefaultGradDPI 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPrintDefaultGradDPI 300

File: AVExpT.h
Line: 6615
kPrinterSpecNameLen 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

#define kPrinterSpecNameLen 256

File: AVExpT.h
Line: 5960
kPrinterSpecNameLen 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

#define kPrinterSpecNameLen 221

File: AVExpT.h
Line: 5975
kPrinterSpecUnicodeNameLen 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

#define kPrinterSpecUnicodeNameLen 221

File: AVExpT.h
Line: 5977
kPrintMaxDPI 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPrintMaxDPI 9600

File: AVExpT.h
Line: 6607
kPrintMaxGradDPI 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPrintMaxGradDPI 9600

File: AVExpT.h
Line: 6613
kPrintMinDPI 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPrintMinDPI 1

File: AVExpT.h
Line: 6605
kPrintMinGradDPI 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPrintMinGradDPI 1

File: AVExpT.h
Line: 6611
kPrintUserNoteLen 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPrintUserNoteLen 256

File: AVExpT.h
Line: 6729
kSectionPrefsIntl 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSectionPrefsIntl "Intl"

Description

International section name.


File: AVExpT.h
Line: 10162
LINK_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define LINK_CURSOR 1100

File: AVExpT.h
Line: 4261
LINK_LAYER 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define LINK_LAYER fixedOne

Description

Links live at this level.


File: AVExpT.h
Line: 2979
LOUPE_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define LOUPE_CURSOR 1302

File: AVExpT.h
Line: 4348
MDAPPERR 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define MDAPPERR h"

File: UnixPlatform.h
Line: 157
MDERRINC 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define MDERRINC h>

File: UnixPlatform.h
Line: 160
MDSYSERR 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define MDSYSERR h"

File: UnixPlatform.h
Line: 153
MDSYSERR 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

#define MDSYSERR h"

File: WinPltfm.h
Line: 21
MEASURE_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define MEASURE_CURSOR 1300

File: AVExpT.h
Line: 4342
MEASURECLOSE_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define MEASURECLOSE_CURSOR 1301

File: AVExpT.h
Line: 4345
MOVE_3D_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define MOVE_3D_CURSOR 1309

File: AVExpT.h
Line: 4369
MOVE_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define MOVE_CURSOR 1206

File: AVExpT.h
Line: 4306
MOVEPAGE_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define MOVEPAGE_CURSOR 1111

File: AVExpT.h
Line: 4264
MOVEPAGES_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define MOVEPAGES_CURSOR 1114

File: AVExpT.h
Line: 4273
MULTI_TASKS 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define MULTI_TASKS 1

File: UnixPlatform.h
Line: 141
name 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define name ##SEL,

File: AVCalls.h
Line: 207
NEXTPAGE_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define NEXTPAGE_CURSOR 1314

File: AVExpT.h
Line: 4384
NO_SHORTCUT 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define NO_SHORTCUT ('\0')

File: AVExpT.h
Line: 1356
NOP_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define NOP_CURSOR 1118

File: AVExpT.h
Line: 4285
NOTE_3D_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define NOTE_3D_CURSOR 1311

File: AVExpT.h
Line: 4375
NOTE_LAYER 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define NOTE_LAYER fixedThree

Description

Closed notes live here, with open notes just above.


File: AVExpT.h
Line: 2981
PAGEVIEW_UPDATE_PAGENUM 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PAGEVIEW_UPDATE_PAGENUM 2

Description

The page number has changed.


File: AVExpT.h
Line: 936
PAGEVIEW_UPDATE_PAGESIZE 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PAGEVIEW_UPDATE_PAGESIZE 4

Description

A new view has been created.


File: AVExpT.h
Line: 941
PAGEVIEW_UPDATE_SCROLL 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PAGEVIEW_UPDATE_SCROLL 1

Description

The view has been scrolled.


File: AVExpT.h
Line: 931
PAGEVIEW_UPDATE_ZOOM 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PAGEVIEW_UPDATE_ZOOM 8

Description

The zoom has been changed.


File: AVExpT.h
Line: 946
PDACTION_DESC_BUF_SIZE 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDACTION_DESC_BUF_SIZE 256

File: AVExpT.h
Line: 5546
PDF_FILEFILTERREC_UNIQUEID 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDF_FILEFILTERREC_UNIQUEID pdf"

File: AVExpT.h
Line: 8213
PDFEditError 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditError ErrBuildCode(ErrAlways, ErrSysPDFEdit, e)

File: AcroErr.h
Line: 317
PDFEditNUMSELECTORS 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditNUMSELECTORS (PDFEditNUMSELECTORSplusOne - 1)

File: PEWCalls.h
Line: 156
PDFEditPrivateHFTName 
Product availability: All
Platform availability: All

Syntax

#define PDFEditPrivateHFTName "PDFEditPrivate"

File: PEVers.h
Line: 28
PDFEditReadNUMSELECTORS 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFEditReadNUMSELECTORS (PDFEditReadNUMSELECTORSplusOne - 1)

File: PERCalls.h
Line: 140
PDFXError 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFXError ErrBuildCode(ErrAlways, ErrSysPDFX, e)

File: AcroErr.h
Line: 316
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: AF_Sel.h
Line: 28
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: AF_Sel.h
Line: 46
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: AFTTS_Sel.h
Line: 33
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: AFTTS_Sel.h
Line: 48
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: cathft.h
Line: 34
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( name##_PROTO)params;

File: cathft.h
Line: 89
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef name##_PROTO *name##_SELPROTO;

File: cathft.h
Line: 93
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: ConsHFT.h
Line: 56
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: ConsHFT.h
Line: 68
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: DigSigHFT.h
Line: 1710
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: DigSigHFT.h
Line: 2049
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: PubSecHFT.h
Line: 1969
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: PubSecHFT.h
Line: 2134
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: Speller_Sel.h
Line: 29
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: Speller_Sel.h
Line: 362
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: SrchHFT.h
Line: 34
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: SrchHFT.h
Line: 49
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: WLHFT.h
Line: 376
PIPROC 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: WLHFT.h
Line: 400
PREPEND_MENU 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PREPEND_MENU (-2)

File: AVExpT.h
Line: 1353
PREPEND_MENUITEM 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PREPEND_MENUITEM (-2)

File: AVExpT.h
Line: 1349
PREVPAGE_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PREVPAGE_CURSOR 1315

File: AVExpT.h
Line: 4386
REPLACEPAGE_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define REPLACEPAGE_CURSOR 1116

File: AVExpT.h
Line: 4279
REPLACEPAGES_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define REPLACEPAGES_CURSOR 1117

File: AVExpT.h
Line: 4282
SELECTOBJECT_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SELECTOBJECT_CURSOR 1303

File: AVExpT.h
Line: 4351
STICKYNOTE_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define STICKYNOTE_CURSOR 1318

File: AVExpT.h
Line: 4392
TABLE_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define TABLE_CURSOR 1304

File: AVExpT.h
Line: 4354
TEXTMARQUEE_3D_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define TEXTMARQUEE_3D_CURSOR 1313

File: AVExpT.h
Line: 4381
THREAD_CONNECT_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define THREAD_CONNECT_CURSOR 1211

File: AVExpT.h
Line: 4321
THREAD_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define THREAD_CURSOR 1119

File: AVExpT.h
Line: 4288
THREAD_END_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define THREAD_END_CURSOR 1212

File: AVExpT.h
Line: 4324
TOOLBUTTON_EXTERNAL 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define TOOLBUTTON_EXTERNAL 2

Description

Indicates that the toolbar button is visible only in the toolbar of an external application (such as a web browser).


File: AVExpT.h
Line: 4825
TOOLBUTTON_INTERNAL 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define TOOLBUTTON_INTERNAL 1

Description

Indicates that the toolbar button is visible only in the viewer's toolbar.


File: AVExpT.h
Line: 4818
TOUCHUPOBJ_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define TOUCHUPOBJ_CURSOR 1305

File: AVExpT.h
Line: 4357
UNSIGNEDCHARS 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

#define UNSIGNEDCHARS 0

File: MacPlatform.h
Line: 27
UNSIGNEDCHARS 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UNSIGNEDCHARS 0

File: UnixPlatform.h
Line: 88
UNSIGNEDCHARS 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

#define UNSIGNEDCHARS 0

File: WinPltfm.h
Line: 29
USE_NAMED_IDLE_PROCS 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define USE_NAMED_IDLE_PROCS 0

File: AVExpT.h
Line: 35
USE_NAMED_LATE_INIT_PROCS 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define USE_NAMED_LATE_INIT_PROCS 0

File: AVExpT.h
Line: 45
USE_NULLDOC 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define USE_NULLDOC 0

File: UnixPlatform.h
Line: 144
VERT_IBEAM_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define VERT_IBEAM_CURSOR 1213

File: AVExpT.h
Line: 4327
VERTBEAMNOBAR_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define VERTBEAMNOBAR_CURSOR 1216

File: AVExpT.h
Line: 4336
WAIT_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define WAIT_CURSOR 1112

File: AVExpT.h
Line: 4267
WORD_ALIGN 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define WORD_ALIGN (sizeof(void *))

File: UnixPlatform.h
Line: 92
WORD_ALIGN 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

#define WORD_ALIGN 2

File: WinPltfm.h
Line: 46
WORDFINDER_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define WORDFINDER_CURSOR 1201

File: AVExpT.h
Line: 4291
X11X 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define X11X h>

File: AVExpT.h
Line: 69
ZOOM_DRAG_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ZOOM_DRAG_CURSOR 1006

File: AVExpT.h
Line: 4249
ZOOM_IN_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ZOOM_IN_CURSOR 1003

File: AVExpT.h
Line: 4240
ZOOM_MAX_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ZOOM_MAX_CURSOR 1005

File: AVExpT.h
Line: 4246
ZOOM_OUT_CURSOR 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ZOOM_OUT_CURSOR 1004

File: AVExpT.h
Line: 4243

Typedefs Detail
ADMWindowRef 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_ADMWindowRef* ADMWindowRef;

File: AVExpT.h
Line: 10531
ASPlatformPrinterSpec 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

typedef _t_ASPlatformPrinterSpec ASPlatformPrinterSpec;

File: AVExpT.h
Line: 5970
ASPlatformPrinterSpec 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

typedef _t_ASPlatformPrinterSpec ASPlatformPrinterSpec;

File: AVExpT.h
Line: 5953
ASPlatformPrinterSpec 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

typedef _t_ASPlatformPrinterSpec ASPlatformPrinterSpec;

File: AVExpT.h
Line: 6047
ASPlatformPrinterSpecRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

typedef _t_ASPlatformPrinterSpec ASPlatformPrinterSpecRec;

File: AVExpT.h
Line: 5970
ASPlatformPrinterSpecRec 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

typedef _t_ASPlatformPrinterSpec ASPlatformPrinterSpecRec;

File: AVExpT.h
Line: 5953
ASPlatformPrinterSpecRec 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

typedef _t_ASPlatformPrinterSpec ASPlatformPrinterSpecRec;

File: AVExpT.h
Line: 6047
AVAdjustCursorParams 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVAdjustCursorParams AVAdjustCursorParams;

File: AVExpT.h
Line: 3794
AVAdjustCursorParamsRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVAdjustCursorParams AVAdjustCursorParamsRec;

File: AVExpT.h
Line: 3794
AVArraySize 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns16 AVArraySize;

An array size value for AV methods.

See Also


File: AVExpT.h
Line: 206
AVAuxDataHandler 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVAuxDataHandler AVAuxDataHandler;

File: AVExpT.h
Line: 5897
AVAuxDataHandlerRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVAuxDataHandler AVAuxDataHandlerRec;

File: AVExpT.h
Line: 5897
AVBatchContext 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_AVBatchContext* AVBatchContext;

Placeholder only. Not currently implemented.


File: AVExpT.h
Line: 9682
AVBufferSize 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 AVBufferSize;

The number of bytes.


File: AVExpT.h
Line: 250
AVClickParams 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVClickParams AVClickParams;

File: AVExpT.h
Line: 3776
AVClickParamsRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVClickParams AVClickParamsRec;

File: AVExpT.h
Line: 3776
AVCursor 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_AVCursor* AVCursor;

A data structure representing the cursor.

See Also


File: AVExpT.h
Line: 4206
AVCursorID 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt32 AVCursorID;

Uses 0+ for valid values.


File: AVExpT.h
Line: 286
AVDestInfo 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVDestInfo AVDestInfo;

File: AVExpT.h
Line: 2399
AVDestInfoRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVDestInfo AVDestInfoRec;

File: AVExpT.h
Line: 2399
AVDevCoord 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVSDKDependentInteger AVDevCoord;

An AVDevCoord contains an x or y coordinate in the page view's device space.


File: AVExpT.h
Line: 374
AVDevRect 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVRect AVDevRect;

A data structure representing a rectangle (a quadrilateral having only horizontal and vertical sides) in a page view's device space.

See Also


File: AVExpT.h
Line: 1115
AVDevRectP 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVRectP AVDevRectP;

File: AVExpT.h
Line: 1120
AVDevSize 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVSDKDependentInteger AVDevSize;

A size in the page view's device space.

See Also


File: AVExpT.h
Line: 368
AVDragRectParams 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVDragRectParams AVDragRectParams;

File: AVExpT.h
Line: 9427
AVDragRectParamsRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVDragRectParams AVDragRectParamsRec;

File: AVExpT.h
Line: 9427
AVDragTypeEx 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt16 AVDragTypeEx;

AVDragType or -1 for err.


File: AVExpT.h
Line: 253
AVExtensionInfo 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _AVExtensionInfoRec AVExtensionInfo;

File: AVExpT.h
Line: 9652
AVExtensionInfoEx 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _AVExtensionInfoRecEx AVExtensionInfoEx;

File: AVExpT.h
Line: 10559
AVExtensionInfoRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _AVExtensionInfoRec AVExtensionInfoRec;

File: AVExpT.h
Line: 9652
AVExtensionInfoRecEx 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _AVExtensionInfoRecEx AVExtensionInfoRecEx;

File: AVExpT.h
Line: 10559
AVFileDescRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVFileDescRec AVFileDescRec;

File: AVExpT.h
Line: 7630
AVFileFilterRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVFileFilterRec AVFileFilterRec;

File: AVExpT.h
Line: 7678
AVFilterIndex 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt16 AVFilterIndex;

A filter index value for AV methods. It uses 0+ for valid values, -1 for all others.

See Also


File: AVExpT.h
Line: 275
AVFlagBits16 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt16 AVFlagBits16;

A flag-bits value for use in callback procedures.

See Also


File: AVExpT.h
Line: 217
AVFlagBits32 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 AVFlagBits32;

A flag-bits value for use in callback procedures.

See Also


File: AVExpT.h
Line: 228
AVIcon 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef void* AVIcon;

File: AVExpT.h
Line: 408
AVIconBundle 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVIconBundleRec AVIconBundle;

File: AVExpT.h
Line: 467
AVIconBundle6 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVIconBundleRec6 AVIconBundle6;

File: AVExpT.h
Line: 548
AVIconBundleIconRef 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

typedef void* AVIconBundleIconRef;

File: AVExpT.h
Line: 420
AVIconBundleIconRef 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

typedef void* AVIconBundleIconRef;

File: AVExpT.h
Line: 425
AVIconBundleIconRef 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

typedef HICON AVIconBundleIconRef;

File: AVExpT.h
Line: 415
AVIconBundleRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVIconBundleRec AVIconBundleRec;

File: AVExpT.h
Line: 467
AVIconBundleRec6 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVIconBundleRec6 AVIconBundleRec6;

An icon bundle allows you to gather up multiple icons and present them to Acrobat as a single AVIcon. For example, when creating a toolbar button you can pass in an icon bundle specifying both gray and color icons; the gray icon will be used to draw the button in its normal state, the color icon will be used to draw the button when the pointer is over it. The format for icon bundles is platform-specific (primarily since the format for AVIcons is platform-specific). On Windows the icons are specified using HICONs, not HBITMAPs. On Mac OS, they are IconSuiteRef resources. The tags at the front are there so the implementation can determine with certainty that the information passed in is an icon bundle and not an Acrobat 4-compatible AVIcon.


File: AVExpT.h
Line: 548
AVIconData 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVIconData AVIconData;

File: AVExpT.h
Line: 686
AVIconDataRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVIconData AVIconDataRec;

File: AVExpT.h
Line: 686
AVIconHandler 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVIconHandlerRec AVIconHandler;

File: AVExpT.h
Line: 641
AVIconHandlerRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVIconHandlerRec AVIconHandlerRec;

File: AVExpT.h
Line: 641
AVIconID 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef const char* AVIconID;

An icon on a menu item or toolbar button.

On Windows this is an HBITMAP or an AVIconBundle.

See Also

AVMenuItemNew
AVToolButtonGetIcon
AVToolButtonNew
AVToolButtonSetIcon

File: AVExpT.h
Line: 407
AVIconType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt32 AVIconType;

Not used.


File: AVExpT.h
Line: 268
AVKeyCode 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns16 AVKeyCode;

A key code value for use in key-down callback procedures.

See Also


File: AVExpT.h
Line: 241
AVMouseEventCode 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt16 AVMouseEventCode;

Not used.


File: AVExpT.h
Line: 231
AVNotificationData 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVNotificationDataRec AVNotificationData;

File: AVExpT.h
Line: 10501
AVOpenSaveDialogOutParams 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVOpenSaveDialogOutParamsRec AVOpenSaveDialogOutParams;

File: AVExpT.h
Line: 7832
AVOpenSaveDialogParams 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVOpenSaveDialogParamsRec AVOpenSaveDialogParams;

File: AVExpT.h
Line: 7811
AVPageIndex 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt32 AVPageIndex;

A page index value for use in an AVDoc view definition. It uses 0+ for valid values, -1 for invalid or non-applicable values.

See Also


File: AVExpT.h
Line: 283
AVPixelOffset 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt16 AVPixelOffset;

A pixel offset value for use in an AVDoc view definition.

See Also


File: AVExpT.h
Line: 195
AVPlatformWindowRef 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_AVPlatformWindowRef* AVPlatformWindowRef;

File: AVExpT.h
Line: 10528
AVPoint 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVPoint AVPoint;

File: AVExpT.h
Line: 1152
AVPriority 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt16 AVPriority;

A signed int for historical reasons.


File: AVExpT.h
Line: 244
AVScreenCoord 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVSDKDependentInteger AVScreenCoord;

An x or y coordinate in the screen space. (0,0) is at the top left of the main monitor.


File: AVExpT.h
Line: 388
AVScreenRect 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVRect AVScreenRect;

A data structure representing a rectangle (a quadrilateral having only horizontal and vertical sides) in a screen's coordinate space.

See Also


File: AVExpT.h
Line: 1142
AVSDKDependentInteger 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt32 AVSDKDependentInteger;

File: AVExpT.h
Line: 360
AVSimpleSelObj 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_AVSimpleSelObj* AVSimpleSelObj;

File: AVExpT.h
Line: 9735
AVSimpleSelProcs 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVSimpleSelProcs AVSimpleSelProcs;

File: AVExpT.h
Line: 9757
AVSimpleSelProcsRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVSimpleSelProcs AVSimpleSelProcsRec;

File: AVExpT.h
Line: 9757
AVStatusItem 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_AVStatusItem* AVStatusItem;

File: AVExpT.h
Line: 9765
AVStatusMonitorProcs 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVStatusMonitorProcs AVStatusMonitorProcs;

File: AVExpT.h
Line: 7604
AVStatusMonitorProcsRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVStatusMonitorProcs AVStatusMonitorProcsRec;

File: AVExpT.h
Line: 7604
AVStructNode 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_AVStructNode* AVStructNode;

An opaque object representing a node in a document structure tree.

See Also


File: AVExpT.h
Line: 8549
AVTArraySize 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt32 AVTArraySize;

The number of items (not the number of bytes) in an array, for use in page view methods.

See Also


File: AVExpT.h
Line: 311
AVTBufferSize 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt32 AVTBufferSize;

The number of bytes in a buffer, for use in page view methods.

See Also


File: AVExpT.h
Line: 318
AVTCount 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt16 AVTCount;

A click-number value for use in page view callback procedures.

See Also


File: AVExpT.h
Line: 348
AVTFlagBits 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt32 AVTFlagBits;

A flag-bits value for use in page view methods.

See Also


File: AVExpT.h
Line: 334
AVTFlagBits16 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns16 AVTFlagBits16;

A flag-bits value for use in tool button methods.

See Also

AVToolButtonSetExternal

File: AVExpT.h
Line: 340
AVTransHandler 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVTransHandler AVTransHandler;

A data structure containing callbacks that implement a transition handler. The callbacks implement the transition handler functions.

See Also


File: AVExpT.h
Line: 7096
AVTransHandlerRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVTransHandler AVTransHandlerRec;

File: AVExpT.h
Line: 7512
AVTransitionPort 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVTransitionPort AVTransitionPort;

File: AVExpT.h
Line: 7133
AVTransitionPortRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_AVTransitionPort AVTransitionPortRec;

File: AVExpT.h
Line: 7133
AVTSmallArraySize 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt16 AVTSmallArraySize;

An array size value for use in page view methods.

See Also


File: AVExpT.h
Line: 325
AVTVersionNumPart 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt16 AVTVersionNumPart;

A version number part.

See Also


File: AVExpT.h
Line: 355
AVVersionNumPart 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns16 AVVersionNumPart;

A version-number part.


File: AVExpT.h
Line: 247
AVVersionParams 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVVersionParamsRec AVVersionParams;

File: AVExpT.h
Line: 10540
AVZoomType 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

typedef _t_AVZoomType AVZoomType;

File: AVExpT.h
Line: 828
DrawContextType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DrawContextType DrawContextType;

File: AVExpT.h
Line: 10525
ExternalDocServerCreationData 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_ExternalDocServerCreationData ExternalDocServerCreationData;

File: AVExpT.h
Line: 2922
ExternalDocServerCreationDataRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_ExternalDocServerCreationData ExternalDocServerCreationDataRec;

File: AVExpT.h
Line: 2922
ExternalDocWindowData 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

typedef _t_ExternalDocWindowData ExternalDocWindowData;

File: AVExpT.h
Line: 2839
ExternalDocWindowData 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

typedef Window ExternalDocWindowData;

File: AVExpT.h
Line: 2843
ExternalDocWindowData 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

typedef HWND ExternalDocWindowData;

File: AVExpT.h
Line: 2759
ExternalDocWindowDataRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

typedef _t_ExternalDocWindowData ExternalDocWindowDataRec;

File: AVExpT.h
Line: 2839
ExternalDocWindowRefData 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

typedef _t_ExternalDocWindowRefData ExternalDocWindowRefData;

File: AVExpT.h
Line: 2816
ExternalDocWindowRefDataRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

typedef _t_ExternalDocWindowRefData ExternalDocWindowRefDataRec;

File: AVExpT.h
Line: 2816
PDFind 
Product availability: All
Platform availability: All

Syntax

typedef struct _t_PDFind* PDFind;

File: PDExpT.h
Line: 2107
PDFlatten 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDFlattenRec PDFlatten;

File: PDFLExpT.h
Line: 366
PDFolder 
Product availability: All
Platform availability: All

Syntax

typedef OPAQUE_64_BITS PDFolder;

An opaque object representing a collection folder dictionary. Folders are used to provide grouping for files in a portable collection.


File: PDExpT.h
Line: 6943
PDFOptFlattenTransparencyOptions 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDFOptFlattenTransparencyOptions PDFOptFlattenTransparencyOptions;

File: AVExpT.h
Line: 10303
PDFOptFlattenTransparencyOptionsRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDFOptFlattenTransparencyOptions PDFOptFlattenTransparencyOptionsRec;

File: AVExpT.h
Line: 10303
PDFOptImageOptions 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDFOptImageOptions PDFOptImageOptions;

File: AVExpT.h
Line: 10267
PDFOptImageOptionsRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDFOptImageOptions PDFOptImageOptionsRec;

File: AVExpT.h
Line: 10267
PDFOptParams 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDFOptParams PDFOptParams;

File: AVExpT.h
Line: 10485
PDFOptParamsRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDFOptParams PDFOptParamsRec;

File: AVExpT.h
Line: 10485
WinPort 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

typedef _t_WinPort WinPort;

File: AVExpT.h
Line: 906
WinPortRec 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

typedef _t_WinPort WinPortRec;

File: AVExpT.h
Line: 906

Enumeration Detail
_t_AVZoomType
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

See Also


File: AVExpT.h
Line: 806

Elements
AVZoomNoVary  

No variable zoom (the zoom is a fixed value such as 1.0 for 100%).

 
AVZoomFitPage  

Fits the page to the window.

 
AVZoomFitWidth  

Fits the page width to the window.

 
AVZoomFitHeight  

Fits the page height to the window.

 
AVZoomFitVisibleWidth  

Fits the width of the portion of the page upon which marks are made to the window.

 
AVZoomPreferred  

Uses the page's preferred zoom.

 
AVZoomReflowWidth  

(New in Acrobat 5.0) Reflow page to window width.

_t_DrawContextType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum _t_DrawContextType {
 kMacCGContextType
}

File: AVExpT.h
Line: 10509

Elements
kMacCGContextType  

Mac only: CGContext

AVAccessColorPolicy 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVAccessColorPolicy {
 kAVAccessUseDocumentColors,
 
 kAVAccessUseSystemColors,
 
 kAVAccessUsePreferenceColors,
 
 kAVAccessForceSystemColors,
 
 kAVAccessUseHiContGreenBlack,
 
 kAVAccessUseHiContYellowBlack,
 
 kAVAccessUseHiContWhiteBlack,
 
 kAVAccessUseHiContBlackWhite
}

See Also


File: AVExpT.h
Line: 9437

Elements
kAVAccessUseDocumentColors  

Use the colors specified within the document.

 
kAVAccessUseSystemColors  

Use the colors specified by the operating system preferences.

 
kAVAccessUsePreferenceColors  

Use the colors specified by the Acrobat preferences.

 
kAVAccessUseHiContGreenBlack  

Use accessible high-contrast colors.

 
AVAccessReadOrder 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax


File: AVExpT.h
Line: 9466

Elements
kAVAccessInferredReadOrder  

Run MakeAccessible to generate a temporary structure.

 
kAVAccessTBLRReadOrder  

Use Wordy's Top-to-Bottom, Left-to-Right order.

 
kAVAccessWordyReadOrder  

Use Wordy's Print Stream order.

 
kAVAccessTaggedReadOrder  

Use the structure tree.

 
kAVAccessUndefinedReadOrder  

The reading order is undetermined.

AVBookletBinding 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax


File: AVExpT.h
Line: 6272

Elements
kAVBookletBinding_Left  

Typical left-side binding for text with left-to-right reading direction. The paper is divided vertically in landscape mode.

 
kAVBookletBinding_Right  

Right-side binding for text with vertical or right-to-left reading direction. The paper is divided vertically in landscape mode.

 
kAVBookletBinding_LeftTall  

Left-side binding for text with left-to-right reading direction. The paper is divided vertically in portrait mode.

 
kAVBookletBinding_RightTall  

Right-side binding for text with vertical or right-to-left reading direction. The paper is divided vertically in portrait mode.

AVBookletDuplexMode 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVBookletDuplexMode {
 kAVBooklet_BothSides,
 
 kAVBooklet_FrontSideOnly,
 
 kAVBooklet_BackSideOnly
}

File: AVExpT.h
Line: 6293

Elements
kAVBooklet_BothSides  

Print pages on both sides.

 
kAVBooklet_FrontSideOnly  

Print pages on front sides only.

 
kAVBooklet_BackSideOnly  

Print pages on back sides only.

AVBookmarkFilter 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVBookmarkFilter {
 kAVBookmarkFilterSelected = 1,
 
 kAVBookmarkFilterFocus = 2
}

File: AVExpT.h
Line: 10137

AVColorForcing 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVColorForcing {
 kAVForceColorNone = 0,
 
 kAVForceColorToGrayscale,
 
 kAVForceColorToMonochrome
}

See Also


File: AVExpT.h
Line: 6206

Elements
kAVForceColorNone  

Do not force color conversions.

 
kAVForceColorToGrayscale  

Force color to grayscale.

 
kAVForceColorToMonochrome  

Force color to monochrome.

AVDragType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

See Also


File: AVExpT.h
Line: 9289

Elements
kAVDragRect  

Move the whole rectangle.

 
kAVDragTopLeft  

Top left corner.

 
kAVDragTopRight  

Top right corner.

 
kAVDragBottomRight  

Bottom right corner.

 
kAVDragBottomLeft  

Bottom left corner.

 
kAVDragTopMiddle  

Top middle.

 
kAVDragRightMiddle  

Right middle.

 
kAVDragBottomMiddle  

Bottom middle.

 
kAVDragLeftMiddle  

Left middle.

 
kAVDragSnapToTopLeft  

Snap to top left.

 
kAVDragSnapToTop  

Snap to top.

 
kAVDragSnapToTopRight  

Snap to top right.

 
kAVDragSnapToRight  

Snap to right.

 
kAVDragSnapToBottomRight  

Snap to bottom right.

 
kAVDragSnapToBottom  

Snap to bottom.

 
kAVDragSnapToBottomLeft  

Snap to bottom left.

 
kAVDragSnapToLeft  

Snap to left.

AVEmitAllFontsOptions 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVEmitAllFontsOptions {
 kAVEmitFontEmbeddedFonts = 1,
 
 kAVEmitFontAllFonts
}

File: AVExpT.h
Line: 6151

Elements
kAVEmitFontEmbeddedFonts  

Emit all embedded fonts.

 
kAVEmitFontAllFonts  

Emit all fonts.

AVEmitFileOptions 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVEmitFileOptions {
 kAVEmitFilePS,
 
 kAVEmitFileEPSNoPrev,
 
 kAVEmitFileEPSPreview
}

File: AVExpT.h
Line: 6079

Elements
kAVEmitFilePS  

A PS file.

 
kAVEmitFileEPSNoPrev  

An EPS file with no preview.

 
kAVEmitFileEPSPreview  

With Acrobat 10, PICT previews for EPS files are no longer supported. TIFF previews are still supported, use kAVEmitFileEPSPreview to request a preview for Mac and Windows An EPS file with standard preview. Deprecated for Acrobat 10

AVEmitType1FontsOptions 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVEmitType1FontsOptions {
 kAVEmitFontNoFonts,
 
 kAVEmitFontAllEmbType1,
 
 kAVEmitFontAllType1
}

File: AVExpT.h
Line: 6113

Elements
kAVEmitFontNoFonts  

Embed no fonts.

 
kAVEmitFontAllEmbType1  

Embed all Type 1 embedded fonts.

 
kAVEmitFontAllType1  

Constants that specify tile marking styles for AVDocPrintTileData(), used in AVDocPrintParams.

AVFavToolFlags 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVFavToolFlags {
 kAVFavToolsFlagOkInternal = 1 << 0,
 
 kAVFavToolsFlagOkExternal = 1 << 1
}

File: AVExpTObsolete1.h
Line: 17

AVFullScreenMonitor 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax


File: AVExpT.h
Line: 9589

Elements
kAVFullScreenLargestIntersection  

Use the monitor with the largest intersection.

 
kAVFullScreenMostColors  

Use the monitor with the most colors.

 
kAVFullScreenWidest  

Use the monitor with the widest screen.

 
kAVFullScreenTallest  

Use the monitor with the tallest screen.

 
kAVFullScreenLargest  

Use the monitor with the largest screen.

 
kAVFullScreenMain  

Use the monitor with the main screen.

 
kAVFullScreen_END_ENUM  

Enum terminator.

AVHowToTopicSortKey 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVHowToTopicSortKey {
 kAcrobatBasicsSortKey = 100,
 
 kAVCreateSortKey = 200,
 
 kAVCombineSortKey = 250,
 
 kAVExportSortKey = 275,
 
 kAVSecureSortKey = 300,
 
 kAVSignSortKey = 400,
 
 kAVFormSortKey = 500,
 
 kAVReviewAndCommentSortKey = 600,
 
 kAV3DSortKey = 650,
 
 kAVEngineeringToolsSortKey = 700,
 
 kAVPrintProductionSortKey = 800,
 
 kAVHowToSortKey = ASMAXUns32
}

File: AVExpT.h
Line: 9978

AVIconColorFormat 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVIconColorFormat {
 kAVIconColor,
 
 kAVIconGrayscale,
 
 kAVIconHighContrast
}

File: AVExpT.h
Line: 474

AVIconDataFormat 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVIconDataFormat {
 kAVIconMacIconRef16,
 
 kAVIconMacIconRef32,
 
 kAVIconMacIconRef128,
 
 kAVIconPNG,
 
 kAVIconLayered
}

See Also


File: AVExpT.h
Line: 491

Elements
kAVIconMacIconRef16  

16x16 icon reference

 
kAVIconMacIconRef32  

32x32 icon reference

 
kAVIconMacIconRef128  

128x128 icon reference

 
AVIdentity 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVIdentity {
 kAVILoginName,
 
 kAVIName,
 
 kAVICorporation,
 
 kAVIEMail,
 
 kAVIDepartment,
 
 kAVITitle,
 
 kAVIFirstName,
 
 kAVILastName,
 
 kAVICorporationAbbr,
 
 kSignedInOnce,
 
 kAVILast
}

See Also


File: AVExpT.h
Line: 8790

AVInfoPanelUpdateType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVInfoPanelUpdateType {
 kAVInfoPanelLock,
 
 kAVInfoPanelUnlock,
 
 kAVInfoPanelRect
}

See Also


File: AVExpT.h
Line: 9659

Elements
kAVInfoPanelLock  

The plug-in is assuming control over the output of the info panel.

 
kAVInfoPanelUnlock  

The plug-in is transferring control back to Acrobat to update the info panel.

 
kAVInfoPanelRect  

The plug-in is passing the values that should be displayed in the info panel to Acrobat.

AVMarksStyleType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVMarksStyleType {
 kAVDefaultMarkType = 0,
 
 kAVInDesignJ1MarkType,
 
 kAVInDesignJ2MarkType,
 
 kAVIllustratorMarkType,
 
 kAVIllustratorJ,
 
 kAVQuarkXPress,
 
 kLastMarkType
}

File: AVExpT.h
Line: 6459

Elements
kAVDefaultMarkType  

No flags implies InDesign style printer marks.

 
AVMouseEvent 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVMouseEvent {
 kAVLeftButtonDown = 1,
 
 kAVLeftButtonUp,
 
 kAVLeftButtonClick,
 
 kAVLeftButtonDblClick,
 
 kAVRightButtonDown,
 
 kAVRightButtonUp,
 
 kAVRightButtonClick,
 
 kAVRightButtonDblClick,
 
 kAVMouseMove,
 
 kAVMouseEnter,
 
 kAVMouseLeave
}

File: AVExpT.h
Line: 950

AVnUpPageOrder 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax


File: AVExpT.h
Line: 6259

Elements
kAVnUpPageOrderHorizontal  

Pages are placed from left to right, and then from top to bottom.

 
kAVnUpPageOrderHorizontalRev  

Pages are placed from right to left, and then from top to bottom.

 
kAVnUpPageOrderVertical  

Pages are placed from top to bottom, and then from left to right.

 
kAVnUpPageOrderVerticalRev  

Pages are placed from top to bottom, and then from right to left.

AVOpenSaveDialogFlags 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVOpenSaveDialogFlags {
 kAVOpenSaveAllowAllFlag = 1 << 0,
 
 kAVOpenSaveAllowMultiple = 1 << 1,
 
 kAVOpenSaveAllowForeignFileSystems = 1 << 2,
 
 kAVOpenSaveAllowSettingsButton = 1 << 3,
 
 kAVOpenSaveMergeTogetherPassedFilters = 1 << 4,
 
 kAVBrowseForFolderNoNewFolderButton = 1 << 5,
 
 kAVDoNotAllowCloudConnections = 1 << 6,
 
 kAVAllowADCAccess = 1 << 7
}

File: AVExpT.h
Line: 7683

Elements
kAVOpenSaveAllowAllFlag  

Use the "All Files (*.*)" file filter for the dialog box. It is meaningful only for an open dialog box.

 
kAVOpenSaveAllowMultiple  

Allow multiple files to be opened through this dialog box. It is meaningful only for an open dialog box.

 
kAVOpenSaveAllowForeignFileSystems  

Allow file systems other than the default to be used to open the file(s).

 
kAVOpenSaveAllowSettingsButton  

Adds a Settings button to the dialog box. It is meaningful for open and save dialog boxes.

 
kAVOpenSaveMergeTogetherPassedFilters  

This is meaningful only for Open dialog boxes with more than one passed filter.

 
kAVBrowseForFolderNoNewFolderButton  

Do not add the Make New Folder push button. It is only meaningful for the Browse For Folder dialog box.

 
kAVDoNotAllowCloudConnections  

Do Not Allow opening files from Cloud. DEPRECATED: **always Set as TRUE** We have removed CloudConnectors from Open/Save Dialog. To reduce change, we set this value in AVAppMac.cpp and wvapp.cpp

 
kAVAllowADCAccess  

Allow Acrobat.com Entry points DEPRECATED ** - This flag is deprecated and nothing happens on using it. We will remove it soon.

AVPageSize 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

See Also


File: AVExpT.h
Line: 6164

Elements
kAVPageSizeUninitialized  

Uninitialized.

 
kAVPageSizeNone  

Perform no adjusting for size; pages are cropped by the printer.

 
kAVPageSizeFitToPaper  

Fit to paper.

 
kAVPageSizeShrinkLargePages  

Shrink large pages.

 
kAVPageSizeTileLargePages  

Tile large pages.

 
kAVPageSizeTileAllPages  

Tile all pages.

 
kAVPageSizeNup  

N-up printing mode.

 
kAVPageSizeBooklet  

Booklet printing mode.

 
kAVPageSizeCustom  

Custom Scale.

AVPrefsType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, UNIX

Syntax

enum AVPrefsType {
 AVP = (a, b) #define AVX #define AVS #define AVPVOIDP(a) #define AVPSTR(a) #define AVU(a, b, c) AV_PREFERENCES avpNumPrefs
}

File: AVExpT.h
Line: 104

AVPrefsType 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

enum AVPrefsType {
 AVP = (a, b) #define AVX #define AVS #define AVPVOIDP(a) #define AVPSTR(a) #define AVU(a, b, c) AV_PREFERENCES avpNumPrefs
}

See Also


File: AVExpT.h
Line: 104

AVPrintDuplexType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVPrintDuplexType {
 kAVPrintDuplexDontCare = 0,
 
 kAVPrintDuplexSimplex = 1,
 
 kAVPrintDuplexFlipLongEdge = 2,
 
 kAVPrintDuplexFlipShortEdge = 3
}

File: AVExpT.h
Line: 6716

AVPrintTrapType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVPrintTrapType {
 kAVPrintTrapNone = 0x01,
 
 kAVPrintTrapOnHost = 0x02,
 
 kAVPrintTrapInRIP = 0x04
}

File: AVExpT.h
Line: 6989

AVRasterizeFlags 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVRasterizeFlags {
 kAVRasterizeNoFlags = 0,
 
 kAVRasterizeAllTextToOutlines = 1 << 0,
 
 kAVRasterizeAllStrokesToOutlines = 1 << 1,
 
 kAVRasterizeAllowComplexClipRegions = 1 << 2,
 
 kAVRasterizePreserveOverprint = 1 << 3
}

See Also


File: AVExpT.h
Line: 6580

Elements
kAVRasterizeNoFlags  

No flags

 
AVResourcePolicy 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax


File: AVExpT.h
Line: 6237

Elements
kAVResPolicySendAtStart  

Send fonts and resources to the first page on which they are used. Pages must be printed in the order in which they are created. Fonts are downloaded in the global VM. Fonts and resources are removed when they are no longer needed.

 
kAVResPolicySendByRange  

Send fonts and resources to each page on which they are used. Fonts are downloaded in the local VM.

 
kAVResPolicySendPerPage  

Send fonts and resources to each page on which they are used. Fonts are downloaded in the local VM.

AVSpecialCategory 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVSpecialCategory {
 kAVSCUser,
 
 kAVSCApp,
 
 kAVSCLocal,
 
 kAVSCLast
}

See Also


File: AVExpT.h
Line: 7949

Elements
kAVSCUser  

User folders.

 
kAVSCApp  

Application folders.

 
kAVSCLocal  

Local (to this machine) domain

 
kAVSCLast  

Often used to tag the end of an enumeration with a specific value.

AVSpecialError 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVSpecialError {
 kAVSEOkay,
 
 kAVSEInvalidCombination,
 
 kAVSEDoesntExist,
 
 kAVSECouldntCreate,
 
 kAVSEError
}

See Also


File: AVExpT.h
Line: 8190

Elements
kAVSEOkay  

No error.

 
kAVSEInvalidCombination  

Invalid category/ folder combination.

 
kAVSEDoesntExist  

File or directory does not exist.

 
kAVSECouldntCreate  

File system error: directory could not be created.

 
kAVSEError  

Some other generic error.

AVSpecialFolder 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVSpecialFolder {
 kAVSFRoot,
 
 kAVSFEBooks,
 
 kAVSFPreferences,
 
 kAVSFSequences,
 
 kAVSFDocuments,
 
 kAVSFJavaScript,
 
 kAVSFStamps,
 
 kAVSFDictionaries,
 
 kAVSFPlugIns,
 
 kAVSFSPPlugIns,
 
 kAVSFHelp,
 
 kAVSFTemp,
 
 kAVSFMessages,
 
 kAVSFResource,
 
 kAVSFUpdate,
 
 kAVSFHelpLocale,
 
 kAVSFAuthoring,
 
 kAVSFSecurity,
 
 kAVSFLocalRoot,
 
 kAVSFLocalCache,
 
 kAVSFTasks,
 
 kAVSFLinguistics,
 
 kAVSFMappingTables,
 
 kAVSFDocTemplates,
 
 kAVSFDesktop,
 
 kAVSFPrintSupport,
 
 kAVSFGettingStarted,
 
 kAVSFTouchUpFind,
 
 kAVSFOrganizerDatabase,
 
 kAVSFHostedServicesTemplates,
 
 kAVSFSwatchbooks,
 
 kAVSFStampsLocale,
 
 kAVSFNavigators,
 
 kAVSFNavigatorsLocalized,
 
 kAVSFMultimediaSkins,
 
 kAVSFDocSettings,
 
 kAVSFDocSettingsCombineFiles,
 
 kAVSFDocSettingsRedaction,
 
 kAVSFApplicationResources,
 
 kAVSFFileInfo,
 
 kAVSFJobOptions,
 
 kAVSFSWF,
 
 kAVSFBuiltInPlugIns,
 
 kAVSFIDTemplates,
 
 kAVSFServices,
 
 kAVSFServicesRdr,
 
 kAVSFServicesStd,
 
 kAVSFServicesPro,
 
 kAVSFApplicationAllLocales,
 
 kAVSFUICustomization,
 
 kAVSFApplicationCurrentLocale,
 
 kAVSFAcroApp,
 
 kAVSFLast
}

See Also


File: AVExpT.h
Line: 7973

Elements
kAVSFRoot  

Viewer root: the location of the application. It is sometimes needed to sniff for DLLs and other files that live at this level.

 
kAVSFEBooks  

User eBook license files (RMF) used by WebBUY to indicate ownership/rights of particular PDF documents.

 
kAVSFPreferences  

User preferences folder. It should contain preferences files (for example, ini or Mac OS prefs files). Generally you do not want the user touching these. If a plug-in provides regular preferences, it should use the miIni.c interface, which would map to pref files in this folder on Mac OS and the registry on Windows.

 
kAVSFSequences  

User-defined batch sequences: Custom batch scripts that the user has written/defined and saved. Application batch sequences: Batch sequences that are shipped with the product as examples.

 
kAVSFDocuments  

User documents folder The viewer and all plug-ins should default to opening and saving in this folder.

 
kAVSFJavaScript  

User JavaScripts folder: JavaScript (.js) files written by the user that are loaded at application launch. These are editable directly by the user and as such are not usually found in the same folder as kAVSFEBooks, kAVSFPreferences, or kAVSFSequences.

 
kAVSFStamps  

User stamps folder: Custom rubber stamps created by the user are stored in this folder.

Application stamps folder: Stamps that are shipped with the product.

 
kAVSFDictionaries  

User-installed dictionaries: User-installed dictionaries for the spell checker.

Application-installed dictionaries: Dictionaries that are shipped with the product.

 
kAVSFPlugIns  

The application plug-ins folder where plug-ins are stored. The kAVSCUser and kAVSCLocal domains are recommended. kAVSCApp domain is deprecated.

 
kAVSFSPPlugIns  

Suite Pea plug-ins folder.

 
kAVSFHelp  

Help folder Application help.

 
kAVSFTemp  

Temporary folder.

 
kAVSFMessages  

User messages/application messages folder.

 
kAVSFResource  

PDFL resource folder.

 
kAVSFUpdate  

Update folder.

 
kAVSFHelpLocale  

Downloaded Adobe Reader Help folder:

Used to store the full Adobe Reader Help file on systems that lock out access to the application Help folder.

 
kAVSFTasks  

<DEPRECATED>

 
kAVSFLinguistics  

Linguistics Library (LILO) files shared among all Adobe applications.

 
kAVSFMappingTables  

Mapping Tables for the SaveAsXML plug-in.

 
kAVSFDocTemplates  

Used to create a new PDF file from the document template. User templates folder: Custom template files that the user creates are stored in this folder.

Application doc template folder: Doc templates that are shipped with the product.

 
kAVSFDesktop  

User desktop folder.

 
kAVSFPrintSupport  

Common PrintSpt folder for storing custom printer marks files.

InDesign CS puts its custom marks files there, which is why the Viewer looks there as well.

 
kAVSFTouchUpFind  

The TouchUp/Find Application plugin folder where TouchUp stores XML files.

 
kAVSFOrganizerDatabase  

The folder where the Organizer database files are to be located.

 
kAVSFHostedServicesTemplates  

Used to create a PDF file envelope containing a secure attachment.

 
kAVSFSwatchbooks  

Swatchbooks.

 
kAVSFStampsLocale  

Application's localized stamps folder: localized application stamps are stored in this folder.

Application localized stamps folder: localized stamps that are shipped with the product.

 
kAVSFNavigators  

Acrobat 10 navigators are stored in this folder

 
kAVSFNavigatorsLocalized  

Strings for Acrobat 10 navigators are stored in this folder. The navigators are stored in 'kAVSFNavigators' folder. This folder is not used for custom navigators.

 
kAVSFMultimediaSkins  

Application multimedia skins folder: Multimedia skins that are shipped with the product.

 
kAVSFDocSettings  

Doc settings root

 
kAVSFDocSettingsCombineFiles  

DocSettings/CombineFiles

 
kAVSFDocSettingsRedaction  

DocSettings/Redaction

 
kAVSFApplicationResources  

Application resources

 
kAVSFFileInfo  

FileInfo

 
kAVSFJobOptions  

Distiller job options Not avaialble on Windows (registry)

 
kAVSFSWF  

SWF's Not avaialble on Windows (SWF's are resources on Windows, files on Mac)

 
kAVSFBuiltInPlugIns  

Built-in plug-ins

 
kAVSFIDTemplates  

IDTemplates

 
kAVSFServices  

Service plug-ins (SPA)

 
kAVSFApplicationAllLocales  

pointer to where locales are stored (does NOT include locale itself)

 
kAVSFUICustomization  

User and application defined UI Customization files

 
kAVSFApplicationCurrentLocale  

pointer to where current locales is stored

 
kAVSFAcroApp  

User and application defined App files

 
kAVSFLast  

Often used to tag the end of an enumeration with a specific value.

AVTaskOrderNumbers 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVTaskOrderNumbers {
 kAVeBookTaskOrder = 100,
 
 kAVNewDocumentTaskOrder = 200,
 
 kAVCombineFilesTaskOrder = 300,
 
 kAVCollabTasksTaskOrder = 350,
 
 kAVExportTaskOrder = 400,
 
 kAVMeetingTaskOrder = 500,
 
 kAVSecureTaskOrder = 600,
 
 kAVSignTaskOrder = 700,
 
 kAVFormTaskOrder = 800,
 
 kAVMultimediaTaskOrder = 850,
 
 kAVReviewAndCommentTaskOrder = 900,
 
 kAVSendForReviewTaskOrder = 1000,
 
 kAVPictureTasksTaskOrder = 1100
}

File: AVExpT.h
Line: 10007

AVTileMark 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVTileMark {
 kAVTileMarkNone = 0,
 
 kAVTileMarkWestern,
 
 kAVTileMarkEastern
}

See Also


File: AVExpT.h
Line: 6138

AVUseValue 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVUseValue {
 kAVuseAuto = 0,
 
 kAVuse,
 
 kAVnoUse
}

See Also


File: AVExpT.h
Line: 6226

Elements
kAVuseAuto  

Let Acrobat decide whether to use a feature.

 
kAVuse  

Force Acrobat to use a feature, even if Acrobat determines that it will not work.

 
kAVnoUse  

Do not use a feature, even if Acrobat determines that it will work.

AVZoomType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, UNIX

Syntax


File: AVExpT.h
Line: 836

Elements
AVZoomNoVary  

No variable zoom.

 
AVZoomFitPage  

Fit page to window.

 
AVZoomFitWidth  

Fit page width to the window.

 
AVZoomFitHeight  

Fit page height to the window.

 
AVZoomFitVisibleWidth  

Fit visible width to the window.

 
AVZoomPreferred  

Use the page's preferred zoom.

 
AVZoomReflowWidth  

Reflow the page to the window width.

kAVParagraphDirection 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum kAVParagraphDirection {
 kAVParagraphDirectionLeftToRight,
 
 kAVParagraphDirectionRightToLeft,
 
 kAVParagraphDirectionSameAsDocument,
 
 kAVParagraphDirection_END_ENUM
}

File: AVExpT.h
Line: 10147

PDFarEastFont 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax


File: PDFLExpT.h
Line: 147

Elements
PDOutput_PS  

Emit a PostScript file.

 
PDOutput_EPSNoPrev  

Emit an EPS file with no preview.

 
PDOutput_EPSMacStdPrev  

Emit an EPS file with standard preview.

 
PDOutput_EPSMacExtPrev  

Emit an EPS file with extended preview.

PDFindFlags 
Product availability: All
Platform availability: All

Syntax

enum PDFindFlags {
 PDFindWholeWords = 0x0001,
 
 PDFindCaseSens = 0x0002,
 
 PDFindReverse = 0x0004,
 
 PDFindAllOnPage = 0x0008,
 
 PDFindIgnoreFH = 0x0100,
 
 PDFindIgnoreDiacritics = 0x0200,
 
 PDFindReset = 0x0800
}

File: PDExpT.h
Line: 2110

Elements
PDFindWholeWords  

Find whole words only.

 
PDFindCaseSens  

Perform a case-sensitive search.

 
PDFindReverse  

Perform a reverse order search.

 
PDFindAllOnPage  

Return a PDTextSelect with all found words on the page.

 
PDFindIgnoreFH  

Do not perform a match of full-width/half-width Kana characters.

 
PDFindReset  

Reset to the beginning of the document.

PDFlattenTilingMode 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDFlattenTilingMode {
 kPDNoTiling = 0,
 
 kPDConstantTiling,
 
 kPDAdaptiveTiling
}

File: PDFLExpT.h
Line: 291

Elements
kPDNoTiling  

No tiling.

 
kPDConstantTiling  

Constant tiling.

 
kPDAdaptiveTiling  

Adaptive tiling.

PDFOptCompressionAlgo 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDFOptCompressionAlgo {
 kPDFOptNoRecompression = 0,
 
 kPDFOptJpeg2000,
 
 kPDFOptJpeg,
 
 kPDFOptFlate,
 
 kPDFOptJBIG2,
 
 kPDFOptCCITT3,
 
 kPDFOptCCITT4,
 
 kPDFOptRunLength
}

File: AVExpT.h
Line: 10201

PDFOptCompressionQlty 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDFOptCompressionQlty {
 kPDFOptMinimumQlty = 0,
 
 kPDFOptLowQlty,
 
 kPDFOptMediumQlty,
 
 kPDFOptHighQlty,
 
 kPDFOptMaximumQlty,
 
 kPDFOptLossless
}

File: AVExpT.h
Line: 10223

PDFOptDownsamplingAlgo 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDFOptDownsamplingAlgo {
 kPDFOptNoDownsampling = 0,
 
 kPDFOptAverage,
 
 kPDFOptSubsampling,
 
 kPDFOptBicubic
}

File: AVExpT.h
Line: 10189

PDFOptObjectCompression 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDFOptObjectCompression {
 kPDFOptUntouchedCompression = 0,
 
 kPDFOptFullCompression,
 
 kPDFOptPartialCompression,
 
 kPDFOptRemoveCompression
}

File: AVExpT.h
Line: 10325

PDFOptPDFVersion 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDFOptPDFVersion {
 kPDFOptRetainVersion = 0,
 
 kPDFOptAcrobat4,
 
 kPDFOptAcrobat5,
 
 kPDFOptAcrobat6,
 
 kPDFOptAcrobat7,
 
 kPDFOptAcrobat8,
 
 kPDFOptAcrobat9,
 
 kPDFOptAcrobat10
}

File: AVExpT.h
Line: 10309

Variables Detail
gUnixHFT 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

HFT gUnixHFT;

File: UnixCalls.h
Line: 110
gUnixVersion 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

ASUns32 gUnixVersion;

File: UnixCalls.h
Line: 111

Structure Detail
_AVExtensionInfoRec
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _AVExtensionInfoRec {
 ASAtom asaName; 
 
 ASBool bLoaded; 
 
 ASBool bCertified; 
 
 AVVersionNumPart nMajorVersion; 
 
 AVVersionNumPart nMinorVersion; 
 
 char* cDate; 
 
 ASPathName aspFile; 
 
 char* cDescription; 
 
 char* cLegal; 
 
 char* cDependencies; 
}

A data structure containing information about a client loaded by the viewer.

See Also


File: AVExpT.h
Line: 9624

Elements
asaName  

The registered name of the plug-in.

 
bLoaded  

Always true, indicating that the plug-in was loaded.

 
bCertified  

true if the plug-in is certified, false otherwise.

 
nMajorVersion  

The major and minor versions of the plug-in.

 
cDate  

The creation timestamp on the plug-in.

 
aspFile  

The path to the plug-in.

 
cDescription  

A description of the plug-in. It may be NULL.

 
cLegal  

The legal text associated with the plug-in. It may be NULL.

 
cDependencies  

The dependencies of the plug-in.

_AVExtensionInfoRecEx 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _AVExtensionInfoRecEx {
 ASSize_t size; 
 
 AVExtensionInfo pExtensionInfo; 
 
 AVVersionParams pVersionParams; 
}

A newer version of AVExtensionInfo. This supports the new version format. Use pVersionParams to access version related information. For everything else, use the pExtensionInfo member which points to the same content as obtained using the older AVExtensionAcquireInfo API.

See Also


File: AVExpT.h
Line: 10550

Elements
size  

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

 
_t_ASPlatformPrinterSpec 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

struct _t_ASPlatformPrinterSpec {
 ASSize_t size; 
 
 short hRes; 
 
 short vRes; 
 
 UniChar printerName[kPrinterSpecNameLen]; 
}


File: AVExpT.h
Line: 5961

Elements
size  

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

 
hRes  

The best known resolution of the current printer.

 
printerName  

The name of the printer.

_t_ASPlatformPrinterSpec 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

struct _t_ASPlatformPrinterSpec {
 ASSize_t size; 
 
 char* printerName; 
 
 ASUns8 baseAddr; 
 
 AVBufferSize rowBytes; 
 
 AVBufferSize depth; 
 
 AVRect bounds; 
}


File: AVExpT.h
Line: 5932

Elements
size  

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

 
printerName  

A print command, such as "lp -dMyPrinter -n4". If printerName is NULL, a default print command is used. The Acrobat viewer's built-in default is "lp" on most UNIX systems, and "lpr" on Sun operating systems. This should print to the system's default printer. Some UNIX systems also use the environment variable LPDEST or PRINTER. See the documentation for your platform to determine whether this is the case.

 
_t_ASPlatformPrinterSpec 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

struct _t_ASPlatformPrinterSpec {
 ASSize_t size; 
 
 char driverName[kPrinterSpecNameLen]; 
 
 char printerName[kPrinterSpecNameLen]; 
 
 char portName[kPrinterSpecNameLen]; 
 
 ASBool createMetaFile; 
 
 char metaFileName[260]; 
 
 ASInt32 win16Hdc; 
 
 ASInt32 hRes; 
 
 ASInt32 vRes; 
 
 ASInt32 colorDepth; 
 
 ASBool isPostScript; 
 
 ASUns16 driverNameW[kPrinterSpecUnicodeNameLen]; 
 
 ASUns16 printerNameW[kPrinterSpecUnicodeNameLen]; 
 
 ASUns16 portNameW[kPrinterSpecUnicodeNameLen]; 
 
 ASUns16 metaFileNameW[260]; 
}

A data structure representing a platform specification for a printer. It is used in AVDocPrintParams.

See Also


File: AVExpT.h
Line: 5985

Elements
size  

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

 
driverName  

See Windows.h DEVNAMES for a description of these fields. This char name is deprecated; please use the Unicode version driverNameW.

 
printerName  

The name of the printer. For example, it can be "HPPCL", "HP LaserJet 4", or "LPT1". This char name is deprecated; please use the Unicode version printerNameW.

 
portName  

The port to print to. This char name is deprecated; please use the Unicode version portNameW.

 
createMetaFile  

This must be true of Windows 32-bit platforms; optional for Windows 16-bit platforms.

 
metaFileName  

The path name for the metafile. It is only required if createMetaFile is true. This char name is deprecated; please use the Unicode version metaFileNameW.

 
win16Hdc  

An HDC for embedded printing on Windows 16-bit platforms, unused on Windows 32-bit platforms.

 
hRes  

The horizontal resolution of printer. For example, a value of 300 means 300 dpi.

 
vRes  

The vertical resolution of printer. For example, a value of 300 means 300 dpi.

 
colorDepth  

The color depth of the device; its value is typically 1, 8, or 24. This determines the depth of images created for the printer. You may specify 24 when printing to a monochrome printer. The driver is expected to convert to the printer depth. It is not used if isPostScript is true.

 
isPostScript  

Set to true if printing to a PostScript printer.

 
driverNameW  

Unicode names of the driver. When both driverName and driverNameW are valid, the Unicode name is used.

 
printerNameW  

Unicode names of the printer. When both printerName and printerNameW are valid, the Unicode name is used.

 
portNameW  

Unicode names of the port. When both portName and portNameW are valid, the Unicode name is used.

 
metaFileNameW  

Unicode path name for the metafile. When both metaFileName and metaFileNameW are valid, the Unicode name is used.

_t_AVAdjustCursorParams 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVAdjustCursorParams {
 ASSize_t size; 
 
 AVDevCoord xHit; 
 
 AVDevCoord yHit; 
 
 ASAtom toolType; 
}

Parameters that describe where and how a cursor event occurred, for the use of cursor handling callback procedures.

See Also


File: AVExpT.h
Line: 3785

Elements
size  

The size of this structure.

 
xHit  

The x-coordinate of the cursor.

 
yHit  

The y-coordinate of the cursor.

 
toolType  

The tool type that received the cursor event

_t_AVAuxDataHandler 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVAuxDataHandler {
 ASSize_t size; 
 
 AVAuxDataPerformProc PerformProc; 
}

A data structure containing callbacks and data representing an auxiliary data handler. NULL values are acceptable; in such cases default behavior is used.

See Also


File: AVExpT.h
Line: 5887

Elements
size  

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

 
PerformProc  

Called with auxiliary data when a client calls AVDocSendAuxData(). This proc should perform whatever action is required for the auxiliary data.

_t_AVClickParams 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVClickParams {
 ASSize_t size; 
 
 AVDevCoord xHit; 
 
 AVDevCoord yHit; 
 
 AVFlagBits16 flags; 
 
 AVTCount clickNo; 
 
 ASAtom toolType; 
}

Parameters that describe where and how a mouse click occurred, for the use of click-handling callback procedures.

See Also


File: AVExpT.h
Line: 3763

Elements
size  

The size of this structure.

 
xHit  

The x-coordinate of the mouse click.

 
yHit  

The y-coordinate of the mouse click.

 
flags  

Indicates which modifier keys are pressed. It must be an OR of the Modifier Keys values.

 
clickNo  

1 if this is a single click, 2 if this is a double click, 3 if this is a triple click.

 
toolType  

The tool type that received the click event.

_t_AVDestInfo 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVDestInfo {
 ASSize_t size; 
 
 const char* namedDest; 
 
 AVTArraySize nameLength; 
 
 PDPageNumber pageNum; 
 
 ASAtom fitType; 
 
 ASFixedRect destRect; 
 
 ASFixed zoom; 
}

A data structure representing a destination in a PDF document. An AVDestInfo carries all the information that a PDViewDestination can. It is used for ensuring that cross-document links in external windows act as expected, so a client can go to a destination without building it via PDViewDestCreate(), which does not work on read-only documents.

See Also


File: AVExpT.h
Line: 2372

Elements
size  

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

 
namedDest  

The named destination associated with this destination. If this is non-NULL, the other attributes are ignored. This destination may contain multi-byte characters.

 
nameLength  

The length of namedDest in bytes.

 
pageNum  

The page number of the destination view.

 
fitType  

The fit type of the destination view. It must be one of View Destination Fit Types.

 
destRect  

A rectangle enclosing the destination view.

 
zoom  

The zoom factor of the destination view. Use zero to inherit the zoom.

_t_AVDragRectParams 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVDragRectParams {
 ASSize_t size; 
 
 AVPageView pageView; 
 
 ASInt32 xStart; 
 
 ASInt32 yStart; 
 
 ASFixedRect startRect; 
 
 ASFixedRect resultRect; 
 
 AVDragType dragType; 
 
 AVDevRect extrema; 
 
 AVCursor cursorArray; 
 
 ASInt32 nCursors; 
 
 AVPageViewDrawProc drawProc; 
 
 AVDevRect minRect; 
}

The parameters for AVPageViewDragRectSnappedEx(), which supersedes AVPageViewDragRectSnapped() in Acrobat 6.0. In addition to the parameters allowed by the earlier method, the new version allows you to specify your own drawing procedure.


File: AVExpT.h
Line: 9386

Elements
size  

Set by the caller to sizeof(AVDragRectParamsRec).

 
pageView  

The page view where the drag occurs.

 
xStart  

The starting x-coordinate in device space.

 
yStart  

The starting y-coordinate in device space.

 
startRect  

The initial rect in page space.

 
resultRect  

The resulting rect in page space.

 
dragType  

The desired drag type, which is typically the result of AVRectHandleHitTest().

 
extrema  

The device-space drag bounds.

 
cursorArray  

Pass NULL for default cursors.

 
nCursors  

The number of cursors in cursorArray.

 
drawProc  

Pass NULL for the default Acrobat proc.

 
minRect  

The device space minimum rectangle. This rectangle is used as a lower bound during a resize operation. The exact position of the rectangle is not important. The rectangles [0,0,10,20] and [100,100,110,120] are considered identical since they have the same width and height.

_t_AVFileDescRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVFileDescRec {
 char extension[32]; 
 
 ASUns32 macFileType; 
 
 ASUns32 macFileCreator; 
}

A structure to handle file types and/or extensions in open and save dialog boxes.

See Also


File: AVExpT.h
Line: 7618

Elements
extension  

A string up to 32 characters in length, for file extension. Use \ 0 on Windows for do not care (ignored on Windows only if \0 is used).

 
macFileType  

File type (used on Mac OS only). Use 0 for do not care.

 
macFileCreator  

File creator (used on Mac OS only). Use 0 for do not care.

_t_AVFileFilterRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVFileFilterRec {
 ASText filterDescription; 
 
 AVFileDescRec fileDescs; 
 
 AVArraySize numFileDescs; 
}

A structure to hold a series of file type descriptors that form a file filter for an open or save dialog box.

See Also


File: AVExpT.h
Line: 7665

Elements
filterDescription  

Localized string describing this filter. It is the name that appears in the open or save dialog box.

 
fileDescs  

An array of AVFileDescRec objects. A single AVFileFilterRec can have as many AVFileDescRec objects as needed. On Windows, the file name is concatenated with the extension string of the relevant AVFileDescRec in the Open and Save dialog boxes. On Mac OS, the fileDescription string is used in the File Open and Save dialog boxes, and the AVFileDescRec objects are used to filter which files are displayed when that AVFileFilterRec is selected.

 
numFileDescs  

The number of AVFileDescRec objects in fileDescs.

_t_AVIconBundleRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVIconBundleRec {
 ASUns32 tag1; 
 
 ASUns32 tag2; 
 
 ASInt32 version; 
 
 AVIconBundleIconRef grayIcon; 
 
 AVIconBundleIconRef colorIcon; 
}

An icon bundle allows you to gather up multiple icons and present them to Acrobat as a single AVIcon. For example, when creating a toolbar button you can pass in an icon bundle specifying both gray and color icons; the gray icon will be used to draw the button in its normal state, and the color icon will be used to draw the button when the pointer is over it.

The format for icon bundles is platform-specific (primarily since the format for AVIcon objects is platform-specific). On Windows the icons can be specified using HICONs, not HBITMAPs. On Mac OS, they are IconSuiteRef resources. Both platforms support the PNG format.

The tags at the front are there so the implementation can determine with certainty that the information passed in is an icon bundle and not an Acrobat 4-compatible AVIcon.


File: AVExpT.h
Line: 451

Elements
tag1  

Set to AVIC (for example, bundle.tag1 = 'AVIC').

 
tag2  

Set to ONBU (for example, bundle.tag2 = 'ONBU').

 
version  

Set to the version of the application (for example, 0x00050000 for Acrobat 5.0).

 
grayIcon  

Defined according to the AVIconBundleRef typedef.

 
colorIcon  

Defined according to the AVIconBundleRef typedef.

_t_AVIconBundleRec6 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVIconBundleRec6 {
 ASUns32 tag1; 
 
 ASUns32 tag2; 
 
 ASInt32 version; 
 
 AVIconHandler handler; 
 
 void* iconData; 
 
 void* iconDataHighResolution; 
}

An icon bundle allows you to gather up multiple icons and present them to Acrobat as a single AVIcon. For example, when creating a toolbar button you can pass in an icon bundle specifying both gray and color icons; the gray icon will be used to draw the button in its normal state, the color icon will be used to draw the button when the pointer is over it. The format for icon bundles is platform-specific (primarily since the format for AVIcon objects is platform-specific). On Windows the icons are specified using HICONs, not HBITMAPs. On Mac OS, they are IconSuiteRef resources. The tags at the front are there so the implementation can determine with certainty that the information passed in is an icon bundle and not an Acrobat 4-compatible AVIcon.


File: AVExpT.h
Line: 659

Elements
tag1  

Set to AVIC (for example, bundle.tag1 = 'AVIC')

 
tag2  

Set to ONBU (for example, bundle.tag2 = 'ONBU')

 
version  

Set to the version of the application (for example, 0x00060000 for Acrobat 6.0)

 
handler  

The icon handler.

 
iconData  

A pointer to the icon data record structure.

 
iconDataHighResolution  

A pointer to the icon data record structure for the high Resolution version of the icon.

_t_AVIconData 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVIconData {
 ASStm dataStm; 
 
 AVIconColorFormat eColorFormat; 
}

A data record for an AVIconBundle6.

See Also


File: AVExpT.h
Line: 681

Elements
dataStm  

A data stream containing the binary-encoded data.

 
eColorFormat  

The color this icon represents.

_t_AVIconHandlerRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVIconHandlerRec {
 ASInt32 size; 
 
 void* clientData; 
 
 AVIconHandlerMeasureProc Measure; 
 
 AVIconHandlerOpenStmProc OpenStm; 
 
 AVIconHandlerGetFlagsProc GetFlags; 
 
 AVIconHandlerReleaseProc Release; 
 
 AVIconHandlerResizeProc Resize; 
}


File: AVExpT.h
Line: 626

Elements
size  

The size of the structure. Set it to sizeof(AVIconHandlerRec).

 
clientData  

A pointer to user-defined data passed to the callback.

 
_t_AVPoint 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVPoint {
 ASInt32 h; 
 
 ASInt32 v; 
}


File: AVExpT.h
Line: 1147

_t_AVSimpleSelProcs 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVSimpleSelProcs {
 ASSize_t size; 
 
 const char* type; 
 
 AVSimpleSelHiliteProc hiliteProc; 
 
 AVSimpleSelDeHiliteProc deHiliteProc; 
 
 AVSimpleSelDataDestroyProc destroyProc; 
}


File: AVExpT.h
Line: 9746

Elements
size  

Set to sizeof(AVSimpleSelProcsRec).

 
type  

The sub-selection type.

 
_t_AVStatusMonitorProcs 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVStatusMonitorProcs {
 ASSize_t size; 
 
 ASProgressMonitor progMon; 
 
 void* progMonClientData; 
 
 ASCancelProc cancelProc; 
 
 void* cancelProcClientData; 
 
 ASReportProc reportProc; 
 
 void* reportProcClientData; 
}

A structure that contains a progress monitor, a cancel procedure, and an error report procedure.

See Also


File: AVExpT.h
Line: 7563

Elements
size  

The size of this structure. Set it to sizeof(AVStatusMonitorProcsRec).

 
progMon  

(May be NULL) The progress monitor. In general, clients of this structure test members for NULL. If a member is found, they do not do anything.

 
progMonClientData  

The progress monitor client data that was acquired with the progress monitor.

 
cancelProc  

This call has been replaced by ASCancelProc().

This is a callback to check for cancelling operations. A CancelProc is typically passed to some method that takes a long time to complete. At frequent intervals, the method calls the CancelProc. If it returns true, then the method cancels its operation; if it returns false, it continues.

 
cancelProcClientData  

The cancellation procedure client data that was acquired with the cancellation procedure.

 
reportProc  

(May be NULL) The report procedure. In general, clients of this structure test members for NULL. If a member is found, they do not do anything.

 
reportProcClientData  

The report procedure client data that was acquired with the report procedure.

_t_AVTransHandler 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

A data structure containing callbacks that implement a transition handler. The callbacks implement the transition handler functions.

See Also


File: AVExpT.h
Line: 7453

Elements
size  

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

 
GetType  

Return the transition handler type (for example, "Wipe").

 
Execute  

Given this PDTrans, execute this transition.

 
GetUIName  

Given this PDTrans, determine the UIName.

 
GetItemUIName  

Return the UIName for the Nth item, NULL if N is invalid.

 
InitTransDict  

Fill this dict with generic information if necessary.

 
CompleteTransDict  

Fill this dict with specific, standard information.

 
DoProperties  

The proc to bring up the user interface window. Fill in the PDTrans for non-standard plug-ins that have additional information.

 
GetInstructions  

message1 for non-standard plug-ins that have additional information.

 
GetButtonText  

Button text for non-standard plug-ins that have additional information.

 
GetStringOneText  

message2 for non-standard plug-ins that have additional information.

 
GetStringTwoText  

message3 for non-standard plug-ins that have additional information.

 
GetName  

Acrobat 5: given this PDTrans, determine its LI name. This is used for non-standard plug-ins that have additional information.

 
GetItemName  

Acrobat 5: return the LI name for the Nth item, ASAtomNull if N is invalid. This is used for non-standard plug-ins that have additional information.

 
discludeFromRandom  

Acrobat 6: determine if this transition is OK to use with the Random transition. This is used for non-standard plug-ins that have additional information.

 
discludeFromUI  

Acrobat 7: Determine if this transition is OK to set through the user interface. Certain effects, such as /Fly, do not make sense in the general case.

 
GetItemDirectionUIName  

Acrobat 8

 
GetBiDirEnabled  

Acrobat 8: Determines whether this transition has a bidirectional counterpart.

 
GetSmoothActionEnabled  

Acrobat 8: Determines whether this transition uses Smooth Action.

_t_AVTransitionPort 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_AVTransitionPort {
 void* reserved; 
 
 AVRect32 rect32; 
 
 int Acrobat8ForMacDoesNotSupportTheAVTransitionPort; 
 
 int PleaseContactDeveloperSupportIfThisIsAnIssueForYou; 
}

A platform-dependent data structure for a transition.

In general, a transition port specifies a bitmap and a rectangle describing the portion of the bitmap affected by the transition. The transition handler's AVTransHandlerExecuteProc() callback must copy all the bits from the source port's bitmap within the source port's rectangle to the area in the destination port's bitmap described by the destination port's rectangle. The source and destination ports' rectangles are guaranteed to be equal in size.

See Also


File: AVExpT.h
Line: 7111

_t_ExternalDocServerCreationData 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

Data for an AVDoc in an external window. It is a platform-dependent structure used in AVDocOpenParams when opening an AVDoc with AVDocOpenFromASFileWithParamString(), AVDocOpenFromASFileWithParams(), or AVDocOpenFromPDDocWithParams().

See Also


File: AVExpT.h
Line: 2861

Elements
size  

The size of the data structure. It must be set to sizeof(ExternalDocServerCreationData Rec).

 
platformWindow  

A platform-dependent structure of type ExternalDocWindowData representing a window.

Operating system detail:

Operating system

Description

Mac OS

The ExternalDocWindowData structure is used.

Windows

HWND is cast as ExternalDocWindowData.

UNIX

Widget is cast as ExternalDocWindowData.

 
acrobatProc  

An optional callback. It is called when the Acrobat button (if present) is clicked in the external application.

 
acrobatProcData  

Client-specified data for acrobatProc.

 
crossDocLinkProc  

A callback of type CrossDocLinkProc.

 
crossDocLinkProcData  

Client-specified data for crossDocLinkProc.

 
setMessage  

Currently unused.

 
setMessageProcData  

Currently unused. Client-specified data for setMessage.

 
crossDocLinkWithDestProc  

A callback to call when a cross-document link occurs.

 
crossDocLinkWithDestData  

Client-specified data for crossDocLinkWithDestProc.

 
setFocus  

(New in Acrobat 5.0) A callback to call when Acrobat returns focus to the browser displaying the document.

 
setFocusProcData  

(New in Acrobat 5.0) Client-specified data for setFocus.

 
setFocusSHIFTTAB  

(New in Acrobat 7.0) Used for extended TAB handling in the browser.

 
setFocusSHIFTTABProcData  

(New in Acrobat 7.0) Used for extended TAB handling in the browser.

 
setFocusCTRLTAB  

(New in Acrobat 7.0) Used for extended TAB handling in the browser.

 
setFocusCTRLTABProcData  

(New in Acrobat 7.0) Used for extended TAB handling in the browser.

_t_ExternalDocWindowData 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

struct _t_ExternalDocWindowData {
 ExternalDocWindowRefDataRec ref; 
 
 void* setCursorProcData; 
}

Data for an AVDoc in an external window. It is a platform-dependent structure used in ExternalDocServerCreationData when opening an AVDoc with AVDocOpenFromASFileWithParamString(), AVDocOpenFromASFileWithParams(), or AVDocOpenFromPDDocWithParams().

On Mac OS, a plug-in must handle events that affect the window, such as resize and mouse events.

See Also


File: AVExpT.h
Line: 2831

Elements
ref  

A pointer to external window data. It must be of type ExternalDocWindowRefData.

 
setCursorProcData  

Optional client-specified data.

_t_ExternalDocWindowRefData 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

struct _t_ExternalDocWindowRefData {
 void** pluginView; 
 
 ASUns32 x; 
 
 ASUns32 y; 
 
 ASUns32 width; 
 
 ASUns32 height; 
 
 ASInt32 portx; 
 
 ASInt32 porty; 
}

(Mac OS only) Data for an external window. A platform-dependent structure used in ExternalDocWindowData when opening an AVDoc with AVDocOpenFromASFileWithParamString(), AVDocOpenFromASFileWithParams(), or AVDocOpenFromPDDocWithParams().

Coordinates specified in this structure are in application space. Use AVRectToRect() to translate from user space to device space coordinates, then use Mac OS GlobalToLocal function to translate from device space coordinates to application space coordinates.

See Also


File: AVExpT.h
Line: 2780

Elements
pluginView  

View

 
x  

The x-displacement in application space coordinates from the application's window to the AVPageView in which Acrobat renders the PDF file.

 
y  

The y-displacement in application space coordinates from the application's window to the AVPageView in which Acrobat renders the PDF file.

 
width  

The width of the external window, specified in device space units.

 
height  

The height of the external window, specified in device space units.

 
portx  

The x-displacement in application space coordinates from the AVPageView in which Acrobat renders the PDF file to the actual PDF file page. It should usually be 0.

 
porty  

The y-displacement in application space coordinates from the AVPageView in which Acrobat renders the PDF file to the actual PDF file page. Should usually be 0.

_t_PDFOptFlattenTransparencyOptions 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDFOptFlattenTransparencyOptions {
 ASSize_t size; 
 
 ASInt32 pctRasterVectorBalance; 
 
 ASInt32 ppiLineArtAndText; 
 
 ASInt32 ppiGradientAndMesh; 
 
 ASBool bConvertText; 
 
 ASBool bConvertStrokes; 
 
 ASBool bClipComplexRegions; 
 
 ASBool bPreserveOverprint; 
}

Transparency flattening options


File: AVExpT.h
Line: 10271

Elements
size  

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

 
pctRasterVectorBalance  

The percentage of vector information that is to be preserved. Lower values will cause higher rasterization of vectors.

Being a percentage, its value should lie between 0 and 100.

 
ppiLineArtAndText  

Specfies the pixels per inch for flattening edges of atomic regions. Its value should lie between 1 and 9600.

 
ppiGradientAndMesh  

Specfies the pixels per inch for flattening the interiors of atomic regions. Its value should lie between 1 and 1200.

 
bConvertText  

If true, it outputs text outlines instead of native text.

 
bConvertStrokes  

If true, it converts strokes to outlines.

 
bClipComplexRegions  

If true, it ensures that boundaries between vector and rasterized artwork fall along object paths.

 
bPreserveOverprint  

If true, it preserves overprint.

_t_PDFOptImageOptions 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

Image optimization options


File: AVExpT.h
Line: 10237

Elements
size  

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

 
enmDownsamplingAlgo  

The downsampling algorithm to be used on the image.

 
ppiDownsampleTo  

Downsample to the specified ppi.

 
ppiDownsampleAbove  

Downsample only if the image is above this ppi.

 
enmCompressionAlgo  

Compression algorithms: recompress using this algorithm. The rules for filter availability for an image type should be followed.

 
enmCompressionQlty  

Compression quality: recompress to this quality level. It is ignored if it is not relevant for the filter type.

 
nTileSize  

Use this tile size if compressing using JPEG2000. It is ignored for other filters. Its value should lie between 128 and 2048.

_t_PDFOptParams 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDFOptParams {
 ASSize_t size; 
 
 ASPathName asPathDest; 
 
 ASFileSys fileSys; 
 
 ProgressMonitor progMon; 
 
 void* progMonClientData; 
 
 PDFOptPDFVersion enmAcrobatVersion; 
 
 PDFOptImageOptionsRec imageOptionsColor; 
 
 PDFOptImageOptionsRec imageOptionsGrayscale; 
 
 PDFOptImageOptionsRec imageOptionsMonochrome; 
 
 PDFont arrPDFontsToUnembed; 
 
 ASInt32 cPDFontsToUnembed; 
 
 PDFOptFlattenTransparencyOptions pdfOptFlattenTransparencyOptions; 
 
 ASBool bRemoveFormActions; 
 
 ASBool bFlattenFormFields; 
 
 ASBool bRemoveJavascriptActions; 
 
 ASBool bRemoveAlternateImages; 
 
 ASBool bRemoveThumbnails; 
 
 ASBool bRemoveDocumentTags; 
 
 ASBool bSmoothenLines; 
 
 ASBool bMergeImageFragments; 
 
 ASBool bRemovePrintSettings; 
 
 ASBool bRemoveSrchIndex; 
 
 ASBool bRemoveBookmarks; 
 
 ASBool bRemoveCommentsAndWidgets; 
 
 ASBool bRemoveDocInfoAndMetadata; 
 
 ASBool bRemoveObjectData; 
 
 ASBool bRemoveFileAttachments; 
 
 ASBool bRemoveCrossRefs; 
 
 ASBool bRemovePrivateData; 
 
 ASBool bFlattenVisibleLayers; 
 
 PDFOptObjectCompression enmObjectCompression; 
 
 ASBool bUnencodedToFlate; 
 
 ASBool bLZWToFlate; 
 
 ASBool bRemoveInvalidBookmarks; 
 
 ASBool bRemoveInvalidLinks; 
 
 ASBool bRemoveUnreferencedNamedDests; 
 
 ASBool bLinearize; 
 
 ASBool bSkipIrreducibleImages; 
 
 ASBool bSubsetEmbeddedFonts; 
 
 ASBool bOptimizeContentStms; 
}


File: AVExpT.h
Line: 10337

Elements
size  

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

 
asPathDest  

The path to which the file is to be saved.

 
fileSys  

The file system. If it is NULL, uses the fileSys of the document's current backing file.

 
progMon  

The progress monitor. Use AVAppGetDocProgressMonitor() to obtain the default. It may be NULL.

 
progMonClientData  

A pointer to user-supplied data to pass to progMon each time it is called. It must be NULL if progMon is NULL.

 
enmAcrobatVersion  

Acrobat compatibility version.

 
imageOptionsColor  

Image optimization options for color XObjects. The structure should be filled up keeping in mind the algorithms supported by color images.

 
imageOptionsGrayscale  

Image optimization options for grayscale XObjects. The structure should be filled up keeping in mind the algorithms supported by grayscale images.

 
imageOptionsMonochrome  

Image optimization options for monochrome XObjects. The structure should be filled up keeping in mind the algorithms supported by monochrome images.

 
arrPDFontsToUnembed  

An array of PDFont objects. It is a list of fonts that should be unembedded. It may be NULL.

 
cPDFontsToUnembed  

The length of the arrPDFontsToUnembed array.

 
pdfOptFlattenTransparencyOptions  

A pointer to PDFOptFlattenTransparencyOptions. It specifies options to flatten transparent regions of the document. It can be NULL, in which case transparent regions will be preserved.

 
bRemoveFormActions  

If true, it removes form submissions, import actions, and reset actions.

 
bFlattenFormFields  

If true, it flattens form fields.

 
bRemoveJavascriptActions  

If true, it removes JavaScript actions.

 
bRemoveAlternateImages  

If true, it removes alternate images.

 
bRemoveThumbnails  

If true, it removes embedded thumbnails.

 
bRemoveDocumentTags  

If true, it removes document tags.

 
bSmoothenLines  

If true, it attempts to merge lines made to look like curves into a single curve.

 
bMergeImageFragments  

If true, it attempts to merge fragments of an image into a single image.

 
bRemovePrintSettings  

If true, it removes embedded print settings from the document.

 
bRemoveSrchIndex  

If true, it removes all embedded search indexes from the document.

 
bRemoveBookmarks  

If true, it removes all bookmarks from the document.

 
bRemoveCommentsAndWidgets  

If true, it removes comments and form widgets.

 
bRemoveDocInfoAndMetadata  

If true, it removes document information and metadata.

 
bRemoveObjectData  

If true, it removes object data.

 
bRemoveFileAttachments  

If true, it removes file attachments.

 
bRemoveCrossRefs  

If true, it removes external cross references.

 
bRemovePrivateData  

If true, it removes private data of other applications.

 
bFlattenVisibleLayers  

If true, it deletes hidden layers and flattens visible layers.

 
enmObjectCompression  

Object compression options. Its value should be among the values supported by the acrobatVersion option.

 
bUnencodedToFlate  

If true, it encodes all unencoded streams with the Flate filter.

 
bLZWToFlate  

If true, it reencodes all LZW encoded streams with the Flate filter.

 
bRemoveInvalidBookmarks  

If true, it removes all invalid bookmarks.

 
bRemoveInvalidLinks  

If true, it removes all invalid links.

 
bRemoveUnreferencedNamedDests  

If true, it removes all unreferenced named destinations.

 
bLinearize  

If true, it optimizes the file for fast web view.

 
bSkipIrreducibleImages  

If true, image optimization operations would be applied only if they lead to a reduction in image size. The exception will be cases where recompression is required due to version incompatibility.

 
bSubsetEmbeddedFonts  

If true, all embedded fonts will be subsetted.

 
bOptimizeContentStms  

If true, content streams of all pages in the file are optimized.

_t_WinPort 
Product availability: Acrobat, Reader
Platform availability: Windows

Syntax

struct _t_WinPort {
 HWND hWnd; 
 
 HDC hDC; 
}

The HWND is that of the document window's AVPageView region (the portion of the window in which the PDF file's pages are drawn).

See Also


File: AVExpT.h
Line: 899

AVInkValue 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct AVInkValue {
 ASAtom inkName; 
 
 float value; 
}

An ink value for use in color separation methods.

See Also


File: AVExpT.h
Line: 9894

AVNotificationDataRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct AVNotificationDataRec {
 ASUns32 size; 
 
 const char* notification; 
}


File: AVExpT.h
Line: 10498

AVOpenSaveDialogOutParamsRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct AVOpenSaveDialogOutParamsRec {
 ASFileSys chosenFileSys; 
 
 ASPathName chosenPathName; 
 
 ASInt16 chosenFilterIndex; 
 
 ASBool launchFile; 
}

A structure defining the output parameters related to a file save dialog box. It is used for AVAppSaveDialogEx().

See Also


File: AVExpT.h
Line: 7820

Elements
chosenFileSys  

Output file system to export the file.

 
chosenPathName  

Output Path for the exported file.

 
chosenFilterIndex  

The index of selected AVFileFilterRec object in fileFilters.

 
launchFile  

Exported file is launched only if launchFile is set to true.

AVOpenSaveDialogParamsRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

A structure defining the properties and callbacks related to a file open/save dialog box. It is used for AVAppOpenDialog(), AVAppSaveDialog(), and AVAppChooseFolderDialog().

See Also


File: AVExpT.h
Line: 7756

Elements
size  

The size of this structure. Set it to sizeof(AVOpenSaveDialogParamsRec).

 
flags  

A bitwise OR of the AVOpenSaveDialogFlags.

 
parentWindow  

The parent window of the dialog box (ignored on Mac OS). It may be NULL.

 
windowTitle  

The title of the dialog box that is used for the prompt. It may be NULL for the default title.

 
actionButtonTitle  

The title of the action button (Open, Save, or Choose). It may be NULL for the default title.

 
cancelButtonTitle  

The title of the cancel button. It may be NULL for the default title.

 
initialFileSys  

May be NULL if flags does not contain kAVOpenSaveAllowForeignFileSystems.

 
initialPathName  

Used to specify the initial location or selection. It may be NULL if the default location or selection is acceptable.

 
initialFileName  

Ignored (may be NULL) for Open and ChooseFolder. For Save, the file name portion is used for the edit field. It may be NULL on Windows, but is required on Mac OS.

 
fileFilters  

An array of AVFileFilterRec objects. It is ignored (may be NULL) for ChooseFolder. It may be NULL for Open only if kAVOpenSaveAllowAllFlag is set.

 
numFileFilters  

The number of AVFileFilterRec objects in fileFilters.

 
settingsComputeEnabledProc  

(Optional) Called to determine whether the Settings button should be enabled. It may be NULL. It is ignored if kAVOpenSaveAllowSettingsButton is not set.

 
settingsExecuteProc  

Called when the user clicks on the (enabled) Settings button. It may be NULL. It is ignored if kAVOpenSaveAllowSettingsButton is not set.

 
settingsProcData  

Data that is passed to the settingsExecuteProc callback. It is ignored if kAVOpenSaveAllowSettingsButton is not set.

 
AVVersionParamsRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct AVVersionParamsRec {
 ASSize_t size; 
 
 ASUns32 major; 
 
 ASUns32 minor; 
 
 ASUns32 minor_minor; 
 
 ASUns32 minor_minor_minor; 
}


File: AVExpT.h
Line: 10534

ExecProcData 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct ExecProcData {
 ASUns32 size; 
 
 const char* menuID; 
 
 const char* notification; 
 
 ASAtom buttonID; 
}


File: AVExpT.h
Line: 10489

PDFlattenRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDFlattenRec {
 ASSize_t size; 
 
 PDFlattenTilingMode tilingMode; 
 
 ASBool useTextOutlines; 
 
 ASBool allowShadingOutput; 
 
 ASBool allowLevel3ShadingOutput; 
 
 ASBool strokeToFill; 
 
 ASBool clipComplexRegions; 
 
 float internalDPI; 
 
 float externalDPI; 
 
 float pathDPI; 
 
 ASUns32 tileSizePts; 
 
 ASUns32 maxFltnrImageSize; 
 
 ASUns32 adaptiveThreshold; 
 
 ASBool preserveOverprint; 
}

Controls tile flattening. It is primarily of interest to resource limited (embedded) systems developers.

See Also


File: PDFLExpT.h
Line: 323

Elements
size  

The size of the structure. Set it to sizeof(PDFlattenRec).

 
tilingMode  

0 = no tiling; 1 = constant tiling; 2 = adaptive tiling

 
useTextOutlines  

Output text outlines instead of native text.

 
allowShadingOutput  

Allow shading ouput.

 
allowLevel3ShadingOutput  

Allow level 3 shading output.

 
strokeToFill  

For converting stroke to outline.

 
clipComplexRegions  

Clip complex checkbox.

 
internalDPI  

Resolution for flattening the interior of an atomic region.

 
externalDPI  

Resolution for flattening edges of atomic regions.

 
pathDPI  

Flattener path resolution; the default is 800.

 
tileSizePts  

Target tile size in points.

 
maxFltnrImageSize  

Maximum image size when flattening. The default is 0.

 
adaptiveThreshold  

Adaptive flattening threshold.

 
preserveOverprint  

Attempt to preserve overprint.

Callbacks Detail
AVAuxDataPerformProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVAuxDataPerformProc)(ASAtom auxDataType, void *auxData, AVTBufferSize auxDataLen, AVDoc avDoc, void *clientData)

(Optional) A callback for AVAuxDataHandler. It is called to process auxiliary data sent to the AVDoc using AVDocSendAuxData(). This callback must process the data appropriately for whatever auxDataType is sent.

If NULL, default behavior is used.

See Also


File: AVExpT.h
Line: 5876
AVCmdHandlerInitProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVCmdHandlerInitProc)(ASAtom handlerName)

Initialize the command handler. It is called once for each command handler registered.

See Also


File: AVExpT.h
Line: 8972
AVCmdHandlerTermProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVCmdHandlerTermProc)(ASAtom handlerName)

Terminate the handler. It is called once for each handler registered when Acrobat shuts down. It is called before clients are unloaded.

See Also


File: AVExpT.h
Line: 8983
AVComputeEnabledProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVComputeEnabledProc)(void *data)

A callback that is used to determine whether a menu item, toolbar button, or tool is enabled. If used for a tool, it is one of the optional callbacks for AVTool.

This procedure is called every time the menu or toolbar button is displayed, so it should not do compute-time-intensive processing. It is called before the menu item or toolbar button is displayed, or before a tool is activated. If it returns false, the menu item, toolbar button, or tool is disabled; otherwise it is enabled. If this callback is NULL, the menu item, toolbar button, or tool is always enabled.

Each menu item, toolbar button, or tool can have its own AVComputeEnabledProc(), or they can be shared.

See Also

AVMenuItemSetComputeEnabledProc
AVToolButtonSetComputeEnabledProc

File: AVExpT.h
Line: 1432
AVComputeMarkedProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVComputeMarkedProc)(void *data)

A callback that is used to determine whether a menu item or toolbar button is marked (a marked menu item has a check mark next to it, and a marked toolbar button appears selected). It is called before the menu item or toolbar button is displayed. If it returns false, the menu item of toolbar button is not marked; otherwise it is marked.

Each menu item and toolbar button can have is own AVComputeMarkedProc, or they can be shared.

See Also

AVMenuItemSetComputeMarkedProc
AVToolButtonSetComputeMarkedProc

File: AVExpT.h
Line: 1452
AVComputeTooltipProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASText (*AVComputeTooltipProc)(void *data, ASBool enabled)

A callback that is used to get the mega-tooltip help text for a toolbar button.

It is called whenever the mouse hovers long enough to display the mega-tooltip.

Each toolbar button can have its own AVGetTooltipProc(), or they can be shared.

See Also

AVMenuItemSetComputeEnabledProc
AVToolButtonSetComputeEnabledProc

File: AVExpT.h
Line: 1508
AVComputeVisibleProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVComputeVisibleProc)(void *data)

A callback that is used to determine whether a toolbar button, menu item, or HowTo panel is visible when its parent is opened. It is called before the item is displayed. If it returns true, the item is visible; otherwise it is not visible.

Each toolbar button, menu item, or HowTo panel can have its own visibility procedure, or they can be shared.

Because the procedure is called whenever the item is displayed, it should not do any resource-intensive computing.

See Also


File: AVExpT.h
Line: 1473
AVContextMenuAdditionProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVContextMenuAdditionProc)(ASAtom menuName, AVMenu menu, void *menuData, void *clientData)

Called after a context menu has been created but before it is shown to the user. The callback can add menu items to or remove menu items from the menu. The client must register the callback using AVAppRegisterForContextMenuAddition().

This callback should not raise an error.

See Also


File: AVExpT.h
Line: 1319
AVCustomNotificationProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVCustomNotificationProc)(AVNotificationData data, void *clientData)

File: AVExpT.h
Line: 10502
AVExecuteProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVExecuteProc)(void *data)

A callback that is called whenever a menu item or toolbar button is executed. It implements whatever the menu item or toolbar button does (for example, opening a file or initiating a search).

This method may also be called from an external application displaying a PDF file in its window, using the ExternalDocServerCreationData structure.

See Also

AVMenuItemSetExecuteProc
AVToolButtonSetExecuteProc

File: AVExpT.h
Line: 1407
AVIconHandlerGetFlagsProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVFlagBits32 (*AVIconHandlerGetFlagsProc)(AVIconBundle6 bundle)

A callback for AVIconHandler. It returns the flags value for the icon.

See Also


File: AVExpT.h
Line: 599
AVIconHandlerMeasureProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVIconHandlerMeasureProc)(AVIconBundle6 bundle, ASInt32 *w, ASInt32 *h)

A callback for AVIconHandler that retrieves the measurements of the icon. All icons in the bundle are assumed to be the same size.

See Also


File: AVExpT.h
Line: 571
AVIconHandlerOpenStmProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASStm (*AVIconHandlerOpenStmProc)(AVIconBundle6 bundle, AVIconColorFormat colorFormat)

A callback for AVIconHandler. It opens a stream so that a drawing function can read the data contained in the icon set.

See Also


File: AVExpT.h
Line: 586
AVIconHandlerReleaseProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVIconHandlerReleaseProc)(AVIconBundle6 bundle)

A callback for AVIconHandler. It releases the icon object.

See Also


File: AVExpT.h
Line: 609
AVIconHandlerResizeProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVIcon (*AVIconHandlerResizeProc)(const AVIconBundle6 bundle, ASInt32 width, ASInt32 height)

A callback for AVIconHandler. Creates a new icon with resized dimensions.

See Also


File: AVExpT.h
Line: 622
AVIdleProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVIdleProc)(void *clientData)

A callback that is called periodically when the Acrobat viewer is otherwise idle.

See Also


File: AVExpT.h
Line: 4190
AVNotifyTooltipProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVNotifyTooltipProc)(void *data)

A callback that is called whenever the mouse hovers long enough to display the tooltip text. It returns text that is displayed in the tooltip.

Each toolbar button can have its own tooltip procedure, or they can be shared.

See Also

AVToolButtonSetNotifyTooltipProc

File: AVExpT.h
Line: 1522
AVOpenSaveDialogSettingsComputeEnabledProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVOpenSaveDialogSettingsComputeEnabledProc)(AVFileFilterRec *currentFilter, void *data)

A client can provide this optional callback if you wish to control whether the settings button in the open or save dialog box is enabled or disabled. If you do not provide this callback function, then the state of the settings button, enabled or disabled, will be determined by whether the conversion handler has a settings proc.

See Also


File: AVExpT.h
Line: 7730
AVOpenSaveDialogSettingsExecuteProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVOpenSaveDialogSettingsExecuteProc)(AVFileFilterRec *currentFilter, void *data)

A client provides this optional callback to decide what action is taken when the user clicks on the settings button. The function is called back with the currently selected filter.

See Also


File: AVExpT.h
Line: 7745
AVSelectionEnumProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVSelectionEnumProc)(AVDoc doc, void *clientData, void *aSelectedObject)

A user-supplied callback that is passed in the call to AVDocEnumSelection. It is called once for each 'item' in the selection.

AVDocEnumSelection() calls the AVDocSelectionEnumSelectionProc() for the current selection's server to actually enumerate the selection.

See Also


File: AVExpT.h
Line: 1563
AVSelectionPageRangeEnumProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVSelectionPageRangeEnumProc)(AVDoc doc, void *clientData, PDPageNumber firstPage, PDPageNumber lastPage)

A user-supplied callback that is passed in the call to AVDocSelectionEnumPageRanges(). It is called once for each page in the selection, and consecutive pages are grouped into a single page range.

See Also


File: AVExpT.h
Line: 1585
AVSetFocusProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVSetFocusProc)(void *clientData)

Callback in ExternalDocServerCreationData to return focus to the browser displaying the document.


File: AVExpT.h
Line: 2730
AVSetMessageProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVSetMessageProc)(char *msg, void *clientData)

(Unused) Callback in ExternalDocServerCreationData for opening PDF files in external windows.

See Also


File: AVExpT.h
Line: 2723
AVSimpleSelDataDestroyProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVSimpleSelDataDestroyProc)(AVSimpleSelObj selObj)

File: AVExpT.h
Line: 9743
AVSimpleSelDeHiliteProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVSimpleSelDeHiliteProc)(AVSimpleSelObj selObj, AVDoc doc)

File: AVExpT.h
Line: 9741
AVSimpleSelHiliteProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVSimpleSelHiliteProc)(AVSimpleSelObj selObj, AVDoc doc)

File: AVExpT.h
Line: 9739
AVTextCopyProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVTextCopyProc)(ASAtom format, void *buf, AVTBufferSize bufLen, void *clientData)

A callback for AVDocGetPageText(). Text is passed to it in the specified format.

See Also


File: AVExpT.h
Line: 1249
AVTransHandlerCompleteTransDictProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVTransHandlerCompleteTransDictProc)(AVTransHandler avth, const char *name, CosObj transDict)

A callback for AVTransHandler. This method is called after the user has selected a distinct transition. The transition handler must fill in any dictionary items necessary to create the effect specified by the uiName passed in. For example, if the Wipe transition handler is passed a uiName of "Wipe Left", it would set the Dir key in transDict to the value 180.

AVTransHandlerCompleteTransDictProc() should fill in standard information like direction, dimension, motion, and so forth (information gathered entirely from the user interface name). Other specific information should be filled in by AVTransHandlerDoPropertiesProc.

See Also


File: AVExpT.h
Line: 7363
AVTransHandlerDoPropertiesProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVTransHandlerDoPropertiesProc)(AVTransHandler avth, const char *name, PDTrans trans)

A callback for AVTransHandler. This method is called when the user clicks the button in the transition settings dialog box. This allows the transition to bring up its own custom dialog box allowing the user to further specify the desired transition effect.

Once the user selects a transition effect from the popup menu, the viewer immediately creates a transition (using PDTransNewFromCosDoc() or PDTransNew()), and calls AVTransHandlerInitTransDictProc() and AVTransHandlerCompleteTransDictProc(). If the handler provides both an AVTransHandlerDoPropertiesProc() and AVTransHandlerGetButtonTextProc() callbacks, the dialog box displays a button. When the user clicks on the button, the viewer calls the handler's AVTransHandlerDoPropertiesProc() callback. DoProperties is responsible for making any needed alterations to the transition; InitTransDict and CompleteTransDict are not called after DoProperties.

After the user clicks OK in the dialog box, trans is filled in using the supplied data.

See Also


File: AVExpT.h
Line: 7392
AVTransHandlerEnumProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVTransHandlerEnumProc)(AVTransHandler avth, void *vClientData)

A callback for AVAppEnumTransHandlers. It is called once for each transition handler.

See Also


File: AVExpT.h
Line: 7524
AVTransHandlerExecuteProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVTransHandlerExecuteProc)(AVTransHandler avth, PDTrans trans, AVTransitionPort srcTP, AVTransitionPort dstTP, ASFixed duration)

A callback for AVTransHandler. It executes the specified transition. The transition handler is responsible for copying the pixels specified by srcTP to the location specified by dstTP. In the process, the handler can create any visual effect you desire, as long as the source pixels are eventually copied over the destination pixels in the end.

The handler should, if possible, execute the visual effect in the number of seconds specified by duration.

The implementation will ensure that the source and destination rectangles are the same size, though their corners may not coincide.


File: AVExpT.h
Line: 7174
AVTransHandlerGetBiDirEnabledProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVTransHandlerGetBiDirEnabledProc)(void)

A callback for AVTransHandler.

A transition has different variations but the same type of action. For example, the Wipe transition handler can create four distinct effects: wipe left, wipe right, wipe up, and wipe down.

For some of these effects, there is an opposite effect. For example, Push Left is the opposite of Push Right.

When the application is building the user interface, the dialog box will call GetBiDirEnabled() to check if the transition type's effects have an opposite effect.


File: AVExpT.h
Line: 7288
AVTransHandlerGetButtonTextProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 (*AVTransHandlerGetButtonTextProc)(AVTransHandler avth, char *buffer, ASInt32 bufLen)

A callback for AVTransHandler. It gets a localized string that appears in the button on the transition settings dialog box. If AVTransHandlerGetButtonTextProc() is NULL or the string it returns is empty, no button will appear.

See Also


File: AVExpT.h
Line: 7417
AVTransHandlerGetInstructionsProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 (*AVTransHandlerGetInstructionsProc)(AVTransHandler avth, char *buffer, ASInt32 bufLen)

(Unused) A callback for AVTransHandler.

See Also


File: AVExpT.h
Line: 7403
AVTransHandlerGetItemDirectionUINameProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVTransHandlerGetItemDirectionUINameProc)(AVTransHandler avth, ASInt32 item, ASText buffer)

A callback for AVTransHandler.

A transition has different variations but the same type of action. For example, the Wipe transition handler can create four distinct effects: wipe left, wipe right, wipe up, and wipe down.

The transition setting dialog box should create a list of effects for each distinct transition. It will determine the variation according to the transition type (for example, left, right, up, down).

When the application is building the user interface, the dialog box will call GetItemDirectionUIName() repeatedly for the name of the effect.

See Also


File: AVExpT.h
Line: 7268
AVTransHandlerGetItemNameProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASAtom (*AVTransHandlerGetItemNameProc)(AVTransHandler avth, ASInt32 item)

Returns the canonical name for the item. It should return ASAtomNull if the item number is invalid. This was added in Acrobat 5.0 so that different transitions could be handled in a language-independent manner. If this call is not implemented, then it is acceptable to generate a synthetic name from the transition type and the item index. For example, the "Glitter" trans handler should return a canonical name such as "GlitterDown". If this call is not implemented, then the name will be the trans handler type "Glitter", plus a period, plus the item number (for example, "Glitter.0").


File: AVExpT.h
Line: 7315
AVTransHandlerGetItemUINameProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 (*AVTransHandlerGetItemUINameProc)(AVTransHandler avth, ASInt32 item, char *buffer, ASInt32 bufLen)

A callback for AVTransHandler.

A transition handler can handle several distinct transitions. For example, the Wipe transition handler can create four distinct effects: wipe left, wipe right, wipe up, and wipe down.

The transition setting dialog box should create a separate user interface entry for each distinct transition. It determines both the number and names of the distinct transition types by repeatedly calling each transition handler's AVTransHandlerGetItemUINameProc() callback, starting with an item number of 0 and increasing until AVTransHandlerGetItemUINameProc ()returns an empty string.

Thus, when the transaction handler is selected from the list, this callback is called. The transition handler should fill in the Type and S fields. AVTransHandlerGetItemUINameProc() should fill in any default values. This information is passed into the AVTransHandlerDoPropertiesProc() in the form of a PDTrans if that callback exists.

See Also


File: AVExpT.h
Line: 7245
AVTransHandlerGetNameProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASAtom (*AVTransHandlerGetNameProc)(AVTransHandler avth, PDTrans trans)

File: AVExpT.h
Line: 7319
AVTransHandlerGetSmoothActionEnabledProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVTransHandlerGetSmoothActionEnabledProc)(void)

A callback for AVTransHandler.

When a transition is being performed, the animation can slow down at the end of the transition.

When the application is building the user interface, the dialog box will call GetSmoothActionEnabled() to check if the transition type's effects have an opposite effect.


File: AVExpT.h
Line: 7303
AVTransHandlerGetStringOneTextProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 (*AVTransHandlerGetStringOneTextProc)(AVTransHandler avth, char *buffer, ASInt32 bufLen)

A callback for AVTransHandler. Gets a localized string that appears above the button on the transition settings dialog box.

See Also


File: AVExpT.h
Line: 7430
AVTransHandlerGetStringTwoTextProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 (*AVTransHandlerGetStringTwoTextProc)(AVTransHandler avth, char *buffer, ASInt32 bufLen)

A callback for AVTransHandler. It gets a localized string that appears below the button on the transition settings dialog box.

See Also


File: AVExpT.h
Line: 7443
AVTransHandlerGetTypeProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASAtom (*AVTransHandlerGetTypeProc)(AVTransHandler avth)

A callback for AVTransHandler. It gets the transition type serviced by this handler. The handler for a given transition is found by comparing the result of PDTransGetSubtype() to the value returned by the registered transition handler's AVTransHandlerGetTypeProc() callbacks.

See Also


File: AVExpT.h
Line: 7150
AVTransHandlerGetUINameProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 (*AVTransHandlerGetUINameProc)(AVTransHandler avth, PDTrans trans, char *buffer, ASInt32 bufLen)

A callback for AVTransHandler. It retrieves the user interface name for an existing PDTrans. For example, if the transition type is 'Wipe' and the direction is 180, AVTransHandlerGetUINameProc() would return "Wipe Left", localized.

A transition handler can handle several distinct transitions. For example, the "Wipe" transition handler can create four distinct effects: wipe left, wipe right, wipe up, and wipe down.

The transition setting dialog box creates a separate user interface entry for each distinct transition. It determines both the number and names of the distinct transition types by repeatedly calling each transition handler's AVTransHandlerGetUINameProc() callback, starting with an item number of 0 and increasing until the AVTransHandlerGetUINameProc() callback returns an empty string.

The string returned by AVTransHandlerGetUINameProc() should be localized.

The AVTransHandlerGetUINameProc() is used to enumerate the entire list of supported transition effects that the handler wishes to display in the popup menu. For example, "Wipe Left" for item == 0, "Wipe Right" for item == 1, and so on).

See Also


File: AVExpT.h
Line: 7212
AVTransHandlerInitTransDictProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVTransHandlerInitTransDictProc)(AVTransHandler avth, CosObj transDict)

A callback for AVTransHandler. This method should set default values in the transition dictionary, transDict.

As soon as the handler is selected from the list, AVTransHandlerInitTransDictProc() is called. This function should fill in the Type and S fields of transDict. AVTransHandlerInitTransDictProc() should also fill in any default values. This information is passed to AVTransHandlerDoPropertiesProc() in the form of a PDTrans if AVTransHandlerDoPropertiesProc() exists.

Normally the Type and S fields are filled in when the transition is created via PDTransNewFromCosDoc(). The implementation then calls AVTransHandlerInitTransDictProc() and AVTransHandlerCompleteTransDictProc() immediately on the newly created PDTrans.

See Also


File: AVExpT.h
Line: 7342
CrossDocLinkProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVDoc (*CrossDocLinkProc)(ASPathName path, ASFileSys fileSys, AVDocViewDef viewDef, AVDoc srcDoc, void *data)

A callback in ExternalDocServerCreationData. It is called when a cross-document link is clicked in an AVDoc in an external application's window.

See Also


File: AVExpT.h
Line: 2711
CrossDocLinkWithDestProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVDoc (*CrossDocLinkWithDestProc)(ASPathName path, ASFileSys fileSys, AVDocViewDef viewDef, AVDestInfo destInfo, AVDoc srcDoc, void *data)

A callback in ExternalDocServerCreationData. It is called when a cross-document link is clicked in an AVDoc in an external application's window.

See Also


File: AVExpT.h
Line: 2755
DoClickProcType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax


A callback for AVTool. It handles mouse clicks when the tool is active. For Mac OS, this handles button or option-button mouse clicks. For Windows, this handles right or left button mouse clicks.

See Also


File: AVExpT.h
Line: 4496
DoKeyDownProcType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DoKeyDownProcType)(AVTool tool, AVKeyCode key, AVFlagBits16 flags)

A callback for AVTool. It handles key presses when the tool is active.

See Also


File: AVExpT.h
Line: 4535
DoLeaveProcType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DoLeaveProcType)(AVTool tool, AVPageView pageView)

A callback for AVTool. It is called when the tool leaves the page view (when the cursor is moved out of the page view).


File: AVExpT.h
Line: 4570
ExternalFilePermissionProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*ExternalFilePermissionProc)(CosDoc dP, ASFileSys *fileSys, ASPathName *path)

File: PDFLExpT.h
Line: 90
GetSelectionServerProcType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVDocSelectionServer (*GetSelectionServerProcType)(AVTool tool, AVDoc doc)

A callback for AVTool. It gets the selection server associated with the tool, if any.


File: AVExpT.h
Line: 4580
GetTypeProcType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASAtom (*GetTypeProcType)(AVTool tool)

A callback for AVTool. It returns the tool's name.

See Also


File: AVExpT.h
Line: 4543
HandleMouseWheelScrollProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*HandleMouseWheelScrollProc)(AVTool tool, AVPageView pageView, AVToolMouseWheelDirection direction, AVTCount numLines, AVFlagBits16 flags)

A callback for AVTool. Handles mouse wheel scroll events when the tool is active.


File: AVExpT.h
Line: 4649
IsPersistentProcType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*IsPersistentProcType)(AVTool tool)

A callback for AVTool. It indicates whether the tool should stay active after it has been used or is a one-shot tool.

The Acrobat viewer does not contain any code to enforce a tool's request to be persistent; it is up to each tool to be a good citizen. For example, if a tool is not persistent, after that tool is used once it should get the previously active tool (using AVAppGetLastActiveTool()) and check whether that tool should be persistent (using AVToolIsPersistent()). If so, set the active tool to that tool. If not, set the active tool to the default tool (obtained using AVAppGetDefaultTool()).

See Also


File: AVExpT.h
Line: 4562
PDFindTranslateStringProc 
Product availability: All
Platform availability: All

Syntax

ASBool (*PDFindTranslateStringProc)(char *string, ASInt32 stringLength, PDWord pdWord, void *clientData)

PDFindTranslateStringProc() is passed to PDFindText().


File: PDExpT.h
Line: 3331
PluginExecProc 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*PluginExecProc)(void *)

File: AVExpT.h
Line: 10487

Method Detail
ACROASSERT()
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ACROASSERT(gAcroViewVersion>= level)

Parameters

level

Returns

File: AVCalls.h
Line: 282
AVAcquireSpecialFilePathName() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 AVAcquireSpecialFilePathName(AVSpecialCategory cat, AVSpecialFolder fld, const char* cFile, ASFileSys* asfs, ASPathName* asp)

In Acrobat 6.0, this method is superseded by AVAcquireSpecialFilePathNameWithASText().

Obtains the path name for a file in a special folder. It is the caller's responsibility to release the ASPathName. This method may be used even if the associated file does not exist.

Parameters

cat — 

The folder category. See AVSpecialCategory. Only certain combinations of category/folder are allowed - see AVSpecialError.

 
fld — 

The folder in which the file is located. See AVSpecialFolder. Only certain combinations of category/folder are allowed. See AVSpecialError.

 
cFile — 

The name of the file (including extension) that you want to access.

 
asfs — 

OUT The file system through which the path name was obtained.

 
asp — 

OUT An ASPathName associated with the file. The caller must release it.

Returns

One of the AVSpecialError status codes. The asfs and asp variables will only be valid if the method returns kAVSEOkay or kAVSEDoesntExist. kAVSEDoesntExist is returned if the ASPathName was created but the associated file does not exist.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h
Line: 5305
AVAcquireSpecialFilePathNameWithASText() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASErrorCode AVAcquireSpecialFilePathNameWithASText(AVSpecialCategory cat, AVSpecialFolder fld, const ASText fileName, ASFileSys* asfs, ASPathName* asp)

Obtains the path name for a file in a special folder. It is the caller's responsibility to release the ASPathName. This method may be used even if the associated file does not exist.

Parameters

cat — 

The folder category. See AVSpecialCategory. Only certain combinations of category/folder are allowed; see AVSpecialError.

 
fld — 

The folder in which the file is located. See AVSpecialFolder. Only certain combinations of category/folder are allowed; see AVSpecialError.

 
fileName — 

A text object containing the name of the file (including the extension) that you want to access.

 
asfs — 

OUT The file system through which the path name was obtained.

 
asp — 

OUT The ASPathName associated with the file. The caller must release it.

Returns

One of the AVSpecialError status codes. The asfs and asp variables will only be valid if the method returns kAVSEOkay or kAVSEDoesntExist. kAVSEDoesntExist is returned if the ASPathName was created but the associated file does not exist.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8417
AVAcquireSpecialFolderPathName() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASErrorCode AVAcquireSpecialFolderPathName(AVSpecialCategory cat, AVSpecialFolder fld, ASBool bCreate, ASFileSys* asfs, ASPathName* asp)

Obtains the path name of a special folder. This method cannot be used to obtain the ASPathName of a folder that does not exist. It is the caller's responsibility to release the ASPathName.

Parameters

cat — 

The folder category. See AVSpecialCategory. Only certain combinations of category/folder are allowed. See AVSpecialError.

 
fld — 

The folder. See AVSpecialFolder. Only certain combinations of category/folder are allowed. See AVSpecialError.

 
bCreate — 

Create the folder if it does not exist.

 
asfs — 

(Filled by the method) The file system through which the path name was obtained.

 
asp — 

(Filled by the method) An ASPathName associated with the folder.

Returns

One of the AVSpecialError status codes. It returns kAVSEOkay if the method executed without error. The asfs and asp variables will only be valid if the method returns kAVSEOkay. If bCreate is false and the folder does not exist, kAVSEError is returned on Windows, while kAVSEDoesntExist is returned on Mac OS.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h
Line: 5271
AVDestInfoDestroy() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVDestInfoDestroy(AVDestInfo destInfo)

Releases the memory associated with a destination.

Parameters

destInfo — 

IN/OUT The destination information object to destroy.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020003

File: AVProcs.h
Line: 3924
AVExtensionAcquireInfo() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVExtensionInfo AVExtensionAcquireInfo(AVArraySize nIndex)

Fills an AVExtensionInfoRec structure with some information about a client. It is the caller's responsibility to release the memory associated with the contents of the returned structure by calling AVExtensionReleaseInfo().

Parameters

nIndex — 

The index of the client for which to retrieve information. The minimum value for index is zero; the maximum is the return value of AVExtensionGetNumPlugIns() - 1.

Returns

The structure containing information about the client.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h
Line: 5877
AVExtensionAcquireInfoEx() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVExtensionInfoEx AVExtensionAcquireInfoEx(AVArraySize nIndex)

Fills an AVExtensionInfoRecEx structure with some information about a client. It extends the AVExtensionInfoRec API which does not support new versioning scheme. Similar to AVExtensionAcquireInfo, it is the caller's responsibility to release the memory associated with the contents of the returned structure by calling AVExtensionReleaseInfoEx().

Parameters

nIndex — 

The index of the client for which to retrieve information. The minimum value for index is zero; the maximum is the return value of AVExtensionGetNumPlugIns() - 1.

Returns

The structure containing information about the client.

See Also

Since

PI_ACROVIEW_VERSION >= 0x000C0003

File: AVProcs.h
Line: 10314
AVExtensionGetNumPlugIns() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVArraySize AVExtensionGetNumPlugIns()

Returns the number of clients loaded by Acrobat.

Returns

The number of clients.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h
Line: 5861
AVExtensionReleaseInfo() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVExtensionReleaseInfo(AVExtensionInfo info)

Releases the memory associated with the contents of info.

Parameters

info — 

The AVExtensionInfoRec structure to release.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h
Line: 5888
AVExtensionReleaseInfoEx() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVExtensionReleaseInfoEx(AVExtensionInfoEx info)

Releases the memory associated with the contents of info.

Parameters

info — 

The AVExtensionInfoRecEx structure to release.

See Also

Since

PI_ACROVIEW_VERSION >= 0x000C0003

File: AVProcs.h
Line: 10324
AVGetOptimizerParamsForPreset() 
Product availability: Acrobat
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool AVGetOptimizerParamsForPreset(ASText presetName, AVDoc avDoc, PDFOptParams pdfOptParams)

This method can be used to obtain a PDFOptParamsRec structure populated with the values corresponding to a PDF Optimizer preset.

The values of certain members of the preset may be dependent on the PDF file that needs to be optimized. This is true when:

In the second parameter, the caller should specify the AVDoc to get values relevant to a particular file.

If avDoc is specified as NULL, the values populated in pdfOptParams are those that are actually stored in the preset. These may or may not be valid for all PDFs. The list of fonts to be unembedded will always be a NULL value in this case.

If the flattening of transparency is off in the preset, pdfOptFlattenTransparencyOptions is also set to a NULL value.

The method assigns NULL values to asPathDest and fileSys members of PDFOptParamsRec.

It is the caller's responsibility to free the arrPDFontsToUnembed and pdfOptFlattenTransparencyOptions members using ASfree().

The progMon and progMonClientData members are populated with the standard application progress monitor, which is the same as the one returned by the AVAppGetDocProgressMonitor() proc.

It is the caller's responsibilty to ensure that a preset of the specified name is available to the Acrobat user, either as a shipped or a user-created preset. A useful check could be to ensure that the specified preset name is among the names returned by the AVGetOptimizerPresets() method.

Parameters

presetName — 

The preset for which a populated PDFOptParamsRec is desired.

 
avDoc — 

(filled by the method) A pointer to PDFOptParamsRec.

 
pdfOptParams

Returns

true if successful. It returns false if the specified preset name is invalid.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00080000

File: AVProcs.h
Line: 9761
AVGetOptimizerPresets() 
Product availability: Acrobat
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 AVGetOptimizerPresets(ASText** pPresetNames)

This method fills the parameter with names of all PDF Optimizer presets that are available to the caller.

Parameters

pPresetNames — 

The array that will be allocated and populated by the method. The caller should free each member of the array using ASTextDestroy(), and then free the array using ASfree().

Returns

The number of preset names populated.

Since

PI_ACROVIEW_VERSION >= 0x00080000

File: AVProcs.h
Line: 9712
AVIconCreateFromPDF() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVIcon AVIconCreateFromPDF(PDDoc pdDoc, ASInt32 pageNum, ASInt32 width, ASInt32 height)

Creates dynamically scalable icon from PDF.

Parameters

pdDoc — 

PDDoc object from which icon should be created.

 
pageNum — 

Page number of PDF which should be used to create icon.

 
width — 

Default width of icon.

 
height — 

Default height of icon.

Returns

Since

PI_ACROVIEW_VERSION >= 0x000C0003

File: AVProcs.h
Line: 10360
AVIdentityGetText() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASText AVIdentityGetText(AVIdentity it, ASText ast)

Gets the value of a particular aspect of the active user's identity. Valid keys are login name, name, corporation and email.

Parameters

it — 

IN/OUT The AVIdentity key to retrieve.

 
ast — 

IN/OUT (Filled by the method) An ASText object to hold the text associated with the identity key.

Returns

A useful handle to the text parameter.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h
Line: 5432
AVIdentitySetText() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVIdentitySetText(AVIdentity it, ASText ast)

Sets the value of a particular aspect of the active user's identity.

It is not possible to modify the kAVILoginName value through this method.

Parameters

it — 

IN/OUT The AVIdentity key to set.

 
ast — 

IN/OUT The new value for the key.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h
Line: 5445
AVLegacyToolBarAddButton() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolBarAddButton(AVToolBar toolBar, AVToolButton button, ASBool before, AVToolButton otherButton)

Inserts a button into a toolbar. Call AVLegacyToolBarUpdateButtonStates() after adding a button to update the toolbar.

Parameters

toolBar — 

The toolbar into which a button is added.

 
button — 

The button to add to the toolbar.

 
before — 

If true, button is added before otherButton; if false, it is added after. If otherButton is NULL and before is true, the button is added to the beginning of the toolbar. If otherButton is NULL and before is false, the button is added to the end of the toolbar.

 
otherButton — 

A button relative to which the new button is added.

See Also

Exceptions

genErrNoMemory

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2618
AVLegacyToolBarAddButtonEx() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolBarAddButtonEx(AVToolBar toolBar, AVToolButton button, AVToolBarAddButtonParams params)

Inserts a button into a toolbar.

Parameters

toolBar — 

The toolbar into which the button is added.

 
button — 

The button to add to the toolbar.

 
params — 

A pointer to an AVToolBarAddButtonParamsRec, describing how the button should be added to the toolbar.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00090000

File: AVProcs.h
Line: 9902
AVLegacyToolBarEnumButtons() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolBarEnumButtons(AVToolBar toolBar, AVToolButtonEnumProc enumProc, void* clientData)

Calls enumProc once for each toolbar button in the specified toolbar.

If a tool button has a flyout, this is a separate toolbar from the toolbar returned by AVAppGetLegacyToolBar(); enumerating the toolbar buttons on this main toolbar does not enumerate the toolbar buttons on any flyout. To enumerate the toolbar buttons on a button's flyout, call AVLegacyToolButtonGetFlyout() to get its associated toolbar, then call AVLegacyToolBarEnumButtons() with this toolbar.

Parameters

toolBar — 

IN/OUT The toolbar whose buttons are enumerated.

 
enumProc — 

IN/OUT A user-supplied procedure to call once for each button. The enumeration ends if enumProc returns false.

 
clientData — 

IN/OUT A pointer to user-supplied data to pass to enumProc each time it is called.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2598
AVLegacyToolBarGetButtonByName() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVToolButton AVLegacyToolBarGetButtonByName(AVToolBar toolBar, ASAtom buttonName)

Gets the toolbar button that has the specified name.

Parameters

toolBar — 

The toolbar in which the button is located.

 
buttonName — 

The ASAtom for the button to get. The character string representing buttonName can be converted to an ASAtom using ASAtomFromString(). See Toolbar and Toolbar Button Names for a list of the names of the built-in buttons.

Returns

The button with the specified name; if the name is not found, the return value is NULL.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2566
AVLegacyToolBarGetNumButtons() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVTArraySize AVLegacyToolBarGetNumButtons(AVToolBar toolBar)

Gets the number of buttons in toolbar.

Parameters

toolBar — 

IN/OUT The toolbar whose button count is obtained.

Returns

The number of buttons in toolBar.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2629
AVLegacyToolBarIsRoomFor() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool AVLegacyToolBarIsRoomFor(AVToolBar toolBar, AVTCount nButtons, AVTCount nSeparators)

Tests whether there is room in a toolbar for an additional specified number of buttons and separators.

On Windows, this method assumes the application window has been maximized.

Parameters

toolBar — 

The toolbar to check.

 
nButtons — 

The number of buttons.

 
nSeparators — 

The number of separators.

Returns

true if there is room in toolBar to add nButtons and nSeparators, false otherwise.

See Also

AVAppGetLegacyToolBar
AVLegacyToolBarGetFrame
AVLegacyToolBarGetNumbuttons
AVLegacyToolButtonGetFlyout
AVLegacyToolButtonNew

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2649
AVLegacyToolBarNew() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVToolBar AVLegacyToolBarNew(const char* name, const char* title)

Creates a new named toolbar. AVAppRegisterToolBarPosition() must be called after creating the new toolbar to position it relative to other toolbars.

Parameters

name — 

IN/OUT The internal, language-independent name of the toolbar. It may not be NULL.

 
title — 

IN/OUT The localized, user-friendly name of the toolbar. It may not be NULL.

Returns

The new AVToolBar.

See Also

AVLegacyToolBarGetFrame
AVLegacyToolBarGetNumbuttons
AVLegacyToolButtonGetFlyout
AVLegacyToolButtonNew

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h
Line: 5511
AVLegacyToolBarNewFlyout() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVToolBar AVLegacyToolBarNewFlyout()

Creates a new sub-toolbar for use as a toolbar button flyout.

Flyouts are established by creating a new toolbar with AVLegacyToolBarNewFlyout(), appending toolbar buttons to the new toolbar using AVToolBar calls, and attaching that toolbar to a tool button, known as the anchor button, with AVLegacyToolButtonSetFlyout().

This method creates a distinct toolbar from the toolbar returned by AVAppGetLegacyToolBar().

Returns

The newly created toolbar to use for a flyout.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h
Line: 4167
AVLegacyToolBarNewWithASText() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVToolBar AVLegacyToolBarNewWithASText(const char* name, ASConstText title)

Creates a new named toolbar. AVAppRegisterToolBarPosition() must be called after creating the new toolbar to position it relative to other toolbars.

Parameters

name — 

IN/OUT The internal, language-independent name of the toolbar. It may not be NULL.

 
title — 

IN/OUT The localized, user-friendly name of the toolbar. It may not be NULL.

Returns

The new AVToolBar.

See Also

AVLegacyToolBarGetFrame
AVLegacyToolBarGetNumbuttons
AVLegacyToolButtonGetFlyout
AVLegacyToolButtonNew

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h
Line: 10039
AVLegacyToolBarUpdateButtonStates() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolBarUpdateButtonStates(AVToolBar toolbar)

Forces a redraw of toolbar. Call this method when a toolbar button is added or removed, or one of the buttons changes state.

Parameters

toolbar — 

IN/OUT The toolbar to redraw.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2662
AVLegacyToolButtonAddAnimationIcon() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonAddAnimationIcon(AVToolButton button, AVIcon newIcon)

Adds the specified AVIcon to the AVToolbutton object's animation list.

Parameters

button — 

An AVToolbutton to which newIcon will be added.

 
newIcon — 

An icon that is added to the animation list for button.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8021
AVLegacyToolButtonDestroy() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonDestroy(AVToolButton toolButton)

Removes the specified button from the toolbar and destroys the button. Call AVLegacyToolBarUpdateButtonStates() after removing a button to update the toolbar.

Parameters

toolButton — 

IN/OUT The button to destroy.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2703
AVLegacyToolButtonExecute() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonExecute(AVToolButton button)

Executes the AVExecuteProc() associated with button, if it exists. This AVExecuteProc() is set by AVLegacyToolButtonSetExecuteProc(). It does nothing if AVLegacyToolButtonIsEnabled() for the button returns false.

Parameters

button — 

IN/OUT The button whose execute proc is executed.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2752
AVLegacyToolButtonGetAnimationIconCount() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 AVLegacyToolButtonGetAnimationIconCount(AVToolButton button)

Returns the count of animation icons associated with this tool button.

Parameters

button — 

An AVToolbutton whose item count is returned.

Returns

An ASInt32 representing the number of icons associated with this tool button.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8036
AVLegacyToolButtonGetAnimationPeriod() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 AVLegacyToolButtonGetAnimationPeriod(AVToolButton button)

Gets the period in seconds of how often to flip the tool button animation icons.

Parameters

button — 

An AVToolbutton whose animation period list is being examined.

Returns

An ASInt32 representing the period in seconds for this tool button.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8109
AVLegacyToolButtonGetFlyout() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVToolBar AVLegacyToolButtonGetFlyout(AVToolButton button)

Gets the flyout attached to a toolbar button. A flyout is a sub-toolbar attached to a toolbar button.

This method gets a different toolbar from the toolbar returned by AVAppGetLegacyToolBar().

Parameters

button — 

The toolbar button whose flyout is obtained.

Returns

The flyout associated with button. It returns NULL if there is no flyout associated with button.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h
Line: 4200
AVLegacyToolButtonGetIcon() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVIcon AVLegacyToolButtonGetIcon(AVToolButton button)

Gets the icon associated with the specified AVToolButton.

Parameters

button — 

The button whose icon is obtained.

Returns

The icon associated with button.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h
Line: 4258
AVLegacyToolButtonGetLabelText() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool AVLegacyToolButtonGetLabelText(AVToolButton button, ASText resultText, AVToolButtonLabelPriority* priority)

Gets the label text associated with the specified AVToolButton and its priority value. The priority determines the preference order in which labels are shown when a toolbar is too short to hold all of the button labels. If the priority is less than kAVButtonPriorityOnExtraLow, the label text is not shown at all unless the user forces all labels to be shown using the General preferences panel.

Parameters

button — 

The button whose label text is obtained.

 
resultText — 

(Filled by the method) The label text.

 
priority — 

(Filled by the method) The label text's priority value.

Returns

true if the label text string and priority are successfully obtained, false otherwise.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8959
AVLegacyToolButtonGetMenu() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVMenu AVLegacyToolButtonGetMenu(AVToolButton button)

Gets the menu attached to a toolbar button.

Parameters

button — 

IN/OUT The toolbar button to which a menu is attached.

Returns

The menu attached to button.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h
Line: 4229
AVLegacyToolButtonGetName() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASAtom AVLegacyToolButtonGetName(AVToolButton button)

Gets the ASAtom corresponding to the name of the specified toolbar button.

Parameters

button — 

The toolbar button whose name is obtained.

Returns

The ASAtom corresponding to the toolbar button's name. ASAtom can be converted to a character string using ASAtomGetString(). See Toolbar and Toolbar Button Names for a list of the built-in button names.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2738
AVLegacyToolButtonIsAnimationRunning() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool AVLegacyToolButtonIsAnimationRunning(AVToolButton button)

Indicates whether the tool button animation list is flipping.

Parameters

button — 

The AVToolbutton whose animation list may be flipping.

Returns

An ASBool indicating whether the button is flipping icons.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8079
AVLegacyToolButtonIsEnabled() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool AVLegacyToolButtonIsEnabled(AVToolButton button)

Tests whether a toolbar button is enabled.

Parameters

button — 

The button to test.

Returns

true if the button's AVComputeEnabledProc() returns true, false otherwise.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2814
AVLegacyToolButtonIsMarked() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool AVLegacyToolButtonIsMarked(AVToolButton button)

Tests whether the specified button is marked.

Parameters

button — 

The button to test.

Returns

true if the button's AVComputeMarkedProc() returns true, false if button is not marked or does not have an AVComputeMarkedProc().

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2825
AVLegacyToolButtonIsSeparator() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool AVLegacyToolButtonIsSeparator(AVToolButton button)

Tests whether a toolbar button is a separator or a normal button.

Parameters

button — 

IN/OUT The button to test.

Returns

true if the button is a separator, false otherwise.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2723
AVLegacyToolButtonNew() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVToolButton AVLegacyToolButtonNew(ASAtom name, AVIcon icon, ASBool longOnly, ASBool isSeparator)

Creates a toolbar button with the specified name, icon and long-menus state. It can also be used to create a separator with the specified name.

Parameters

name — 

The ASAtom corresponding to the button's name. The character string for name can be converted to an ASAtom using ASAtomFromString().

 
icon — 

The icon to use for this button. On Windows, icon is an 18x18 icon with a light gray background (that is, RGB values of 192,192,192).

 
longOnly — 

(Ignored in Acrobat 3.0 or later) If true, the button is shown only when the user selects Full Menus in the Acrobat viewer. If false, it is shown in both Full menu and Short menu modes.

 
isSeparator — 

If true, the new button is a separator used to leave space between groups of related buttons. For separators, icon, the button's AVExecuteProc(), AVComputeEnabledProc(), and AVComputeMarkedProc() are ignored. In addition, separators are not clickable. If false, the button is a normal toolbar button.

Returns

The newly created button.

See Also

Exceptions

genErrNoMemory

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2693
AVLegacyToolButtonRemove() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonRemove(AVToolButton button)

Removes the specified button from the toolbar, but does not destroy the button. Call AVLegacyToolBarUpdateButtonStates() after removing a button to update the toolbar.

Parameters

button — 

IN/OUT The button to remove.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2713
AVLegacyToolButtonRemoveAnimationIcons() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonRemoveAnimationIcons(AVToolButton button)

Removes all icons from the tool button animation list.

Parameters

button — 

An AVToolbutton that will have its animation icon list cleared.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8123
AVLegacyToolButtonSetAnimationPeriod() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetAnimationPeriod(AVToolButton button, ASInt32 newPeriod)

Sets the period in seconds of how often to flip the tool button animation icons.

Parameters

button — 

An AVToolbutton whose animation period list is being modified.

 
newPeriod — 

An ASInt32 period in seconds for this tool button.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8094
AVLegacyToolButtonSetComputeEnabledProc() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetComputeEnabledProc(AVToolButton button, AVComputeEnabledProc proc, void* clientData)

Sets the AVComputeEnabledProc() associated with a toolbar button. This routine determines whether the button can be selected.

Parameters

button — 

The button whose AVComputeEnabledProc() is set.

 
proc — 

A user-supplied procedure to call whenever the Acrobat viewer needs to know whether button should be enabled.

 
clientData — 

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

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2785
AVLegacyToolButtonSetComputeMarkedProc() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetComputeMarkedProc(AVToolButton button, AVComputeMarkedProc proc, void* clientData)

Sets the AVComputeMarkedProc() associated with a toolbar button. A marked button appears pressed on the screen.

Parameters

button — 

The button whose AVComputeMarkedProc() is set.

 
proc — 

A user-supplied callback to call whenever the Acrobat viewer needs to know whether the specified toolbar button should be marked.

 
clientData — 

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

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2804
AVLegacyToolButtonSetComputeTooltipProc() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetComputeTooltipProc(AVToolButton button, AVComputeTooltipProc proc, void* clientData)

Sets the AVComputeTooltipProc() associated with a toolbar button. This routine determines the text displayed in the mega-tooltip.

Parameters

button — 

IN/OUT The button whose AVComputeTooltipProc() is set.

 
proc — 

IN/OUT A user-supplied procedure to call whenever the Acrobat viewer needs to know what mega-tooltip to display.

 
clientData — 

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

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8918
AVLegacyToolButtonSetComputeVisibleProc() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetComputeVisibleProc(AVToolButton button, AVComputeVisibleProc p, void* data)

Sets the AVComputeVisibleProc() associated with a toolbar button. This routine determines whether the button is visible when its parent toolbar is visible.

Parameters

button — 

The toolbar button whose visibility procedure is set.

 
p — 

A user-supplied procedure to call when the Acrobat viewer needs to know if the button is visible.

 
data — 

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

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 9247
AVLegacyToolButtonSetExecuteProc() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetExecuteProc(AVToolButton button, AVExecuteProc proc, void* clientData)

Sets the user-supplied procedure to call to actually perform the button's intended function.

Parameters

button — 

IN/OUT The button whose AVExecuteProc() is set.

 
proc — 

IN/OUT A user-supplied procedure to call when button is executed.

 
clientData — 

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

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 2768
AVLegacyToolButtonSetExternal() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetExternal(AVToolButton button, AVTFlagBits16 external)

Indicates that the specified toolbar button should be displayed in toolbars contained in external windows, such as in a web browser.

Parameters

button — 

The button.

 
external — 

Indicates whether to show the button in external windows. It must be one of Tool Button Flags.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h
Line: 3537
AVLegacyToolButtonSetFlyout() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetFlyout(AVToolButton button, AVToolBar flyout)

Attaches a sub-toolbar or flyout to a toolbar button. A copy of the button is attached to the front of the toolbar. A click-hold pops up the flyout and allow the user to select a different button.

Flyouts are established by creating a new toolbar with AVLegacyToolBarNewFlyout(), appending toolbar buttons to the new toolbar using AVToolBar calls, and attaching that toolbar to a tool button, known as the anchor button, with AVLegacyToolButtonSetFlyout().

Parameters

button — 

IN/OUT The toolbar button to attach to the flyout.

 
flyout — 

IN/OUT The flyout to which button is attached.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h
Line: 4185
AVLegacyToolButtonSetHelpText() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetHelpText(AVToolButton button, const char* text)

Sets the text to show in tooltips. This text is shown when the cursor is held over a toolbar button for a period of time.

In Acrobat 4.0 and later, toolbar buttons can also have single key shortcuts assigned to them. (Conceptually, tools have shortcuts but the shortcuts are attached to the buttons). This is done by appending a vertical bar character '|' followed by the shortcut to the button's tooltip text.

Appending the shortcut to the tooltip text allows it to localize at the same time as the tooltip text.

Parameters

button — 

The toolbar button to which a tooltip is added.

 
text — 

The text to show.


Example
How to use examples
Here is the tooltip text for the Hand tool: 'Hand Tool (H)|h' The trailing '|h' portion indicates that the Hand tool uses the 'H' key as the shortcut. This portion is stripped off before the tooltip is displayed. This behavior only applies to tooltips where the '|' is the second-to-last character.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h
Line: 3324
AVLegacyToolButtonSetHelpTextWithASText() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetHelpTextWithASText(AVToolButton button, ASConstText text)

Sets the text to show in tooltips. This text is shown when the cursor is held over a toolbar button for a period of time.

In Acrobat 4.0 and later, toolbar buttons can also have single key shortcuts assigned to them. (Conceptually, tools have shortcuts but the shortcuts are attached to the buttons). This is done by appending a vertical bar character '|' followed by the shortcut to the button's tooltip text.

Appending the shortcut to the tooltip text allows it to localize at the same time as the tooltip text.

Parameters

button — 

The toolbar button to which a tooltip is added.

 
text — 

The text to show.


Example
How to use examples
Here is the tooltip text for the Hand tool: 'Hand Tool (H)|h' The trailing '|h' portion indicates that the Hand tool uses the 'H' key as the shortcut. This portion is stripped off before the tooltip is displayed. This behavior only applies to tooltips where the '|' is the second-to-last character.

See Also

Since

PI_ACROVIEW_VERSION >= 0x000A0000

File: AVProcs.h
Line: 10022
AVLegacyToolButtonSetIcon() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetIcon(AVToolButton button, AVIcon icon)

Sets a new icon for a toolbar button.

A tool button's icon can change dynamically. This allows multi-state buttons, such as the one that opens and closes the splitter bar, to change appearance appropriately. This should allow multiple buttons to collapse into one.

Most other aspects of a tool button, such as its execute proc and tooltip text, can be changed on the fly using other AVToolButton methods.

Parameters

button — 

IN/OUT The toolbar button whose icon is set.

 
icon — 

IN/OUT The icon to place on button.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h
Line: 4248
AVLegacyToolButtonSetLabelText() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetLabelText(AVToolButton button, ASConstText labelText, AVToolButtonLabelPriority priority)

Sets the label text associated with the specified AVToolButton and its priority value. The priority determines the preference order in which labels are shown when a toolbar is too short to hold all of the button labels. If the priority is less than kAVButtonPriorityOnExtraLow, the label text is not shown at all unless the user forces all labels to be shown using the General preference panel.

Parameters

button — 

The button whose label text is obtained.

 
labelText — 

The label text.

 
priority — 

The label text's priority value.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8937
AVLegacyToolButtonSetMenu() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetMenu(AVToolButton button, AVMenu menu)

Attaches a menu to a toolbar button.

If a tool button has no execute proc, the menu pops up when the tool button is clicked. If the tool button does have an execute proc, the user must click and hold on the button for some time to display the menu. Simply clicking on the button invokes the button's execute proc as usual.

Parameters

button — 

IN/OUT The toolbar button to which a menu is attached.

 
menu — 

IN/OUT The menu to attach to button.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h
Line: 4218
AVLegacyToolButtonSetMenuIcon() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetMenuIcon(AVToolButton button, AVIcon icon)

Sets a new icon for a toolbar button to display in menus and other UI elements generated from the button that are too small to display the button's normal icon.

Toolbar buttons that do not have menu icons assigned to them via this API will have appropriately-sized icons generated for them based on the icon provided via AVLegacyToolButtonSetIcon. This may result in scaling or clipping artifacts.

Parameters

button — 

IN The toolbar button whose menu icon is set.

 
icon — 

IN The icon to assign as the button's menu icon.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00080000

File: AVProcs.h
Line: 9818
AVLegacyToolButtonSetNotifyTooltipProc() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonSetNotifyTooltipProc(AVToolButton button, AVNotifyTooltipProc proc, void* clientData)

Sets the AVNotifyTooltipProc() associated with a toolbar button. This routine is called before text is displayed in the tooltip.

Parameters

button — 

The toolbar button whose tooltip procedure is set.

 
proc — 

A user-supplied procedure to call when the Acrobat viewer needs to display tooltip text, as when the cursor moves over the button.

 
clientData — 

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

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 9022
AVLegacyToolButtonStartAnimation() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonStartAnimation(AVToolButton button)

Starts flipping icons for specified button.

Parameters

button — 

An AVToolbutton whose animation list will be started.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8050
AVLegacyToolButtonStopAnimation() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVLegacyToolButtonStopAnimation(AVToolButton button)

Stops flipping icons for specified button.

Parameters

button — 

An AVToolbutton whose animation list will be stopped.

See Also

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8064
AVROUTINE() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

*name AVROUTINE(newlev , name )

Parameters

 

Returns

File: AVCalls.h
Line: 1651
AVUtilGetBaseNameAndExtensionByPathName() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool AVUtilGetBaseNameAndExtensionByPathName(ASFileSys fileSys, ASPathName pathName, AVTArraySize numAddExt, const char*const * addExt, char** baseName, char** baseExt)

Parses a path name to obtain the base file name and extension for a particular file. The function enumerates all registered convertToPDF and convertFromPDF handlers to find a matching extension for the file passed in. This function allocates memory for the file name and extension. It is the caller's responsibility to free the memory allocated by the method.

Parameters

fileSys — 

The file system from which the path was obtained. Pass NULL to use the default file system.

 
pathName — 

The path containing the file name.

 
numAddExt — 

The number of additional extensions to search through.

 
addExt — 

An array of NULL-terminated strings with extensions to search through.

 
baseName — 

(Allocated and filled by the method) A buffer containing the file name. It can be NULL if you do not want the base file name.

 
baseExt — 

(Allocated and filled by the method) A buffer containing the file extension. It can be NULL if you do not want the base file extension.

Returns

true if the file info was successfully extracted from the path, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h
Line: 5383
AVUtilGetBaseNameAndExtensionByString() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool AVUtilGetBaseNameAndExtensionByString(char* fileName, AVTArraySize numAddExt, const char*const * addExt, char** baseName, char** baseExt)

Parses a file name string to obtain the base file name path and extension for a particular file. The function enumerates all registered convertToPDF and convertFromPDF handlers to find a matching extension for the file passed in. This function allocates memory for the file name and extension. It is the caller's responsibility to free the memory allocated by the method.

Parameters

fileName — 

The file name string to parse.

 
numAddExt — 

The number of additional extensions to search through.

 
addExt — 

An array of NULL-terminated strings with extensions to search through.

 
baseName — 

(Allocated and filled by the method) A buffer containing the file name path, which is the path without the extension (for example, c:\folder\file). It can be NULL if you do not want the base file name path.

 
baseExt — 

(Allocated and filled by the method) A buffer containing the file extension. It can be NULL if you do not want the base file extension.

Returns

true if the file information was successfully extracted from fileName, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h
Line: 5416
AVUtilGetBaseNameAndExtensionEx() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool AVUtilGetBaseNameAndExtensionEx(const ASFileSys fileSys, const ASPathName pathName, const ASText fileName, ASInt32 numAddExt, const char*const * addExt, ASText baseName, char** baseExt)

Parses a path name to obtain the base file name and extension for a particular file. The function enumerates all registered convertToPDF and convertFromPDF handlers to find a matching extension for the file passed in. This function allocates memory for the file name and extension. It is the caller's responsibility to free the memory allocated by the method.

Parameters

fileSys — 

The file system from which the path was obtained. Pass NULL to use the default file system.

 
pathName — 

The path containing the file name.

 
fileName — 

The file name as a constant text object.

 
numAddExt — 

The number of additional extensions to search through.

 
addExt — 

An array of NULL-terminated strings with extensions to search through.

 
baseName — 

(Allocated and filled by the method) A buffer containing the file name. It can be NULL if you do not want the base file name.

 
baseExt — 

(Allocated and filled by the method) A buffer containing the file extension. It can be NULL if you do not want the base file extension.

Returns

true if the file info was successfully extracted from the path, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h
Line: 8384
DoObjFound() 
Product availability: Acrobat
Platform availability:

Syntax

ASInt32 DoObjFound(ConsultantAgent* pAgent, CosObj Obj, const PDFObjType* pObjTypeHierarchy, const iSizeObjHierarchy, ConsStack Stack, CosObj* pObjRet)

A callback called when an object is found.

Parameters

pAgent
 
Obj
 
pObjTypeHierarchy
 
iSizeObjHierarchy
 
Stack
 
pObjRet

Returns

File: ConsExpT.h
Line: 267
DoObjIDFound() 
Product availability: Acrobat
Platform availability:

Syntax

ASInt32 DoObjIDFound(ConsultantAgent* pAgent, CosObj Obj, const PDFObjType* pObjTypeHierarchy, const iSizeObjHierarchy, ConsStack Stack, CosObj* pObjRet)

Parameters

pAgent
 
Obj
 
pObjTypeHierarchy
 
iSizeObjHierarchy
 
Stack
 
pObjRet

Returns

File: ConsExpT.h
Line: 293
DoPostProcess() 
Product availability: Acrobat
Platform availability:

Syntax

void DoPostProcess(ConsultantAgent* pAgent)

Functions that do not depend on the class' this pointer being present. So, these can be called from C or from an HFT. Hence, they require an active agent as a parameter.

Parameters

pAgent


File: ConsExpT.h
Line: 262
GetAcroPluginResourceMap() 
Product availability: Acrobat, Reader
Platform availability: Macintosh

Syntax

ResFileRefNum GetAcroPluginResourceMap()

Returns

File: PIMain.h
Line: 173
GetCertValidityPV() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool GetCertValidityPV(PSSigValidateParams params)

Validates PKCS7 Detached Sigantures for Protected View

Parameters

params — 

Validation Related parameters

Returns

File: PubSecHFTProcs.h
Line: 586
GetRequestedHFT() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool GetRequestedHFT(const char* table, ASUns32 requiredVer, ASUns32* resultingVer, HFT* resultHFT)

Parameters

table
 
requiredVer
 
resultingVer
 
resultHFT

Returns

File: PIMain.h
Line: 142
GetRequestedHFT() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool GetRequestedHFT(const char* table, ASUns32 requiredVer, ASUns32* resultingVer, HFT* resultHFT)

Parameters

table
 
requiredVer
 
resultingVer
 
resultHFT

Returns

File: PDFLInitCommon.h
Line: 74
IsChecked() 
Product availability: Acrobat
Platform availability:

Syntax

ASBool IsChecked()

Returns

File: CAVAlert.h
Line: 144
PDFolderGetCreationDate() 
Product availability: All
Platform availability: All

Syntax

ASBool PDFolderGetCreationDate(PDFolder folder, ASTimeRec* date)

Gets the creation date of the folder.

Parameters

folder — 

The folder.

 
date — 

A pointer to an ASTimeRec that will be filled with the folder creation date.

Returns

true if the folder has a creation date, false otherwise.


File: PDProcs.h
Line: 12405
PDFolderGetDescription() 
Product availability: All
Platform availability: All

Syntax

ASBool PDFolderGetDescription(PDFolder folder, ASText text)

Gets the description of the folder.

Parameters

folder — 

The folder.

 
text — 

A text object that will receive the folder description.

Returns

true if the folder has a description, false otherwise.


File: PDProcs.h
Line: 12418
PDFolderGetDescriptionStyled() 
Product availability: All
Platform availability: All

Syntax

ASBool PDFolderGetDescriptionStyled(PDFolder folder, ASText text)

Gets the description of the folder as styled text, in XML Text Layout Format.

Parameters

folder — 

The folder.

 
text — 

A text object that will receive the folder description.

Returns

true if the folder has a description, false otherwise.


File: PDProcs.h
Line: 12425
PDFolderGetFieldDate() 
Product availability: All
Platform availability: All

Syntax

ASBool PDFolderGetFieldDate(PDFolder folder, ASAtom fieldID, ASTimeRec* date)

Gets the value of the specified date field in the folder.

Parameters

folder — 

The folder.

 
fieldID — 

The field identifier.

 
date — 

The date that will receive the field value

Returns

true if the field value was found, false otherwise.


File: PDProcs.h
Line: 12514
PDFolderGetFieldNumber() 
Product availability: All
Platform availability: All

Syntax

ASBool PDFolderGetFieldNumber(PDFolder folder, ASAtom fieldID, float* number)

Gets the value of the specified numeric field in the folder.

Parameters

folder — 

The folder.

 
fieldID — 

The field identifier.

 
number — 

The number that will receive the field value.

Returns

true if the field value was found, false otherwise.


File: PDProcs.h
Line: 12497
PDFolderGetFieldStyle() 
Product availability: All
Platform availability: All

Syntax

ASBool PDFolderGetFieldStyle(PDFolder folder, ASAtom fieldID, ASCab styles)

Gets the style dictionary for the specified field in the folder

Parameters

folder — 

The folder.

 
fieldID — 

The field identifier.

 
styles — 

ASCab object that will receive the field styles

Returns

true if the field value was found, false otherwise.


File: PDProcs.h
Line: 12489
PDFolderGetFieldStyledText() 
Product availability: All
Platform availability: All

Syntax

ASBool PDFolderGetFieldStyledText(PDFolder attachment, ASAtom fieldID, ASText text)

Gets the value of the specified text field in the folder as styled text, in XML Text Layout Format.

Parameters

attachment — 

The folder.

 
fieldID — 

The field identifier.

 
text — 

The text object that will receive the field value.

Returns

true if the field value was found, false otherwise.


File: PDProcs.h
Line: 12472
PDFolderGetFieldText() 
Product availability: All
Platform availability: All

Syntax

ASBool PDFolderGetFieldText(PDFolder folder, ASAtom fieldID, ASText text)

Gets the value of the specified text field in the folder.

Parameters

folder — 

The folder.

 
fieldID — 

The field identifier.

 
text — 

The text object that will receive the field value.

Returns

true if the field value was found, false otherwise.


File: PDProcs.h
Line: 12446
PDFolderGetFirstChild() 
Product availability: All
Platform availability: All

Syntax

PDFolder PDFolderGetFirstChild(PDFolder folder)

Gets the first child of a folder.

Parameters

folder — 

The folder.

Returns

The first child of the folder. If no child exists, the returned folder is invalid.


File: PDProcs.h
Line: 12355
PDFolderGetID() 
Product availability: All
Platform availability: All

Syntax

ASInt32 PDFolderGetID(PDFolder folder)

Gets the ID number of a folder.

Parameters

folder — 

The folder.

Returns

The folder ID.


File: PDProcs.h
Line: 12379
PDFolderGetModDate() 
Product availability: All
Platform availability: All

Syntax

ASBool PDFolderGetModDate(PDFolder folder, ASTimeRec* date)

Gets the modification date of the folder.

Parameters

folder — 

The folder.

 
date — 

A pointer to an ASTimeRec that will be filled with the folder modification date.

Returns

true if the folder has a modification date, false otherwise.


File: PDProcs.h
Line: 12392
PDFolderGetName() 
Product availability: All
Platform availability: All

Syntax

void PDFolderGetName(PDFolder folder, ASText name)

Gets the name of a folder.

Parameters

folder — 

The folder.

 
name — 

The name of the folder.


File: PDProcs.h
Line: 12373
PDFolderGetNextSibling() 
Product availability: All
Platform availability: All

Syntax

PDFolder PDFolderGetNextSibling(PDFolder folder)

Gets the next sibling of a folder.

Parameters

folder — 

The folder.

Returns

The next sibling of the folder. If no next sibling exists, the returned folder is invalid.


File: PDProcs.h
Line: 12361
PDFolderGetParent() 
Product availability: All
Platform availability: All

Syntax

PDFolder PDFolderGetParent(PDFolder folder)

Gets the parent of the specified folder.

Parameters

folder — 

The folder object.

Returns

The parent of the specified folder. If no parent exists, the returned folder is invalid.


File: PDProcs.h
Line: 12343
PDFolderGetPathText() 
Product availability: All
Platform availability: All

Syntax

void PDFolderGetPathText(PDFolder folder, ASText path)

Gets the path of the folder.

Parameters

folder — 

The folder.

 
path — 

The folder path.


File: PDProcs.h
Line: 12385
PDFolderIsValid() 
Product availability: All
Platform availability: All

Syntax

ASBool PDFolderIsValid(PDFolder folder)

Determines if a PDFolder is valid.

Parameters

folder — 

The folder object

Returns

true if the folder is a dictionary, false otherwise.


File: PDProcs.h
Line: 12284
PDFolderSetCreationDate() 
Product availability: All
Platform availability: All

Syntax

void PDFolderSetCreationDate(PDFolder folder, const ASTimeRec* date)

Sets the creation date of the folder.

Parameters

folder — 

The folder.

 
date — 

A pointer to an ASTimeRec will be used to set the creation date.


File: PDProcs.h
Line: 12411
PDFolderSetDescription() 
Product availability: All
Platform availability: All

Syntax

void PDFolderSetDescription(PDFolder folder, ASConstText text)

Sets the description of the folder. Removes a styled version if present.

Parameters

folder — 

The folder.

 
text — 

The new description for the folder.


File: PDProcs.h
Line: 12431
PDFolderSetDescriptionStyled() 
Product availability: All
Platform availability: All

Syntax

void PDFolderSetDescriptionStyled(PDFolder folder, ASConstText text)

Sets the description of the folder using styled text. Keeps the non-styled description in sync. with the styled version.

Parameters

folder — 

The folder.

 
text — 

The new description for the folder in XML Text Layout Format.


File: PDProcs.h
Line: 12438
PDFolderSetFieldDate() 
Product availability: All
Platform availability: All

Syntax

void PDFolderSetFieldDate(PDFolder folder, ASAtom fieldID, const ASTimeRec* date)

Sets the specified date field in the folder.

Parameters

folder — 

The folder.

 
fieldID — 

The field identifier.

 
date — 

The date to use as the new value for the specified field.

Exceptions

genErrBadParm is raised if the field does not exist in the collection schema or the field type is not D (date).

File: PDProcs.h
Line: 12523
PDFolderSetFieldNumber() 
Product availability: All
Platform availability: All

Syntax

void PDFolderSetFieldNumber(PDFolder folder, ASAtom fieldID, float number)

Sets the specified numeric field in the folder.

Parameters

folder — 

The folder.

 
fieldID — 

The field identifier.

 
number — 

The number to use as the new value for the specified field.

Exceptions

genErrBadParm is raised if the field does not exist in the collection schema or the field type is not N (number).

File: PDProcs.h
Line: 12506
PDFolderSetFieldStyle() 
Product availability: All
Platform availability: All

Syntax

void PDFolderSetFieldStyle(PDFolder folder, ASAtom fieldID, ASConstCab styles)

Sets the style dictionary for the specified field in the folder.

Parameters

folder — 

The folder.

 
fieldID — 

The field identifier.

 
styles — 

ASConstCab containing field styles for the specified field.

Exceptions

genErrBadParm is raised if the field does not exist in the collection schema or the field type is not S (text).

File: PDProcs.h
Line: 12481
PDFolderSetFieldStyledText() 
Product availability: All
Platform availability: All

Syntax

void PDFolderSetFieldStyledText(PDFolder folder, ASAtom fieldID, ASConstText text)

Sets the specified text field in the folder

Parameters

folder — 

The folder.

 
fieldID — 

The field identifier.

 
text — 

Text Layout Format XML containing the text to use as the new value for the specified field.

Exceptions

genErrBadParm is raised if the field does not exist in the collection schema or the field type is not S (text).

File: PDProcs.h
Line: 12464
PDFolderSetFieldText() 
Product availability: All
Platform availability: All

Syntax

void PDFolderSetFieldText(PDFolder folder, ASAtom fieldID, ASConstText text)

Sets the specified text field in the folder.

Parameters

folder — 

The folder.

 
fieldID — 

The field identifier.

 
text — 

The text to use as the new value for the specified field.

Exceptions

genErrBadParm is raised if the field does not exist in the collection schema or the field type is not S (text).

File: PDProcs.h
Line: 12455
PDFolderSetModDate() 
Product availability: All
Platform availability: All

Syntax

void PDFolderSetModDate(PDFolder folder, const ASTimeRec* date)

Sets the modification date of the folder.

Parameters

folder — 

The folder.

 
date — 

A pointer to an ASTimeRec that will be used to set the modification date.


File: PDProcs.h
Line: 12398
PDFolderSetName() 
Product availability: All
Platform availability: All

Syntax

void PDFolderSetName(PDFolder folder, ASConstText folderName)

Sets the name of a folder.

Parameters

folder — 

The folder.

 
folderName — 

The name of the folder.


File: PDProcs.h
Line: 12367
PDFolderSetParent() 
Product availability: All
Platform availability: All

Syntax

void PDFolderSetParent(PDFolder folder, PDFolder parent)

Sets the parent of the specified folder.

Parameters

folder — 

The folder that will receive a new parent.

 
parent — 

The new parent folder.


File: PDProcs.h
Line: 12349