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-Filegraf_growbox()
graf_shrinkbox()
Form Library
form_dial()                                                             AES

Syntax

WORD form_dial( mode, x1, y1, w1, h1, x2, y2, w2, h2 )
WORD mode, x1, y1, w1, h1, x2, y2, w2, h2;

Function       form_dial() is used to reserve and release screen space for
               dialog usage. In addition, it also optionally provides
               grow/shrink box effects.

Opcode         51 (0x33)

Availability   All AES versions.

Parameters     mode specifies the action to take and the meaning of
               remaining parameters as follows:

               Name        #   Action

               FMD_START   0   This mode reserves the screen space for
                               a dialog. x2, y2, w2, and h2, contain the
                               coordinates of the dialog to be used
                               (usually obtained through form_center()).

               FMD_GROW    1   This mode draws an expanding box from the
                               coordinates specified in x1, y1, w1, and h1
                               to the coordinates specified in x2, y2, w2,
                               and h2. This call is optional and is not
                               required to display a dialog.

               FMD_SHRINK  2   This mode draws a shrinking box from the
                               coordinates specified in x2, y2, w2, and h2
                               to the coordinates specified in x1, y1, w1,
                               and h1. This call is optional and is not
                               required to display a dialog.

               FMD_FINISH  3   This mode releases the screen space for
                               a dialog (previously reserved with mode 0).
                               x2, y2, w2, and h2 contain the coordinates
                               of the space to release. One of the
                               side-effects of this call is a WM_REDRAW
                               message sent to any window which the dialog
                               was covering.

Binding        intin[0] = mode;
               intin[1] = x1;
               intin[2] = y1;
               intin[3] = w1;
               intin[4] = h1;
               intin[5] = x2;
               intin[6] = y2;
               intin[7] = w2;
               intin[8] = h2;

               return crys_if(0x33);

Return Value   The function returns 0 if an error occurred or non-zero
               otherwise.

Version Notes  The AES does not currently make use of mode FMD_START. The
               call should, however, still be executed for upward
               compatibility.

See Also       graf_growbox(), graf_shrinkbox()

Group          Form Library