AV_Layer.General (Acrobat)

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

enum AVDragType {

  kAVDragRect,


 


  kAVDragTopLeft,


 


  kAVDragTopRight,


 


  kAVDragBottomRight,


 


  kAVDragBottomLeft,


 


  kAVDragTopMiddle,


 


  kAVDragRightMiddle,


 


  kAVDragBottomMiddle,


 


  kAVDragLeftMiddle,


 


  kAVDragSnapToTopLeft,


 


  kAVDragSnapToTop,


 


  kAVDragSnapToTopRight,


 


  kAVDragSnapToRight,


 


  kAVDragSnapToBottomRight,


 


  kAVDragSnapToBottom,


 


  kAVDragSnapToBottomLeft,


 


  kAVDragSnapToLeft

}

See Also

AVRectHandleHitTest

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

enum AVFullScreenMonitor {

  kAVFullScreenLargestIntersection,


 


  kAVFullScreenMostColors,


 


  kAVFullScreenWidest,


 


  kAVFullScreenTallest,


 


  kAVFullScreenLargest,


 


  kAVFullScreenMain,


 


  kAVFullScreen_END_ENUM

}

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

AVIdentityGetText
AVIdentitySetText

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

AVPageViewUpdateInfoPanel

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

enum AVnUpPageOrder {

  kAVnUpPageOrderHorizontal,


 


  kAVnUpPageOrderHorizontalRev,


 


  kAVnUpPageOrderVertical,


 


  kAVnUpPageOrderVerticalRev

}

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

enum AVPageSize {

  kAVPageSizeUninitialized = 0,


 


  kAVPageSizeNone,


 


  kAVPageSizeFitToPaper,


 


  kAVPageSizeShrinkLargePages,


 


  kAVPageSizeTileLargePages,


 


  kAVPageSizeTileAllPages,


 


  kAVPageSizeNup,


 


  kAVPageSizeBooklet,


 


  kAVPageSizeCustom

}

See Also

AVAppGetPreference
AVAppSetPreference

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

enum AVResourcePolicy {

  kAVResPolicySendAtStart,


 


  kAVResPolicySendByRange,


 


  kAVResPolicySendPerPage

}

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

}

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

}

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

}

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

enum AVZoomType {

  AVZoomNoVary,


 


  AVZoomFitPage,


 


  AVZoomFitWidth,


 


  AVZoomFitHeight,


 


  AVZoomFitVisibleWidth,


 


  AVZoomPreferred,


 


  AVZoomReflowWidth

}

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

enum PDFarEastFont {

  PDOutput_PS,


 


  PDOutput_EPSNoPrev,


 


  PDOutput_EPSMacStdPrev,


 


  PDOutput_EPSMacExtPrev

}

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.

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.

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

AVAnnotHandlerAdjustCursorExProc

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.

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

AVAnnotHandlerDoClickExProc

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.

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.

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.

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;  

}

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

AVAppRegisterTransHandler

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.

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

struct _t_AVTransHandler {

  ASSize_t size;  


 


  AVTransHandlerGetTypeProc GetType;  


 


  AVTransHandlerExecuteProc Execute;  


 


  AVTransHandlerGetUINameProc GetUIName;  


 


  AVTransHandlerGetItemUINameProc GetItemUIName;  


 


  AVTransHandlerInitTransDictProc InitTransDict;  


 


  AVTransHandlerCompleteTransDictProc CompleteTransDict;  


 


  AVTransHandlerDoPropertiesProc DoProperties;  


 


  AVTransHandlerGetInstructionsProc GetInstructions;  


 


  AVTransHandlerGetButtonTextProc GetButtonText;  


 


  AVTransHandlerGetStringOneTextProc GetStringOneText;  


 


  AVTransHandlerGetStringTwoTextProc GetStringTwoText;  


 


  AVTransHandlerGetNameProc GetName;  


 


  AVTransHandlerGetItemNameProc GetItemName;  


 


  ASBool discludeFromRandom;  


 


  ASBool discludeFromUI;  


 


  AVTransHandlerGetItemDirectionUINameProc GetItemDirectionUIName;  


 


  AVTransHandlerGetBiDirEnabledProc GetBiDirEnabled;  


 


  AVTransHandlerGetSmoothActionEnabledProc GetSmoothActionEnabled;  

}

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

AVTransHandlerExecuteProc

File: AVExpT.h

Line: 7111

