IDataExchHandlerFlavorHelper.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 Data Exchange handler extensibility
// 
//========================================================================================

#ifndef __IDataExchHandlerFlavorHelper__
#define __IDataExchHandlerFlavorHelper__

#include "DragDropID.h"
#include "DragDropConstants.h"
#include "PMFlavorTypes.h"

class IDataExchangeHandler;
class IPMDataObject;

class IDataExchangeHandlerFlavorHelper : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IDATAEXCHANGEHANDLERFLAVORHELPER };

 virtual DataExchange::eHelperType
 GetHelperType() const = 0;

 virtual DataExchangeResponse CanConvertExternalFlavor(const IDataExchangeHandler*, ExternalPMFlavor fromWhichFlavor) const = 0;

 virtual DataExchangeResponse CanProduceExternalFlavor(const IDataExchangeHandler*, ExternalPMFlavor toWhichFlavor) const = 0;

 virtual void AddPromisesForExternalize(IDataExchangeHandler*, const IPMDataObject* whichItem, OrderedPromiseList& orderedPromiseList) = 0;
 
 virtual void AddInternalizeableFlavorsToList(const IDataExchangeHandler*, OrderedFlavorList& flavorList) const = 0;
 
 virtual void AddExternalizeableFlavorsToList(const IDataExchangeHandler*, OrderedFlavorList& flavorList) const = 0;

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

 virtual void ReorderFlavors(const IDataExchangeHandler*, OrderedFlavorList&) {}

};

#endif