InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDynamicEventTimingFacade.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: SusanCL
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // ADOBE CONFIDENTIAL
16 //
17 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
18 //
19 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
20 // with the terms of the Adobe license agreement accompanying it. If you have received
21 // this file from a source other than Adobe, then your use, modification, or
22 // distribution of it requires the prior written permission of Adobe.
23 //
24 //========================================================================================
25 
26 #include "DynamicDocumentsID.h"
27 #include "IDynamicEventTimingMgr.h"
28 
29 #include "AnimationTypes.h"
30 #include "UIDList.h"
31 #include "Utils.h"
32 
33 
34 namespace Facade
35 {
48 class IDynamicEventTimingFacade : public IPMUnknown
49 {
50  public:
51  enum { kDefaultIID = IID_IDYNAMICEVENTTIMINGFACADE };
52 
62  virtual IDynamicEventTimingMgr::DynamicTargetPtr CreateDynamicTarget (const UIDRef& ownerRef, const UIDRef& targetRef, uint32 role = kTimingTargetRoleDefault, uint32 action = kTimingTargetVerbPlay) = 0;
69  virtual IDynamicEventTimingMgr::DynamicTargetPtr CreateDynamicTarget (const UIDRef& targetRef, uint32 role = kTimingTargetRoleDefault, uint32 action = kTimingTargetVerbPlay) = 0;
75  virtual IDynamicEventTimingMgr::DynamicTargetPtr CreateDynamicTarget (const UIDRef& targetOrOwnerRef, const IDynamicEventTimingMgr::DynamicTargetPtr& targetPtr) = 0;
83  virtual int32 FindDynamicTarget (const UIDRef& ownerRef, const IDynamicEventTimingMgr::DynamicTargetList& targetlist, IDynamicEventTimingMgr::DynamicTargetPtr& target) const = 0;
84 
93  virtual bool DynamicTargetTriggeredByPageEvents (const UIDRef& itemRef, std::vector<EventTriggerType>* eventList = nil) const = 0;
94 
100  virtual int32 FindDynamicEvent (const UIDRef& ownerRef, const EventTriggerType& trigger) const = 0;
101 
107  virtual bool RemoveDynamicEvent (const UIDRef& ownerRef, const EventTriggerType& trigger) const = 0;
108 
113  virtual uint32 GetNumDynamicEvents (const UIDRef& ownerRef) const = 0;
114 
120  virtual EventTriggerType GetNthDynamicEvent (const UIDRef& ownerRef, uint32 which) const = 0;
121 
127  virtual uint32 GetNumGroupsInEvent (const UIDRef& ownerRef, const EventTriggerType& trigger) const = 0;
128 
136  virtual bool GetNthGroupItemsInEvent (const UIDRef& ownerRef, const EventTriggerType& trigger, uint32 which, IDynamicEventTimingMgr::DynamicTargetList& itemList) const = 0;
137 
146  virtual uint32 GetNthGroupNumPlaysInEvent (const UIDRef& ownerRef, const EventTriggerType& whichTrigger, uint32 which) const = 0;
147 
156  virtual bool SetNthGroupNumPlaysInEvent (const UIDRef& ownerRef, const EventTriggerType& whichTrigger, uint32 which, uint32 newNumPlays) = 0;
157 
166  virtual bool GetNthGroupPlaysLoopInEvent (const UIDRef& ownerRef, const EventTriggerType& whichTrigger, uint32 which) const = 0;
167 
176  virtual bool SetNthGroupPlaysLoopInEvent (const UIDRef& ownerRef, const EventTriggerType& whichTrigger, uint32 which, bool playsLoop) = 0;
177 
187  virtual bool MoveNthGroupInEvent (const UIDRef& ownerRef, const EventTriggerType& trigger, uint32 which, int32 newPosition) const = 0;
188 
198  virtual bool RemoveNthGroupInEvent (const UIDRef& ownerRef, const EventTriggerType& trigger, uint32 which) const = 0;
199 
207  virtual bool UnlinkNthGroupInEvent (const UIDRef& ownerRef, const EventTriggerType& trigger, uint32 which) const = 0;
208 
218  virtual bool AddTargetInNthGroup(const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, int32 at = -1) const = 0;
219 
230  virtual bool ReplaceTargetInNthGroup(const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& targetToReplace, const IDynamicEventTimingMgr::DynamicTargetPtr& newTarget, uint32 whichGroup) const = 0;
231 
243  virtual bool RemoveTargetInNthGroup (const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 which) const = 0;
244 
253  virtual bool RemoveTargetInEvent (const UIDRef& ownerRef, const EventTriggerType& trigger, const UIDRef& targetRef) const = 0;
254 
267  virtual bool MoveTargetBeforeNthGroupInEvent (const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 oldGroup, uint32 beforeGroup) const = 0;
268 
281  virtual bool MoveTargetAfterNthGroupInEvent (const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 oldGroup, uint32 afterGroup) const = 0;
282 
298  virtual bool MoveTargetIntoNthGroupAt (const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 oldGroup, uint32 atGroup, int32 at = -1) const = 0;
299 
311  virtual bool SetTargetDelayInNthGroup (const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 which, const PMReal& delay) const = 0;
312 
321  virtual PMReal GetTargetDelayInNthGroup (const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 which) const = 0;
322 
331  virtual IDynamicEventTimingMgr::DynamicTargetPtr GetTargetDataInNthGroup (const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 which) const = 0;
332 
343  virtual bool SetTargetDataInNthGroup (const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 which) const = 0;
344 
352  virtual bool GroupTargetsInEvent (const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetList& targetList, int32 newGroup) const = 0;
353 
362  virtual bool UnlinkTargetInEvent (const UIDRef& ownerRef, const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 which) const = 0;
363 
373  virtual int32 FindTargetInEvent (const UIDRef& ownerRef, const EventTriggerType& whichTrigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, IDynamicEventTimingMgr::DynamicTargetList& itemList, uint32* pItemPosition = nil) const = 0;
374 
382  virtual int32 FindTargetInNthGroup (const UIDRef& ownerRef, const EventTriggerType& whichTrigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 which) const = 0;
383 
393  virtual bool ReassignEventForTargets (const UIDRef& ownerRef, const EventTriggerType& trigger, const EventTriggerType& newTrigger, const IDynamicEventTimingMgr::DynamicTargetList& targetList) const = 0;
394 
401  virtual bool DynamicTargetIsSelfTriggered (const UIDRef& itemRef) const = 0;
402 
408  virtual EventTriggerType GetSelfClickRolloverItemDynamicEvent (const UIDRef& itemRef) const = 0;
409 
417  virtual bool AddSelfClickRolloverDynamicEventToItem (const UIDRef& itemRef, const EventTriggerType& trigger) const = 0;
418 
424  virtual bool RemoveSelfClickRolloverDynamicEventFromItem (const UIDRef& itemRef, const EventTriggerType& trigger) const = 0;
425 
431  virtual bool SetSelfClickRolloverItemDelay (const UIDRef& itemRef, const PMReal& delay) const = 0;
432 
437  virtual PMReal GetSelfClickRolloverItemDelay (const UIDRef& itemRef) const = 0;
438 
444  virtual bool SetSelfClickRolloverItemTargetData (const UIDRef& itemRef, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget) const = 0;
445 
450  virtual IDynamicEventTimingMgr::DynamicTargetPtr GetSelfClickRolloverItemTargetData (const UIDRef& itemRef) const = 0;
451 };
452 
453 }; // namespace