Module ui_input_event 

Available on crate feature api-12 only.

Structs

ArkUI_InteractionHandapi-15

Defines whether the touch event is from the left or right hand.

ArkUI_ModifierKeyName

Defines an enum for modifier keys.

ArkUI_UIInputEvent

Defines the UI input event.

ArkUI_UIInputEvent_Type

Enumerates the UI input event types.

HitTestMode

Enumerates the hit test modes.

InputEventSourceType

MouseEventAction

TouchEventAction

TouchEventToolType

_bindgen_ty_6api-15

Defines an enum for the axis types for focus axis events.

_bindgen_ty_7api-15

Enumerates the action types for axis events.

Constants

UI_AXIS_EVENT_ACTION_BEGINapi-15

The axis event begins.

UI_AXIS_EVENT_ACTION_CANCELapi-15

The axis event is canceled.

UI_AXIS_EVENT_ACTION_ENDapi-15

The axis event ends.

UI_AXIS_EVENT_ACTION_NONEapi-15

The axis event is abnormal.

UI_AXIS_EVENT_ACTION_UPDATEapi-15

The axis event is updated.

UI_FOCUS_AXIS_EVENT_ABS_BRAKEapi-15

ABS_BRAKE.

UI_FOCUS_AXIS_EVENT_ABS_GASapi-15

ABS_GAS.

UI_FOCUS_AXIS_EVENT_ABS_HAT0Xapi-15

ABS_HAT0X.

UI_FOCUS_AXIS_EVENT_ABS_HAT0Yapi-15

ABS_HAT0Y.

UI_FOCUS_AXIS_EVENT_ABS_RZapi-15

ABS_RZ.

UI_FOCUS_AXIS_EVENT_ABS_Xapi-15

ABS_X.

UI_FOCUS_AXIS_EVENT_ABS_Yapi-15

ABS_Y.

UI_FOCUS_AXIS_EVENT_ABS_Zapi-15

ABS_Z.

Functions

OH_ArkUI_AxisEvent_GetAxisAction^⚠api-15

Obtains the action type of the current axis event.

OH_ArkUI_AxisEvent_GetHorizontalAxisValue^⚠

Obtains the value of the horizontal scroll axis for this axis event.

OH_ArkUI_AxisEvent_GetPinchAxisScaleValue^⚠

Obtains the scale value of the pinch axis for this axis event.

OH_ArkUI_AxisEvent_GetScrollStep^⚠api-17

Obtains the scroll step configuration of the mouse wheel axis event.

OH_ArkUI_AxisEvent_GetVerticalAxisValue^⚠

Obtains the value of the vertical scroll axis for this axis event.

OH_ArkUI_AxisEvent_SetPropagation^⚠api-17

Sets whether to enable axis event propagation.

OH_ArkUI_FocusAxisEvent_GetAxisValue^⚠api-15

Obtains the axis value of a focus axis event.

OH_ArkUI_FocusAxisEvent_SetStopPropagation^⚠api-15

Sets whether to prevent a focus axis event from bubbling up.

OH_ArkUI_HoverEvent_IsHovered^⚠api-17

Checks whether the cursor is hovering over this component.

OH_ArkUI_MouseEvent_GetMouseAction^⚠

Get the value of the mouse action type for mouse events.

OH_ArkUI_MouseEvent_GetMouseButton^⚠

Get the value of the button type for mouse events.

OH_ArkUI_MouseEvent_GetPressedButtons^⚠api-15

Obtains the pressed buttons from a mouse event.

OH_ArkUI_MouseEvent_GetRawDeltaX^⚠api-15

Obtains the x-axis offset of the mouse pointer position relative to the position in the previously reported mouse event. This value may be less than the difference between the two reported X coordinates when the mouse pointer is near the screen edge.

OH_ArkUI_MouseEvent_GetRawDeltaY^⚠api-15

Obtains the y-axis offset of the mouse pointer position relative to the position in the previously reported mouse event. This value may be less than the difference between the two reported Y coordinates when the mouse pointer is near the screen edge.

OH_ArkUI_PointerEvent_CreateClonedEvent^⚠api-15

