IScrapItem.h

//========================================================================================
// 
// $File$
// 
// Owner: Robin_Briggs
// 
// $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.
// 
// 
// This is the clipboard interface for all selectable objects. It 
// supports the generic commands DeleteCmd, PasteCmd, CopyCmd. Each
// object on the selection list will be requested to return an
// IScrapItem interface. The interface is used to get a command that
// can delete, copy, or paste the item.
// 
//========================================================================================

#ifndef __ISCRAPITEM__
#define __ISCRAPITEM__

#include "IPMUnknown.h"
#include "GenericID.h"
#include "PMPoint.h"

class ICommand;
class UIDList;

class IScrapItem : public IPMUnknown {
public:
 enum { kDefaultIID = IID_ISCRAPITEM };

 virtual ICommand *GetDeleteCmd(bool16 includeRegisteredItems = kTrue) = 0;
 
 virtual ICommand *GetCopyCmd(ICommand *cmd, IDataBase *destinationDB, UID destParent, PMPoint* offset = nil, bool16 includeRegisteredItems = kTrue) = 0;
 
 virtual ICommand *GetPasteCmd(ICommand *cmd, IDataBase *destinationDB, UID destParent, PMPoint* offset = nil, bool16 includeRegisteredItems = kTrue) = 0;
 

 virtual ICommand *GetPreDeleteCleanupCommands(ICommand *cmd) = 0;
 
 virtual ICommand *GetPostDeleteCleanupCommands(ICommand *cmd) = 0;
 

 virtual bool16 RegisterScrapItem( UID nOtherItem ) = 0;
 
 virtual bool16 UnregisterScrapItem( UID nOtherItem ) = 0; 

 virtual bool16 IsRegistered( UID nOtherItem ) const = 0; 
 

 virtual bool16 HasRegisteredItems() const = 0; 
 

 virtual const UIDList* GetRegisteredItemsList() const = 0;
};

#endif // __ISCRAPITEM__