Native XComponent

概述

描述ArkUI XComponent持有的surface和触摸事件，该事件可用于EGL/OpenGLES和媒体数据输入，并显示在ArkUI XComponent上，具体使用请参考XComponent开发指导。

说明：

该模块从API Version 8 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

汇总

文件

结构体

类型定义

枚举

函数

变量

类型定义说明

OH_NativeXComponent

typedef struct OH_NativeXComponent OH_NativeXComponent

描述:

提供封装的OH_NativeXComponent实例。

起始版本：

8

OH_NativeXComponent_Callback

typedef struct OH_NativeXComponent_Callback OH_NativeXComponent_Callback

描述:

注册surface生命周期和触摸事件回调。

起始版本：

8

OH_NativeXComponent_KeyEvent

typedef struct OH_NativeXComponent_KeyEvent OH_NativeXComponent_KeyEvent

描述:

提供封装的OH_NativeXComponent_KeyEvent实例。

起始版本：

10

OH_NativeXComponent_MouseEvent_Callback

typedef struct OH_NativeXComponent_MouseEvent_Callback OH_NativeXComponent_MouseEvent_Callback

描述:

注册鼠标事件的回调。

起始版本：

9

枚举类型说明

anonymous enum

anonymous enum

描述:

枚举API访问状态。

起始版本：

8

OH_NativeXComponent_EventSourceType

enum OH_NativeXComponent_EventSourceType

描述:

触摸事件源类型。

起始版本：

9

OH_NativeXComponent_KeyAction

enum OH_NativeXComponent_KeyAction

描述:

按键事件动作。

起始版本：

10

OH_NativeXComponent_KeyCode

enum OH_NativeXComponent_KeyCode

描述:

按键事件的键码。

起始版本：

10

OH_NativeXComponent_MouseEventAction

enum OH_NativeXComponent_MouseEventAction

描述:

鼠标事件动作。

起始版本：

9

OH_NativeXComponent_MouseEventButton

enum OH_NativeXComponent_MouseEventButton

描述:

鼠标事件按键。

起始版本：

9

OH_NativeXComponent_TouchEventType

enum OH_NativeXComponent_TouchEventType

描述:

触摸事件类型。

起始版本：

8

OH_NativeXComponent_TouchPointToolType

enum OH_NativeXComponent_TouchPointToolType

描述:

触摸点工具类型

起始版本：

9

函数说明

OH_NativeXComponent_GetKeyEvent()

int32_t OH_NativeXComponent_GetKeyEvent (OH_NativeXComponent * component, OH_NativeXComponent_KeyEvent ** keyEvent )

描述:

获取ArkUI XComponent调度的按键事件。

参数:

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetKeyEventAction()

int32_t OH_NativeXComponent_GetKeyEventAction (OH_NativeXComponent_KeyEvent * keyEvent, OH_NativeXComponent_KeyAction * action )

描述:

获取传入按键事件的动作。

参数:

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetKeyEventCode()

int32_t OH_NativeXComponent_GetKeyEventCode (OH_NativeXComponent_KeyEvent * keyEvent, OH_NativeXComponent_KeyCode * code )

描述:

获取传入按键事件的按键码。

参数:

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetKeyEventDeviceId()

int32_t OH_NativeXComponent_GetKeyEventDeviceId (OH_NativeXComponent_KeyEvent * keyEvent, int64_t * deviceId )

描述:

获取传入按键事件的设备id。

参数:

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetKeyEventSourceType()

int32_t OH_NativeXComponent_GetKeyEventSourceType (OH_NativeXComponent_KeyEvent * keyEvent, OH_NativeXComponent_EventSourceType * sourceType )

描述:

获取传入按键事件的事件源类型。

参数:

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetKeyEventTimeStamp()

int32_t OH_NativeXComponent_GetKeyEventTimeStamp (OH_NativeXComponent_KeyEvent * keyEvent, int64_t * timeStamp )

描述:

获取传入按键事件的时间戳。

参数:

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetMouseEvent()

int32_t OH_NativeXComponent_GetMouseEvent (OH_NativeXComponent * component, const void * window, OH_NativeXComponent_MouseEvent * mouseEvent )

描述:

获取ArkUI XComponent调度的鼠标事件

参数:

返回:

返回执行的状态代码。

起始版本：

9

OH_NativeXComponent_GetTouchEvent()

int32_t OH_NativeXComponent_GetTouchEvent (OH_NativeXComponent * component, const void * window, OH_NativeXComponent_TouchEvent * touchEvent )

描述:

获取ArkUI XComponent调度的触摸事件。

