diff --git a/zh-cn/native_sdk/arkui/ace_engine/native/native_gesture.h b/zh-cn/native_sdk/arkui/ace_engine/native/native_gesture.h index 971b8c5ea1bc8fc82d08fe859001331eb2741e41..5c159b9399ddd740f45e3cffc27b3b516b0bd4a5 100644 --- a/zh-cn/native_sdk/arkui/ace_engine/native/native_gesture.h +++ b/zh-cn/native_sdk/arkui/ace_engine/native/native_gesture.h @@ -316,550 +316,550 @@ typedef ArkUI_TouchRecognizerHandle* ArkUI_TouchRecognizerHandleArray; typedef void (*ArkUI_GestureRecognizerDisposeNotifyCallback)(ArkUI_GestureRecognizer* recognizer, void* userData); /** -* @brief 判断是否组件内置手势。 -* -* @param event 手势打断回调事件。 -* @return true: 系统内置手势； -* false: 非系统内置手势。 -* @since 12 -*/ + * @brief 判断是否组件内置手势。 + * + * @param event 手势打断回调事件。 + * @return true: 系统内置手势； + * false: 非系统内置手势。 + * @since 12 + */ bool OH_ArkUI_GestureInterruptInfo_GetSystemFlag(const ArkUI_GestureInterruptInfo* event); /** -* @brief 返回被打断的手势指针。 -* -* @param event 手势打断回调事件。 -* @return 被打断的手势指针。 -* @since 12 -*/ + * @brief 返回被打断的手势指针。 + * + * @param event 手势打断回调事件。 + * @return 被打断的手势指针。 + * @since 12 + */ ArkUI_GestureRecognizer* OH_ArkUI_GestureInterruptInfo_GetRecognizer(const ArkUI_GestureInterruptInfo* event); /** -* @brief 返回打断的手势事件数据。 -* -* @param event 手势打断回调事件。 -* @return 打断的手势事件数据。 -* @since 12 -*/ + * @brief 返回打断的手势事件数据。 + * + * @param event 手势打断回调事件。 + * @return 打断的手势事件数据。 + * @since 12 + */ ArkUI_GestureEvent* OH_ArkUI_GestureInterruptInfo_GetGestureEvent(const ArkUI_GestureInterruptInfo* event); /** -* @brief 当要触发的是系统内部手势时，使用该方法可返回该系统内部手势的类型。 -* -* @param event 手势打断回调事件。 -* @return 要触发的内部手势对应的手势类型，如果当前触发的手势不是系统内部手势，则返回 -1。 -* @since 12 -*/ + * @brief 当要触发的是系统内部手势时，使用该方法可返回该系统内部手势的类型。 + * + * @param event 手势打断回调事件。 + * @return 要触发的内部手势对应的手势类型，如果当前触发的手势不是系统内部手势，则返回 -1。 + * @since 12 + */ int32_t OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType(const ArkUI_GestureInterruptInfo* event); /** -* @brief 从手势打断信息中获取触摸识别器。 -* -* @param info 指向手势打断信息的指针。 -* @param recognizers 指向触摸识别器数组的指针。 -* @param size 触摸识别器数组的大小。 -* @return Returns {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 -* @since 15 -*/ + * @brief 从手势打断信息中获取触摸识别器。 + * + * @param info 指向手势打断信息的指针。 + * @param recognizers 指向触摸识别器数组的指针。 + * @param size 触摸识别器数组的大小。 + * @return Returns {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 + * @since 15 + */ int32_t OH_ArkUI_GestureInterruptInfo_GetTouchRecognizers(const ArkUI_GestureInterruptInfo* info, ArkUI_TouchRecognizerHandleArray* recognizers, int32_t* size); /** -* @brief 获取触摸识别器对应的组件句柄。 -* -* @param recognizer 触摸识别器的句柄。 -* @return 触摸识别器对应的组件句柄。 -* @since 15 -*/ + * @brief 获取触摸识别器对应的组件句柄。 + * + * @param recognizer 触摸识别器的句柄。 + * @return 触摸识别器对应的组件句柄。 + * @since 15 + */ ArkUI_NodeHandle OH_ArkUI_TouchRecognizer_GetNodeHandle(const ArkUI_TouchRecognizerHandle recognizer); /** -* @brief 在手势打断回调中向指定的触摸识别器发送取消触摸的事件 -* -* @param recognizer 触摸识别器的句柄。 -* @param info 指向手势打断信息的指针。 -* @return Returns {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 -* @since 15 -*/ + * @brief 在手势打断回调中向指定的触摸识别器发送取消触摸的事件 + * + * @param recognizer 触摸识别器的句柄。 + * @param info 指向手势打断信息的指针。 + * @return Returns {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 + * @since 15 + */ int32_t OH_ArkUI_TouchRecognizer_CancelTouch(ArkUI_TouchRecognizerHandle recognizer, ArkUI_GestureInterruptInfo* info); /** -* @brief 返回手势事件类型。 -* -* @param event 手势事件。 -* @return 手势事件类型。 -* @since 12 -*/ + * @brief 返回手势事件类型。 + * + * @param event 手势事件。 + * @return 手势事件类型。 + * @since 12 + */ ArkUI_GestureEventActionType OH_ArkUI_GestureEvent_GetActionType(const ArkUI_GestureEvent* event); /** -* @brief 返回手势输入。 -* -* @param event 手势事件。 -* @return 手势事件的原始输入事件。 -* @since 12 -*/ + * @brief 返回手势输入。 + * + * @param event 手势事件。 + * @return 手势事件的原始输入事件。 + * @since 12 + */ const ArkUI_UIInputEvent* OH_ArkUI_GestureEvent_GetRawInputEvent(const ArkUI_GestureEvent* event); /** -* @brief 返回长按手势定时触发次数。 -* -* @param event 手势事件。 -* @return 长按手势定时触发次数。 -* @since 12 -*/ + * @brief 返回长按手势定时触发次数。 + * + * @param event 手势事件。 + * @return 长按手势定时触发次数。 + * @since 12 + */ int32_t OH_ArkUI_LongPress_GetRepeatCount(const ArkUI_GestureEvent* event); /** -* @brief 滑动手势返回手势主方向速度。 -* -* @param event 手势事件。 -* @return 当前手势主方向速度，为xy轴方向速度的平方和的算数平方根，单位px/秒。 -* @since 12 -*/ + * @brief 滑动手势返回手势主方向速度。 + * + * @param event 手势事件。 + * @return 当前手势主方向速度，为xy轴方向速度的平方和的算数平方根，单位px/秒。 + * @since 12 + */ float OH_ArkUI_PanGesture_GetVelocity(const ArkUI_GestureEvent* event); /** -* @brief 滑动手势返回当前手势的x轴方向速度。 -* -* @param event 手势事件。 -* @return 当前手势的x轴方向速度，单位px/秒。 -* @since 12 -*/ + * @brief 滑动手势返回当前手势的x轴方向速度。 + * + * @param event 手势事件。 + * @return 当前手势的x轴方向速度，单位px/秒。 + * @since 12 + */ float OH_ArkUI_PanGesture_GetVelocityX(const ArkUI_GestureEvent* event); /** -* @brief 滑动手势返回当前手势的y轴方向速度。 -* -* @param event 手势事件。 -* @return 当前手势的y轴方向速度，单位px/秒。 -* @since 12 -*/ + * @brief 滑动手势返回当前手势的y轴方向速度。 + * + * @param event 手势事件。 + * @return 当前手势的y轴方向速度，单位px/秒。 + * @since 12 + */ float OH_ArkUI_PanGesture_GetVelocityY(const ArkUI_GestureEvent* event); /** -* @brief 滑动手势返回当前手势事件x轴相对偏移量。 -* -* @param event 手势事件。 -* @return 当前手势事件x轴相对偏移量，单位为px。 -* @since 12 -*/ + * @brief 滑动手势返回当前手势事件x轴相对偏移量。 + * + * @param event 手势事件。 + * @return 当前手势事件x轴相对偏移量，单位为px。 + * @since 12 + */ float OH_ArkUI_PanGesture_GetOffsetX(const ArkUI_GestureEvent* event); /** -* @brief 滑动手势返回当前手势事件y轴相对偏移量。 -* -* @param event 手势事件。 -* @return 当前手势事件y轴相对偏移量，单位为px。 -* @since 12 -*/ + * @brief 滑动手势返回当前手势事件y轴相对偏移量。 + * + * @param event 手势事件。 + * @return 当前手势事件y轴相对偏移量，单位为px。 + * @since 12 + */ float OH_ArkUI_PanGesture_GetOffsetY(const ArkUI_GestureEvent* event); /** -* @brief 滑动手势返回当前手势事件角度信息。 -* -* 角度计算方式：滑动手势被识别到后，连接两根手指之间的线被识别为起始线条，随着手指的滑动，手指之间的线条会发生旋转，\n -* 根据起始线条两端点和当前线条两端点的坐标，使用反正切函数分别计算其相对于水平方向的夹角，\n -* 最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。\n -* 以起始线条为坐标系，顺时针旋转为0到180度，逆时针旋转为-180到0度。\n -* -* @param event 手势事件。 -* @return 滑动手势的角度，即两根手指间的线段与水平方向的夹角变化的度数。 -* @since 12 -*/ + * @brief 滑动手势返回当前手势事件角度信息。 + * + * 角度计算方式：滑动手势被识别到后，连接两根手指之间的线被识别为起始线条，随着手指的滑动，手指之间的线条会发生旋转，\n + * 根据起始线条两端点和当前线条两端点的坐标，使用反正切函数分别计算其相对于水平方向的夹角，\n + * 最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。\n + * 以起始线条为坐标系，顺时针旋转为0到180度，逆时针旋转为-180到0度。\n + * + * @param event 手势事件。 + * @return 滑动手势的角度，即两根手指间的线段与水平方向的夹角变化的度数。 + * @since 12 + */ float OH_ArkUI_SwipeGesture_GetAngle(const ArkUI_GestureEvent* event); /** -* @brief 滑动手势场景中所有手指滑动平均速度。 -* -* @param event 手势事件。 -* @return 滑动手势速度，即所有手指滑动的平均速度，单位为px/秒。 -* @since 12 -*/ + * @brief 滑动手势场景中所有手指滑动平均速度。 + * + * @param event 手势事件。 + * @return 滑动手势速度，即所有手指滑动的平均速度，单位为px/秒。 + * @since 12 + */ float OH_ArkUI_SwipeGesture_GetVelocity(const ArkUI_GestureEvent* event); /** -* @brief 旋转手势返回当前手势事件角度信息。 -* -* @param event 手势事件。 -* @return 旋转角度。 -* @since 12 -*/ + * @brief 旋转手势返回当前手势事件角度信息。 + * + * @param event 手势事件。 + * @return 旋转角度。 + * @since 12 + */ float OH_ArkUI_RotationGesture_GetAngle(const ArkUI_GestureEvent* event); /** -* @brief 捏合手势返回当前手势事件缩放信息。 -* -* @param event 手势事件。 -* @return 缩放比例。 -* @since 12 -*/ + * @brief 捏合手势返回当前手势事件缩放信息。 + * + * @param event 手势事件。 + * @return 缩放比例。 + * @since 12 + */ float OH_ArkUI_PinchGesture_GetScale(const ArkUI_GestureEvent* event); /** -* @brief 捏合手势中心点相对于当前组件元素左上角x轴坐标。 -* -* @param event 手势事件。 -* @return 捏合手势中心点相对于当前组件元素左上角x轴坐标，单位为px。 -* @since 12 -*/ + * @brief 捏合手势中心点相对于当前组件元素左上角x轴坐标。 + * + * @param event 手势事件。 + * @return 捏合手势中心点相对于当前组件元素左上角x轴坐标，单位为px。 + * @since 12 + */ float OH_ArkUI_PinchGesture_GetCenterX(const ArkUI_GestureEvent* event); /** -* @brief 捏合手势中心点相对于当前组件元素左上角y轴坐标。 -* -* @param event 手势事件。 -* @return 捏合手势中心点相对于当前组件元素左上角y轴坐标，单位为px。 -* @since 12 -*/ + * @brief 捏合手势中心点相对于当前组件元素左上角y轴坐标。 + * + * @param event 手势事件。 + * @return 捏合手势中心点相对于当前组件元素左上角y轴坐标，单位为px。 + * @since 12 + */ float OH_ArkUI_PinchGesture_GetCenterY(const ArkUI_GestureEvent* event); /** -* @brief 获取绑定该手势的ARKUI组件 -* -* @param event 手势事件。 -* @return 绑定该手势的ARKUI组件。若返回Null，则表示event是无效值。 -* @since 12 -*/ + * @brief 获取绑定该手势的ARKUI组件 + * + * @param event 手势事件。 + * @return 绑定该手势的ARKUI组件。若返回Null，则表示event是无效值。 + * @since 12 + */ ArkUI_NodeHandle OH_ArkUI_GestureEvent_GetNode(const ArkUI_GestureEvent* event); /** -* @brief 获取手势响应链的信息。 -* -* @param event 手势打断回调事件。 -* @param responseChain 响应链组件上的手势识别器。 -* @param count 响应链组件上的手势识别器的数量。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -* @since 12 -*/ + * @brief 获取手势响应链的信息。 + * + * @param event 手势打断回调事件。 + * @param responseChain 响应链组件上的手势识别器。 + * @param count 响应链组件上的手势识别器的数量。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + * @since 12 + */ int32_t OH_ArkUI_GetResponseRecognizersFromInterruptInfo(const ArkUI_GestureInterruptInfo* event, ArkUI_GestureRecognizerHandleArray* responseChain, int32_t* count); /** -* @brief 设置手势识别器的使能状态。 -* -* @param recognizer 手势识别器指针。 -* @param enabled 使能状态。true表示使能，false表示无法使能。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -* @since 12 -*/ + * @brief 设置手势识别器的使能状态。 + * + * @param recognizer 手势识别器指针。 + * @param enabled 使能状态。true表示使能，false表示无法使能。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + * @since 12 + */ int32_t OH_ArkUI_SetGestureRecognizerEnabled(ArkUI_GestureRecognizer* recognizer, bool enabled); /** -* @brief 设置是否严格检查触摸手指数量的标志。实际触摸手指数量不等于设置的手指数量的时候，该手势识别不成功。 -* -* @param recognizer 手势识别器指针。 -* @param limitFingerCount 表示严格检查触摸手指数量的状态。true表示检查手指数量，false表示不检查手指数量。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -* @since 15 -*/ + * @brief 设置是否严格检查触摸手指数量的标志。实际触摸手指数量不等于设置的手指数量的时候，该手势识别不成功。 + * + * @param recognizer 手势识别器指针。 + * @param limitFingerCount 表示严格检查触摸手指数量的状态。true表示检查手指数量，false表示不检查手指数量。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + * @since 15 + */ int32_t OH_ArkUI_SetGestureRecognizerLimitFingerCount(ArkUI_GestureRecognizer* recognizer, bool limitFingerCount); /** -* @brief 获取手势识别器的使能状态。 -* -* @param recognizer 手势识别器指针。 -* @return true - 使能。 -* false - 禁用。 -* @since 12 -*/ + * @brief 获取手势识别器的使能状态。 + * + * @param recognizer 手势识别器指针。 + * @return true - 使能。 + * false - 禁用。 + * @since 12 + */ bool OH_ArkUI_GetGestureRecognizerEnabled(ArkUI_GestureRecognizer* recognizer); /** -* @brief 获取手势识别器的状态。 -* -* @param recognizer 手势识别器指针。 -* @param state 手势识别器的状态。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -* @since 12 -*/ + * @brief 获取手势识别器的状态。 + * + * @param recognizer 手势识别器指针。 + * @param state 手势识别器的状态。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + * @since 12 + */ int32_t OH_ArkUI_GetGestureRecognizerState(ArkUI_GestureRecognizer* recognizer, ArkUI_GestureRecognizerState* state); /** -* @brief 获取手势事件目标信息。 -* -* @param recognizer 手势识别器指针。 -* @param info 手势事件目标信息。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -* @since 12 -*/ + * @brief 获取手势事件目标信息。 + * + * @param recognizer 手势识别器指针。 + * @param info 手势事件目标信息。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + * @since 12 + */ int32_t OH_ArkUI_GetGestureEventTargetInfo(ArkUI_GestureRecognizer* recognizer, ArkUI_GestureEventTargetInfo** info); /** -* @brief 当前滚动类容器组件是否在顶部。 -* -* @param info 手势事件目标信息。 -* @param ret 当前滚动类容器组件是否在顶部。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -* {@link ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER} - 非滚动类容器。 -* @since 12 -*/ + * @brief 当前滚动类容器组件是否在顶部。 + * + * @param info 手势事件目标信息。 + * @param ret 当前滚动类容器组件是否在顶部。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + * {@link ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER} - 非滚动类容器。 + * @since 12 + */ int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollBegin(ArkUI_GestureEventTargetInfo* info, bool* ret); /** -* @brief 当前滚动类容器组件是否在底部。 -* -* @param info 手势事件目标信息。 -* @param ret 当前滚动类容器组件是否在底部。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -* {@link ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER} - 非滚动类容器。 -* @since 12 -*/ + * @brief 当前滚动类容器组件是否在底部。 + * + * @param info 手势事件目标信息。 + * @param ret 当前滚动类容器组件是否在底部。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + * {@link ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER} - 非滚动类容器。 + * @since 12 + */ int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollEnd(ArkUI_GestureEventTargetInfo* info, bool* ret); /** -* @brief 获取滑动手势的滑动方向。 -* -* @param recognizer 手势识别器指针。 -* @param directionMask 滑动手势的滑动方向。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -* @since 12 -*/ + * @brief 获取滑动手势的滑动方向。 + * + * @param recognizer 手势识别器指针。 + * @param directionMask 滑动手势的滑动方向。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + * @since 12 + */ int32_t OH_ArkUI_GetPanGestureDirectionMask(ArkUI_GestureRecognizer* recognizer, ArkUI_GestureDirectionMask* directionMask); /** -* @brief 当前手势是否为系统内置手势。 -* -* @param recognizer 手势识别器指针。 -* @return true - 是系统内置手势。 -* false - 不是系统内置手势。 -* @since 12 -*/ + * @brief 当前手势是否为系统内置手势。 + * + * @param recognizer 手势识别器指针。 + * @return true - 是系统内置手势。 + * false - 不是系统内置手势。 + * @since 12 + */ bool OH_ArkUI_IsBuiltInGesture(ArkUI_GestureRecognizer* recognizer); /** -* @brief 获取手势识别器的标记。 -* -* @param recognizer 手势识别器指针。 -* @param buffer 存储区。 -* @param bufferSize 存储区大小。 -* @param result 拷贝的字符串长度。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -* {@link ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH} - 存储区大小不足。 -* @since 12 -*/ + * @brief 获取手势识别器的标记。 + * + * @param recognizer 手势识别器指针。 + * @param buffer 存储区。 + * @param bufferSize 存储区大小。 + * @param result 拷贝的字符串长度。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + * {@link ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH} - 存储区大小不足。 + * @since 12 + */ int32_t OH_ArkUI_GetGestureTag(ArkUI_GestureRecognizer* recognizer, char* buffer, int32_t bufferSize, int32_t* result); /** -* @brief 获取手势识别器绑定的组件的ID。 -* -* @param recognizer 手势识别器指针。 -* @param nodeId 组件的ID。 -* @param size 存储区大小。 -* @param result 拷贝的字符串长度。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -* {@link ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH} - 存储区大小不足。 -* @since 12 -*/ + * @brief 获取手势识别器绑定的组件的ID。 + * + * @param recognizer 手势识别器指针。 + * @param nodeId 组件的ID。 + * @param size 存储区大小。 + * @param result 拷贝的字符串长度。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + * {@link ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH} - 存储区大小不足。 + * @since 12 + */ int32_t OH_ArkUI_GetGestureBindNodeId(ArkUI_GestureRecognizer* recognizer, char* nodeId, int32_t size, int32_t* result); /** -* @brief 当前手势识别器是否有效。 -* -* @param recognizer 手势识别器指针。 -* @return true - 手势识别器有效。 -* false - 手势识别器无效。 -* @since 12 -*/ + * @brief 当前手势识别器是否有效。 + * + * @param recognizer 手势识别器指针。 + * @return true - 手势识别器有效。 + * false - 手势识别器无效。 + * @since 12 + */ bool OH_ArkUI_IsGestureRecognizerValid(ArkUI_GestureRecognizer* recognizer); /** -* @brief 获取并行内部手势事件中的用户自定义数据。 -* -* @param event 并行内部手势事件。 -* @return 用户自定义数据的指针。 -* @since 12 -*/ + * @brief 获取并行内部手势事件中的用户自定义数据。 + * + * @param event 并行内部手势事件。 + * @return 用户自定义数据的指针。 + * @since 12 + */ void* OH_ArkUI_ParallelInnerGestureEvent_GetUserData(ArkUI_ParallelInnerGestureEvent* event); /** -* @brief 获取并行内部手势事件中的当前手势识别器。 -* -* @param event 并行内部手势事件。 -* @return 当前手势识别器的指针。 -* @since 12 -*/ + * @brief 获取并行内部手势事件中的当前手势识别器。 + * + * @param event 并行内部手势事件。 + * @return 当前手势识别器的指针。 + * @since 12 + */ ArkUI_GestureRecognizer* OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer( ArkUI_ParallelInnerGestureEvent* event); /** -* @brief 获取并行内部手势事件中的冲突的手势识别器。 -* -* @param event 并行内部手势事件。 -* @param array 冲突的手势识别器数组。 -* @param size 冲突的手势识别器数组的大小。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -* @since 12 -*/ + * @brief 获取并行内部手势事件中的冲突的手势识别器。 + * + * @param event 并行内部手势事件。 + * @param array 冲突的手势识别器数组。 + * @param size 冲突的手势识别器数组的大小。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + * @since 12 + */ int32_t OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers(ArkUI_ParallelInnerGestureEvent* event, ArkUI_GestureRecognizerHandleArray* array, int32_t* size); /** -* @brief 设置手势识别器对象析构通知回调函数。 -* -* @param recognizer 手势识别器指针。 -* @param callback 手势识别器对象析构通知回调函数。 -* @param userData 用户自定义数据。 -* @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 -*/ + * @brief 设置手势识别器对象析构通知回调函数。 + * + * @param recognizer 手势识别器指针。 + * @param callback 手势识别器对象析构通知回调函数。 + * @param userData 用户自定义数据。 + * @return {@link ARKUI_ERROR_CODE_NO_ERROR} - 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} - 参数错误。 + */ int32_t OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify(ArkUI_GestureRecognizer* recognizer, ArkUI_GestureRecognizerDisposeNotifyCallback callback, void* userData); /** -* @brief 获取手势识别器的滑动方向。 -* -* @param recognizer 手势识别器指针。 -* @param directMask 手势识别器的滑动方向。 -* @return 错误码。 -* {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 -* @since 18 -*/ + * @brief 获取手势识别器的滑动方向。 + * + * @param recognizer 手势识别器指针。 + * @param directMask 手势识别器的滑动方向。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 + * @since 18 + */ int32_t OH_ArkUI_GetGestureParam_DirectMask( ArkUI_GestureRecognizer* recognizer, ArkUI_GestureDirectionMask* directMask); /** -* @brief 获取手势识别器的手指数。 -* -* @param recognizer 手势识别器指针。 -* @param finger 手势识别器的手指数。 -* @return 错误码。 -* {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 -* @since 18 -*/ + * @brief 获取手势识别器的手指数。 + * + * @param recognizer 手势识别器指针。 + * @param finger 手势识别器的手指数。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 + * @since 18 + */ int32_t OH_ArkUI_GetGestureParam_FingerCount(ArkUI_GestureRecognizer* recognizer, int* finger); /** -* @brief 获取手势识别器是否有手指数限制。 -* -* @param recognizer 手势识别器指针。 -* @param isLimited 手势识别器是否有手指数限制。 -* @return 错误码。 -* {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 -* @since 18 -*/ + * @brief 获取手势识别器是否有手指数限制。 + * + * @param recognizer 手势识别器指针。 + * @param isLimited 手势识别器是否有手指数限制。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 + * @since 18 + */ int32_t OH_ArkUI_GetGestureParam_limitFingerCount(ArkUI_GestureRecognizer* recognizer, bool* isLimited); /** -* @brief 获取手势识别器是否连续触发事件回调。 -* -* @param recognizer 手势识别器指针。 -* @param isRepeat 手势识别器是否连续触发事件回调。 -* @return 错误码。 -* {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 -* @since 18 -*/ + * @brief 获取手势识别器是否连续触发事件回调。 + * + * @param recognizer 手势识别器指针。 + * @param isRepeat 手势识别器是否连续触发事件回调。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 + * @since 18 + */ int32_t OH_ArkUI_GetGestureParam_repeat(ArkUI_GestureRecognizer* recognizer, bool* isRepeat); /** -* @brief 获取手势识别器的手指允许的移动距离范围。 -* -* @param recognizer 手势识别器指针。 -* @param distance 手势识别器的手指允许的移动距离范围。 -* @return 错误码。 -* {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 -* @since 18 -*/ + * @brief 获取手势识别器的手指允许的移动距离范围。 + * + * @param recognizer 手势识别器指针。 + * @param distance 手势识别器的手指允许的移动距离范围。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 + * @since 18 + */ int32_t OH_ArkUI_GetGestureParam_distance(ArkUI_GestureRecognizer* recognizer, double* distance); /** -* @brief 获取手势识别器的识别滑动的最小速度。 -* -* @param recognizer 手势识别器指针。 -* @param speed 手势识别器的识别滑动的最小速度。 -* @return 错误码。 -* {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 -* @since 18 -*/ + * @brief 获取手势识别器的识别滑动的最小速度。 + * + * @param recognizer 手势识别器指针。 + * @param speed 手势识别器的识别滑动的最小速度。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 + * @since 18 + */ int32_t OH_ArkUI_GetGestureParam_speed(ArkUI_GestureRecognizer* recognizer, double* speed); /** -* @brief 获取手势识别器的触发长按的最短时间。 -* -* @param recognizer 手势识别器指针。 -* @param duration 手势识别器的触发长按的最短时间。 -* @return 错误码。 -* {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 -* @since 18 -*/ + * @brief 获取手势识别器的触发长按的最短时间。 + * + * @param recognizer 手势识别器指针。 + * @param duration 手势识别器的触发长按的最短时间。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 + * @since 18 + */ int32_t OH_ArkUI_GetGestureParam_duration(ArkUI_GestureRecognizer* recognizer, int* duration); /** -* @brief 获取手势识别器的旋转手势的最小改变度数。 -* -* @param recognizer 手势识别器指针。 -* @param angle 手势识别器的旋转手势的最小改变度数。 -* @return 错误码。 -* {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 -* @since 18 -*/ + * @brief 获取手势识别器的旋转手势的最小改变度数。 + * + * @param recognizer 手势识别器指针。 + * @param angle 手势识别器的旋转手势的最小改变度数。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 + * @since 18 + */ int32_t OH_ArkUI_GetGestureParam_angle(ArkUI_GestureRecognizer* recognizer, double* angle); /** -* @brief 获取手势识别器的手势移动阈值。 -* -* @param recognizer 手势识别器指针。 -* @param distanceThreshold 手势识别器的手势移动阈值。单位：px。 -* @return 错误码。 -* {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 -* @since 18 -*/ + * @brief 获取手势识别器的手势移动阈值。 + * + * @param recognizer 手势识别器指针。 + * @param distanceThreshold 手势识别器的手势移动阈值。单位：px。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 + * @since 18 + */ int32_t OH_ArkUI_GetGestureParam_distanceThreshold(ArkUI_GestureRecognizer* recognizer, double* distanceThreshold); /** -* @brief 设置手势最小滑动阈值表。当设备类型为非法值时，设置不生效。 -* -* @param recognizer 手势识别器指针。 -* @param size 手势最小滑动阈值数组的大小。 -* @param toolTypeArray 指向输入事件的工具类型数组的指针。 -* @param distanceArray 指向最小滑动阈值数组的指针。单位为px。 -* @return 错误码。 -* Returns {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 -* Returns {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 -* @since 19 -*/ + * @brief 设置手势最小滑动阈值表。当设备类型为非法值时，设置不生效。 + * + * @param recognizer 手势识别器指针。 + * @param size 手势最小滑动阈值数组的大小。 + * @param toolTypeArray 指向输入事件的工具类型数组的指针。 + * @param distanceArray 指向最小滑动阈值数组的指针。单位为px。 + * @return 错误码。 + * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 + * Returns {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 + * @since 19 + */ ArkUI_ErrorCode OH_ArkUI_PanGesture_SetDistanceMap( ArkUI_GestureRecognizer* recognizer, int size, int* toolTypeArray, double* distanceArray); /** -* @brief 获取手势识别器的手势移动阈值表。仅支持对通过OH_ArkUI_PanGesture_SetDistanceMap修改过的设备类型的阈值查询， -* 对于默认滑动阈值可通过查询UI_INPUT_EVENT_TOOL_TYPE_UNKNOWN类型获得，其他未主动设置过的类型不会返回。 -* -* @param recognizer 手势识别器指针。 -* @param toolType 输入事件的工具类型。 -* @param distance 手势识别器的手势移动阈值。单位为px。 -* @return 错误码。 -* Returns {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 -* Returns {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 -* @since 19 -*/ + * @brief 获取手势识别器的手势移动阈值表。仅支持对通过OH_ArkUI_PanGesture_SetDistanceMap修改过的设备类型的阈值查询， + * 对于默认滑动阈值可通过查询UI_INPUT_EVENT_TOOL_TYPE_UNKNOWN类型获得，其他未主动设置过的类型不会返回。 + * + * @param recognizer 手势识别器指针。 + * @param toolType 输入事件的工具类型。 + * @param distance 手势识别器的手势移动阈值。单位为px。 + * @return 错误码。 + * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} 参数错误。 + * Returns {@link ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED} 不支持手势识别器类型。 + * @since 19 + */ ArkUI_ErrorCode OH_ArkUI_PanGesture_GetDistanceByToolType( ArkUI_GestureRecognizer* recognizer, int toolType, double* distance); diff --git a/zh-cn/native_sdk/arkui/ace_engine/native/native_type.h b/zh-cn/native_sdk/arkui/ace_engine/native/native_type.h index be4a460c2781b183248ce366f5d0932c98a2edc5..374ad5da3cbff7d208daf7af256776856e404e53 100644 --- a/zh-cn/native_sdk/arkui/ace_engine/native/native_type.h +++ b/zh-cn/native_sdk/arkui/ace_engine/native/native_type.h @@ -4925,48 +4925,48 @@ bool OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus(ArkUI_CrossLanguageO typedef struct ArkUI_VisibleAreaEventOptions ArkUI_VisibleAreaEventOptions; /** -* @brief 创建可见区域变化监听的参数。 -* -* @return 可见区域变化监听的参数。 -* @since 17 -*/ + * @brief 创建可见区域变化监听的参数。 + * + * @return 可见区域变化监听的参数。 + * @since 17 + */ ArkUI_VisibleAreaEventOptions* OH_ArkUI_VisibleAreaEventOptions_Create(); /** -* @brief 销毁可见区域变化监听的参数。 -* -* @param option 需要销毁的实例。 -* @since 17 -*/ + * @brief 销毁可见区域变化监听的参数。 + * + * @param option 需要销毁的实例。 + * @since 17 + */ void OH_ArkUI_VisibleAreaEventOptions_Dispose(ArkUI_VisibleAreaEventOptions* option); /** -* @brief 设置阈值数组。 -* -* @param option 可见区域变化监听的参数实例。 -* @param value 阈值数组。其中每个元素代表组件可见面积（即组件在屏幕显示区的面积，只计算父组件内的面积， -* 超出父组件部分不会计算）与组件自身面积的比值。每个阈值的取值范围为[0.0, 1.0]， -* 如果开发者设置的阈值超出该范围，则会实际取值0.0或1.0。 -* @param size 阈值数组大小。 -* @return 错误码。 -* {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 -* 异常原因：传入参数验证失败，参数不能为空。 -* @since 17 -*/ + * @brief 设置阈值数组。 + * + * @param option 可见区域变化监听的参数实例。 + * @param value 阈值数组。其中每个元素代表组件可见面积（即组件在屏幕显示区的面积，只计算父组件内的面积， + * 超出父组件部分不会计算）与组件自身面积的比值。每个阈值的取值范围为[0.0, 1.0]， + * 如果开发者设置的阈值超出该范围，则会实际取值0.0或1.0。 + * @param size 阈值数组大小。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + * 异常原因：传入参数验证失败，参数不能为空。 + * @since 17 + */ int32_t OH_ArkUI_VisibleAreaEventOptions_SetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t size); /** -* @brief 设置预期更新间隔，单位为ms。定义了开发者期望的更新间隔。 -* -* @param option 可见区域变化监听的参数实例。 -* @param value 预期更新间隔，单位为ms。定义了开发者期望的更新间隔。默认值：1000。 -* @return 错误码。 -* {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 -* {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 -* 异常原因：传入参数验证失败，参数不能为空。 -* @since 17 -*/ + * @brief 设置预期更新间隔，单位为ms。定义了开发者期望的更新间隔。 + * + * @param option 可见区域变化监听的参数实例。 + * @param value 预期更新间隔，单位为ms。定义了开发者期望的更新间隔。默认值：1000。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + * 异常原因：传入参数验证失败，参数不能为空。 + * @since 17 + */ int32_t OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval( ArkUI_VisibleAreaEventOptions *option, int32_t value);