Section 3: library functions
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…
XkbGetXlibControls – Determines the current state of the Library Controls Synopsis unsigned int XkbGetXlibControls (Display *display); Arguments– display connection to X serverDescriptionXkbGetXlibControls returns the current state of the Library Controls as a bit mask that is an inclusive OR of the control masks from Table 1 for the controls that are enabled. For the optional…
XkbGetVirtualMods – Obtain a subset of the virtual modifier bindings (the vmods array) in a keyboard description Synopsis Status XkbGetVirtualMods (Display *dpy, unsigned int which, XkbDescPtr xkb); Arguments– dpy connection to server – which mask indicating virtual modifier bindings to get – xkb Xkb description where results will be placedDescriptionXkbGetVirtualMods sends a request to the…
XkbGetUpdatedMap – Update the client or server map information in an existing keyboard description Synopsis Status XkbGetUpdatedMap (Display *display, unsigned int which, XkbDescPtr xkb); Arguments– display connection to X server – which mask selecting subcomponents to populate – xkb keyboard description to be updatedDescriptionThe which parameter is a bitwise inclusive OR of the masks in…
XkbGetStickyKeysOptions – Queries the current StickyKeys attributes for a keyboard device Synopsis Bool XkbGetStickyKeysOptions (Display *display, unsigned int device_spec, unsigned int *options_rtrn); Arguments– display connection to X server – device_spec device ID, or XkbUseCoreKbd – options_rtrn backfilled with StickyKeys option maskDescriptionThe StickyKeys control has two options that can be accessed via the ax_options of an…
XkbGetState – Obtains the keyboard state Synopsis Status XkbGetState (Display *display, unsigned int device_spec, XkbStatePtr state_return); Argumentsdisplay connection to the X server device_spec device ID, or XkbUseCoreKbd state_return backfilled with Xkb stateDescriptionThe XkbGetState function queries the server for the current keyboard state, waits for a reply, and then backfills state_return with the results. All group…
XkbGetSlowKeysDelay – Gets the SlowKeys acceptance delay for a keyboard device Synopsis Bool XkbGetSlowKeysDelay (Display *display, unsigned int device_spec, unsigned int *delay_rtrn); Arguments– display connection to X server – device_spec device ID, or XkbUseCoreKbd – delay_rtrn backfilled with SlowKeys delay, msDescriptionSome users may accidentally bump keys while moving a hand or typing stick toward the…
XkbGetNames – Obtain symbolic names from the server Synopsis Status XkbGetNames (Display *dpy, unsigned int which, XkbDescPtr Xkb); Arguments– dpy connection to the X server – which mask of names or map components to be updated – Xkb keyboard description to be updatedDescriptionXkbGetNames retrieves symbolic names for the components of the keyboard extension from the…
XkbGetNamedIndicator – Look up the indicator map and other information for an indicator by name Synopsis Bool XkbGetNamedDeviceIndicator (Display *dpy, unsigned int dev_spec, unsigned int led_class, unsigned int led_id, Atom name, int *ndx_rtrn, Bool *state_rtrn, XkbIndicatorMapPtr map_rtrn, Bool *real_rtrn); Bool XkbGetNamedIndicator (Display *dpy, Atom name, int *ndx_rtrn, Bool *state_rtrn, XkbIndicatorMapPtr map_rtrn, Bool *real_rtrn); Arguments– dpy…
XkbGetNamedGeometry – Loads a keyboard geometry description from this database by name Synopsis Status XkbGetNamedGeometry (Display *dpy, XkbDescPtr xkb, Atom name);Arguments– dpy connection to the X server – xkb keyboard description into which the geometry should be loaded – name name of the geometry to be loadedDescriptionIt is also possible to load a keyboard geometry…
XkbGetNamedIndicator – Look up the indicator map and other information for an indicator by name Synopsis Bool XkbGetNamedDeviceIndicator (Display *dpy, unsigned int dev_spec, unsigned int led_class, unsigned int led_id, Atom name, int *ndx_rtrn, Bool *state_rtrn, XkbIndicatorMapPtr map_rtrn, Bool *real_rtrn); Bool XkbGetNamedIndicator (Display *dpy, Atom name, int *ndx_rtrn, Bool *state_rtrn, XkbIndicatorMapPtr map_rtrn, Bool *real_rtrn); Arguments– dpy…
XkbGetNameChanges – Update the local copy of the keyboard description with the actual values of the results of one or more calls to XkbNoteNameChanges Synopsis Status XkbGetNameChanges (Display *dpy, XkbDescPtr xkb, XkbNameChangesPtr changes); Arguments– dpy connection to the X server – xkb keyboard description to which names are copied – changes names components to be…
XkbGetMap – Allocate an XkbDescRec structure and populate it with the server’s keyboard client map and server map Synopsis XkbDescPtr XkbGetMap (Display *display, unsigned int which, unsigned int device_spec); Arguments– display connection to X server – which mask selecting subcomponents to populate – device_spec device_id, or XkbUseCoreKbdDescriptionXkb provides two functions to obtain the keyboard mapping…
XkbGetKeyboardByName – Build a new keyboard description from a set of named components, and to optionally have the server use the resulting description to replace an active one Synopsis XkbDescPtr XkbGetKeyboardByName (Display *dpy, unsigned int device_spec, XkbComponentNamesPtr names, unsigned int want, unsigned int need, Bool load); Arguments– dpy connection to X server – device_spec device…
XkbGetKeyboard – Retrieves one or more components of a keyboard device description Synopsis XkbDescPtr XkbGetKeyboard (Display *display, unsigned int which, unsigned int device_spec); Argumentsdisplay connection to the X server device_spec device ID, or XkbUseCoreKbd bits_to_change determines events to be selected / deselected values_for_bits 1=>select, 0->deselect; for events in bits_to_changeDescriptionXkbGetKeyboard allocates and returns a pointer to…
XkbGetKeyVirtualModMap – Obtain the virtual modifier map (the vmodmap array) for a subset of the keys in a keyboard description Synopsis Status XkbGetKeyVirtualModMap (Display *dpy, unsigned int first, unsigned int num, XkbDescPtr xkb); Arguments– dpy connection to server – first keycode of first key to fetch – num number of keys for which virtual mod…
XkbGetKeyTypes – Obtain the list of available key types in the server’s keyboard mapping Synopsis Status XkbGetKeyTypes (Display *dpy, unsigned int first, unsigned int num, XkbDescPtr xkb); Arguments– dpy connection to X server – first index to first type to get, 0 => 1st type – num number of key types to be returned –…