Execution Window

PROGRAM
. STRING *8 STR1
. INTEGER*4  INT1
. DATE DAT1 ('DD/MM/YY')
. COMPUTE STR1 = 'String'; INT1 = 1; DAT1 = '01/01/93'
. DISPLAY TEXT 'No video attribute' AT 10 25
. DISPLAY TEXT  STR1  AT 11 25 VIDEO 2   | bold
. DISPLAY TEXT  INT1  AT 12,25 VIDEO 4   | inverse
. DISPLAY TEXT  DAT1  AT 13,25 VIDEO 22  | Bold/inverse/underline
. WAIT 30
END PROGRAM

Clears the screen. The cursor position is not affected.

FIELD INPUT varname
      AT row, col WIDTH display_width,input_length
    [ ARROWS right_arrow_char_value , left_arrow_char_value ]
    [ AUTOTAB ]
    [ BACKSPACE char_value ]
    [ DEFAULT varname | string_constant ]
    [ DELETE char_value ]
    [ EDITMODE 0 | 1]
    [ EDITSIDE 0 | 1]
    [ HELP 'help page']
    [ INSERT | OVERSTRIKE ]
    [ LEFT | RIGHT ]
    [ POSITION num_varname ]
    [ TABMODE 0 | 1]
    [ TERMINATOR num_varname [ ( list of char_values ) ] ]
    [ TIMEOUT num_value ]
    [ VIDEO video_value ]

Unless a TERMINATOR clause is specified, input is terminated by pressing any special key aside from the left/right arrow keys, [Delete], [Delete_field] and [End_of_line] keys. The user can use these keys to edit the field.

The varname is the name of the variable where the input is stored. If a variable is implicitly defined by this command, it is a string variable. Trailing blanks are trimmed from the input.

If a numeric variable is specified, input text which corresponds to a numeric format is stored as a number. If the input text does not correspond to a numeric format, undefined is stored.

AT	Specifies the screen location of the beginning of the input field.
WIDTH	Specifies the display width of the field and the maximum length of the input string (max_input_length). If the maximum length is greater than the display width, then the field is scrolled horizontally as the cursor attempts to move past either end of the input area.
ARROWS	Specifies the key values that move the cursor one character to the right or to the left. By default, these are 259 and 260. (The Right Arrow and Left Arrow keys.)
AUTOTAB	Specifies that input terminates when the maximum input length is reached. Without AUTOTAB, the user must specifically terminate input.
BACKSPACE	Specifies the key value that deletes the character to the left of the cursor. This default is 304.
DEFAULT	Specifies the variable or string constant that is displayed in the input field area upon entering the FIELD INPUT command. This string may then be edited by the user. If using a variable, it may be the same as the first parameter on the command.
DELETE	Specifies the key value that deletes the character where the cursor is positioned. The default is 276.
EDITMODE	Alternative method of specifying INSERT | OVERSTRIKE option. Specify a numeric integer variable or constant. 0 equates to INSERT, 1 equates to OVERSTRIKE.
EDITSIDE	Alternative method of specifying LEFT | RIGHT option. Specify a numeric integer variable or constant. 0 equates to RIGHT, 1 equates to LEFT.
HELP	Specifies a help page that is displayed if the user presses (Help) while positioned on this field. The page must be in html format in the help directory. The page name can contain directory names using forward slashes to delimit. Enclose the name in quotes. The system will convert this to a file name prefixed with a path pointing to the help directory and suffixed with the file extension .htm.
INSERT | OVERSTRIKE	INSERT (the default) specifies that characters are inserted at the cursor location. OVERSTRIKE specifies that input characters overwrite existing characters.
LEFT | RIGHT	LEFT specifies that characters are entered starting at the leftmost column of the field and moving to the right. RIGHT specifies that characters are entered starting at the rightmost column of the field and moving to the left. If using a language which requires entry of text from right to left, specify, RIGHT, OVERSTRIKE and optionally set ARROWS (304,260). LEFT is the default.
POSITION	Performs two functions. When the command is executed, it specifies the position within the field to place the cursor. If the value is undefined or 0, the cursor is placed at field position 1. After input is terminated, it contains the position within the field where the cursor was located when the terminator key was pressed.
TABMODE	Alternative method of specifying AUTOTAB option. Specify a numeric integer variable or constant. 0 equates to NOAUTOTAB, 1 equates to AUTOTAB.
TERMINATOR	Specifies a variable that receives the key value that terminated input processing. It optionally specifies a list of key values that terminate input processing. The list of key values may be constants or numeric variables within parentheses. A maximum of 16 terminator values may be specified in the list. If a terminator list is specified, only those referenced in the list terminate input. Other control or function key characters sound a warning. If no list is specified, then any special key not used for editing causes termination of input. If the termination is caused by an AUTOTAB, the terminator variable is set to 30001. If termination is caused by a TIMEOUT, the terminator variable is set to 30002.
TIMEOUT	Specifies the amount of time to wait for the user's input, in tenths of a second. Zero (the default) puts no time limit on the user. If the user does not enter a value in the specified amount of time, and a variable is specified on the TERMINATOR, it is set to the "time out" character value which is 30002 and execution continues.
VIDEO	Specifies the video treatment of the input field.

