diff options
Diffstat (limited to 'specs/XKB/ch09.xml')
| -rw-r--r-- | specs/XKB/ch09.xml | 176 |
1 files changed, 88 insertions, 88 deletions
diff --git a/specs/XKB/ch09.xml b/specs/XKB/ch09.xml index dad70f24..0241880b 100644 --- a/specs/XKB/ch09.xml +++ b/specs/XKB/ch09.xml @@ -16,7 +16,7 @@ document, the <primary>audible bell</primary></indexterm> <indexterm significance="preferred" zone="Bells"> <primary>bell</primary><secondary>audible</secondary></indexterm> - bell is defined to be the system bell, or the default keyboard bell, as +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. </para> @@ -24,7 +24,7 @@ opposed to any other audible sound generated elsewhere in the system. <para> You can ask to receive <symbol>XkbBellNotify</symbol> - events (see <link linkend="Detecting_Bells">section 9.4</link>) when any client rings any one of the following: +events (see <link linkend="Detecting_Bells">section 9.4</link>) when any client rings any one of the following: </para> <itemizedlist> @@ -37,9 +37,9 @@ The default bell <para> Any bell on an input device that can be specified by a <structfield>bell_class</structfield> - and +and <structfield>bell_id</structfield> - pair +pair </para> </listitem> <listitem> @@ -55,7 +55,7 @@ visual feedback, if any, that is associated with the name.) <para> You can also ask to receive <symbol>XkbBellNotify</symbol> - events when the server rings the default bell or if any client has requested +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. </para> @@ -63,27 +63,27 @@ listed. <para> You can disable audible bells on a global basis (to set the <emphasis>AudibleBell</emphasis> - control, see <xref linkend="Keyboard_Controls" />). For example, a client that replaces the keyboard +control, see <xref linkend="Keyboard_Controls" />). For example, a client that replaces the keyboard bell with some other audible cue might want to turn off the <emphasis>AudibleBell</emphasis> - control to prevent the server from also generating a sound and avoid +control to prevent the server from also generating a sound and avoid cacophony. If you disable audible bells and request to receive <symbol>XkbBellNotify</symbol> - events, you can generate feedback different from the default bell. +events, you can generate feedback different from the default bell. </para> <para> You can, however, override the <emphasis>AudibleBell</emphasis> - control by calling one of the functions that force the ringing of a bell in +control by calling one of the functions that force the ringing of a bell in spite of the setting of the <emphasis>AudibleBell</emphasis> - control — +control — <function>XkbForceDeviceBell</function> - or +or <function>XkbForceBell</function> - (see <link linkend="Forcing_a_Server_Generated_Bell">section 9.3.3</link>). In this case the server does not generate a bell event. +(see <link linkend="Forcing_a_Server_Generated_Bell">section 9.3.3</link>). In this case the server does not generate a bell event. </para> @@ -92,10 +92,10 @@ 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 <emphasis>AccessXFeedback</emphasis> - control is used to configure the specific types of operations that generate +control is used to configure the specific types of operations that generate feedback. See <link linkend="The_AccessXFeedback_Control">section 10.6.3</link> for a discussion on <emphasis>AccessXFeedback</emphasis> - control. +control. </para> <para> @@ -112,7 +112,7 @@ 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 <symbol>XkbBellNotify</symbol> - events. Note that these are arbitrary names and that there is no binding to +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. @@ -122,7 +122,7 @@ These named bells are shown in <link linkend="table9.1">Table 9.1</link>; the name is included in any bell event sent to clients that have requested to receive <symbol>XkbBellNotify</symbol> - events. +events. </para> <table id='table9.1' frame='topbot'> @@ -212,9 +212,9 @@ 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 <symbol>XkbBellNotify</symbol> - events (see <link linkend="Detecting_Bells">section 9.4</link>). When it receives a +events (see <link linkend="Detecting_Bells">section 9.4</link>). When it receives a <symbol>XkbBellNotify</symbol> - event, the audio client could then send a request to an audio server to play a +event, the audio client could then send a request to an audio server to play a sound. </para> @@ -222,19 +222,19 @@ sound. <para> You can control the audible bells feature by passing the <symbol>XkbAudibleBellMask</symbol> - to +to <function>XkbChangeEnabledControls</function> - (see <link linkend="The_EnabledControls_Control">section 10.1.1</link>). If you set +(see <link linkend="The_EnabledControls_Control">section 10.1.1</link>). If you set <symbol>XkbAudibleBellMask</symbol> - on, the server rings the system bell when a bell event occurs. This is the +on, the server rings the system bell when a bell event occurs. This is the default. If you set <symbol>XkbAudibleBellMask</symbol> - off and a bell event occurs, the server does not ring the system bell unless +off and a bell event occurs, the server does not ring the system bell unless you call <function>XkbForceDeviceBell</function> - or +or <function>XkbForceBell</function> - (see <link linkend="Forcing_a_Server_Generated_Bell">section 9.3.3</link>). +(see <link linkend="Forcing_a_Server_Generated_Bell">section 9.3.3</link>). </para> <para> @@ -255,25 +255,25 @@ 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 <structfield>bell_class</structfield> - and +and <structfield>bell_id</structfield> - parameters; set them as follows: Set +parameters; set them as follows: Set <structfield>bell_class</structfield> - to +to <symbol>BellFeedbackClass</symbol> - or +or <symbol>KbdFeedbackClass</symbol>. A device can have more than one feedback of each type; set <structfield>bell_id</structfield> - to the particular bell feedback of +to the particular bell feedback of <structfield>bell_class</structfield> - type. +type. </para> <para> <link linkend="table9.2">Table 9.2</link> shows the conditions that cause a bell to sound or an <structname>XkbBellNotifyEvent</structname> - to be generated when a bell function is called. +to be generated when a bell function is called. </para> <table id='table9.2' frame='topbot'> @@ -446,18 +446,18 @@ To ring the bell on an X input extension device or the default keyboard, use <para> Set <parameter>percent</parameter> - to be the volume relative to the base volume for the keyboard as described for +to be the volume relative to the base volume for the keyboard as described for <function>XBell</function>. </para> <para> Note that <parameter>bell_class</parameter> - and +and <parameter>bell_id</parameter> - indicate the bell to physically ring. +indicate the bell to physically ring. <parameter>name</parameter> - is simply an arbitrary moniker for the client application’s use. +is simply an arbitrary moniker for the client application’s use. </para> <para> @@ -466,13 +466,13 @@ To determine the current feedback settings of an extension input device, use See <olink targetdoc='inputlib' targetptr='Controlling_Device_Feedback'>the X input extension documentation</olink> for more information on <function>XGetFeedbackControl</function> - and related data structures. +and related data structures. </para> <para> If a compatible keyboard extension is not present in the X server, <function>XkbDeviceBell</function> - immediately returns +immediately returns <symbol>False</symbol>. Otherwise, <function>XkbDeviceBell</function> @@ -481,13 +481,13 @@ rings the bell as specified for the display and keyboard device and returns If you have disabled the audible bell, the server does not ring the system bell, although it does generate a <symbol>XkbBellNotify</symbol> - event. +event. </para> <para> You can call <function>XkbDeviceBell</function> - without first initializing the keyboard extension. +without first initializing the keyboard extension. </para> <para> @@ -556,11 +556,11 @@ default keyboard: <para> If a compatible keyboard extension isn’t present in the X server, <function>XkbBell</function> - calls +calls <function>XBell</function> with the specified <parameter>display</parameter> - and +and <parameter>percent</parameter>, and returns <symbol>False</symbol>. @@ -568,7 +568,7 @@ Otherwise, <function>XkbBell</function> calls <function>XkbDeviceBell</function> - with the specified +with the specified <parameter>display</parameter>, <parameter>window</parameter>, <parameter>percent</parameter>, @@ -576,7 +576,7 @@ and <parameter>name</parameter>, a <structfield>device_spec</structfield> - of +of <symbol>XkbUseCoreKbd</symbol>, a <structfield>bell_class</structfield> @@ -586,7 +586,7 @@ and a <structfield>bell_id</structfield> of <symbol>XkbDfltXIId</symbol>, - and returns +and returns <symbol>True</symbol>. </para> @@ -594,13 +594,13 @@ of If you have disabled the audible bell, the server does not ring the system bell, although it does generate a <symbol>XkbBellNotify</symbol> - event. +event. </para> <para> You can call <function>XkbBell</function> - without first initializing the keyboard extension. +without first initializing the keyboard extension. </para> </sect2> @@ -721,17 +721,17 @@ without ringing the corresponding bell, use <para> If a compatible keyboard extension isn’t present in the X server, <function>XkbDeviceBellEvent</function> - immediately returns +immediately returns <symbol>False</symbol>. Otherwise, <function>XkbDeviceBellEvent</function> - causes an +causes an <symbol>XkbBellNotify</symbol> - event to be sent to all interested clients and returns +event to be sent to all interested clients and returns <symbol>True</symbol>. Set <parameter>percent</parameter> - to be the volume relative to the base volume for the keyboard as described for +to be the volume relative to the base volume for the keyboard as described for <function>XBell</function>. </para> @@ -739,13 +739,13 @@ Set <para> In addition, <function>XkbDeviceBellEvent</function> - may generate +may generate <type>Atom</type> - protocol errors as well as +protocol errors as well as <symbol>XkbBellNotify</symbol> - events. You can call +events. You can call <function>XkbBell</function> - without first initializing the keyboard extension. +without first initializing the keyboard extension. </para> @@ -816,13 +816,13 @@ the keyboard without ringing the bell: <para> If a compatible keyboard extension isn’t present in the X server, <function>XkbBellEvent</function> - immediately returns +immediately returns <symbol>False</symbol>. Otherwise, <function>XkbBellEvent</function> calls <function>XkbDeviceBellEvent</function> - with the specified +with the specified <parameter>display</parameter>, <parameter>window</parameter>, <parameter>percent</parameter>, @@ -830,7 +830,7 @@ and <parameter>name</parameter>, a <structfield>device_spec</structfield> - of +of <symbol>XkbUseCoreKbd</symbol>, a <structfield>bell_class</structfield> @@ -840,9 +840,9 @@ and a <structfield>bell_id</structfield> of <symbol>XkbDfltXIId</symbol>, - and returns what +and returns what <function>XkbDeviceBellEvent</function> - returns. +returns. </para> <para> @@ -949,7 +949,7 @@ audible bells, use <function>XkbForceDeviceBell</function>. <para> If a compatible keyboard extension isn’t present in the X server, <function>XkbForceDeviceBell</function> - immediately returns +immediately returns <symbol>False</symbol>. Otherwise, <function>XkbForceDeviceBell</function> @@ -957,21 +957,21 @@ rings the bell as specified for the display and keyboard device and returns <symbol>True</symbol>. Set <parameter>percent</parameter> - to be the volume relative to the base volume for the keyboard as described for +to be the volume relative to the base volume for the keyboard as described for <function>XBell</function>. There is no <structfield>name</structfield> - parameter because +parameter because <function>XkbForceDeviceBell</function> does not cause an <symbol>XkbBellNotify</symbol> - event. +event. </para> <para> You can call <function>XkbBell</function> - without first initializing the keyboard extension. +without first initializing the keyboard extension. </para> <para> @@ -1017,24 +1017,24 @@ for audible bells, use <para> If a compatible keyboard extension isn’t present in the X server, <function>XkbForceBell</function> - calls +calls <function>XBell</function> with the specified <parameter>display</parameter> - and +and <parameter>percent</parameter> - and returns +and returns <symbol>False</symbol>. Otherwise, <function>XkbForceBell</function> calls <function>XkbForceDeviceBell</function> - with the specified +with the specified <parameter>display</parameter> and <parameter>percent</parameter>, <structfield>device_spec</structfield> - = += <symbol>XkbUseCoreKbd</symbol>, <structfield>bell_class</structfield> = @@ -1043,26 +1043,26 @@ and = <symbol>XkbDfltXIId</symbol>, <structfield>window</structfield> - = None, and += None, and <structfield>name</structfield> - = += <symbol>NULL</symbol>, and returns what <function>XkbForceDeviceBell</function> - returns. +returns. </para> <para> <function>XkbForceBell</function> does not cause an <symbol>XkbBellNotify</symbol> - event. +event. </para> <para> You can call <function>XkbBell</function> - without first initializing the keyboard extension. +without first initializing the keyboard extension. </para> </sect2> @@ -1073,47 +1073,47 @@ You can call <para> Xkb generates <symbol>XkbBellNotify</symbol> - events for all bells except for those resulting from calls to +events for all bells except for those resulting from calls to <function>XkbForceDeviceBell</function> - and +and <function>XkbForceBell</function>. To receive <symbol>XkbBellNotify</symbol> - events under all possible conditions, pass +events under all possible conditions, pass <symbol>XkbBellNotifyMask</symbol> - in both the +in both the <parameter>bits_to_change</parameter> and <parameter>values_for_bits</parameter> - parameters to +parameters to <function>XkbSelectEvents</function> - (see <link linkend="Selecting_Xkb_Events">section 4.3</link>). +(see <link linkend="Selecting_Xkb_Events">section 4.3</link>). </para> <para> The <symbol>XkbBellNotify</symbol> - event has no event details. It is either selected or it is not. However, you +event has no event details. It is either selected or it is not. However, you can call <function>XkbSelectEventDetails</function> - using +using <symbol>XkbBellNotify</symbol> - as the +as the <structfield>event_type</structfield> - and specifying +and specifying <symbol>XkbAllBellEventsMask</symbol> - in +in <parameter>bits_to_change</parameter> - and +and <parameter>values_for_bits</parameter>. - This has the same effect as a call to +This has the same effect as a call to <function>XkbSelectEvents</function>. </para> <para> The structure for the <symbol>XkbBellNotify</symbol> - event type contains: +event type contains: <programlisting> typedef struct _XkbBellNotify { |