xkbgetindicatormap(3) [x11r4 man page]
XkbGetIndicatorMap(3) XKB FUNCTIONS XkbGetIndicatorMap(3) NAME
XkbGetIndicatorMap - Gets the map for one or more indicators, using a mask to specify the indicators SYNOPSIS
Status XkbGetIndicatorMap ( dpy, which, desc ) Display *dpy; unsigned int which; XkbDescPtr desc; ARGUMENTS
- dpy connection to the X server - which mask of indicators for which maps should be returned - desc keyboard description to be updated DESCRIPTION
Xkb allows applications to obtain information about indicators using two different methods. The first method, which is similar to the core X implementation, uses a mask to specify the indicators. The second method, which is more suitable for applications concerned with interop- erability, uses indicator names. The correspondence between the indicator name and the bit position in masks is as follows: one of the parameters returned from XkbGetNamedIndicators is an index that is the bit position to use in any function call that requires a mask of indicator bits, as well as the indicator's index into the XkbIndicatorRec array of indicator maps. XkbGetIndicatorMap obtains the maps from the server for only those indicators specified by the which mask and copies the values into the keyboard description specified by desc. If the indicators field of the desc parameter is NULL, XkbGetIndicatorMap allocates and initial- izes it. To free the indicator maps, use XkbFreeIndicatorMaps. DIAGNOSTICS
BadAlloc Unable to allocate storage BadMatch A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid BadImplementation Invalid reply from server SEE ALSO
XkbFreeIndicatorMaps(3), XkbGetNamedIndicators(3) X Version 11 libX11 1.2.1 XkbGetIndicatorMap(3)
Check Out this Related Man Page
XkbGetIndicatorState(3) XKB FUNCTIONS XkbGetIndicatorState(3) NAME
XkbGetIndicatorState - Obtains the current state of the keyboard indicators SYNOPSIS
Status XkbGetIndicatorState (Display *display, unsigned int device_spec, unsigned int state_return); ARGUMENTS
- display connection to the X server - device_spec device ID, or XkbUseCoreKbd - state_return backfilled with a mask of the indicator state DESCRIPTION
Xkb allows applications to obtain information about indicators using two different methods. The first method, which is similar to the core X implementation, uses a mask to specify the indicators. The second method, which is more suitable for applications concerned with interop- erability, uses indicator names. The correspondence between the indicator name and the bit position in masks is as follows: one of the parameters returned from XkbGetNamedIndicators is an index that is the bit position to use in any function call that requires a mask of indicator bits, as well as the indicator's index into the XkbIndicatorRec array of indicator maps. XkbGetIndicatorState queries the display for the state of the indicators on the device specified by the device_spec. For each indicator that is "turned on" on the device, the associated bit is set in state_return. If a compatible version of the Xkb extension is not avail- able in the server, XkbGetIndicatorState returns a BadMatch error. Otherwise, it sends the request to the X server, places the state of the indicators into state_return, and returns Success. Thus the value reported by XkbGetIndicatorState is identical to the value reported by the core protocol. DIAGNOSTICS
BadMatch A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid SEE ALSO
XkbGetNamedIndicators(3) X Version 11 libX11 1.6.0 XkbGetIndicatorState(3)