FIELD INPUT TEXTLINE at 11 , 40 width 20 , 20 video 4

FILL  row1 , col1 , row2 , col2
    [ VIDEO video_value ]
    [ CHARACTER str_var | 'c' ]

The FILL command fills the rectangular area of the screen defined by the coordinates with the specified character and video treatment.

VIDEO	Specifies the video treatment of the fill character.
CHARACTER	Specifies a single character to fill the area. Specify either a string variable or a single character string constant. The default character is the blank (' ').

PROGRAM
. COMPUTE BLUONYEL = 2**2 + 2**8 + 2**13 + 2**14
. BOX AT  5 20 15 60 VIDEO BLUONYEL
. FILL 6 21 14 59 CHARACTER '*' VIDEO BLUONYEL
. WAIT 50
END PROGRAM

LINE CHARACTER ( list_of_num_values ) AT row , col
   [ VIDEO video_val ]

LINE CHARACTER draws a set of line characters on the screen. Each value in the parenthesised list draws one character. The values must be between 1 and 15 where each value represents a different line drawing character. The values and the characters that are drawn are:

1 Top Left Corner
2 Top Right Corner
3 Bottom Left Corner
4 Bottom Right Corner
5 Top T Intersection
6 Bottom T Intersection
7 Left T Intersection
8 Right T Intersection
9 Intersection Cross
10 Vertical Line
11 Top End of Vertical Line
12 Bottom End of Vertical Line
13 Horizontal Line
14 Left End of Horizontal Line
15 Right End of Horizontal Line

AT	Specifies the coordinates at which the first line character in the list is placed. This is required.
VIDEO	Specifies the video treatment of the line characters.

HORIZONTAL MENU  row1, col1, row2, col2
      [ SPACING leading_blanks, trailing_blanks ]
      [ WIDTH   width ]

VERTICAL MENU  row1, col1, row2, col2

Horizontal menus are displayed across the screen and are scrolled left and right. Vertical menus are displayed down the screen and scroll up and down. The following options can be specified for both menu types:

      [ ARROWS       up_key_value, down_key_value ]
      [ BOX          row1,col1,row2,col2,boxtype_num , video_value ]
      [ ENTER        select_key_value, unselect_key_value ]
      [ EXIT         key_varname, element_varname,top_varname,last_item_varname ]
      [ FILL         char,video_value ]
      [ GROUP        num_value , up_key_value, down_key_value ]
      [ HELP         help_page ]
      [ HOTKEYS ]
      [ KEEPMENU     num_value ]
      [ PASTEONLY    num_value ]
      [ PROMPT       col1, col2, prompt_string, video_value ]
      [ PROMPTVIDEO  video_value ]
      [ SCREENOK     num_value ]
      [ SELECT       col1, col2, select_string, video_value ]
      [ SELECTARRAY  name_of_first_select_variable | array_name ]
      [ SELECTVIDEO  selected_item_video_value ]
      [ START        top_item_to_display, first_item_to_point_to ]
      [ TERMINATORS  ( list of char_values ) ]
      [ TIMEOUT      wait_time_value ]
      [ TITLE        row,col,title_string, video_value ]
      [ VIEW         top, bottom ]

There are two further options in horizontal menus:

      [ SPACING      before, after]
      [ WIDTH        width]

Menu Options

FAMILY first_family, last_family, video_value
LIST (list of string values), video_value
LIST array_name, number_of_items, video_value
LIST str_varname, number_of_items, video_value
MEMBER family, first_member, last_member, video_value
RECTYPE first_rectype_num, last_rectype_num, video_value
VARNAME rectype,first_var,last_var,video_value

