@ohos.multimodalInput.keyEvent (按键输入事件)

设备上报的按键事件,继承自InputEvent

说明:

本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import { Action, Key, KeyEvent } from '@kit.InputKit';

Action

按键事件类型。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.MultimodalInput.Input.Core

名称 说明
CANCEL 0 按键取消。
DOWN 1 按键按下。
UP 2 按键抬起。

Key

按键。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.MultimodalInput.Input.Core

名称 类型 只读 可选 说明
code KeyCode 键值。
pressedTime number 按键按下时间,单位:μs。
deviceId number 输入设备的唯一标识,同一个物理设备反复插拔或重启,设备ID可能会发生变化。

KeyEvent

按键事件。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.MultimodalInput.Input.Core

名称 类型 只读 可选 说明
action Action 按键事件类型。
key Key 按键。
unicodeChar number 按键对应的unicode字符。
keys Key [] 当前处于按下状态的按键列表。
ctrlKey boolean 当前ctrlKey是否处于按下状态。
true表示处于按下状态,false表示处于抬起状态。
altKey boolean 当前altKey是否处于按下状态。
true表示处于按下状态,false表示处于抬起状态。
shiftKey boolean 当前shiftKey是否处于按下状态。
true表示处于按下状态,false表示处于抬起状态。
logoKey boolean 当前logoKey是否处于按下状态。
true表示处于按下状态,false表示处于抬起状态。
fnKey boolean 当前fnKey是否处于按下状态。
true表示处于按下状态,false表示处于抬起状态。
capsLock boolean 当前capsLock是否处于使能状态。
true表示处于使能状态,false表示处于未使能状态。
numLock boolean 当前numLock是否处于使能状态。
true表示处于使能状态,false表示处于未使能状态。
scrollLock boolean 当前scrollLock是否处于使能状态。
true表示处于使能状态,false表示处于未使能状态。