提交 724d27e1 编写于 作者: M mayunteng_1

修改和dts文件一致

Signed-off-by: Nmayunteng_1 <mayunteng@huawei.com>
Change-Id: I128c11d207f6774756f58352c2885a9f9c7a46a4
上级 89f54375
...@@ -18,35 +18,35 @@ import inputConsumer from '@ohos.multimodalInput.inputConsumer'; ...@@ -18,35 +18,35 @@ import inputConsumer from '@ohos.multimodalInput.inputConsumer';
## inputConsumer.on ## inputConsumer.on
on(type: "key", keyOption: KeyOption, callback: Callback&lt;KeyOption&gt;): void on(type: "key", keyOptions: KeyOptions, callback: Callback&lt;KeyOptions&gt;): void
开始监听组合按键事件, 当满足条件的组合按键输入事件发生时,将KeyOption回调到入参callback表示的回调函数上。 开始监听组合按键事件, 当满足条件的组合按键输入事件发生时,将KeyOptions回调到入参callback表示的回调函数上。
**系统能力:** SystemCapability.MultimodalInput.Input.InputConsumer **系统能力:** SystemCapability.MultimodalInput.Input.InputConsumer
**参数:** **参数:**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 监听输入事件类型,只支持“key”。 | | type | string | 是 | 监听输入事件类型,只支持“key”。 |
| keyOption | [KeyOption](#keyoption) | 是 | 组合键选项,用来指定组合键输入时应该符合的条件。 | | keyOptions | [KeyOptions](#keyoption) | 是 | 组合键选项,用来指定组合键输入时应该符合的条件。 |
| callback | Callback&lt;KeyOption&gt; | 是 | 回调函数。当满足条件的按键输入产生时,回调到此函数,以传入的keyOption为入参。 | | callback | Callback&lt;KeyOptions&gt; | 是 | 回调函数。当满足条件的按键输入产生时,回调到此函数,以传入的keyOptions为入参。 |
**示例:** **示例:**
``` ```
let keyOption = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0} let keyOptions = { preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0 }
let callback = function(keyOption) { let callback = function (keyOptions) {
console.info("preKeys: " + keyOption.preKeys, "finalKey: " + keyOption.finalKey, console.info("preKeys: " + keyOptions.preKeys, "finalKey: " + keyOptions.finalKey,
"isFinalKeyDown: " + keyOption.isFinalKeyDown, "finalKeyDownDuration: " + keyOption.finalKeyDownDuration) "isFinalKeyDown: " + keyOptions.isFinalKeyDown, "finalKeyDownDuration: " + keyOptions.finalKeyDownDuration)
} }
inputConsumer.on('key', keyOption, callback); inputConsumer.on('key', keyOptions, callback);
``` ```
## inputConsumer.off ## inputConsumer.off
off(type: "key", keyOption: KeyOption, callback: Callback&lt;KeyOption&gt;): void off(type: "key", keyOptions: KeyOptions, callback: Callback&lt;KeyOptions&gt;): void
停止监听组合按键事件。 停止监听组合按键事件。
...@@ -54,33 +54,33 @@ off(type: "key", keyOption: KeyOption, callback: Callback&lt;KeyOption&gt;): voi ...@@ -54,33 +54,33 @@ off(type: "key", keyOption: KeyOption, callback: Callback&lt;KeyOption&gt;): voi
**参数:** **参数:**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 监听输入事件类型,只支持“key”。 | | type | string | 是 | 监听输入事件类型,只支持“key”。 |
| keyOption | [KeyOption](#keyoption) | 是 | 开始监听时传入的KeyOption。 | | keyOptions | [KeyOptions](#keyoption) | 是 | 开始监听时传入的KeyOptions。 |
| callback | Callback&lt;KeyOption&gt; | 是 | 开始监听时与KeyOption一同传入的回调函数&nbsp;。 | | callback | Callback&lt;KeyOptions&gt; | 是 | 开始监听时与KeyOptions一同传入的回调函数&nbsp;。 |
**示例:** **示例:**
``` ```
let keyOption = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0} let keyOptions = { preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0 }
let callback = function(keyOption) { let callback = function (keyOptions) {
console.info("preKeys: " + keyOption.preKeys, "finalKey: " + keyOption.finalKey, console.info("preKeys: " + keyOptions.preKeys, "finalKey: " + keyOptions.finalKey,
"isFinalKeyDown: " + keyOption.isFinalKeyDown, "finalKeyDownDuration: " + keyOption.finalKeyDownDuration) "isFinalKeyDown: " + keyOptions.isFinalKeyDown, "finalKeyDownDuration: " + keyOptions.finalKeyDownDuration)
} }
inputConsumer.off('key', keyOption, callback); inputConsumer.off('key', keyOptions, callback);
``` ```
## KeyOption ## KeyOptions
组合键输入事件发生时,组合键满足的选项。 组合键输入事件发生时,组合键满足的选项。
**系统能力:** 以下各项对应系统能力均为SystemCapability.MultimodalInput.Input.InputConsumer **系统能力:** 以下各项对应系统能力均为SystemCapability.MultimodalInput.Input.InputConsumer
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| preKeys | Array | 是 | 组合键前置按键集合,可为空,前置按键无顺序要求。 | | preKeys | Array | 是 | 组合键前置按键集合,可为空,前置按键无顺序要求。 |
| finalKey | Number | 是 | 组合键最后按键,不能为空。 | | finalKey | Number | 是 | 组合键最后按键,不能为空。 |
| isFinalKeyDown | boolean | 是 | 组合键最后按键是按下还是抬起,默认是按下。 | | isFinalKeyDown | boolean | 是 | 组合键最后按键是按下还是抬起,默认是按下。 |
| finalKeyDownDuration | Number | 是 | 组合键最后按键按下持续时长,默认无时长要求。 | | finalKeyDownDuration | Number | 是 | 组合键最后按键按下持续时长,默认无时长要求。 |
...@@ -165,11 +165,18 @@ export default { ...@@ -165,11 +165,18 @@ export default {
**系统能力:** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力:** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| ------- | -------------------------------------- | ---------------------------------------- | | ---------- | -------------------------------------- | ------------------------------------------------------------ |
| id | number | 输入设备的唯一标识,同一个物理设备反复插拔,其设备id会发生变化。 | | id | number | 输入设备的唯一标识,同一个物理设备反复插拔,其设备id会发生变化。 |
| name | string | 输入设备的名字。 | | name | string | 输入设备的名字。 |
| sources | Array&lt;[SourceType](#sourcetype)&gt; | 输入设备支持的源类型。比如有的键盘上附带触摸板,则此设备有keyboard和touchpad两种输入源。 | | sources | Array&lt;[SourceType](#sourcetype)&gt; | 输入设备支持的源类型。比如有的键盘上附带触摸板,则此设备有keyboard和touchpad两种输入源。 |
| axisRanges | Array&lt;[axisRanges](#axisrange)&gt; | 输入设备的轴信息。 |
| bus | number | 输入设备的总线类型。 |
| product | number | 输入设备的产品信息。 |
| vendor | number | 输入设备的厂商信息。 |
| version | number | 输入设备的版本信息。 |
| phys | string | 输入设备的物理地址。 |
| uniq | string | 输入设备的唯一标识。 |
## AxisType ## AxisType
......
...@@ -63,7 +63,7 @@ export default { ...@@ -63,7 +63,7 @@ export default {
## inputMonitor.off ## inputMonitor.off
off(type: "touch", receiver: TouchEventReceiver): void off(type: "touch", receiver?: TouchEventReceiver): void
停止监听全局输入。 停止监听全局输入。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册