目录

ArkUI_NativeGestureAPI_2

typedef struct {...} ArkUI_NativeGestureAPI_2

概述

定义手势模块接口集合,在ArkUI_NativeGestureAPI_1的基础上扩展提供设置手势打断事件回调的能力,用于在手势处理过程中根据回调结果继续或打断手势。开发者可以通过gestureApi1访问基础手势接口,配合setGestureInterrupterToNode实现完整的手势打断处理功能。

起始版本: 18

相关模块: ArkUI_NativeModule

所在头文件: native_gesture.h

汇总

[h2]成员变量

名称 描述
ArkUI_NativeGestureAPI_1* gestureApi1 指向ArkUI_NativeGestureAPI_1结构体的指针。

[h2]成员函数

成员函数说明

[h2]setGestureInterrupterToNode()

int32_t (*setGestureInterrupterToNode)(ArkUI_NodeHandle node, void* userData, ArkUI_GestureInterruptResult (*interrupter)(ArkUI_GestureInterruptInfo* info))

描述:

设置手势打断事件的回调函数,适用于需要在手势识别过程中根据当前交互状态决定手势继续响应或中断的场景,例如处理手势响应冲突。

参数:

参数项 描述
ArkUI_NodeHandle node 需要被设置手势打断回调的ArkUI节点指针。
void* userData 用户自定义数据,用于在设置手势打断回调时关联调用方自定义的上下文数据,供回调执行处理逻辑时使用;不需要关联自定义上下文时可传入nullptr。
ArkUI_GestureInterruptResult (*interrupter)(ArkUI_GestureInterruptInfo* info)

手势打断回调,info提供手势打断数据。interrupter返回GESTURE_INTERRUPT_RESULT_CONTINUE时手势正常进行,适用于允许手势继续响应的场景;返回GESTURE_INTERRUPT_RESULT_REJECT时手势打断,适用于需要优先处理其他手势或交互的场景。设置此参数为nullptr时将取消注册回调函数。

说明: 该手势打断回调注册后,后续在单次手势处理流程中都会存在。即使在同一次手势处理流程中使用setGestureInterrupterToNode接口将手势打断回调重置为nullptr,或者使用dispose接口使即将被触发的手势销毁,该回调在满足触发条件后仍会响应。如果在该回调中使用到的对象,在回调触发前可能已被释放,需要确保该对象在回调触发期间仍可安全访问。

返回:

类型 说明
int32_t

错误码。

ARKUI_ERROR_CODE_NO_ERROR 成功。

ARKUI_ERROR_CODE_PARAM_INVALID 参数错误。