L_DispContainerSetProbeToolUpdatedCallBack

Summary

Sets a callback function, which occurs every time the probe tool changes its position, thus changes the displayed information.

Syntax

L_LTIVW_API L_INT L_DispContainerSetProbeToolUpdatedCallBack(hCellWnd, pfnCallBack, pUserData);

Parameters

L_HWND hCellWnd

A handle to the window that represents the Medical Viewer Cell.

DISPCONTAINERPROBETOOLUPDATEDCALLBACK pfnCallBack

Callback function that is called every time the user moves the probe tool and change its location. The callback function must adhere to the function prototype described in DISPCONTAINERPROBETOOLUPDATEDCALLBACK.

LPVOID pUserData

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.

Returns

Comments

To get the current callback function used to notify the user about the change in the probe tool position, call the L_DispContainerGetProbeToolUpdatedCallBack.

To enable the probe tool action, first use the function L_DispContainerAddAction, then use the function L_DispContainerSetAction using the flag CONTAINER_ACTION_PROBETOOL.

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_DispContainerGetProbeToolUpdatedCallBack
• 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
• DISPCONTAINERANNOTATIONCALLBACK
• DISPCONTAINERANNOTATIONCREATEDCALLBACK
• DISPCONTAINERTAGCALLBACK
• DISPCONTAINERACTIONCALLBACK

Topics

• Image Viewer Cells
• Image Viewer Functions: Image Viewer Cells

Example

This function sets the probe tool callback.

L_INT EXT_CALLBACK ProbeToolCallback(L_HWND hCellWnd, 
                                     L_INT nSubCellIndex, 
                                     L_INT nX, 
                                     L_INT nY, 
                                     pBITMAPHANDLE pBitmap, 
                                     L_TCHAR * szPixelValue, 
                                     L_VOID * pUserData) 
{ 
   UNREFERENCED_PARAMETER(pUserData); 
   UNREFERENCED_PARAMETER(pBitmap); 
   UNREFERENCED_PARAMETER(nSubCellIndex); 
   UNREFERENCED_PARAMETER(hCellWnd); 
 
   wsprintf(szPixelValue, TEXT("X Value = %d and Y Value = %d"), nX, nY); 
 
   return SUCCESS; 
} 
 
 
L_INT L_DispContainerSetProbeToolUpdatedCallBackExample(HWND hCellWnd) 
{ 
   L_VOID * pPreviousUserData; 
   DISPCONTAINERPROBETOOLUPDATEDCALLBACK pPreviousCallback; 
 
   L_DispContainerGetProbeToolUpdatedCallBack(hCellWnd, &pPreviousCallback, &pPreviousUserData); 
 
   L_DispContainerSetProbeToolUpdatedCallBack(hCellWnd, ProbeToolCallback, NULL); 
 
   L_DispContainerAddAction(hCellWnd, CONTAINER_ACTION_PROBETOOL, 0); 
 
   L_DispContainerSetAction(hCellWnd, CONTAINER_ACTION_PROBETOOL, CONTAINER_MOUSE_BUTTON_LEFT, 0); 
 
   return SUCCESS; 
}