Module native_dialog 

Available on crate feature api-12 only.

Structs

ArkUI_CustomDialogOptionsapi-19

Defines a struct for the content object of a custom dialog box.

ArkUI_DialogDismissEvent

Defines a struct for a dialog box dismiss event.

ArkUI_DialogStateapi-20

Enumerates the state of dialog.

ArkUI_DismissReason

Enumerates the actions for triggering closure of the dialog box.

ArkUI_ImmersiveModeapi-15

Enumerates the immersive mode.

ArkUI_LevelModeapi-15

Enumerates the level mode.

ArkUI_NativeDialogAPI_1

Provides the custom dialog box APIs for the native side.

ArkUI_NativeDialogAPI_2api-15

Provides the custom dialog box APIs for the native side.

ArkUI_NativeDialogAPI_3api-19

Provides the custom dialog box APIs for the native side.

Functions

OH_ArkUI_CustomDialog_CloseDialog^⚠api-19

Closes a custom dialog box.

OH_ArkUI_CustomDialog_CreateOptions^⚠api-19

Creates custom dialog box options.

OH_ArkUI_CustomDialog_DisposeOptions^⚠api-19

Destroys the custom dialog box options.

OH_ArkUI_CustomDialog_GetState^⚠api-20

Get state of dialog.

OH_ArkUI_CustomDialog_OpenDialog^⚠api-19

Displays a custom dialog box.

OH_ArkUI_CustomDialog_RegisterOnDidAppearCallback^⚠api-19

Registers a callback to be invoked when the custom dialog box appears.

OH_ArkUI_CustomDialog_RegisterOnDidDisappearCallback^⚠api-19

Registers a callback to be invoked when the custom dialog box disappears.

OH_ArkUI_CustomDialog_RegisterOnWillAppearCallback^⚠api-19

Registers a callback to be invoked when the custom dialog box is about to appear.

OH_ArkUI_CustomDialog_RegisterOnWillDisappearCallback^⚠api-19

Registers a callback to be invoked when the custom dialog box is about to disappear.

OH_ArkUI_CustomDialog_RegisterOnWillDismissCallback^⚠api-19

Registers a callback for the dismissal event of the custom dialog box.

OH_ArkUI_CustomDialog_SetAlignment^⚠api-19

Sets the alignment mode of the dialog box.

OH_ArkUI_CustomDialog_SetAutoCancel^⚠api-19

Specifies whether to allow users to touch the mask to dismiss the custom dialog box.

OH_ArkUI_CustomDialog_SetBackgroundBlurStyle^⚠api-19

Sets the background blur style of the dialog box.

OH_ArkUI_CustomDialog_SetBackgroundBlurStyleOptions^⚠api-19

Sets the background blur effect for a dialog box.

OH_ArkUI_CustomDialog_SetBackgroundColor^⚠api-19

Sets the background color of the dialog box.

OH_ArkUI_CustomDialog_SetBackgroundEffect^⚠api-19

Sets the background effect parameters for a dialog box.

OH_ArkUI_CustomDialog_SetBorderColor^⚠api-19

Sets the border color of the dialog box.

OH_ArkUI_CustomDialog_SetBorderStyle^⚠api-19

Sets the border style of the dialog box.

OH_ArkUI_CustomDialog_SetBorderWidth^⚠api-19

Sets the border width of the dialog box.

OH_ArkUI_CustomDialog_SetCornerRadius^⚠api-19

Sets the corner radius for a custom dialog box.

OH_ArkUI_CustomDialog_SetCustomShadow^⚠api-19

Sets the custom shadow of the dialog box background.

OH_ArkUI_CustomDialog_SetHeight^⚠api-19

Sets the height of the dialog box background.

OH_ArkUI_CustomDialog_SetHoverModeArea^⚠api-19

Set the default display area of the dialog box in hover mode.

OH_ArkUI_CustomDialog_SetHoverModeEnabled^⚠api-19

Sets whether to enable the hover mode for the dialog box.

OH_ArkUI_CustomDialog_SetImmersiveMode^⚠api-19

Sets the immersive mode for a custom dialog box.

OH_ArkUI_CustomDialog_SetKeyboardAvoidMode^⚠api-19

Sets the keyboard avoidance mode of the dialog box.

OH_ArkUI_CustomDialog_SetLevelMode^⚠api-19

Sets the level mode for a custom dialog box.

OH_ArkUI_CustomDialog_SetLevelUniqueId^⚠api-19

Sets the level uniqueId for a custom dialog box.

OH_ArkUI_CustomDialog_SetMask^⚠api-19

Sets the mask for a custom dialog box.

OH_ArkUI_CustomDialog_SetModalMode^⚠api-19

Sets the modal mode for a custom dialog box.

OH_ArkUI_CustomDialog_SetShadow^⚠api-19

Sets the shadow of the dialog box background.

OH_ArkUI_CustomDialog_SetSubwindowMode^⚠api-19

Sets whether to display the dialog box in a subwindow.

OH_ArkUI_CustomDialog_SetWidth^⚠api-19

Sets the width of the dialog box background.

OH_ArkUI_CustomDialog_UpdateDialog^⚠api-19

Updates a custom dialog box.

OH_ArkUI_DialogDismissEvent_GetDismissReason^⚠

Obtains the c from a dialog box dismiss event object.

OH_ArkUI_DialogDismissEvent_GetUserData^⚠

Obtains the pointer to user data in a dialog box dismiss event object.

OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss^⚠

Sets whether to block the system behavior of dismissing a dialog box.

Type Aliases

ArkUI_OnWillDismissEvent

Invoked when the dialog box is closed.