ultrix man page for dwtbegincopytoclipboard

DwtBeginCopyToClipboard(3Dwt)											     DwtBeginCopyToClipboard(3Dwt)

Name
       DwtBeginCopyToClipboard - Sets up storage and data structures to receive clipboard data.

Syntax
       int DwtBeginCopyToClipboard(display, window, clip_label,
				  widget, callback, item_id)
	    Display *display;
	    Window window;
	    DwtCompString clip_label;
	    Widget widget;
	    VoidProc callback;
	    long *item_id;

Arguments
       display	 Specifies  a pointer to the Display structure that was returned in a previous call to XOpenDisplay.  For information on XOpenDis-
		 play and the Display structure, see the Guide to the Xlib Library: C Language Binding.

       window	 Specifies the window ID that relates the application window to the clipboard.	The same application instance should pass the same
		 window ID to each clipboard function that it calls.

       clip_label
		 Specifies  the  label	to  be	associated with the data item.	This argument is used to identify the data item, for example, in a
		 clipboard viewer.  An example of a label is the name of the application that places the data in the clipboard.

       widget	 Specifies the ID of the widget that will receive messages requesting data previously passed  by  name.   This	argument  must	be
		 present in order to pass data by name.  Any valid widget ID in your application can be used.  All message handling is done by the
		 cut and paste functions.

       callback  Specifies the address of the callback function that is called when the clipboard needs data that was originally passed  by  name.
		 This  is  also  the  callback to receive the DELETE message for items that were originally passed by name.  This argument must be
		 present in order to pass data by name.

       item_id	 Specifies the number assigned to this data item.  The application uses this number in calls to DwtCopyToClipboard,  DwtEndCopyTo-
		 Clipboard, and DwtCancelCopyToClipboard.

Description
       The  DwtBeginCopyToClipboard  function sets up storage and data structures to receive clipboard data.  An application calls DwtBeginCopyTo-
       Clipboard during a cut or copy operation.  The data item that these structures receive then becomes the next-paste item in the clipboard.

       The widget and callback arguments must be present in order to pass data by name.  The callback format is as follows:

       function name(widget, data_id, private_id, reason)
	    Widget *widget;
	    int *data_id;
	    int *private_id;
	    int *reason;

       widget	 Specifies the ID of the widget passed to DwtBeginCopyToClipboard.

       data_id	 Specifies the identifying number returned by DwtCopyToClipboard, which identifies the pass-by-name data.

       private_id
		 Specifies the private information passed to DwtCopyToClipboard.

       reason	 Specifies the reason, which is either DwtCRClipboardDataDelete or DwtCRClipboardDataRequest.

Return Values
       This function returns one of these status return constants:

       ClipboardSuccess   The function is  success-
			  ful.

       ClipboardLocked	  The	 function    failed
			  because the clipboard was
			  locked  by another appli-
			  cation.  The	application
			  can  continue to call the
			  function  with  the  same
			  parameters	until	the
			  clipboard  is   unlocked.
			  Optionally,  the applica-
			  tion can ask if the  user
			  wants  to  keep trying or
			  to give up on the  opera-
			  tion.

See Also
       DwtCopyToClipboard(3Dwt), DwtEndCopyToClipboard(3Dwt), DwtCancelCopyToClipboard(3Dwt), DwtStartCopyToClipboard(3Dwt)
       Guide to the XUI Toolkit: C Language Binding
       Guide to the XUI Toolkit Intrinsics: C Language Binding

														     DwtBeginCopyToClipboard(3Dwt)