Functioning (window entry)

Description

This template is called from a button at the bottom of the screen, a menu, the contextual menu for a field or a function to open an entry or visualisation window. this window can be a full screen window (it is based on the instruction Inpbox); it can be a dialogue box (it is based on the instruction Dlgbox) or it can be a message box (in this case it is based on the instruction Messbox). In the window dictionary, the field AFFICHAGE will indicate the type of box to be opened.

The window can contain :

    a screen or several screen

    the buttons at the bottom of the screen

    the menus (except for a message box)

    the left lists (except for message box)

      

The processes

The template is a supervisor process that calls the annex processes : the standard process and the specific/custom process (if it is entered in the dictionary for the action) and a process generated by window (named WGxxxxxx where  xxxxxx is the code for the window). These two standard and specific processes are structured in the same way, that is to say they start with a label ACTION, which process the different events likely to arrive during the execution of the function.

The standard process
This process supplied by ADONIX, must absolutely not be modified by the custom/specific. 

The specific/custom process
This process is not supplied by Adonix, but it can be developed (both for the standard functions for which additions are required and for the specific/custom functions).

The Actions

The standard or specific process described by the label $ACTION to write in the following fashion( where XXXXXX is the event code ) : 

$ ACTION
Case ACTION
   When "XXXXXX" : Gosub XXXXXX
   When default
Endcase
Return

Each event is identified by an alphanumeric code contained in the ACTION variable. If there is no process for the event, the functioning of the function will not be impeded by it. It is in the sub-programme $ACTION, that it is pointed to the added label. Within the "ACTION case " syntax is used to specify that as many lines as events are to be completed. The $ACTION is called from the supervisor process by GOSUB ; this therefore makes it possible to use the local variables from the supervisor process. 

Attached to this is the list of actions. Next the detailed description of these actions is found. Described here is the calling context for the OBJective of these actions.

Add the specific/custom actions to the standard

By, default, for a single event, the specific/custom action is called before the standard action.

It can cancel and replace the standard action if it sets the variable GPEto the value 1. 

To execute the standard action with the specific/custom action, copy the standard process in the specific/custom action, then add the specific/custom process and finally set the variable GPE to the value 1. Example :

Supervisor process
GPE=0
Gosub  ACTION  From  trait_std              ( call to the standard )
If GPE=0
   Gosub  ACTION  From  trait_spé.            ( call to the specific/custom process )
Endif

Specific/custom process
$ ACTION
Case ACTION
   When "OUVRE" : Gosub OUVRE
   When default
Endcase
Return

$OUVRE
...                                                                ( specific/custom action OUVRE )
GPE = 1                                                     (no call to the standard following the specific/custom)
Return

---