IDragDropController.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Interface definition for the Drag and Drop controller
// 
//========================================================================================

#ifndef __IDragDropController__
#define __IDragDropController__

#include "CDataExchangeController.h"

#include "DragDropConstants.h"

#include "IPMDataObject.h"
#include "IDataExchangeHandler.h"
#include "PMPoint.h"
#include "DragDropID.h"
#include "CursorSpec.h"

class IPMDataObject;
class IDragDropSource;
class IDragDropTarget;
class IEvent;
class DataObjectIterator;
class IAbortableCmdSeq;

class IDragDropController : public CDataExchangeController
{
 public:
 enum { kDefaultIID = IID_IDRAGDROPCONTROLLER };
 
 public:
 // ----- Constructor/Destructor
 IDragDropController(IPMUnknown *boss) : CDataExchangeController(boss) {};
 virtual ~IDragDropController() {};

 // ----- Managing the drag UI
 virtual bool16 StartDrag(IDragDropSource*, IEvent* e, bool16 patientUser = kFalse) = 0;
 
 virtual ErrorCode ClearDrag() = 0;
 
 virtual bool16 IsDragInProgress() const = 0; 
 
 virtual GSysPoint GetDragMouseLocation() const = 0;
 
 virtual bool16 IsPatientUser() const = 0; 
 
 virtual bool16 IsUserUsingCopyGesture() const = 0;
 
 virtual bool16 DidUserUseCopyGesture() const = 0;
 
 virtual bool16 DidUserUseDragChildrenGesture() const = 0;
 
 virtual bool16 IsTargetSameAsSource() const = 0;

 virtual bool16 NeedsToInternalize() const = 0;

 // ----- Methods to access data contained in a drag.
 virtual uint16 GetItemCount() = 0;
 
 virtual IPMDataObject* AddDragItem(uint32 itemID) = 0; // Returns an addref'd interface, caller must release

 virtual IPMDataObject* GetDragItem(uint32 itemID) = 0;
 
 virtual IAbortableCmdSeq* GetCommandSequence() const = 0;
 
 // ----- Active handlers
 virtual IDataExchangeHandler* QuerySourceHandler() const = 0;
 
 virtual void SetSourceHandler(IDataExchangeHandler* handler) = 0;
 
 virtual IDataExchangeHandler* QueryTargetHandler() const = 0;

 virtual void SetTargetHandler(IDataExchangeHandler* handler) = 0;
 
 virtual IDataExchangeHandler* QueryHandlerForInternalize(DataExchangeResponse& response, const PMFlavor& internalizedFlavor = kNoFlavor) const = 0;

 // ----- Externalize/Internalize Methods
 virtual ErrorCode FulfillPromise(IPMDataObject* whichItem, const ExternalPMFlavor& whichFlavor) const = 0;
 
 virtual ErrorCode ExternalizeDrag(PMFlavor whichFlavor) const = 0;
 
 virtual bool16 CanInternalizeDuringTracking() const = 0;
 
 virtual ErrorCode InternalizeDrag(ExternalPMFlavor extFlavor, PMFlavor intFlavor) = 0;
 
 // ----- Support for target supplied cursor feedback
 virtual void SetTrackingCursorFeedback(const CursorSpec& cursor) = 0;
 
 virtual CursorSpec GetDefaultTrackingCursorFeedback(DragDrop::eTargetResponse targetResponse) const = 0;

 virtual bool16 WillTargetProvideCursorFeedback() const = 0;

 // ----- Support for platform specific drag drop features
#ifdef MACINTOSH

 virtual OSErr CopyDropLocation(CFURLRef* dropLocation) const = 0;
 
 virtual OSErr SetDropLocation(CFURLRef dropLocation) = 0;
#endif

 virtual void SuppressExternalDragHandling(bool16 doSuppress) = 0;
};

class SuppressExternalDragsDuringCriticalSection
{
 public:
 SuppressExternalDragsDuringCriticalSection()
 {
 InterfacePtr<IDragDropController> dragController(GetExecutionContextSession(), IID_IDRAGDROPCONTROLLER);
 if (dragController)
 dragController->SuppressExternalDragHandling(kTrue);
 }
 
 ~SuppressExternalDragsDuringCriticalSection()
 {
 InterfacePtr<IDragDropController> dragController(GetExecutionContextSession(), IID_IDRAGDROPCONTROLLER);
 if (dragController)
 dragController->SuppressExternalDragHandling(kFalse);
 }
};

#endif