Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

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

!20133 mmi_touchpad_set_docs_0626 

Merge pull request !20133 from xixian/master
上级 75ec36c4 00625c52
显示空白变更内容
内联 并排
Showing with 381 addition and 0 deletion
zh-cn/application-dev/reference/apis/js-apis-pointer.md
浏览文件 @ 25eac07e
......@@ -1345,3 +1345,384 @@ try {
console.log(`getTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadPinchSwitch<sup>10+</sup>
setTouchpadPinchSwitch(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(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`setTouchpadPinchSwitch success`);
});
} catch (error) {
console.log(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadPinchSwitch<sup>10+</sup>
setTouchpadPinchSwitch(state: boolean): Promise\<void>
设置触控板双指捏合功能开关，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| state | boolean| 是 | 触控板双指捏合功能开关开启状态。 true代表开启，false代表关闭，默认开启。 |
**返回值**：
| 参数 | 说明 |
| ------------------- | ---------------- |
| Promise\<void> | Promise对象。 |
**示例**：
```js
try {
pointer.setTouchpadPinchSwitch(false).then(() => {
console.log(`setTouchpadPinchSwitch success`);
});
} catch (error) {
console.log(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadPinchSwitch<sup>10+</sup>
getTouchpadPinchSwitch(callback: AsyncCallback\<boolean>): void
获取触控板双指捏合功能开启状态，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------- |
| callback | AsyncCallback\<boolean> | 是 | 回调函数，异步返回触控板双指捏合功能开启状态。 |
**示例**：
```js
try {
pointer.getTouchpadPinchSwitch((error, state) => {
console.log(`getTouchpadPinchSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadPinchSwitch<sup>10+</sup>
getTouchpadPinchSwitch(): Promise\<boolean>
获取触控板双指捏合功能开启状态，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**返回值**：
| 参数 | 说明 |
| --------------------- | ------------------- |
| Promise\<boolean> | Promise实例，异步返回触控板双指捏合功能开启状态。 |
**示例**：
```js
try {
pointer.getTouchpadPinchSwitch().then((state) => {
console.log(`getTouchpadPinchSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadSwipeSwitch<sup>10+</sup>
setTouchpadSwipeSwitch(state: boolean, callback: AsyncCallback\<void>): void
设置触控板多指滑动功能开关，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------- |
| state | boolean | 是 |触控板多指滑动开关开启状态。 true代表多指滑动开启，false代表多指滑动关闭，默认开启。 |
| callback | AsyncCallback\<void> | 是 | 回调函数。 |
**示例**：
```js
try {
pointer.setTouchpadSwipeSwitch(true, (error) => {
if (error) {
console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`setTouchpadSwipeSwitch success`);
});
} catch (error) {
console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadSwipeSwitch<sup>10+</sup>
setTouchpadSwipeSwitch(state: boolean): Promise\<void>
设置触控板多指滑动功能开关，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| state | boolean| 是 | 触控板多指滑动功能开关开启状态。 true代表多指滑动开启，false代表多指滑动关闭，默认开启。 |
**返回值**：
| 参数 | 说明 |
| ------------------- | ---------------- |
| Promise\<void> | Promise对象。 |
**示例**：
```js
try {
pointer.setTouchpadSwipeSwitch(false).then(() => {
console.log(`setTouchpadSwipeSwitch success`);
});
} catch (error) {
console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadSwipeSwitch<sup>10+</sup>
getTouchpadSwipeSwitch(callback: AsyncCallback\<boolean>): void
获取触控板多指滑动功能开启状态，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------- |
| callback | AsyncCallback\<boolean> | 是 | 回调函数，异步返回触控板多指滑动功能开启状态。 |
**示例**：
```js
try {
pointer.getTouchpadSwipeSwitch((error, state) => {
console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadSwipeSwitch<sup>10+</sup>
getTouchpadSwipeSwitch(): Promise\<boolean>
获取触控板多指滑动功能开启状态，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**返回值**：
| 参数 | 说明 |
| --------------------- | ------------------- |
| Promise\<boolean> | Promise实例，异步返回触控板多指滑动功能开启状态。 |
**示例**：
```js
try {
pointer.getTouchpadSwipeSwitch().then((state) => {
console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## RightClickType<sup>10+</sup>
右键菜单触发方式。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
| 名称 | 值 | 说明 |
| -------------------------------- | ---- | ------ |
| TOUCHPAD_RIGHT_BUTTON | 1 |触控板右键区域。 |
| TOUCHPAD_LEFT_BUTTON | 2 |触控板左键区域。 |
| TOUCHPAD_TWO_FINGER_TAP | 3 |双指轻击或按压触控板。|
## pointer.setTouchpadRightClickType<sup>10+</sup>
setTouchpadRightClickType(type: RightClickType, callback: AsyncCallback\<void>): void
设置触控板右键菜单类型，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------- |
| type| RightClickType| 是 |type代表触控板右键菜单类型。<br>- TOUCHPAD_RIGHT_BUTTON：触控板右键区域。<br>- TOUCHPAD_LEFT_BUTTON：触控板左键区域。<br>- TOUCHPAD_TWO_FINGER_TAP：双指轻击或按压触控板。<br>默认为TOUCHPAD_RIGHT_BUTTON 。 |
| callback | AsyncCallback\<void> | 是 | 回调函数。 |
**示例**：
```js
try {
pointer.setTouchpadRightClickType(RightClickType::TOUCHPAD_RIGHT_BUTTON , (error) => {
if (error) {
console.log(`setTouchpadRightClickType, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`setTouchpadRightClickType success`);
});
} catch (error) {
console.log(`setTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setTouchpadRightClickType<sup>10+</sup>
setTouchpadRightClickType(type: RightClickType): Promise\<void>
设置触控板右键菜单类型，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| type| RightClickType| 是 | type代表触控板右键菜单类型。<br>- TOUCHPAD_RIGHT_BUTTON：触控板右键区域。<br>- TOUCHPAD_LEFT_BUTTON：触控板左键区域。<br>- TOUCHPAD_TWO_FINGER_TAP：双指轻击或按压触控板。<br>默认为TOUCHPAD_RIGHT_BUTTON 。 |
**返回值**：
| 参数 | 说明 |
| ------------------- | ---------------- |
| Promise\<void> | Promise对象。 |
**示例**：
```js
try {
pointer.setTouchpadRightClickType(RightClickType::TOUCHPAD_RIGHT_BUTTON ).then(() => {
console.log(`setTouchpadRightClickType success`);
});
} catch (error) {
console.log(`setTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadRightClickType<sup>10+</sup>
getTouchpadRightClickType(callback: AsyncCallback\<RightClickType>): void
获取触控板右键菜单类型，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------- |
| callback | AsyncCallback\<RightClickType> | 是 | 回调函数，异步返回触控板右键菜单类型。 |
**示例**：
```js
try {
pointer.getTouchpadRightClickType((error, type) => {
console.log(`getTouchpadRightClickType success, type: ${JSON.stringify(type)}`);
});
} catch (error) {
console.log(`getTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getTouchpadRightClickType<sup>10+</sup>
getTouchpadRightClickType(): Promise\<RightClickType>
获取触控板右键菜单类型，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**返回值**：
| 参数 | 说明 |
| --------------------- | ------------------- |
| Promise\<RightClickType > | Promise实例，异步返回触控板右键菜单类型。 |
**示例**：
```js
try {
pointer.getTouchpadRightClickType().then((type) => {
console.log(`getTouchpadRightClickType success, typeed: ${JSON.stringify(type)}`);
});
} catch (error) {
console.log(`getTouchpadRightClickType 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.
先完成此消息的编辑！
想要评论请 注册 或