#include <IPageItemScrapUtils.h>

Inheritance diagram for IPageItemScrapUtils:

Public Types
enum	{ kDefaultIID = IID_IPAGEITEMSCRAPUTILS }

Public Member Functions
virtual ICommand *	GetDuplicatePageItemsCmd (const UIDList *pageItems, const PMPoint &offset, UIDRef parent, bool16 preserveLayers) const =0

virtual ICommand *	GetDuplicatePathPointsCmd (const UIDList pageItems, const PathSelectionList pathItems, K2Vector< PointSelectorList > *newPathItems, const PMPoint &offset, UIDRef parent, bool16 preserveLayers) const =0

virtual UID	FindLayer (IHierarchy *parentHier, const PMString &searchName, bool16 isGuideLayer) const =0

virtual UIDRef	MakeLayer (const UIDRef &docRef, PMString layerName, const IPageItemLayerData layerData)=0

virtual UIDRef	MakeLayer (const UIDRef &docRef, IDocumentLayer *sourceDocLayer)=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

Utilities related to page item scrap and duplicating page items.

Member Function Documentation

virtual UID IPageItemScrapUtils::FindLayer	(	IHierarchy *	parentHier,
		const PMString &	searchName,
		bool16	isGuideLayer
	)		const

pure virtual

Find the uid of the spread layer to put a duplicated item on. Used when Paste Remembers Layers is on.

Parameters

parentHier	the hierarchy interface for the parent of the item being duplicated.
searchName,the	name of the layer the item being duplicated is on.
isGuideLayer	pass kTrue if duplicating guides (kGuideItemBoss), otherwise use kFalse.

Returns: UID the UID of the spread layer to duplicate the item on, kInvalidUID if a layer with that name is not present in the document.

See Also: ILayerList.h; ISpreadLayer.h

virtual UIDRef IPageItemScrapUtils::MakeLayer	(	const UIDRef &	docRef,
		PMString *	layerName,
		const IPageItemLayerData *	layerData
	)

pure virtual

Create a layer with the given name in the document targetted by docRef, and using the data in layerData. Target layer will be created in same z-order position in target document as specified in layerData. Generally used internally by duplicate code to create matching destination layers as necessary. Only a layer is created, no content is copied.

Parameters

docRef	a UIDRef to the target document
layerName	a pointer to the string to use for the name
layerData	an interface pointer containing information

Returns: a UIDRef to the created document layer.

See Also: IPageItemLayerData.h; IDocumentLayer.h

virtual UIDRef IPageItemScrapUtils::MakeLayer	(	const UIDRef &	docRef,
		IDocumentLayer *	sourceDocLayer
	)

pure virtual

Create a layer in the target document with all the attributes of the source layer. Target layer will be created in same z-order position in target document as it is in source document. Generally internally by duplicate code to create matching destination layers as necessary. Only a layer is created, no content is copied.

Parameters

docRef	a UIDRef to the target document
sourceDocLayer	an interface pointer to the IDocumentLayer to copy attributes from.

Returns: a UIDRef to the created document layer.

See Also: IDocumentLayer.h

Public Types

Public Member Functions

Detailed Description

Member Function Documentation