SATGUI Display Language (SAT/DL) Parameters

action

Action: Sets action for item.
Format: {name [parameter] [...]}
For example {update first_name last_name} will run the update action, with the values of the first_name and last_name items as parameters, when the action is invoked.
Used: addButton addButtons addEntries addEntry addMultiList setAction

alpha

Action: Sets entry item validation to accept alphabetic characters only.
Pattern: {^[a-zA-Z]+$}
Used: addEntries addEntry

alphanumeric|alphanum

Action: Sets entry item validation to accept alphabetic and numeric characters only.
Pattern: {^[a-zA-Z0-9]+$}
Used: addEntries addEntry

blue

Action: Sets item text colour to "blue".
Used: addLabel setMessage
See: red

buttondata

Action: Defines row layout of button items.
Format: {name options} {...}
The name and options are the same as for addButton. A null button item will display a gap of pad characters between Button Items.
Used: addButtons

center

Action: Label text will be center aligned within the label area. The default alignment is left (there is no specific left align option). If more than one alignment option is specified, then the last only is used.
Used: addEntry addLabel
See: right

columndata (Entries)

Action: Defines column/row (grid) layout of entry items.
Format: {column_1_size {name ?size? options} {...}} {column_n_size {name ?size? options} {...}}
"column_n_size" is in the same format as the Entry Item size parameter. The label size specifed in "column_n_size" will be used for all Entry Items in the column.
A null entry item will display a gap equal to the size of one Entry Item in the grid.
Used: addEntries

columndata (List)

Action: Defines column layout of Multi Column Listbox.
Format: {label,size,?justify? ...}
The column title is derived from the label (See Name Format). The column size is the width in characters. By default the column will be left aligned. Justify options are "numeric" and "right". Numeric justification lines up on the decimal point. If there is no decimal point, numbers are right aligned, text left aligned.
Used: addMultiList

copy(?data_items?)

Action: Copies data from multi-list columns into data items.
Format: column_1_item,column_2_item,column_3_item,...
The data from column 1 of the multi-list is copied to the first data item in the list, and so on. If there is a column which is not to be copied to a data item, then a null data item name must be used.
Used: addMultiList

date

Action: Sets entry item validation to accept date format string only.
Pattern: Depends on date format.
Used: addEntries addEntry

date_format

Action: Sets date format to be used for entry item validation.
Formats: mm/dd/yy
mm/dd/yyyy
dd/mm/yy
dd/mm/yyyy
mm.dd.yy
mm.dd.yyyy
dd.mm.yy
dd.mm.yyyy
Used: setDateFormat
See: date

disabled

Action: Item update is disallowed (effectively read only). The default value is determined by the current state. Use setState to override the effect of the state.
Used: addButton addButtons addCheckButtons addEntries addEntry addRadioButtons
See: normal

focus

Action: Gives focus (positions cursor) to the entry. If more than one entry is given focus, then the last created is used.
Used: addEntries addEntry

exit

Action: Exit (logout) application.
Used: addButton addButtons

groove

Action: Sets relief style to "groove".
Used: addBorder setRelief

group

Action: Sets menubar group name.
Used: newScreen setGroup

group(?groups?)

Action: Sets list of groups for which menu item is enabled.
Format: ?+|-?group_1,?+|-?group_2,?+|-?group_3,...
The optional "+" or "-" prefix specifies that the item should always be normal/disbaled regardless of the current state.
Used: addMenu

horizontal

Action: Line up components of item horizonally (default vertical).
Used: addCheckButtons addRadioButtons

integer|int

Action: Sets entry item validation to accept numeric characters only.
Pattern: {^[0-9]+$}
Used: addEntries addEntry

ipaddress|ip

Action: Sets entry item validation to accept internet IP address format string only.
Pattern: {^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,3}$}
Used: addEntries addEntry

item (Menu)

Action: Sets menubar menu item name.
Used: addMenu

labels

Action: Sets list of labels to be used by command.
Format: {?+?label_1 ?+?label_2 ...}
The optional "+" label prefix is used to indicate that the Check/Radio button is activated.
Used: addCheckButtons addRadioButtons

left

Action: Left justify label/text.
Used: addEntries addBorder addMultiList

