MENU

This Command defines the Number (ID), Title and Prompt for a Menu belonging to the current Verb Group. This Command must be present prior to attempting to define any Menu Buttons via a BUTTON Command.

Parameters

MENU_ID

Menu ID. This must either be an Integer lying in the range 0-4095 (denoting absolute addressing) or the following syntax may be used:-

MENU #+n

\

where ``n" is an integer in the range 0-4095. (``MENU #" is equivalent to ``MENU #+0"). This implies self-relative addressing and the Menu will be assigned an ID relative to the lowest Menu ID defined within the file. If absolute addressing is used anywhere within the File, this is the lowest Menu ID defined. If self-relative addressing is used throughout the File, then this Base ID is the first unassigned ID at the time the file is read and all Menus will be assigned IDs relative to this. In this latter case the calling program should use the optional arguments to the UI_DEFINE_FILE subprogram to determine which Menus were actually defined.

Qualifiers

/CLONED_FROM=<menu_id>

Specifies that this Menu is ``cloned" from the specified Menu and therefore has the same attributes (Prompt, Title, Style, Button Field Parameters etc.) as it. The action of this Qualifier is positional and depends on whether it appears before or after the other Qualifiers. This Qualifier will override settings specified by any previous Qualifiers but the cloned settings will themselves be overridden by any Qualifiers that follow this one. Thus the following will create Menu ``#+1" having the same settings as Menu ``#" apart from the Title:-

MENU  +1/CLONEDFROM= /TITLE="Title"

Note that the <menu_id> specified for this Qualifier must obey the syntax rules for Menu ids described for the MENU_ID Parameter.

/PROMPT=<text>

Text String to be displayed as a Menu Prompt. This will be converted to upper case unless it is enclosed in quotes. If it contains any embedded word separator characters (spaces, commas etc.) then it should also be enclosed in quotes. The Menu Prompt defaults to null (all spaces) if this Qualifier is absent of has no associated text string.

/STYLE=<style>

Overrides the default Text Style for the Menu Title and Prompt. The possible Style attributes are BLINK, BOLD, REVERSE and UNDERLINE and they may be specified using the following syntax:-

/STYLE=(BOLD,REVERSE,...)

\

Omitting the attributes will result in normal Text and the parentheses may be omitted if only a single attribute is desired.

/TITLE=<text>

Text String to be displayed as a Menu Title. This will be converted to upper case unless it is enclosed in quotes. If it contains any embedded word separator characters (spaces, commas etc.) then it should also be enclosed in quotes. The Menu Title defaults to null (all spaces) if this Qualifier is absent of has no associated text string.

/VIEWPORT=<id>

Specifies the Viewport within which the Menu is to be displayed in Viewport Mode. This defaults to the MENU Viewport if this Qualifier is absent or has no associated Value. The syntax of the Viewport ID is described in full for the VIEWPORT Command.

/X_ID=<x-cor>

Specifies the X Position (or Column) of the Button ID Field for Text Menus. A positive position will override the UIPACK default while a negative or zero position, or a missing value, will result in the UIPACK Default being retained.

/WIDTH_ID=<width>

Specifies the Width of the Button ID Field for Text Menus. A negative or zero Width, or a missing value, will result in the UIPACK Default being retained.

/X_BUTTON=<x-cor>

Specifies the X Position (or Column) of the Button Text Field for Text Menus. A positive position will override the UIPACK default that takes account of the width of the screen or viewport. A negative or zero position, or a missing value, will result in the UIPACK Default being retained.

/WIDTH_BUTTON=<width>

Specifies the Width of the Button Text Field for Text Menus. A negative or zero Width, or a missing value, will result in the UIPACK Default being retained.

/FLAG_BUTTON=<flag>

Specifies the truncation indication for descriptions that overflow the Button Text Field for Text Menus. The UIPACK default is for such descriptions to be terminated by ellipsis (...). This default may be overridden by specifying <flag> as FALSE, whereas a value of TRUE, or a missing value, retain the UIPACK default.

/X_RESPONSE=<x-cor>

Specifies the X Position (or Column) of the Response Text Field for Text Action Menus. A positive position will override the UIPACK default that takes account of the width of the screen or viewport. A negative or zero position, or a missing value, will result in the UIPACK Default being retained. Note that the /X_RESPONSE setting for an Action Menu is converted into the /X_VALUE setting for other Menus when cloning.

/WIDTH_RESPONSE=<width>

Specifies the Width of the Response Text Field for Text Action Menus. This is setup by default to be no greater than 1/3 of the width of the Screen (or Viewport within which the Menu is displayed). This Qualifier may be used to disable the display of the Response Text altogether (by specifying a negative width) or to override the UIPACK Default. A Width of Zero, or a missing value, will result in the UIPACK Default being retained. Note that the /WIDTH_RESPONSE setting for an Action Menu is converted into the /WIDTH_VALUE setting for other Menus when cloning.

/FLAG_RESPONSE=<flag>

Specifies the truncation indication for responses that overflow the response field for Text Action Menus. The UIPACK default is for such responses to be terminated by ellipsis (...). This default may be overridden by specifying <flag> as FALSE, whereas a value of TRUE, or a missing value, retain the UIPACK default. Note that the /FLAG_RESPONSE setting for an Action Menu is converted into the /FLAG_VALUE setting for other Menus when cloning.

/X_VALUE=<x-cor>

Specifies the X Position (or Column) of the Value Text Field for Text Menus. A positive position will override the UIPACK default that takes account of the width of the screen or viewport. A negative or zero position, or a missing value, will result in the UIPACK Default being retained. Note that the /X_VALUE setting for a non-Action Menu is converted into the /X_RESPONSE setting for Action Menus when cloning.

/WIDTH_VALUE=<width>

Specifies the Width of the Value Text Field for Text Menus. This is setup by default to be no greater than 1/3 of the width of the Screen (or Viewport within which the Menu is displayed). This Qualifier may be used to disable the display of the Value Text altogether (by specifying a negative width) or to override the UIPACK Default. A Width of Zero, or a missing value, will result in the UIPACK Default being retained. Note that the /WIDTH_VALUE setting for a non-Action Menu is converted into the /WIDTH_RESPONSE setting for Action Menus when cloning.

/FLAG_VALUE=<flag>

Specifies the truncation indication for values that overflow the value field for Text Menus. The UIPACK default is for such responses to be terminated by ellipsis (...). This default may be overridden by specifying <flag> as FALSE, whereas a value of TRUE, or a missing value, retain the UIPACK default. Note that the /FLAG_VALUE setting for a non-Action Menu is converted into the /FLAG_RESPONSE setting for Action Menus when cloning.

Qualifiers may be attached either to the Keyword or to the Menu ID and thus the following is legal:-

MENU/PROMPT="Menu Prompt"  +4/VIEWPORT= +2