Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XtGetSelectionValueIncremental(3) XT FUNCTIONS XtGetSelectionValueIncremental(3)

NAME
     XtGetSelectionValueIncremental,  XtGetSelectionValuesIncremental  -  obtain
     selection values

SYNTAX
     #include <X11/Intrinsic.h>

     void XtGetSelectionValueIncremental(Widget w, Atom selection, Atom  target,
	    XtSelectionCallbackProc callback, XtPointer client_data, Time time);

     void  XtGetSelectionValuesIncremental(Widget  w, Atom selection, Atom *tar-
	    gets,  int	count,	 XtSelectionCallbackProc   callback,   XtPointer
	    *client_data, Time time);

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

     client_data
	       Specifies the argument that is to be passed to the specified pro-
	       cedure when it is called.

     client_data
	       Specifies the client data (one for  each  target  type)	that  is
	       passed  to the callback procedure when it is called for that tar-
	       get.

     count     Specifies the length of the targets and client_data lists.

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

     target    Specifies  the  type  of the information that is needed about the
	       selection.

     targets   Specifies the types of information that is needed about	the  se-
	       lection.

     time      Specifies  the  timestamp that indicates when the selection value
	       is desired.

     w	       Specifies the widget that is making the request.

DESCRIPTION
     The XtGetSelectionValueIncremental function is similar to XtGetSelectionVa-
     lue except that the selection_callback procedure will be called  repeatedly
     upon  delivery of multiple segments of the selection value.  The end of the
     selection value is indicated when selection_callback is called with a  non-
     NULL value of length zero, which must still be freed by the client.  If the
     transfer of the selection is aborted in the middle of a transfer (for exam-
     ple, because to timeout), the selection_callback procedure is called with a
     type  value  equal to the symbolic constant XT_CONVERT_FAIL so that the re-
     questor can dispose of the partial selection value it has collected up  un-
     til that point.  Upon receiving XT_CONVERT_FAIL, the requesting client must
     determine for itself whether or not a partially completed transfer is mean-
     ingful.

     The  XtGetSelectionValuesIncremental function is similar to XtGetSelection-
     ValueIncremental 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  XtGetSelectionValueIncremental.  The callback is called
     once with the corresponding client data for each  target.	 XtGetSelection-
     ValuesIncremental 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 when calling XtGetSelectionValueIncremental
     repeatedly.

SEE ALSO
     X Toolkit Intrinsics - C Language Interface
     Xlib - C Language X Interface

X Version 11			   libXt 1.3.1 XtGetSelectionValueIncremental(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XtGetSelectionValueIncremental&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help