man/XtGetSelectionValueIncremental.man

   1 .\" Copyright (c) 1993, 1994  X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice shall be included in
  11 .\" all copies or substantial portions of the Software.
  12 .\"
  13 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  16 .\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  17 .\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  18 .\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  19 .\" SOFTWARE.
  20 .\"
  21 .\" Except as contained in this notice, the name of the X Consortium shall not
  22 .\" be used in advertising or otherwise to promote the sale, use or other
  23 .\" dealing in this Software without prior written authorization from the
  24 .\" X Consortium.
  25 .\"
  26 .ds tk X Toolkit
  27 .ds xT X Toolkit Intrinsics \- C Language Interface
  28 .ds xI Intrinsics
  29 .ds xW X Toolkit Athena Widgets \- C Language Interface
  30 .ds xL Xlib \- C Language X Interface
  31 .ds xC Inter-Client Communication Conventions Manual
  32 .ds Rn 3
  33 .ds Vn 2.2
  34 .hw XtGet-Selection-Value-Incremental XtGet-Selection-Values-Incremental wid-get
  35 .na
  36 .de Ds
  37 .nf
  38 .\\$1D \\$2 \\$1
  39 .ft CW
  40 .ps \\n(PS
  41 .\".if \\n(VS>=40 .vs \\n(VSu
  42 .\".if \\n(VS<=39 .vs \\n(VSp
  43 ..
  44 .de De
  45 .ce 0
  46 .if \\n(BD .DF
  47 .nr BD 0
  48 .in \\n(OIu
  49 .if \\n(TM .ls 2
  50 .sp \\n(DDu
  51 .fi
  52 ..
  53 .de IN          \" send an index entry to the stderr
  54 ..
  55 .de Pn
  56 .ie t \\$1\fB\^\\$2\^\fR\\$3
  57 .el \\$1\fI\^\\$2\^\fP\\$3
  58 ..
  59 .de ZN
  60 .ie t \fB\^\\$1\^\fR\\$2
  61 .el \fI\^\\$1\^\fP\\$2
  62 ..
  63 .ny0
  64 .TH XtGetSelectionValueIncremental __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
  65 .SH NAME
  66 XtGetSelectionValueIncremental, XtGetSelectionValuesIncremental \- obtain selection values
  67 .SH SYNTAX
  68 .HP
  69 void XtGetSelectionValueIncremental(Widget \fIw\fP, Atom \fIselection\fP, Atom
  70 \fItarget\fP, XtSelectionCallbackProc \fIcallback\fP, XtPointer
  71 \fIclient_data\fP, Time \fItime\fP);
  72 .HP
  73 void XtGetSelectionValuesIncremental(Widget \fIw\fP, Atom \fIselection\fP,
  74 Atom *\fItargets\fP, int \fIcount\fP, XtSelectionCallbackProc \fIcallback\fP,
  75 XtPointer \fIclient_data\fP, Time \fItime\fP);
  76 .SH ARGUMENTS
  77 .ds Cb \ that is to be called when the selection value has been obtained
  78 .IP \fIcallback\fP 1i
  79 Specifies the callback procedure\*(Cb.
  80 .ds Cd it is called
  81 .IP \fIclient_data\fP 1i
  82 Specifies the argument that is to be passed to the specified procedure
  83 when \*(Cd.
  84 .IP \fIclient_data\fP 1i
  85 Specifies the client data (one for each target type)
  86 that is passed to the callback procedure when it is called for that target.
  87 .IP \fIcount\fP 1i
  88 Specifies the length of the targets and client_data lists.
  89 .IP \fIselection\fP 1i
  90 Specifies the particular selection desired (that is, primary or secondary).
  91 .IP \fItarget\fP 1i
  92 Specifies the type of the information that is needed about the selection.
  93 .IP \fItargets\fP 1i
  94 Specifies the types of information that is needed about the selection.
  95 .ds Ti value is desired
  96 .IP \fItime\fP 1i
  97 Specifies the timestamp that indicates when the selection \*(Ti.
  98 .ds Wi that is making the request
  99 .IP \fIw\fP 1i
 100 Specifies the widget \*(Wi.
 101 .SH DESCRIPTION
 102 The
 103 .ZN XtGetSelectionValueIncremental
 104 function is similar to
 105 .ZN XtGetSelectionValue
 106 except that the \fIselection_callback\fP procedure will be called
 107 repeatedly upon delivery of multiple segments of the selection value.
 108 The end of the selection value is indicated when \fIselection_callback\fP
 109 is called with a non-NULL value of length zero, which must still be
 110 freed by the client. If the transfer of the selection is aborted in the
 111 middle of a transfer (for example, because to timeout), the
 112 \fIselection_callback\fP procedure is called with a type value equal
 113 to the symbolic constant
 114 .ZN XT_CONVERT_FAIL
 115 so that the requestor can dispose of the partial selection value it has
 116 collected up until that point. Upon receiving
 117 .ZN XT_CONVERT_FAIL ,
 118 the requesting client must determine for itself whether or not a
 119 partially completed transfer is meaningful.
 120 .LP
 121 The
 122 .ZN XtGetSelectionValuesIncremental
 123 function is similar to
 124 .ZN XtGetSelectionValueIncremental
 125 except that it takes a list of target types and a list of client data
 126 and obtains the current value of the selection converted to each of the targets.
 127 The effect is as if each target were specified in a separate call to
 128 .ZN XtGetSelectionValueIncremental .
 129 The callback is called once with the corresponding client data for each target.
 130 .ZN XtGetSelectionValuesIncremental
 131 does guarantee that all the conversions will use the same selection value
 132 because the ownership of the selection cannot change in the middle of the list,
 133 as would be when calling
 134 .ZN XtGetSelectionValueIncremental
 135 repeatedly.
 136 .SH "SEE ALSO"
 137 .br
 138 \fI\*(xT\fP
 139 .br
 140 \fI\*(xL\fP