Form specification files / Form item attributes |
The WIDGET attribute specifies the type of graphical widget to be used for the field.
WIDGET = "identifier"
The WIDGET attribute defines the type of widget to be used for the form field.
This attribute is used with CONFIG, CLASS and INCLUDE attributes, to parameter the field widget.
The identifier widget type is case sensitive, only uppercase letters are recognized.
When you use the WIDGET attribute, the form cannot be properly displayed on character based terminals, it should only be displayed on graphical front ends.
Symbol | Effect | Other attributes |
---|---|---|
Canvas | The field is used as a drawing area. Field must be declared as FORMONLY field. |
None. |
BUTTON | The field is presented as a button widget with a label. | CONFIG: The unique parameter defines the key to be
sent when the user clicks on the button. Button text is defined in configuration files or from the
program with a DISPLAY TO instruction. For example: CONFIG = "Control-z" |
BMP | The field is presented as a button with an image. | CONFIG: First parameter defines the image file to
be displayed, second parameter defines the key to be sent when the user clicks on the button. For example: CONFIG = "smiley.bmp F11" Important: Image files are not centralized on the machine where the program is executed;
image files must be present on the Workstation. See front end specific documentation for more
details.
|
CHECK | The field is presented as a checkbox widget. It can be used with the CLASS attribute to change the behavior of the widget. | CONFIG: First and second parameters define the values corresponding respectively to the state "Checked" / "Unchecked" of the check box, while the third parameter defines the label of the checkbox. For example: CONFIG = "Y N Confirmation" If the text part must include spaces, add {} curly braces around the text: CONFIG = "Y N {Order validated}" If the CLASS attribute is used with the "KEY" value, the first and second parameters defines the keys to be sent respectively when the checkbox is "Checked" / "Unchecked", and the third parameter defines the label of the checkbox as with normal checkbox usage. For example (line breaks added for document readability): CLASS = "KEY", |
COMBO | The field is presented as a combobox widget. It can be used with the CLASS attribute to change the behavior of the widget. | INCLUDE: This attribute defines the list of
acceptable values that will be displayed in the combobox list. For example (line breaks added for document readability): INCLUDE = Important: The INCLUDE attribute cannot hold value range definitions,
because all items must be explicitly listed to be added to the combobox list.
The following example is not supported: INCLUDE = (1 TO 10) |
FIELD_BMP | The field is presented as a normal editbox, plus a button on the right. | CONFIG: The first parameter defines the image file to be displayed in the button; the second parameter defines the key to be sent when the user clicks on the button. For example: CONFIG = "combo.bmp Control-z" |
LABEL | The field is presented as a simple label, a read-only text. | None. |
RADIO | The field is presented as a radiogroup widget. | CONFIG: Parameter pairs define respectively the
value and the label corresponding to one radio button. For example (line breaks added for document readability): CONFIG = If the radio texts must include spaces, add {} curly braces around the texts (line breaks added for document readability): CONFIG = "AA {First option} If the CLASS attribute is used with the value "KEY", the first element of each pairs represents the key to be sent when the user selects a radio button. For example (line breaks added for document readability): CLASS = "KEY", |
The following list of widgets can be enabled or disabled from programs with a DISPLAY TO instruction:
If you display an exclamation mark in such fields, the button is enabled, but if you display a star (*), it is disabled:
DISPLAY "*" TO button1 # disables the button DISPLAY "!" TO button1 # enables the button
DISPLAY "Click me" TO button1 # Sets text and enables the button
DISPLAY "smiley.bmp" TO button1 # Sets image and enables the button
Image files are not centralized on the machine where the program is executed; image files must be present on the Workstation. See front end specific documentation for more details.
DISPLAY "Firstname" TO l_firstname # Sets text of the label field
The fields declared with the WIDGET="Canvas" attribute can be used by the program as drawing areas. Canvas fields must be defined in the LAYOUT section. A set of drawing functions are provided to fill canvas fields with graphical elements.