This section describes the TCL commands designed to be used in PDFs.
The following rules apply to the commands described in this section:
The format of the command descriptions below is:
Words in uppercase in the format are the command name, parameter names, or other keywords (e.g. "ELSE"), and are to be typed as shown (not necessarily in uppercase, however).
In cases where the form of the command is not "proc invocation form," that is, when the form is not "PROC P1=A P2=B ..." the "Parameters" section is omitted.
Parameter values shown in the format section in uppercase are literals and must be typed as shown; values in lowercase indicate the type or use of the value.
BODY signals the start of the procedure body.
FORMAT
BODY
BREAK causes an immediate loop exit.
BREAK
EMIT will transfer status data to the parent Terminal Monitor.
EMIT $SFI=integer $SKEY=string
FOR variable-name = for-list
loop body
END-FOR
GETPAR + PARMS=variable-name-list PREFACE=preface-strings
A list of variable names. The variables named must be declared in the declaration section of the procedure.
An override for the standard dynamic tutor preface ("Parameters requested: ..."). PREFACE may be multi-valued, in which case each component becomes a line in the preface.
GLOBALS HELP=help-location
global definitions
local declarations
global references
END-GLOBALS
The name of the file containing the help information for this PDF and the defined global variables. If this parameter is omitted, TAE looks for a file of type "HLP" with the same name and library as the PDF.
A value of "*" for "help-location" indicates that the help text is to be found immediately following the END-GLOBALS command.
GOTO LABEL = label
The label of the next line to execute.
LOOP
IF (X=4)
GOTO THERE !invalid: violates nesting
ELSE
THERE> I = I+1
END-IF
END- LOOP
The statement label "_DEFAULT>" is a reserved statement label that matches any GOTO. This feature is useful when using the GOTO statement as a "dispatcher" as in the following example:
procedure
subcmd s1
...
end-subcmd
subcmd s2
...
end-subcmd
subcmd s3
...
end-subcmd
subcmd s4
...
end-subcmd
body
goto @_subcmd ! dispatch on active subcommand
s1>
! process subcommand s1
s2>
! process subcommand s2
_default>GOTOs that are executed from an _ONFAIL command do not honor the _DEFAULT label. This rule permits exception processing to bypass a section of dispatch labels.
The search for the target of a GOTO is in the forward direction. Because of this, several DEFAULT labels may be used in the same procedure. Consider the following coding sequence:
goto @target1 l1>... l2>... _default>... ... goto @target2 l1>... l2>... _default>...
The IF/ELSE construct provides conditional execution based on the evaluation of the logical expression.
IF (logical-expression)
if-part
ELSE
else-part
END-IF
IF/ELSE-IF causes one of several groups of commands to be executed, depending on the evaluation of the respective conditions.
FORMAT
IF (logical-exp-1)
part-1
ELSE-IF (logical-exp-2)
part-2
. . .
ELSE
else-part
END- IF
IF (x = 1)
LET OPTION ="A"
ELSE-IF (x = 2)
LET OPTION = "B"
ELSE-IF (x = 3)
LET OPTION = "C"
ELSE
WRITE "Unrecognized option. Try another."
END- IF
LET variable-name = expression
FORMAT
LOCAL NAME = variable-name or name-list
TYPE = INTEGER or
REAL or
(STRING, maximum size of string) or
FILE
COUNT = integer:integer
INITIAL = (integer,...) or
(real,...) or
(string,...)
VALID = (integer:integer,...) or
(real:real,...) or
(string, string,...)
ACCESS = IN or
OUT or
INOUT or
NOCHECK
QUALS = proc-name or
"TCL command"
PARAMETERS
INITIAL (optional)
The initial value. This value must be of the type and count allowed by the TYPE and COUNT attributes in the declarations.
USAGE NOTES
NEXT
NOP
DEFCMD Q NOP !define Q to be NOP P
PARM NAME = parameter-name or name-list
TYPE = INTEGER or
REAL or
(STRING, size-of-string) or
NAME or
FILE or
VOID
COUNT = integer:integer
DEFAULT = (integer,...) or
(real,...) or
(string,...)
VALID = (integer:integer,...) or
(real:real,...) or
(string, string,...)
ACCESS = IN or
OUT or
INOUT or
NOCHECK or
EVENT
QUALS = proc-name or
"TCL command"
or
PARM-PAGE with the same parameters as PARM.
Parameter-name. The name must follow the rules for TCL standard names. (See Section 3.2.2.)
A list of names may also be supplied. Each name in the list receives the same parameter definition. (Defining multiple names in one PARM statement is considerably more efficient than using a separate PARM statement for each name.)
The TYPE of the parameter; permitted types are INTEGER, REAL, STRING, FILE, KEYWORD, NAME, and VOID. If the type is STRING, then TYPE may have two elements: the first element is "STRING", and the second optional element is the maximum string length. The default maximum length is 132 characters. See Section 2.3.2 for a description of NAME parameters. (Output parameters must have type NAME.) A type of VOID is used by TAE Plus internally.
The COUNT specifies the minimum and maximum number of values that the parameter may assume. If COUNT is single-valued then the value becomes the minimum and maximum. If COUNT is of the form "n:m", the first value is the minimum and the second the maximum; no spaces are permitted after the n or before the m. If COUNT is not specified, a count of one is assumed.
The maximum count is 300.
COUNT is also used to declare that a variable is nullable: if the minimum count is zero, then the variable is nullable. In addition, the COUNT may specify a non-zero range and the value zero, e.g., "COUNT = (0, 5:10)" declares a nullable variable for which substantial values must have a count between five and ten.
The default value assumed if the proc is invoked with no value for the named parameter. If DEFAULT is not specified, the parameter is a mandatory parameter (that is, the user must specify a value on the proc invocation line or in tutor mode.)
The DEFAULT values must be of the type and count allowed by the TYPE and COUNT attributes specified in this declaration. If a default is specified for a multi-valued parameter, all elements must be specified.
The DEFAULT for a parameter of type NAME is resolved in the context local to the PDF containing the DEFAULT. When the proc is invoked, however, a NAME reference on the proc invocation line is resolved in the context of the invoking proc.
The DEFAULT parameter on a PARM command defining a parameter with qualifiers may not be used to set values for the parameter's qualifiers. For example, a line of the form:
PARM x QUALS=y DEFAULT=25|7,8|
is not accepted.
The VALID values restrict the allowable set of values that a parameter may assume. If the parameter is an integer or a real then the VALID list consists of a list of inclusive ranges. If the parameter is a string, then the list is a list of acceptable values.
A range is specified as a:b, meaning "a through b inclusive." No spaces are permitted after the "a" and before the "b". If ":b" is omitted, then "a" is the only permitted value.
A VALID string must contain 132 or fewer characters. The VALID list is required for parameters of type KEYWORD.
If the access is IN or INOUT, the parameter must have type FILE, and TAE verifies that the file exists. If the access is NOCHECK, no verification is made. (Note that file verification is not done if the global $FILEVER is set to "NO".) See the "Usage Notes" for the use of ACCESS=EVENT.
The QUALS is the name of the proc that contains the declarations for qualifiers of the parameter. See Usage note #13 for more information.
USAGE NOTES
If, for example, VALID for a parameter is (DUMP, NODUMP), some valid values for the parameter are "DU" , , "DUMP" , or "N" , "NO", etc.
If a user specifies an abbreviation, the value of the parameter is converted to the full string as specified in VALID. If, in the example above, the user had specified "d", the value of the parameter would be translated to "DUMP".
parm x quals="y|restore=y|z=2"
parm y quals="y|restore=yy|z=3"
Thus, parms with the same qualifier set do not have to have the same defaults. The following rules apply to QUALS:
For details on parameter qualifiers, see Section 2.3.4.
PARMSET/END-PROC bracket a parameter set PDF.
FORMAT
PARMSET HELP=help-location NAME=proc-name
variable declarations
END-PROC
or
PARMSET-COMPILED and the same as above.
The name of the file containing the help information on this PDF and its parameters. If this parameter is omitted, TAE looks for a "HLP" type file with the same name and library as the PDF.
A value of "*" for HELP indicates that the help text is to be found immediately following the END-PROC command.
The parameter set name of an internal proc.
PROCEDURE/END-PROC bracket a procedure.
PROCEDURE HELP=help-location +
NAME=proc-name OPTIONS=interrupt-opt
declarations
BODY
procedure body
END-PROC
or
PROCEDURE-COMPILED and same as above.
The name of the file containing the help information on this procedure and its parameters. If this parameter is omitted, TAE looks for a "HLP" type file with the same name and library as the PDF.
A value of "*" for HELP indicates that the help text is to be found immediately following the END-PROC command.
The proc name of an internal proc.
With "OPTIONS=NOINTERRUPT", the associated procedure cannot be aborted, even if "DISABLE-INTERRUPT" is in effect. SELFTUTOR is described in detail in Section 2.12 of this manual.
With "OPTIONS=COMPRESSTUTOR", a more compact form of the traditional TAE tutor display will be used. The line spacing between parameters is omitted, allowing up to 18 scalar parameters on a 24-line display.
PROCEDURE
!Internal proc for parameter qualifiers
PARMSET NAME INTPROC
PARM BAND INTEGER
END-PROC
!COPY - Use IMGCOPY primitive
PARM INFILE FILE ACCESS = IN QUALS = INTPROC
PARM OUTFILE FILE ACCESS = OUT QUALS = INTPROC
LOCAL I INTEGER
BODY
FOR INFILE.BAND = 1, 2, 3, 4, 5, 6
IMGCOPY INFILE, OUTFILE, @INFILE.BAND
END-FOR
END-PROC
PROCESS EXECUTE = file-spec +
HELP = help-location +
OPTIONS = interrupt-opt +
NAME = proc name
declarations
END-PROC
or
PROCESS-COMPILED and same as above.
The name of the executable image file for the process to execute. If EXECUTE is not specified, then the executable image file is assumed to be in the same library as the PDF, with a name the same as the proc name (type EXE).
The name of the file containing the help text for this proc and its parameters. If this parameter is omitted, TAE looks for the HELP information in a "HLP" type file with the same name and library as the PDF.
A value of "*" for the HELP parameter indicates that the help text is to be found immediately following the END-PROC command.
The most common setting for OPTIONS is INTERRUPT. If OPTIONS is NOINTERRUPT, the TAE interrupt mode is suppressed, and the user will not be able to abort the proc. SELFTUTOR is described in detail in Section 2.12 of this manual.
With "OPTIONS=COMPRESSTUTOR", a more compact form of the traditional TAE tutor display will be used. The line spacing between parameters is omitted, allowing up to 18 scalar parameters on a 24-line display.
The proc name of an internal proc.
PROCESS ! IMGCOPY PARM IN FILE ACCESS = IN PARM OUT FILE ACCESS = OUT PARM BAND INTEGER RANGE = 1:6 END-PROC
PUTMSG writes a TCL message to the standard output device and the session log, in standard message format.
The text part of the message. If the message contains the "%" character it must be preceded by another "%".
The message key for the message.
LET FILE = "IMG"
PUTMSG "File &FILE not found.", +
KEY="GP-NOFILE"
will produce the following output on the standard output device:
[GP-NOFILE] File 1MG not found.
LET FILE = "IMG"
PUTMSG-TRACE "File &FILE not found.", +
KEY= "GP-NOFILE"
will produce the following output on the standard output device:
[GP-NOFILE] File IMG not found.;
proc 'example', line n.
PUTMSG "%%r a"
will produce the following output:
[TAE-NOKEY] %r a
RECVAR VARIABLE=(vl, v2, v2...) JOB=jobname
VARIABLE (optional)
The list of TCL variables to be received.
JOB (optional)
Name of the job transmitting the message. The default is "ALL", meaning RECVAR will receive from any job.
USAGE NOTES
EXAMPLE
This example shows a (trivial) server that adds one to the value of a variable.
Procedure !simple server
refgbl $parent !parent's job name
local _job string
local value integer
body enable-recvar !enable server queue
sendvar job=@$parent !synchronize with parent
loop !begin serving
recvar (_job, value) !receive request
let value = value + 1 !operate on request
sendvar value job=@_job !return to requestor
end-loop
end-proc
REFGBL declares that the named globals are used in the proc.
FORMAT
REFGBL NAME = (name-1, name-2, ...)
The name of the variable referenced. The maximum number of names is 50.
EXAMPLES
RETURN terminates procedure execution.
FORMAT
RETURN $SFI=integer $SKEY=string
The value to which the $SFI global is to be set upon procedure exit.
The value to which the $SKEY global is to be set upon procedure exit.
USAGE NOTES
EXAMPLES
SENDVAR packages a collection of TCL variables into a message (a TAE V- block) and sends the message to another job.
FORMAT
SENDVAR VARIABLE=(vl, v2, v3, ...) JOB=jobname
List of TCL variables to be placed in the message.
The name of the JOB to receive the message.
USAGE NOTES
SENDVAR (A, B, "input string") JOB=XYZ !invalid
The following example shows two TAE procs. The first proc is a simple server; the second proc submits the server for asynchronous execution and sends two requests to the server.
procedure !simple server
refgbl $parent !parent's job name
local _job string
local value integer
body
enable-recvar !enable server queue
sendvar job=@$parent !tell parent we're ready
loop
recvar (_job, value) !receive request
let value = value + 1 !operate on request
sendvar value job=@_job !return to requestor
end-loop
end-proc
procedure !request service from server
local value integer initial=1
body
enable-recvar
server |run=(async, myserver)| !start the above server
recvar job=myserver !wait till server ready
sendvar value job=myserver !request service
recvar value job=myserver
display value
sendvar value job=myserver !request service
recvar value job=myserver
display value
end-proc
The STOP command terminates the current procedure and all higher level active procedures.
FORMAT
STOP
PARAMETERS
USAGE NOTES
After the STOP command is executed, TAE proceeds to request a new command on the primary level. (The relationship between STOP and RETURN in FORTRAN is similar to the STOP and RETURN in TCL).
SUBCMD/END-SUBCMD declares a set ofvariables (usually parameters) to be associated with the named subcommand.
FORMAT
PARAMETERS
NAME
The name of the subcommand, a TCL standard name. The name must not have more than twelve characters.
USAGE NOTES
EXAMPLES
PROCESS !TAPE UTILITY
PARM TRIES INTEGER DEFAULT=1
SUBCMD-DEFAULT READ
PARM RECORDS INTEGER
END-SUB
SUBCMD FILEMARK
PARM NUMFILES INTEGER
END-SUB
END-PROC
SWITCH sets the switch bits in the implicit global $SWITCH.
FORMAT
SWITCH VALUE=hexadecimal-value
PARAMETERS
The value to be placed into $SWITCH.
USAGE NOTES
EXAMPLES
The WPT subcommands specified on the following pages give TAE Plus users the ability to prototype WPT application programs using TCL.
TAE Plus allows user interface designers to design "point-and-click" user interfaces of the kind popularized by Apple's Macintosh. It includes a user interface design tool (the WorkBench), a subroutine package that makes use of the WorkBench's output (WPT), and the WPT TCL commands described on the following pages. See the "TAE Plus Overview" manual for introductory material on TAE Plus; the "TAE Plus User Interface Developer's Guide" for information on how to prototype with the WPT command; and the "TAE Plus (language) Reference Manual (UNIX, VMS)" for information on the WPT subroutine package.
WPT subcommands correspond to functions in the WPT subroutine package, as follows:
| WPT Package Function | WPT Subcommand |
|---|---|
| Wpt_AddEvent | none |
| Wpt_AddTimer | none |
| Wpt_BeginWait | WPT-BEGINWAIT |
| Wpt_CCInit | none |
| Wpt_CheckEvent | none |
| Wpt_CloseDisplay | none |
| Wpt_CloseItems | none |
| Wpt_EndWait | WPT-ENDWAIT |
| Wpt_Finish | none |
| Wpt_GetConstraintSensitivity | none |
| Wpt_GetHelpStyle | none |
| Wpt_GetIntgConstraints | none |
| Wpt_GetItemSensitivity | none |
| Wpt_GetMenu | none |
| Wpt_GetMenuEntryPath | none |
| Wpt_GetPanelState | none |
| Wpt_GetRealConstraints | none |
| Wpt_GetStringConstraints | none |
| Wpt_Init | WPT-INIT |
| Wpt_InsertMenuEntries | none |
| Wpt_ItemWindow | none |
| Wpt_KeyinCheckForNuLLInput | none |
| Wpt_MenuUpdate | none |
| Wpt_MissingVal | none |
| Wpt_NextEvent | WPT-EVENT |
| Wpt_NewPanel | WPT-PANEL |
| Wpt_OpenDisplay | none |
| Wpt_PanelDisplayId | none |
| Wpt_PanelErase | WPT-ERASE |
| Wpt_PanelMessage | WPT-MESSAGE |
| Wpt_PanelMessageNoBlock | none |
| Wpt_PanelMissingVal | none |
| Wpt_PanelReset | none |
| Wpt_PanelWindow | none |
| Wpt_PanelTopWindow | none |
| Wpt_PanelWidgetld | none |
| Wpt_ParmReject | WPT-REJECT |
| Wpt_ParmRejectNoBlock | none |
| Wpt_ParmUpdate | WPT-PARMUPDATE |
| Wpt_Pending | none |
| Wpt_RemoveEvent | none |
| Wpt_RemoveMenuEntries | none |
| Wpt_RemoveTimer | none |
| Wpt_Rehearse | WPT-REHEARSE |
| Wpt_SetConstraintSensitivity | none |
| Wpt_SetIntg | none |
| Wpt_SetIntgConstraints | none |
| Wpt_SetItemSensitivity | none |
| Wpt_SetHelpStyle | none |
| Wpt_SetMenu | none |
| Wpt_SetMenuSensitivity | none |
| Wpt_SetNoValue | none |
| Wpt_SetPanelState | WPT-SETPANELSTATE |
| Wpt_SetReal | none |
| Wpt_SetRealConstraints | none |
| Wpt_SetString | none |
| Wpt_SetStringConstraints | none |
| Wpt_SetTimeOut | (timeout parm for WPT-EVENT) |
| Wpt_ViewUpdate | WPT-VIEWUPDATE |
WPT-BEGINWAIT - Set Wait Indicator
WPT-BEGINWAIT sets the "wait indicator." Use of this command will indicate to the user that the specified panel(s) is temporarily in a wait state and is not available for interaction. The indication to the user of this wait state is that the cursor becomes an hourglass icon.
FORMAT
WPT-BEGINWAIT PANEL parameter-name
PARAMETERS
Name(s) of the panel(s) to receive the wait indicator. If the panel parameter is "ALL", then all panels receive the wait indicator.
WPT-ENDWAIT - Remove Wait Indicator
WPT-ENDWAIT Removes the "wait indicator." See the description of WPT- BEGINWAIT for an explanation of the wait indicator.
FORMAT
WPT-ENDWAIT PANEL = parameter-name
PARAMETERS
WPT-ERASE - Erase a Panel from the Screen
FORMAT
WPT-ERASE PANEL = panel-name
PARAMETERS
Name of panel to be erased. The name of a panel is established at the time of panel creation with WPT-PANEL. If the PANEL parameter is "ALL", all panels are erased from the screen.
WPT-EVENT - Wait for the next WPT event
WPT-EVENT waits for the next WPT event and delivers event information. When an event is received from a panel, the target variable identified by WPT-PANEL is updated to reflect the current values on the screen.
FORMAT
WPT-EVENT PARM = parm-name
PANEL = panel-name
TIMEOUT = seconds
PARAMETERS
The name of a TCL string variable to receive the name of the parameter that generated the event.
The name of a TCL string variable to receive the name of the panel that generated the event.
Time to wait before generating a "timeout" event. See Usage Notes. The default, 0, implies no timeout.
USAGE NOTES
EXAMPLE
!
! Sample procedure showing use of timeout.
! Par files are assumed to have been created (by the WB).
!
procedure
local (parm, panel)
body
disable-force_lower !permit upper/lower file names
let _onfail = "continue"
!*************************************
wpt-init
!*************************************
local VV quals="example_v.par" ! view variable
local TV quals="example_t.par" ! target variable
!*************************************
! put up the panel and wait for events from help or exit
! or timeout
!
wpt-panel target=TV view=VV ! display Main Menubar
loop
wpt-event parm=parm pane1=pane1 timeout=10
goto &"panel"_&"parm" ! dispatch on panel/parm
example_help> !" help" parm
wpt-message p="&panel" m="Help button"
next
example_exit>
wpt-erase all ! "exit" parm
return
next
WPT_EVENT_TIMEOUT>
wpt-message "" "Come on, DO SOMETHING!"
next
end-loop
cleanup> wpt-erase all
enable-force_lower !return to lowercase-only file names
end-proc
WPT-INIT - Initialize the WPT package
WPT-INIT initializes the WPT package. Should be executed before any other WPT TCL command.
FORMAT
WPT-INIT HOST = host
DISPLAY = display
PROTOCOL = protocol
PARAMETERS
The name of the display's host node. "UNIX", the default, is a special string that implies the local node.
Display number. (The main console is 0, default.)
DECnet or TCP.
USAGE NOTES
(DISPLAY is of the form "host:display.screen" where "host" and "display" are the same as the parameters to WPT-INIT, the colon implies "TCP", and "SCREEN" is a screen number for the display (default 0).)
WPT-MESSAGE - Create a dialog box
FORMAT
WPT-MESSAGE PANEL = panel-name
MESSAGE = message
PARAMETERS
Name of the panel to which the dialog box is to be attached. The name of a panel is established at the time of panel creation with WPT-PANEL.
String to be displayed in the dialog box. (The dialog box also contains a NOTED icon used to dismiss the dialog box.)
USAGE NOTES
WPT-MESSAGE displays the message and returns after the user selects the NOTED icon. This is known as "blocking." No other TCL command will execute until the message display is dismissed.
WPT-PANEL - Create a WPT panel
WPT-PANEL creates a WPT panel and enables the receipt of events from the
FORMAT
WPT-PANEL VIEW = view
TARGET = target
PANEL = panel-name
STATE = state
PARAMETERS
Name of a TCL variable that, through qualifiers, contains a parameter set defining the view parameters for the panel. The qualifiers define the presentation and position of the panel.
TARGET (optional)
Name of a TCL variable that, through qualifiers, contains a parameter set defining the target parameters of the panel. When the user sets a value through the panel, the proper qualifier is updated. Target qualifiers are only updated then WPT-EVENT receives an event from the panel; thus, a panel typically has at least one ACCESS=EVENT parameter.
For a parameter that has a set of discrete constraints (created using the WorkBench's "Constraints" option for an item), WPT automatically creates a TAE variable "qualifier" named _SELECT. _SELECT is an integer containing the TCL index (starting with 1) of the parameter's value selection from the constraint list. A value of 0 for _SELECT implies no valid selection exists for the string parameter. The programmer accesses this index value by using Vm_Find to request the variable P._SELECT, where P is the string parameter name. (If _SELECT already exists, then WPT updates the index.)
If this parameter is omitted, then there are no parameters associated with the window. In this case, TAE decorates the panel according to the view parameters. Such panels are used for graphic output by the application. Note that no WPT-EVENT events are generated from such panels.
PANEL (optional)
The name to be assigned to the panel. This name is used to reference the panel from the other WFT commands. If panel is omitted, then the name defined by view.PANEL.NAME becomes the panel name, where "view" is the name of the view TCL variable.
STATE (optional)
Defines the creation state of the panel. The valid choices are:
WPT-REHEARSE - Simulate Data Driven Object Updates
WPT-REHEARSE turns on or off the simulated update of all Data Driven Objects (DDOs) on all visible application panels. The update interval and style of updating may be specified. DDOs on panels made visible after this call are automatically added to the internal list of DDOs to update. Iconic and invisible panels will not have their DDOs updated. When a panel is erased, its DDOs will be removed from the inernal list.
The DDOs will cycle through values defined using their own minimum and maximum values. Each color or picture range will be used.
FORMAT
WPT-REHEARSE INTERVAL = interval
ORDER = order
CYCLES = cycles
PARAMETERS
Time duration, in milliseconds, between updates of the data driven objects.
ORDER
Defines the starting value and the direction of each update. Valid values are:
| "Min-Max" | Start at minimum value and increase to the maximum value. Restart at minimum on repeat. | |
| "Max-Min" | Start at maximum value and decrease to the minimum value. Restart at maximum on repeat. | |
| "Min-Max-Min" | Start at minimum value, increase to maximum then decrease to the minimum. Continue on repeat. (DEFAULT) | |
| "Max-Min-Max" | Start at maximum value, decrease to minimum then increase to the maximum. Continue on repeat. |
Defines the repetition option. Valid values are:
| "repeated" | Continue cycling as defined by the ORDER. (DEFAULT) | |
| "once" | Cycle once for each DDO then stop. |
WPT-SETPANELSTATE - Change the current display state of a panel
WPT-SETPANELSTATE changes the current display state of a panel.
FORMAT
WPT-SETPANELSTATE PANEL = panel-name
STATE = state-name
PARAMETERS
Name of the panel to have its state changed.
Specifies the new state of a panel. It is often called after a determination of the current panel state using WPT-GETPANELSTATE. See WPT-PANEL for a description of each panel state. Valid states are:
WPT-PARMUPDATE - Update a Parm Display
WPT-PARMUPDATE updates a parameter display. The parameter display may be given a new value, a new selection or a new valid list. The new value, new valid list, or new selection must have already been set. The "LET" TCL command can be used for this purpose.
FORMAT
WPT-PARMUPDATE PANEL = panel-name
PARM = parameter name
PARAMETERS
Name of the panel where an updated parameter is displayed.
Name of a parameter to be updated.
EXAMPLE
Assume you have a panel "p1" with a DDO item called "stretcher". Your TCL procedure might have:
local p1V quals="p1_v.par" ! view variable
local p1T quals="p1_t.par" ! target variable
WPT-PANEL view=p1V target=p1T panel=p1 ! display panel
... ! other TCL commands
loop ! main event loop
... ! dispatching
"p1_stretcher">
let p1T.stretcher = 1.0
WPT-PARMUPDATE panel=p1 parm=stretcher
... ! other TCL commands
WPT-REJECT - Generate a rejection message
FORMAT
WPT-REJECT PANEL = panel-name
PARM = parm-name
MESSAGE = message
PARAMETERS
Name of the panel containing the parameter to be rejected. The name of a panel is established at the time of panel creation with WPT-PANEL.
Name of the target parameter whose new value is to be rejected.
String to be displayed in the dialog box. (The dialog box also contains a NOTED action button used to dismiss the dialog box.)
WPT-VIEWUPDATE - Update the view of an item
WPT-VIEWUPDATE updates the view of an item on an existing panel.
FORMAT
WPT-VIEWUPDATE PANEL = panel-name
PARM = parm-name
VIEW = view
PARAMETERS
Name of the panel containing the parameter whose view is to be changed. The name of a panel is established at the time of panel creation with WPT-PANEL.
Name of the parameter whose view is to be changed.
The name of a TCL variable whose qualifiers define the new display characteristics for the PARM. Note, this is the view for the PARM, not the view for the panel.
USAGE NOTES
WRITE writes the specified string to the standard output device.
FORMAT
WRITE STRING = string
PARAMETERS
The string that is to be written to the standard output device.
USAGE NOTES
EXAMPLES