LayerPD_Layer
ObjectPDTrans

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



Typedef Summary
 Typedef
 PDTrans
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.
Method Summary
 Method
 
ASBool PDTransEqual(PDTrans pdtOne, PDTrans pdtTwo)
Tests two transitions for equality. Two transitions are equal only if their Cos objects are equal (see CosObjEqual()).
 
PDTrans PDTransFromCosObj(CosObj coLayer)
Converts the specified dictionary Cos object to a transition and verifies that the transition is valid. This method does not copy the object but is instead the logical equivalent of a type cast.
 
Gets the dictionary Cos object corresponding to the transition and verifies that the transition is valid. This method does not copy the object but is the logical equivalent of a type cast.
 
Gets the duration for the given transition.
 
Gets a transition's subtype.
 
Tests whether a transition is valid, meaning that the transition has not been deleted.
 
PDTrans PDTransNew(PDDoc pdd, ASAtom asaSubtype, ASFixed fxDuration)
Creates a new transition of the specified type and duration associated with the CosDoc of the given PDDoc.
 
PDTrans PDTransNewFromCosDoc(CosDoc cd, ASAtom asaSubtype, ASFixed fxDuration)
Creates a new transition of the specified type and duration associated with the given CosDoc.
 
PDTrans PDTransNull()
Gets a NULL transition. This can be used in conjunction with PDTransEqual() to determine whether a transition is NULL.

Typedefs Detail
PDTrans 
Product availability: All
Platform availability: All

Syntax

typedef OPAQUE_64_BITS PDTrans;

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 Also


File: PDExpT.h
Line: 3947



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

Syntax

ASBool PDTransEqual(PDTrans pdtOne, PDTrans pdtTwo)

Tests two transitions for equality. Two transitions are equal only if their Cos objects are equal (see CosObjEqual()).

Parameters

pdtOne — 

A transition to test for equality.

 
pdtTwo — 

A transition to test for equality.

Returns

true if the transitions are equal, false otherwise.

See Also

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5748
PDTransFromCosObj() 
Product availability: All
Platform availability: All

Syntax

PDTrans PDTransFromCosObj(CosObj coLayer)

Converts the specified dictionary Cos object to a transition and verifies that the transition is valid. This method does not copy the object but is instead the logical equivalent of a type cast.

Parameters

coLayer — 

The dictionary Cos object to convert to a transition.

Returns

The transition corresponding to the given dictionary object, obj.

See Also

Exceptions

pdErrBadBaseObj is raised if the transition is not valid as determined by PDTransIsValid().

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5719
PDTransGetCosObj() 
Product availability: All
Platform availability: All

Syntax

CosObj PDTransGetCosObj(PDTrans pdl)

Gets the dictionary Cos object corresponding to the transition and verifies that the transition is valid. This method does not copy the object but is the logical equivalent of a type cast.

Parameters

pdl — 

The transition whose Cos object is obtained.

Returns

The dictionary Cos object corresponding to the transition. it returns the NULL Cos object if the transition is invalid as determined by PDTransIsValid().

See Also

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5735
PDTransGetDuration() 
Product availability: All
Platform availability: All

Syntax

ASFixed PDTransGetDuration(PDTrans pdt)

Gets the duration for the given transition.

Parameters

pdt — 

IN/OUT The transition for which the duration is obtained.

Returns

The transition duration, specified in seconds. If no duration is specified in the transition, the return value is fxDefaultTransDuration (1 second).

See Also

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5888
PDTransGetSubtype() 
Product availability: All
Platform availability: All

Syntax

ASAtom PDTransGetSubtype(PDTrans pdt)

Gets a transition's subtype.

Parameters

pdt — 

IN/OUT The transition whose subtype is obtained.

Returns

The ASAtom for the transition's subtype. It can be converted to a string using ASAtomGetString().

See Also

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5865
PDTransIsValid() 
Product availability: All
Platform availability: All

Syntax

ASBool PDTransIsValid(PDTrans pdt)

Tests whether a transition is valid, meaning that the transition has not been deleted.

Parameters

pdt — 

The transition dictionary whose validity is tested.

Returns

true if the transition is valid, false otherwise.

See Also

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5691
PDTransNew() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDTrans PDTransNew(PDDoc pdd, ASAtom asaSubtype, ASFixed fxDuration)

Creates a new transition of the specified type and duration associated with the CosDoc of the given PDDoc.

Parameters

pdd — 

The PDDoc to whose CosDoc the transition is added.

 
asaSubtype — 

The transition subtype to create. It must be one of the transition effects described in Section 8.3.3 in the PDF Reference. All implementations that support transitions are required to support these transitions at a minimum. Plug-ins can register new types or provide a new handler for an existing type.

 
fxDuration — 

The transition duration, in seconds.

Returns

The newly created transition.

See Also

Exceptions

pdErrBadBaseObj is raised if the transition is not valid as determined by PDTransIsValid().

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5854
PDTransNewFromCosDoc() 
Product availability: All
Platform availability: All

Syntax

PDTrans PDTransNewFromCosDoc(CosDoc cd, ASAtom asaSubtype, ASFixed fxDuration)

Creates a new transition of the specified type and duration associated with the given CosDoc.

Parameters

cd — 

The CosDoc to which the transition is added.

 
asaSubtype — 

The transition subtype to create. This subtype is returned by the AVTransHandlerGetTypeProc() callback in AVTransHandler.

 
fxDuration — 

The transition duration, in seconds.

Returns

The newly created transition.

See Also

Exceptions

pdErrBadBaseObj is raised if the transition is not valid as determined by PDTransIsValid().

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5834
PDTransNull() 
Product availability: All
Platform availability: All

Syntax

PDTrans PDTransNull()

Gets a NULL transition. This can be used in conjunction with PDTransEqual() to determine whether a transition is NULL.

Returns

A NULL transition.

See Also

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5702