man-pages/man3/XChangeKeyboardDevice.3.html
2021-03-31 01:06:50 +01:00

207 lines
3.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of XCHANGEKEYBOARDDEVIC</TITLE>
</HEAD><BODY>
<H1>XCHANGEKEYBOARDDEVIC</H1>
Section: &nbsp; (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">&nbsp;</A>
<H2>NAME</H2>
XChangeKeyboardDevice - change which device is used as the X keyboard
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<PRE>
#include &lt;<A HREF="file:///usr/include/X11/extensions/XInput.h">X11/extensions/XInput.h</A>&gt;
</PRE>
<P>
<PRE>
Status XChangeKeyboardDevice( Display *display,
XDevice *device);
</PRE>
<P>
<PRE>
display
Specifies the connection to the X server.
</PRE>
<P>
<PRE>
device
Specifies the device to be used as the X keyboard.
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<DL COMPACT><DT id="1"><DD>
<PRE>
The XChangeKeyboardDevice request causes the server to use the
specified device as the X keyboard. The device must have been
previously opened by the requesting client via XOpenDevice or a
BadDevice error will result. The device must support input
class Keys, or a BadMatch error will result. If the server
implementation does not support using the requested device as
the X keyboard, a BadDevice error will result.
</PRE>
</DL>
<P>
<DL COMPACT><DT id="2"><DD>
<PRE>
If the specified device is grabbed by another client,
AlreadyGrabbed is returned. If the specified device is frozen
by a grab on another device, GrabFrozen is returned. If the
request is successful, Success is returned.
</PRE>
</DL>
<P>
<DL COMPACT><DT id="3"><DD>
<PRE>
If the request succeeds, a ChangeDeviceNotify event is sent to
all clients that have selected that event. A MappingNotify
event with request = MappingKeyboard is sent to all clients.
The specified device becomes the X keyboard and the old X
keyboard becomes accessible through the input extension
protocol requests.
</PRE>
</DL>
<P>
<DL COMPACT><DT id="4"><DD>
<PRE>
XChangeKeyboardDevice can generate a BadDevice or a BadMatch
error.
</PRE>
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>DIAGNOSTICS</H2>
<P>
<DL COMPACT><DT id="5"><DD>
<PRE>
BadDevice
An invalid device was specified. The specified device
does not exist, has not been opened by this client via
XOpenInputDevice, or is already one of the core X device
(pointer or keyboard). This error may also occur if the
server implementation does not support using the
specified device as the X keyboard.
</PRE>
</DL>
<P>
<DL COMPACT><DT id="6"><DD>
<PRE>
BadMatch
This error may occur if an XChangeKeyboardDevice request
was made specifying a device that has no keys.
</PRE>
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<DL COMPACT><DT id="7"><DD>
<PRE>
<A HREF="/cgi-bin/man/man2html?3+XChangePointerDevice">XChangePointerDevice</A>(3)
</PRE>
</DL>
<P>
<HR>
<A NAME="index">&nbsp;</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>
<DT id="12"><A HREF="#lbAF">SEE ALSO</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:00 GMT, March 31, 2021
</BODY>
</HTML>