1XSENDEXTENSIONEVENT(3) XSENDEXTENSIONEVENT(3)
2
6 XSendExtensionEvent - send input extension events to a client
7
9 #include <X11/extensions/XInput.h>
10 Status XSendExtensionEvent( Display *display,
12 XDevice *device,
13 Window destination,
14 Bool propagate,
15 int event_count,
16 XEventClass *event_list,
17 XEvent *event_send);
18 display
20 Specifies the connection to the X server.
21 device
23 Specifies the device from which the events are to be
24 sent.
25 destination
27 Specifies the window the event is to be sent to. You can
28 pass window id, PointerWindow, or InputFocus.
29 propagate
31 Specifies a Boolean value that is either True or False.
32 event_count
34 Specifies the count of XEventClasses in event_list.
35 event_list
37 Specifies the list of event selections to be used.
38 event_send
40 Specifies a pointer to the event that is to be sent.
41
43 The XSendExtensionEvent request identifies the destination
44 window, determines which clients should receive the specified
45 events, and ignores any active grabs. This request requires you
46 to pass an event class list. For a discussion of the valid
47 event class names, see XOpenDevice(3) This
48 request uses the w argument to identify the destination window
49 as follows:
50 * If w is PointerWindow, the destination window is the window
51 that contains the pointer.
52 * If w is InputFocus and if the focus window contains the
53 pointer, the destination window is the window that contains
54 the pointer; otherwise, the destination window is the focus
55 window.
56 To determine which clients should receive the specified events,
58 XSendExtensionEvent uses the propagate argument as follows:
59 * If event_list is the empty set, the event is sent to the
60 client that created the destination window. If that client
61 no longer exists, no event is sent.
62 * If propagate is False, the event is sent to every client
63 selecting on destination any of the event types specified by
64 the event_list array.
65 * If propagate is True and no clients have selected on
66 destination any of the events specified by the event_list
67 array, the destination is replaced with the closest ancestor
68 of destination for which some client has selected a type
69 specified by the event-list array and for which no
70 intervening window has that type in
71 its do-not-propagate-mask. If no such window exists or if
72 the window is an ancestor of the focus window and
73 InputFocus was originally specified as the destination, the
74 event is not sent to any clients. Otherwise, the event is
75 reported to every client selecting on the final destination
76 any of the events specified in the event_list array.
77 The event in the XEvent structure must be one of the events
79 defined by the input extension (or a BadValue error results) so
80 that the X server can correctly byte-swap the contents as
81 necessary. The contents of the event are otherwise unaltered and
82 unchecked by the X server except to force send_event to True in
83 the forwarded event and to set the serial number in the event
84 correctly.
85 XSendExtensionEvent returns zero if the conversion to wire
87 protocol format failed and returns nonzero
88 otherwise. XSendExtensionEvent can generate BadClass, BadDevice,
89 BadValue, and BadWindow errors.
90
92 BadDevice
93 An invalid device was specified. The specified device
94 does not exist or has not been opened by this client via
95 XOpenInputDevice. This error may also occur if the
96 specified device is the X keyboard or X pointer device.
97 BadValue
99 Some numeric value falls outside the range of values
100 accepted by the request. Unless a specific range is
101 specified for an argument, the full range defined by the
102 argument's type is accepted. Any argument defined as a
103 set of alternatives can generate this error.
104 BadWindow
106 A value for a Window argument does not name a defined
107 window.
108 09/15/2021 XSENDEXTENSIONEVENT(3)