| Layer | PD_Layer |
| Object | PDTrans |
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 | ||
|---|---|---|
| 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 | ||
|---|---|---|
|
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.
|
||
|
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.
|
||
|
ASFixed PDTransGetDuration(PDTrans pdt)
Gets the duration for the given transition.
|
||
|
ASAtom PDTransGetSubtype(PDTrans pdt)
Gets a transition's subtype.
|
||
|
ASBool PDTransIsValid(PDTrans pdt)
Tests whether a transition is valid, meaning that the transition has not been deleted.
|
||
|
Creates a new transition of the specified type and duration associated with the CosDoc of the given PDDoc.
|
||
|
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.
|
||
| PDTrans |
| Product availability: All |
| Platform availability: All |
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 |
| PDTransEqual | () |
| Product availability: All |
| Platform availability: All |
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. |
|
See Also
Since
| File: PDProcs.h |
| Line: 5748 |
| PDTransFromCosObj | () |
| Product availability: All |
| Platform availability: All |
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. |
The transition corresponding to the given dictionary object, |
See Also
Exceptions
Since
| File: PDProcs.h |
| Line: 5719 |
| PDTransGetCosObj | () |
| Product availability: All |
| Platform availability: All |
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. |
The dictionary Cos object corresponding to the transition. it returns the |
See Also
Since
| File: PDProcs.h |
| Line: 5735 |
| PDTransGetDuration | () |
| Product availability: All |
| Platform availability: All |
Gets the duration for the given transition.
Parameters
pdt — | IN/OUT The transition for which the duration is obtained. |
The transition duration, specified in seconds. If no duration is specified in the transition, the return value is fxDefaultTransDuration ( |
See Also
Since
| File: PDProcs.h |
| Line: 5888 |
| PDTransGetSubtype | () |
| Product availability: All |
| Platform availability: All |
Parameters
pdt — | IN/OUT The transition whose subtype is obtained. |
The ASAtom for the transition's subtype. It can be converted to a string using ASAtomGetString(). |
See Also
Since
| File: PDProcs.h |
| Line: 5865 |
| PDTransIsValid | () |
| Product availability: All |
| Platform availability: All |
Tests whether a transition is valid, meaning that the transition has not been deleted.
Parameters
pdt — | The transition dictionary whose validity is tested. |
|
See Also
Since
| File: PDProcs.h |
| Line: 5691 |
| PDTransNew | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
Creates a new transition of the specified type and duration associated with the CosDoc of the given PDDoc.
Parameters
pdd — | ||
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. |
The newly created transition. |
See Also
Exceptions
Since
| File: PDProcs.h |
| Line: 5854 |
| PDTransNewFromCosDoc | () |
| Product availability: All |
| Platform availability: All |
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. |
The newly created transition. |
See Also
Exceptions
Since
| File: PDProcs.h |
| Line: 5834 |
| PDTransNull | () |
| Product availability: All |
| Platform availability: All |
PDTrans PDTransNull()
Gets a NULL transition. This can be used in conjunction with PDTransEqual() to determine whether a transition is NULL.
A |
See Also
Since
| File: PDProcs.h |
| Line: 5702 |