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       Bool XkbSetNamedIndicator (Display *dpy, unsigned int device_spec, Atom
12              name, Bool change_state, Bool state, Bool create_new, XkbIndica‐
13              torMapPtr map);
14

ARGUMENTS

16       - dpy  connection to the X server
17
18       - device_spec
19              device ID, or XkbUseCoreKbd
20
21       - name name of the indicator to change
22
23       - change_state
24              whether to change the indicator state or not
25
26       - state
27              desired new state for the indicator
28
29       - create_new
30              whether  a  new indicator with the specified name should be cre‐
31              ated when necessary
32
33       - map  new map for the indicator
34

DESCRIPTION

36       If a compatible version of the Xkb extension is not  available  in  the
37       server,  XkbSetNamedIndicator  returns  False.  Otherwise,  it  sends a
38       request to the X server to change the indicator specified by  name  and
39       returns True.
40
41       If  change_state  is  True,  and  the optional parameter, state, is not
42       NULL, XkbSetNamedIndicator tells the server to change the state of  the
43       named indicator to the value specified by state.
44
45       If an indicator with the name specified by name does not already exist,
46       the create_new parameter tells the server whether it  should  create  a
47       new  named indicator. If create_new is True, the server finds the first
48       indicator that doesn't have a name and gives it the name  specified  by
49       name.   If the optional parameter, map, is not NULL, XkbSetNamedIndica‐
50       tor tells the server to change the indicator's map to the values speci‐
51       fied in map.
52
53       In  addition,  it can also generate XkbIndicatorStateNotify, XkbIndica‐
54       torMapNotify, and XkbNamesNotify events.
55

RETURN VALUES

57       True           The XkbSetNamedIndicator function returns True if a com‐
58                      patible version of the Xkb extension is available in the
59                      server.
60
61       False          The XkbSetNamedIndicator function  returns  False  if  a
62                      compatible version of the Xkb extension is not available
63                      in the server.
64

DIAGNOSTICS

66       BadAtom        A name is neither a valid Atom or None
67
68       BadImplementation
69                      Invalid reply from server
70

SEE ALSO

72       XkbIndicatorMapNotify(3), XkbIndicatorStateNotify(3), XkbNamesNotify(3)
73
74
75
76
77X Version 11                     libX11 1.6.4          XkbSetNamedIndicator(3)
Impressum