HITTESTINFO

typedef struct tagHITTESTINFO
{
   L_UINT uStructSize;
   L_INT nHandleIndex;
   L_INT nHandleID;
   L_INT nReserved;
} *pHITTESTINFO, HITTESTINFO;

The HITTESTINFO structure provides hit test information for the LAnnContainer::HitTest function.

Member

Description

uStructSize

Size of this structure. Use sizeof(HITTESTINFO).

nHandleIndex

This is the zero-based index of the handle. This field is valid only if puResult of LAnnContainer::HitTest is updated with either ANNHIT_HANDLE or ANNHIT_USER_HANDLE. The default handles and the user handles are maintained internally as separate arrays of handles. This means that there is both a default handle "0" and a user handle "0". This index can be used with other annotation handle functions.

nHandleID

The unique ID associated with the user handle. The ID can be set with the LAnnXXX::AddUserHandle, LAnnXXX::ChangeUserHandle, or LAnnXXX::EnumerateHandles functions, where LAnnXXX represents the classes that support handles. These classes are as follows:

 

LAnnAudioClip

 

LAnnButton

 

LAnnCrossProduct

 

LAnnCurve

 

LAnnCurveClosed

 

LAnnEllipse

 

LAnnEncrypt

 

LAnnFreehand

 

LAnnFreehandHotSpot

 

LAnnHilite

 

LAnnHotSpot

 

LAnnLine

 

LAnnNote

 

LAnnPolygon

 

LAnnPoint

 

LAnnPolyline

 

LAnnPolyRuler

 

LAnnProtractor

 

LAnnPointer

 

LAnnPushPin

 

LAnnRedact

 

LAnnRectangle

 

LAnnRTF

 

LAnnRuler

 

LAnnStamp

 

LAnnText

 

LAnnTextPointer

 

LAnnToolBar

 

LAnnVideo

nReserved

Reserved for future use. Set this field to zero.

Comments

For an example showing the use of this structure, refer to LAnnContainer::HitTest.

See Also

Functions:

LAnnContainer::HitTest, LAnnContainer::Convert, LAnnContainer::RestrictCursor, LAnnotation::GetRestrictToContainer, LAnnotation::SetRestrictToContainer, LAnnotation::Define2, LAnnotation::Define

Topics:

Annotation Functions: Creating Custom Annotations