Sets a callback function that enables the user to handle mouse events.
#include "ltivw.h"
L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerSetMouseCallBack(hCellWnd, pfnCallBack, pUserData)
A handle to the window that represents the cell on which the function's effect will be applied.
Callback function that is called every time the user makes an action with the mouse. The callback function must adhere to the function prototype described in DISPCONTAINERMOUSECALLBACK.
Void pointer that you can use to pass one or more additional parameters that the callback function needs. To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID *. The callback function, which receives the address in its own pUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure. If the additional parameters are not needed, you can pass NULL in this parameter.
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
To get the current callback function used to handle mouse events, call L_DispContainerGetMouseCallBack.
The following messages indicate there has been a mouse event:
WM_MOUSEMOVE.
WM_LBUTTONDOWN.
WM_RBUTTONDOWN.
WM_MBUTTONDOWN.
WM_XBUTTONDOWN
WM_LBUTTONUP.
WM_RBUTTONUP.
WM_MBUTTONUP
WM_XBUTTONUP
WM_MBUTTONDBLCLK.
WM_RBUTTONDBLCLK
WM_LBUTTONDBLCLK
WM_XBUTTONDBLCLK
For an example, refer to L_DispContainerFlipAnnotationContainer.