NAME

XLookupKeysym, XRefreshKeyboardMapping, XLookupString, XRebindKeySym − handle keyboard input events

SYNTAX

KeySym XLookupKeysym(event_key, index)
      XKeyEvent ∗event_key;
      int index;

XRefreshKeyboardMapping(event_map)
      XMappingEvent ∗event_map;

int XLookupString(event_struct, buffer_return, bytes_buffer, keysym_return, status_return)
      XKeyEvent ∗event_struct;
      char ∗buffer_return;
      int bytes_buffer;
      KeySym ∗keysym_return;
      XComposeStatus ∗status_return;

XRebindKeysym(display, keysym, list, mod_count, string, bytes_string)
      Display ∗display;
      KeySym keysym;
      KeySym ∗list;
      int mod_count;
      unsigned char ∗string;
      int bytes_string;

ARGUMENTS

buffer_returnReturns the translated characters. 

bytes_bufferSpecifies the length of the buffer.  No more than bytes_buffer of translation are returned. 

bytes_stringSpecifies the length of the string. 

displaySpecifies the connection to the X server. 

event_keySpecifies the key event that is to be used.  This event is either a KeyPress event or a KeyRelease event.

event_mapSpecifies the mapping event that is to be used. 

event_structSpecifies the key event structure to be used: XKeyPressedEvent or XKeyReleasedEvent.

indexSpecifies the index into the KeySyms table. 

keysymSpecifies the keysym to be rebound. 

keysym_return
If this argument is not NULL, returns the keysym computed from the event.

listSpecifies a pointer to an array of keysyms that are being used as modifiers. 

mod_countSpecifies the number of modifiers in the modifier list. 

status_return
Specifies either a pointer to the XCompose structure that is to contain compose key state information and that allows compose key processing to take place, or NULL.

stringSpecifies a pointer to the string that is to be returned by XLookupString.

DESCRIPTION

The XLookupKeysym function uses a given keyboard event and the index you specified to return the KeySym from the list that corresponds to the keycode member in the XKeyPressedEvent or XKeyReleasedEvent structure.

The XRefreshKeyboardMapping function refreshes the stored modifier and keymap information.

The XLookupString function is a convenience routine that can be used to map a key event to an ASCII string, using the modifier bits in the key event to deal with shift, lock, and control.

The XRebindKeysym function can be used to rebind the meaning of a keysym for the client.

SEE ALSO

XStringToKeysym(3X)
Xlib − C Language X Interface

1 March 1988