xref: /386bsd/usr/X386/man/man3/XQueryPointer.3x (revision a2142627)
.\\$1D \\$2 \\$1
.ps \\n(PS
.if \\n(VS>=40 .vs \\n(VSu
.if \\n(VS<=39 .vs \\n(VSp
..

0 .nr BD 0

..

.KS .TA .5i 3i

..
.KE

.. .. .KS

.D

choose appropriate monospace font
the imagen conditional, 480,
may be changed to L if LB is too
heavy for your eyes...

.. .R .. .. .. .TB

\\*(NO .R .. . \" Note End -- doug kraft 3/85

0 .. .ny0

XQueryPointer 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
NAME
XQueryPointer - get pointer coordinates
SYNTAX
$Header: XQueryPntr.f,v 1.1 88/02/26 10:02:18 mento Exp $
Bool XQueryPointer\^(\^display, w\^, root_return\^, child_return\^, root_x_return\^, root_y_return\^,

win_x_return\^, win_y_return\^, mask_return\^)

Display *display\^;

Window w\^;

Window *root_return\^, *child_return\^;

int *root_x_return\^, *root_y_return\^;

int *win_x_return\^, *win_y_return\^;

unsigned int *mask_return\^;

ARGUMENTS
child_return 1i
Returns the child window that the pointer is located in, if any. $Header: display.a,v 1.1 88/02/26 10:26:29 mento Exp $
display 1i
Specifies the connection to the X server. $Header: mask1.a,v 1.1 88/02/26 10:28:48 mento Exp $
mask_return 1i
Returns the current state of the modifier keys and pointer buttons. $Header: root_gen.a,v 1.2 88/08/04 11:19:15 mento Exp $
root_return 1i
Returns the root window \*(Ro. $Header: rootxy.a,v 1.2 88/08/17 09:03:18 mento Exp $
root_x_return 1i

.ns

root_y_return 1i
Return the pointer coordinates relative to the root window's origin. $Header: w.a,v 1.2 88/05/07 11:35:31 mento Exp $
w 1i
Specifies the window. $Header: winxy.a,v 1.2 88/08/17 09:04:07 mento Exp $
win_x_return 1i

.ns

win_y_return 1i
Return the pointer coordinates relative to the specified window.
DESCRIPTION
$Header: XQueryPntr.d,v 1.2 88/06/11 07:52:42 mento Exp $
The .ZN XQueryPointer function returns the root window the pointer is logically on and the pointer coordinates relative to the root window's origin. If .ZN XQueryPointer returns .ZN False , the pointer is not on the same screen as the specified window, and .ZN XQueryPointer returns .ZN None to child_return and zero to win_x_return and win_y_return. If .ZN XQueryPointer returns .ZN True , the pointer coordinates returned to win_x_return and win_y_return are relative to the origin of the specified window. In this case, .ZN XQueryPointer returns the child that contains the pointer, if any, or else .ZN None to child_return.

.ZN XQueryPointer returns the current logical state of the keyboard buttons and the modifier keys in mask_return. It sets mask_return to the bitwise inclusive OR of one or more of the button or modifier key bitmasks to match the current state of the mouse buttons and the modifier keys.

.ZN XQueryPointer can generate a .ZN BadWindow error.

DIAGNOSTICS
$Header: badwindow.e,v 1.1 87/09/04 08:23:20 mento Exp $

1i .ZN BadWindow A value for a Window argument does not name a defined Window.

"SEE ALSO"
XGetWindowAttributes(3X11), XQueryTree(3X11)

\*(xL