IDropDesktopFileCmdData Class Reference

#include <IDropDesktopFileCmdData.h>

Inheritance diagram for IDropDesktopFileCmdData:

Public Types
enum	{ kDefaultIID = IID_IDROPDESKTOPFILECMDDATA }
enum	eDropBehavior { kPlace, kReplace, kImport, kLoadPlaceGun }

Public Member Functions
virtual void	Set (const PMPoint &where, const UIDRef &parent, IDFile &file, UIFlags flags, const UIDRef &targetDoc, IPlaceBehavior *targetBehavior, const eDropBehavior dropBehavior=kPlace)=0
virtual void	Set (const PMPoint &where, const UIDRef &parent, IDFile &file, UIFlags flags, const UIDRef &targetDoc, IHierarchy *targetHier, const eDropBehavior dropBehavior=kPlace)=0
virtual const PMPoint &	GetDropPoint () const =0
virtual const UIDRef &	GetParent () const =0
virtual const IDFile &	GetSysFile () const =0
virtual UIFlags	GetUIFlags () const =0
virtual const UIDRef &	GetTargetDocument () const =0
virtual IPlaceBehavior *	GetTargetBehavior () const =0
virtual IHierarchy *	GetTargetHierarchy () const =0
virtual const eDropBehavior	GetDropBehavior () 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 used on command boss used when a desktop file is dropped on a layout window.

Member Enumeration Documentation

enum IDropDesktopFileCmdData::eDropBehavior

Specify what to do with file once it is placed.

Enumerator
kPlace	standard ProcessPlace.
kReplace	ProcessReplace.
kImport	importing file as is (simulates Place dialog)
kLoadPlaceGun	loads place gun

Member Function Documentation

virtual const eDropBehavior IDropDesktopFileCmdData::GetDropBehavior ( ) const

pure virtual

Get the drop behavior for the drop

virtual const PMPoint& IDropDesktopFileCmdData::GetDropPoint ( ) const

pure virtual

Get the location where the file was dropped

virtual const UIDRef& IDropDesktopFileCmdData::GetParent ( ) const

pure virtual

Get the parent pageitem to use for the drop

virtual const IDFile& IDropDesktopFileCmdData::GetSysFile ( ) const

pure virtual

Get the file that was dropped

virtual IPlaceBehavior* IDropDesktopFileCmdData::GetTargetBehavior ( ) const

pure virtual

Get the place behavior of the target

virtual const UIDRef& IDropDesktopFileCmdData::GetTargetDocument ( ) const

pure virtual

Get the document the drop occurred over for the drop

virtual IHierarchy* IDropDesktopFileCmdData::GetTargetHierarchy ( ) const

pure virtual

Get the spread layer of the target

virtual UIFlags IDropDesktopFileCmdData::GetUIFlags ( ) const

pure virtual

Get the UIFlags for the drop

virtual void IDropDesktopFileCmdData::Set ( const PMPoint &  where, const UIDRef &  parent, IDFile &  file, UIFlags  flags, const UIDRef &  targetDoc, IPlaceBehavior *  targetBehavior, const eDropBehavior  dropBehavior = kPlace  )

pure virtual

Put the IPlaceBehavior version of the data into the interface

Parameters

where	IN where di the drop occur in pasteboard coordinates
parent	IN object (if any) to be used as the parent for pageitems created by the drop
file	IN the file that was dropped
flags	IN flags indicating whether UI should be suppressed
targetDoc	IN document that the drop occured over
targetBehavior	IN Pointer to target place behavior object
dropBehavior	IN what type of drop to perform

virtual void IDropDesktopFileCmdData::Set ( const PMPoint &  where, const UIDRef &  parent, IDFile &  file, UIFlags  flags, const UIDRef &  targetDoc, IHierarchy *  targetHier, const eDropBehavior  dropBehavior = kPlace  )

pure virtual

Put the IHierarchy version of the data into the interface (special for XML)

Parameters

where	IN where di the drop occur in pasteboard coordinates
parent	IN object (if any) to be used as the parent for pageitems created by the drop
file	IN the file that was dropped
flags	IN flags indicating whether UI should be suppressed
targetDoc	IN document that the drop occured over
targetHier	IN Pointer to IHierarchy object
dropBehavior	IN what type of drop to perform