L_DispContainerGetKeyboardAction

#include "ltivw.h"

L_INT EXT_FUNCTION L_DispContainerGetKeyboardAction(hCon, nAction, nMouseDirection, puVk, puModifiers, uFlags)

HDISPCONTAINER hCon;

/* handle to the container */

L_INT nAction;

/* action ID */

L_INT nMouseDirection;

/* mouse direction */

L_UINT L_FAR * puVK;

/* pointer to a variable to be updated */

L_UINT L_FAR * puModifiers;

/* pointer to a variable to be updated */

L_UINT uFlags;

/* reserved for future use */

Gets the keystroke combinations for a specific action. This function is available only in the Medical Imaging Suite toolkits.

Parameter

Description

hCon

Handle to the container.

nAction

Value that represents the action for which to get the keystroke combination. If nAction is equal to or greater than 100, it is a user-defined action. Otherwise, it should be one of these predefined actions:

 

CONTAINER_ACTION_WINDOWLEVEL

[1] Window leveling

 

CONTAINER_ACTION_SCALE

[2] Scaling

 

CONTAINER_ACTION_OFFSET

[3] Offset

 

CONTAINER_ACTION_STACK

[4] Stacking

 

CONTAINER_ACTION_MAG

[5] Magnifying glass

 

CONTAINER_ACTION_ALPHA

[6] Alpha

nMouseDirection

Value that represents the mouse direction for which to get the assigned keystroke. Possible values are:

 

Value

Meaning

 

CONTAINER_MOUSEMOVE_UP

[0x00000000] Mouse moving up.

 

CONTAINER_MOUSEMOVE_DOWN

[0x00000001] Mouse moving down.

 

CONTAINER_MOUSEMOVE_LEFT

[0x00000002] Mouse moving left.

 

CONTAINER_MOUSEMOVE_RIGHT

[0x00000003] Mouse moving right.

 

puVK

Pointer to a variable to be updated with the virtual key code. These are the virtual key codes used by the Microsoft Windows CE operating system. For more information refer to: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winui/windowsuserinterface/userinput/virtualkeycodes.asp.

puModifiers

Pointer to a variable to be updated with the modifier key(s). Possible values are:

 

Value

Meaning

 

CONTAINER_KEY_NONE

[0x00000000] No other key should be pressed.

 

CONTAINER_KEY_SHIFT

[0x00000001] Left or right Shift key must be pressed.

 

CONTAINER_KEY_CTRL

[0x00000002] Left or right Control key must be pressed.

 

CONTAINER_KEY_ALT

[0x00000004] Left or right ALT key must be pressed.

uFlags

Reserved for future use. Must be zero.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To set the keystroke combination for a specific action, call L_DispContainerSetKeyboardAction.

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_DispContainerAddAction, L_DispContainerSetAction, L_DispContainerSetActionProperties, L_DispContainerGetActionProperties, L_DispContainerRemoveAction, L_DispContainerGetActionCount, L_DispContainerSetKeyboardAction, L_DispContainerIsActionActive, L_DispContainerGetActionCallBack, L_DispContainerSetActionCallBack

Topics:

Applying Actions

 

Image Viewer Functions: Applying Actions

Example

For an example refere to L_DispContainerRemoveAction