IUserActionFacade.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 _IUserActionFacade_
#define _IUserActionFacade_

#include "IPMUnknown.h"
#include "IActionsPlaybackPreference.h"
#include "IScriptRequestData.h"
#include "IUserActionSequence.h"

#include "Utils.h"

class UserActionPlaybackContext;
class UserActionPlaybackOptions;

class IUserActionFacade : public IPMUnknown
{
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
public:
 enum { kDefaultIID = IID_IUSERACTIONFACADE };

 //____________________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________________
public:
 virtual IPMUnknown* CreateUserActionGroup (IUserActionSequence::UserActionSequenceName& groupName, IPMUnknown* iUserActionSet) = 0;

 virtual int32 GetNumberUserActionChildren (IPMUnknown* iUserAction) = 0;

 virtual IPMUnknown* QueryNthUserActionChild (IPMUnknown* iUserAction, int32 index, const PMIID& interfaceIID = IID_IUNKNOWN) = 0;

 virtual ErrorCode SetUserActionEnableState (IPMUnknown* iUserAction, bool16 doEnableAction) = 0;

 virtual ErrorCode SetUserActionName (IPMUnknown* iUserAction, WideString& name) = 0; 

 virtual bool16 GetUserActionEnableState (IPMUnknown* iUserAction) = 0;

 virtual WideString GetUserActionName (IPMUnknown* iUserAction) = 0;

 virtual ErrorCode LoadActions (ClassID serviceProviderClassID, const IDFile& actionSysfile) = 0;

 virtual ErrorCode SaveActions (ClassID serviceProviderClassID, IUserActionSequence* iActionSet, IDFile& actionSysfile) = 0;

 virtual bool16 StartRecordingUserActions (ClassID serviceProviderClassID, IPMUnknown* iRecordingUserSequence) = 0;

 virtual void Stop (ClassID serviceProviderClassID) = 0;

 virtual bool16 StartPlaybackUserActions (ClassID serviceProviderClassID, UserActionPlaybackContext& playbackContext, UserActionPlaybackOptions& playbackOptions,IUserActionSequence::UserActionList& userActionAtomPlaybackList, bool16 createOuterSequence, const PMString* sequenceName, K2Vector<PMString>* playbackErrorStrings, IScriptRequestData::TargetHandlingPolicy) = 0;

 virtual void ClearTransformAgainActions (void) = 0;
 virtual void StartRecordingTransformAgainActions (void) = 0;
 virtual void StartPlaybackTransformAgainUserActions (UserActionPlaybackContext& playbackContext, K2Vector<PMString>* playbackErrorStrings, IScriptRequestData::TargetHandlingPolicy) = 0;
 virtual void StartPlaybackTransformLastAgainUserActions (UserActionPlaybackContext& playbackContext, K2Vector<PMString>* playbackErrorStrings, IScriptRequestData::TargetHandlingPolicy) = 0;
 virtual int16 CountTransformAgainActions (void) = 0;
 virtual int32 GetTransformAgainGenerationID (void) = 0;
 virtual IUserActionSequence* PopLastTransformAgainAction (void) = 0;
 virtual void PushLastTransformAgainAction (IUserActionSequence*) = 0;

 virtual void GetPlaybackOptionsPreferences (IActionsPlaybackPreference::PlaybackSpeed& playbackSpeed, PMReal& pauseForSeconds) = 0;
 virtual ErrorCode SetPlaybackOptionsPreferences (IActionsPlaybackPreference::PlaybackSpeed playbackSpeed, PMReal pauseForSeconds) = 0;
};

#endif // _IUserActionFacade_