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