


XmDropTransfer(3X)					   XmDropTransfer(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmDDrrooppTTrraannssffeerr - The DropTransfer widget class

SYNOPSIS


  ##iinncclluuddee <<XXmm//DDrraaggDDrroopp..hh>>

DESCRIPTION
  DropTransfer provides	a set of resources that	identifies the procedures and
  associated information required by the toolkit in order to process and com-
  plete	a drop transaction.  Clients should not	explicitly create a Drop-
  Transfer widget.  Instead, a client initiates	a transfer by calling XXmmDDrroopp--
  TTrraannssffeerrSSttaarrtt, which initializes and returns a DropTransfer widget.  If
  this function	is called within an XXmmNNddrrooppPPrroocc	callback, the actual
  transfers are	initiated after	the callback returns.  Even if no data needs
  to be	transferred, XXmmDDrrooppTTrraannssffeerrSSttaarrtt needs to be called (typically with
  no arguments,	or just	setting	XXmmNNttrraannssffeerrSSttaattuuss) to finish the drag and
  drop transaction.

  The XXmmNNddrrooppTTrraannssffeerrss resource	specifies a transfer list that describes the
  requested target types for the source	data.  A transfer list is an array of
  XXmmDDrrooppTTrraannssffeerrEEnnttrryyRReecc structures, each of which identifies a	target type.
  The transfer list is analogous to the	MULTIPLE selections capability
  defined in the _I_n_t_e_r-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s	_M_a_n_u_a_l (ICCCM).

  The DropTransfer resource, XXmmNNttrraannssffeerrPPrroocc, 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.  Addi-
  tional target	types can be requested after a transfer	is initiated by	cal-
  ling the XXmmDDrrooppTTrraannssffeerrAAdddd function.

  Structures

  An XXmmDDrrooppTTrraannssffeerrEEnnttrryy is a pointer to the following structure of type
  XXmmDDrrooppTTrraannssffeerrEEnnttrryyRReecc, which	identifies a selection target associated with
  a given drop transaction:


  ttyyppeeddeeff ssttrruucctt
  {{
    XXttPPooiinntteerr _c_l_i_e_n_t__d_a_t_a;;
    AAttoomm      _t_a_r_g_e_t;;
  }} XXmmDDrrooppTTrraannssffeerrEEnnttrryyRReecc,, **XXmmDDrrooppTTrraannssffeerrEEnnttrryy;;

  _c_l_i_e_n_t__d_a_t_a
	    Specifies any additional information required by this selection
	    target

  _t_a_r_g_e_t    Specifies a	selection target associated with the drop operation

  Classes

  DropTransfer inherits	behavior and a resource	from OObbjjeecctt.

  The class pointer is xxmmDDrrooppTTrraannssffeerrOObbjjeeccttCCllaassss.

  The class name is XXmmDDrrooppTTrraannssffeerr.

  New Resources

  The following	table defines a	set of widget resources	used by	the program-
  mer 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 .Xdefaults file, remove the	XXmmNN or XXmmCC
  prefix and use the remaining letters.	 To specify one	of the defined values
  for a	resource in a .Xdefaults file, remove the XXmm prefix and	use the
  remaining letters (in	either lowercase or uppercase, but include any under-
  scores between words).  The codes in the access column indicate if the
  given	resource can be	set at creation	time (CC), set by using XXttSSeettVVaalluueess
  (SS), retrieved by using XXttGGeettVVaalluueess (GG), or is not applicable	(NN//AA).

			 XXmmDDrrooppTTrraannssffeerr	RReessoouurrccee SSeett
     ____________________________________________________________________
     NNaammee			 DDeeffaauulltt			   AAcccceessss
	   CCllaassss		       TTyyppee
     ____________________________________________________________________
     ____________________________________________________________________
     XmNdropTransfers		 NULL				   CG
	   XmCDropTransfers		XmDropTransferEntryRec *
     ____________________________________________________________________
     XmNincremental		 False				   CSG
	   XmCIncremental		Boolean
     ____________________________________________________________________
     XmNnumDropTransfers	 0				   CSG
	   XmCNumDropTransfers		Cardinal
     ____________________________________________________________________
     XmNtransferProc		 NULL				   CSG
	   XmCTransferProc		XtSelectionCallbackProc
     ____________________________________________________________________
     XmNtransferStatus		 XmTRANSFER_SUCCESS		   CSG
	   XmCTransferStatus		unsigned char
     ____________________________________________________________________

  XXmmNNddrrooppTTrraannssffeerrss
	    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.

  XXmmNNiinnccrreemmeennttaall
	    Specifies a	Boolean	value that indicates whether the transfer on
	    the	receiver side uses the Xt incremental selection	transfer
	    mechanism described	in _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s-_C _L_a_n_g_u_a_g_e _I_n_t_e_r_f_a_c_e.
	    If the value is True, the receiver uses incremental	transfer; if
	    the	value is False,	the receiver uses atomic transfer.

  XXmmNNnnuummDDrrooppTTrraannssffeerrss
	    Specifies the number of entries in XXmmNNddrrooppTTrraannssffeerrss.  If this
	    resource is	set to 0 at any	time, the transfer is considered com-
	    plete.  The	value of XXmmNNttrraannssffeerrSSttaattuuss determines the completion
	    handshaking	process.

  XXmmNNttrraannssffeerrPPrroocc
	    Specifies a	procedure of type XXttSSeelleeccttiioonnCCaallllbbaacckkPPrroocc that
	    delivers the requested selection values.  The _w_i_d_g_e_t argument
	    passed to this procedure is	the DropTransfer widget.  The selec-
	    tion atom passed is	_MOTIF_DROP.  For additional information on
	    selection callback procedures, see _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s-_C
	    _L_a_n_g_u_a_g_e _I_n_t_e_r_f_a_c_e.

  XXmmNNttrraannssffeerrSSttaattuuss
	    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:

	    XXmmTTRRAANNSSFFEERR__SSUUCCCCEESSSS	The transfer succeeded.

	    XXmmTTRRAANNSSFFEERR__FFAAIILLUURREE	The transfer failed.

  Inherited Resources

  DropTransfer inherits	behavior and a resource	from OObbjjeecctt.  For a complete
  description of this resource,	refer to the OObbjjeecctt reference page.

			      OObbjjeecctt RReessoouurrccee SSeett
	      ___________________________________________________
	      NNaammee		   DDeeffaauulltt		   AAcccceessss
		    CCllaassss		 TTyyppee
	      ___________________________________________________
	      ___________________________________________________
	      XmNdestroyCallback   NULL			   C
		    XmCCallback		  XtCallbackList
	      ___________________________________________________

RELATED	INFORMATION
  OObbjjeecctt((33XX)), XXmmDDiissppllaayy((33XX)), XXmmDDrraaggCCoonntteexxtt((33XX)),	XXmmDDrraaggIIccoonn((33XX)),
  XXmmDDrrooppSSiittee((33XX)), XXmmDDrrooppTTrraannssffeerrAAdddd((33XX)), and XXmmDDrrooppTTrraannssffeerrSSttaarrtt((33XX)).










































