268 lines
5.4 KiB
HTML
268 lines
5.4 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of XSENDEXTENSIONEVENT</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>XSENDEXTENSIONEVENT</H1>
|
|
Section: (3)<BR>Updated: 06/19/2019<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
XSendExtensionEvent - send input extension events to a client
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<P>
|
|
<PRE>
|
|
#include <<A HREF="file:///usr/include/X11/extensions/XInput.h">X11/extensions/XInput.h</A>>
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
Status XSendExtensionEvent( Display *display,
|
|
XDevice *device,
|
|
Window destination,
|
|
Bool propagate,
|
|
int event_count,
|
|
XEventClass *event_list,
|
|
XEvent *event_send);
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
display
|
|
Specifies the connection to the X server.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
device
|
|
Specifies the device from which the events are to be
|
|
sent.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
destination
|
|
Specifies the window the event is to be sent to. You can
|
|
pass window id, PointerWindow,or InputFocus.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
propagate
|
|
Specifies a Boolean value that is either True or False.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
event_count
|
|
Specifies the count of XEventClasses in event_list.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
event_list
|
|
Specifies the list of event selections to be used.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
event_send
|
|
Specifies a pointer to the event that is to be sent.
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="1"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
The XSendExtensionEvent request identifies the destination
|
|
window, determines which clients should receive the specified
|
|
events, and ignores any active grabs. This request requires you
|
|
to pass an event class list. For a discussion of the valid
|
|
event class names, see <A HREF="/cgi-bin/man/man2html?3+XOpenDevice">XOpenDevice</A>(3) This
|
|
request 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 InputFocusand 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.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="2"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
To determine which clients should receive the specified events,
|
|
XSendExtensionEventuses the propagate argument as follows:
|
|
* If event_list 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 eventtypes specified by
|
|
the event_list array.
|
|
* If propagate is Trueand no clients have selected on
|
|
destination any ofthe events specified by the event_list
|
|
array,the destination is replaced with theclosest ancestor
|
|
of destination for which some client has selected atype
|
|
specified by the event-list array and for which no
|
|
interveningwindow has that type in
|
|
itsdo-not-propagate-mask. If no such window exists or if
|
|
the window isan ancestor of the focus window and
|
|
InputFocuswas originally specifiedas the destination, the
|
|
event is not sent to any clients. Otherwise, the event is
|
|
reported to every client selecting on the finaldestination
|
|
any of the events specified in the event_list array.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="3"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
The event in the XEventstructure must be one of the events
|
|
defined by the input extension (or a BadValueerror results) so
|
|
that the X server can correctly byte-swapthe contents as
|
|
necessary. The contents of the event areotherwise unaltered and
|
|
unchecked by the X server except to force send_event to Truein
|
|
the forwarded event and to set the serial number in the event
|
|
correctly.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="4"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
XSendExtensionEventreturns zero if the conversion to wire
|
|
protocol format failedand returns nonzero
|
|
otherwise.XSendExtensionEventcan generate BadClass, BadDevice,
|
|
BadValue, and BadWindow errors.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>DIAGNOSTICS</H2>
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="5"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
BadDevice
|
|
An invalid device was specified. The specified device
|
|
does not exist or has not been opened by this client via
|
|
XOpenInputDevice. This error may also occur if the
|
|
specified device is the X keyboard or X pointer device.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="6"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
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.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="7"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
BadWindow
|
|
A value for a Window argument does not name a defined
|
|
window.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="8"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="9"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="10"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="11"><A HREF="#lbAE">DIAGNOSTICS</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:01 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|