ILayoutSelectionSuite Class Reference

#include <ILayoutSelectionSuite.h>

Inheritance diagram for ILayoutSelectionSuite:

Public Types
enum	{ kDefaultIID = IID_ILAYOUTSELECTION_ISUITE }

Public Member Functions
virtual void	SelectPageItemsInternal (const UIDList &newItems, Selection::Action selectionMode, Selection::LayoutScrollChoice doScroll, bool16)=0
Extending
virtual void	SelectPageItems (const UIDList &newItems, Selection::Action selectionMode, Selection::LayoutScrollChoice doScroll)=0
virtual void	SelectInTarget (IPMUnknown *targetingBoss, Selection::Action selectionMode, Selection::LayoutScrollChoice doScroll)=0
virtual void	SelectInView (IControlView *controlView, const PMRect &rect, Selection::Action selectionMode, int32 selectionType, bool16 deselectSelected, Selection::LayoutScrollChoice doScroll)=0
virtual void	SelectAllPageItems (IHierarchy *spreadHierarchy, UID specificLayerUID, Selection::LayoutScrollChoice doScroll)=0
virtual void	SelectKeyObject (const UIDRef &keyObject)=0
Shrinking
virtual void	DeselectPageItems (const UIDList &itemsToDeselect)=0
virtual void	DeselectPageItemsNotSupporting (const PMIID &id)=0
virtual void	DeselectAllExceptThisPageItem (const UID &)=0
virtual void	DeselectAllPageItems (void)=0
Utilities
virtual bool16	IsLayoutSelectionEmpty (void) const =0
virtual bool16	IsPageItemSelected (const UID &) 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 for layout-related selections.

Member Function Documentation

virtual void ILayoutSelectionSuite::DeselectAllExceptThisPageItem ( const UID &  )

pure virtual

Deselect everything in the selection except the specified item.

Parameters

UID&

virtual void ILayoutSelectionSuite::DeselectAllPageItems ( void  )

pure virtual

Deselect everything in the selection.

Parameters

void

virtual void ILayoutSelectionSuite::DeselectPageItems ( const UIDList &  itemsToDeselect )

pure virtual

Deselect the specified items.

Parameters

itemsToDeselect

virtual void ILayoutSelectionSuite::DeselectPageItemsNotSupporting ( const PMIID &  id )

pure virtual

Deselect any items in the selection which do not support the specified IID.

Parameters

id	the PMIID of the items to keep in the selection

virtual bool16 ILayoutSelectionSuite::IsLayoutSelectionEmpty ( void  ) const

pure virtual

Is the selection empty?

Parameters

void

Returns

bool16 return kTrue if selection is empty, kFalse otherwise.

virtual bool16 ILayoutSelectionSuite::IsPageItemSelected ( const UID &  ) const

pure virtual

Determine if a particular UID is contained in the current selection.

Parameters

UID&	the UID of the item to look for in the selection.

Returns

bool16 kTrue if this item is in the selection, kFalse otherwise.

virtual void ILayoutSelectionSuite::SelectAllPageItems ( IHierarchy *  spreadHierarchy, UID  specificLayerUID, Selection::LayoutScrollChoice  doScroll  )

pure virtual

Select all the items in the given hierarchy.

Parameters

spreadHierarchy	The top level of the hierarchy to determine where to start selecting from.
specificLayerUID	Filter items to a particular layer if not kInvalidUID
doScroll	how to scroll after the selection action.

virtual void ILayoutSelectionSuite::SelectInTarget ( IPMUnknown *  targetingBoss, Selection::Action  selectionMode, Selection::LayoutScrollChoice  doScroll  )

pure virtual

Select the specified items using the selectionMode and the targetting boss items from the targeting boss will be removed.

Parameters

targetingBoss	the targetting boss containing IID_ILAYOUTTARGET
selectionMode	how to select the item.
doScroll	how to scroll after the selection action.

virtual void ILayoutSelectionSuite::SelectInView ( IControlView *  controlView, const PMRect &  rect, Selection::Action  selectionMode, int32  selectionType, bool16  deselectSelected, Selection::LayoutScrollChoice  doScroll  )

pure virtual

Select the specified items within the rectangle using the selectionMode.

Parameters

controlView	the control view to do the selection in.
rect	the rect (in pasteboard coordinates)
selectionMode	how to select the item.
selectionType	Specify the selection type (kSelect, kDirectSelect, etc.) to use when marquee selecting
deselectSelected	Do we need to deselect the page items that are already selected?
doScroll	how to scroll after the selection action.

virtual void ILayoutSelectionSuite::SelectKeyObject ( const UIDRef &  keyObject )

pure virtual

Set the key object in the selection.

Parameters

keyObject

The UIDRef of the object to serve as the key. This object must already be selected (unless clearing). Pass kInvalidUIDRef to clear key object.

virtual void ILayoutSelectionSuite::SelectPageItems ( const UIDList &  newItems, Selection::Action  selectionMode, Selection::LayoutScrollChoice  doScroll  )

pure virtual

Select the specified item using the selectionMode.

Parameters

newItem	the item to select.
selectionMode	how to select the item.
doScroll	how to scroll after the selection action.Select the list of specified items using the selectionMode.
newItems	the list of items to select.
selectionMode	how to select the items.
doScroll	how to scroll after the selection action.