IEvent.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 __IEVENT__
#define __IEVENT__

#include "PMTypes.h"
#include "VirtualKey.h"

class IEventHandler;

class INTERFACE_DECL IEvent {
public:
 virtual ~IEvent() {}
 
 virtual bool16 LButtonDn() const = 0;

 virtual bool16 OptionAltKeyDown() const = 0;

 virtual bool16 CmdKeyDown() const = 0;

 virtual bool16 ShiftKeyDown() const = 0;

 virtual bool16 ShiftLockKeyDown() const = 0;

 virtual bool16 MacCtrlDown() const = 0;

 virtual bool16 LeftAltDown() const = 0;

 virtual bool16 RightAltDown() const = 0;

 virtual bool16 LeftControlDown() const = 0;

 virtual bool16 RightControlDown() const = 0;

 virtual SysChar GetChar() const = 0;

 virtual void SetChar( SysChar theChar ) = 0;

 virtual VirtualKey GetVirtualKey() const = 0;

 virtual bool16 IsAltGrChar() const = 0;


 virtual bool16 IsRepeatKey() const = 0;

 virtual GSysPoint GlobalWhere() const = 0;

 enum ScrollUnits { kLines, kPixels };

 virtual PMPoint GetMouseScrollDelta(ScrollUnits units = kLines) const = 0;

 virtual PMReal GetTime() const = 0;


 enum BaseEventHandledState { kShouldCall, kDontCall, kHasCalled };
 typedef BaseEventHandledState UI_DoEventHandledState;

 virtual void SetUI_DoEventHandledState(UI_DoEventHandledState /* state */) {}

 virtual UI_DoEventHandledState GetUI_DoEventHandledState() const {return kDontCall;}

 // Note: These API are needed in CC and beyond - and should be removed. For now they are no-ops.
#ifdef ID_DEPRECATED
 typedef BaseEventHandledState SystemHandledState;

 virtual void SetSystemHandledState(SystemHandledState state) = 0;

 virtual SystemHandledState GetSystemHandledState() const = 0;
#endif // ID_DEPRECATED

 typedef enum IEventType {
 kFirstEventType = 1,

 // The following event types are available to event watchers and to event handlers pushed on to the event dispatcher, and are also delivered to widget event handlers, 
 
 kMouseMove = kFirstEventType,
 kMouseExit,
 kMouseDrag,
 kLButtonDn,
 kRButtonDn,
 kMButtonDn,
 kLButtonUp,
 kRButtonUp,
 kMButtonUp,
 kDoubleClick,
 kTripleClick,
 kQuadrupleClick,
 kQuintupleClick,
 kMouseWheel,
 kControlCmd,
 kKeyDown,
 kKey,
 kKeyUp,
 kTabletEvent,
 kGestureEvent,
 kMultiTouchEvent,
 
 
 // The following event types are ONLY available to event watchers and to event handlers pushed on to the event dispatcher
 // Note: These events may be removed later in the CC dev cycle, so it is preferable to rely on alternative mechanisms
 // see: IApplicationActiveState, kApplicationSuspend/ResumeMsg notifications, and the WindowActivationChanged method of IControlView
 
 kSuspend,
 kResume,
 kActivate,
 kDeactivate,
 
 
 // The following event types are ONLY available to event watchers
 // Note: This events may be removed later in the CC dev cycle, so it is preferable to rely on alternative mechanisms
 // see: idle tasks or timers.
 
 kNull,
 
 
 // Unrecognized event
 
 kInvalid,

#if 0 // OBSOLETE EVENT TYPES, these are not sent in CC and beyond
 kApple, 
 kUpdate,
 kCarbonModifierChangedEvent,
 kCommandProcess,
 kPlatformEvent,
#endif // OBSOLETE

 kEndOfEventTypes
 } EventType;

 virtual EventType GetType() const = 0;

 virtual void SetType(const EventType theType) = 0;
 
 enum GestureType {
 kGestureNone = 0,
 kGestureBegin,
 kGestureEnd,
 kGestureRotation,
 kGestureMagnify,
 kGestureSwipe,
 kGesturePan,
 kEndOfGestureTypes
 };
 
 virtual GestureType GetGestureType() const {return IEvent::kGestureNone;}
 
 virtual float GetRotationInDegrees() const {return 0.0f;}
 virtual float GetMagnificationAmount() const {return 0.0f;}

 enum SwipeDirection {
 kSwipeDirectionNone = 0,
 kSwipeDirectionLeft,
 kSwipeDirectionRight,
 kSwipeDirectionUp,
 kSwipeDirectionDown
 };
 virtual SwipeDirection GetSwipeDirection() const {return IEvent::kSwipeDirectionNone;}

 enum TabletAction {
 kTabletActionNone = 0,
 kTabletActionProximity, // pen entered/exited the tablet's sensitivity range
 kTabletActionPen, // pen param changed: pressure, tilt, tip, etc. -- not just position
 kEndOfTabletActions
 };
 
 virtual TabletAction GetTabletAction() const {return IEvent::kTabletActionNone;}
 
 // Note: no support yet for tablet event details (have to look at underlying platform event) 

};

#endif // __IEVENT__