XWarpPointer(XS)  X Version 11 (Release 5) 6 January 1993   XWarpPointer(XS)


 Name

    XWarpPointer - move pointer

 Syntax


    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


    destw     Specifies the destination window or None.

    destx
    desty     Specify the x and y coordinates within the destination window.

    display    Specifies the connection to the X server.

    srcx
    srcy
    srcwidth
    srcheight Specify a rectangle in the source window.

    srcw      Specifies the source window or None.

 Description

    If destw is None, XWarpPointer moves the pointer by the offsets (destx,
    desty) relative to the current position of the pointer.  If destw is a
    window, XWarpPointer moves the pointer to the offsets (destx, desty)
    relative to the origin of destw.  However, if srcw is a window, the
    move only takes place if the window srcw contains the pointer and if the
    specified rectangle of srcw contains the pointer.

    The srcx and srcy coordinates are relative to the origin of srcw.  If
    srcheight is zero, it is replaced with the current height of srcw minus
    srcy.  If srcwidth is zero, it is replaced with the current width of
    srcw minus srcx.

    There is seldom any reason for calling this function.  The pointer should
    normally be left to the user.  If you do use this function, however, it
    generates events just as if the user had instantaneously moved the
    pointer from one position to another.  Note that you cannot use XWarp-
    Pointer to move the pointer outside the confineto window of an active
    pointer grab.  An attempt to do so will only move the pointer as far as
    the closest edge of the confineto window.

    XWarpPointer can generate a ``BadWindow'' error.

 Diagnostics


    ``BadWindow''  A value for a Window argument does not name a defined Win-
                   dow.

 See also

    XSetInputFocus(XS)
    Xlib - C Language X Interface