DL Logo

PDTrans Definitions

fxDefaultPageDuration

Header: PDExpT.h:4049

Syntax

#define fxDefaultPageDuration - fixedOne

fxDefaultTransDuration

Header: PDExpT.h:4050

Syntax

#define fxDefaultTransDuration fixedOne

PDTrans Typedefs

PDTrans

Header: PDExpT.h:4047

Description

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.

Syntax

typedef OPAQUE_64_BITS PDTrans;

Returned From

Used By

PDTrans Functions

PDTransEqual

Header: PDProcs.h:5835

Description

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

Related Methods

Syntax

ASBool PDTransEqual(PDTrans pdtOne, PDTrans pdtTwo);

Parameters

pdtOne
A transition to test for equality.
pdtTwo
A transition to test for equality.

Returns

true if the transitions are equal, false otherwise.

PDTransFromCosObj

Header: PDProcs.h:5806

Description

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.

Syntax

PDTrans PDTransFromCosObj(CosObj coLayer);

Parameters

coLayer
The dictionary Cos object to convert to a transition.

Returns

The transition corresponding to the given dictionary object, obj.

Exceptions

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

PDTransGetCosObj

Header: PDProcs.h:5822

Description

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.

Syntax

CosObj PDTransGetCosObj(PDTrans pdl);

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

PDTransGetDuration

Header: PDProcs.h:5980

Description

Gets the duration for the given transition.

Related Methods

Syntax

ASFixed PDTransGetDuration(PDTrans pdt);

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

PDTransGetSubtype

Header: PDProcs.h:5957

Description

Gets a transition's subtype.

Related Methods

Syntax

ASAtom PDTransGetSubtype(PDTrans pdt);

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

PDTransIsValid

Header: PDProcs.h:5778

Description

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

Related Methods

Syntax

ASBool PDTransIsValid(PDTrans pdt);

Parameters

pdt
The transition dictionary whose validity is tested.

Returns

true if the transition is valid, false otherwise.

PDTransNew

Header: PDProcs.h:5946

Description

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

Related Methods

Syntax

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

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 under "Presentations" in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 12.4.4, page 377.

You can find this document on the web store of the International Standards Organization (ISO).

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.

Exceptions

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

PDTransNewFromCosDoc

Header: PDProcs.h:5921

Description

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

Related Methods

Syntax

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

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.

Exceptions

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

PDTransNull

Header: PDProcs.h:5789

Description

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

Related Methods

Syntax

PDTrans PDTransNull(void);

Returns

A NULL transition.