native_dialog.h

概述

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

库： libace_ndk.z.so

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

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

起始版本： 12

相关模块：ArkUI_NativeModule

汇总

结构体

名称	描述
struct  ArkUI_NativeDialogAPI_1	ArkUI提供的Native侧自定义弹窗接口集合，范围为ArkUI_NativeDialogAPI_1。
struct  ArkUI_NativeDialogAPI_2	ArkUI提供的Native侧自定义弹窗接口集合，范围为ArkUI_NativeDialogAPI_2。

类型定义

名称	描述
typedef bool(* ArkUI_OnWillDismissEvent) (int32_t reason)	弹窗关闭的回调函数。
typedef struct ArkUI_DialogDismissEvent ArkUI_DialogDismissEvent	定义弹窗关闭事件对象。
typedef struct ArkUI_CustomDialogOptions ArkUI_CustomDialogOptions	定义自定义弹窗的内容对象。

枚举

名称	描述
ArkUI_DismissReason { DIALOG_DISMISS_BACK_PRESS = 0, DIALOG_DISMISS_TOUCH_OUTSIDE, DIALOG_DISMISS_CLOSE_BUTTON, DIALOG_DISMISS_SLIDE_DOWN }	弹窗关闭的触发方式。
ArkUI_LevelMode { ARKUI_LEVEL_MODE_OVERLAY = 0, ARKUI_LEVEL_MODE_EMBEDDED }	设置弹窗显示层级。
ArkUI_ImmersiveMode { ARKUI_IMMERSIVE_MODE_DEFAULT = 0, ARKUI_IMMERSIVE_MODE_EXTEND }	指定嵌入式弹窗的蒙层覆盖区域。

函数

名称	描述
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)	获取交互式关闭事件指针中的关闭原因。