PCL and Customization > User Interface and List Processor Functions > widget Function Descriptions
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
widget Function Descriptions
Widgets provide the user an opportunity to interact with Patran. User interaction with a widget is called an event. Widget callback functions in PCL will be called for a variety of widget events. The data passed to PCL for each widget type is described here. See User Interface Functions, 297 for a discussion of the events that lead to the widget callbacks. The arguments passed to the PCL callback function must be declared with the below datatype to avoid a runtime error.
 
Table 5‑1
Widget Type
Data Type
Description of Callback Data
button
 
No arguments are passed.
buttonicon
 
No arguments are passed.
cascade item
 
Does not register events.
databox
string[ ]
“GAIN”, “LOSE”, “CR”, or “WIDSET” (if appropriate ui_wid_set ( ) call has been made) depending on which event instigated the callback.
file
string[ ]
string[ ]
Complete pathname of file.
“OPEN” or “CANCEL”
form
 
Does not register events.
frame
 
Does not register events.
graph
 
Does not register events.
item
 
Does not register events.
itemicon
 
Does not register events.
label
 
Does not register events.
labelicon
 
Does not register events.
listbox
integer
string[ ]()
The number of selected items.
Label of the selected items in the listbox.
menu
string[ ]
Name of the selected menu item.
modalform
 
Does not register events.
option menu
string[ ]
Name of the currently selected item.
popup menu
string[]
Name of the selected item.
scroll frame
 
Does not register events.
select databox
string[ ]
“GAIN”, “LOSE”, “CR”, “VALUE_CHANGED”or “WIDSET” ( if a call to ui_wid_set 'VALUE' has been made), depending on which event initiated the callback.
select frame
 
No arguments are passed.
separator
 
Does not register events.
slide bar
real
string[ ]
Current value of the slide bar.
“VALUE_CHANGED” or “DRAG”
spread sheet
string[ ]
integer
integer
integer
integer
integer
“SELECTED”. To be expanded.
Starting selected column.
Starting selected row.
Ending selected column.
Ending selected row.
Selected layer.
switch
string[ ]
string[ ]
Name of the switch item changed.
“ON” or “OFF”, depending on whether the named switch item, argument #1, has just been turned on or off.
text
 
Does not register events.
toggle
logical
Value of toggle, TRUE or FALSE.
toggleicon
logical
Value of toggleicon, TRUE or FALSE.
color bar
widget
integer
integer
Widget ID of the color bar.
User data specified in the widget creation call.
Selected item.
color menu
widget
integer
integer
Widget ID of the color bar.
User data specified in the widget creation call.
New color value.