Name

XtGetSelectionValue, XtGetSelectionValues, XtGetSelectionValueIncremental, XtGetSelectionValuesIncremental − obtain selection values

Syntax

void XtGetSelectionValue(w, selection, target, callback, client_data, time)
      Widget w;
      Atom selection;
      Atom target;
      XtSelectionCallbackProc callback;
      caddr_t client_data;
      Time time;

void XtGetSelectionValues(w, selection, targets, count, callback, client_data, time)
      Widget w;
      Atom selection;
      Atom *targets;
      int count;
      XtSelectionCallbackProc callback;
      caddr_t client_data;
      Time time;

void XtGetSelectionValueIncremental(w, selection, target, selection_callback, cancel_callback, client_data, time)
     Widget w;
     Atom selection;
     Atom target;
     XtSelectionIncrCallbackProc selection_callback;
     XtCancelSelectionCallbackProc cancel_callback;
     caddr_t client_data;
     Time time;

void XtGetSelectionValuesIncremental(w, selection, targets, count, selection_callback, cancel_callback, client_data, time)
     Widget w;
     Atom selection;
     Atom *targets;
     int count;
     XtSelectionIncrCallbackProc selection_callback;
     XtCancelConvertSelectionProc cancel_callback;
     caddr_t client_data;
     Time time;

Arguments

callbackSpecifies the callback procedure that is to be called when the selection value has been obtained. 

cancel_callback
Specifies the callback procedure that is to be called if the connection is lost.

client_dataSpecifies the argument that is to be passed to the specified procedure when it is called. 

client_dataSpecifies the client data (one for each target type) that is passed to the callback procedure when it is called for that target. 

countSpecifies the length of the targets and client_data lists. 

selectionSpecifies the particular selection desired (that is, primary or secondary). 

selection_callback
Specifies the callback procedure that is to be called to obtain the next incremental chunk of data or for each selection value obtained.

targetSpecifies the type of the information that is needed about the selection. 

targetsSpecifies the types of information that is needed about the selection. 

timeSpecifies the timestamp that indicates when the selection value is desired. 

wSpecifies the widget that is making the request. 

Description

The XtGetSelectionValue function requests the value of the selection that has been converted to the target type. The specified callback will be called some time after XtGetSelectionValue is called; in fact, it may be called before or after XtGetSelectionValue returns.

The XtGetSelectionValues function is similar to XtGetSelectionValue except that it takes a list of target types and a list of client data and obtains the current value of the selection converted to each of the targets. The effect is as if each target were specified in a separate call to XtGetSelectionValue. The callback is called once with the corresponding client data for each target. XtGetSelectionValues does guarantee that all the conversions will use the same selection value becaues the ownership of the selection cannot change in the middle of the list, as would be when calling XtGetSelectionValue repeatedly.

The XtGetSelectionValueIncremental function is similar to XtGetSelectionValue except that the callback procedure will be called repeatedly each time upon delivery of the next segment of the selection value. The end of the selection value is detected when callback is called with a value of length zero. If the transfer of the selection is aborted in the middle of a transfer, the cancel_callback procedure is called so that the requestor can dispose of the partial selection value it has collected up until that point.

The XtGetSelectionValuesIncremental function is similar to XtGetSelectionValueIncremental except that it takes a list of targets and client_data. XtGetSelectionValuesIncremental is equivalent to calling XtGetSelectionValueIncremental successively for each target/client_data pair. XtGetSelectionValuesIncremental does guarantee that all the conversions will use the same selection value because the ownership of the selection cannot change in the middle of the list, as would be possible when calling XtGetSelectionValueIncremental repeatedly.

See Also

XtAppGetSelectionTimeout(3Xt), XtOwnSelection(3Xt)
Guide to the XUI Toolkit Intrinsics
Guide to the Xlib Library