MouseEvent

java.lang.Object
- ohos.multimodalinput.event.MultimodalEvent
- - ohos.multimodalinput.event.CompositeEvent
  - - ohos.multimodalinput.event.MouseEvent

所有已实现的接口:

Sequenceable
```
public abstract class MouseEvent
extends CompositeEvent
```
Reports mouse events.
A reported event can contain both mouse button state change and cursor state change.

从以下版本开始:

1

另请参阅:

CompositeEvent

SystemCapability

SystemCapability.MultimodalInput#MULTIMODAL_INPUT

嵌套类概要
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

字段概要

字段
限定符和类型	字段	说明
`static int`	`AXIS_X`	Indicates the movement of the mouse pointer or scroll wheel in the X axis.
`static int`	`AXIS_Y`	Indicates the movement of the mouse pointer or scroll wheel in the Y axis.
`static int`	`AXIS_Z`	Indicates the movement of the mouse pointer or scroll wheel in the Z axis.
`static int`	`BACK_BUTTON`	Indicates that the back button on the mouse is pressed.
`static int`	`FORWARD_BUTTON`	Indicates that the forward button on the mouse is pressed.
`static int`	`HOVER_ENTER`	Indicates that a mouse button is not pressed while the cursor moves into the window or view.
`static int`	`HOVER_EXIT`	Indicates the exit of the cursor from a window or view when the left mouse button is not pressed.
`static int`	`HOVER_MOVE`	Indicates the movement of the cursor in a window or view when the left mouse button is not pressed.
`static int`	`LEFT_BUTTON`	Indicates that the left button on the mouse is pressed.
`static int`	`MIDDLE_BUTTON`	Indicates that the middle button on the mouse is pressed.
`static int`	`MOVE`	Indicates the movement of the cursor in a window or view when the left mouse button is pressed.
`static int`	`NONE`	Indicates no mouse action.
`static int`	`NONE_BUTTON`	Indicates that no mouse button is pressed.
`static int`	`PRESS`	Indicates that a mouse button is pressed.
`static int`	`RELEASE`	Indicates that a mouse button is released.
`static int`	`RIGHT_BUTTON`	Indicates that the right button on the mouse is pressed.

从类继承的字段 ohos.multimodalinput.event.MultimodalEvent
BUILTIN_KEY, DEFAULT_TYPE, highLevelEvent, KEYBOARD, MOUSE, ROTATION, SPEECH, STYLUS, TOUCH_PANEL, UNSUPPORTED_DEVICE, uuid

构造器概要

构造器
构造器说明

MouseEvent()

构造器
构造器	说明
`MouseEvent()`

方法概要

所有方法实例方法抽象方法
限定符和类型	方法	说明
`abstract int`	`getAction()`	Obtains the mouse action.
`abstract int`	`getActionButton()`	Obtains the mouse button whose status has changed.
`abstract MmiPoint`	`getCursor()`	Obtains the current position of the mouse pointer.
`abstract float`	`getCursorDelta(int axis)`	Obtains the movement of the mouse pointer in the given direction since last call.
`abstract int`	`getPressedButtons()`	Obtains all mouse buttons in the pressed state.
`abstract float`	`getScrollingDelta(int axis)`	Obtains the movement of the scroll wheel in the given direction since last call.
`abstract void`	`setCursorOffset(float offsetX, float offsetY)`	Sets the offset position relative to the screen.

从类继承的方法 ohos.multimodalinput.event.MultimodalEvent
getDeviceId, getInputDeviceId, getOccurredTime, getSourceDevice, getUuid, isSameEvent, marshalling, unmarshalling

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - AXIS_X
```
public static final int AXIS_X
```
    Indicates the movement of the mouse pointer or scroll wheel in the X axis.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - AXIS_Y
```
public static final int AXIS_Y
```
    Indicates the movement of the mouse pointer or scroll wheel in the Y axis.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - AXIS_Z
```
public static final int AXIS_Z
```
    Indicates the movement of the mouse pointer or scroll wheel in the Z axis.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - BACK_BUTTON
```
public static final int BACK_BUTTON
```
    Indicates that the back button on the mouse is pressed.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - FORWARD_BUTTON
```
public static final int FORWARD_BUTTON
```
    Indicates that the forward button on the mouse is pressed.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - HOVER_ENTER
```
public static final int HOVER_ENTER
```
    Indicates that a mouse button is not pressed while the cursor moves into the window or view.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - HOVER_EXIT
```
public static final int HOVER_EXIT
```
    Indicates the exit of the cursor from a window or view when the left mouse button is not pressed.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - HOVER_MOVE
