native_dialog.h

概述

提供ArkUI在Native侧的自定义弹窗接口定义集合。

引用文件： <arkui/native_dialog.h>

库： libace_ndk.z.so

系统能力： SystemCapability.ArkUI.ArkUI.Full

起始版本： 12

相关模块： ArkUI_NativeModule

相关示例： NativeDialogSample

汇总

结构体

名称	typedef关键字	描述
ArkUI_NativeDialogAPI_1	ArkUI_NativeDialogAPI_1	ArkUI提供的Native侧自定义弹窗接口集合。
ArkUI_NativeDialogAPI_2	ArkUI_NativeDialogAPI_2	ArkUI提供的Native侧自定义弹窗接口集合。
ArkUI_NativeDialogAPI_3	ArkUI_NativeDialogAPI_3	ArkUI提供的Native侧自定义弹窗接口集合。
ArkUI_DialogDismissEvent	ArkUI_DialogDismissEvent	定义弹窗关闭事件对象。
ArkUI_CustomDialogOptions	ArkUI_CustomDialogOptions	定义自定义弹窗的内容对象。

枚举

名称	typedef关键字	描述
ArkUI_DismissReason	ArkUI_DismissReason	弹窗关闭的触发方式。
ArkUI_LevelMode	ArkUI_LevelMode	设置弹窗显示层级。
ArkUI_ImmersiveMode	ArkUI_ImmersiveMode	指定嵌入式弹窗的蒙层覆盖区域。
ArkUI_DialogState	ArkUI_DialogState	枚举对话框的状态。

函数

