include/Xm/Ext18List.h

0001 /*
0002  * Motif
0003  *
0004  * Copyright (c) 1987-2012, The Open Group. All rights reserved.
0005  *
0006  * These libraries and programs are free software; you can
0007  * redistribute them and/or modify them under the terms of the GNU
0008  * Lesser General Public License as published by the Free Software
0009  * Foundation; either version 2 of the License, or (at your option)
0010  * any later version.
0011  *
0012  * These libraries and programs are distributed in the hope that
0013  * they will be useful, but WITHOUT ANY WARRANTY; without even the
0014  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
0015  * PURPOSE. See the GNU Lesser General Public License for more
0016  * details.
0017  *
0018  * You should have received a copy of the GNU Lesser General Public
0019  * License along with these librararies and programs; if not, write
0020  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
0021  * Floor, Boston, MA 02110-1301 USA
0022  *
0023  */
0024
0025 #ifndef _XmExt18List_h_
0026 #define _XmExt18List_h_
0027
0028 #if defined(__cplusplus)
0029 extern "C" {
0030 #endif
0031
0032 #include <Xm/MultiList.h>
0033 #include <Xm/XmP.h>
0034
0035 externalref WidgetClass xmExt18ListWidgetClass XM_DEPRECATED;
0036
0037 enum {
0038     XmEXT18LIST_FOUND = XmMULTILIST_FOUND,
0039     XmEXT18LIST_NOT_FOUND = XmMULTILIST_NOT_FOUND
0040 };
0041
0042 typedef XmMultiListWidgetClass  *XmExt18ListWidgetClass;
0043 typedef XmMultiListWidget   *XmExt18ListWidget;
0044
0045 typedef XmMultiListRowInfo       Xm18RowInfo;
0046
0047 typedef XmMultiListCallbackStruct   XmExt18ListCallbackStruct;
0048
0049 /*
0050  * Function Name: XmExt18ListGetSelectedRows
0051  * Description:   Takes an Extended List and returns a NULL terminated array
0052  *                of pointers to selected rows from the internal list
0053  * Arguments:     w - the extended list widget
0054  * Returns:       Xm18RowInfo **
0055  */
0056
0057 Xm18RowInfo ** XmExt18ListGetSelectedRows(Widget w) XM_DEPRECATED;
0058
0059 /*  Function Name: XmCreateExtended18List
0060  *  Description: Creation Routine for UIL and ADA.
0061  *  Arguments: parent - the parent widget.
0062  *                 name - the name of the widget.
0063  *                 args, num_args - the number and list of args.
0064  *  Returns: The Widget created.
0065  */
0066
0067 extern Widget XmCreateExtended18List(Widget,
0068                                      String,
0069                                      ArgList,
0070                                      Cardinal) XM_DEPRECATED;
0071
0072 extern Widget XmCreateExt18List(Widget,
0073                                 String,
0074                                 ArgList,
0075                                 Cardinal) XM_DEPRECATED;
0076
0077 extern Widget XmVaCreateExt18List(
0078                         Widget parent,
0079                         char *name,
0080                         ...) XM_DEPRECATED;
0081
0082 extern Widget XmVaCreateManagedExt18List(
0083                         Widget parent,
0084                         char *name,
0085                         ...) XM_DEPRECATED;
0086
0087 /*  Function Name: XmExt18ListUnselectAllItems
0088  *  Description:   Unselects all rows
0089  *  Arguments:     w - the ilist widget.
0090  *  Returns:       none
0091  */
0092 extern void XmExt18ListUnselectAllItems(Widget w) XM_DEPRECATED;
0093
0094 /*  Function Name: XmExt18ListUnselectItem
0095  *  Description:   Unselects the row passed in
0096  *  Arguments:     w - the ilist widget.
0097  *                 row_info - ptr to the row passed in
0098  *  Returns:       none
0099  */
0100 extern void XmExt18ListUnselectItem(Widget, Xm18RowInfo *) XM_DEPRECATED;
0101
0102 /*  Function Name: XmExt18ListToggleRow
0103  *  Description:   Toggles the selection state of a specified row
0104  *  Arguments:     w - the extended list widget
0105  *  Returns:       none
0106  */
0107 extern void XmExt18ListToggleRow(Widget, short) XM_DEPRECATED;
0108
0109 /*  Function Name: XmExt18ListSelectItems
0110  *  Description:   Set selection state by matching column entries to XmString
0111  *  Arguments:     w - the extended list widget
0112  *         item - XmString to use as selection key
0113  *         column - column number (0 - N) to match (or XmANY_COLUMN)
0114  *         notify - if True, call XmNsingleSelectionCallback
0115  *  Returns:       none
0116  */
0117 extern void XmExt18ListSelectItems(Widget, XmString, int, Boolean) XM_DEPRECATED;
0118
0119 /*  Function Name: XmExt18ListDeselectItems
0120  *  Description:   Set selection state by matching column entries to XmString
0121  *  Arguments:     w - the extended list widget
0122  *         item - XmString to use as selection key
0123  *         column - column number (0 - N) to match (or XmANY_COLUMN)
0124  *  Returns:       none
0125  */
0126 extern void XmExt18ListDeselectItems(Widget, XmString, int) XM_DEPRECATED;
0127
0128 /*  Function Name: XmExt18ListSelectAllItems
0129  *  Description:   Set selection state on all rows
0130  *  Arguments:     w - the extended list widget
0131  *         notify - if True, call XmNsingleSelectionCallback for each
0132  *  Returns:       none
0133  */
0134 extern void XmExt18ListSelectAllItems(Widget, Boolean) XM_DEPRECATED;
0135
0136 /*  Function Name: XmExt18ListSelectRow
0137  *  Description:   Set selection state on all rows
0138  *  Arguments:     w - the extended list widget
0139  *         row - the row to select
0140  *         notify - if True, call XmNsingleSelectionCallback
0141  *  Returns:       none
0142  */
0143 extern void XmExt18ListSelectRow(Widget, int, Boolean) XM_DEPRECATED;
0144
0145 /*  Function Name: XmExt18ListDeselectRow
0146  *  Description:   Set selection state on all rows
0147  *  Arguments:     w - the extended list widget
0148  *         row - the row to select
0149  *  Returns:       none
0150  */
0151 extern void XmExt18ListDeselectRow(Widget, int) XM_DEPRECATED;
0152
0153 /*
0154  * Function Name: XmExt18ListGetSelectedRowArray
0155  * Description:   Takes an Extended List and returns a NULL terminated array
0156  *                of pointers to selected rows from the internal list
0157  * Arguments:     w - the extended list widget
0158  *        num_rows - pointer to the number of rows
0159  * Returns:       array of integer (selected) row numbers
0160  */
0161 extern int *XmExt18ListGetSelectedRowArray(Widget, int *) XM_DEPRECATED;
0162
0163 /*  Function Name: XmExt18ListMakeRowVisible
0164  *  Description:   Shifts the visible extended list rows as desired
0165  *  Arguments:     w - the extended list widget
0166  *         row - the row number wished to be made visible
0167  *  Returns:       none
0168  */
0169 void XmExt18ListMakeRowVisible(Widget, int) XM_DEPRECATED;
0170
0171 #if defined(__cplusplus)
0172 }
0173 #endif
0174
0175 #endif /* _XmExt18List_h_ */