InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ICommandProcessor Class Referenceabstract

#include <ICommandProcessor.h>

Inheritance diagram for ICommandProcessor:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICOMMANDPROCESSOR }
 

Public Member Functions

virtual ErrorCode ProcessCommand (ICommand *cmd)=0
 
virtual ErrorCode LWProcessCommand (ICommand *cmd)=0
 
virtual ICommandSequence * BeginCommandSequence (const char *trackingData=nullptr)=0
 
virtual ErrorCode EndCommandSequence (ICommandSequence *sequence)=0
 
virtual IAbortableCmdSeq * BeginAbortableCmdSeq (const char *trackingData=nullptr)=0
 
virtual ErrorCode EndCommandSequence (IAbortableCmdSeq *sequence)=0
 
virtual ErrorCode AbortCommandSequence (IAbortableCmdSeq *sequence)=0
 
virtual SequenceMark SetSequenceMark (const IAbortableCmdSeq *sequence)=0
 
virtual ErrorCode RollBackCommandSequence (const IAbortableCmdSeq *sequence, SequenceMark upToMark=SequenceMark())=0
 
virtual void EnableBusyCursor (bool16 bEnable)=0
 
virtual bool16 IsBusyCursorEnabled () const =0
 
virtual ErrorCode ExecuteDynamic (ICommand *cmd)=0
 
virtual ErrorCode ExecuteImmediate (ICommand *cmd)=0
 
virtual void InstallInterceptor (ICommandInterceptor *newInterceptor)=0
 
virtual void DeinstallInterceptor (ICommandInterceptor *theInterceptor)=0
 
virtual bool16 InterceptScheduledCmd (ICommand *cmd)=0
 
virtual void PartialPurge ()=0
 
virtual I_Base_CommandSequence * GetCurrentCommandSequence () const =0
 
virtual ICommand * GetCurrentCommand () const =0
 
virtual bool8 IsProcessorStackEmpty () const =0
 
virtual IAutoUndoSequence * BeginAutoUndoSequence (IDataBase *target, const char *trackingData=nullptr)=0
 
virtual ErrorCode EndAutoUndoSequence (IAutoUndoSequence *arg)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Global command processor; client code should not need to call methods of this interface directly, to process commands use CmdUtils.

See Also
CmdUtils
ICommand
IDataBase

Member Function Documentation

virtual void ICommandProcessor::EnableBusyCursor (bool16 bEnable)
pure virtual

Turn on or off automatic busy cursor support during commands and sequences.

Parameters
bEnablekTrue to turn on (the default) or kFalse to turn off busy cursor.
virtual ErrorCode ICommandProcessor::ExecuteDynamic (ICommand * cmd)
pure virtual

DEPRICATED Avoid using this function if possible - this is legacy and is deprecated.

virtual bool16 ICommandProcessor::IsBusyCursorEnabled () const
pure virtual

Is automatic busy cursor support on or off.

Parameters
none
Returns
bool16 kTrue if busy cursor support is turned on (the default), or kFalse if off