IMoveReferencePointCmdData Class Reference

#include <IMoveRefPointCmdData.h>

Inheritance diagram for IMoveReferencePointCmdData:

Public Member Functions
virtual void	SetMoveReferencePointCmdData (ILayoutControlData *layoutData, IReferencePointData::ReferencePointPosition newPosition, const PBPMPoint &newLocation, const PBPMRect &newReferenceFrame=kZeroRect)=0
virtual void	SetOldReferencePointLocation (const PBPMPoint &oldLocation)=0
virtual ILayoutControlData *	GetReferencePointLayoutData () const =0
virtual const IReferencePointData::ReferencePointPosition	GetNewReferencePointPosition ()=0
virtual const PBPMPoint	GetOldReferencePointLocation ()=0
virtual const PBPMPoint	GetNewReferencePointLocation ()=0
virtual const PBPMRect	GetNewContentOffsetFrame ()=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

Command data interface for controlling the reference point location for a layout view. In general, these methods are probably only used internally since the management of the reference point is handled via higher-level calls.

See Also

kMoveReferencePointCmdBoss

IRefPointUIUtils.h

Member Function Documentation

virtual const PBPMRect IMoveReferencePointCmdData::GetNewContentOffsetFrame ( )

pure virtual

Return the data value for newReferenceFrame that was set in the Set method.

Returns

PBPMRect the reference frame value

virtual const PBPMPoint IMoveReferencePointCmdData::GetNewReferencePointLocation ( )

pure virtual

Return the data value for newLocation that was set in the Set method.

Parameters

PBPMPoint

the reference point value

virtual const IReferencePointData::ReferencePointPosition IMoveReferencePointCmdData::GetNewReferencePointPosition ( )

pure virtual

Return the data value for newPosition that was set in the Set method.

Returns

ReferencePointPosition the new reference position

virtual const PBPMPoint IMoveReferencePointCmdData::GetOldReferencePointLocation ( )

pure virtual

Return the old reference point location, used for invalidating when observing command changes.

Returns

PBPMPoint the old reference location before the command was executed.

virtual ILayoutControlData* IMoveReferencePointCmdData::GetReferencePointLayoutData ( ) const

pure virtual

Return the ILayoutControlData* for the target view.

Returns

ILayoutControlData* for the target view.

virtual void IMoveReferencePointCmdData::SetMoveReferencePointCmdData ( ILayoutControlData *  layoutData, IReferencePointData::ReferencePointPosition  newPosition, const PBPMPoint &  newLocation, const PBPMRect &  newReferenceFrame = kZeroRect  )

pure virtual

Set the data for the move reference point command.

Parameters

layoutData	[IN] the ILayoutControlData for the layout view to set the reference point in.
newPosition	[IN] the ReferencePointPosition to change to
newLocation	[IN] the new location in global pasteboard coordinates for the reference point
newReferenceFrame[IN]	the reference frame for the reference point to be relative to (use kZeroRect if not relevant).

virtual void IMoveReferencePointCmdData::SetOldReferencePointLocation ( const PBPMPoint &  oldLocation )

pure virtual

Used internally by the kMoveReferencePointCmdBoss to save off the old location value.

Parameters

oldLocation

[IN] the previous reference location value.