/* * Copyright (c) 2021-2023 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @file * @kit ArkUI */ import { AsyncCallback } from './@ohos.base'; /** * @namespace promptAction * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * @namespace promptAction * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * @namespace promptAction * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ declare namespace promptAction { /** * @typedef ShowToastOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * @typedef ShowToastOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * @typedef ShowToastOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ interface ShowToastOptions { /** * Text to display. * * @type { string | Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * Text to display. * * @type { string | Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Text to display. * * @type { string | Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ message: string | Resource; /** * Duration of toast dialog box. The default value is 1500. * The recommended value ranges from 1500ms to 10000ms. * NOTE: A value less than 1500 is automatically changed to 1500. The maximum value is 10000ms. * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * Duration of toast dialog box. The default value is 1500. * The recommended value ranges from 1500ms to 10000ms. * NOTE: A value less than 1500 is automatically changed to 1500. The maximum value is 10000ms. * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Duration of toast dialog box. The default value is 1500. * The recommended value ranges from 1500ms to 10000ms. * NOTE: A value less than 1500 is automatically changed to 1500. The maximum value is 10000ms. * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ duration?: number; /** * The distance between toast dialog box and the bottom of screen. * * @type { ?(string | number) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * The distance between toast dialog box and the bottom of screen. * * @type { ?(string | number) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * The distance between toast dialog box and the bottom of screen. * * @type { ?(string | number) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ bottom?: string | number; /** * Determine the show mode of the toast. * * @type { ?ToastShowMode } * @default ToastShowMode.DEFAULT * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 11 */ /** * Determine the show mode of the toast. * * @type { ?ToastShowMode } * @default ToastShowMode.DEFAULT * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ showMode?: ToastShowMode; /** * Defines the toast alignment of the screen. * * @type { ?Alignment } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ alignment?: Alignment; /** * Defines the toast offset. * * @type { ?Offset } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ offset?: Offset; /** * Background color of toast. * * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ backgroundColor?: ResourceColor; /** * Text color of toast. * * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ textColor?: ResourceColor; /** * Background blur Style of toast. * * @type { ?BlurStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ backgroundBlurStyle?: BlurStyle; /** * Shadow of toast. * * @type { ?(ShadowOptions | ShadowStyle) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ shadow?: ShadowOptions | ShadowStyle; /** * Define whether to respond to the hover mode. * * @type { ?boolean } * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 14 */ enableHoverMode?: boolean; /** * Defines the toast's diaplay area in hover mode. * * @type { ?HoverModeAreaType } * @default HoverModeAreaType.BOTTOM_SCREEN * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 14 */ hoverModeArea?: HoverModeAreaType; } /** * Enum for the toast showMode. * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 11 */ /** * Enum for the toast showMode. * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ export enum ToastShowMode { /** * Toast shows in app. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 11 */ /** * Toast shows in app. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ DEFAULT = 0, /** * Toast shows at the top. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 11 */ /** * Toast shows at the top. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ TOP_MOST = 1, /** * Toast shows in SYSTEM_TOAST window. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @since 12 */ SYSTEM_TOP_MOST = 2 } /** * @typedef Button * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * @typedef Button * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * @typedef Button * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ interface Button { /** * The text displayed in the button. * * @type { string | Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * The text displayed in the button. * * @type { string | Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * The text displayed in the button. * * @type { string | Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ text: string | Resource; /** * The foreground color of button. * * @type { string | Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * The foreground color of button. * * @type { string | Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * The foreground color of button. * * @type { string | Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ color: string | Resource; /** * Define whether the button responds to Enter/Space key by default. * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ primary?: boolean; } /** * @typedef ShowDialogSuccessResponse * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * @typedef ShowDialogSuccessResponse * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * @typedef ShowDialogSuccessResponse * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ interface ShowDialogSuccessResponse { /** * Index of the selected button, starting from 0. * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * Index of the selected button, starting from 0. * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Index of the selected button, starting from 0. * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ index: number; } /** * @typedef ShowDialogOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * @typedef ShowDialogOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * @typedef ShowDialogOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ interface ShowDialogOptions { /** * Title of the text to display. * * @type { ?(string | Resource) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * Title of the text to display. * * @type { ?(string | Resource) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Title of the text to display. * * @type { ?(string | Resource) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ title?: string | Resource; /** * Text body. * * @type { ?(string | Resource) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * Text body. * * @type { ?(string | Resource) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Text body. * * @type { ?(string | Resource) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ message?: string | Resource; /** * Array of buttons in the dialog box. * The array structure is {text:'button', color: '#666666'}. * One to three buttons are supported. * The first button is of the positiveButton type, the second is of the negativeButton type, and the third is of the neutralButton type. * * @type { ?Array