IEventHandler.h

//========================================================================================
// 
// $File$
// 
// Owner: ?
// 
// $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.
// 
//========================================================================================

#ifndef __IEVENTHANDLER__
#define __IEVENTHANDLER__

#include "IPMUnknown.h"
#include "ShuksanID.h" // for IID_IEVENTHANDLER


class IEvent;
class IEventHandler;
class IControlView;

class INTERFACE_DECL IEventHandler : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IEVENTHANDLER }; // for UseDefaultIID()
 
 virtual bool16 Activate(IEvent* e) = 0; 
 
 virtual bool16 Deactivate(IEvent* e) = 0;
 
 virtual bool16 Suspend(IEvent* e) = 0;
 
 virtual bool16 Resume(IEvent* e) = 0;
 
 virtual bool16 MouseMove(IEvent* e) = 0; 

 virtual bool16 MouseExit(IEvent* e) = 0;

 virtual bool16 MouseDrag(IEvent* e) = 0;
 
 virtual bool16 LButtonDn(IEvent* e) = 0;
 
 virtual bool16 RButtonDn(IEvent* e) = 0;
 
 virtual bool16 MButtonDn(IEvent* e) = 0;
 
 virtual bool16 LButtonUp(IEvent* e) = 0; 
 
 virtual bool16 RButtonUp(IEvent* e) = 0; 
 
 virtual bool16 MButtonUp(IEvent* e) = 0; 
 
 virtual bool16 ButtonDblClk(IEvent* e) = 0; 
 
 virtual bool16 ButtonTrplClk(IEvent* e) = 0;
 
 virtual bool16 ButtonQuadClk(IEvent* e) = 0;
 
 virtual bool16 ButtonQuintClk(IEvent* e) = 0;
 
 virtual bool16 MouseWheel(IEvent* e) = 0;
 
 virtual bool16 TabletEvent(IEvent* e) = 0;
 virtual bool16 GestureEvent(IEvent* e) = 0;

 virtual bool16 MultiTouchEvent(IEvent* e) = 0;
 
 virtual bool16 ControlCmd(IEvent* e) = 0; 
 
 
 // Keyboard Related Events
 
 virtual bool16 KeyDown(IEvent* e) = 0;
 
 virtual bool16 KeyCmd(IEvent* e) = 0;
 
 virtual bool16 KeyUp(IEvent* e) = 0;
 
 
 // Keyboard Focus Related Functions
 
 virtual void PreGetKeyFocus() = 0;

 virtual void PostGetKeyFocus() = 0;

 virtual void PreGiveUpKeyFocus() = 0;

 virtual void PostGiveUpKeyFocus() = 0;
 
 virtual bool16 WillingToGiveUpKeyFocus() = 0;
 
 virtual bool16 SuspendKeyFocus() = 0;
 
 virtual bool16 ResumeKeyFocus() = 0;
 
 virtual bool16 CanHaveKeyFocus() const = 0;
 
 virtual bool16 WantsTabKeyFocus() const = 0;

#if 0 // OBSOLETE AS OF CC

 virtual bool16 Update(IEvent* e) = 0;
 
 virtual bool16 PlatformEvent(IEvent* e) = 0;
 
 virtual bool16 CallSysEventHandler(IEvent* e) = 0;
#endif // OBSOLETE AS OF CC

 
 virtual void SetView(IControlView* view) = 0;
 
};

// All the event handler's methods for handling specific event types
// share the EHandlerMethod prototype.
//
typedef bool16 (IEventHandler::*EHandlerMethod)(IEvent* e);



#endif // __IEVENTHANDLER__