dwtstartcopyfromclipboard(3dwt) [ultrix man page]
DwtStartCopyFromClipboard(3Dwt) DwtStartCopyFromClipboard(3Dwt) Name DwtStartCopyFromClipboard - Indicates that the application is ready to start copying data from the clipboard and locks the clipboard. Syntax int DwtStartCopyFromClipboard(display, window, time) Display *display; Window window; Time time; 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. time Specifies the timestamping of the event that triggered the copy. Description The DwtStartCopyFromClipboard function notifies the cut and paste functions that the application is ready to start copying data from the clipboard. DwtStartCopyFromClipboard locks the clipboard and remains locked until you call DwtEndCopyFromClipboard. After calling DwtStartCopyFromClipboard, an application can make multiple calls to DwtCopyFromClipboard requesting data in one or several formats. You specify the format by setting the format_name argument to DwtCopyFromClipboard. Each call to DwtCopyFromClipboard in a spec- ified format results in data being incrementally copied from the clipboard until all data with the specified format has been copied. When all data in a specified format has been successfully copied, DwtCopyFromClipboard returns ClipboardSuccess. When more data remains to be copied in the specified format, DwtCopyFromClipboard returns ClipboardTruncate. An application can copy data in as many formats as desired before calling DwtEndCopyFromClipboard. It is recommended that any calls to inquire routines needed by the application be made between the call to DwtStartCopyFromClipboard and the call to DwtEndCopyFromClipboard. That way, the application does not need to call DwtClipboardLock and DwtClipboardUnlock. To perform cut and paste operations between your application and an application using the ICCCM clipboard selection mechanism, you must use DwtStartCopyToClipboard and provide a timestamping value for time, not a CurrentTime value. Use of the value CurrentTime for time may cause the ICCCM interface to fail. Applications do not need to use DwtStartCopyFromClipboard and DwtEndCopyFromClipboard, in which case DwtCopyFromClipboard works as docu- mented. However, using these two functions allows incremental copying from the clipboard and ensures ICCCM compatibility. 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 DwtCopyFromClipboard(3Dwt), DwtEndCopyFromClipboard(3Dwt) Guide to the XUI Toolkit: C Language Binding Guide to the XUI Toolkit Intrinsics: C Language Binding DwtStartCopyFromClipboard(3Dwt)
Check Out this Related Man Page
DwtStartCopyToClipboard(3Dwt) DwtStartCopyToClipboard(3Dwt) Name DwtStartCopyToClipboard - Sets up storage and data structures to receive clipboard data. Syntax int DwtStartCopyToClipboard(display, window, clip_label, time, widget, callback, item_id) Display *display; Window window; DwtCompString clip_label; Time time; 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. time Specifies the timestamping of the event that triggered the copy. 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 DwtStartCopyToClipboard function sets up storage and data structures to receive clipboard data. An application calls DwtStartCopyTo- Clipboard during a cut or copy operation. The data item that these structures receive through calls to DwtCopyToClipboard then becomes the next item to be pasted (the next-paste item) in the clipboard after the call to DwtEndCopyToClipboard. DwtStartCopyToClipboard is like DwtBeginCopyToClipboard except that it has the time argument to support the ICCCM clipboard selection mech- anism. To perform cut and paste operations between your application and an application using the ICCCM clipboard selection mechanism, you must use DwtStartCopyToClipboard and provide a timestamping value for time, not a CurrentTime value. Use of the value CurrentTime for time may cause the ICCCM interface to fail. The window 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 DwtStartCopyToClipboard. 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), DwtBeginCopyToClipboard(3Dwt) Guide to the XUI Toolkit: C Language Binding Guide to the XUI Toolkit Intrinsics: C Language Binding DwtStartCopyToClipboard(3Dwt)