Module ui_input_event

Available on crate feature api-12 only.

Structs

ArkUI_ModifierKeyName

Defines an enum for modifier keys.

ArkUI_UIInputEvent

ArkUI_UIInputEvent_Type

Enumerates the UI input event types.

HitTestMode

Enumerates the hit test modes.

InputEventSourceType

MouseEventAction

TouchEventAction

TouchEventToolType

Functions

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_GetVerticalAxisValue^⚠

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

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_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_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_GetPressure^⚠

Obtains the pressure applied to the touchscreen from a directional input event (for example, a touch 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_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_GetEventTime^⚠

Obtains the time when this UI input event occurs.

OH_ArkUI_UIInputEvent_GetPressedKeys^⚠api-14

Obtains the pressed status of modifier keys from UI input event. The following modifier keys are supported: Ctrl, Alt, Shift, Fn. However, the Fn key on external keyboards is not supported.

OH_ArkUI_UIInputEvent_GetSourceType^⚠

Obtains the source type of this UI input event.

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.