'\" t
...\" DropTrA.sgm /main/10 1996/09/08 20:42:28 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 "XmDropTransfer" "library call"
.SH "NAME"
\fBXmDropTransfer\fP \(em The DropTransfer widget class
.iX "XmDropSite"
.iX "widget class" "DropTransfer"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/DragDrop\&.h>
.fi
.SH "DESCRIPTION"
.PP
DropTransfer provides a set of resources that identifies
the procedures and associated information required by the
toolkit in order to process and complete a drop transaction\&.
Clients should not explicitly create a DropTransfer widget\&.
Instead, a client initiates a transfer by calling
\fBXmDropTransferStart\fP, which initializes and returns a
DropTransfer widget\&. If this function is called within an
\fBXmNdropProc\fP callback, the actual transfers are initiated
after the callback returns\&. Even if no data needs to be transferred,
\fBXmDropTransferStart\fP needs to be called (typically with
no arguments, or just setting \fBXmNtransferStatus\fP) to finish
the drag and drop transaction\&.
.PP
The \fBXmNdropTransfers\fP resource specifies a transfer
list that describes the requested target types for the source
data\&. A transfer list is an array of \fBXmDropTransferEntryRec\fR
structures, each of which identifies a target type\&. The
transfer list is analogous to the MULTIPLE selections capability
defined in the \fIInter-Client Communication Conventions Manual\fP
(ICCCM)\&.
.PP
The DropTransfer resource, \fBXmNtransferProc\fP, specifies a
transfer procedure of type XtSelectionCallbackProc that
delivers the requested selection data\&. This procedure operates
in conjunction with the underlying Xt selection capabilities and
is called for each target in the transfer list\&. Additional target
types can be requested after a transfer is initiated by calling
the \fBXmDropTransferAdd\fP function\&.
.SS "Structures"
.PP
An \fBXmDropTransferEntry\fR is a pointer to the following structure of
type \fBXmDropTransferEntryRec\fR, which identifies a selection
target associated with a given drop transaction:
.PP
.nf
typedef struct
{
        XtPointer       \fIclient_data\fP\fB;
        Atom\fP \fItarget\fP\fB;
} XmDropTransferEntryRec, *XmDropTransferEntry;\fP
.fi
.IP "\fIclient_data\fP" 10
Specifies any additional information required
by this selection target
.IP "\fItarget\fP" 10
Specifies a selection target associated with the drop
operation
.SS "Classes"
.PP
DropTransfer inherits behavior and a resource from \fBObject\fP\&.
.PP
The class pointer is \fBxmDropTransferObjectClass\fP\&.
.PP
The class name is \fBXmDropTransfer\fP\&.
.SS "New Resources"
.PP
The following table defines a set of widget resources used by the
programmer to specify data\&. The programmer can also set the
resource values for the inherited classes to set attributes for
this widget\&. To reference a resource by name or by class in
a \fB\&.Xdefaults\fP file, remove the \fBXmN\fP or \fBXmC\fP prefix and use
the remaining letters\&. To specify one of the defined values for a
resource in a \fB\&.Xdefaults\fP file, remove the \fBXm\fP prefix and use
the remaining letters (in either lowercase or uppercase, but include
any underscores between words)\&. The codes in the access column
indicate if the given resource can be set at creation time (C),
set by using \fBXtSetValues\fP (S), retrieved by using
\fBXtGetValues\fP (G), or is not applicable (N/A)\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmDropTransfer Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNdropTransfersXmCDropTransfersXmDropTransferEntryRec *NULLCG
_____
XmNincrementalXmCIncrementalBooleanFalseCSG
_____
XmNnumDropTransfersXmCNumDropTransfersCardinal0CSG
_____
XmNtransferProcXmCTransferProcXtSelectionCallbackProcNULLCSG
_____
XmNtransferStatusXmCTransferStatusunsigned charXmTRANSFER_SUCCESSCSG
_____
.TE
.IP "\fBXmNdropTransfers\fP" 10
Specifies the address of an array of drop transfer entry records\&. The
drop transfer is complete when all the entries in the list have been
processed\&.
.IP "\fBXmNincremental\fP" 10
Specifies a Boolean value that indicates whether the transfer on the
receiver side uses the Xt incremental selection transfer mechanism
described in \fIX Toolkit Intrinsics\(emC Language Interface\fP\&.
If the value is True, the receiver uses incremental transfer; if the
value is False, the receiver uses atomic transfer\&.
.IP "\fBXmNnumDropTransfers\fP" 10
Specifies the number of entries in \fBXmNdropTransfers\fP\&. If
this resource is set to 0 at any time, the transfer is considered
complete\&. The value of \fBXmNtransferStatus\fP determines the
completion handshaking process\&.
.IP "\fBXmNtransferProc\fP" 10
Specifies a procedure of type \fBXtSelectionCallbackProc\fP that
delivers the requested selection values\&.
The \fIwidget\fP argument passed to this procedure is the DropTransfer
widget\&.
The selection atom passed is _MOTIF_DROP\&.
For additional information on selection callback procedures, see \fIX
Toolkit Intrinsics\(emC Language Interface\fP\&.
.IP "\fBXmNtransferStatus\fP" 10
Specifies the current status of the drop transfer\&. The client
updates this value when the transfer ends and communicates
the value to the initiator\&. The possible values are
.RS
.IP "\fBXmTRANSFER_SUCCESS\fP" 10
The transfer succeeded\&.
.IP "\fBXmTRANSFER_FAILURE\fP" 10
The transfer failed\&.
.RE
.SS "Inherited Resources"
.PP
DropTransfer inherits behavior and a resource from \fBObject\fP\&.
For a complete description of this resource, refer
to the \fBObject\fP reference page\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBObject Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
_____
.TE
.SH "RELATED INFORMATION"
.PP
\fBObject\fP(3),
\fBXmDisplay\fP(3),
\fBXmDragContext\fP(3),
\fBXmDragIcon\fP(3),
\fBXmDropSite\fP(3),
\fBXmDropTransferAdd\fP(3), and
\fBXmDropTransferStart\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:23