InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IAnimationBehaviorData Class Referenceabstract

#include <IAnimationBehaviorData.h>

Inheritance diagram for IAnimationBehaviorData:
IBehaviorDataIPMUnknown

Public Types

enum  Operation {
  kPlay = 0, kStop, kPause, kResume,
  kReverse, kStopAll
}
 
- Public Types inherited from IBehaviorData
enum  { kDefaultIID = IID_IBEHAVIORDATA }
 

Public Member Functions

virtual void SetOperation (Operation operation)=0
 
virtual Operation GetOperation () const =0
 
virtual void SetTarget (UID const &target)=0
 
virtual UID GetTarget () const =0
 
virtual void SetAutoReverseOnRollOff (bool reverseOnRollOff)=0
 
virtual bool GetAutoReverseOnRollOff () const =0
 
- Public Member Functions inherited from IBehaviorData
virtual int32 GetAction () const =0
 
virtual PMString GetName () const =0
 
virtual UID GetOwner () const =0
 
virtual void SetOwner (const UID &owner)=0
 
virtual bool16 IsEnabled () const =0
 
virtual bool16 Enable (const bool16 &enable=kTrue)=0
 
bool16 IsDisabled () const
 
bool16 Disable ()
 
virtual void Copy (IPMUnknown *srcData)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Data interface for Play Animation Behavior.

See Also
INamedPageItemList (for a way of getting candidates for SetTarget()

Member Function Documentation

virtual bool IAnimationBehaviorData::GetAutoReverseOnRollOff () const
pure virtual

Get whether animation should reverse itself on roll off

Returns
true if target should auto-reverse on roll off
virtual Operation IAnimationBehaviorData::GetOperation () const
pure virtual

Get Operation to perform on animation

Returns
One of Operation enum
virtual UID IAnimationBehaviorData::GetTarget () const
pure virtual

Get UID of animated page item to target

Returns
UID of animated page item to target
virtual void IAnimationBehaviorData::SetAutoReverseOnRollOff (bool reverseOnRollOff)
pure virtual

Set whether target animation should reverse itself on roll off

Parameters
reverseOnRollOffBoolean. If true, target should auto-reverse on roll off
virtual void IAnimationBehaviorData::SetOperation (Operation operation)
pure virtual

Set Operation to perform on animation

Parameters
operationOne of Operation enum
virtual void IAnimationBehaviorData::SetTarget (UID const & target)
pure virtual

Set UID of animated page item to target

Parameters
targetUID of animated page item to target