man/XSetInputFocus.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 XSetInputFocus __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XSetInputFocus, XGetInputFocus \- control input focus
 145 .SH SYNTAX
 146 .HP
 147 int XSetInputFocus\^(\^Display *\fIdisplay\fP\^, Window \fIfocus\fP\^, int
 148 \fIrevert_to\fP\^, Time \fItime\fP\^);
 149 .HP
 150 int XGetInputFocus\^(\^Display *\fIdisplay\fP\^, Window *\fIfocus_return\fP\^,
 151 int *\fIrevert_to_return\fP\^);
 152 .SH ARGUMENTS
 153 .IP \fIdisplay\fP 1i
 154 Specifies the connection to the X server.
 155 .IP \fIfocus\fP 1i
 156 Specifies the window,
 157 .ZN PointerRoot ,
 158 or
 159 .ZN None .
 160 .IP \fIfocus_return\fP 1i
 161 Returns the focus window,
 162 .ZN PointerRoot ,
 163 or
 164 .ZN None .
 165 .IP \fIrevert_to\fP 1i
 166 Specifies where the input focus reverts to if the window becomes not
 167 viewable.
 168 You can pass
 169 .ZN RevertToParent ,
 170 .ZN RevertToPointerRoot ,
 171 or
 172 .ZN RevertToNone .
 173 .IP \fIrevert_to_return\fP 1i
 174 Returns the current focus state
 175 .Pn ( RevertToParent ,
 176 .ZN RevertToPointerRoot ,
 177 or
 178 .ZN RevertToNone ).
 179 .IP \fItime\fP 1i
 180 Specifies the time.
 181 You can pass either a timestamp or
 182 .ZN CurrentTime .
 183 .SH DESCRIPTION
 184 The
 185 .ZN XSetInputFocus
 186 function changes the input focus and the last-focus-change time.
 187 It has no effect if the specified time is earlier than the current
 188 last-focus-change time or is later than the current X server time.
 189 Otherwise, the last-focus-change time is set to the specified time
 190 .Pn ( CurrentTime
 191 is replaced by the current X server time).
 192 .ZN XSetInputFocus
 193 causes the X server to generate
 194 .ZN FocusIn
 195 and
 196 .ZN FocusOut
 197 events.
 198 .LP
 199 Depending on the focus argument,
 200 the following occurs:
 201 .IP \(bu 5
 202 If focus is
 203 .ZN None ,
 204 all keyboard events are discarded until a new focus window is set,
 205 and the revert_to argument is ignored.
 206 .IP \(bu 5
 207 If focus is a window,
 208 it becomes the keyboard's focus window.
 209 If a generated keyboard event would normally be reported to this window
 210 or one of its inferiors, the event is reported as usual.
 211 Otherwise, the event is reported relative to the focus window.
 212 .IP \(bu 5
 213 If focus is
 214 .ZN PointerRoot ,
 215 the focus window is dynamically taken to be the root window of whatever screen
 216 the pointer is on at each keyboard event.
 217 In this case, the revert_to argument is ignored.
 218 .LP
 219 The specified focus window must be viewable at the time
 220 .ZN XSetInputFocus
 221 is called,
 222 or a
 223 .ZN BadMatch
 224 error results.
 225 If the focus window later becomes not viewable,
 226 the X server
 227 evaluates the revert_to argument to determine the new focus window as follows:
 228 .IP \(bu 5
 229 If revert_to is
 230 .ZN RevertToParent ,
 231 the focus reverts to the parent (or the closest viewable ancestor),
 232 and the new revert_to value is taken to be
 233 .ZN RevertToNone .
 234 .IP \(bu 5
 235 If revert_to is
 236 .ZN RevertToPointerRoot
 237 or
 238 .ZN RevertToNone ,
 239 the focus reverts to
 240 .ZN PointerRoot
 241 or
 242 .ZN None ,
 243 respectively.
 244 When the focus reverts,
 245 the X server generates
 246 .ZN FocusIn
 247 and
 248 .ZN FocusOut
 249 events, but the last-focus-change time is not affected.
 250 .LP
 251 .ZN XSetInputFocus
 252 can generate
 253 .ZN BadMatch ,
 254 .ZN BadValue ,
 255 and
 256 .ZN BadWindow
 257 errors.
 258 .LP
 259 The
 260 .ZN XGetInputFocus
 261 function returns the focus window and the current focus state.
 262 .SH DIAGNOSTICS
 263 .TP 1i
 264 .ZN BadValue
 265 Some numeric value falls outside the range of values accepted by the request.
 266 Unless a specific range is specified for an argument, the full range defined
 267 by the argument's type is accepted.  Any argument defined as a set of
 268 alternatives can generate this error.
 269 .TP 1i
 270 .ZN BadWindow
 271 A value for a Window argument does not name a defined Window.
 272 .SH "SEE ALSO"
 273 XWarpPointer(__libmansuffix__)
 274 .br
 275 \fI\*(xL\fP