Inheritance diagram for ISpreadSelectionSuite:

Public Types
enum	{ kDefaultIID = IID_ISPREADSELECTION_ISUITE }

Public Member Functions
virtual void	SelectSpreadItems (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	SelectAllPages (ISpread *spread, Selection::LayoutScrollChoice doScroll)=0

virtual void	SelectAllSpreads (Selection::LayoutScrollChoice doScroll)=0

virtual void	SelectKeyObject (const UIDRef &keyObject)=0

virtual UIDRef	GetSelectedKeyObject () const =0

virtual bool16	IsKeyObjectSelected (const UIDRef &uidRef) const =0

virtual void	DeselectSpreadItems (const UIDList &itemsToDeselect)=0

virtual void	DeselectAllExceptThisSpreadItem (const UID &)=0

virtual void	DeselectAllSpreadItems ()=0

virtual bool16	IsSpreadSelectionEmpty () const =0

virtual bool16	IsSpreadItemSelected (const UID &) const =0

virtual bool32	CanShowObjectConstraints () const =0

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

Member Function Documentation

virtual bool32 ISpreadSelectionSuite::CanShowObjectConstraints ( ) const

pure virtual

Return whether or not the current page selection has layout policies that allow the object constraints on the key object selection to be displayed.

virtual void ISpreadSelectionSuite::DeselectAllExceptThisSpreadItem ( const UID & )

pure virtual

Deselect everything in the selection except the specified item.

Parameters

UID&

virtual void ISpreadSelectionSuite::DeselectAllSpreadItems ( )

pure virtual

Deselect everything in the selection.

Parameters

void

virtual void ISpreadSelectionSuite::DeselectSpreadItems ( const UIDList & itemsToDeselect )

pure virtual

Deselect the specified items.

Parameters

itemsToDeselect

virtual UIDRef ISpreadSelectionSuite::GetSelectedKeyObject ( ) const

pure virtual

Return a UIDRef for the key object in the selection. May return kInvalidUIDRef if there isn't one.

Returns: UIDRef of the key object.

virtual bool16 ISpreadSelectionSuite::IsKeyObjectSelected ( const UIDRef & uidRef ) const

pure virtual

Determine if a particular UID is set as the key object.

Parameters

uidRef& the UIDRef of the key object in question.

Returns: bool16 kTrue if this item is the key object, kFalse otherwise.

virtual bool16 ISpreadSelectionSuite::IsSpreadItemSelected ( 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 bool16 ISpreadSelectionSuite::IsSpreadSelectionEmpty ( ) const

pure virtual

Is the selection empty?

Returns: bool16 return kTrue if selection is empty, kFalse otherwise.

virtual void ISpreadSelectionSuite::SelectAllPages	(	ISpread *	spread,
		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 ISpreadSelectionSuite::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 ISpreadSelectionSuite::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 ISpreadSelectionSuite::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 ISpreadSelectionSuite::SelectSpreadItems	(	const UIDList &	newItems,
		Selection::Action	selectionMode,
		Selection::LayoutScrollChoice	doScroll
	)

pure virtual

Select the list of specified items using the selectionMode.

Parameters

newItems	the list of items to select.
selectionMode	how to select the items.
doScroll	how to scroll after the selection action.

Public Types

Public Member Functions

Member Function Documentation