Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   10987 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

XQueryPointer()						       XQueryPointer()

Name
  XQueryPointer – get the current pointer location.

Synopsis
  Bool	  XQueryPointer(display,   window,   root_return,   child_return,
  root_x_return, root_y_return, win_x_return, win_y_return, mask_return)
	Display *display;
	Window window;
	Window *root_return, *child_return;
	int *root_x_return, *root_y_return;
	int *win_x_return, *win_y_return;
	unsigned int *mask_return;

Arguments
  display     Specifies a  connection  to  an  X  server;  returned  from
	      XOpenDisplay().

  window      Specifies a window which indicates which screen the pointer
	      position is returned for, and child_return will be a  child
	      of this window if pointer is inside a child.

  root_return Returns the root window ID the pointer is currently on.

  child_return
	      Returns the ID of the child of w the pointer is located in,
	      or zero if it not in a child.

  root_x_returReturn the x and y coordinates of the pointer  relative  to
  root_y_returthe root's origin.

  win_x_returnReturn  the  x and y coordinates of the pointer relative to
  win_y_returnthe origin of window window.

  mask_return Returns the current state of the modifier keys and  pointer
	      buttons.	 This  is a mask composed of the OR of any number
	      of the following symbols: ShiftMask, LockMask, ControlMask,
	      Mod1Mask,	 Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask, Button1‐
	      Mask, Button2Mask, Button3Mask, Button4Mask, Button5Mask.

Returns
  True if the pointer is on the same screen as the window argument,  else
  False.

Description
  XQueryPointer()  gets	 the pointer coordinates relative to a window and
  relative to  the  root  window,  the	root_return  window  ID	 and  the
  child_return	window	ID  (if any) the pointer is currently in, and the
  current state of modifier keys and buttons.

  If XQueryPointer() returns False, then the pointer is not on	the  same
  screen   as	window,	  child_return	is  None,  and	win_x_return  and
  win_y_return	are  zero.   However,  root_return,  root_x_return,   and
  root_y_return	 are  still valid.  If XQueryPointer() returns True, then
  the pointer is on the same screen as window, and all return values  are
  valid.

  The  logical	state  of  the	pointer buttons and modifier keys can lag
  behind their physical state if device event processing is frozen due to
  a grab.

Errors
  BadWindow

See Also
  XChangeActivePointerGrab(),	XChangePointerControl(),  XGetPointerCon‐
  trol(),  XGetPointerMapping(),  XGrabPointer(),   XSetPointerMapping(),
  XUngrabPointer(), XWarpPointer().

Xlib - Pointer						       XQueryPointer()

Vote for polarhome