_t_ExternalDocServerCreationData

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_ExternalDocServerCreationData {

  ASSize_t size;  


 


  ExternalDocWindowData platformWindow;  


 


  AVExecuteProc acrobatProc;  


 


  void* acrobatProcData;  


 


  CrossDocLinkProc crossDocLinkProc;  


 


  void* crossDocLinkProcData;  


 


  AVSetMessageProc setMessage;  


 


  void* setMessageProcData;  


 


  CrossDocLinkWithDestProc crossDocLinkWithDestProc;  


 


  void* crossDocLinkWithDestData;  


 


  AVSetFocusProc setFocus;  


 


  void* setFocusProcData;  


 


  AVSetFocusProc setFocusSHIFTTAB;  


 


  void* setFocusSHIFTTABProcData;  


 


  AVSetFocusProc setFocusCTRLTAB;  


 


  void* setFocusCTRLTABProcData;  

}

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().

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.

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.

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

struct _t_PDFOptImageOptions {

  ASSize_t size;  


 


  PDFOptDownsamplingAlgo enmDownsamplingAlgo;  


 


  ASInt32 ppiDownsampleTo;  


 


  ASInt32 ppiDownsampleAbove;  


 


  PDFOptCompressionAlgo enmCompressionAlgo;  


 


  PDFOptCompressionQlty enmCompressionQlty;  


 


  ASInt32 nTileSize;  

}

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

AVPageViewAcquireMachinePort

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

AVPageViewGetPixelInformationAtPoint

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

AVAppSaveDialogEx

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

struct AVOpenSaveDialogParamsRec {

  ASSize_t size;  


 


  AVOpenSaveDialogFlags flags;  


 


  AVWindow parentWindow;  


 


  ASText windowTitle;  


 


  ASText actionButtonTitle;  


 


  ASText cancelButtonTitle;  


 


  ASFileSys initialFileSys;  


 


  ASPathName initialPathName;  


 


  ASText initialFileName;  


 


  AVFileFilterRec fileFilters;  


 


  AVArraySize numFileFilters;  


 


  AVOpenSaveDialogSettingsComputeEnabledProc settingsComputeEnabledProc;  


 


  AVOpenSaveDialogSettingsExecuteProc settingsExecuteProc;  


 


  void* settingsProcData;  


 


  ASBool showExportCheckbox;  

}

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

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

PDPrintParams

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

AVDocSendAuxData

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

AVCmdHandlerTermProc

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

AVCmdHandlerInitProc

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

AVAppSetHowToPanelComputeVisibleProc
AVMenuItemSetComputeVisibleProc
AVToolButtonSetComputeVisibleProc

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

AVAppRegisterForContextMenuAddition

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

AVOpenSaveDialogSettingsExecuteProc

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.

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.

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

AVDocEnumSelection

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.

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.

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

AVDocGetPageText

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

AVTransHandlerDoPropertiesProc

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.

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

AVAppEnumTransHandlers

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

AVTransHandlerDoPropertiesProc

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

AVActionGetInstructionsProc

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

AVTransHandlerGetItemUINameProc

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

AVTransHandlerGetUINameProc

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

AVTransHandlerGetStringTwoTextProc

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

AVTransHandlerGetStringOneTextProc

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

PDTransGetSubtype

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

AVTransHandlerGetItemUINameProc

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.

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.

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.

File: AVExpT.h

Line: 2755

DoClickProcType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DoClickProcType)(AVTool tool, AVPageView pageView, AVDevCoord xHit, AVDevCoord yHit, AVFlagBits16 flags, AVTCount clickNo)

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

DoKeyDownProcType

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

DoClickProcType

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

AVAppGetToolByName

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

AVToolIsPersistent

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.

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

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

AVAcquireSpecialFilePathName

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

AVPageViewToDestInfo

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

AVExtensionReleaseInfo

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

AVExtensionReleaseInfoEx

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.

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

AVExtensionAcquireInfo

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

AVExtensionAcquireInfoEx

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:

The Acrobat compatibility level specifies retaining the compatibility of the file.
The default list of fonts to be unembedded needs to be determined.

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

AVGetOptimizerPresets

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

AVIdentitySetText

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

AVIdentityGetText

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

AVLegacyToolButtonRemove

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

AVLegacyToolButtonRemove

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.

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

AVLegacyToolBarEnumButtons

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.

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.

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.

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`.

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

AVLegacyToolButtonSetIcon

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.

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.

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.

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.

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

AVLegacyToolButtonSetLabelText

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.

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

AVLegacyToolBarGetButtonByName

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.

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

AVLegacyToolButtonSetComputeEnabledProc

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

AVLegacyToolButtonSetComputeMarkedProc

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

AVLegacyToolButtonIsEnabled

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.

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

AVLegacyToolBarAddButton

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.

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.

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.

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.

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.

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.

See Also