Creates a cloned event pointer based on an event pointer.

OH_ArkUI_PointerEvent_DestroyClonedEvent^⚠api-15

Destroys a cloned event pointer.

OH_ArkUI_PointerEvent_GetChangedPointerId^⚠api-15

Obtains the ID of the touch pointer that triggers the current touch event.

OH_ArkUI_PointerEvent_GetDisplayX^⚠

Obtains the X coordinate relative to the upper left corner of the current screen from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetDisplayXByIndex^⚠

Obtains the X coordinate of a specific touch point relative to the upper left corner of the current screen from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetDisplayY^⚠

Obtains the Y coordinate relative to the upper left corner of the current screen from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetDisplayYByIndex^⚠

Obtains the Y coordinate of a specific touch point relative to the upper left corner of the current screen from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetHistoryDisplayX^⚠

Obtains the X coordinate of a specific touch point in a historical event relative to the upper left corner of the current screen from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetHistoryDisplayY^⚠

Obtains the Y coordinate of a specific touch point in a historical event relative to the upper left corner of the current screen from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetHistoryEventTime^⚠

Obtains the occurrence time of a historical event from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetHistoryPointerCount^⚠

Obtains the number of touch points in a specific historical event from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetHistoryPointerId^⚠

Obtains the ID of a touch point in a specific historical event from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetHistoryPressure^⚠

Obtains the pressure applied to the touchscreen in a specific historical event from a directional input event (for example, a touch event)..

OH_ArkUI_PointerEvent_GetHistorySize^⚠

Obtains the number of historical events from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetHistoryTiltX^⚠

Obtains the angle relative to the YZ plane in a specific historical event from a directional input event (for example, a touch event). The value range is [-90, 90]. A positive value indicates a rightward tilt.

OH_ArkUI_PointerEvent_GetHistoryTiltY^⚠

Obtains the angle relative to the XZ plane in a specific historical event from a directional input event (for example, a touch event). The value range is [-90, 90]. A positive value indicates a downward tilt.

OH_ArkUI_PointerEvent_GetHistoryTouchAreaHeight^⚠

Obtains the height of the touch area in a specific historical event from a directional input event (for example, a touch event).

OH_ArkUI_PointerEvent_GetHistoryTouchAreaWidth^⚠

Obtains the width of the touch area in a specific historical event from a directional input event (for example, a touch event).

OH_ArkUI_PointerEvent_GetHistoryWindowX^⚠

Obtains the X coordinate of a specific touch point in a historical event relative to the upper left corner of the current application window from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetHistoryWindowY^⚠

Obtains the Y coordinate of a specific touch point in a historical event relative to the upper left corner of the current application window from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetHistoryX^⚠

Obtains the X coordinate of a specific touch point in a historical event relative to the upper left corner of the current component from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetHistoryY^⚠

Obtains the Y coordinate of a specific touch point in a historical event relative to the upper left corner of the current component from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetInteractionHand^⚠api-15

Obtains whether the current touch event is from the left or right hand.

OH_ArkUI_PointerEvent_GetInteractionHandByIndex^⚠api-15

Obtains whether the current touch event is from the left or right hand.

OH_ArkUI_PointerEvent_GetPointerCount^⚠

Obtains the number of touch points from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetPointerId^⚠

Obtains the ID of a touch point from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetPressedTimeByIndex^⚠api-15

Obtains the press time of a specific touch point.

OH_ArkUI_PointerEvent_GetPressure^⚠

Obtains the pressure applied to the touchscreen from a directional input event (for example, a touch event).

OH_ArkUI_PointerEvent_GetRollAngle^⚠api-17

Obtains the rotation angle of the stylus around the z-axis from a UI input event.

OH_ArkUI_PointerEvent_GetTiltX^⚠

Obtains the angle relative to the YZ plane from a directional input event (for example, a touch event). The value range is [-90, 90]. A positive value indicates a rightward tilt.

OH_ArkUI_PointerEvent_GetTiltY^⚠

Obtains the angle relative to the XZ plane from a directional input event (for example, a touch event). The value range is [-90, 90]. A positive value indicates a downward tilt.

OH_ArkUI_PointerEvent_GetTouchAreaHeight^⚠

