IScrapItem Class Reference

#include <IScrapItem.h>

Inheritance diagram for IScrapItem:

Public Types
enum	{ kDefaultIID = IID_ISCRAPITEM }

Public Member Functions
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
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This interface is used to get copy/paste/delete command for the items that could be on clipboard.

Member Enumeration Documentation

anonymous enum

Define the default IID for IScrapItem.

Member Function Documentation

virtual ICommand* IScrapItem::GetCopyCmd ( ICommand *  cmd, IDataBase *  destinationDB, UID  destParent, PMPoint *  offset = nil, bool16  includeRegisteredItems = kTrue  )

pure virtual

Get a command that can copy the object into the specified area of the destination target(document).

Parameters

cmd	refers to the root command, usually it could pass as nil and will be initialized as current copy command.
destinationDB	refers to the database of target.
destParent	refers to the parent which the item will be copied to such as layer.
offset	refers to the specified area the item will be on. The default value is nil.
includeRegisteredItems	refers to if we need to include registered items when do copy operation. The default value is kTrue.

Returns

ICommand the copy command.

virtual ICommand* IScrapItem::GetDeleteCmd ( bool16  includeRegisteredItems = kTrue )

pure virtual

Get a command that can delete the object.

Parameters

includeRegisteredItems

indicating if we need to get delete command for those registered items too. The default value is kTrue.

Returns

ICommand the delete command.

virtual ICommand* IScrapItem::GetPasteCmd ( ICommand *  cmd, IDataBase *  destinationDB, UID  destParent, PMPoint *  offset = nil, bool16  includeRegisteredItems = kTrue  )

pure virtual

Get a command that can paste the object into the specified area such as active layer, text sub-selection of the destination target(document).

Parameters

cmd	refers to the root command, usually it could pass as nil and will be initialized as current copy command.
destinationDB	refers to the database of target.
destParent	refers to the parent which the item will be copied to such as layer.
offset	refers to the specified area the item will be on. The default value is nil.
includeRegisteredItems	refers to if we need to include registered items when do copy operation. The default value is kTrue.

Returns

ICommand the paste command.

virtual ICommand* IScrapItem::GetPostDeleteCleanupCommands ( ICommand *  cmd )

pure virtual

Get a command that is created by iterating over the services registered for post delete and append those commands to the delete command.

Parameters

cmd	which seems not been used in current code(dragontail).

Returns

ICommand the predelete command. It could be a CompoundSequenceCmd.

virtual ICommand* IScrapItem::GetPreDeleteCleanupCommands ( ICommand *  cmd )

pure virtual

Get a command that is created by iterating over the services registered for pre delete and prepend those commands to the delete command.

Parameters

cmd	which seems not been used in current code(dragontail).

Returns

ICommand the predelete command. It could be a CompoundSequenceCmd.

virtual const UIDList* IScrapItem::GetRegisteredItemsList ( ) const

pure virtual

Get the item list that has registered.

Returns

const UIDList* items that are registered.

virtual bool16 IScrapItem::HasRegisteredItems ( ) const

pure virtual

Check whether any items have been registered or not.

Returns

bool16 kTrue if there are items registered, otherwise kFalse.

virtual bool16 IScrapItem::IsRegistered ( UID  nOtherItem ) const

pure virtual

Check whether the other scrap item has been registered or not.

Parameters

nOtherItem

specifies the other item.

Returns

bool16 kTrue if the other item has been registered, otherwise kFalse.

virtual bool16 IScrapItem::RegisterScrapItem ( UID  nOtherItem )

pure virtual

Register other scrap items to a scrap item. If you do so the Get***Cmd will return a CompoundSequenceCmd that contain the Get***Cmd of all registered scrap items. The order of the command collection is: first the registered items then this item.

Parameters

nOtherItem

specifies the other item to be registered.

Returns

bool16 kTrue if the other item has been successfully registered, otherwise kFalse.

virtual bool16 IScrapItem::UnregisterScrapItem ( UID  nOtherItem )

pure virtual

Unregister other scrap items from a scrap item.

Parameters

nOtherItem

specifies the other item to be unregistered.

Returns

bool16 kTrue if the other item has been unregistered, otherwise kFalse.