XSendEvent(3X)                                     XSendEvent(3X)



NAME
     XSendEvent, XDisplayMotionBufferSize, XGetMotionEvents,
     XTimeCoord  -  send  events  and  manipulate  the XTimeCoord
     structure

SYNOPSIS
     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;

DESCRIPTION
     The XSendEvent function identifies the destination window,
     determines which clients should receive the specified
     events, and ignores any active grabs.  This function re-
     quires you to pass an event mask.  For a discussion of the
     valid event mask names, see Section 8.3 in Xlib - C Language
     Interface.  This function uses the w argument to identify
     the destination window as follows:

          If w is PointerWindow, the destination window is the
          window that contains the pointer.

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

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

          If event-mask 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 event-mask argument.




November, 1990                                                  1

XSendEvent(3X)                                     XSendEvent(3X)



          If propagate is TRUE and no clients have selected on
          destination any of the event types in the event mask,
          the destination is replaced with the closest ancestor
          of destination for which some client has selected a
          type in the event mask and for which no intervening
          window has that type in its do_not_propagate_mask
          member. If no such window exists or if the window is an
          ancestor of the focus window and InputFocus was origi-
          nally 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 event-mask.

     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 send_event to TRUE in the forwarded event
     and to set
     serial correctly.

     XSendEvent returns zero if the conversion to wire protocol
     format failed and returns nonzero otherwise.

     The server may retain the recent history of the pointer mo-
     tion 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 mo-
     tion 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 start time is later than the
     stop time or if the start time is in the future, no events
     are returned.  If the stop time is in the future, it is
     equivalent to specifying CurrentTime.

   Arguments
     These functions accept the following arguments:

     display Specifies the connection to the X server.

     event-mask
             Specifies the event mask.

     event-send
             Specifies a pointer to the event that is to be sent.

     nevents-return
             Returns the number of events from the motion history



2                                                  November, 1990

XSendEvent(3X)                                     XSendEvent(3X)



             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.  PointerWindow, or
             InputFocus.

     w       Specifies the window the event is to be sent to.

   Structures
     The XTimeCoord structure is defined as follows.

     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.

ERRORS
     BadValue
             Some numeric value falls outside the range of values
             accepted by the request.  Unless a range is speci-
             fied 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 de-
             fined Window.

     The XSendEvent function can generate BadValue and BadWindow
     errors.

     The XGetMotionEvents function can generate a BadWindow er-
     ror.

SEE ALSO
     XAnyEvent(3X), XIfEvent(3X), XNextEvent(3X),
     XPutBackEvent(3X)

     Xlib - C Language Interface








November, 1990                                                  3