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


 Name

    XQueryPointer - get pointer coordinates

 Syntax


    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


    childreturn   Returns the child window that the pointer is located in,
                   if any.

    display        Specifies the connection to the X server.

    maskreturn    Returns the current state of the modifier keys and pointer
                   buttons.

    rootreturn    Returns the root window that the pointer is in.

    rootxreturn
    rootyreturn  Return the pointer coordinates relative to the root
                   window's origin.

    w              Specifies the window.

    winxreturn
    winyreturn   Return the pointer coordinates relative to the specified
                   window.

 Description

    The XQueryPointer function returns the root window the pointer is logi-
    cally on and the pointer coordinates relative to the root window's ori-
    gin.  If XQueryPointer returns False, the pointer is not on the same
    screen as the specified window, and XQueryPointer returns None to
    childreturn and zero to winxreturn and winyreturn.  If XQueryPointer
    returns True, the pointer coordinates returned to winxreturn and
    winyreturn are relative to the origin of the specified window.  In this
    case, XQueryPointer returns the child that contains the pointer, if any,
    or else None to childreturn.

    XQueryPointer returns the current logical state of the keyboard buttons
    and the modifier keys in maskreturn.  It sets maskreturn 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.

    XQueryPointer can generate a ``BadWindow'' error.

 Diagnostics


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

 See also

    XGetWindowAttributes(XS), XQueryTree(XS)
    Xlib - C Language X Interface