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

NAME

6       XmTransferDone — A toolkit function that completes a data transfer
7

SYNOPSIS

9       #include <Xm/Xm.h>
10
11       void XmTransferDone(
12       XtPointer transfer_id,
13       XmTransferStatus status);
14

DESCRIPTION

16       XmTransferDone  completes an already-initiated data transfer operation.
17       An application can call this  routine  from  an  XmNdestinationCallback
18       procedure  or  any function called as a result, including the selection
19       procedures called as a result of calls to XmTransferValue.
20
21       The caller of XmTransferDone supplies an identifier  for  the  transfer
22       operation  and  an indication of the completion status.  XmTransferDone
23       causes any remaining transfers for the operation to be discarded.
24
25       transfer_id
26                 Specifies a unique indentifier for the data  transfer  opera‐
27                 tion.   The value must be the same as the value of the trans‐
28                 fer_id member of the  XmDestinationCallbackStruct  passed  to
29                 the XmNdestinationCallback procedure.
30
31       status    Specifies  the  completion status of the data transfer.  Fol‐
32                 lowing are the possible values:
33
34                 XmTRANSFER_DONE_SUCCEED
35                           The transfer was completed successfully.  This sta‐
36                           tus has the following additional effects:
37
38                              ·  For  a  move  operation,  the selection owner
39                                 receives a request to convert  the  selection
40                                 to the DELETE target.
41
42                              ·  If  a  TRANSACT operation is in progress, the
43                                 owner receives a request to commit the trans‐
44                                 action.
45
46                              ·  If  a PERSIST or _MOTIF_SNAPSHOT operation is
47                                 in progress, the owner receives  a  notifica‐
48                                 tion that the operation is finished.
49
50                              ·  The widget class destination procedure is not
51                                 called.
52
53                 XmTRANSFER_DONE_FAIL
54                           The transfer was  completed  unsuccessfully.   This
55                           status has the following additional effects:
56
57                              ·  For  a  move  operation,  the selection owner
58                                 does not receive a  request  to  convert  the
59                                 selection to the DELETE target.
60
61                              ·  For a drag and drop operation, the DropTrans‐
62                                 fer's XmNtransferStatus is  set  to  XmTRANS‐
63                                 FER_FAILURE.
64
65                              ·  If  a  TRANSACT operation is in progress, the
66                                 owner receives a request to abort the  trans‐
67                                 action.
68
69                              ·  If  a PERSIST or _MOTIF_SNAPSHOT operation is
70                                 in progress, the owner receives  a  notifica‐
71                                 tion that the operation is finished.
72
73                              ·  The widget class destination procedure is not
74                                 called.
75
76                 XmTRANSFER_DONE_CONTINUE
77                           This  status  has  the  same  effect  as   XmTRANS‐
78                           FER_DONE_SUCCEED,  except  that  if  a  PERSIST  or
79                           _MOTIF_SNAPSHOT operation is in progress, the owner
80                           does  not receive a notification that the operation
81                           is finished.
82
83                 XmTRANSFER_DONE_DEFAULT
84                           The widget class destination procedure  is  called.
85                           Further  effects depend on the actions of that pro‐
86                           cedure.
87

89       XmTransferSendRequest(3), XmTransferStartRequest(3), XmTransferStartRe‐
90       quest(3), and XmTransferValue(3).
91
92
93
94                                                  XmTransferDone(library call)
Impressum