Inheritance diagram for IUserActionSequence:

Public Types
enum	{ kDefaultIID = IID_IUSERACTIONSEQUENCE }

enum	SequenceID { kInvalidSequenceID = 0, kSetSequence, kGroupSequence, kActionSequence }

typedef WideString	UserActionSequenceName

typedef K2Vector< InterfacePtr < IPMUnknown > >	UserActionList

Public Member Functions
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

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Enumeration Documentation

enum IUserActionSequence::SequenceID

Enumerator
kInvalidSequenceID	Specify an invalid user action sequence ID.
kSetSequence	Specify a user action set.
kGroupSequence	Specify a user action group.
kActionSequence	Specify a user action item.

Member Function Documentation

virtual void IUserActionSequence::AddAction	(	IPMUnknown *	iNewAction,
		int32	at = `-1`
	)

pure virtual

Adds a user action at the specified position.

Parameters

iNewAction	is new user action to add.
position	is the position at which to add the new action. If position is -1, new action is appended at the end.

virtual void IUserActionSequence::AddActions	(	UserActionList &	newActionList,
		int32	position = `-1`
	)

pure virtual

Adds a list of user actions at the specified position.

Parameters

newActionList	is the list of user actions.
position	is the position at which to add the new actions. If position is -1, new actions are appended at the end.

virtual IUserActionSequence* IUserActionSequence::Clone ( IPMUnknown * iNewParent = nil )

pure virtual

Create a clone copy of this user action sequence.

Parameters

iNewParent is the new parent for the cloned user action sequence. If iNewParent is nil, the parent of the cloned user action is the same as this user action sequence.

virtual void IUserActionSequence::GetActions ( UserActionList & actionList )

pure virtual

Returns a list of its user actions.

Parameters

actionList is the list of user actions.

virtual const UserActionSequenceName& IUserActionSequence::GetName ( void ) const

pure virtual

Returns the name of this user action sequence.

Returns: the user action sequence name in a WideString.

virtual IUserActionSequence::SequenceID IUserActionSequence::GetSequenceID ( ) const

pure virtual

Returns the user action sequence ID. This is one of type defined by SequenceID.

Returns: the user action sequence ID.

virtual IPMUnknown* IUserActionSequence::QueryParent ( const PMIID & interfaceIID = IID_IUNKNOWN )

pure virtual

Returns the specified interface of this user action sequence's parent.

Parameters

interfaceIID is the requested interface IID.

Returns: the requested user action sequence parent interface.

virtual void IUserActionSequence::Record	(	const WideString &	actionName,
		IPMUnknown *	iUserActionAtom
	)

pure virtual

Record the specified user action atom.

Parameters

actionName	is the name of the specified action list.
iUserActionAtom	is the user action atom to record.

virtual void IUserActionSequence::RemoveActions ( UserActionList & actionList )

pure virtual

Removes only the user actions specified by the list. Child actions are not removed.

Parameters

actionList is list of user actions to remove.

virtual void IUserActionSequence::RemoveActionsAndChildren ( UserActionList & actionList )

pure virtual

Removes user actions specified by the list and recursively remove all children as well.

Parameters

actionList is list of user actions to remove.

virtual void IUserActionSequence::RemoveAllActions ( void )

pure virtual

Removes all user actions.

virtual void IUserActionSequence::SetName ( UserActionSequenceName & newName )

pure virtual

Sets the name of this user action sequence.

Parameters

newName is the new user action sequence name in a WideString.

virtual void IUserActionSequence::SetName ( PMString & )

pure virtual

Sets the name of this user action sequence.

Parameters

newName is the new user action sequence name in a PMString.

virtual void IUserActionSequence::SetParent ( IUserActionSequence * iNewParent )

pure virtual

Set this user action sequence's parent.

Parameters

iNewParent is the new parent to set.

virtual void IUserActionSequence::SetSequenceID ( IUserActionSequence::SequenceID sequenceID )

pure virtual

Sets the user action sequence ID. This is one of type defined by SequenceID.

Parameters

sequenceID the new user action sequence ID to set.

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation