#include <IScrapSuite.h>

Inheritance diagram for IScrapSuite:

Public Types
enum	{ kDefaultIID = IID_ISCRAPSUITE }

Public Member Functions
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

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 void	BuildFlavorListForExternalize (IDataExchangeController *dataController, OrderedFlavorList &flavorList) const =0

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

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

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

IID_ISCRAPSUITE interface; This interface reside both on page item specifers and selection suites. Normally these method apply on specific item first, then on selections, however, usage of specifier is obseleting.

Member Function Documentation

virtual void IScrapSuite::BuildFlavorListForExternalize	(	IDataExchangeController *	dataController,
		OrderedFlavorList &	flavorList
	)		const

pure virtual

Get the external flavors that can be Externalized(Copy)

Parameters

dataController	Data exchange controller, such as clipboard, dragdrop, libraryscrapcontroller etc.
flavorList	[IN/OUT] flavor list, store result

Returns

Implemented in CScrapSuite_Extensible.

virtual void IScrapSuite::BuildFlavorListForInternalize	(	IDataExchangeController *	dataController,
		OrderedFlavorList &	flavorList
	)		const

pure virtual

Get the external flavors that can be Internalized (Paste)

Parameters

dataController	Data exchange controller, such as clipboard, dragdrop, libraryscrapcontroller etc.
flavorList	[IN/OUT] flavor list, store result

Returns

Implemented in CScrapSuite_Extensible.

virtual bool16 IScrapSuite::CanClear ( )

pure virtual

Can the (selected) pageitem(s) be cleared?

Parameters

none

Returns

Implemented in CScrapSuite_Extensible.

virtual bool16 IScrapSuite::CanCopy ( IClipboardController * clipboard )

pure virtual

Can the (selected) pageitem(s) be copied?

Parameters

clipboard the clipboard the items copied to

Returns

Implemented in CScrapSuite_Extensible.

virtual bool16 IScrapSuite::CanCut ( IClipboardController * clipboard )

pure virtual

Can the (selected) pageitem(s) be cut?

Parameters

clipboard the clipboard the items copied to

Returns

Implemented in CScrapSuite_Extensible.

virtual bool16 IScrapSuite::CanDeselectAll ( )

pure virtual

Can the (selected) pageitem(s) all be deselected?

Parameters

none

Returns: bool16

virtual bool16 IScrapSuite::CanDuplicate ( )

pure virtual

Can the (selected) pageitem(s) be duplicated?

Parameters

none

Returns: bool16

Implemented in CScrapSuite_Extensible.

virtual bool16 IScrapSuite::CanPaste ( IClipboardController * clipboard )

pure virtual

Can the pageitem(s) in the clipboard be pasted (selection accept paste)?

Parameters

clipboard the clipboard stores the items

Returns

Implemented in CScrapSuite_Extensible.

virtual bool16 IScrapSuite::CanPasteInside	(	IClipboardController *	clipboard,
		IControlView *	view = `nil`,
		const PBPMPoint &	point = `kInvalidPoint`
	)

pure virtual

Can the pageitem(s) in the clipboard be pasted inside to selection?

Parameters

clipboard	the clipboard stores the items
view	Control view for the point. Use nil to use selection for paste inside.
thePoint	point in pasteboard coordinates to use for paste inside. Use kInvalidPoint to ignore and use selection as basis.

Returns

Implemented in CScrapSuite_Extensible.

virtual bool16 IScrapSuite::CanPasteInsideAtPoint	(	IControlView *	view,
		const PBPMPoint &	point
	)		const

pure virtual

Does current selection accept pasteinside?

Parameters

