#include <IPathSelectionSuite.h>

Inheritance diagram for IPathSelectionSuite:

Public Types
enum	{ kDefaultIID = IID_IPATHSELECTION_SUITE }

Public Member Functions
virtual void	ActivatePathSelection (bool16 isPathSelection)=0

virtual bool16	IsPathSelectionActive () const =0

virtual ErrorCode	SelectPageItemPathPoint (const UIDRef &item, const PointSelector &handleID, bool16 drawit=kFalse)=0

virtual ErrorCode	SelectPageItemPathPoints (const UIDRef &item, const PointSelectorList &pts, bool16 drawit=kFalse)=0

virtual ErrorCode	SelectPathPoints (const PathSelectionList &list, bool16 drawit=kFalse)=0

virtual ErrorCode	SelectEntirePageItem (const UIDList &itemList, bool16 drawit=kFalse)=0

virtual ErrorCode	ReplacePathSelection (const PathSelectionList &add, bool16 drawit=kFalse)=0

virtual ErrorCode	AlterPathSelection (const PathSelectionList &drop, const PathSelectionList &add, bool16 drawit=kFalse)=0

virtual ErrorCode	Replace_ (const UIDList &itemList, bool16 drawit=kFalse)=0

virtual ErrorCode	DeselectPageItemPathPoint (const UIDRef &item, const PointSelector &handle, bool16 drawit=kFalse)=0

virtual ErrorCode	DeselectPageItemPathPoints (const UIDRef &item, const PointSelectorList &pts, bool16 drawit=kFalse)=0

virtual ErrorCode	DeselectPathPoints (const PathSelectionList &list, bool16 drawit=kFalse)=0

virtual ErrorCode	DeselectEntirePageItem (const UIDList &itemList, bool16 drawit=kFalse)=0

virtual ErrorCode	DeselectAllPaths (bool16 drawit=kFalse)=0

virtual bool16	IsPathSelectionEmpty () const =0

virtual bool16	IsAnyPageItemPathPointSelected (const UIDRef &item) const =0

virtual bool16	IsPageItemPathPointSelected (const UIDRef &item, const PointSelector &handle) const =0

virtual int32	CountPathSelectedPageItems () const =0

virtual UIDList	GetPathSelectedPageItems () const =0

virtual int32	CountPathSelectors (const UIDRef &item) const =0

virtual void	GetSelectorList (const UIDRef &item, PointSelectorList &ptsOut) const =0

virtual const PathSelectionList &	GetPathSelection () const =0

virtual bool16	IsEntirePageItemSelected (const UIDRef &item) const =0

virtual bool16	IsEntirePathSelected (const UIDRef &item, int32 pathIndex) const =0

virtual bool16	IsSinglePoint (UIDRef theItem=nil, PointSelector thePoint=nil) const =0

virtual bool16	IsSingleSegment (UIDRef theItem=nil, PointSelector theSegment=nil) const =0

virtual bool16	IsTwoContiguousSegs (UIDRef theItem=nil, PointSelector thePoint=nil) 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 support selection over paths. Based on IPathSelection, IPathSelectionSuite lives on the selection manager boss. With the exception of drawing, most methods forward to the IPathSelectionTarget on the concrete layout selection boss.

See Also: IPathSelection; IPathSelectionTarget

Member Function Documentation

virtual void IPathSelectionSuite::ActivatePathSelection ( bool16 isPathSelection )

pure virtual

Toggles path selection mode on/off

virtual ErrorCode IPathSelectionSuite::AlterPathSelection	(	const PathSelectionList &	drop,
		const PathSelectionList &	add,
		bool16	drawit = `kFalse`
	)

pure virtual

Replaces certain path components in the selection with others

virtual int32 IPathSelectionSuite::CountPathSelectedPageItems ( ) const

pure virtual

Return number of objects with path components selected

virtual int32 IPathSelectionSuite::CountPathSelectors ( const UIDRef & item ) const

pure virtual

Return number of path components selected on object

virtual ErrorCode IPathSelectionSuite::DeselectAllPaths ( bool16 drawit = kFalse )

pure virtual

Deselects all path components

virtual ErrorCode IPathSelectionSuite::DeselectEntirePageItem	(	const UIDList &	itemList,
		bool16	drawit = `kFalse`
	)

pure virtual

Deselects all path components of these items

