Command: identbox

Syntax

identbox { <message> }

Description

Interactively examine atables for identifier details.

Parameters

• <message>
  Text for the Action command box. This may be changed interactively (see Notes below). If omitted, the string value ’List’ is used.

Switches

• -ic
  Open the menu box iconic, or iconise the menu box if it is not already iconised.

• -pos=<screen_xy>
  X,Y screen position for the menu box. The default is 150,150.

• -tb
  Display the window menu icon in the Windows taskbar. The default behavior is not to display it in the taskbar but only to display it on the desktop when minimized. This switch has no meaning on Unix systems.

Notes

This command displays an interactive identifier menu box. If such a menu box is already displayed, no action is taken. The menu box is divided into three sections:

1. Action - An interactive command box containing an operation to be performed on the Current Identifier. This is a stanza value. Any occurrence of $1 within the stanza is substituted by the current identifier name. If no $1 is present within the stanza, the current identifier name is appended to the text.

Whenever the Apply button within the menu bar is pressed, the stanza is executed. If the stanza is empty, no action is taken.

2. Filter - A Filter command box, a Type Mask command box, three scrollable lists (Atables, Types and Identifiers), a Current Identifier command box, and Identifier Type information text field.

• Filter command box - contains an atable and wild pattern. Its value may be changed by overtyping.

• Type Mask command box - contains an identifier type name, or * for any. The value may be changed. A wild pattern other than * is not permitted.

• Atables list - a scrollable list. Selecting one of its entries changes the atable part of the Filter but not the wild pattern. Double clicking applies the filter using the wild pattern and type mask to produce the Identifiers list.

• Types list - a scrollable list containing all current identifier types in all atables. Selecting one of its entries changes the value in Type Mask. Double clicking applies the filter using the wild pattern and type mask to produce the Identifiers list.

• Identifiers list - a scrollable list containing all identifiers which match the pattern in Filter. Selecting one of its entries displays the full name of the selected identifier in the Current Identifier command box. Double clicking an entry executes the Apply button as well.

• Current Identifier command box - displays the currently selected identifier to which the Action stanza is applied whenever the Apply button is pressed.

• Identifier Type text - monitors the type and array size of the current selected identifier. A * indicates an array of variable length.

3. Menu Bar - Four menu buttons: Apply, Filter, Reset and Close.

• Apply button - applies the current Action stanza to the Current Identifier.

• Filter button - applies the current Filter to produce identifier names which appear in the Identifiers list.

• Reset button - recreates the Atables and Types lists. This is useful when modelling commands have created and deleted atables and types since the menu box was last used. The menu box is not updated automatically.

• Close button - deletes the menu box. Interaction with the menu box is available only when the system is in polling mode, i.e. when all windows and menus are available for selection.

See Also