名称	typedef关键字	描述
typedef bool (*ArkUI_OnWillDismissEvent)(int32_t reason)	ArkUI_OnWillDismissEvent	弹窗关闭的回调函数。
void OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss(ArkUI_DialogDismissEvent* event, bool shouldBlockDismiss)	-	设置是否需要屏蔽系统关闭弹窗行为，true表示屏蔽系统行为，不关闭弹窗，false表示不屏蔽。
void* OH_ArkUI_DialogDismissEvent_GetUserData(ArkUI_DialogDismissEvent* event)	-	获取弹窗关闭事件对象中的用户自定义数据指针。
int32_t OH_ArkUI_DialogDismissEvent_GetDismissReason(ArkUI_DialogDismissEvent* event)	-	获取交互式关闭事件指针中的关闭原因。
int32_t OH_ArkUI_CustomDialog_OpenDialog(ArkUI_CustomDialogOptions* options, void (*callback)(int32_t dialogId))	-	弹出自定义弹窗。
int32_t OH_ArkUI_CustomDialog_UpdateDialog(ArkUI_CustomDialogOptions* options, void (*callback)(int32_t dialogId))	-	更新自定义弹窗。
int32_t OH_ArkUI_CustomDialog_CloseDialog(int32_t dialogId)	-	关闭自定义弹窗。
ArkUI_CustomDialogOptions* OH_ArkUI_CustomDialog_CreateOptions(ArkUI_NodeHandle content)	-	创建自定义弹窗配置。
void OH_ArkUI_CustomDialog_DisposeOptions(ArkUI_CustomDialogOptions* options)	-	销毁自定义弹窗配置。
int32_t OH_ArkUI_CustomDialog_SetLevelMode(ArkUI_CustomDialogOptions* options, ArkUI_LevelMode levelMode)	-	设置弹窗的显示层级。
int32_t OH_ArkUI_CustomDialog_SetLevelUniqueId(ArkUI_CustomDialogOptions* options, int32_t uniqueId)	-	设置弹窗显示层级页面下的节点id。
int32_t OH_ArkUI_CustomDialog_SetImmersiveMode(ArkUI_CustomDialogOptions* options, ArkUI_ImmersiveMode immersiveMode)	-	设置嵌入式弹窗蒙层的显示区域。
int32_t OH_ArkUI_CustomDialog_SetBackgroundColor(ArkUI_CustomDialogOptions* options, uint32_t backgroundColor)	-	设置弹窗的背景颜色。
int32_t OH_ArkUI_CustomDialog_SetCornerRadius(ArkUI_CustomDialogOptions* options, float topLeft, float topRight, float bottomLeft, float bottomRight)	-	设置弹窗的圆角半径。
int32_t OH_ArkUI_CustomDialog_SetBorderWidth(ArkUI_CustomDialogOptions* options, float top, float right, float bottom, float left, ArkUI_LengthMetricUnit unit)	-	设置弹窗的边框宽度。
int32_t OH_ArkUI_CustomDialog_SetBorderColor(ArkUI_CustomDialogOptions* options, uint32_t top, uint32_t right, uint32_t bottom, uint32_t left)	-	设置弹窗的边框颜色。
int32_t OH_ArkUI_CustomDialog_SetBorderStyle(ArkUI_CustomDialogOptions* options, int32_t top, int32_t right, int32_t bottom, int32_t left)	-	设置弹窗的边框样式。
int32_t OH_ArkUI_CustomDialog_SetWidth(ArkUI_CustomDialogOptions* options, float width, ArkUI_LengthMetricUnit unit)	-	设置弹窗的背板宽度。
int32_t OH_ArkUI_CustomDialog_SetHeight(ArkUI_CustomDialogOptions* options, float height, ArkUI_LengthMetricUnit unit)	-	设置弹窗的背板高度。
int32_t OH_ArkUI_CustomDialog_SetShadow(ArkUI_CustomDialogOptions* options, ArkUI_ShadowStyle shadow)	-	设置弹窗的背板阴影。
int32_t OH_ArkUI_CustomDialog_SetCustomShadow(ArkUI_CustomDialogOptions* options, const ArkUI_AttributeItem* customShadow)	-	设置弹窗的背板阴影。
int32_t OH_ArkUI_CustomDialog_SetBackgroundBlurStyle(ArkUI_CustomDialogOptions* options, ArkUI_BlurStyle blurStyle)	-	设置弹窗的背板模糊材质。
int32_t OH_ArkUI_CustomDialog_SetAlignment(ArkUI_CustomDialogOptions* options, int32_t alignment, float offsetX, float offsetY)	-	设置弹窗的对齐模式。
int32_t OH_ArkUI_CustomDialog_SetModalMode(ArkUI_CustomDialogOptions* options, bool isModal)	-	设置自定义弹窗是否开启模态样式的弹窗。
int32_t OH_ArkUI_CustomDialog_SetAutoCancel(ArkUI_CustomDialogOptions* options, bool autoCancel)	-	设置自定义弹窗是否允许点击遮罩层退出。
int32_t OH_ArkUI_CustomDialog_SetSubwindowMode(ArkUI_CustomDialogOptions* options, bool showInSubwindow)	-	设置弹窗是否在子窗口显示此弹窗。
int32_t OH_ArkUI_CustomDialog_SetMask(ArkUI_CustomDialogOptions* options, uint32_t maskColor, const ArkUI_Rect* maskRect)	-	设置自定义弹窗遮罩属性。
int32_t OH_ArkUI_CustomDialog_SetKeyboardAvoidMode(ArkUI_CustomDialogOptions* options, ArkUI_KeyboardAvoidMode keyboardAvoidMode)	-	设置弹窗避让键盘的模式。
int32_t OH_ArkUI_CustomDialog_SetHoverModeEnabled(ArkUI_CustomDialogOptions* options, bool enabled)	-	设置弹窗是否响应悬停态。
int32_t OH_ArkUI_CustomDialog_SetHoverModeArea(ArkUI_CustomDialogOptions* options, ArkUI_HoverModeAreaType hoverModeAreaType)	-	设置悬停态下弹窗默认展示区域。
int32_t OH_ArkUI_CustomDialog_RegisterOnWillDismissCallback(ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(ArkUI_DialogDismissEvent* event))	-	注册系统关闭自定义弹窗的监听事件。
int32_t OH_ArkUI_CustomDialog_RegisterOnWillAppearCallback(ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData))	-	注册自定义弹窗显示动效前的监听事件。
int32_t OH_ArkUI_CustomDialog_RegisterOnDidAppearCallback(ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData))	-	注册自定义弹窗弹出时的监听事件。
int32_t OH_ArkUI_CustomDialog_RegisterOnWillDisappearCallback(ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData))	-	注册自定义弹窗退出动效前的监听事件。
int32_t OH_ArkUI_CustomDialog_RegisterOnDidDisappearCallback(ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData))	-	注册自定义弹窗消失时的监听事件。
int32_t OH_ArkUI_CustomDialog_GetState(ArkUI_NativeDialogHandle handle, ArkUI_DialogState* state)	-	获取弹窗的状态。
int32_t OH_ArkUI_CustomDialog_SetBackgroundBlurStyleOptions(ArkUI_CustomDialogOptions* options, const ArkUI_AttributeItem* backgroundBlurStyleOptions)	-	设置弹窗的背景模糊效果。
int32_t OH_ArkUI_CustomDialog_SetBackgroundEffect(ArkUI_CustomDialogOptions* options, const ArkUI_AttributeItem* backgroundEffect)	-	设置弹窗的背景效果参数。

