Topic       : TOS - The Operating System
Author      : 
Version     : tos.hyp (December 19, 2008)
Subject     : Programmieren/Atari
Nodes       : 3010
Index Size  : 93790
HCP-Version : 5
Compiled on : Atari
@charset    : atarist
@lang       : 
@default    : Title
@help       : 
@options    : +g -i -s +x +zz -t4
@width      : 70
View Ref-File8.11.5  form_do                                                    TOS

 Name:         »Form do dialog« - Process the dialog with input from 
               the user.

 Opcode:       50

 Syntax:       int16_t form_do ( OBJECT *fo_dotree, int16_t 
               fo_dostartob );

 Description:  The call form_do takes over the processing of user 
               actions in a dialog form from the calling application, 
               suspending program control and handling all selectable 
               objects, radio buttons etc. The following apply:

                Parameter     Meaning

                fo_dotree     Pointer to object tree of the dialog box
                fo_dostartob  Index of the editable object where the 
                              text cursor should be at the opening of 
                              the dialog (the object must have the 
                              EDITABLE flag set); it will be 0 if the 
                              object tree contains no editable object

               Note: The function only returns once the user activates 
               an object with the EXIT or TOUCHEXIT flag, and restores 
               control to the calling program.

 Return value: This will be the index of the object which was used to 
               close the dialog. With a double-click, in addition bit 
               15 will be set.

 Availability: All AES versions.

 Group:        Form library

 See Also:     Binding   form_xdo   OBJECT