IAlignAndDistributeSuite Class Reference

Inheritance diagram for IAlignAndDistributeSuite:

Public Types
enum	{ kDefaultIID = IID_IALIGNANDDISTRIBUTESUITE }

Public Member Functions
virtual bool16	CanAlign (AlignType alignHow) const =0
virtual bool16	CanDistribute (DistributeType distributeHow, const PMReal &spacingValue, UseDistributeValue useValue) const =0
virtual bool16	CanSetKeyObject () const =0
virtual bool16	CanCancelKeyObject () const =0
virtual bool16	CanToggleKeyObject () const =0
virtual bool16	IsKeyObjectSelected () const =0
virtual ErrorCode	DoAlign (AlignType alignHow)=0
virtual ErrorCode	DoDistribute (DistributeType distributeHow, const PMReal &spacingValue, UseDistributeValue useValue)=0
virtual ErrorCode	DoSetKeyObject (const UIDRef &item=kInvalidUIDRef)=0
virtual ErrorCode	DoCancelKeyObject ()=0
virtual ErrorCode	DoToggleKeyObject (const UIDRef &item)=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 bool16 IAlignAndDistributeSuite::CanAlign ( AlignType  alignHow ) const

pure virtual

Returns kTrue if DoAlign() can be called, kFalse otherwise..

Parameters

alignHow

- how to align the objects, see IAlignCmdData

Returns

bool16

virtual bool16 IAlignAndDistributeSuite::CanCancelKeyObject ( ) const

pure virtual

Returns kTrue if the key object can be cleared, kFalse otherwise (i.e. it is not set)

virtual bool16 IAlignAndDistributeSuite::CanDistribute ( DistributeType  distributeHow, const PMReal &  spacingValue, UseDistributeValue  useValue  ) const

pure virtual

Returns kTrue if DoDistribute() can be called, kFalse otherwise..

Parameters

distributeHow	- how to distribute the objects, see IDistributeCmdData
spacingValue	- spacing value for between objects
useValue	- use the spacingValue or not

Returns

bool16

virtual bool16 IAlignAndDistributeSuite::CanSetKeyObject ( ) const

pure virtual

Returns kTrue if the key object can be called, kFalse otherwise.

virtual bool16 IAlignAndDistributeSuite::CanToggleKeyObject ( ) const

pure virtual

Returns kTrue if the key object can be cleared or set.

virtual ErrorCode IAlignAndDistributeSuite::DoAlign ( AlignType  alignHow )

pure virtual

Process commands to align the items in the selection with the specified type of alignment.

Parameters

alignHow

- how to align the objects, see IAlignCmdData

Returns

ErrorCode

virtual ErrorCode IAlignAndDistributeSuite::DoCancelKeyObject ( )

pure virtual

Clear any key object that has been set.

Returns

ErrorCode

virtual ErrorCode IAlignAndDistributeSuite::DoDistribute ( DistributeType  distributeHow, const PMReal &  spacingValue, UseDistributeValue  useValue  )

pure virtual

Process commands to distribute the items in the selection with the specified type of distribution. Depending on the value of useValue, optionally use the spacing value in distribution.

Parameters

distributeHow	- how to distribute the objects, see IDistributeCmdData
spacingValue	- spacing value for between objects
useValue	- use the spacingValue or not

Returns

ErrorCode

virtual ErrorCode IAlignAndDistributeSuite::DoSetKeyObject ( const UIDRef &  item = kInvalidUIDRef )

pure virtual

Set the key object. If default value (kInvalidUIDRef) is used, one of the objects in the selection will be used, or a particular object may be chosen.

Parameters

item	- the UIDRef of the item in the selection to use as the "key" object.

Returns

ErrorCode

virtual ErrorCode IAlignAndDistributeSuite::DoToggleKeyObject ( const UIDRef &  item )

pure virtual

If indicated object is key object, clear it, if not, set it.

Parameters

item	- the UIDRef of the item in the selection to toggle as the "key" object.

Returns

ErrorCode

virtual bool16 IAlignAndDistributeSuite::IsKeyObjectSelected ( ) const

pure virtual

Returns kTrue if the key object is selected.