枚举类型说明

ArkUI_DismissReason

enum ArkUI_DismissReason

描述：

弹窗关闭的触发方式。

起始版本： 12

枚举项	描述
DIALOG_DISMISS_BACK_PRESS = 0	点击三键back、侧滑（左滑/右滑）、键盘ESC触发。
DIALOG_DISMISS_TOUCH_OUTSIDE = 1	点击遮障层触发。
DIALOG_DISMISS_CLOSE_BUTTON = 2	点击关闭按钮。
DIALOG_DISMISS_SLIDE_DOWN = 3	下拉关闭。

ArkUI_LevelMode

enum ArkUI_LevelMode

描述：

设置弹窗显示层级。

起始版本： 15

枚举项	描述
ARKUI_LEVEL_MODE_OVERLAY = 0	显示在应用最上层。
ARKUI_LEVEL_MODE_EMBEDDED = 1	嵌入式显示在应用的页面内。

ArkUI_ImmersiveMode

enum ArkUI_ImmersiveMode

描述：

指定嵌入式弹窗的蒙层覆盖区域。

起始版本： 15

枚举项	描述
ARKUI_IMMERSIVE_MODE_DEFAULT = 0	弹窗蒙层按照显示页面给定的布局约束显示。
ARKUI_IMMERSIVE_MODE_EXTEND = 1	弹窗蒙层可扩展至覆盖状态栏和导航条。

ArkUI_DialogState

enum ArkUI_DialogState

描述：

枚举对话框的状态。

起始版本： 20

枚举项	描述
DIALOG_UNINITIALIZED = 0	未初始化，控制器未与dialog绑定时。
DIALOG_INITIALIZED = 1	已初始化，控制器与dialog绑定后。
DIALOG_APPEARING = 2	显示中，dialog显示动画过程中。
DIALOG_APPEARED = 3	已显示，dialog显示动画结束。
DIALOG_DISAPPEARING = 4	消失中，dialog消失动画过程中。
DIALOG_DISAPPEARED = 5	已消失，dialog消失动画结束后。

函数说明

ArkUI_OnWillDismissEvent()

typedef bool (*ArkUI_OnWillDismissEvent)(int32_t reason)

描述：

弹窗关闭的回调函数。

起始版本： 12

参数:

名称	描述
reason	触发弹窗关闭的原因。

返回值：

类型	说明
bool	返回任意值都表示不关闭弹窗。

OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss()

void OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss(ArkUI_DialogDismissEvent* event, bool shouldBlockDismiss)

描述：

设置是否需要屏蔽系统关闭弹窗行为，true表示屏蔽系统行为，不关闭弹窗，false表示不屏蔽。

起始版本： 12

参数：

参数项	描述
ArkUI_DialogDismissEvent* event	弹窗关闭事件对象指针。
bool shouldBlockDismiss	实现需要屏蔽系统关闭弹窗行为。

OH_ArkUI_DialogDismissEvent_GetUserData()

void* OH_ArkUI_DialogDismissEvent_GetUserData(ArkUI_DialogDismissEvent* event)

描述：

获取弹窗关闭事件对象中的用户自定义数据指针。

起始版本： 12

参数：

参数项	描述
ArkUI_DialogDismissEvent* event	弹窗关闭事件对象指针。

返回：

类型	说明
void*	用户自定义数据指针。

OH_ArkUI_DialogDismissEvent_GetDismissReason()

int32_t OH_ArkUI_DialogDismissEvent_GetDismissReason(ArkUI_DialogDismissEvent* event)

描述：

获取交互式关闭事件指针中的关闭原因。

起始版本： 12

参数：

参数项	描述
ArkUI_DialogDismissEvent* event	弹窗关闭事件对象指针。

返回：

