Class: TMouseDragAndDropInteractor

Declaration: MouseDragAndDrop.h

Taxonomy Categories:

Member Functions:

~TMouseDragAndDropInteractor
TMouseDragAndDropInteractor
operator=
operator<<=
operator>>=
MouseDown
MouseUp
MouseMoved
HandleDeactivate
HandleActivate

Interface Category:

API.

Inherits From:

TDragAndDropInteractor, MMouseEventHandler

Inherited By:

None.

Purpose:

TMouseDragAndDropInteractor handles drag-and-drop interaction in direct response to mouse input.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive classes from TMouseDragAndDropInteractor.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TMouseDragAndDropInteractor::~TMouseDragAndDropInteractor

virtual ~ TMouseDragAndDropInteractor ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMouseDragAndDropInteractor::TMouseDragAndDropInteractor

TMouseDragAndDropInteractor (TDragAndDropItem * adoptedScrap, MGraphic * adoptedGraphic, const TViewHandle & coordinateView)
TMouseDragAndDropInteractor (const TMouseDragAndDropInteractor &)

Interface Category:

API.

Purpose:

Creates a TMouseDragAndDropInteractor for the specified scrap item and view.
Copy constructor.

Calling Context:

Called to create a TMouseDragAndDropInteractor for the specified scrap item and view.
Called to copy an object.

Parameters:

TDragAndDropItem * adoptedScrap -The adopted scrap for this interactor.
MGraphic * adoptedGraphic -The graphic to use for animated feedback.
const TViewHandle & coordinateView -The coordinate view for this interactor.
const TMouseDragAndDropInteractor & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMouseDragAndDropInteractor::operator=

TMouseDragAndDropInteractor & operator =(const TMouseDragAndDropInteractor &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TMouseDragAndDropInteractor & -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMouseDragAndDropInteractor::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The source stream.

Return Value:

Returns a reference to the stream from which the object streams itself.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMouseDragAndDropInteractor::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The destination stream.

Return Value:

Returns a reference to the stream to which the object streams itself.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMouseDragAndDropInteractor::MouseDown

virtual bool MouseDown (TMouseDownEvent & mouseDown)

Interface Category:

API.

Purpose:

Starts a dragging operation for the item associated with this interactor at the location specified by the mouse event.

Calling Context:

Called when a dragging operation is started.

Parameters:

TMouseDownEvent & mouseDown -The mouse event.

Return Value:

Always returns true.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMouseDragAndDropInteractor::MouseUp

virtual bool MouseUp (TMouseUpEvent & mouseUp)

Interface Category:

API.

Purpose:

Drops the item associated with this interactor at the location specified by the mouse event.

Calling Context:

Called when a dragging operation ends.

Parameters:

TMouseUpEvent & mouseUp -The mouse event.

Return Value:

Always returns true.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMouseDragAndDropInteractor::MouseMoved

virtual bool MouseMoved (TMouseMovedEvent & mouseMoved)

Interface Category:

API.

Purpose:

Moves the item being dragged to the intermediate location specified by the mouse event.

Calling Context:

Called at intermediate points along the trajectory of the item being dragged.

Parameters:

TMouseMovedEvent & mouseMoved -The mouse event.

Return Value:

Always returns true.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMouseDragAndDropInteractor::HandleDeactivate

virtual void HandleDeactivate ()

Interface Category:

API.

Purpose:

An override that stops the Interactor, if the Interactor really was started.

Calling Context:

Called by the Input system framework at the time the Interactor is deactivated.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMouseDragAndDropInteractor::HandleActivate

virtual void HandleActivate ()

Interface Category:

API.

Purpose:

An override that prevents the interactor from starting immediately: instead, it waits for the tolerance test to pass, and then starts the interactor.

Calling Context:

Called by the Input system framework at the time the Interactor is activated.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This member function is included to address activation policy and implement a dragging hysteresis. For example, an object can be dragged within some small tolerance and not be counted as a drag, but as a mouse click.

Click the icon to mail questions or corrections about this material to Taligent personnel.