harmony 鸿蒙ArkUI_EventModule

2025-06-12
浏览 (4)

ArkUI_EventModule

概述

在Native端提供ArkUI的UI输入事件能力。

起始版本： 12

汇总

文件

名称	描述
ui_input_event.h	提供ArkUI在Native侧的事件定义。

类型定义

名称	描述
typedef struct ArkUI_UIInputEvent ArkUI_UIInputEvent	UI输入事件定义。

枚举

名称	描述
ArkUI_UIInputEvent_Type { ARKUI_UIINPUTEVENT_TYPE_UNKNOWN = 0, ARKUI_UIINPUTEVENT_TYPE_TOUCH = 1, ARKUI_UIINPUTEVENT_TYPE_AXIS = 2, ARKUI_UIINPUTEVENT_TYPE_MOUSE = 3, ARKUI_UIINPUTEVENT_TYPE_KEY = 4²⁰⁺ }	UI输入事件类型定义。
{ OH_NATIVEXCOMPONENT_RESULT_SUCCESS = 0, OH_NATIVEXCOMPONENT_RESULT_FAILED = -1, OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER = -2, UI_TOUCH_EVENT_ACTION_CANCEL = 0, UI_TOUCH_EVENT_ACTION_DOWN = 1, UI_TOUCH_EVENT_ACTION_MOVE = 2, UI_TOUCH_EVENT_ACTION_UP = 3 }	定义输入事件的Action Code。
{ 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, UI_INPUT_EVENT_TOOL_TYPE_TOUCHPAD = 4, UI_INPUT_EVENT_TOOL_TYPE_JOYSTICK = 5 }	产生输入事件的工具类型定义。
{ UI_INPUT_EVENT_SOURCE_TYPE_UNKNOWN = 0, UI_INPUT_EVENT_SOURCE_TYPE_MOUSE = 1, UI_INPUT_EVENT_SOURCE_TYPE_TOUCH_SCREEN = 2 }	产生输入事件的来源类型定义。
HitTestMode { HTM_DEFAULT = 0, HTM_BLOCK, HTM_TRANSPARENT, HTM_NONE }	定义触摸测试类型的枚举值。
{ 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。
{ UI_MOUSE_EVENT_BUTTON_NONE = 0, UI_MOUSE_EVENT_BUTTON_LEFT = 1, UI_MOUSE_EVENT_BUTTON_RIGHT = 2, UI_MOUSE_EVENT_BUTTON_MIDDLE = 3, UI_MOUSE_EVENT_BUTTON_BACK = 4, UI_MOUSE_EVENT_BUTTON_FORWARD = 5 }	定义鼠标事件的按键类型。
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按键。
{ 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, 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 }	定义焦点轴事件的轴类型。
{ ARKUI_EVENT_HAND_NONE = 0, ARKUI_EVENT_HAND_LEFT = 1, ARKUI_EVENT_HAND_RIGHT = 2 }	定义事件是由左手点击触发还是右手点击触发。

函数

名称	描述
int32_t OH_ArkUI_UIInputEvent_GetType (const ArkUI_UIInputEvent *event)	获取UI输入事件的类型。
int32_t OH_ArkUI_UIInputEvent_GetAction (const ArkUI_UIInputEvent *event)	获取UI输入事件的操作类型。
int32_t OH_ArkUI_UIInputEvent_GetSourceType (const ArkUI_UIInputEvent *event)	获取产生UI输入事件的来源类型。
int32_t OH_ArkUI_UIInputEvent_GetToolType (const ArkUI_UIInputEvent *event)	获取产生UI输入事件的工具类型。
int64_t OH_ArkUI_UIInputEvent_GetEventTime (const ArkUI_UIInputEvent *event)	获取UI输入事件发生的时间。
uint32_t OH_ArkUI_PointerEvent_GetPointerCount (const ArkUI_UIInputEvent *event)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点数量。
int32_t OH_ArkUI_PointerEvent_GetPointerId (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。
int32_t OH_ArkUI_PointerEvent_GetChangedPointerId (const ArkUI_UIInputEvent event, uint32_t pointerIndex)	获取当前触摸事件触发的id。
float OH_ArkUI_PointerEvent_GetX (const ArkUI_UIInputEvent *event)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的X坐标。
float OH_ArkUI_PointerEvent_GetXByIndex (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的X坐标。
float OH_ArkUI_PointerEvent_GetY (const ArkUI_UIInputEvent *event)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的Y坐标。
float OH_ArkUI_PointerEvent_GetYByIndex (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的Y坐标。
float OH_ArkUI_PointerEvent_GetWindowX (const ArkUI_UIInputEvent *event)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的X坐标。
float OH_ArkUI_PointerEvent_GetWindowXByIndex (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的X坐标。
float OH_ArkUI_PointerEvent_GetWindowY (const ArkUI_UIInputEvent *event)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的Y坐标。
float OH_ArkUI_PointerEvent_GetWindowYByIndex (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的Y坐标。
float OH_ArkUI_PointerEvent_GetDisplayX (const ArkUI_UIInputEvent *event)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的X坐标。
float OH_ArkUI_PointerEvent_GetDisplayXByIndex (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的X坐标。
float OH_ArkUI_PointerEvent_GetDisplayY (const ArkUI_UIInputEvent *event)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的Y坐标。
float OH_ArkUI_PointerEvent_GetDisplayYByIndex (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的Y坐标。
float OH_ArkUI_PointerEvent_GetPressure (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件）中获取触屏压力。
float OH_ArkUI_PointerEvent_GetTiltX (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件）中获取相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。
float OH_ArkUI_PointerEvent_GetTiltY (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件）中获取相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。
int32_t OH_ArkUI_PointerEvent_GetRollAngle (const ArkUI_UIInputEvent event, double rollAngle)	从带有指向性的输入事件（如触摸事件）中获取手写笔与设备平面的夹角。
float OH_ArkUI_PointerEvent_GetTouchAreaWidth (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件）中获取触屏区域的宽度。
float OH_ArkUI_PointerEvent_GetTouchAreaHeight (const ArkUI_UIInputEvent *event, uint32_t pointerIndex)	从带有指向性的输入事件（如触摸事件）中获取触屏区域的高度。
uint32_t OH_ArkUI_PointerEvent_GetHistorySize (const ArkUI_UIInputEvent *event)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件数量。
int64_t OH_ArkUI_PointerEvent_GetHistoryEventTime (const ArkUI_UIInputEvent *event, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件发生的时间。
uint32_t OH_ArkUI_PointerEvent_GetHistoryPointerCount (const ArkUI_UIInputEvent *event, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中多点触控的接触点数量。
int32_t OH_ArkUI_PointerEvent_GetHistoryPointerId (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。
float OH_ArkUI_PointerEvent_GetHistoryX (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的X坐标。
float OH_ArkUI_PointerEvent_GetHistoryY (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的Y坐标。
float OH_ArkUI_PointerEvent_GetHistoryWindowX (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的X坐标。
float OH_ArkUI_PointerEvent_GetHistoryWindowY (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的Y坐标。
float OH_ArkUI_PointerEvent_GetHistoryDisplayX (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的X坐标。
float OH_ArkUI_PointerEvent_GetHistoryDisplayY (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的Y坐标。
float OH_ArkUI_PointerEvent_GetHistoryPressure (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏压力。
float OH_ArkUI_PointerEvent_GetHistoryTiltX (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。
float OH_ArkUI_PointerEvent_GetHistoryTiltY (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。
float OH_ArkUI_PointerEvent_GetHistoryTouchAreaWidth (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的宽度。
float OH_ArkUI_PointerEvent_GetHistoryTouchAreaHeight (const ArkUI_UIInputEvent *event, uint32_t pointerIndex, uint32_t historyIndex)	从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的高度。
double OH_ArkUI_AxisEvent_GetVerticalAxisValue (const ArkUI_UIInputEvent *event)	获取当前轴事件的垂直滚动轴的值。
double OH_ArkUI_AxisEvent_GetHorizontalAxisValue (const ArkUI_UIInputEvent *event)	获取当前轴事件的水平滚动轴的值。
double OH_ArkUI_AxisEvent_GetPinchAxisScaleValue (const ArkUI_UIInputEvent *event)	获取当前轴事件的捏合轴缩放的值。
int32_t OH_ArkUI_AxisEvent_GetAxisAction(const ArkUI_UIInputEvent *event)	获取当前轴事件的操作类型的值。
int32_t OH_ArkUI_PointerEvent_SetInterceptHitTestMode (const ArkUI_UIInputEvent *event, HitTestMode mode)	配置HitTest模式。
int32_t OH_ArkUI_MouseEvent_GetMouseButton (const ArkUI_UIInputEvent *event)	获取鼠标事件的按键类型的值。
int32_t OH_ArkUI_MouseEvent_GetMouseAction (const ArkUI_UIInputEvent *event)	获取鼠标事件的鼠标动作类型的值。
int32_t OH_ArkUI_PointerEvent_SetStopPropagation (const ArkUI_UIInputEvent *event, bool stopPropagation)	设置是否阻止事件冒泡。
int32_t OH_ArkUI_UIInputEvent_GetDeviceId (const ArkUI_UIInputEvent *event)	获取当前按键的输入设备ID。
int32_t OH_ArkUI_UIInputEvent_GetPressedKeys (const ArkUI_UIInputEvent event, int32_t pressedKeyCodes, int32_t *length)	获取所有按下的按键，当前只支持按键事件。
double OH_ArkUI_FocusAxisEvent_GetAxisValue (const ArkUI_UIInputEvent event, int32_t axis)	获取焦点轴事件的轴值。
int32_t OH_ArkUI_FocusAxisEvent_SetStopPropagation (const ArkUI_UIInputEvent event, bool stopPropagation)	设置是否阻止焦点轴事件冒泡。
int32_t OH_ArkUI_PointerEvent_GetInteractionHand (const ArkUI_UIInputEvent event, ArkUI_InteractionHand hand)	获取当前触摸事件是左手点击触发还是右手点击触发。
int32_t OH_ArkUI_PointerEvent_GetInteractionHandByIndex (const ArkUI_UIInputEvent event, int32_t pointerIndex, ArkUI_InteractionHand hand)	获取当前触摸事件是左手点击触发还是右手点击触发。
float OH_ArkUI_UIInputEvent_GetEventTargetWidth (const ArkUI_UIInputEvent)	获取事件命中的组件的宽度。
float OH_ArkUI_UIInputEvent_GetEventTargetHeight (const ArkUI_UIInputEvent)	获取事件命中的组件的高度。
float OH_ArkUI_UIInputEvent_GetEventTargetPositionX (const ArkUI_UIInputEvent)	获取事件命中的组件的X坐标。
float OH_ArkUI_UIInputEvent_GetEventTargetPositionY (const ArkUI_UIInputEvent)	获取事件命中的组件的Y坐标。
float OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionX (const ArkUI_UIInputEvent)	获取事件命中的组件的全局X坐标。
float OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionY (const ArkUI_UIInputEvent)	获取事件命中的组件的全局Y坐标。
int32_t OH_ArkUI_UIInputEvent_GetModifierKeyStates (const ArkUI_UIInputEvent, uint64_t *keys)	获取UI输入事件的功能键按压状态。
bool OH_ArkUI_HoverEvent_IsHovered (const ArkUI_UIInputEvent)	获取鼠标是否悬浮在当前组件上。
int32_t OH_ArkUI_PointerEvent_CreateClonedEvent (const ArkUI_UIInputEvent event, ArkUI_UIInputEvent clonedevent)	基于原始事件指针创建克隆事件指针。
int32_t OH_ArkUI_PointerEvent_DestroyClonedEvent (const ArkUI_UIInputEvent *event)	销毁克隆事件指针。
int32_t OH_ArkUI_PointerEvent_SetClonedEventLocalPosition (const ArkUI_UIInputEvent *event, float x, float y)	设置指向性事件相对于当前组件左上角的X坐标和Y坐标。
int32_t OH_ArkUI_PointerEvent_SetClonedEventLocalPositionByIndex (const ArkUI_UIInputEvent *event, float x, float y, int32_t pointerIndex)	设置指向性事件特有接触点相对于当前组件左上角的X坐标和Y坐标。
int32_t OH_ArkUI_PointerEvent_SetClonedEventActionType (const ArkUI_UIInputEvent *event, int32_t actionType)	设置当前带有指向性的克隆输入事件的事件类型。
int32_t OH_ArkUI_PointerEvent_SetClonedEventChangedFingerId (const ArkUI_UIInputEvent *event, int32_t fingerId)	设置当前带有指向性的克隆输入事件的触摸点ID。
int32_t OH_ArkUI_PointerEvent_SetClonedEventFingerIdByIndex (const ArkUI_UIInputEvent *event, int32_t fingerId, int32_t pointerIndex)	设置带有指向性的克隆输入事件特定接触点的触摸点ID。
int32_t OH_ArkUI_PointerEvent_PostClonedEvent (ArkUI_NodeHandle node, const ArkUI_UIInputEvent event)	转发克隆事件到特定节点。
int64_t OH_ArkUI_PointerEvent_GetPressedTimeByIndex (const ArkUI_UIInputEvent *event, int32_t pointerIndex)	获取特定触摸点的按压时间。
float OH_ArkUI_MouseEvent_GetRawDeltaX (const ArkUI_UIInputEvent *event)	获取X轴相对于前一个上报的鼠标事件的鼠标指针位置的偏移量。当鼠标指针位于屏幕边缘时，该值可能小于两次上报的X坐标的差。
float OH_ArkUI_MouseEvent_GetRawDeltaY (const ArkUI_UIInputEvent *event)	获取相对于前一个上报的鼠标事件的鼠标指针位置的Y轴偏移量。当鼠标指针位于屏幕边缘时，该值可能小于两次上报的Y坐标的差。
int32_t OH_ArkUI_MouseEvent_GetPressedButtons (const ArkUI_UIInputEvent event, int32_t pressedButtons, int32_t* length)	从鼠标事件中获取按下的按钮。
int32_t OH_ArkUI_UIInputEvent_GetTargetDisplayId (const ArkUI_UIInputEvent *event)	获取发生UI输入事件的屏幕ID。
int32_t OH_ArkUI_AxisEvent_SetPropagation(const ArkUI_UIInputEvent *event, bool propagation)	设置是否激活轴事件冒泡。
int32_t OH_ArkUI_AxisEvent_GetScrollStep(const ArkUI_UIInputEvent *event)	获取鼠标滚轮轴滚动步长配置。
ArkUI_ErrorCode OH_ArkUI_UIInputEvent_GetLatestStatus()	调用该方法获取最近一次UIInput相关方法的执行情况。通常情况下不需要使用该方法，仅在返回值结果不确定是否异常时使用。起始版本： 20

类型定义说明

ArkUI_UIInputEvent

typedef struct ArkUI_UIInputEvent ArkUI_UIInputEvent

描述：

UI输入事件定义。

起始版本： 12

枚举类型说明

anonymous enum

anonymous enum

描述：

定义输入事件的Action Code。

起始版本： 12

枚举值	描述
OH_NATIVEXCOMPONENT_RESULT_SUCCESS	成功结果。
OH_NATIVEXCOMPONENT_RESULT_FAILED	失败结果。
OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER	无效参数。
UI_TOUCH_EVENT_ACTION_CANCEL	触摸取消。
UI_TOUCH_EVENT_ACTION_DOWN	触摸按下。
UI_TOUCH_EVENT_ACTION_MOVE	触摸移动。
UI_TOUCH_EVENT_ACTION_UP	触摸抬起。

anonymous enum

anonymous enum

描述：

产生输入事件的工具类型定义。

起始版本： 12

枚举值	描述
UI_INPUT_EVENT_TOOL_TYPE_UNKNOWN	不支持的工具类型。
UI_INPUT_EVENT_TOOL_TYPE_FINGER	手指。
UI_INPUT_EVENT_TOOL_TYPE_PEN	笔。
UI_INPUT_EVENT_TOOL_TYPE_MOUSE	鼠标。
UI_INPUT_EVENT_TOOL_TYPE_TOUCHPAD	触控板。
UI_INPUT_EVENT_TOOL_TYPE_JOYSTICK	操纵杆。

anonymous enum

anonymous enum

描述：

产生输入事件的来源类型定义。

起始版本： 12

枚举值	描述
UI_INPUT_EVENT_SOURCE_TYPE_UNKNOWN	不支持的来源类型。
UI_INPUT_EVENT_SOURCE_TYPE_MOUSE	鼠标。
UI_INPUT_EVENT_SOURCE_TYPE_TOUCH_SCREEN	触摸屏。

anonymous enum

anonymous enum

描述：

定义鼠标事件的Action Code。

起始版本： 12

枚举值	描述
UI_MOUSE_EVENT_ACTION_UNKNOWN	无效行为。
UI_MOUSE_EVENT_ACTION_PRESS	鼠标按键按下。
UI_MOUSE_EVENT_ACTION_RELEASE	鼠标按键松开。
UI_MOUSE_EVENT_ACTION_MOVE	鼠标移动。
UI_MOUSE_EVENT_ACTION_CANCEL	鼠标按键被取消。起始版本： 18

anonymous enum

anonymous enum

描述：

定义鼠标事件的按键类型。

起始版本： 12

枚举值	描述
UI_MOUSE_EVENT_BUTTON_NONE	无按键。
UI_MOUSE_EVENT_BUTTON_LEFT	鼠标左键。
UI_MOUSE_EVENT_BUTTON_RIGHT	鼠标右键。
UI_MOUSE_EVENT_BUTTON_MIDDLE	鼠标中键。
UI_MOUSE_EVENT_BUTTON_BACK	鼠标左侧后退键。
UI_MOUSE_EVENT_BUTTON_FORWARD	鼠标左侧前进键。

ArkUI_ModifierKeyName

enum ArkUI_ModifierKeyName

描述：

定义modifier按键。

起始版本： 12

枚举值	描述
ARKUI_MODIFIER_KEY_CTRL	Ctrl.
ARKUI_MODIFIER_KEY_SHIFT	Shift.
ARKUI_MODIFIER_KEY_ALT	Alt.
ARKUI_MODIFIER_KEY_FN	Fn（仅调试使用，通常不上报Fn状态）.

ArkUI_UIInputEvent_Type

enum ArkUI_UIInputEvent_Type

描述：

UI输入事件类型定义。

起始版本： 12

HitTestMode

enum HitTestMode

描述：

定义触摸测试类型的枚举值。

起始版本： 12

枚举值	描述
HTM_DEFAULT	默认触摸测试效果，自身和子节点都响应触摸测试，但会阻塞兄弟节点的触摸测试。
HTM_BLOCK	自身响应触摸测试，阻塞子节点和兄弟节点的触摸测试。
HTM_TRANSPARENT	自身和子节点都响应触摸测试，不会阻塞兄弟节点的触摸测试。
HTM_NONE	自身不响应触摸测试，不会阻塞子节点和兄弟节点的触摸测试。

anonymous enum

anonymous enum

描述：

定义焦点轴事件的轴类型。

起始版本： 15

枚举值	描述
UI_FOCUS_AXIS_EVENT_ABS_X	游戏手柄X轴。
UI_FOCUS_AXIS_EVENT_ABS_Y	游戏手柄Y轴。
UI_FOCUS_AXIS_EVENT_ABS_Z	游戏手柄Z轴。
UI_FOCUS_AXIS_EVENT_ABS_RZ	游戏手柄RZ轴。
UI_FOCUS_AXIS_EVENT_ABS_GAS	游戏手柄GAS轴。
UI_FOCUS_AXIS_EVENT_ABS_BRAKE	游戏手柄BRAKE轴。
UI_FOCUS_AXIS_EVENT_ABS_HAT0X	游戏手柄HAT0X轴。
UI_FOCUS_AXIS_EVENT_ABS_HAT0Y	游戏手柄HAT0Y轴。

InteractionHand

enum ArkUI_InteractionHand

描述：

定义事件是由左手点击触发还是右手点击触发。

起始版本： 15

枚举值	描述
ARKUI_EVENT_HAND_NONE	未知。
ARKUI_EVENT_HAND_LEFT	左手。
ARKUI_EVENT_HAND_RIGHT	右手。

函数说明

OH_ArkUI_AxisEvent_GetHorizontalAxisValue()

double OH_ArkUI_AxisEvent_GetHorizontalAxisValue (const ArkUI_UIInputEvent * event)

描述：

获取当前轴事件的水平滚动轴的值。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前轴事件的水平滚动轴的值，如果参数异常则返回0.0。

OH_ArkUI_AxisEvent_GetPinchAxisScaleValue()

double OH_ArkUI_AxisEvent_GetPinchAxisScaleValue (const ArkUI_UIInputEvent * event)

描述：

获取当前轴事件的捏合轴缩放的值。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前轴事件的捏合轴缩放的值，如果参数异常则返回0.0。

OH_ArkUI_AxisEvent_GetVerticalAxisValue()

double OH_ArkUI_AxisEvent_GetVerticalAxisValue (const ArkUI_UIInputEvent * event)

描述：

获取当前轴事件的垂直滚动轴的值。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前轴事件的垂直滚动轴的值，如果参数异常则返回0.0。

OH_ArkUI_AxisEvent_GetAxisAction()

int32_t OH_ArkUI_AxisEvent_GetAxisAction(const ArkUI_UIInputEvent* event)

描述：

获取当前轴事件的操作类型的值。

起始版本： 15

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前轴事件的操作类型的值。

OH_ArkUI_MouseEvent_GetMouseAction()

int32_t OH_ArkUI_MouseEvent_GetMouseAction (const ArkUI_UIInputEvent * event)

描述：

获取鼠标事件的鼠标动作类型的值。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回鼠标动作类型，1表示按键按下，2表示按键松开，3表示鼠标移动。

OH_ArkUI_MouseEvent_GetMouseButton()

int32_t OH_ArkUI_MouseEvent_GetMouseButton (const ArkUI_UIInputEvent * event)

描述：

获取鼠标事件的按键类型的值。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回鼠标按键类型，1为左键，2为右键，3为中键，4为后退键，5为前进键。

OH_ArkUI_PointerEvent_GetDisplayX()

float OH_ArkUI_PointerEvent_GetDisplayX (const ArkUI_UIInputEvent * event)

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的X坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前带有指向性的输入事件相对于当前屏幕左上角的X坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetDisplayXByIndex()

float OH_ArkUI_PointerEvent_GetDisplayXByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的X坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回当前带有指向性的输入事件相对于当前屏幕左上角的X坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetDisplayY()

float OH_ArkUI_PointerEvent_GetDisplayY (const ArkUI_UIInputEvent * event)

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的Y坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前带有指向性的输入事件相对于当前屏幕左上角的Y坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetDisplayYByIndex()

float OH_ArkUI_PointerEvent_GetDisplayYByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的Y坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回当前带有指向性的输入事件相对于当前屏幕左上角的Y坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetHistoryDisplayX()

float OH_ArkUI_PointerEvent_GetHistoryDisplayX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的X坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回当前带有指向性的输入事件相对于当前屏幕左上角的X坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetHistoryDisplayY()

float OH_ArkUI_PointerEvent_GetHistoryDisplayY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的Y坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回当前带有指向性的输入事件相对于当前屏幕左上角的Y坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetHistoryEventTime()

int64_t OH_ArkUI_PointerEvent_GetHistoryEventTime (const ArkUI_UIInputEvent * event, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件发生的时间。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
historyIndex	表示历史事件数据列表的序号。

返回：

返回UI输入事件发生的时间，如果参数异常则返回0。

OH_ArkUI_PointerEvent_GetHistoryPointerCount()

uint32_t OH_ArkUI_PointerEvent_GetHistoryPointerCount (const ArkUI_UIInputEvent * event, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中多点触控的接触点数量。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
historyIndex	表示历史事件数据列表的序号。

返回：

特定历史事件中多点触控的接触点数量。

OH_ArkUI_PointerEvent_GetHistoryPointerId()

int32_t OH_ArkUI_PointerEvent_GetHistoryPointerId (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回特定历史事件中的特定接触点标识。

OH_ArkUI_PointerEvent_GetHistoryPressure()

float OH_ArkUI_PointerEvent_GetHistoryPressure (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏压力。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回当前带有指向性的输入事件产生的触屏压力，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetHistorySize()

uint32_t OH_ArkUI_PointerEvent_GetHistorySize (const ArkUI_UIInputEvent * event)

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件数量。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前历史事件数量。

OH_ArkUI_PointerEvent_GetHistoryTiltX()

float OH_ArkUI_PointerEvent_GetHistoryTiltX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回当前带有指向性的输入事件中相对YZ平面的角度。

OH_ArkUI_PointerEvent_GetHistoryTiltY()

float OH_ArkUI_PointerEvent_GetHistoryTiltY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回当前带有指向性的输入事件中相对XZ平面的角度。

OH_ArkUI_PointerEvent_GetHistoryTouchAreaHeight()

float OH_ArkUI_PointerEvent_GetHistoryTouchAreaHeight (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的高度。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回当前带有指向性的输入事件中触屏区域的高度。

OH_ArkUI_PointerEvent_GetHistoryTouchAreaWidth()

float OH_ArkUI_PointerEvent_GetHistoryTouchAreaWidth (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的宽度。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回当前带有指向性的输入事件中触屏区域的宽度。

OH_ArkUI_PointerEvent_GetHistoryWindowX()

float OH_ArkUI_PointerEvent_GetHistoryWindowX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的X坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回当前带有指向性的输入事件相对于当前应用窗口左上角的X坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetHistoryWindowY()

float OH_ArkUI_PointerEvent_GetHistoryWindowY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的Y坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回当前带有指向性的输入事件相对于当前应用窗口左上角的Y坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetHistoryX()

float OH_ArkUI_PointerEvent_GetHistoryX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的X坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回当前带有指向性的输入事件相对于当前组件左上角的X坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetHistoryY()

float OH_ArkUI_PointerEvent_GetHistoryY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的Y坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表的序号。
historyIndex	表示历史事件数据列表的序号。

返回：

返回当前带有指向性的输入事件相对于当前组件左上角的Y坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetPointerCount()

uint32_t OH_ArkUI_PointerEvent_GetPointerCount (const ArkUI_UIInputEvent * event)

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点数量。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前带有指向性的输入事件的接触点数量。

OH_ArkUI_PointerEvent_GetPointerId()

int32_t OH_ArkUI_PointerEvent_GetPointerId (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回特定接触点标识。

OH_ArkUI_PointerEvent_GetChangedPointerId()

int32_t OH_ArkUI_PointerEvent_GetChangedPointerId (const ArkUI_UIInputEvent * event, uint32_t * pointerIndex )

描述：

获取当前触摸事件触发的id。

起始版本： 15

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回执行的状态代码。返回0表示设置成功，如果返回401，表示返回失败，可能的原因是参数异常，例如event是一个空指针。

OH_ArkUI_PointerEvent_GetPressure()

float OH_ArkUI_PointerEvent_GetPressure (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件）中获取触屏压力。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回当前带有指向性的输入事件产生的触屏压力，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetTiltX()

float OH_ArkUI_PointerEvent_GetTiltX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件）中获取相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回当前带有指向性的输入事件中相对YZ平面的角度。

OH_ArkUI_PointerEvent_GetTiltY()

float OH_ArkUI_PointerEvent_GetTiltY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件）中获取相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回当前带有指向性的输入事件中相对XZ平面的角度。

OH_ArkUI_PointerEvent_GetRollAngle()

int32_t OH_ArkUI_PointerEvent_GetRollAngle (const ArkUI_UIInputEvent * event, double * rollAngle )

描述：

从带有指向性的输入事件（如触摸事件）中获取手写笔与设备平面的夹角。

起始版本： 17

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
rollAngle	表示存储角度的变量。默认值为0。参数异常不会更改此值。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_PointerEvent_GetTouchAreaHeight()

float OH_ArkUI_PointerEvent_GetTouchAreaHeight (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件）中获取触屏区域的高度。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回当前带有指向性的输入事件中触屏区域的高度。

OH_ArkUI_PointerEvent_GetTouchAreaWidth()

float OH_ArkUI_PointerEvent_GetTouchAreaWidth (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件）中获取触屏区域的宽度。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回当前带有指向性的输入事件中触屏区域的宽度。

OH_ArkUI_PointerEvent_GetWindowX()

float OH_ArkUI_PointerEvent_GetWindowX (const ArkUI_UIInputEvent * event)

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的X坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前带有指向性的输入事件相对于当前应用窗口左上角的X坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetWindowXByIndex()

float OH_ArkUI_PointerEvent_GetWindowXByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的X坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回当前带有指向性的输入事件相对于当前应用窗口左上角的X坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetWindowY()

float OH_ArkUI_PointerEvent_GetWindowY (const ArkUI_UIInputEvent * event)

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的Y坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前带有指向性的输入事件相对于当前应用窗口左上角的Y坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetWindowYByIndex()

float OH_ArkUI_PointerEvent_GetWindowYByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的Y坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回当前带有指向性的输入事件相对于当前应用窗口左上角的Y坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetX()

float OH_ArkUI_PointerEvent_GetX (const ArkUI_UIInputEvent * event)

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的X坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前带有指向性的输入事件相对于当前组件左上角的X坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetXByIndex()

float OH_ArkUI_PointerEvent_GetXByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的X坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回当前带有指向性的输入事件相对于当前组件左上角的X坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetY()

float OH_ArkUI_PointerEvent_GetY (const ArkUI_UIInputEvent * event)

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的Y坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前带有指向性的输入事件相对于当前组件左上角的Y坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_GetYByIndex()

float OH_ArkUI_PointerEvent_GetYByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )

描述：

从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的Y坐标。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。

返回：

返回当前带有指向性的输入事件相对于当前组件左上角的Y坐标，如果参数异常则返回0.0f。

OH_ArkUI_PointerEvent_SetInterceptHitTestMode()

int32_t OH_ArkUI_PointerEvent_SetInterceptHitTestMode (const ArkUI_UIInputEvent * event, HitTestMode mode )

描述：

配置HitTest模式。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
mode	指定HitTest模式，参数类型HitTestMode。

返回：

返回执行的状态代码。

OH_ArkUI_PointerEvent_SetStopPropagation()

int32_t OH_ArkUI_PointerEvent_SetStopPropagation (const ArkUI_UIInputEvent * event, bool stopPropagation )

描述：

设置是否阻止事件冒泡。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
stopPropagation	表示是否阻止事件冒泡。

返回：

返回执行的状态代码。返回0表示设置成功，如果返回401，表示返回失败，可能的原因是参数异常，例如event是一个空指针。

OH_ArkUI_UIInputEvent_GetAction()

int32_t OH_ArkUI_UIInputEvent_GetAction (const ArkUI_UIInputEvent * event)

描述：

获取UI输入事件的操作类型。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前UI输入事件的操作类型，如果参数异常则返回0。

OH_ArkUI_UIInputEvent_GetDeviceId()

int32_t OH_ArkUI_UIInputEvent_GetDeviceId (const ArkUI_UIInputEvent * event)

描述：

获取当前按键的输入设备ID。

起始版本： 14

参数:

名称	描述
event	ArkUI_UIInputEvent事件指针。

返回：

当前按键的输入设备ID。

OH_ArkUI_UIInputEvent_GetEventTime()

int64_t OH_ArkUI_UIInputEvent_GetEventTime (const ArkUI_UIInputEvent * event)

描述：

获取UI输入事件发生的时间。单位：ns。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回UI输入事件发生的时间，如果参数异常则返回0。

OH_ArkUI_UIInputEvent_GetPressedKeys()

int32_t OH_ArkUI_UIInputEvent_GetPressedKeys (const ArkUI_UIInputEvent * event, int32_t * pressedKeyCodes, int32_t * length )

描述：

获取所有按下的按键，当前只支持按键事件。

起始版本： 14

参数:

名称	描述
event	ArkUI_UIInputEvent事件指针。
pressedKeyCodes	输出参数，表示所有按下键的数组，指向的内存空间需要调用者申请。
length	作为输入参数表示传入的pressedKeyCodes数组长度，作为输出参数表示实际按下按键的个数。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH 内存分配不足。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_UIInputEvent_GetSourceType()

int32_t OH_ArkUI_UIInputEvent_GetSourceType (const ArkUI_UIInputEvent * event)

描述：

获取产生UI输入事件的来源类型。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回产生当前UI输入事件的来源类型。

OH_ArkUI_UIInputEvent_GetToolType()

int32_t OH_ArkUI_UIInputEvent_GetToolType (const ArkUI_UIInputEvent * event)

描述：

获取产生UI输入事件的工具类型。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回产生当前UI输入事件的工具类型。

OH_ArkUI_UIInputEvent_GetType()

int32_t OH_ArkUI_UIInputEvent_GetType (const ArkUI_UIInputEvent * event)

描述：

获取UI输入事件的类型。

起始版本： 12

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回当前UI输入事件的类型，如果参数异常则返回0。

OH_ArkUI_FocusAxisEvent_GetAxisValue()

double OH_ArkUI_FocusAxisEvent_GetAxisValue (const ArkUI_UIInputEvent * event， int32_t axis)

描述：

获取焦点轴事件的轴值。

起始版本： 15

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
axis	焦点轴事件的轴类型。

返回：

返回焦点轴事件的轴值，表示手柄上摇杆推动或按键按下的程度，如果参数异常则返回0.0。

OH_ArkUI_FocusAxisEvent_SetStopPropagation()

int32_t OH_ArkUI_FocusAxisEvent_SetStopPropagation (const ArkUI_UIInputEvent * event， bool stopPropagation)

描述：

设置是否阻止焦点轴事件冒泡。

起始版本： 15

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
stopPropagation	是否阻止事件冒泡。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_PointerEvent_GetPressedTimeByIndex()

int64_t OH_ArkUI_PointerEvent_GetPressedTimeByIndex (const ArkUI_UIInputEvent* event, uint32_t pointerIndex)

描述：

获取特定触摸点的按压时间。

起始版本： 15

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	指示多点触控数据列表中目标触控点的索引。

返回：

返回特定触摸点的按下时间；如果发生任何参数错误，则返回0。

OH_ArkUI_MouseEvent_GetRawDeltaX()

float OH_ArkUI_MouseEvent_GetRawDeltaX (const ArkUI_UIInputEvent* event)

描述：

获取X轴相对于前一个上报的鼠标事件的鼠标指针位置的偏移量。当鼠标指针位于屏幕边缘时，该值可能小于两次上报的X坐标的差。

起始版本： 15

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回相对于前一个上报的鼠标事件的鼠标指针位置的X轴偏移量；如果发生任何参数错误，则返回0.0f。

OH_ArkUI_MouseEvent_GetRawDeltaY()

float OH_ArkUI_MouseEvent_GetRawDeltaY (const ArkUI_UIInputEvent* event)

描述：

获取Y轴相对于前一个上报的鼠标事件的鼠标指针位置的偏移量。当鼠标指针位于屏幕边缘时，该值可能小于两次上报的Y坐标的差。

起始版本： 15

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回相对于前一个上报的鼠标事件的鼠标指针位置的Y轴偏移量；如果发生任何参数错误，则返回0.0f。

OH_ArkUI_MouseEvent_GetPressedButtons()

int32_t OH_ArkUI_MouseEvent_GetPressedButtons (const ArkUI_UIInputEvent* event, int32_t* pressedButtons, int32_t* length)

描述：

从鼠标事件中获取按下的按钮。

起始版本： 15

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pressedButtons	指示按下按钮的列表。需要先创建一个int数组，用来储存按下的按钮。
length	作为输入参数表示传入的pressedButtons数组长度，作为输出参数表示实际按下按键的个数。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 给定的缓冲区不够。

OH_ArkUI_UIInputEvent_GetTargetDisplayId()

int32_t OH_ArkUI_UIInputEvent_GetTargetDisplayId (const ArkUI_UIInputEvent* event)

描述：

获取发生UI输入事件的屏幕ID。

起始版本： 15

参数:

名称	描述
event	表示指向当前UI输入事件的指针。

返回：

返回屏幕ID；如果发生任何参数错误，则返回0。

OH_ArkUI_PointerEvent_GetInteractionHand()

int32_t OH_ArkUI_PointerEvent_GetInteractionHand (const ArkUI_UIInputEvent * event, ArkUI_InteractionHand * hand)

描述：

获取当前触摸事件是左手点击触发还是右手点击触发。

起始版本： 15

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
hand	返回当前事件识别的交互手。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_PointerEvent_GetInteractionHandByIndex()

int32_t OH_ArkUI_PointerEvent_GetInteractionHandByIndex (const ArkUI_UIInputEvent * event, int32_t pointerIndex, ArkUI_InteractionHand * hand)

描述：

获取当前触摸事件是左手点击触发还是右手点击触发。

起始版本： 15

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
pointerIndex	表示多点触控数据列表中的序号。
hand	返回指定手指的交互手。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_UIInputEvent_GetEventTargetWidth()

float OH_ArkUI_UIInputEvent_GetEventTargetWidth(const ArkUI_UIInputEvent* event)

描述：

获取事件命中的组件的宽度。

起始版本： 17

参数:

名称	描述
event	表示指向ArkUI_UIInputEvent对象的指针。

返回：

返回事件命中的组件的宽度；如果发生任何参数错误，则返回 0.0f。

OH_ArkUI_UIInputEvent_GetEventTargetHeight()

float OH_ArkUI_UIInputEvent_GetEventTargetHeight(const ArkUI_UIInputEvent* event)

描述：

获取事件命中的组件的高度。

起始版本： 17

参数:

名称	描述
event	表示指向ArkUI_UIInputEvent对象的指针。

返回：

返回事件命中的组件的高度；如果发生任何参数错误，则返回 0.0f。

OH_ArkUI_UIInputEvent_GetEventTargetPositionX()

float OH_ArkUI_UIInputEvent_GetEventTargetPositionX(const ArkUI_UIInputEvent* event)

描述：

获取事件命中的组件的X坐标。

起始版本： 17

参数:

名称	描述
event	表示指向ArkUI_UIInputEvent对象的指针。

返回：

返回事件命中的组件的X坐标；如果发生任何参数错误，则返回 0.0f。

OH_ArkUI_UIInputEvent_GetEventTargetPositionY()

float OH_ArkUI_UIInputEvent_GetEventTargetPositionY(const ArkUI_UIInputEvent* event)

描述：

获取事件命中的组件的Y坐标。

起始版本： 17

参数:

名称	描述
event	表示指向ArkUI_UIInputEvent对象的指针。

返回：

返回事件命中的组件的Y坐标；如果发生任何参数错误，则返回 0.0f。

OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionX()

float OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionX(const ArkUI_UIInputEvent* event)

描述：

获取事件命中的组件的全局X坐标。

起始版本： 17

参数:

名称	描述
event	表示指向ArkUI_UIInputEvent对象的指针。

返回：

返回事件命中的组件的全局X坐标；如果发生任何参数错误，则返回 0.0f。

OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionY()

float OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionY(const ArkUI_UIInputEvent* event)

描述：

获取事件命中的组件的全局Y坐标。

起始版本： 17

参数:

名称	描述
event	表示指向ArkUI_UIInputEvent对象的指针。

返回：

返回事件命中的组件的全局Y坐标；如果发生任何参数错误，则返回 0.0f。

OH_ArkUI_UIInputEvent_GetModifierKeyStates()

int32_t OH_ArkUI_UIInputEvent_GetModifierKeyStates(const ArkUI_UIInputEvent* event, uint64_t* keys)

描述：

获取UI输入事件的功能键按压状态。

起始版本： 17

参数:

名称	描述
event	表示指向ArkUI_UIInputEvent对象的指针。
keys	表示当前处于按下状态的modifier key组合。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_HoverEvent_IsHovered()

bool OH_ArkUI_HoverEvent_IsHovered(const ArkUI_UIInputEvent* event)

描述：

获取鼠标是否悬浮在当前组件上。

起始版本： 17

参数:

名称	描述
event	表示指向ArkUI_UIInputEvent对象的指针。

返回：

如果鼠标悬浮在当前组件上则返回true。如果鼠标没有悬浮在当前组件上，返回false。

OH_ArkUI_PointerEvent_CreateClonedEvent()

int32_t OH_ArkUI_PointerEvent_CreateClonedEvent(const ArkUI_UIInputEvent* event, ArkUI_UIInputEvent** clonedEvent)

描述：

基于原始事件指针创建克隆事件指针。

起始版本： 15

参数:

名称	描述
event	ArkUI_UIInputEvent事件指针。
clonedEvent	ArkUI_UIInputEvent克隆事件指针。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_PointerEvent_DestroyClonedEvent()

int32_t OH_ArkUI_PointerEvent_DestroyClonedEvent(const ArkUI_UIInputEvent* event)

描述：

销毁克隆事件指针。

起始版本： 15

参数:

名称	描述
event	ArkUI_UIInputEvent事件指针。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT 输入的事件指针不是克隆事件。

OH_ArkUI_PointerEvent_SetClonedEventLocalPosition()

int32_t OH_ArkUI_PointerEvent_SetClonedEventLocalPosition(const ArkUI_UIInputEvent * event, float x, float y)

描述：

设置指向性事件相对于当前组件左上角的X坐标和Y坐标。

起始版本： 15

参数:

名称	描述
event	ArkUI_UIInputEvent事件指针。
x	当前带有指向性的输入事件相对于当前组件左上角的X坐标。
y	当前带有指向性的输入事件相对于当前组件左上角的Y坐标。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT 输入的事件指针不是克隆事件。

OH_ArkUI_PointerEvent_SetClonedEventLocalPositionByIndex()

int32_t OH_ArkUI_PointerEvent_SetClonedEventLocalPositionByIndex(const ArkUI_UIInputEvent * event, 
float x, float y, int32_t pointerIndex)

描述：

设置指向性事件特有接触点相对于当前组件左上角的X坐标和Y坐标。

起始版本： 15

参数:

名称	描述
event	ArkUI_UIInputEvent事件指针。
x	当前带有指向性的输入事件相对于当前组件左上角的X坐标。
y	当前带有指向性的输入事件相对于当前组件左上角的Y坐标。
pointerIndex	表示多点触控数据列表中的序号。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT 输入的事件指针不是克隆事件。

OH_ArkUI_PointerEvent_SetClonedEventActionType()

int32_t OH_ArkUI_PointerEvent_SetClonedEventActionType(const ArkUI_UIInputEvent * event, int32_t actionType)

描述：

设置当前带有指向性的克隆输入事件的事件类型。

起始版本： 15

参数:

名称	描述
event	ArkUI_UIInputEvent事件指针。
actionType	事件类型。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT 输入的事件指针不是克隆事件。

OH_ArkUI_PointerEvent_SetClonedEventChangedFingerId()

int32_t OH_ArkUI_PointerEvent_SetClonedEventChangedFingerId(const ArkUI_UIInputEvent * event, int32_t fingerId)

描述：

设置当前带有指向性的克隆输入事件的触摸点ID。

起始版本： 15

参数:

名称	描述
event	ArkUI_UIInputEvent事件指针。
fingerId	触发当前事件指针的触摸点ID。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT 输入的事件指针不是克隆事件。

OH_ArkUI_PointerEvent_SetClonedEventFingerIdByIndex()

int32_t OH_ArkUI_PointerEvent_SetClonedEventFingerIdByIndex(const ArkUI_UIInputEvent * event, 
int32_t fingerId, int32_t pointerIndex)

描述：

设置带有指向性的克隆输入事件特定接触点的触摸点ID。

起始版本： 15

参数:

名称	描述
event	ArkUI_UIInputEvent事件指针。
fingerId	触发当前事件指针的触摸点ID。
pointerIndex	表示多点触控数据列表中的序号。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT 输入的事件指针不是克隆事件。

OH_ArkUI_PointerEvent_PostClonedEvent()

int32_t OH_ArkUI_PointerEvent_PostClonedEvent(ArkUI_NodeHandle node, const ArkUI_UIInputEvent * event)

描述：

转发克隆事件到特定节点。

起始版本： 15

参数:

名称	描述
event	ArkUI_UIInputEvent事件指针。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_NON_CLONED_POINTER_EVENT 输入的事件指针不是克隆事件。 ARKUI_ERROR_CODE_POST_CLONED_COMPONENT_STATUS_ABNORMAL 组件状态异常。 ARKUI_ERROR_CODE_POST_CLONED_NO_COMPONENT_HIT_TO_RESPOND_TO_THE_EVENT 未命中可响应事件的组件。

OH_ArkUI_AxisEvent_SetPropagation()

int32_t OH_ArkUI_AxisEvent_SetPropagation (const ArkUI_UIInputEvent * event, bool propagation)

描述：

设置是否激活轴事件冒泡。

起始版本： 17

参数:

名称	描述
event	表示指向当前UI输入事件的指针。
propagation	表示是否激活事件冒泡。

返回：

ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_AxisEvent_GetScrollStep()

int32_t OH_ArkUI_AxisEvent_GetScrollStep (const ArkUI_UIInputEvent * event)

描述：

获取鼠标滚轮轴滚动步长配置。

起始版本： 17

参数:

名称	描述
event	指向 ArkUI_UIInputEvent事件指针。

返回：

返回鼠标滚轮轴滚动步长配置。

OH_ArkUI_UIInputEvent_GetLatestStatus()

ArkUI_ErrorCode OH_ArkUI_UIInputEvent_GetLatestStatus()

描述：

调用该方法获取最近一次UIInput相关方法的执行情况。通常情况下不需要使用该方法，仅在返回值结果不确定是否异常时使用。以下是一个使用示例（对于返回的float类型，0.0并不代表错误，因此可以进一步使用GetLatestStatus方法来确认是否发生异常）。

float x = OH_ArkUI_PointerEvent_GetX(event);
if (ARKUI_ERROR_CODE_NO_ERROR != OH_Arkui_UIInputEvent_GetlatestStatus()) {
    // error
    return;
}

系统将在每次执行UIInput相关函数时主动清空上一次函数调用的状态，以确保每次通过该接口获取的均为最近一次的状态。

起始版本： 20

返回：

返回最近一次调用UIInput方法产生的结果代码。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkUI（方舟UI框架）

harmony 鸿蒙ARKUI_TextPickerCascadeRangeContent

harmony 鸿蒙ARKUI_TextPickerRangeContent

harmony 鸿蒙ArkUI_AnimateCompleteCallback

harmony 鸿蒙ArkUI_AttributeItem

harmony 鸿蒙ArkUI_ColorStop

harmony 鸿蒙ArkUI_ContextCallback

harmony 鸿蒙ArkUI_ExpectedFrameRateRange

harmony 鸿蒙ArkUI_IntOffset

harmony 鸿蒙ArkUI_IntSize

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/4Kl2F5