From 84b99cac0350f7904d7cd920b007350b98cdf05f Mon Sep 17 00:00:00 2001 From: mayunteng_1 Date: Sat, 27 Aug 2022 17:32:51 +0800 Subject: [PATCH] =?UTF-8?q?=E5=A4=9A=E6=A8=A1=E9=BC=A0=E6=A0=87=E6=A0=B7?= =?UTF-8?q?=E5=BC=8F=E5=92=8C=E9=BC=A0=E6=A0=87=E9=80=9F=E5=BA=A6doc?= =?UTF-8?q?=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: mayunteng_1 Change-Id: Ifd84ddaf141dbf5056832546bd7a4f1b2334cf7b --- .../reference/apis/js-apis-pointer.md | 253 ++++++++++++++++++ .../reference/apis/js-apis-window.md | 1 + 2 files changed, 254 insertions(+) mode change 100644 => 100755 zh-cn/application-dev/reference/apis/js-apis-pointer.md mode change 100644 => 100755 zh-cn/application-dev/reference/apis/js-apis-window.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-pointer.md b/zh-cn/application-dev/reference/apis/js-apis-pointer.md old mode 100644 new mode 100755 index ff5f66a3cc..36f9efa232 --- a/zh-cn/application-dev/reference/apis/js-apis-pointer.md +++ b/zh-cn/application-dev/reference/apis/js-apis-pointer.md @@ -112,3 +112,256 @@ pointer.isPointerVisible().then( data => { console.log(`isPointerThen success data=${JSON.stringify(data)}`); }); ``` + +## pointer.setPointerSpeed9+ + +setPointerSpeed(speed: number, callback: AsyncCallback<void>): void; + +设置鼠标移动速度，使用callback方式作为异步方法。 + +**系统能力**：SystemCapability.MultimodalInput.Input.Pointer + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------------------------------- | +| speed | number | 是 | 鼠标移动速度设置挡位值1-11，最大值：11，最小值：1，标准值：5 | +| callback | AysncCallback<void> | 是 | 回调函数，异步返回查询结果。 | + +**示例**： + +```js +pointer.setPointerSpeed(5, (err, data) => { + if (err) { + console.log(`set pointer speed failed. err=${JSON.stringify(err)}`); + return; + } + console.log(`set pointer speed success.`); +); +``` + +## pointer.setPointerSpeed9+ + +setPointerSpeed(speed: number): Promise<void> + +设置鼠标移动速度，使用Promise方式作为异步方法。 + +**系统能力**：SystemCapability.MultimodalInput.Input.Pointer + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | ------------------------------------------------------------------- | +| speed | number | 是 | 鼠标移动速度设置挡位值1-11，最大值：11，最小值：1，标准值：5 | + +**返回值**： + +| 参数 | 说明 | +| ------------------- | ------------------------------- | +| Promise<void> | Promise实例，用于异步获取结果。 | + +**示例**： + +```js +pointer.setPointerSpeed(5).then( data => { + console.log(`set pointer speed success`); + }, err => { + console.log(`set pointer speed failed err=${JSON.stringify(err)}`); +}); +``` + +## pointer.getPointerSpeed9+ + +getPointerSpeed(callback: AsyncCallback<number>): void + +获取当前鼠标移动速度，使用callback方式作为异步方法。 + +**系统能力**：SystemCapability.MultimodalInput.Input.Pointer + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | ---------------------------- | +| callback | AsyncCallback<number> | 是 | 回调函数，异步返回查询结果。 | + +**示例**： + +```js +pointer.getPointerSpeed((speed)=>{ + console.log("The pointer speed is " + speed); +}); +``` + +## pointer.getPointerSpeed9+ + +getPointerSpeed(): Promise<number> + +获取当前鼠标移动速度，使用Promise方式作为异步方法。 + +**系统能力**：SystemCapability.MultimodalInput.Input.Pointer + +**返回值**： + +| 参数 | 说明 | +| ---------------------- | ------------------------------- | +| Promise<number> | Promise实例，用于异步获取结果。 | + +**示例**： + +```js +pointer.getPointerSpeed().then( data => { + console.log(`getPointerSpeed success data=${JSON.stringify(data)}`); +}); +``` + +## pointer.getPointerStyle9+ + +getPointerStyle(windowId: number, callback: AsyncCallback<PointerStyle>): void; + +获取鼠标样式类型，使用callback方式作为异步方法。 + +**系统能力**：SystemCapability.MultimodalInput.Input.Pointer + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------------------------------- | +| windowId | number | 是 | 输入设备的窗口id | +| callback | AsyncCallback<[PointerStyle](#pointerstyle9)> | 是 | 回调函数，异步返回查询结果。| + +**示例**： + +```js +// 示例获取设备的鼠标样式。 +pointer.getPointerStyle(windowId, (ret)=>{ + console.log("The mouse pointer style is: " + ret); +}); +``` + +## pointer.getPointerStyle9+ + +getPointerStyle(windowId: number): Promise<PointerStyle< + +获取鼠标样式类型，使用Promise方式作为异步方法。 + +**系统能力**：SystemCapability.MultimodalInput.Input.Pointer + +**参数**： + +| 参数 | 说明 | +| -------- | --------------------------------- | +| Promise<[PointerStyle](#pointerstyle9)> |Promise实例，用于异步获取结果。| + + +**示例**： + +```js +// 示例获取设备的鼠标样式。 +pointer.PointerStyle(windowId).then((ret)=>{ + console.log("The mouse pointer style is: " + ret); +}); +``` + +## pointer.setPointerStyle9+ + +setPointerStyle(windowId: number, pointerStyle: PointerStyle, callback: AsyncCallback<void<): void; + +设置鼠标的样式类型，使用callback方式作为异步方法。 + +**系统能力**：SystemCapability.MultimodalInput.Input.Pointer + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------| ---- | --------------------------------- | +| windowId | number | 是 | 输入设备的窗口id | +| pointerStyle | [PointerStyle](#pointerstyle9) | 是 | 鼠标样式id | +| callback | AysncCallback<void> | 是 | 回调函数，异步返回查询结果。| + +**示例**： + +```js +// 示例设置设备的鼠标样式。 +pointer.setPointerStyle(windowId, (err, data) => { + if (err) { + console.log(`Set mouse pointer style failed. err=${JSON.stringify(err)}`); + return; + } + console.log(`Set mouse pointer style success.`); +}); +``` +## pointer.setPointerStyle9+ + +setPointerStyle(windowId: number, pointerStyle: PointerStyle): Promise<void<; + +设置鼠标的样式类型，使用Promise方式作为异步方法。 + +**系统能力**：SystemCapability.MultimodalInput.Input.Pointer + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------------------------------- | +| windowId | number | 是 | 输入设备的窗口id | +| pointerStyle | [PointerStyle](#pointerstyle9) | 是 | 鼠标样式id | +| Promise<void> | void | 是 |Promise实例，用于异步获取结果。 | + +**示例**： + +```js +// 示例设置设备的鼠标样式。 +pointer.setPointerStyle(windowId, pointerStyle).then(data => { + console.log(`Set mouse pointer style success`); + }, err => { + console.log(`Set mouse pointer style failed err=${JSON.stringify(data)}`); +}); +``` +## PointerStyle9+ + +定义鼠标样式类型。 + +**系统能力**：SystemCapability.MultimodalInput.Input.Pointer + +| 名称 | 参数类型 | 值 | 说明 | +| ------------------- | ------ | ---- | --------- | +| DEFAULT | number | 0 | 默认 | +| EAST | number | 1 | 向东箭头 | +| WEST | number | 2 | 向西箭头 | +| SOUTH | number | 3 | 向南箭头 | +| NORTH | number | 4 | 向北箭头 | +| WEST_EAST | number | 5 | 向西东箭头 | +| NORTH_SOUTH | number | 6 | 向北南箭头 | +| NORTH_EAST | number | 7 | 向东北箭头 | +| NORTH_WEST | number | 8 | 向西北箭头 | +| SOUTH_EAST | number | 9 | 向东南箭头 | +| SOUTH_WEST | number | 10 | 向西南箭头 | +| NORTH_EAST_SOUTH_WEST | number | 11 | 东北西南调整 | +| NORTH_WEST_SOUTH_EAST | number | 12 | 西北东南调整 | +| CROSS | number | 13 | 准确选择 | +| CURSOR_COPY | number | 14 | 拷贝 | +| CURSOR_FORBID | number | 15 | 不可用 | +| COLOR_SUCKER | number | 16 | 滴管 | +| HAND_GRABBING | number | 17 | 并拢的手 | +| HAND_OPEN | number | 18 | 张开的手 | +| HAND_POINTING | number | 19 | 手形指针 | +| HELP | number | 20 | 帮助选择 | +| MOVE | number | 21 | 移动 | +| RESIZE_LEFT_RIGHT | number | 22 | 内部左右调整 | +| RESIZE_UP_DOWN | number | 23 | 内部上下调整 | +| SCREENSHOT_CHOOSE | number | 24 | 截图十字准星 | +| SCREENSHOT_CURSOR | number | 25 | 截图 | +| TEXT_CURSOR | number | 26 | 文本选择 | +| ZOOM_IN | number | 27 | 放大 | +| ZOOM_OUT | number | 28 | 缩小 | +| MIDDLE_BTN_EAST | number | 29 | 向东滚动 | +| MIDDLE_BTN_WEST | number | 30 | 向西滚动 | +| MIDDLE_BTN_SOUTH | number | 31 | 向南滚动 | +| MIDDLE_BTN_NORTH | number | 32 | 向北滚动 | +| MIDDLE_BTN_NORTH_SOUTH | number | 33 | 向北南滚动 | +| MIDDLE_BTN_NORTH_EAST | number | 34 | 向东北滚动 | +| MIDDLE_BTN_NORTH_WEST | number | 35 | 向西北滚动 | +| MIDDLE_BTN_SOUTH_EAST | number | 36 | 向东南滚动 | +| MIDDLE_BTN_SOUTH_WEST | number | 37 | 向西南滚动 | +| MIDDLE_BTN_NORTH_SOUTH_WEST_EAST | number | 38 | 四向锥形移动 | + + diff --git a/zh-cn/application-dev/reference/apis/js-apis-window.md b/zh-cn/application-dev/reference/apis/js-apis-window.md old mode 100644 new mode 100755 index 6352e23f62..15e4cc7262 --- a/zh-cn/application-dev/reference/apis/js-apis-window.md +++ b/zh-cn/application-dev/reference/apis/js-apis-window.md @@ -224,6 +224,7 @@ import window from '@ohos.window'; | isPrivacyMode7+ | boolean | 是 | 是 | 隐私模式，默认为false。 | | isRoundCorner(deprecated) | boolean | 是 | 是 | 窗口是否为圆角。默认为false。
- **说明：** 从API version 9开始废弃。
- 从 API version 7开始支持 | | isTransparent7+ | boolean | 是 | 是 | 窗口是否透明。默认为false。 | +| id9+ | number | 是 | 是 | 窗口ID | ## ColorSpace8+ -- GitLab