1# ArkUI_EventModule
2
3
4## 概述
5
6在Native端提供ArkUI的UI输入事件能力。
7
8**起始版本：** 12
9
10
11## 汇总
12
13
14### 文件
15
16| 名称 | 描述 |
17| -------- | -------- |
18| [ui_input_event.h](ui__input__event_8h.md) | 提供ArkUI在Native侧的事件定义。  |
19
20
21### 类型定义
22
23| 名称 | 描述 |
24| -------- | -------- |
25| typedef struct [ArkUI_UIInputEvent](#arkui_uiinputevent) [ArkUI_UIInputEvent](#arkui_uiinputevent) | UI输入事件定义。  |
26
27
28### 枚举
29
30| 名称 | 描述 |
31| -------- | -------- |
32| [ArkUI_UIInputEvent_Type](#arkui_uiinputevent_type) { ARKUI_UIINPUTEVENT_TYPE_UNKNOWN = 0, ARKUI_UIINPUTEVENT_TYPE_TOUCH = 1, ARKUI_UIINPUTEVENT_TYPE_AXIS = 2, ARKUI_UIINPUTEVENT_TYPE_MOUSE = 3 } | UI输入事件类型定义。  |
33| {<br/>OH_NATIVEXCOMPONENT_RESULT_SUCCESS = 0, OH_NATIVEXCOMPONENT_RESULT_FAILED = -1, OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER = -2, UI_TOUCH_EVENT_ACTION_CANCEL = 0,<br/>UI_TOUCH_EVENT_ACTION_DOWN = 1, UI_TOUCH_EVENT_ACTION_MOVE = 2, UI_TOUCH_EVENT_ACTION_UP = 3<br/>} | 定义输入事件的Action Code。  |
34| {<br/>UI_INPUT_EVENT_TOOL_TYPE_UNKNOWN = 0, UI_INPUT_EVENT_TOOL_TYPE_FINGER = 1, UI_INPUT_EVENT_TOOL_TYPE_PEN = 2, UI_INPUT_EVENT_TOOL_TYPE_MOUSE = 3,<br/>UI_INPUT_EVENT_TOOL_TYPE_TOUCHPAD = 4, UI_INPUT_EVENT_TOOL_TYPE_JOYSTICK = 5<br/>} | 产生输入事件的工具类型定义。  |
35| { UI_INPUT_EVENT_SOURCE_TYPE_UNKNOWN = 0, UI_INPUT_EVENTT_SOURCE_TYPE_MOUSE = 1, UI_INPUT_EVENTT_SOURCE_TYPE_TOUCH_SCREEN = 2 } | 产生输入事件的来源类型定义。  |
36| [HitTestMode](#hittestmode) { HTMDEFAULT = 0, HTMBLOCK, HTMTRANSPARENT, HTMNONE } | 定义触摸测试类型的枚举值。  |
37| { UI_MOUSE_EVENT_ACTION_UNKNOWN = 0, UI_MOUSE_EVENT_ACTION_PRESS = 1, UI_MOUSE_EVENT_ACTION_RELEASE = 2, UI_MOUSE_EVENT_ACTION_MOVE = 3 } | 定义鼠标事件的Action Code。  |
38| {<br/>UI_MOUSE_EVENT_BUTTON_NONE = 0, UI_MOUSE_EVENT_BUTTON_LEFT = 1, UI_MOUSE_EVENT_BUTTON_RIGHT = 2, UI_MOUSE_EVENT_BUTTON_MIDDLE = 3,<br/>UI_MOUSE_EVENT_BUTTON_BACK = 4, UI_MOUSE_EVENT_BUTTON_FORWARD = 5<br/>} | 定义鼠标事件的按键类型。  |
39| [ArkUI_ModifierKeyName](#arkui_modifierkeyname) { ARKUI_MODIFIER_KEY_CTRL = 1 &lt;&lt; 0, ARKUI_MODIFIER_KEY_SHIFT = 1 &lt;&lt; 1, ARKUI_MODIFIER_KEY_ALT = 1 &lt;&lt; 2, ARKUI_MODIFIER_KEY_FN = 1 &lt;&lt; 3 } | 定义modifier按键。  |
40
41
42### 函数
43
44| 名称 | 描述 |
45| -------- | -------- |
46| int32_t [OH_ArkUI_UIInputEvent_GetType](#oh_arkui_uiinputevent_gettype) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取UI输入事件的类型。  |
47| int32_t [OH_ArkUI_UIInputEvent_GetAction](#oh_arkui_uiinputevent_getaction) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取UI输入事件的操作类型。  |
48| int32_t [OH_ArkUI_UIInputEvent_GetSourceType](#oh_arkui_uiinputevent_getsourcetype) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取产生UI输入事件的来源类型。  |
49| int32_t [OH_ArkUI_UIInputEvent_GetToolType](#oh_arkui_uiinputevent_gettooltype) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取产生UI输入事件的工具类型。  |
50| int64_t [OH_ArkUI_UIInputEvent_GetEventTime](#oh_arkui_uiinputevent_geteventtime) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取UI输入事件发生的时间。  |
51| uint32_t [OH_ArkUI_PointerEvent_GetPointerCount](#oh_arkui_pointerevent_getpointercount) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点数量。  |
52| int32_t [OH_ArkUI_PointerEvent_GetPointerId](#oh_arkui_pointerevent_getpointerid) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。  |
53| float [OH_ArkUI_PointerEvent_GetX](#oh_arkui_pointerevent_getx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的X坐标。  |
54| float [OH_ArkUI_PointerEvent_GetXByIndex](#oh_arkui_pointerevent_getxbyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的X坐标。  |
55| float [OH_ArkUI_PointerEvent_GetY](#oh_arkui_pointerevent_gety) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的Y坐标。  |
56| float [OH_ArkUI_PointerEvent_GetYByIndex](#oh_arkui_pointerevent_getybyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的Y坐标。  |
57| float [OH_ArkUI_PointerEvent_GetWindowX](#oh_arkui_pointerevent_getwindowx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的X坐标。  |
58| float [OH_ArkUI_PointerEvent_GetWindowXByIndex](#oh_arkui_pointerevent_getwindowxbyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的X坐标。  |
59| float [OH_ArkUI_PointerEvent_GetWindowY](#oh_arkui_pointerevent_getwindowy) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的Y坐标。  |
60| float [OH_ArkUI_PointerEvent_GetWindowYByIndex](#oh_arkui_pointerevent_getwindowybyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的Y坐标。  |
61| float [OH_ArkUI_PointerEvent_GetDisplayX](#oh_arkui_pointerevent_getdisplayx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的X坐标。  |
62| float [OH_ArkUI_PointerEvent_GetDisplayXByIndex](#oh_arkui_pointerevent_getdisplayxbyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的X坐标。  |
63| float [OH_ArkUI_PointerEvent_GetDisplayY](#oh_arkui_pointerevent_getdisplayy) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的Y坐标。  |
64| float [OH_ArkUI_PointerEvent_GetDisplayYByIndex](#oh_arkui_pointerevent_getdisplayybyindex) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的Y坐标。  |
65| float [OH_ArkUI_PointerEvent_GetPressure](#oh_arkui_pointerevent_getpressure) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件）中获取触屏压力。  |
66| float [OH_ArkUI_PointerEvent_GetTiltX](#oh_arkui_pointerevent_gettiltx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件）中获取相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。  |
67| float [OH_ArkUI_PointerEvent_GetTiltY](#oh_arkui_pointerevent_gettilty) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件）中获取相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。  |
68| float [OH_ArkUI_PointerEvent_GetTouchAreaWidth](#oh_arkui_pointerevent_gettouchareawidth) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件）中获取触屏区域的宽度。  |
69| float [OH_ArkUI_PointerEvent_GetTouchAreaHeight](#oh_arkui_pointerevent_gettouchareaheight) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex) | 从带有指向性的输入事件（如触摸事件）中获取触屏区域的高度。  |
70| uint32_t [OH_ArkUI_PointerEvent_GetHistorySize](#oh_arkui_pointerevent_gethistorysize) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件数量。  |
71| int64_t [OH_ArkUI_PointerEvent_GetHistoryEventTime](#oh_arkui_pointerevent_gethistoryeventtime) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件发生的时间。  |
72| uint32_t [OH_ArkUI_PointerEvent_GetHistoryPointerCount](#oh_arkui_pointerevent_gethistorypointercount) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中多点触控的接触点数量。  |
73| int32_t [OH_ArkUI_PointerEvent_GetHistoryPointerId](#oh_arkui_pointerevent_gethistorypointerid) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。  |
74| float [OH_ArkUI_PointerEvent_GetHistoryX](#oh_arkui_pointerevent_gethistoryx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的X坐标。  |
75| float [OH_ArkUI_PointerEvent_GetHistoryY](#oh_arkui_pointerevent_gethistoryy) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的Y坐标。  |
76| float [OH_ArkUI_PointerEvent_GetHistoryWindowX](#oh_arkui_pointerevent_gethistorywindowx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的X坐标。  |
77| float [OH_ArkUI_PointerEvent_GetHistoryWindowY](#oh_arkui_pointerevent_gethistorywindowy) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的Y坐标。  |
78| float [OH_ArkUI_PointerEvent_GetHistoryDisplayX](#oh_arkui_pointerevent_gethistorydisplayx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的X坐标。  |
79| float [OH_ArkUI_PointerEvent_GetHistoryDisplayY](#oh_arkui_pointerevent_gethistorydisplayy) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的Y坐标。  |
80| float [OH_ArkUI_PointerEvent_GetHistoryPressure](#oh_arkui_pointerevent_gethistorypressure) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏压力。  |
81| float [OH_ArkUI_PointerEvent_GetHistoryTiltX](#oh_arkui_pointerevent_gethistorytiltx) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。  |
82| float [OH_ArkUI_PointerEvent_GetHistoryTiltY](#oh_arkui_pointerevent_gethistorytilty) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。  |
83| float [OH_ArkUI_PointerEvent_GetHistoryTouchAreaWidth](#oh_arkui_pointerevent_gethistorytouchareawidth) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的宽度。  |
84| float [OH_ArkUI_PointerEvent_GetHistoryTouchAreaHeight](#oh_arkui_pointerevent_gethistorytouchareaheight) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, uint32_t pointerIndex, uint32_t historyIndex) | 从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的高度。  |
85| double [OH_ArkUI_AxisEvent_GetVerticalAxisValue](#oh_arkui_axisevent_getverticalaxisvalue) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取当前轴事件的垂直滚动轴的值。  |
86| double [OH_ArkUI_AxisEvent_GetHorizontalAxisValue](#oh_arkui_axisevent_gethorizontalaxisvalue) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取当前轴事件的水平滚动轴的值。  |
87| double [OH_ArkUI_AxisEvent_GetPinchAxisScaleValue](#oh_arkui_axisevent_getpinchaxisscalevalue) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取当前轴事件的捏合轴缩放的值。  |
88| int32_t [OH_ArkUI_PointerEvent_SetInterceptHitTestMode](#oh_arkui_pointerevent_setintercepthittestmode) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, [HitTestMode](#hittestmode) mode) | 配置HitTest模式。  |
89| int32_t [OH_ArkUI_MouseEvent_GetMouseButton](#oh_arkui_mouseevent_getmousebutton) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取鼠标事件的按键类型的值。  |
90| int32_t [OH_ArkUI_MouseEvent_GetMouseAction](#oh_arkui_mouseevent_getmouseaction) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取鼠标事件的鼠标动作类型的值。  |
91| int32_t [OH_ArkUI_PointerEvent_SetStopPropagation](#oh_arkui_pointerevent_setstoppropagation) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, bool stopPropagation) | 设置是否阻止事件冒泡。  |
92| int32_t [OH_ArkUI_UIInputEvent_GetDeviceId](#oh_arkui_uiinputevent_getdeviceid) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event) | 获取当前按键的输入设备ID。  |
93| int32_t [OH_ArkUI_UIInputEvent_GetPressedKeys](#oh_arkui_uiinputevent_getpressedkeys) (const [ArkUI_UIInputEvent](#arkui_uiinputevent) \*event, int32_t \*pressedKeyCodes, int32_t \*length) | 获取功能键按压状态。报错信息请参考以下错误码。支持功能键 'Ctrl'\|'Alt'\|'Shift'\|'Fn'，设备外接带Fn键的键盘不支持Fn键查询。  |
94
95
96## 类型定义说明
97
98
99### ArkUI_UIInputEvent
100
101```
102typedef struct ArkUI_UIInputEvent ArkUI_UIInputEvent
103```
104**描述：**
105
106UI输入事件定义。
107
108**起始版本：** 12
109
110
111## 枚举类型说明
112
113
114### anonymous enum
115
116```
117anonymous enum
118```
119**描述：**
120
121定义输入事件的Action Code。
122
123**起始版本：** 12
124
125| 枚举值 | 描述 |
126| -------- | -------- |
127| OH_NATIVEXCOMPONENT_RESULT_SUCCESS  | 成功结果。  |
128| OH_NATIVEXCOMPONENT_RESULT_FAILED  | 失败结果。  |
129| OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER  | 无效参数。  |
130| UI_TOUCH_EVENT_ACTION_CANCEL  | 触摸取消。  |
131| UI_TOUCH_EVENT_ACTION_DOWN  | 触摸按下。  |
132| UI_TOUCH_EVENT_ACTION_MOVE  | 触摸移动。  |
133| UI_TOUCH_EVENT_ACTION_UP  | 触摸抬起。  |
134
135
136### anonymous enum
137
138```
139anonymous enum
140```
141**描述：**
142
143产生输入事件的工具类型定义。
144
145**起始版本：** 12
146
147| 枚举值 | 描述 |
148| -------- | -------- |
149| UI_INPUT_EVENT_TOOL_TYPE_UNKNOWN  | 不支持的工具类型。  |
150| UI_INPUT_EVENT_TOOL_TYPE_FINGER  | 手指。  |
151| UI_INPUT_EVENT_TOOL_TYPE_PEN  | 笔。  |
152| UI_INPUT_EVENT_TOOL_TYPE_MOUSE  | 鼠标。  |
153| UI_INPUT_EVENT_TOOL_TYPE_TOUCHPAD  | 触控板。  |
154| UI_INPUT_EVENT_TOOL_TYPE_JOYSTICK  | 操纵杆。  |
155
156
157### anonymous enum
158
159```
160anonymous enum
161```
162**描述：**
163
164产生输入事件的来源类型定义。
165
166**起始版本：** 12
167
168| 枚举值 | 描述 |
169| -------- | -------- |
170| UI_INPUT_EVENT_SOURCE_TYPE_UNKNOWN  | 不支持的来源类型。  |
171| UI_INPUT_EVENTT_SOURCE_TYPE_MOUSE  | 鼠标。  |
172| UI_INPUT_EVENTT_SOURCE_TYPE_TOUCH_SCREEN  | 触摸屏。  |
173
174
175### anonymous enum
176
177```
178anonymous enum
179```
180**描述：**
181
182定义鼠标事件的Action Code。
183
184**起始版本：** 12
185
186| 枚举值 | 描述 |
187| -------- | -------- |
188| UI_MOUSE_EVENT_ACTION_UNKNOWN  | 无效行为  |
189| UI_MOUSE_EVENT_ACTION_PRESS  | 鼠标按键按下。  |
190| UI_MOUSE_EVENT_ACTION_RELEASE  | 鼠标按键松开。  |
191| UI_MOUSE_EVENT_ACTION_MOVE  | 鼠标移动。  |
192
193
194### anonymous enum
195
196```
197anonymous enum
198```
199**描述：**
200
201定义鼠标事件的按键类型。
202
203**起始版本：** 12
204
205| 枚举值 | 描述 |
206| -------- | -------- |
207| UI_MOUSE_EVENT_BUTTON_NONE  | 无按键。  |
208| UI_MOUSE_EVENT_BUTTON_LEFT  | 鼠标左键。  |
209| UI_MOUSE_EVENT_BUTTON_RIGHT  | 鼠标右键。  |
210| UI_MOUSE_EVENT_BUTTON_MIDDLE  | 鼠标中键。  |
211| UI_MOUSE_EVENT_BUTTON_BACK  | 鼠标左侧后退键。  |
212| UI_MOUSE_EVENT_BUTTON_FORWARD  | 鼠标左侧前进键。  |
213
214
215### ArkUI_ModifierKeyName
216
217```
218enum ArkUI_ModifierKeyName
219```
220**描述：**
221
222定义modifier按键。
223
224**起始版本：** 12
225
226| 枚举值 | 描述 |
227| -------- | -------- |
228| ARKUI_MODIFIER_KEY_CTRL  | Ctrl.  |
229| ARKUI_MODIFIER_KEY_SHIFT  | Shift.  |
230| ARKUI_MODIFIER_KEY_ALT  | Alt.  |
231| ARKUI_MODIFIER_KEY_FN  | Fn.  |
232
233
234### ArkUI_UIInputEvent_Type
235
236```
237enum ArkUI_UIInputEvent_Type
238```
239**描述：**
240
241UI输入事件类型定义。
242
243**起始版本：** 12
244
245
246### HitTestMode
247
248```
249enum HitTestMode
250```
251**描述：**
252
253定义触摸测试类型的枚举值。
254
255**起始版本：** 12
256
257| 枚举值 | 描述 |
258| -------- | -------- |
259| HTMDEFAULT  | 默认触摸测试效果，自身和子节点都响应触摸测试，但会阻塞兄弟节点的触摸测试。  |
260| HTMBLOCK  | 自身响应触摸测试，阻塞子节点和兄弟节点的触摸测试。  |
261| HTMTRANSPARENT  | 自身和子节点都响应触摸测试，不会阻塞兄弟节点的触摸测试。  |
262| HTMNONE  | 自身不响应触摸测试，不会阻塞子节点和兄弟节点的触摸测试。  |
263
264
265## 函数说明
266
267
268### OH_ArkUI_AxisEvent_GetHorizontalAxisValue()
269
270```
271double OH_ArkUI_AxisEvent_GetHorizontalAxisValue (const ArkUI_UIInputEvent * event)
272```
273**描述：**
274
275获取当前轴事件的水平滚动轴的值。
276
277**起始版本：** 12
278
279**参数:**
280
281| 名称 | 描述 |
282| -------- | -------- |
283| event | 表示指向当前UI输入事件的指针。  |
284
285**返回：**
286
287返回当前轴事件的水平滚动轴的值，如果参数异常则返回0.0。
288
289
290### OH_ArkUI_AxisEvent_GetPinchAxisScaleValue()
291
292```
293double OH_ArkUI_AxisEvent_GetPinchAxisScaleValue (const ArkUI_UIInputEvent * event)
294```
295**描述：**
296
297获取当前轴事件的捏合轴缩放的值。
298
299**起始版本：** 12
300
301**参数:**
302
303| 名称 | 描述 |
304| -------- | -------- |
305| event | 表示指向当前UI输入事件的指针。  |
306
307**返回：**
308
309返回当前轴事件的捏合轴缩放的值，如果参数异常则返回0.0。
310
311
312### OH_ArkUI_AxisEvent_GetVerticalAxisValue()
313
314```
315double OH_ArkUI_AxisEvent_GetVerticalAxisValue (const ArkUI_UIInputEvent * event)
316```
317**描述：**
318
319获取当前轴事件的垂直滚动轴的值。
320
321**起始版本：** 12
322
323**参数:**
324
325| 名称 | 描述 |
326| -------- | -------- |
327| event | 表示指向当前UI输入事件的指针。  |
328
329**返回：**
330
331返回当前轴事件的垂直滚动轴的值，如果参数异常则返回0.0。
332
333
334### OH_ArkUI_MouseEvent_GetMouseAction()
335
336```
337int32_t OH_ArkUI_MouseEvent_GetMouseAction (const ArkUI_UIInputEvent * event)
338```
339**描述：**
340
341获取鼠标事件的鼠标动作类型的值。
342
343**起始版本：** 12
344
345**参数:**
346
347| 名称 | 描述 |
348| -------- | -------- |
349| event | 表示指向当前UI输入事件的指针。  |
350
351**返回：**
352
353返回鼠标动作类型，1表示按键按下，2表示按键松开，3表示鼠标移动。
354
355
356### OH_ArkUI_MouseEvent_GetMouseButton()
357
358```
359int32_t OH_ArkUI_MouseEvent_GetMouseButton (const ArkUI_UIInputEvent * event)
360```
361**描述：**
362
363获取鼠标事件的按键类型的值。
364
365**起始版本：** 12
366
367**参数:**
368
369| 名称 | 描述 |
370| -------- | -------- |
371| event | 表示指向当前UI输入事件的指针。  |
372
373**返回：**
374
375返回鼠标按键类型，1为左键，2为右键，3为中键，4为后退键，5为前进键。
376
377
378### OH_ArkUI_PointerEvent_GetDisplayX()
379
380```
381float OH_ArkUI_PointerEvent_GetDisplayX (const ArkUI_UIInputEvent * event)
382```
383**描述：**
384
385从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的X坐标。
386
387**起始版本：** 12
388
389**参数:**
390
391| 名称 | 描述 |
392| -------- | -------- |
393| event | 表示指向当前UI输入事件的指针。  |
394
395**返回：**
396
397返回当前带有指向性的输入事件相对于当前屏幕左上角的X坐标，如果参数异常则返回0.0f。
398
399
400### OH_ArkUI_PointerEvent_GetDisplayXByIndex()
401
402```
403float OH_ArkUI_PointerEvent_GetDisplayXByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
404```
405**描述：**
406
407从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的X坐标。
408
409**起始版本：** 12
410
411**参数:**
412
413| 名称 | 描述 |
414| -------- | -------- |
415| event | 表示指向当前UI输入事件的指针。  |
416| pointerIndex | 表示多点触控数据列表中的序号。  |
417
418**返回：**
419
420返回当前带有指向性的输入事件相对于当前屏幕左上角的X坐标，如果参数异常则返回0.0f。
421
422
423### OH_ArkUI_PointerEvent_GetDisplayY()
424
425```
426float OH_ArkUI_PointerEvent_GetDisplayY (const ArkUI_UIInputEvent * event)
427```
428**描述：**
429
430从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前屏幕左上角的Y坐标。
431
432**起始版本：** 12
433
434**参数:**
435
436| 名称 | 描述 |
437| -------- | -------- |
438| event | 表示指向当前UI输入事件的指针。  |
439
440**返回：**
441
442返回当前带有指向性的输入事件相对于当前屏幕左上角的Y坐标，如果参数异常则返回0.0f。
443
444
445### OH_ArkUI_PointerEvent_GetDisplayYByIndex()
446
447```
448float OH_ArkUI_PointerEvent_GetDisplayYByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
449```
450**描述：**
451
452从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前屏幕左上角的Y坐标。
453
454**起始版本：** 12
455
456**参数:**
457
458| 名称 | 描述 |
459| -------- | -------- |
460| event | 表示指向当前UI输入事件的指针。  |
461| pointerIndex | 表示多点触控数据列表中的序号。  |
462
463**返回：**
464
465返回当前带有指向性的输入事件相对于当前屏幕左上角的Y坐标，如果参数异常则返回0.0f。
466
467
468### OH_ArkUI_PointerEvent_GetHistoryDisplayX()
469
470```
471float OH_ArkUI_PointerEvent_GetHistoryDisplayX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
472```
473**描述：**
474
475从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的X坐标。
476
477**起始版本：** 12
478
479**参数:**
480
481| 名称 | 描述 |
482| -------- | -------- |
483| event | 表示指向当前UI输入事件的指针。  |
484| pointerIndex | 表示多点触控数据列表的序号。  |
485| historyIndex | 表示历史事件数据列表的序号。  |
486
487**返回：**
488
489返回当前带有指向性的输入事件相对于当前屏幕左上角的X坐标，如果参数异常则返回0.0f。
490
491
492### OH_ArkUI_PointerEvent_GetHistoryDisplayY()
493
494```
495float OH_ArkUI_PointerEvent_GetHistoryDisplayY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
496```
497**描述：**
498
499从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前屏幕左上角的Y坐标。
500
501**起始版本：** 12
502
503**参数:**
504
505| 名称 | 描述 |
506| -------- | -------- |
507| event | 表示指向当前UI输入事件的指针。  |
508| pointerIndex | 表示多点触控数据列表的序号。  |
509| historyIndex | 表示历史事件数据列表的序号。  |
510
511**返回：**
512
513返回当前带有指向性的输入事件相对于当前屏幕左上角的Y坐标，如果参数异常则返回0.0f。
514
515
516### OH_ArkUI_PointerEvent_GetHistoryEventTime()
517
518```
519int64_t OH_ArkUI_PointerEvent_GetHistoryEventTime (const ArkUI_UIInputEvent * event, uint32_t historyIndex )
520```
521**描述：**
522
523从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件发生的时间。
524
525**起始版本：** 12
526
527**参数:**
528
529| 名称 | 描述 |
530| -------- | -------- |
531| event | 表示指向当前UI输入事件的指针。  |
532| historyIndex | 表示历史事件数据列表的序号。  |
533
534**返回：**
535
536返回UI输入事件发生的时间，如果参数异常则返回0。
537
538
539### OH_ArkUI_PointerEvent_GetHistoryPointerCount()
540
541```
542uint32_t OH_ArkUI_PointerEvent_GetHistoryPointerCount (const ArkUI_UIInputEvent * event, uint32_t historyIndex )
543```
544**描述：**
545
546从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中多点触控的接触点数量。
547
548**起始版本：** 12
549
550**参数:**
551
552| 名称 | 描述 |
553| -------- | -------- |
554| event | 表示指向当前UI输入事件的指针。  |
555| historyIndex | 表示历史事件数据列表的序号。  |
556
557**返回：**
558
559特定历史事件中多点触控的接触点数量。
560
561
562### OH_ArkUI_PointerEvent_GetHistoryPointerId()
563
564```
565int32_t OH_ArkUI_PointerEvent_GetHistoryPointerId (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
566```
567**描述：**
568
569从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。
570
571**起始版本：** 12
572
573**参数:**
574
575| 名称 | 描述 |
576| -------- | -------- |
577| event | 表示指向当前UI输入事件的指针。  |
578| pointerIndex | 表示多点触控数据列表的序号。  |
579| historyIndex | 表示历史事件数据列表的序号。  |
580
581**返回：**
582
583返回特定历史事件中的特定接触点标识。
584
585
586### OH_ArkUI_PointerEvent_GetHistoryPressure()
587
588```
589float OH_ArkUI_PointerEvent_GetHistoryPressure (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
590```
591**描述：**
592
593从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏压力。
594
595**起始版本：** 12
596
597**参数:**
598
599| 名称 | 描述 |
600| -------- | -------- |
601| event | 表示指向当前UI输入事件的指针。  |
602| pointerIndex | 表示多点触控数据列表中的序号。  |
603| historyIndex | 表示历史事件数据列表的序号。  |
604
605**返回：**
606
607返回当前带有指向性的输入事件产生的触屏压力，如果参数异常则返回0.0f。
608
609
610### OH_ArkUI_PointerEvent_GetHistorySize()
611
612```
613uint32_t OH_ArkUI_PointerEvent_GetHistorySize (const ArkUI_UIInputEvent * event)
614```
615**描述：**
616
617从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取历史事件数量。
618
619**起始版本：** 12
620
621**参数:**
622
623| 名称 | 描述 |
624| -------- | -------- |
625| event | 表示指向当前UI输入事件的指针。  |
626
627**返回：**
628
629返回当前历史事件数量。
630
631
632### OH_ArkUI_PointerEvent_GetHistoryTiltX()
633
634```
635float OH_ArkUI_PointerEvent_GetHistoryTiltX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
636```
637**描述：**
638
639从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。
640
641**起始版本：** 12
642
643**参数:**
644
645| 名称 | 描述 |
646| -------- | -------- |
647| event | 表示指向当前UI输入事件的指针。  |
648| pointerIndex | 表示多点触控数据列表中的序号。  |
649| historyIndex | 表示历史事件数据列表的序号。  |
650
651**返回：**
652
653返回当前带有指向性的输入事件中相对YZ平面的角度。
654
655
656### OH_ArkUI_PointerEvent_GetHistoryTiltY()
657
658```
659float OH_ArkUI_PointerEvent_GetHistoryTiltY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
660```
661**描述：**
662
663从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。
664
665**起始版本：** 12
666
667**参数:**
668
669| 名称 | 描述 |
670| -------- | -------- |
671| event | 表示指向当前UI输入事件的指针。  |
672| pointerIndex | 表示多点触控数据列表中的序号。  |
673| historyIndex | 表示历史事件数据列表的序号。  |
674
675**返回：**
676
677返回当前带有指向性的输入事件中相对XZ平面的角度。
678
679### OH_ArkUI_PointerEvent_GetHistoryTouchAreaHeight()
680
681```
682float OH_ArkUI_PointerEvent_GetHistoryTouchAreaHeight (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
683```
684**描述：**
685
686从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的高度。
687
688**起始版本：** 12
689
690**参数:**
691
692| 名称 | 描述 |
693| -------- | -------- |
694| event | 表示指向当前UI输入事件的指针。  |
695| pointerIndex | 表示多点触控数据列表中的序号。  |
696| historyIndex | 表示历史事件数据列表的序号。  |
697
698**返回：**
699
700返回当前带有指向性的输入事件中触屏区域的高度。
701
702
703### OH_ArkUI_PointerEvent_GetHistoryTouchAreaWidth()
704
705```
706float OH_ArkUI_PointerEvent_GetHistoryTouchAreaWidth (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
707```
708**描述：**
709
710从带有指向性的输入事件（如触摸事件）中获取特定历史事件中的触屏区域的宽度。
711
712**起始版本：** 12
713
714**参数:**
715
716| 名称 | 描述 |
717| -------- | -------- |
718| event | 表示指向当前UI输入事件的指针。  |
719| pointerIndex | 表示多点触控数据列表中的序号。  |
720| historyIndex | 表示历史事件数据列表的序号。  |
721
722**返回：**
723
724返回当前带有指向性的输入事件中触屏区域的宽度。
725
726
727### OH_ArkUI_PointerEvent_GetHistoryWindowX()
728
729```
730float OH_ArkUI_PointerEvent_GetHistoryWindowX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
731```
732**描述：**
733
734从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的X坐标。
735
736**起始版本：** 12
737
738**参数:**
739
740| 名称 | 描述 |
741| -------- | -------- |
742| event | 表示指向当前UI输入事件的指针。  |
743| pointerIndex | 表示多点触控数据列表的序号。  |
744| historyIndex | 表示历史事件数据列表的序号。  |
745
746**返回：**
747
748返回当前带有指向性的输入事件相对于当前应用窗口左上角的X坐标，如果参数异常则返回0.0f。
749
750
751### OH_ArkUI_PointerEvent_GetHistoryWindowY()
752
753```
754float OH_ArkUI_PointerEvent_GetHistoryWindowY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
755```
756**描述：**
757
758从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前应用窗口左上角的Y坐标。
759
760**起始版本：** 12
761
762**参数:**
763
764| 名称 | 描述 |
765| -------- | -------- |
766| event | 表示指向当前UI输入事件的指针。  |
767| pointerIndex | 表示多点触控数据列表的序号。  |
768| historyIndex | 表示历史事件数据列表的序号。  |
769
770**返回：**
771
772返回当前带有指向性的输入事件相对于当前应用窗口左上角的Y坐标，如果参数异常则返回0.0f。
773
774
775### OH_ArkUI_PointerEvent_GetHistoryX()
776
777```
778float OH_ArkUI_PointerEvent_GetHistoryX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
779```
780**描述：**
781
782从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的X坐标。
783
784**起始版本：** 12
785
786**参数:**
787
788| 名称 | 描述 |
789| -------- | -------- |
790| event | 表示指向当前UI输入事件的指针。  |
791| pointerIndex | 表示多点触控数据列表的序号。  |
792| historyIndex | 表示历史事件数据列表的序号。  |
793
794**返回：**
795
796返回当前带有指向性的输入事件相对于当前组件左上角的X坐标，如果参数异常则返回0.0f。
797
798
799### OH_ArkUI_PointerEvent_GetHistoryY()
800
801```
802float OH_ArkUI_PointerEvent_GetHistoryY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex, uint32_t historyIndex )
803```
804**描述：**
805
806从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定历史事件中特定接触点相对于当前组件左上角的Y坐标。
807
808**起始版本：** 12
809
810**参数:**
811
812| 名称 | 描述 |
813| -------- | -------- |
814| event | 表示指向当前UI输入事件的指针。  |
815| pointerIndex | 表示多点触控数据列表的序号。  |
816| historyIndex | 表示历史事件数据列表的序号。  |
817
818**返回：**
819
820返回当前带有指向性的输入事件相对于当前组件左上角的Y坐标，如果参数异常则返回0.0f。
821
822
823### OH_ArkUI_PointerEvent_GetPointerCount()
824
825```
826uint32_t OH_ArkUI_PointerEvent_GetPointerCount (const ArkUI_UIInputEvent * event)
827```
828**描述：**
829
830从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点数量。
831
832**起始版本：** 12
833
834**参数:**
835
836| 名称 | 描述 |
837| -------- | -------- |
838| event | 表示指向当前UI输入事件的指针。  |
839
840**返回：**
841
842返回当前带有指向性的输入事件的接触点数量。
843
844
845### OH_ArkUI_PointerEvent_GetPointerId()
846
847```
848int32_t OH_ArkUI_PointerEvent_GetPointerId (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
849```
850**描述：**
851
852从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取多点触控的接触点标识。
853
854**起始版本：** 12
855
856**参数:**
857
858| 名称 | 描述 |
859| -------- | -------- |
860| event | 表示指向当前UI输入事件的指针。  |
861| pointerIndex | 表示多点触控数据列表中的序号。  |
862
863**返回：**
864
865返回特定接触点标识。
866
867
868### OH_ArkUI_PointerEvent_GetPressure()
869
870```
871float OH_ArkUI_PointerEvent_GetPressure (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
872```
873**描述：**
874
875从带有指向性的输入事件（如触摸事件）中获取触屏压力。
876
877**起始版本：** 12
878
879**参数:**
880
881| 名称 | 描述 |
882| -------- | -------- |
883| event | 表示指向当前UI输入事件的指针。  |
884| pointerIndex | 表示多点触控数据列表中的序号。  |
885
886**返回：**
887
888返回当前带有指向性的输入事件产生的触屏压力，如果参数异常则返回0.0f。
889
890
891### OH_ArkUI_PointerEvent_GetTiltX()
892
893```
894float OH_ArkUI_PointerEvent_GetTiltX (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
895```
896**描述：**
897
898从带有指向性的输入事件（如触摸事件）中获取相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。
899
900**起始版本：** 12
901
902**参数:**
903
904| 名称 | 描述 |
905| -------- | -------- |
906| event | 表示指向当前UI输入事件的指针。  |
907| pointerIndex | 表示多点触控数据列表中的序号。  |
908
909**返回：**
910
911返回当前带有指向性的输入事件中相对YZ平面的角度。
912
913
914### OH_ArkUI_PointerEvent_GetTiltY()
915
916```
917float OH_ArkUI_PointerEvent_GetTiltY (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
918```
919**描述：**
920
921从带有指向性的输入事件（如触摸事件）中获取相对XZ平面的角度，值的范围[-90, 90]，其中正值是向下倾斜。
922
923**起始版本：** 12
924
925**参数:**
926
927| 名称 | 描述 |
928| -------- | -------- |
929| event | 表示指向当前UI输入事件的指针。  |
930| pointerIndex | 表示多点触控数据列表中的序号。  |
931
932**返回：**
933
934返回当前带有指向性的输入事件中相对XZ平面的角度。
935
936
937### OH_ArkUI_PointerEvent_GetTouchAreaHeight()
938
939```
940float OH_ArkUI_PointerEvent_GetTouchAreaHeight (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
941```
942**描述：**
943
944从带有指向性的输入事件（如触摸事件）中获取触屏区域的高度。
945
946**起始版本：** 12
947
948**参数:**
949
950| 名称 | 描述 |
951| -------- | -------- |
952| event | 表示指向当前UI输入事件的指针。  |
953| pointerIndex | 表示多点触控数据列表中的序号。  |
954
955**返回：**
956
957返回当前带有指向性的输入事件中触屏区域的高度。
958
959
960### OH_ArkUI_PointerEvent_GetTouchAreaWidth()
961
962```
963float OH_ArkUI_PointerEvent_GetTouchAreaWidth (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
964```
965**描述：**
966
967从带有指向性的输入事件（如触摸事件）中获取触屏区域的宽度。
968
969**起始版本：** 12
970
971**参数:**
972
973| 名称 | 描述 |
974| -------- | -------- |
975| event | 表示指向当前UI输入事件的指针。  |
976| pointerIndex | 表示多点触控数据列表中的序号。  |
977
978**返回：**
979
980返回当前带有指向性的输入事件中触屏区域的宽度。
981
982
983### OH_ArkUI_PointerEvent_GetWindowX()
984
985```
986float OH_ArkUI_PointerEvent_GetWindowX (const ArkUI_UIInputEvent * event)
987```
988**描述：**
989
990从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的X坐标。
991
992**起始版本：** 12
993
994**参数:**
995
996| 名称 | 描述 |
997| -------- | -------- |
998| event | 表示指向当前UI输入事件的指针。  |
999
1000**返回：**
1001
1002返回当前带有指向性的输入事件相对于当前应用窗口左上角的X坐标，如果参数异常则返回0.0f。
1003
1004
1005### OH_ArkUI_PointerEvent_GetWindowXByIndex()
1006
1007```
1008float OH_ArkUI_PointerEvent_GetWindowXByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
1009```
1010**描述：**
1011
1012从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的X坐标。
1013
1014**起始版本：** 12
1015
1016**参数:**
1017
1018| 名称 | 描述 |
1019| -------- | -------- |
1020| event | 表示指向当前UI输入事件的指针。  |
1021| pointerIndex | 表示多点触控数据列表中的序号。  |
1022
1023**返回：**
1024
1025返回当前带有指向性的输入事件相对于当前应用窗口左上角的X坐标，如果参数异常则返回0.0f。
1026
1027
1028### OH_ArkUI_PointerEvent_GetWindowY()
1029
1030```
1031float OH_ArkUI_PointerEvent_GetWindowY (const ArkUI_UIInputEvent * event)
1032```
1033**描述：**
1034
1035从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前应用窗口左上角的Y坐标。
1036
1037**起始版本：** 12
1038
1039**参数:**
1040
1041| 名称 | 描述 |
1042| -------- | -------- |
1043| event | 表示指向当前UI输入事件的指针。  |
1044
1045**返回：**
1046
1047返回当前带有指向性的输入事件相对于当前应用窗口左上角的Y坐标，如果参数异常则返回0.0f。
1048
1049
1050### OH_ArkUI_PointerEvent_GetWindowYByIndex()
1051
1052```
1053float OH_ArkUI_PointerEvent_GetWindowYByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
1054```
1055**描述：**
1056
1057从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前应用窗口左上角的Y坐标。
1058
1059**起始版本：** 12
1060
1061**参数:**
1062
1063| 名称 | 描述 |
1064| -------- | -------- |
1065| event | 表示指向当前UI输入事件的指针。  |
1066| pointerIndex | 表示多点触控数据列表中的序号。  |
1067
1068**返回：**
1069
1070返回当前带有指向性的输入事件相对于当前应用窗口左上角的Y坐标，如果参数异常则返回0.0f。
1071
1072
1073### OH_ArkUI_PointerEvent_GetX()
1074
1075```
1076float OH_ArkUI_PointerEvent_GetX (const ArkUI_UIInputEvent * event)
1077```
1078**描述：**
1079
1080从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的X坐标。
1081
1082**起始版本：** 12
1083
1084**参数:**
1085
1086| 名称 | 描述 |
1087| -------- | -------- |
1088| event | 表示指向当前UI输入事件的指针。  |
1089
1090**返回：**
1091
1092返回当前带有指向性的输入事件相对于当前组件左上角的X坐标，如果参数异常则返回0.0f。
1093
1094
1095### OH_ArkUI_PointerEvent_GetXByIndex()
1096
1097```
1098float OH_ArkUI_PointerEvent_GetXByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
1099```
1100**描述：**
1101
1102从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的X坐标。
1103
1104**起始版本：** 12
1105
1106**参数:**
1107
1108| 名称 | 描述 |
1109| -------- | -------- |
1110| event | 表示指向当前UI输入事件的指针。  |
1111| pointerIndex | 表示多点触控数据列表中的序号。  |
1112
1113**返回：**
1114
1115返回当前带有指向性的输入事件相对于当前组件左上角的X坐标，如果参数异常则返回0.0f。
1116
1117
1118### OH_ArkUI_PointerEvent_GetY()
1119
1120```
1121float OH_ArkUI_PointerEvent_GetY (const ArkUI_UIInputEvent * event)
1122```
1123**描述：**
1124
1125从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取相对于当前组件左上角的Y坐标。
1126
1127**起始版本：** 12
1128
1129**参数:**
1130
1131| 名称 | 描述 |
1132| -------- | -------- |
1133| event | 表示指向当前UI输入事件的指针。  |
1134
1135**返回：**
1136
1137返回当前带有指向性的输入事件相对于当前组件左上角的Y坐标，如果参数异常则返回0.0f。
1138
1139
1140### OH_ArkUI_PointerEvent_GetYByIndex()
1141
1142```
1143float OH_ArkUI_PointerEvent_GetYByIndex (const ArkUI_UIInputEvent * event, uint32_t pointerIndex )
1144```
1145**描述：**
1146
1147从带有指向性的输入事件（如触摸事件、鼠标事件、轴事件）中获取特定接触点相对于当前组件左上角的Y坐标。
1148
1149**起始版本：** 12
1150
1151**参数:**
1152
1153| 名称 | 描述 |
1154| -------- | -------- |
1155| event | 表示指向当前UI输入事件的指针。  |
1156| pointerIndex | 表示多点触控数据列表中的序号。  |
1157
1158**返回：**
1159
1160返回当前带有指向性的输入事件相对于当前组件左上角的Y坐标，如果参数异常则返回0.0f。
1161
1162
1163### OH_ArkUI_PointerEvent_SetInterceptHitTestMode()
1164
1165```
1166int32_t OH_ArkUI_PointerEvent_SetInterceptHitTestMode (const ArkUI_UIInputEvent * event, HitTestMode mode )
1167```
1168**描述：**
1169
1170配置HitTest模式。
1171
1172**起始版本：** 12
1173
1174**参数:**
1175
1176| 名称 | 描述 |
1177| -------- | -------- |
1178| event | 表示指向当前UI输入事件的指针。  |
1179| mode | 指定HitTest模式，参数类型[HitTestMode](#hittestmode)。  |
1180
1181**返回：**
1182
1183返回执行的状态代码。
1184
1185
1186### OH_ArkUI_PointerEvent_SetStopPropagation()
1187
1188```
1189int32_t OH_ArkUI_PointerEvent_SetStopPropagation (const ArkUI_UIInputEvent * event, bool stopPropagation )
1190```
1191**描述：**
1192
1193设置是否阻止事件冒泡。
1194
1195**起始版本：** 12
1196
1197**参数:**
1198
1199| 名称 | 描述 |
1200| -------- | -------- |
1201| event | 表示指向当前UI输入事件的指针。  |
1202| stopPropagation | 表示是否阻止事件冒泡。  |
1203
1204**返回：**
1205
1206返回执行的状态代码。返回0表示设置成功，如果返回401，表示返回失败，可能的原因是参数异常，例如event是一个空指针。
1207
1208
1209### OH_ArkUI_UIInputEvent_GetAction()
1210
1211```
1212int32_t OH_ArkUI_UIInputEvent_GetAction (const ArkUI_UIInputEvent * event)
1213```
1214**描述：**
1215
1216获取UI输入事件的操作类型。
1217
1218**起始版本：** 12
1219
1220**参数:**
1221
1222| 名称 | 描述 |
1223| -------- | -------- |
1224| event | 表示指向当前UI输入事件的指针。  |
1225
1226**返回：**
1227
1228返回当前UI输入事件的操作类型，如果参数异常则返回0。
1229
1230
1231### OH_ArkUI_UIInputEvent_GetDeviceId()
1232
1233```
1234int32_t OH_ArkUI_UIInputEvent_GetDeviceId (const ArkUI_UIInputEvent * event)
1235```
1236**描述：**
1237
1238获取当前按键的输入设备ID。
1239
1240**起始版本：** 14
1241
1242**参数:**
1243
1244| 名称 | 描述 |
1245| -------- | -------- |
1246| event | ArkUI_UIInputEvent事件指针。  |
1247
1248**返回：**
1249
1250当前按键的输入设备ID。
1251
1252
1253### OH_ArkUI_UIInputEvent_GetEventTime()
1254
1255```
1256int64_t OH_ArkUI_UIInputEvent_GetEventTime (const ArkUI_UIInputEvent * event)
1257```
1258**描述：**
1259
1260获取UI输入事件发生的时间。
1261
1262**起始版本：** 12
1263
1264**参数:**
1265
1266| 名称 | 描述 |
1267| -------- | -------- |
1268| event | 表示指向当前UI输入事件的指针。  |
1269
1270**返回：**
1271
1272返回UI输入事件发生的时间，如果参数异常则返回0。
1273
1274
1275### OH_ArkUI_UIInputEvent_GetPressedKeys()
1276
1277```
1278int32_t OH_ArkUI_UIInputEvent_GetPressedKeys (const ArkUI_UIInputEvent * event, int32_t * pressedKeyCodes, int32_t * length )
1279```
1280**描述：**
1281
1282获取功能键按压状态。报错信息请参考以下错误码。支持功能键 'Ctrl'|'Alt'|'Shift'|'Fn'，设备外接带Fn键的键盘不支持Fn键查询。
1283
1284**起始版本：** 14
1285
1286**参数:**
1287
1288| 名称 | 描述 |
1289| -------- | -------- |
1290| event | ArkUI_UIInputEvent事件指针。  |
1291| pressedKeyCodes | 输出参数，表示所有按下键的数组，指向的内存空间需要调用者申请。  |
1292| length | 作为输入参数表示传入的pressedKeyCodes数组长度，作为输出参数表示实际按下按键的个数。  |
1293
1294**返回：**
1295
1296[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) 成功。 [ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR](_ark_u_i___native_module.md) 内存分配不足。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) 函数参数异常。
1297
1298
1299### OH_ArkUI_UIInputEvent_GetSourceType()
1300
1301```
1302int32_t OH_ArkUI_UIInputEvent_GetSourceType (const ArkUI_UIInputEvent * event)
1303```
1304**描述：**
1305
1306获取产生UI输入事件的来源类型。
1307
1308**起始版本：** 12
1309
1310**参数:**
1311
1312| 名称 | 描述 |
1313| -------- | -------- |
1314| event | 表示指向当前UI输入事件的指针。  |
1315
1316**返回：**
1317
1318返回产生当前UI输入事件的来源类型。
1319
1320
1321### OH_ArkUI_UIInputEvent_GetToolType()
1322
1323```
1324int32_t OH_ArkUI_UIInputEvent_GetToolType (const ArkUI_UIInputEvent * event)
1325```
1326**描述：**
1327
1328获取产生UI输入事件的工具类型。
1329
1330**起始版本：** 12
1331
1332**参数:**
1333
1334| 名称 | 描述 |
1335| -------- | -------- |
1336| event | 表示指向当前UI输入事件的指针。  |
1337
1338**返回：**
1339
1340返回产生当前UI输入事件的工具类型。
1341
1342
1343### OH_ArkUI_UIInputEvent_GetType()
1344
1345```
1346int32_t OH_ArkUI_UIInputEvent_GetType (const ArkUI_UIInputEvent * event)
1347```
1348**描述：**
1349
1350获取UI输入事件的类型。
1351
1352**起始版本：** 12
1353
1354**参数:**
1355
1356| 名称 | 描述 |
1357| -------- | -------- |
1358| event | 表示指向当前UI输入事件的指针。  |
1359
1360**返回：**
1361
1362返回当前UI输入事件的类型，如果参数异常则返回0。
1363