XWindowEvent(3X) — X Version 11

NAME

XWindowEvent, XCheckWindowEvent, XMaskEvent, XCheckMaskEvent, XCheckTypedEvent, XCheckTypedWindowEvent, XGetMotionEvents, XSendEvent − select event types

SYNTAX

XWindowEvent(display, w, event_mask, event_return)
      Display ∗display;
      Window w;
      long event_mask;
      XEvent ∗event_return;

Bool XCheckWindowEvent(display, w, event_mask, event_return)
      Display ∗display;
      Window w;
      int event_mask;
      XEvent ∗event_return;

XMaskEvent(display, event_mask, event_return)
      Display ∗display;
      unsigned long event_mask;
      XEvent ∗event_return;

Bool XCheckMaskEvent(display, event_mask, event_return)
      Display ∗display;
      unsigned long event_mask;
      XEvent ∗event_return;

Bool XCheckTypedEvent(display, event_type, event_return)
      Display ∗display;
      int event_type;
      XEvent ∗event_return;

Bool XCheckTypedWindowEvent(display, w, event_type, event_return)
      Display ∗display;
      Window w;
      int event_type;
      XEvent ∗event_return;

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

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

ARGUMENTS

displaySpecifies the connection to the X server.

event_maskSpecifies the event mask. This mask is the bitwise inclusive OR of one or more of the valid event mask bits.

event_returnThe function copies the matched event’s associated structure into this client-supplied structure.

event_sendSpecifies a pointer to the event that is to be sent.

event_typeSpecifies the event type to be compared.

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

propagateSpecifies a boolean value that is either True or False.

start

stopSpecify the time interval in which the events are returned from the motion history buffer. You can pass a time stamp, expressed in milliseconds, or CurrentTime. If the stop time is in the future, it is equivalent to specifying CurrentTime.

wSpecifies the window ID.

DESCRIPTION

The XWindowEvent function searches the event queue for an event that matches both the specified window and event mask. When it finds a match, XWindowEvent removes that event from the queue and copies it into the specified XEvent structure.

The XCheckWindowEvent function searches the event queue, then the events available on the server connection, for the first event that matches the specified window and event mask. When it finds a match, XCheckWindowEvent removes that event, copies it into the specified XEvent structure, and returns True.

The XMaskEvent function searches the event queue for the events associated with the specified mask. When it finds a match, XMaskEvent removes that and copies it into the specified XEvent structure.

The XCheckMaskEvent function searches first the event queue, then any events available on the server connection, for the first event that matches the specified mask. When it finds a match, XCheckMaskEvent removes that event, copies it into the specified XEvent structure, and returns True.

The XCheckTypedEvent function searches first the event queue, then any events available on the server connection, for the first event that matches the specified type. When it finds a match, XCheckTypedEvent returns its associated event structure to the specified XEvent structure and returns True.

The XCheckTypedWindowEvent function searches first the event queue, then any events available on the server connection, for the first event that matches the specified type and window. When it finds a match, XCheckTypedWindowEvent removes the event from the queue, copies it into the specified XEvent structure and returns True.

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 (including borders) the specified window at its present placement. .PN XGetMotionEvents can generate a BadWindowe error.

The XSendEvent function sends an event to a specified window. .PN XSendEvent can generate BadValue and BadWindowe errors.

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 Window.