IGuideDataSuite Class Reference

#include <IGuideDataSuite.h>

Inheritance diagram for IGuideDataSuite:

Public Types
enum	{ kDefaultIID = IID_IGUIDEDATASUITE }

Public Member Functions
virtual bool16	AreGuidesSelected () const =0
virtual void	GetViewThreshold (K2Vector< PMReal > &thresholdList)=0
virtual void	GetColorUID (K2Vector< UID > &colorUIDList)=0
virtual void	GetType (K2Vector< IGuideData::GuideType > &typeList)=0
virtual void	GetGrowZone (K2Vector< PMReal > &growZoneList)=0
virtual ErrorCode	DeselectGuideUnderViewThreshold (PMReal viewTheshold)=0
virtual ErrorCode	DoSetColor (const UID &colorUID)=0
virtual ErrorCode	DoSetThreshold (const PMReal &viewTheshold)=0
virtual ErrorCode	DoSetType (IGuideData::GuideType type)=0
virtual ErrorCode	DoSetGrowZone (const PMReal &growZone)=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

Defines the interface for a guide data suite to be used in the new selection architecture

Member Function Documentation

virtual bool16 IGuideDataSuite::AreGuidesSelected ( ) const

pure virtual

Does the selection contain guides (guides cannot be selected with anything else)

Parameters

none

Returns

bool16

virtual ErrorCode IGuideDataSuite::DeselectGuideUnderViewThreshold ( PMReal  viewTheshold )

pure virtual

Deselect guides with a view threshold below the specified value.

Parameters

viewTheshold

- value for view threshold when guides are no longer visible.

Returns

ErrorCode

virtual ErrorCode IGuideDataSuite::DoSetColor ( const UID &  colorUID )

pure virtual

Change the color of the selected guides.

Parameters

colorRef

- UIDRef for the UID color to change the guide color.

Returns

ErrorCode

virtual ErrorCode IGuideDataSuite::DoSetGrowZone ( const PMReal &  growZone )

pure virtual

Process commands to set the guides in the selection to have the indicated grow zone.

Parameters

growZone

- the grow zone to set, see IGuideData

Returns

ErrorCode

virtual ErrorCode IGuideDataSuite::DoSetThreshold ( const PMReal &  viewTheshold )

pure virtual

Change the viewThreshold of the selected guides.

Parameters

viewTheshold

- value for view threshold when guides are no longer visible.

Returns

ErrorCode

virtual ErrorCode IGuideDataSuite::DoSetType ( IGuideData::GuideType  type )

pure virtual

Process commands to set the guides in the selection to the indicated guide type.

Parameters

type	- what type of guides to set, see IGuideData

Returns

ErrorCode

virtual void IGuideDataSuite::GetColorUID ( K2Vector< UID > &  colorUIDList )

pure virtual

Return a list of color UID values for guides in the selection. Only the unique UIDs are returned.

Parameters

colorIndex

virtual void IGuideDataSuite::GetGrowZone ( K2Vector< PMReal > &  growZoneList )

pure virtual

Return a list of guide zones for guides in the selection. Only the unique values are returned.

Parameters

growZoneList

virtual void IGuideDataSuite::GetType ( K2Vector< IGuideData::GuideType > &  typeList )

pure virtual

Return a list of guide data types for guides in the selection. Only the unique types are returned.

Parameters

typeList

virtual void IGuideDataSuite::GetViewThreshold ( K2Vector< PMReal > &  thresholdList )

pure virtual

Return a list of view threshold values for guides in the selection. Only the unique values are returned.

Parameters

guideList