IScrapSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Burbidge
// 
// $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 __IScrapSuite__
#define __IScrapSuite__

#include "IPMUnknown.h"
#include "IControlView.h"
#include "PMPoint.h"
#include "K2Vector.h"
#include "ShuksanID.h"
#include "PMFlavorTypes.h"

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

class IClipboardController;
class IDataExchangeController;
class ICommand;
class UIDList;
class IDataExchangeHandler;

//========================================================================================
// CLASS IScrapSuite
//========================================================================================
class IScrapSuite : public IPMUnknown
{
// ----- Abilities
public:
 enum { kDefaultIID = IID_ISCRAPSUITE };

 virtual bool16 CanClear() = 0;

 virtual bool16 CanCopy(IClipboardController* clipboard) = 0;

 virtual bool16 CanCut(IClipboardController* clipboard) = 0;

 virtual bool16 CanPaste(IClipboardController* clipboard) = 0;

 virtual bool16 CanPasteInside(IClipboardController* clipboard, IControlView* view = nil, const PBPMPoint& point = kInvalidPoint) = 0;

 virtual bool16 CanDuplicate() = 0;

 virtual bool16 CanDeselectAll() = 0;

 // Does current selection support Copy/Paste (part of the answer to CanXXX() operations, above)

 virtual bool16 CanSelectionBeCopied() const = 0;

 virtual bool16 CanSelectionAcceptPaste() const = 0;

 virtual bool16 CanSelectionAcceptPasteInside() const = 0;


 virtual bool16 CanPasteInsideAtPoint(IControlView* view, const PBPMPoint& point) const = 0;

 // Get the external flavors that can be Externalized (Copy), or Internalized (Paste)
public:

 virtual void BuildFlavorListForExternalize(IDataExchangeController* dataController, OrderedFlavorList& flavorList) const = 0;

 virtual void BuildFlavorListForInternalize(IDataExchangeController* dataController, OrderedFlavorList& flavorList) const = 0;

// ----- Manipulators
public:

 virtual ErrorCode Clear() = 0;

 virtual ErrorCode Copy(IClipboardController* clipboard) = 0;

 virtual ErrorCode Cut(IClipboardController* clipboard) = 0;

 virtual ErrorCode Paste(IClipboardController* clipboard, IControlView* view, bool16 ignoreAttributes = kFalse) = 0;

 virtual ErrorCode Duplicate(const PBPMPoint& offset, IControlView* view, bool8 selectDuplicate = kTrue) = 0;

 virtual ErrorCode DeselectAll() = 0;


 virtual ErrorCode PasteInside(IClipboardController* clipboard, IControlView* view, const PBPMPoint& point = kInvalidPoint) = 0;

 virtual ErrorCode CopyToScrap(IDataExchangeController* dataController) = 0;

 virtual ErrorCode PasteFromScrap(IDataExchangeController* dataController, IControlView* view, bool16 ignoreAttributes = kFalse) = 0;

 virtual ErrorCode PasteInsideFromScrap(IDataExchangeController* dataController, IControlView* view, const PBPMPoint& point = kInvalidPoint) = 0;

};

#endif