Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

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

!11241 inputmonitor资料整改 

Merge pull request !11241 from mayunteng/master
上级 791235a8 8f445573
显示空白变更内容
内联 并排
Showing with 66 addition and 58 deletion
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
浏览文件 @ 5da026d8
# 输入监听 # 输入监听
InputMonitor模块提供了监听全局触摸事件的功能。 输入监听模块，提供了监听输入设备事件（当前支持触摸屏和鼠标）的能力。
> **说明：** > **说明：**
>
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> >
> - 本模块接口均为系统接口。 > - 本模块接口均为系统接口。
...@@ -29,19 +29,19 @@ on(type: "touch", receiver: TouchEventReceiver): void ...@@ -29,19 +29,19 @@ on(type: "touch", receiver: TouchEventReceiver): void
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------- | | -------- | ---------------------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型，取值“touch”。 | | type | string | 是 | 输入设备事件类型，取值“touch”。 |
| receiver | [TouchEventReceiver](#toucheventreceiver) | 是 | 触摸输入事件回调函数。 | | receiver | [TouchEventReceiver](#toucheventreceiver) | 是 | 回调函数，异步上报触摸屏输入事件。 |
**示例：** **示例：**
```js ```js
try { try {
inputMonitor.on("touch", (data)=> { inputMonitor.on("touch", (touchEvent) => {
console.log(`Monitor on TouchEvent success ${JSON.stringify(data)}`); console.log(`Monitor on success ${JSON.stringify(touchEvent)}`);
return false; return false;
}); });
} catch (error) { } catch (error) {
console.log(`Failed to monitor on TouchEvent, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
} }
``` ```
...@@ -58,19 +58,19 @@ on(type: "mouse", receiver: Callback<MouseEvent>): void ...@@ -58,19 +58,19 @@ on(type: "mouse", receiver: Callback<MouseEvent>): void
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- | | -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型，取值“mouse”。 | | type | string | 是 | 输入设备事件类型，取值“mouse”。 |
| receiver | Callback<MouseEvent> | 是 | 鼠标输入事件回调函数。 | | receiver | Callback<MouseEvent> | 是 | 回调函数，异步上报鼠标输入事件。 |
**示例：** **示例：**
```js ```js
try { try {
inputMonitor.on("mouse", (data)=> { inputMonitor.on("mouse", (mouseEvent) => {
console.log(`Monitor on MouseEvent success ${JSON.stringify(data)}`); console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`);
return false; return false;
}); });
} catch (error) { } catch (error) {
console.log(`Failed to monitor on MouseEvent, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
} }
``` ```
...@@ -89,31 +89,36 @@ off(type: "touch", receiver?: TouchEventReceiver): void ...@@ -89,31 +89,36 @@ off(type: "touch", receiver?: TouchEventReceiver): void
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------- | | -------- | ---------------------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型，取值“touch”。 | | type | string | 是 | 输入设备事件类型，取值“touch”。 |
| receiver | [TouchEventReceiver](#toucheventreceiver) | 否 | 触摸输入事件回调函数。 | | receiver | [TouchEventReceiver](#toucheventreceiver) | 否 | 需要取消监听的回调函数，若无此参数，则取消当前应用监听的所有回调函数。 |
**示例：** **示例：**
```js ```js
// 取消监听全局触屏事件 // 取消监听单个回调函数
try { callback: function(touchEvent) {
inputMonitor.off("touch"); console.log(`Monitor on success ${JSON.stringify(touchEvent)}`);
} catch (error) { return false;
console.log(`Failed to monitor off TouchEvent, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
// 单独取消receiver的监听。
callback:function(data) {
console.log(`call success ${JSON.stringify(data)}`);
}, },
try { try {
inputMonitor.on("touch", this.callback); inputMonitor.on("touch", this.callback);
inputMonitor.off("touch", this.callback);
} catch (error) { } catch (error) {
console.log(`Failed to monitor on TouchEvent, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
```js
// 取消监听所有回调函数
callback: function(touchEvent) {
console.log(`Monitor on success ${JSON.stringify(touchEvent)}`);
return false;
}, },
try { try {
inputMonitor.off("touch",this.callback); inputMonitor.on("touch", this.callback);
inputMonitor.off("touch");
} catch (error) { } catch (error) {
console.log(`Failed to monitor off TouchEvent, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
} }
``` ```
...@@ -129,39 +134,40 @@ off(type: "mouse", receiver?: Callback<MouseEvent>): void ...@@ -129,39 +134,40 @@ off(type: "mouse", receiver?: Callback<MouseEvent>): void
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- | | -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型，取值“mouse”。 | | type | string | 是 | 输入设备事件类型，取值“mouse”。 |
| receiver | Callback<MouseEvent> | 否 | 鼠标输入事件回调函数。 | | receiver | Callback<MouseEvent> | 否 | 需要取消监听的回调函数，若无此参数，则取消当前应用监听的所有回调函数。 |
**示例：** **示例：**
```js ```js
// 取消监听全局鼠标事件 // 取消监听单个回调函数
try { callback: function(mouseEvent) {
inputMonitor.off("mouse"); console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`);
} catch (error) {
console.log(`Failed to monitor off MouseEvent, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
// 单独取消receiver的监听。
callback:function(data) {
console.log(`call success ${JSON.stringify(data)}`);
}, },
try { try {
inputMonitor.on("mouse", this.callback); inputMonitor.on("mouse", this.callback);
inputMonitor.off("mouse", this.callback);
} catch (error) { } catch (error) {
console.log(`Failed to monitor on MouseEvent, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
```js
// 取消监听所有回调函数
callback: function(mouseEvent) {
console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`);
}, },
try { try {
inputMonitor.off("mouse", this.callback); inputMonitor.on("mouse", this.callback);
inputMonitor.off("mouse");
} catch (error) { } catch (error) {
console.log(`Failed to monitor off MouseEvent, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
} }
``` ```
## TouchEventReceiver ## TouchEventReceiver
触摸输入事件的回调函数。如果返回true，则触摸输入被监听器消耗，系统将执行关闭动作。 触摸输入事件的回调函数。
**需要权限：** ohos.permission.INPUT_MONITORING **需要权限：** ohos.permission.INPUT_MONITORING
...@@ -170,23 +176,25 @@ try { ...@@ -170,23 +176,25 @@ try {
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------- | ---- | ---------------------------------------- | | ---------- | ---------------------------------------- | ---- | ---------------------------------------- |
| touchEvent | [TouchEvent](../arkui-js/js-components-common-events.md) | 是 | 触摸输入事件回调函数，返回true表示输触事件被监听器消费，false表示输触事件未被监听器消费。 | | touchEvent | [TouchEvent](../arkui-js/js-components-common-events.md) | 是 | 触摸输入事件。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ---------------------------------------- | | ------- | ---------------------------------------- |
| Boolean | 返回true表示触摸输入事件被监听器消费，false表示触摸输入事件未被监听器消费。 | | Boolean | 若返回true，本次触摸后续产生的事件不再分发到窗口；若返回false，本次触摸后续产生的事件还会分发到窗口。 |
**示例：** **示例：**
```js ```js
try { try {
inputMonitor.on("touch", (event) => { inputMonitor.on("touch", touchEvent => {
// 若返回true，表示本次操作后续所有事件不再分发到窗口，事件都由监听者消费。 if (touchEvent.touches.size() == 3) { // 当前有三个手指按下
return true;
} else {
return false; return false;
}
}); });
inputMonitor.off("touch");
} catch (error) { } catch (error) {
console.log(`Failed to monitor off TouchEvent, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
} }
``` ```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或