• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ui_input_event.h
2
3
4## Overview
5
6Provides ArkUI event definitions on the native side.
7
8**Library**: libace_ndk.z.so
9
10**File to include**: <arkui/ui_input_event.h>
11
12**System capability**: SystemCapability.ArkUI.ArkUI.Full
13
14**Since**: 12
15
16**Related module**: [ArkUI_EventModule](_ark_u_i___event_module.md)
17
18
19## Summary
20
21
22### Types
23
24| Name| Description|
25| -------- | -------- |
26| typedef struct [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) | Defines the UI input event. |
27
28
29### Enums
30
31| Name| Description|
32| -------- | -------- |
33| [ArkUI_UIInputEvent_Type](_ark_u_i___event_module.md#arkui_uiinputevent_type) { **ARKUI_UIINPUTEVENT_TYPE_UNKNOWN** = 0, **ARKUI_UIINPUTEVENT_TYPE_TOUCH** = 1, **ARKUI_UIINPUTEVENT_TYPE_AXIS** = 2, **ARKUI_UIINPUTEVENT_TYPE_MOUSE** = 3 } | Enumerates the UI input event types. |
34| {<br>[OH_NATIVEXCOMPONENT_RESULT_SUCCESS](_ark_u_i___event_module.md) = 0, [OH_NATIVEXCOMPONENT_RESULT_FAILED](_ark_u_i___event_module.md) = -1, [OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER](_ark_u_i___event_module.md) = -2, [UI_TOUCH_EVENT_ACTION_CANCEL](_ark_u_i___event_module.md) = 0,<br>[UI_TOUCH_EVENT_ACTION_DOWN](_ark_u_i___event_module.md) = 1, [UI_TOUCH_EVENT_ACTION_MOVE](_ark_u_i___event_module.md) = 2, [UI_TOUCH_EVENT_ACTION_UP](_ark_u_i___event_module.md) = 3<br>} | Enumerates the action codes of the input event. |
35| {<br>[UI_INPUT_EVENT_TOOL_TYPE_UNKNOWN](_ark_u_i___event_module.md) = 0, [UI_INPUT_EVENT_TOOL_TYPE_FINGER](_ark_u_i___event_module.md) = 1, [UI_INPUT_EVENT_TOOL_TYPE_PEN](_ark_u_i___event_module.md) = 2, [UI_INPUT_EVENT_TOOL_TYPE_MOUSE](_ark_u_i___event_module.md) = 3,<br>[UI_INPUT_EVENT_TOOL_TYPE_TOUCHPAD](_ark_u_i___event_module.md) = 4, [UI_INPUT_EVENT_TOOL_TYPE_JOYSTICK](_ark_u_i___event_module.md) = 5<br>} | Enumerates the tool types of the input event. |
36| { [UI_INPUT_EVENT_SOURCE_TYPE_UNKNOWN](_ark_u_i___event_module.md) = 0, [UI_INPUT_EVENT_SOURCE_TYPE_MOUSE](_ark_u_i___event_module.md) = 1, [UI_INPUT_EVENTT_SOURCE_TYPE_TOUCH_SCREEN](_ark_u_i___event_module.md) = 2 } | Enumerates the source types of the input event. |
37| [HitTestMode](_ark_u_i___event_module.md#hittestmode) { [HTM_DEFAULT](_ark_u_i___event_module.md) = 0, [HTM_BLOCK](_ark_u_i___event_module.md), [HTM_TRANSPARENT](_ark_u_i___event_module.md), [HTM_NONE](_ark_u_i___event_module.md) } | Enumerates the hit test modes. |
38| { [UI_MOUSE_EVENT_ACTION_UNKNOWN](_ark_u_i___event_module.md) = 0, [UI_MOUSE_EVENT_ACTION_PRESS](_ark_u_i___event_module.md) = 1, [UI_MOUSE_EVENT_ACTION_RELEASE](_ark_u_i___event_module.md) = 2, [UI_MOUSE_EVENT_ACTION_MOVE](_ark_u_i___event_module.md) = 3, [UI_MOUSE_EVENT_ACTION_CANCEL](_ark_u_i___event_module.md) = 13, } | Enumerates the action codes of the mouse event. |
39| {<br>[UI_MOUSE_EVENT_BUTTON_NONE](_ark_u_i___event_module.md) = 0, [UI_MOUSE_EVENT_BUTTON_LEFT](_ark_u_i___event_module.md) = 1, [UI_MOUSE_EVENT_BUTTON_RIGHT](_ark_u_i___event_module.md) = 2, [UI_MOUSE_EVENT_BUTTON_MIDDLE](_ark_u_i___event_module.md) = 3,<br>[UI_MOUSE_EVENT_BUTTON_BACK](_ark_u_i___event_module.md) = 4, [UI_MOUSE_EVENT_BUTTON_FORWARD](_ark_u_i___event_module.md) = 5<br>} | Enumerates the button types of the mouse event. |
40| [ArkUI_ModifierKeyName](_ark_u_i___event_module.md#arkui_modifierkeyname) { [ARKUI_MODIFIER_KEY_CTRL](_ark_u_i___event_module.md) = 1 &lt;&lt; 0, [ARKUI_MODIFIER_KEY_SHIFT](_ark_u_i___event_module.md) = 1 &lt;&lt; 1, [ARKUI_MODIFIER_KEY_ALT](_ark_u_i___event_module.md) = 1 &lt;&lt; 2, [ARKUI_MODIFIER_KEY_FN](_ark_u_i___event_module.md) = 1 &lt;&lt; 3 } | Enumerates the modifier keys. |
41| {<br>[UI_FOCUS_AXIS_EVENT_ABS_X](_ark_u_i___event_module.md) = 0, [UI_FOCUS_AXIS_EVENT_ABS_Y](_ark_u_i___event_module.md) = 1, [UI_FOCUS_AXIS_EVENT_ABS_Z](_ark_u_i___event_module.md) = 2, [UI_FOCUS_AXIS_EVENT_ABS_RZ](_ark_u_i___event_module.md) = 3,<br>[UI_FOCUS_AXIS_EVENT_ABS_GAS](_ark_u_i___event_module.md) = 4, [UI_FOCUS_AXIS_EVENT_ABS_BRAKE](_ark_u_i___event_module.md) = 5, [UI_FOCUS_AXIS_EVENT_ABS_HAT0X](_ark_u_i___event_module.md) = 6, [UI_FOCUS_AXIS_EVENT_ABS_HAT0Y](_ark_u_i___event_module.md) = 7<br>} | Enumerates the axis types for focus axis events. |
42| {<br>[ARKUI_EVENT_HAND_NONE](_ark_u_i___event_module.md) = 0, [ARKUI_EVENT_HAND_LEFT](_ark_u_i___event_module.md) = 1, [ARKUI_EVENT_HAND_RIGHT](_ark_u_i___event_module.md) = 2} | Defines whether an event is triggered by a left-hand or right-hand tap. |
43
44
45### Functions
46
47| Name| Description|
48| -------- | -------- |
49| int32_t [OH_ArkUI_UIInputEvent_GetType](_ark_u_i___event_module.md#oh_arkui_uiinputevent_gettype) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the type of a UI input event. |
50| int32_t [OH_ArkUI_UIInputEvent_GetAction](_ark_u_i___event_module.md#oh_arkui_uiinputevent_getaction) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the action type of this UI input event. |
51| int32_t [OH_ArkUI_UIInputEvent_GetSourceType](_ark_u_i___event_module.md#oh_arkui_uiinputevent_getsourcetype) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the source type of a UI input event. |
52| int32_t [OH_ArkUI_UIInputEvent_GetToolType](_ark_u_i___event_module.md#oh_arkui_uiinputevent_gettooltype) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the tool type of a UI input event. |
53| int64_t [OH_ArkUI_UIInputEvent_GetEventTime](_ark_u_i___event_module.md#oh_arkui_uiinputevent_geteventtime) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the time when a specified UI input event occurs. |
54| uint32_t [OH_ArkUI_PointerEvent_GetPointerCount](_ark_u_i___event_module.md#oh_arkui_pointerevent_getpointercount) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the number of touch points from a directional input event (such as a touch event, mouse event, or axis event). |
55| int32_t [OH_ArkUI_PointerEvent_GetPointerId](_ark_u_i___event_module.md#oh_arkui_pointerevent_getpointerid) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | Obtains the ID of a touch point from a directional input event (such as a touch event, mouse event, or axis event). |
56| int32_t [OH_ArkUI_PointerEvent_GetChangedPointerId](_ark_u_i___event_module.md#oh_arkui_pointerevent_getchangedpointerid) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t \*pointerIndex) | Obtains the ID of the touch pointer that triggers the current touch event. |
57| float [OH_ArkUI_PointerEvent_GetX](_ark_u_i___event_module.md#oh_arkui_pointerevent_getx) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 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). |
58| float [OH_ArkUI_PointerEvent_GetXByIndex](_ark_u_i___event_module.md#oh_arkui_pointerevent_getxbyindex) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 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). |
59| float [OH_ArkUI_PointerEvent_GetY](_ark_u_i___event_module.md#oh_arkui_pointerevent_gety) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 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). |
60| float [OH_ArkUI_PointerEvent_GetYByIndex](_ark_u_i___event_module.md#oh_arkui_pointerevent_getybyindex) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 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). |
61| float [OH_ArkUI_PointerEvent_GetWindowX](_ark_u_i___event_module.md#oh_arkui_pointerevent_getwindowx) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 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). |
62| float [OH_ArkUI_PointerEvent_GetWindowXByIndex](_ark_u_i___event_module.md#oh_arkui_pointerevent_getwindowxbyindex) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 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). |
63| float [OH_ArkUI_PointerEvent_GetWindowY](_ark_u_i___event_module.md#oh_arkui_pointerevent_getwindowy) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 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). |
64| float [OH_ArkUI_PointerEvent_GetWindowYByIndex](_ark_u_i___event_module.md#oh_arkui_pointerevent_getwindowybyindex) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 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). |
65| float [OH_ArkUI_PointerEvent_GetDisplayX](_ark_u_i___event_module.md#oh_arkui_pointerevent_getdisplayx) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 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). |
66| float [OH_ArkUI_PointerEvent_GetDisplayXByIndex](_ark_u_i___event_module.md#oh_arkui_pointerevent_getdisplayxbyindex) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 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). |
67| float [OH_ArkUI_PointerEvent_GetDisplayY](_ark_u_i___event_module.md#oh_arkui_pointerevent_getdisplayy) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 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). |
68| float [OH_ArkUI_PointerEvent_GetDisplayYByIndex](_ark_u_i___event_module.md#oh_arkui_pointerevent_getdisplayybyindex) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 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). |
69| float [OH_ArkUI_PointerEvent_GetPressure](_ark_u_i___event_module.md#oh_arkui_pointerevent_getpressure) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | Obtains the pressure applied to the touchscreen from a directional input event (for example, a touch event). |
70| float [OH_ArkUI_PointerEvent_GetTiltX](_ark_u_i___event_module.md#oh_arkui_pointerevent_gettiltx) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 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. |
71| float [OH_ArkUI_PointerEvent_GetTiltY](_ark_u_i___event_module.md#oh_arkui_pointerevent_gettilty) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 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. |
72| float [OH_ArkUI_PointerEvent_GetTouchAreaWidth](_ark_u_i___event_module.md#oh_arkui_pointerevent_gettouchareawidth) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | Obtains the width of the touch area from a directional input event (for example, a touch event). |
73| float [OH_ArkUI_PointerEvent_GetTouchAreaHeight](_ark_u_i___event_module.md#oh_arkui_pointerevent_gettouchareaheight) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex) | Obtains the height of the touch area from a directional input event (for example, a touch event). |
74| uint32_t [OH_ArkUI_PointerEvent_GetHistorySize](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorysize) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the number of historical events from a directional input event (such as a touch event, mouse event, or axis event). |
75| int64_t [OH_ArkUI_PointerEvent_GetHistoryEventTime](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistoryeventtime) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t historyIndex) | Obtains the occurrence time of a historical event from a directional input event (such as a touch event, mouse event, or axis event). |
76| uint32_t [OH_ArkUI_PointerEvent_GetHistoryPointerCount](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorypointercount) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t historyIndex) | 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). |
77| int32_t [OH_ArkUI_PointerEvent_GetHistoryPointerId](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorypointerid) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | Obtains the ID of a touch point from a directional input event (such as a touch event, mouse event, or axis event). |
78| float [OH_ArkUI_PointerEvent_GetHistoryX](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistoryx) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | Obtains the X-coordinate of a specific touch point in a specific 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). |
79| float [OH_ArkUI_PointerEvent_GetHistoryY](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistoryy) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | Obtains the Y-coordinate of a specific touch point in a specific 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). |
80| float [OH_ArkUI_PointerEvent_GetHistoryWindowX](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorywindowx) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | Obtains the X-coordinate of a specific touch point in a specific 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). |
81| float [OH_ArkUI_PointerEvent_GetHistoryWindowY](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorywindowy) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | Obtains the Y-coordinate of a specific touch point in a specific 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). |
82| float [OH_ArkUI_PointerEvent_GetHistoryDisplayX](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorydisplayx) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | Obtains the X-coordinate of a specific touch point in a specific 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). |
83| float [OH_ArkUI_PointerEvent_GetHistoryDisplayY](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorydisplayy) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | Obtains the Y-coordinate of a specific touch point in a specific 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). |
84| float [OH_ArkUI_PointerEvent_GetHistoryPressure](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorypressure) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | Obtains the pressure applied to the touchscreen in a specific historical event from a directional input event (for example, a touch event). |
85| float [OH_ArkUI_PointerEvent_GetHistoryTiltX](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorytiltx) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 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. |
86| float [OH_ArkUI_PointerEvent_GetHistoryTiltY](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorytilty) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 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. |
87| float [OH_ArkUI_PointerEvent_GetHistoryTouchAreaWidth](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorytouchareawidth) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | Obtains the width of the touch area in a specific historical event from a directional input event (for example, a touch event). |
88| float [OH_ArkUI_PointerEvent_GetHistoryTouchAreaHeight](_ark_u_i___event_module.md#oh_arkui_pointerevent_gethistorytouchareaheight) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | Obtains the height of the touch area in a specific historical event from a directional input event (for example, a touch event). |
89| double [OH_ArkUI_AxisEvent_GetVerticalAxisValue](_ark_u_i___event_module.md#oh_arkui_axisevent_getverticalaxisvalue) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the value of the vertical scroll axis for this axis event. |
90| double [OH_ArkUI_AxisEvent_GetHorizontalAxisValue](_ark_u_i___event_module.md#oh_arkui_axisevent_gethorizontalaxisvalue) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the value of the horizontal scroll axis for this axis event. |
91| double [OH_ArkUI_AxisEvent_GetPinchAxisScaleValue](_ark_u_i___event_module.md#oh_arkui_axisevent_getpinchaxisscalevalue) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the scale value of the pinch axis for this axis event. |
92| int32_t [OH_ArkUI_AxisEvent_GetAxisAction](_ark_u_i___event_module.md#oh_arkui_axisevent_getaxisaction)(const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the action type of the current axis event. |
93| int32_t [OH_ArkUI_PointerEvent_SetInterceptHitTestMode](_ark_u_i___event_module.md#oh_arkui_pointerevent_setintercepthittestmode) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, [HitTestMode](_ark_u_i___event_module.md#hittestmode) mode) | Sets how the component behaves during hit testing. |
94| int32_t [OH_ArkUI_MouseEvent_GetMouseButton](_ark_u_i___event_module.md#oh_arkui_mouseevent_getmousebutton) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the button type of a mouse event. |
95| int32_t [OH_ArkUI_MouseEvent_GetMouseAction](_ark_u_i___event_module.md#oh_arkui_mouseevent_getmouseaction) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the action type of a mouse event. |
96| int32_t [OH_ArkUI_PointerEvent_SetStopPropagation](_ark_u_i___event_module.md#oh_arkui_pointerevent_setstoppropagation) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, bool stopPropagation) | Sets whether to stop event propagation. |
97| int32_t [OH_ArkUI_UIInputEvent_GetDeviceId](_ark_u_i___event_module.md#oh_arkui_uiinputevent_getdeviceid) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the ID of the input device that triggers a key event. |
98| int32_t [OH_ArkUI_UIInputEvent_GetPressedKeys](_ark_u_i___event_module.md#oh_arkui_uiinputevent_getpressedkeys) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, int32_t \*pressedKeyCodes, int32_t \*length) | Obtains all pressed keys. Currently, only key events are supported. |
99| double [OH_ArkUI_FocusAxisEvent_GetAxisValue](_ark_u_i___event_module.md#oh_arkui_focusaxisevent_getaxisvalue) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, int32_t \*axis) | Obtains the axis value of a focus axis event. |
100| int32_t [OH_ArkUI_FocusAxisEvent_SetStopPropagation](_ark_u_i___event_module.md#oh_arkui_focusaxisevent_setstoppropagation) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, bool \*stopPropagation) | Sets whether to prevent a focus axis event from bubbling up. |
101| int32_t [OH_ArkUI_PointerEvent_GetInteractionHand](_ark_u_i___event_module.md#oh_arkui_pointerevent_getinteractionhand) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, [ArkUI_InteractionHand](_ark_u_i___event_module.md#interactionhand) \*hand) | Checks whether an event is triggered by a left-hand or right-hand tap. |
102| int32_t [OH_ArkUI_PointerEvent_GetInteractionHandByIndex](_ark_u_i___event_module.md#oh_arkui_pointerevent_getinteractionhandbyindex) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, int32_t pointerIndex, [ArkUI_InteractionHand](_ark_u_i___event_module.md#interactionhand) \*hand) | Checks whether an event is triggered by a left-hand or right-hand tap. |
103| int32_t [OH_ArkUI_PointerEvent_CreateClonedEvent](_ark_u_i___event_module.md#oh_arkui_pointerevent_createclonedevent) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*clonedevent) | Creates a cloned event pointer based on an event pointer. |
104| int32_t [OH_ArkUI_PointerEvent_DestroyClonedEvent](_ark_u_i___event_module.md#oh_arkui_pointerevent_destroyclonedevent) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Destroys a cloned event pointer. |
105| int32_t [OH_ArkUI_PointerEvent_SetClonedEventLocalPosition](_ark_u_i___event_module.md#oh_arkui_pointerevent_setclonedeventlocalposition) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, float x, float y) | Sets the X and Y coordinates of a cloned event relative to the upper left corner of the current component. |
106| int32_t [OH_ArkUI_PointerEvent_SetClonedEventLocalPositionByIndex](_ark_u_i___event_module.md#oh_arkui_pointerevent_setclonedeventlocalpositionbyindex) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, float x, float y, int32_t pointerIndex) | 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. |
107| int32_t [OH_ArkUI_PointerEvent_SetClonedEventActionType](_ark_u_i___event_module.md#oh_arkui_pointerevent_setclonedeventactiontype) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, int32_t actionType) | Sets the action type of a cloned event. |
108| int32_t [OH_ArkUI_PointerEvent_SetClonedEventChangedFingerId](_ark_u_i___event_module.md#oh_arkui_pointerevent_setclonedeventchangedfingerid) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, int32_t fingerId) | Sets the touch point ID of a cloned pointer event. |
109| int32_t [OH_ArkUI_PointerEvent_SetClonedEventFingerIdByIndex](_ark_u_i___event_module.md#oh_arkui_pointerevent_setclonedeventfingeridbyindex) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, int32_t fingerId, int32_t pointerIndexe) | Sets the touch point ID of a specific contact point of a cloned event. |
110| int32_t [OH_ArkUI_PointerEvent_PostClonedEvent](_ark_u_i___event_module.md#oh_arkui_pointerevent_postclonedevent) ([ArkUI_NodeHandle](_ark_u_i___native_module.md#arkui_nodehandle) \*node, const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Posts a cloned event to a specific node. |
111| int64_t [OH_ArkUI_PointerEvent_GetPressedTimeByIndex](_ark_u_i___event_module.md#oh_arkui_pointerevent_getpressedtimebyindex) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, int32_t pointerIndex) | Obtains the press time of a specific touch point. |
112| float [OH_ArkUI_MouseEvent_GetRawDeltaX](_ark_u_i___event_module.md#oh_arkui_mouseevent_getrawdeltax) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 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. |
113| float [OH_ArkUI_MouseEvent_GetRawDeltaY](_ark_u_i___event_module.md#oh_arkui_mouseevent_getrawdeltay) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 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. |
114| int32_t [OH_ArkUI_MouseEvent_GetPressedButtons](_ark_u_i___event_module.md#oh_arkui_mouseevent_getpressedbuttons) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, int32_t* pressedButtons, int32_t* length) | Obtains the pressed buttons from a mouse event. |
115| int32_t [OH_ArkUI_UIInputEvent_GetTargetDisplayId](_ark_u_i___event_module.md#oh_arkui_uiinputevent_gettargetdisplayid) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the ID of the screen where the UI input event occurs. |
116| float [OH_ArkUI_UIInputEvent_GetEventTargetWidth](_ark_u_i___event_module.md#oh_arkui_uiinputevent_geteventtargetwidth) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the width of the component hit by an event. |
117| float [OH_ArkUI_UIInputEvent_GetEventTargetHeight](_ark_u_i___event_module.md#oh_arkui_uiinputevent_geteventtargetheight) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the height of the component hit by an event. |
118| float [OH_ArkUI_UIInputEvent_GetEventTargetPositionX](_ark_u_i___event_module.md#oh_arkui_uiinputevent_geteventtargetpositionx) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the X coordinate of the component hit by an event. |
119| float [OH_ArkUI_UIInputEvent_GetEventTargetPositionY](_ark_u_i___event_module.md#oh_arkui_uiinputevent_geteventtargetpositiony) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the Y coordinate of the component hit by an event. |
120| float [OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionX](_ark_u_i___event_module.md#oh_arkui_uiinputevent_geteventtargetglobalpositionx) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the global X coordinate of the component hit by an event. |
121| float [OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionY](_ark_u_i___event_module.md#oh_arkui_uiinputevent_geteventtargetglobalpositiony) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the global Y coordinate of the component hit by an event. |
122| bool [OH_ArkUI_HoverEvent_IsHovered](_ark_u_i___event_module.md#oh_arkui_hoverevent_ishovered) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Checks whether the cursor is hovering over this component. |
123| int32_t [OH_ArkUI_UIInputEvent_GetModifierKeyStates](_ark_u_i___event_module.md#oh_arkui_uiinputevent_getmodifierkeystates) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, uint64_t keys) | Obtains the state of the modifier keys in a UI input event. |
124