IDataExchangeController.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 our data exchange controllers
// 
//========================================================================================

#ifndef __IDataExchangeController__
#define __IDataExchangeController__

#include "IPMUnknown.h"
#include "IPMDataObject.h"
#include "IDataExchangeHandler.h"

#include "DragDropID.h"

class DataObjectIterator;

class IDataExchangeController : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IDATAEXCHANGECONTROLLER };

 public:
 virtual void RegisterAllHandlers() = 0;

 // ----- Handler queries
 virtual IDataExchangeHandler* QueryHandler(const PMFlavor& flavor) const = 0;
 
 virtual IDataExchangeHandler* QueryHandler(const ExternalPMFlavor& fromFlavor, const PMFlavor& toFlavor) const = 0;

 virtual IDataExchangeHandler* QueryHandlerForInternalize(DataExchangeResponse& response, const PMFlavor& internalizeToThisFlavor = kNoFlavor) const = 0;

 virtual IDataExchangeHandler* QueryActiveHandler() const = 0;
 
 virtual void SetActiveHandler(IDataExchangeHandler* activeHandler) = 0;

 virtual ErrorCode FulfillPromise(IPMDataObject* whichItem, const ExternalPMFlavor& whichFlavor) const = 0;

 virtual bool16 NeedsToInternalize() const = 0;

 virtual IDataBase* GetScrapDataBase() const = 0;

 virtual ErrorCode Initialize() = 0;
 
 virtual bool16 IsValid() const = 0;
 
 virtual void Cleanup() = 0;
 
 virtual void GetInternalizeableFlavors(OrderedFlavorList &flavorList) const = 0;
 
 virtual bool16 IsClipboardExternal()const = 0;
};

#endif