CTracker.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 __CTRACKER__
#define __CTRACKER__

#include "ITracker.h"
#include "ITrackerTimer.h"
#include "HelperInterface.h"
#include "PMRect.h"
#include "AcquireModalCursor.h"
#include "AutoBusyCursor.h"
#include "IDynamicTrackerData.h"
#include "K2Vector.h"
#include "CSprite.h"

class IPanorama;
class ISnapTo;
class ILayoutSelectionSuite;
class ISelectionManager;
class IRulerData;
class IEventHandler;

//----------------------------------------------------------------------------------------
// CTracker: Concrete implementation for trackers
//----------------------------------------------------------------------------------------


class CTracker : public ITracker
{
 public:
 CTracker(IPMUnknown *boss);
 virtual ~CTracker();
 
 virtual void SetupTracker(IControlView* theControlView, ISnapTo* theSnapper = NULL, IItemContext* context = NULL);

 virtual IControlView* QueryControlView() const;

 virtual bool16 IsEnabled();

 virtual bool16 IsTracking();

 virtual void EnableTracking();

 virtual void DisableTracking();
 
 virtual bool16 BeginTracking(IEvent* theEvent);

 virtual void HandleContinueTracking(const GSysPoint& where);

 virtual void ContinueTracking(const PBPMPoint& where, bool16 mouseDidMove);

 virtual bool16 EndTracking(IEvent* theEvent);

 virtual void AbortTracking(IEvent* theEvent);

 virtual void TimerMessage(int32 flags) { SetTimerFlags(GetTimerFlags() | flags); }

 virtual bool16 WantTimer(ClassID trackerTimerBoss);

 protected:
 
 virtual void Initialize(IEvent* theEvent);
 
 virtual bool16 DoBeginTracking(IEvent* theEvent);
 
 virtual bool16 DoEndTracking(IEvent* theEvent);
 
 virtual void NotifyBeginTracking(const PMPoint& startPt, IDynamicTrackerData::TrackingEffect effect = IDynamicTrackerData::kUnknown);

 virtual void NotifyContinueTracking(const PMPoint& startPt, const PMPoint& endPoint, IDynamicTrackerData::TrackingEffect effect = IDynamicTrackerData::kUnknown);
 
 virtual void NotifyEndTracking(const PMPoint& startPt, const PMPoint& endPoint, IDynamicTrackerData::TrackingEffect effect = IDynamicTrackerData::kUnknown);

 virtual IDynamicTrackerData::TrackingEffect GetTrackingEffect(IDynamicTrackerData::TrackingState state);
 
 virtual void PushEventHandler();
 
 virtual void PopEventHandler();
 
 virtual bool16 WantsToAutoScroll(const PMPoint& currentPoint);

 virtual PMPoint AutoScroll(const PMPoint& scrollBy, const PMPoint& scrolledPoint);
 
 virtual void GlobalToPasteboard(const GSysPoint& thePoint, PBPMPoint& convertedPoint);

 virtual PMPoint PasteboardToGlobal(const PBPMPoint& pbPoint);
 
 virtual IPanorama *QueryPanorama( IControlView *pView ) const;
 
 virtual void DisableUpdates();
 
 virtual void EnableUpdates();

 void DeselectAllItems() ; 

 virtual void ComputeAdjustedPoint (PMPoint& adjustedPoint);
 
 void InitializeModalCursor();

 void ChangeModalCursor(const CursorSpec& spec);

 void UpdateModalCursor();
 
 void ReleaseModalCursor();

 virtual uint32 GetMouseMoveDelay(){ return kDefaultMouseMoveDelay; }
 
 virtual uint32 GetMouseSteadyDelay(){ return kDefaultMouseSteadyDelay; }

 virtual bool16 AdjustPoint(PBPMPoint& point);

 void StartTimer(ClassID trackerTimerBoss, uint32 milliSeconds, uint32 mouseMoveDelay = kDefaultMouseMoveDelay, uint32 mouseSteadyDelay = kDefaultMouseSteadyDelay);

 void StopTimer(ClassID trackerTimerBoss);

 bool16 GetTimerFlags() { return (fTimerFlags); }
 void SetTimerFlags(int32 flags) { fTimerFlags = flags; }
 
 uint32 GetElapsedTime() { return SystemUtils::TickCount() - fFirstTicks; }

protected:
 virtual IDataBase* GetTrackingDataBase() const;
 
 IControlView* fControlView;
 IDataBase* fDataBase;
 IItemContext* fItemContext;
 ISnapTo* fSnapTo;
 SnapType fSnapType; // Current snap status of fCurrentPoint. Should be updated when DoSnapTo is called.

 bool16 fIsTracking;
 bool16 fWantsToAutoScroll;
 PMPoint fPreviousPoint;
 PMPoint fFirstPoint;
 GSysPoint fFirstGlobalWhere;
 uint32 fFirstTicks; // TickCount at BeginTracking time
 
 
 bool16 fEnabled;

 IRulerData* fHorzRuler;
 IRulerData* fVertRuler;

 AcquireModalCursor* fModalCursor;
 AutoBusyCursor* fAutoBusyCursor;
 
 uint32 fOldSchedulerMask; // save off the old scheduler mask, so it can be restored

 int32 fTimerFlags;
 K2Vector<ITrackerTimer*> fTimerPtrs;
 //InterfaceCollection<ITrackerTimer> fTimerCollection;

#ifdef DEBUG
 const IEventHandler* fMyEventHandler;
#endif

 // Deactivate the IPageItemFocus at the keyboard
 static void DeactivatePageItem() ;
 
 
};


#endif