From d09257f8383944061cd6bba22b511e93d4f918a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=94=B0=E9=9B=A8?= Date: Sat, 21 Jun 2025 17:56:30 +0800 Subject: [PATCH] update MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 田雨 --- .../arkui/ace_engine/native/native_dialog.h | 348 +++++++++--------- 1 file changed, 174 insertions(+), 174 deletions(-) diff --git a/zh-cn/native_sdk/arkui/ace_engine/native/native_dialog.h b/zh-cn/native_sdk/arkui/ace_engine/native/native_dialog.h index 9576fe3f..c2882e3e 100644 --- a/zh-cn/native_sdk/arkui/ace_engine/native/native_dialog.h +++ b/zh-cn/native_sdk/arkui/ace_engine/native/native_dialog.h @@ -46,10 +46,10 @@ extern "C" { #endif /** -* @brief 弹窗关闭的触发方式。 -* -* @since 12 -*/ + * @brief 弹窗关闭的触发方式。 + * + * @since 12 + */ typedef enum { /** 系统定义的返回操作、键盘ESC触发。*/ DIALOG_DISMISS_BACK_PRESS = 0, @@ -62,10 +62,10 @@ typedef enum { } ArkUI_DismissReason; /** -* @brief 设置弹窗显示层级。 -* -* @since 15 -*/ + * @brief 设置弹窗显示层级。 + * + * @since 15 + */ typedef enum { /** 显示在应用最上层。 */ ARKUI_LEVEL_MODE_OVERLAY = 0, @@ -74,10 +74,10 @@ typedef enum { } ArkUI_LevelMode; /** -* @brief 指定嵌入式弹窗的蒙层覆盖区域。 -* -* @since 15 -*/ + * @brief 指定嵌入式弹窗的蒙层覆盖区域。 + * + * @since 15 + */ typedef enum { /** 弹窗蒙层按照显示页面给定的布局约束显示。 */ ARKUI_IMMERSIVE_MODE_DEFAULT = 0, @@ -86,10 +86,10 @@ typedef enum { } ArkUI_ImmersiveMode; /** -* @brief 枚举对话框的状态。 -* -* @since 20 -*/ + * @brief 枚举对话框的状态。 + * + * @since 20 + */ typedef enum { /** 未初始化，控制器未与dialog绑定时。 */ DIALOG_UNINITIALIZED = 0, @@ -106,10 +106,10 @@ typedef enum { } ArkUI_DialogState; /** -* @brief 弹窗关闭的回调函数。 -* -* @since 12 -*/ + * @brief 弹窗关闭的回调函数。 + * + * @since 12 + */ typedef bool (*ArkUI_OnWillDismissEvent)(int32_t reason); /** @@ -134,195 +134,195 @@ typedef struct ArkUI_CustomDialogOptions ArkUI_CustomDialogOptions; */ typedef struct { /** - * @brief 创建自定义弹窗并返回指向自定义弹窗的指针。 - * - * @note create方法需要在调用show方法之前调用。 - * @return 返回指向自定义弹窗的指针，如果创建失败，则返回空指针。 - */ + * @brief 创建自定义弹窗并返回指向自定义弹窗的指针。 + * + * @note create方法需要在调用show方法之前调用。 + * @return 返回指向自定义弹窗的指针，如果创建失败，则返回空指针。 + */ ArkUI_NativeDialogHandle (*create)(); /** - * @brief 销毁自定义弹窗。 - * - * @param handle 指向自定义弹窗控制器的指针。 - */ + * @brief 销毁自定义弹窗。 + * + * @param handle 指向自定义弹窗控制器的指针。 + */ void (*dispose)(ArkUI_NativeDialogHandle handle); /** - * @brief 挂载自定义弹窗内容。 - * - * @note setContent方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @param content 弹窗内容根节点指针。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 挂载自定义弹窗内容。 + * + * @note setContent方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @param content 弹窗内容根节点指针。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*setContent)(ArkUI_NativeDialogHandle handle, ArkUI_NodeHandle content); /** - * @brief 卸载自定义弹窗内容。 - * - * @note removeContent方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 卸载自定义弹窗内容。 + * + * @note removeContent方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*removeContent)(ArkUI_NativeDialogHandle handle); /** - * @brief 设置自定义弹窗对齐方式。 - * - * @note setContentAlignment方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @param alignment 对齐方式，参数类型{@Link ArkUI_Alignment}。 - * @param offsetX 弹窗的水平偏移量，浮点型。 - * @param offsetY 弹窗的垂直偏移量，浮点型。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 设置自定义弹窗对齐方式。 + * + * @note setContentAlignment方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @param alignment 对齐方式，参数类型{@Link ArkUI_Alignment}。 + * @param offsetX 弹窗的水平偏移量，浮点型。 + * @param offsetY 弹窗的垂直偏移量，浮点型。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*setContentAlignment)(ArkUI_NativeDialogHandle handle, int32_t alignment, float offsetX, float offsetY); /** - * @brief 重置setContentAlignment方法设置的属性，使用系统默认的对齐方式。 - * - * @note resetContentAlignment方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 重置setContentAlignment方法设置的属性，使用系统默认的对齐方式。 + * + * @note resetContentAlignment方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*resetContentAlignment)(ArkUI_NativeDialogHandle handle); /** - * @brief 设置自定义弹窗是否开启模态样式的弹窗。 - * - * @note setModalMode方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @param isModal 设置是否开启模态窗口，模态窗口有蒙层，非模态窗口无蒙层。为true时开启模态窗口，为false时不开启模态窗口。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 设置自定义弹窗是否开启模态样式的弹窗。 + * + * @note setModalMode方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @param isModal 设置是否开启模态窗口，模态窗口有蒙层，非模态窗口无蒙层。为true时开启模态窗口，为false时不开启模态窗口。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*setModalMode)(ArkUI_NativeDialogHandle handle, bool isModal); /** - * @brief 设置自定义弹窗是否允许通过点击遮罩层退出。 - * - * @note setAutoCancel方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @param autoCancel 设置是否允许通过点击遮罩层退出，true表示关闭弹窗，false表示不关闭弹窗。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 设置自定义弹窗是否允许通过点击遮罩层退出。 + * + * @note setAutoCancel方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @param autoCancel 设置是否允许通过点击遮罩层退出，true表示关闭弹窗，false表示不关闭弹窗。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*setAutoCancel)(ArkUI_NativeDialogHandle handle, bool autoCancel); /** - * @brief 设置自定义弹窗遮罩属性。 - * - * @note setMask方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @param maskColor 设置遮罩颜色，0xargb格式。 - * @param maskRect 遮蔽层区域范围的指针，遮蔽层区域内的事件不透传，在遮蔽层区域外的事件透传。参数类型{@link ArkUI_Rect}。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 设置自定义弹窗遮罩属性。 + * + * @note setMask方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @param maskColor 设置遮罩颜色，0xargb格式。 + * @param maskRect 遮蔽层区域范围的指针，遮蔽层区域内的事件不透传，在遮蔽层区域外的事件透传。参数类型{@link ArkUI_Rect}。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*setMask)(ArkUI_NativeDialogHandle handle, uint32_t maskColor, const ArkUI_Rect* maskRect); /** - * @brief 设置弹窗背景色。 - * - * @note setBackgroundColor方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @param backgroundColor 设置弹窗背景颜色，0xargb格式。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 设置弹窗背景色。 + * + * @note setBackgroundColor方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @param backgroundColor 设置弹窗背景颜色，0xargb格式。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*setBackgroundColor)(ArkUI_NativeDialogHandle handle, uint32_t backgroundColor); /** - * @brief 设置弹窗背板圆角半径。 - * - * @note setCornerRadius方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @param topLeft 设置弹窗背板左上角圆角半径。 - * @param topRight 设置弹窗背板右上角圆角半径。 - * @param bottomLeft 设置弹窗背板左下圆角半径。 - * @param bottomRight 设置弹窗背板右下角圆角半径。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 设置弹窗背板圆角半径。 + * + * @note setCornerRadius方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @param topLeft 设置弹窗背板左上角圆角半径。 + * @param topRight 设置弹窗背板右上角圆角半径。 + * @param bottomLeft 设置弹窗背板左下圆角半径。 + * @param bottomRight 设置弹窗背板右下角圆角半径。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*setCornerRadius)(ArkUI_NativeDialogHandle handle, float topLeft, float topRight, float bottomLeft, float bottomRight); /** - * @brief 设置弹窗宽度占栅格宽度的个数。 - * - * @note setGridColumnCount方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @param gridCount 默认为按照窗口大小自适应，最大栅格数为系统最大栅格数。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 设置弹窗宽度占栅格宽度的个数。 + * + * @note setGridColumnCount方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @param gridCount 默认为按照窗口大小自适应，最大栅格数为系统最大栅格数。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*setGridColumnCount)(ArkUI_NativeDialogHandle handle, int32_t gridCount); /** - * @brief 弹窗容器样式是否可以自定义。 - * - * @note enableCustomStyle方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @param enableCustomStyle true:宽度自适应子节点，圆角为0，弹窗背景色透明；false:高度自适应子节点，宽度由栅格系统定义, 圆角半径24vp。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 弹窗容器样式是否可以自定义。 + * + * @note enableCustomStyle方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @param enableCustomStyle true:宽度自适应子节点，圆角为0，弹窗背景色透明；false:高度自适应子节点，宽度由栅格系统定义, 圆角半径24vp。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*enableCustomStyle)(ArkUI_NativeDialogHandle handle, bool enableCustomStyle); /** - * @brief 弹窗容器是否使用自定义弹窗动画。 - * - * @note enableCustomAnimation方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @param enableCustomAnimation true:使用自定义动画，关闭系统默认动画；false:使用系统默认动画。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 弹窗容器是否使用自定义弹窗动画。 + * + * @note enableCustomAnimation方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @param enableCustomAnimation true:使用自定义动画，关闭系统默认动画；false:使用系统默认动画。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*enableCustomAnimation)(ArkUI_NativeDialogHandle handle, bool enableCustomAnimation); /** - * @brief 当触发系统定义的返回操作、键盘ESC关闭交互操作时，如果注册了该回调函数，弹窗不会立即关闭，而是由用户决定是否关闭。 - * - * @note registerOnWillDismiss方法需要在调用show方法之前调用。 - * @param handle 指向自定义弹窗控制器的指针。 - * @param eventHandler 弹窗关闭的回调函数 参数类型{@Link OnWillDismissEvent}。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 当触发系统定义的返回操作、键盘ESC关闭交互操作时，如果注册了该回调函数，弹窗不会立即关闭，而是由用户决定是否关闭。 + * + * @note registerOnWillDismiss方法需要在调用show方法之前调用。 + * @param handle 指向自定义弹窗控制器的指针。 + * @param eventHandler 弹窗关闭的回调函数 参数类型{@Link OnWillDismissEvent}。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*registerOnWillDismiss)(ArkUI_NativeDialogHandle handle, ArkUI_OnWillDismissEvent eventHandler); /** - * @brief 显示自定义弹窗。 - * - * @param handle 指向自定义弹窗控制器的指针。 - * @param showInSubWindow 是否在子窗口显示弹窗。true表示在子窗显示弹窗。false表示不在子窗显示弹窗。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 显示自定义弹窗。 + * + * @param handle 指向自定义弹窗控制器的指针。 + * @param showInSubWindow 是否在子窗口显示弹窗。true表示在子窗显示弹窗。false表示不在子窗显示弹窗。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*show)(ArkUI_NativeDialogHandle handle, bool showInSubWindow); /** - * @brief 关闭自定义弹窗，如已关闭，则不生效。 - * - * @param handle 指向自定义弹窗控制器的指针。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 关闭自定义弹窗，如已关闭，则不生效。 + * + * @param handle 指向自定义弹窗控制器的指针。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*close)(ArkUI_NativeDialogHandle handle); /** - * @brief 注册系统关闭自定义弹窗的监听事件。 - * - * @param handle 指向自定义弹窗控制器的指针。 - * @param userData 用户自定义数据指针。 - * @param callback 监听自定义弹窗关闭的回调事件。 - * @return 错误码。 - * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 - */ + * @brief 注册系统关闭自定义弹窗的监听事件。 + * + * @param handle 指向自定义弹窗控制器的指针。 + * @param userData 用户自定义数据指针。 + * @param callback 监听自定义弹窗关闭的回调事件。 + * @return 错误码。 + * {@link ARKUI_ERROR_CODE_NO_ERROR} 成功。 + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} 函数参数异常。 + */ int32_t (*registerOnWillDismissWithUserData)( ArkUI_NativeDialogHandle handle, void* userData, void (*callback)(ArkUI_DialogDismissEvent* event)); } ArkUI_NativeDialogAPI_1; -- Gitee