IEventUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Lonnie Millett
// 
// $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 __IEventUtils__
#define __IEventUtils__

// ----- Interfaces -----

#include "IPMUnknown.h"

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

// ----- ID.h files -----

#include "AppUIID.h"

// ----- Forward declarations -----

class IEvent;
class IControlView;
class CursorSpec;

class IEventUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IEVENTUTILS };

 virtual GSysPoint GetGlobalMouseLocation() = 0;

 virtual bool16 IsMouseButtonDown() = 0;

 virtual bool16 IsMouseButtonReleased() = 0;

 virtual bool16 IsUserStartingDrag(IEvent *e, bool16 &isPatientUser, const CursorSpec* patientCursor = nil) = 0;

 virtual bool16 IsUserStartingDrag(IEvent *e, bool16 &isPatientUser, const SysRect& startOnExitGRect, const CursorSpec* patientCursor = nil) = 0;

 virtual void PMCaptureMouse(IControlView* theView) = 0;
 
 virtual void PMReleaseMouse(void) = 0;

 virtual void RemoveNextKeyCmd(IEvent* e) = 0;

 virtual bool16 IsDragOrTrackInProgress() = 0;

#ifdef MACINTOSH

 virtual void MovePaletteWindowsOffScreen(bool16 off) = 0;
#endif

 virtual int16 GetModifiersFromEvent(const IEvent* e) = 0;

#ifdef WINDOWS

 virtual bool16 HandleSysCommandMessage(HWND hWnd, UINT sysMsg, WPARAM wParam, LPARAM lParam) = 0;
#endif

 virtual bool16 IsTrackInProgress() = 0;
 
 virtual bool16 IsUserEventPending(bool16 needPendingKeyEventOnly = kFalse) = 0;
 
 virtual void EmulateAsynModalLoop() = 0;
};

#endif