diff --git a/zh-cn/application-dev/reference/apis/js-apis-pointer.md b/zh-cn/application-dev/reference/apis/js-apis-pointer.md index 36f9efa232eb7c86ce5c9f3359dba1175d846813..79fce2b3dc7597f940ef5b5e8423db448d3dea68 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-pointer.md +++ b/zh-cn/application-dev/reference/apis/js-apis-pointer.md @@ -12,11 +12,11 @@ import pointer from '@ohos.multimodalInput.pointer'; ``` -## pointer.setPointerVisibele +## pointer.setPointerVisibele9+ setPointerVisible(visible: boolean, callback: AsyncCallback<void>): void -设置鼠标指针显示或者隐藏，使用callback方式作为异步方法。 +设置鼠标指针显示或者隐藏，使用callback异步回调。 **系统能力**：SystemCapability.MultimodalInput.Input.Pointer @@ -25,21 +25,21 @@ setPointerVisible(visible: boolean, callback: AsyncCallback<void>): void | 参数 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------------------------------------------------------------- | | visible | boolean | 是 | 鼠标指针显示或者隐藏状态，true: 鼠标指针显示; false: 鼠标指针隐藏。 | -| callback | AysncCallback<void> | 是 | 回调函数，异步返回查询结果。 | +| callback | AysncCallback<void> | 是 | 回调函数。当设置鼠标显示或隐藏成功，err为undefined，否则为错误对象。 | **示例**： ```js pointer.setPointerVisible(true, (err, data) => { - if (err) { - console.log(`set pointer visible failed. err=${JSON.stringify(err)}`); - return; - } - console.log(`set pointer visible success.`); + if (err) { + console.log(`set pointer visible failed. err=${JSON.stringify(err)}`); + return; + } + console.log(`set pointer visible success.`); ); ``` -## pointer.setPointerVisible +## pointer.setPointerVisible9+ setPointerVisible(visible: boolean): Promise<void> @@ -62,18 +62,18 @@ setPointerVisible(visible: boolean): Promise<void> **示例**： ```js -pointer.setPointerVisible(false).then( data => { - console.log(`set mouse pointer visible success`); - }, data => { - console.log(`set mouse pointer visible failed err=${JSON.stringify(data)}`); +pointer.setPointerVisible(false).then(data => { + console.log(`set mouse pointer visible success`); +}, data => { + console.log(`set mouse pointer visible failed err=${JSON.stringify(data)}`); }); ``` -## pointer.isPointerVisible +## pointer.isPointerVisible9+ isPointerVisible(callback: AsyncCallback<boolean>): void -获取鼠标指针显示或隐藏状态，使用callback方式作为异步方法。 +获取鼠标指针显示或隐藏状态，使用callback异步回调。 **系统能力**：SystemCapability.MultimodalInput.Input.Pointer @@ -87,11 +87,11 @@ isPointerVisible(callback: AsyncCallback<boolean>): void ```js pointer.isPointerVisible((visible)=>{ - console.log("The mouse pointer visible attributes is " + visible); + console.log("The mouse pointer visible attributes is " + visible); }); ``` -## pointer.isPointerVisible +## pointer.isPointerVisible9+ isPointerVisible(): Promise<boolean> @@ -109,15 +109,15 @@ isPointerVisible(): Promise<boolean> ```js pointer.isPointerVisible().then( data => { - console.log(`isPointerThen success data=${JSON.stringify(data)}`); + console.log(`isPointerThen success data=${JSON.stringify(data)}`); }); ``` ## pointer.setPointerSpeed9+ -setPointerSpeed(speed: number, callback: AsyncCallback<void>): void; +setPointerSpeed(speed: number, callback: AsyncCallback<void>): void -设置鼠标移动速度，使用callback方式作为异步方法。 +设置鼠标移动速度，使用callback异步回调。 **系统能力**：SystemCapability.MultimodalInput.Input.Pointer @@ -125,18 +125,18 @@ setPointerSpeed(speed: number, callback: AsyncCallback<void>): void; | 参数 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------------------------------------------------------------- | -| speed | number | 是 | 鼠标移动速度设置挡位值1-11，最大值：11，最小值：1，标准值：5 | -| callback | AysncCallback<void> | 是 | 回调函数，异步返回查询结果。 | +| speed | number | 是 | 鼠标移动速度设置挡位值1-11，最大值：11，最小值：1，标准值：5。 | +| callback | AysncCallback<void> | 是 | 回调函数。当设置鼠标速度成功，err为undefined，否则为错误对象。 | **示例**： ```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.`); + if (err) { + console.log(`set pointer speed failed. err=${JSON.stringify(err)}`); + return; + } + console.log(`set pointer speed success.`); ); ``` @@ -144,7 +144,7 @@ pointer.setPointerSpeed(5, (err, data) => { setPointerSpeed(speed: number): Promise<void> -设置鼠标移动速度，使用Promise方式作为异步方法。 +设置鼠标移动速度，使用Promise异步回调。 **系统能力**：SystemCapability.MultimodalInput.Input.Pointer @@ -152,21 +152,21 @@ setPointerSpeed(speed: number): Promise<void> | 参数 | 类型 | 必填 | 说明 | | ------- | ------- | ---- | ------------------------------------------------------------------- | -| speed | number | 是 | 鼠标移动速度设置挡位值1-11，最大值：11，最小值：1，标准值：5 | +| speed | number | 是 | 鼠标移动速度设置挡位值1-11，最大值：11，最小值：1，标准值：5。 | **返回值**： | 参数 | 说明 | | ------------------- | ------------------------------- | -| Promise<void> | Promise实例，用于异步获取结果。 | +| 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.setPointerSpeed(5).then(data => { + console.log(`set pointer speed success`); +}, err => { + console.log(`set pointer speed failed err=${JSON.stringify(err)}`); }); ``` @@ -174,7 +174,7 @@ pointer.setPointerSpeed(5).then( data => { getPointerSpeed(callback: AsyncCallback<number>): void -获取当前鼠标移动速度，使用callback方式作为异步方法。 +获取当前鼠标移动速度，使用callback异步回调。 **系统能力**：SystemCapability.MultimodalInput.Input.Pointer @@ -188,7 +188,7 @@ getPointerSpeed(callback: AsyncCallback<number>): void ```js pointer.getPointerSpeed((speed)=>{ - console.log("The pointer speed is " + speed); + console.log("The pointer speed is " + speed); }); ``` @@ -196,7 +196,7 @@ pointer.getPointerSpeed((speed)=>{ getPointerSpeed(): Promise<number> -获取当前鼠标移动速度，使用Promise方式作为异步方法。 +获取当前鼠标移动速度，使用Promise异步回调。 **系统能力**：SystemCapability.MultimodalInput.Input.Pointer @@ -210,7 +210,7 @@ getPointerSpeed(): Promise<number> ```js pointer.getPointerSpeed().then( data => { - console.log(`getPointerSpeed success data=${JSON.stringify(data)}`); + console.log(`getPointerSpeed success data=${JSON.stringify(data)}`); }); ``` @@ -218,7 +218,7 @@ pointer.getPointerSpeed().then( data => { getPointerStyle(windowId: number, callback: AsyncCallback<PointerStyle>): void; -获取鼠标样式类型，使用callback方式作为异步方法。 +获取鼠标样式类型，使用callback异步回调。 **系统能力**：SystemCapability.MultimodalInput.Input.Pointer @@ -226,15 +226,22 @@ getPointerStyle(windowId: number, callback: AsyncCallback<PointerStyle>): | 参数 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------------------- | -| windowId | number | 是 | 输入设备的窗口id | +| windowId | number | 是 | 输入设备的窗口id。 | | callback | AsyncCallback<[PointerStyle](#pointerstyle9)> | 是 | 回调函数，异步返回查询结果。| **示例**： ```js -// 示例获取设备的鼠标样式。 -pointer.getPointerStyle(windowId, (ret)=>{ - console.log("The mouse pointer style is: " + ret); +// 获取设备的鼠标样式。 +var windowClass = null; +window.getTopWindow((err, data) => { + windowClass = data; + windowClass.getProperties((err, data) => { + var windowId = data.id; + pointer.getPointerStyle(windowId, (err, ret) => { + console.log("The mouse pointer style is: " + ret); + }); + }); }); ``` @@ -256,9 +263,16 @@ getPointerStyle(windowId: number): Promise<PointerStyle< **示例**： ```js -// 示例获取设备的鼠标样式。 -pointer.PointerStyle(windowId).then((ret)=>{ - console.log("The mouse pointer style is: " + ret); +// 获取设备的鼠标样式。 +var windowClass = null; +window.getTopWindow((err, data) => { + windowClass = data; + windowClass.getProperties((err, data) => { + var windowId = data.id; + pointer.getPointerStyle(windowId).then((ret) => { + console.log("The mouse pointer style is: " + ret); + }); + }); }); ``` @@ -266,7 +280,7 @@ pointer.PointerStyle(windowId).then((ret)=>{ setPointerStyle(windowId: number, pointerStyle: PointerStyle, callback: AsyncCallback<void<): void; -设置鼠标的样式类型，使用callback方式作为异步方法。 +设置鼠标的样式类型，使用callback异步回调。 **系统能力**：SystemCapability.MultimodalInput.Input.Pointer @@ -274,20 +288,23 @@ setPointerStyle(windowId: number, pointerStyle: PointerStyle, callback: AsyncCal | 参数 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------| ---- | --------------------------------- | -| windowId | number | 是 | 输入设备的窗口id | -| pointerStyle | [PointerStyle](#pointerstyle9) | 是 | 鼠标样式id | -| callback | AysncCallback<void> | 是 | 回调函数，异步返回查询结果。| +| windowId | number | 是 | 输入设备的窗口id。 | +| pointerStyle | [PointerStyle](#pointerstyle9) | 是 | 鼠标样式id。 | +| callback | AysncCallback<void> | 是 | 回调函数。当设置样式成功，err为undefined，否则为错误对象。| **示例**： ```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.`); +// 设置设备的鼠标样式。 +var windowClass = null; +window.getTopWindow((err, data) => { + windowClass = data; + windowClass.getProperties((err, data) => { + var windowId = data.id; + pointer.setPointerStyle(windowId, pointer.PointerStyle.CROSS, (err) => { + console.log(`Set mouse pointer style success.`); + }); + }); }); ``` ## pointer.setPointerStyle9+ @@ -302,18 +319,23 @@ setPointerStyle(windowId: number, pointerStyle: PointerStyle): Promise<void&l | 参数 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------------------- | -| windowId | number | 是 | 输入设备的窗口id | -| pointerStyle | [PointerStyle](#pointerstyle9) | 是 | 鼠标样式id | -| Promise<void> | void | 是 |Promise实例，用于异步获取结果。 | +| 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)}`); +// 设置设备的鼠标样式。 +var windowClass = null; +window.getTopWindow((err, data) => { + windowClass = data; + windowClass.getProperties((err, data) => { + var windowId = data.id; + pointer.setPointerStyle(windowId, pointer.PointerStyle.CROSS).then(() => { + console.log(`Set mouse pointer style success`); + }); + }); }); ``` ## PointerStyle9+ @@ -322,46 +344,46 @@ pointer.setPointerStyle(windowId, pointerStyle).then(data => { **系统能力**：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 | 四向锥形移动 | +| 名称 | 值 | 说明 | +| ------------------- | ---- | --------- | +| DEFAULT | 0 | 默认 | +| EAST | 1 | 向东箭头 | +| WEST | 2 | 向西箭头| +| SOUTH | 3 | 向南箭头 | +| NORTH | 4 | 向北箭头 | +| WEST_EAST | 5 | 向西东箭头 | +| NORTH_SOUTH | 6 | 向北南箭头 | +| NORTH_EAST | 7 | 向东北箭头 | +| NORTH_WEST | 8 | 向西北箭头 | +| SOUTH_EAST | 9 | 向东南箭头 | +| SOUTH_WEST | 10 | 向西南箭头 | +| NORTH_EAST_SOUTH_WEST | 11 | 东北西南调整 | +| NORTH_WEST_SOUTH_EAST | 12 | 西北东南调整 | +| CROSS | 13 | 准确选择 | +| CURSOR_COPY | 14 | 拷贝 | +| CURSOR_FORBID | 15 | 不可用 | +| COLOR_SUCKER | 16 | 滴管 | +| HAND_GRABBING | 17 | 并拢的手 | +| HAND_OPEN | 18 | 张开的手 | +| HAND_POINTING | 19 | 手形指针 | +| HELP | 20 | 帮助选择 | +| MOVE | 21 | 移动 | +| RESIZE_LEFT_RIGHT | 22 | 内部左右调整 | +| RESIZE_UP_DOWN | 23 | 内部上下调整 | +| SCREENSHOT_CHOOSE | 24 | 截图十字准星 | +| SCREENSHOT_CURSOR | 25 | 截图 | +| TEXT_CURSOR | 26 | 文本选择 | +| ZOOM_IN | 27 | 放大 | +| ZOOM_OUT | 28 | 缩小 | +| MIDDLE_BTN_EAST | 29 | 向东滚动 | +| MIDDLE_BTN_WEST | 30 | 向西滚动 | +| MIDDLE_BTN_SOUTH | 31 | 向南滚动 | +| MIDDLE_BTN_NORTH | 32 | 向北滚动 | +| MIDDLE_BTN_NORTH_SOUTH | 33 | 向北南滚动 | +| MIDDLE_BTN_NORTH_EAST | 34 | 向东北滚动 | +| MIDDLE_BTN_NORTH_WEST | 35 | 向西北滚动 | +| MIDDLE_BTN_SOUTH_EAST | 36 | 向东南滚动 | +| MIDDLE_BTN_SOUTH_WEST | 37 | 向西南滚动 | +| MIDDLE_BTN_NORTH_SOUTH_WEST_EAST | 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 index 15e4cc7262a1a7c1d946e26a199c1b6fe7609d94..8f719085f401a7a40a0b9c3b1a67b8663fcccebf 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-window.md +++ b/zh-cn/application-dev/reference/apis/js-apis-window.md @@ -224,7 +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 | +| id9+ | number | 是 | 是 | 窗口ID。 | ## ColorSpace8+