_o_h___native_x_component.md 21.8 KB
Newer Older
Z
zengyawen 已提交
1 2 3
# Native XComponent


Z
zengyawen 已提交
4
描述ArkUI XComponent持有的surface和触摸事件,该事件可用于EGL/OpenGLES和媒体数据输入,并显示在ArkUI XComponent上。
Z
zengyawen 已提交
5 6


Z
zengyawen 已提交
7
**自从:**
Z
zengyawen 已提交
8 9 10 11 12


8


Z
zengyawen 已提交
13
## 汇总
Z
zengyawen 已提交
14 15


Z
zengyawen 已提交
16 17 18 19 20
### 文件

| 文件名称 | 描述 |
| -------- | -------- |
| [native_interface_xcomponent.h](native__interface__xcomponent_8h.md) | 声明用于访问Native XComponent的API。 |
Z
zengyawen 已提交
21 22


Z
zengyawen 已提交
23
### 结构体
Z
zengyawen 已提交
24

Z
zengyawen 已提交
25
| 结构体名称 | 描述 |
Z
zengyawen 已提交
26
| -------- | -------- |
Z
zengyawen 已提交
27 28 29 30 31
| [OH_NativeXComponent_TouchPoint](_o_h___native_x_component___touch_point.md) | 触摸事件中触摸点的信息。 |
| [OH_NativeXComponent_TouchEvent](_o_h___native_x_component___touch_event.md) | 触摸事件。 |
| [OH_NativeXComponent_MouseEvent](_o_h___native_x_component___mouse_event.md) | 鼠标事件。 |
| [OH_NativeXComponent_Callback](_o_h___native_x_component___callback.md) | 注册surface生命周期和触摸事件回调。 |
| [OH_NativeXComponent_MouseEvent_Callback](_o_h___native_x_component___mouse_event___callback.md) | 注册鼠标事件的回调。 |
Z
zengyawen 已提交
32 33


Z
zengyawen 已提交
34
### 类型定义
Z
zengyawen 已提交
35

