Section 3: library functions
XkbAllocGeomColors – Allocate geometry colors Synopsis Status XkbAllocGeomColors (XkbGeometryPtr geom, int num_needed); Arguments– geom geometry for which colors should be allocated – num_needed number of new colors requiredDescriptionXkb 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…
XkbAllocDeviceLedInfo – Obtain an XkbDeviceLedInfoRec structure Synopsis Status XkbAllocDeviceLedInfo (XkbDeviceInfoPtr device_info, int num_needed); Arguments– device_info structure in which to allocate LED space – num_needed number of indicators to allocate space forDescriptionXkbAllocDeviceLedInfo allocates space for an XkbDeviceLedInfoRec and places it in device_info. If num_needed is nonzero, num_needed XkbIndicatorMapRec structures are also allocated and linked into the…
XkbAllocDeviceInfo – Obtain an XkbDeviceInfoRec structure Synopsis XkbDeviceInfoPtr XkbAllocDeviceInfo (unsigned int device_spec, unsigned int n_buttons, unsigned int sz_leds); Arguments– device_spec device ID with which structure will be used – n_buttons number of button actions to allocate space for – sz_leds number of LED feedbacks to allocate space forDescriptionXkbAllocDeviceInfo allocates space for an XkbDeviceInfoRec structure and…
XkbAllocControls – Allocates an XkbControlsRec structure in the XkbDescRec Synopsis Status XkbAllocControls (XkbDescPtr xkb, unsigned int which); Arguments– xkb Xkb description in which to allocate ctrls rec – which mask of components of ctrls to allocateDescriptionThe need to allocate an XkbControlsRec structure seldom arises; Xkb creates one when an application calls XkbGetControls or a related…
XkbAllocCompatMap – Allocate a new compatibility map if you do not already have one available Synopsis Status XkbAllocCompatMap (XkbDescPtr xkb, unsigned int which, unsigned int num_si); Arguments– xkb keyboard description in which to allocate compat map – which mask of compatibility map components to allocate – num_si number of symbol interpretations to allocateDescriptionxkb specifies the…
XkbAllocClientMap – Allocate and initialize an empty client map description record Synopsis Status XkbAllocClientMap (XkbDescPtr xkb, unsigned int which, unsigned int type_count); Arguments– xkb keyboard description in which to allocate client map – which mask selecting map components to allocate – type_count value of num_types field in map to be allocatedDescriptionCalling XkbGetMap should be sufficient…
XkbAddSymInterpret – Add a symbol interpretation to the list of symbol interpretations in an XkbCompatRec Synopsis XkbSymInterpretPtr XkbAddSymInterpret (XkbDescPtr xkb, XkbSymInterpretPtr si, Bool updateMap, XkbChangesPtr changes); Arguments– xkb keyboard description to be updated – si symbol interpretation to be added – updateMap True=>apply compatibility map to keys – changes changes are put hereDescriptionXkbAddSymInterpret adds si…
XkbAddGeomShape – Add a shape to a keyboard geometry Synopsis XkbShapePtr XkbAddGeomShape (XkbGeometryPtr geom, Atom name, int sz_outlines); Arguments– geom geometry to be updated – name name of the new shape – sz_outlines number of outlines to be reservedDescriptionXkb provides functions to add a single new element to the top-level keyboard geometry. In each case…
XkbAddGeomSection – Add one section to an existing keyboard geometry Synopsis XkbSectionPtr XkbAddGeomSection (XkbGeometryPtr geom, Atom name, int sz_rows, int sz_doodads, int sz_overlays); Arguments– geom geometry to be updated – name name of the new section – sz_rows number of rows to reserve in the section – sz_doodads number of doodads to reserve in the…
XkbAddGeomRow – Add a row to a section Synopsis XkbRowPtr XkbAddGeomRow (XkbSectionPtr section, int sz_keys); Arguments– section section to be updated – sz_keys number of keys to be reservedDescriptionXkb provides functions to add a single new element to the top-level keyboard geometry. In each case the num_ * fields of the corresponding structure is incremented…
XkbAddGeomProperty – Add one property to an existing keyboard geometry description Synopsis XkbPropertyPtr XkbAddGeomProperty (XkbGeometryPtr geom, char *name, char *value); Arguments– geom geometry to be updated – name name of the new property – value value for the new propertyDescriptionXkb provides functions to add a single new element to the top-level keyboard geometry. In each…
XkbAddGeomOverlayRow – Add a row to an existing overlay Synopsis XkbOverlayRowPtr XkbAddGeomOverlayRow (XkbOverlayPtr overlay, XkbRowPtr row_under, int sz_keys); Arguments– overlay overlay to be updated – row_under row to be overlayed in the section overlay overlays – sz_keys number of keys to reserve in the rowDescriptionXkb provides functions to add a single new element to the…
XkbAddGeomOverlayKey – Add a key to an existing overlay row Synopsis XkbOverlayKeyPtr XkbAddGeomOverlayKey (XkbOverlayPtr overlay, XkbRowPtr row, char *under); Arguments– overlay overlay to be updated – row row in overlay to be updated – under primary name of the key to be consideredDescriptionXkb provides functions to add a single new element to the top-level keyboard…
XkbAddGeomOverlay – Add one overlay to a section Synopsis XkbOverlayPtr XkbAddGeomOverlay (XkbSectionPtr section, Atom name, int sz_rows); Arguments– section section to which an overlay will be added – name name of the overlay – sz_rows number of rows to reserve in the overlayDescriptionXkb provides functions to add a single new element to the top-level keyboard…
XkbAddGeomOutline – Add one outline to an existing shape Synopsis XkbOutlinePtr XkbAddGeomOutline (XkbShapePtr shape, int sz_points); Arguments– shape shape to be updated – sz_points number of points to be reservedDescriptionXkb provides functions to add a single new element to the top-level keyboard geometry. In each case the num_ * fields of the corresponding structure is…
XkbAddGeomKeyAlias – Add one key alias to an existing keyboard geometry description Synopsis XkbKeyAliasPtr XkbAddGeomKeyAlias (XkbGeometryPtr geom, char *alias, char *real); Arguments– geom geometry to be updated – alias alias to be added – real real name to be bound to the new aliasDescriptionXkb provides functions to add a single new element to the top-level…
XkbAddGeomKey – Add one key at the end of an existing row of keys Synopsis XkbKeyPtr XkbAddGeomKey (XkbRowPtr row); Arguments– row row to be updatedDescriptionXkb provides functions to add a single new element to the top-level keyboard geometry. In each case the num_ * fields of the corresponding structure is incremented by 1. These functions…
XkbAddGeomDoodad – Add one doodad to a section of a keyboard geometry or to the top-level geometry Synopsis XkbDoodadPtr XkbAddGeomDoodad (XkbGeometryPtr geom, XkbSectionPtr section, Atom name); Arguments– geom geometry to which the doodad is added – section section, if any, to which the doodad is added – name name of the new doodadDescriptionXkb provides functions…
XkbAddGeomColor – Add one color name to an existing keyboard geometry description Synopsis XkbColorPtr XkbAddGeomColor (XkbGeometryPtr geom, char *spec, unsigned int pixel); Arguments– geom geometry to be updated – spec color to be added – pixel color to be addedDescriptionXkb provides functions to add a single new element to the top-level keyboard geometry. In each…
XkbAddDeviceLedInfo – Initialize an XkbDeviceLedInfoRec structure Synopsis XkbDeviceLedInfoPtr XkbAddDeviceLedInfo (XkbDeviceInfoPtr device_info, unsigned int led_class, unsigned int led_id); Arguments– device_info structure in which to add LED info – led_class input extension class for LED device of interest – led_id input extension ID for LED device of interestDescriptionXkbAddDeviceLedInfo first checks to see whether an entry matching led_class…