+
+ | \c B_SHIFT_KEY |
+
+ Transforms lowercase case characters into uppercase characters
+ or chooses an alternative punctuation character. The shift key
+ is also used in combination with \c B_COMMAND_KEY to produce
+ keyboard shortcuts.
+ |
+
+
+ | \c B_COMMAND_KEY |
+
+ Produces keyboard shortcuts for common operations such as
+ cut, copy, paste, print, and find.
+ |
+
+
+ | \c B_CONTROL_KEY |
+
+ Outputs control characters in terminal. The control key is
+ sometimes also used as an alternative to \c B_COMMAND_KEY
+ to produce keyboard shortcuts in applications.
+ |
+
+
+ | \c B_OPTION_KEY |
+
+ Used to in combination with other keys to output special
+ characters such as accented letters and symbols. Because
+ \c B_OPTION_KEY is not found on all keyboards it should not
+ be used for essential functions.
+ |
+
+
+ | \c B_MENU_KEY |
+
+ The Menu key is used to produce contextual menus. Like
+ \c B_OPTION_KEY, the Menu key should not be used for essential
+ functions since it is not available on all keyboards.
+ |
+
+
+
+In addition you can access the left and right modifier keys individually with
+the following constants:
+
+
+ | \c version |
+ The version number of the keymap |
+
+
+
+ \c caps_key
+ \c scroll_key
+ \c num_key
+ |
+ Lock key codes |
+
+
+
+ \c left_shift_key
+ \c right_shift_key
+ |
+ Left and right shift key codes |
+
+
+
+ \c left_command_key
+ \c right_command_key
+ |
+ Left and right command key codes |
+
+
+
+ \c left_control_key
+ \c right_control_key
+ |
+ Left and right control key codes |
+
+
+
+ \c left_option_key
+ \c right_option_key
+ |
+ Left and right option key codes |
+
+
+ | \c menu_key |
+ Menu key code |
+
+
+ | \c lock_settings |
+ A bitmap containing the default state of the lock keys |
+
+
+
+To programmatically set a modifier key in the system keymap use the
+set_modifier_key() function. You can also programmatically set the
+state of the num lock, caps lock, and scroll lock keys by calling the
+set_keyboard_locks() function.
+
+\section character_maps Character Maps
+
+The next section of the \c key_map struct contains maps of offsets
+into the array of UTF-8 character encodings filled out in the second
+parameter by get_key_map(). Since the character maps are filled with UTF-8
+characters they may be 1, 2, 3, or rarely 4 bytes long. The characters are
+contained in non-\c NUL terminated Pascal strings. The first byte of the
+string indicates how many bytes the character is made up of. For example the
+string for a horizontal ellipses (...) character looks like this:
+
+\code
+x03xE2x80xA6
+\endcode
+
+The first byte is 03 meaning that the character is 3 bytes long. The bytes
+E2 80 A6 is the UTF-8 byte representation of the horizontal ellipses character.
+Recall that there is no terminating \c NUL character for these strings.
+
+Not every key is mapped to a character. If a key is unmapped the character
+array contains a 0-byte string. Unmapped keys do not produce \c B_KEY_DOWN
+messages. Modifier keys should not be mapped into the character array.
+
+The following character maps are defined:
+
+
+ | \c control_map |
+ Map of characters when the control key is pressed |
+
+
+ | \c option_caps_shift_map |
+
+ Map of characters when caps lock is turned on and both the
+ option key and shift keys are pressed.
+ |
+
+
+ | \c option_caps_map |
+
+ Map of characters when caps lock is turned on and the option key
+ is pressed
+ |
+
+
+ | \c option_shift_map |
+ Map of characters when both shift and option keys are pressed |
+
+
+ | \c option_map |
+ Map of characters when the option key is pressed |
+
+
+ | \c caps_shift_map |
+
+ Map of characters when caps lock is on and the shift key is
+ pressed
+ |
+
+
+ | \c caps_map |
+ Map of characters when caps lock is turned on |
+
+
+ | \c shift_map |
+ Map of characters when shift is pressed |
+
+
+ | \c normal_map |
+ Map of characters when no modifiers keys are pressed |
+
+
+
+\section dead_keys Dead Keys
+
+Dead keys are keys that do not produce a character until they are combined
+with another key. Because the key does not produce a character on their own
+they are considered "dead" until they are brought to life by being combined
+with another key. These dead keys are generally used to produce accented
+characters.
+
+Each of the fields below is a 32-byte array of dead key characters. The dead
+keys are organized into pairs in the array so each dead key array can contain
+up to 16 pairs of dead key characters. The first pair in the array should
+contain \c B_SPACE followed by and the accent character in the second offset.
+This serves to identify what accent character is contained in the array
+and serves to define a space followed by accent pair to represent the unadorned
+accent character.
+
+The rest of the array is filled with pairs containing an unaccented character
+followed by the accent character.
+
+