Z
zengyawen 已提交
36
| 类型定义名称 | 描述 |
Z
zengyawen 已提交
37
| -------- | -------- |
Z
zengyawen 已提交
38 39 40
| [OH_NativeXComponent](#ohnativexcomponent) | 提供封装的OH_NativeXComponent实例。 |
| [OH_NativeXComponent_Callback](#ohnativexcomponentcallback) | 注册surface生命周期和触摸事件回调。 |
| [OH_NativeXComponent_MouseEvent_Callback](#ohnativexcomponentmouseeventcallback) | 注册鼠标事件的回调。 |
Z
zengyawen 已提交
41 42


Z
zengyawen 已提交
43
### 枚举
Z
zengyawen 已提交
44

Z
zengyawen 已提交
45
| 枚举名称 | 描述 |
Z
zengyawen 已提交
46
| -------- | -------- |
Z
zengyawen 已提交
47 48 49 50
| {OH_NATIVEXCOMPONENT_RESULT_SUCCESS = 0, <br>OH_NATIVEXCOMPONENT_RESULT_FAILED = -1, <br/>OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER = -2, <br/>OHOS_IMAGE_RESULT_SUCCESS = 0,  <br/>OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 } | [枚举](#anonymous-enum)API访问状态。 |
| [OH_NativeXComponent_TouchEventType](#ohnativexcomponenttoucheventtype) {  <br/>OH_NATIVEXCOMPONENT_DOWN = 0, <br/>OH_NATIVEXCOMPONENT_UP, <br/>OH_NATIVEXCOMPONENT_MOVE, <br/>OH_NATIVEXCOMPONENT_CANCEL,<br/>OH_NATIVEXCOMPONENT_UNKNOWN } | 触摸事件类型。 |
| [OH_NativeXComponent_MouseEventAction](#ohnativexcomponentmouseeventaction) { <br/>OH_NATIVEXCOMPONENT_MOUSE_NONE = 0, <br/>OH_NATIVEXCOMPONENT_MOUSE_PRESS, <br/>OH_NATIVEXCOMPONENT_MOUSE_RELEASE, <br/>OH_NATIVEXCOMPONENT_MOUSE_MOVE } | 鼠标事件动作。 |
| [OH_NativeXComponent_MouseEventButton](#ohnativexcomponentmouseeventbutton) {  <br/>OH_NATIVEXCOMPONENT_NONE_BUTTON = 0, <br/>OH_NATIVEXCOMPONENT_LEFT_BUTTON = 0x01, <br/>OH_NATIVEXCOMPONENT_RIGHT_BUTTON = 0x02, <br/>OH_NATIVEXCOMPONENT_MIDDLE_BUTTON = 0x04,   <br/>OH_NATIVEXCOMPONENT_BACK_BUTTON = 0x08, <br/>OH_NATIVEXCOMPONENT_FORWARD_BUTTON = 0x10 } | 鼠标事件按键。 |
Z
zengyawen 已提交
51 52


Z
zengyawen 已提交
53
### 函数
Z
zengyawen 已提交
54

Z
zengyawen 已提交
55
| 函数名称 | 描述 |
Z
zengyawen 已提交
56
| -------- | -------- |
Z
zengyawen 已提交
57 58 59 60 61 62 63
| [OH_NativeXComponent_GetXComponentId](#ohnativexcomponentgetxcomponentid) ([OH_NativeXComponent](#ohnativexcomponent) \*component, char \*id, uint64_t \*size) | 获取ArkUI XComponent的id。 |
| [OH_NativeXComponent_GetXComponentSize](#ohnativexcomponentgetxcomponentsize) ([OH_NativeXComponent](#ohnativexcomponent) \*component, const void \*window, uint64_t \*width, uint64_t \*height) | 获取ArkUI XComponent持有的surface的大小。 |
| [OH_NativeXComponent_GetXComponentOffset](#ohnativexcomponentgetxcomponentoffset) ([OH_NativeXComponent](#ohnativexcomponent) \*component, const void \*window, double \*x, double \*y) | 获取ArkUI XComponent组件相对屏幕左上顶点的偏移量。 |
| [OH_NativeXComponent_GetTouchEvent](#ohnativexcomponentgettouchevent) ([OH_NativeXComponent](#ohnativexcomponent) \*component, const void \*window, [OH_NativeXComponent_TouchEvent](_o_h___native_x_component___touch_event.md) \*touchEvent) | 获取ArkUI XComponent调度的触摸事件。 |
| [OH_NativeXComponent_GetMouseEvent](#ohnativexcomponentgetmouseevent) ([OH_NativeXComponent](#ohnativexcomponent) \*component, const void \*window, [OH_NativeXComponent_MouseEvent](_o_h___native_x_component___mouse_event.md) \*mouseEvent) | 获取ArkUI XComponent调度的鼠标事件 |
| [OH_NativeXComponent_RegisterCallback](#ohnativexcomponentregistercallback) ([OH_NativeXComponent](#ohnativexcomponent) \*component, [OH_NativeXComponent_Callback](_o_h___native_x_component___callback.md) \*callback) | 为此OH_NativeXComponent实例注册回调。 |
| [OH_NativeXComponent_RegisterMouseEventCallback](#ohnativexcomponentregistermouseeventcallback) ([OH_NativeXComponent](#ohnativexcomponent) \*component, [OH_NativeXComponent_MouseEvent_Callback](_o_h___native_x_component___mouse_event___callback.md) \*callback) | 为此OH_NativeXComponent实例注册鼠标事件回调。 |
Z
zengyawen 已提交
64 65


Z
zengyawen 已提交
66
### 变量
Z
zengyawen 已提交
67

Z
zengyawen 已提交
68
| 变量名称 | 描述 |
Z
zengyawen 已提交
69
| -------- | -------- |
Z
zengyawen 已提交
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
| [OH_XCOMPONENT_ID_LEN_MAX](#ohxcomponentidlenmax) = 128 | ArkUI XComponent的id最大长度。 |
| [OH_MAX_TOUCH_POINTS_NUMBER](#ohmaxtouchpointsnumber) = 10 | 触摸事件中的可识别的触摸点个数最大值。 |
| [OH_NativeXComponent_TouchPoint::id](#id-12) = 0 | 手指的唯一标识符。 |
| [OH_NativeXComponent_TouchPoint::screenX](#screenx-13) = 0.0 | 触摸点相对于屏幕左边缘的x坐标。 |
| [OH_NativeXComponent_TouchPoint::screenY](#screeny-13) = 0.0 | 触摸点相对于屏幕上边缘的y坐标。 |
| [OH_NativeXComponent_TouchPoint::x](#x-13) = 0.0 | 触摸点相对于XComponent组件左边缘的x坐标。 |
| [OH_NativeXComponent_TouchPoint::y](#y-13) = 0.0 | 触摸点相对于XComponent组件上边缘的y坐标。 |
| [OH_NativeXComponent_TouchPoint::type](#type-12) = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN | 触摸事件的触摸类型。 |
| [OH_NativeXComponent_TouchPoint::size](#size-12) = 0.0 | 指垫和屏幕之间的接触面积。 |
| [OH_NativeXComponent_TouchPoint::force](#force-12) = 0.0 | 当前触摸事件的压力。 |
| [OH_NativeXComponent_TouchPoint::timeStamp](#timestamp-12) = 0 | 当前触摸事件的时间戳。 |
| [OH_NativeXComponent_TouchPoint::isPressed](#ispressed) = false | 当前点是否被按下。 |
| [OH_NativeXComponent_TouchEvent::id](#id-22) = 0 | 手指的唯一标识符。 |
| [OH_NativeXComponent_TouchEvent::screenX](#screenx-23) = 0.0 | 触摸点相对于屏幕左边缘的x坐标。 |
| [OH_NativeXComponent_TouchEvent::screenY](#screeny-23) = 0.0 | 触摸点相对于屏幕上边缘的y坐标。 |
| [OH_NativeXComponent_TouchEvent::x](#x-23) = 0.0 | 触摸点相对于XComponent组件左边缘的x坐标。 |
| [OH_NativeXComponent_TouchEvent::y](#y-23) = 0.0 | 触摸点相对于XComponent组件上边缘的y坐标。 |
| [OH_NativeXComponent_TouchEvent::type](#type-22) = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN | 触摸事件的触摸类型。 |
| [OH_NativeXComponent_TouchEvent::size](#size-22) = 0.0 | 指垫和屏幕之间的接触面积。 |
| [OH_NativeXComponent_TouchEvent::force](#force-22) = 0.0 | 当前触摸事件的压力。 |
| [OH_NativeXComponent_TouchEvent::deviceId](#deviceid) = 0 | 产生当前触摸事件的设备的ID。 |
| [OH_NativeXComponent_TouchEvent::timeStamp](#timestamp-22) = 0 | 当前触摸事件的时间戳。 |
| [OH_NativeXComponent_TouchEvent::touchPoints](#touchpoints) [OH_MAX_TOUCH_POINTS_NUMBER] | 当前触摸点的数组。 |
| [OH_NativeXComponent_TouchEvent::numPoints](#numpoints) = 0 | 当前接触点的数量。 |
| [OH_NativeXComponent_MouseEvent::x](#x-33) | 点击触点相对于当前组件左上角的x轴坐标。 |
| [OH_NativeXComponent_MouseEvent::y](#y-33) | 点击触点相对于当前组件左上角的y轴坐标。 |
| [OH_NativeXComponent_MouseEvent::screenX](#screenx-33) | 点击触点相对于屏幕左上角的x轴坐标。 |
| [OH_NativeXComponent_MouseEvent::screenY](#screeny-33) | 点击触点相对于屏幕左上角的y轴坐标。 |
| [OH_NativeXComponent_MouseEvent::timestamp](#timestamp) | 当前鼠标事件的时间戳。 |
| [OH_NativeXComponent_MouseEvent::action](#action) | 当前鼠标事件动作。 |
| [OH_NativeXComponent_MouseEvent::button](#button) | 鼠标事件按键。 |
| [OH_NativeXComponent_Callback::OnSurfaceCreated](#onsurfacecreated) )([OH_NativeXComponent](#ohnativexcomponent) \*component, void \*window) | 创建surface时调用。 |
| [OH_NativeXComponent_Callback::OnSurfaceChanged](#onsurfacechanged) )([OH_NativeXComponent](#ohnativexcomponent) \*component, void \*window) | 当surface改变时调用。 |
| [OH_NativeXComponent_Callback::OnSurfaceDestroyed](#onsurfacedestroyed) )([OH_NativeXComponent](#ohnativexcomponent) \*component, void \*window) | 当surface被破坏时调用。 |
| [OH_NativeXComponent_Callback::DispatchTouchEvent](#dispatchtouchevent) )([OH_NativeXComponent](#ohnativexcomponent) \*component, void \*window) | 当触摸事件被触发时调用。 |
| [OH_NativeXComponent_MouseEvent_Callback::DispatchMouseEvent](#dispatchmouseevent) )([OH_NativeXComponent](#ohnativexcomponent) \*component, void \*window) | 当鼠标事件被触发时调用。 |
| [OH_NativeXComponent_MouseEvent_Callback::DispatchHoverEvent](#dispatchhoverevent) )([OH_NativeXComponent](#ohnativexcomponent) \*component, bool isHover) | 当悬停事件被触发时调用。 |


## 详细描述


## 类型定义说明
Z
zengyawen 已提交
113 114


Z
zengyawen 已提交
115
### OH_NativeXComponent
Z
zengyawen 已提交
116 117


Z
zengyawen 已提交
118 119 120
```
typedef struct OH_NativeXComponent OH_NativeXComponent
```
Z
zengyawen 已提交
121

Z
zengyawen 已提交
122
**描述:**
Z
zengyawen 已提交
123

Z
zengyawen 已提交
124
提供封装的OH_NativeXComponent实例。
Z
zengyawen 已提交
125

Z
zengyawen 已提交
126
**自从:**
Z
zengyawen 已提交
127

Z
zengyawen 已提交
128 129 130 131
8


### OH_NativeXComponent_Callback
Z
zengyawen 已提交
132 133 134


```
Z
zengyawen 已提交
135
typedef struct OH_NativeXComponent_Callback OH_NativeXComponent_Callback
Z
zengyawen 已提交
136 137
```

Z
zengyawen 已提交
138
**描述:**
Z
zengyawen 已提交
139

Z
zengyawen 已提交
140
注册surface生命周期和触摸事件回调。
Z
zengyawen 已提交
141

Z
zengyawen 已提交
142 143 144 145 146 147
**自从:**

8


### OH_NativeXComponent_MouseEvent_Callback
Z
zengyawen 已提交
148 149 150


```
Z
zengyawen 已提交
151
typedef struct OH_NativeXComponent_MouseEvent_Callback OH_NativeXComponent_MouseEvent_Callback
Z
zengyawen 已提交
152 153
```

Z
zengyawen 已提交
154 155 156
**描述:**

注册鼠标事件的回调。
Z
zengyawen 已提交
157

Z
zengyawen 已提交
158
**自从:**
Z
zengyawen 已提交
159

Z
zengyawen 已提交
160
9
Z
zengyawen 已提交
161

Z
zengyawen 已提交
162 163

## 枚举类型说明
Z
zengyawen 已提交
164 165 166 167


### anonymous enum

Z
zengyawen 已提交
168

Z
zengyawen 已提交
169 170 171 172
```
anonymous enum
```

Z
zengyawen 已提交
173
**描述:**
Z
zengyawen 已提交
174

Z
zengyawen 已提交
175
枚举API访问状态。
Z
zengyawen 已提交
176

Z
zengyawen 已提交
177
| 枚举值 | 描述 |
Z
zengyawen 已提交
178
| -------- | -------- |
Z
zengyawen 已提交
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
| OH_NATIVEXCOMPONENT_RESULT_SUCCESS | 成功结果。 |
| OH_NATIVEXCOMPONENT_RESULT_FAILED | 失败结果。 |
| OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER | 无效参数。 |
| OHOS_IMAGE_RESULT_SUCCESS | 成功的结果 |
| OHOS_IMAGE_RESULT_BAD_PARAMETER | 无效值 |

**自从:**

8


### OH_NativeXComponent_MouseEventAction


```
enum OH_NativeXComponent_MouseEventAction
```

**描述:**

鼠标事件动作.

| 枚举值 | 描述 |
| -------- | -------- |
| OH_NATIVEXCOMPONENT_MOUSE_NONE | 无效鼠标事件 。 |
| OH_NATIVEXCOMPONENT_MOUSE_PRESS | 鼠标按键按下时触发鼠标事件。 |
| OH_NATIVEXCOMPONENT_MOUSE_RELEASE | 鼠标按键松开时触发鼠标事件。 |
| OH_NATIVEXCOMPONENT_MOUSE_MOVE | 鼠标在屏幕上移动时触发鼠标事件。 |

**自从:**

9


### OH_NativeXComponent_MouseEventButton


```
enum OH_NativeXComponent_MouseEventButton
```

**描述:**

鼠标事件按键。

| 枚举值 | 描述 |
| -------- | -------- |
| OH_NATIVEXCOMPONENT_NONE_BUTTON | 鼠标无按键操作时触发鼠标事件。 |
| OH_NATIVEXCOMPONENT_LEFT_BUTTON | 按下鼠标左键时触发鼠标事件。 |
| OH_NATIVEXCOMPONENT_RIGHT_BUTTON | 按下鼠标右键时触发鼠标事件。 |
| OH_NATIVEXCOMPONENT_MIDDLE_BUTTON | 按下鼠标中键时触发鼠标事件。 |
| OH_NATIVEXCOMPONENT_BACK_BUTTON | 按下鼠标左侧后退键时触发鼠标事件。 |
| OH_NATIVEXCOMPONENT_FORWARD_BUTTON | 按下鼠标左侧前进键时触发鼠标事件。 |

**自从:**

9
Z
zengyawen 已提交
236 237 238 239


### OH_NativeXComponent_TouchEventType

Z
zengyawen 已提交
240

Z
zengyawen 已提交
241 242 243 244
```
enum OH_NativeXComponent_TouchEventType
```

Z
zengyawen 已提交
245 246 247 248 249
**描述:**

触摸事件类型。

| 枚举值 | 描述 |
Z
zengyawen 已提交
250
| -------- | -------- |
Z
zengyawen 已提交
251 252 253 254 255
| OH_NATIVEXCOMPONENT_DOWN | 手指按下时触发触摸事件。 |
| OH_NATIVEXCOMPONENT_UP | 手指抬起时触发触摸事件。 |
| OH_NATIVEXCOMPONENT_MOVE | 手指按下状态下在屏幕上移动时触发触摸事件。 |
| OH_NATIVEXCOMPONENT_CANCEL | 触摸事件取消时触发事件。 |
| OH_NATIVEXCOMPONENT_UNKNOWN | 无效的触摸类型。 |
Z
zengyawen 已提交
256

Z
zengyawen 已提交
257 258 259 260 261 262 263 264 265 266 267 268 269 270
**自从:**

8


## 函数说明


### OH_NativeXComponent_GetMouseEvent()


```
int32_t OH_NativeXComponent_GetMouseEvent (OH_NativeXComponent * component, const void * window, OH_NativeXComponent_MouseEvent * mouseEvent )
```
Z
zengyawen 已提交
271

Z
zengyawen 已提交
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
**描述:**

获取ArkUI XComponent调度的鼠标事件

**参数:**

| Name | 描述 |
| -------- | -------- |
| component | 表示指向OH_NativeXComponent实例的指针。 |
| window | 表示NativeWindow句柄。 |
| mouseEvent | 指示指向当前鼠标事件的指针。 |

**返回:**

返回执行的状态代码。

**自从:**

9
Z
zengyawen 已提交
291 292 293 294


### OH_NativeXComponent_GetTouchEvent()

Z
zengyawen 已提交
295

Z
zengyawen 已提交
296 297 298 299
```
int32_t OH_NativeXComponent_GetTouchEvent (OH_NativeXComponent * component, const void * window, OH_NativeXComponent_TouchEvent * touchEvent )
```

Z
zengyawen 已提交
300
**描述:**
Z
zengyawen 已提交
301

Z
zengyawen 已提交
302
获取ArkUI XComponent调度的触摸事件。
Z
zengyawen 已提交
303

Z
zengyawen 已提交
304
**参数:**
Z
zengyawen 已提交
305

Z
zengyawen 已提交
306
| Name | 描述 |
Z
zengyawen 已提交
307
| -------- | -------- |
Z
zengyawen 已提交
308 309 310 311 312
| component | 表示指向OH_NativeXComponent实例的指针。 |
| window | 表示NativeWindow句柄。 |
| touchEvent | 指示指向当前触摸事件的指针。 |

**返回:**
Z
zengyawen 已提交
313

Z
zengyawen 已提交
314
返回执行的状态代码。
Z
zengyawen 已提交
315

Z
zengyawen 已提交
316 317 318
**自从:**

8
Z
zengyawen 已提交
319 320 321 322


### OH_NativeXComponent_GetXComponentId()

Z
zengyawen 已提交
323

Z
zengyawen 已提交
324 325 326 327
```
int32_t OH_NativeXComponent_GetXComponentId (OH_NativeXComponent * component, char * id, uint64_t * size )
```

Z
zengyawen 已提交
328
**描述:**
Z
zengyawen 已提交
329

Z
zengyawen 已提交
330
获取ArkUI XComponent的id。
Z
zengyawen 已提交
331

Z
zengyawen 已提交
332
**参数:**
Z
zengyawen 已提交
333

Z
zengyawen 已提交
334
| Name | 描述 |
Z
zengyawen 已提交
335
| -------- | -------- |
Z
zengyawen 已提交
336 337 338 339 340 341 342
| component | 表示指向OH_NativeXComponent实例的指针。 |
| id | 指示用于保存此OH_NativeXComponent实例的ID的字符缓冲区。 请注意,空终止符将附加到字符缓冲区,因此字符缓冲区的大小应至少比真实id长度大一个单位。 建议字符缓冲区的大小为[OH_XCOMPONENT_ID_LEN_MAX + 1]。 |
| size | 指示指向id长度的指针。 |

**返回:**

返回执行的状态代码。
Z
zengyawen 已提交
343

Z
zengyawen 已提交
344
**自从:**
Z
zengyawen 已提交
345

Z
zengyawen 已提交
346
8
Z
zengyawen 已提交
347 348 349 350


### OH_NativeXComponent_GetXComponentOffset()

Z
zengyawen 已提交
351

Z
zengyawen 已提交
352 353 354 355
```
int32_t OH_NativeXComponent_GetXComponentOffset (OH_NativeXComponent * component, const void * window, double * x, double * y )
```

Z
zengyawen 已提交
356
**描述:**
Z
zengyawen 已提交
357

Z
zengyawen 已提交
358
获取ArkUI XComponent组件相对屏幕左上顶点的偏移量。
Z
zengyawen 已提交
359

Z
zengyawen 已提交
360
**参数:**
Z
zengyawen 已提交
361

Z
zengyawen 已提交
362
| Name | 描述 |
Z
zengyawen 已提交
363
| -------- | -------- |
Z
zengyawen 已提交
364 365 366 367 368 369
| component | 表示指向OH_NativeXComponent实例的指针。 |
| window | 表示NativeWindow句柄。 |
| x | 指示指向当前surface的x坐标的指针。 |
| y | 指示指向当前surface的y坐标的指针。 |

**返回:**
Z
zengyawen 已提交
370

Z
zengyawen 已提交
371
返回执行的状态代码。
Z
zengyawen 已提交
372

Z
zengyawen 已提交
373 374 375
**自从:**

8
Z
zengyawen 已提交
376 377 378 379


### OH_NativeXComponent_GetXComponentSize()

Z
zengyawen 已提交
380

Z
zengyawen 已提交
381 382 383 384
```
int32_t OH_NativeXComponent_GetXComponentSize (OH_NativeXComponent * component, const void * window, uint64_t * width, uint64_t * height )
```

Z
zengyawen 已提交
385
**描述:**
Z
zengyawen 已提交
386

Z
zengyawen 已提交
387
获取ArkUI XComponent持有的surface的大小。
Z
zengyawen 已提交
388

Z
zengyawen 已提交
389
**参数:**
Z
zengyawen 已提交
390

Z
zengyawen 已提交
391
| Name | 描述 |
Z
zengyawen 已提交
392
| -------- | -------- |
Z
zengyawen 已提交
393 394 395 396 397 398 399 400
| component | 表示指向OH_NativeXComponent实例的指针。 |
| window | 表示NativeWindow句柄。 |
| width | 指示指向当前surface宽度的指针。 |
| height | 指示指向当前surface高度的指针。 |

**返回:**

返回执行的状态代码。
Z
zengyawen 已提交
401

Z
zengyawen 已提交
402
**自从:**
Z
zengyawen 已提交
403

Z
zengyawen 已提交
404
8
Z
zengyawen 已提交
405 406 407 408


### OH_NativeXComponent_RegisterCallback()

Z
zengyawen 已提交
409

Z
zengyawen 已提交
410 411 412 413
```
int32_t OH_NativeXComponent_RegisterCallback (OH_NativeXComponent * component, OH_NativeXComponent_Callback * callback )
```

Z
zengyawen 已提交
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
**描述:**

为此OH_NativeXComponent实例注册回调。

**参数:**

| Name | 描述 |
| -------- | -------- |
| component | 表示指向OH_NativeXComponent实例的指针。 |
| callback | 指示指向surface生命周期和触摸事件回调的指针。 |

**返回:**

返回执行的状态代码。

**自从:**

8


### OH_NativeXComponent_RegisterMouseEventCallback()


```
int32_t OH_NativeXComponent_RegisterMouseEventCallback (OH_NativeXComponent * component, OH_NativeXComponent_MouseEvent_Callback * callback )
```

**描述:**
Z
zengyawen 已提交
442

Z
zengyawen 已提交
443
为此OH_NativeXComponent实例注册鼠标事件回调。
Z
zengyawen 已提交
444

Z
zengyawen 已提交
445
**参数:**
Z
zengyawen 已提交
446

Z
zengyawen 已提交
447
| Name | 描述 |
Z
zengyawen 已提交
448
| -------- | -------- |
Z
zengyawen 已提交
449 450
| component | 表示指向OH_NativeXComponent实例的指针。 |
| callback | 指示指向鼠标事件回调的指针。 |
Z
zengyawen 已提交
451

Z
zengyawen 已提交
452
**返回:**
Z
zengyawen 已提交
453

Z
zengyawen 已提交
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
返回执行的状态代码。

**自从:**

9


## 变量说明


### OH_XCOMPONENT_ID_LEN_MAX


```
const uint32_t OH_XCOMPONENT_ID_LEN_MAX = 128
```

**描述:**

ArkUI XComponent的id最大长度。

**自从:**

8


### OH_MAX_TOUCH_POINTS_NUMBER


```
const uint32_t OH_MAX_TOUCH_POINTS_NUMBER = 10
```
Z
zengyawen 已提交
486

Z
zengyawen 已提交
487
**描述:**
Z
zengyawen 已提交
488

Z
zengyawen 已提交
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
触摸事件中的可识别的触摸点个数最大值。

**自从:**

8


### action


```
OH_NativeXComponent_MouseEventAction OH_NativeXComponent_MouseEvent::action
```

**描述:**

当前鼠标事件动作。

**自从:**

8


### button


```
OH_NativeXComponent_MouseEventButton OH_NativeXComponent_MouseEvent::button
```

**描述:**

鼠标事件按键

**自从:**

8
Z
zengyawen 已提交
526 527 528 529


### deviceId

Z
zengyawen 已提交
530

Z
zengyawen 已提交
531 532 533 534
```
int64_t OH_NativeXComponent_TouchEvent::deviceId = 0
```

Z
zengyawen 已提交
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
**描述:**

产生当前触摸事件的设备的ID。

**自从:**

8


### DispatchHoverEvent


```
void(* OH_NativeXComponent_MouseEvent_Callback::DispatchHoverEvent) (OH_NativeXComponent *component, bool isHover)
```

**描述:**

当悬停事件被触发时调用。

**自从:**

8
Z
zengyawen 已提交
558

Z
zengyawen 已提交
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573

### DispatchMouseEvent


```
void(* OH_NativeXComponent_MouseEvent_Callback::DispatchMouseEvent) (OH_NativeXComponent *component, void *window)
```

**描述:**

当鼠标事件被触发时调用。

**自从:**

8
Z
zengyawen 已提交
574 575 576 577


### DispatchTouchEvent

Z
zengyawen 已提交
578

Z
zengyawen 已提交
579 580 581 582
```
void(* OH_NativeXComponent_Callback::DispatchTouchEvent) (OH_NativeXComponent *component, void *window)
```

Z
zengyawen 已提交
583
**描述:**
Z
zengyawen 已提交
584

Z
zengyawen 已提交
585 586 587 588 589
当触摸事件被触发时调用。

**自从:**

8
Z
zengyawen 已提交
590 591 592 593


### force [1/2]

Z
zengyawen 已提交
594

Z
zengyawen 已提交
595 596 597 598
```
float OH_NativeXComponent_TouchPoint::force = 0.0
```

Z
zengyawen 已提交
599 600 601
**描述:**

当前触摸事件的压力。
Z
zengyawen 已提交
602

Z
zengyawen 已提交
603 604 605
**自从:**

8
Z
zengyawen 已提交
606 607 608 609


### force [2/2]

Z
zengyawen 已提交
610

Z
zengyawen 已提交
611 612 613 614
```
float OH_NativeXComponent_TouchEvent::force = 0.0
```

Z
zengyawen 已提交
615 616 617 618 619
**描述:**

当前触摸事件的压力。

**自从:**
Z
zengyawen 已提交
620

Z
zengyawen 已提交
621
8
Z
zengyawen 已提交
622 623 624 625


### id [1/2]

Z
zengyawen 已提交
626

Z
zengyawen 已提交
627 628 629 630
```
int32_t OH_NativeXComponent_TouchPoint::id = 0
```

Z
zengyawen 已提交
631 632 633
**描述:**

手指的唯一标识符。
Z
zengyawen 已提交
634

Z
zengyawen 已提交
635 636 637
**自从:**

8
Z
zengyawen 已提交
638 639 640 641


### id [2/2]

Z
zengyawen 已提交
642

Z
zengyawen 已提交
643 644 645 646
```
int32_t OH_NativeXComponent_TouchEvent::id = 0
```

Z
zengyawen 已提交
647
**描述:**
Z
zengyawen 已提交
648

Z
zengyawen 已提交
649 650 651 652 653
手指的唯一标识符。

**自从:**

8
Z
zengyawen 已提交
654 655 656 657


### isPressed

Z
zengyawen 已提交
658

Z
zengyawen 已提交
659 660 661 662
```
bool OH_NativeXComponent_TouchPoint::isPressed = false
```

Z
zengyawen 已提交
663
**描述:**
Z
zengyawen 已提交
664

Z
zengyawen 已提交
665 666 667 668 669
当前点是否被按下。

**自从:**

8
Z
zengyawen 已提交
670 671 672 673


### numPoints

Z
zengyawen 已提交
674

Z
zengyawen 已提交
675 676 677 678
```
uint32_t OH_NativeXComponent_TouchEvent::numPoints = 0
```

Z
zengyawen 已提交
679 680 681 682 683
**描述:**

当前接触点的数量。

**自从:**
Z
zengyawen 已提交
684

Z
zengyawen 已提交
685
8
Z
zengyawen 已提交
686 687 688 689


### OnSurfaceChanged

Z
zengyawen 已提交
690

Z
zengyawen 已提交
691 692 693 694
```
void(* OH_NativeXComponent_Callback::OnSurfaceChanged) (OH_NativeXComponent *component, void *window)
```

Z
zengyawen 已提交
695 696 697
**描述:**

当surface改变时调用。
Z
zengyawen 已提交
698

Z
zengyawen 已提交
699 700 701
**自从:**

8
Z
zengyawen 已提交
702 703 704 705


### OnSurfaceCreated

Z
zengyawen 已提交
706

Z
zengyawen 已提交
707 708 709 710
```
void(* OH_NativeXComponent_Callback::OnSurfaceCreated) (OH_NativeXComponent *component, void *window)
```

Z
zengyawen 已提交
711 712 713 714 715
**描述:**

创建surface时调用。

**自从:**
Z
zengyawen 已提交
716

Z
zengyawen 已提交
717
8
Z
zengyawen 已提交
718 719 720 721


### OnSurfaceDestroyed

Z
zengyawen 已提交
722

Z
zengyawen 已提交
723 724 725 726
```
void(* OH_NativeXComponent_Callback::OnSurfaceDestroyed) (OH_NativeXComponent *component, void *window)
```

Z
zengyawen 已提交
727
**描述:**
Z
zengyawen 已提交
728

Z
zengyawen 已提交
729
当surface被破坏时调用。
Z
zengyawen 已提交
730

Z
zengyawen 已提交
731 732 733 734 735 736
**自从:**

8


### screenX [1/3]
Z
zengyawen 已提交
737 738 739 740 741 742


```
float OH_NativeXComponent_TouchPoint::screenX = 0.0
```

Z
zengyawen 已提交
743
**描述:**
Z
zengyawen 已提交
744

Z
zengyawen 已提交
745
触摸点相对于屏幕左边缘的x坐标。
Z
zengyawen 已提交
746

Z
zengyawen 已提交
747 748 749 750 751 752
**自从:**

8


### screenX [2/3]
Z
zengyawen 已提交
753 754 755 756 757 758


```
float OH_NativeXComponent_TouchEvent::screenX = 0.0
```

Z
zengyawen 已提交
759 760 761 762 763 764 765
**描述:**

触摸点相对于屏幕左边缘的x坐标。

**自从:**

8
Z
zengyawen 已提交
766 767


Z
zengyawen 已提交
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
### screenX [3/3]


```
float OH_NativeXComponent_MouseEvent::screenX
```

**描述:**

点击触点相对于屏幕左上角的x轴坐标。

**自从:**

8


### screenY [1/3]
Z
zengyawen 已提交
785 786 787 788 789 790


```
float OH_NativeXComponent_TouchPoint::screenY = 0.0
```

Z
zengyawen 已提交
791 792 793 794 795 796 797
**描述:**

触摸点相对于屏幕上边缘的y坐标。

**自从:**

8
Z
zengyawen 已提交
798 799


Z
zengyawen 已提交
800
### screenY [2/3]
Z
zengyawen 已提交
801 802 803 804 805 806


```
float OH_NativeXComponent_TouchEvent::screenY = 0.0
```

Z
zengyawen 已提交
807 808 809 810 811 812 813 814 815 816 817
**描述:**

触摸点相对于屏幕上边缘的y坐标。

**自从:**

8


### screenY [3/3]

Z
zengyawen 已提交
818

Z
zengyawen 已提交
819 820 821 822 823 824 825 826 827 828 829
```
float OH_NativeXComponent_MouseEvent::screenY
```

**描述:**

点击触点相对于屏幕左上角的y轴坐标。

**自从:**

8
Z
zengyawen 已提交
830 831 832 833


### size [1/2]

Z
zengyawen 已提交
834

Z
zengyawen 已提交
835 836 837 838
```
double OH_NativeXComponent_TouchPoint::size = 0.0
```

Z
zengyawen 已提交
839
**描述:**
Z
zengyawen 已提交
840

Z
zengyawen 已提交
841 842 843 844 845
指垫和屏幕之间的接触面积。

**自从:**

8
Z
zengyawen 已提交
846 847 848 849


### size [2/2]

Z
zengyawen 已提交
850

Z
zengyawen 已提交
851 852 853 854
```
double OH_NativeXComponent_TouchEvent::size = 0.0
```

Z
zengyawen 已提交
855
**描述:**
Z
zengyawen 已提交
856

Z
zengyawen 已提交
857 858 859 860 861
指垫和屏幕之间的接触面积。

**自从:**

8
Z
zengyawen 已提交
862 863 864 865


### timeStamp [1/2]

Z
zengyawen 已提交
866

Z
zengyawen 已提交
867 868 869 870
```
long long OH_NativeXComponent_TouchPoint::timeStamp = 0
```

Z
zengyawen 已提交
871 872 873 874 875
**描述:**

当前触摸事件的时间戳。

**自从:**
Z
zengyawen 已提交
876

Z
zengyawen 已提交
877
8
Z
zengyawen 已提交
878 879 880 881


### timeStamp [2/2]

Z
zengyawen 已提交
882

Z
zengyawen 已提交
883 884 885 886
```
long long OH_NativeXComponent_TouchEvent::timeStamp = 0
```

Z
zengyawen 已提交
887 888 889
**描述:**

当前触摸事件的时间戳。
Z
zengyawen 已提交
890

Z
zengyawen 已提交
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
**自从:**

8


### timestamp


```
int64_t OH_NativeXComponent_MouseEvent::timestamp
```

**描述:**

当前鼠标事件的时间戳

**自从:**

8
Z
zengyawen 已提交
910 911 912 913


### touchPoints

Z
zengyawen 已提交
914

Z
zengyawen 已提交
915 916 917 918
```
OH_NativeXComponent_TouchPoint OH_NativeXComponent_TouchEvent::touchPoints[OH_MAX_TOUCH_POINTS_NUMBER]
```

Z
zengyawen 已提交
919 920 921
**描述:**

当前触摸点的数组。
Z
zengyawen 已提交
922

Z
zengyawen 已提交
923 924 925
**自从:**

8
Z
zengyawen 已提交
926 927 928 929


### type [1/2]

Z
zengyawen 已提交
930

Z
zengyawen 已提交
931 932 933 934
```
OH_NativeXComponent_TouchEventType OH_NativeXComponent_TouchPoint::type = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN
```

Z
zengyawen 已提交
935 936 937
**描述:**

触摸事件的触摸类型。
Z
zengyawen 已提交
938

Z
zengyawen 已提交
939 940 941
**自从:**

8
Z
zengyawen 已提交
942 943 944 945


### type [2/2]

Z
zengyawen 已提交
946

Z
zengyawen 已提交
947 948 949 950
```
OH_NativeXComponent_TouchEventType OH_NativeXComponent_TouchEvent::type = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN
```

Z
zengyawen 已提交
951
**描述:**
Z
zengyawen 已提交
952

Z
zengyawen 已提交
953
触摸事件的触摸类型。
Z
zengyawen 已提交
954

Z
zengyawen 已提交
955 956 957 958 959 960
**自从:**

8


### x [1/3]
Z
zengyawen 已提交
961 962 963 964 965 966


```
float OH_NativeXComponent_TouchPoint::x = 0.0
```

Z
zengyawen 已提交
967 968 969
**描述:**

触摸点相对于XComponent组件左边缘的x坐标。
Z
zengyawen 已提交
970

Z
zengyawen 已提交
971
**自从:**
Z
zengyawen 已提交
972

Z
zengyawen 已提交
973 974 975 976
8


### x [2/3]
Z
zengyawen 已提交
977 978 979 980 981 982


```
float OH_NativeXComponent_TouchEvent::x = 0.0
```

Z
zengyawen 已提交
983 984 985
**描述:**

触摸点相对于XComponent组件左边缘的x坐标。
Z
zengyawen 已提交
986

Z
zengyawen 已提交
987 988 989
**自从:**

8
Z
zengyawen 已提交
990 991


Z
zengyawen 已提交
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
### x [3/3]


```
float OH_NativeXComponent_MouseEvent::x
```

**描述:**

点击触点相对于当前组件左上角的x轴坐标。

**自从:**

8


### y [1/3]

Z
zengyawen 已提交
1010 1011 1012 1013 1014

```
float OH_NativeXComponent_TouchPoint::y = 0.0
```

Z
zengyawen 已提交
1015 1016 1017 1018 1019 1020 1021
**描述:**

触摸点相对于XComponent组件上边缘的y坐标。

**自从:**

8
Z
zengyawen 已提交
1022 1023


Z
zengyawen 已提交
1024
### y [2/3]
Z
zengyawen 已提交
1025 1026 1027 1028 1029 1030


```
float OH_NativeXComponent_TouchEvent::y = 0.0
```

Z
zengyawen 已提交
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
**描述:**

触摸点相对于XComponent组件上边缘的y坐标。

**自从:**

8


### y [3/3]


```
float OH_NativeXComponent_MouseEvent::y
```

**描述:**

点击触点相对于当前组件左上角的y轴坐标。
Z
zengyawen 已提交
1050

Z
zengyawen 已提交
1051 1052 1053
**自从:**

8