erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11
spiegel-keyman/web/docs/engine/reference/interface/keyInformation.md
Marc Durdin 6c145cb775 refactor(web): move web engine help to app repo 
Note: build.sh updated to make sure that test:help build action:target
doesn't also call test.sh by adding `:_all` meta-target.

Note: CI will need a new help-keyman-com.sh build step to deploy web
engine help.

Fixes: #12347
2024-10-31 11:00:06 +07:00

978 B
Raw Blame History

title
keyInformation (KKI)

Summary

Returns an object with extended information about a specified keystroke event.

Syntax

keyman.interface.keyInformation(e);

or

KeymanWeb.KKI(e); // Shorthand

Parameters

e
Type: Object
The event object to be evaluated.

Return Value

Object
An object with extended key event information.

Description

Note: This function will not succeed if it is called from outside of a keyboard's standard text-processing operations.

The key_event object contains the following members:

vk
boolean
A flag indicating whether or not the event corresponds to a virtual key.
code
number
The underlying keycode for the event.
modifiers
number
A set of bit-flags corresponding to the SHIFT, CTRL, and ALT state of the keyboard.

The bit masks for each modifier are as follows:

  • SHIFT : 0x10

  • CTRL : 0x20

  • ALT : 0x40