!8798 鼠标样式和鼠标速度以及窗口id

Merge pull request !8798 from mayunteng/master

zh-cn/application-dev/reference/apis/js-apis-pointer.md

@@ -12,11 +12,11 @@
 import pointer from '@ohos.multimodalInput.pointer';
 ```
 
-## pointer.setPointerVisibele
+## pointer.setPointerVisibele<sup>9+</sup>
 
 setPointerVisible(visible: boolean, callback: AsyncCallback&lt;void&gt;): void
 
-设置鼠标指针显示或者隐藏，使用callback方式作为异步方法。
+设置鼠标指针显示或者隐藏，使用callback异步回调。
 
 **系统能力**：SystemCapability.MultimodalInput.Input.Pointer
 
@@ -25,21 +25,21 @@ setPointerVisible(visible: boolean, callback: AsyncCallback&lt;void&gt;): void
 | 参数     | 类型                      | 必填 | 说明                                                                |
 | -------- | ------------------------- | ---- | ------------------------------------------------------------------- |
 | visible  | boolean                   | 是   | 鼠标指针显示或者隐藏状态，true: 鼠标指针显示; false: 鼠标指针隐藏。 |
-| callback | AysncCallback&lt;void&gt; | 是   | 回调函数，异步返回查询结果。                                        |
+| callback | AysncCallback&lt;void&gt; | 是   | 回调函数。当设置鼠标显示或隐藏成功，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.setPointerVisible<sup>9+</sup>
 
 setPointerVisible(visible: boolean): Promise&lt;void&gt;
 
@@ -62,18 +62,18 @@ setPointerVisible(visible: boolean): Promise&lt;void&gt;
 **示例**：
 
 ```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.isPointerVisible<sup>9+</sup>
 
 isPointerVisible(callback: AsyncCallback&lt;boolean&gt;): void
 
-获取鼠标指针显示或隐藏状态，使用callback方式作为异步方法。
+获取鼠标指针显示或隐藏状态，使用callback异步回调。
 
 **系统能力**：SystemCapability.MultimodalInput.Input.Pointer
 
@@ -87,11 +87,11 @@ isPointerVisible(callback: AsyncCallback&lt;boolean&gt;): 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.isPointerVisible<sup>9+</sup>
 
 isPointerVisible(): Promise&lt;boolean&gt;
 
@@ -109,6 +109,285 @@ isPointerVisible(): Promise&lt;boolean&gt;
 
 ```js
 pointer.isPointerVisible().then( data => {
-    console.log(`isPointerThen success data=${JSON.stringify(data)}`);
+  console.log(`isPointerThen success data=${JSON.stringify(data)}`);
 });
 ```
