1XkbSetNamedIndicator(3)          XKB FUNCTIONS         XkbSetNamedIndicator(3)
2
3
4

NAME

6       XkbSetNamedIndicator  -  Names an indicator if it is not already named;
7       toggles the state of the indicator; sets the indicator to  a  specified
8       state and sets the indicator map for the indicator
9

SYNOPSIS

11
12
13       Bool    XkbSetNamedDeviceIndicator    (Display   *dpy,   unsigned   int
14              device_spec, unsigned int led_class, unsigned int  led_id,  Atom
15              name, Bool change_state, Bool state, Bool create_new, XkbIndica‐
16              torMapPtr map); Bool XkbSetNamedIndicator  (Display  *dpy,  Atom
17              name, Bool change_state, Bool state, Bool create_new, XkbIndica‐
18              torMapPtr map);
19

ARGUMENTS

21       - dpy  connection to the X server
22
23       - device_spec
24              device ID, or XkbUseCoreKbd
25
26       - led_class
27              feedback class, or XkbDfltXIClass
28
29       - led_id
30              feedback ID, or XkbDfltXIId
31
32       - name name of the indicator to change
33
34       - change_state
35              whether to change the indicator state or not
36
37       - state
38              desired new state for the indicator
39
40       - create_new
41              whether a new indicator with the specified name should  be  cre‐
42              ated when necessary
43
44       - map  new map for the indicator
45

DESCRIPTION

47       If  a  compatible  version of the Xkb extension is not available in the
48       server, XkbSetNamedDeviceIndicator returns False. Otherwise, it sends a
49       request  to  the X server to change the indicator specified by name and
50       returns True.
51
52       If change_state is True, XkbSetNamedDeviceIndicator tells the server to
53       change  the  state  of  the  named  indicator to the value specified by
54       state.  If change_state is False, then state is not used.
55
56       If an indicator with the name specified by name does not already exist,
57       the  create_new  parameter  tells the server whether it should create a
58       new named indicator. If create_new is True, the server finds the  first
59       indicator  that  doesn't have a name and gives it the name specified by
60       name.  If the optional parameter, map, is  not  NULL,  XkbSetNamedDevi‐
61       ceIndicator  tells the server to change the indicator's map to the val‐
62       ues specified in map.
63
64       In addition, it can also generate  XkbIndicatorStateNotify,  XkbIndica‐
65       torMapNotify, and XkbNamesNotify events.
66
67       XkbSetNamedIndicator  is a convenience function that calls XkbSetNamed‐
68       DeviceIndicator with a device_spec of  XkbUseCoreKbd,  a  led_class  of
69       XkbDfltXIClass,  and  a  led_id  of XkbDfltXIId.  It returns the return
70       value from XkbSetNamedDeviceIndicator.
71

RETURN VALUES

73       True           The XkbSetNamedIndicator and  XkbSetNamedDeviceIndicator
74                      functions return True if a compatible version of the Xkb
75                      extension is available in the server.
76
77       False          The XkbSetNamedIndicator and  XkbSetNamedDeviceIndicator
78                      functions  return  False  if a compatible version of the
79                      Xkb extension is not available in the server.
80

DIAGNOSTICS

82       BadAtom        A name is neither a valid Atom or None
83
84       BadImplementation
85                      Invalid reply from server
86
87       BadKeyboard    device_spec does not specify a device with indicators.
88
89       BadMatch       led_id is not DfltXIId and does not specify  a  feedback
90                      of the class specified by led_class on the device speci‐
91                      fied by device_spec.
92
93       BadValue       led_class does  not  specify  DfltXIClass,  LedFeedback‐
94                      Class, or KbdFeedbackClass.
95

SEE ALSO

97       XkbIndicatorMapNotify(3), XkbIndicatorStateNotify(3), XkbNamesNotify(3)
98
99
100
101
102X Version 11                     libX11 1.6.7          XkbSetNamedIndicator(3)
Impressum