InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ILayoutHitTestSuite Class Referenceabstract

#include <ILayoutHitTestSuite.h>

Inheritance diagram for ILayoutHitTestSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ILAYOUTHITTESTSUITE }
 

Public Member Functions

virtual ITracker * QueryHitTestHandlesForTracker (IControlView *view, const PBPMPoint &where, ClassID handlerBossClass, bool16 bDragging=kFalse, int16 tolerance=kHitTestTolerance)=0
 
virtual IGeometry * QueryHitTestHandles (IControlView *view, const PBPMPoint &where, PointSelector &handleIndex, bool16 bDragging=kFalse, int16 tolerance=kHitTestTolerance)=0
 
virtual IGeometry * QueryHitTestBoundingBox (IControlView *view, const PBPMPoint &where, int16 tolerance=kHitTestTolerance)=0
 
virtual IGeometry * QueryHitTestItems (IControlView *view, const PBPMPoint &where, ClassID handlerBossClass, int16 tolerance=kHitTestTolerance)=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

Suite interface to support hit-testing on the current layout selection. Used to determine whether a given point in a currently-selected item has been hit.

Member Function Documentation

virtual IGeometry* ILayoutHitTestSuite::QueryHitTestBoundingBox (IControlView * view,
const PBPMPoint & where,
int16 tolerance = kHitTestTolerance 
)
pure virtual

For the currently-selected pageitems in the given view, hit-test a point against item bounding boxes, returning the item's IGeometry interface

Parameters
view[IN] The view whose selection to test
where[IN] Pasteboard coordinates of point to test
tolerance[IN] The tolerance for how close 'where' must be to be considered a hit. Defaults to kHitTestTolerance.
Returns
IGeometry* for the selected pageitem hit. Nil if no selected item hit. The reference count is incremented. The caller is responsible for calling Release() or embedding the return value in an appropriate InterfacePtr construct.
See Also
HitTestDragConstants.h for kHitTestTolerance
virtual IGeometry* ILayoutHitTestSuite::QueryHitTestHandles (IControlView * view,
const PBPMPoint & where,
PointSelector & handleIndex,
bool16 bDragging = kFalse,
int16 tolerance = kHitTestTolerance 
)
pure virtual

For the currently-selected pageitems in the given view, hit-test a point against selection handles, returning the item's IGeometry interface, and indicating which handle was hit

Parameters
view[IN] The view whose selection to test
where[IN] Pasteboard coordinates of point to test
handleIndex[OUT] Indicates which handle was hit
bDragging[IN] Whether mouse is being dragged
tolerance[IN] The tolerance for how close 'where' must be to be considered a hit. Defaults to kHitTestTolerance.
Returns
IGeometry* for the selected pageitem hit. Nil if no selected item hit. The reference count is incremented. The caller is responsible for calling Release() or embedding the return value in an appropriate InterfacePtr construct.
See Also
HitTestDragConstants.h for kHitTestTolerance
virtual ITracker* ILayoutHitTestSuite::QueryHitTestHandlesForTracker (IControlView * view,
const PBPMPoint & where,
ClassID handlerBossClass,
bool16 bDragging = kFalse,
int16 tolerance = kHitTestTolerance 
)
pure virtual

For the currently-selected pageitems in the given view, hit-test a point against selection handles using the hit-test handler boss, returning the appropriate tracker

Parameters
view[IN] The view whose selection to test
where[IN] Pasteboard coordinates of point to test
handlerBossClass[IN] Hit-test handler boss to use
bDragging[IN] Whether mouse is being dragged
tolerance[IN] The tolerance for how close 'where' must be to be considered a hit. Defaults to kHitTestTolerance.
Returns
ITracker* for the tracker to use. Nil if no selected item hit. The reference count is incremented. The caller is responsible for calling Release() or embedding the return value in an appropriate InterfacePtr construct.
See Also
GenericID.h and GenericClass.fr for various kXXXHitTestHandlerBoss definitions
HitTestDragConstants.h for kHitTestTolerance
virtual IGeometry* ILayoutHitTestSuite::QueryHitTestItems (IControlView * view,
const PBPMPoint & where,
ClassID handlerBossClass,
int16 tolerance = kHitTestTolerance 
)
pure virtual

For the currently-selected pageitems in the given view, hit-test a point against items using the hit-test handler boss, returning the item's IGeometry interface

Parameters
view[IN] The view whose selection to test
where[IN] Pasteboard coordinates of point to test
handlerBossClass[IN] Hit-test handler boss to use
tolerance[IN] The tolerance for how close 'where' must be to be considered a hit. Defaults to kHitTestTolerance.
Returns
IGeometry* for the selected pageitem hit. Nil if no selected item hit. The reference count is incremented. The caller is responsible for calling Release() or embedding the return value in an appropriate InterfacePtr construct.
See Also
GenericID.h and GenericClass.fr for various kXXXHitTestHandlerBoss definitions
HitTestDragConstants.h for kHitTestTolerance