Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
8269b263
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
8269b263
编写于
11月 22, 2022
作者:
O
openharmony_ci
提交者:
Gitee
11月 22, 2022
浏览文件
操作
浏览文件
下载
差异文件
!11657 多模ts文件和资料问题
Merge pull request !11657 from mayunteng/master
上级
8693b294
a8641023
变更
11
隐藏空白更改
内联
并排
Showing
11 changed file
with
155 addition
and
137 deletion
+155
-137
zh-cn/application-dev/reference/apis/js-apis-cooperate.md
zh-cn/application-dev/reference/apis/js-apis-cooperate.md
+16
-14
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
...n/application-dev/reference/apis/js-apis-inputconsumer.md
+8
-8
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
+70
-70
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md
...pplication-dev/reference/apis/js-apis-inputeventclient.md
+7
-7
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
+21
-13
zh-cn/application-dev/reference/apis/js-apis-keycode.md
zh-cn/application-dev/reference/apis/js-apis-keycode.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
+3
-3
zh-cn/application-dev/reference/apis/js-apis-mouseevent.md
zh-cn/application-dev/reference/apis/js-apis-mouseevent.md
+5
-5
zh-cn/application-dev/reference/apis/js-apis-pointer.md
zh-cn/application-dev/reference/apis/js-apis-pointer.md
+18
-10
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
+5
-5
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-cooperate.md
浏览文件 @
8269b263
...
...
@@ -4,7 +4,9 @@
> **说明**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块接口均为系统接口。
## 导入模块
...
...
@@ -18,7 +20,7 @@ enable(enable: boolean, callback: AsyncCallback<void>): void
开启、关闭键鼠穿越,使用AsyncCallback异步方式返回结果。
**系统能力**
: SystemCapability.MultimodalInput.Input.
InputDevice
Cooperate
**系统能力**
: SystemCapability.MultimodalInput.Input.Cooperate
**参数**
:
...
...
@@ -52,7 +54,7 @@ enable(enable: boolean): Promise<void>
开启、关闭键鼠穿越,使用Promise异步方式返回结果。
**系统能力**
: SystemCapability.MultimodalInput.Input.
InputDevice
Cooperate
**系统能力**
: SystemCapability.MultimodalInput.Input.Cooperate
**参数**
:
...
...
@@ -90,7 +92,7 @@ start(sinkDeviceDescriptor: string, srcInputDeviceId: number, callback: AsyncCal
启动键鼠穿越,使用AsyncCallback异步方式返回结果。
**系统能力**
:SystemCapability.MultimodalInput.Input.
InputDevice
Cooperate
**系统能力**
:SystemCapability.MultimodalInput.Input.Cooperate
**参数**
:
...
...
@@ -133,7 +135,7 @@ start(sinkDeviceDescriptor: string, srcInputDeviceId: number): Promise\<void>
启动键鼠穿越,使用Promise异步方式返回结果。
**系统能力**
: SystemCapability.MultimodalInput.Input.
InputDevice
Cooperate
**系统能力**
: SystemCapability.MultimodalInput.Input.Cooperate
**参数**
:
...
...
@@ -181,7 +183,7 @@ stop(callback: AsyncCallback\<void>): void
停止键鼠穿越,使用AsyncCallback异步方式返回结果。
**系统能力**
:SystemCapability.MultimodalInput.Input.
InputDevice
Cooperate
**系统能力**
:SystemCapability.MultimodalInput.Input.Cooperate
**参数**
:
...
...
@@ -213,9 +215,9 @@ stop(): Promise\<void>
停止键鼠穿越,使用Promise异步方式返回结果。
**系统能力**
:SystemCapability.MultimodalInput.Input.
InputDevice
Cooperate
**系统能力**
:SystemCapability.MultimodalInput.Input.Cooperate
**
参数
**
:
**
返回值
**
:
| 参数名 | 说明 |
| -------- | ---------------------------- |
...
...
@@ -241,7 +243,7 @@ getState(deviceDescriptor: string, callback: AsyncCallback<{ state: boolean }>):
获取键鼠穿越开关的状态,使用AsyncCallback异步方式返回结果。
**系统能力**
:SystemCapability.MultimodalInput.Input.
InputDevice
Cooperate
**系统能力**
:SystemCapability.MultimodalInput.Input.Cooperate
**参数**
:
...
...
@@ -273,7 +275,7 @@ getState(deviceDescriptor: string): Promise<{ state: boolean }>
获取键鼠穿越开关的状态,使用Promise异步方式返回结果。
**系统能力**
:SystemCapability.MultimodalInput.Input.
InputDevice
Cooperate
**系统能力**
:SystemCapability.MultimodalInput.Input.Cooperate
**参数**
:
...
...
@@ -312,7 +314,7 @@ on(type: 'cooperation', callback: AsyncCallback<{ deviceDescriptor: string, even
注册监听键鼠穿越状态。
**系统能力**
:SystemCapability.MultimodalInput.Input.
InputDevice
Cooperate
**系统能力**
:SystemCapability.MultimodalInput.Input.Cooperate
**参数**
:
...
...
@@ -341,7 +343,7 @@ off(type: 'cooperation', callback?: AsyncCallback\<void>): void
关闭监听键鼠穿越状态。
**系统能力**
:SystemCapability.MultimodalInput.Input.
InputDevice
Cooperate
**系统能力**
:SystemCapability.MultimodalInput.Input.Cooperate
**参数**
:
...
...
@@ -385,9 +387,9 @@ try {
键鼠穿越事件。
**系统能力**
:SystemCapability.MultimodalInput.Input.
InputDevice
Cooperate
**系统能力**
:SystemCapability.MultimodalInput.Input.Cooperate
|
参数名
| 值 | 说明 |
|
名称
| 值 | 说明 |
| -------- | --------- | ----------------- |
| MSG_COOPERATE_INFO_START | 200 | 键鼠穿越消息,表示键鼠穿越开始。 |
| MSG_COOPERATE_INFO_SUCCESS | 201 | 键鼠穿越消息,表示键鼠穿越成功。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
浏览文件 @
8269b263
...
...
@@ -27,7 +27,7 @@ on(type: "key", keyOptions: KeyOptions, callback: Callback<KeyOptions>): v
**参数:**
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| ---------- | -------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 事件类型,目前只支持”key“。 |
| keyOptions |
[
keyOptions
](
#keyoptions
)
| 是 | 组合键选项。 |
...
...
@@ -58,7 +58,7 @@ off(type: "key", keyOptions: KeyOptions, callback?: Callback<KeyOptions>):
**参数:**
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| ---------- | -------------------------- | ---- | ------------------------------- |
| type | string | 是 | 事件类型,当前只支持”key“。 |
| keyOptions |
[
keyOptions
](
#keyoptions
)
| 是 | 组合键选项。 |
...
...
@@ -106,9 +106,9 @@ try {
**系统能力:**
SystemCapability.MultimodalInput.Input.InputConsumer
|
参数 | 类型 | 必填 | 说明
|
| ---------
----------- | ------- | ---- | -----------------
------- |
| preKeys | Array | 是 | 前置按键集合,数量范围[0, 4],前置按键无顺序要求。 |
| finalKey | Number | 是 | 最终按键,此项必填,最终按键触发上报回调函数。 |
| isFinalKeyDown | boolean | 是 | 最终按键状态。 |
| finalKeyDownDuration | Number | 是 | 最终按键保持按下持续时间,为0时立即触发回调函数,大于0时,当isFinalKeyDown为true,则最终按键按下超过此时长后触发回调函数,当isFinalKeyDown为false,则最终按键按下到抬起时间小于此时长时触发回调函数。 |
|
名称 | 类型 | 可读 | 可写 | 说明
|
| ---------
| ------ | ---- | ---- |
------- |
| preKeys | Array | 是 |
否 |
前置按键集合,数量范围[0, 4],前置按键无顺序要求。 |
| finalKey | Number | 是 |
否 |
最终按键,此项必填,最终按键触发上报回调函数。 |
| isFinalKeyDown | boolean | 是 |
否 |
最终按键状态。 |
| finalKeyDownDuration | Number | 是 |
否 |
最终按键保持按下持续时间,为0时立即触发回调函数,大于0时,当isFinalKeyDown为true,则最终按键按下超过此时长后触发回调函数,当isFinalKeyDown为false,则最终按键按下到抬起时间小于此时长时触发回调函数。 |
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
浏览文件 @
8269b263
...
...
@@ -26,7 +26,7 @@ getDeviceList(callback: AsyncCallback<Array<number>>): void
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback
<
Array
<
number
>>
| 是 | 回调函数,异步返回所有输入设备的id列表。 |
...
...
@@ -82,7 +82,7 @@ getDeviceInfo(deviceId: number, callback: AsyncCallback<InputDeviceData>):
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------------- | ---- | --------------------------------------- |
| deviceId | number | 是 | 输入设备id。 |
| callback | AsyncCallback
<
[InputDeviceData](#inputdevicedata)
>
| 是 | 回调函数,异步返回输入设备信息。 |
...
...
@@ -114,7 +114,7 @@ getDeviceInfo(deviceId: number): Promise<InputDeviceData>
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- |
| deviceId | number | 是 | 输入设备id。 |
...
...
@@ -147,7 +147,7 @@ on(type: "change", listener: Callback<DeviceListener>): void
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ----------- |
| type | string | 是 | 输入设备的事件类型。 |
| listener | Callback
<
[DeviceListener](#devicelistener9)
>
| 是 | 回调函数,异步上报输入设备热插拔事件。 |
...
...
@@ -186,7 +186,7 @@ off(type: "change", listener?: Callback<DeviceListener>): void
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ----------- |
| type | string | 是 | 输入设备的事件类型。 |
| listener | Callback
<
[DeviceListener](#devicelistener9)
>
| 否 | 取消监听的回调函数。 |
...
...
@@ -231,7 +231,7 @@ getDeviceIds(callback: AsyncCallback<Array<number>>): void
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback
<
Array
<
number
>>
| 是 | 回调函数,异步返回所有输入设备的id列表。 |
...
...
@@ -283,7 +283,7 @@ getDevice(deviceId: number, callback: AsyncCallback<InputDeviceData>): voi
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------------- | ---- | -------------------------------- |
| deviceId | number | 是 | 输入设备id。 |
| callback | AsyncCallback
<
[InputDeviceData](#inputdevicedata)
>
| 是 | 回调函数,异步返回输入设备信息。 |
...
...
@@ -313,7 +313,7 @@ getDevice(deviceId: number): Promise<InputDeviceData>
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------ |
| deviceId | number | 是 | 输入设备id。 |
...
...
@@ -342,7 +342,7 @@ supportKeys(deviceId: number, keys: Array<KeyCode>, callback: AsyncCallbac
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | ------------------------------------------------------ |
| deviceId | number | 是 | 输入设备id,同一个物理设备反复插拔,设备id会发生变化。 |
| keys | Array
<
KeyCode
>
| 是 | 需要查询的键码值,最多支持5个按键查询。 |
...
...
@@ -371,7 +371,7 @@ supportKeys(deviceId: number, keys: Array<KeyCode>): Promise<Array<b
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------ |
| deviceId | number | 是 | 输入设备id,同一个物理设备反复插拔,设备id会发生变化。 |
| keys | Array
<
KeyCode
>
| 是 | 需要查询的键码值,最多支持5个按键查询。 |
...
...
@@ -405,7 +405,7 @@ getKeyboardType(deviceId: number, callback: AsyncCallback<KeyboardType>):
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ |
| deviceId | number | 是 | 输入设备的唯一标识,同一个物理设备反复插拔,设备id会发生变化。 |
| callback | AsyncCallback
<
[KeyboardType](#keyboardtype9)
>
| 是 | 回调函数,异步返回查询结果。 |
...
...
@@ -437,7 +437,7 @@ getKeyboardType(deviceId: number): Promise<KeyboardType>
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| deviceId | number | 是 | 输入设备的唯一标识,同一个物理设备反复插拔,设备id会发生变化。 |
...
...
@@ -466,10 +466,10 @@ try {
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称
| 参数类型 | 说明
|
| --------
| --------------------------- | -----------------------------------------------------
------- |
| type |
[
ChangedType
](
#changedtype
)
|
输入设备插入或者移除。
|
| deviceId | number | 输入设备的唯一标识,同一个物理设备反复插拔,设备id会发生变化。 |
| 名称
| 类型 | 可读 | 可写 | 说明
|
| --------
- | ------ | ---- | ---- |
------- |
| type |
[
ChangedType
](
#changedtype
)
|
是 | 否 | 输入设备插入或者移除。
|
| deviceId | number |
是 | 否 |
输入设备的唯一标识,同一个物理设备反复插拔,设备id会发生变化。 |
## InputDeviceData
...
...
@@ -477,18 +477,18 @@ try {
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称
| 参数类型 | 说明
|
| ---------
----------- | -------------------------------------- | -----------------------------------------------------
------- |
| id | number | 输入设备的唯一标识,同一个物理设备反复插拔,设备id会发生变化。 |
| name | string | 输入设备的名字。 |
| sources | Array
<
[SourceType](#sourcetype)
>
| 输入设备支持的源类型。比如有的键盘上附带触摸板,则此设备有keyboard和touchpad两种输入源。 |
| axisRanges | Array
<
[axisRanges](#axisrange)
>
| 输入设备的轴信息。 |
| bus
<sup>
9+
</sup>
| number | 输入设备的总线类型。 |
| product
<sup>
9+
</sup>
| number | 输入设备的产品信息。 |
| vendor
<sup>
9+
</sup>
| number | 输入设备的厂商信息。 |
| version
<sup>
9+
</sup>
| number | 输入设备的版本信息。 |
| phys
<sup>
9+
</sup>
| string | 输入设备的物理地址。 |
| uniq
<sup>
9+
</sup>
| string | 输入设备的唯一标识。 |
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ---------
| ------ | ---- | ---- |
------- |
| id | number |
是 | 否 |
输入设备的唯一标识,同一个物理设备反复插拔,设备id会发生变化。 |
| name | string |
是 | 否 |
输入设备的名字。 |
| sources | Array
<
[SourceType](#sourcetype)
>
|
是 | 否 |
输入设备支持的源类型。比如有的键盘上附带触摸板,则此设备有keyboard和touchpad两种输入源。 |
| axisRanges | Array
<
[axisRanges](#axisrange)
>
|
是 | 否 |
输入设备的轴信息。 |
| bus
<sup>
9+
</sup>
| number |
是 | 否 |
输入设备的总线类型。 |
| product
<sup>
9+
</sup>
| number |
是 | 否 |
输入设备的产品信息。 |
| vendor
<sup>
9+
</sup>
| number |
是 | 否 |
输入设备的厂商信息。 |
| version
<sup>
9+
</sup>
| number |
是 | 否 |
输入设备的版本信息。 |
| phys
<sup>
9+
</sup>
| string |
是 | 否 |
输入设备的物理地址。 |
| uniq
<sup>
9+
</sup>
| string |
是 | 否 |
输入设备的唯一标识。 |
## AxisType<sup>9+</sup>
...
...
@@ -496,17 +496,17 @@ try {
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称
| 参数类型 | 说明
|
| ---------
-- | ------ | --------
------- |
| touchMajor | string | 表示touchMajor轴。 |
| touchMinor | string | 表示touchMinor轴。 |
| toolMinor | string | 表示toolMinor轴。 |
| toolMajor | string | 表示toolMajor轴。 |
| orientation | string | 表示orientation轴。 |
| pressure | string | 表示pressure轴。 |
| x | string | 表示x轴。 |
| y | string | 表示y轴。 |
| NULL | string | 无。 |
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ---------
| ------ | ---- | ---- |
------- |
| touchMajor | string |
是 | 否 |
表示touchMajor轴。 |
| touchMinor | string |
是 | 否 |
表示touchMinor轴。 |
| toolMinor | string |
是 | 否 |
表示toolMinor轴。 |
| toolMajor | string |
是 | 否 |
表示toolMajor轴。 |
| orientation | string |
是 | 否 |
表示orientation轴。 |
| pressure | string |
是 | 否 |
表示pressure轴。 |
| x | string |
是 | 否 |
表示x轴。 |
| y | string |
是 | 否 |
表示y轴。 |
| NULL | string |
是 | 否 |
无。 |
## AxisRange
...
...
@@ -514,41 +514,41 @@ try {
**系统能力**
: SystemCapability.MultimodalInput.Input.InputDevice
| 名称
| 参数类型 | 说明
|
| ---------
-------------- | ------------------------- | -
------- |
| source |
[
SourceType
](
#sourcetype
)
| 轴的输入源类型。 |
| axis |
[
AxisType
](
#axistype9
)
| 轴的类型。 |
| max | number | 轴的最大值。 |
| min | number | 轴的最小值。 |
| fuzz
<sup>
9+
</sup>
| number | 轴的模糊值。 |
| flat
<sup>
9+
</sup>
| number | 轴的基准值。 |
| resolution
<sup>
9+
</sup>
| number | 轴的分辨率。 |
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ---------
| ------ | ---- | ---- |
------- |
| source |
[
SourceType
](
#sourcetype
)
|
是 | 否 |
轴的输入源类型。 |
| axis |
[
AxisType
](
#axistype9
)
|
是 | 否 |
轴的类型。 |
| max | number |
是 | 否 |
轴的最大值。 |
| min | number |
是 | 否 |
轴的最小值。 |
| fuzz
<sup>
9+
</sup>
| number |
是 | 否 |
轴的模糊值。 |
| flat
<sup>
9+
</sup>
| number |
是 | 否 |
轴的基准值。 |
| resolution
<sup>
9+
</sup>
| number |
是 | 否 |
轴的分辨率。 |
## SourceType
## SourceType
<sup>9+</sup>
轴的输入源类型。比如鼠标设备可上报x轴事件,则x轴的输入源就是鼠标。
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称
| 参数类型 | 说明
|
| ---------
-- | ------ | ----
------- |
| keyboard | string | 表示输入设备是键盘。 |
| touchscreen | string | 表示输入设备是触摸屏。 |
| mouse | string | 表示输入设备是鼠标。 |
| trackball | string | 表示输入设备是轨迹球。 |
| touchpad | string | 表示输入设备是触摸板。 |
| joystick | string | 表示输入设备是操纵杆。 |
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ---------
| ------ | ---- | ---- |
------- |
| keyboard | string |
是 | 否 |
表示输入设备是键盘。 |
| touchscreen | string |
是 | 否 |
表示输入设备是触摸屏。 |
| mouse | string |
是 | 否 |
表示输入设备是鼠标。 |
| trackball | string |
是 | 否 |
表示输入设备是轨迹球。 |
| touchpad | string |
是 | 否 |
表示输入设备是触摸板。 |
| joystick | string |
是 | 否 |
表示输入设备是操纵杆。 |
## ChangedType
## ChangedType
<sup>9+</sup>
定义监听设备热插拔事件。
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称
| 参数类型 | 说明
|
| ------
| ------ | --
------- |
| add | string | 表示输入设备插入。 |
| remove | string | 表示输入设备移除。 |
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
--- | ------ | ---- | ---- |
------- |
| add | string |
是 | 否 |
表示输入设备插入。 |
| remove | string |
是 | 否 |
表示输入设备移除。 |
## KeyboardType<sup>9+</sup>
...
...
@@ -556,11 +556,11 @@ try {
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 |
参数类型 |
值 | 说明 |
| ------------------- | ----
-- | ----
| --------- |
| NONE |
number |
0 | 表示无按键设备。 |
| UNKNOWN |
number |
1 | 表示未知按键设备。 |
| ALPHABETIC_KEYBOARD |
number |
2 | 表示全键盘设备。 |
| DIGITAL_KEYBOARD |
number |
3 | 表示小键盘设备。 |
| HANDWRITING_PEN |
number |
4 | 表示手写笔设备。 |
| REMOTE_CONTROL |
number |
5 | 表示遥控器设备。 |
| 名称 | 值 | 说明 |
| ------------------- | ---- | --------- |
| NONE | 0 | 表示无按键设备。 |
| UNKNOWN | 1 | 表示未知按键设备。 |
| ALPHABETIC_KEYBOARD | 2 | 表示全键盘设备。 |
| DIGITAL_KEYBOARD | 3 | 表示小键盘设备。 |
| HANDWRITING_PEN | 4 | 表示手写笔设备。 |
| REMOTE_CONTROL | 5 | 表示遥控器设备。 |
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
浏览文件 @
8269b263
...
...
@@ -15,7 +15,7 @@ import InputEvent from '@ohos.multimodalInput.inputEvent';
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ---------- | ------ | ---- | ---- | -------------- |
| id | number | 是 | 否 | 事件id |
| deviceId | number | 是 | 否 | 上报输入事件的设备id |
...
...
zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md
浏览文件 @
8269b263
...
...
@@ -27,7 +27,7 @@ injectEvent({KeyEvent: KeyEvent}): void
**参数:**
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | --------- |
| KeyEvent |
[
KeyEvent
](
#keyevent
)
| 是 | 按键注入描述信息。 |
...
...
@@ -62,10 +62,10 @@ try {
**系统能力:**
SystemCapability.MultimodalInput.Input.InputSimulator
|
参数 | 类型 | 必填 | 说明
|
| ---------
------ | ------- | ---- | -------------------
------- |
| isPressed | boolean | 是 | 按键是否按下。 |
| keyCode | number | 是 | 按键键值,当前只支持back键。 |
| keyDownDuration | number | 是 | 按键按下持续时间。 |
| isIntercepted | boolean | 是 | 按键是否可以被拦截。 |
|
名称 | 类型 | 可读 | 可写 | 说明
|
| ---------
| ------ | ---- | ---- |
------- |
| isPressed | boolean | 是
| 否
| 按键是否按下。 |
| keyCode | number | 是
| 否
| 按键键值,当前只支持back键。 |
| keyDownDuration | number | 是
| 否
| 按键按下持续时间。 |
| isIntercepted | boolean | 是
| 否
| 按键是否可以被拦截。 |
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
浏览文件 @
8269b263
# 输入监听
输入监听模块,提供了监听输入设备事件(当前支持触摸屏和鼠标)的能力。
> **说明:**
>
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
@@ -26,13 +27,14 @@ on(type: "touch", receiver: TouchEventReceiver): void
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数 | 类型 | 必填 | 说明 |
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型,取值“touch”。 |
| receiver |
[
TouchEventReceiver
](
#toucheventreceiver
)
| 是 | 回调函数,异步上报触摸屏输入事件。 |
**示例:**
**示例:**
```
js
try
{
...
...
@@ -45,6 +47,7 @@ try {
}
```
## inputMonitor.on<sup>9+</sup>
on(type: "mouse", receiver: Callback
<
MouseEvent
>
): void
...
...
@@ -54,9 +57,9 @@ on(type: "mouse", receiver: Callback<MouseEvent>): void
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
**参数:**
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型,取值“mouse”。 |
| receiver | Callback
<
MouseEvent
>
| 是 | 回调函数,异步上报鼠标输入事件。 |
...
...
@@ -86,13 +89,14 @@ off(type: "touch", receiver?: TouchEventReceiver): void
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数 | 类型 | 必填 | 说明 |
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型,取值“touch”。 |
| receiver |
[
TouchEventReceiver
](
#toucheventreceiver
)
| 否 | 需要取消监听的回调函数,若无此参数,则取消当前应用监听的所有回调函数。 |
**示例:**
**示例:**
```
js
// 取消监听单个回调函数
...
...
@@ -124,6 +128,8 @@ try {
}
```
## inputMonitor.off<sup>9+</sup>
off(type: "mouse", receiver?: Callback
<
MouseEvent
>
): void
停止监听全局鼠标事件。
...
...
@@ -132,9 +138,9 @@ off(type: "mouse", receiver?: Callback<MouseEvent>): void
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
**参数:**
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型,取值“mouse”。 |
| receiver | Callback
<
MouseEvent
>
| 否 | 需要取消监听的回调函数,若无此参数,则取消当前应用监听的所有回调函数。 |
...
...
@@ -179,17 +185,19 @@ try {
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
**参数:**
| 参数 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------- | ---- | ---------------------------------------- |
| touchEvent |
[
TouchEvent
](
../arkui-js/js-components-common-events.md
)
| 是 | 触摸输入事件。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | ---------------------------------------- |
| Boolean | 若返回true,本次触摸后续产生的事件不再分发到窗口;若返回false,本次触摸后续产生的事件还会分发到窗口。 |
**示例:**
**示例:**
```
js
try
{
...
...
zh-cn/application-dev/reference/apis/js-apis-keycode.md
浏览文件 @
8269b263
...
...
@@ -15,7 +15,7 @@ import {KeyCode} from '@ohos.multimodalInput.keyCode';
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| -------------------------------- | ------ | ---- | ---- | --------------------------- |
| KEYCODE_FN | number | 是 | 否 | 功能(Fn)键 |
| KEYCODE_UNKNOWN | number | 是 | 否 | 未知按键 |
...
...
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
浏览文件 @
8269b263
...
...
@@ -16,7 +16,7 @@ import {Action, Key, KeyEvent} from '@ohos.multimodalInput.keyEvent';
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ------ | -------- | ---- | ---- | -------- |
| CANCEL | number | 是 | 否 | 按键取消 |
| DOWN | number | 是 | 否 | 按键按下 |
...
...
@@ -26,7 +26,7 @@ import {Action, Key, KeyEvent} from '@ohos.multimodalInput.keyEvent';
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ----------- | -------- | ---- | ---- | -------------- |
| code | KeyCode | 是 | 否 | 按键码 |
| pressedTime | number | 是 | 否 | 按键按下时间 |
...
...
@@ -36,7 +36,7 @@ import {Action, Key, KeyEvent} from '@ohos.multimodalInput.keyEvent';
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ----------- | -------- | ---- | ---- | ------------------------------ |
| action | Action | 是 | 否 | 按键动作 |
| key | Key | 是 | 否 | 当前上报的按键 |
...
...
zh-cn/application-dev/reference/apis/js-apis-mouseevent.md
浏览文件 @
8269b263
...
...
@@ -15,7 +15,7 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ----------- | -------- | ---- | ---- | -------------------- |
| CANCEL | number | 是 | 否 | 取消 |
| MOVE | number | 是 | 否 | 鼠标移动 |
...
...
@@ -30,7 +30,7 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ------- | ------ | ---- | ---- | ----- |
| LEFT | number | 是 | 否 | 鼠标左键 |
| MIDDLE | number | 是 | 否 | 鼠标中键 |
...
...
@@ -45,7 +45,7 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ----------------- | ------ | ---- | ---- | ----- |
| SCROLL_VERTICAL | number | 是 | 否 | 垂直滚动轴 |
| SCROLL_HORIZONTAL | number | 是 | 否 | 水平滚动轴 |
...
...
@@ -56,7 +56,7 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ----- | ------ | ---- | ---- | ---- |
| axis | Axis | 是 | 否 | 轴类型 |
| value | number | 是 | 否 | 轴的值 |
...
...
@@ -66,7 +66,7 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| -------------- | ----------- | ---- | ---- | ---------------------------------------- |
| action | Action | 是 | 否 | 鼠标事件动作 |
| screenX | number | 是 | 否 | 鼠标光标在屏幕中的横坐标 |
...
...
zh-cn/application-dev/reference/apis/js-apis-pointer.md
浏览文件 @
8269b263
...
...
@@ -22,7 +22,7 @@ setPointerVisible(visible: boolean, callback: AsyncCallback<void>): void
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| visible | boolean | 是 | 鼠标指针是否显示。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
...
...
@@ -53,7 +53,7 @@ setPointerVisible(visible: boolean): Promise<void>
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ---------------------------------------- |
| visible | boolean | 是 | 鼠标指针是否显示。 |
...
...
@@ -85,7 +85,7 @@ isPointerVisible(callback: AsyncCallback<boolean>): void
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | -------------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,异步返回鼠标指针显示或隐藏状态。 |
...
...
@@ -135,9 +135,11 @@ setPointerSpeed(speed: number, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.MultimodalInput.Input.Pointer
**系统API**
: 此接口为系统接口。
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------- |
| speed | number | 是 | 鼠标移动速度,范围1-11,默认为5。 |
| callback | AysncCallback
<
void
>
| 是 | 回调函数。 |
...
...
@@ -166,9 +168,11 @@ setPointerSpeed(speed: number): Promise<void>
**系统能力**
:SystemCapability.MultimodalInput.Input.Pointer
**系统API**
: 此接口为系统接口。
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| speed | number | 是 | 鼠标移动速度,范围1-11,默认为5。 |
...
...
@@ -198,9 +202,11 @@ getPointerSpeed(callback: AsyncCallback<number>): void
**系统能力**
:SystemCapability.MultimodalInput.Input.Pointer
**系统API**
: 此接口为系统接口。
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------- |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,异步返回鼠标移动速度。 |
...
...
@@ -228,6 +234,8 @@ getPointerSpeed(): Promise<number>
**系统能力**
:SystemCapability.MultimodalInput.Input.Pointer
**系统API**
: 此接口为系统接口。
**返回值**
:
| 参数 | 说明 |
...
...
@@ -256,7 +264,7 @@ getPointerStyle(windowId: number, callback: AsyncCallback<PointerStyle>):
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------- |
| windowId | number | 是 | 窗口id。 |
| callback | AsyncCallback
<
[PointerStyle](#pointerstyle9)
>
| 是 | 回调函数,异步返回鼠标样式类型。 |
...
...
@@ -294,7 +302,7 @@ getPointerStyle(windowId: number): Promise<PointerStyle>
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| -------- | ------ | ---- | -------- |
| windowId | number | 是 | 窗口id。 |
...
...
@@ -337,7 +345,7 @@ setPointerStyle(windowId: number, pointerStyle: PointerStyle, callback: AsyncCal
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| ------------ | ------------------------------ | ---- | ----------------------------------- |
| windowId | number | 是 | 窗口id。 |
| pointerStyle |
[
PointerStyle
](
#pointerstyle9
)
| 是 | 鼠标样式id。 |
...
...
@@ -375,7 +383,7 @@ setPointerStyle(windowId: number, pointerStyle: PointerStyle): Promise<void&g
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数
名
| 类型 | 必填 | 说明 |
| ------------------- | ------------------------------ | ---- | ---------------- |
| windowId | number | 是 | 窗口id。 |
| pointerStyle |
[
PointerStyle
](
#pointerstyle9
)
| 是 | 鼠标样式id。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
浏览文件 @
8269b263
...
...
@@ -16,7 +16,7 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ------ | ------ | ---- | ---- | ---- |
| CANCEL | number | 是 | 否 | 触摸取消 |
| DOWN | number | 是 | 否 | 触摸按下 |
...
...
@@ -27,7 +27,7 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| -------- | ------ | ---- | ---- | ---- |
| FINGER | number | 是 | 否 | 手指 |
| PEN | number | 是 | 否 | 笔 |
...
...
@@ -42,7 +42,7 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ------------ | ------ | ---- | ---- | ---- |
| TOUCH_SCREEN | number | 是 | 否 | 触摸屏 |
| PEN | number | 是 | 否 | 手写笔 |
...
...
@@ -52,7 +52,7 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ----------- | ------ | ---- | ---- | ----------------------------------- |
| id | number | 是 | 否 | 触摸事件标识 |
| pressedTime | number | 是 | 否 | 按下时间戳 |
...
...
@@ -77,7 +77,7 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 |
参数类型 | 可读 | 可写 | 描述
|
| 名称 |
类型 | 可读 | 可写 | 说明
|
| ---------- | ---------- | ---- | ---- | --------- |
| action | Action | 是 | 否 | 触摸动作 |
| touch | Touch | 是 | 否 | 当前触摸点 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录