IPMDataObject.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 objects used in clipboard and drag and drop operations
// 
//========================================================================================

#ifndef __IPMDataObject__
#define __IPMDataObject__

#include "IPMUnknown.h"
#include "PMFlavorTypes.h"
#include "K2Vector.h"
#include "DragDropID.h"

#ifdef WINDOWS
 #include <objbase.h>
#endif

class IPMDataObject : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPMDATAOBJECT };

 public:
 virtual void PromiseFlavor(ExternalPMFlavor newFlavor, PMFlavorFlags flavorFlags = kNormalFlavorFlag) = 0;
 
 virtual uint32 GetItemID() const= 0;

 virtual void SetItemID(uint32 id) = 0;
#ifdef MACINTOSH

 virtual PasteboardRef GetPasteboardRef() const = 0;

 virtual void SetPasteboardRef(PasteboardRef) = 0;
#endif
#ifdef WINDOWS

 virtual IDataObject* GetOLEItem() const = 0;
 
 virtual void SetOLEItem(IDataObject* obj) = 0;
#endif

 virtual uint16 CountFlavors() const = 0;
 
 virtual K2Vector<ExternalPMFlavor>* GetPromisedFlavors() const = 0;
 
 virtual bool16 FlavorExists(ExternalPMFlavor requestedFlavor) const = 0;

 virtual DataExchangeResponse FlavorExistsWithPriority(ExternalPMFlavor flavor) const = 0;

 virtual uint32 GetSizeOfFlavorData(ExternalPMFlavor flavor) const = 0;

 // 
 virtual IPMStream* GetStreamForReading(ExternalPMFlavor flavor) = 0;
 
 virtual IPMStream* GetStreamForWriting(ExternalPMFlavor flavor) = 0;
 
 virtual void FinishedWithStream(IPMStream*) = 0;

 enum {
 kUnspecifiedUsage = -1, 
 kInternalizeUsage = 0, 
 kExternalizeUsage = 1};
 
 virtual int16 GetUsage() const= 0;

 virtual void SetUsage(int16) = 0;
};

#endif