IScrapSuitePasteHelper.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 Scrap SuitePaste extensibility
// 
//========================================================================================

#ifndef __IScrapSuitePasteHelper__
#define __IScrapSuitePasteHelper__

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

#include "IScrapSuite.h"

// --- Defaults for creating text frames when pasting text and dragging/dropping text.
// An unlikely place for these constants to reside...
const PMReal kDefaultTextFrameHeight = 150.0;
const PMReal kDefaultTextFrameWidth = 150.0;

class IScrapSuitePasteHelper : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ISCRAPSUITEPASTEHELPER };

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

 // ----- Abilities
 virtual DataExchangeResponse CanPaste(const IScrapSuite*, IDataExchangeController* dataController) const = 0;
 
 virtual DataExchangeResponse CanPasteInside(const IScrapSuite*, IDataExchangeController* dataController, IControlView* view = nil, const PBPMPoint& point = kInvalidPoint) const = 0;

 virtual void AddInternalizeableFlavorsToList(const IScrapSuite*, IDataExchangeController*, OrderedFlavorList& flavorList) const = 0;

 // ----- Manipulators
 virtual ErrorCode Paste(const IScrapSuite*, IClipboardController* clipboard, IControlView* view, bool16 ignoreAttributes = kFalse) = 0;
 
 virtual ErrorCode PasteInside(const IScrapSuite*, IClipboardController* clipboard, IControlView* view, const PBPMPoint& point = kInvalidPoint) = 0;
 
 virtual ErrorCode PasteFromScrap(const IScrapSuite*, IDataExchangeController* dataController, IControlView* view, bool16 ignoreAttributes = kFalse) = 0;
 
 virtual ErrorCode PasteInsideFromScrap(const IScrapSuite*, IDataExchangeController* dataController, IControlView* view, const PBPMPoint& point = kInvalidPoint) = 0;
};

#endif