InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IBatchPlaceTrackerHelper Class Referenceabstract

#include <IBatchPlaceTrackerHelper.h>

Inheritance diagram for IBatchPlaceTrackerHelper:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IBATCHPLACETRACKERHELPER }
 

Public Member Functions

virtual UIDList AdjustAlreadyPlacedItems (PMPoint startPnt, IControlView *controlView, const UIDRef &parent, const PMPointList &points, const IEvent &theEvent, IPlaceBehavior::eAfterPlace *afterPlace)=0
 
virtual UIDRef ConvertPlacedItemsToInline (ITextTarget *iTextTarget)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Abstract interface for a helper class to assist a tracker in doing "batch place" operations; that is, imports that immediately put potentially many pageitems onto the page, but still need to have the standard place-gun capabilities of positioning where the item(s) should be put, import preview, etc. This class aids in the proper positioning of the items after the user clicks a position for placement.

Member Function Documentation

virtual UIDList IBatchPlaceTrackerHelper::AdjustAlreadyPlacedItems (PMPoint startPnt,
IControlViewcontrolView,
const UIDRefparent,
const PMPointListpoints,
const IEventtheEvent,
IPlaceBehavior::eAfterPlaceafterPlace 
)
pure virtual

Perform the adjustments needed to properly position the already placed items according to the user's click. Typically this would mean a translation of the items from their import-time locations to the user's click location.

Parameters
startPntIN where the snippet was initially imported
controlViewIN the view clicked in by the user
parentIN the parent item for the pageitem(s)
pointsIN two points – first button-down location, and if a drag-box, the button-up location
theEventIN the event record
afterPlaceOUT what behavior to take after the place operation
Returns
UIDList of the adjusted items
virtual UIDRef IBatchPlaceTrackerHelper::ConvertPlacedItemsToInline (ITextTargetiTextTarget)
pure virtual

Convert the placed snippet into an inline at the indicated text location. Only succeeds if the snippet contains a single object with IHierarchy.

Parameters
iTextTargetIN is the text location at which to create the inline
Returns
the UIDRef of the inline