PA_GetDragAndDropKind


version 2003


PA_GetDragAndDropKind (dragInfo) → PA_DragKind

Parameter Type Description
dragInfo PA_DragAndDropInfo Information about the dragged object
Function result PA_DragKind Kind of the object being dragged

Description

The routine PA_GetDragAndDropKind returns the kind of object being drag/dropped onto the area. The area calls after having retrieved the current information using PA_GetDragAndDropInfo , at eAE_AllowDrop or eAE_Drop event.

It returns a value of type PA_DragKind , defined as an enum in the "PublicTypes.h" header file :

typedef enum
{
   eDK_InvalidDrag = -1,
   eDK_DragVariable = 0,
   eDK_DragTable,
   eDK_DragField
} PA_DragKind;

Examples

(1) See the sample in Drag and drop with a plugin area.

(2) Some wrappers of this routine.

   char DraggedObjectIsAVariable (PA_DragAndDropInfo ddi)
   {
      return (char) (PA_GetDragAndDropKind(ddi) ==  eDK_DragVariable) ? 1 : 0;
   }
 
   char DraggedObjectIsAField (PA_DragAndDropInfo ddi)
   {
      return (char)( PA_GetDragAndDropKind(ddi) ==  eDK_DragField) ? 1 : 0;
   }

See Also

Drag and drop with a plugin area .

Error Handling

None.