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


 Name

    XSendEvent - send events and pointer motion history structure

 Syntax


    Status XSendEvent(display, w, propagate, event_mask, event_send)
          Display *display;
          Window w;
          Bool propagate;
          long event_mask;
          XEvent *event_send;

    unsigned long XDisplayMotionBufferSize(display)
          Display *display;

    XTimeCoord *XGetMotionEvents(display, w, start, stop, nevents_return)
          Display *display;
          Window w;
          Time start, stop;
          int *nevents_return;


 Arguments


    display        Specifies the connection to the X server.

    eventmask     Specifies the event mask.

    eventsend     Specifies the event that is to be sent.

    neventsreturn Returns the number of events from the motion history
                   buffer.

    propagate      Specifies a Boolean value.

    start
    stop           Specify the time interval in which the events are returned
                   from the motion history buffer.  You can pass a timestamp
                   or CurrentTime.

    w              Specifies the window the window the event is to be sent
                   to, PointerWindow, or InputFocus.

 Description

    The XSendEvent function identifies the destination window, determines
    which clients should receive the specified events, and ignores any active
    grabs.  This function requires you to pass an event mask.  For a discus-
    sion of the valid event mask names, see section 10.3 of Xlib - C Language
    X Interface.  This function uses the w argument to identify the destina-
    tion window as follows:

    +  If w is PointerWindow, the destination window is the window that con-
       tains the pointer.

    +  If w is InputFocus and if the focus window contains the pointer, the
       destination window is the window that contains the pointer; otherwise,
       the destination window is the focus window.

    To determine which clients should receive the specified events, XSen-
    dEvent uses the propagate argument as follows:

    +  If eventmask is the empty set, the event is sent to the client that
       created the destination window.  If that client no longer exists, no
       event is sent.

    +  If propagate is False, the event is sent to every client selecting on
       destination any of the event types in the eventmask argument.

    +  If propagate is True and no clients have selected on destination any
       of the event types in event-mask, the destination is replaced with the
       closest ancestor of destination for which some client has selected a
       type in event-mask and for which no intervening window has that type
       in its do-not-propagate-mask.  If no such window exists or if the win-
       dow is an ancestor of the focus window and InputFocus was originally
       specified as the destination, the event is not sent to any clients.
       Otherwise, the event is reported to every client selecting on the
       final destination any of the types specified in eventmask.

    The event in the XEvent structure must be one of the core events or one
    of the events defined by an extension (or a ``BadValue'' error results)
    so that the X server can correctly byte-swap the contents as necessary.
    The contents of the event are otherwise unaltered and unchecked by the X
    server except to force sendevent to True in the forwarded event and to
    set the serial number in the event correctly.

    XSendEvent returns zero if the conversion to wire protocol format failed
    and returns nonzero otherwise.  XSendEvent can generate ``BadValue'' and
    ``BadWindow'' errors.

    The server may retain the recent history of the pointer motion and do so
    to a finer granularity than is reported by MotionNotify events.  The
    XGetMotionEvents function makes this history available.

    The XGetMotionEvents function returns all events in the motion history
    buffer that fall between the specified start and stop times, inclusive,
    and that have coordinates that lie within the specified window (including
    its borders) at its present placement.  If the server does not support
    motion history, or if the start time is later than the stop time, or if
    the start time is in the future, no events are returned, and XGetMo-
    tionEvents returns NULL.  If the stop time is in the future, it is
    equivalent to specifying CurrentTime.  XGetMotionEvents can generate a
    ``BadWindow'' error.

 Structures

    The XTimeCoord structure contains:

       typedef struct {
             Time time;
             short x, y;
       } XTimeCoord;

    The time member is set to the time, in milliseconds.  The x and y members
    are set to the coordinates of the pointer and are reported relative to
    the origin of the specified window.

 Diagnostics


    ``BadValue''   Some numeric value falls outside the range of values
                   accepted by the request.  Unless a specific range is
                   specified for an argument, the full range defined by the
                   argument's type is accepted.  Any argument defined as a
                   set of alternatives can generate this error.

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

 See also

    XAnyEvent(XS), XIfEvent(XS), XNextEvent(XS), XPutBackEvent(XS)
    Xlib - C Language X Interface