Inheritance diagram for ILayerSuite:

Public Types
enum	{ kDefaultIID = IID_ILAYERSUITE }

Public Member Functions
virtual void	GetSelectedLayers (UIDList &docLayerUIDList)=0

virtual bool16	AreAllItemsOnLayerSelected (IDocumentLayer documentLayer, IControlView view, bool16 guideLayerOnly)=0

virtual void	DeselectAllItemsOnLayer (IDocumentLayer documentLayer, IControlView view, bool16 guideLayerOnly)=0

virtual void	DeselectAllItemsInList (UIDList &list, ISelectionManager *selectionMgr)=0

virtual void	SelectAllItemsOnLayer (IDocumentLayer documentLayer, IControlView view, bool16 guideLayerOnly, Selection::Action replaceOrAdd)=0

virtual ErrorCode	MoveToLayer (IDocumentLayer sourceLayer, IDocumentLayer targetLayer, IControlView *view, Selection::Action replaceOrAdd, bool16 bDuplicate)=0

virtual UIDList	GetSelectedItemsForLayersPanel () 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

Suite interface to manipulate document-wide layers

Member Function Documentation

virtual bool16 ILayerSuite::AreAllItemsOnLayerSelected	(	IDocumentLayer *	documentLayer,
		IControlView *	view,
		bool16	guideLayerOnly
	)

pure virtual

Checks if everything on a particular layer (on current spread) is selected

Parameters

documentLayer,the	IDocumentLayer that will be checked.
view,the	IControlView to use.
guideLayerOnly,kTrue	for guide layers only, kFalse for all layers.

virtual void ILayerSuite::DeselectAllItemsInList	(	UIDList &	list,
		ISelectionManager *	selectionMgr
	)

pure virtual

Deselects items in the pass in list

Parameters

documentLayer,the	IDocumentLayer that will be deselected.
view,the	IControlView to use.

virtual void ILayerSuite::DeselectAllItemsOnLayer	(	IDocumentLayer *	documentLayer,
		IControlView *	view,
		bool16	guideLayerOnly
	)

pure virtual

Deselects items on the current layer (on current spread)

Parameters

documentLayer,the	IDocumentLayer that will be deselected.
view,the	IControlView to use.
guideLayerOnly,kTrue	for guide layers only, kFalse for all layers.

virtual UIDList ILayerSuite::GetSelectedItemsForLayersPanel ( ) const

pure virtual

Returns a UIDList of pageitems known to the layers panel, an part of the current selection

Returns: list of page items shown in the layers panel that are currently selected

virtual void ILayerSuite::GetSelectedLayers ( UIDList & docLayerUIDList )

pure virtual

Populates the UIDList the document layer uids for selection.

Parameters

docLayerUIDList,UIDs of document layers the selection is on.

virtual ErrorCode ILayerSuite::MoveToLayer	(	IDocumentLayer *	sourceLayer,
		IDocumentLayer *	targetLayer,
		IControlView *	view,
		Selection::Action	replaceOrAdd,
		bool16	bDuplicate
	)

pure virtual

Moves items selected in layout on current spread & current layer to new layer.

Parameters

sourceLayer,selection	on source IDocumentLayer will be moved to targetLayer IDocumentLayer.
targetLayer,selection	on source IDocumentLayer will be moved to targetLayer IDocumentLayer.
view,the	IControlView to use.
guideLayerOnly,kTrue	if moving guide layers, kFalse otherwise.
replaceOrAdd	- Selection::kReplace or Selection::kAddTo
bDuplicate,kTrue	to duplicate the selection before moving to the destination layer.

virtual void ILayerSuite::SelectAllItemsOnLayer	(	IDocumentLayer *	documentLayer,
		IControlView *	view,
		bool16	guideLayerOnly,
		Selection::Action	replaceOrAdd
	)

pure virtual

Selects items on the current layer (on current spread)

Parameters

list,the	list items to deselect.
view,the	IControlView to use.
guideLayerOnly,kTrue	for guide layers only, kFalse for all layers.
replaceOrAdd	- Selection::kReplace or Selection::kAddTo