Text frame descriptors

``Frame descriptors for text frame definition files'' lists the frame descriptors that can be used in a text frame definition file. None of these descriptors is required in a text frame definition file. If any are used they can be in any order, but they must precede the SLK descriptors. Note that the only kinds of descriptors in text frame definition files are frame descriptors and SLK descriptors. (Text frames do not have an equivalent to item or field descriptors.)

Note that text frames may also be defined, at least for simple needs, using the textframe command. This command can be used to reduce the number of text frame definition files needed in an application. See ``The textframe command'' for more information on using this short-cut.

Frame descriptors for text frame definition files

Descriptor	Default if not defined	Type	When referenced	Default frequency of evaluation
altslks	FALSE	Boolean	When frame is opened/updated	When frame is opened/updated
begrow	any	position	When frame is opened/updated	When frame is opened/updated
begcol	any	position	When frame is opened/updated	When frame is opened/updated
close	no default	null	When frame is closed	When frame is closed
columns	30	integer	When frame is opened/updated	When frame is opened/updated
done	close	command	When frame is closed	Whenever referenced
edit	FALSE	Boolean	When frame is opened/updated	When frame is opened/updated

Descriptor	Default if not defined	Type	When referenced	Default frequency of evaluation
framemsg	no default	string	When frame is opened/updated	When frame is opened/updated
header	no default	string	When frame is opened/updated	When frame is opened/updated
help	no default	command	When user asks for help	Whenever referenced
init	TRUE	Boolean	When frame is opened/updated	Whenever referenced
interrupt	inherited value*	Boolean	When an interruptible descriptor is evaluated	Whenever referenced
lifetime	longterm	string	When frame is opened, closed, made current, or made non-current	Whenever referenced
oninterrupt	inherited value*	command	After descriptor evaluation is interrupted	Whenever referenced
reread	FALSE	Boolean	When frame is opened/updated	Whenever referenced
rows	min(10,linesOfText)	integer	When frame is opened/updated	When frame is opened
text	no default	string	When frame is opened/updated	When frame is opened/updated
title	Text	string	When frame is opened	When frame is opened
wrap	TRUE	Boolean	When frame is opened/updated	When frame is opened/updated

``SLK descriptors for text frame definition files'' lists the SLK descriptors that can be used in a text frame definition file. When they are used in a text frame definition file, they must be the last descriptors in the file. The name and button descriptors must be defined, and name must be the first descriptor in each set of SLK descriptors.

SLK descriptors for text frame definition files

Descriptor	Default if not defined	Type	When referenced	Default frequency of evaluation
action	no default	command	When SLK is pressed	Whenever referenced
button	no default	integer	When frame is opened/updated	Whenever referenced
interrupt	inherited value*	Boolean	When SLK action descriptor is evaluated	Whenever referenced
name	no default	string	When frame is opened/updated	Whenever referenced
oninterrupt	inherited value*	command	After SLK action descriptor evaluation is interrupted	Whenever referenced

*

The value of interrupt and oninterrupt in any given set of descriptors is inherited from the next higher level in a precedence hierarchy. If these descriptors have not been defined anywhere in your application, interrupt defaults to FALSE and oninterrupt defaults to `message operation interrupted!`nop. (See ``Interrupt signal handling'' for more information.)