Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 ea375dbb 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!22549 多模文档整改 

Merge pull request !22549 from ningning/master
上级 96826c76 9e99e7fa
隐藏空白更改
内联 并排
Showing with 99 addition and 111 deletion
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
浏览文件 @ ea375dbb
......@@ -8,18 +8,15 @@
>
> - 本模块接口为系统接口。
## 导入模块
```js
import inputConsumer from '@ohos.multimodalInput.inputConsumer';
```
## inputConsumer.on
on(type: "key", keyOptions: KeyOptions, callback: Callback<KeyOptions>): void
on(type: 'key', keyOptions: KeyOptions, callback: Callback<KeyOptions>): void
订阅组合按键，当满足条件的组合按键输入事件发生时，使用Callback异步方式上报组合按键数据。
......@@ -29,7 +26,7 @@ on(type: "key", keyOptions: KeyOptions, callback: Callback<KeyOptions>): v
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 事件类型，目前只支持”key“。 |
| type | string | 是 | 事件类型，目前仅支持'key'。 |
| keyOptions | [KeyOptions](#keyoptions) | 是 | 组合键选项。 |
| callback | Callback<KeyOptions> | 是 | 回调函数，当满足条件的组合按键输入事件发生时，异步上报组合按键数据。 |
......@@ -50,7 +47,7 @@ try {
## inputConsumer.off
off(type: "key", keyOptions: KeyOptions, callback?: Callback<KeyOptions>): void
off(type: 'key', keyOptions: KeyOptions, callback?: Callback<KeyOptions>): void
取消订阅组合按键。
......@@ -60,9 +57,9 @@ off(type: "key", keyOptions: KeyOptions, callback?: Callback<KeyOptions>):
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------------- | ---- | ------------------------------- |
| type | string | 是 | 事件类型，当前只支持”key“。 |
| type | string | 是 | 事件类型，当前仅支持 'key'。 |
| keyOptions | [KeyOptions](#keyoptions) | 是 | 组合键选项。 |
| callback | Callback<KeyOptions> | 否 | 需要取消订阅的回调函数，若无此参数，则取消当前应用的组合键选项已订阅的所有回调函数。 |
| callback | Callback<KeyOptions> | 否 | 需要取消订阅的回调函数。若不填，则取消当前应用组合键选项已订阅的所有回调函数。 |
**示例：**
......@@ -99,7 +96,6 @@ try {
}
```
## KeyOptions
组合键选项。
......@@ -108,7 +104,7 @@ try {
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ------ | ---- | ---- | ------- |
| preKeys | Array\<number> | 是 | 否 | 前置按键集合，数量范围[0, 4]，前置按键无顺序要求。 |
| finalKey | number | 是 | 否 | 最终按键，此项必填，最终按键触发上报回调函数。 |
| isFinalKeyDown | boolean | 是 | 否 | 最终按键状态。 |
| finalKeyDownDuration | number | 是 | 否 | 最终按键保持按下持续时间，为0时立即触发回调函数，大于0时，当isFinalKeyDown为true，则最终按键按下超过此时长后触发回调函数，当isFinalKeyDown为false，则最终按键按下到抬起时间小于此时长时触发回调函数。 |
| preKeys | Array\<number> | 是 | 否 | 前置按键集合，数量范围[0, 4]，前置按键无顺序要求。<br>如组合按键Ctrl+Alt+A中，Ctrl+Alt称为前置按键。 |
| finalKey | number | 是 | 否 | 最终按键，此项必填，最终按键触发上报回调函数。<br>如组合按键Ctrl+Alt+A中，A称为最终按键按键。 |
| isFinalKeyDown | boolean | 是 | 否 | 最终按键状态。<br>ture表示按键按下，false表示按键抬起。 |
| finalKeyDownDuration | number | 是 | 否 | 最终按键保持按下持续时间，单位为微秒（μs）。<br>当finalKeyDownDuration为0时，立即触发回调函数。<br>当finalKeyDownDuration大于0时，isFinalKeyDown为true，则最终按键按下超过设置时长后触发回调函数；isFinalKeyDown为false，则最终按键按下到抬起时间小于设置时长时触发回调函数。 |
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
浏览文件 @ ea375dbb
......@@ -22,6 +22,6 @@ import InputEvent from '@ohos.multimodalInput.inputEvent';
| ---------- | ------ | ---- | ---- | -------------- |
| id | number | 是 | 否 | 事件id |
| deviceId | number | 是 | 否 | 上报输入事件的设备id |
| actionTime | number | 是 | 否 | 输入事件的上报时间 |
| actionTime | number | 是 | 否 | 上报输入事件的时间 |
| screenId | number | 是 | 否 | 目标屏幕id |
| windowId | number | 是 | 否 | 目标窗口id |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md
浏览文件 @ ea375dbb
......@@ -8,20 +8,17 @@
>
> - 本模块接口为系统接口。
## 导入模块
```js
import inputEventClient from '@ohos.multimodalInput.inputEventClient';
```
## inputEventClient.injectEvent
injectEvent({KeyEvent: KeyEvent}): void
按键注入，当前仅支持返回键（键值2）注入。
按键注入，当前仅支持返回键/KEYCODE_BACK（键码值2）注入。
**系统能力：** SystemCapability.MultimodalInput.Input.InputSimulator
......@@ -55,7 +52,6 @@ try {
}
```
## KeyEvent
按键注入描述信息。
......@@ -64,8 +60,8 @@ try {
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ------ | ---- | ---- | ------- |
| isPressed | boolean | 是 | 否 | 按键是否按下。 |
| keyCode | number | 是 | 否 | 按键键值，当前只支持back键。 |
| keyDownDuration | number | 是 | 否 | 按键按下持续时间。 |
| isIntercepted | boolean | 是 | 否 | 按键是否可以被拦截。 |
| isPressed | boolean | 是 | 否 | 按键是否按下。<br>ture表示按键按下，false表示按键抬起。 |
| keyCode | number | 是 | 否 | 按键键码值。当前仅支持返回键/KEYCODE_BACK键。 |
| keyDownDuration | number | 是 | 否 | 按键按下持续时间，单位为微秒（μs）。 |
| isIntercepted | boolean | 是 | 否 | 按键是否可以被拦截。<br>ture表示可以被拦截，false表示不可被拦截。 |
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
浏览文件 @ ea375dbb
# @ohos.multimodalInput.inputMonitor (输入监听)
输入监听模块，提供了监听输入设备事件（当前支持触屏、鼠标和触控板手势）的能力。
输入监听模块，提供了监听输入设备事件的能力。输入设备事件当前包括触摸（触屏）事件、鼠标输入事件和触控板输入事件。
> **说明：**
>**说明：**
>
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>- 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> - 本模块接口均为系统接口。
>- 本模块接口均为系统接口。
>
>- 文档中“全局”表示整个触控屏或触控板。如监听全局触摸事件，表示触摸触控板任何位置时，整个触控板的触摸事件均被监听。
## 导入模块
```js
import inputMonitor from '@ohos.multimodalInput.inputMonitor';
```
## inputMonitor.on('touch')
on(type: 'touch', receiver: TouchEventReceiver): void
监听全局触屏事件。
监听全局触摸（触屏）事件。
**需要权限：** ohos.permission.INPUT_MONITORING
......@@ -31,7 +30,7 @@ on(type: 'touch', receiver: TouchEventReceiver): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型，取值“touch”。 |
| type | string | 是 | 输入设备事件类型，取值'touch'。 |
| receiver | [TouchEventReceiver](#toucheventreceiver) | 是 | 回调函数，异步上报触摸屏输入事件。 |
**示例：**
......@@ -61,7 +60,7 @@ on(type: 'mouse', receiver: Callback&lt;MouseEvent&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型，取值“mouse”。 |
| type | string | 是 | 输入设备事件类型，取值'mouse'。 |
| receiver | Callback&lt;MouseEvent&gt; | 是 | 回调函数，异步上报鼠标输入事件。 |
**示例：**
......@@ -77,13 +76,11 @@ try {
}
```
## inputMonitor.off('touch')
off(type: 'touch', receiver?: TouchEventReceiver): void
取消监听全局触屏事件。
取消监听全局触摸（触屏）事件。
**需要权限：** ohos.permission.INPUT_MONITORING
......@@ -93,8 +90,8 @@ off(type: 'touch', receiver?: TouchEventReceiver): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型，取值“touch”。 |
| receiver | [TouchEventReceiver](#toucheventreceiver) | 否 | 需要取消监听的回调函数，若无此参数，则取消当前应用监听的所有回调函数。 |
| type | string | 是 | 输入设备事件类型，取值'touch'。 |
| receiver | [TouchEventReceiver](#toucheventreceiver) | 否 | 需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。 |
**示例：**
......@@ -142,8 +139,8 @@ off(type: 'mouse', receiver?: Callback&lt;MouseEvent&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型，取值“mouse”。 |
| receiver | Callback&lt;MouseEvent&gt; | 否 | 需要取消监听的回调函数，若无此参数，则取消当前应用监听的所有回调函数。 |
| type | string | 是 | 输入设备事件类型，取值'mouse'。 |
| receiver | Callback&lt;MouseEvent&gt; | 否 | 需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。 |
**示例：**
......@@ -179,7 +176,7 @@ try {
## TouchEventReceiver
触摸输入事件的回调函数。
触摸（触屏）输入事件的回调函数。
**需要权限：** ohos.permission.INPUT_MONITORING
......@@ -216,7 +213,7 @@ try {
on(type: 'pinch', receiver: Callback&lt;[Pinch](js-apis-multimodalinput-gestureevent.md#pinch)&gt;): void
监听全局的触控板捏合事件。
监听全局触控板的捏合事件。
**需要权限：** ohos.permission.INPUT_MONITORING
......@@ -226,7 +223,7 @@ on(type: 'pinch', receiver: Callback&lt;[Pinch](js-apis-multimodalinput-gesturee
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型，取值“pinch”。 |
| type | string | 是 | 输入设备事件类型，取值'pinch'。 |
| receiver | Callback&lt;[Pinch](js-apis-multimodalinput-gestureevent.md#pinch)&gt; | 是 | 回调函数，异步上报捏合输入事件。 |
**示例：**
......@@ -246,7 +243,7 @@ try {
off(type: 'pinch', receiver?: Callback&lt;[Pinch](js-apis-multimodalinput-gestureevent.md#pinch)&gt;): void
取消监听全局的触控板捏合事件。
取消监听全局触控板的捏合事件。
**需要权限：** ohos.permission.INPUT_MONITORING
......@@ -256,8 +253,8 @@ off(type: 'pinch', receiver?: Callback&lt;[Pinch](js-apis-multimodalinput-gestur
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型，取值“pinch”。 |
| receiver | Callback&lt;[Pinch](js-apis-multimodalinput-gestureevent.md#pinch)&gt; | 否 | 需要取消监听的回调函数，若无此参数，则取消当前应用监听的所有回调函数。 |
| type | string | 是 | 输入设备事件类型，取值'pinch'。 |
| receiver | Callback&lt;[Pinch](js-apis-multimodalinput-gestureevent.md#pinch)&gt; | 否 | 需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。 |
**示例：**
......@@ -295,7 +292,7 @@ try {
on(type: 'threeFingersSwipe', receiver: Callback&lt;[ThreeFingersSwipe](js-apis-multimodalinput-gestureevent.md#threefingersswipe)&gt;): void
监听全局的触控板三指滑动事件。
监听全局触控板的三指滑动事件。
**需要权限：** ohos.permission.INPUT_MONITORING
......@@ -305,7 +302,7 @@ on(type: 'threeFingersSwipe', receiver: Callback&lt;[ThreeFingersSwipe](js-apis-
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型，取值“threeFingersSwipe”。 |
| type | string | 是 | 输入设备事件类型，取值'threeFingersSwipe'。 |
| receiver | Callback&lt;[ThreeFingersSwipe](js-apis-multimodalinput-gestureevent.md#threefingersswipe)&gt; | 是 | 回调函数，异步上报三指滑动输入事件。 |
**示例：**
......@@ -325,7 +322,7 @@ try {
off(type: 'threeFingersSwipe', receiver?: Callback&lt;[ThreeFingersSwipe](js-apis-multimodalinput-gestureevent.md#threefingersswipe)&gt;): void
取消监听全局的触控板三指滑动事件。
取消监听全局触控板的三指滑动事件。
**需要权限：** ohos.permission.INPUT_MONITORING
......@@ -335,8 +332,8 @@ off(type: 'threeFingersSwipe', receiver?: Callback&lt;[ThreeFingersSwipe](js-api
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型，取值“threeFingersSwipe”。 |
| receiver | Callback&lt;[ThreeFingersSwipe](js-apis-multimodalinput-gestureevent.md#threefingersswipe)&gt; | 否 | 需要取消监听的回调函数，若无此参数，则取消当前应用监听的所有回调函数。 |
| type | string | 是 | 输入设备事件类型，取值'threeFingersSwipe'。 |
| receiver | Callback&lt;[ThreeFingersSwipe](js-apis-multimodalinput-gestureevent.md#threefingersswipe)&gt; | 否 | 需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。 |
**示例：**
......@@ -374,7 +371,7 @@ try {
on(type: 'fourFingersSwipe', receiver: Callback&lt;[FourFingersSwipe](js-apis-multimodalinput-gestureevent.md#fourfingersswipe)&gt;): void
监听全局的触控板四指滑动事件。
监听全局触控板的四指滑动事件。
**需要权限：** ohos.permission.INPUT_MONITORING
......@@ -384,7 +381,7 @@ on(type: 'fourFingersSwipe', receiver: Callback&lt;[FourFingersSwipe](js-apis-mu
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型，取值“fourFingersSwipe”。 |
| type | string | 是 | 输入设备事件类型，取值'fourFingersSwipe'。 |
| receiver | Callback&lt;[FourFingersSwipe](js-apis-multimodalinput-gestureevent.md#fourfingersswipe)&gt; | 是 | 回调函数，异步上报四指滑动输入事件。 |
**示例：**
......@@ -404,7 +401,7 @@ try {
off(type: 'fourFingersSwipe', receiver?: Callback&lt;[FourFingersSwipe](js-apis-multimodalinput-gestureevent.md#fourfingersswipe)&gt;): void
取消监听全局的触控板四指滑动事件。
取消监听全局触控板的四指滑动事件。
**需要权限：** ohos.permission.INPUT_MONITORING
......@@ -414,8 +411,8 @@ off(type: 'fourFingersSwipe', receiver?: Callback&lt;[FourFingersSwipe](js-apis-
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型，取值“fourFingersSwipe”。 |
| receiver | Callback&lt;[FourFingersSwipe](js-apis-multimodalinput-gestureevent.md#fourfingersswipe)&gt; | 否 | 需要取消监听的回调函数，若无此参数，则取消当前应用监听的所有回调函数。 |
| type | string | 是 | 输入设备事件类型，取值'fourFingersSwipe'。 |
| receiver | Callback&lt;[FourFingersSwipe](js-apis-multimodalinput-gestureevent.md#fourfingersswipe)&gt; | 否 | 需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-keycode.md
浏览文件 @ ea375dbb
# @ohos.multimodalInput.keyCode (键值)
按键设备键值。
按键设备的键码值，按键设备包括键盘、电源键、拍照键等。
> **说明：**
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -13,7 +14,7 @@ import {KeyCode} from '@ohos.multimodalInput.keyCode';
## KeyCode
按键键码值。
键码值。
**系统能力**：SystemCapability.MultimodalInput.Input.Core
......@@ -23,20 +24,20 @@ import {KeyCode} from '@ohos.multimodalInput.keyCode';
| KEYCODE_UNKNOWN | -1 | 未知按键 |
| KEYCODE_HOME | 1 | 功能（Home）键 |
| KEYCODE_BACK | 2 | 返回键 |
| KEYCODE_MEDIA_PLAY_PAUSE | 10 | 多媒体键 播放/暂停 |
| KEYCODE_MEDIA_STOP | 11 | 多媒体键 停止 |
| KEYCODE_MEDIA_NEXT | 12 | 多媒体键 下一首 |
| KEYCODE_MEDIA_PREVIOUS | 13 | 多媒体键 上一首 |
| KEYCODE_MEDIA_REWIND | 14 | 多媒体键 快退 |
| KEYCODE_MEDIA_FAST_FORWARD | 15 | 多媒体键 快进 |
| KEYCODE_MEDIA_PLAY_PAUSE | 10 | 多媒体键：播放/暂停 |
| KEYCODE_MEDIA_STOP | 11 | 多媒体键：停止 |
| KEYCODE_MEDIA_NEXT | 12 | 多媒体键：下一首 |
| KEYCODE_MEDIA_PREVIOUS | 13 | 多媒体键：上一首 |
| KEYCODE_MEDIA_REWIND | 14 | 多媒体键：快退 |
| KEYCODE_MEDIA_FAST_FORWARD | 15 | 多媒体键：快进 |
| KEYCODE_VOLUME_UP | 16 | 音量增加键 |
| KEYCODE_VOLUME_DOWN | 17 | 音量减小键 |
| KEYCODE_POWER | 18 | 电源键 |
| KEYCODE_CAMERA | 19 | 拍照键 |
| KEYCODE_VOLUME_MUTE | 22 | 扬声器静音键 |
| KEYCODE_MUTE | 23 | 话筒静音键 |
| KEYCODE_BRIGHTNESS_UP | 40 | 亮度调节按键 调亮 |
| KEYCODE_BRIGHTNESS_DOWN | 41 | 亮度调节按键 调暗 |
| KEYCODE_BRIGHTNESS_UP | 40 | 亮度调节按键：调亮 |
| KEYCODE_BRIGHTNESS_DOWN | 41 | 亮度调节按键：调暗 |
| KEYCODE_0 | 2000 | 按键'0' |
| KEYCODE_1 | 2001 | 按键'1' |
| KEYCODE_2 | 2002 | 按键'2' |
......@@ -49,11 +50,11 @@ import {KeyCode} from '@ohos.multimodalInput.keyCode';
| KEYCODE_9 | 2009 | 按键'9' |
| KEYCODE_STAR | 2010 | 按键'*' |
| KEYCODE_POUND | 2011 | 按键'#' |
| KEYCODE_DPAD_UP | 2012 | 导航键 向上 |
| KEYCODE_DPAD_DOWN | 2013 | 导航键 向下 |
| KEYCODE_DPAD_LEFT | 2014 | 导航键 向左 |
| KEYCODE_DPAD_RIGHT | 2015 | 导航键 向右 |
| KEYCODE_DPAD_CENTER | 2016 | 导航键 确定键 |
| KEYCODE_DPAD_UP | 2012 | 导航键：向上 |
| KEYCODE_DPAD_DOWN | 2013 | 导航键：向下 |
| KEYCODE_DPAD_LEFT | 2014 | 导航键：向左 |
| KEYCODE_DPAD_RIGHT | 2015 | 导航键：向右 |
| KEYCODE_DPAD_CENTER | 2016 | 导航键：确定键 |
| KEYCODE_A | 2017 | 按键'A' |
| KEYCODE_B | 2018 | 按键'B' |
| KEYCODE_C | 2019 | 按键'C' |
......@@ -89,8 +90,8 @@ import {KeyCode} from '@ohos.multimodalInput.keyCode';
| KEYCODE_TAB | 2049 | Tab键 |
| KEYCODE_SPACE | 2050 | 空格键 |
| KEYCODE_SYM | 2051 | 符号修改器按键 |
| KEYCODE_EXPLORER | 2052 | 浏览器功能键，此键用于启动浏览器应用程序。 |
| KEYCODE_ENVELOPE | 2053 | 电子邮件功能键，此键用于启动电子邮件应用程序。 |
| KEYCODE_EXPLORER | 2052 | 浏览器功能键，此键用于启动浏览器应用程序 |
| KEYCODE_ENVELOPE | 2053 | 电子邮件功能键，此键用于启动电子邮件应用程序 |
| KEYCODE_ENTER | 2054 | 回车键 |
| KEYCODE_DEL | 2055 | 退格键 |
| KEYCODE_GRAVE | 2056 | 按键'`' |
......@@ -122,11 +123,11 @@ import {KeyCode} from '@ohos.multimodalInput.keyCode';
| KEYCODE_MOVE_END | 2082 | 光标移动到末尾键 |
| KEYCODE_INSERT | 2083 | 插入键 |
| KEYCODE_FORWARD | 2084 | 前进键 |
| KEYCODE_MEDIA_PLAY | 2085 | 多媒体键 播放 |
| KEYCODE_MEDIA_PAUSE | 2086 | 多媒体键 暂停 |
| KEYCODE_MEDIA_CLOSE | 2087 | 多媒体键 关闭 |
| KEYCODE_MEDIA_EJECT | 2088 | 多媒体键 弹出 |
| KEYCODE_MEDIA_RECORD | 2089 | 多媒体键 录音 |
| KEYCODE_MEDIA_PLAY | 2085 | 多媒体键：播放 |
| KEYCODE_MEDIA_PAUSE | 2086 | 多媒体键：暂停 |
| KEYCODE_MEDIA_CLOSE | 2087 | 多媒体键：关闭 |
| KEYCODE_MEDIA_EJECT | 2088 | 多媒体键：弹出 |
| KEYCODE_MEDIA_RECORD | 2089 | 多媒体键：录音 |
| KEYCODE_F1 | 2090 | 按键'F1' |
| KEYCODE_F2 | 2091 | 按键'F2' |
| KEYCODE_F3 | 2092 | 按键'F3' |
......
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
浏览文件 @ ea375dbb
......@@ -33,7 +33,7 @@ import {Action, Key, KeyEvent} from '@ohos.multimodalInput.keyEvent';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | ---- | ---- | -------------- |
| code | KeyCode | 是 | 否 | 按键码 |
| pressedTime | number | 是 | 否 | 按键按下时间 |
| pressedTime | number | 是 | 否 | 按键按下时间，单位为微秒（μs） |
| deviceId | number | 是 | 否 | 按键所属设备id |
## KeyEvent
......@@ -44,15 +44,15 @@ import {Action, Key, KeyEvent} from '@ohos.multimodalInput.keyEvent';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | ---- | ---- | ------------------------------ |
| action | Action | 是 | 否 | 按键动作 |
| key | Key | 是 | 否 | 当前上报的按键 |
| action | [Action](#action) | 是 | 否 | 按键动作 |
| key | [Key](#key) | 是 | 否 | 当前上报的按键 |
| unicodeChar | number | 是 | 否 | 按键对应的uniCode字符 |
| keys | Key[] | 是 | 否 | 当前处于按下状态的按键列表 |
| ctrlKey | boolean | 是 | 否 | 当前ctrlKey是否处于按下状态 |
| ctrlKey | boolean | 是 | 否 | 当前ctrlKey是否处于按下状态 <br/>ture表示处于按下状态，false表示处于抬起状态。 |
| altKey | boolean | 是 | 否 | 当前altKey是否处于按下状态 |
| shiftKey | boolean | 是 | 否 | 当前shiftKey是否处于按下状态 |
| logoKey | boolean | 是 | 否 | 当前logoKey是否处于按下状态 |
| fnKey | boolean | 是 | 否 | 当前fnKey是否处于按下状态 |
| capsLock | boolean | 是 | 否 | 当前capsLock是否处于激活状态 |
| capsLock | boolean | 是 | 否 | 当前capsLock是否处于激活状态 <br/>ture表示处于激活状态，false表示处于未激活状态。 |
| numLock | boolean | 是 | 否 | 当前numLock是否处于激活状态 |
| scrollLock | boolean | 是 | 否 | 当前scrollLock是否处于激活状态 |
zh-cn/application-dev/reference/apis/js-apis-mouseevent.md
浏览文件 @ ea375dbb
......@@ -28,7 +28,6 @@ import { Action, Button, Axis, AxisValue, MouseEvent } from '@ohos.multimodalInp
| AXIS_UPDATE | 5 | 鼠标轴事件更新 |
| AXIS_END | 6 | 鼠标轴事件结束 |
## Button
鼠标按键。
......@@ -79,22 +78,22 @@ import { Action, Button, Axis, AxisValue, MouseEvent } from '@ohos.multimodalInp
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | ----------- | ---- | ---- | ---------------------------------------- |
| action | Action | 是 | 否 | 鼠标事件动作 |
| action | [Action](#action) | 是 | 否 | 鼠标事件动作 |
| screenX | number | 是 | 否 | 鼠标光标在屏幕中的横坐标 |
| screenY | number | 是 | 否 | 鼠标光标在屏幕中的纵坐标 |
| windowX | number | 是 | 否 | 鼠标所在窗口的横坐标 |
| windowY | number | 是 | 否 | 鼠标所在窗口的纵坐标 |
| rawDeltaX | number | 是 | 否 | 鼠标本次操作横坐标偏移值 |
| rawDeltaY | number | 是 | 否 | 鼠标本次操作纵坐标偏移值 |
| button | Button | 是 | 否 | 鼠标按钮
| button | [Button](#button) | 是 | 否 | 鼠标按钮
| pressedButtons | Button[] | 是 | 否 | 当前处于按下状态的鼠标按钮 |
| axes | AxisValue[] | 是 | 否 | 事件包含的所有轴数据 |
| pressedKeys | KeyCode[] | 是 | 否 | 当前处于按下状态的按键列表 |
| ctrlKey | boolean | 是 | 否 | 当前ctrlKey是否处于按下状态 |
| ctrlKey | boolean | 是 | 否 | 当前ctrlKey是否处于按下状态 <br>ture表示处于按下状态，false表示处于抬起状态 |
| altKey | boolean | 是 | 否 | 当前altKey是否处于按下状态 |
| shiftKey | boolean | 是 | 否 | 当前shiftKey是否处于按下状态 |
| logoKey | boolean | 是 | 否 | 当前logoKey是否处于按下状态 |
| fnKey | boolean | 是 | 否 | 当前fnKey是否处于按下状态 |
| capsLock | boolean | 是 | 否 | 当前capsLock是否处于激活状态 |
| capsLock | boolean | 是 | 否 | 当前capsLock是否处于激活状态 <br>ture表示激活状态，false表示处于未激活状态 |
| numLock | boolean | 是 | 否 | 当前numLock是否处于激活状态 |
| scrollLock | boolean | 是 | 否 | 当前scrollLock是否处于激活状态 |
zh-cn/application-dev/reference/apis/js-apis-shortKey.md
浏览文件 @ ea375dbb
# @ohos.multimodalInput.shortKey(快捷键)
通过本模块接口，可以设置快捷键拉起Ability的延迟时间，如设置长按快捷键3s后进行截屏等。
通过本模块接口，可以设置快捷键拉起Ability的延迟时间，如设置长按快捷键3s后再截屏等。
> **说明：**
>
> - 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> - 本模块接口为系统接口。
## 导入模块
......@@ -17,7 +18,7 @@ import shortKey from '@ohos.multimodalInput.shortKey';
setKeyDownDuration(businessKey: string, delay: number, callback: AsyncCallback&lt;void&gt;): void
设置快捷键拉起Ability的延迟时间，使用AsyncCallback异步方式返回结果。
设置快捷键拉起Ability的延迟时间，使用Callback异步回调。
**系统能力**：SystemCapability.MultimodalInput.Input.ShortKey
......@@ -25,9 +26,9 @@ setKeyDownDuration(businessKey: string, delay: number, callback: AsyncCallback&l
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------- | ---- | ------------------------------------------------------------ |
| businessKey| string | 是 | 业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应 |
| delay | number | 是 | 该值仅支持快捷键按下触发，表示按下快捷键多长时间后拉起Ability，单位是毫秒（ms） |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
| businessKey| string | 是 | 业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应。 |
| delay | number | 是 | 按下快捷键多长时间后拉起Ability，单位是毫秒（ms），仅支持快捷键按下触发。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，设置成功时，err为undefined，否则为错误对象。 |
**示例**：
......@@ -45,13 +46,11 @@ try {
}
```
## shortKey.setKeyDownDuration
setKeyDownDuration(businessKey: string, delay: number): Promise&lt;void&gt;
设置快捷键拉起Ability的延迟时间，使用Promise异步方式返回结果。
设置快捷键拉起Ability的延迟时间，使用Promise异步回调。
**系统能力**：SystemCapability.MultimodalInput.Input.ShortKey
......@@ -59,14 +58,14 @@ setKeyDownDuration(businessKey: string, delay: number): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ------------------------------------------------------------ |
| businessKey| string | 是 | 业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应 |
| delay | number | 是 | 该值仅支持快捷键按下触发，表示按下快捷键多长时间后拉起Ability，单位是毫秒（ms） |
| businessKey| string | 是 | 业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应。 |
| delay | number | 是 | 按下快捷键多长时间后拉起Ability，单位是毫秒（ms），仅支持快捷键按下触发。 |
**返回值**：
| 参数 | 说明 |
| ------------- | ------------- |
| Promise&lt;void&gt; | Promise对象。 |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例**：
......
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
浏览文件 @ ea375dbb
# @ohos.multimodalInput.touchEvent (触摸输入事件)
设备上报的触屏事件。
设备上报的触摸（触屏）事件。
> **说明：**
>
......@@ -14,7 +14,7 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
## Action
触屏事件类型。
触摸事件类型。
**系统能力**：SystemCapability.MultimodalInput.Input.Core
......@@ -27,7 +27,7 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
## ToolType
操作触屏的工具类型。
操作触摸的工具类型。
**系统能力**：SystemCapability.MultimodalInput.Input.Core
......@@ -52,7 +52,7 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
| ------------ | ------ | ---- |
| TOUCH_SCREEN | 0 | 触摸屏 |
| PEN | 1 | 手写笔 |
| TOUCH_PAD | 2 | 触摸板 |
| TOUCH_PAD | 2 | 触控板 |
## Touch
......@@ -63,7 +63,7 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------ | ---- | ---- | ----------------------------------- |
| id | number | 是 | 否 | 触摸事件标识 |
| pressedTime | number | 是 | 否 | 按下时间戳 |
| pressedTime | number | 是 | 否 | 按下时间戳，单位为微秒（μs） |
| screenX | number | 是 | 否 | 触摸位置所属的屏幕x坐标 |
| screenY | number | 是 | 否 | 触摸位置所属的屏幕y坐标 |
| windowX | number | 是 | 否 | 触摸位置在窗口中的x坐标 |
......@@ -71,15 +71,15 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
| pressure | number | 是 | 否 | 压力值，取值范围是[0.0, 1.0], 0.0表示不支持 |
| width | number | 是 | 否 | 触摸区域的宽度 |
| height | number | 是 | 否 | 触摸区域的高度 |
| tiltX | number | 是 | 否 | 相对YZ平面的角度,取值的范围[-90, 90]，其中正值是向右倾斜。 |
| tiltY | number | 是 | 否 | 相对XZ平面的角度,值的范围[-90, 90]，其中正值是向下倾斜。 |
| tiltX | number | 是 | 否 | 相对YZ平面的角度,取值的范围[-90, 90]，其中正值是向右倾斜 |
| tiltY | number | 是 | 否 | 相对XZ平面的角度,值的范围[-90, 90]，其中正值是向下倾斜 |
| toolX | number | 是 | 否 | 工具区域的中心点x坐标 |
| toolY | number | 是 | 否 | 工具区域的中心点y坐标 |
| toolWidth | number | 是 | 否 | 工具区域宽度 |
| toolHeight | number | 是 | 否 | 工具区域高度 |
| rawX | number | 是 | 否 | 输入设备上的x坐标 |
| rawY | number | 是 | 否 | 输入设备上的y坐标 |
| toolType | ToolType | 是 | 否 | 工具类型 |
| toolType | [ToolType](#tooltype) | 是 | 否 | 工具类型 |
## TouchEvent
......@@ -89,7 +89,7 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------- | ---------- | ---- | ---- | --------- |
| action | Action | 是 | 否 | 触摸动作 |
| touch | Touch | 是 | 否 | 当前触摸点 |
| action | [Action](#action) | 是 | 否 | 触屏事件类型 |
| touch | [Touch](#touch) | 是 | 否 | 当前触摸点信息 |
| touches | Touch[] | 是 | 否 | 所有触摸点 |
| sourceType | SourceType | 是 | 否 | 触摸来源的设备类型 |
| sourceType | [SourceType](#sourcetype) | 是 | 否 | 触摸来源的设备类型 |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或