From b16ccf0acd664edfaf113ac9eacd22298618e47d Mon Sep 17 00:00:00 2001 From: mayunteng_1 Date: Tue, 24 May 2022 08:25:10 +0000 Subject: [PATCH] =?UTF-8?q?InputDevice=E5=92=8Cinputmonitor=E8=A1=A5?= =?UTF-8?q?=E5=85=85=E6=96=B0=E5=A2=9E=E6=8E=A5=E5=8F=A3=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: mayunteng_1 Change-Id: I14c0b04a272f68e279225797a3a933b231e65bda --- .../reference/apis/js-apis-inputdevice.md | 127 +++++------------- .../reference/apis/js-apis-inputmonitor.md | 38 ++---- .../reference/apis/js-apis-mouseevent.md | 124 ----------------- 3 files changed, 47 insertions(+), 242 deletions(-) delete mode 100644 zh-cn/application-dev/reference/apis/js-apis-mouseevent.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md index 2117c36b39..7bc372ad07 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md @@ -11,7 +11,7 @@ ## 导入模块 -``` +```js import inputDevice from '@ohos.multimodalInput.inputDevice'; ``` @@ -33,20 +33,11 @@ getDeviceIds(callback: AsyncCallback<Array<number>>): void **示例：** -``` -export default { - data: { - deviceIds: Array, - }, - callback: function(ids) { - this.deviceIds = ids; - }, - testGetDeviceIds: function () { - console.info("InputDeviceJsTest---start---testGetDeviceIds"); - inputDevice.getDeviceIds(this.callback); - console.info("InputDeviceJsTest---end---testGetDeviceIds"); - } -} +```js +// 示例获取设备所有设备id。 +inputDevice.getDeviceIds(function (ids) { + // 处理结果 +}); ``` ## inputDevice.getDeviceIds @@ -65,18 +56,14 @@ function getDeviceIds(): Promise> **示例：** -``` -export default { - testGetDeviceIds: function () { - console.info("InputDeviceJsTest---start---testGetDeviceIds"); - let promise = inputDevice.getDeviceIds(); - promise.then((data)=> { - console.info('GetDeviceIds successed, Data: ' + JSON.stringify(data)) - }).catch((err)=>{ - console.error('Failed GetDeviceIds. Cause: ' + JSON.stringify(err)); - }); - } -} +```js +// 示例获取设备所有设备id。 +let promise = inputDevice.getDeviceIds(); +promise.then((ids)=> { + // 处理结果 +}).catch((err)=>{ + // 处理异常 +}); ``` @@ -100,24 +87,11 @@ getDevice(deviceId: number, callback: AsyncCallback<InputDeviceData>): voi **示例：** -``` -export default { - InputDeviceData: { - deviceId : 0, - name : "NA", - sources : Array, - axisRanges : Array, - }, - callback: function(deviceData) { - this.InputDeviceData = deviceData; - }, - testGetDevice: function () { - // 示例获取设备id为1的设备信息。 - console.info("InputDeviceJsTest---start---testGetDevice"); - inputDevice.getDevice(1, this.callback); - console.info("InputDeviceJsTest---end---testGetDevice"); - } -} +```js +// 示例获取设备id为1的设备信息。 +inputDevice.getDevice(1, function (deviceData) { + // 处理结果 +}); ``` ## inputDevice.getDevice @@ -136,25 +110,14 @@ function getDevice(deviceId: number): Promise **示例：** -``` -export default { - InputDeviceData: { - deviceId : 0, - name : "NA", - sources : Array, - axisRanges : Array, - }, - testGetDevice: function () { - // 示例获取设备id为1的设备信息。 - console.info("InputDeviceJsTest---start---testGetDevice"); - let promise = inputDevice.getDevice(1); - promise.then((data)=> { - console.info('GetDeviceId successed, Data: ' + JSON.stringify(data)) - }).catch((err)=>{ - console.error('Failed GetDeviceId. Cause: ' + JSON.stringify(err)); - }); - } -} +```js +// 示例获取设备id为1的设备信息。 +let promise = inputDevice.getDevice(1); +promise.then((data) => { + // 处理结果 +}).catch((err) => { + // 处理异常 +}); ``` @@ -177,21 +140,10 @@ on(type: "change", listener: Callback): void **示例：** ```js -export default { - DeviceListener: { - type : "NA", - deviceId : 0 - }, - callback: function(deviceChangedData) { - this.DeviceListener = deviceChangedData; - }, - testOn: function () { - // 示例监听设备插拔事件 - console.info("InputDeviceJsTest---start---testOn"); - inputDevice.on("change", this.callback); - console.info("InputDeviceJsTest---end---testOn"); - } -} +// 示例监听设备插拔事件 +inputDevice.on("change", function (deviceChangedData) { + // 处理结果 +}); ``` ## inputDevice.off @@ -212,21 +164,8 @@ function off(type: "change", listener?: Callback): void; **示例：** ```js -export default { - DeviceListener: { - type : "NA", - deviceId : 0 - }, - callback: function(deviceChangedData) { - this.DeviceListener = deviceChangedData; - }, - testOff: function () { - // 示例监听设备插拔事件 - console.info("InputDeviceJsTest---start---testOff"); - inputDevice.off("change", this.callback); - console.info("InputDeviceJsTest---end---testOff"); - } -} +// 示例取消监听设备插拔事件 +inputDevice.off("change"); ``` ## InputDeviceData diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md b/zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md index c6df91a5a5..4088e77cc6 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md @@ -39,12 +39,10 @@ on(type: "touch", receiver: TouchEventReceiver): void **示例：** ```js -testOn() { - inputMonitor.off("touch", (event) => { - // 消费触屏事件 - return false; - }); -} +inputMonitor.off("touch", (event) => { + // 消费触屏事件 + return false; +}); ``` on(type: "mouse", receiver: TouchEventReceiver): void @@ -65,11 +63,9 @@ on(type: "mouse", receiver: TouchEventReceiver): void **示例：** ```js -testOn() { - inputMonitor.off("mouse", (event) => { - // 消费鼠标事件 - }); -} +inputMonitor.off("mouse", (event) => { + // 消费鼠标事件 +}); ``` @@ -93,9 +89,7 @@ off(type: "touch", receiver: TouchEventReceiver): void **示例：** ```js -testOff() { - inputMonitor.off("touch"); -} +inputMonitor.off("touch"); ``` off(type: "mouse", receiver?: Callback): void @@ -116,9 +110,7 @@ off(type: "mouse", receiver?: Callback): void **示例：** ```js -testOff() { - inputMonitor.off("mouse"); -} +inputMonitor.off("mouse"); ``` @@ -147,11 +139,9 @@ testOff() { **示例：** ```js -test() { - inputMonitor.on("touch", (event) => { - // 消费触屏事件 - return false; - }); - inputMonitor.off("touch"); -} +inputMonitor.on("touch", (event) => { + // 消费触屏事件 + return false; +}); +inputMonitor.off("touch"); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-mouseevent.md b/zh-cn/application-dev/reference/apis/js-apis-mouseevent.md deleted file mode 100644 index cad87a1f0b..0000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-mouseevent.md +++ /dev/null @@ -1,124 +0,0 @@ -# MouseEvent - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -```ts -import MouseEvent from '@ohos.multimodalInput.mouseEvent' -``` - -## 属性 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core - -| 名称 | 参数类型 | 可读 | 可写 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| action | Action | 是 | 否 | 设备类型。 | -| screenX | string | 是 | 否 | 设备厂家名称。 | -| screenY | string | 是 | 否 | 设备品牌名称。 | -| windowX | string | 是 | 否 | 外部产品系列。 | -| windowY | string | 是 | 否 | 产品系列。 | -| rawDeltaX | string | 是 | 否 | 认证型号。 | -| rawDeltaY | string | 是 | 否 | 内部软件子型号。 | -| button | string | 是 | 否 | 硬件版本号。 | -| pressedButtons | string | 是 | 否 | 硬件Profile。 | -| axes | string | 是 | 否 | 设备序列号。 | -| pressedKeys | string | 是 | 否 | Bootloader版本号。 | -| ctrlKey | string | 是 | 否 | 应用二进制接口（Abi）列表。 | -| altKey | string | 是 | 否 | 安全补丁级别。 | -| shiftKey | string | 是 | 否 | 产品版本。 | -| logoKey | string | 是 | 否 | 差异版本号。 | -| fnKey | string | 是 | 否 | 系统的发布类型，取值为：
- Canary：面向特定开发者发布的早期预览版本，不承诺API稳定性。
- Beta：面向开发者公开发布的Beta版本，不承诺API稳定性。
- Release：面向开发者公开发布的正式版本，承诺API稳定性。 | -| capsLock | string | 是 | 否 | 系统版本。 | -| numLock | number | 是 | 否 | Major版本号，随主版本更新增加。 | -| scrollLock | number | 是 | 否 | Senior版本号，随局部架构、重大特性增加。 | - -# Action - -鼠标事件类型。 - -## 导入模块 - -```ts -import Action from '@ohos.multimodalInput.mouseEvent' -``` - -## 属性 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core - -| 名称 | 参数类型 | 可读 | 可写 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| CANCEL | number | 是 | 否 | 取消事件。 | -| MOVE | number | 是 | 否 | 移动事件。 | -| BUTTON_DOWN | number | 是 | 否 | 按下事件。 | -| BUTTON_UP | number | 是 | 否 | 抬起事件。 | -| AXIS_BEGIN | number | 是 | 否 | 鼠标关联轴事件开始。 | -| AXIS_UPDATE | number | 是 | 否 | 鼠标关联轴事件更新。 | -| AXIS_END | number | 是 | 否 | 鼠标关联轴事件结束。 | - -# Button - -鼠标按键类型。 - -## 导入模块 - -```ts -import Button from '@ohos.multimodalInput.mouseEvent' -``` - -## 属性 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core - -| 名称 | 参数类型 | 可读 | 可写 | 描述 | -| ------- | -------- | ---- | ---- | -------------- | -| LEFT | number | 是 | 否 | 鼠标左键。 | -| MIDDLE | number | 是 | 否 | 鼠标中键。 | -| RIGHT | number | 是 | 否 | 鼠标右键。 | -| SIDE | number | 是 | 否 | 鼠标side键。 | -| EXTRA | number | 是 | 否 | 鼠标extra键。 | -| FORWARD | number | 是 | 否 | 鼠标前进键。 | -| BACK | number | 是 | 否 | 鼠标后退键。 | -| TASK | number | 是 | 否 | 鼠标自定义键。 | - -# Axis - -鼠标轴类型。 - -## 导入模块 - -```ts -import Axis from '@ohos.multimodalInput.mouseEvent' -``` - -## 属性 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core - -| 名称 | 参数类型 | 可读 | 可写 | 描述 | -| ----------------- | -------- | ---- | ---- | ------------ | -| SCROLL_VERTICAL | number | 是 | 否 | 鼠标垂直轴。 | -| SCROLL_HORIZONTAL | number | 是 | 否 | 鼠标水平轴。 | -| PINCH | number | 是 | 否 | 鼠标捏合轴。 | - -# AxisValue - -鼠标轴数据。 - -## 导入模块 - -```ts -import AxisValue from '@ohos.multimodalInput.mouseEvent' -``` - -## 属性 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core - -| 名称 | 参数类型 | 可读 | 可写 | 描述 | -| ----- | -------- | ---- | ---- | ------------ | -| axis | Axis | 是 | 是 | 鼠标轴类型。 | -| value | number | 是 | 是 | 鼠标轴的值。 | \ No newline at end of file -- GitLab