Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xkbgetnamedindicator(3) [x11r4 man page]

XkbGetNamedIndicator(3) 					   XKB FUNCTIONS					   XkbGetNamedIndicator(3)

NAME
XkbGetNamedIndicator - Look up the indicator map and other information for an indicator by name SYNOPSIS
Bool XkbGetNamedIndicator ( dpy, dev_spec, name, ndx_rtrn, state_rtrn, map_rtrn, real_rtrn ) Display *dpy; unsigned int dev_spec; Atom name; int *ndx_rtrn; Bool *state_rtrn; XkbIndicatorMapPtr map_rtrn; Bool *real_rtrn; ARGUMENTS
- dpy connection to the X server - dev_spec keyboard device ID, or XkbUseCoreKbd - name name of the indicator to be retrieved - ndx_rtrn backfilled with the index of the retrieved indicator - state_rtrn backfilled with the current state of the retrieved indicator - map_rtrn backfilled with the mapping for the retrieved indicator - real_rtrn backfilled with True if the named indicator is real (physical) DESCRIPTION
Xkb also allows applications to refer to indicators by name. Use XkbGetNames to get the indicator names. Using names eliminates the need for hard-coding bitmask values for particular keyboards. For example, instead of using vendor-specific constants such as WSKBLed_ScrollLock mask on Digital workstations or XLED_SCROLL_LOCK on Sun workstations, you can instead use XkbGetNamedIndicator to look up information on the indicator named "Scroll Lock." If the device specified by device_spec has an indicator named name, XkbGetNamedIndicator returns True and populates the rest of the parame- ters with information about the indicator. Otherwise, XkbGetNamedIndicator returns False. The ndx_rtrn field returns the zero-based index of the named indicator. This index 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. state_rtrn returns the current state of the named indicator (True = on, False = off). map_rtrn returns the indicator map for the named indicator. In addi- tion, if the indicator is mapped to a physical LED, the real_rtrn parameter is set to True. Each of the " _rtrn " arguments is optional; you can pass NULL for any unneeded " _rtrn " arguments. RETURN VALUES
True The XkbGetNamedIndicator function returns True if the device specified by device_spec has an indicator named name. False The XkbGetNamedIndicator function returns False if the device specified by device_spec does not have an indicator named name. SEE ALSO
XkbGetNames(3) X Version 11 libX11 1.2.1 XkbGetNamedIndicator(3)

Check Out this Related Man Page

XkbSetNamedIndicator(3) 					   XKB FUNCTIONS					   XkbSetNamedIndicator(3)

NAME
XkbSetNamedIndicator - Names an indicator if it is not already named; toggles the state of the indicator; sets the indicator to a specified state and sets the indicator map for the indicator SYNOPSIS
Bool XkbSetNamedIndicator (Display *dpy, unsigned int device_spec, Atom name, Bool change_state, Bool state, Bool create_new, XkbIndica- torMapPtr map); ARGUMENTS
- dpy connection to the X server - device_spec device ID, or XkbUseCoreKbd - name name of the indicator to change - change_state whether to change the indicator state or not - state desired new state for the indicator - create_new whether a new indicator with the specified name should be created when necessary - map new map for the indicator DESCRIPTION
If a compatible version of the Xkb extension is not available in the server, XkbSetNamedIndicator returns False. Otherwise, it sends a request to the X server to change the indicator specified by name and returns True. If change_state is True, and the optional parameter, state, is not NULL, XkbSetNamedIndicator tells the server to change the state of the named indicator to the value specified by state. If an indicator with the name specified by name does not already exist, the create_new parameter tells the server whether it should create a new named indicator. If create_new is True, the server finds the first indicator that doesn't have a name and gives it the name specified by name. If the optional parameter, map, is not NULL, XkbSetNamedIndicator tells the server to change the indicator's map to the values specified in map. In addition, it can also generate XkbIndicatorStateNotify, XkbIndicatorMapNotify, and XkbNamesNotify events. RETURN VALUES
True The XkbSetNamedIndicator function returns True if a compatible version of the Xkb extension is available in the server. False The XkbSetNamedIndicator function returns False if a compatible version of the Xkb extension is not available in the server. DIAGNOSTICS
BadAtom A name is neither a valid Atom or None BadImplementation Invalid reply from server SEE ALSO
XkbIndicatorMapNotify(3), XkbIndicatorStateNotify(3), XkbNamesNotify(3) X Version 11 libX11 1.6.0 XkbSetNamedIndicator(3)
Man Page