IUserActionSequence.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Martz
// 
// $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.
// 
// 
// Note:
// 
//========================================================================================

#ifndef _IUserActionSequence_
#define _IUserActionSequence_
//________________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________________
 //.......Interface headers....................................................................
 #include "IPMUnknown.h"
 
 //.......ID headers...........................................................................
 #include "AppFrameworkID.h"
//________________________________________________________________________________________________
// DEFINES
//________________________________________________________________________________________________
//================================================================================================
//________________________________________________________________________________________________
// CLASS FORWARDS
//________________________________________________________________________________________________
//________________________________________________________________________________________________
// CLASS DECLARATION
//________________________________________________________________________________________________
class IUserActionSequence : public IPMUnknown
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_IUSERACTIONSEQUENCE };
 typedef WideString UserActionSequenceName;
 typedef K2Vector<InterfacePtr<IPMUnknown> > UserActionList;
 
 typedef enum {
 kInvalidSequenceID = 0,
 kSetSequence,
 kGroupSequence,
 kActionSequence
 } SequenceID;
 //____________________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________________
 public:
 
 virtual const UserActionSequenceName& GetName (void) const = 0;
 
 virtual void SetName (UserActionSequenceName& newName) = 0; 
 
 virtual void SetName (PMString&) = 0; 
 
 virtual IUserActionSequence::SequenceID GetSequenceID () const = 0;
 
 virtual void SetSequenceID (IUserActionSequence::SequenceID sequenceID) = 0;
 
 virtual void GetActions (UserActionList& actionList) = 0;
 
 virtual void AddActions (UserActionList& newActionList, int32 position = -1) = 0;

 virtual void AddAction (IPMUnknown* iNewAction, int32 at = -1) = 0;

 virtual void RemoveActions (UserActionList& actionList) = 0;

 virtual void RemoveActionsAndChildren (UserActionList& actionList) = 0;
 virtual void RemoveAllActions (void) = 0; 
 
 virtual void SetParent (IUserActionSequence* iNewParent) = 0;

 virtual IPMUnknown* QueryParent (const PMIID& interfaceIID = IID_IUNKNOWN) = 0;
 
 virtual IUserActionSequence* Clone (IPMUnknown* iNewParent = nil) = 0;

 virtual void Record (const WideString& actionName, IPMUnknown* iUserActionAtom) = 0;
 private:
 };

#endif // _IUserActionSequence_