ICommandInterceptor.h

//========================================================================================
// 
// $File$
// 
// Owner: Roey Horns
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Reviewed: 10/06/98
// 
//========================================================================================

#ifndef __ICOMMANDINTERCEPTOR__
#define __ICOMMANDINTERCEPTOR__

#include "CommandID.h"
#include "IPMUnknown.h"

class ICommand;
class ICommandSequence;

class ICommandInterceptor : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ICOMMANDINTERCEPTOR };

 // Each interception method should return one of the following values.
 typedef enum
 {
 kCmdNotHandled, // command should get passed on to other interceptors
 // they will decide whether to process it
 kCmdNotHandledSkipInterceptors,
 // command should get processed, other interceptors
 // should get skipped
 kCmdHandled // command should not get processed, other interceptors
 // should get skipped
 } InterceptResult;
 
 virtual InterceptResult InterceptProcessCommand(ICommand *cmd) = 0;
 virtual InterceptResult InterceptScheduleCommand(ICommand *cmd) = 0; 
 
 virtual InterceptResult InterceptExecuteDynamic(ICommand * cmd) = 0;
 
 // install/deinstall itself as command interceptor
 virtual void InstallSelf() = 0;
 virtual void DeinstallSelf() = 0;
 
 // these will eventually go away
 virtual InterceptResult InterceptExecuteImmediate(ICommand * cmd) = 0;
};

#endif // __ICOMMANDINTERCEPTOR__