Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xgetmodifiermapping(3) [hpux man page]

XGetModifierMapping()													     XGetModifierMapping()

Name
  XGetModifierMapping - obtain the mapping of modifier keys (Shift, Control, etc.).

Synopsis
  XModifierKeymap *XGetModifierMapping(display)
	Display *display;

Arguments
  display   Specifies a connection to an X server; returned from XOpenDisplay().

Returns
  The current modifier mapping.

Description
  XGetModifierMapping() returns the keycodes of the keys being used as modifiers.

  There  are  eight  modifiers, represented by the symbols ShiftMapIndex, LockMapIndex, ControlMapIndex, Mod1MapIndex, Mod2MapIndex, Mod3Map-
  Index, Mod4MapIndex, and Mod5MapIndex.  The modifiermap member of the XModifierKeymap() structure contains eight sets of keycodes, each set
  containing  max_keypermod  keycodes.	 Zero keycodes are not meaningful.  If an entire modifiermap is filled with zero's, the corresponding
  modifier is disabled.  No keycode will appear twice anywhere in the map.

Structures
     typedef struct {
	 int max_keypermod;	  /* server's max number of keys per modifier */
	 KeyCode *modifiermap;	  /* an 8 by max_keypermod array of
				       * keycodes to be used as modifiers */
     } XModifierKeymap;

     /* modifier names.  Used to build a SetModifierMapping request or
	to read a GetModifierMapping request. */
     #define ShiftMapIndex	  0
     #define LockMapIndex	  1
     #define ControlMapIndex	  2
     #define Mod1MapIndex	  3
     #define Mod2MapIndex	  4
     #define Mod3MapIndex	  5
     #define Mod4MapIndex	  6
     #define Mod5MapIndex	  7

See Also
  XChangeKeyboardMapping(),   XDeleteModifiermapEntry(),   XFreeModifiermap(),	 XGetKeyboardMapping(),   XInsertModifiermapEntry(),	XKey-
  codeToKeysym(),  XKeysymToKeycode(),	XKeysymToString(),  XLookupKeysym(), XLookupString(), XNewModifierMap, XQueryKeymap(), XRebindKeySym,
  XRefreshKeyboardMapping(), XSetModifierMapping(), XStringToKeysym().

X Programming Library													     XGetModifierMapping()

Check Out this Related Man Page

XInsertModifiermapEntry()												 XInsertModifiermapEntry()

Name
  XInsertModifiermapEntry - add a new entry to an XModifierKeymap structure.

Synopsis
  XModifierKeymap *XInsertModifiermapEntry(modmap,
	    keycode_entry, modifier)
	  XModifierKeymap *modmap;
	  KeyCode keycode_entry;
	  int modifier;

Arguments
  modmap    Specifies a pointer to an XModifierKeymap() structure.

  keycode_entry
	    Specifies the keycode of the key to be added to modmap.

  modifier  Specifies  the  modifier you want mapped to the keycode specified in keycode_entry.  This should be one of the constants:  Shift-
	    MapIndex, LockMapIndex, ControlMapIndex, Mod1MapIndex, Mod2MapIndex, Mod3MapIndex, Mod4MapIndex, or Mod5MapIndex.

Returns
  The modifier map structure with the keycode added.

Description
  XInsertModifiermapEntry() returns an XModifierKeymap structure suitable for calling XSetModifierMapping(), in which the  specified  keycode
  is  added  to  the  set  of  keycodes that is mapped to the specified modifier (like Shift or Control).  XInsertModifiermapEntry() does not
  change the mapping itself.

  This function is normally used by calling XGetModifierMapping() to get a pointer to the current XModifierKeymap structure for  use  as  the
  modmap argument to XInsertModifiermapEntry().

  Note	that  the structure pointed to by modmap is freed by XInsertModifiermapEntry().  It should not be freed or otherwise used by applica-
  tions.

  For a description of the modifier map, see XSetModifierMapping().

Structures
     typedef struct {
	 int max_keypermod;	  /* server's max number of keys per modifier */
	 KeyCode *modifiermap;	  /* an 8 by max_keypermod array of
				       * keycodes to be used as modifiers */
     } XModifierKeymap;

     #define ShiftMapIndex    0
     #define LockMapIndex     1
     #define ControlMapIndex  2
     #define Mod1MapIndex     3
     #define Mod2MapIndex     4
     #define Mod3MapIndex     5
     #define Mod4MapIndex     6
     #define Mod5MapIndex     7

See Also
  XDeleteModifiermapEntry(),  XFreeModifiermap(),  XGetKeyboardMapping(),  XGetModifierMapping(),   XKeycodeToKeysym(),   XKeysymToKeycode(),
  XKeysymToString(),  XLookupKeysym(),	XLookupString(), XNewModifierMap, XQueryKeymap(), XRebindKeySym, XRefreshKeyboardMapping(), XSetModi-
  fierMapping(), XStringToKeysym().

Xlib - Resource Manager 												 XInsertModifiermapEntry()
Man Page