347 lines
5.7 KiB
HTML
347 lines
5.7 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of XGETDEVICEMODIFIERMA</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>XGETDEVICEMODIFIERMA</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>
|
|
|
|
XGetDeviceModifierMapping, XSetDeviceModifierMapping - query or change device modifier mappings
|
|
<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>
|
|
int XSetDeviceModifierMapping( Display *display,
|
|
XDevice *device,
|
|
XModifierKeymap *modmap);
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
XModifierKeymap *XGetDeviceModifierMapping( Display *display,
|
|
XDevice *device);
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
display
|
|
Specifies the connection to the X server.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
device
|
|
Specifies the device whose modifier mapping is to be
|
|
queried or modified.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
modmap
|
|
Specifies a pointer to the XModifierKeymap structure.
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="1"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
The XSetDeviceModifierMapping request specifies the KeyCodes of
|
|
the keys (if any) that are to be used as modifiers for the
|
|
specified device. If it succeeds, the X server generates a
|
|
DeviceMappingNotify event, and XSetDeviceModifierMapping
|
|
returns MappingSuccess. X permits at most eight modifier keys.
|
|
If more than eight are specified in the XModifierKeymap
|
|
structure, a BadLength error results.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="2"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
The modifiermap member of the XModifierKeymap structure
|
|
contains eight sets of max_keypermod KeyCodes, one for each
|
|
modifier in the order Shift, Lock, Control, Mod1, Mod2, Mod3,
|
|
Mod4, and Mod5. Only nonzero KeyCodes have meaning in each set,
|
|
and zero KeyCodes are ignored. In addition, all of the nonzero
|
|
KeyCodes must be in the range specified by min_keycode and
|
|
max_keycode as returned by XListInputDevices, or a BadValue
|
|
error results. No KeyCode may appear twice in the entire map,
|
|
or a BadValue error results.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="3"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
An X server can impose restrictions on how modifiers can be
|
|
changed, for example, if certain keys do not generate up
|
|
transitions in hardware, if auto-repeat cannot be disabled on
|
|
certain keys, or if multiple modifier keys are not supported.
|
|
If some such restriction is violated, the status reply is
|
|
MappingFailed, and none of the modifiers are changed. If the
|
|
new KeyCodes specified for a modifier differ from those
|
|
currently defined and any (current or new) keys for that
|
|
modifier are in the logically down state,
|
|
XSetDeviceModifierMapping returns MappingBusy, and none of the
|
|
modifiers is changed.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="4"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
XSetDeviceModifierMapping can generate BadLength, BadDevice,
|
|
BadMatch, BadAlloc, and BadValue errors.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="5"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
The XGetDeviceModifierMapping request returns a pointer to a
|
|
newly created XModifierKeymap structure that contains the keys
|
|
being used as modifiers. The structure should be freed after
|
|
use by calling XFreeModifierMapping . If only zero values
|
|
appear in the set for any modifier, that modifier is disabled.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="6"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
XGetDeviceModifierMapping can generate BadDevice and BadMatch
|
|
errors.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
Structures
|
|
<P>
|
|
<DL COMPACT><DT id="7"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
The XModifierKeymap structure contains:
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="8"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
typedef struct {
|
|
int max_keypermod;
|
|
KeyCode *modifiermap;
|
|
} XModifierKeymap;
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>DIAGNOSTICS</H2>
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="9"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
BadLength
|
|
More than eight keys were specified in the
|
|
XModifierKeymap structure.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="10"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
BadAlloc
|
|
The server failed to allocate the requested resource or
|
|
server memory.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="11"><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="12"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
BadMatch
|
|
This error may occur if an XGetDeviceModifierMapping or
|
|
XChangeDeviceModifierMapping request was made specifying
|
|
a device that has no keys.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="13"><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>
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="14"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
<A HREF="/cgi-bin/man/man2html?3+XSetDeviceKeyMapping">XSetDeviceKeyMapping</A>(3), <A HREF="/cgi-bin/man/man2html?3+XSetDeviceButtonMapping">XSetDeviceButtonMapping</A>(3)
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="15"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="16"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="17"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="18"><A HREF="#lbAE">DIAGNOSTICS</A><DD>
|
|
<DT id="19"><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>
|