ARROWS	Specifies the character values for arrow key movement. By default, arrow key movement for vertical menus is defined as the down Arrow and up Arrow keys (key values 258 and 257), and arrow key movement for horizontal menus is defined as the left Arrow and right Arrow keys (key values 260 and 259).
BOX	Draws a box at the specified coordinates with the specified video attribute. Row1 and col1 specify the upper left corner of the box, and row2 and col2 specify the lower right corner of the box. The boxtype specifies which line drawing characters to use when the current box overlaps another box; a boxtype of 1 causes intersections of one box with another to use intersection characters (equivalent to a BOX OVER); a boxtype of 0 ignores intersections with another box (equivalent to a BOX AT).
ENTER	Specifies the character value of the keys to use for selecting and unselecting menu items, respectively (see the SELECT and EXIT clauses). There are no default ENTER keys.
EXIT	When the user presses a key to exit the menu, the key_varname variable contains the character value of the key pressed to exit the menu. The element_varname contains the position of the menu item being prompted for at the time the menu was exited. The top_varname variable contains the position of the item at the top of the menu when the terminator key was pressed. The last_item_varname contains the string value of the menu item where the prompt was positioned when the menu was exited. The TERMINATORS clause defines which key or keys cause termination of the menu.
FAMILY	Fills the menu with the names of the families specified in the list. The values of the first and last families may be either numeric or string values. The null family occupies a space in the menu but displays no text. By specifying the first family as 'A' and the last family as 'ZZZZZZZZ', all named families in the procedure file are displayed.
FILL	Fills any area of the menu that is not part of a menu item's field, plus leading and trailing blanks in horizontal menus, with the specified character and video attribute.
GROUP	Specifies the size of multiple line scrolling jumps (equivalent to a page-up and page-down function). Specifies which keys (page up, page down) move the prompt the specified number of menu items. The default page up/page down values are 296 for up and 273 for down.
HELP	Specifies a help page that is displayed when the user presses the (Help). The page must be in html format in the help directory. The page name can contain directory names using forward slashes to delimit. Enclose the name in quotes. The system will convert this to a file name prefixed with a path pointing to the help directory and suffixed with the file extension .htm.
HOTKEYS	Specifies that the menu supports hot-keys. If a menu supports hot keys, the first capital letter in each menu item is the hot key. Pressing this from any point in the menu invokes the item. If the menu does not support hot keys, it supports alpha positioning. This means that when the user types in characters, the menu position is set to the item beginning with those characters. The menu should be in alphabetic sequence for alpha positioning.
KEEPMENU	Specifies whether the menu remains on the screen after termination. By default, the menu is cleared from the screen when the user exits from it. A non-zero value keeps the menu on the screen, zero or undefined clears the menu. The value 1 leaves the last prompted for item highlighted. The value 2 'un-highlights' the last prompted for item.
LIST	Specifies a list of items to display as menu choices. The video specifies the video display when the items are not being prompted for. The list is: A list of values in parentheses either string constants or string variables. These are the menu items in the specified sequence. The name of a string array and the number of items to display. A variable and a number of items. The variable is the first menu item and the variables that follow this in the program are the subsequent items. (Typically a TO list.) The number of items is a numeric constant or variable.
MEMBER	Fills the menu with the names of the members implied in the first member and last member specification. The first and last member referenced may be either numeric or string.
PASTEONLY	Specifies that the menu is displayed on the screen, but not executed. A non-zero value displays with no execution; a zero or undefined value displays and executes. This is normally used in conjunction with KEEPMENU which leaves the menu on the screen after it is displayed and when program execution continues past the menu command.
PROMPT	Displays the prompt string at the specified columns of the menu. The prompt string moves from item to item according to the user's directions. (In most applications, either the PROMPT or the PROMPTVIDEO clause is used.) In vertical menus, col1 and col2 refer to the columns on the execution window where the prompt string is displayed. These can have the same value resulting in a single character prompt. In horizontal menus, col1 and col2 refer to the positions within an item's field that contain the prompt string, where the field width is equal to the width plus any leading or trailing blanks.
PROMPTVIDEO	Specifies the video treatment of the menu item being prompted for.
RECTYPE	Fills the menu with the names of the record types implied by the range of record types specified.
SCREENOK	Specifies that the appearance of the screen is as required and that the menu is not re-displayed. A non-zero value specifies that the screen is OK and is not re-displayed; a zero or undefined value specifies that the menu display is displayed. This is often used with the KEEPMENU option allowing the program to go out of the menu and perform some task and then return to the menu transparently to the user.
SELECT	Specifies the manner in which selected menu items in a multiple select menu are 'marked'. The specified string is displayed at the specified columns next to selected items. The ENTER option and the TERMINATORS option must be used to allow multiple choice menus. The SELECTARRAY option must also be specified so that the program can tell which items were selected after the menu is exited.
SELECTARRAY	Names the array or first variable of a numeric variable list used to indicate which items have been selected. The number of elements in the array must be at least as great as the number of items in the menu. When an item is selected, the array element corresponding to the ordinal position of the menu item is set to 1. When an item is un-selected (see ENTER), the corresponding array element is set to 0. Any select array element containing a non-zero or non-null value at the time the menu is first executed treats the corresponding menu items as having been selected.
SELECTVIDEO	Specifies the video treatment of selected menu items. Either the SELECTVIDEO, SELECT or both are used for multiple choice menus.
SPACING	Specifies the number of spaces before and after each menu item on a HORIZONTAL MENU.
START	Specifies how the menu items are displayed within the menu when the command is executed. The first argument specifies the item to display at the top of the menu. The second argument specifies the item highlighted. Both arguments are numeric and may be variables or constants. If START is not specified, the first menu item is placed at the top and the prompt points to the first item.
TERMINATORS	Specifies a list of legal terminators by their character values. When this clause is specified only the keys defined in the list cause termination of the menu. If the user presses a key not defined as a terminator key or as a special key by one of the other clauses, the bell rings and the menu is not terminated. The maximum number of terminator values that can be specified is 254. If hot-keys are supported these are terminators by definition. The key values may be numeric constants or variables. If this clause is not specified, any key, except those which are defined to take a specific action, causes termination of the menu. The EXIT clause stores which key caused termination of the menu.
TIMEOUT	Specifies the amount of time to wait for a user to press a key after the menu is displayed, in 1/10 of a second increments. If the user does not press a key in that period of time, the "time out" terminator value is set (char_value = 30002) and the menu is terminated.
VARNAME	Fills the menu with a list of variable names for the specified record type, with the specified video attribute. The variable references may be either string or numeric. Strings refer to variable names, numbers refer to DATA LIST order number.
VIEW	Specifies when scrolling occurs as the user moves up and down the menu. Specifies how many rows at the top and bottom of the menu are always displayed away from the prompted item. The default is 0 for both top and bottom, meaning that the menu does not begin scrolling until the user reaches the bottom (or top) of the menu area.
WIDTH	Specifies the maximum width of each item on a horizontal menu. If an item is longer than the width specified, then it is truncated to fit the width; if the item is shorter, it is padded with blanks. A width of 0 uses the minimum width needed for each item.

