Topic       : The ATARI Compendium
Author      : Scott Sanders / JAY Software
Version     : 1.25 (20/6/2003)
Subject     : Documentation
Nodes       : 1117
Index Size  : 32614
HCP-Version : 6
Compiled on : Atari
@charset    : UTF-8
@lang       : en
@default    : 
@help       : %About
@options    : +g -i -t4 +y +z
@width      : 100
View Ref-FileForm Library
form_alert()                                                            AES

Syntax

WORD form_alert( default, alertstr )
WORD default;
CHAR *alertstr;

Function       form_alert() displays a standardized alert box and returns
               the user's selection.

Opcode         52 (0x34)

Availability   All AES versions.

Parameters     default contains the number of the exit button which is to
               be made default (1-3). alertstr contains a formatted string
               as follows: "[#][Alert Text][Buttons]".
               # specifies the icon to display in the alert as follows:

               #       Icon Displayed

               0       No Icon


               1


               2


               3


               4


               5



               'Alert Text' is a text string of as many as 5 lines composed
               of up to 30 characters each. Each line is separated by a '|'
               character.
               'Buttons' is a text string to define as many as 3 buttons
               up to 10 characters each. If only one button is used, its
               text may be as long as 30 characters. Again, each button is
               separated by a '|' character

Binding        intin[0] = default;

               addrin[0] = alertstr;

               return crys_if(0x34);

Return Value   form_alert() returns a WORD indicating which button was used
               to exit by the user (A possible value of 1-3).

Version Notes  Icons #4-5 are only available as of AES version 4.1.

Caveats        Several versions of the AES have special quirks related to
               this function. By following the quidelines below you should
               avoid any difficulty:

               1. All AES versions below 1.06 have some difficulty
                  formatting alert strings padded with spaces.
                  If you want your alerts to look right on all AES versions,
                  do not pad any button or line with spaces with the
                  exception below.
               2. Add one space to the end of the longest text line on an
                  alert. This will prevent the right edge from touching the
                  border in some AES versions.

Group          Form Library