L_DispContainerSetActionCallBack

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerSetActionCallBack(hCon, pfnCallBack, pUserData)

HDISPCONTAINER hCon;

/* handle to the container */

DISPCONTAINERACTIONCALLBACK pfnCallBack;

/* callback function. */

L_VOID * pUserData;

/*pointer to more parameters for the callback. */

Sets a callback function, which lets the user handle user-defined actions. This function is available only in the Medical Imaging Suite Suite toolkits.

Parameter

Description

hCon

Handle to the container.

pfnCallBack

Callback function that is called every time the container indicates there has been a mouse or keyboard event that is associated with a user-defined action.

 

The callback function must adhere to the function prototype described in DISPCONTAINERACTIONCALLBACK.

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

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To get the current callback function used to handle custom actions, call L_DispContainerGetActionCallBack.

The following messages indicate there has been a mouse or keyboard event:

WM_MOUSEMOVE.

WM_LBUTTONDOWN.

WM_RBUTTONDOWN.

WM_MBUTTONDOWN.

WM_LBUTTONUP.

WM_RBUTTONUP.

WM_MBUTTONUP.

WM_MOUSEWHEEL.

WM_KEYDOWN.

WM_KEYUP.

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_DispContainerGetTagCallBack, L_DispContainerSetTagCallBack, L_DispContainerGetActionCallBack, DISPCONTAINERTAGCALLBACK, DISPCONTAINERACTIONCALLBACK

Topics:

Applying Actions

 

Image Viewer Functions: Applying Actions

Example

For an example, refer to L_DispContainerGetActionCallBack.