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

displaySpecifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay. For information on XOpenDisplay and the Display structure, see the Guide to the Xlib Library: C Language Binding.

windowSpecifies 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.

timeSpecifies 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 specified 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 documented. However, using these two functions allows incremental copying from the clipboard and ensures ICCCM compatibility.

Return Value

This function returns one of these status return constants:

ClipboardSuccess	The function is successful.
ClipboardLocked	The function failed because the clipboard was locked by another application. The application can continue to call the function with the same parameters until the clipboard is unlocked. Optionally, the application can ask if the user wants to keep trying or to give up on the operation.