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/XkbBell.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/XkbBell.man')
-rw-r--r-- | libX11/man/xkb/XkbBell.man | 344 |
1 files changed, 344 insertions, 0 deletions
diff --git a/libX11/man/xkb/XkbBell.man b/libX11/man/xkb/XkbBell.man new file mode 100644 index 000000000..2a8a0e1fc --- /dev/null +++ b/libX11/man/xkb/XkbBell.man @@ -0,0 +1,344 @@ +'\" t +.\" 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 XkbBell __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbBell \- Rings the bell on the default keyboard +.SH SYNOPSIS +.B Bool XkbBell +( +.I display, +.I window, +.I percent, +.I name +) +.br + Display *\fIdisplay\fP\^; +.br + Window \fIwindow\fP\^; +.br + int \fIpercent\fP\^; +.br + Atom \fIname\fP\^; +.if n .ti +5n +.if t .ti +.5i +.SH ARGUMENTS +.TP +.I \- display +connection to the X server +.TP +.I \- window +event window, or None +.TP +.I \- percent +relative volume, which can range from -100 to 100 inclusive +.TP +.I \- name +a bell name, or NULL +.SH DESCRIPTION +.LP +The core X protocol allows only applications to explicitly sound the system bell +with a +given duration, pitch, and volume. Xkb extends this capability by allowing +clients to +attach symbolic names to bells, disable audible bells, and receive an event +whenever the +keyboard bell is rung. For the purposes of this document, the +.I audible +bell is defined to be the system bell, or the default keyboard bell, as opposed +to any +other audible sound generated elsewhere in the system. +You can ask to receive XkbBellNotify events when any client rings any one of the +following: + +.IP \(bu 5 +The default bell +.IP \(bu 5 +Any bell on an input device that can be specified by a bell_class and bell_id +pair +.IP \(bu 5 +Any bell specified only by an arbitrary name. (This is, from the server's point +of view, +merely a name, and not connected with any physical sound-generating device. Some +client +application must generate the sound, or visual feedback, if any, that is +associated with +the name.) + +.LP +You can also ask to receive XkbBellNotify events when the server rings the +default bell +or if any client has requested events only (without the bell sounding) for any +of the +bell types previously listed. + +You can disable audible bells on a global basis. For example, a client that +replaces the +keyboard bell with some other audible cue might want to turn off the AudibleBell +control +to prevent the server from also generating a sound and avoid cacophony. If you +disable +audible bells and request to receive XkbBellNotify events, you can generate +feedback +different from the default bell. + +You can, however, override the AudibleBell control by calling one of the +functions that +force the ringing of a bell in spite of the setting of the AudibleBell control - +.I XkbForceDeviceBell +or +.I XkbForceBell. +In this case the server does not generate a bell event. + +Just as some keyboards can produce keyclicks to indicate when a key is pressed +or +repeating, Xkb can provide feedback for the controls by using special beep +codes. The +AccessXFeedback control is used to configure the specific types of operations +that +generate feedback. + +Bell Names + +You can associate a name to an act of ringing a bell by converting the name to +an Atom +and then using this name when you call the functions listed in this chapter. If +an event +is generated as a result, the name is then passed to all other clients +interested in +receiving XkbBellNotify events. Note that these are arbitrary names and that +there is no +binding to any sounds. Any sounds or other effects (such as visual bells on the +screen) +must be generated by a client application upon receipt of the bell event +containing the +name. There is no default name for the default keyboard bell. The server does +generate +some predefined bells for the AccessX controls. These named bells are shown in +Table 1 below; the name is included in any bell event sent to clients that have +requested to receive XkbBellNotify events. + +.TS +c s +l l +lW(4I) l. +Table 1 Predefined Bells +_ +Action Named Bell +_ +Indicator turned on AX_IndicatorOn +Indicator turned off AX_IndicatorOff +More than one indicator changed state AX_IndicatorChange +Control turned on AX_FeatureOn +Control turned off AX_FeatureOff +More than one control changed state AX_FeatureChange +T{ SlowKeys and BounceKeys about to be turned on or off +T} AX_SlowKeysWarning +SlowKeys key pressed AX_SlowKeyPress +SlowKeys key accepted AX_SlowKeyAccept +SlowKeys key rejected AX_SlowKeyReject +Accepted SlowKeys key released AX_SlowKeyRelease +BounceKeys key rejected AX_BounceKeyReject +StickyKeys key latched AX_StickyLatch +StickyKeys key locked AX_StickyLock +StickyKeys key unlocked AX_StickyUnlock +.TE + +Audible Bells + +Using Xkb you can generate bell events that do not necessarily ring the system +bell. This +is useful if you need to use an audio server instead of the system beep. For +example, +when an audio client starts, it could disable the audible bell (the system bell) +and then +listen for XkbBellNotify events. When it receives a XkbBellNotify event, the +audio client +could then send a request to an audio server to play a sound. + +You can control the audible bells feature by passing the XkbAudibleBellMask to +.I XkbChangeEnabledControls. +If you set XkbAudibleBellMask on, the server rings the system bell when a bell +event +occurs. This is the default. If you set XkbAudibleBellMask off and a bell event +occurs, +the server does not ring the system bell unless you call +.I XkbForceDeviceBell +or +.I XkbForceBell. + +Audible bells are also part of the per-client auto-reset controls. + +Bell Functions + +Use the functions described in this section to ring bells and to generate bell +events. + +The input extension has two types of feedbacks that can generate bells - bell +feedback +and keyboard feedback. Some of the functions in this section have +.I bell_class +and +.I bell_id +parameters; set them as follows: Set +.I bell_class +to BellFeedbackClass or KbdFeedbackClass. A device can have more than one +feedback of +each type; set +.I bell_id +to the particular bell feedback of +.I bell_class +type. + +Table 2 shows the conditions that cause a bell to sound or an XkbBellNotifyEvent +to be generated when a bell function is called. + +.TS +c s s s +l l l l +l l l l. +Table 2 Bell Sounding and Bell Event Generating +_ +Function called AudibleBell Server sounds a bell Server sends an +XkbBellNotifyEvent +_ +XkbDeviceBell On Yes Yes +XkbDeviceBell Off No Yes +XkbBell On Yes Yes +XkbBell Off No Yes +XkbDeviceBellEvent On or Off No Yes +XkbBellEvent On or Off No Yes +XkbDeviceForceBell On or Off Yes No +XkbForceBell On or Off Yes No +.TE + +If a compatible keyboard extension isn't present in the X server, +.I XkbBell +calls +.I XBell +with the specified +.I display +and +.I percent, +and returns False. Otherwise, +.I XkbBell +calls +.I XkbDeviceBell +with the specified +.I display, window, percent, +and +.I name, +a +.I device_spec +of XkbUseCoreKbd, a +.I bell_class +of XkbDfltXIClass, and a +.I bell_id +of XkbDfltXIId, and returns True. + +If you have disabled the audible bell, the server does not ring the system bell, +although it does generate a XkbBellNotify event. + +You can call +.I XkbBell +without first initializing the keyboard extension. +.SH "RETURN VALUES" +.TP 15 +FALSE +The XkbBell function returns FALSE if XlibDisplayNoXkb is set. +.SH STRUCTURES +.LP +Xkb generates XkbBellNotify events for all bells except for those resulting from +calls to +.I XkbForceDeviceBell +and +.I XkbForceBell. +To receive XkbBellNotify events under all possible conditions, pass +XkbBellNotifyMask in +both the +.I bits_to_change +and +.I values_for_bits +parameters to +.I XkbSelectEvents. + +The XkbBellNotify event has no event details. It is either selected or it is +not. +However, you can call +.I XkbSelectEventDetails +using XkbBellNotify as the +.I event_type +and specifying XkbAllBellNotifyMask in +.I bits_to_change +and +.I values_for_bits. +This has the same effect as a call to +.I XkbSelectEvents. + +The structure for the XkbBellNotify event type contains: +.nf + + typedef struct _XkbBellNotify { + int type; /\(** Xkb extension base event code */ + unsigned long serial; /\(** X server serial number for event */ + Bool send_event; /\(** True => synthetically generated */ + Display * display; /\(** server connection where event generated */ + Time time; /\(** server time when event generated */ + int xkb_type; /\(** XkbBellNotify */ + unsigned int device; /\(** Xkb device ID, will not be XkbUseCoreKbd +*/ + int percent; /\(** requested volume as % of max */ + int pitch; /\(** requested pitch in Hz */ + int duration; /\(** requested duration in microseconds */ + unsigned int bell_class; /\(** X input extension feedback class */ + unsigned int bell_id; /\(** X input extension feedback ID */ + Atom name; /\(** "name" of requested bell */ + Window window; /\(** window associated with event */ + Bool event_only; /\(** False -> the server did not produce a beep +*/ + } XkbBellNotifyEvent; + +.fi +If your application needs to generate visual bell feedback on the screen when it +receives +a bell event, use the window ID in the XkbBellNotifyEvent, if present. + +.SH "SEE ALSO" +.BR XBell (3X11), +.BR XkbBellNotify (__libmansuffix__), +.BR XkbChangeEnabledControls (__libmansuffix__), +.BR XkbDeviceBell (__libmansuffix__), +.BR XkbForceBell (__libmansuffix__), +.BR XkbForceDeviceBell (__libmansuffix__), +.BR XkbUseCoreKbd (__libmansuffix__) + + + + + |