XHPSetKeyboardMapping(3X)												 XHPSetKeyboardMapping(3X)

NAME

       XHPSetKeyboardMapping, XHPRefreshKeyboardMapping - set/refresh the keyboard mapping

SYNOPSIS

       #include <X11/XHPlib.h>

       Status XHPSetKeyboardMapping(display, kbd_id, force_read)
	     Display *display;
	     KEYBOARD_ID kbd_id;
	     int force_read;

       XHPRefreshKeyboardMapping(event_map)
	     XMappingEvent *event_map;

       XHPSetKbdMapInit(display, kbd_id, force_read, status_in_out)
	     Display *display;
	     KEYBOARD_ID kbd_id;
	     int force_read;
	     XComposeStatus *status_in_out;

DESCRIPTION

       XHPSetKeyboardMapping allows an application to emulate other keyboards.	It does this by replacing the key map associated with display.
       The keyboard to be emulated is specified by kbd_id.

       The routines described on this man page are provided for backwards compatibility only; they will be discontinued in a future release of HP-
       UX.  XHPSetKeyboardMapping and XHPSetKbdMapInit can only manipulate the keymaps of HP keyboards connected via the HIL interface.  The
       system cannot distinguish between an HP DIN keyboard and DIN keyboards from another source, and hence cannot safely remap these keyboards.

       XHPSetKeyboardMapping reads the key map from the file /etc/X11/XHPKeymaps .  However, if the keyboard specified with kbd_id is the same as
       the physical keyboard recognized by the server as the input device, XHPSetKeyboardMapping requests the key map directly from the server.
       In this way, any changes to the key map (such as with XChangeKeyboardMapping) are preserved.  This functionality can be overridden by
       setting force_read to a non-NULL value; if the value of force_read is non-NULL, XHPSetKeyboardMapping will always obtain the key map from
       the file /etc/X11/XHPKeymaps .

       XHPSetKeyboardMapping fails if kbd_id is an unrecognized value or if it cannot open the key map file; the display's copy of the key map is
       not modified.

       If the server's keyboard is a non-HP keyboard or is connected to the workstation by an interface other than HIL, XHPSetKeyboardMapping
       returns an error code and does not modify the key map.

       XHPSetKbdMapInit is a macro defined in XHPlib.h.  It is intended for clients using XHPGetEurasianCvt and will perform the necessary
       initialization and cleanup for that routine, as well as setting the key map for display.

       The following values for kbd_id are define in <X11/HXPlib.h>:

       KB_US_English	    specifies an HP46021A US ASCII keyboard

       KB_Canada_French     specifies an HP46021AC Canadian French keyboard

       KB_German	    specifies an HP46021AD German keyboard

       KB_Euro_Spanish	    specifies an HP46021AE European Spanish keyboard

       KB_French	    specifies an HP46021AF French keyboard

       KB_Dutch 	    specifies an HP46021AH Dutch keyboard

       KB_Katakana	    specifies an HP46021AJ Katakana keyboard

       KB_Canada_English    specifies an HP46021AL Canadian English keyboard

       KB_Latin_Spanish     specifies an HP46021AM Latin American Spanish keyboard

       KB_Norwegian	    specifies an HP46021AN Norwegian keyboard

       KB_Swiss_German2     specifies an HP46021AP Swiss German keyboard

       KB_Swiss_German	    specifies an HP46020 Swiss German keyboard

       KB_Swiss_French2     specifies an HP46021AQ Swiss French keyboard

       KB_Swiss_French	    specifies an HP46020 Swiss French keyboard

       KB_Swedish	    specifies an HP46021AS Swedish keyboard

       KB_UK_English	    specifies an HP46021AU UK English keyboard

       KB_Belgian	    specifies an HP46021AW Belgian keyboard

       KB_Finnish	    specifies an HP46021AX Finnish keyboard

       KB_Danish	    specifies an HP46021AY Danish keyboard

       KB_Italian	    specifies an HP46021AZ Italian keyboard

       KB_T_Chinese	    specifies an HP46021AW#ZAA Traditional Chinese keyboard

       KB_Korean	    specifies an HP46021AW#ZAB Korean keyboard

       KB_S_Chinese	    specifies an HP46021AW#ZAC Simplified Chinese keyboard

       KB_Japanese	    specifies an HP46021AW#ZAL Japanese keyboard

       XHPRefreshKeyboardMapping refreshes display's copy of the key map and modifier information.  It facilitates handling MappingNotify events
       when using XHPSetKeyboardMapping with the force_read argument set to NULL (i.e. when the key map for the keyboard is read from the server
       and not from the XHPKeymaps file).

       If the key map has been read from XHPKeymaps, changes to the server's key map are irrelevant; MappingNotify events should be ignored when
       using XHPSetKeyboardMapping with force_read set to a non-NULL value.

RETURN VALUE

       XHPSetKeyboardMapping returns zero if it succeeds, otherwise it returns one of the following values, defined in <X11/HXPlib.h>:

       XHPKB_NOKEYFILE		   The file /etc/X11/XHPKeymaps does not exist or could not be opened.

       XHPKB_BADMAGIC		   Either libxHP11.a or /etc/X11/XHPKeymaps is not the latest version.

       XHPKB_BADKBID		   The kbd_id argument is set to an improper value.

       XHPKB_NONHPINPUTDEV	   The keyboard attached to the server is not an HP keyboard.  The key map requested was not loaded.

ORIGIN

       Hewlett-Packard Company

SEE ALSO

       XHPConvertLookup(3X), XHPGetEurasianCvt(3X)

X Version 11							     Release 5						 XHPSetKeyboardMapping(3X)