ISpreadDynamicContentMgr.h

//========================================================================================
// 
// $File$
// 
// Owner: SusanCL
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __ISpreadDynamicContentMgr__
#define __ISpreadDynamicContentMgr__

#include "DynamicDocumentsID.h"
#include "IPMUnknown.h"
#include "AnimationTypes.h"
#include "vector"

class ISpreadDynamicContentMgr : public IPMUnknown
{ 
public:

 enum { kDefaultIID = IID_ISPREADDYNAMICCONTENTMGR };

 enum DynamicContentType {
 kInvalidContentType = 0,
 kAnimationItemType,
 kSoundItemType,
 kMovieItemType,
 kMultiStateItemType,
 kButtonItemType
 };

 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;
};

#endif // __ISpreadDynamicContentMgr__