ISpreadDynamicContentMgr Class Reference

#include <ISpreadDynamicContentMgr.h>

Inheritance diagram for ISpreadDynamicContentMgr:

Public Types
enum	{ kDefaultIID = IID_ISPREADDYNAMICCONTENTMGR }
enum	DynamicContentType {   kInvalidContentType = 0, kAnimationItemType, kSoundItemType, kMovieItemType,   kMultiStateItemType, kButtonItemType }

Public Member Functions
virtual uint32	GetNumTargets () const =0
virtual bool	CanAddTarget (UID pageItemUID)=0
virtual bool	AddTarget (UID pageItemUID)=0
virtual bool	RemoveTarget (UID pageItemUID)=0
virtual int32	FindTarget (UID pageItemUID) const =0
virtual UID	GetNthTarget (uint32 index) const =0
virtual DynamicContentType	GetNthTargetType (uint32 index) const =0
virtual bool	NthTargetIsAnimated (uint32 index) const =0
virtual bool	GetNthTargetName (uint32 index, PMString &name) const =0
virtual void	GetItemsByTargetType (const DynamicContentType &targetType, std::vector< UID > &itemList) const =0
virtual uint32	GetNumButtons () const =0
virtual bool	AddButton (UID buttonUID)=0
virtual bool	RemoveButton (UID buttonUID)=0
virtual int32	FindButton (UID buttonUID) const =0
virtual UID	GetNthButton (uint32 index) const =0
virtual void	GetButtons (std::vector< UID > &buttonList) const =0
virtual void	GetUnassignedTargets (std::vector< UID > &targetList) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This is a persistent data interface to track InDesign dynamic content on the spread. This interface sits on the spread boss. Dynamic contents are page item with animation, media page items, button page items, and children of multi-state object page items. The media page items include movies, sound, and SWF's.

Member Enumeration Documentation

enum ISpreadDynamicContentMgr::DynamicContentType

This enum defines the types of dynamic content tracked here.

Enumerator
kInvalidContentType	Indicate an invalid content type.
kAnimationItemType	Indicate an animation item type.
kSoundItemType	Indicate an sound item type.
kMovieItemType	Indicate an sound item type.
kMultiStateItemType	Indicate an multi-state item type.
kButtonItemType	Indicate an buttom item type.

Member Function Documentation

virtual bool ISpreadDynamicContentMgr::AddButton ( UID  buttonUID )

pure virtual

Add this button on the spread

Parameters

buttonUID

is button to add.

Returns

true if successful, otherwise false.

virtual bool ISpreadDynamicContentMgr::AddTarget ( UID  pageItemUID )

pure virtual

Add this dynamic content item to be tracked for this spread.

Parameters

pageItemUID

is the page item to track.

Returns

true if successful; otherwise returns false.

virtual bool ISpreadDynamicContentMgr::CanAddTarget ( UID  pageItemUID )

pure virtual

Return true if page item is an dynamic content we care about and if this page item is on the spread. Currently we keep track of page item with animation, mso items, all media items (movies, swf, sounds, etc.)

Parameters

pageItemUID

is the page item interested

Returns

true if page item is an interactive content.

virtual int32 ISpreadDynamicContentMgr::FindButton ( UID  buttonUID ) const

pure virtual

Find the button index for the given button UID.

Parameters

buttonUID

is the button UID.

Returns

the button index. Returns -1 if this button UID is not in the list.

virtual int32 ISpreadDynamicContentMgr::FindTarget ( UID  pageItemUID ) const

pure virtual

Returns the index of the pageItemUID in this list.

Parameters

pageItemUID

is the UID of the target we are looking for.

Returns

the index of the specified target UID in this list. index is set to -1 if pageItemUID is not in the list.

virtual void ISpreadDynamicContentMgr::GetButtons ( std::vector< UID > &  buttonList ) const

pure virtual

Returns the buttons on this spread.

Parameters

buttonList

contains the buttons on the spread.

virtual void ISpreadDynamicContentMgr::GetItemsByTargetType ( const DynamicContentType &  targetType, std::vector< UID > &  itemList  ) const

pure virtual

Returns the all the items that are specified target type.

Parameters

targetType	is the target type.
itemList	is the list of items of this type.

virtual UID ISpreadDynamicContentMgr::GetNthButton ( uint32  index ) const

pure virtual

Returns the nth button.

Parameters

index

is the index of the button on the spread interested.

Returns

the button UID for this index.

virtual UID ISpreadDynamicContentMgr::GetNthTarget ( uint32  index ) const

pure virtual

Returns the nth dynamic target item.

Parameters

index

is the index of the dynamic item being tracked for this spread.

Returns

the item UID.

virtual bool ISpreadDynamicContentMgr::GetNthTargetName ( uint32  index, PMString &  name  ) const

pure virtual

Returns the nth dynamic target item's name.

Parameters

index	is the index of the dynamic item being tracked for this spread.
name	is the target's name.

Returns

true if successful; otherwise returns false.

virtual DynamicContentType ISpreadDynamicContentMgr::GetNthTargetType ( uint32  index ) const

pure virtual

Returns the nth dynamic target item's name.

Parameters

index	is the index of the dynamic item being tracked for this spread.
targetType	is the target's type.

Returns

true if successful; otherwise returns false.

virtual uint32 ISpreadDynamicContentMgr::GetNumButtons ( ) const

pure virtual

Buttons on this spread.Returns the number of buttons on the spread.

Returns

The number of buttons on the spread.

virtual uint32 ISpreadDynamicContentMgr::GetNumTargets ( ) const

pure virtual

Returns the number of dynamic items on the spread.

Returns

The number of dynamic items on the spread.

virtual void ISpreadDynamicContentMgr::GetUnassignedTargets ( std::vector< UID > &  targetList ) const

pure virtual

Returns a list of animated targets that are not assigned a trigger event.

Parameters

targetList

contains the unassigned animated targets on the spread.

virtual bool ISpreadDynamicContentMgr::NthTargetIsAnimated ( uint32  index ) const

pure virtual

Returns true if nth target is also animated.

Parameters

index

is the index of the dynamic item being tracked for this spread.

Returns

true if target is also animated.

virtual bool ISpreadDynamicContentMgr::RemoveButton ( UID  buttonUID )

pure virtual

Remove the nth button from the spread.

virtual bool ISpreadDynamicContentMgr::RemoveTarget ( UID  pageItemUID )

pure virtual

Remove the specified item from being tracked.

Parameters

pageItemUID

is the page item to remove.

Returns

true if successful; otherwise returns false.