InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CompoundSequenceCmd Class Reference
Inheritance diagram for CompoundSequenceCmd:
SequenceCmdCommandICommandIPMUnknown

Public Member Functions

 CompoundSequenceCmd (IPMUnknown *boss)
 
- Public Member Functions inherited from SequenceCmd
 SequenceCmd (IPMUnknown *boss)
 
- Public Member Functions inherited from Command
 Command (IPMUnknown *boss)
 
virtual void GetName (PMString *name) const
 
virtual void SetName (const PMString &newName)
 
virtual bool16 IsNameRequired () const
 
virtual const UIDListGetItemList () const
 
virtual const UIDListGetItemListReference () const
 
virtual void SetItemList (const UIDList &newItemList)
 
virtual void DoImmediate (bool16 isDynamic=kFalse)
 
virtual void LWDoImmediate ()
 
virtual void DoDynamic ()
 
virtual CommandState GetCommandState () const
 
virtual bool16 IsDone () const
 
virtual bool16 CanJoin (const ICommand *pNewCmd) const
 
virtual void SetCreatorID (int32 creatorID)
 
virtual int32 GetCreatorID () const
 
virtual bool16 LowMemIsOK () const
 
virtual const TargetGetTarget () const
 
virtual Undoability GetUndoability () const
 
virtual void SetUndoability (Undoability newUndoability)
 
virtual void SetActive (bool16 isActive)
 
virtual bool16 IsActive () const
 
virtual bool8 IsLWProcessed () const
 

Protected Member Functions

virtual void SetUpTarget ()
 
virtual void Do ()
 
virtual PMStringCreateName ()
 
- Protected Member Functions inherited from SequenceCmd
virtual void BeginSequence ()
 
virtual void EndSequence ()
 
ICommandSequenceGetSequence ()
 
- Protected Member Functions inherited from Command
virtual void DoNotify ()
 
virtual void SetCommandState (CommandState state)
 
virtual void PreVerify (CommandState state)
 
virtual void PostVerify (CommandState state)
 
void SetTarget (const Target &newTarget)
 
void SetTarget (PredefinedTarget newTarget)
 
void SetTarget (IDataBase *db)
 

Additional Inherited Members

- Public Types inherited from Command
enum  CommandDummyArg { kItemList = 1 }
 
- Protected Types inherited from Command
enum  PredefinedTarget { kSessionWorkspaceTarget, kSessionTarget }
 
- Protected Attributes inherited from Command
UIDList fItemList
 

Member Function Documentation

virtual PMString* CompoundSequenceCmd::CreateName ()
protectedvirtual

Returns the name that appears in undo or redo menu items to identify this command.

Returns
the name of the command

Reimplemented from Command.

virtual void CompoundSequenceCmd::Do ()
protectedvirtual

Changes the model and must be defined by all commands. If you encounter an error condition within your Do method you normally set the global error code and return.

See Also
ErrorUtils::SetPMGlobalErrorCode

Implements SequenceCmd.

virtual void CompoundSequenceCmd::SetUpTarget ()
protectedvirtual

Sets up the target, the database that contains the objects changed by the command. Define if your command has a target that is not known at construction time and is not equivalent to the database passed in the command's item list when the command is processed.

See Also
Command::SetTarget

Reimplemented from Command.