1XmClipboardCopy(library call)                    XmClipboardCopy(library call)
2
3
4

NAME

6       XmClipboardCopy  — A clipboard function that copies a data item to tem‐
7       porary storage for later copying to clipboard
8

SYNOPSIS

10       #include <Xm/CutPaste.h>
11       int XmClipboardCopy (display, window, item_id, format_name,
12               buffer, length, private_id, data_id)
13               Display * display;
14               Window  window;
15               long    item_id;
16               char    * format_name;
17               XtPointer       buffer;
18               unsigned long   length;
19               long    private_id;
20               long    * data_id;
21       (void)
22

DESCRIPTION

24       XmClipboardCopy copies a data item to temporary storage.  The data item
25       is  moved from temporary storage to the clipboard data structure when a
26       call to XmClipboardEndCopy is made.  Additional calls  to  XmClipboard‐
27       Copy  before a call to XmClipboardEndCopy add additional data item for‐
28       mats to the same data item or append data to an existing  format.  For‐
29       mats are described in the Inter-Client Communication Conventions Manual
30       (ICCCM) as targets.
31
32       NOTE: Do not call XmClipboardCopy before a call to XmClipboardStartCopy
33       has been made. The latter function allocates temporary storage required
34       by XmClipboardCopy.
35
36       If the buffer argument is NULL, the data is considered to be passed  by
37       name.   When  data  that  has been passed by name is later requested by
38       another application, the application that  owns  the  data  receives  a
39       callback  with  a  request  for the data. The application that owns the
40       data must then transfer the data to the clipboard with the XmClipboard‐
41       CopyByName  function.   When  a  data  item  that was passed by name is
42       deleted from the clipboard, the application that owns the data receives
43       a callback stating that the data is no longer needed.
44
45       For  information  on  the  callback function, see the callback argument
46       description for XmClipboardStartCopy.
47
48       display   Specifies  a  pointer  to  the  Display  structure  that  was
49                 returned in a previous call to XOpenDisplay or XtDisplay.
50
51       window    Specifies the window ID of a widget that relates the applica‐
52                 tion window to the clipboard. The widget's window ID  can  be
53                 obtained  through  XtWindow.   The  same application instance
54                 should pass the same window ID to each of the clipboard func‐
55                 tions that it calls.
56
57       item_id   Specifies the number assigned to this data item.  This number
58                 was returned by a previous call to XmClipboardStartCopy.
59
60       format_name
61                 Specifies the name of the format in which the  data  item  is
62                 stored  on  the  clipboard. The format was known as target in
63                 the ICCCM.
64
65       buffer    Specifies the buffer from  which  the  clipboard  copies  the
66                 data.
67
68       length    Specifies  the  length, in bytes, of the data being copied to
69                 the clipboard.
70
71       private_id
72                 Specifies the private data  that  the  application  wants  to
73                 store with the data item.
74
75       data_id   Specifies  an  identifying  number  assigned to the data item
76                 that uniquely identifies the data item and the format.   This
77                 argument is required only for data that is passed by name.
78

RETURN

80       XmClipboardSuccess
81                 The function was successful.
82
83       XmClipboardLocked
84                 The  function  failed  because  the  clipboard  was locked by
85                 another application. The application can continue to call the
86                 function  again  with the same parameters until the lock goes
87                 away. This gives the application the opportunity  to  ask  if
88                 the user wants to keep trying or to give up on the operation.
89
90       XmClipboardFail
91                 The  function  failed  because  XmClipboardStartCopy  was not
92                 called or because the data item contains too many formats.
93
95       XmClipboardCopyByName(3), XmClipboardEndCopy(3), and  XmClipboardStart‐
96       Copy(3).
97
98
99
100                                                 XmClipboardCopy(library call)
Impressum