鼠標指針

2024-01-23 17:37 更新

鼠標指針管理模塊，用于查詢和設置鼠標指針相關屬性。

說明

本模塊首批接口從API version 9開始支持。后續(xù)版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

  1. import pointer from '@ohos.multimodalInput.pointer';

pointer.setPointerVisible

setPointerVisible(visible: boolean, callback: AsyncCallback<void>): void

設置鼠標指針顯示或者隱藏，使用AsyncCallback異步方式返回結果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.Pointer

參數：

參數名

類型

必填

說明

visible

boolean

是

鼠標指針是否顯示。

callback

AsyncCallback<void>

是

回調函數。

示例：

  1. try {
  2.   pointer.setPointerVisible(true, (error) => {
  3.     if (error) {
  4.       console.log(`Set pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  5.       return;
  6.     }
  7.     console.log(`Set pointer visible success`);
  8.   });
  9. } catch (error) {
  10.   console.log(`Set pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  11. }

pointer.setPointerVisible

setPointerVisible(visible: boolean): Promise<void>

設置鼠標指針顯示或者隱藏，使用Promise異步方式返回結果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.Pointer

參數：

參數名

類型

必填

說明

visible

boolean

是

鼠標指針是否顯示。

返回值：

參數

說明

Promise<void>

Promise對象。

示例：

  1. try {
  2.   pointer.setPointerVisible(false).then(() => {
  3.     console.log(`Set pointer visible success`);
  4.   });
  5. } catch (error) {
  6.   console.log(`Set pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  7. }

pointer.isPointerVisible

isPointerVisible(callback: AsyncCallback<boolean>): void

獲取鼠標指針顯示或隱藏狀態(tài)，使用AsyncCallback異步方式返回結果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.Pointer

參數：

參數名

類型

必填

說明

callback

AsyncCallback<boolean>

是

回調函數，異步返回鼠標指針顯示或隱藏狀態(tài)。

示例：

  1. try {
  2.   pointer.isPointerVisible((error, visible) => {
  3.     if (error) {
  4.       console.log(`Get pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  5.       return;
  6.     }
  7.     console.log(`Get pointer visible success, visible: ${JSON.stringify(visible)}`);
  8.   });
  9. } catch (error) {
  10.   console.log(`Get pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  11. }

pointer.isPointerVisible

isPointerVisible(): Promise<boolean>

獲取鼠標指針顯示或隱藏狀態(tài)，使用Promise異步方式返回結果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.Pointer

返回值：

參數

說明

Promise<boolean>

Promise對象，異步返回鼠標指針顯示或隱藏狀態(tài)。

示例：

  1. try {
  2.   pointer.isPointerVisible().then((visible) => {
  3.     console.log(`Get pointer visible success, visible: ${JSON.stringify(visible)}`);
  4.   });
  5. } catch (error) {
  6.   console.log(`Get pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  7. }

pointer.getPointerStyle

getPointerStyle(windowId: number, callback: AsyncCallback<PointerStyle>): void

獲取鼠標樣式類型，使用AsyncCallback異步方式返回結果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.Pointer

參數：

參數名

類型

必填

說明

windowId

number

是

窗口id。

callback

AsyncCallback<PointerStyle>

是

回調函數，異步返回鼠標樣式類型。

示例：

  1. import window from '@ohos.window';
  2. 

  3. window.getLastWindow(this.context, (error, win) => {
  4.   if (error.code) {
  5.     console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
  6.     return;
  7.   }
  8.   let windowId = win.getWindowProperties().id;
  9.   if (windowId < 0) {
  10.     console.log(`Invalid windowId`);
  11.     return;
  12.   }
  13.   try {
  14.     pointer.getPointerStyle(windowId, (error, style) => {
  15.       console.log(`Get pointer style success, style: ${JSON.stringify(style)}`);
  16.     });
  17.   } catch (error) {
  18.     console.log(`Get pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  19.   }
  20. });

pointer.getPointerStyle

getPointerStyle(windowId: number): Promise<PointerStyle>

獲取鼠標樣式類型，使用Promise異步方式返回結果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.Pointer

參數：

參數名

類型

必填

說明

windowId

number

是

窗口id。

返回值：

參數

說明

Promise<PointerStyle>

Promise實例，異步返回鼠標樣式類型。

示例：

  1. import window from '@ohos.window';
  2. 

  3. window.getLastWindow(this.context, (error, win) => {
  4.   if (error.code) {
  5.     console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
  6.     return;
  7.   }
  8.   let windowId = win.getWindowProperties().id;
  9.   if (windowId < 0) {
  10.     console.log(`Invalid windowId`);
  11.     return;
  12.   }
  13.   try {
  14.     pointer.getPointerStyle(windowId).then((style) => {
  15.       console.log(`Get pointer style success, style: ${JSON.stringify(style)}`);
  16.     });
  17.   } catch (error) {
  18.     console.log(`Get pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  19.   }
  20. });

pointer.setPointerStyle

setPointerStyle(windowId: number, pointerStyle: PointerStyle, callback: AsyncCallback<void>): void

設置鼠標樣式類型，使用AsyncCallback異步方式返回結果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.Pointer

參數：

參數名

類型

必填

說明

windowId

number

是

窗口id。

pointerStyle

PointerStyle

是

鼠標樣式。

callback

AsyncCallback<void>

是

回調函數。

示例：

  1. import window from '@ohos.window';
  2. 

  3. window.getLastWindow(this.context, (error, win) => {
  4.   if (error.code) {
  5.     console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
  6.     return;
  7.   }
  8.   let windowId = win.getWindowProperties().id;
  9.   if (windowId < 0) {
  10.     console.log(`Invalid windowId`);
  11.     return;
  12.   }
  13.   try {
  14.     pointer.setPointerStyle(windowId, pointer.PointerStyle.CROSS, error => {
  15.       console.log(`Set pointer style success`);
  16.     });
  17.   } catch (error) {
  18.     console.log(`Set pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  19.   }
  20. });

pointer.setPointerStyle

setPointerStyle(windowId: number, pointerStyle: PointerStyle): Promise<void>

設置鼠標樣式類型，使用Promise異步方式返回結果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.Pointer

參數：

參數名

類型

必填

說明

windowId

number

是

窗口id。

pointerStyle

PointerStyle

是

鼠標樣式。

Promise<void>

void

是

Promise對象。

示例：

  1. import window from '@ohos.window';
  2. 

  3. window.getLastWindow(this.context, (error, win) => {
  4.   if (error.code) {
  5.     console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
  6.     return;
  7.   }
  8.   let windowId = win.getWindowProperties().id;
  9.   if (windowId < 0) {
  10.     console.log(`Invalid windowId`);
  11.     return;
  12.   }
  13.   try {
  14.     pointer.setPointerStyle(windowId, pointer.PointerStyle.CROSS).then(() => {
  15.       console.log(`Set pointer style success`);
  16.     });
  17.   } catch (error) {
  18.     console.log(`Set pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  19.   }
  20. });

PointerStyle

鼠標樣式類型。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.Pointer

名稱

值

說明

圖示

DEFAULT

0

默認

EAST

1

向東箭頭

WEST

2

向西箭頭

SOUTH

3

向南箭頭

NORTH

4

向北箭頭

WEST_EAST

5

向西東箭頭

NORTH_SOUTH

6

向北南箭頭

NORTH_EAST

7

向東北箭頭

NORTH_WEST

8

向西北箭頭

SOUTH_EAST

9

向東南箭頭

SOUTH_WEST

10

向西南箭頭

NORTH_EAST_SOUTH_WEST

11

東北西南調整

NORTH_WEST_SOUTH_EAST

12

西北東南調整

CROSS

13

準確選擇

CURSOR_COPY

14

拷貝

CURSOR_FORBID

15

不可用

COLOR_SUCKER

16

滴管

HAND_GRABBING

17

并攏的手

HAND_OPEN

18

張開的手

HAND_POINTING

19

手形指針

HELP

20

幫助選擇

MOVE

21

移動

RESIZE_LEFT_RIGHT

22

內部左右調整

RESIZE_UP_DOWN

23

內部上下調整

SCREENSHOT_CHOOSE

24

截圖十字準星

SCREENSHOT_CURSOR

25

截圖

TEXT_CURSOR

26

文本選擇

ZOOM_IN

27

放大

ZOOM_OUT

28

縮小

MIDDLE_BTN_EAST

29

向東滾動

MIDDLE_BTN_WEST

30

向西滾動

MIDDLE_BTN_SOUTH

31

向南滾動

MIDDLE_BTN_NORTH

32

向北滾動

MIDDLE_BTN_NORTH_SOUTH

33

向北南滾動

MIDDLE_BTN_NORTH_EAST

34

向東北滾動

MIDDLE_BTN_NORTH_WEST

35

向西北滾動

MIDDLE_BTN_SOUTH_EAST

36

向東南滾動

MIDDLE_BTN_SOUTH_WEST

37

向西南滾動

MIDDLE_BTN_NORTH_SOUTH_WEST_EAST

38

四向錐形移動

以上內容是否對您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號