参数:

返回:

返回执行的状态代码。

起始版本：

8

OH_NativeXComponent_GetTouchPointTiltX()

int32_t OH_NativeXComponent_GetTouchPointTiltX (OH_NativeXComponent * component, uint32_t pointIndex, float * tiltX )

描述:

获取ArkUI XComponent触摸点倾斜与X轴角度。

参数:

返回:

返回执行的状态代码。

起始版本：

9

OH_NativeXComponent_GetTouchPointTiltY()

int32_t OH_NativeXComponent_GetTouchPointTiltY (OH_NativeXComponent * component, uint32_t pointIndex, float * tiltY )

描述:

获取ArkUI XComponent触摸点倾斜与Y轴角度。

参数:

返回:

返回执行的状态代码。

起始版本：

9

OH_NativeXComponent_GetTouchPointToolType()

int32_t OH_NativeXComponent_GetTouchPointToolType (OH_NativeXComponent * component, uint32_t pointIndex, OH_NativeXComponent_TouchPointToolType * toolType )

描述:

获取ArkUI XComponent触摸点工具类型。

参数:

返回:

返回执行的状态代码。

起始版本：

9

OH_NativeXComponent_GetXComponentId()

int32_t OH_NativeXComponent_GetXComponentId (OH_NativeXComponent * component, char * id, uint64_t * size )

描述:

获取ArkUI XComponent的id。

参数:

返回:

返回执行的状态代码。

起始版本：

8

OH_NativeXComponent_GetXComponentOffset()

int32_t OH_NativeXComponent_GetXComponentOffset (OH_NativeXComponent * component, const void * window, double * x, double * y )

描述:

获取ArkUI XComponent组件相对屏幕左上顶点的偏移量。

参数:

返回:

返回执行的状态代码。

起始版本：

8

OH_NativeXComponent_GetXComponentSize()

int32_t OH_NativeXComponent_GetXComponentSize (OH_NativeXComponent * component, const void * window, uint64_t * width, uint64_t * height )

描述:

获取ArkUI XComponent持有的surface的大小。

参数:

返回:

返回执行的状态代码。

起始版本：

8

OH_NativeXComponent_RegisterBlurEventCallback()

int32_t OH_NativeXComponent_RegisterBlurEventCallback (OH_NativeXComponent * component, void(*callback)(OH_NativeXComponent *component, void *window))

描述:

为此OH_NativeXComponent实例注册失焦事件回调。

参数:

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_RegisterCallback()

int32_t OH_NativeXComponent_RegisterCallback (OH_NativeXComponent * component, OH_NativeXComponent_Callback * callback )

描述:

为此OH_NativeXComponent实例注册回调。

参数:

返回:

返回执行的状态代码。

起始版本：

8

OH_NativeXComponent_RegisterFocusEventCallback()

int32_t OH_NativeXComponent_RegisterFocusEventCallback (OH_NativeXComponent * component, void(*callback)(OH_NativeXComponent *component, void *window))

描述:

为此OH_NativeXComponent实例注册获焦事件回调。

参数:

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_RegisterKeyEventCallback()

int32_t OH_NativeXComponent_RegisterKeyEventCallback (OH_NativeXComponent * component, void(*callback)(OH_NativeXComponent *component, void *window))

描述:

为此OH_NativeXComponent实例注册按键事件回调。

参数:

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_RegisterMouseEventCallback()

int32_t OH_NativeXComponent_RegisterMouseEventCallback (OH_NativeXComponent * component, OH_NativeXComponent_MouseEvent_Callback * callback )

描述:

为此OH_NativeXComponent实例注册鼠标事件回调。

参数:

返回:

返回执行的状态代码。

起始版本：

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

描述：

触摸事件中的可识别的触摸点个数最大值。

起始版本：

8

action

OH_NativeXComponent_MouseEventAction OH_NativeXComponent_MouseEvent::action

描述:

当前鼠标事件动作。

起始版本：

8

button

OH_NativeXComponent_MouseEventButton OH_NativeXComponent_MouseEvent::button

描述:

鼠标事件按键。

起始版本：

8

deviceId

int64_t OH_NativeXComponent_TouchEvent::deviceId = 0

描述:

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

起始版本：

8

DispatchHoverEvent

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

描述:

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

起始版本：

8

DispatchMouseEvent

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

描述:

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

起始版本：

8

DispatchTouchEvent

void(* OH_NativeXComponent_Callback::DispatchTouchEvent) (OH_NativeXComponent *component, void *window)

描述:

当触摸事件被触发时调用。

