#include <IGuideUtils.h>

Inheritance diagram for IGuideUtils:

Public Types
enum	{ kDefaultIID = IID_IGUIDEUTILS }

enum	LayerMaskFlags { kMaskNothing = 0x00000000, kMaskHiddenLayers = 0x00000001, kMaskLockedLayers = 0x00000002, kMaskHiddenAndLockedLayers = kMaskHiddenLayers + kMaskLockedLayers }

Public Member Functions
virtual UID	GetNewOwnerUID (IGuideData *guideData, const PMPoint &locationPoint)=0

virtual void	GetSortedSliceGuides (const UIDRef &pageRef, UIDList &horizontalGuides, UIDList &verticalGuides) const =0

virtual void	GetSortedSliceGuides (const UIDRef &pageRef, const PMRect &pageBoundsSpreadCoordinates, UIDList &horizontalGuides, UIDList &verticalGuides) const =0

virtual UIDList	GetGuidesOnSpread (const UIDRef &spreadRef, const LayerMaskFlags flags) const =0

virtual void	FilterNonGuides (UIDList &list)=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

Guide-related utilities on model side.

See Also: kUtilsBoss; IGuideUIUtils for answers about ruler-guide related questions.

Member Function Documentation

virtual void IGuideUtils::FilterNonGuides ( UIDList & list )

pure virtual

Given a list of page items, strip the non guides out.

Parameters

list	IN/OUT the UIDList for the list to process.

virtual UID IGuideUtils::GetNewOwnerUID	(	IGuideData *	guideData,
		const PMPoint &	locationPoint
	)

pure virtual

With the given guide data and a point, get the owner of the guide which it will reside on. The owner is either a page or spread/pasteboard. If command/ctrl key is pressed, we will force the guide to be a pasteboard guide by setting the spread as its parent.

Parameters

guideData	IN the given guide data interface.
locationPoint	IN the given point usually it is the mouse location in spread coordinates.

Returns: UID the UID of a page or a spread, by default it is kInvalidUID.

virtual void IGuideUtils::GetSortedSliceGuides	(	const UIDRef &	pageRef,
		UIDList &	horizontalGuides,
		UIDList &	verticalGuides
	)		const

pure virtual

Given a page, return a sorted list of slice guides

Parameters

pageRef	[IN] UIDRef of the page
horizontalGuides	[OUT] On return, will contain the horizontal page and spread guides sorted top to bottom
verticalGuides	[OUT] On return, will contain the vertical page and spread guides sorted left to right

Public Types

Public Member Functions

Detailed Description

Member Function Documentation