ITracker.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 __ITRACKER__
#define __ITRACKER__

#include "PMTypes.h"
#include "PMPoint.h"

//----------------------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------------------

class IEvent;
class IControlView;
class ISnapTo;
class IItemContext;

//----------------------------------------------------------------------------------------
// ITracker: Abstract interface for trackers
//----------------------------------------------------------------------------------------

class ITracker : public IPMUnknown
{
 public:
 inline void SetupTracker( IControlView* theControlView){ SetupTracker(theControlView, (ISnapTo*)0, (IItemContext*)0);}

 inline void SetupSpecialTracker( IControlView* theControlView, ISnapTo* theSnapper, IItemContext* context){ SetupTracker(theControlView, theSnapper, context);}
 
 virtual IControlView* QueryControlView() const = 0;

 virtual bool16 IsEnabled() = 0;

 virtual bool16 IsTracking() = 0; // BeginTracking has been called

 virtual void EnableTracking() = 0;

 virtual void DisableTracking() = 0;

 virtual bool16 BeginTracking(IEvent* theEvent) = 0;

 virtual void HandleContinueTracking(const GSysPoint& where) = 0;

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

 virtual bool16 EndTracking(IEvent* theEvent) = 0;

 virtual void AbortTracking(IEvent* theEvent) = 0;

 virtual void TimerMessage(int32 data) = 0;

 virtual bool16 DoBeginTracking(IEvent* theEvent) = 0;

 virtual bool16 DoEndTracking(IEvent* theEvent) = 0;

 virtual void Initialize(IEvent* theEvent) = 0;

private:

 virtual void SetupTracker(IControlView* theControlView, ISnapTo* theSnapper, IItemContext* context) = 0;
};

#endif