c       This program demonstrates two very simple menus, a
c       VERTICAL MENU and a HORIZONTAL MENU. The user
c       selects an item from the first menu, the choice is
c       redisplayed, and the second menu allows the user to
c       do it all again or exit the program.

PROGRAM
STRING * 80 MESSAGE

LOOP
VERTICAL MENU 5 , 30 , 10 , 45
         list     ( 'First Menu Item' 'Second Menu Item'
                    'Third Menu Item' 'Fourth Menu Item') , 0
         promptvideo 4
         exit KEYVAR,ELEMVAR,TOPVAR,LASTSEL

COMPUTE MESSAGE = 'You have selected the ' + LASTSEL + ' '
DISPLAY TEXT MESSAGE AT 15 , 20
HORIZONTAL MENU 20,30,20,50
           spacing     2 , 2
           list        ('Do Again' 'Exit') ,0
           promptvideo 4
           box         19,29,21,51,0,0
           exit        KEYVAR,ELEMVAR,TOPVAR,LASTSEL
IF(ELEMVAR  NE 1) EXIT LOOP
END LOOP
END PROGRAM

SENSE MOUSE  START row col
             END row_var col_var
             BUTTON button_var
             CHARACTER char_var

Displays a mouse cursor on the screen as the mouse is moved. Execution terminates either when a mouse button is pressed or when a keyboard key is pressed. When processing is terminated by a button pressed, the mouse cursor position and the terminating button number is reported. When processing is terminated by a keypress, the character value of the key pressed is reported (the mouse position is also reported). Specify all keywords - START, END, BUTTON, and CHARACTER - in the order shown:

START	The screen coordinates of the mouse cursor when the command is executed. The values of the starting row and column may be either explicit numbers or variable names.
END	The variables which hold the screen coordinates of the mouse when the command is completed.
BUTTON	The variable which contains the numeric value of the button that was pressed. 0 - No button (the command is terminated with a keypress); 1 - primary button; 2 - secondary button.
CHARACTER	The variable which contains the character value of the key that was pressed. 0 - if mouse button pressed.

