TmList(3Tm)							   TmList(3Tm)

NAME    [Toc]    [Back]

     TmList - the List widget class

SYNOPSIS    [Toc]    [Back]

     xmList  pathName [options]

DESCRIPTION    [Toc]    [Back]

     This is the tcl binding to	the Motif List widget.

CLASSES    [Toc]    [Back]

     The class name for	resource files is XmList. Resources are	inherited from
     TmPrimitive, TmCore. Methods are inherited	from TmCore.

RESOURCES    [Toc]    [Back]

     The new resources are

	  automaticSelection
	  doubleClickInterval
	  itemCount
	  items
	  listMarginHeight
	  listMarginWidth
	  listSizePolicy
	  listSpacing
	  scrollBarDisplayPolicy
	  selectedItemCount
	  selectedItems
	  stringDirection
	  topItemPosition
	  visibleItemCount


     itemCount
	  The value for	this resource is the number of items. If this number
	  is different from the	actual number of items in the list, Motif will
	  probably core	dump.

     items
	  The value for	this resource is a string consisting of	words
	  separated by commas.	An item	may contain a comma if it is prefixed
	  by the escape	character as in	`\,'.


     selectionPolicy
	  The values for this resource are
	       single_select
	       multiple_select
	       extended_select
	       browse_select
	       extendedSelectionCallback
	       multipleSelectionCallback
	       singleSelectionCallback



									Page 1






TmList(3Tm)							   TmList(3Tm)

METHODS    [Toc]    [Back]

     The extra methods supported for this class	are

	  addItem
	  addItemUnselected
	  deleteItem
	  deleteAllItems
	  deletePosition
	  deselectAllItems
	  deselectItem
	  deselectPosition
	  itemExists
	  positionSelected
	  selectItem
	  selectPosition
	  setBottomItem
	  setBottomPosition
	  setItem
	  setPosition
	  browseSelectionCallback
	  defaultActionCallback

     addItem item position
	  Add an item to the list at a particular position.  A position	of 1
	  makes	it the first, 2	makes it second, etc.  A position of 0 makes
	  it the last item.


     addItemUnselected item position
	  Add an item to the list at a particular position.  Do	not select the
	  item even if it is in	the selected set.


     deleteItem	item
	  Delete the first matching item from the list.


     deletePosition position
	  Delete the item at the position in the list.


     deselectAllItems
	  remove all items from	the selected set.


     deselectItem  item
	  Deselect the first item in the selected set that matches the item.


     deselectPosition position
	  Deselect the item at the specified position.




									Page 2






TmList(3Tm)							   TmList(3Tm)



     itemExists	 item
	  returns "true" if the	item is	in the list, otherwise "false"


     itemPosition  item
	  returns the position of the item in the list.


     selectItem	 item notify
	  Selects the item, and	if notify is true calls	the selection callback


     selectPosition position notify
	  Selects the item at the position, and	if notify is true calls	the
	  selection callback.


     setBottomItem item
	  make the specified item the last visible item	in the list


     setBottomPosition	position
	  make the item	at the position	the last visible item in the list.


     setItem  item
	  make the item	the first visible item in the lis


     setItem  item
	  make the item	the first visible item in the list

CALLBACK SUBSTITUTIONS    [Toc]    [Back]

     The following substitutions are supported:
	  %reason - the	additional values are
	       browse_select
	       default_action
	       extended_select
	       multiple_select
	       single_select
     %item - the selected item.
     %item_position - the position of the selected item.
     %selected_items - the list	of selected items.
     %selected_item_count - the	number of selected items.
     %selection_type - one of initial modification addition

BUGS    [Toc]    [Back]

     If	the number of items is different from the number set in	itemCount,
     Motif will	probably core dump.

     The list of items is a tcl	list.  This is different to the	comma


									Page 3






TmList(3Tm)							   TmList(3Tm)



     separated list usually used by Motif.  Sorry about	the inconsistency.

AUTHOR    [Toc]    [Back]

     Jan Newmarch, University of Canberra


									PPPPaaaaggggeeee 4444