IBehaviorSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Brubidge
// 
// $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 __IBehaviorSuite_h__
#define __IBehaviorSuite_h__

#include "IPMUnknown.h"
#include "BehaviorID.h"
#include "BehaviorTypes.h"
#include <vector>

class IBehaviorData;
class IBehaviorEvent;

class IBehaviorSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IBEHAVIORSUITE };
 
 virtual bool16 CanApplyActions() const = 0;

 virtual bool16 IsEventSupported(IBehaviorEvent* inEvent) const = 0;

 virtual bool16 CanMoveAction(const UID& actionToMove, const ActionEvent& newEvent, int32 newPosition) = 0;
 
 virtual void GetActions(const ActionEvent& forEvent, IDataBase*& db, std::vector<UID>& actions) const = 0;

 virtual void GetEventAndActions(IDataBase*& db, std::vector< std::pair<ActionEvent, UID> >& actions) const = 0;
 
 virtual ErrorCode AddAction(const ActionEvent& forEvent, IBehaviorData* actionData, UID& newAction) = 0;

 virtual ErrorCode ReplaceAction(const ActionEvent& forEvent, const UID& actionToReplace, IBehaviorData* actionData) = 0;

 virtual ErrorCode DuplicateAction(const ActionEvent& forEvent, const UID& actionToDuplicate, UID& newAction) = 0;

 virtual ErrorCode DeleteAction(const UID& actionToDelete) = 0;

 virtual ErrorCode MoveAction(const UID& actionToMove, const ActionEvent& newEvent, int32 newPosition) = 0;

 virtual ErrorCode EnableAction(const UID& actionToEnable, const bool16& enable = kTrue) = 0;

 virtual ErrorCode DeleteAllActions() = 0;
};

#endif // __IBehaviorSuite_h__