menu

Action: Sets menubar menu name.
Used: addMenu

money

Action: Sets entry item validation to accept a "money" format (numeric with 2 decimal places) string only.
Pattern: {^[0-9]+[.][0-9]{2}$}
Used: addEntries addEntry

name

Action: Gives name to item. Item names must be unique for a given display. Item labels/titles are derived from the item name (See Name Format).
Used: action addBorder addButton addCheckButtons addData addEntry addLabel addMultiList addRadioButtons addValidation remove setAction

noborder

Action: Sets item border to 0 (zero).
Used: addButton addButtons addLabel

normal

Action: Item update is allowed. The default value is determined by the current state. Use setState to override the effect of the state.
Used: addButton addButtons addCheckButtons addEntries addEntry addRadioButtons
See: disabled

numeric|num

Action: Sets entry item validation to accept numeric characters with/without decimal only.
Pattern: {^[0-9]+[.]?[0-9]*$}
Used: addEntries addEntry

options

Action: List of options to be used by command.
Used: addBorder addButton addCheckButtons addData addEntry addLabel addMultiList addRadioButtons setMessage setRelief setState setTitle

outline

Action: Draw outline around Item. The relief style can be set using setRelief. The default relief style is "groove".
Used: addButton addCheckButtons addEntry addLabel addMultiList addRadioButtons

pad

Action: Sets pad width in characters between columns/row items.
Used: addButtons addEntry

parameters

Action: Sets list of parameters to be used by command.
Used: action

pattern

Action: Sets pattern (TCL format regular expression) to be used for entry item validation.
Used: addValidation

position

Action: Sets position of top left of display item(s).
Format: xpos,ypos
The "x" position is in columns (from zero), where one column is the average width of a character in the default font used for a label. The "y" position is in rows (from zero), where one row is the line spacing in the default font used for a label.
Used: addBorder addButton addButtons addCheckButtons addEntries addEntry addLabel addMultiList addRadioButtons

raised

Action: Sets relief style to "raised".
Used: addBorder setRelief

red

Action: Sets item text colour to "red".
Used: addLabel setMessage
See: blue

right

Action: Right justify label/text.
Used: addEntries addBorder addMultiList

safe

Action: Sets data item to "safe". Safe data items are not deleted by clear.
Used: addData

secret

Action: Sets entry item to display "*" for each character entered.
Used: addEntries addEntry

size (border/screen)

Action: Sets the size (width and height) of a border/screen.
Format: widthxheight
The "width" is in columns, where one column is the average width of a character in the default font used for a label. The "height" position is in rows, where one row is the line spacing in the default font used for a label.
Used: addButton addButtons

size (button)

Action: Sets the size (width) of a button item.
Format: width
The width is in columns, where one column is the average width of a character in the default font used for a label.
Used: addButton addButtons

size (multi-list)

Action: Sets the size (lines) of a multi-list item.
Format: lines
The number of data lines to be displayed (without scrollbar).
Used: addMultiList

state

Action: Sets item state to current state.
Used: addButton addButtons addCheckButtons addRadioButtons

sunken

Action: Sets relief style to "sunken".
Used: addBorder setRelief

title

Action: Displays title at top left of item. Item titles are derived from the item name (See Name Format).
Used: addBorder addCheckButtons addRadioButtons

validate

Action: Causes all entry item validations to be performed when action is invoked.
Used: addButton addButtons addEntries addEntry addMultiList

validate(?prefix?)

Action: Causes validations for all entry items prefixed with prefix to be performed when action is invoked. A null prefix will cause validation of all entry items without a prefix.
Used: addButton addButtons addEntries addEntry addMultiList

validation

Action: Sets validation to be used for item. There is a selection of predefined validations (See below). Use addValidation to add additional pattern based validations.
Predefined: alpha=Alphabetic only.
alphanumeric|alphanum=Alphabetic and numbers only.
date=Valid date.
integer|int=Numbers only.
money=Number with two decimal spaces.
numeric|num=Number with or without a decimal.
ipaddress|ip=Internet IP address.
Used: addEntries addEntry

value

Action: Sets value for item.
Used: setItem setItems


Copyright © 2001 Adrian Davis.