HDISPCONTAINER hCon;

/* handle to the container */

L_INT nAction;

/* action ID */

L_INT nButton;

/* mouse direction */

L_UINT uKey;

/* virtual key which will be attach to the mouse direction */

L_UINT uFlags;

/* modifier key */

Parameter

Description

hCon

Handle to the container.

nAction

Value that represents the action assigned to the keystroke. If nAction is equal to or greater than 100, it is a user-defined action. Otherwise, it can be one of the following predefined actions.

Value

Meaning

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

CONTAINER_ACTION_ANNOTATION_RULER

[7] Ruler annotation

CONTAINER_ACTION_ANNOTATION_ANGLE

[8] Angle annotation

CONTAINER_ACTION_ANNOTATION_TEXT

[9] Text annotation

CONTAINER_ACTION_ANNOTATION_ARROW

[10] Arrow annotation

CONTAINER_ACTION_ANNOTATION_RECTANGLE

[11] Rectangle annotation

CONTAINER_ACTION_ANNOTATION_ELLIPSE

[12] Ellipse annotation

CONTAINER_ACTION_ANNOTATION_HILITE

[13] Highlight annotation

CONTAINER_ACTION_REGION_RECTANGLE

[14] Rectangular region

CONTAINER_ACTION_REGION_ELLIPSE

[15] Elliptical region

CONTAINER_ACTION_REGION_FREEHAND

[16] Free hand region

CONTAINER_ACTION_REGION_POLYGON

[17] Polygon region

CONTAINER_ACTION_REGION_MAGICWAND

[18] Magic wand (contiguous color)  region

CONTAINER_ACTION_REGION_COLORRANGE

[19] Color range region

CONTAINER_ACTION_REGION_CIRCLE

[20] Circular region

CONTAINER_ACTION_REGION_SQUARE

[21] Square region

CONTAINER_ACTION_REGION_NUDGETOOL

[22] Nudge tool

CONTAINER_ACTION_REGION_SHRINKTOOL

[23] Shrink tool

nButton

Value that represents the mouse direction assigned to the 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.

uKey

Value that represents the virtual key to be set. These are the virtual key codes used by the Microsoft Windows operating system. For more information refer to: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winui/windowsuserinterface/userinput/virtualkeycodes.asp.

uFlags

Flag that indicates which modifier key should be pressed with the key specified in uKey. 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.

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

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.

Functions:

L_DispContainerAddAction, L_DispContainerSetAction, L_DispContainerSetActionProperties, L_DispContainerGetActionProperties, L_DispContainerRemoveAction, L_DispContainerGetActionCount, L_DispContainerGetKeyboardAction, L_DispContainerIsActionActive, L_DispContainerGetActionCallBack, L_DispContainerSetActionCallBack

Topics:

Applying Actions

Image Viewer Functions: Applying Actions