Copyright (c) 1999 - Sun Microsystems, Inc.
All rights reserved.
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, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, provided that the above
copyright notice(s) and this permission notice appear in all copies of
the Software and that both the above copyright notice(s) and this
permission notice appear in supporting documentation.
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
OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Except as contained in this notice, the name of a copyright holder
shall not be used in advertising or otherwise to promote the sale, use
or other dealings in this Software without prior written authorization
of the copyright holder.
Display *display\^;
unsigned long which\^;
XkbDescPtr xkb\^;
- display connection to X server
- which mask of controls requested
- xkb keyboard description for controls information
For each bit that is set in the which parameter, XkbSetControls sends the corresponding values from the xkb->ctrls field to the server. Valid values for which are any combination of the masks listed in Table 1 that have "ok" in the which column. Table 1 shows the actual values for the individual mask bits used to select controls for modification and to enable and disable the control. Note that the same mask bit is used to specify general modifications to the parameters used to configure the control (which), and to enable and disable the control (enabled_ctrls). The anomalies in the table (no "ok" in column) are for controls that have no configurable attributes; and for controls that are not boolean controls and therefore cannot be enabled or disabled.
|
xkb->ctrls is NULL, the server does not support a compatible version of Xkb, or the Xkb
extension has not been properly initialized,
XkbSetControls returns False. Otherwise, it sends the request to the X server and returns True.
Note that changes to attributes of controls in the XkbControlsRec structure are
apparent only when the associated control is enabled, although the corresponding
values are still updated in the X server. For example, the
repeat_delay and
repeat_interval fields are ignored unless the RepeatKeys control is enabled (that is, the X
server's equivalent of
xkb->ctrls has XkbRepeatKeyMask set in
enabled_ctrls). It is permissible to modify the attributes of a control in one call to
XkbSetControls and enable the control in a subsequent call. See
XkbChangeEnabledControls for more information on enabling and disabling controls.
Note that the
enabled_ctrls field is itself a control - the EnabledControls control. As such, to set a
specific configuration of enabled and disabled boolean controls, you must set
enabled_ctrls to the appropriate bits to enable only the controls you want and disable all
others, then specify the XkbControlsEnabledMask in a call to
XkbSetControls.
Because this is somewhat awkward if all you want to do is enable and disable
controls, and not modify any of their attributes, a convenience function is also
provided for this purpose,
XkbChangeEnabledControls. "RETURN VALUES" 15 True The XkbSetControls function returns True when it sends the request to the X server. 15 False The XkbSetControls function returns False when xkb->ctrls is NULL, the server does not support a compatible version of Xkb, or the Xkb extension has not been properly initialized. DIAGNOSTICS 15 BadAlloc Unable to allocate storage 15 BadMatch A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid "SEE ALSO" XkbChangeEnabledControls (__libmansuffix__), XkbFreeControls (__libmansuffix__)
|