Help Version 19.0.2017.10.27
References ▼
#include "ltwrappr.h"
L_INT LImageViewerCell::GetKeyboardAction (nAction, nMouseDirection, puVk, puModifiers, uFlags);
L_INT nAction; |
action ID |
L_INT nMouseDirection; |
mouse direction |
L_UINT *puVk; |
pointer to a variable to be updated |
L_UINT * puModifiers; |
pointer to a variable to be updated |
L_UINT uFlags; |
reserved for future use |
Gets the keystroke combinations for a specific action.
| Parameter | Description | |
| 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 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] Rectangular annotation | |
| CONTAINER_ACTION_ANNOTATION_ELLIPSE | [12] Elliptical 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] Polygonal 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 | |
| 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: https://msdn.microsoft.com/en-us/library/ms927178.aspx. | |
| 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. Pass 0. | |
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
To set the keystroke combination for a specific action, call LImageViewerCell::SetKeyboardAction.
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. |
For an example, refer to LImageViewerCell::RemoveAction.