LayerPD_Layer
ObjectPDXObject

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



Typedef Summary
 Typedef
 PDXObject
A superclass used for PDF XObjects. Acrobat currently uses two XObject subclasses: PDImage and PDForm. You can use any PDXObject method on these three objects.
Callback Summary
 Callback
 PDXObjectFilterEnumProc
A callback for PDXObjectEnumFilters(). It is called once for each filter that has been applied to an XObject's data.
Method Summary
 Method
 
void PDXObjectEnumFilters(PDXObject obj, PDXObjectFilterEnumProc proc, void* clientData)
(Obsolete, provided only for backwards compatibility) Enumerates the filters attached to an XObject, calling a user-supplied procedure for each filter.
 
(Obsolete, provided only for backwards compatibility) Gets the Cos object associated with an XObject. This method does not copy the object, but is instead the logical equivalent of a type cast.
 
void PDXObjectGetData(PDXObject obj, PDGetDataProc getDataProc, void* clientData)
(Obsolete, provided only for backwards compatibility) Passes the data from an XObject to a user-supplied procedure.
 
(Obsolete, provided only for backwards compatibility) Gets the value of the XObject stream's length key, which specifies the amount of data in the PDF file (that is, after all compression/encoding filters have been applied).
 
(Obsolete, provided only for backwards compatibility) Gets the subtype of an XObject. Examples of a subtype are Image and Form.

Typedefs Detail
PDXObject 
Product availability: All
Platform availability: All

Syntax

typedef struct _t_PDXObject* PDXObject;

A superclass used for PDF XObjects. Acrobat currently uses two XObject subclasses: PDImage and PDForm. You can use any PDXObject method on these three objects.

See Also


File: PDExpT.h
Line: 2416


Callbacks Detail
PDXObjectFilterEnumProc 
Product availability: All
Platform availability: All

Syntax

ASBool (*PDXObjectFilterEnumProc)(char *filter, CosObj decodeParms, void *clientData)

A callback for PDXObjectEnumFilters(). It is called once for each filter that has been applied to an XObject's data.

See Also


File: PDExpT.h
Line: 3002

Method Detail
PDXObjectEnumFilters()
Product availability: All
Platform availability: All

Syntax

void PDXObjectEnumFilters(PDXObject obj, PDXObjectFilterEnumProc proc, void* clientData)

(Obsolete, provided only for backwards compatibility) Enumerates the filters attached to an XObject, calling a user-supplied procedure for each filter.

Parameters

obj — 

The XObject whose filters are enumerated.

 
proc — 

A user-supplied callback to call for each filter attached to the XObject. Enumeration ends if proc returns false. proc will not be called if there are no filters attached to the XObject.

 
clientData — 

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

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3788
PDXObjectGetCosObj() 
Product availability: All
Platform availability: All

Syntax

CosObj PDXObjectGetCosObj(PDXObject xObj)

(Obsolete, provided only for backwards compatibility) Gets the Cos object associated with an XObject. This method does not copy the object, but is instead the logical equivalent of a type cast.

Parameters

xObj — 

The XObject whose Cos object is obtained.

Returns

The dictionary Cos object for the XObject.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3747
PDXObjectGetData() 
Product availability: All
Platform availability: All

Syntax

void PDXObjectGetData(PDXObject obj, PDGetDataProc getDataProc, void* clientData)

(Obsolete, provided only for backwards compatibility) Passes the data from an XObject to a user-supplied procedure.

Parameters

obj — 

The XObject whose data is read.

 
getDataProc — 

A user-supplied callback to call with the XObject's data. Enumeration ends if getDataProc returns false.

 
clientData — 

A pointer to user-supplied data to pass to getDataProc.

See Also

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3773
PDXObjectGetDataLength() 
Product availability: All
Platform availability: All

Syntax

ASInt32 PDXObjectGetDataLength(PDXObject xObj)

(Obsolete, provided only for backwards compatibility) Gets the value of the XObject stream's length key, which specifies the amount of data in the PDF file (that is, after all compression/encoding filters have been applied).

Parameters

xObj — 

The XObject whose data length is obtained.

Returns

The XObject's data length.

See Also

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3759
PDXObjectGetSubtype() 
Product availability: All
Platform availability: All

Syntax

ASAtom PDXObjectGetSubtype(PDXObject xObj)

(Obsolete, provided only for backwards compatibility) Gets the subtype of an XObject. Examples of a subtype are Image and Form.

Parameters

xObj — 

The XObject whose subtype is obtained.

Returns

The ASAtom corresponding to the XObject's subtype. It can be converted into a string using ASAtomGetString().

See Also

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3736