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 ( dpy, device_spec, name, change_state, state, create_new, map )
Display * dpy ;
unsigned int device_spec ;
Atom name ;
Bool change_state ;
Bool state ;
Bool create_new ;
XkbIndicatorMapPtr 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, XkbSet-
NamedIndicator 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, XkbSetNamedIndi-
cator 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 Xkb-
NamesNotify 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.1.5 XkbSetNamedIndicator(3)
Generated by $Id: phpMan.php,v 4.49 2006/02/26 13:18:18 chedong Exp $ Author: Che Dong
On Apache
Under GNU General Public License
2012-05-25 16:26 @38.107.179.240 Crawled by CCBot/1.0 (+http://www.commoncrawl.org/bot.html)