Inheritance diagram for IUserActionFacade:

Public Types
enum	{ kDefaultIID = IID_IUSERACTIONFACADE }

Public Member Functions

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

is the new action name.

Set the action name of the specified user action.

Parameters

iUserAction specifies the user action.

Returns: kSuccess if successfull.

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

Public Member Functions inherited from IPMUnknown

virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0

virtual void AddRef () const =0

virtual void Release () const =0

Member Function Documentation

virtual void IUserActionFacade::ClearTransformAgainActions ( void )

pure virtual

Clear the saved Transform Again actions

virtual IPMUnknown* IUserActionFacade::CreateUserActionGroup	(	IUserActionSequence::UserActionSequenceName &	groupName,
		IPMUnknown *	iUserActionSet
	)

pure virtual

Create a new user action group within the specified action group and name.

Parameters

groupName	is the name of the new group.
iUserActionSet	is the user action set in which to create the new group.

Returns: IPMUnknown* to the new user action group.

virtual int32 IUserActionFacade::GetNumberUserActionChildren ( IPMUnknown * iUserAction )

pure virtual

Return the number of child actions of the specified user action.

Parameters

iUserAction is the user action.

Returns: the number of child actions.

virtual bool16 IUserActionFacade::GetUserActionEnableState ( IPMUnknown * iUserAction )

pure virtual

Get the enabling state of the specified user action.

Parameters

iUserAction specifies the user action.

Returns: kTrue is the user action is enabled. Otherwise kFalse.

virtual WideString IUserActionFacade::GetUserActionName ( IPMUnknown * iUserAction )

pure virtual

Get the name of the specified user action.

Parameters

iUserAction specifies the user action.

Returns: the action name in a WideString.

virtual ErrorCode IUserActionFacade::LoadActions	(	ClassID	serviceProviderClassID,
		const IDFile &	actionSysfile
	)

pure virtual

Load the specified action file.

Parameters

serviceProviderClassID	determines which User Action Manager to use
actionSysfile	is the action file to load. actionSysfile contains one single user action set.

Returns: kSucces if load action is successful.

virtual IPMUnknown* IUserActionFacade::QueryNthUserActionChild	(	IPMUnknown *	iUserAction,
		int32	index,
		const PMIID &	interfaceIID = `IID_IUNKNOWN`
	)

pure virtual

Return the requested interface of the specified user action's nth child.

Parameters

iUserAction	is the user action.
index	specifies the nth child.
wantedIID	is the requested interfaceIID.

Returns: IPMUnknown* to the requested interface of the user action's nth child.

virtual ErrorCode IUserActionFacade::SaveActions	(	ClassID	serviceProviderClassID,
		IUserActionSequence *	iActionSet,
		IDFile &	actionSysfile
	)

pure virtual

Save the specified action set to a file.

Parameters

serviceProviderClassID	determines which User Action Manager to use
iActionSet	is the action set to save.
actionSysfile	is the action file to which the set will be saved.

Returns: kSucces if save action is successful.

virtual ErrorCode IUserActionFacade::SetUserActionEnableState	(	IPMUnknown *	iUserAction,
		bool16	doEnableAction
	)

pure virtual

Set the enabling state of the specified user action.

Parameters

iUserAction specifies the user action. is the new enabling state.

Returns: kSuccess if successfull.

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

pure virtual

Playback a list of the specified user action items.

Parameters

serviceProviderClassID	determines which User Action Manager to use
playbackContext	is the context that should be used to bind the action to whatever is the current subject. This could be the selection, the doc or app workspace, etc.
userActionAtomPlaybackList	is the list of user action atoms.

Returns: kTrue if playback is successfully. Otherwise it returns kFalse.

virtual bool16 IUserActionFacade::StartRecordingUserActions	(	ClassID	serviceProviderClassID,
		IPMUnknown *	iRecordingUserSequence
	)

pure virtual

Start recording within the specified user action group or after the specified user action item.

Parameters

serviceProviderClassID	determines which User Action Manager to use
iRecordingUserSequence	is the user action group where recorded events will be added. In this case, the new user events will be added at the end of teh group. If iRecordingUserSequence specifies an user action item, then new events will be recorded after this user action item.

Returns: kTrue if recording started successfully. Otherwise it returns kFalse.

virtual void IUserActionFacade::Stop ( ClassID serviceProviderClassID )

pure virtual

Stop the active record or playback session.

Parameters

serviceProviderClassID determines which User Action Manager to use

Public Types

Public Member Functions

Member Function Documentation