Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
Bool XkbSetNamedDeviceIndicator "(\^Display *" "dpy" "\^," "unsigned int " "device_spec" "\^," "unsigned int " "led_class" "\^," "unsigned int " "led_id" "\^," "Atom " "name" "\^," "Bool " "change_state" "\^," "Bool " "state" "\^," "Bool " "create_new" "\^," "XkbIndicatorMapPtr " "map" "\^);" Bool XkbSetNamedIndicator "(\^Display *" "dpy" "\^," "Atom " "name" "\^," "Bool " "change_state" "\^," "Bool " "state" "\^," "Bool " "create_new" "\^," "XkbIndicatorMapPtr " "map" "\^);"
dpy connection to the X server
device_spec device ID, or XkbUseCoreKbd
led_class feedback class, or XkbDfltXIClass
led_id feedback ID, or XkbDfltXIId
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
If a compatible version of the Xkb extension is not available in the server, XkbSetNamedDeviceIndicator 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, XkbSetNamedDeviceIndicator tells the server to change the state of the named indicator to the value specified by state . If change_state is False, then state is not used. 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, XkbSetNamedDeviceIndicator 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.
XkbSetNamedIndicator is a convenience function that calls XkbSetNamedDeviceIndicator with a device_spec of XkbUseCoreKbd , a led_class of XkbDfltXIClass , and a led_id of XkbDfltXIId . It returns the return value from XkbSetNamedDeviceIndicator .
15 True The XkbSetNamedIndicator " and " XkbSetNamedDeviceIndicator functions return True if a compatible version of the Xkb extension is available in the server.
15 False The XkbSetNamedIndicator " and " XkbSetNamedDeviceIndicator functions return False if a compatible version of the Xkb extension is not available in the server.
15 BadAtom A name is neither a valid Atom or None
15 BadImplementation Invalid reply from server
15 BadKeyboard device_spec does not specify a device with indicators.
15 BadMatch led_id is not DfltXIId and does not specify a feedback of the class specified by led_class on the device specified by device_spec .
15 BadValue led_class does not specify DfltXIClass ", " LedFeedbackClass ", or " KbdFeedbackClass .