类型	说明
int32_t	关闭原因，异常情况返回-1。 DIALOG_DISMISS_BACK_PRESS 点击三键back、侧滑（左滑/右滑）、键盘ESC关闭。 DIALOG_DISMISS_TOUCH_OUTSIDE 点击遮障层时。 DIALOG_DISMISS_CLOSE_BUTTON 点击关闭按钮。 DIALOG_DISMISS_SLIDE_DOWN 下拉关闭。

OH_ArkUI_CustomDialog_OpenDialog()

int32_t OH_ArkUI_CustomDialog_OpenDialog(ArkUI_CustomDialogOptions* options, void (*callback)(int32_t dialogId))

描述：

弹出自定义弹窗。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
void (*callback)(int32_t dialogId)	开启弹窗的回调，返回入参是弹窗ID。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_UpdateDialog()

int32_t OH_ArkUI_CustomDialog_UpdateDialog(ArkUI_CustomDialogOptions* options, void (*callback)(int32_t dialogId))

描述：

更新自定义弹窗。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
void (*callback)(int32_t dialogId)	更新弹窗的回调，返回入参是弹窗ID。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_CloseDialog()

int32_t OH_ArkUI_CustomDialog_CloseDialog(int32_t dialogId)

描述：

关闭自定义弹窗。

起始版本： 19

参数：

参数项	描述
int32_t dialogId	需要关闭的弹窗ID。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_CreateOptions()

ArkUI_CustomDialogOptions* OH_ArkUI_CustomDialog_CreateOptions(ArkUI_NodeHandle content)

描述：

创建自定义弹窗配置。

起始版本： 19

参数：

参数项	描述
ArkUI_NodeHandle content	自定义弹窗的内容。

返回：

类型	说明
ArkUI_CustomDialogOptions*	自定义弹窗配置的指针。

OH_ArkUI_CustomDialog_DisposeOptions()

void OH_ArkUI_CustomDialog_DisposeOptions(ArkUI_CustomDialogOptions* options)

描述：

销毁自定义弹窗配置。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	自定义弹窗配置的指针。

OH_ArkUI_CustomDialog_SetLevelMode()

int32_t OH_ArkUI_CustomDialog_SetLevelMode(ArkUI_CustomDialogOptions* options, ArkUI_LevelMode levelMode)

描述：

设置弹窗的显示层级。

说明：

本方法需要在调用OH_ArkUI_CustomDialog_OpenDialog方法之前调用。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	指向自定义弹窗options的指针。
ArkUI_LevelMode levelMode	显示层级的枚举值， 类型为ArkUI_LevelMode。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetLevelUniqueId()

int32_t OH_ArkUI_CustomDialog_SetLevelUniqueId(ArkUI_CustomDialogOptions* options, int32_t uniqueId)

描述：

设置弹窗显示层级页面下的节点id。

说明：

本方法需要在调用OH_ArkUI_CustomDialog_OpenDialog方法之前调用。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	指向自定义弹窗options的指针。
int32_t uniqueId	指定节点id，会查找该节点所在页面，并将弹窗显示在该页面下。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetImmersiveMode()

int32_t OH_ArkUI_CustomDialog_SetImmersiveMode(ArkUI_CustomDialogOptions* options, ArkUI_ImmersiveMode immersiveMode)

描述：

设置嵌入式弹窗蒙层的显示区域。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	指向自定义弹窗options的指针。
ArkUI_ImmersiveMode immersiveMode	显示区域类型的枚举值， 类型为ArkUI_ImmersiveMode。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetBackgroundColor()

int32_t OH_ArkUI_CustomDialog_SetBackgroundColor(ArkUI_CustomDialogOptions* options, uint32_t backgroundColor)

描述：

设置弹窗的背景颜色。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
uint32_t backgroundColor	弹窗背景颜色，0xARGB格式。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetCornerRadius()

int32_t OH_ArkUI_CustomDialog_SetCornerRadius(ArkUI_CustomDialogOptions* options, float topLeft, float topRight, float bottomLeft, float bottomRight)

描述：

