Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XmTransferDone(3)	   Library Functions Manual	     XmTransferDone(3)

NAME
       XmTransferDone -- A toolkit function that completes a data transfer

SYNOPSIS
       #include	<Xm/Xm.h>

       void XmTransferDone(
       XtPointer transfer_id,
       XmTransferStatus	status);

DESCRIPTION
       XmTransferDone  completes an already-initiated data transfer operation.
       An application can call this  routine  from  an	XmNdestinationCallback
       procedure  or  any function called as a result, including the selection
       procedures called as a result of	calls to XmTransferValue.

       The caller of XmTransferDone supplies an	identifier  for	 the  transfer
       operation  and  an indication of	the completion status.	XmTransferDone
       causes any remaining transfers for the operation	to be discarded.

       transfer_id
		 Specifies a unique indentifier	for the	data  transfer	opera-
		 tion.	 The value must	be the same as the value of the	trans-
		 fer_id	member of the  XmDestinationCallbackStruct  passed  to
		 the XmNdestinationCallback procedure.

       status	 Specifies  the	 completion status of the data transfer.  Fol-
		 lowing	are the	possible values:

		 XmTRANSFER_DONE_SUCCEED
			   The transfer	was completed successfully.  This sta-
			   tus has the following additional effects:

			      o	 For a move operation, the selection owner re-
				 ceives	a request to convert the selection  to
				 the DELETE target.

			      o	 If  a	TRANSACT operation is in progress, the
				 owner receives	a request to commit the	trans-
				 action.

			      o	 If  a PERSIST or _MOTIF_SNAPSHOT operation is
				 in progress, the owner	receives  a  notifica-
				 tion that the operation is finished.

			      o	 The widget class destination procedure	is not
				 called.

		 XmTRANSFER_DONE_FAIL
			   The transfer	was  completed	unsuccessfully.	  This
			   status has the following additional effects:

			      o	 For  a	 move  operation,  the selection owner
				 does not receive a request to convert the se-
				 lection to the	DELETE target.

			      o	 For a drag and	drop operation,	the DropTrans-
				 fer's XmNtransferStatus is  set  to  XmTRANS-
				 FER_FAILURE.

			      o	 If  a	TRANSACT operation is in progress, the
				 owner receives	a request to abort the	trans-
				 action.

			      o	 If  a PERSIST or _MOTIF_SNAPSHOT operation is
				 in progress, the owner	receives  a  notifica-
				 tion that the operation is finished.

			      o	 The widget class destination procedure	is not
				 called.

		 XmTRANSFER_DONE_CONTINUE
			   This	 status	 has  the  same	 effect	 as   XmTRANS-
			   FER_DONE_SUCCEED,  except that if a PERSIST or _MO-
			   TIF_SNAPSHOT	operation is in	 progress,  the	 owner
			   does	 not receive a notification that the operation
			   is finished.

		 XmTRANSFER_DONE_DEFAULT
			   The widget class destination	procedure  is  called.
			   Further  effects depend on the actions of that pro-
			   cedure.

RELATED
       XmTransferSendRequest(3), XmTransferStartRequest(3), XmTransferStartRe-
       quest(3), and XmTransferValue(3).

							     XmTransferDone(3)

NAME | SYNOPSIS | DESCRIPTION | RELATED

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=XmTransferDone&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help