Class: TDragAndDropInteractor

Declaration: DragAndDrop.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TInteractor

Inherited By:

TMouseDragAndDropInteractor

Purpose:

TDragAndDropInteractor represents a drag-and-drop interaction.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Other input devices wanting to be interactors for drag and drop can derive classes from TDragAndDropInteractor. TMouseDragAndDropInteractor is a system provided derived class for the mouse input device. There are no required functions to override.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TDragAndDropInteractor::~TDragAndDropInteractor

virtual ~ TDragAndDropInteractor ()

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: TDragAndDropInteractor::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 the object streams itself in from.

Exceptions:

Throws TInvalidVersionError() if the flattened of the object from the stream is not the original version.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDragAndDropInteractor::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 the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDragAndDropInteractor::TDragAndDropInteractor

TDragAndDropInteractor (TDragAndDropItem * adoptedDragAndDropItem, MGraphic * adoptedGraphic)
TDragAndDropInteractor (const TDragAndDropInteractor &)

Interface Category:

API.

Purpose:

Creates a TDragAndDropInteractor for the specified item being dragged.
Copy constructor.

Calling Context:

Called when an item is being dragged.
Called to copy an object.

Parameters:

TDragAndDropItem * adoptedDragAndDropItem -The item being dragged.
MGraphic * adoptedGraphic -The graphic used for animated dragging feedback.
const TDragAndDropInteractor & -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: TDragAndDropInteractor::operator=

TDragAndDropInteractor & operator =(const TDragAndDropInteractor &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TDragAndDropInteractor & -The object being 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: TDragAndDropInteractor::HandleActivate

virtual void HandleActivate ()

Interface Category:

API.

Purpose:

Changes the graphic for the item associated with this interactor to indicate the item is being dragged.

Calling Context:

Called by the Interaction framework when the drag-and-drop interaction begins.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDragAndDropInteractor::HandleDeactivate

virtual void HandleDeactivate ()

Interface Category:

API.

Purpose:

Changes the graphic for the item associated with this interactor to indicate the item is no longer being dragged.

Calling Context:

Called by the Interaction framework when a drag-and-drop interaction is completed.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDragAndDropInteractor::DropAt

virtual void DropAt (const TGPoint & where)

Interface Category:

API.

Purpose:

Ends the drag-and-drop interaction for the dragged item and creates a TDropNegotiator to begin data movement the source to the target.

Calling Context:

Called when the item being dragged is dropped.

Parameters:

const TGPoint & where -The global coordinates of the dragged object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDragAndDropInteractor::DragAt

virtual void DragAt (const TGPoint & where)

Interface Category:

API.

Purpose:

Provides animated dragging feedback.

Calling Context:

Called at intermediate points along a dragged object's trajectory to provide animated dragging feedback.

Parameters:

const TGPoint & where -The global coordinates of the intermediate point on the object's trajectory.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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