Obtains the height of the touch area from a directional input event (for example, a touch event).

OH_ArkUI_PointerEvent_GetTouchAreaWidth^⚠

Obtains the width of the touch area from a directional input event (for example, a touch event).

OH_ArkUI_PointerEvent_GetWindowX^⚠

Obtains the X coordinate relative to the upper left corner of the current application window from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetWindowXByIndex^⚠

Obtains the X coordinate of a specific touch point relative to the upper left corner of the current application window from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetWindowY^⚠

Obtains the Y coordinate relative to the upper left corner of the current application window from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetWindowYByIndex^⚠

Obtains the Y coordinate of a specific touch point relative to the upper left corner of the current application window from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetX^⚠

Obtains the X coordinate relative to the upper left corner of the current component from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetXByIndex^⚠

Obtains the X coordinate of a specific touch point relative to the upper left corner of the current component from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetY^⚠

Obtains the Y coordinate relative to the upper left corner of the current component from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_GetYByIndex^⚠

Obtains the Y coordinate of a specific touch point relative to the upper left corner of the current component from a directional input event (such as a touch event, mouse event, or axis event).

OH_ArkUI_PointerEvent_PostClonedEvent^⚠api-15

Posts a cloned event to a specific node.

OH_ArkUI_PointerEvent_SetClonedEventActionType^⚠api-15

Sets the action type of a cloned event.

OH_ArkUI_PointerEvent_SetClonedEventChangedFingerId^⚠api-15

Sets the touch point ID of a cloned pointer event.

OH_ArkUI_PointerEvent_SetClonedEventFingerIdByIndex^⚠api-15

Sets the touch point ID of a specific contact point of a cloned event.

OH_ArkUI_PointerEvent_SetClonedEventLocalPosition^⚠api-15

Sets the X and Y coordinates of a cloned event relative to the upper left corner of the current component.

OH_ArkUI_PointerEvent_SetClonedEventLocalPositionByIndex^⚠api-15

Sets the X and Y coordinates of a specific contact point of a cloned event relative to the upper left corner of the current component.

OH_ArkUI_PointerEvent_SetInterceptHitTestMode^⚠

Sets how the component behaves during hit testing.

OH_ArkUI_PointerEvent_SetStopPropagation^⚠

Sets whether to prevent event bubbling.

OH_ArkUI_UIInputEvent_GetAction^⚠

Obtains the action type of this UI input event.

OH_ArkUI_UIInputEvent_GetDeviceId^⚠api-14

Obtains the ID of device that triggers UI input event.

OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionX^⚠api-17

Obtains the global X coordinate of the component hit by an event.

OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionY^⚠api-17

Obtains the global Y coordinate of the component hit by an event.

OH_ArkUI_UIInputEvent_GetEventTargetHeight^⚠api-17

Obtains the height of the component hit by an event.

OH_ArkUI_UIInputEvent_GetEventTargetPositionX^⚠api-17

Obtains the X coordinate of the component hit by an event.

OH_ArkUI_UIInputEvent_GetEventTargetPositionY^⚠api-17

Obtains the Y coordinate of the component hit by an event.

OH_ArkUI_UIInputEvent_GetEventTargetWidth^⚠api-17

Obtains the width of the component hit by an event.

OH_ArkUI_UIInputEvent_GetEventTime^⚠

Obtains the time when this UI input event occurs.

OH_ArkUI_UIInputEvent_GetModifierKeyStates^⚠api-17

Obtains the state of the modifier keys in a UI input event.

OH_ArkUI_UIInputEvent_GetPressedKeys^⚠api-14

Obtains all keys that are pressed from UI input event. Only supports key events currently.

OH_ArkUI_UIInputEvent_GetSourceType^⚠

Obtains the source type of this UI input event.

OH_ArkUI_UIInputEvent_GetTargetDisplayId^⚠api-15

Obtains the ID of the screen where the UI input event occurs.

OH_ArkUI_UIInputEvent_GetToolType^⚠

Obtains the tool type of this UI input event.

OH_ArkUI_UIInputEvent_GetType^⚠

Obtains the type of this UI input event.