Skip to content

D
Docs

OpenHarmony / Docs
8 个月 前同步成功

通知 158
Star 292
Fork 28
D
Docs

前往新版Gitcode，体验更适合开发者的 AI 搜索 >>

提交 f12046ff 编写于 作者: X xixian_2023
浏览文件
操作

mmi_set_pointer_sizecolor_docs 

Signed-off-by:xixian_2023<xixian@huawei.com>
上级 146ec537
隐藏空白更改
内联 并排
Showing with 354 addition and 0 deletion
zh-cn/application-dev/reference/apis/js-apis-pointer.md
浏览文件 @ f12046ff
......@@ -1725,4 +1725,358 @@ try {
} catch (error) {
console.log(`getTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setPointerSize<sup>10+</sup>
setPointerSize(size: number, callback: AsyncCallback&lt;void&gt;): void
设置鼠标光标大小，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------- |
| size | number | 是 | 鼠标光标大小，范围为[1-7]，默认为1。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，当设置成功时，err为undefined，否则为错误对象。 |
**示例**：
```js
try {
pointer.setPointerSize(1, (error) => {
if (error) {
console.log(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`setPointerSize success`);
});
} catch (error) {
console.log(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setPointerSize<sup>10+</sup>
setPointerSize(size: number): Promise&lt;void&gt;
设置鼠标光标大小，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| size | number | 是 | 鼠标光标大小，范围为[1-7]，默认为1。 |
**返回值**：
| 参数 | 说明 |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例**：
```js
try {
pointer.setPointerSize(3).then(() => {
console.log(`setPointerSize success`);
});
} catch (error) {
console.log(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setPointerSizeSync<sup>10+</sup>
setPointerSizeSync(size: number): void;
设置鼠标光标大小，使用同步方式进行设置。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| size | number | 是 | 鼠标光标大小，范围为[1-7]，默认为1。 |
**示例**：
```js
try {
pointer.setPointerSizeSync(5);
console.log(`setPointerSizeSync success`);
} catch (error) {
console.log(`setPointerSizeSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getPointerSize<sup>10+</sup>
getPointerSize(callback: AsyncCallback&lt;number&gt;): void
获取鼠标光标大小，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，异步返回鼠标光标大小。 |
**示例**：
```js
try {
pointer.getPointerSize((error, size) => {
console.log(`getPointerSize success, size: ${JSON.stringify(size)}`);
});
} catch (error) {
console.log(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getPointerSize<sup>10+</sup>
getPointerSize(): Promise&lt;number&gt;
获取当前鼠标光标大小，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**返回值**：
| 参数 | 说明 |
| --------------------- | ------------------- |
| Promise&lt;number&gt; | Promise对象，异步返回鼠标光标大小。 |
**示例**：
```js
try {
pointer.getPointerSize().then((size) => {
console.log(`getPointerSize success, size: ${JSON.stringify(size)}`);
});
} catch (error) {
console.log(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getPointerSizeSync<sup>10+</sup>
getPointerSizeSync(): number
获取鼠标光标大小，使用同步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**返回值**：
| 参数 | 说明 |
| --------------------- | ------------------- |
| number | 鼠标光标大小。 |
**示例**：
```js
try {
let pointerSize = pointer.getPointerSizeSync();
console.log(`getPointerSizeSync success, pointerSize: ${JSON.stringify(pointerSize)}`);
} catch (error) {
console.log(`getPointerSizeSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setPointerColor<sup>10+</sup>
setPointerColor(color: number, callback: AsyncCallback&lt;void&gt;): void
设置鼠标光标颜色，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------- |
| color | number | 是 | 鼠标光标颜色，默认为黑色：0x000000。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，当设置成功时，err为undefined，否则为错误对象。 |
**示例**：
```js
try {
pointer.setPointerColor(0xF6C800, (error) => {
if (error) {
console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`setPointerColor success`);
});
} catch (error) {
console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setPointerColor<sup>10+</sup>
setPointerColor(color: number): Promise&lt;void&gt;
设置鼠标光标颜色，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| color | number | 是 | 鼠标光标颜色，默认为黑色：0x000000。 |
**返回值**：
| 参数 | 说明 |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例**：
```js
try {
pointer.setPointerColor(0xF6C800).then(() => {
console.log(`setPointerColor success`);
});
} catch (error) {
console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.setPointerColorSync<sup>10+</sup>
setPointerColorSync(color: number): void;
设置鼠标光标颜色，使用同步方式进行设置。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------- |
| color | number | 是 | 鼠标光标颜色，默认为黑色：0x000000。 |
**示例**：
```js
try {
pointer.setPointerColorSync(0xF6C800);
console.log(`setPointerColorSync success`);
} catch (error) {
console.log(`setPointerColorSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getPointerColor<sup>10+</sup>
getPointerColor(callback: AsyncCallback&lt;number&gt;): void
获取鼠标光标颜色，使用AsyncCallback异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，异步返回鼠标光标颜色。 |
**示例**：
```js
try {
pointer.getPointerColor((error, color) => {
console.log(`getPointerColor success, color: ${JSON.stringify(color)}`);
});
} catch (error) {
console.log(`getPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getPointerColor<sup>10+</sup>
getPointerColor(): Promise&lt;number&gt;
获取当前鼠标光标颜色，使用Promise异步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**返回值**：
| 参数 | 说明 |
| --------------------- | ------------------- |
| Promise&lt;number&gt; | Promise对象，异步返回鼠标光标颜色。 |
**示例**：
```js
try {
pointer.getPointerColor().then((color) => {
console.log(`getPointerColor success, color: ${JSON.stringify(color)}`);
});
} catch (error) {
console.log(`getPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## pointer.getPointerColorSync<sup>10+</sup>
getPointerColorSync(): number
获取鼠标光标颜色，使用同步方式返回结果。
**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
**系统API**: 此接口为系统接口。
**返回值**：
| 参数 | 说明 |
| --------------------- | ------------------- |
| number | 鼠标光标颜色。 |
**示例**：
```js
try {
let pointerColor = pointer.getPointerColorSync();
console.log(`getPointerColorSync success, pointerColor: ${JSON.stringify(pointerColor)}`);
} catch (error) {
console.log(`getPointerColorSync 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.
先完成此消息的编辑！
想要评论请 注册 或