1. 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
2. SYNOPSIS ▲
Bool XkbSetNamedIndicator (Display * dpy , unsigned int device_spec , Atom name , Bool change_state , Bool state , Bool create_new , XkbIndicatorMapPtr map );
3. 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
4. DESCRIPTION ▲
If a compatible version of the Xkb extension is not available in the server, XkbSetNamedIndicatorreturns False. Otherwise, it sends a request to the X server to change the indicator specified by nameand returns True. If change_stateis True, and the optional parameter, state,is not NULL, XkbSetNamedIndicatortells the server to change the state of the named indicator to the value specified by state. If an indicator with the name specified by namedoes not already exist, the create_newparameter tells the server whether it should create a new named indicator. If create_newis 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,XkbSetNamedIndicatortells 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.
5. RETURN VALUES ▲
- True
The XkbSetNamedIndicatorfunction returns True if a compatible version of the Xkb extension is available in the server. - False
The XkbSetNamedIndicatorfunction returns False if a compatible version of the Xkb extension is not available in the server.
6. DIAGNOSTICS ▲
BadAtom
A name is neither a valid Atom or None
BadImplementation
Invalid reply from server
7. SEE ALSO ▲
R XkbIndicatorMapNotify (3),
R XkbIndicatorStateNotify (3),
R XkbNamesNotify (3)