Inheritance diagram for IMoveTrackerData:

Public Types
enum	{ kDefaultIID = IID_IMOVETRACKERDATA }

Public Member Functions
virtual void	Set (UIDList itemList, const PBPMPoint &startPt, int32 selectionMode, bool16 deselect, UIDList reselectItemList=nil)=0

virtual UIDList *	GetItemList () const =0

virtual UIDList *	GetReselectItemList () const =0

virtual const PBPMPoint	GetStartPoint () const =0

virtual int32	GetSelectionMode () const =0

virtual bool16	GetDeselect () const =0

virtual bool16	ShouldDrawFirst ()=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 IMoveTrackerData::GetDeselect ( ) const

pure virtual

Gets the data value for whether to deselect page items.

Returns: the deselect value. kFalse means tracker will select page items in item list, kTrue means then will be deselected.

virtual UIDList* IMoveTrackerData::GetItemList ( ) const

pure virtual

Gets the data value for the tracker's item list.

Returns: a pointer to the item list for the tracker to operate on.

virtual UIDList* IMoveTrackerData::GetReselectItemList ( ) const

pure virtual

Gets the data value for the tracker's "reselect" item list. May be nil, and defaults to nil if not set.

Returns: a pointer to the "reselect" item list for the tracker to select after tracking has completed.

virtual int32 IMoveTrackerData::GetSelectionMode ( ) const

pure virtual

Gets the data value for the Selection enum type.

Returns: the selectionMode for how the tracker should select the item(s). Either Selection::kAddTo or Selection::kReplace

virtual const PBPMPoint IMoveTrackerData::GetStartPoint ( ) const

pure virtual

Gets the data value for the initial mouse down location for the tracker.

Returns: a PMPoint in pasteboard coordinate space.

virtual void IMoveTrackerData::Set	(	UIDList *	itemList,
		const PBPMPoint &	startPt,
		int32	selectionMode,
		bool16	deselect,
		UIDList *	reselectItemList = `nil`
	)

pure virtual

Set method to control how a tracker moves page items.

Parameters

itemList	A pointer to the item list of page items for tracker to move.
startPt	A PMPoint in pasteboard coordinate space. Represents the users mouse down location.
selectionMode	how to select the item(s). Either Selection::kAddTo or Selection::kReplace
isVisible	The setting for the new layer's visibility. Default is kTrue for visible, kFalse for hidden.
deselect	Should the tracker deselect the items in item list. Typically set when user Shift clicks on an item. Typically set to kFalse and by default tracker selects the items in the item list.
reselectItemList	A pointer to the "reselect" item list of page items for tracker to select after move has completed. Used for moving content of an image frame with rollover effect when we don't want to select the content. If nil, after move is completed, selection won't be altered. If empty list, selection will be set to this list (i.e. no selection), otherwise items in list will be selected.

virtual bool16 IMoveTrackerData::ShouldDrawFirst ( )

pure virtual

Gets the data value for if drawing should the Selection enum type. Calling this method toggles the value to kFalse. Use for drag and drop between targets to know if drag is local or not.

Returns: the value

Public Types

Public Member Functions

Member Function Documentation