Section 3: library functions
XkbKeysymToModifiers – Finds the set of modifiers bound to a particular keysym on the core keyboard Synopsis unsigned int XkbKeysymToModifiers (Display *dpy, KeySym ks); Arguments– dpy connection to X server – ks keysym of interestDescriptionXkbKeysymToModifiers finds the set of modifiers currently bound to the keysym ks on the core keyboard. The value returned is the…
XkbKeycodeToKeysym – Finds the keysym bound to a particular key at a specified group and shift level Synopsis KeySym XkbKeycodeToKeysym (Display *dpy, KeyCode kc, unsigned int group, unsigned int level); Arguments– dpy connection to X server – kc key of interest – group group of interest – level shift level of interestDescriptionXkbKeycodeToKeysym returns the keysym…
XkbKeyTypesForCoreSymbols – Determine the Xkb key types appropriate for the symbols bound to a key in a core keyboard mapping Synopsis int XkbKeyTypesForCoreSymbols (XkbDescPtr xkb, int map_width, KeySym *core_syms, unsigned int protected, int *types_inout, KeySym *xkb_syms_rtrn); Arguments– xkb keyboard description in which to place symbols – map_width width of core protocol keymap in xkb_syms_rtrn –…
XkbKeyTypeIndex – Obtain the index of a key type or the pointer to a key type Synopsis int XkbKeyTypeIndex (XkbDescPtr xkb, KeyCode keycode, int group); Arguments– xkb Xkb description of interest – keycode keycode of interest – group group indexDescriptionXkbKeyTypeIndex computes an index into the types vector of the client map in xkb from the…
XkbKeyType – Obtain the index of a key type or the pointer to a key type Synopsis XkbKeyTypePtr XkbKeyType (XkbDescPtr xkb, KeyCode keycode, int group); Arguments– xkb Xkb description of interest – keycode keycode of interest – group group indexDescriptionXkbKeyType returns a pointer to the key type in the types vector of the client map…
XkbKeySymsPtr – Returns the pointer to the two-dimensional array of keysyms for the key corresponding to keycode Synopsis KeySym * XkbKeySymsPtr (XkbDescPtr xkb, KeyCode keycode); Arguments– xkb Xkb description of interest – keycode keycode of interestDescriptionThe key width and number of groups associated with a key are used to form a small two-dimensional array of…
XkbKeySymsOffset – Returns the offset of the two-dimensional array of keysyms for the key corresponding to keycode Synopsis int XkbKeySymsOffset (XkbDescPtr xkb, KeyCode keycode); Arguments– xkb Xkb description of interest – keycode keycode of interestDescriptionThe key width and number of groups associated with a key are used to form a small two-dimensional array of KeySyms…
XkbKeySymEntry – Returns the keysym corresponding to shift level shift and group grp from the two-dimensional array of keysyms for the key corresponding to keycode Synopsis KeySym XkbKeySymEntry (XkbDescPtr xkb, KeyCode keycode, int shift, int grp); Arguments– xkb Xkb description of interest – keycode keycode of interest – shift shift level of interest – grp…
XkbKeyNumSyms – Returns the total number of keysyms for the key corresponding to keycode Synopsis int XkbKeyNumSyms (XkbDescPtr xkb, KeyCode keycode); Arguments– xkb Xkb description of interest – keycode keycode of interestDescriptionThe key width and number of groups associated with a key are used to form a small two-dimensional array of KeySyms for a key….
XkbKeyNumGroups – Returns the number of groups of symbols bound to the key corresponding to keycode Synopsis int XkbKeyNumGroups (XkbDescPtr xkb, KeyCode keycode); Arguments– xkb Xkb description of interest – keycode keycode of interestDescriptionThe group_info field of an XkbSymMapRec is an encoded value containing the number of groups of symbols bound to the key as…
XkbKeyNumActions – Computes the number of actions associated with the key corresponding to keycode Synopsis int XkbKeyNumActions (XkbDescPtr xkb, KeyCode keycode); Arguments– xkb Xkb description of interest – keycode keycode of interestDescriptionA key action defines the effect key presses and releases have on the internal state of the server. For example, the expected key action…
XkbKeyHasActions – Determines if the key corresponding to keycode has any actions associated with it Synopsis int XkbKeyHasActions (XkbDescPtr xkb, KeyCode keycode); Arguments– xkb Xkb description of interest – keycode keycode of interestDescriptionA key action defines the effect key presses and releases have on the internal state of the server. For example, the expected key…
XkbKeyGroupsWidth – Computes the maximum width associated with the key corresponding to keycode Synopsis int XkbKeyGroupsWidth (XkbDescPtr xkb, KeyCode keycode); Arguments– xkb Xkb description of interest – keycode keycode of interestDescriptionThe key width and number of groups associated with a key are used to form a small two-dimensional array of KeySyms for a key. This…
XkbKeyGroupWidth – Computes the width of the type associated with the group grp for the key corresponding to keycode Synopsis int XkbKeyGroupWidth (XkbDescPtr xkb, KeyCode keycode, int grp); Arguments– xkb Xkb description of interest – keycode keycode of interest – grp group of interestDescriptionThe key width and number of groups associated with a key are…
XkbKeyGroupInfo – Returns the number of groups of symbols bound to the key corresponding to keycode Synopsis unsigned char XkbKeyGroupInfo (XkbDescPtr xkb, KeyCode keycode); Arguments– xkb Xkb description of interest – keycode keycode of interestDescriptionThe group_info field of an XkbSymMapRec is an encoded value containing the number of groups of symbols bound to the key…
XkbKeyActionsPtr – Returns a pointer to the two-dimensional array of key actions associated with the key corresponding to keycode Synopsis XkbKeyActionPtr XkbKeyActionsPtr (XkbDescPtr xkb, KeyCode keycode); Arguments– xkb Xkb description of interest – keycode keycode of interestDescriptionA key action defines the effect key presses and releases have on the internal state of the server. For…
XkbKeyActionEntry – Returns a pointer to the key action corresponding to group grp and shift level lvl from the two-dimensional table of key actions associated with the key corresponding to keycode Synopsis XkbAction * XkbKeyActionEntry (XkbDescPtr xkb, KeyCode keycode, int shift, int grp); Arguments– xkb Xkb description of interest – keycode keycode of interest –…
XkbKeyAction – Returns the key action Synopsis XkbAction XkbKeyAction (XkbDescPtr xkb, KeyCode keycode, int idx); Arguments– xkb Xkb description of interest – keycode keycode of interest – idx index for group and shift levelDescriptionA key action defines the effect key presses and releases have on the internal state of the server. For example, the expected…
XkbInitCanonicalKeyTypes – Set the definitions of the canonical key types in a client map to their default values Synopsis Status XkbInitCanonicalKeyTypes (XkbDescPtr xkb, unsigned int which, int keypadVMod); Arguments– xkb keyboard description containing client map to initialize – which mask of types to initialize – keypadVMod index of NumLock virtual modifierDescriptionXkbInitCanonicalKeyTypes initializes the first XkbNumRequiredTypes…
XkbIgnoreExtension – Prevents core X library keyboard functions from using the X Keyboard Extension Synopsis Bool XkbIgnoreExtension (Bool *ignore); Argumentsignore True means ignore the extensionDescriptionIf a server supports the Xkb extension, the X library normally implements preXkb keyboard functions using the Xkb keyboard description and state. The server Xkb keyboard state may differ from the…