CScrapSuite_Extensible.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 __CScrapSuite_Extensible__
#define __CScrapSuite_Extensible__

#include "IK2ServiceProvider.h"
#include "IScrapSuite.h"
#include "CPMUnknown.h"

class IScrapSuitePasteHelper;


class CScrapSuite_Extensible : public CPMUnknown<IScrapSuite>
{
 public:
 CScrapSuite_Extensible(IPMUnknown *boss);
 virtual ~CScrapSuite_Extensible();
 
 enum eActionType {
 kPasteAction = 0, 
 kPasteInsideAction, 
 kPasteFromScrapAction, 
 kPasteInsideFromScrapAction, 
 kActionType_Max = kPasteInsideFromScrapAction
 };
 
 // ----- Abilities
 virtual bool16 CanClear() = 0;
 virtual bool16 CanCopy(IClipboardController* clipboard) = 0;
 virtual bool16 CanDuplicate() = 0;

 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;

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

 virtual ErrorCode Cut(IClipboardController* clipboard);
 
 // ----- Manipulators
 virtual ErrorCode Clear() = 0;
 virtual ErrorCode Copy(IClipboardController* clipboard) = 0;
 virtual ErrorCode Duplicate(const PBPMPoint& offset, IControlView* view, bool8 selectDuplicate = kTrue) = 0;

 virtual ErrorCode CopyToScrap(IDataExchangeController* dataController) = 0;
 
 // Get the external flavors that can be Externalized (Copy), or Internalized (Paste)
 virtual void BuildFlavorListForExternalize(IDataExchangeController* dataController, OrderedFlavorList& flavorList) const = 0;
 
 virtual void BuildFlavorListForInternalize(IDataExchangeController* dataController, OrderedFlavorList& flavorList) const;

 virtual ErrorCode Paste(IClipboardController* clipboard, IControlView* view, bool16 ignoreAttributes);
 virtual ErrorCode PasteInside(IClipboardController* clipboard, IControlView* view, const PBPMPoint& point = kInvalidPoint);
 virtual ErrorCode PasteFromScrap(IDataExchangeController* dataController, IControlView* view, bool16 ignoreAttributes);
 virtual ErrorCode PasteInsideFromScrap(IDataExchangeController* dataController, IControlView* view, const PBPMPoint& point = kInvalidPoint);

 // ----- Extensibility
 virtual ServiceID GetScrapSuitePasteHelperServiceID() const = 0;

 private:
 IScrapSuitePasteHelper* GetActiveScrapSuitePasteHelper(eActionType action) const;
 IScrapSuitePasteHelper* QueryHelper_ForAction(eActionType action, IDataExchangeController* dataController, IControlView* view = nil, const PBPMPoint& point = kInvalidPoint) const;

 IScrapSuitePasteHelper* fActiveScrapSuitePasteHelpers[kActionType_Max]; 
 // Lifetime does not extend beyond duration of an atomic CanPaste, Paste or PasteFromScrap call. 
};

#endif //__CDragDropSource__