harmony 鸿蒙@ohos.multimodalInput.pointer (Mouse Pointer)
@ohos.multimodalInput.pointer (Mouse Pointer)
The pointer module provides APIs related to pointer attribute management.
NOTE
The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import pointer from '@ohos.multimodalInput.pointer';
pointer.setPointerVisible9+
setPointerVisible(visible: boolean, callback: AsyncCallback<void>): void
Sets the visible status of the mouse pointer. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
visible | boolean | Yes | Whether the mouse pointer is visible. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setPointerVisible(true, (error: Error) => {
if (error) {
console.log(`Set pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`Set pointer visible success`);
});
} catch (error) {
console.log(`Set pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setPointerVisible9+
setPointerVisible(visible: boolean): Promise<void>
Sets the visible status of the mouse pointer. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
visible | boolean | Yes | Whether the mouse pointer is visible. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setPointerVisible(false).then(() => {
console.log(`Set pointer visible success`);
});
} catch (error) {
console.log(`Set pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setPointerVisibleSync10+
setPointerVisibleSync(visible: boolean): void
Sets the visible status of the mouse pointer. This API returns the result synchronously.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
visible | boolean | Yes | Whether the mouse pointer is visible. The value true indicates that the mouse pointer is visible, and the value false indicates the opposite. |
Example
try {
pointer.setPointerVisibleSync(false)
console.log(`Set pointer visible success`)
} catch (error) {
console.log(`Set pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`)
}
pointer.isPointerVisible9+
isPointerVisible(callback: AsyncCallback<boolean>): void
Checks the visible status of the mouse pointer. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
Example
try {
pointer.isPointerVisible((error: Error, visible: Boolean) => {
if (error) {
console.log(`Get pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`Get pointer visible success, visible: ${JSON.stringify(visible)}`);
});
} catch (error) {
console.log(`Get pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.isPointerVisible9+
isPointerVisible(): Promise<boolean>
Checks the visible status of the mouse pointer. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Return value
Name | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
try {
pointer.isPointerVisible().then((visible: Boolean) => {
console.log(`Get pointer visible success, visible: ${JSON.stringify(visible)}`);
});
} catch (error) {
console.log(`Get pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.isPointerVisibleSync10+
isPointerVisibleSync(): boolean
Obtains the visible status of the mouse pointer. This API returns the result synchronously.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Return value
Name | Description |
---|---|
boolean | Visible status of the mouse pointer. |
Example
try {
let visible: boolean = pointer.isPointerVisibleSync()
console.log(`Get pointer visible success, visible: ${JSON.stringify(visible)}`)
} catch (error) {
console.log(`Get pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`)
}
pointer.setPointerSpeed9+
setPointerSpeed(speed: number, callback: AsyncCallback<void>): void
Sets the moving speed of the mouse pointer. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
speed | number | Yes | Moving speed of the mouse pointer. The value ranges from 1 to 11. The default value is 5. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setPointerSpeed(5, (error: Error) => {
if (error) {
console.log(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`Set pointer speed success`);
});
} catch (error) {
console.log(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setPointerSpeed9+
setPointerSpeed(speed: number): Promise<void>
Sets the moving speed of the mouse pointer. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
speed | number | Yes | Moving speed of the mouse pointer. The value ranges from 1 to 11. The default value is 5. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setPointerSpeed(5).then(() => {
console.log(`Set pointer speed success`);
});
} catch (error) {
console.log(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setPointerSpeedSync10+
setPointerSpeedSync(speed: number): void
Sets the moving speed of the mouse pointer. This API returns the result synchronously.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
speed | number | Yes | Moving speed of the mouse pointer. The value ranges from 1 to 11. The default value is 5. |
Example
try {
let speed = pointer.setPointerSpeedSync(5);
console.log(`Set pointer speed success`);
} catch (error) {
console.log(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getPointerSpeed9+
getPointerSpeed(callback: AsyncCallback<number>): void
Obtains the moving speed of the mouse pointer. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<number> | Yes | Callback used to return the result. |
Example
try {
pointer.getPointerSpeed((error: Error, speed: Number) => {
if (error) {
console.log(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`Get pointer speed success, speed: ${JSON.stringify(speed)}`);
});
} catch (error) {
console.log(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getPointerSpeed9+
getPointerSpeed(): Promise<number>
Obtains the moving speed of the mouse pointer. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<number> | Promise used to return the result. |
Example
try {
pointer.getPointerSpeed().then(speed => {
console.log(`Get pointer speed success, speed: ${JSON.stringify(speed)}`);
});
} catch (error) {
console.log(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getPointerSpeedSync10+
getPointerSpeedSync(): number
Obtains the moving speed of the mouse pointer. This API returns the result synchronously.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
number | Moving speed of the mouse pointer. |
Example
try {
let speed = pointer.getPointerSpeedSync();
console.log(`Get pointer speed success, speed: ${JSON.stringify(speed)}`);
} catch (error) {
console.log(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setHoverScrollState10+
setHoverScrollState(state: boolean, callback: AsyncCallback<void>): void
Sets the status of the mouse hover scroll switch. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Status of the mouse hover scroll switch. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setHoverScrollState(true, (error: Error) => {
if (error) {
console.log(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`Set the mouse hover scroll success`);
});
} catch (error) {
console.log(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setHoverScrollState10+
setHoverScrollState(state: boolean): Promise<void>
Sets the status of the mouse hover scroll switch. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Status of the mouse hover scroll switch. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setHoverScrollState(true).then(() => {
console.log(`Set the mouse hover scroll success`);
});
} catch (error) {
console.log(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getHoverScrollState10+
getHoverScrollState(callback: AsyncCallback<boolean>): void
Obtains the status of the mouse hover scroll switch. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
Example
try {
pointer.getHoverScrollState((error: Error, state: Boolean) => {
console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`Get the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getHoverScrollState10+
getHoverScrollState(): Promise<boolean>
Obtains the status of the mouse hover scroll switch. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
try {
pointer.getHoverScrollState().then((state: Boolean) => {
console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`Get the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setMousePrimaryButton10+
setMousePrimaryButton(primary: PrimaryButton, callback: AsyncCallback<void>): void
Sets the primary button of the mouse. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
primary | PrimaryButton | Yes | ID of the primary mouse button. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setMousePrimaryButton(pointer.PrimaryButton.RIGHT, (error: Error) => {
if (error) {
console.log(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`Set mouse primary button success`);
});
} catch (error) {
console.log(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setMousePrimaryButton10+
setMousePrimaryButton(primary: PrimaryButton): Promise<void>
Sets the primary button of the mouse. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
primary | PrimaryButton | Yes | ID of the primary mouse button. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setMousePrimaryButton(pointer.PrimaryButton.RIGHT).then(() => {
console.log(`Set mouse primary button success`);
});
} catch (error) {
console.log(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getMousePrimaryButton10+
getMousePrimaryButton(callback: AsyncCallback<PrimaryButton>): void
Obtains the primary button of the mouse. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<PrimaryButton> | Yes | Callback used to return the result. |
Example
try {
pointer.getMousePrimaryButton((error: Error, primary: pointer.PrimaryButton) => {
console.log(`Get mouse primary button success, primary: ${JSON.stringify(primary)}`);
});
} catch (error) {
console.log(`Get mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getMousePrimaryButton10+
getMousePrimaryButton(): Promise<PrimaryButton>
Obtains the primary button of the mouse. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<PrimaryButton> | Promise used to return the result. |
Example
try {
pointer.getMousePrimaryButton().then((primary: pointer.PrimaryButton) => {
console.log(`Get mouse primary button success, primary: ${JSON.stringify(primary)}`);
});
} catch (error) {
console.log(`Get mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
PrimaryButton10+
Type of the primary mouse button.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Name | Value | Description |
---|---|---|
LEFT | 0 | Left mouse button. |
RIGHT | 1 | Right mouse button. |
pointer.setMouseScrollRows10+
setMouseScrollRows(rows: number, callback: AsyncCallback<void>): void
Sets the number of mouse scroll rows. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
rows | number | Yes | Number of mouse scroll rows. The value ranges from 1 to 100. The default value is 3. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setMouseScrollRows(1, (error: Error) => {
if (error) {
console.log(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return;
}
console.log(`setMouseScrollRows success`);
});
} catch (error) {
console.log(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setMouseScrollRows10+
setMouseScrollRows(rows: number): Promise<void>
Sets the number of mouse scroll rows. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
rows | number | Yes | Number of mouse scroll rows. The value ranges from 1 to 100. The default value is 3. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setMouseScrollRows(20).then(() => {
console.log(`setMouseScrollRows success`);
});
} catch (error) {
console.log(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getMouseScrollRows10+
getMouseScrollRows(callback: AsyncCallback<number>): void
Obtains the number of mouse scroll rows. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<number> | Yes | Callback used to return the result. |
Example
try {
pointer.getMouseScrollRows((error: Error, rows: Number) => {
console.log(`getMouseScrollRows success, rows: ${JSON.stringify(rows)}`);
});
} catch (error) {
console.log(`getMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getMouseScrollRows10+
getMouseScrollRows(): Promise<number>
Obtains the moving speed of the mouse pointer. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<number> | Promise used to return the result. |
Example
try {
pointer.getMouseScrollRows().then((rows: Number) => {
console.log(`getMouseScrollRows success, rows: ${JSON.stringify(rows)}`);
});
} catch (error) {
console.log(`getMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getPointerStyle9+
getPointerStyle(windowId: number, callback: AsyncCallback<PointerStyle>): void
Obtains the mouse pointer style. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
windowId | number | Yes | Window ID. |
callback | AsyncCallback<PointerStyle> | Yes | Callback used to return the result. |
Example
import { BusinessError } from '@ohos.base';
import window from '@ohos.window';
let context = getContext(this);
window.getLastWindow(context, (error: BusinessError, win: window.Window) => {
if (error.code) {
console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
return;
}
let windowId = win.getWindowProperties().id;
if (windowId < 0) {
console.log(`Invalid windowId`);
return;
}
try {
pointer.getPointerStyle(windowId, (error: Error, style: pointer.PointerStyle) => {
console.log(`Get pointer style success, style: ${JSON.stringify(style)}`);
});
} catch (error) {
console.log(`Get pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
});
pointer.getPointerStyle9+
getPointerStyle(windowId: number): Promise<PointerStyle>
Obtains the mouse pointer style. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
windowId | number | Yes | Window ID. |
Return value
Name | Description |
---|---|
Promise<PointerStyle> | Promise used to return the result. |
Example
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
let context = getContext(this);
window.getLastWindow(context, (error: BusinessError, win: window.Window) => {
if (error.code) {
console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
return;
}
let windowId = win.getWindowProperties().id;
if (windowId < 0) {
console.log(`Invalid windowId`);
return;
}
try {
pointer.getPointerStyle(windowId).then((style: pointer.PointerStyle) => {
console.log(`Get pointer style success, style: ${JSON.stringify(style)}`);
});
} catch (error) {
console.log(`Get pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
});
pointer.getPointerStyleSync10+
getPointerStyleSync(windowId: number): PointerStyle
Obtains the mouse pointer style. This API returns the result synchronously.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
windowId | number | Yes | Window ID. |
Return value
Name | Description |
---|---|
PointerStyle | Mouse pointer style. |
Example
try {
let style: pointer.PointerStyle = pointer.getPointerStyleSync(-1)
console.log(`Get pointer style success, style: ${JSON.stringify(style)}`)
} catch (error) {
console.log(`Get pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`)
}
pointer.setPointerStyle9+
setPointerStyle(windowId: number, pointerStyle: PointerStyle, callback: AsyncCallback<void>): void
Sets the mouse pointer style. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
windowId | number | Yes | Window ID. |
pointerStyle | PointerStyle | Yes | Mouse pointer style ID. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
window.getLastWindow(getContext(), (error: BusinessError, win: window.Window) => {
if (error.code) {
console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
return;
}
let windowId = win.getWindowProperties().id;
if (windowId < 0) {
console.log(`Invalid windowId`);
return;
}
try {
pointer.setPointerStyle(windowId, pointer.PointerStyle.CROSS, error => {
console.log(`Set pointer style success`);
});
} catch (error) {
console.log(`Set pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
});
pointer.setPointerStyle9+
setPointerStyle(windowId: number, pointerStyle: PointerStyle): Promise<void>
Sets the mouse pointer style. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
windowId | number | Yes | Window ID. |
pointerStyle | PointerStyle | Yes | Mouse pointer style ID. |
Promise<void> | void | Yes | Promise used to return the result. |
Example
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
window.getLastWindow(getContext(), (error: BusinessError, win: window.Window) => {
if (error.code) {
console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
return;
}
let windowId = win.getWindowProperties().id;
if (windowId < 0) {
console.log(`Invalid windowId`);
return;
}
try {
pointer.setPointerStyle(windowId, pointer.PointerStyle.CROSS).then(() => {
console.log(`Set pointer style success`);
});
} catch (error) {
console.log(`Set pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
});
pointer.setPointerStyleSync10+
setPointerStyleSync(windowId: number, pointerStyle: PointerStyle): void
Sets the mouse pointer style. This API returns the result synchronously.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
windowId | number | Yes | Window ID. |
pointerStyle | PointerStyle | Yes | Mouse pointer style ID. |
Example
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
window.getLastWindow(getContext(), (error: BusinessError, win: window.Window) => {
if (error.code) {
console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
return;
}
let windowId = win.getWindowProperties().id;
if (windowId < 0) {
console.log(`Invalid windowId`);
return;
}
try {
pointer.setPointerStyleSync(windowId, pointer.PointerStyle.CROSS);
console.log(`Set pointer style success`);
} catch (error) {
console.log(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
});
PointerStyle9+
Enumerates mouse pointer styles.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Name | Value | Description | Legend |
---|---|---|---|
DEFAULT | 0 | Default | |
EAST | 1 | East arrow | |
WEST | 2 | West arrow | |
SOUTH | 3 | South arrow | |
NORTH | 4 | North arrow | |
WEST_EAST | 5 | West-east arrow | |
NORTH_SOUTH | 6 | North-south arrow | |
NORTH_EAST | 7 | North-east arrow | |
NORTH_WEST | 8 | North-west arrow | |
SOUTH_EAST | 9 | South-east arrow | |
SOUTH_WEST | 10 | South-west arrow | |
NORTH_EAST_SOUTH_WEST | 11 | North-east and south-west adjustment | |
NORTH_WEST_SOUTH_EAST | 12 | North-west and south-east adjustment | |
CROSS | 13 | Cross (accurate selection) | |
CURSOR_COPY | 14 | Copy | |
CURSOR_FORBID | 15 | Forbid | |
COLOR_SUCKER | 16 | Sucker | |
HAND_GRABBING | 17 | Grabbing hand | |
HAND_OPEN | 18 | Opening hand | |
HAND_POINTING | 19 | Hand-shaped pointer | |
HELP | 20 | Help | |
MOVE | 21 | Move | |
RESIZE_LEFT_RIGHT | 22 | Left and right resizing | |
RESIZE_UP_DOWN | 23 | Up and down resizing | |
SCREENSHOT_CHOOSE | 24 | Screenshot crosshair | |
SCREENSHOT_CURSOR | 25 | Screenshot | |
TEXT_CURSOR | 26 | Text selection | |
ZOOM_IN | 27 | Zoom in | |
ZOOM_OUT | 28 | Zoom out | |
MIDDLE_BTN_EAST | 29 | Scrolling east | |
MIDDLE_BTN_WEST | 30 | Scrolling west | |
MIDDLE_BTN_SOUTH | 31 | Scrolling south | |
MIDDLE_BTN_NORTH | 32 | Scrolling north | |
MIDDLE_BTN_NORTH_SOUTH | 33 | Scrolling north-south | |
MIDDLE_BTN_NORTH_EAST | 34 | Scrolling north-east | |
MIDDLE_BTN_NORTH_WEST | 35 | Scrolling north-west | |
MIDDLE_BTN_SOUTH_EAST | 36 | Scrolling south-east | |
MIDDLE_BTN_SOUTH_WEST | 37 | Scrolling south-west | |
MIDDLE_BTN_NORTH_SOUTH_WEST_EAST | 38 | Moving as a cone in four directions | |
HORIZONTAL_TEXT_CURSOR10+ | 39 | Horizontal text selection | |
CURSOR_CROSS10+ | 40 | Cross | |
CURSOR_CIRCLE10+ | 41 | Circle | |
LOADING10+ | 42 | Animation loading | |
RUNNING10+ | 43 | Animation running in the background |
pointer.setTouchpadScrollSwitch10+
setTouchpadScrollSwitch(state: boolean, callback: AsyncCallback<void>): void
Sets the scroll switch of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Scroll switch status. The value true indicates that the scroll switch is enabled, and the value false indicates the opposite. The default value is true. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setTouchpadScrollSwitch(true, (error: 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.setTouchpadScrollSwitch10+
setTouchpadScrollSwitch(state: boolean): Promise<void>
Sets the scroll switch of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Scroll switch status. The value true indicates that the scroll switch is enabled, and the value false indicates the opposite. The default value is true. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setTouchpadScrollSwitch(false).then(() => {
console.log(`setTouchpadScrollSwitch success`);
});
} catch (error) {
console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadScrollSwitch10+
getTouchpadScrollSwitch(callback: AsyncCallback<boolean>): void
Obtains the scroll switch status of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
Example
try {
pointer.getTouchpadScrollSwitch((error: Error, state: Boolean) => {
console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadScrollSwitch10+
getTouchpadScrollSwitch(): Promise<boolean>
Obtains the scroll switch status of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
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.setTouchpadScrollDirection10+
setTouchpadScrollDirection(state: boolean, callback: AsyncCallback<void>): void
Sets the scroll direction of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Scroll direction of the touchpad. The value true indicates that the scroll direction is the same as the finger moving direction, and the value false indicates the opposite. The default value is true. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setTouchpadScrollDirection(true, (error: 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.setTouchpadScrollDirection10+
setTouchpadScrollDirection(state: boolean): Promise<void>
Sets the scroll direction of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Scroll direction of the touchpad. The value true indicates that the scroll direction is the same as the finger moving direction, and the value false indicates the opposite. The default value is true. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setTouchpadScrollDirection (false).then(() => {
console.log(`setTouchpadScrollDirection success`);
});
} catch (error) {
console.log(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadScrollDirection10+
getTouchpadScrollDirection(callback: AsyncCallback<boolean>): void
Obtains the scroll direction of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
Example
try {
pointer.getTouchpadScrollDirection ((error: Error, state: Boolean) => {
console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadScrollDirection10+
getTouchpadScrollDirection(): Promise<boolean>
Obtains the scroll direction of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
try {
pointer.getTouchpadScrollDirection().then((state: Boolean) => {
console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setTouchpadTapSwitch10+
setTouchpadTapSwitch(state: boolean, callback: AsyncCallback<void>): void
Sets the tap switch of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Tap switch status of the touchpad The value true indicates that the tap switch is enabled, and the value false indicates the opposite. The default value is true. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setTouchpadTapSwitch(true, (error: 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 10+
setTouchpadTapSwitch(state: boolean): Promise<void>
Sets the tap switch of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Tap switch status of the touchpad The value true indicates that the tap switch is enabled, and the value false indicates the opposite. The default value is true. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setTouchpadTapSwitch(false).then(() => {
console.log(`setTouchpadTapSwitch success`);
});
} catch (error) {
console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadTapSwitch10+
getTouchpadTapSwitch(callback: AsyncCallback<boolean>): void
Obtains the tap switch status of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
Example
try {
pointer.getTouchpadTapSwitch((error: Error, state: Boolean) => {
console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadTapSwitch10+
getTouchpadTapSwitch(): Promise<boolean>
Obtains the tap switch status of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
try {
pointer.getTouchpadTapSwitch().then((state: Boolean) => {
console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setTouchpadPointerSpeed10+
setTouchpadPointerSpeed(speed: number, callback: AsyncCallback<void>): void
Sets the mouse pointer moving speed of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
speed | number | Yes | Mouse pointer moving speed of the touchpad. The value range is [1,11]. The default value is 5. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setTouchpadPointerSpeed(1, (error: 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.setTouchpadPointerSpeed10+
setTouchpadPointerSpeed(speed: number): Promise<void>
Sets the mouse pointer moving speed of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
speed | number | Yes | Mouse pointer moving speed of the touchpad. The value range is [1,11]. The default value is 5. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setTouchpadPointerSpeed(10).then(() => {
console.log(`setTouchpadPointerSpeed success`);
});
} catch (error) {
console.log(`setTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadPointerSpeed10+
getTouchpadPointerSpeed(callback: AsyncCallback<number>): void
Obtains the mouse pointer moving speed of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<number> | Yes | Callback used to return the result. |
Example
try {
pointer.getTouchpadPointerSpeed((error: Error, speed: Number) => {
console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`);
});
} catch (error) {
console.log(`getTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadPointerSpeed10+
getTouchpadPointerSpeed(): Promise<number>
Obtains the mouse pointer moving speed of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<number> | Promise used to return the result. |
Example
try {
pointer.getTouchpadPointerSpeed().then((speed: Number) => {
console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`);
});
} catch (error) {
console.log(`getTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setTouchpadPinchSwitch10+
setTouchpadPinchSwitch(state: boolean, callback: AsyncCallback<void>): void
Sets the pinch switch of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Pinch switch status of the touchpad. The value true indicates that the pinch switch is enabled, and the value false indicates the opposite. The default value is true. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setTouchpadTapSwitch(true, (error: 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.setTouchpadPinchSwitch10+
setTouchpadPinchSwitch(state: boolean): Promise<void>
Sets the pinch switch of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Pinch switch status of the touchpad. The value true indicates that the pinch switch is enabled, and the value false indicates the opposite. The default value is true. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setTouchpadPinchSwitch(false).then(() => {
console.log(`setTouchpadPinchSwitch success`);
});
} catch (error) {
console.log(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadPinchSwitch10+
getTouchpadPinchSwitch(callback: AsyncCallback<boolean>): void
Obtains the pinch switch status of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
Example
try {
pointer.getTouchpadPinchSwitch((error: Error, state: Boolean) => {
console.log(`getTouchpadPinchSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadPinchSwitch10+
getTouchpadPinchSwitch(): Promise<boolean>
Obtains the pinch switch status of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
try {
pointer.getTouchpadPinchSwitch().then((state: Boolean) => {
console.log(`getTouchpadPinchSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setTouchpadSwipeSwitch10+
setTouchpadSwipeSwitch(state: boolean, callback: AsyncCallback<void>): void
Sets the multi-finger swipe switch of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Swipe switch status of the touchpad. The value true indicates that the swipe switch is enabled, and the value false indicates the opposite. The default value is true. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setTouchpadSwipeSwitch(true, (error: 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.setTouchpadSwipeSwitch10+
setTouchpadSwipeSwitch(state: boolean): Promise<void>
Sets the swipe switch of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
state | boolean | Yes | Swipe switch status of the touchpad. The value true indicates that the swipe switch is enabled, and the value false indicates the opposite. The default value is true. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setTouchpadSwipeSwitch(false).then(() => {
console.log(`setTouchpadSwipeSwitch success`);
});
} catch (error) {
console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadSwipeSwitch10+
getTouchpadSwipeSwitch(callback: AsyncCallback<boolean>): void
Obtains the multi-finger swipe switch status of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
Example
try {
pointer.getTouchpadSwipeSwitch((error: Error, state: Boolean) => {
console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadSwipeSwitch10+
getTouchpadSwipeSwitch(): Promise<boolean>
Obtains the multi-finger swipe switch status of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
try {
pointer.getTouchpadSwipeSwitch().then((state: Boolean) => {
console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`);
});
} catch (error) {
console.log(`getTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
RightClickType10+
Enumerates shortcut menu triggering modes.
System capability: SystemCapability.MultimodalInput.Input.Pointer
Name | Value | Description |
---|---|---|
TOUCHPAD_RIGHT_BUTTON | 1 | Tapping the right-button area of the touchpad. |
TOUCHPAD_LEFT_BUTTON | 2 | Tapping the left-button area of the touchpad. |
TOUCHPAD_TWO_FINGER_TAP | 3 | Tapping or pressing the touchpad with two fingers. |
pointer.setTouchpadRightClickType10+
setTouchpadRightClickType(type: RightClickType, callback: AsyncCallback<void>): void
Sets the shortcut menu type of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | RightClickType | Yes | Shortcut menu type of the touchpad. - TOUCHPAD_RIGHT_BUTTON: tapping the right-button area of the touchpad. - TOUCHPAD_LEFT_BUTTON: tapping the left-button area of the touchpad. - TOUCHPAD_TWO_FINGER_TAP: tapping or pressing the touchpad with two fingers. The default value is TOUCHPAD_RIGHT_BUTTON. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
try {
pointer.setTouchpadRightClickType(pointer.RightClickType.TOUCHPAD_RIGHT_BUTTON , (error: 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.setTouchpadRightClickType10+
setTouchpadRightClickType(type: RightClickType): Promise<void>
Sets the shortcut menu type of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | RightClickType | Yes | Shortcut menu type of the touchpad. - TOUCHPAD_RIGHT_BUTTON: tapping the right-button area of the touchpad. - TOUCHPAD_LEFT_BUTTON: tapping the left-button area of the touchpad. - TOUCHPAD_TWO_FINGER_TAP: tapping or pressing the touchpad with two fingers. The default value is TOUCHPAD_RIGHT_BUTTON. |
Return value
Name | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
try {
pointer.setTouchpadRightClickType(pointer.RightClickType.TOUCHPAD_RIGHT_BUTTON).then(() => {
console.log(`setTouchpadRightClickType success`);
});
} catch (error) {
console.log(`setTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadRightClickType10+
getTouchpadRightClickType(callback: AsyncCallback<RightClickType>): void
Obtains the shortcut menu type of the touchpad. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<RightClickType> | Yes | Callback used to return the result. |
Example
try {
pointer.getTouchpadRightClickType((error: Error, type: pointer.RightClickType) => {
console.log(`getTouchpadRightClickType success, type: ${JSON.stringify(type)}`);
});
} catch (error) {
console.log(`getTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getTouchpadRightClickType10+
getTouchpadRightClickType(): Promise<RightClickType>
Obtains the shortcut menu type of the touchpad. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<RightClickType > | Promise used to return the result. |
Example
try {
pointer.getTouchpadRightClickType().then((type: pointer.RightClickType) => {
console.log(`getTouchpadRightClickType success, typeed: ${JSON.stringify(type)}`);
});
} catch (error) {
console.log(`getTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setPointerSize10+
setPointerSize(size: number, callback: AsyncCallback<void>): void
Sets the pointer size. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
size | number | Yes | Pointer size. The value ranges from 1 to 7. The default value is 1. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Example
try {
pointer.setPointerSize(1, (error: 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.setPointerSize10+
setPointerSize(size: number): Promise<void>
Sets the pointer size. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
size | number | Yes | Pointer size. The value ranges from 1 to 7. The default value is 1. |
Return value
Name | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
try {
pointer.setPointerSize(3).then(() => {
console.log(`setPointerSize success`);
});
} catch (error) {
console.log(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setPointerSizeSync10+
setPointerSizeSync(size: number): void;
Sets the pointer size. This API returns the result synchronously.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
size | number | Yes | Pointer size. The value ranges from 1 to 7. The default value is 1. |
Example
try {
pointer.setPointerSizeSync(5);
console.log(`setPointerSizeSync success`);
} catch (error) {
console.log(`setPointerSizeSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getPointerSize10+
getPointerSize(callback: AsyncCallback<number>): void
Obtains the pointer size. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<number> | Yes | Callback used to return the result. |
Example
try {
pointer.getPointerSize((error: Error, size: Number) => {
console.log(`getPointerSize success, size: ${JSON.stringify(size)}`);
});
} catch (error) {
console.log(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getPointerSize10+
getPointerSize(): Promise<number>
Obtains the pointer size. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<number> | Promise used to return the result. |
Example
try {
pointer.getPointerSize().then((size: Number) => {
console.log(`getPointerSize success, size: ${JSON.stringify(size)}`);
});
} catch (error) {
console.log(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getPointerSizeSync10+
getPointerSizeSync(): number
Obtains the pointer size. This API returns the result synchronously.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
number | Pointer size. |
Example
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.setPointerColor10+
setPointerColor(color: number, callback: AsyncCallback<void>): void
Sets the pointer color. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
color | number | Yes | Pointer color. The default value is black (0x000000). |
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Example
try {
pointer.setPointerColor(0xF6C800, (error: 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.setPointerColor10+
setPointerColor(color: number): Promise<void>
Sets the pointer color. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
color | number | Yes | Pointer color. The default value is black (0x000000). |
Return value
Name | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
try {
pointer.setPointerColor(0xF6C800).then(() => {
console.log(`setPointerColor success`);
});
} catch (error) {
console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.setPointerColorSync10+
setPointerColorSync(color: number): void;
Sets the pointer color. This API returns the result synchronously.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
color | number | Yes | Pointer color. The default value is black (0x000000). |
Example
try {
pointer.setPointerColorSync(0xF6C800);
console.log(`setPointerColorSync success`);
} catch (error) {
console.log(`setPointerColorSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getPointerColor10+
getPointerColor(callback: AsyncCallback<number>): void
Obtains the pointer color. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<number> | Yes | Callback used to return the result. |
Example
try {
pointer.getPointerColor((error: Error, color: Number) => {
console.log(`getPointerColor success, color: ${JSON.stringify(color)}`);
});
} catch (error) {
console.log(`getPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getPointerColor10+
getPointerColor(): Promise<number>
Obtains the pointer color. This API uses a promise to return the result.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
Promise<number> | Promise used to return the result. |
Example
try {
pointer.getPointerColor().then((color: Number) => {
console.log(`getPointerColor success, color: ${JSON.stringify(color)}`);
});
} catch (error) {
console.log(`getPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
pointer.getPointerColorSync10+
getPointerColorSync(): number
Obtains the pointer color. This API returns the result synchronously.
System capability: SystemCapability.MultimodalInput.Input.Pointer
System API: This is a system API.
Return value
Name | Description |
---|---|
number | Pointer color. |
Example
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`])}`);
}
你可能感兴趣的鸿蒙文章
harmony 鸿蒙System Common Events (To Be Deprecated Soon)
harmony 鸿蒙System Common Events
harmony 鸿蒙API Reference Document Description
harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)
harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)
harmony 鸿蒙@ohos.bundle (Bundle)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)
- 所属分类: 后端技术
- 本文标签:
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