Section 3: library functions
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 descriptionDescriptionXkbApplyCompatMapToKey essentially performs the operation described in Core Keyboard…
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 allocatedDescriptionXkbAllocServerMap allocates and initializes an…
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 neededDescriptionMost applications…
XkbAllocKeyboard – Creates a keyboard description from scratch Synopsis XkbDescRec XkbAllocKeyboard (void); DescriptionApplications 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, it returns…
XkbAllocIndicatorMaps – Allocates, directly, the indicators member of the keyboard description record Synopsis Status XkbAllocIndicatorMaps (variable_type *xkb); Arguments– xkb keyboard description structureDescriptionThe 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 record and returns Success….
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 componentsDescriptionXkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries….
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 requiredDescriptionXkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify…
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 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…
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 requiredDescriptionXkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify keyboard…
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 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…
XkbAllocGeomProps – Allocate geometry properties Synopsis Status XkbAllocGeomProps (XkbGeometryPtr geom, int num_needed); Arguments– geom _summary_ – num_needed _summary_DescriptionXkb 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 element(s), and it is…
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 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…
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 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…
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 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…
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 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…
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 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…
XkbAllocGeomOutlines – Allocate space for an arbitrary number of outlines to a shape Synopsis Status XkbAllocGeomOutlines (XkbShapePtr shape, int num_needed); Arguments– shape shape for which outlines should be allocated – num_needed number of new outlines requiredDescriptionXkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create…
XkbAllocGeomKeys – Allocate space for an arbitrary number of keys to a row Synopsis Status XkbAllocGeomKeys (XkbRowPtr row, int num_needed); Arguments– row row to which keys should be allocated – num_needed number of new keys requiredDescriptionXkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create…
XkbAllocGeomKeyAliases – Allocate geometry key aliases Synopsis Status XkbAllocGeomKeyAliases (XkbGeometryPtr geom, int num_needed); Arguments– geom geometry for which key aliases should be allocated – num_needed number of new key aliases 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…
XkbAllocGeomDoodads – Allocate doodads that are global to a keyboard geometry Synopsis Status XkbAllocGeomDoodads (XkbGeometryPtr geom, int num_needed); Arguments– geom geometry for which doodads should be allocated – num_needed number of new doodads requiredDescriptionXkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify…