1# ArkUI_EventModule 2 3 4## 概述 5 6在Native端提供ArkUI的UI输入事件能力。 7 8**起始版本：** 12 9 10 11## 汇总 12 13 14### 文件 15 16| 名称 | 描述 | 17| -------- | -------- | 18| [ui_input_event.h](ui__input__event_8h.md) | 提供ArkUI在Native侧的事件定义。 | 19 20 21### 类型定义 22 23| 名称 | 描述 | 24| -------- | -------- | 25| typedef struct [ArkUI_UIInputEvent](#arkui_uiinputevent) [ArkUI_UIInputEvent](#arkui_uiinputevent) | UI输入事件定义。 | 26 27 28### 枚举 29 30| 名称 | 描述 | 31| -------- | -------- | 32| [ArkUI_UIInputEvent_Type](#arkui_uiinputevent_type) { ARKUI_UIINPUTEVENT_TYPE_UNKNOWN = 0, ARKUI_UIINPUTEVENT_TYPE_TOUCH = 1, ARKUI_UIINPUTEVENT_TYPE_AXIS = 2, ARKUI_UIINPUTEVENT_TYPE_MOUSE = 3 } | UI输入事件类型定义。 | 33| {<br/>OH_NATIVEXCOMPONENT_RESULT_SUCCESS = 0, OH_NATIVEXCOMPONENT_RESULT_FAILED = -1, OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER = -2, UI_TOUCH_EVENT_ACTION_CANCEL = 0,<br/>UI_TOUCH_EVENT_ACTION_DOWN = 1, UI_TOUCH_EVENT_ACTION_MOVE = 2, UI_TOUCH_EVENT_ACTION_UP = 3<br/>} | 定义输入事件的Action Code。 | 34| {<br/>UI_INPUT_EVENT_TOOL_TYPE_UNKNOWN = 0, UI_INPUT_EVENT_TOOL_TYPE_FINGER = 1, UI_INPUT_EVENT_TOOL_TYPE_PEN = 2, UI_INPUT_EVENT_TOOL_TYPE_MOUSE = 3,<br/>UI_INPUT_EVENT_TOOL_TYPE_TOUCHPAD = 4, UI_INPUT_EVENT_TOOL_TYPE_JOYSTICK = 5<br/>} | 产生输入事件的工具类型定义。 | 35| { UI_INPUT_EVENT_SOURCE_TYPE_UNKNOWN = 0, UI_INPUT_EVENTT_SOURCE_TYPE_MOUSE = 1, UI_INPUT_EVENTT_SOURCE_TYPE_TOUCH_SCREEN = 2 } | 产生输入事件的来源类型定义。 | 36| [HitTestMode](#hittestmode) { HTMDEFAULT = 0, HTMBLOCK, HTMTRANSPARENT, HTMNONE } | 定义触摸测试类型的枚举值。 | 37| { UI_MOUSE_EVENT_ACTION_UNKNOWN = 0, UI_MOUSE_EVENT_ACTION_PRESS = 1, UI_MOUSE_EVENT_ACTION_RELEASE = 2, UI_MOUSE_EVENT_ACTION_MOVE = 3 } | 定义鼠标事件的Action Code。 | 38| {<br/>UI_MOUSE_EVENT_BUTTON_NONE = 0, UI_MOUSE_EVENT_BUTTON_LEFT = 1, UI_MOUSE_EVENT_BUTTON_RIGHT = 2, UI_MOUSE_EVENT_BUTTON_MIDDLE = 3,<br/>UI_MOUSE_EVENT_BUTTON_BACK = 4, UI_MOUSE_EVENT_BUTTON_FORWARD = 5<br/>} | 定义鼠标事件的按键类型。 | 39| [ArkUI_ModifierKeyName](#arkui_modifierkeyname) { ARKUI_MODIFIER_KEY_CTRL = 1 << 0, ARKUI_MODIFIER_KEY_SHIFT = 1 << 1, ARKUI_MODIFIER_KEY_ALT = 1 << 2, ARKUI_MODIFIER_KEY_FN = 1 << 3 } | 定义modifier按键。 | 40| {<br/>ARKUI_EVENT_HAND_NONE = 0, ARKUI_EVENT_HAND_LEFT = 1, ARKUI_EVENT_HAND_RIGHT = 2<br/>} | 定义事件是由左手点击触发还是右手点击触发。 | 41| {<br/>UI_FOCUS_AXIS_EVENT_ABS_X = 0, UI_FOCUS_AXIS_EVENT_ABS_Y = 1, UI_FOCUS_AXIS_EVENT_ABS_Z = 2, UI_FOCUS_AXIS_EVENT_ABS_RZ = 3,<br/>UI_FOCUS_AXIS_EVENT_ABS_GAS = 4, UI_FOCUS_AXIS_EVENT_ABS_BRAKE = 5, UI_FOCUS_AXIS_EVENT_ABS_HAT0X = 6, UI_FOCUS_AXIS_EVENT_ABS_HAT0Y = 7<br/>} | 定义焦点轴事件的轴类型。 | 42 43 44### 函数 45 46| 名称 | 描述 | 47| -------- | -------- | 48| int32_t [OH_ArkUI_UIInputEvent_GetType](#oh_arkui_uiinputevent_gettype) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取UI输入事件的类型。 | 49| int32_t [OH_ArkUI_UIInputEvent_GetAction](#oh_arkui_uiinputevent_getaction) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取UI输入事件的操作类型。 | 50| int32_t [OH_ArkUI_UIInputEvent_GetSourceType](#oh_arkui_uiinputevent_getsourcetype) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取产生UI输入事件的来源类型。 | 51| int32_t [OH_ArkUI_UIInputEvent_GetToolType](#oh_arkui_uiinputevent_gettooltype) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取产生UI输入事件的工具类型。 | 52| int64_t [OH_ArkUI_UIInputEvent_GetEventTime](#oh_arkui_uiinputevent_geteventtime) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取UI输入事件发生的时间。 | 53| uint32_t [OH_ArkUI_PointerEvent_GetPointerCount](#oh_arkui_pointerevent_getpointercount) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点数量。 | 54| int32_t [OH_ArkUI_PointerEvent_GetPointerId](#oh_arkui_pointerevent_getpointerid) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。 | 55| int32_t [OH_ArkUI_PointerEvent_GetChangedPointerId](#oh_arkui_pointerevent_getchangedpointerid) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t \*pointerIndex) | 获取当前触摸事件触发的id。 | 56| float [OH_ArkUI_PointerEvent_GetX](#oh_arkui_pointerevent_getx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的X坐标。 | 57| float [OH_ArkUI_PointerEvent_GetXByIndex](#oh_arkui_pointerevent_getxbyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的X坐标。 | 58| float [OH_ArkUI_PointerEvent_GetY](#oh_arkui_pointerevent_gety) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的Y坐标。 | 59| float [OH_ArkUI_PointerEvent_GetYByIndex](#oh_arkui_pointerevent_getybyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的Y坐标。 | 60| float [OH_ArkUI_PointerEvent_GetWindowX](#oh_arkui_pointerevent_getwindowx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的X坐标。 | 61| float [OH_ArkUI_PointerEvent_GetWindowXByIndex](#oh_arkui_pointerevent_getwindowxbyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的X坐标。 | 62| float [OH_ArkUI_PointerEvent_GetWindowY](#oh_arkui_pointerevent_getwindowy) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的Y坐标。 | 63| float [OH_ArkUI_PointerEvent_GetWindowYByIndex](#oh_arkui_pointerevent_getwindowybyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的Y坐标。 | 64| float [OH_ArkUI_PointerEvent_GetDisplayX](#oh_arkui_pointerevent_getdisplayx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的X坐标。 | 65| float [OH_ArkUI_PointerEvent_GetDisplayXByIndex](#oh_arkui_pointerevent_getdisplayxbyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的X坐标。 | 66| float [OH_ArkUI_PointerEvent_GetDisplayY](#oh_arkui_pointerevent_getdisplayy) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的Y坐标。 | 67| float [OH_ArkUI_PointerEvent_GetDisplayYByIndex](#oh_arkui_pointerevent_getdisplayybyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的Y坐标。 | 68| float [OH_ArkUI_PointerEvent_GetPressure](#oh_arkui_pointerevent_getpressure) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件）中获取触屏压力。 | 69| float [OH_ArkUI_PointerEvent_GetTiltX](#oh_arkui_pointerevent_gettiltx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件）中获取相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。 | 70| float [OH_ArkUI_PointerEvent_GetTiltY](#oh_arkui_pointerevent_gettilty) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件）中获取相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。 | 71| float [OH_ArkUI_PointerEvent_GetTouchAreaWidth](#oh_arkui_pointerevent_gettouchareawidth) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件）中获取触屏区域的宽度。 | 72| float [OH_ArkUI_PointerEvent_GetTouchAreaHeight](#oh_arkui_pointerevent_gettouchareaheight) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件）中获取触屏区域的高度。 | 73| uint32_t [OH_ArkUI_PointerEvent_GetHistorySize](#oh_arkui_pointerevent_gethistorysize) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件数量。 | 74| int64_t [OH_ArkUI_PointerEvent_GetHistoryEventTime](#oh_arkui_pointerevent_gethistoryeventtime) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件发生的时间。 | 75| uint32_t [OH_ArkUI_PointerEvent_GetHistoryPointerCount](#oh_arkui_pointerevent_gethistorypointercount) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中多点触控的接触点数量。 | 76| int32_t [OH_ArkUI_PointerEvent_GetHistoryPointerId](#oh_arkui_pointerevent_gethistorypointerid) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。 | 77| float [OH_ArkUI_PointerEvent_GetHistoryX](#oh_arkui_pointerevent_gethistoryx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的X坐标。 | 78| float [OH_ArkUI_PointerEvent_GetHistoryY](#oh_arkui_pointerevent_gethistoryy) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的Y坐标。 | 79| float [OH_ArkUI_PointerEvent_GetHistoryWindowX](#oh_arkui_pointerevent_gethistorywindowx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的X坐标。 | 80| float [OH_ArkUI_PointerEvent_GetHistoryWindowY](#oh_arkui_pointerevent_gethistorywindowy) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的Y坐标。 | 81| float [OH_ArkUI_PointerEvent_GetHistoryDisplayX](#oh_arkui_pointerevent_gethistorydisplayx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的X坐标。 | 82| float [OH_ArkUI_PointerEvent_GetHistoryDisplayY](#oh_arkui_pointerevent_gethistorydisplayy) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的Y坐标。 | 83| float [OH_ArkUI_PointerEvent_GetHistoryPressure](#oh_arkui_pointerevent_gethistorypressure) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏压力。 | 84| float [OH_ArkUI_PointerEvent_GetHistoryTiltX](#oh_arkui_pointerevent_gethistorytiltx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。 | 85| float [OH_ArkUI_PointerEvent_GetHistoryTiltY](#oh_arkui_pointerevent_gethistorytilty) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。 | 86| float [OH_ArkUI_PointerEvent_GetHistoryTouchAreaWidth](#oh_arkui_pointerevent_gethistorytouchareawidth) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的宽度。 | 87| float [OH_ArkUI_PointerEvent_GetHistoryTouchAreaHeight](#oh_arkui_pointerevent_gethistorytouchareaheight) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的高度。 | 88| double [OH_ArkUI_AxisEvent_GetVerticalAxisValue](#oh_arkui_axisevent_getverticalaxisvalue) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取当前轴事件的垂直滚动轴的值。 | 89| double [OH_ArkUI_AxisEvent_GetHorizontalAxisValue](#oh_arkui_axisevent_gethorizontalaxisvalue) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取当前轴事件的水平滚动轴的值。 | 90| double [OH_ArkUI_AxisEvent_GetPinchAxisScaleValue](#oh_arkui_axisevent_getpinchaxisscalevalue) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取当前轴事件的捏合轴缩放的值。 | 91| int32_t [OH_ArkUI_AxisEvent_GetAxisAction](#oh_arkui_axisevent_getaxisaction)(const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取当前轴事件的操作类型的值。 | 92| int32_t [OH_ArkUI_PointerEvent_SetInterceptHitTestMode](#oh_arkui_pointerevent_setintercepthittestmode) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, [HitTestMode](#hittestmode) mode) | 配置HitTest模式。 | 93| int32_t [OH_ArkUI_MouseEvent_GetMouseButton](#oh_arkui_mouseevent_getmousebutton) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取鼠标事件的按键类型的值。 | 94| int32_t [OH_ArkUI_MouseEvent_GetMouseAction](#oh_arkui_mouseevent_getmouseaction) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取鼠标事件的鼠标动作类型的值。 | 95| int32_t [OH_ArkUI_PointerEvent_SetStopPropagation](#oh_arkui_pointerevent_setstoppropagation) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, bool stopPropagation) | 设置是否阻止事件冒泡。 | 96| int32_t [OH_ArkUI_UIInputEvent_GetDeviceId](#oh_arkui_uiinputevent_getdeviceid) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取当前按键的输入设备ID。 | 97| int32_t [OH_ArkUI_UIInputEvent_GetPressedKeys](#oh_arkui_uiinputevent_getpressedkeys) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, int32_t \*pressedKeyCodes, int32_t \*length) | 获取功能键按压状态。报错信息请参考以下错误码。支持功能键 'Ctrl'\|'Alt'\|'Shift'\|'Fn'，设备外接带Fn键的键盘不支持Fn键查询。 | 98| int32_t [OH_ArkUI_PointerEvent_GetInteractionHand](#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) | 获取当前触摸事件是左手点击触发还是右手点击触发。 | 99| int32_t [OH_ArkUI_PointerEvent_GetInteractionHandByIndex](#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) | 获取当前触摸事件是左手点击触发还是右手点击触发。 | 100| double [OH_ArkUI_FocusAxisEvent_GetAxisValue](#oh_arkui_focusaxisevent_getaxisvalue) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, int32_t \*axis) | 获取焦点轴事件的轴值。 | 101| int32_t [OH_ArkUI_FocusAxisEvent_SetStopPropagation](#oh_arkui_focusaxisevent_setstoppropagation) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, bool \*stopPropagation) | 设置是否阻止焦点轴事件冒泡。 | 102| int32_t [OH_ArkUI_PointerEvent_CreateClonedEvent](#oh_arkui_pointerevent_createclonedevent) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, [ArkUI_UIInputEvent](#arkui_uiinputevent) \*clonedevent) | 基于原始事件指针创建克隆事件指针。 | 103| int32_t [OH_ArkUI_PointerEvent_DestroyClonedEvent](#oh_arkui_pointerevent_destroyclonedevent) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 销毁克隆事件指针。 | 104| int32_t [OH_ArkUI_PointerEvent_SetClonedEventLocalPosition](#oh_arkui_pointerevent_setclonedeventlocalposition) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, float x, float y) | 设置指向性事件相对于当前组件左上角的X坐标和Y坐标。 | 105| int32_t [OH_ArkUI_PointerEvent_SetClonedEventLocalPositionByIndex](#oh_arkui_pointerevent_setclonedeventlocalpositionbyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, float x, float y, int32_t pointerIndex) | 设置指向性事件特有接触点相对于当前组件左上角的X坐标和Y坐标。 | 106| int32_t [OH_ArkUI_PointerEvent_SetClonedEventActionType](#oh_arkui_pointerevent_setclonedeventactiontype) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, int32_t actionType) | 设置当前带有指向性的克隆输入事件的事件类型。 | 107| int32_t [OH_ArkUI_PointerEvent_SetClonedEventChangedFingerId](#oh_arkui_pointerevent_setclonedeventchangedfingerid) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, int32_t fingerId) | 设置当前带有指向性的克隆输入事件的触摸点ID。 | 108| int32_t [OH_ArkUI_PointerEvent_SetClonedEventFingerIdByIndex](#oh_arkui_pointerevent_setclonedeventfingeridbyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, int32_t fingerId, int32_t pointerIndex) | 设置带有指向性的克隆输入事件特定接触点的触摸点ID。 | 109| int32_t [OH_ArkUI_PointerEvent_PostClonedEvent](#oh_arkui_pointerevent_postclonedevent) ([ArkUI_NodeHandle](_ark_u_i___native_module.md#arkui_nodehandle) \*node, const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 转发克隆事件到特定节点。 | 110| int64_t [OH_ArkUI_PointerEvent_GetPressedTimeByIndex](#oh_arkui_pointerevent_getpressedtimebyindex) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, int32_t pointerIndex) | 获取特定触摸点的按压时间。 | 111| float [OH_ArkUI_MouseEvent_GetRawDeltaX](#oh_arkui_mouseevent_getrawdeltax) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取X轴相对于前一个上报的鼠标事件的鼠标指针位置的偏移量。当鼠标指针位于屏幕边缘时，该值可能小于两次上报的X坐标的差。 | 112| float [OH_ArkUI_MouseEvent_GetRawDeltaY](#oh_arkui_mouseevent_getrawdeltay) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取相对于前一个上报的鼠标事件的鼠标指针位置的Y轴偏移量。当鼠标指针位于屏幕边缘时，该值可能小于两次上报的Y坐标的差。 | 113| int32_t [OH_ArkUI_MouseEvent_GetPressedButtons](#oh_arkui_mouseevent_getpressedbuttons) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, int32_t* pressedButtons, int32_t* length) | 从鼠标事件中获取按下的按钮。 | 114| int32_t [OH_ArkUI_UIInputEvent_GetTargetDisplayId](#oh_arkui_uiinputevent_gettargetdisplayid) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取发生UI输入事件的屏幕ID。 | 115 116 117## 类型定义说明 118 119 120### ArkUI_UIInputEvent 121 122``` 123typedef struct ArkUI_UIInputEvent ArkUI_UIInputEvent 124``` 125**描述：** 126 127UI输入事件定义。 128 129**起始版本：** 12 130 131 132## 枚举类型说明 133 134 135### anonymous enum 136 137``` 138anonymous enum 139``` 140**描述：** 141 142定义输入事件的Action Code。 143 144**起始版本：** 12 145 146| 枚举值 | 描述 | 147| -------- | -------- | 148| OH_NATIVEXCOMPONENT_RESULT_SUCCESS | 成功结果。 | 149| OH_NATIVEXCOMPONENT_RESULT_FAILED | 失败结果。 | 150| OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER | 无效参数。 | 151| UI_TOUCH_EVENT_ACTION_CANCEL | 触摸取消。 | 152| UI_TOUCH_EVENT_ACTION_DOWN | 触摸按下。 | 153| UI_TOUCH_EVENT_ACTION_MOVE | 触摸移动。 | 154| UI_TOUCH_EVENT_ACTION_UP | 触摸抬起。 | 155 156 157### anonymous enum 158 159``` 160anonymous enum 161``` 162**描述：** 163 164产生输入事件的工具类型定义。 165 166**起始版本：** 12 167 168| 枚举值 | 描述 | 169| -------- | -------- | 170| UI_INPUT_EVENT_TOOL_TYPE_UNKNOWN | 不支持的工具类型。 | 171| UI_INPUT_EVENT_TOOL_TYPE_FINGER | 手指。 | 172| UI_INPUT_EVENT_TOOL_TYPE_PEN | 笔。 | 173| UI_INPUT_EVENT_TOOL_TYPE_MOUSE | 鼠标。 | 174| UI_INPUT_EVENT_TOOL_TYPE_TOUCHPAD | 触控板。 | 175| UI_INPUT_EVENT_TOOL_TYPE_JOYSTICK | 操纵杆。 | 176 177 178### anonymous enum 179 180``` 181anonymous enum 182``` 183**描述：** 184 185产生输入事件的来源类型定义。 186 187**起始版本：** 12 188 189| 枚举值 | 描述 | 190| -------- | -------- | 191| UI_INPUT_EVENT_SOURCE_TYPE_UNKNOWN | 不支持的来源类型。 | 192| UI_INPUT_EVENTT_SOURCE_TYPE_MOUSE | 鼠标。 | 193| UI_INPUT_EVENTT_SOURCE_TYPE_TOUCH_SCREEN | 触摸屏。 | 194 195 196### anonymous enum 197 198``` 199anonymous enum 200``` 201**描述：** 202 203定义鼠标事件的Action Code。 204 205**起始版本：** 12 206 207| 枚举值 | 描述 | 208| -------- | -------- | 209| UI_MOUSE_EVENT_ACTION_UNKNOWN | 无效行为。 | 210| UI_MOUSE_EVENT_ACTION_PRESS | 鼠标按键按下。 | 211| UI_MOUSE_EVENT_ACTION_RELEASE | 鼠标按键松开。 | 212| UI_MOUSE_EVENT_ACTION_MOVE | 鼠标移动。 | 213 214 215### anonymous enum 216 217``` 218anonymous enum 219``` 220**描述：** 221 222定义鼠标事件的按键类型。 223 224**起始版本：** 12 225 226| 枚举值 | 描述 | 227| -------- | -------- | 228| UI_MOUSE_EVENT_BUTTON_NONE | 无按键。 | 229| UI_MOUSE_EVENT_BUTTON_LEFT | 鼠标左键。 | 230| UI_MOUSE_EVENT_BUTTON_RIGHT | 鼠标右键。 | 231| UI_MOUSE_EVENT_BUTTON_MIDDLE | 鼠标中键。 | 232| UI_MOUSE_EVENT_BUTTON_BACK | 鼠标左侧后退键。 | 233| UI_MOUSE_EVENT_BUTTON_FORWARD | 鼠标左侧前进键。 | 234 235 236### ArkUI_ModifierKeyName 237 238``` 239enum ArkUI_ModifierKeyName 240``` 241**描述：** 242 243定义modifier按键。 244 245**起始版本：** 12 246 247| 枚举值 | 描述 | 248| -------- | -------- | 249| ARKUI_MODIFIER_KEY_CTRL | Ctrl. | 250| ARKUI_MODIFIER_KEY_SHIFT | Shift. | 251| ARKUI_MODIFIER_KEY_ALT | Alt. | 252| ARKUI_MODIFIER_KEY_FN | Fn. | 253 254 255### ArkUI_UIInputEvent_Type 256 257``` 258enum ArkUI_UIInputEvent_Type 259``` 260**描述：** 261 262UI输入事件类型定义。 263 264**起始版本：** 12 265 266 267### HitTestMode 268 269``` 270enum HitTestMode 271``` 272**描述：** 273 274定义触摸测试类型的枚举值。 275 276**起始版本：** 12 277 278| 枚举值 | 描述 | 279| -------- | -------- | 280| HTMDEFAULT | 默认触摸测试效果，自身和子节点都响应触摸测试，但会阻塞兄弟节点的触摸测试。 | 281| HTMBLOCK | 自身响应触摸测试，阻塞子节点和兄弟节点的触摸测试。 | 282| HTMTRANSPARENT | 自身和子节点都响应触摸测试，不会阻塞兄弟节点的触摸测试。 | 283| HTMNONE | 自身不响应触摸测试，不会阻塞子节点和兄弟节点的触摸测试。 | 284 285 286### InteractionHand 287 288``` 289enum ArkUI_InteractionHand 290``` 291**描述：** 292 293定义事件是由左手点击触发还是右手点击触发。 294 295**起始版本：** 15 296 297| 枚举值 | 描述 | 298| -------- | -------- | 299| ARKUI_EVENT_HAND_NONE | 未知。 | 300| ARKUI_EVENT_HAND_LEFT | 左手。 | 301| ARKUI_EVENT_HAND_RIGHT | 右手。 | 302### anonymous enum 303 304``` 305anonymous enum 306``` 307**描述：** 308 309定义焦点轴事件的轴类型。 310 311**起始版本：** 15 312 313| 枚举值 | 描述 | 314| -------- | -------- | 315| UI_FOCUS_AXIS_EVENT_ABS_X | 游戏手柄X轴。 | 316| UI_FOCUS_AXIS_EVENT_ABS_Y | 游戏手柄Y轴。 | 317| UI_FOCUS_AXIS_EVENT_ABS_Z | 游戏手柄Z轴。 | 318| UI_FOCUS_AXIS_EVENT_ABS_RZ | 游戏手柄RZ轴。 | 319| UI_FOCUS_AXIS_EVENT_ABS_GAS | 游戏手柄GAS轴。 | 320| UI_FOCUS_AXIS_EVENT_ABS_BRAKE | 游戏手柄BRAKE轴。 | 321| UI_FOCUS_AXIS_EVENT_ABS_HAT0X | 游戏手柄HAT0X轴。 | 322| UI_FOCUS_AXIS_EVENT_ABS_HAT0Y | 游戏手柄HAT0Y轴。 | 323 324 325## 函数说明 326 327 328### OH_ArkUI_AxisEvent_GetHorizontalAxisValue() 329 330``` 331double OH_ArkUI_AxisEvent_GetHorizontalAxisValue (const ArkUI_UIInputEvent * event) 332``` 333**描述：** 334 335获取当前轴事件的水平滚动轴的值。 336 337**起始版本：** 12 338 339**参数:** 340 341| 名称 | 描述 | 342| -------- | -------- | 343| event | 表示指向当前UI输入事件的指针。 | 344 345**返回：** 346 347返回当前轴事件的水平滚动轴的值，如果参数异常则返回0.0。 348 349 350### OH_ArkUI_AxisEvent_GetPinchAxisScaleValue() 351 352``` 353double OH_ArkUI_AxisEvent_GetPinchAxisScaleValue (const ArkUI_UIInputEvent * event) 354``` 355**描述：** 356 357获取当前轴事件的捏合轴缩放的值。 358 359**起始版本：** 12 360 361**参数:** 362 363| 名称 | 描述 | 364| -------- | -------- | 365| event | 表示指向当前UI输入事件的指针。 | 366 367**返回：** 368 369返回当前轴事件的捏合轴缩放的值，如果参数异常则返回0.0。 370 371 372### OH_ArkUI_AxisEvent_GetVerticalAxisValue() 373 374``` 375double OH_ArkUI_AxisEvent_GetVerticalAxisValue (const ArkUI_UIInputEvent * event) 376``` 377**描述：** 378 379获取当前轴事件的垂直滚动轴的值。 380 381**起始版本：** 12 382 383**参数:** 384 385| 名称 | 描述 | 386| -------- | -------- | 387| event | 表示指向当前UI输入事件的指针。 | 388 389**返回：** 390 391返回当前轴事件的垂直滚动轴的值，如果参数异常则返回0.0。 392 393### OH_ArkUI_AxisEvent_GetAxisAction() 394 395``` 396int32_t OH_ArkUI_AxisEvent_GetAxisAction(const ArkUI_UIInputEvent* event) 397``` 398 399**描述：** 400 401获取当前轴事件的操作类型的值。 402 403**起始版本：** 15 404 405**参数:** 406 407| 名称 | 描述 | 408| -------- | -------- | 409| event | 表示指向当前UI输入事件的指针。 | 410 411**返回：** 412 413返回当前轴事件的操作类型的值。 414 415 416### OH_ArkUI_MouseEvent_GetMouseAction() 417 418``` 419int32_t OH_ArkUI_MouseEvent_GetMouseAction (const ArkUI_UIInputEvent * event) 420``` 421**描述：** 422 423获取鼠标事件的鼠标动作类型的值。 424 425**起始版本：** 12 426 427**参数:** 428 429| 名称 | 描述 | 430| -------- | -------- | 431| event | 表示指向当前UI输入事件的指针。 | 432 433**返回：** 434 435返回鼠标动作类型，1表示按键按下，2表示按键松开，3表示鼠标移动。 436 437 438### OH_ArkUI_MouseEvent_GetMouseButton() 439 440``` 441int32_t OH_ArkUI_MouseEvent_GetMouseButton (const ArkUI_UIInputEvent * event) 442``` 443**描述：** 444 445获取鼠标事件的按键类型的值。 446 447**起始版本：** 12 448 449**参数:** 450 451| 名称 | 描述 | 452| -------- | -------- | 453| event | 表示指向当前UI输入事件的指针。 | 454 455**返回：** 456 457返回鼠标按键类型，1为左键，2为右键，3为中键，4为后退键，5为前进键。 458 459 460### OH_ArkUI_PointerEvent_GetDisplayX() 461 462``` 463float OH_ArkUI_PointerEvent_GetDisplayX (const ArkUI_UIInputEvent * event) 464``` 465**描述：** 466 467从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的X坐标。 468 469**起始版本：** 12 470 471**参数:** 472 473| 名称 | 描述 | 474| -------- | -------- | 475| event | 表示指向当前UI输入事件的指针。 | 476 477**返回：** 478 479返回当前带有指向性的输入事件相对于当前屏幕左上角的X坐标，如果参数异常则返回0.0f。 480 481 482### OH_ArkUI_PointerEvent_GetDisplayXByIndex() 483 484``` 485float OH_ArkUI_PointerEvent_GetDisplayXByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 486``` 487**描述：** 488 489从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的X坐标。 490 491**起始版本：** 12 492 493**参数:** 494 495| 名称 | 描述 | 496| -------- | -------- | 497| event | 表示指向当前UI输入事件的指针。 | 498| pointerIndex | 表示多点触控数据列表中的序号。 | 499 500**返回：** 501 502返回当前带有指向性的输入事件相对于当前屏幕左上角的X坐标，如果参数异常则返回0.0f。 503 504 505### OH_ArkUI_PointerEvent_GetDisplayY() 506 507``` 508float OH_ArkUI_PointerEvent_GetDisplayY (const ArkUI_UIInputEvent * event) 509``` 510**描述：** 511 512从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的Y坐标。 513 514**起始版本：** 12 515 516**参数:** 517 518| 名称 | 描述 | 519| -------- | -------- | 520| event | 表示指向当前UI输入事件的指针。 | 521 522**返回：** 523 524返回当前带有指向性的输入事件相对于当前屏幕左上角的Y坐标，如果参数异常则返回0.0f。 525 526 527### OH_ArkUI_PointerEvent_GetDisplayYByIndex() 528 529``` 530float OH_ArkUI_PointerEvent_GetDisplayYByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 531``` 532**描述：** 533 534从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的Y坐标。 535 536**起始版本：** 12 537 538**参数:** 539 540| 名称 | 描述 | 541| -------- | -------- | 542| event | 表示指向当前UI输入事件的指针。 | 543| pointerIndex | 表示多点触控数据列表中的序号。 | 544 545**返回：** 546 547返回当前带有指向性的输入事件相对于当前屏幕左上角的Y坐标，如果参数异常则返回0.0f。 548 549 550### OH_ArkUI_PointerEvent_GetHistoryDisplayX() 551 552``` 553float OH_ArkUI_PointerEvent_GetHistoryDisplayX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 554``` 555**描述：** 556 557从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的X坐标。 558 559**起始版本：** 12 560 561**参数:** 562 563| 名称 | 描述 | 564| -------- | -------- | 565| event | 表示指向当前UI输入事件的指针。 | 566| pointerIndex | 表示多点触控数据列表的序号。 | 567| historyIndex | 表示历史事件数据列表的序号。 | 568 569**返回：** 570 571返回当前带有指向性的输入事件相对于当前屏幕左上角的X坐标，如果参数异常则返回0.0f。 572 573 574### OH_ArkUI_PointerEvent_GetHistoryDisplayY() 575 576``` 577float OH_ArkUI_PointerEvent_GetHistoryDisplayY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 578``` 579**描述：** 580 581从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的Y坐标。 582 583**起始版本：** 12 584 585**参数:** 586 587| 名称 | 描述 | 588| -------- | -------- | 589| event | 表示指向当前UI输入事件的指针。 | 590| pointerIndex | 表示多点触控数据列表的序号。 | 591| historyIndex | 表示历史事件数据列表的序号。 | 592 593**返回：** 594 595返回当前带有指向性的输入事件相对于当前屏幕左上角的Y坐标，如果参数异常则返回0.0f。 596 597 598### OH_ArkUI_PointerEvent_GetHistoryEventTime() 599 600``` 601int64_t OH_ArkUI_PointerEvent_GetHistoryEventTime (const ArkUI_UIInputEvent * event, uint32_t historyIndex ) 602``` 603**描述：** 604 605从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件发生的时间。 606 607**起始版本：** 12 608 609**参数:** 610 611| 名称 | 描述 | 612| -------- | -------- | 613| event | 表示指向当前UI输入事件的指针。 | 614| historyIndex | 表示历史事件数据列表的序号。 | 615 616**返回：** 617 618返回UI输入事件发生的时间，如果参数异常则返回0。 619 620 621### OH_ArkUI_PointerEvent_GetHistoryPointerCount() 622 623``` 624uint32_t OH_ArkUI_PointerEvent_GetHistoryPointerCount (const ArkUI_UIInputEvent * event, uint32_t historyIndex ) 625``` 626**描述：** 627 628从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中多点触控的接触点数量。 629 630**起始版本：** 12 631 632**参数:** 633 634| 名称 | 描述 | 635| -------- | -------- | 636| event | 表示指向当前UI输入事件的指针。 | 637| historyIndex | 表示历史事件数据列表的序号。 | 638 639**返回：** 640 641特定历史事件中多点触控的接触点数量。 642 643 644### OH_ArkUI_PointerEvent_GetHistoryPointerId() 645 646``` 647int32_t OH_ArkUI_PointerEvent_GetHistoryPointerId (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 648``` 649**描述：** 650 651从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。 652 653**起始版本：** 12 654 655**参数:** 656 657| 名称 | 描述 | 658| -------- | -------- | 659| event | 表示指向当前UI输入事件的指针。 | 660| pointerIndex | 表示多点触控数据列表的序号。 | 661| historyIndex | 表示历史事件数据列表的序号。 | 662 663**返回：** 664 665返回特定历史事件中的特定接触点标识。 666 667 668### OH_ArkUI_PointerEvent_GetHistoryPressure() 669 670``` 671float OH_ArkUI_PointerEvent_GetHistoryPressure (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 672``` 673**描述：** 674 675从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏压力。 676 677**起始版本：** 12 678 679**参数:** 680 681| 名称 | 描述 | 682| -------- | -------- | 683| event | 表示指向当前UI输入事件的指针。 | 684| pointerIndex | 表示多点触控数据列表中的序号。 | 685| historyIndex | 表示历史事件数据列表的序号。 | 686 687**返回：** 688 689返回当前带有指向性的输入事件产生的触屏压力，如果参数异常则返回0.0f。 690 691 692### OH_ArkUI_PointerEvent_GetHistorySize() 693 694``` 695uint32_t OH_ArkUI_PointerEvent_GetHistorySize (const ArkUI_UIInputEvent * event) 696``` 697**描述：** 698 699从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件数量。 700 701**起始版本：** 12 702 703**参数:** 704 705| 名称 | 描述 | 706| -------- | -------- | 707| event | 表示指向当前UI输入事件的指针。 | 708 709**返回：** 710 711返回当前历史事件数量。 712 713 714### OH_ArkUI_PointerEvent_GetHistoryTiltX() 715 716``` 717float OH_ArkUI_PointerEvent_GetHistoryTiltX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 718``` 719**描述：** 720 721从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。 722 723**起始版本：** 12 724 725**参数:** 726 727| 名称 | 描述 | 728| -------- | -------- | 729| event | 表示指向当前UI输入事件的指针。 | 730| pointerIndex | 表示多点触控数据列表中的序号。 | 731| historyIndex | 表示历史事件数据列表的序号。 | 732 733**返回：** 734 735返回当前带有指向性的输入事件中相对YZ平面的角度。 736 737 738### OH_ArkUI_PointerEvent_GetHistoryTiltY() 739 740``` 741float OH_ArkUI_PointerEvent_GetHistoryTiltY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 742``` 743**描述：** 744 745从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。 746 747**起始版本：** 12 748 749**参数:** 750 751| 名称 | 描述 | 752| -------- | -------- | 753| event | 表示指向当前UI输入事件的指针。 | 754| pointerIndex | 表示多点触控数据列表中的序号。 | 755| historyIndex | 表示历史事件数据列表的序号。 | 756 757**返回：** 758 759返回当前带有指向性的输入事件中相对XZ平面的角度。 760 761### OH_ArkUI_PointerEvent_GetHistoryTouchAreaHeight() 762 763``` 764float OH_ArkUI_PointerEvent_GetHistoryTouchAreaHeight (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 765``` 766**描述：** 767 768从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的高度。 769 770**起始版本：** 12 771 772**参数:** 773 774| 名称 | 描述 | 775| -------- | -------- | 776| event | 表示指向当前UI输入事件的指针。 | 777| pointerIndex | 表示多点触控数据列表中的序号。 | 778| historyIndex | 表示历史事件数据列表的序号。 | 779 780**返回：** 781 782返回当前带有指向性的输入事件中触屏区域的高度。 783 784 785### OH_ArkUI_PointerEvent_GetHistoryTouchAreaWidth() 786 787``` 788float OH_ArkUI_PointerEvent_GetHistoryTouchAreaWidth (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 789``` 790**描述：** 791 792从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的宽度。 793 794**起始版本：** 12 795 796**参数:** 797 798| 名称 | 描述 | 799| -------- | -------- | 800| event | 表示指向当前UI输入事件的指针。 | 801| pointerIndex | 表示多点触控数据列表中的序号。 | 802| historyIndex | 表示历史事件数据列表的序号。 | 803 804**返回：** 805 806返回当前带有指向性的输入事件中触屏区域的宽度。 807 808 809### OH_ArkUI_PointerEvent_GetHistoryWindowX() 810 811``` 812float OH_ArkUI_PointerEvent_GetHistoryWindowX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 813``` 814**描述：** 815 816从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的X坐标。 817 818**起始版本：** 12 819 820**参数:** 821 822| 名称 | 描述 | 823| -------- | -------- | 824| event | 表示指向当前UI输入事件的指针。 | 825| pointerIndex | 表示多点触控数据列表的序号。 | 826| historyIndex | 表示历史事件数据列表的序号。 | 827 828**返回：** 829 830返回当前带有指向性的输入事件相对于当前应用窗口左上角的X坐标，如果参数异常则返回0.0f。 831 832 833### OH_ArkUI_PointerEvent_GetHistoryWindowY() 834 835``` 836float OH_ArkUI_PointerEvent_GetHistoryWindowY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 837``` 838**描述：** 839 840从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的Y坐标。 841 842**起始版本：** 12 843 844**参数:** 845 846| 名称 | 描述 | 847| -------- | -------- | 848| event | 表示指向当前UI输入事件的指针。 | 849| pointerIndex | 表示多点触控数据列表的序号。 | 850| historyIndex | 表示历史事件数据列表的序号。 | 851 852**返回：** 853 854返回当前带有指向性的输入事件相对于当前应用窗口左上角的Y坐标，如果参数异常则返回0.0f。 855 856 857### OH_ArkUI_PointerEvent_GetHistoryX() 858 859``` 860float OH_ArkUI_PointerEvent_GetHistoryX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 861``` 862**描述：** 863 864从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的X坐标。 865 866**起始版本：** 12 867 868**参数:** 869 870| 名称 | 描述 | 871| -------- | -------- | 872| event | 表示指向当前UI输入事件的指针。 | 873| pointerIndex | 表示多点触控数据列表的序号。 | 874| historyIndex | 表示历史事件数据列表的序号。 | 875 876**返回：** 877 878返回当前带有指向性的输入事件相对于当前组件左上角的X坐标，如果参数异常则返回0.0f。 879 880 881### OH_ArkUI_PointerEvent_GetHistoryY() 882 883``` 884float OH_ArkUI_PointerEvent_GetHistoryY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex ) 885``` 886**描述：** 887 888从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的Y坐标。 889 890**起始版本：** 12 891 892**参数:** 893 894| 名称 | 描述 | 895| -------- | -------- | 896| event | 表示指向当前UI输入事件的指针。 | 897| pointerIndex | 表示多点触控数据列表的序号。 | 898| historyIndex | 表示历史事件数据列表的序号。 | 899 900**返回：** 901 902返回当前带有指向性的输入事件相对于当前组件左上角的Y坐标，如果参数异常则返回0.0f。 903 904 905### OH_ArkUI_PointerEvent_GetPointerCount() 906 907``` 908uint32_t OH_ArkUI_PointerEvent_GetPointerCount (const ArkUI_UIInputEvent * event) 909``` 910**描述：** 911 912从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点数量。 913 914**起始版本：** 12 915 916**参数:** 917 918| 名称 | 描述 | 919| -------- | -------- | 920| event | 表示指向当前UI输入事件的指针。 | 921 922**返回：** 923 924返回当前带有指向性的输入事件的接触点数量。 925 926 927### OH_ArkUI_PointerEvent_GetPointerId() 928 929``` 930int32_t OH_ArkUI_PointerEvent_GetPointerId (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 931``` 932**描述：** 933 934从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。 935 936**起始版本：** 12 937 938**参数:** 939 940| 名称 | 描述 | 941| -------- | -------- | 942| event | 表示指向当前UI输入事件的指针。 | 943| pointerIndex | 表示多点触控数据列表中的序号。 | 944 945**返回：** 946 947返回特定接触点标识。 948 949 950### OH_ArkUI_PointerEvent_GetChangedPointerId() 951 952``` 953int32_t OH_ArkUI_PointerEvent_GetChangedPointerId (const ArkUI_UIInputEvent * event, uint32_t * pointerIndex ) 954``` 955**描述：** 956 957获取当前触摸事件触发的id。 958 959**起始版本：** 15 960 961**参数:** 962 963| 名称 | 描述 | 964| -------- | -------- | 965| event | 表示指向当前UI输入事件的指针。 | 966| pointerIndex | 表示多点触控数据列表中的序号。 | 967 968**返回：** 969 970返回执行的状态代码。返回0表示设置成功，如果返回401，表示返回失败，可能的原因是参数异常，例如event是一个空指针。 971 972 973### OH_ArkUI_PointerEvent_GetPressure() 974 975``` 976float OH_ArkUI_PointerEvent_GetPressure (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 977``` 978**描述：** 979 980从带有指向性的输入事件（如触摸事件）中获取触屏压力。 981 982**起始版本：** 12 983 984**参数:** 985 986| 名称 | 描述 | 987| -------- | -------- | 988| event | 表示指向当前UI输入事件的指针。 | 989| pointerIndex | 表示多点触控数据列表中的序号。 | 990 991**返回：** 992 993返回当前带有指向性的输入事件产生的触屏压力，如果参数异常则返回0.0f。 994 995 996### OH_ArkUI_PointerEvent_GetTiltX() 997 998``` 999float OH_ArkUI_PointerEvent_GetTiltX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 1000``` 1001**描述：** 1002 1003从带有指向性的输入事件（如触摸事件）中获取相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。 1004 1005**起始版本：** 12 1006 1007**参数:** 1008 1009| 名称 | 描述 | 1010| -------- | -------- | 1011| event | 表示指向当前UI输入事件的指针。 | 1012| pointerIndex | 表示多点触控数据列表中的序号。 | 1013 1014**返回：** 1015 1016返回当前带有指向性的输入事件中相对YZ平面的角度。 1017 1018 1019### OH_ArkUI_PointerEvent_GetTiltY() 1020 1021``` 1022float OH_ArkUI_PointerEvent_GetTiltY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 1023``` 1024**描述：** 1025 1026从带有指向性的输入事件（如触摸事件）中获取相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。 1027 1028**起始版本：** 12 1029 1030**参数:** 1031 1032| 名称 | 描述 | 1033| -------- | -------- | 1034| event | 表示指向当前UI输入事件的指针。 | 1035| pointerIndex | 表示多点触控数据列表中的序号。 | 1036 1037**返回：** 1038 1039返回当前带有指向性的输入事件中相对XZ平面的角度。 1040 1041 1042### OH_ArkUI_PointerEvent_GetTouchAreaHeight() 1043 1044``` 1045float OH_ArkUI_PointerEvent_GetTouchAreaHeight (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 1046``` 1047**描述：** 1048 1049从带有指向性的输入事件（如触摸事件）中获取触屏区域的高度。 1050 1051**起始版本：** 12 1052 1053**参数:** 1054 1055| 名称 | 描述 | 1056| -------- | -------- | 1057| event | 表示指向当前UI输入事件的指针。 | 1058| pointerIndex | 表示多点触控数据列表中的序号。 | 1059 1060**返回：** 1061 1062返回当前带有指向性的输入事件中触屏区域的高度。 1063 1064 1065### OH_ArkUI_PointerEvent_GetTouchAreaWidth() 1066 1067``` 1068float OH_ArkUI_PointerEvent_GetTouchAreaWidth (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 1069``` 1070**描述：** 1071 1072从带有指向性的输入事件（如触摸事件）中获取触屏区域的宽度。 1073 1074**起始版本：** 12 1075 1076**参数:** 1077 1078| 名称 | 描述 | 1079| -------- | -------- | 1080| event | 表示指向当前UI输入事件的指针。 | 1081| pointerIndex | 表示多点触控数据列表中的序号。 | 1082 1083**返回：** 1084 1085返回当前带有指向性的输入事件中触屏区域的宽度。 1086 1087 1088### OH_ArkUI_PointerEvent_GetWindowX() 1089 1090``` 1091float OH_ArkUI_PointerEvent_GetWindowX (const ArkUI_UIInputEvent * event) 1092``` 1093**描述：** 1094 1095从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的X坐标。 1096 1097**起始版本：** 12 1098 1099**参数:** 1100 1101| 名称 | 描述 | 1102| -------- | -------- | 1103| event | 表示指向当前UI输入事件的指针。 | 1104 1105**返回：** 1106 1107返回当前带有指向性的输入事件相对于当前应用窗口左上角的X坐标，如果参数异常则返回0.0f。 1108 1109 1110### OH_ArkUI_PointerEvent_GetWindowXByIndex() 1111 1112``` 1113float OH_ArkUI_PointerEvent_GetWindowXByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 1114``` 1115**描述：** 1116 1117从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的X坐标。 1118 1119**起始版本：** 12 1120 1121**参数:** 1122 1123| 名称 | 描述 | 1124| -------- | -------- | 1125| event | 表示指向当前UI输入事件的指针。 | 1126| pointerIndex | 表示多点触控数据列表中的序号。 | 1127 1128**返回：** 1129 1130返回当前带有指向性的输入事件相对于当前应用窗口左上角的X坐标，如果参数异常则返回0.0f。 1131 1132 1133### OH_ArkUI_PointerEvent_GetWindowY() 1134 1135``` 1136float OH_ArkUI_PointerEvent_GetWindowY (const ArkUI_UIInputEvent * event) 1137``` 1138**描述：** 1139 1140从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的Y坐标。 1141 1142**起始版本：** 12 1143 1144**参数:** 1145 1146| 名称 | 描述 | 1147| -------- | -------- | 1148| event | 表示指向当前UI输入事件的指针。 | 1149 1150**返回：** 1151 1152返回当前带有指向性的输入事件相对于当前应用窗口左上角的Y坐标，如果参数异常则返回0.0f。 1153 1154 1155### OH_ArkUI_PointerEvent_GetWindowYByIndex() 1156 1157``` 1158float OH_ArkUI_PointerEvent_GetWindowYByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 1159``` 1160**描述：** 1161 1162从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的Y坐标。 1163 1164**起始版本：** 12 1165 1166**参数:** 1167 1168| 名称 | 描述 | 1169| -------- | -------- | 1170| event | 表示指向当前UI输入事件的指针。 | 1171| pointerIndex | 表示多点触控数据列表中的序号。 | 1172 1173**返回：** 1174 1175返回当前带有指向性的输入事件相对于当前应用窗口左上角的Y坐标，如果参数异常则返回0.0f。 1176 1177 1178### OH_ArkUI_PointerEvent_GetX() 1179 1180``` 1181float OH_ArkUI_PointerEvent_GetX (const ArkUI_UIInputEvent * event) 1182``` 1183**描述：** 1184 1185从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的X坐标。 1186 1187**起始版本：** 12 1188 1189**参数:** 1190 1191| 名称 | 描述 | 1192| -------- | -------- | 1193| event | 表示指向当前UI输入事件的指针。 | 1194 1195**返回：** 1196 1197返回当前带有指向性的输入事件相对于当前组件左上角的X坐标，如果参数异常则返回0.0f。 1198 1199 1200### OH_ArkUI_PointerEvent_GetXByIndex() 1201 1202``` 1203float OH_ArkUI_PointerEvent_GetXByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 1204``` 1205**描述：** 1206 1207从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的X坐标。 1208 1209**起始版本：** 12 1210 1211**参数:** 1212 1213| 名称 | 描述 | 1214| -------- | -------- | 1215| event | 表示指向当前UI输入事件的指针。 | 1216| pointerIndex | 表示多点触控数据列表中的序号。 | 1217 1218**返回：** 1219 1220返回当前带有指向性的输入事件相对于当前组件左上角的X坐标，如果参数异常则返回0.0f。 1221 1222 1223### OH_ArkUI_PointerEvent_GetY() 1224 1225``` 1226float OH_ArkUI_PointerEvent_GetY (const ArkUI_UIInputEvent * event) 1227``` 1228**描述：** 1229 1230从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的Y坐标。 1231 1232**起始版本：** 12 1233 1234**参数:** 1235 1236| 名称 | 描述 | 1237| -------- | -------- | 1238| event | 表示指向当前UI输入事件的指针。 | 1239 1240**返回：** 1241 1242返回当前带有指向性的输入事件相对于当前组件左上角的Y坐标，如果参数异常则返回0.0f。 1243 1244 1245### OH_ArkUI_PointerEvent_GetYByIndex() 1246 1247``` 1248float OH_ArkUI_PointerEvent_GetYByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex ) 1249``` 1250**描述：** 1251 1252从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的Y坐标。 1253 1254**起始版本：** 12 1255 1256**参数:** 1257 1258| 名称 | 描述 | 1259| -------- | -------- | 1260| event | 表示指向当前UI输入事件的指针。 | 1261| pointerIndex | 表示多点触控数据列表中的序号。 | 1262 1263**返回：** 1264 1265返回当前带有指向性的输入事件相对于当前组件左上角的Y坐标，如果参数异常则返回0.0f。 1266 1267 1268### OH_ArkUI_PointerEvent_SetInterceptHitTestMode() 1269 1270``` 1271int32_t OH_ArkUI_PointerEvent_SetInterceptHitTestMode (const ArkUI_UIInputEvent * event, HitTestMode mode ) 1272``` 1273**描述：** 1274 1275配置HitTest模式。 1276 1277**起始版本：** 12 1278 1279**参数:** 1280 1281| 名称 | 描述 | 1282| -------- | -------- | 1283| event | 表示指向当前UI输入事件的指针。 | 1284| mode | 指定HitTest模式，参数类型[HitTestMode](#hittestmode)。 | 1285 1286**返回：** 1287 1288返回执行的状态代码。 1289 1290 1291### OH_ArkUI_PointerEvent_SetStopPropagation() 1292 1293``` 1294int32_t OH_ArkUI_PointerEvent_SetStopPropagation (const ArkUI_UIInputEvent * event, bool stopPropagation ) 1295``` 1296**描述：** 1297 1298设置是否阻止事件冒泡。 1299 1300**起始版本：** 12 1301 1302**参数:** 1303 1304| 名称 | 描述 | 1305| -------- | -------- | 1306| event | 表示指向当前UI输入事件的指针。 | 1307| stopPropagation | 表示是否阻止事件冒泡。 | 1308 1309**返回：** 1310 1311返回执行的状态代码。返回0表示设置成功，如果返回401，表示返回失败，可能的原因是参数异常，例如event是一个空指针。 1312 1313 1314### OH_ArkUI_UIInputEvent_GetAction() 1315 1316``` 1317int32_t OH_ArkUI_UIInputEvent_GetAction (const ArkUI_UIInputEvent * event) 1318``` 1319**描述：** 1320 1321获取UI输入事件的操作类型。 1322 1323**起始版本：** 12 1324 1325**参数:** 1326 1327| 名称 | 描述 | 1328| -------- | -------- | 1329| event | 表示指向当前UI输入事件的指针。 | 1330 1331**返回：** 1332 1333返回当前UI输入事件的操作类型，如果参数异常则返回0。 1334 1335 1336### OH_ArkUI_UIInputEvent_GetDeviceId() 1337 1338``` 1339int32_t OH_ArkUI_UIInputEvent_GetDeviceId (const ArkUI_UIInputEvent * event) 1340``` 1341**描述：** 1342 1343获取当前按键的输入设备ID。 1344 1345**起始版本：** 14 1346 1347**参数:** 1348 1349| 名称 | 描述 | 1350| -------- | -------- | 1351| event | ArkUI_UIInputEvent事件指针。 | 1352 1353**返回：** 1354 1355当前按键的输入设备ID。 1356 1357 1358### OH_ArkUI_UIInputEvent_GetEventTime() 1359 1360``` 1361int64_t OH_ArkUI_UIInputEvent_GetEventTime (const ArkUI_UIInputEvent * event) 1362``` 1363**描述：** 1364 1365获取UI输入事件发生的时间。 1366 1367**起始版本：** 12 1368 1369**参数:** 1370 1371| 名称 | 描述 | 1372| -------- | -------- | 1373| event | 表示指向当前UI输入事件的指针。 | 1374 1375**返回：** 1376 1377返回UI输入事件发生的时间，如果参数异常则返回0。 1378 1379 1380### OH_ArkUI_UIInputEvent_GetPressedKeys() 1381 1382``` 1383int32_t OH_ArkUI_UIInputEvent_GetPressedKeys (const ArkUI_UIInputEvent * event, int32_t * pressedKeyCodes, int32_t * length ) 1384``` 1385**描述：** 1386 1387获取功能键按压状态。报错信息请参考以下错误码。支持功能键 'Ctrl'|'Alt'|'Shift'|'Fn'，设备外接带Fn键的键盘不支持Fn键查询。 1388 1389**起始版本：** 14 1390 1391**参数:** 1392 1393| 名称 | 描述 | 1394| -------- | -------- | 1395| event | ArkUI_UIInputEvent事件指针。 | 1396| pressedKeyCodes | 输出参数，表示所有按下键的数组，指向的内存空间需要调用者申请。 | 1397| length | 作为输入参数表示传入的pressedKeyCodes数组长度，作为输出参数表示实际按下按键的个数。 | 1398 1399**返回：** 1400 1401[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 [ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR](_ark_u_i___native_module.md) 内存分配不足。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。 1402 1403 1404### OH_ArkUI_UIInputEvent_GetSourceType() 1405 1406``` 1407int32_t OH_ArkUI_UIInputEvent_GetSourceType (const ArkUI_UIInputEvent * event) 1408``` 1409**描述：** 1410 1411获取产生UI输入事件的来源类型。 1412 1413**起始版本：** 12 1414 1415**参数:** 1416 1417| 名称 | 描述 | 1418| -------- | -------- | 1419| event | 表示指向当前UI输入事件的指针。 | 1420 1421**返回：** 1422 1423返回产生当前UI输入事件的来源类型。 1424 1425 1426### OH_ArkUI_UIInputEvent_GetToolType() 1427 1428``` 1429int32_t OH_ArkUI_UIInputEvent_GetToolType (const ArkUI_UIInputEvent * event) 1430``` 1431**描述：** 1432 1433获取产生UI输入事件的工具类型。 1434 1435**起始版本：** 12 1436 1437**参数:** 1438 1439| 名称 | 描述 | 1440| -------- | -------- | 1441| event | 表示指向当前UI输入事件的指针。 | 1442 1443**返回：** 1444 1445返回产生当前UI输入事件的工具类型。 1446 1447 1448### OH_ArkUI_UIInputEvent_GetType() 1449 1450``` 1451int32_t OH_ArkUI_UIInputEvent_GetType (const ArkUI_UIInputEvent * event) 1452``` 1453**描述：** 1454 1455获取UI输入事件的类型。 1456 1457**起始版本：** 12 1458 1459**参数:** 1460 1461| 名称 | 描述 | 1462| -------- | -------- | 1463| event | 表示指向当前UI输入事件的指针。 | 1464 1465**返回：** 1466 1467返回当前UI输入事件的类型，如果参数异常则返回0。 1468 1469 1470### OH_ArkUI_PointerEvent_GetInteractionHand() 1471 1472``` 1473int32_t OH_ArkUI_PointerEvent_GetInteractionHand (const ArkUI_UIInputEvent * event, ArkUI_InteractionHand * hand) 1474``` 1475**描述：** 1476 1477获取当前触摸事件是左手点击触发还是右手点击触发。 1478 1479**起始版本：** 15 1480 1481**参数:** 1482 1483| 名称 | 描述 | 1484| -------- | -------- | 1485| event | 表示指向当前UI输入事件的指针。 | 1486| hand | 返回当前事件识别的交互手。 | 1487 1488 1489### OH_ArkUI_PointerEvent_GetInteractionHandByIndex() 1490 1491``` 1492int32_t OH_ArkUI_PointerEvent_GetInteractionHandByIndex (const ArkUI_UIInputEvent * event, int32_t pointerIndex, ArkUI_InteractionHand * hand) 1493``` 1494**描述：** 1495 1496获取当前触摸事件是左手点击触发还是右手点击触发。 1497 1498**起始版本：** 15 1499 1500**参数:** 1501 1502| 名称 | 描述 | 1503| -------- | -------- | 1504| event | 表示指向当前UI输入事件的指针。 | 1505| pointerIndex | 表示多点触控数据列表中的序号。 | 1506| hand | 返回指定手指的交互手。 | 1507 1508**返回：** 1509 1510[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。 1511 1512 1513### OH_ArkUI_FocusAxisEvent_GetAxisValue() 1514 1515``` 1516double OH_ArkUI_FocusAxisEvent_GetAxisValue (const ArkUI_UIInputEvent * event， int32_t axis) 1517``` 1518**描述：** 1519 1520获取焦点轴事件的轴值。 1521 1522**起始版本：** 15 1523 1524**参数:** 1525 1526| 名称 | 描述 | 1527| -------- | -------- | 1528| event | 表示指向当前UI输入事件的指针。 | 1529| axis | 焦点轴事件的轴类型。 | 1530 1531**返回：** 1532 1533返回焦点轴事件的轴值，如果参数异常则返回0.0。 1534 1535 1536### OH_ArkUI_FocusAxisEvent_SetStopPropagation() 1537 1538``` 1539int32_t OH_ArkUI_FocusAxisEvent_SetStopPropagation (const ArkUI_UIInputEvent * event， bool stopPropagation) 1540``` 1541**描述：** 1542 1543设置是否阻止焦点轴事件冒泡。 1544 1545**起始版本：** 15 1546 1547**参数:** 1548 1549| 名称 | 描述 | 1550| -------- | -------- | 1551| event | 表示指向当前UI输入事件的指针。 | 1552| stopPropagation | 是否阻止事件冒泡。 | 1553 1554**返回：** 1555 1556[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。 1557 1558 1559### OH_ArkUI_PointerEvent_GetPressedTimeByIndex() 1560 1561``` 1562int64_t OH_ArkUI_PointerEvent_GetPressedTimeByIndex (const ArkUI_UIInputEvent* event, uint32_t pointerIndex) 1563``` 1564**描述：** 1565 1566获取特定触摸点的按压时间。 1567 1568**起始版本：** 15 1569 1570**参数:** 1571 1572| 名称 | 描述 | 1573| -------- | -------- | 1574| event | 表示指向当前UI输入事件的指针。 | 1575| pointerIndex | 指示多点触控数据列表中目标触控点的索引。 | 1576 1577**返回：** 1578 1579返回特定触摸点的按下时间；如果发生任何参数错误，则返回0。 1580 1581 1582### OH_ArkUI_MouseEvent_GetRawDeltaX() 1583 1584``` 1585float OH_ArkUI_MouseEvent_GetRawDeltaX (const ArkUI_UIInputEvent* event) 1586``` 1587**描述：** 1588 1589获取X轴相对于前一个上报的鼠标事件的鼠标指针位置的偏移量。当鼠标指针位于屏幕边缘时，该值可能小于两次上报的X坐标的差。 1590 1591**起始版本：** 15 1592 1593**参数:** 1594 1595| 名称 | 描述 | 1596| -------- | -------- | 1597| event | 表示指向当前UI输入事件的指针。 | 1598 1599**返回：** 1600 1601返回相对于前一个上报的鼠标事件的鼠标指针位置的X轴偏移量；如果发生任何参数错误，则返回0.0f。 1602 1603 1604### OH_ArkUI_MouseEvent_GetRawDeltaY() 1605 1606``` 1607float OH_ArkUI_MouseEvent_GetRawDeltaY (const ArkUI_UIInputEvent* event) 1608``` 1609**描述：** 1610 1611获取Y轴相对于前一个上报的鼠标事件的鼠标指针位置的偏移量。当鼠标指针位于屏幕边缘时，该值可能小于两次上报的Y坐标的差。 1612 1613**起始版本：** 15 1614 1615**参数:** 1616 1617| 名称 | 描述 | 1618| -------- | -------- | 1619| event | 表示指向当前UI输入事件的指针。 | 1620 1621**返回：** 1622 1623返回相对于前一个上报的鼠标事件的鼠标指针位置的Y轴偏移量；如果发生任何参数错误，则返回0.0f。 1624 1625 1626### OH_ArkUI_MouseEvent_GetPressedButtons() 1627 1628``` 1629int32_t OH_ArkUI_MouseEvent_GetPressedButtons (const ArkUI_UIInputEvent* event, int32_t* pressedButtons, int32_t* length) 1630``` 1631**描述：** 1632 1633从鼠标事件中获取按下的按钮。 1634 1635**起始版本：** 15 1636 1637**参数:** 1638 1639| 名称 | 描述 | 1640| -------- | -------- | 1641| event | 表示指向当前UI输入事件的指针。 | 1642| pressedButtons | 指示按下按钮的列表。需要先创建一个int数组，用来储存按下的按钮。 | 1643| length | 作为输入参数表示传入的pressedButtons数组长度，作为输出参数表示实际按下按键的个数。 | 1644 1645**返回：** 1646 1647[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。[ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR](_ark_u_i___native_module.md) 给定的缓冲区不够。 1648 1649 1650### OH_ArkUI_UIInputEvent_GetTargetDisplayId() 1651 1652``` 1653int32_t OH_ArkUI_UIInputEvent_GetTargetDisplayId (const ArkUI_UIInputEvent* event) 1654``` 1655**描述：** 1656 1657获取发生UI输入事件的屏幕ID。 1658 1659**起始版本：** 15 1660 1661**参数:** 1662 1663| 名称 | 描述 | 1664| -------- | -------- | 1665| event | 表示指向当前UI输入事件的指针。 | 1666 1667**返回：** 1668 1669返回屏幕ID；如果发生任何参数错误，则返回0。 1670 1671 1672### OH_ArkUI_PointerEvent_CreateClonedEvent() 1673 1674``` 1675int32_t OH_ArkUI_PointerEvent_CreateClonedEvent(const ArkUI_UIInputEvent* event, ArkUI_UIInputEvent** clonedEvent) 1676``` 1677**描述：** 1678 1679基于原始事件指针创建克隆事件指针。 1680 1681**起始版本：** 15 1682 1683**参数:** 1684 1685| 名称 | 描述 | 1686| -------- | -------- | 1687| event | ArkUI_UIInputEvent事件指针。 | 1688| clonedEvent | ArkUI_UIInputEvent克隆事件指针。 | 1689 1690**返回：** 1691 1692[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 1693[ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。 1694 1695### OH_ArkUI_PointerEvent_DestroyClonedEvent() 1696 1697``` 1698int32_t OH_ArkUI_PointerEvent_DestroyClonedEvent(const ArkUI_UIInputEvent* event) 1699``` 1700**描述：** 1701 1702销毁克隆事件指针。 1703 1704**起始版本：** 15 1705 1706**参数:** 1707 1708| 名称 | 描述 | 1709| -------- | -------- | 1710| event | ArkUI_UIInputEvent事件指针。 | 1711 1712**返回：** 1713 1714[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 1715[ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。 1716[ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT](_ark_u_i___native_module.md) 输入的事件指针不是克隆事件。 1717 1718### OH_ArkUI_PointerEvent_SetClonedEventLocalPosition() 1719 1720``` 1721int32_t OH_ArkUI_PointerEvent_SetClonedEventLocalPosition(const ArkUI_UIInputEvent * event, float x, float y) 1722``` 1723**描述：** 1724 1725设置指向性事件相对于当前组件左上角的X坐标和Y坐标。 1726 1727**起始版本：** 15 1728 1729**参数:** 1730 1731| 名称 | 描述 | 1732| -------- | -------- | 1733| event | ArkUI_UIInputEvent事件指针。 | 1734| x | 当前带有指向性的输入事件相对于当前组件左上角的X坐标。 | 1735| y | 当前带有指向性的输入事件相对于当前组件左上角的Y坐标。 | 1736 1737**返回：** 1738 1739[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 1740[ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。 1741[ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT](_ark_u_i___native_module.md) 输入的事件指针不是克隆事件。 1742 1743### OH_ArkUI_PointerEvent_SetClonedEventLocalPositionByIndex() 1744 1745``` 1746int32_t OH_ArkUI_PointerEvent_SetClonedEventLocalPositionByIndex(const ArkUI_UIInputEvent * event, 1747float x, float y, int32_t pointerIndex) 1748``` 1749**描述：** 1750 1751设置指向性事件特有接触点相对于当前组件左上角的X坐标和Y坐标。 1752 1753**起始版本：** 15 1754 1755**参数:** 1756 1757| 名称 | 描述 | 1758| -------- | -------- | 1759| event | ArkUI_UIInputEvent事件指针。 | 1760| x | 当前带有指向性的输入事件相对于当前组件左上角的X坐标。 | 1761| y | 当前带有指向性的输入事件相对于当前组件左上角的Y坐标。 | 1762| pointerIndex | 表示多点触控数据列表中的序号。 | 1763 1764**返回：** 1765 1766[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 1767[ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。 1768[ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT](_ark_u_i___native_module.md) 输入的事件指针不是克隆事件。 1769 1770### OH_ArkUI_PointerEvent_SetClonedEventActionType() 1771 1772``` 1773int32_t OH_ArkUI_PointerEvent_SetClonedEventActionType(const ArkUI_UIInputEvent * event, int32_t actionType) 1774``` 1775**描述：** 1776 1777设置当前带有指向性的克隆输入事件的事件类型。 1778 1779**起始版本：** 15 1780 1781**参数:** 1782 1783| 名称 | 描述 | 1784| -------- | -------- | 1785| event | ArkUI_UIInputEvent事件指针。 | 1786| actionType | 事件类型。 | 1787 1788**返回：** 1789 1790[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 1791[ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。 1792[ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT](_ark_u_i___native_module.md) 输入的事件指针不是克隆事件。 1793 1794### OH_ArkUI_PointerEvent_SetClonedEventChangedFingerId() 1795 1796``` 1797int32_t OH_ArkUI_PointerEvent_SetClonedEventChangedFingerId(const ArkUI_UIInputEvent * event, int32_t fingerId) 1798``` 1799**描述：** 1800 1801设置当前带有指向性的克隆输入事件的触摸点ID。 1802 1803**起始版本：** 15 1804 1805**参数:** 1806 1807| 名称 | 描述 | 1808| -------- | -------- | 1809| event | ArkUI_UIInputEvent事件指针。 | 1810| fingerId | 触发当前事件指针的触摸点ID。 | 1811 1812**返回：** 1813 1814[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 1815[ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。 1816[ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT](_ark_u_i___native_module.md) 输入的事件指针不是克隆事件。 1817 1818### OH_ArkUI_PointerEvent_SetClonedEventFingerIdByIndex() 1819 1820``` 1821int32_t OH_ArkUI_PointerEvent_SetClonedEventFingerIdByIndex(const ArkUI_UIInputEvent * event, 1822int32_t fingerId, int32_t pointerIndex) 1823``` 1824**描述：** 1825 1826设置带有指向性的克隆输入事件特定接触点的触摸点ID。 1827 1828**起始版本：** 15 1829 1830**参数:** 1831 1832| 名称 | 描述 | 1833| -------- | -------- | 1834| event | ArkUI_UIInputEvent事件指针。 | 1835| fingerId | 触发当前事件指针的触摸点ID。 | 1836| pointerIndex | 表示多点触控数据列表中的序号。 | 1837 1838**返回：** 1839 1840[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 1841[ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。 1842[ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT](_ark_u_i___native_module.md) 输入的事件指针不是克隆事件。 1843 1844### OH_ArkUI_PointerEvent_PostClonedEvent() 1845 1846``` 1847int32_t OH_ArkUI_PointerEvent_PostClonedEvent(ArkUI_NodeHandle node, const ArkUI_UIInputEvent * event) 1848``` 1849**描述：** 1850 1851转发克隆事件到特定节点。 1852 1853**起始版本：** 15 1854 1855**参数:** 1856 1857| 名称 | 描述 | 1858| -------- | -------- | 1859| event | ArkUI_UIInputEvent事件指针。 | 1860 1861**返回：** 1862 1863[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 1864[ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。 1865[ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT](_ark_u_i___native_module.md) 输入的事件指针不是克隆事件。 1866[ARKUI_ERROR_CODE_POST_CLONED_COMPONENT_STATUS_ABNORMAL](_ark_u_i___native_module.md) 组件状态异常。 1867[ARKUI_ERROR_CODE_POST_CLONED_NO_COMPONENT_HIT_TO_RESPOND_TO_THE_EVENT](_ark_u_i___native_module.md) 未命中可响应事件的组件。 1868