fgl_winquestion()

Displays an interactive message box with configurable Ok/Yes/No/Cancel/Ignore/Abort/Retry buttons.

Syntax

fgl_winquestion(
   title STRING,
   text STRING,
   default STRING,
   buttons STRING,
   icon STRING,
   danger SMALLINT )
  RETURNING value STRING

title is the message box title.
text is the message displayed in the message box. Use '\n' to separate lines (does not work on ASCII client).
default defines the default button that is preselected.
buttons defines the options. Must be a pipe-separated list of 2 or three options : ok, yes, no, cancel, abort, retry, ignore.
icon is the name of the icon to be displayed.
danger is supported for backward compatibility. This parameter is ignored.

Usage

The fgl_winquestion() function shows a question message box to the end user and waits for an answer.

Important: With front-ends implementing this function with the system dialog box API creating a modal window, the end user will have to close the modal window first, before continuing within the window of another program. Consider using a menu with "dialog" style instead, to not block other programs.

The function returns the label of the option which has been selected by the user.

Supported names for the icon parameter are: information, exclamation, question, stop. Note that on some front-ends such as iOS devices, the native message popup window does not display an image.

The buttons parameter defines the list of options that the user can select. Possible values are: ok, yes, no, cancel, abort, retry, ignore. You must specify a pipe-separated list of options, with a maximum of 3 options. For example: "ok", "yes|no", "yes|no|cancel", "abort|retry|ignore".

Important: To display the popup window of this API, desktop and mobile front-ends use the platform specific message box API, with a predefined set of buttons. Some non-standard option combinations may not be supported, such as "ok|yes|abort". Further, the order of the buttons depends also from platform standards. For example, with "abort|retry|ignore", the buttons can appear in the following order: [Retry] [Ignore] [Abort].

On front-ends using a system dialog box API, the option buttons will be automatically localized according to the operating system language settings. On other front-ends, the option buttons will be decorated according to action default settings.

Example

IMPORT FGL fgldialog
MAIN
  DEFINE answer STRING
  LET answer = "yes"
  WHILE answer = "yes"
    LET answer = fgl_winquestion(
        "Procedure", "Would you like to continue ? ",
        "cancel", "yes|no|cancel", "question", 0)
  END WHILE
  IF answer = "cancel" THEN
     DISPLAY "Canceled."
  END IF
END MAIN