InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ICommandInterceptor Class Referenceabstract

#include <ICommandInterceptor.h>

Inheritance diagram for ICommandInterceptor:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICOMMANDINTERCEPTOR }
 
enum  InterceptResult { kCmdNotHandled, kCmdNotHandledSkipInterceptors, kCmdHandled }
 

Public Member Functions

virtual InterceptResult InterceptProcessCommand (ICommand *cmd)=0
 
virtual InterceptResult InterceptScheduleCommand (ICommand *cmd)=0
 
virtual InterceptResult InterceptExecuteDynamic (ICommand *cmd)=0
 
virtual void InstallSelf ()=0
 
virtual void DeinstallSelf ()=0
 
virtual InterceptResult InterceptExecuteImmediate (ICommand *cmd)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

A CommandInterceptor can be installed at the CommandProcessor in order to intercept any command before it is processed. The Interceptor decides whether the command will processed at all. There can be more than one CommandInterceptor at once. Use with extreme caution from third-party client code.

Member Function Documentation

virtual InterceptResult ICommandInterceptor::InterceptExecuteDynamic (ICommandcmd)
pure virtual

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