Section 3: library functions
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…
XkbPtrActionX – Returns the high_XXX and low_XXX fields of act converted to a signed int Synopsis int XkbPtrActionX (XkbPtrAction act); Arguments– act action from which to extract XDescriptionActions 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…
XkbOutOfRangeGroupNumber – Returns the out-of-range group number, represented as a group index, from the group_info field of an XkbSymMapRec structure Synopsis unsigned char XkbOutOfRangeGroupNumber (unsigned char grp_inf); Arguments– grp_inf Xkb description of interestDescriptionXkbOutOfRangeGroupNumber returns the out-of-range group number, represented as a group index, from the group_info field of an XkbSymMapRec structure. The group_info field of…
XkbOutOfRangeGroupInfo – Returns only the out-of-range processing information from the group_info field of an XkbSymMapRec structure Synopsis unsigned char XkbOutOfRangeGroupInfo (unsigned char grp_inf); Arguments– grp_inf Xkb description of interestDescriptionXkbOutOfRangeGroupInfo returns only the out-of-range processing information from the group_info field of an XkbSymMapRec structure. The group_info field of an XkbSymMapRec is an encoded value containing the…
XkbOpenDisplay – Checks for a compatible version of the Xkb extension in both the library and the server, and initializes the extension for use. Synopsis Display *XkbOpenDisplay (char *display_name, int *event_rtrn, int *error_rtrn, int *major_in_out, int *minor_in_out, int *reason_rtrn); Argumentsdisplay_name hardware display name, which determines the display and communications domain to be used event_rtrn backfilled…
XkbNoteNameChanges – Note the changed names in a changes structure Synopsis void XkbNoteNameChanges (XkbNameChangesPtr old, XkbNamesNotifyEvent *new, unsigned int wanted); Arguments– old XkbNameChanges structure to be updated – new event from which changes are to be copied – wanted types of names for which changes are to be notedDescriptionWhen your application receives a XkbNamesNotify event,…
XkbNoteIndicatorChanges – Notes the changes in a changes structure Synopsis void XkbNoteIndicatorChanges (XkbIndicatorChangesPtr old, XkbIndicatorNotifyEvent *new, unsigned int wanted); Arguments– old XkbIndicatorChanges structure to be updated – new event from which changes are to be copied – wanted which changes are to be notedDescriptionWhenever an indicator changes state, the server sends XkbIndicatorStateNotify events to all…
XkbNoteDeviceChanges – Note device changes reported in an XkbExtensionDeviceNotify event Synopsis void XkbNoteDeviceChanges (XkbDeviceChangesPtr old, XkbExtensionDeviceNotifyEvent *new, unsigned int wanted); Arguments– old structure tracking state changes – new event indicating state changes – wanted mask indicating changes to noteDescriptionThe wanted field specifies the changes that should be noted in old, and is composed of the…
XkbNoteControlsChanges – Notes the changes in a changes structure when a client receives an XkbControlsNotify event Synopsis void XkbNoteControlsChanges (XkbControlsChangesPtr changes, XkbControlsNotifyEvent *new, unsigned int wanted); Arguments– changes records changes indicated by new – new tells which things have changed – wanted tells which parts of new to record in changesDescriptionWhenever a field in the…
XkbModActionVMods – Returns the vmods1 and vmods2 fields of act converted to the vmods format of an Xkb modifier description Synopsis unsigned short XkbModActionVMods (XkbAction act); Arguments– act action from which to extract virtual modsDescriptionXkbModActionVMods returns the vmods1 and vmods2 fields of act converted to the vmods format of an Xkb modifier description.
XkbLookupKeySym – Find the symbol associated with a key for a particular state Synopsis Bool XkbLookupKeySym (Display *dpy, KeyCode key, unsigned int state, unsigned int *mods_rtrn, KeySym *sym_rtrn); Arguments– dpy connection to X server – key key for which symbols are to be found – state state for which symbol should be found – mods_rtrn…
XkbLookupKeyBinding – Find the string bound to a key by XRebindKeySym Synopsis int XkbLookupKeyBinding (Display *dpy, KeySym sym, unsigned int state, char *buf, int nbytes, int *extra_rtrn); Arguments– dpy connection to server – sym connection to server – state state for which string is to be looked up – buf buffer into which returned string…
XkbLockModifiers – Locks and unlocks any of the eight real keyboard modifiers Synopsis Bool XkbLockModifiers (Display *display, unsigned int device_spec, unsigned int affect, unsigned int values); Argumentsdisplay connection to the X server device_spec device ID, or XkbUseCoreKbd affect mask of real modifiers whose lock state is to change values 1 => lock, 0 => unlock;…
XkbLockGroup – Locks the keysym group Synopsis Bool XkbLockGroup (Display *display, unsigned int device_spec, unsigned int group); Argumentsdisplay connection to the X server device_spec device ID, or XkbUseCoreKbd group index of the keysym group to lockDescriptionXkbLockGroup sends a request to the server to lock the specified group and does not wait for a reply. It…
XkbListComponents – List of components for one or more component types Synopsis XkbComponentListPtr XkbListComponents (Display *dpy, unsigned int device_spec, XkbComponentNamesPtr ptrns, int *max_inout); Arguments– dpy connection to X server – device_spec device ID, or XkbUseCoreKbd – ptrns namelist for components of interest – max_inout max # returned names, # left overDescriptionYou may ask the server…