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.2  form_button                                                TOS

 Name:         »Form button« - Simulate the clicking on an object.

 Opcode:       56

 Syntax:       int16_t form_button ( OBJECT *fo_btree, int16_t 
               fo_bobject, int16_t fo_bclicks, int16_t *fo_bnxtobj );

 Description:  The call form_button simulates mouse clicks on an 
               object. The following apply:

                Parameter   Meaning

                fo_btree    Address of the object tree in memory
                fo_bobject  Object to be processed
                fo_bclicks  Number of mouse clicks
                fo_bnxtobj  New current object, or 0 if the next 
                            object has the status HIDDEN or DISABLED, 
                            or is not editable

               Note: At a double-click on an object with TOUCHEXIT, 
               bit 15 will be set in the parameter fo_bnxtobj. The 
               rectangle list will not be taken into account by this 
               function.

               The correct usage of the function is as follows:

                  . Monitor mouse clicks with evnt_multi or 
                    evnt_button
                  . Once a click occurs, use obj_find to check if the 
                    click was made on the object.
                  . If it was, call form_button with the appropriate 
                    values.

               Warning: This function was not originally documented by 
               Atari, so you may need to add bindings for it to some 
               earlier 'C' compilers.

 Return value: The return value of the function is 0 if an EXIT or 
               TOUCHEXIT object was selected, else it is positive.

 Availability: All AES versions.

 Group:        Form library

 See Also:     Binding   OBJECT   evnt_multi   form_keybd