• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.multimodalInput.keyEvent (按键输入事件)
2
3<!--Kit: Input Kit-->
4<!--Subsystem: MultimodalInput-->
5<!--Owner: @zhaoxueyuan-->
6<!--Designer: @hanruofei-->
7<!--Tester: @Lyuxin-->
8<!--Adviser: @Brilliantry_Rui-->
9
10设备上报的按键事件，继承自[InputEvent](js-apis-inputevent.md)。
11
12> **说明：**
13>
14> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
15
16## 导入模块
17
18```js
19import { Action, Key, KeyEvent } from '@kit.InputKit';
20```
21
22## Action
23
24按键事件类型。
25
26**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
27
28**系统能力：** SystemCapability.MultimodalInput.Input.Core
29
30| 名称   | 值  | 说明     |
31| ------ | ------- | -------- |
32| CANCEL | 0    | 按键取消。 |
33| DOWN   | 1    | 按键按下。 |
34| UP     | 2    | 按键抬起。 |
35
36## Key
37
38按键。
39
40**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
41
42**系统能力：** SystemCapability.MultimodalInput.Input.Core
43
44| 名称        | 类型 | 只读 | 可选 | 说明           |
45| ----------- | -------- | ---- | ---- | -------------- |
46| code        | [KeyCode](js-apis-keycode.md#keycode)  | 否   | 否   | 按键码。         |
47| pressedTime | number   | 否   | 否   | 按键按下时间，单位为微秒（μs）。 |
48| deviceId    | number   | 否   | 否   | 按键所属设备id。   |
49
50## KeyEvent
51
52按键事件。
53
54**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
55
56**系统能力：** SystemCapability.MultimodalInput.Input.Core
57
58| 名称        | 类型 | 只读 | 可选 | 说明                           |
59| ----------- | -------- | ---- | ---- | ------------------------------ |
60| action      | [Action](#action)   | 否   | 否   | 按键动作。                       |
61| key         | [Key](#key)      | 否   | 否   | 当前上报的按键。             |
62| unicodeChar | number   | 否   | 否   | 按键对应的uniCode字符。          |
63| keys        | [Key](#key) []    | 否   | 否   | 当前处于按下状态的按键列表。     |
64| ctrlKey     | boolean  | 否   | 否   | 当前ctrlKey是否处于按下状态。 <br/>true表示处于按下状态，false表示处于抬起状态。 |
65| altKey      | boolean  | 否   | 否   | 当前altKey是否处于按下状态。 <br/>true表示处于按下状态，false表示处于抬起状态。     |
66| shiftKey    | boolean  | 否   | 否   | 当前shiftKey是否处于按下状态。 <br/>true表示处于按下状态，false表示处于抬起状态。   |
67| logoKey     | boolean  | 否   | 否   | 当前logoKey是否处于按下状态。 <br/>true表示处于按下状态，false表示处于抬起状态。    |
68| fnKey       | boolean  | 否   | 否   | 当前fnKey是否处于按下状态。 <br/>true表示处于按下状态，false表示处于抬起状态。      |
69| capsLock    | boolean  | 否   | 否   | 当前capsLock是否处于激活状态。 <br/>true表示处于激活状态，false表示处于未激活状态。   |
70| numLock     | boolean  | 否   | 否   | 当前numLock是否处于激活状态。 <br/>true表示处于激活状态，false表示处于未激活状态。    |
71| scrollLock  | boolean  | 否   | 否   | 当前scrollLock是否处于激活状态。 <br/>true表示处于激活状态，false表示处于未激活状态。 |
72