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-File9.1.3.17  Xform_do                                                 TOS

 Name:        »Xform_do« - Manage a form.

 Declaration  int16_t cdecl (*Xform_do) (OBJECT *tree, int16_t 
              startob, int16_t *puntmsg);

 Description  The call Xform_do takes on the management of a form, as 
              well as (to a limited extent) the handling of AES 
              messages. The following apply:

               Parameter  Meaning
               tree       Address of the object tree
               startob    Start object
               puntmsg    Message buffer

              Note: Under COPS the CPX can draw an object tree up to 
              512*384 pixels in size and pass it to this function.

 Return value: The function returns one of the following values:

               -1: puntmsg contains a message to be evaluated:

                  WM_REDRAW:  The CPX must itself redraw objects that 
                              do not belong to the object tree. The 
                              rectangle list can be obtained with the 
                              functions GetFirstRect and GetNextRect.

                  AC_CLOSE:   and

                  WM_CLOSE:   The CPX was terminated; reserved memory 
                              is to be freed immediately. AC_CLOSE is 
                              to be evaluated as 'Cancel', WM_CLOSE as 
                              'OK'.

                  CT_KEY:     Special message that permits evaluation 
                              of key-presses, provided these can have 
                              no repercussions on EDIT fields.

                               puntmsg[3]  High byte  :  Scancode of the pressed key 
                               puntmsg[3]  Low byte   :  ASCII-code of the pressed key 

                  Else:       Index of object clicked on (a double- 
                              click is flagged in the upper bit).

 Group:       XCONTROL functions

 See also:    form_do   form_xdo   Rectangle-list of a window