Provided by: libmotif-dev_2.3.8-3.1build1_amd64 bug

NAME

       XmMultiList — The Multi-column List widget

SYNOPSIS

       #include <Xm/MultiList.h>

DESCRIPTION

       This  widget  contains  a  multi-column  list with headers along the top and a search area
       along the bottom. The list has scrollbars along the right  and  bottom  edges  that  allow
       vertical  and  horizontal  scrolling  both by column and by pixel. The portion of the list
       data that is currently visible can  be  altered  by  scrollbar  actions,  widget  resource
       setting  and the redisplay of the list data after a string search has been successful. The
       sorting of elements within a particular column is also supported. To sort the list by  the
       elements in a given column, select the column's title.

       To search for a particular string in the list, type the string value to be searched for in
       the list's associated text field and then press the "Find" pushbutton. The search for  the
       string begins in the currently selected row, after the location of the previously searched
       for string, or at the first column and first row if there is no column selected.   If  the
       string is not found in that row, then the search continues through all rows after and then
       before, the currently selected row. If the string is found, the display  of  the  list  is
       adjusted  to  make  the  string  visible. If the string was not found, or if the string is
       visible, the application will issue a warning beep.

       Pointer button one allows the user to select a row or a column for sorting. The  callbacks
       on the doubleClickCallback list are called when the user double clicks pointer button one.
       If the list data can contain a row pixmap to display at the extreme left of the row.

   Classes
       MultiList inherits behavior, resources, and traits from Core, Composite,  Constraint,  and
       XmManager.

       The class pointer is xmMultiListWidgetClass.

       The class name is XmMultiList.

   New Resources
       The  following  table  defines a set of widget resources used by the programmer to specify
       data. The programmer can also set the resource values for the  inherited  classes  to  set
       attributes  for  this widget.  To reference a resource by name or by class in a .Xdefaults
       file, remove the XmN or XmC prefix and use the remaining letters.  To specify one  of  the
       defined  values  for  a  resource  in  a .Xdefaults file, remove the Xm prefix and use the
       remaining letters (in either lowercase or uppercase, but include any  underscores  between
       words).  The  codes  in  the  access  column  indicate if the given resource can be set at
       creation time (C), set by using XtSetValues (S), retrieved by using XtGetValues (G), or is
       not applicable (N/A).

       ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
--

Callback Routines

       All procedures on the MultiList's singleSelectionCallback  and  doubleClickCallback  lists
       will  have  a  pointer  to  a XmMultiListRowInfo structure passed to them in the call_data
       field. This structure is defined above.

       Note: if a single SelectionCallback is registered on an MultiList in extended_select_mode,
       the value of call_data is undefined.

                 void (callback)(Widget w, XtPointer client_data, XtPointer call_data)

       w         the MultiList widget

       client_data
                 the client data specified by the application

       call_data a pointer to an XmMultiListRowInfo structure corrsponding the the row selected

Sort Function

       typedef int (XmMultiListSortFunction) (short column, XmMultiRowInfo * row1, XmMultiRowInfo
       * row2);

       column    the column currently being sorted

       row1, row2
                 the two rows being compared. The return value must  be  an  integer  less  than,
                 equal  to,  or  greater  than 0, depending on whether the first argument is less
                 than, equal to, or greater than the second.

RELATED

       Composite(3),     Constraint(3),     Core(3),     XmCreateMultiList(3),      XmManager(3),
       XmMultiListDeselectAllItems(3),  XmMultiListDeselectItem(3),  XmMultiListDeselectItems(3),
       XmMultiListDeselectRow(3),                              XmMultiListGetSelectedRowArray(3),
       XmMultiListGetSelectedRows(3), XmMultiListMakeRowVisible(3), XmMultiListSelectAllItems(3),
       XmMultiListSelectItems(3), XmMultiListSelectRow(3), and XmMultiListToggleRow(3).

COPYRIGHT

       Copyright (c) 1992 by Integrated Computer Solutions, Inc.

                                                                                   XmMultiList(3)