Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 d617d481 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!19560 mmi_set_touchpad_api_docs 

Merge pull request !19560 from xixian/master
上级 b6e7c063 30a8bb41
显示空白变更内容
内联 并排
Showing with 493 addition and 1 deletion
zh-cn/application-dev/reference/apis/js-apis-pointer.md
浏览文件 @ d617d481
......@@ -853,3 +853,495 @@ window.getLastWindow(this.context, (error, win) => {
| HORIZONTAL_TEXT_CURSOR | 39 | 垂直文本选择 |![Horizontal_Text_Cursor.png](./figures/Horizontal_Text_Cursor.png)|
| CURSOR_CROSS | 40 | 十字光标 |![Cursor_Cross.png](./figures/Cursor_Cross.png)|
| CURSOR_CIRCLE | 41 | 圆形光标 |![Cursor_Circle.png](./figures/Cursor_Circle.png)|
## pointer.setTouchpadScrollSwitch<sup>10+</sup>
setTouchpadScrollSwitch(state: boolean, callback: AsyncCallback\<void>): void
设置触控板滚轴开关，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------- |
| state | boolean | 是 | 滚轴开关开启的状态，true代表开启，false代表关闭，默认为开启 |
| callback | AsyncCallback\<void> | 是 | 回调函数。 |
**示例**：
```js
try {
pointer.setTouchpadScrollSwitch(true, (error) => {
if (error) {
console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`setTouchpadScrollSwitch success`);
});
} catch (error) {
console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadScrollSwitch<sup>10+</sup>
setTouchpadScrollSwitch(state: boolean): Promise\<void>
设置触控板滚轴开关，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| state | boolean| 是 | 滚轴开关开启的状态，true代表开启，false代表关闭，默认为开启 |
**返回值**：
| 参数 | 说明 |
| ------------------- | ---------------- |
| Promise\<void> | Promise对象。 |
**示例**：
```js
try {
pointer.setTouchpadScrollSwitch(false).then(() => {
console.log(`setTouchpadScrollSwitch success`);
});
} catch (error) {
console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadScrollSwitch<sup>10+</sup>
getTouchpadScrollSwitch(callback: AsyncCallback\<boolean>): void
获取触控板滚轴能力开启状态，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------- |
| callback | AsyncCallback\<boolean> | 是 | 回调函数，异步返回触控板滚轴能力开启状态。 |
**示例**：
```js
try {
pointer.getTouchpadScrollSwitch ((error, state) => {
console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadScrollSwitch<sup>10+</sup>
getTouchpadScrollSwitch(): Promise\<boolean>
获取触控板滚轴能力开启状态，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**返回值**：
| 参数 | 说明 |
| --------------------- | ------------------- |
| Promise\<boolean> | Promise实例，异步返回触控板滚轴能力开启状态。 |
**示例**：
```js
try {
pointer.getTouchpadScrollSwitch().then((state) => {
console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadScrollDirection<sup>10+</sup>
setTouchpadScrollDirection(state: boolean, callback: AsyncCallback\<void>): void
设置触控板滚轴的方向，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------- |
| state | boolean | 是 | state为触控板滚轴的方向。true与手指滑动的方向一致，false与手指滑动的方向相反，默认为true。 |
| callback | AsyncCallback\<void> | 是 | 回调函数。 |
**示例**：
```js
try {
pointer.setTouchpadScrollDirection(true, (error) => {
if (error) {
console.log(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`setTouchpadScrollDirection success`);
});
} catch (error) {
console.log(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadScrollDirection<sup>10+</sup>
setTouchpadScrollDirection(state: boolean): Promise\<void>
设置触控板滚轴的方向，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| state | boolean| 是 | state为触控板滚轴的方向。true与手指滑动的方向一致，false与手指滑动的方向相反，默认为true。 |
**返回值**：
| 参数 | 说明 |
| ------------------- | ---------------- |
| Promise\<void> | Promise对象。 |
**示例**：
```js
try {
pointer.setTouchpadScrollDirection (false).then(() => {
console.log(`setTouchpadScrollDirection success`);
});
} catch (error) {
console.log(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadScrollDirection<sup>10+</sup>
getTouchpadScrollDirection(callback: AsyncCallback\<boolean>): void
获取触控板滚轴方向，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------- |
| callback | AsyncCallback\<boolean> | 是 | 回调函数，异步返回触控板滚轴方向。 |
**示例**：
```js
try {
pointer.getTouchpadScrollSwitch ((error, state) => {
console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadScrollDirection<sup>10+</sup>
getTouchpadScrollDirection(): Promise\<boolean>
获取触控板滚轴方向，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**返回值**：
| 参数 | 说明 |
| --------------------- | ------------------- |
| Promise\<boolean> | Promise实例，异步返回触控板滚轴方向。 |
**示例**：
```js
try {
pointer.getTouchpadScrollDirection().then((state) => {
console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadTapSwitch<sup>10+</sup>
setTouchpadTapSwitch(state: boolean, callback: AsyncCallback\<void>): void
设置触控板轻触功能开关，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------- |
| state | boolean | 是 |触控板轻触功能开关开启状态。 true代表轻触开启，false代表轻触关闭，默认开启。 |
| callback | AsyncCallback\<void> | 是 | 回调函数。 |
**示例**：
```js
try {
pointer.setTouchpadTapSwitch(true, (error) => {
if (error) {
console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`setTouchpadTapSwitch success`);
});
} catch (error) {
console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadTapSwitch <sup>10+</sup>
setTouchpadTapSwitch(state: boolean): Promise\<void>
设置触控板轻触功能开关，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| state | boolean| 是 | 触控板轻触功能开关开启状态。 true代表轻触开启，false代表轻触关闭，默认开启。 |
**返回值**：
| 参数 | 说明 |
| ------------------- | ---------------- |
| Promise\<void> | Promise对象。 |
**示例**：
```js
try {
pointer.setTouchpadTapSwitch(false).then(() => {
console.log(`setTouchpadTapSwitch success`);
});
} catch (error) {
console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadTapSwitch<sup>10+</sup>
getTouchpadTapSwitch(callback: AsyncCallback\<boolean>): void
获取触控板轻触能力开启状态，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------- |
| callback | AsyncCallback\<boolean> | 是 | 回调函数，异步返回触控板轻触功能开启状态。 |
**示例**：
```js
try {
pointer.getTouchpadTapSwitch((error, state) => {
console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadTapSwitch<sup>10+</sup>
getTouchpadTapSwitch(): Promise\<boolean>
获取触控板轻触功能开启状态，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**返回值**：
| 参数 | 说明 |
| --------------------- | ------------------- |
| Promise\<boolean> | Promise实例，异步返回触控板轻触功能开启状态。 |
**示例**：
```js
try {
pointer.getTouchpadTapSwitch().then((state) => {
console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadPointerSpeed<sup>10+</sup>
setTouchpadPointerSpeed(speed: number, callback: AsyncCallback\<void>): void
设置触控板光标移动速度，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------- |
| speed | number | 是 |speed代表光标移动速度。speed取值范围[1,11]，默认5。 |
| callback | AsyncCallback\<void> | 是 | 回调函数。 |
**示例**：
```js
try {
pointer.setTouchpadPointerSpeed(1, (error) => {
if (error) {
console.log(`setTouchpadPointerSpeedfailed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`setTouchpadPointerSpeed success`);
});
} catch (error) {
console.log(`setTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadPointerSpeed<sup>10+</sup>
setTouchpadPointerSpeed(speed: number): Promise\<void>
设置触控板光标移动速度，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| speed| number | 是 | speed代表光标移动速度。speed取值范围[1,11]，默认5。 |
**返回值**：
| 参数 | 说明 |
| ------------------- | ---------------- |
| Promise\<void> | Promise对象。 |
**示例**：
```js
try {
pointer.setTouchpadPointerSpeed(10).then(() => {
console.log(`setTouchpadPointerSpeed success`);
});
} catch (error) {
console.log(`setTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadPointerSpeed<sup>10+</sup>
getTouchpadPointerSpeed(callback: AsyncCallback\<number>): void
获取触控板光标移动速度，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------- |
| callback | AsyncCallback\<number> | 是 | 回调函数，异步返回触控板光标移动速度。 |
**示例**：
```js
try {
pointer.getTouchpadPointerSpeed((error, speed) => {
console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`);
});
} catch (error) {
console.log(`getTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadPointerSpeed<sup>10+</sup>
getTouchpadPointerSpeed(): Promise\<number>
获取触控板光标移动速度，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**返回值**：
| 参数 | 说明 |
| --------------------- | ------------------- |
| Promise\<number> | Promise实例，异步返回触控板光标移动速度。 |
**示例**：
```js
try {
pointer.getTouchpadPointerSpeed().then((speed) => {
console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`);
});
} catch (error) {
console.log(`getTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或