XmClipboardStartCopy man page on Ultrix

Man page or keyword search:  
man Server   3690 pages
apropos Keyword Search (all sections)
Output format
Ultrix logo
[printable version]

XmClipboardStartCopy(3X)	   OSF/Motif	      XmClipboardStartCopy(3X)

NAME
       XmClipboardStartCopy  - A clipboard function that sets up a storage and
       data structure

SYNOPSIS
       #include <Xm/Xm.h> #include <Xm/CutPaste.h>

       int XmClipboardStartCopy (display, window, clip_label,		 time‐
       stamp,  widget,	callback, item_id)	Display	  * display;	  Win‐
       dow    window;	     XmString  clip_label;	  Time	    timestamp;
	    Widget    widget;	     XmCutPasteProccallback;	   long	     *
       item_id;

DESCRIPTION
       XmClipboardStartCopy sets up storage and	 data  structures  to  receive
       clipboard  data.	  An  application  calls this function during a cut or
       copy operation.	The data  item	that  these  structures	 receive  then
       becomes the next data item in the clipboard.

       Copying	a  large  piece of data to the clipboard can take a long time.
       It is possible that, once copied, no application will ever request that
       data.   The  Motif  Toolkit provides a mechanism so that an application
       does not need to actually pass data to the clipboard until the data has
       been requested by some application.

       Instead,	 the  application  passes  format  and	length	information in
       XmClipboardCopy to the clipboard functions, along with a widget ID  and
       a  callback  function  address  that is passed in XmClipboardStartCopy.
       The widget ID is needed for communications between the clipboard	 func‐
       tions in the application that owns the data and the clipboard functions
       in the application that requests the data.

       The callback functions are responsible for copying the actual  data  to
       the clipboard via XmClipboardCopyByName.	 The callback function is also
       called if the data item is removed from the clipboard, and  the	actual
       data is therefore no longer needed.  Specifies a pointer to the Display
       structure that was returned in  a  previous  call  to  XOpenDisplay  or
       XtDisplay.  Specifies a widget's window ID that relates the application
       window to the clipboard.	 The widget's window ID	 can  be  obtained  by
       using  XtWindow.	  The  same  application instance should pass the same
       window ID to each of the clipboard functions that it calls.   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.  Specifies the time of the event that	triggered  the
       copy.   A valid timestamp must be supplied; it is not sufficient to use
       CurrentTime.  Specifies the ID of the  widget  that  receives  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 for this purpose and all the message handling
       is taken care of by the cut and paste functions.	 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.
       Specifies  the number assigned to this data item.  The application uses
       this  number  in	 calls	to  XmClipboardCopy,  XmClipboardEndCopy,  and
       XmClipboardCancelCopy.

       For  more  information on passing data by name, see XmClipboardCopy(3X)
       and XmClipboardCopyByName(3X).

       The widget and callback arguments must be present in order to pass data
       by  name.  The callback format is as follows: void (*callback) (widget,
       data_id,	 private,  reason)    Widget	widget;	   int	     *data_id;
	 int	   *private;   int	 *reason; Specifies the ID of the wid‐
       get passed to this function.  Specifies the identifying number returned
       by  XmClipboardCopy, which identifies the pass-by-name data.  Specifies
       the private information passed to XmClipboardCopy.  Specifies the  rea‐
       son,   which   is   either   XmCR_CLIPBOARD_DATA_DELETE	or  XmCR_CLIP‐
       BOARD_DATA_REQUEST.

RETURN VALUE
       The function is successful.  The function failed because the  clipboard
       was  locked  by	another	 application.  The application can continue to
       call the function again with the same parameters until  the  lock  goes
       away.   This  gives  the application the opportunity to ask if the user
       wants to keep trying or to give up on the operation.

RELATED INFORMATION
       XmClipboardCancelCopy(3X), XmClipboardCopy(3X), XmClipboardCopyBy‐
       Name(3X), XmClipboardEndCopy(3X), XmClipboardEndRetrieve(3X), XmClip‐
       boardInquireCount(3X), XmClipboardInquireFormat(3X), XmClipboard‐
       InquireLength(3X), XmClipboardInquirePendingItems(3X), XmClipboard‐
       Lock(3X), XmClipboardRegisterFormat(3X), XmClipboardRetrieve(3X),
       XmClipboardStartRetrieve(3X), XmClipboardUndoCopy(3X), XmClipboardUn‐
       lock(3X), and XmClipboardWithdrawFormat(3X).

						      XmClipboardStartCopy(3X)
[top]

List of man pages available for Ultrix

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net