Inheritance diagram for CLayoutTracker:

Public Member Functions
virtual bool16	BeginTracking (IEvent *theEvent)

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

virtual bool16	EndTracking (IEvent *theEvent)

virtual void	AbortTracking (IEvent *theEvent)

Public Member Functions inherited from CTracker
	CTracker (IPMUnknown *boss)

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 void	HandleContinueTracking (const GSysPoint &where)

Public Member Functions inherited from ITracker
void	SetupTracker (IControlView *theControlView)

void	SetupSpecialTracker (IControlView theControlView, ISnapTo theSnapper, IItemContext *context)

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Protected Member Functions
virtual void	Initialize (IEvent *theEvent)

virtual bool16	DoBeginTracking (IEvent *theEvent)

virtual void	StartDrag (const PBPMPoint &where)

virtual void	ContinueDrag (const PBPMPoint &where, bool16 shiftDown)

virtual void	StopDrag (const PBPMPoint &where)

	CLayoutTracker (IPMUnknown *boss)

virtual void	HandleStartDrag (const PBPMPoint &where)

virtual void	HandleStopDrag (const PBPMPoint &where)

virtual void	TimerMessage (int32 flags)

virtual bool16	WantTimer (ClassID trackerTimerBoss)

virtual void	SetDragStarted (bool16 start)

virtual bool16	IsDragStarted () const

virtual void	SetShiftKeyPressed (bool16 pressed)

virtual bool16	IsShiftKeyPressed () const

Protected Member Functions inherited from CTracker
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 ()

virtual uint32	GetMouseSteadyDelay ()

virtual bool16	AdjustPoint (PBPMPoint &point)

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

void	StopTimer (ClassID trackerTimerBoss)

bool16	GetTimerFlags ()

void	SetTimerFlags (int32 flags)

uint32	GetElapsedTime ()

virtual IDataBase *	GetTrackingDataBase () const

Protected Attributes
PMPoint	fInitialViewPoint

bool16	fDragStarted

bool16	fShiftKeyPressed

PMRect	fPasteboardBounds

Protected Attributes inherited from CTracker
IControlView *	fControlView

IDataBase *	fDataBase

IItemContext *	fItemContext

ISnapTo *	fSnapTo

SnapType	fSnapType

bool16	fIsTracking

bool16	fWantsToAutoScroll

PMPoint	fPreviousPoint

PMPoint	fFirstPoint

GSysPoint	fFirstGlobalWhere

uint32	fFirstTicks

bool16	fEnabled

IRulerData *	fHorzRuler

IRulerData *	fVertRuler

AcquireModalCursor *	fModalCursor

AutoBusyCursor *	fAutoBusyCursor

uint32	fOldSchedulerMask

int32	fTimerFlags

K2Vector< ITrackerTimer * >	fTimerPtrs

Additional Inherited Members
Static Protected Member Functions inherited from CTracker
static void	DeactivatePageItem ()

Member Function Documentation

virtual void CLayoutTracker::AbortTracking ( IEvent * theEvent )

virtual

Override this method to provide any special behavior required if the tracker was aborted in the middle of tracking. For example the PlaceTextTracker needs to abort if a menu is selected after the tracker is enabled

Parameters

theEvent [IN] the associated event

Reimplemented from CTracker.

virtual bool16 CLayoutTracker::BeginTracking ( IEvent * theEvent )

virtual

Start tracking the mouse. Usually called as the result of a mouse down event.

Parameters

theEvent [IN] the associated event

Reimplemented from CTracker.

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

virtual

The default implementation does nothing; client code will likely override this. Called after BeginTracking() and before EndTracking(). ContinueTracking is called repeatedly even when the mouse is not moving (to support things like auto scrolling)

Parameters

where	[IN] current location of mouse ptr
mouseDidMove	[IN] kTrue if mouse-event generated this call, kFalse otherwise (e.g. auto-scrolling)

Reimplemented from CTracker.

virtual bool16 CLayoutTracker::DoBeginTracking ( IEvent * theEvent )

protectedvirtual

A return value of kTrue means "continue tracking". i.e. this tracker did not simply spawn a different one

Parameters

theEvent [IN] event that is behind this call

Reimplemented from CTracker.

virtual bool16 CLayoutTracker::EndTracking ( IEvent * theEvent )

virtual

Tracking is completed. Tidy up and post any dynamic commands.

Parameters

theEvent [IN] the associated event

Reimplemented from CTracker.

virtual void CLayoutTracker::Initialize ( IEvent * theEvent )

protectedvirtual

Subclasses of CTracker can override Initialize and DoBeginTracking() instead of overriding BeginTracking(). This way they are guaranteed that Initialize has been called first, and the thread only gets started if DoBeginTracking() returns kTrue.

Previously, overrides of BeginTracking() had to call the inherited method at the end, thereby losing the benefit of any initialization done by the base class.

Set initial fields. Called before DoBeginTracking()

Parameters

theEvent [IN] the event at time of call

Reimplemented from CTracker.

virtual void CLayoutTracker::TimerMessage ( int32 flags )

protectedvirtual

Called after the ITrackerTimer has expired. Timer is started in BeginTracking. Used to turn on patient user tracking by CLayoutTracker. Can be used to change cursor feedback.

Parameters

flags [IN] int32 value, flags from IShape, typically draw flags such as kPatientUser or kDynamicPause

See Also: kMouseTrackerBoss; ITrackerTimer.h; CLayoutTracker.h; IShape.h; StartTimer, StopTimer, WantTimer

Reimplemented from CTracker.

virtual bool16 CLayoutTracker::WantTimer ( ClassID trackerTimerBoss )

protectedvirtual

Stop a tracker timer with a particular ClassID

Parameters

trackerTimerBoss [IN] ClassID for the tracker timer. Typical values are kMouseTrackerBoss, kPatientUserBoss and kDynamicPauseTimerBoss.

Returns: bool16 kTrue to start the timer for this class, kFalse otherwise. Default implemention returns kFalse.

Reimplemented from CTracker.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation