CDataExchangeHandlerFor.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.
// 
//========================================================================================

#ifndef __CDataExchangeHandlerFor__
#define __CDataExchangeHandlerFor__

#include "CPMUnknown.h"

#include "IDataExchangeHandler.h"

//========================================================================================
// class CDataExchangeHandlerFor
// Usage is something like this:
// 
// #include "CDataExchangeHandlerFor.h"
//
// class MyDataExchangeHandler : public CDataExchangeHandlerFor {
// MyDataExchangeHandler(IPMUnknown* boss) : CDataExchangeHandlerFor(boss) {fPMFlavor = kMyPMFlavor;}
// virtual ~MyDataExchangeHandler() {}
// };
//
//========================================================================================

class CDataExchangeHandlerFor : public CPMUnknown<IDataExchangeHandler>
{
public:
 typedef CPMUnknown<IDataExchangeHandler> Inherited;
 
 CDataExchangeHandlerFor(IPMUnknown *boss);
 virtual ~CDataExchangeHandlerFor();

 virtual void CreateScrapStorage();
 virtual PMFlavor GetFlavor() const = 0;
 
 virtual DataExchangeResponse CanInternalizeData(IPMDataObject* whichItem) const;
 
 virtual bool16 CanConvertExternalFlavor(ExternalPMFlavor fromWhichFlavor) const;

 virtual void AddInternalizeableFlavorsToList(OrderedFlavorList& flavorList) const;
 
 virtual void AddExternalizeableFlavorsToList(OrderedFlavorList& flavorList) const;

 virtual void Clear();
 
 virtual bool16 IsEmpty() const;
 
 // ----- Conversion to platform drag manager
 public:
 virtual ErrorCode ExternalizePromises(IPMDataObject* whichItem);

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

 virtual ErrorCode Internalize(IPMDataObject* whichItem);

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

#endif //__CDataExchangeHandlerFor__