1XSendExtensionEvent(3) X FUNCTIONS XSendExtensionEvent(3)
2
6 XSendExtensionEvent - send input extension events to a client
7
9 Status XSendExtensionEvent(Display *display, XDevice *device, Window
10 destination, Bool propagate, int event_count, XEventClass
11 *event_list, XEvent *event_send);
12
14 display Specifies the connection to the X server.
15 device Specifies the device from which the events are to be sent.
17 destination Specifies the window the event is to be sent to. You can
19 pass window id, PointerWindow, or InputFocus.
20 propagate Specifies a Boolean value that is either True or False.
22 event_count Specifies the count of XEventClasses in event_list.
24 event_list Specifies the list of event selections to be used.
26 event_send Specifies a pointer to the event that is to be sent.
28 DESCRIPTION
31 The XSendExtensionEvent request identifies the destination win‐
32 dow, determines which clients should receive the specified
33 events, and ignores any active grabs. This request requires you
34 to pass an event class list. For a discussion of the valid
35 event class names, see XOpenDevice(3). This request uses the w
36 argument to identify the destination window as follows:
37 · If w is PointerWindow , the destination window is the window that
39 contains the pointer.
40 · If w is InputFocus and if the focus window contains the pointer,
42 the destination window is the window that contains the pointer;
43 otherwise, the destination window is the focus window.
44 To determine which clients should receive the specified events,
46 XSendExtensionEvent uses the propagate argument as follows:
47 · If event_list is the empty set, the event is sent to the client
49 that created the destination window. If that client no longer
50 exists, no event is sent.
51 · If propagate is False, the event is sent to every client selecting
53 on destination any of the event types specified by the event_list
54 array.
55 · If propagate is True and no clients have selected on destination
57 any of the events specified by the event_list array, the destina‐
58 tion is replaced with the closest ancestor of destination for
59 which some client has selected a type specified by the event-list
60 array and for which no intervening window has that type in its do-
61 not-propagate-mask. If no such window exists or if the window is
62 an ancestor of the focus window and InputFocus was originally
63 specified as the destination, the event is not sent to any
64 clients. Otherwise, the event is reported to every client select‐
65 ing on the final destination any of the events specified in the
66 event_list array.
67 The event in the XEvent structure must be one of the events defined by
69 the input extension (or a BadValue error results) so that the X server
70 can correctly byte-swap the contents as necessary. The contents of the
71 event are otherwise unaltered and unchecked by the X server except to
72 force send_event to True in the forwarded event and to set the serial
73 number in the event correctly.
74 XSendExtensionEvent returns zero if the conversion to wire protocol
76 format failed and returns nonzero otherwise. XSendExtensionEvent can
77 generate BadClass, BadDevice, BadValue, and BadWindow errors.
78
80 BadDevice An invalid device was specified. The specified device does
81 not exist or has not been opened by this client via XOpen‐
82 InputDevice. This error may also occur if the specified
83 device is the X keyboard or X pointer device.
84 BadValue Some numeric value falls outside the range of values
86 accepted by the request. Unless a specific range is speci‐
87 fied for an argument, the full range defined by the argu‐
88 ment's type is accepted. Any argument defined as a set of
89 alternatives can generate this error.
90 BadWindow A value for a Window argument does not name a defined Win‐
92 dow.
93
95 Programming with Xlib
96X Version 11 libXi 1.1.1 XSendExtensionEvent(3)