DISPCONTAINERANNOTATIONCALLBACK

#include "l_bitmap.h"

L_INT pEXT_CALLBACK YourFunction(uMessage, nX, nY, nCellIndex, nSubCellIndex, pUserData)

L_UINT uMessage;

/* message */

L_INT nX;

/* X mouse position */

L_INT nY;

/* Y mouse position */

L_INT nCellIndex;

/* index of the affected cell */

L_INT nSubCellIndex;

/* index into the image list attached to the cell */

L_VOID * pUserData;

/* pointer to more parameters for the callback */

This callback function is called every time the user clicks on an annotation object.

Parameter

Description

uMessage

Value that represents the message from the mouse. Possible values are:

 

WM_LBUTTONDOWN

 

WM_LBUTTONUP

 

WM_MBUTTONDOWN

 

WM_MBUTTONUP

 

WM_XBUTTONDOWN

 

WM_XBUTTONUP

 

WM_MOUSEMOVE

 

WM_RBUTTONDOWN

 

WM_RBUTTONUP

nX

A Value that represents the X position of the cursor.

nY

A Value that represents the Y position of the cursor.

nCellIndex

A zero-based index of the cell that contains the annotation object.

nSubCellIndex

A zero-based index of the sub-cell that contains that annotation object.

pUserData

A void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of L_DispContainerSetAnnotationCallBack.) Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To set the current callback use L_DispContainerGetAnnotationCallBack. To get the current callback, call L_DispContainerGetAnnotationCallBack

Required DLLs and Libraries

LTIVW
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

L_DispContainerGetMouseCallBack, L_DispContainerSetMouseCallBack, L_DispContainerSetActionCallBack, L_DispContainerSetTagCallBack, L_DispContainerGetTagCallBack, L_DispContainerSetAnnotationCallBack, L_DispContainerGetAnnotationCreatedCallBack, L_DispContainerSetAnnotationCreatedCallBack, L_DispContainerGetPrePaintCallBack, L_DispContainerSetPrePaintCallBack, DISPCONTAINERPREPAINTCALLBACK, L_DispContainerGetPostPaintCallBack, L_DispContainerSetPostPaintCallBack DISPCONTAINERPOSTPAINTCALLBACK, DISPCONTAINERANNOTATIONCREATEDCALLBACK, DISPCONTAINERTAGCALLBACK, DISPCONTAINERACTIONCALLBACK

Topics:

Image Viewer Cells

 

Image Viewer Functions: Callbacks

 

Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to L_DispContainerGetAnnotationCallBack.