NAME

XWarpPointer − move the pointer to another point on the screen. 

Synopsis

XWarpPointer(display, src_w, dest_w, src_x, src_y,

src_width, src_height, dest_x, dest_y)
Display *display;
Window src_w, dest_w;
int src_x, src_y;
unsigned int src_width, src_height;
int dest_x, dest_y;

Arguments

displaySpecifies a connection to an X server; returned from XOpenDisplay(). 

src_wSpecifies the ID of the source window.  You can also pass None. 

dest_wSpecifies the ID of the destination window.  You can also pass None. 

src_x

src_ySpecify the x and y coordinates within the source window.  These are used with src_width and src_height to determine the rectangle the pointer must be in in order to be moved.  They are not the present pointer position.  If src_w is None, these coordinates are relative to the root window of src_w. 

src_width

src_heightSpecify the width and height in pixels of the source area.  Used with src_x and src_y. 

dest_x

dest_ySpecify the destination x and y coordinates within the destination window.  If dest_w is None, these coordinates are relative to the root window of dest_w. 

Description

XWarpPointer() moves the pointer suddenly from one point on the screen to another.  If dest_w is a window, XWarpPointer() moves the pointer to [dest_x, dest_y] relative to the destination window’s origin.  If dest_w is None, XWarpPointer() moves the pointer according to the offsets [dest_x, dest_y] relative to the current position of the pointer.  If src_w is None, the move is independent of the current cursor position (dest_x and dest_y use global coordinates).  If the source window is not None, the move only takes place if the pointer is currently contained in a visible portion of the rectangle of the source window (including its inferiors) specified by src_x, src_y, src_width and src_height.  If src_width is zero (0), the pointer must be between src_x and the right edge of the window to be moved.  If src_height is zero (0), the pointer must be between src_y and the bottom edge of the window to be moved.  XWarpPointer() cannot be used to move the pointer outside the confine_to window of an active pointer grab.  If such an attempt is made, the pointer is moved to the point on the border of the confine_to window nearest the requested destination.  XWarpPointer() generates events as if the user had (instantaneously) moved the pointer.  This function should not be used unless absolutely necessary, and then only in tightly controlled, predictable situations.  It has the potential to confuse the user. 

Errors

BadWindow

See Also

XChangeActivePointerGrab(), XChangePointerControl(), XGetPointerControl(), XGetPointerMapping(), XGrabPointer(), XQueryPointer(), XSetPointerMapping(), XUngrabPointer(). 

Copyright O’Reilly & Assoc.  —