Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of the X Consortium shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the X Consortium.
Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Digital Equipment Corporation
Portions Copyright \(co 1990, 1991 by
Tektronix, Inc.
Permission to use, copy, modify and distribute this documentation for
any purpose and without fee is hereby granted, provided that the above
copyright notice appears in all copies and that both that copyright notice
and this permission notice appear in all copies, and that the names of
Digital and Tektronix not be used in in advertising or publicity pertaining
to this documentation without specific, written prior permission.
Digital and Tektronix makes no representations about the suitability
of this documentation for any purpose.
It is provided "as is" without express or implied warranty.
int XChangeKeyboardMapping(\^Display *display, int first_keycode, int keysyms_per_keycode, KeySym *keysyms, int num_codes\^);
KeySym *XGetKeyboardMapping(\^Display *display, KeyCode first_keycode, int keycode_count, int *keysyms_per_keycode_return\^);
int XDisplayKeycodes\^(\^Display *display\^, int *min_keycodes_return\^, int *max_keycodes_return\^);
int XSetModifierMapping(\^Display *display, XModifierKeymap *modmap\^);
XModifierKeymap *XGetModifierMapping(\^Display *display\^);
XModifierKeymap *XNewModifiermap(\^int max_keys_per_mod\^);
XModifierKeymap *XInsertModifiermapEntry\^(\^XModifierKeymap *modmap, KeyCode keycode_entry, int modifier\^);
XModifierKeymap *XDeleteModifiermapEntry\^(\^XModifierKeymap *modmap, KeyCode keycode_entry, int modifier\^);
int XFreeModifiermap(\^XModifierKeymap *modmap\^);
.EX num_codes * keysyms_per_keycode
The specified first_keycode must be greater than or equal to min_keycode returned by XDisplayKeycodes , or a BadValue error results. In addition, the following expression must be less than or equal to max_keycode as returned by XDisplayKeycodes , or a BadValue error results:
.EX first_keycode + num_codes - 1
KeySym number N, counting from zero, for KeyCode K has the following index in keysyms, counting from zero:
.EX (K - first_keycode) * keysyms_per_keycode + N
The specified keysyms_per_keycode can be chosen arbitrarily by the client to be large enough to hold all desired symbols. A special KeySym value of NoSymbol should be used to fill in unused elements for individual KeyCodes. It is legal for NoSymbol to appear in nontrailing positions of the effective list for a KeyCode. XChangeKeyboardMapping generates a MappingNotify event.
There is no requirement that the X server interpret this mapping. It is merely stored for reading and writing by clients.
XChangeKeyboardMapping can generate BadAlloc and BadValue errors.
The XGetKeyboardMapping function returns the symbols for the specified number of KeyCodes starting with first_keycode. The value specified in first_keycode must be greater than or equal to min_keycode as returned by XDisplayKeycodes , or a BadValue error results. In addition, the following expression must be less than or equal to max_keycode as returned by XDisplayKeycodes :
.EX first_keycode + keycode_count - 1
If this is not the case, a BadValue error results. The number of elements in the KeySyms list is:
.EX keycode_count * keysyms_per_keycode_return
KeySym number N, counting from zero, for KeyCode K has the following index in the list, counting from zero: .EX (K - first_code) * keysyms_per_code_return + N
The X server arbitrarily chooses the keysyms_per_keycode_return value to be large enough to report all requested symbols. A special KeySym value of NoSymbol is used to fill in unused elements for individual KeyCodes. To free the storage returned by XGetKeyboardMapping , use XFree .
XGetKeyboardMapping can generate a BadValue error.
The XDisplayKeycodes function returns the min-keycodes and max-keycodes supported by the specified display. The minimum number of KeyCodes returned is never less than 8, and the maximum number of KeyCodes returned is never greater than 255. Not all KeyCodes in this range are required to have corresponding keys.
The XSetModifierMapping function specifies the KeyCodes of the keys (if any) that are to be used as modifiers. If it succeeds, the X server generates a MappingNotify event, and XSetModifierMapping returns MappingSuccess . X permits at most 8 modifier keys. If more than 8 are specified in the XModifierKeymap structure, a BadLength error results.
The modifiermap member of the XModifierKeymap structure contains 8 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 in the Display structure, or a BadValue error results.
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, XSetModifierMapping returns MappingBusy , and none of the modifiers is changed.
XSetModifierMapping can generate BadAlloc and BadValue errors.
The XGetModifierMapping function 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 XFreeModifiermap . If only zero values appear in the set for any modifier, that modifier is disabled.
The XNewModifiermap function returns a pointer to XModifierKeymap structure for later use.
The XInsertModifiermapEntry function adds the specified KeyCode to the set that controls the specified modifier and returns the resulting XModifierKeymap structure (expanded as needed).
The XDeleteModifiermapEntry function deletes the specified KeyCode from the set that controls the specified modifier and returns a pointer to the resulting XModifierKeymap structure.
The XFreeModifiermap function frees the specified XModifierKeymap structure.
.EX typedef struct { int max_keypermod; /* This server's max number of keys per modifier */ KeyCode *modifiermap; /* An 8 by max_keypermod array of the modifiers */ } XModifierKeymap;
1i BadAlloc The server failed to allocate the requested resource or server memory.
1i 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.
\*(xL