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_do()                                                               AES

Syntax

WORD form_do( tree, editobj )
OBJECT *tree;
WORD editobj;

Function       form_do() provides an automated dialog handling function to
               the calling application. It suspends program control,
               handles all radio buttons, selectable objects, etc...
               until an object with the TOUCHEXIT or EXIT flag is
               selected.

Opcode         50 (0x32)

Availability   All AES versions.

Parameters     tree is a pointer to a valid object tree (see the
               discussion on objects in this chapter) which contains
               a dialog with at least one EXIT or TOUCHEXIT button or
               object.
               editobj is the object index into tree which specifies the
               desired initial location of the edit cursor (the object
               must be flagged as EDITABLE). If the form has no text
               editable fields, you should use 0.

Binding        intin[0] = editobj;

               addrin[0] = tree;

               return crys_if(0x32);

Return Value   form_do() returns the object index of the EXIT or TOUCHEXIT
               button which was selected. If the object was double
               clicked, top bit will be set. This means that to obtain the
               actual object number you should mask it out with 0x7FFF.

Group          Form Library