view	Control view paste to(ususally front view; active context's view)

Returns: kTrue if this point location can accept paste inside, kFalse otherwise.

Implemented in CScrapSuite_Extensible.

virtual bool16 IScrapSuite::CanSelectionAcceptPaste ( ) const

pure virtual

Does current selection accept paste?

Parameters

none

Returns: kTrue if selection can accept paste, kFalse otherwise.

Implemented in CScrapSuite_Extensible.

virtual bool16 IScrapSuite::CanSelectionAcceptPasteInside ( ) const

pure virtual

Does current selection accept pasteinside?

Parameters

none

Returns: kTrue if selection can accept paste inside, kFalse otherwise.

Implemented in CScrapSuite_Extensible.

virtual bool16 IScrapSuite::CanSelectionBeCopied ( ) const

pure virtual

Can current selection be copied?

Parameters

none

Returns

Implemented in CScrapSuite_Extensible.

virtual ErrorCode IScrapSuite::Clear ( )

pure virtual

Clear (delete) the selection

Parameters

none

Returns: Command sequence processing result

Implemented in CScrapSuite_Extensible.

virtual ErrorCode IScrapSuite::Copy ( IClipboardController * clipboard )

pure virtual

Copy item or selection to clipboard

Parameters

clipboard the clipboard the items copied to

Returns: Command sequence processing result

Implemented in CScrapSuite_Extensible.

virtual ErrorCode IScrapSuite::CopyToScrap ( IDataExchangeController * dataController )

pure virtual

Copy item or selection to scrap (specified by dataController)

Parameters

dataController Data exchange controller, such as clipboard, dragdrop, libraryscrapcontroller etc.

Returns: Command sequence processing result

Implemented in CScrapSuite_Extensible.

virtual ErrorCode IScrapSuite::Cut ( IClipboardController * clipboard )

pure virtual

Copy item or selection to clipboard and delete it.

Parameters

clipboard the clipboard the items copied to

Returns: Command sequence processing result

Implemented in CScrapSuite_Extensible.

virtual ErrorCode IScrapSuite::DeselectAll ( )

pure virtual

Deselect all page items or selections

Parameters

none

Returns: Command sequence processing result

virtual ErrorCode IScrapSuite::Duplicate	(	const PBPMPoint &	offset,
		IControlView *	view,
		bool8	selectDuplicate = `kTrue`
	)

pure virtual

Duplicate a page item

Parameters

offset	offset relative to original item
view	Control view to duplicate item to(ususally front view; active context's view)
selectDuplicate	if kTrue (default), select the duplicated item

Returns: Command sequence processing result

Implemented in CScrapSuite_Extensible.

virtual ErrorCode IScrapSuite::Paste	(	IClipboardController *	clipboard,
		IControlView *	view,
		bool16	ignoreAttributes = `kFalse`
	)

pure virtual

Paste item from the clipboard to the view

Parameters

clipboard	the clipboard the items pasted from
view	Control view paste to(ususally front view; active context's view)
ignoreAttributes	Ignore the attributes when pasting, default to kFalse

Returns: Command sequence processing result

Implemented in CScrapSuite_Extensible.

virtual ErrorCode IScrapSuite::PasteFromScrap	(	IDataExchangeController *	dataController,
		IControlView *	view,
		bool16	ignoreAttributes = `kFalse`
	)

pure virtual

Paste item from scrap (specified by dataController) to the view

Parameters

dataController	Data exchange controller, such as clipboard, dragdrop, libraryscrapcontroller etc.
view	Control view to paste item to(ususally front view; active context's view)
ignoreAttributes	Ignore the attributes when pasting from scrap, default to kFalse

Returns: Command sequence processing result

Implemented in CScrapSuite_Extensible.

virtual ErrorCode IScrapSuite::PasteInside	(	IClipboardController *	clipboard,
		IControlView *	view,
		const PBPMPoint &	point = `kInvalidPoint`
	)

pure virtual

Paste item on the clipboard inside to selected item (first of selected items)

Parameters

clipboard	the clipboard the items pasted from
view	Control view paste to(ususally front view; active context's view)
thePoint	point in pasteboard coordinates to use for paste inside. Use kInvalidPoint to ignore and use selection as basis.

Returns: Command sequence processing result

Implemented in CScrapSuite_Extensible.

virtual ErrorCode IScrapSuite::PasteInsideFromScrap	(	IDataExchangeController *	dataController,
		IControlView *	view,
		const PBPMPoint &	point = `kInvalidPoint`
	)

pure virtual

Paste item from scrap (specified by dataController) insdie to the selected item in the view

Parameters

dataController	Data exchange controller, such as clipboard, dragdrop, libraryscrapcontroller etc.
view	Control view to paste item to(ususally front view; active context's view)
thePoint	point in pasteboard coordinates to use for paste inside. Use kInvalidPoint to ignore and use selection as basis.

Returns: Command sequence processing result

Implemented in CScrapSuite_Extensible.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation