IZeroPointPrefsCmdData Class Reference

#include <IZeroPointPrefsCmdData.h>

Inheritance diagram for IZeroPointPrefsCmdData:

Public Types
enum	{ kDefaultIID = IID_IZEROPOINTPREFSCMDDATA }

Public Member Functions
virtual void	Set (const UIDRef &doc, PMPoint zeroPoint, bool16 lock)=0
virtual const UIDRef &	GetDocument () const =0
virtual const PMPoint	GetZeroPoint () const =0
virtual const bool16	GetZeroPointLock () 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

Data interface for zero point preference-related commands. Used to set/get data for either the session workspace or the document workspace. Session workspace values are used for future documents and document workspace values are used for the current document. If UID is kInvalidUID, the session is used.

See Also

SetZeroPointPrefCmd

SetZeroPointLockPrefCmd

ZeroPointTracker

ZeroPointEventHandler

Member Function Documentation

virtual const UIDRef& IZeroPointPrefsCmdData::GetDocument ( ) const

pure virtual

Accessor for document to affect.

Returns

reference to UID of document to affect

virtual const PMPoint IZeroPointPrefsCmdData::GetZeroPoint ( ) const

pure virtual

Accessor for location of zero point relative to upper left corner of document spread.

Returns

relative location for zero point

virtual const bool16 IZeroPointPrefsCmdData::GetZeroPointLock ( ) const

pure virtual

Accessor for whether zero point is locked.

Returns

kTrue if zero point is locked, otherwise kFalse

virtual void IZeroPointPrefsCmdData::Set ( const UIDRef &  doc, PMPoint  zeroPoint, bool16  lock  )

pure virtual

Set zero point location relative to upper left corner of document spread and whether zero point is locked.

Parameters

doc	which document to affect.
zeroPoint	the relative location for zero point
lock	whether zero point is locked.