I_Base_CommandSequence Class Reference

#include <ICommandSequence.h>

Inheritance diagram for I_Base_CommandSequence:

Public Member Functions
virtual ICommand::Undoability	GetUndoability () const =0
virtual void	SetUndoability (ICommand::Undoability newUndoability)=0
virtual void	GetName (PMString *name) const =0
virtual void	SetName (const PMString &newName)=0
virtual void	AddReference ()=0
virtual void	ReleaseReference ()=0
virtual const char *	GetTrackingData ()=0

Detailed Description

Abstract base class for command sequences.

The type of command sequence that meets most needs is ICommandSequence. If you need more sophisticated error handling and retry behaviour within your sequence consider using IAbortableCmdSeq.

THIS IS NOT A STANDARD BOSS CLASS INTERFACE; that is, it doesn't support the IPMUnknown protocol and can't be wrapped in an InterfacePtr.

Member Function Documentation

virtual void I_Base_CommandSequence::AddReference ( )

pure virtual

Increase the ref count on this command sequence by one.

virtual void I_Base_CommandSequence::GetName ( PMString *  name ) const

pure virtual

Gets the name of this command sequence

Parameters

name	returned as the name to show in the undo/redo menu items.

See Also

ICommand

virtual const char* I_Base_CommandSequence::GetTrackingData ( )

pure virtual

For internal use only

virtual ICommand::Undoability I_Base_CommandSequence::GetUndoability ( ) const

pure virtual

Returns the undoability of this command sequence

Returns

the undoability of this command sequence

See Also

ICommand

virtual void I_Base_CommandSequence::ReleaseReference ( )

pure virtual

Decrease the ref count on this command sequence by one.

virtual void I_Base_CommandSequence::SetName ( const PMString &  newName )

pure virtual

Set the name of this command sequence

Parameters

newName

the name to show in the undo/redo menu items.

See Also

ICommand

virtual void I_Base_CommandSequence::SetUndoability ( ICommand::Undoability  newUndoability )

pure virtual

Set the undoability of this command sequence

Parameters

newUndoability

the undoability of this command sequence

See Also

ICommand