Section 3: library functions
XkbSelectEvents – Selects and / or deselects for delivery of one or more Xkb events and has them delivered under all conditions Synopsis Bool XkbSelectEvents (Display *display, unsigned int device_spec, unsigned long int bits_to_change, unsigned long int values_for_bits); Argumentsdisplay connection to the X server device_spec device ID, or XkbUseCoreKbd bits_to_change determines events to be selected…
XkbSelectEventDetails – Selects or deselects for a specific Xkb event and optionally places conditions on when events of that type are reported to your client Synopsis Bool XkbSelectEventDetails (Display *display, unsigned int device_spec, unsigned int event_type, unsigned long int bits_to_change, unsigned long int values_for_bits); Argumentsdisplay connection to the X server device_spec device ID, or XkbUseCoreKbd…
XkbSASetScreen – Sets the screenXXX field of act from s Synopsis void XkbSASetScreen (XkbSwitchScreenAction act, int s); Arguments– act action in which to set screenXXX – s value to set in screenXXXDescriptionActions associated with the XkbSwitchScreen action structure change the active screen on a multiscreen display. The type field of the XkbSwitchScreenAction structure should always…
XkbSASetPtrDfltValue – Sets the valueXXX field of act from val Synopsis void XkbSASetPtrDfltValue (XkbAction act, int val); Arguments– act action in which to set valueXXX – val value to set in valueXXXDescriptionActions associated with the XkbPtrDfltAction structure change the mk_dflt_btn attribute of the MouseKeys control. If the MouseKeys control is not enabled, KeyPress and KeyRelease…
XkbSASetGroup – Sets the group_XXX field of act from the group index grp Synopsis void XkbSASetGroup (XkbAction act, int grp);Arguments– act action from which to set group – grp group index to set in group_XXXDescriptionXkbSASetGroup sets the group_XXX field of act from the group index grp. StructureActions associated with the XkbGroupAction structure change the current…
XkbSAScreen – Returns the screenXXX field of act converted to a signed int Synopsis int XkbSAScreen (XkbSwitchScreenAction act); Arguments– act action from which to extract screenDescriptionActions associated with the XkbSwitchScreen action structure change the active screen on a multiscreen display. The type field of the XkbSwitchScreenAction structure should always be XkbSA_SwitchScreen. The flags field is…
XkbSARedirectVModsMask – Returns the vmods_mask0 and vmods_mask1 fields of act converted to an unsigned int Synopsis unsigned int XkbSARedirectVModsMask (XkbRedirectKeyAction act); Arguments– act action from which to extract vmodsDescriptionActions associated with the XkbRedirectKeyAction structure generate KeyPress and KeyRelease events containing a keycode different from the key that was pressed or released. The type field for…
XkbSARedirectVMods – Returns the vmods0 and vmods1 fields of act converted to an unsigned int Synopsis unsigned int XkbSARedirectVMods (XkbRedirectKeyAction act); Arguments– act action from which to extract vmodsDescriptionActions associated with the XkbRedirectKeyAction structure generate KeyPress and KeyRelease events containing a keycode different from the key that was pressed or released. The type field for…
XkbSARedirectSetVModsMask – Sets the vmods_mask0 and vmods_mask1 fields of act from vm Synopsis void XkbSARedirectSetVModsMask (XkbRedirectKeyAction act, unsigned int vm); Arguments– act action in which to set vmods – vm new value for virtual modifier maskDescriptionActions associated with the XkbRedirectKeyAction structure generate KeyPress and KeyRelease events containing a keycode different from the key that was…
XkbSARedirectSetVMods – Sets the vmods0 and vmods1 of act from v Synopsis void XkbSARedirectSetVMods (XkbRedirectKeyAction act, unsigned int v); Arguments– act action in which to set vmods – v new value for virtual modifiersDescriptionActions associated with the XkbRedirectKeyAction structure generate KeyPress and KeyRelease events containing a keycode different from the key that was pressed or…
XkbSAPtrDfltValue – Returns the valueXXX field of act converted to a signed int Synopsis int XkbSAPtrDfltValue (XkbAction act); Arguments– act action from which to extract groupDescriptionActions associated with the XkbPtrDfltAction structure change the mk_dflt_btn attribute of the MouseKeys control. If the MouseKeys control is not enabled, KeyPress and KeyRelease events are treated as though the…
XkbSAGroup – Returns the group_XXX field of act converted to a signed int Synopsis int XkbSAGroup (XkbAction act);Arguments– act action from which to extract groupDescriptionXkbSAGroup returns the group_XXX field of act converted to a signed int. StructureActions associated with the XkbGroupAction structure change the current group state when keys are pressed and released: typedef struct…
XkbSAActionSetCtrls – Sets the ctrls0 through ctrls3 fields of act from ctrls Synopsis void XkbSAActionSetCtrls (XkbCtrlsAction act, unsigned int ctrls); Arguments– act action in which to set ctrls0-ctrls3 – ctrls value to set in ctrls0-ctrls3DescriptionActions associated with the XkbCtrlsAction structure change the state of the boolean controls. The type field can have any one of…
XkbResizeKeyType – Change the number of levels in a key type Synopsis Status XkbResizeKeyType (XkbDescPtr xkb, int type_ndx, int map_count, Bool want_preserve, int new_num_lvls); Arguments– xkb keyboard description containing client map to update – type_ndx index in xkb->map->types of type to change – map_count total # of map entries needed for the type – want_preserve…
XkbResizeKeySyms – Change the number of symbols bound to a key Synopsis KeySym * XkbResizeKeySyms (XkbDescRec *xkb, int key, int needed); Arguments– xkb keyboard description to be changed – key keycode for key to modify – needed new number of keysyms required for keyDescriptionXkbResizeKeySyms reserves the space needed for needed keysyms and returns a pointer…
XkbResizeKeyActions – Change the number of actions bound to a key Synopsis XkbAction * XkbResizeKeyActions (XkbDescRec *xkb, int key, int needed); Arguments– xkb keyboard description to change – key keycode of key to change – needed new number of actions requiredDescriptionThe xkb parameter points to the keyboard description containing the key whose number of actions…
XkbResizeDeviceButtonActions – Allocate additional space for button actions in an XkbDeviceInfoRec structure Synopsis Status XkbResizeDeviceButtonActions (XkbDeviceInfoPtr device_info, unsigned int new_total); Arguments– device_info structure in which to allocate button actions – new_total new total number of button actions neededDescriptionXkbResizeDeviceButtonActions reallocates space, if necessary, to make sure there is room for a total of new_total button actions…
XkbRefreshKeyboardMapping – Update the keyboard description that is internal to the X library Synopsis Status XkbRefreshKeyboardMapping (XkbMapNotifyEvent *event); Arguments– event event initiating remappingDescriptionXkbRefreshKeyboardMapping is the Xkb equivalent of the core XRefreshKeyboardMapping function. It requests that the X server send the current key mapping information to this client. A client usually invokes XkbRefreshKeyboardMapping after receiving an…
XkbQueryExtension – Determines the compatibility of a library at runtime. Synopsis Bool XkbQueryExtension (Display *dpy, int *opcode_rtrn, int *event_rtrn, int *error_rtrn, int *major_in_out, int *minor_in_out); Argumentsdpy connection to the X server opcode_rtrn backfilled with the major extension opcode event_rtrn backfilled with the extension base event code error_rtrn backfilled with the extension base error code major_in_out…
XkbPtrActionY – Returns the high_YYY and low_YYY fields of act converted to a signed int Synopsis int XkbPtrActionY (XkbPtrAction act); Arguments– act action from which to extract YDescriptionActions associated with the XkbPtrAction structure move the pointer when keys are pressed and released. If the MouseKeys control is not enabled, KeyPress and KeyRelease events are treated…