设置弹窗的圆角半径。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
float topLeft	弹窗左上角的圆角半径，单位：vp。默认值：从API version 12开始，为32vp。API version 11及之前版本，为24vp。
float topRight	弹窗右上角的圆角半径，单位：vp。默认值：从API version 12开始，为32vp。API version 11及之前版本，为24vp。
float bottomLeft	弹窗左下角的圆角半径，单位：vp。默认值：从API version 12开始，为32vp。API version 11及之前版本，为24vp。
float bottomRight	弹窗右下角的圆角半径，单位：vp。默认值：从API version 12开始，为32vp。API version 11及之前版本，为24vp。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetBorderWidth()

int32_t OH_ArkUI_CustomDialog_SetBorderWidth(ArkUI_CustomDialogOptions* options, float top, float right, float bottom, float left, ArkUI_LengthMetricUnit unit)

描述：

设置弹窗的边框宽度。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
float top	弹窗上边框的宽度。
float right	弹窗右边框的宽度。
float bottom	弹窗下边框的宽度。
float left	弹窗左边框的宽度。
ArkUI_LengthMetricUnit unit	指定宽度的单位，默认为vp。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetBorderColor()

int32_t OH_ArkUI_CustomDialog_SetBorderColor(ArkUI_CustomDialogOptions* options, uint32_t top, uint32_t right, uint32_t bottom, uint32_t left)

描述：

设置弹窗的边框颜色。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
uint32_t top	弹窗上边框的颜色，0xARGB格式。
uint32_t right	弹窗右边框的颜色，0xARGB格式。
uint32_t bottom	弹窗下边框的颜色，0xARGB格式。
uint32_t left	弹窗左边框的颜色，0xARGB格式。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetBorderStyle()

int32_t OH_ArkUI_CustomDialog_SetBorderStyle(ArkUI_CustomDialogOptions* options, int32_t top, int32_t right, int32_t bottom, int32_t left)

描述：

设置弹窗的边框样式。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
int32_t top	弹窗上边框的样式，参数类型ArkUI_BorderStyle，默认值为ARKUI_BORDER_STYLE_SOLID。
int32_t right	弹窗右边框的样式，参数类型ArkUI_BorderStyle，默认值为ARKUI_BORDER_STYLE_SOLID。
int32_t bottom	弹窗下边框的样式，参数类型ArkUI_BorderStyle，默认值为ARKUI_BORDER_STYLE_SOLID。
int32_t left	弹窗左边框的样式，参数类型ArkUI_BorderStyle，默认值为ARKUI_BORDER_STYLE_SOLID。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetWidth()

int32_t OH_ArkUI_CustomDialog_SetWidth(ArkUI_CustomDialogOptions* options, float width, ArkUI_LengthMetricUnit unit)

描述：

设置弹窗的背板宽度。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
float width	弹窗的背板宽度。
ArkUI_LengthMetricUnit unit	指定宽度的单位，默认为vp。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetHeight()

int32_t OH_ArkUI_CustomDialog_SetHeight(ArkUI_CustomDialogOptions* options, float height, ArkUI_LengthMetricUnit unit)

描述：

设置弹窗的背板高度。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
float height	弹窗的背板高度。
ArkUI_LengthMetricUnit unit	指定高度的单位，默认为vp。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetShadow()

int32_t OH_ArkUI_CustomDialog_SetShadow(ArkUI_CustomDialogOptions* options, ArkUI_ShadowStyle shadow)

描述：

设置弹窗的背板阴影。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
ArkUI_ShadowStyle shadow	弹窗的背板阴影样式，枚举值。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetCustomShadow()

int32_t OH_ArkUI_CustomDialog_SetCustomShadow(ArkUI_CustomDialogOptions* options, const ArkUI_AttributeItem* customShadow)

描述：

设置弹窗的背板阴影。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
const ArkUI_AttributeItem* customShadow	弹窗的自定义阴影参数，格式与ArkUI_NodeAttributeType中的NODE_CUSTOM_SHADOW属性一致。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetBackgroundBlurStyle()

int32_t OH_ArkUI_CustomDialog_SetBackgroundBlurStyle(ArkUI_CustomDialogOptions* options, ArkUI_BlurStyle blurStyle)

描述：

设置弹窗的背板模糊材质。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
ArkUI_BlurStyle blurStyle	弹窗的背板模糊材质，枚举值。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetAlignment()

int32_t OH_ArkUI_CustomDialog_SetAlignment(ArkUI_CustomDialogOptions* options, int32_t alignment, float offsetX, float offsetY)

描述：

