Print Page as PDF
FIELD EDITOR - EN~DIR0() ICR (1016)

FIELD EDITOR - EN~DIR0()    ICR (1016)

Name Value
NUMBER 1016
IA # 1016
DATE CREATED 1994/10/17
CUSTODIAL PACKAGE VA FILEMAN
CUSTODIAL ISC San Francisco
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DIR0
NAME FIELD EDITOR - EN~DIR0()
GENERAL DESCRIPTION 
Kernel needs to use the screen-oriented field editor
for the character based GUI emulation module.
STATUS Active
DURATION Till Otherwise Agreed
ID DIR0
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
EN 
This procedure initiates a screen-oriented read.  The
editing window appears in reverse video.  On exit, the field editor writes the
final text in high intensity.
VARIABLES TYPE VARIABLES DESCRIPTION
ROW Input 
The $Y position of the editing window.  The default
value is 0.
COL Input 
The $X position of the first column of the editing
window.  The default is 0.
WIDTH Input 
The width (number of characters) of the editing
window.  The default value is IOM-COL-1.
HEIGHT Input 
The height (number of lines) of the editing window.
The default value is 1.  If HEIGHT is greater than 1, the editing window will
not scroll horizontally.
DEF Input 
The text to initially display in the editing window.
The default value is null.
MAX Input 
The maximum number of characters that can be entered
into the editing window.  If HEIGHT is 1, the default value is 245 and the
editing window can scroll horizontally.  If HEIGHT is greater than 1, MAX can
be no larger than WIDTH*HEIGHT-1.
IP Input 
The initial location of the cursor (the Insertion
Point) within the default answer DEF.  The default value is 1.
MAP Both 
This input array can be used to disable or override
the default key sequences of the field editor, or to define customized key
sequences with associated associated entry points.  This array is passed by
reference, and its contents are changed by the call.
FLAGS Input 
Control the way field editor operates.  The values
and effects are: K   Keep screen handling variables.  Makes subsequent calls
more efficient.  P   Don't Paint the answer upon exit.  T   On exit, turn
Terminators on and Echo off.  W   On exit, keep autoWrap mode off, type ahead
on, and right margin at 0.  r   Right justify the answer upon exit.
ANSWER Both 
The text entered by the user.  If a time-out occured,
ANSWER is equal to the DEF input parameter.
CODE Both 
This variable consists of one or two up arrow
(^)-pieces.  The first ^-piece of CODE is a mnemonic code that indicates the
key(s) the user pressed to terminate the field editor.  The second ^-piece of
CODE is 1 if the user made any modifications to the default value, even if the
net result of series of modifications leaves the value effecitvely unchanged.
If no modi- fications were made, the second ^-piece of CODE is 0.  (This info
corresponds to the MWAPI CHANGED element attribute.)
UPDATE 
This procedure can be called from within the entry
points defined in the MAP input variable to EN^DIR0.  It can be used to change
the value of the current answer and the cursor position within the current
answer.
VARIABLES TYPE VARIABLES DESCRIPTION
NEW_VALUE Input 
The new value of the current answer.  If this
parameter is not passed in, then the current answer is unchanged.
NEW_IP Input 
The insertion point within NEW_VALUE.  If NEW_IP is
not passed in, then the insertion point is not changed.  If NEW_IP is less
than 1, then a value of 1 is assumed.  If NEW_IP is greater than the length of
NEW_VALUE plus 1, a NEW_IP value of $L(NEW_VALUE)+1 is assumed.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC
KERNEL Oakland