include/Xm/List.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 #ifndef _XmList_h
0024 #define _XmList_h
0025
0026 #include <Xm/Xm.h>
0027
0028 #ifdef __cplusplus
0029 extern "C" {
0030 #endif
0031
0032 externalref WidgetClass xmListWidgetClass;
0033
0034 #define XmINITIAL   0
0035 #define XmADDITION  1
0036 #define XmMODIFICATION  2
0037
0038 #ifndef XmIsList
0039 #define XmIsList(w) XtIsSubclass(w, xmListWidgetClass)
0040 #endif /* XmIsList */
0041
0042 typedef struct _XmListClassRec * XmListWidgetClass;
0043 typedef struct _XmListRec      * XmListWidget;
0044
0045 /********    Public Function Declarations    ********/
0046
0047 extern void XmListAddItem(
0048                         Widget w,
0049                         XmString item,
0050                         int pos) ;
0051 extern void XmListAddItems(
0052                         Widget w,
0053                         XmString *items,
0054                         int item_count,
0055                         int pos) ;
0056 extern void XmListAddItemsUnselected(
0057                         Widget w,
0058                         XmString *items,
0059                         int item_count,
0060                         int pos) ;
0061 extern void XmListAddItemUnselected(
0062                         Widget w,
0063                         XmString item,
0064                         int pos) ;
0065 extern void XmListDeleteItem(
0066                         Widget w,
0067                         XmString item) ;
0068 extern void XmListDeleteItems(
0069                         Widget w,
0070                         XmString *items,
0071                         int item_count) ;
0072 extern void XmListDeletePositions(
0073                         Widget    w,
0074                         int      *position_list,
0075                         int       position_count ) ;
0076 extern void XmListDeletePos(
0077                         Widget w,
0078                         int pos) ;
0079 extern void XmListDeleteItemsPos(
0080                         Widget w,
0081                         int item_count,
0082                         int pos) ;
0083 extern void XmListDeleteAllItems(
0084                         Widget w) ;
0085 extern void XmListReplaceItems(
0086                         Widget w,
0087                         XmString *old_items,
0088                         int item_count,
0089                         XmString *new_items) ;
0090 extern void XmListReplaceItemsPos(
0091                         Widget w,
0092                         XmString *new_items,
0093                         int item_count,
0094                         int position) ;
0095 extern void XmListReplaceItemsUnselected(
0096                         Widget w,
0097                         XmString *old_items,
0098                         int item_count,
0099                         XmString *new_items) ;
0100 extern void XmListReplaceItemsPosUnselected(
0101                         Widget w,
0102                         XmString *new_items,
0103                         int item_count,
0104                         int position) ;
0105 extern void XmListReplacePositions(
0106                         Widget    w,
0107                         int      *position_list,
0108                         XmString *item_list,
0109                         int       item_count ) ;
0110 extern void XmListSelectItem(
0111                         Widget w,
0112                         XmString item,
0113 #if NeedWidePrototypes
0114                         int notify) ;
0115 #else
0116                         Boolean notify) ;
0117 #endif /* NeedWidePrototypes */
0118 extern void XmListSelectPos(
0119                         Widget w,
0120                         int pos,
0121 #if NeedWidePrototypes
0122                         int notify) ;
0123 #else
0124                         Boolean notify) ;
0125 #endif /* NeedWidePrototypes */
0126 extern void XmListDeselectItem(
0127                         Widget w,
0128                         XmString item) ;
0129 extern void XmListDeselectPos(
0130                         Widget w,
0131                         int pos) ;
0132 extern void XmListDeselectAllItems(
0133                         Widget w) ;
0134 extern void XmListSetPos(
0135                         Widget w,
0136                         int pos) ;
0137 extern void XmListSetBottomPos(
0138                         Widget w,
0139                         int pos) ;
0140 extern void XmListSetItem(
0141                         Widget w,
0142                         XmString item) ;
0143 extern void XmListSetBottomItem(
0144                         Widget w,
0145                         XmString item) ;
0146 extern void XmListSetAddMode(
0147                         Widget w,
0148 #if NeedWidePrototypes
0149                         int add_mode) ;
0150 #else
0151                         Boolean add_mode) ;
0152 #endif /* NeedWidePrototypes */
0153 extern Boolean XmListItemExists(
0154                         Widget w,
0155                         XmString item) ;
0156 extern int XmListItemPos(
0157                         Widget w,
0158                         XmString item) ;
0159 extern int XmListGetKbdItemPos(
0160                         Widget w) ;
0161 extern Boolean XmListSetKbdItemPos(
0162                         Widget w,
0163                         int    pos ) ;
0164 extern int XmListYToPos(
0165                         Widget w,
0166                         Position y) ; /* NeedWidePrototypes ????? */
0167 extern Boolean XmListPosToBounds(
0168                         Widget w,
0169                         int         position,
0170                         Position   *x,
0171                         Position   *y,
0172                         Dimension  *width,
0173                         Dimension  *height) ;
0174 extern Boolean XmListGetMatchPos(
0175                         Widget w,
0176                         XmString item,
0177                         int **pos_list,
0178                         int *pos_count) ;
0179 extern Boolean XmListGetSelectedPos(
0180                         Widget w,
0181                         int **pos_list,
0182                         int *pos_count) ;
0183 extern void XmListSetHorizPos(
0184                         Widget w,
0185                         int position) ;
0186 extern void XmListUpdateSelectedList(
0187                         Widget w) ;
0188 extern Boolean XmListPosSelected(
0189             Widget  w,
0190             int     pos);
0191 extern Widget XmCreateList(
0192                         Widget parent,
0193                         char *name,
0194                         ArgList args,
0195                         Cardinal argCount) ;
0196 extern Widget XmCreateScrolledList(
0197                         Widget parent,
0198                         char *name,
0199                         ArgList args,
0200                         Cardinal argCount) ;
0201 extern Widget XmVaCreateList(
0202                         Widget parent,
0203                         char *name,
0204                         ...);
0205 extern Widget XmVaCreateManagedList(
0206                         Widget parent,
0207                         char *name,
0208                         ...);
0209 /********    End Public Function Declarations    ********/
0210
0211
0212 #ifdef __cplusplus
0213 }  /* Close scope of 'extern "C"' declaration which encloses file. */
0214 #endif
0215
0216 #endif /* _XmList_h */
0217 /* DON'T ADD ANYTHING AFTER THIS #endif */