设置弹窗的对齐模式。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
int32_t alignment	弹窗的对齐模式，参数类型ArkUI_Alignment。
float offsetX	弹窗的水平偏移量，浮点型，单位：vp。
float offsetY	弹窗的垂直偏移量，浮点型，单位：vp。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetModalMode()

int32_t OH_ArkUI_CustomDialog_SetModalMode(ArkUI_CustomDialogOptions* options, bool isModal)

描述：

设置自定义弹窗是否开启模态样式的弹窗。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
bool isModal	设置是否开启模态窗口。模态窗口有蒙层，非模态窗口无蒙层。设置为true表示开启模态窗口。设置为false表示关闭模态窗口。 默认值：false

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetAutoCancel()

int32_t OH_ArkUI_CustomDialog_SetAutoCancel(ArkUI_CustomDialogOptions* options, bool autoCancel)

描述：

设置自定义弹窗是否允许点击遮罩层退出。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
bool autoCancel	设置是否允许点击遮罩层退出，true表示关闭弹窗，false表示不关闭弹窗。 默认值：true

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetSubwindowMode()

int32_t OH_ArkUI_CustomDialog_SetSubwindowMode(ArkUI_CustomDialogOptions* options, bool showInSubwindow)

描述：

设置弹窗是否在子窗口显示此弹窗。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
bool showInSubwindow	设置弹窗需要显示在主窗口之外时，是否在子窗口显示此弹窗。值为true：弹窗可以显示在主窗口外，独立子窗口。值为false：弹窗显示在应用内，非独立子窗口。 默认值：false

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetMask()

int32_t OH_ArkUI_CustomDialog_SetMask(ArkUI_CustomDialogOptions* options, uint32_t maskColor, const ArkUI_Rect* maskRect)

描述：

设置自定义弹窗遮罩属性。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
uint32_t maskColor	弹窗的遮罩颜色，0xargb格式。
const ArkUI_Rect* maskRect	遮蔽层区域范围的指针，遮蔽层区域内的事件不透传，在遮蔽层区域外的事件透传。参数类型ArkUI_Rect。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetKeyboardAvoidMode()

int32_t OH_ArkUI_CustomDialog_SetKeyboardAvoidMode(ArkUI_CustomDialogOptions* options, ArkUI_KeyboardAvoidMode keyboardAvoidMode)

描述：

设置弹窗避让键盘的模式。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
ArkUI_KeyboardAvoidMode keyboardAvoidMode	键盘避让模式，枚举值。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetHoverModeEnabled()

int32_t OH_ArkUI_CustomDialog_SetHoverModeEnabled(ArkUI_CustomDialogOptions* options, bool enabled)

描述：

设置弹窗是否响应悬停态。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
bool enabled	是否响应悬停态，默认false。值为true时响应悬停态，值为false时不响应悬停态。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetHoverModeArea()

int32_t OH_ArkUI_CustomDialog_SetHoverModeArea(ArkUI_CustomDialogOptions* options, ArkUI_HoverModeAreaType hoverModeAreaType)

描述：

设置悬停态下弹窗默认展示区域。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
ArkUI_HoverModeAreaType hoverModeAreaType	悬停态区域，枚举值。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_RegisterOnWillDismissCallback()

int32_t OH_ArkUI_CustomDialog_RegisterOnWillDismissCallback(ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(ArkUI_DialogDismissEvent* event))

描述：

注册系统关闭自定义弹窗的监听事件。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
void* userData	用户自定义数据指针。
void (*callback)(ArkUI_DialogDismissEvent* event)	监听自定义弹窗关闭的回调事件。 - event: 回调函数的入参，捕获关闭原因。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_RegisterOnWillAppearCallback()

int32_t OH_ArkUI_CustomDialog_RegisterOnWillAppearCallback(ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData))

描述：

注册自定义弹窗显示动效前的监听事件。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
void* userData	用户自定义数据指针。
void (*callback)(void* userData)	弹窗显示动效前的事件回调。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_RegisterOnDidAppearCallback()

int32_t OH_ArkUI_CustomDialog_RegisterOnDidAppearCallback(ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData))

描述：

注册自定义弹窗弹出时的监听事件。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
void* userData	用户自定义数据指针。
void (*callback)(void* userData)	弹窗弹出后的事件回调。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_RegisterOnWillDisappearCallback()

