Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_MouseTracker Class Reference

CP_MouseTracker. More...

List of all members.

Public Member Functions

 CP_MouseTracker (CP_View *inDestPane, trackerProcPtr inTrackingProcPtr, void *inData=NULL, trackerProcPtr inPreTrackingProcPtr=NULL, trackerProcPtr inPostTrackingProcPtr=NULL)
virtual ~CP_MouseTracker ()
UInt32 GetTrackDelay ()
SInt32 * GetData ()
CP_Point GetLastMouseLocation ()
void SetTrackDelay (UInt32 inTrackDelay)
void SetData (void *inData)
virtual void TrackMouse (CP_Point &inStartLocation)

Protected Member Functions

virtual void OnPreTrackMouse (CP_Point &inLocation)
virtual void OnTrackingMouse (CP_Point &inLocation)
virtual void OnPostTrackMouse (CP_Point &inLocation)

Protected Attributes

CP_View * fDestView
void * fData
UInt32 fTrackingDelay
trackerProcPtr fPreTrackingProcPtr
trackerProcPtr fTrackingProcPtr
trackerProcPtr fPostTrackingProcPtr
CP_Point fLastMouseLocation

Detailed Description

A class to handle tracking the mouse in a destination CP_View object.

Constructor & Destructor Documentation

CP_MouseTracker::CP_MouseTracker (  CP_View *  inDestPane,
trackerProcPtr  inTrackingProcPtr,
void *  inData = NULL,
trackerProcPtr  inPreTrackingProcPtr = NULL,
trackerProcPtr  inPostTrackingProcPtr = NULL
) 
 

Constructor.

Parameters:
inDestPane - the CP_View oject that this object is tracking the mouse in.
inTrackingProcPtr - the routine called during mouse tracking.
inData - any data passed to the callback routines.
inPreTrackingProcPtr - the routine called before the mouse is tracked.
inPostTrackingProPtr - the routine called after the mosue is tracked.

CP_MouseTracker::~CP_MouseTracker (   )  [virtual]
 

Destructor.

Member Function Documentation

UInt32 CP_MouseTracker::GetTrackDelay (   ) 
 

Return the delay used before calling the OnTrackingMouse callback.

SInt32* CP_MouseTracker::GetData (   ) 
 

Return any data associated with this object.

CP_Point CP_MouseTracker::GetLastMouseLocation (   ) 
 

Return the last location of the mouse.

void CP_MouseTracker::SetTrackDelay (  UInt32  inTrackDelay  ) 
 

Set the tracking delay.

void CP_MouseTracker::SetData (  void *  inData  ) 
 

Set any data associated with this object. This data is passed to all of the tracking callbacks.

void CP_MouseTracker::TrackMouse (  CP_Point &  inStartLocation  )  [virtual]
 

MacOS routine to track the mouse while the mouse is down. This routine will call the above routines, which in turn call your pre, during and post tracking callbacks.

Parameters:
inLocation - the initial location of the mouse.

void CP_MouseTracker::OnPreTrackMouse (  CP_Point &  inLocation  )  [protected, virtual]
 

Called just before we enter the main mouse tracking loop. The routine calls your pre tracking procedure.

Parameters:
inLocation - the initial location of the mouse.

void CP_MouseTracker::OnTrackingMouse (  CP_Point &  inLocation  )  [protected, virtual]
 

Called during mouse tracking. This routine calls your tracking procedure continuously while the mouse is down.

Parameters:
inLocation - current location of the mouse.

void CP_MouseTracker::OnPostTrackMouse (  CP_Point &  inLocation  )  [protected, virtual]
 

Called after the mouse is released. The routine calls your post tracking procedure.

Parameters:
inLocation - the initial location of the mouse.

Member Data Documentation

CP_View* CP_MouseTracker::fDestView [protected]
 

The destination pane we are tracking in.

void* CP_MouseTracker::fData [protected]
 

Data associated with this object.

UInt32 CP_MouseTracker::fTrackingDelay [protected]
 

The delay between tracking calls.

trackerProcPtr CP_MouseTracker::fPreTrackingProcPtr [protected]
 

Callback to a routine called just before we track the mouse.

trackerProcPtr CP_MouseTracker::fTrackingProcPtr [protected]
 

Callback to a routine called continuously during tracking.

trackerProcPtr CP_MouseTracker::fPostTrackingProcPtr [protected]
 

Callback to a routine called after tracking.

CP_Point CP_MouseTracker::fLastMouseLocation [protected]
 

Last location of the mouse.

The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:01:53 2005 for CPLAT by  doxygen 1.4.0