Two consecutive SENSE MOUSE commands may not give the user enough time to release the button from the first command. Specify a short delay, with the WAIT command, before executing the second SENSE MOUSE. The following example allows the user to draw a box on the screen by using the mouse to specify the top left and then bottom right coordinates of the box.

PROGRAM
SENSE MOUSE START 10 40 END R1 C1 BUTTON BN CHARACTER CHN
DISPLAY TEXT '*' AT R1 C1   | mark corner until box is drawn
WAIT 1                      | wait for user
SENSE MOUSE START R1 C1 END R2 C2 BUTTON BN CHARACTER CHN
BOX AT R1 C1 R2 C2
WAIT 10
END PROGRAM

Waits for a specified number of tenths of a second.

Copies a template from a template member (with a ':P' suffix) to the template file. Member name is a fully qualified member name including family name, family password, member name, member password and member type. It is a string expression, that is a string variable or a string in quotes.

DELETE TEMPLATE FILE MEMBER name
Removes the named template from the template file. The name may be a string constant, a string variable or [string_expression].

POP TEMPLATE [ REDRAW [ AT row, col ]
      [ IOSTAT varname] ]

Retrieves the top-most template from the push list, removes it from the list and optionally redraws it.

REDRAW	Displays the template on the screen. If the AT clause is not specified, it is re-drawn at its original location.
AT	Specifies the placement of a re-drawn template by specifying the location of the upper left hand corner of the template.
IOSTAT	Specify a numeric variable which receives a return value. A zero indicates success. A non-zero value is the number of the associated error message.

Saves a rectangular area of the screen on a stack for later reloading. The upper left corner of the template is defined by row1 and col1, and the bottom right corner by row2 and col2.

MEMORY

Specifies that the template is stored in memory rather than on the template scratch file. This speeds up execution at the expense of memory.

RESTORE TEMPLATE { LOCAL templt_name_str_value | MEMBER member_name_string_value }
                 [ AT row , col ]
                 [ IOSTAT varname]
                 [ VIDEO video_value]

Retrieves the named template and displays it on the screen, overwriting the portion of the screen occupied by the template.

LOCAL	Restores a template stored on a template file or in memory, depending on where it was last stored. The name may be specified as a quoted string or as a variable that contains the name of the template.
MEMBER	Restores a template stored as a member in the procedure file. The member name may be fully qualified with procfile name, family name and passwords. The member must be a 'template' type, with the suffix ':P'.
AT	Specifies the placement of the upper left corner of the template. If this is not specified, the template is restored to its original location. A template that exceeds the boundaries of the execution window gives unpredictable results.
IOSTAT	Specify a numeric variable which receives a return value. A zero indicates success. A non-zero value is the number of the associated error message.
VIDEO	Specify a video value to change all video values on the restored template to the specified value.

SCROLL TEMPLATE  row1 , col1 , row2 , col2
     { UP | DOWN } num_value ROWS
     [ FILLCHAR char | FILLSTRING string [ VIDEO video_value ] ]

Moves an area of the screen, a template, up or down the specified number of rows within the specified template area. If an area is moved up one row, for example, the top line of the area disappears, the other rows move up one row and the bottom row stays the same unless a fill is specified in which case the last row would be filled with the fill character or string.

The upper left corner of the template area is specified by row1 and col1; the lower right corner of the template area is specified by row2, col2.

UP | DOWN	UP moves the template up the specified number of rows. DOWN moves the template down the specified number of rows.
ROWS	Specifies that the unit of movement is rows and is a required keyword.
FILLCHAR	Specifies a character with which the vacated rows are filled.
FILLSTRING	Specifies a string with which the vacated rows are filled.
VIDEO	Specifies the video treatment of the fill character or string.

STORE TEMPLATE row1 , col1 , row2 , col2
    { LOCAL name [ MEMORY ] |   MEMBER name }

Stores a portion of the screen as a template by specifying the upper left corner coordinates ( row1 , col1 ) and the lower right corner ( row2 , col2 ). The stored template can be accessed later with the RESTORE TEMPLATE command.

LOCAL	Stores the template either on the template scratch file or in memory. It is stored in memory if the system setting MMRYTMPL is ON or if the MEMORY keyword is specified. The template name may be a string in quotes or as a string variable.
MEMORY	Specifies that the template is stored in memory rather than on the template file.
MEMBER	Stores the template as a member. The member name may be fully qualified with procfile, family name and passwords. The member is given the suffix ':P'. The name may be specified as a string in quotes or as a string variable.