include/Xm/CutPaste.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 _XmCutPaste_h
0024 #define _XmCutPaste_h
0025
0026 #include <Xm/Xm.h>
0027
0028 #ifdef __cplusplus
0029 extern "C" {
0030 #endif
0031
0032 /* XmClipboard return status definitions */
0033
0034 typedef enum {
0035   XmClipboardFail = 0,
0036   XmClipboardSuccess = 1,
0037   XmClipboardTruncate = 2,
0038   XmClipboardLocked = 4,
0039   XmClipboardBadFormat = 5,
0040   XmClipboardNoData = 6
0041 } XmClipboardStatus;
0042
0043 /* XmClipboard pre-1.2 definitions */
0044
0045 #define ClipboardFail       0
0046 #define ClipboardSuccess    1
0047 #define ClipboardTruncate   2
0048 #define ClipboardLocked     4
0049 #define ClipboardBadFormat      5
0050 #define ClipboardNoData     6
0051
0052 typedef struct {
0053     long DataId;
0054     long PrivateId;
0055 } XmClipboardPendingRec, *XmClipboardPendingList;
0056
0057 typedef void (*XmCutPasteProc)( Widget w, long * data_id, long * private_id,
0058                                     int * reason) ;
0059 typedef void (*VoidProc)( Widget w, int * data_id, int * private_id,
0060                                     int * reason) ;
0061
0062
0063 /********    Public Function Declarations    ********/
0064
0065 extern int XmClipboardBeginCopy(
0066                         Display *display,
0067                         Window window,
0068                         XmString label,
0069                         Widget widget,
0070                         VoidProc callback,
0071                         long *itemid) ;
0072 extern int XmClipboardStartCopy(
0073                         Display *display,
0074                         Window window,
0075                         XmString label,
0076                         Time timestamp,
0077                         Widget widget,
0078                         XmCutPasteProc callback,
0079                         long *itemid) ;
0080 extern int XmClipboardCopy(
0081                         Display *display,
0082                         Window window,
0083                         long itemid,
0084                         char *format,
0085                         XtPointer buffer,
0086                         unsigned long length,
0087                         long private_id,
0088                         long *dataid) ;
0089 extern int XmClipboardEndCopy(
0090                         Display *display,
0091                         Window window,
0092                         long itemid) ;
0093 extern int XmClipboardCancelCopy(
0094                         Display *display,
0095                         Window window,
0096                         long itemid) ;
0097 extern int XmClipboardWithdrawFormat(
0098                         Display *display,
0099                         Window window,
0100                         long data) ;
0101 extern int XmClipboardCopyByName(
0102                         Display *display,
0103                         Window window,
0104                         long data,
0105                         XtPointer buffer,
0106                         unsigned long length,
0107                         long private_id) ;
0108 extern int XmClipboardUndoCopy(
0109                         Display *display,
0110                         Window window) ;
0111 extern int XmClipboardLock(
0112                         Display *display,
0113                         Window window) ;
0114 extern int XmClipboardUnlock(
0115                         Display *display,
0116                         Window window,
0117 #if NeedWidePrototypes
0118                         int all_levels) ;
0119 #else
0120                         Boolean all_levels) ;
0121 #endif /* NeedWidePrototypes */
0122 extern int XmClipboardStartRetrieve(
0123                         Display *display,
0124                         Window window,
0125                         Time timestamp) ;
0126 extern int XmClipboardEndRetrieve(
0127                         Display *display,
0128                         Window window) ;
0129 extern int XmClipboardRetrieve(
0130                         Display *display,
0131                         Window window,
0132                         char *format,
0133                         XtPointer buffer,
0134                         unsigned long length,
0135                         unsigned long *outlength,
0136                         long *private_id) ;
0137 extern int XmClipboardInquireCount(
0138                         Display *display,
0139                         Window window,
0140                         int *count,
0141                         unsigned long *maxlength) ;
0142 extern int XmClipboardInquireFormat(
0143                         Display *display,
0144                         Window window,
0145                         int n,
0146                         XtPointer buffer,
0147                         unsigned long bufferlength,
0148                         unsigned long *outlength) ;
0149 extern int XmClipboardInquireLength(
0150                         Display *display,
0151                         Window window,
0152                         char *format,
0153                         unsigned long *length) ;
0154 extern int XmClipboardInquirePendingItems(
0155                         Display *display,
0156                         Window window,
0157                         char *format,
0158                         XmClipboardPendingList *list,
0159                         unsigned long *count) ;
0160 extern int XmClipboardRegisterFormat(
0161                         Display *display,
0162                         char *format_name,
0163                         int format_length) ;
0164
0165 /********    End Public Function Declarations    ********/
0166
0167
0168 #ifdef __cplusplus
0169 }  /* Close scope of 'extern "C"' declaration which encloses file. */
0170 #endif
0171
0172 #endif /* _XmCutPaste_h */
0173 /* DON'T ADD ANYTHING AFTER THIS #endif */