diff options
author | marha <marha@users.sourceforge.net> | 2009-06-28 22:07:26 +0000 |
---|---|---|
committer | marha <marha@users.sourceforge.net> | 2009-06-28 22:07:26 +0000 |
commit | 3562e78743202e43aec8727005182a2558117eca (patch) | |
tree | 8f9113a77d12470c5c851a2a8e4cb02e89df7d43 /libX11/man/xkb/XkbGetNamedIndicator.man | |
download | vcxsrv-3562e78743202e43aec8727005182a2558117eca.tar.gz vcxsrv-3562e78743202e43aec8727005182a2558117eca.tar.bz2 vcxsrv-3562e78743202e43aec8727005182a2558117eca.zip |
Checked in the following released items:
xkeyboard-config-1.4.tar.gz
ttf-bitstream-vera-1.10.tar.gz
font-alias-1.0.1.tar.gz
font-sun-misc-1.0.0.tar.gz
font-sun-misc-1.0.0.tar.gz
font-sony-misc-1.0.0.tar.gz
font-schumacher-misc-1.0.0.tar.gz
font-mutt-misc-1.0.0.tar.gz
font-misc-misc-1.0.0.tar.gz
font-misc-meltho-1.0.0.tar.gz
font-micro-misc-1.0.0.tar.gz
font-jis-misc-1.0.0.tar.gz
font-isas-misc-1.0.0.tar.gz
font-dec-misc-1.0.0.tar.gz
font-daewoo-misc-1.0.0.tar.gz
font-cursor-misc-1.0.0.tar.gz
font-arabic-misc-1.0.0.tar.gz
font-winitzki-cyrillic-1.0.0.tar.gz
font-misc-cyrillic-1.0.0.tar.gz
font-cronyx-cyrillic-1.0.0.tar.gz
font-screen-cyrillic-1.0.1.tar.gz
font-xfree86-type1-1.0.1.tar.gz
font-adobe-utopia-type1-1.0.1.tar.gz
font-ibm-type1-1.0.0.tar.gz
font-bitstream-type1-1.0.0.tar.gz
font-bitstream-speedo-1.0.0.tar.gz
font-bh-ttf-1.0.0.tar.gz
font-bh-type1-1.0.0.tar.gz
font-bitstream-100dpi-1.0.0.tar.gz
font-bh-lucidatypewriter-100dpi-1.0.0.tar.gz
font-bh-100dpi-1.0.0.tar.gz
font-adobe-utopia-100dpi-1.0.1.tar.gz
font-adobe-100dpi-1.0.0.tar.gz
font-util-1.0.1.tar.gz
font-bitstream-75dpi-1.0.0.tar.gz
font-bh-lucidatypewriter-75dpi-1.0.0.tar.gz
font-adobe-utopia-75dpi-1.0.1.tar.gz
font-bh-75dpi-1.0.0.tar.gz
bdftopcf-1.0.1.tar.gz
font-adobe-75dpi-1.0.0.tar.gz
mkfontscale-1.0.6.tar.gz
openssl-0.9.8k.tar.gz
bigreqsproto-1.0.2.tar.gz
xtrans-1.2.2.tar.gz
resourceproto-1.0.2.tar.gz
inputproto-1.4.4.tar.gz
compositeproto-0.4.tar.gz
damageproto-1.1.0.tar.gz
zlib-1.2.3.tar.gz
xkbcomp-1.0.5.tar.gz
freetype-2.3.9.tar.gz
pthreads-w32-2-8-0-release.tar.gz
pixman-0.12.0.tar.gz
kbproto-1.0.3.tar.gz
evieext-1.0.2.tar.gz
fixesproto-4.0.tar.gz
recordproto-1.13.2.tar.gz
randrproto-1.2.2.tar.gz
scrnsaverproto-1.1.0.tar.gz
renderproto-0.9.3.tar.gz
xcmiscproto-1.1.2.tar.gz
fontsproto-2.0.2.tar.gz
xextproto-7.0.3.tar.gz
xproto-7.0.14.tar.gz
libXdmcp-1.0.2.tar.gz
libxkbfile-1.0.5.tar.gz
libfontenc-1.0.4.tar.gz
libXfont-1.3.4.tar.gz
libX11-1.1.5.tar.gz
libXau-1.0.4.tar.gz
libxcb-1.1.tar.gz
xorg-server-1.5.3.tar.gz
Diffstat (limited to 'libX11/man/xkb/XkbGetNamedIndicator.man')
-rw-r--r-- | libX11/man/xkb/XkbGetNamedIndicator.man | 138 |
1 files changed, 138 insertions, 0 deletions
diff --git a/libX11/man/xkb/XkbGetNamedIndicator.man b/libX11/man/xkb/XkbGetNamedIndicator.man new file mode 100644 index 000000000..8abad9dc2 --- /dev/null +++ b/libX11/man/xkb/XkbGetNamedIndicator.man @@ -0,0 +1,138 @@ +.\" 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. +.\" +.TH XkbGetNamedIndicator __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbGetNamedIndicator \- Look up the indicator map and other information for an +indicator by name +.SH SYNOPSIS +.B Bool XkbGetNamedIndicator +( +.I dpy, +.I dev_spec, +.I name, +.I ndx_rtrn, +.I state_rtrn, +.I map_rtrn, +.I real_rtrn +) +.br + Display *\fIdpy\fP\^; +.br + unsigned int \fIdev_spec\fP\^; +.br + Atom \fIname\fP\^; +.br + int *\fIndx_rtrn\fP\^; +.br + Bool *\fIstate_rtrn\fP\^; +.br + XkbIndicatorMapPtr \fImap_rtrn\fP\^; +.br + Bool *\fIreal_rtrn\fP\^; +.if n .ti +5n +.if t .ti +.5i +.SH ARGUMENTS +.TP +.I \- dpy +connection to the X server +.TP +.I \- dev_spec +keyboard device ID, or XkbUseCoreKbd +.TP +.I \- name +name of the indicator to be retrieved +.TP +.I \- ndx_rtrn +backfilled with the index of the retrieved indicator +.TP +.I \- state_rtrn +backfilled with the current state of the retrieved indicator +.TP +.I \- map_rtrn + backfilled with the mapping for the retrieved indicator +.TP +.I \- real_rtrn +backfilled with True if the named indicator is real (physical) +.SH DESCRIPTION +.LP +Xkb also allows applications to refer to indicators by name. Use +.I XkbGetNames +to get the indicator names. Using names eliminates the need for hard-coding +bitmask values for particular keyboards. For example, instead of using +vendor-specific constants such as WSKBLed_ScrollLock mask on Digital +workstations or XLED_SCROLL_LOCK on Sun workstations, you can instead use +.I XkbGetNamedIndicator +to look up information on the indicator named "Scroll Lock." + +If the device specified by +.I device_spec +has an indicator named +.I name, XkbGetNamedIndicator +returns True and populates the rest of the parameters with information about the +indicator. Otherwise, +.I XkbGetNamedIndicator +returns False. + +The +.I ndx_rtrn +field returns the zero-based index of the named indicator. This index is the bit +position to use in any function call that requires a mask of indicator bits, as +well as the indicator's index into the XkbIndicatorRec array of indicator maps. +.I state_rtrn +returns the current state of the named indicator (True = on, False = off). +.I map_rtrn +returns the indicator map for the named indicator. In addition, if the indicator +is mapped to a physical LED, the +.I real_rtrn +parameter is set to True. + +Each of the " +.I _rtrn +" arguments is optional; you can pass NULL for any unneeded " +.I _rtrn +" arguments. +.SH "RETURN VALUES" +.TP 15 +True +The +.I XkbGetNamedIndicator +function returns True if the device specified by +.I device_spec +has an indicator named +.I name. +.TP 15 +False +The +.I XkbGetNamedIndicator +function returns False if the device specified by +.I device_spec +does not have an indicator named +.I name. +.SH "SEE ALSO" +.BR XkbGetNames (__libmansuffix__) |