LayerPDFEdit_Layer
ObjectPDEObject

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


Typedef Summary
 Typedef
 PDEObject
The abstract super class of the 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.
Method Summary
 Method
 
void PDEAcquire(INPDEObject obj)
Increments the reference count for an object.
 
void PDEAddTag(INPDEObject object, INExtensionID clientID, INASUns32 tag, IN void* value)
Adds an identifier-value pair to an object.
 
void* PDEGetTag(INPDEObject object, INExtensionID clientID, INASUns32 tag)
Gets an object's value for a given clientID-tag identifier that was added by PDEAddTag.
 
ASInt32 PDEObjectGetType(INPDEObject obj)
Gets the type of an element.
 
void PDERelease(INPDEObject obj)
Decrements the reference count for the object. If the count becomes zero, the object is destroyed.
 
void PDEReleaseSpan(INPDESpanSetP pdeSpan)
Releases a PDESpan object that is returned by PDEFontAddGlyphs().
 
void PDERemoveTag(INPDEObject object, INExtensionID clientID, INASUns32 tag)
Removes an object's value for a given clientID-tag identifier that was added by PDEAddTag.

Typedefs Detail
PDEObject 
Product availability: All
Platform availability: All

Syntax

typedef struct _t_PDEObject* PDEObject;

The abstract super class of the 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.

See Also

PDERelease
PDEObjectDump

File: PEExpT.h
Line: 105



Method Detail
PDEAcquire()
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDEAcquire(INPDEObject obj)

Increments the reference count for an object.

Parameters

obj — 

IN/OUT The element whose count is incremented.

See Also

PDERelease

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h
Line: 1354
PDEAddTag() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDEAddTag(INPDEObject object, INExtensionID clientID, INASUns32 tag, IN void* value)

Adds an identifier-value pair to an object.

The clientID-tag combination is a unique identifier for the value. Each client has its own identifier space. It is often convenient to use ASAtoms as tags.

Parameters

object — 

The element to tag. The object may be a PDEElement, PDEContent, PDEFont, PDEColorSpace, and so on.

 
clientID — 

Identifies the caller/client. For clients, this should be the gExtensionID extension. For the Adobe PDF Library, if there is only one client of the PDFEdit subsystem, clientID should be zero. If there are multiple clients, each should specify a nonzero, non-negative clientID. (A negative clientID is reserved for the implementation.)
 
tag — 

The tag to add to object. If tag is 0, this is the same as calling PDERemoveTag(). In other words, you cannot tell the difference between a tag whose value is zero and a tag that is nonexistent.

 
value — 

A pointer to a value to associate with object. Only the pointer is stored. If the pointer points to data, it is the responsibility of the client to manage the data and its memory.

See Also

PDEGetTag
PDERemoveTag

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

File: PEWProcs.h
Line: 1113
PDEGetTag() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void* PDEGetTag(INPDEObject object, INExtensionID clientID, INASUns32 tag)

Gets an object's value for a given clientID-tag identifier that was added by PDEAddTag.

Parameters

object — 

The element whose value is obtained.

 
clientID — 

Identifies the caller/client. For clients, this should be the gExtensionID extension. For the Adobe PDF Library, if there is only one client of the PDFEdit subsystem, clientID should be zero. If there are multiple clients, each should specify a nonzero, non-negative clientID. (A negative clientID is reserved for the implementation.)
 
tag — 

The object's tag. If object has no tag, this is 0.

Returns

The value associated with the clientID-tag identifier.

See Also

PDEAddTag
PDERemoveTag

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

File: PEWProcs.h
Line: 1137
PDEObjectGetType() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 PDEObjectGetType(INPDEObject obj)

Gets the type of an element.

Parameters

obj — 

IN/OUT The element whose type is obtained.

Returns

The object type, which is one of PDEType.

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h
Line: 1339
PDERelease() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDERelease(INPDEObject obj)

Decrements the reference count for the object. If the count becomes zero, the object is destroyed.

Do not call PDERelease() on PDEContent that you acquired with PDPageAcquirePDEContent(); call PDPageReleasePDEContent() instead.

Parameters

obj — 

IN/OUT The element released.

See Also

PDEAcquire

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h
Line: 1376
PDEReleaseSpan() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDEReleaseSpan(INPDESpanSetP pdeSpan)

Releases a PDESpan object that is returned by PDEFontAddGlyphs().

Parameters

pdeSpan

See Also

PDEFontAddGlyphs

Exceptions

genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00070000

File: PEWProcs.h
Line: 2982
PDERemoveTag() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDERemoveTag(INPDEObject object, INExtensionID clientID, INASUns32 tag)

Removes an object's value for a given clientID-tag identifier that was added by PDEAddTag.

If PDEAddTag is called with a 0 tag, this is the same as calling PDERemoveTag().

Parameters

object — 

The element whose tag is removed.

 
clientID — 

Identifies the caller/client. For clients, this should be the gExtensionID extension. For the Adobe PDF Library, if there is only one client of the PDFEdit subsystem, clientID should be zero. If there are multiple clients, each should specify a nonzero, non-negative clientID. (A negative clientID is reserved for the implementation.)
 
tag — 

The tag value.

See Also

PDEAddTag
PDEGetTag

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

File: PEWProcs.h
Line: 1162



© 2004-2013 Adobe Systems Incorporated. All rights reserved.
Thu Jan 21 2016, 11:19 AM IST