man/XSetSelectionOwner.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 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 is 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 dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XSetSelectionOwner __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XSetSelectionOwner, XGetSelectionOwner, XConvertSelection \- manipulate window selection
 145 .SH SYNTAX
 146 .HP
 147 int XSetSelectionOwner\^(\^Display *\fIdisplay\fP\^, Atom \fIselection\fP\^,
 148 Window \fIowner\fP\^, Time \fItime\fP\^);
 149 .HP
 150 Window XGetSelectionOwner\^(\^Display *\fIdisplay\fP\^, Atom
 151 \fIselection\fP\^);
 152 .HP
 153 int XConvertSelection\^(\^Display *\fIdisplay\fP\^, Atom \fIselection\fP\^,
 154 Atom \fItarget\fP\^, Atom \fIproperty\fP\^, Window \fIrequestor\fP\^, Time
 155 \fItime\fP\^);
 156 .SH ARGUMENTS
 157 .IP \fIdisplay\fP 1i
 158 Specifies the connection to the X server.
 159 .IP \fIowner\fP 1i
 160 Specifies the owner of the specified selection atom.
 161 You can pass a window or
 162 .ZN None .
 163 .IP \fIproperty\fP 1i
 164 Specifies the property name.
 165 You also can pass
 166 .ZN None .
 167 .IP \fIrequestor\fP 1i
 168 Specifies the requestor.
 169 .IP \fIselection\fP 1i
 170 Specifies the selection atom.
 171 .IP \fItarget\fP 1i
 172 Specifies the target atom.
 173 .IP \fItime\fP 1i
 174 Specifies the time.
 175 You can pass either a timestamp or
 176 .ZN CurrentTime .
 177 .SH DESCRIPTION
 178 The
 179 .ZN XSetSelectionOwner
 180 function changes the owner and last-change time for the specified selection
 181 and has no effect if the specified time is earlier than the current
 182 last-change time of the specified selection
 183 or is later than the current X server time.
 184 Otherwise, the last-change time is set to the specified time,
 185 with
 186 .ZN CurrentTime
 187 replaced by the current server time.
 188 If the owner window is specified as
 189 .ZN None ,
 190 then the owner of the selection becomes
 191 .ZN None
 192 (that is, no owner).
 193 Otherwise, the owner of the selection becomes the client executing
 194 the request.
 195 .LP
 196 If the new owner (whether a client or
 197 .ZN None )
 198 is not
 199 the same as the current owner of the selection and the current
 200 owner is not
 201 .ZN None ,
 202 the current owner is sent a
 203 .ZN SelectionClear
 204 event.
 205 If the client that is the owner of a selection is later
 206 terminated (that is, its connection is closed)
 207 or if the owner window it has specified in the request is later
 208 destroyed,
 209 the owner of the selection automatically
 210 reverts to
 211 .ZN None ,
 212 but the last-change time is not affected.
 213 The selection atom is uninterpreted by the X server.
 214 .ZN XGetSelectionOwner
 215 returns the owner window, which is reported in
 216 .ZN SelectionRequest
 217 and
 218 .ZN SelectionClear
 219 events.
 220 Selections are global to the X server.
 221 .LP
 222 .ZN XSetSelectionOwner
 223 can generate
 224 .ZN BadAtom
 225 and
 226 .ZN BadWindow
 227 errors.
 228 .LP
 229 The
 230 .ZN XGetSelectionOwner
 231 function
 232 returns the window ID associated with the window that currently owns the
 233 specified selection.
 234 If no selection was specified, the function returns the constant
 235 .ZN None .
 236 If
 237 .ZN None
 238 is returned,
 239 there is no owner for the selection.
 240 .LP
 241 .ZN XGetSelectionOwner
 242 can generate a
 243 .ZN BadAtom
 244 error.
 245 .LP
 246 .ZN XConvertSelection
 247 requests that the specified selection be converted to the specified target
 248 type:
 249 .IP \(bu 5
 250 If the specified selection has an owner, the X server sends a
 251 .ZN SelectionRequest
 252 event to that owner.
 253 .IP \(bu 5
 254 If no owner for the specified
 255 selection exists, the X server generates a
 256 .ZN SelectionNotify
 257 event to the
 258 requestor with property
 259 .ZN None .
 260 .LP
 261 The arguments are passed on unchanged in either of the events.
 262 There are two predefined selection atoms: PRIMARY and SECONDARY.
 263 .LP
 264 .ZN XConvertSelection
 265 can generate
 266 .ZN BadAtom
 267 and
 268 .ZN BadWindow
 269 errors.
 270 .SH DIAGNOSTICS
 271 .TP 1i
 272 .ZN BadAtom
 273 A value for an Atom argument does not name a defined Atom.
 274 .TP 1i
 275 .ZN BadWindow
 276 A value for a Window argument does not name a defined Window.
 277 .SH "SEE ALSO"
 278 \fI\*(xL\fP