IClipboardController.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 __IClipboardController__
#define __IClipboardController__

#include "CDataExchangeController.h"
#include "ShuksanID.h"
#include "DragDropID.h"

#include "IDataExchangeHandler.h"

#ifdef MACINTOSH
//#define USE_CARBONSCRAPCALLS 1
#endif

//========================================================================================
// Forward declarations
//========================================================================================

class IDataExchangeHandler;
class IDataBase;

//========================================================================================
// CLASS IClipboardController
//========================================================================================

class IClipboardController : public CDataExchangeController
{
 public:
 enum { kDefaultIID = IID_ICLIPBOARDCONTROLLER };

 // ----- Constructor/Destructor
 IClipboardController(IPMUnknown *boss) : CDataExchangeController(boss) {};
 virtual ~IClipboardController() {};

 // ----- Active handler (compatibility methods - use QueryActiveHandler/SetActiveHandler instead)
 public:
 virtual IDataExchangeHandler* QueryActiveScrapHandler() const = 0;
 virtual void SetActiveScrapHandler(IDataExchangeHandler* activeHandler) = 0;
 
 
 virtual bool16 IsClipboardExternal()const = 0;

 virtual void SetIsClipboardExternal(bool16 isClipboardExternal=kTrue) =0;

 // ----- Scrap Conversion
 public:
 virtual ErrorCode FulfillPromise(IPMDataObject* whichItem, const ExternalPMFlavor& whichFlavor) const = 0;

 virtual void SetShouldExternalize(bool16 should = kTrue) = 0;

 virtual ErrorCode Externalize() const = 0;

 virtual void SetShouldInternalize(bool16 should = kTrue) = 0;

 virtual bool16 NeedsToInternalize() const = 0;

 virtual ErrorCode Internalize() = 0;
 
 virtual bool16 GetPreferredClipboardFlavor(ExternalPMFlavor& preferredFlavor) = 0;

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

 // ----- Clipboard Copy operations: PrepareForCopy and CopyHasCompleted
 virtual ErrorCode PrepareForCopy() = 0;

 virtual ErrorCode CopyHasCompleted() = 0;
 
 virtual bool16 IsExternalizeInProgress() const = 0;

 virtual bool16 IsCutOperation() const = 0;
 
 virtual void SetCutOperation(bool16 isCut) = 0;

 virtual PMString GetClipboardsContentSourceApp() const = 0;

};

#endif