virtual ErrorCode IPathSelectionSuite::DeselectPageItemPathPoint	(	const UIDRef &	item,
		const PointSelector &	handle,
		bool16	drawit = `kFalse`
	)

pure virtual

Deselects a path component

virtual ErrorCode IPathSelectionSuite::DeselectPageItemPathPoints	(	const UIDRef &	item,
		const PointSelectorList &	pts,
		bool16	drawit = `kFalse`
	)

pure virtual

Deselects these path components for this item

virtual ErrorCode IPathSelectionSuite::DeselectPathPoints	(	const PathSelectionList &	list,
		bool16	drawit = `kFalse`
	)

pure virtual

Deselects these path components

virtual UIDList IPathSelectionSuite::GetPathSelectedPageItems ( ) const

pure virtual

Retrieves the items with selected path components

virtual const PathSelectionList& IPathSelectionSuite::GetPathSelection ( ) const

pure virtual

Get entire selection

virtual void IPathSelectionSuite::GetSelectorList	(	const UIDRef &	item,
		PointSelectorList &	ptsOut
	)		const

pure virtual

Retrieves the selected path components of an item

virtual bool16 IPathSelectionSuite::IsAnyPageItemPathPointSelected ( const UIDRef & item ) const

pure virtual

Returns kTrue if one or more path components on this item are selected

virtual bool16 IPathSelectionSuite::IsEntirePageItemSelected ( const UIDRef & item ) const

pure virtual

Returns kTrue if all points (and thus all segments as well) on the object are selected

virtual bool16 IPathSelectionSuite::IsEntirePathSelected	(	const UIDRef &	item,
		int32	pathIndex
	)		const

pure virtual

Returns kTrue if all points (and thus all segments as well) on the object's path are selected

virtual bool16 IPathSelectionSuite::IsPageItemPathPointSelected	(	const UIDRef &	item,
		const PointSelector &	handle
	)		const

pure virtual

Returns kTrue if this path component on this item is selected

virtual bool16 IPathSelectionSuite::IsPathSelectionActive ( ) const

pure virtual

Returns kTrue if the current selection is a path selection

virtual bool16 IPathSelectionSuite::IsPathSelectionEmpty ( ) const

pure virtual

Returns kTrue if there are no path components selected

virtual bool16 IPathSelectionSuite::IsSinglePoint	(	UIDRef *	theItem = `nil`,
		PointSelector *	thePoint = `nil`
	)		const

pure virtual

Returns kTrue if only a single anchor point (and one or both contiguous segments) is selected

virtual bool16 IPathSelectionSuite::IsSingleSegment	(	UIDRef *	theItem = `nil`,
		PointSelector *	theSegment = `nil`
	)		const

pure virtual

Returns kTrue if only a single segment is selected

virtual bool16 IPathSelectionSuite::IsTwoContiguousSegs	(	UIDRef *	theItem = `nil`,
		PointSelector *	thePoint = `nil`
	)		const

pure virtual

Returns kTrue if two contiguous segments are selected (and nothing else)

virtual ErrorCode IPathSelectionSuite::Replace_	(	const UIDList &	itemList,
		bool16	drawit = `kFalse`
	)

pure virtual

Replaces currently selected path components with all path components of these items

virtual ErrorCode IPathSelectionSuite::ReplacePathSelection	(	const PathSelectionList &	add,
		bool16	drawit = `kFalse`
	)

pure virtual

Replaces currently selected path components with others

virtual ErrorCode IPathSelectionSuite::SelectEntirePageItem	(	const UIDList &	itemList,
		bool16	drawit = `kFalse`
	)

pure virtual

Selects all path components of these items

virtual ErrorCode IPathSelectionSuite::SelectPageItemPathPoint	(	const UIDRef &	item,
		const PointSelector &	handleID,
		bool16	drawit = `kFalse`
	)

pure virtual

Selects a path component

virtual ErrorCode IPathSelectionSuite::SelectPageItemPathPoints	(	const UIDRef &	item,
		const PointSelectorList &	pts,
		bool16	drawit = `kFalse`
	)

pure virtual

Selects a set of path components of an item

virtual ErrorCode IPathSelectionSuite::SelectPathPoints	(	const PathSelectionList &	list,
		bool16	drawit = `kFalse`
	)

pure virtual

Selects a list of path components

Public Types

Public Member Functions

Detailed Description

Member Function Documentation