```
public static final int HOVER_MOVE
```
    Indicates the movement of the cursor in a window or view when the left mouse button is not pressed.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - LEFT_BUTTON
```
public static final int LEFT_BUTTON
```
    Indicates that the left button on the mouse is pressed.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - MIDDLE_BUTTON
```
public static final int MIDDLE_BUTTON
```
    Indicates that the middle button on the mouse is pressed.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - MOVE
```
public static final int MOVE
```
    Indicates the movement of the cursor in a window or view when the left mouse button is pressed.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - NONE
```
public static final int NONE
```
    Indicates no mouse action.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - NONE_BUTTON
```
public static final int NONE_BUTTON
```
    Indicates that no mouse button is pressed.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - PRESS
```
public static final int PRESS
```
    Indicates that a mouse button is pressed.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - RELEASE
```
public static final int RELEASE
```
    Indicates that a mouse button is released.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - RIGHT_BUTTON
```
public static final int RIGHT_BUTTON
```
    Indicates that the right button on the mouse is pressed.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - MouseEvent
```
public MouseEvent()
```
- 方法详细资料
  - getAction
```
public abstract int getAction()
```
    Obtains the mouse action.
    
    返回:
    
    Returns the mouse action. The return value can be PRESS, RELEASE, MOVE, HOVER_ENTER, HOVER_MOVE, or HOVER_EXIT.
    
    从以下版本开始:
    
    1
  - getActionButton
```
public abstract int getActionButton()
```
    Obtains the mouse button whose status has changed.
    
    返回:
    
    Returns the mouse button whose status has changed. The return value can be NONE_BUTTON, LEFT_BUTTON, RIGHT_BUTTON, MIDDLE_BUTTON, BACK_BUTTON, or FORWARD_BUTTON. Note that NONE_BUTTON indicates that there is no mouse button whose status has changed.
    
    从以下版本开始:
    
    3
  - getPressedButtons
```
public abstract int getPressedButtons()
```
    Obtains all mouse buttons in the pressed state.
    
    返回:
    
    Returns all mouse buttons in the pressed state. The return value can be NONE_BUTTON, or the result of logical OR operations among LEFT_BUTTON, RIGHT_BUTTON, MIDDLE_BUTTON, BACK_BUTTON, and FORWARD_BUTTON. Note that NONE_BUTTON indicates that there is no mouse button in the pressed state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    NONE_BUTTON, LEFT_BUTTON, RIGHT_BUTTON, MIDDLE_BUTTON, FORWARD_BUTTON
  - getCursor
```
public abstract MmiPoint getCursor()
```
    Obtains the current position of the mouse pointer.
    
    返回:
    
    Returns the current position of the mouse pointer.
    
    从以下版本开始:
    
    3
  - setCursorOffset
```
public abstract void setCursorOffset(float offsetX,
                                     float offsetY)
```
    Sets the offset position relative to the screen.
    
    参数:
    
    offsetX - Indicates the offset relative to the x on the upper left corner of the screen.
    
    offsetY - Indicates the offset relative to the y on the upper left corner of the screen.
    
    从以下版本开始:
    
    3
  - getCursorDelta
```
public abstract float getCursorDelta(int axis)
```
    Obtains the movement of the mouse pointer in the given direction since last call.
    
    参数:
    
    axis - Indicates the movement direction of the mouse pointer. The value can be AXIS_X, AXIS_Y, or AXIS_Z.
    
    返回:
    
    Returns the movement of the mouse pointer in the given direction since last call.
    
    从以下版本开始:
    
    3
  - getScrollingDelta
```
public abstract float getScrollingDelta(int axis)
```
    Obtains the movement of the scroll wheel in the given direction since last call.
    
    参数:
    
    axis - Indicates the movement direction of the scroll wheel. The value can be AXIS_X, AXIS_Y, or AXIS_Z.
    
    返回:
    
    Returns the movement of the scroll wheel in the given direction since last call.
    
    从以下版本开始:
    
    3

类 MouseEvent

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

从类继承的字段 ohos.multimodalinput.event.MultimodalEvent

构造器概要

方法概要

从类继承的方法 ohos.multimodalinput.event.MultimodalEvent

从类继承的方法 java.lang.Object

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

AXIS_X

AXIS_Y

AXIS_Z

BACK_BUTTON

FORWARD_BUTTON

HOVER_ENTER

HOVER_EXIT

HOVER_MOVE

LEFT_BUTTON

MIDDLE_BUTTON

MOVE

NONE

NONE_BUTTON

PRESS

RELEASE

RIGHT_BUTTON

构造器详细资料

MouseEvent

方法详细资料

getAction

getActionButton

getPressedButtons

getCursor

setCursorOffset

getCursorDelta

getScrollingDelta