DragDropConstants.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.
// 
// 
// Constants and Simple Classes used in the Drag and Drop framework
// 
//========================================================================================

#ifndef __DragDropConstants__
#define __DragDropConstants__

#include "PMFlavorTypes.h"


class DataExchange
{
 public:
 enum eHelperType {
 kDefaultHelper = 0,
 kAddonHelper = 1,
 kOverrideHelper = 2,
 kOverrideFlavorPriorityHelper = 3 
 };
};

class DragDrop
{
 public:
 enum eCursorType { kDefaultDragCursors = -99 };

 enum eOutlineType { 
 kNoDragOutline = 0, 
 kDefaultDragOutline = -1 
 };

 enum eTargetHiliteType { 
 kNoDropHilite = 0, 
 kDefaultDropHilite = -1,
 kTargetWillDrawDropHilite = kNoDropHilite
 };
 
 enum eTargetWillDrawTrackingFeedback { 
 kUseDefaultTrackingFeedback = 0, 
 kTargetWillDrawTrackingFeedback = 1 
 };

 enum eTargetWillProvideCursorFeedback { 
 kUseDefaultCursorFeedback = 0, 
 kTargetWillProvideCursorFeedback = 1 
 };

 enum eTargetTrackingBehavior { 
 kUseDefaultTargetTracking = 0,
 kTargetTrackingBehaviorIsSticky = 1 
 };

 enum eTargetResponse {
 kWontAcceptDrop = 0, 
 kDropWillCopy = 1, 
 kDropWillMove = 2, 
 kDropWillLink = 4,
 kNoDropEffectCursor = -1 
 };

 enum eCommandType {
 kDragCommand = 0,
 kDragMoveCommand,
 kDropCommand, 
 kDrag = kDragCommand, kDragMove = kDragMoveCommand, kDrop = kDropCommand
 };

 enum eHelperType {
 kDefaultHelper = 0,
 kAddonHelper = 1,
 kOverrideHelper = 2
 };


 class TargetResponse : public DataExchangeResponse
 {
 public: 
 TargetResponse() 
 : DataExchangeResponse(), 
 fResponse(kWontAcceptDrop), 
 fTargetWillDrawTrackingFeedback(kUseDefaultTrackingFeedback),
 fTargetWillProvideCursorFeedback(kUseDefaultCursorFeedback),
 fTargetTrackingBehavior(kUseDefaultTargetTracking) {}
 
 TargetResponse(eTargetResponse response, 
 eTargetWillDrawTrackingFeedback willTargetDrawTrackingFeedback = kUseDefaultTrackingFeedback, 
 eTargetWillProvideCursorFeedback willTargetProvideCursorFeedback = kUseDefaultCursorFeedback, 
 eTargetTrackingBehavior targetTrackingBehavior = kUseDefaultTargetTracking, 
 PMFlavorPriority priority = kUnknownFlavorPriority
 )
 : DataExchangeResponse((response != kWontAcceptDrop && response != kNoDropEffectCursor), priority),
 fResponse(response), 
 fTargetWillDrawTrackingFeedback(willTargetDrawTrackingFeedback),
 fTargetWillProvideCursorFeedback(willTargetProvideCursorFeedback),
 fTargetTrackingBehavior(targetTrackingBehavior) {}
 
 TargetResponse(const DataExchangeResponse& deResponse, 
 eTargetResponse targResponse, 
 eTargetWillDrawTrackingFeedback willTargetDrawTrackingFeedback = kUseDefaultTrackingFeedback, 
 eTargetWillProvideCursorFeedback willTargetProvideCursorFeedback = kUseDefaultCursorFeedback, 
 eTargetTrackingBehavior targetTrackingBehavior = kUseDefaultTargetTracking
 ) 
 : DataExchangeResponse(deResponse),
 fResponse(targResponse), 
 fTargetWillDrawTrackingFeedback(willTargetDrawTrackingFeedback),
 fTargetWillProvideCursorFeedback(willTargetProvideCursorFeedback),
 fTargetTrackingBehavior(targetTrackingBehavior) {}
 
 TargetResponse(const TargetResponse& other) 
 : DataExchangeResponse(other), fResponse(other.fResponse), 
 fTargetWillDrawTrackingFeedback(other.fTargetWillDrawTrackingFeedback),
 fTargetWillProvideCursorFeedback(other.fTargetWillProvideCursorFeedback),
 fTargetTrackingBehavior(other.fTargetTrackingBehavior) {}
 
 bool16 CanTargetAccept() const {return CanDo();}
 eTargetResponse GetResponse() const {return fResponse;}
 bool16 WillTargetDrawTrackingFeedback() const {return fTargetWillDrawTrackingFeedback == DragDrop::kTargetWillDrawTrackingFeedback;}
 bool16 WillTargetProvideCursorFeedback() const {return fTargetWillProvideCursorFeedback == DragDrop::kTargetWillProvideCursorFeedback;}
 bool16 TargetTrackingBehaviorIsSticky() const {return fTargetTrackingBehavior == DragDrop::kTargetTrackingBehaviorIsSticky;}

 protected:
 eTargetResponse fResponse;
 eTargetWillDrawTrackingFeedback fTargetWillDrawTrackingFeedback;
 eTargetWillProvideCursorFeedback fTargetWillProvideCursorFeedback;
 eTargetTrackingBehavior fTargetTrackingBehavior;
 };

 static const TargetResponse kWontAcceptTargetResponse;
 static const TargetResponse kInvalidTargetResponse; 
};


#endif