Section 3: library functions
XkbChangeEnabledControls – Manipulates the EnabledControls control Synopsis Bool XkbChangeEnabledControls (Display *dpy, unsigned int device_spec, unsigned int mask, unsigned int values); Arguments – dpy connection to X server – device_spec keyboard device to modify – mask 1 bit -> controls to enable / disable – values 1 bit => enable, 0 bit => disable Description…
XkbChangeDeviceInfo – Update the server’s description of a device with the changes noted in an XkbDeviceChangesRec Synopsis Bool XkbChangeDeviceInfo (Display *dpy, XkbDeviceInfoPtr device_info, XkbDeviceChangesPtr changes); Arguments – dpy connection to X server – device_info local copy of device state and configuration – changes note specifying changes in device_info Description XkbChangeDeviceInfo updates the server’s description…
XkbChangeControls – Provides a flexible method for updating the controls in a server to match those in the changed keyboard description Synopsis Bool XkbChangeControls (Display *dpy, XkbDescPtr xkb, XkbControlsChangesPtr changes); Arguments – dpy connection to X server – xkb keyboard description with changed xkb->ctrls – changes which parts of xkb->ctrls have changed Description The…
XkbBellEvent – Provides a function that initiates a bell event for the keyboard without ringing the bell Synopsis Bool XkbBellEvent (Display *display, Window window, int percent, Atom name); Arguments – display connection to the X server – window the event window, or None – percent, relative volume, which can range from -100 to 100…
XkbBell – Rings the bell on the default keyboard Synopsis Bool XkbBell (Display *display, Window window, int percent, Atom name); Arguments – display connection to the X server – window event window, or None – percent relative volume, which can range from -100 to 100 inclusive – name a bell name, or NULL Description…
XkbApplyCompatMapToKey – Apply the new compatibility mapping to an individual key to get its semantics updated Synopsis Bool XkbApplyCompatMapToKey (XkbDescPtr xkb, KeyCode key, XkbChangesPtr changes); Arguments – xkb keyboard description to be updated – key key to be updated – changes notes changes to the Xkb keyboard description Description XkbApplyCompatMapToKey essentially performs the operation…
XkbAllocServerMap – Allocate and initialize an empty server map description record Synopsis Status XkbAllocServerMap (XkbDescPtr xkb, unsigned int which, unsigned int count_acts); Arguments – xkb keyboard description in which to allocate server map – which mask selecting map components to allocate – count_acts value of num_acts field in map to be allocated Description XkbAllocServerMap…
XkbAllocNames – Allocate symbolic names structures Synopsis Status XkbAllocNames (XkbDescPtr xkb, unsigned int which, int num_rg, int num_key_aliases); Arguments – xkb keyboard description for which names are to be allocated – which mask of names to be allocated – num_rg total number of radio group names needed – num_key_aliases total number of key aliases…
XkbAllocKeyboard – Creates a keyboard description from scratch Synopsis XkbDescRec XkbAllocKeyboard (void); Description Applications seldom need to directly allocate a keyboard description; calling XkbGetKeyboard usually suffices. In the event you need to create a keyboard description from scratch, however, use XkbAllocKeyboard rather than directly calling malloc. If XkbAllocKeyboard fails to allocate the keyboard description,…
XkbAllocIndicatorMaps – Allocates, directly, the indicators member of the keyboard description record Synopsis Status XkbAllocIndicatorMaps (variable_type *xkb); Arguments – xkb keyboard description structure Description The xkb parameter must point to a valid keyboard description. If it doesn’t, XkbAllocIndicatorMaps returns a BadMatch error. Otherwise, XkbAllocIndicatorMaps allocates and initializes the indicators member of the keyboard description…
XkbAllocGeometry – Allocate an entire geometry Synopsis Status XkbAllocGeometry (XkbDescPtr xkb, XkbGeometrySizesPtr sizes); Arguments – xkb keyboard description for which geometry is to be allocated – sizes initial sizes for all geometry components Description Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create…
XkbAllocGeomShapes – Allocate space for an arbitrary number of geometry shapes Synopsis Status XkbAllocGeomShapes (XkbGeometryPtr geom, int num_needed); Arguments – geom geometry for which shapes should be allocated – num_needed number of new shapes required Description Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions…
XkbAllocGeomSections – Allocate geometry sections Synopsis Status XkbAllocGeomSections (XkbGeometryPtr geom, int num_needed); Arguments – geom geometry for which sections should be allocated – num_needed number of new sections required Description Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries….
XkbAllocGeomSectionDoodads – Allocate doodads that are specific to a section Synopsis Status XkbAllocGeomSectionDoodads (XkbSectionPtr section, int num_needed); Arguments – section section for which doodads should be allocated – num_needed number of new doodads required Description Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to…
XkbAllocGeomRows – Allocate rows in a section Synopsis Status XkbAllocGeomRows (XkbSectionPtr section, int num_needed); Arguments – section section for which rows should be allocated – num_needed number of new rows required Description Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify…
XkbAllocGeomProps – Allocate geometry properties Synopsis Status XkbAllocGeomProps (XkbGeometryPtr geom, int num_needed); Arguments – geom _summary_ – num_needed _summary_ Description Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries. Note that these functions merely allocate space for the new…
XkbAllocGeomPoints – Allocate points in an outline Synopsis Status XkbAllocGeomPoints (XkbOutlinePtr outline, int num_needed); Arguments – outline outline for which points should be allocated – num_needed number of new points required Description Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify…
XkbAllocGeomOverlays – Allocate overlays in a section Synopsis Status XkbAllocGeomOverlays (XkbSectionPtr section, int num_needed); Arguments – section section for which overlays should be allocated – num_needed number of new overlays required Description Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify…
XkbAllocGeomOverlayRows – Allocate rows in a overlay Synopsis Status XkbAllocGeomOverlayRows (XkbOverlayPtr overlay, int num_needed); Arguments – overlay section for which rows should be allocated – num_needed number of new rows required Description Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify…
XkbAllocGeomOverlayKeys – Allocate keys in an overlay row Synopsis Status XkbAllocGeomOverlayKeys (XkbOverlayRowPtr row, int num_needed); Arguments – row section for which rows should be allocated – num_needed number of new rows required Description Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or…