InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CDragDropTargetFlavorHelper Class Referenceabstract

#include <CDragDropTargetFlavorHelper.h>

Inheritance diagram for CDragDropTargetFlavorHelper:
IDragDropTargetFlavorHelperIPMUnknownBscDNDCustomFlavorHelperCusDtLnkUIDDTargetFlavorHelper

Public Member Functions

 CDragDropTargetFlavorHelper (IPMUnknown *boss)
 
virtual DragDrop::eHelperType GetHelperType () const
 
virtual bool16 HelperWillDoDragTracking () const
 
virtual void PrepareHelperForDrag () const
 
virtual DragDrop::TargetResponse CouldAcceptTypes (const IDragDropTarget *, DataObjectIterator *, const IDragDropSource *, const IDragDropController *) const =0
 
bool16 CanHandleDragData () const
 
void SetCanHandleDragData (bool16 can)
 
virtual bool16 DoDragEnter_PreflightDragData (IDragDropTarget *, IDragDropController *)
 
virtual void DoDragEnter (IDragDropTarget *)
 
virtual void DoDragWithin (IDragDropTarget *, const PMPoint &localPt)
 
virtual void DoDragLeave (IDragDropTarget *)
 
virtual ErrorCode ProcessDragDropCommand (IDragDropTarget *, IDragDropController *, DragDrop::eCommandType)=0
 
DragDrop::TargetResponse HandleCouldAcceptTypes (const IDragDropTarget *, DataObjectIterator *, const IDragDropSource *, const IDragDropController *) const
 
virtual PMRect GetDragDataBounds () const
 

Protected Member Functions

DragDrop::TargetResponse GetCachedResponse () const
 

Protected Attributes

DragDrop::TargetResponse fCachedResponse
 
bool16 fCanHandleDragData
 

Additional Inherited Members

- Public Types inherited from IDragDropTargetFlavorHelper
enum  { kDefaultIID = IID_IDRAGDROPTARGETFLAVORHELPER }
 

Detailed Description

Common baseclass for Drag Drop Target Flavor Helpers. Implementors of drop target flavor helpers should subclass CDragDropTargetFlavorHelper,

See Also
IDragDropTargetFlavorHelper

Member Function Documentation

bool16 CDragDropTargetFlavorHelper::CanHandleDragData () const
inline

Once we see the data inside a drag, can we still perform the drop.

virtual DragDrop::TargetResponse CDragDropTargetFlavorHelper::CouldAcceptTypes (const IDragDropTarget,
DataObjectIterator,
const IDragDropSource,
const IDragDropController 
) const
pure virtual

Override to indicate if this target helper can accept the current drag.

Implements IDragDropTargetFlavorHelper.

Implemented in CusDtLnkUIDDTargetFlavorHelper, and BscDNDCustomFlavorHelper.

virtual void CDragDropTargetFlavorHelper::DoDragEnter (IDragDropTarget)
virtual

Override to respond to a drag entering the target. Default implementation falls back to the target.

Implements IDragDropTargetFlavorHelper.

virtual bool16 CDragDropTargetFlavorHelper::DoDragEnter_PreflightDragData (IDragDropTarget,
IDragDropController 
)
virtual

Override to give helper a chance to "preflight" the data contained in a drag. Default implementation returns kTrue (all is well).

Implements IDragDropTargetFlavorHelper.

virtual void CDragDropTargetFlavorHelper::DoDragLeave (IDragDropTarget)
virtual

Override to respond to a drag leaving the target. Default implementation falls back to the target.

Implements IDragDropTargetFlavorHelper.

virtual void CDragDropTargetFlavorHelper::DoDragWithin (IDragDropTarget,
const PMPointlocalPt 
)
virtual

Override to respond to a drag moving within the target. Default implementation falls back to the target.

Implements IDragDropTargetFlavorHelper.

virtual PMRect CDragDropTargetFlavorHelper::GetDragDataBounds () const
virtual

Override to return the bounds of the item(s) being dragged. Default implementation returns an empty rect.

Implements IDragDropTargetFlavorHelper.

virtual DragDrop::eHelperType CDragDropTargetFlavorHelper::GetHelperType () const
virtual

Override to change the type or priority of the helper. Default implementation returns DragDrop::kDefaultHelper.

Implements IDragDropTargetFlavorHelper.

DragDrop::TargetResponse CDragDropTargetFlavorHelper::HandleCouldAcceptTypes (const IDragDropTarget,
DataObjectIterator,
const IDragDropSource,
const IDragDropController 
) const
virtual

INTERNAL_USE_ONLY - Subclasses should override CouldAcceptTypes.

Implements IDragDropTargetFlavorHelper.

virtual bool16 CDragDropTargetFlavorHelper::HelperWillDoDragTracking () const
virtual

Override if the helper wants to do its own drag dracking. Default implementation returns kFalse.

Implements IDragDropTargetFlavorHelper.

virtual void CDragDropTargetFlavorHelper::PrepareHelperForDrag () const
virtual

Override to perform any necessary initialization of the target helper, called from HandleCouldAcceptTypes. Default implementation does nothing.

virtual ErrorCode CDragDropTargetFlavorHelper::ProcessDragDropCommand (IDragDropTarget,
IDragDropController,
DragDrop::eCommandType  
)
pure virtual

Override to create and process (or schedule) the commands needed to complete the drop operation.

Implements IDragDropTargetFlavorHelper.

Implemented in CusDtLnkUIDDTargetFlavorHelper, and BscDNDCustomFlavorHelper.

void CDragDropTargetFlavorHelper::SetCanHandleDragData (bool16 can)
inline

Set the "can handle drag data" flag.