IDataExchangeHandler.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 handlers used to manage data for data exchange operations
// 
//========================================================================================

#ifndef __IDataExchangeHandler__
#define __IDataExchangeHandler__

#include "IPMUnknown.h"
#include "PMFlavorTypes.h"

#include "DragDropID.h"

class IPMDataObject;
class IPMStream;

class IDataExchangeHandler : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IDATAEXCHANGEHANDLER };

 // ----- Initialization
 public:
 virtual void CreateScrapStorage() = 0;

 // ----- Accessors
 public:
 virtual void Clear() = 0;

 virtual bool16 IsEmpty() const = 0;
 
 virtual PMFlavor GetFlavor() const = 0;
 
 virtual DataExchangeResponse CanInternalizeData(IPMDataObject* whichItem) const = 0;

 virtual bool16 CanConvertExternalFlavor(ExternalPMFlavor fromWhichFlavor) const = 0;

 virtual void AddInternalizeableFlavorsToList(OrderedFlavorList& flavorList) const = 0;

 virtual void AddExternalizeableFlavorsToList(OrderedFlavorList& flavorList) const = 0;

 // ----- Conversion to platform data exchange (clipboard and drag/drop)
 public:
 virtual ErrorCode ExternalizePromises(IPMDataObject* whichItem) = 0;

 virtual ErrorCode Externalize(IPMDataObject* whichItem, ExternalPMFlavor toWhichFlavor, IPMStream* s) = 0;

 virtual ErrorCode Internalize(IPMDataObject* whichItem) = 0;

 virtual ErrorCode Internalize(IPMDataObject* whichItem, ExternalPMFlavor fromWhichFlavor, IPMStream* s) = 0;
};

#endif