起始版本：

8

force [1/2]

float OH_NativeXComponent_TouchPoint::force = 0.0

描述:

当前触摸事件的压力。

起始版本：

8

force [2/2]

float OH_NativeXComponent_TouchEvent::force = 0.0

描述:

当前触摸事件的压力。

起始版本：

8

id [1/2]

int32_t OH_NativeXComponent_TouchPoint::id = 0

描述:

手指的唯一标识符。

起始版本：

8

id [2/2]

int32_t OH_NativeXComponent_TouchEvent::id = 0

描述:

手指的唯一标识符。

起始版本：

8

isPressed

bool OH_NativeXComponent_TouchPoint::isPressed = false

描述:

当前点是否被按下。

起始版本：

8

numPoints

uint32_t OH_NativeXComponent_TouchEvent::numPoints = 0

描述:

当前接触点的数量。

起始版本：

8

OnSurfaceChanged

void(* OH_NativeXComponent_Callback::OnSurfaceChanged) (OH_NativeXComponent *component, void *window)

描述:

当surface改变时调用。

起始版本：

8

OnSurfaceCreated

void(* OH_NativeXComponent_Callback::OnSurfaceCreated) (OH_NativeXComponent *component, void *window)

描述:

创建surface时调用。

起始版本：

8

OnSurfaceDestroyed

void(* OH_NativeXComponent_Callback::OnSurfaceDestroyed) (OH_NativeXComponent *component, void *window)

描述:

当surface被销毁时调用。

起始版本：

8

screenX [1/3]

float OH_NativeXComponent_TouchPoint::screenX = 0.0

描述:

触摸点相对于XComponent所在应用窗口左上角的x坐标。

起始版本：

8

screenX [2/3]

float OH_NativeXComponent_TouchEvent::screenX = 0.0

描述:

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

起始版本：

8

screenX [3/3]

float OH_NativeXComponent_MouseEvent::screenX

描述:

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

起始版本：

8

screenY [1/3]

float OH_NativeXComponent_TouchPoint::screenY = 0.0

描述:

触摸点相对于XComponent所在应用窗口左上角的y坐标。

起始版本：

8

screenY [2/3]

float OH_NativeXComponent_TouchEvent::screenY = 0.0

描述:

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

起始版本：

8

screenY [3/3]

float OH_NativeXComponent_MouseEvent::screenY

描述:

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

起始版本：

8

size [1/2]

double OH_NativeXComponent_TouchPoint::size = 0.0

描述:

指垫和屏幕之间的接触面积。

起始版本：

8

size [2/2]

double OH_NativeXComponent_TouchEvent::size = 0.0

描述:

指垫和屏幕之间的接触面积。

起始版本：

8

timeStamp [1/2]

long long OH_NativeXComponent_TouchPoint::timeStamp = 0

描述:

当前触摸事件的时间戳。

起始版本：

8

timeStamp [2/2]

long long OH_NativeXComponent_TouchEvent::timeStamp = 0

描述:

当前触摸事件的时间戳。

起始版本：

8

timestamp

int64_t OH_NativeXComponent_MouseEvent::timestamp

描述:

当前鼠标事件的时间戳。

起始版本：

8

touchPoints

OH_NativeXComponent_TouchPoint OH_NativeXComponent_TouchEvent::touchPoints[OH_MAX_TOUCH_POINTS_NUMBER]

描述:

当前触摸点的数组。

起始版本：

8

type [1/2]

OH_NativeXComponent_TouchEventType OH_NativeXComponent_TouchPoint::type = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN

描述:

触摸事件的触摸类型。

起始版本：

8

type [2/2]

OH_NativeXComponent_TouchEventType OH_NativeXComponent_TouchEvent::type = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN

描述:

触摸事件的触摸类型。

起始版本：

8

x [1/3]

float OH_NativeXComponent_TouchPoint::x = 0.0

描述:

触摸点相对于XComponent组件左边缘的x坐标。

起始版本：

8

x [2/3]

float OH_NativeXComponent_TouchEvent::x = 0.0

描述:

触摸点相对于XComponent组件左边缘的x坐标。

起始版本：

8

x [3/3]

float OH_NativeXComponent_MouseEvent::x

描述:

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

起始版本：

8

y [1/3]

float OH_NativeXComponent_TouchPoint::y = 0.0

描述:

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

起始版本：

8

y [2/3]

float OH_NativeXComponent_TouchEvent::y = 0.0

描述:

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

起始版本：

8

y [3/3]

float OH_NativeXComponent_MouseEvent::y

描述:

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

起始版本：

8