Motif Widget Writer's Guide Migration Version

Motif 2.1 Widget Writer's Guide

XmeSecondarySource

A toolkit function that takes ownership of the secondary selection

Format

#include <Xm/TransferP.h>
Boolean XmeSecondarySourceWidget
widgetTime time

DESCRIPTION

XmeSecondarySource takes ownership of the secondary selection. A widget usually calls XmeSecondarySource from an action routine that starts a secondary selection.

XmeSecondarySource establishes a function that is called when the widget is asked to convert the secondary selection. That function makes the following sequence of calls:

Calls the application's XmNconvertCallback procedures, if any. XmeSecondarySource passes an XmConvertCallbackStruct (with the selection member set to SECONDARY) to each of these XmNconvertCallback procedures.

Calls the source widget's convertProc trait method; convertProc is one of the trait methods of the XmQTtransfer trait. However, if any XmNconvertCallback procedure returns XmCONVERT_DONE or XmCONVERT_REFUSE, then XmeSecondarySource will not call convertProc.

XmeSecondarySource also establishes a function that is called when the widget loses the selection. That function makes the following sequence of calls:

Calls the application's XmNconvertCallback procedures, if any. XmeSecondarySource passes an XmConvertCallbackStruct to each of these XmNconvertCallback procedures. XmeSecondarySource initializes the XmConvertCallbackStruct as follows:

Sets the selection member to SECONDARY

Sets the target member to _MOTIF_LOSE_SELECTION

Calls the source widget's convertProc trait method. However, if any XmNconvertCallback procedure returns XmCONVERT_DONE or XmCONVERT_REFUSE, then XmeSecondarySource will not call convertProc.

XmeSecondarySource is used in conjunction with XmeSecondaryTransfer.

widget

Specifies the widget that is to take ownership of the selection.

time

Specifies the time of the transfer. This is usually the timestamp from the event passed to an action routine. You should call XtLastTimeStampProcessed to generate the time value. If you set time to CurrentTime or 0, UTM will automatically change the call to XtLastTimeStampProcessed.

RETURN

This function returns False if the widget cannot take ownership of the secondary selection. Otherwise, it returns True.

RELATED

XmQTtransfer(3), XmTransferDone(3), XmTransferValue(3), XmeClipboardSink(3), XmeClipboardSource(3), XmeConvertMerge(3), XmeDragSource(3), XmeDropSink(3), XmeGetEncodingAtom(3), XmePrimarySink(3), XmePrimarySource(3), XmeSecondarySink(3), XmeSecondaryTransfer(3), XmeStandardConvert(3), XmeStandardTargets(3), and XmeTransferAddDoneProc(3).