+
+## pointer.setPointerSpeed<sup>9+</sup>
+
+setPointerSpeed(speed: number, callback: AsyncCallback&lt;void&gt;): void
+
+设置鼠标移动速度，使用callback异步回调。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**参数**：
+
+| 参数     | 类型                      | 必填 | 说明                                                                |
+| -------- | ------------------------- | ---- | ------------------------------------------------------------------- |
+| speed  | number                   | 是   | 鼠标移动速度设置挡位值1-11，最大值：11，最小值：1，标准值：5。           |
+| callback | AysncCallback&lt;void&gt; | 是   | 回调函数。当设置鼠标速度成功，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.`);
+);
+```
+
+## pointer.setPointerSpeed<sup>9+</sup>
+
+setPointerSpeed(speed: number): Promise&lt;void&gt;
+
+设置鼠标移动速度，使用Promise异步回调。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**参数**：
+
+| 参数    | 类型    | 必填 | 说明                                                                |
+| ------- | ------- | ---- | ------------------------------------------------------------------- |
+| speed | number | 是   | 鼠标移动速度设置挡位值1-11，最大值：11，最小值：1，标准值：5。           |
+
+**返回值**：
+
+| 参数                | 说明                            |
+| ------------------- | ------------------------------- |
+| Promise&lt;void&gt; | 无返回结果的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.getPointerSpeed<sup>9+</sup>
+
+getPointerSpeed(callback: AsyncCallback&lt;number&gt;): void
+
+获取当前鼠标移动速度，使用callback异步回调。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**参数**：
+
+| 参数     | 类型                         | 必填 | 说明                         |
+| -------- | ---------------------------- | ---- | ---------------------------- |
+| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数，异步返回查询结果。 |
+
+**示例**：
+
+```js
+pointer.getPointerSpeed((speed)=>{
+  console.log("The pointer speed is " + speed);
+});
+```
+
+## pointer.getPointerSpeed<sup>9+</sup>
+
+getPointerSpeed(): Promise&lt;number&gt;
+
+获取当前鼠标移动速度，使用Promise异步回调。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**返回值**：
+
+| 参数                   | 说明                            |
+| ---------------------- | ------------------------------- |
+| Promise&lt;number&gt; | Promise实例，用于异步获取结果。 |
+
+**示例**：
+
+```js
+pointer.getPointerSpeed().then( data => {
+  console.log(`getPointerSpeed success data=${JSON.stringify(data)}`);
+});
+```
+
+## pointer.getPointerStyle<sup>9+</sup>
+
+getPointerStyle(windowId: number, callback: AsyncCallback&lt;PointerStyle&gt;): void
+
+获取鼠标样式类型，使用callback异步回调。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**参数**：
+
+| 参数     | 类型                                    | 必填   | 说明                              |
+| -------- | ---------------------------------------- | ---- | --------------------------------- |
+| windowId | number                                   | 是    | 输入设备的窗口id。 |
+| callback | AsyncCallback&lt;[PointerStyle](#pointerstyle9)&gt; | 是 | 回调函数，异步返回查询结果。|
+
+**示例**：
+
+```js
+// 获取设备的鼠标样式。
+import window from '@ohos.window';
+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);
+    });
+  });
+});
+```
+
+## pointer.getPointerStyle<sup>9+</sup>
+
+getPointerStyle(windowId: number): Promise&lt;PointerStyle&gt;
+
+获取鼠标样式类型，使用Promise方式作为异步方法。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**参数**：
+
+| 参数     | 说明                              |
+| -------- | --------------------------------- |
+| Promise&lt;[PointerStyle](#pointerstyle9)&gt; |Promise实例，用于异步获取结果。|
+
+
+**示例**：
+
+```js
+// 获取设备的鼠标样式。
+import window from '@ohos.window';
+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);
+    });
+  });
+});
+```
+
+## pointer.setPointerStyle<sup>9+</sup>
+
+setPointerStyle(windowId: number, pointerStyle: PointerStyle, callback: AsyncCallback&lt;void&gt;): void
+
+设置鼠标的样式类型，使用callback异步回调。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**参数**：
+
+| 参数     | 类型                                     | 必填   | 说明                              |
+| -------- | ----------------------------------------| ---- | --------------------------------- |
+| windowId | number                                  | 是    | 输入设备的窗口id。 |
+| pointerStyle | [PointerStyle](#pointerstyle9)      | 是    | 鼠标样式id。 |
+| callback | AysncCallback&lt;void&gt; | 是   | 回调函数。当设置样式成功，err为undefined，否则为错误对象。|
+
+**示例**：
+
+```js
+// 设置设备的鼠标样式。
+import window from '@ohos.window';
+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.setPointerStyle<sup>9+</sup>
+
+setPointerStyle(windowId: number, pointerStyle: PointerStyle): Promise&lt;void&gt;
+
+设置鼠标的样式类型，使用Promise方式作为异步方法。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**参数**：
+
+| 参数     | 类型                                     | 必填   | 说明                              |
+| -------- | ---------------------------------------- | ---- | --------------------------------- |
+| windowId | number                                   | 是    | 输入设备的窗口id。                   |
+| pointerStyle | [PointerStyle](#pointerstyle9)       | 是    | 鼠标样式id。                         |
+| Promise&lt;void&gt; | void | 是    |无返回结果的Promise对象。  |
+
+**示例**：
+
+```js
+// 设置设备的鼠标样式。
+import window from '@ohos.window';
+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`);
+    });
+  });
+});
+```
+## PointerStyle<sup>9+</sup>
+
+定义鼠标样式类型。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+| 名称                     | 值    | 说明        |
+| ------------------- | ---- | --------- |
+| 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    | 四向锥形移动 |
+
+

zh-cn/application-dev/reference/apis/js-apis-window.md

@@ -224,6 +224,7 @@ import window from '@ohos.window';
 | isPrivacyMode<sup>7+</sup>            | boolean                   | 是   | 是   | 隐私模式，默认为false。                                      |
 | isRoundCorner<sup>(deprecated)</sup>  | boolean                   | 是   | 是   | 窗口是否为圆角。默认为false。<br>- **说明：** 从API version 9开始废弃。<br/>- 从 API version 7开始支持 |
 | isTransparent<sup>7+</sup>            | boolean                   | 是   | 是   | 窗口是否透明。默认为false。                                  |
+| id<sup>9+</sup>                       | number                    | 是   | 否   | 窗口ID，默认值为0.0。                                                  |
 
 ## ColorSpace<sup>8+</sup>