From bed08f8db33e5d83d5162b113554fe210622be8f Mon Sep 17 00:00:00 2001 From: liuwei Date: Mon, 8 Aug 2022 14:53:09 +0800 Subject: [PATCH] add pointer md Signed-off-by: liuwei Change-Id: I7f013c0551376814e40c7999bde668f9d08ef1b0 --- .../reference/apis/js-apis-pointer.md | 114 ++++++++++++++++++ 1 file changed, 114 insertions(+) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-pointer.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 new file mode 100644 index 0000000000..79b22d4d8c --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-pointer.md @@ -0,0 +1,114 @@ +# 鼠标指针 + +鼠标指针管理模块,用于提供鼠标指针相关属性接口。 + +> **说明**: +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```js +import pointer from '@ohos.multimodalInput.pointer'; +``` + +## pointer.setPointerVisibele ``9+`` + +setPointerVisible(visible: boolean, callback: AsyncCallback<void>): void; + +设置鼠标指针显示或者隐藏,使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**参数**: + +| 参数 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ----------------------------------------- | +| visible | boolean | 是 | true: 鼠标指针显示; false: 鼠标指针隐藏。 | +| callback | AysncCallback<void> | 是 | 回调函数,异步返回查询结果。 | + +**示例**: + +```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.`); +); +``` + +## pointer.setPointerVisible ``9+`` + +setPointerVisible(visible: boolean) : Promise<void>; + +设置鼠标指针显示或者隐藏,使用Promise方式作为异步方法。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**参数**: + +| 参数 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | ----------------------------------------- | +| visible | boolean | 是 | true: 鼠标指针显示; false: 鼠标指针隐藏。 | + +**返回值**: + +| 参数 | 说明 | +| ------------------- | ------------------------------- | +| Promise<void> | Promise实例,用于异步获取结果。 | + +**示例**: + +```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.isPointerVisible + +isPointerVisible(callback: AsyncCallback<boolean>) : void; + +获取鼠标指针是否显示,使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**参数**: + +| 参数 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | ---------------------------- | +| callback | AsyncCallback<boolean> | 是 | 回调函数,异步返回查询结果。 | + +**示例**: + +```js +pointer.isPointerVisible((visible)=>{ + console.log("The mouse pointer visible attributes is " + visible); +}); +``` + +## pointer.isPointerVisible + +isPointerVisible(): Promise<boolean> + +获取鼠标指针是否显示,使用Promise方式作为异步方法。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**返回值**: + +| 参数 | 说明 | +| ---------------------- | ------------------------------- | +| Promise<boolean> | Promise实例,用于异步获取结果。 | + +**示例**: + +```js +pointer.isPointerVisible().then( data => { + console.log(`isPointerThen success data=${JSON.stringify(data)}`); +}); +``` -- GitLab