int32_t OH_ArkUI_CustomDialog_RegisterOnWillDisappearCallback(ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData))

描述：

注册自定义弹窗退出动效前的监听事件。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
void* userData	用户自定义数据指针。
void (*callback)(void* userData)	弹窗退出动效前的事件回调。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_RegisterOnDidDisappearCallback()

int32_t OH_ArkUI_CustomDialog_RegisterOnDidDisappearCallback(ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData))

描述：

注册自定义弹窗消失时的监听事件。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
void* userData	用户自定义数据指针。
void (*callback)(void* userData)	弹窗消失时的事件回调。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_GetState()

int32_t OH_ArkUI_CustomDialog_GetState(ArkUI_NativeDialogHandle handle, ArkUI_DialogState* state)

描述：

获取弹窗的状态。

起始版本： 20

参数：

参数项	描述
ArkUI_NativeDialogHandle handle	指向自定义弹窗控制器的指针。
ArkUI_DialogState* state	自定义弹窗的状态。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetBackgroundBlurStyleOptions()

int32_t OH_ArkUI_CustomDialog_SetBackgroundBlurStyleOptions(ArkUI_CustomDialogOptions* options, const ArkUI_AttributeItem* backgroundBlurStyleOptions)

描述：

设置弹窗的背景模糊效果。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
const ArkUI_AttributeItem* backgroundBlurStyleOptions	弹窗的背景模糊效果。参数ArkUI_AttributeItem格式： .value[0].i32：表示深浅色模式，取ArkUI_ColorMode枚举值。 .value[1]?.i32：表示取色模式，取ArkUI_AdaptiveColor枚举值。 .value[2]?.f32：表示模糊效果程度，取[0.0,1.0]范围内的值，超出有效值区间时取边界值。 .value[3]?.u32：表示灰阶模糊参数，对黑色的提亮程度，有效值范围为[0,127]，超出有效值范围，取0。 .value[4]?.u32：表示灰阶模糊参数，对白色的压暗程度，有效值范围为[0,127]，超出有效值范围，取0。 .value[5]?.i32：表示模糊激活策略，取ArkUI_BlurStyleActivePolicy枚举值。 .value[6]?.u32：表示窗口失焦后，窗口内控件模糊效果会被移除，此时控件背板的颜色，0xargb类型。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomDialog_SetBackgroundEffect()

int32_t OH_ArkUI_CustomDialog_SetBackgroundEffect(ArkUI_CustomDialogOptions* options, const ArkUI_AttributeItem* backgroundEffect)

描述：

设置弹窗的背景效果参数。

起始版本： 19

参数：

参数项	描述
ArkUI_CustomDialogOptions* options	弹窗参数。
const ArkUI_AttributeItem* backgroundEffect	弹窗的背景效果参数。参数ArkUI_AttributeItem格式： .value[0].f32：表示模糊半径，单位为vp。 .value[1]?.f32：表示饱和度。 .value[2]?.f32：表示亮度。 .value[3]?.u32：表示颜色，0xargb类型。 .value[4]?.i32：表示取色模式，取ArkUI_AdaptiveColor枚举值。 .value[5]?.u32：表示灰阶模糊参数，对黑色的提亮程度，有效值范围为[0,127]，超出有效值范围，取0。 .value[6]?.u32：表示灰阶模糊参数，对白色的压暗程度，有效值范围为[0,127]，超出有效值范围，取0。 .value[7]?.i32：表示模糊激活策略，取ArkUI_BlurStyleActivePolicy枚举值。 .value[8]?.u32：表示窗口失焦后，窗口内控件模糊效果会被移除，此时控件背板的颜色，0xargb类型。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 arkts-apis-uicontext-contextmenucontroller

openharmony 鸿蒙 errorcode-canvas

openharmony 鸿蒙 capi-oh-nativexcomponent-native-xcomponent-oh-nativexcomponent

openharmony 鸿蒙 errorcode-bindSheet

openharmony 鸿蒙 js-apis-arkui-uiExtension-sys

openharmony 鸿蒙 capi-arkui-accessibility-arkui-accessibilityeventinfo

openharmony 鸿蒙 capi-arkui-rendernodeutils

openharmony 鸿蒙 capi-native-node-h-nodeattributetype-layoutcomponent

openharmony 鸿蒙 js-apis-arkui-node

openharmony 鸿蒙 capi-native-node-h