man/XQueryPointer.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 XQueryPointer __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XQueryPointer \- get pointer coordinates
 145 .SH SYNTAX
 146 .HP
 147 Bool XQueryPointer\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Window
 148 *\fIroot_return\fP\^, Window *\fIchild_return\fP\^, int
 149 *\fIroot_x_return\fP\^, int *\fIroot_y_return\fP\^, int *\fIwin_x_return\fP\^,
 150 int *\fIwin_y_return\fP\^, unsigned int *\fImask_return\fP\^);
 151 .SH ARGUMENTS
 152 .IP \fIchild_return\fP 1i
 153 Returns the child window that the pointer is located in, if any.
 154 .IP \fIdisplay\fP 1i
 155 Specifies the connection to the X server.
 156 .IP \fImask_return\fP 1i
 157 Returns the current state of the modifier keys and pointer buttons.
 158 .ds Ro that the pointer is in
 159 .IP \fIroot_return\fP 1i
 160 Returns the root window \*(Ro.
 161 .IP \fIroot_x_return\fP 1i
 162 .br
 163 .ns
 164 .IP \fIroot_y_return\fP 1i
 165 Return the pointer coordinates relative to the root window's origin.
 166 .IP \fIw\fP 1i
 167 Specifies the window.
 168 .IP \fIwin_x_return\fP 1i
 169 .br
 170 .ns
 171 .IP \fIwin_y_return\fP 1i
 172 Return the pointer coordinates relative to the specified window.
 173 .SH DESCRIPTION
 174 The
 175 .ZN XQueryPointer
 176 function returns the root window the pointer is logically on and the pointer
 177 coordinates relative to the root window's origin.
 178 If
 179 .ZN XQueryPointer
 180 returns
 181 .ZN False ,
 182 the pointer is not on the same screen as the specified window, and
 183 .ZN XQueryPointer
 184 returns
 185 .ZN None
 186 to child_return and zero to win_x_return and win_y_return.
 187 If
 188 .ZN XQueryPointer
 189 returns
 190 .ZN True ,
 191 the pointer coordinates returned to win_x_return and win_y_return
 192 are relative to the origin of the specified window.
 193 In this case,
 194 .ZN XQueryPointer
 195 returns the child that contains the pointer, if any,
 196 or else
 197 .ZN None
 198 to child_return.
 199 .LP
 200 .ZN XQueryPointer
 201 returns the current logical state of the keyboard buttons
 202 and the modifier keys in mask_return.
 203 It sets mask_return to the bitwise inclusive OR of one or more
 204 of the button or modifier key bitmasks to match
 205 the current state of the mouse buttons and the modifier keys.
 206 .LP
 207 .ZN XQueryPointer
 208 can generate a
 209 .ZN BadWindow
 210 error.
 211 .SH DIAGNOSTICS
 212 .TP 1i
 213 .ZN BadWindow
 214 A value for a Window argument does not name a defined Window.
 215 .SH "SEE ALSO"
 216 XGetWindowAttributes(__libmansuffix__),
 217 XQueryTree(__libmansuffix__)
 218 .br
 219 \fI\*(xL\fP