File: XmTransferDone.3

package info (click to toggle)
motif 2.3.4-13
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 81,160 kB
  • ctags: 51,769
  • sloc: ansic: 596,938; cpp: 3,951; yacc: 2,854; makefile: 2,070; csh: 1,199; sh: 1,070; lex: 455
file content (137 lines) | stat: -rw-r--r-- 4,073 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
'\" t
...\" TransfA.sgm /main/8 1996/08/30 16:20:20 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmTransferDone" "library call"
.SH "NAME"
\fBXmTransferDone\fP \(em A toolkit function that completes a data transfer
.iX "XmTransferDone"
.iX "toolkit functions" "XmTransferDone"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
.sp \n(PDu
\fBvoid \fBXmTransferDone\fP\fR(
\fBXtPointer \fBtransfer_id\fR\fR,
\fBXmTransferStatus \fBstatus\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmTransferDone\fP completes an already-initiated data transfer
operation\&.
An application can call this routine from an
\fBXmNdestinationCallback\fP procedure or any function called as a
result, including the selection procedures called as a result of calls
to \fBXmTransferValue\fP\&.
.PP
The caller of \fBXmTransferDone\fP supplies an identifier for the
transfer operation and an indication of the completion status\&.
\fBXmTransferDone\fP causes any remaining transfers for the operation to
be discarded\&.
.IP "\fBtransfer_id\fP" 10
Specifies a unique indentifier for the data transfer operation\&.
The value must be the same as the value of the \fBtransfer_id\fP member
of the \fBXmDestinationCallbackStruct\fR passed to the
\fBXmNdestinationCallback\fP procedure\&.
.IP "\fIstatus\fP" 10
Specifies the completion status of the data transfer\&.
Following are the possible values:
.RS
.IP "\fBXmTRANSFER_DONE_SUCCEED\fP" 10
The transfer was completed successfully\&.
This status has the following additional effects:
.RS
.IP "   \(bu" 6
For a move operation, the selection owner receives a request to convert
the selection to the \fBDELETE\fP target\&.
.IP "   \(bu" 6
If a \fBTRANSACT\fP operation is in progress, the owner receives a
request to commit the transaction\&.
.IP "   \(bu" 6
If a \fBPERSIST\fP or \fB_MOTIF_SNAPSHOT\fP operation is in progress,
the owner receives a notification that the operation is finished\&.
.IP "   \(bu" 6
The widget class destination procedure is not called\&.
.RE
.IP "\fBXmTRANSFER_DONE_FAIL\fP" 10
The transfer was completed unsuccessfully\&.
This status has the following additional effects:
.RS
.IP "   \(bu" 6
For a move operation, the selection owner does not receive a request to
convert the selection to the \fBDELETE\fP target\&.
.IP "   \(bu" 6
For a drag and drop operation, the DropTransfer\&'s
\fBXmNtransferStatus\fP is set to \fBXmTRANSFER_FAILURE\fP\&.
.IP "   \(bu" 6
If a \fBTRANSACT\fP operation is in progress, the owner receives a
request to abort the transaction\&.
.IP "   \(bu" 6
If a \fBPERSIST\fP or \fB_MOTIF_SNAPSHOT\fP operation is in
progress, the owner receives a notification that the operation
is finished\&.
.IP "   \(bu" 6
The widget class destination procedure is not called\&.
.RE
.IP "\fBXmTRANSFER_DONE_CONTINUE\fP" 10
This status has the same effect as \fBXmTRANSFER_DONE_SUCCEED\fP, except
that if a \fBPERSIST\fP or \fB_MOTIF_SNAPSHOT\fP operation is
in progress, the
owner does not receive a notification that the operation is finished\&.
.IP "\fBXmTRANSFER_DONE_DEFAULT\fP" 10
The widget class destination procedure is called\&.
Further effects depend on the actions of that procedure\&.
.RE
.SH "RELATED"
.PP
\fBXmTransferSendRequest\fP(3),
\fBXmTransferStartRequest\fP(3),
\fBXmTransferStartRequest\fP(3),
and
\fBXmTransferValue\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:33