man/XtGetSelectionValue.man

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