ClassPackage Description
Acrobat_Color_Layer AcroColor is an HFT that allows you to access the AcroColor engine (ACE), which controls color profile management for Adobe Acrobat. Plug-ins can import the AcroColor HFT to use the color management methods.
AS_LayerASAtom objects are hashed tokens that Acrobat uses in place of strings to optimize performance (it is much faster to compare ASAtom objects than strings). ASAtom methods convert between strings and ASAtom objects.
AS_LayerASCab objects (cabinets) can be used to store arbitrary key-value pairs. The keys are always NULL-terminated strings containing only low-ASCII alphanumeric characters.
AS_LayerCallbacks allow Acrobat to call functions in a plug-in. The core API provides macros to create and destroy callbacks. These include ASCallbackCreateProto(), ASCallbackCreateReplacement(), and ASCallbackCreateNotification() (defined in PICommon.h), and ASCallbackDestroy(). These macros (which eventually call the macro ASCallbackCreate()) allow compilers to perform type checking, eliminating an extremely common source of bugs. It is sometimes necessary for a plug-in to call ASCallbackCreate() directly; for example, when it is passing function pointers without typedefs to Mac OS toolbox routines.
AS_LayerDate objects represent a particular date and time. All date objects are guaranteed to give accurate representation of UTC time (not adjusted for leap seconds, as the addition of leap seconds to the international calendar does not happen according to a well-defined rule).
AS_LayerAn ASExtension represents a specific plug-in. A unique ASExtension object is created for each plug-in when it is loaded. If the plug-in fails to initialize, the ASExtension remains, but is marked as dead. The ASEnumExtensions() method allows you to iterate over all plug-in objects.
AS_LayerThe ASFile interface encapsulates Acrobat's access to file services. It provides a common interface for Acrobat, applications, and plug-ins to access file system services on different platforms, and enables you to provide your own file storage implementations.
AS_LayerAn ASFileSys is a collection of functions that implement file system services, such as opening files, deleting files, reading data from a file, and writing data to a file. Each ASFileSys provides these services for one class of devices. Acrobat has a built-in ASFileSys that services the platform's native file system. Acrobat on Windows includes an additional ASFileSys that services the OLE2 IStorage/IStream interfaces. Plug-ins may create additional ASFileSys objects to service other file systems. For example, a plug-in could implement an ASFileSys to access PDF files stored in a document database or to access PDF files across a serial link.
AS_LayerAn opaque object used to retrieve a platform-specific path object. This object was added in Acrobat 6.0 to improve device-independent path referencing.
AS_LayerAn ASStm is a data stream that may be a buffer in memory, a file, or an arbitrary user-written procedure. You typically would use an ASStm to extract data from a PDF file. When writing or extracting data streams, the ASStm must be connected to a Cos stream. ASStm methods allow you to open and close streams, and to read and write data.
AS_LayerAn ASText object holds encoded text.
AS_LayerAn ASTimeSpan object represents an exact time span, measured in seconds. The internal representation uses 64-bit signed integers (to avoid the 2038 problem caused by 32-bit representation). Negative timespans are allowed.
AS_Layer An object containing data and methods supporting a universal unique identifier (UUID) for the current user or the current session.
COS_LayerCos arrays are one-dimensional collections of objects accessed by a numeric index. Array indexes are zero-based. An array's elements may be any combination of the Cos data types.
COS_LayerCos boolean objects can have a value of true or false.
COS_LayerA Cos dictionary is an associative table whose elements are pairs of objects:
COS_LayerA CosDoc object is the Cos layer representation of an entire PDF file. See the PDF Reference for an overview of PDF document structure. See Section 3.6.1, "Document Catalog", in the PDF Reference, for a description of the catalog dictionary.
COS_LayerFixed numbers may only be in decimal format. See Section 3.2.2 in the PDF Reference for details.
COS_LayerIntegers may be specified by signed or unsigned constants. See Section 3.2.2 in the PDF Reference for details.
COS_LayerA name is a sequence of non-white space characters. In code, a name is preceded by the forward slash (/) character indicating that it is a string literal, for example: /AName. See Section 3.2.4 in the PDF Reference for details.
COS_LayerThere is only one NULL object, which is used to fill empty or uninitialized positions in arrays or dictionaries. See Section 3.2.8 in the PDF Reference for details.
COS_LayerA CosObj is a general object in a PDF file, which may be of any Cos object type. The Cos layer provides methods that are not specific to any particular object. Several methods are available to manipulate a Cos object.
COS_LayerThe CosObjCollection is an opaque structure representing a set of Cos objects associated with a particular Cos document. The initial value of a variable of type CosObjCollection is undefined. Use CosNewObjCollection() to create a collection.
COS_LayerA stream is a sequence of characters that can be read a portion at a time. Streams are used for objects with large amounts of data, such as images, page content, or private data a plug-in creates. A stream consists of these elements, which are listed in their relative order in the stream object, starting at the beginning. See Section 3.2.7 in the PDF Reference for a description of the stream object.
COS_LayerA string is a sequences of characters, enclosed in parentheses. See Section 3.2.3 in the PDF Reference for details.
PDFEdit_LayerDump methods allow enumerating objects and their attributes. An object's information can be dumped in human readable form. An object dump includes its reference count, which is useful in debugging reference count problems. PDELogDump PDEObjectDump PDEAttrEnumTable
COS_LayerThe Cos layer provides methods to encrypt and decrypt data in arbitrary memory blocks. The encryption and decryption uses Acrobat's built-in algorithm (RC4 from RSA Data Security, Inc.) and a key that can be specified.
AS_Layer Errors object.
AS_Layer Fixed point math object.
AS_Layer General AS layer objects.
COS_Layer General Cos layer objects.
PDFEdit_LayerThese utility methods simplify tasks, such as setting up graphics information structures and merging resources for a page. PDEDefaultGState PDEEnumElements PDEMergeResourcesDict
PDF_Library General PDF Library constructs.
PD_LayerSome methods are general PD layer methods that are not associated with a specific object.
PDSEdit_Layer General PDSEdit layer objects.
AS_Layer HFT and HFT server objects.
PDFEdit_Layer JPX color space object.
AS_Layer Memory allocation object.
PD_LayerActions are tasks that Acrobat performs when a user clicks on a link or a bookmark. Acrobat allows a document to execute an action automatically when a document is opened.
PD_LayerThis is the abstract superclass for all annotations (see Section 8.4, Annotations, in the PDF Reference). Acrobat has two built-in annotation classes: PDTextAnnot and PDLinkAnnot. Plug-ins add movie, Widget (form field), and other annotation types. You can define new annotation subtypes by creating new annotation handlers (see Developing Plug-ins and Applications). There are no objects of type PDAnnot, but you can use PDAnnot methods on any subclass of PDAnnot.
PD_LayerThis is the abstract superclass for all annotations (see Section 8.4, Annotations, in the PDF Reference). Acrobat has two built-in annotation classes: PDTextAnnot and PDLinkAnnot. Plug-ins add movie, Widget (form field), and other annotation types. You can define new annotation subtypes by creating new annotation handlers (see Developing Plug-ins and Applications). There are no objects of type PDAnnot, but you can use PDAnnot methods on any subclass of PDAnnot.
PD_LayerA bead is a single rectangle in an article thread. An article thread represents a sequence of physically discontiguous but logically related items in a document (for example, a news story that starts on one page of a newsletter and runs onto one or more nonconsecutive pages). See Section 8.3.2, Articles, in the PDF Reference for more information on article threads and beads.
PD_LayerA bookmark corresponds to an outline object in a PDF document (see Section 8.2.2, Document Outline, in the PDF Reference). A document outline allows the user to navigate interactively from one part of the document to another. An outline consists of a tree-structured hierarchy of bookmarks, which display the document's structure to the user. Each bookmark has:
PD_LayerA PDCharProc is a character procedure, which is a stream of graphic operators (see PDGraphic) that draw a particular glyph of a Type 3 PostScript font.
PD_Layer PDF file collection dictionary object.
PD_LayerA PDDoc object represents a PDF document. There is a correspondence between a PDDoc and an ASFile. Also, every AVDoc has an associated PDDoc, although a PDDoc may not be associated with an AVDoc.
PDFEdit_LayerA PDEClip is a list of PDEElement objects containing a list of PDEPath objects and PDEText objects that describe a clipping state. PDEClip objects can be created and built up with PDEClip methods. Any PDEElement object can have PDEClip associated with it by using the PDEElementSetClip() method.
PDFEdit_LayerA PDEColorSpace object is a reference to a color space used on a page. The color space is part of the graphics state attributes of a PDEElement. See Section 4.5, Color Spaces, in the PDF Reference, for details on color spaces and color operators.
PDFEdit_Layer A group of PDEElements on a page in a PDF file. In the PDF file, containers are delimited by Marked Content BMC/EMC or BDC/EMC pairs. Every PDEContainer has a Marked Content tag associated with it. In addition to grouping a set of elements, a BDC/EMC pair specifies a property list to be associated with the grouping. Thus a PDEContainer corresponding to a BDC/EMC pair also has a property list dictionary associated with it.
PDFEdit_LayerThe PDEContent object is the workhorse of the PDFEdit API, since it contains the modifiable contents of a PDPage.
PDFEdit_LayerA color space with a variable number of device-dependent components. It is usually used to store multiple spot colors in a single color space.
PDFEdit_LayerPDEElement is the base class for elements of a page display list (PDEContent) and for clip objects. The general PDEElement methods allow you to get and set general element properties.
PDFEdit_LayerA PDEExtGState object is a reference to an ExtGState resource used on a page. It specifies a PDEElement object's extended graphics state, which is part of its graphics state, as specified in a PDEGraphicState structure. See Section 4.3.4 in the PDF Reference for information on extended graphics states.
PDFEdit_LayerA PDEFont object is a reference to a font used on a page. It may be equated with a font in the system. A PDEFont is not the same as a PDFont; a PDEFont is associated with a particular document.
PDFEdit_LayerA PDEForm is a PDEElement that contains a form XObject. Form XObjects are described in Section 4.9, Form XObjects, in the PDF Reference. A PDEContent may be obtained from a PDEForm to edit the form's display list.
PDFEdit_LayerAn in-memory representation of objects in a PDEContent. It has no state and is not represented in any way in a PDF content stream (a PDEContent object).
PDFEdit_LayerA PDEImage is a PDEElement that contains an image XObject or inline image.
PDFEdit_LayerPDEObject is the abstract superclass of PDFEdit classes. You can find the type of any object with the PDEObjectGetType() method. You can then cast and apply that class' methods to the object. In addition, you can cast any of the PDFEdit objects to a PDEObject and use it anywhere a PDEObject is called for, such as in the PDEObject methods. PDEAcquire() and PDERelease() increment and decrement the reference counts of a PDEObject.
PDFEdit_LayerA PDEPath is a PDEElement that contains a path. It can have fill and stroke attributes. It also has graphics state attributes. The shape of a PDEPath can be used to represent a clipping path.
PDFEdit_LayerA PDEPattern is a reference to a pattern resource used on a page. See Section 4.6 in the PDF Reference for information on patterns.
PDFEdit_LayerA PDEPlace is a PDEElement that marks a place on a page. In a PDF file, a place is represented by the MP or DP marked content operators.
PDFEdit_LayerA PDEPS is a pass-through PostScript object.
PDFEdit_LayerA PDEShading is a PDEElement that represents smooth shading.
PDFEdit_LayerA PDESoftMask is a reference to a SoftMask resource used to support transparency.
PDFEdit_LayerA PDEText object is a PDEElement that represents text. It is a container for text as show strings or as individual characters. Each subelement may have different graphics state properties. However, the same clipping path applies to all sub-elements of a PDEText. Also, the charpath of a PDEText object can be used to represent a clipping path.
PDFEdit_LayerA PDETextItem is a PDEElement representing a text object.
PDFEdit_LayerA PDEUnknown is a PDEElement representing an unknown element. The PDEUnknownGetOpName() method gets the operator name of an unknown operator.
PDFEdit_LayerA PDEXGroup is a reference to an XGroup resource used to support transparency.
PDFEdit_LayerA PDEXObject object is a PDEElement representing an arbitrary XObject. See Section 4.7, External XObjects, in the PDF Reference, for information on XObjects.
PD_Layer PDF file attachment object.
PD_LayerA PDFileSpec corresponds to the PDF file specification object (see Section 3.10, File Specifications, in the PDF Reference). It is used to specify a file in an action (see PDAction).
PD_LayerA PDFont is a font that is used to draw text on a page. It corresponds to a font resource in a PDF file (see Chapter 5, Text, in the PDF Reference).
PD_LayerA PDForm is a self-contained set of graphics operators that is used when a particular graphic is drawn more than once in a document. It corresponds to a form resource (see Section 4.9, Form XObjects, in the PDF Reference). PDForm objects inherit from the PDXObject class; you can use any PDXObject methods on a PDForm.
PD_LayerPDGraphic is the abstract superclass for all graphic objects that comprise page, charproc, and PDForm descriptions (see Chapter 4, Graphics, in the PDF Reference). There are no objects of type PDGraphic, but its methods can be used by any graphic object. There are three types of graphic objects: PDPath, PDText, and PDInlineImage. In addition to these three objects, there are also operators in the content stream. These operators are: Save, Restore, references to XObjects (forms and image resources), and for Type 3 font descriptions only, charwidth and cachedevice. You can access these objects and operators via PDPageEnumContents(), PDFormEnumPaintProc(), or PDCharProcEnum().
PD_LayerA PDImage is a sampled image or image mask, and corresponds to a PDF Image resource (see Stencil Masking in Section 4.8, Images, in the PDF Reference). You can use any PDXObject method on a PDImage.
PD_LayerA PDInlineImage is an image whose data is stored in the page description's contents stream instead of being stored as an image resource (see PDImage). PDInlineImage is a subclass of PDGraphic and corresponds to the PDF inline image operator (see Section 4.8.6, In-Line Images, in the PDF Reference).
PD_LayerA PDLinkAnnot corresponds to a link annotation (see Sections 8.4.5, Annotation Types, in the PDF Reference). You can use any PDAnnot method on a PDLinkAnnot.
PD_LayerA PDNameTree is used to map Cos strings to Cos objects, just as a Cos dictionary is used to map Cos names to Cos objects. However, a name tree can have many more entries than a Cos dictionary. You can create a PDNameTree and locate it where appropriate (perhaps under a page, but most often right under the catalog). A PDNameTree is used to store the named destination information.
PD_LayerA PDNumTree is used to map integers to arbitrary Cos objects just as a Cos dictionary is used to map Cos names to Cos objects. However, a number tree can have many more entries than a Cos dictionary.
PD_LayerThe PDOCConfig object represents an optional-content configuration structure, used to maintain a set of visibility states and other optional-content information in a PDF file for future use. A document has a default configuration, saved in the D entry in the OCProperties dictionary, and can have a list of other configurations, saved as an array in the Configs entry in the OCProperties dictionary.
PD_LayerThe PDOCContext object represents an optional-content context in a document, within which document objects such as words or annotations are visible or hidden. The context keeps track of the ON-OFF states of all of the optional-content groups (OCGs, represented by the PDOCG object) in a document. Content is or is not visible with respect to the OCG states stored in a specific context. The context does not correspond to any explicit PDF specification.
PD_LayerThe PDOCCG object represents an optional-content group. This corresponds to a PDF OCG dictionary representing a collection of graphic objects that can be made visible or invisible. Any graphic content of the PDF can be made optional, including page contents, XObjects, and annotations. The specific content objects in the group have an OC entry in the PDF. The group itself is a named object that you can manipulate in the Layers panel of Acrobat 6.0 and later.
PD_LayerThe PDOCMD object represents an optional-content membership dictionary (OCMD) that allows the visibility of optional content to depend on the states in a set of optional-content groups (PDOCG). The object corresponds to the PDF OCMD dictionary.
PD_LayerA PDPage is a page in a document, corresponding to the PDF Page object (see Page Objects in Section 3.6.2, Page Tree, in the PDF Reference).
PD_LayerA PDPageLabel represents a page label. These labels allow non-sequential page numbering or the addition of arbitrary labels for a page (such as the inclusion of Roman numerals at the beginning of a book).
PD_LayerA PDPath is a graphic object (a subclass of PDGraphic) representing a path in a page description. Paths are arbitrary shapes made of straight lines, rectangles, and cubic curves. Path objects may be filled or stroked, and they can serve as a clipping path. For details, see the following sections in the PDF Reference:
PDSEdit_LayerA PDSAttrObj represents a structure attribute object, which is a Cos dictionary or stream describing attributes associated with a PDSElement. The attribute's data may be application-specific, suiting the application that adds or extracts logical structure information. An attribute object can have a revision number to indicate whether other applications have modified either the associated element or the element's contents since the application created or modified the element.
PDSEdit_LayerThe PDSClassMap (or class map) associates class names with a set of attribute objects. A structural element may have a list of names identifying the classes to which it belongs. Associated attributes are shared by all structural elements belonging to a given class. There is only one class map per document, associated with the PDSTreeRoot.
PDSEdit_LayerPDSElement is the basic building block of the structure tree. It represents PDF structural elements, which are nodes in a tree, defining a PDF document's logical structure.
PDSEdit_LayerPortions of a page's contents may be wrapped with marked content operators. A PDSMC object represents this marked content. A tag and an optional property list may be associated with a PDSMC. PDSMC is identical to the PDFEdit class PDEContainer. PDSMC objects may be nested.
PDSEdit_LayerAn object reference (OBJR) is a reference to a PDF object. A PDSOBJR object references an entire Cos dictionary or stream.
PDSEdit_LayerEach structure element must have a structure type. The definition of such types is application-specific. In addition, PDF 1.3 defines a standard set of structure types for logical structure in PDF documents. The role map (PDSRoleMap) maps application-specific element types to the standard element types that have a similar function. There is only one PDSRoleMap per document, associated with the PDSTreeRoot.
PDSEdit_LayerAll logical structure information is in the structure tree, and the PDSTreeRoot is its root. There is at most one PDSTreeRoot in each document.
PD_LayerA PDStyle object provides access to information on the fonts, font sizes, and colors used in a PDWord.
PDFEdit_LayerA PDSysEncoding is a subclass of PDEElement that provides system encoding for a PDF file.
PDFEdit_LayerA PDSysFont is a reference to a font installed on the host system. PDSysFont methods allow your plug-in to list the fonts available on the host system and to find a font on the system that matches a PDEFont, if it is present.
PD_LayerA PDText is a graphic object (a subclass of PDGraphic) representing one or more character strings on a page.
PD_LayerA PDTextAnnot corresponds to a PDF text annotation. For details, see Text Annotations in Section 8.4.5, Annotation Types, in the PDF Reference. You can use any PDAnnot method on a PDTextAnnot.
PD_LayerPDTextSelect objects represent a selection of text on a single page, and may contain more than one disjointed group of words. A text selection contains one or more ranges of text, with each range containing the word numbers (in PDF order, as returned by PDWordFinderEnumWords() or PDWordFinderAcquireWordList()) of the selected words. Each range has a start word (the first word in the series) and an end word (the first word not in the series).
PD_LayerA thread corresponds to an article in Acrobat's user interface, and contains an ordered sequence of rectangles that bound the article. Each rectangle is called a bead. See Section 8.3.2, Articles, in the PDF Reference for more information on articles and beads in PDF.
PD_LayerA PDThumb is a thumbnail preview image of a page.
PD_LayerA PDTrans represents a transition to a page. The Trans key in a page dictionary specifies a transition dictionary, which describes the effect to use when going to a page and the amount of time the transition should take. See Section 8.3.3, Presentations, in the PDF Reference for more information on transitions.
PD_LayerA PDViewDest represents a particular view of a page in a document. It contains a reference to a page, a rectangle on that page, and information specifying how to adjust the view to fit the window's size and shape. It corresponds to a PDF Dest array (see Named Destinations in Section 8.2, Document-Level Navigation, in the PDF Reference) and can be considered a special form of a PDAction.
PD_LayerA PDWord object represents a word in a PDF file. Each word contains a sequence of characters in one or more styles (see PDStyle).
PD_LayerA PDWordFinder extracts words from a PDF file, and enumerates the words on a single page or on all pages in a document. The core API provides methods to extract words from a document, obtain information on the word finder, and to release a list of words after a plug-in is done using it.
PD_LayerThis object corresponds to a PDF XObject (see Section 4.9, Form XObjects, in the PDF Reference). PDXObject objects currently used by Acrobat are of one of the two XObject subclasses: PDImage and PDForm. You can use any PDXObject method on these objects.
PD_LayerThis class ensures that PDPage objects are released even in case of exceptions and RAISE.
AS_Layer Host encoding object.