PCL and Customization > Broken, Obsolete, Modified and New Functions > User Interface and List Processor Functions (Chapter 5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
User Interface and List Processor Functions (Chapter 5)
 
lp_sub_str_ent_type
Issue:Not supported in Patran.
Resolution:Removed the function description from the documentation.
Type:Obsolete.
Description:
 
 
This function concatenates substrings from the list processor string according to entity type keyword. List processor functionaliy is not envoqued (the strings is not interpreted).
Input:
 
 
STRING
in_list[]
This value specifies the list processor string of entities.
STRING
keyword[]
This value specifies the keyword for extracting entity substrings. Ex: “Point”, “Curve”, “Surface”, “Solid”, “Node”, Element”, “MPC”.
INTEGER
case_sensitive
This value specifies 0 (FALSE) not to be case sensitive, 1 (TRUE) otherwise.
Output:
 
 
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
 
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
Example:
INTEGER status, case_sensitive
STRING in_list[100], keyword[32], return_list[VIRTUAL]
 
in_list = “Node 1 Curve 4 Node 2:3 Element 5”
keyword = “Node”
case_sensitive = 0   /* FALSE */
$   for which return_list=”Node 1 2:3”
$      notice that we do not obtain “Node 1:3”
status = lp_sub_str_ent_type(in_list, keyword, case_sensitive, @
            return_list)
IF (0 < status) THEN
   msg_to_form(status, 4, 0, 0, 0.0, ““)
ELSE
   IF (0 > status) THEN
      /* Error information already displayed */
   ELSE
      write_line(“return_list =”, return_list)
   END IF
END IF
 
Issue:Argument description changed.
Resolution:Updated the function description in the body of the document..
Type:Modified.
 
Original Description Information:
(parent, callback, x, y, width, num_rows, filter_label, filter_mask, dirs_label, files_label, selection_label, selection, ok_label, filterbutton_label, cancel_label )
Function:
 
 
Creates a file selection widget.
Input:
 
 
WIDGET
parent
Parent widget ID. Must be a frame, a form or a modal form.
STRING
callback
Name of the PCL function that is called for an event in this widget. The function must be in the class in which the widget is created. Use ““ if events for this widget are not of interest.
NUMERIC
x
X location of the widget in inches relative to the parent.
NUMERIC
y
Y location of the widget in inches relative to the parent.
NUMERIC
width
Width of the file widget, in inches.
INTEGER
num_rows
Number of items to display in the files and directory listboxes.
STRING
filter_label
Label describing the filter databox.
STRING
filter_mask
Used to specify which files appear in the listbox.
STRING
dirs_label
Label to appear above the listbox containing the directories.
STRING
files_label
Label to appear above the listbox containing the files relevant to the filter_mask.
STRING
selection_label
Label describing the selection databox.
STRING
selection
Filename to appear in the databox labeled selection_label. Also highlights in listbox, if present.
STRING
ok_label
Label describing the OK button.
STRING
filterbutton_label
Label describing the Filter button.
STRING
cancel_label
Label describing the Cancel button.
Output:
 
 
WIDGET
<Return Value>
Widget ID. NULL if the widget could not be created.
Error Conditions:
 
None.
 
 
 
Comments:
The PCL callback function will be called when the OK button or the Cancel button is selected. Selecting the OK button instructs the UIMS to pass two arguments; the complete pathname of the selected file and “OPEN.” Selecting the Cancel button instructs the UIMS to pass two arguments; the first is not used and will be set to ““, and “CANCEL.”
 
New Description Information:
(parent, callback, x, y, width, num_rows, filter_label, filter_mask, dirs_label, files_label, selection_label, selection, ok_label, filterbutton_label, cancel_label )
Description:
 
 
This function will create a file selection form.
Input:
 
 
WIDGET
parent_id
This value specifies a widget identifier for the parent widget of this form.
STRING
callback_func[]
This value specifies the name of the PCL function that will be called for an event representing a form event. This call back function must be a member of the class in which this widget is created.
REAL
x_location
This value specifies the x axis location of the file widget in pixels relative to the upper left corner of the parent widget.
REAL
y_location
This value specifies the y axis location of the file widget in pixels relative to the upper left corner of the parent widget.
REAL
width
This value specifies the width of the widget in pixels, excluding the border.
INTEGER
number_rows
This value specifies the number of rows that will be displayed in files and directory list boxes of the form.
STRING
filter_label[]
This value specifies the title used on the form to describe the filter data box.
STRING
filter_mask[]
This value specifies the path and filter mask that determines which files will be displayed in the file list box.
STRING
directory_label[]
This value specifies the text used on the form to describe the directory data box.
STRING
files_label[]
This value specifies the text used on the form to describe the files data box.
STRING
selection_label[]
This value specifies the text used on the form to describe the selection data box.
STRING
file_name[]
This value specifies a file name to be displayed in the selection data box. If the file name specified is listed in the file list box the file list box entry will be highlighted.
STRING
ok_label[]
This value specifies the text used to label the “OK” button.
STRING
filterbutton_label[]
This value specifies the text used to label the “Filter” button.
STRING
cancel_label[]
This value specifies the text used to label the “Cancel” button.
Output:
 
 
WIDGET
<Return Value>
This function returns avalid form widget identifier when executed successfully and a value on WIDGET_NULL to indicate a change an error.
Error Conditions:
 
None.
Remarks:
The PCL callback function will be called when the “OK” or the “Cancel button” is selected. This PCL callback fuction should be designed to accept two strings as arguments and to return nothing. When the “OK” button is selected the callback function will have the complete path and name of the selected file passed as the first argument and the work “OPEN” passed as the second argument. When the “Cancel” button is selected an empty string or ““ will be passed as the first argument and the work “CANCEL” will be passed as the second argument.
The following input values can be manipulated through a call to the function ui_wid_set():
 
 
Input Value Name
Corresponding
ui_wid_set() Parameter Name
 
 
 
 
callback_function
NAME
 
x_location
X
 
y_location
Y
 
width
WIDTH
 
number_rows
None available.
 
filter_label[]
FILTERLABEL
 
filter_mask[]
DIRECTORY and FILTER
 
directory_label[]
None available.
 
files_label[]
FILESLABEL
 
selection_label[]
FILENAMELABEL
 
file_name[]
FILENAME
 
ok_label[]
OKBUTTONLABEL
 
filterbutton_label[]
FILTERBUTTONLABEL
 
cancel_label[]
CANCELBUTTONLABEL
 
Issue:Argument description changed.
Resolution:Updated the function description in the body of the document.
Type:Modified.
 
Original Description Information:
ui_wid_set
( widget, parm, value )
Description:
 
 
Sets a widget parameter.
Input:
 
 
WIDGET
widget
Widget whose parameter is to be set.
STRING
parm
Name of parameter to set.
SEE BELOW
value
Value of parameter.
Output:
 
 
LOGICAL
<Return Value>
TRUE if no error.
Error Conditions:
 
None.
 
 
Comments:
The datatype of the value must be that of the widget's parm. For example, for a call to:
ui_wid_set (button, “ENABLE”, logical_variable);
the third argument must be declared as a logical. For the call:
ui_wid_set (button, “X”, real_variable);
the third argument must be declared as a real.
Possible parm names:
Button parameters:
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if this widget is to be displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“HEIGHT” (REAL) - Height of the widget.
“LABEL” (STRING) - Text to be displayed.
“NAME” (STRING) - Name of the widget.
“WIDTH” (REAL) - Width of the widget.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
Cascade Item parameters:
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if this widget is to be displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“ACCELERATOR” (STRING) - Accelerator key to drop the menu.
“LABEL” (STRING) - Text to be displayed.
“NAME” (STRING) - Name of the widget.
“MNEMONIC” (STRING) - Key mnemonic to drop the menu.
Color Bar parameters:
“DISPLAY” or “VISIBLE” (LOGICAL) - TRUE if this widget is displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“ITEMCOLOR” (INTEGER(2)) - Item color of the widget. The ui_wid_set or ui_wid_get call must be passed an array of size two. The first element of the carry should contain the item number. On a call to ui_wid_set the second element of the array should contain the index of the color desired. A call to the function ui_wid_get will return the color index in the second element.
“CURRENTITEM” (INTEGER) - Currently depressed color button of the colorbar.
“NITEMS” (INTEGER) - Number of color buttons in the colorbar.
“LABEL” (STRING) - Label of the accompanying label widget. Invalid if colorbar is not created with a label.
Color Menu parameters:
“DISPLAY” or “VISIBLE” (LOGICAL) - TRUE if this widget is displayed.
“COLOR” (INTEGER) - Color of the widget.
“LABEL” (STRING) - Label of the accompanying label widget. Invalid if colorbar is not created with a label.
“LABEL” (STRING) - Label of the accompanying label widget. Invalid if colorbar is not created with a label.
“WIDTH” (REAL) - Width of the widget.
“HEIGHT” (REAL) - Height of the widget.
Databox and Selectdatabox parameters:
“APPENDVALUE” (STRING) - Append the string onto the current value.
“COLUMNS” (INTEGER) - Width of the widget as the number of visible characters. Valid only for databoxes.
“DATATYPE” (STRING) - Name of the type of data that will be accepted by the databox. 
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if the widget is to be displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“FILTER_ENTITY” - Valid only for selectdataboxes.
“HEIGHT” (REAL) - Height of the widget.
“LABEL” (STRING) - Label of the databox.
“MAXNUMCHARS” (INTEGER) - Upper limit of characters allowed in the databox. Valid only for databoxes.
“NAME” (STRING) - Name of the widget.
“PROMPT” (STRING) - Prompt to be displayed when the selectdatabox has focus and if the datatype displays a selection menu. Valid only for selectdataboxes.
“READONLY” - Valid only for databoxes.
“SINGLESELECT” (LOGICAL) - Used only for selectdataboxes. TRUE for the selectdatabox if only one pick is to appear in the selectdatabox.
“UNSELECT” (LOGICAL) - FALSE if all text is to be selected.
“VALUE” (type defined by the databox's datatype) - Current value of the databox.
“WIDSETNOTIFY” (LOGICAL) - TRUE if the callback function is to be called for ui_wid_set calls.
“WIDTH” (REAL) - Width of the widget.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
File parameters:
“CANCELBUTTONLABEL” (STRING) - Label to appear in the cancel button.
“DIRECTORY” (STRING) - Pathname of the directory.
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if this widget is to be displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“FILENAME” (STRING) - Name of the file to appear in the file databox.
“FILENAMELABEL” (STRING) - Label to appear above the file databox.
“FILESLABEL” (STRING) - Label for the files databox.
“FILTER” (STRING) - Mask to be used when filtering files.
“FILTERBUTTONLABEL” (STRING) - Label for the filter button.
“FILTERLABEL” (STRING) - Label for the filter databox.
“FILTERPATH” (STRING) - Value of the filter databox.
“HEIGHT” (REAL) - Height of the widget.
“NAME” (STRING) - Name of the widget.
“OKBUTTONLABEL” (STRING) - Label for the OK button.
“WIDTH” (REAL) - Width of the widget.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
Form and modalform parameters:
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if widget is currently displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“HEIGHT” (REAL) - Height of widget.
“LABEL” (STRING) - Label to appear in the banner of the form. 
“NAME” (STRING) - Name of the widget.
“WIDTH” (REAL) - Width of widget.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
Frame, Scrollframe, and Selectframe parameters:
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if the frame’s children that have been specifically left ON via a ui_wid_set() are to be displayed.
“DISPLAYALL or VISIBLEALL” (LOGICAL) - TRUE if the frame’s children are to be displayed regardless of whether the children have been displayed or hidden via a ui_wid_set().
“ENABLE” (LOGICAL) - TRUE if frames children are to be selectable.
“HEIGHT” (REAL) - Height of widget.
“LABEL” (STRING) - String to appear above the frame.
“NAME” (STRING) - Name of the widget.
“TOGGLEVALUE” - Valid only for selectframes.
“WIDTH” (REAL) - Width of widget.
“WORKINGHEIGHT” - Valid only for scrollframes.
“WORKINGWIDTH” - Valid only for scrollframes.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
Item parameters:
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if widget is currently displayed. Invalid for listbox items.
“ACCELERATOR” (CHAR) - Specifies CRTL<char> sequence to invoke item. Item need not be visible for accelerator to work. Invalid for listbox items.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable. Not valid for listbox items.
“ICON” (STRING) - Name of the icon used in lieu of the label. See ui_itemicon_create (p. 326).
“LABEL” (STRING) - Text to be displayed.
“MNEMONIC” (CHAR) - Specifies key to invoke item. Item must be visible for mnemonic to work. Only valid for menu items.
“NAME” (STRING) - Name of the widget.
“VALUE” (LOGICAL) - Value of the widget. Invalid for menubar items.
Label parameters:
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if this widget is to be displayed.
“ENABLE” (LOGICAL) - TRUE if the label is in bold print.
“HEIGHT” (REAL) - Height of the widget.
“ICON” (STRING) - Name of the icon to be displayed in lieu of the label. Valid only for widgets created with ui_labelicon_create.
“LABEL” (STRING) - Text to be displayed.
“NAME” (STRING) - Name of the widget.
“WIDTH” (REAL) - Width of the widget.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
Listbox parameters:
“BOTTOMITEM” (STRING) - Label of the item that is to be the bottom visible item.
“BOTTOMPOS” (INTEGER) -Number of the items to appear at the bottom of the listbox.
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if this widget is to be displayed.
“DUPLICATEITEM” (LOGICAL) - TRUE if this listbox allows items having the same value to appear more than once.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“HEIGHT” (REAL) - Height of the widget.
“LABEL” (STRING) - Label to describe the listbox.
“NAME” (STRING) - Name of the listbox.
“ROWS” (INTEGER) - Number of rows that can be visible in the displayed listbox.
“SELECTIONTYPE” (STRING) - Selection type of the listbox. “SINGLE”, “MULTIPLE”, “BROWSE”, “EXTEND”, or “READONLY”.
“TOPITEM” (STRING) - Label of the item that is to be the top visible item.
“VALUE” (STRING ARRAY) - Selected items of the widget.
“WIDTH” (REAL) - Width of the widget.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
“UNSELECT” (LOGICAL) - FALSE if all items are to be selected.
Menu parameters:
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“LABEL” (STRING) - Label of the menu.
“MNEMONIC” (CHAR) - Specifies key to invoke menu.
Menubar parameters:
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if this widget is to be displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
Optionmenu parameters:
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if this widget is to be displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“LABEL” (STRING) - Label of the optionmenu.
“NAME” (STRING) - Name of the optionmenu.
“VALUE” (STRING) - Currently displayed item label of the optionmenu.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
Selectdatabox parameters:
See Databox and Selectdatabox parameters:, 855.
Separator:
“DISPLAY or VISIBLE”
“HEIGHT” (REAL) - Height of the widget.
“WIDTH” (REAL) - Width of the widget.
“X” (REAL) - X location of the widget.
“Y” (REAL) -Y location of the widget.
Slidebar parameters:
“DECPOINTS” (INTEGER) - Number of digits to appear after the decimal point. Used only when show_value (see ui_slidebar_create (p. 356)) is TRUE.
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if this widget is to be displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“LABEL” (STRING) - Text to be displayed.
“MAXLABEL” (STRING) - Label to appear at the upper end of the slidebar.
“MAXVALUE” (REAL) - Maximum allowable value.
“MINLABEL” (STRING) - Label to appear at the lower end of the slidebar.
“MINVALUE” (REAL) - Minimum allowable value.
“NAME” (STRING) - Name of the widget.
“VALUE” (REAL) - Value of the widget.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
Spreadsheet:
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if widget is currently displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“LABEL” (STRING) - Main label to be displayed with the widget.
“UNSELECT” (LOGICAL) - TRUE to unselect all cells. FALSE does nothing.
Switch parameters:
“COLUMNS” (INTEGER) - Number of columns of items that the switch should contain.
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if this widget is to be displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“LABEL” (STRING) - Label to be displayed with the widget.
“NAME” (STRING) - Name of the widget.
“VALUE” (STRING) - Name of the item that is currently on. If “NONE”, all switch items will be turned OFF.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
Text:
“APPENDVALUE” (STRING) - String to append onto the current value.
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if widget is currently displayed.
“EDITABLE” (LOGICAL) - TRUE if the user may alter the text value.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“HEIGHT” (REAL) - Height of the widget.
“MAXNUMCHARS” (INTEGER) - Maximum number of characters that can be contained in the widget.
“NAME” (STRING) - Name of the widget.
“POSITION” (INTEGER) - Location of the insertion bar in the text box.
“UNSELECT” (LOGICAL) - FALSE if all text is to be selected.
“VALUE” (STRING) - Text that appears in the widget. To include a newline character, place “\n” in the string.
“WIDTH” (REAL) - Width of the widget.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
Toggle parameters:
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if this widget is currently displayed.
“ENABLE” (LOGICAL) - TRUE if this widget is selectable.
“ICON” (STRING) - Name of icon to be used, valid only when created with ui_toggleicon_create.
“LABEL” (STRING) - Text to be displayed to describe the toggle.
“NAME” (STRING) - Name of the widget.
“VALUE” (LOGICAL) - Value of the widget.
“WIDTH” (REAL) - Width of the widget.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
Window parameters:
“DISPLAY or VISIBLE” (LOGICAL) - TRUE if widget is currently displayed.
“ENABLE” (LOGICAL) - TRUE if this window is selectable.
“HEIGHT” (REAL) - Height of widget.
“LABEL” (STRING) - String to appear in the window’s banner.
“NAME” (STRING) - Name of the window.
“WIDTH” (REAL) - Width of widget.
“X” (REAL) - X location of widget.
“Y” (REAL) - Y location of widget.
 
New Description Information:
ui_wid_set
( widget_id, parameter_name, parameter_value )
Description:
 
 
This function will set a widget parameter value.
Input:
 
 
WIDGET
widget_id
This value specifies the identifier of the widget that will be modified.
STRING
parameter_name[]
This value specifies the name of the paramter to be modified. See below for more information.
DYNAMIC_ILRS
parameter_value
This value specifies the array of flags used to identify the specific entity types to be exported. See the remarks below for more information.
Output:
 
 
LOGICAL
<Return Value>
This function returns a value of TRUE when executed successfully and a non TRUE value to indicate a change in status or an error.
Error Conditions:
 
This function may return a nonzero value if an error occurs.
Remarks:
The data type of the input value parameter_value must match the data type specified for the input value paramter_name as listed in the tables below. The parameter names that can be used and the functions used to create the widgets with which they can be used are listed in the tables below.
Button parameters:
 
Data Type
Parameter Name
Description
LOGICAL
DISPLAY or VISIBLE
TRUE if this widget is to be displayed.
LOGICAL
ENABLE
TRUE if this widget is selectable.
REAL
HEIGHT
Height of the widget.
STRING
LABEL
Text to be displayed.
STRING
NAME
Name of the widget.
REAL
WIDTH
Width of the widget.
REAL
X
X location of widget.
REAL
y
Y location of widget.
Cascade Item parameters:
 
Data Type
Parameter Name
Description
LOGICAL
DISPLAY or VISIBLE
TRUE if this widget is to be displayed.
LOGICAL
ENABLE
TRUE if this widget is selectable.
STRING
ACCELERATOR
Accelerator key to drop the menu.
STRING
LABEL
Text to be displayed.
STRING
NAME
Name of the widget.
Color Bar parameters:
 
Data Type
Parameter Name
Description
LOGICAL
DISPLAY or VISIBLE
TRUE if this widget is to be displayed.
LOGICAL
ENABLE
TRUE if this widget is selectable.
INTEGER(2)
ITEMCOLOR
Item color of the widget. The ui_wid_set or ui_wid_get call must be passed an array of size two. The first element of the carry should contain the item number. On a call to ui_wid_set the second element of the array should contain the index of the color desired. A call to the function ui_wid_get will return the color index in the second element.
INTEGER
CURRENTITEM
Currently depressed color button of the colorbar.
INTEGER
NITEMS
Number of color buttons in the colorbar.
STRING
LABEL
Label of the accompanying label widget. Invalid if colorbar is not created with a label.
Color Menu parameters:
 
Data Type
Parameter Name
Description
LOGICAL
DISPLAY or VISIBLE
TRUE if this widget is to be displayed.
INTEGER
COLOR
Color of the widget.
STRING
LABEL
Label of the accompanying label widget. Invalid if colorbar is not created with a label.
REAL
WIDTH
Width of the widget.
REAL
HEIGHT
Height of the widget.
Databox and Selectdatabox parameters:
 
Data Type
Parameter Name
Description
STRING
APPENDVALUE
Append the string onto the current value.
INTEGER
COLUMNS
Width of the widget as the number of visible characters. Valid only for databoxes.
STRING
DATATYPE
Name of the type of data that will be accepted by the databox.
LOGICAL
DISPLAY or VISIBLE
TRUE if this widget is to be displayed.
LOGICAL
ENABLE
TRUE if this widget is selectable.
 
FILTER_ENTITY
Valid only for selectdataboxes.
REAL
HEIGHT
Height of the widget.
STRING
LABEL
Label of the databox.
INTEGER
MAXNUMCHARS
Upper limit of characters allowed in the databox. Valid only for databoxes.
STRING
NAME
Name of the widget.
STRING
PROMPT
Prompt to be displayed when the selectdatabox has focus and if the datatype displays a selection menu. Valid only for selectdataboxes.
 
READONLY
Valid only for databoxes.
LOGICAL
SINGLESELECT
Used only for selectdataboxes. TRUE for the selectdatabox if only one pick is to appear in the selectdatabox.
LOGICAL
UNSELECT
FALSE if all text is to be selected.
(type defined by the databox's datatype)
VALUE
Current value of the databox.
LOGICAL
WIDSETNOTIFY
TRUE if the callback function is to be called for ui_wid_set calls.
REAL
WIDTH
Width of the widget.
REAL
X
X location of widget.
REAL
Y
Y location of widget.
File Parameters:
See the ui_file_create() function description for more information.
 
Data Type
Parameter Name
Description
STRING
CANCELBUTTONLABEL
This value specifies the text used to label the “Cancel” button. See the input value cancel_label in the ui_file_create() function description for more information.
STRING
DIRECTORY
This value specifies the path which is used together with the filter mask specified with the input variable parameter_name value FILTER to determine which files and directories are displayed in the form. See the parameter_name value FILTERPATH for more information. See the input value filter_mask in the ui_file_create() function description for more information.
LOGICAL
ENABLE
This value specifies, when set to TRUE, that the file form can be selected, is active, and can be used for input. If this value is set to FALSE, the form will be grayed out and cannot be selected and used for input.
STRING
FILENAME
This value specifies a file name to be displayed in the selection databox. If the file name specified is listed in the file list box the file list box entry will be highlighted. See the input value file_name in the ui_file_create() function description for more information.
STRING
FILENAMELABEL
This value specifies the text used on the form to describe the selection databox. See the input value selection_label in the ui_file_create() function description for more information.
STRING
FILESLABEL
This value specifies the text used on the form to describe the files databox. See the input value files_label in the ui_file_create() function description.
STRING
FILTER
This value specifies the filter mask which is used together with the path specified with the input variable parameter_name value DIRECTORY to determine which files and directories are displayed in the form. See the parameter_name value FILTERPATH for more information.See the input value filter_mask in the ui_file_create() function description for more information.
STRING
FILTERBUTTONLABEL
This value specifies the text used to label the “Filter” button. See the input value filterbutton_label in the ui_file_create() function description.
STRING
FILTERLABEL
This value specifies the title used on the form to describe the filter databox. See the input value filter_label in the ui_file_create() function description.
STRING
FILTERPATH
This value sets the path and filter mask value in the filter databox and determines what will be displayed in the directory and files databoxes. This parameter_name value combines the operations of the parameter_name values DIRECTORY and FILTER. See the input value filter_mask in the ui_file_create() function description for more information.
REAL
HEIGHT
This value specifies the height of the widget in inches, excluding the border.
STRING
NAME
This value specifies the name of the PCL function that will be called for an event representing a form event. This call back function must be a member of the class in which the ui_file_create() widget is created. See the input value callback_func in the ui_file_create() function description for more information.
STRING
OKBUTTONLABEL
This value specifies the text used to label the “OK” button. See the input value ok_label in the ui_file_create() function description for more information.
STRING
WIDTH
This value specifies the width of the widget in inches, excluding the border. See the input value width in the ui_file_create() function description for more information.
REAL
X
This value specifies the x axis location of the file widget in inches relative to the upper left corner of the parent widget. See the input value x_location in the ui_file_create() function description for more information.
REAL
Y
This value specifies the y axis location of the file widget in inches relative to the upper left corner of the parent widget. See the input value y_location in the ui_file_create() function description for more information.
Form and modalform parameters:
 
Data Type
Parameter Name
Description
LOGICAL
DISPLAY or VISIBLE
TRUE if this widget is currently displayed.
LOGICAL
ENABLE
TRUE if this widget is selectable.
REAL
HEIGHT
Height of the widget.
STRING
LABEL
Label to appear in the banner of the form.
STRING
NAME
Name of the widget.
REAL
WIDTH
Width of the widget.
REAL
X
X location of widget.
REAL
y
Y location of widget.
Frame, Scrollframe, and Selectframe parameters:
 
Data Type
Parameter Name
Description
LOGICAL
DISPLAY or VISIBLE
TRUE if the frame’s children that have been specifically left ON via a ui_wid_set() are to be displayed.
LOGICAL
DISPLAYALL or VISIBLEALL
TRUE if the frame’s children are to be displayed regardless of whether the children have been displayed or hidden via a ui_wid_set().
LOGICAL
ENABLE
TRUE if frame’s children are to be selectable.
REAL
HEIGHT
Height of the widget.
STRING
LABEL
String to appear above the frame.
STRING
NAME
Name of the widget.
 
TOGGLEVALUE
Valid only for selectframes.
REAL
WIDTH
Width of the widget.
 
WORKINGHEIGHT
Valid only for scrollframes.
 
WORKINGWIDTH
Valid only for scrollframes.
REAL
X
X location of widget.
REAL
y
Y location of widget.