Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 46d6c710 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!6014 multimodalinput amend 

Merge pull request !6014 from 胡枭/master
上级 ced04eba dc279b64
隐藏空白更改
内联 并排
Showing with 60 addition and 39 deletion
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
浏览文件 @ 46d6c710
# 组合按键 # 组合按键
InputConsumer模块提供对按键事件的监听。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> >
...@@ -18,19 +19,19 @@ import inputConsumer from '@ohos.multimodalInput.inputConsumer'; ...@@ -18,19 +19,19 @@ import inputConsumer from '@ohos.multimodalInput.inputConsumer';
## inputConsumer.on ## inputConsumer.on
on(type: "key", keyOptions: KeyOptions, callback: Callback<KeyOptions>): void on(type: "key", keyOptions: KeyOptions, callback: Callback&lt;KeyOptions&gt;): void
开始监听组合按键事件, 当满足条件的组合按键输入事件发生时，将keyOptions回调到入参callback表示的回调函数上。 开始监听组合按键事件, 当满足条件的组合按键输入事件发生时，将keyOptions回调到入参callback表示的回调函数上。
**系统能力：** SystemCapability.MultimodalInput.Input.InputConsumer 此接口为系统接口。
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 监听输入事件类型，只支持“key”。 | | type | string | 是 | 监听输入事件类型，只支持“key”。 |
| keyOptions | [keyOptions](#keyOptions) | 是 | 组合键选项，用来指定组合键输入时应该符合的条件。 | | keyOptions | [keyOptions](#keyOptions) | 是 | 组合键选项，用来指定组合键输入时应该符合的条件。 |
| callback | KeyOptions | 是 | 回调函数。当满足条件的按键输入产生时，回调到此函数，以传入的KeyOptions为入参。 | | callback | Callback&lt;KeyOptions&gt; | 是 | 回调函数。当满足条件的按键输入产生时，回调到此函数，以传入的KeyOptions为入参。 |
**示例：** **示例：**
...@@ -46,19 +47,21 @@ inputConsumer.on('key', keyOptions, callback); ...@@ -46,19 +47,21 @@ inputConsumer.on('key', keyOptions, callback);
## inputConsumer.off ## inputConsumer.off
off(type: "key", keyOptions: KeyOptions, callback?: Callback<KeyOptions>): void off(type: "key", keyOptions: KeyOptions, callback?: Callback&lt;KeyOptions&gt;): void
停止监听组合按键事件。 停止监听组合按键事件。
此接口为系统接口。
**系统能力：** SystemCapability.MultimodalInput.Input.InputConsumer **系统能力：** SystemCapability.MultimodalInput.Input.InputConsumer
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 监听输入事件类型，只支持“key”。 | | type | string | 是 | 监听输入事件类型，只支持“key”。 |
| keyOptions | [keyOptions](#keyOptions) | 是 | 开始监听时传入的keyOptions。 | | keyOptions | [keyOptions](#keyOptions) | 是 | 开始监听时传入的keyOptions。 |
| callback | Callback<KeyOptions> | 是 | 开始监听时与KeyOption一同传入的回调函数&nbsp;。 | | callback | Callback&lt;KeyOptions&gt; | 是 | 开始监听时与KeyOption一同传入的回调函数&nbsp;。 |
**示例：** **示例：**
...@@ -76,7 +79,9 @@ inputConsumer.off('key', keyOptions, callback); ...@@ -76,7 +79,9 @@ inputConsumer.off('key', keyOptions, callback);
组合键输入事件发生时，组合键满足的选项。 组合键输入事件发生时，组合键满足的选项。
**系统能力：** 以下各项对应系统能力均为SystemCapability.MultimodalInput.Input.InputConsumer 此接口为系统接口。
**系统能力：**SystemCapability.MultimodalInput.Input.InputConsumer
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
......
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
浏览文件 @ 46d6c710
...@@ -179,7 +179,7 @@ inputDevice.getDevice(1).then((inputDevice)=>{ ...@@ -179,7 +179,7 @@ inputDevice.getDevice(1).then((inputDevice)=>{
## inputDevice.supportKeys<sup>9+</sup> ## inputDevice.supportKeys<sup>9+</sup>
supportKeys(deviceId: number, keys: Array&lt;KeyCode&gt;, callback: Callback&lt;Array&lt;boolean&gt;&gt;): void; supportKeys(deviceId: number, keys: Array&lt;KeyCode&gt;, callback: Callback&lt;Array&lt;boolean&gt;&gt;): void
获取输入设备支持的键码值，使用callback方式作为异步方法。 获取输入设备支持的键码值，使用callback方式作为异步方法。
...@@ -204,7 +204,7 @@ inputDevice.supportKeys(1, [17, 22, 2055], (ret)=>{ ...@@ -204,7 +204,7 @@ inputDevice.supportKeys(1, [17, 22, 2055], (ret)=>{
## inputDevice.supportKeys<sup>9+</sup> ## inputDevice.supportKeys<sup>9+</sup>
supportKeys(deviceId: number, keys: Array&lt;KeyCode&gt;): Promise&lt;Array&lt;boolean&gt;&gt;； supportKeys(deviceId: number, keys: Array&lt;KeyCode&gt;): Promise&lt;Array&lt;boolean&gt;&gt;
获取输入设备支持的键码值，使用Promise方式作为异步方法。 获取输入设备支持的键码值，使用Promise方式作为异步方法。
...@@ -234,7 +234,7 @@ inputDevice.supportKeys(1, [17, 22, 2055]).then((ret)=>{ ...@@ -234,7 +234,7 @@ inputDevice.supportKeys(1, [17, 22, 2055]).then((ret)=>{
## inputDevice.getKeyboardType<sup>9+</sup> ## inputDevice.getKeyboardType<sup>9+</sup>
getKeyboardType(deviceId: number, callback: AsyncCallback&lt;KeyboardType&gt;): void; getKeyboardType(deviceId: number, callback: AsyncCallback&lt;KeyboardType&gt;): void
查询输入设备的键盘类型，使用callback方式作为异步方法。 查询输入设备的键盘类型，使用callback方式作为异步方法。
...@@ -258,7 +258,7 @@ inputDevice.getKeyboardType(1, (ret)=>{ ...@@ -258,7 +258,7 @@ inputDevice.getKeyboardType(1, (ret)=>{
## inputDevice.getKeyboardType<sup>9+</sup> ## inputDevice.getKeyboardType<sup>9+</sup>
getKeyboardType(deviceId: number,): Promise&lt;KeyboardType&gt;； getKeyboardType(deviceId: number): Promise&lt;KeyboardType&gt;
查询输入设备的键盘类型，使用Promise方式作为异步方法。 查询输入设备的键盘类型，使用Promise方式作为异步方法。
......
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
浏览文件 @ 46d6c710
# 输入事件 # 输入事件
设备上报的基本事件。 InputEvent模块描述了设备上报的基本事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
...@@ -11,6 +11,8 @@ ...@@ -11,6 +11,8 @@
import InputEvent from '@ohos.multimodalInput.inputEvent'; import InputEvent from '@ohos.multimodalInput.inputEvent';
``` ```
## InputEvent
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
......
zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md
浏览文件 @ 46d6c710
# 注入按键 # 注入按键
InputEventClient模块提供了注入按键能力。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> >
> 本模块接口均为系统接口，三方应用不支持调用。 > - 本模块接口均为系统接口，三方应用不支持调用。
## 导入模块 ## 导入模块
...@@ -22,6 +23,8 @@ injectEvent({KeyEvent: KeyEvent}): void ...@@ -22,6 +23,8 @@ injectEvent({KeyEvent: KeyEvent}): void
注入按键，KeyEvent为注入按键的描述信息。 注入按键，KeyEvent为注入按键的描述信息。
此接口为系统接口。
**系统能力：** SystemCapability.MultimodalInput.Input.InputSimulator **系统能力：** SystemCapability.MultimodalInput.Input.InputSimulator
**参数：** **参数：**
...@@ -47,11 +50,13 @@ let res = inputEventClient.injectEvent({KeyEvent: keyEvent}); ...@@ -47,11 +50,13 @@ let res = inputEventClient.injectEvent({KeyEvent: keyEvent});
注入按键的描述信息 注入按键的描述信息
此接口为系统接口。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputSimulator **系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputSimulator
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| --------------- | ------- | ---- | --------- | | --------------- | ------- | ---- | --------- |
| isPressed | boolean | 是 | 按键是否按下 | | isPressed | boolean | 是 | 按键是否按下 |
| keyCode | Number | 是 | 按键键值 | | keyCode | number | 是 | 按键键值 |
| keyDownDuration | boolean | 是 | 按键按下持续时间 | | keyDownDuration | number | 是 | 按键按下持续时间 |
| isIntercepted | Number | 是 | 按键是否可以被拦截 | | isIntercepted | boolean | 是 | 按键是否可以被拦截 |
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
浏览文件 @ 46d6c710
# 输入监听 # 输入监听
InputMonitor模块提供了监听全局触摸事件的功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
...@@ -26,6 +27,8 @@ on(type: "touch", receiver: TouchEventReceiver): void ...@@ -26,6 +27,8 @@ on(type: "touch", receiver: TouchEventReceiver): void
开始监听全局触屏事件。 开始监听全局触屏事件。
此接口为系统接口。
**需要权限：**ohos.permission.INPUT_MONITORING **需要权限：**ohos.permission.INPUT_MONITORING
**系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor **系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor
...@@ -45,20 +48,23 @@ inputMonitor.off("touch", (event) => { ...@@ -45,20 +48,23 @@ inputMonitor.off("touch", (event) => {
}); });
``` ```
on(type: "mouse", receiver:Callback<MouseEvent>):void
on(type: "mouse", receiver: Callback&lt;MouseEvent&gt;): void
开始监听全局鼠标事件。 开始监听全局鼠标事件。
此接口为系统接口。
**需要权限：** ohos.permission.INPUT_MONITORING **需要权限：** ohos.permission.INPUT_MONITORING
**系统能力：** SystemCapability.MultimodalInput.Input.InputMonitor **系统能力：** SystemCapability.MultimodalInput.Input.InputMonitor
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------- | | -------- | -------------------------- | ---- | ------------------------------- |
| type | string | 是 | 监听输入事件类型，取值“mouse”。 | | type | string | 是 | 监听输入事件类型，取值“mouse”。 |
| receiver | Callback<MouseEvent> | 是 | 鼠标输入事件回调函数。 | | receiver | Callback&lt;MouseEvent&gt; | 是 | 鼠标输入事件回调函数。 |
**示例：** **示例：**
...@@ -72,10 +78,12 @@ inputMonitor.off("mouse", (event) => { ...@@ -72,10 +78,12 @@ inputMonitor.off("mouse", (event) => {
## inputMonitor.off ## inputMonitor.off
off(type: "touch", receiver?:TouchEventReceiver):void off(type: "touch", receiver?: TouchEventReceiver): void
停止监听全局触屏事件。 停止监听全局触屏事件。
此接口为系统接口。
**需要权限：**ohos.permission.INPUT_MONITORING **需要权限：**ohos.permission.INPUT_MONITORING
**系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor **系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor
...@@ -92,20 +100,22 @@ off(type: "touch", receiver?:TouchEventReceiver):void ...@@ -92,20 +100,22 @@ off(type: "touch", receiver?:TouchEventReceiver):void
inputMonitor.off("touch"); inputMonitor.off("touch");
``` ```
off(type: "mouse", receiver?:Callback<MouseEvent>):void off(type: "mouse", receiver?: Callback&lt;MouseEvent&gt;): void
停止监听全局鼠标事件。 停止监听全局鼠标事件。
此接口为系统接口。
**需要权限：**ohos.permission.INPUT_MONITORING **需要权限：**ohos.permission.INPUT_MONITORING
**系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor **系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------- | | -------- | -------------------------- | ---- | ------------------------------- |
| type | string | 是 | 监听输入事件类型，取值“mouse”。 | | type | string | 是 | 监听输入事件类型，取值“mouse”。 |
| receiver | Callback<MouseEvent> | 否 | 鼠标输入事件回调函数。 | | receiver | Callback&lt;MouseEvent&gt; | 否 | 鼠标输入事件回调函数。 |
**示例：** **示例：**
...@@ -119,10 +129,7 @@ inputMonitor.off("mouse"); ...@@ -119,10 +129,7 @@ inputMonitor.off("mouse");
触摸输入事件的回调函数。如果返回true，则触摸输入被监听器消耗，系统将执行关闭动作。 触摸输入事件的回调函数。如果返回true，则触摸输入被监听器消耗，系统将执行关闭动作。
此接口为系统接口。
### (touchEvent: TouchEvent): Boolean
触摸输入事件的回调函数。函数名由使用者定义，这里是函数调用时必须符合的格式，传入参数必须为TouchEvent类型，返回值为Boolean类型。
**系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor **系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor
......
zh-cn/application-dev/reference/apis/js-apis-keycode.md
浏览文件 @ 46d6c710
# 键值 # 键值
按键类设备键值。 KeyCode模块提供了按键类设备的键值。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
...@@ -11,6 +11,8 @@ ...@@ -11,6 +11,8 @@
import {KeyCode} from '@ohos.multimodalInput.keyCode' import {KeyCode} from '@ohos.multimodalInput.keyCode'
``` ```
## KeyCode
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
......
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
浏览文件 @ 46d6c710
# 按键输入事件 # 按键输入事件
设备上报的按键事件。 KeyEvent模块提供了设备可以上报的按键事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或