ICursorMgr.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard
// 
// $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 __ICURSORMGR__
#define __ICURSORMGR__

#include "IPMUnknown.h"
#include "ShuksanID.h"
#include "CursorSpec.h"
#include "ISnapTo.h"


class ICursorProvider;
class ModalCursorTicket;


// ===================================================================================
// class ICursorMgr
// ===================================================================================
class ICursorMgr : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ICURSORMGR };

 public:
 enum eCursorModifierState
 {
 kNoModifiers = 0x00, 
 kCmdKey = 0x01, 
 kShiftKey = 0x02, 
 kCapsLockKey = 0x04, 
 kOptionAltKey = 0x08, kAltKey = kOptionAltKey, kOptionKey = kOptionAltKey, 
 kControlKey = 0x10,
 kSpaceKey = 0x20
 };

 public: 
 virtual CursorID GetCursorID() = 0;

 virtual CursorSpec GetCursorSpec() = 0;
 
 virtual ICursorProvider* SetToolCursorProvider(ICursorProvider*) = 0;

 virtual void LockToolCursor(bool16 lockit = kTrue) = 0;

 virtual CursorSpec GetSnapToCursorSpec(CursorSpec& currentSpec, SnapType snapType) = 0; 

 enum {
 kNoModalCursor = -1, 
 kModalCursor = 0, 
 kWaitCursor = 1, 
 kModalDialogCursor = 2, 
 kDelayedBusyCursor = 3
 }; 
 enum {
 kDontRestorePreviousCursor = 0, 
 kRestorePreviousCursor = 1, 
 kRecomputeNewCursor = 3,
 };

 virtual void BeginModalCursor(const ModalCursorTicket& callerID) = 0; 
 virtual void BeginModalCursor(const ModalCursorTicket& callerID, const CursorSpec& newspec) = 0;
 virtual void ChangeModalCursor(const ModalCursorTicket& callerID, const CursorSpec& newspec) = 0;
 virtual void EndModalCursor(const ModalCursorTicket& callerID) = 0;
 virtual void BeginWaitCursor(const ModalCursorTicket& callerID) = 0;
 virtual void AnimateWaitCursor(const ModalCursorTicket& callerID) = 0;
 virtual void EndWaitCursor(const ModalCursorTicket& callerID) = 0;
 
 virtual void SetNewCursor(ICursorProvider *, IControlView *, GSysPoint, eCursorModifierState) = 0;

 virtual void SetNewCursor() = 0;
 
 virtual ICursorProvider* TheToolCursorProvider() const = 0; 
 
 virtual void Hide() = 0;
 virtual void Show() = 0;
 virtual bool16 IsHidden() const = 0;
 
 virtual void Suspend() = 0;
 virtual bool16 IsSuspended() const= 0;
 virtual void Resume() = 0;

 virtual void StopTrackingCursor() =0;
 
 
 virtual void Init() = 0;
 virtual void Shutdown() = 0;
 virtual void ClearCache() = 0;
 
 public:
 enum {kSpinningBeachBall = 200, kSpinningWatch = 210, kCyclingArrow = 220};
 
 virtual void ObscureCursor() = 0;
 
 virtual void UnobscureCursor() = 0;
 
 virtual void AnimateWaitCursor() = 0;
 

#if MACINTOSH

 virtual void SetBusyCursorTimeout(int32 timeout) = 0;
 
 
 virtual void SetBusyCursorDelay(int32 delay) = 0;
 
 
 virtual void SetBusyCursorID(ResID id) = 0;
 
#endif

 protected:
 virtual bool16 ModifiersAffectProvider(IControlView *view) const = 0;

 virtual bool16 LocationAffectsProvider(IControlView *view) const = 0;

 virtual bool16 HaveModifiersChanged(eCursorModifierState& oldModifiers, eCursorModifierState& newModifiers) = 0;
};


// ===================================================================================
// class ModalCursorTicket
// ===================================================================================
class ModalCursorTicket {
 public:
 typedef base_type data_type;
 ModalCursorTicket(uint32 caller = 0xFFFFFFFF, int16 restore = ICursorMgr::kRestorePreviousCursor, int16 modalType = ICursorMgr::kModalCursor) :
 fModalType(modalType), fRestoreCursor(restore), fCallerID(caller) {}
 ModalCursorTicket(const ModalCursorTicket& other) :
 fModalType(other.fModalType), fRestoreCursor(other.fRestoreCursor), fCallerID(other.fCallerID)
 {
 }
 
 ModalCursorTicket& operator=(const ModalCursorTicket& other)
 {
 if (this != &other)
 {
 fModalType = other.fModalType;
 fRestoreCursor = other.fRestoreCursor;
 fCallerID = other.fCallerID;
 }
 return *this;
 }
 
 bool operator==(const ModalCursorTicket& other) const
 {
 if ((char*) this == (char*) &other)
 return kTrue;
 else if ((fCallerID == other.fCallerID) && (fModalType == other.fModalType))
 return kTrue;
 else
 return kFalse;
 }

 int16 fModalType;
 int16 fRestoreCursor;
 uint32 fCallerID;
};

#endif // __ICURSORMGR__