Widgets

Tutorial Toolkit Function Descriptions > User Interface > Widgets

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">

Widgets


ui_clear_focus	( wid )


Description:
Clear the input focus for a widget.
Input:
widget	wid	Pointer to the widget.
Output:
none

Example:

Please see ui_clear_focus (p. 330) in the MSC Acumen Toolkit - Code Examples.


ui_wid_restore_widget	( wid )


Description:
Restore the values for this widget and all child widgets.
Input:
widget	wid	Widget ID.
Output:
LOGICAL	<Return Value>	TRUE if no error.

Example:

Please see ui_wid_restore_widget (p. 355) in the MSC Acumen Toolkit - Code Examples.


ui_wid_save_widget	( wid )


Description:
Save the values for this widget and all child widgets.
Input:
widget	wid	Pointer to the widget.
Output:
LOGICAL	<Return Value>	TRUE if no error.

Example:

Please see ui_wid_save_widget (p. 357) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.select	( lbox_id, label )


Description:
Highlight a “name” in the listbox.
Input:
widget	lbox_id	ID of listbox to modify. This is the ID returned by a call to the PCL functions ui_listbox_items_create or uil_utils_listbox.create_list
STRING	label[]	Name in listbox to highlight. This list of names is the list of labels used by the PCL functions ui_listbox_items_create and uil_utils_listbox.create_list.
Output:
LOGICAL	<Return Value>	TRUE if no error.

Example:

Please see uil_utils_listbox.select (p. 382) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.select_none	( lbox_id )


Description:
Clear all highlighted names in the listbox.
Input:
widget	lbox_id	ID of listbox to modify.
Output:
LOGICAL	<Return Value>	TRUE if no error.

Example:

Please see uil_utils_listbox.select_none (p. 387) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.select_list	(list_box_id, label_list, list_count)


Description:
This function will select or highlight a list of names in a listbox.
Input:
widget	list_box_id	This value specifies the identifier of the listbox.
STRING	label_list[31](list_count)
		This value specifies the list of labels in the listbox that will be highlighted. These labels are defined when the listbox is created and are typically a maximum of 31 characters long.
INTEGER	list_count	This value specifies the number of labels specified by the input value label_list.
Output:
LOGICAL	<Return Value>	This function will return a value of TRUE if an error has not occurred and a value of FALSE if an error has occurred.
Error Conditions:
None.
Remarks:
None.

Example:

Please see uil_utils_listbox.select_list (p. 386) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.create_list	( lbox_id, labellist, listcnt )


Description:
Create a list of items in the listbox from the given names.
Input:
widget	lbox_id	ID of listbox to modify.
STRING	labellist[]()	List of names in listbox to create.
INTEGER	listcnt	Number of items in labellist.
Output:
none

Example:

Please see uil_utils_listbox.create_list (p. 369) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.append_list	( lbox_id, labellist, listcnt )


Description:
Append a list of items in the listbox from the given names.
Input:
widget	lbox_id	ID of listbox to modify.
STRING	labellist[]()	List of name items to append.
INTEGER	listcnt	Number of items in labellist.
Output:
none

Example:

See example for uil_utils_listbox.create_list, 142. See also uil_utils_listbox.append_list (p. 367) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.get_selected	( lbox_id, items, num )


Description:
Get the selected items in the listbox.
Input:
widget	lbox_id	ID of listbox to modify.
Output:
STRING	items [xx] (VIRTUAL)	Items selected. xx needs to be equal to or larger than the length of the largest item in the listbox.
INTEGER	num	Number of items selected.

Example:

Please see uil_utils_listbox.get_selected (p. 378) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.get_unselected	( lbox_id, items, num )


Description:
Get the unselected items in the listbox.
Input:
widget	lbox_id	ID of listbox to modify.
Output:
STRING	items [xx] (VIRTUAL)	Items selected. xx needs to be equal to or larger than the length of the largest item in the listbox.
INTEGER	num	Number of items selected.

Example:

Please see uil_utils_listbox.get_unselected (p. 380) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.get_all	( lbox_id, items, num )


Description:
Get all items in the listbox
Input:
widget	lbox_id	ID of listbox widget
Output:
STRING	items [VIRTUAL] (VIRTUAL)	Listbox items.
INTEGER	num	Number of items in listbox.

Example:

See example for uil_utils_listbox.create_list, 142. See also uil_utils_listbox.get_all (p. 376) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.delete_item	( lbox_id, name )


Description:
Delete a given item from the set of listbox items.
Input:
widget	lbox_id	Id of listbox to modify.
STRING	name[]	Name in listbox to delete.
Output:
LOGICAL	<Return Value>	TRUE if no error, FALSE if name does not exist.

Example:

See example for uil_utils_listbox.create_list, 142. See also uil_utils_listbox.delete_item (p. 370) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.delete_item_list	( lbox_id, nitems, itemlist )


Description:
Delete a list of given items from the listbox.
Input:
widget	lbox_id	Id of listbox to modify.
INTEGER	nitems	The number of items in the list.
STRING	itemlist[]()	Names in listbox to delete.
Output:
none

Example:

See example for uil_utils_listbox.create_list, 142. See also uil_utils_listbox.delete_item_list (p. 372) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.delete_selected	( lbox_id )


Description:
Deletes from the listbox the selected items.
Input:
widget	lbox_id	Id of listbox to modify.
Output:
none

Example:

Please see uil_utils_listbox.delete_selected (p. 374) in the MSC Acumen Toolkit - Code Examples.


uil_utils_listbox.select_all	( lbox_id )


Description:
Highlight all names in the listbox.
Input:
widget	lbox_id	Id of listbox to modify.
Output:
none

Example:

See example for uil_utils_listbox.select, 141. See also uil_utils_listbox.select_all (p. 384) in the MSC Acumen Toolkit - Code Examples.