ToastDisplay (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

Windows management functions

Toast management functions

ToastDisplay

Presentation

Example

Managing threads

Successive calls

Related examples

See also

ToastDisplay (Function)

In french: ToastAffiche

Displays a "Toast" message.

Toasts are a short messages that appear on the screen for a few seconds before fading out without any user intervention. A Toast message does not gain focus, it is not modal and it does not interrupt the execution of the application.

Toasts are recommended to show information to the user without locking the execution of the application (e.g.: display a message to indicate that the download has been completed).

This function is available for Linux WEBDEV sites only.

Example

ToastDisplay("This is a Toast message.")

ToastDisplay("This is a Toast message.", toastLong, vaMiddle, haCenter, LightGreen)

// Define the font used (gxxx functions)
ToastDisplay(gFontBold() + gFont("Batang") + gFontSize(18) + ...
gPen(LightYellow) + "My custom message", ...
toastShort, vaBottom, haRight, DarkRed)

MonToast est un Toast
MonToast.Titre = "Le saviez-vous?"
MonToast.Texte = "Les FAA sont un truc génial."
MonToast.Bouton[1].Libellé = "En savoir plus..."
MonToast.Bouton[1].ActionClic = FoncAide
MonToast.ActionFermeture = clicFerme
ToastAffiche(MonToast)
PROCEDURE INTERNE FoncAide
Ouvre("FEN_Aide")
FIN
PROCEDURE INTERNE clicFerme(nBouton)
Trace("Clic fermeture, bouton " + nBouton)
FIN

Syntax

Defining and displaying a toast Hide the details

ToastDisplay(<Message> [, <Display duration> [, <Vertical alignment> [, <Horizontal alignment> [, <Background color>]]]])

<Message>: Character string

Message to display. This message can be multiline

<Display duration>: Optional integer

Constant indicating the display duration of the Toast message:
toastLong The Toast message will be displayed during a long period of time.
toastShort
(Default value) The Toast message will be displayed during a short period of time.

Remark: The exact display duration depends on the device used.

<Vertical alignment>: Optional integer

Constant indicating the vertical alignment of message. This alignment is relative:
to the screen.
to the window.
to the page.
vaBottom
(Default value) The Toast message is displayed at the bottom.
vaMiddle The Toast message is displayed in the middle.
vaTop The Toast message is displayed at the top.

Starting with Android 11, it is no longer possible to set the position of toast messages. This parameter is ignored.

<Horizontal alignment>: Optional integer

Constant indicating the horizontal alignment of the message. This alignment is relative:
to the screen.
to the window.
to the page.
haCenter
(Default value) The Toast message is displayed in the center.
The toast will always be centered horizontally.
haLeft The Toast message is displayed on the left.
This constant is not available.
haRight The Toast message is displayed on the right.
This constant is not available.

Starting with Android 11, it is no longer possible to set the position of toast messages. This parameter is ignored.

<Background color>: Optional integer

Background color used to display the message. This parameter can be:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color.
This parameter is not available.

Displaying a toast based on a Toast variable Hide the details

ToastDisplay(<Toast>)

<Toast>: Toast variable

Name of the Toast variable that defines the toast to be displayed.
Remark: The Toast variable allows you to define additional parameters.

Remarks

Managing threads

ToastDisplay can be called from a WLanguage thread (to notify the user of events that occurred during the thread execution for example).

Successive calls

If ToastDisplay is called several times, each toast is displayed once the previous toast has disappeared. This behavior can be changed using the Overlayable property of the Toast variable. This property allows you to get the same behavior as in version 24: toasts overlap each other.

If ToastDisplay is called several times, only the last call to the function will be taken into account.

Related Examples:

Cross-platform examples (WINDEV Mobile): WM System

[ + ] This application is an example of some of the features of WINDEV Mobile available for Android/iOS.
The following system functions are used:
- NFC
- Multimedia control
- Brightness
- Volume
- Wi-Fi
- Bluetooth
- Toast
- Compass
- Accelerometer
- Camera control
- LED
- Vibration
- Notifications
- Drawing functions
- Internet

Training (WINDEV): WD Toasts

[ + ] This example shows how to use the ToastDisplay and ToastDisplayIW functions as well as Toast variables. A Toast is a temporary message used to inform the user without interrupting the application.

Business / UI classification: UI Code

Component: wd280obj.dll