Section 3: library functions
XkbFreeDeviceInfo – Free an XkbDeviceInfoRec structure Synopsis void XkbFreeDeviceInfo (XkbDeviceInfoPtr device_info, unsigned int which, Bool free_all); Arguments – device_info pointer to XkbDeviceInfoRec in which to free items – which mask of components of device_info to free – free_all True => free everything, including device_info Description If free_all is True, the XkbFreeDeviceInfo frees all components…
XkbFreeControls – Frees memory used by the ctrls member of an XkbDescRec structure Synopsis void XkbFreeControls (XkbDescPtr xkb, unsigned int which, Bool free_all); Arguments – xkb Xkb description in which to free controls components – which mask of components of ctrls to free – free_all True => free everything + ctrls itself Description XkbFreeControls…
XkbFreeComponentList – Free the structure returned by XkbListComponents Synopsis void XkbFreeComponentList (XkbComponentListPtr list); Arguments – list pointer to XkbComponentListRec to free Description When you are done using the structure returned by XkbListComponents, free it using XkbFreeComponentList. See Also XkbListComponents(3)
XkbFreeCompatMap – Free an entire compatibility map or selected portions of one Synopsis void XkbFreeCompatMap (XkbDescPtr xkb, unsigned int which, Bool free_map); Arguments – xkb Xkb description in which to free compatibility map – which mask of compatibility map components to free – free_map True => free XkbCompatMap structure itself Description which specifies the…
XkbFreeClientMap – Free memory used by the client map member of an XkbDescRec structure Synopsis void XkbFreeClientMap (XkbDescPtr xkb, unsigned int which, Bool free_all); Arguments – xkb keyboard description containing client map to free – which mask identifying components of map to free – free_all True => free all client components and map itself…
XkbForceDeviceBell – Rings the bell on any keyboard, overriding user preference settings for audible bells Synopsis Bool XkbForceDeviceBell (Display *display, Window window, unsigned int device_spec, unsigned int bell_class, unsigned int bell_id, int percent); Arguments – display connection to the X server – window event window, or None – device_spec device ID, or XkbUseCoreKbd –…
XkbForceBell – Overrides user preference settings for audible bells to ring the bell on the default keyboard Synopsis Bool XkbForceBell (Display *display, int percent); Arguments – display connection to the X server – percent volume for the bell, which can range from -100 to 100 inclusive Description The core X protocol allows only applications…
XkbFindOverlayForKey – Find the alternate name by using the primary name for a key that is part of an overlay Synopsis char * XkbFindOverlayForKey (XkbGeometryPtr geom, XkbSectionPtr section, char *under); Arguments – geom geometry that contains the section – section section to be searched for matching keys – under primary name of the key…
XkbDeviceBellEvent – Creates a bell event for an X input extension device or for the keyboard, without ringing the corresponding bell Synopsis Bool XkbDeviceBellEvent (Display *display, Window window, unsigned int device_spec, unsigned int bell_class, unsigned int bell_id, int percent, Atom name); Arguments – display connection to the X server – window event window, or…
XkbDeviceBell – Rings the bell on an X input extension device or the default keyboard Synopsis Bool XkbDeviceBell (Display *display, Window window, unsigned int device_spec, unsigned int bell_class, unsigned int bell_id, int percent, Atom name); Arguments – display connection to the X server – window window for which the bell is generated, or None…
XkbCopyKeyTypes – Copy more than one XkbKeyTypeRec structure Synopsis Status XkbCopyKeyTypes (XkbKeyTypePtr from, XkbKeyTypePtr into, int num_types); Arguments – from pointer to array of XkbKeyTypeRecs to copy – into pointer to array of XkbKeyTypeRecs to change – num_types number of types to copy Description XkbCopyKeyTypes copies num_types XkbKeyTypeRec structures from the array specified by…
XkbCopyKeyType – Copy one XkbKeyTypeRec structures Synopsis Status XkbCopyKeyType (XkbKeyTypePtr from, XkbKeyTypePtr into); Arguments – from pointer to XkbKeyTypeRec to be copied – into pointer to XkbKeyTypeRec to be changed Description XkbCopyKeyType copies the key type specified by from to the key type specified by into. Both must point to legal XkbKeyTypeRec structures. Xkb…
XkbComputeShapeTop – Determines the bounding box of the top surface of a shape Synopsis Bool XkbComputeShapeTop (XkbShapePtr shape, XkbBoundsPtr bounds_rtrn); Arguments – shape shape to be examined – bounds_rtrn backfilled with the bounding box for the shape Description Xkb provides a number of convenience functions to help use a keyboard geometry. These include functions…
XkbComputeShapeBounds – Updates the bounding box of a shape Synopsis Bool XkbComputeShapeBounds (XkbShapePtr shape); Arguments – shape shape to be examined Description Xkb provides a number of convenience functions to help use a keyboard geometry. These include functions to return the bounding box of a shape’s top surface and to update the bounding box…
XkbComputeSectionBounds – Update the bounding box of a section Synopsis Bool XkbComputeSectionBounds (XkbGeometryPtr geom, XkbSectionPtr section); Arguments – geom geometry that contains the section – section section to be examined and updated Description If you add or delete a row to or from a section, or if you change the geometry of any of…
XkbComputeRowBounds – Update the bounding box of a row Synopsis Bool XkbComputeRowBounds (XkbGeometryPtr geom, XkbSectionPtr section, XkbRowPtr row); Arguments – geom geometry that contains the section – section section that contains the row – row row to be examined and updated Description XkbComputeRowBounds checks the bounds of all keys in the row and updates…
XkbChangeTypesOfKey – Change the number of groups and the types bound to a key Synopsis Status XkbChangeTypesOfKey (XkbDescPtr xkb, int key, int n_groups, unsigned int groups, int *new_types_in, XkbMapChangesPtr p_changes); Arguments – xkb keyboard description to be changed – key keycode for key of interest – n_groups new number of groups for key –…
XkbChangeNames – _summary-line_ Synopsis Bool XkbChangeNames (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 updated Description XkbChangeNames provides a more flexible method for changing symbolic names than XkbSetNames and requires…
XkbChangeMap – Update only partial components of a keyboard description, modify the appropriate fields in the server and map components of a local copy of the keyboard description Synopsis Bool XkbChangeMap (Display *dpy, XkbDescPtr xkb, XkbMapChangesPtr changes); Arguments – dpy connection to X server – xkb description from which new values are taken –…
XkbChangeIndicators – Changes indicator maps or state without passing the entire keyboard description Synopsis Bool XkbChangeIndicators (Display *dpy, XkbDescPtr xkb, XkbIndicatorChangesPtr changes, unsigned int state); Arguments – dpy connection to the X server – xkb keyboard description from which names are to be taken. – changes indicators to be updated on the server –…