diff options
Diffstat (limited to 'libX11/specs/XKB/ch09.xml')
| -rw-r--r-- | libX11/specs/XKB/ch09.xml | 1430 |
1 files changed, 754 insertions, 676 deletions
diff --git a/libX11/specs/XKB/ch09.xml b/libX11/specs/XKB/ch09.xml index 3f14eed68..0241880b9 100644 --- a/libX11/specs/XKB/ch09.xml +++ b/libX11/specs/XKB/ch09.xml @@ -1,22 +1,30 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> <chapter id='Bells'> <title>Bells</title> +<indexterm zone="Bells"><primary>bell</primary></indexterm> <para> 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 <emphasis> -audible</emphasis> - bell is defined to be the system bell, or the default keyboard bell, as +document, the +<firstterm>audible</firstterm> +<indexterm significance="preferred" zone="Bells"> +<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 opposed to any other audible sound generated elsewhere in the system. </para> <para> -You can ask to receive <emphasis> -XkbBellNotify</emphasis> - events (see section 9.4) when any client rings any one of the following: <!-- xref --> +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: </para> <itemizedlist> @@ -27,11 +35,11 @@ The default bell </listitem> <listitem> <para> -Any bell on an input device that can be specified by a <emphasis> -bell_class</emphasis> - and <emphasis> -bell_id</emphasis> - pair +Any bell on an input device that can be specified by a +<structfield>bell_class</structfield> +and +<structfield>bell_id</structfield> +pair </para> </listitem> <listitem> @@ -45,49 +53,49 @@ visual feedback, if any, that is associated with the name.) </itemizedlist> <para> -You can also ask to receive <emphasis> -XkbBellNotify</emphasis> - events when the server rings the default bell or if any client has requested +You can also ask to receive +<symbol>XkbBellNotify</symbol> +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> <para> -You can disable audible bells on a global basis (to set the <emphasis> -AudibleBell</emphasis> - control, see Chapter 10). 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 -cacophony. If you disable audible bells and request to receive <emphasis> -XkbBellNotify</emphasis> - events, you can generate feedback different from the default bell. +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 +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 +cacophony. If you disable audible bells and request to receive +<symbol>XkbBellNotify</symbol> +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 -spite of the setting of the <emphasis> -AudibleBell</emphasis> - control — <emphasis> -XkbForceDeviceBell</emphasis> - or <emphasis> -XkbForceBell</emphasis> - (see section 9.3.3). In this case the server does not generate a bell event. <!-- xref --> +You can, however, override the +<emphasis>AudibleBell</emphasis> +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 — +<function>XkbForceDeviceBell</function> +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. </para> <para> 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 -feedback. See section 10.6.3 for a discussion on <emphasis> <!-- xref --> -AccessXFeedback</emphasis> - control. +codes. The +<emphasis>AccessXFeedback</emphasis> +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. </para> <para> @@ -102,20 +110,22 @@ and the events the server generates for bells. 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 <emphasis> -XkbBellNotify</emphasis> - events. Note that these are arbitrary names and that there is no binding to +other clients interested in receiving +<symbol>XkbBellNotify</symbol> +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 (see -section 10.6.3). These named bells are shown in Table 9.1; the name is included -in any bell event sent to clients that have requested to receive <emphasis> -XkbBellNotify</emphasis> - events. +<link linkend="The_AccessXFeedback_Control">section 10.6.3</link>). +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. </para> -<table frame='topbot'> +<table id='table9.1' frame='topbot'> <title>Predefined Bells</title> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> @@ -200,36 +210,36 @@ XkbBellNotify</emphasis> 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 <emphasis> -XkbBellNotify</emphasis> - events (see section 9.4). When it receives a <emphasis> <!-- xref --> -XkbBellNotify</emphasis> - event, the audio client could then send a request to an audio server to play a +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 +<symbol>XkbBellNotify</symbol> +event, the audio client could then send a request to an audio server to play a sound. </para> <para> -You can control the audible bells feature by passing the <emphasis> -XkbAudibleBellMask</emphasis> - to <emphasis> -XkbChangeEnabledControls</emphasis> - (see section 10.1.1). If you set <emphasis> <!-- xref --> -XkbAudibleBellMask</emphasis> - on, the server rings the system bell when a bell event occurs. This is the -default. If you set <emphasis> -XkbAudibleBellMask</emphasis> - off and a bell event occurs, the server does not ring the system bell unless -you call <emphasis> -XkbForceDeviceBell</emphasis> - or <emphasis> -XkbForceBell</emphasis> - (see section 9.3.3). <!-- xref --> +You can control the audible bells feature by passing the +<symbol>XkbAudibleBellMask</symbol> +to +<function>XkbChangeEnabledControls</function> +(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 +default. If you set +<symbol>XkbAudibleBellMask</symbol> +off and a bell event occurs, the server does not ring the system bell unless +you call +<function>XkbForceDeviceBell</function> +or +<function>XkbForceBell</function> +(see <link linkend="Forcing_a_Server_Generated_Bell">section 9.3.3</link>). </para> <para> Audible bells are also part of the per-client auto-reset controls. For more -information on auto-reset controls, see section 10.1.2. <!-- xref --> +information on auto-reset controls, see <link linkend="The_AutoReset_Control">section 10.1.2</link>. </para> </sect1> @@ -244,30 +254,29 @@ events. <para> 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 -<emphasis> -bell_class</emphasis> - and <emphasis> -bell_id</emphasis> - parameters; set them as follows: Set <emphasis> -bell_class</emphasis> - to <emphasis> -BellFeedbackClass</emphasis> - or <emphasis> -KbdFeedbackClass</emphasis> -. A device can have more than one feedback of each type; set <emphasis> -bell_id</emphasis> - to the particular bell feedback of <emphasis> -bell_class</emphasis> - type. +<structfield>bell_class</structfield> +and +<structfield>bell_id</structfield> +parameters; set them as follows: Set +<structfield>bell_class</structfield> +to +<symbol>BellFeedbackClass</symbol> +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 +<structfield>bell_class</structfield> +type. </para> <para> -Table 9.2 shows the conditions that cause a bell to sound or an <emphasis> <!-- xref --> -XkbBellNotifyEvent</emphasis> - to be generated when a bell function is called. +<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. </para> -<table frame='topbot'> +<table id='table9.2' frame='topbot'> <title>Bell Sounding and Bell Event Generating</title> <?dbfo keep-together="always" ?> <tgroup cols='4' align='left' colsep='0' rowsep='0'> @@ -341,230 +350,257 @@ XkbBellNotifyEvent</emphasis> <para> To ring the bell on an X input extension device or the default keyboard, use -<emphasis> -XkbDeviceBell.</emphasis> +<function>XkbDeviceBell</function>. </para> -<informaltable frame='none'> -<?dbfo keep-together="always" ?> -<tgroup cols='1' align='left' colsep='0' rowsep='0'> -<colspec colname='c1' colwidth='1.0*'/> -<tbody> - <row> - <entry role='functiondecl'> -Bool <emphasis> -XkbDeviceBell</emphasis> -(<emphasis> -display, window, device_id, bell_class, bell_id, percent, name</emphasis> -) - </entry> - </row> - <row> - <entry role='functionargdecl'> -Display *<emphasis> - display</emphasis> -; /* connection to the X server */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -Window<emphasis> - window</emphasis> -; /* window for which the bell is generated, or None */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -unsigned int <emphasis> -device_spec</emphasis> -; /* device ID, or <emphasis> -XkbUseCoreKbd</emphasis> - */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -unsigned int <emphasis> -bell_class</emphasis> -; /* X input extension bell class of the bell to be rung */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -unsigned int <emphasis> -bell_id</emphasis> -; /* X input extension bell ID of the bell to be rung */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -int <emphasis> -percent</emphasis> -; /* bell volume, from -100 to 100 inclusive */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -Atom <emphasis> -name</emphasis> -; /* a name for the bell, or <emphasis> -NULL</emphasis> - */ - </entry> -</row> -</tbody> -</tgroup> -</informaltable> +<indexterm significance="preferred" zone="XkbDeviceBell"><primary><function>XkbDeviceBell</function></primary></indexterm> +<funcsynopsis id="XkbDeviceBell"> + <funcprototype> + <funcdef>Bool <function>XkbDeviceBell</function></funcdef> +<!-- ( +<parameter>display, window, device_id, bell_class, bell_id, percent, name</parameter> +) --> + + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> + <paramdef>unsigned int <parameter>bell_class</parameter></paramdef> + <paramdef>unsigned int <parameter>bell_id</parameter></paramdef> + <paramdef>int <parameter>percent</parameter></paramdef> + <paramdef>Atom <parameter>name</parameter></paramdef> + </funcprototype> +</funcsynopsis> +<variablelist> + <varlistentry> + <term> + <parameter>display</parameter> + </term> + <listitem> + <para> + connection to the X server + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>window</parameter> + </term> + <listitem> + <para> + window for which the bell is generated, or None + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>device_spec</parameter> + </term> + <listitem> + <para> + device ID, or <symbol>XkbUseCoreKbd</symbol> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>bell_class</parameter> + </term> + <listitem> + <para> + X input extension bell class of the bell to be rung + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>bell_id</parameter> + </term> + <listitem> + <para> + X input extension bell ID of the bell to be rung + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>percent</parameter> + </term> + <listitem> + <para> + bell volume, from −100 to 100 inclusive + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>name</parameter> + </term> + <listitem> + <para> + a name for the bell, or <symbol>NULL</symbol> + </para> + </listitem> + </varlistentry> +</variablelist> <para> -Set <emphasis> -percent</emphasis> - to be the volume relative to the base volume for the keyboard as described for -<emphasis> -XBell</emphasis>. +Set +<parameter>percent</parameter> +to be the volume relative to the base volume for the keyboard as described for +<function>XBell</function>. </para> <para> -Note that <emphasis> -bell_class</emphasis> - and <emphasis> -bell_id</emphasis> - indicate the bell to physically ring. <emphasis> -name</emphasis> - is simply an arbitrary moniker for the client application’s use. +Note that +<parameter>bell_class</parameter> +and +<parameter>bell_id</parameter> +indicate the bell to physically ring. +<parameter>name</parameter> +is simply an arbitrary moniker for the client application’s use. </para> <para> To determine the current feedback settings of an extension input device, use -<emphasis> -XGetFeedbackControl</emphasis> -. See the X input extension documentation for more information on <emphasis> -XGetFeedbackControl</emphasis> - and related data structures. +<function>XGetFeedbackControl</function>. +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. </para> <para> -If a compatible keyboard extension is not present in the X server, <emphasis> -XkbDeviceBell</emphasis> - immediately returns <emphasis> -False</emphasis> -. Otherwise, <emphasis> -XkbDeviceBell </emphasis> +If a compatible keyboard extension is not present in the X server, +<function>XkbDeviceBell</function> +immediately returns +<symbol>False</symbol>. +Otherwise, +<function>XkbDeviceBell</function> rings the bell as specified for the display and keyboard device and returns -<emphasis> -True</emphasis> -. If you have disabled the audible bell, the server does not ring the system -bell, although it does generate a <emphasis> -XkbBellNotify</emphasis> - event. +<symbol>True</symbol>. +If you have disabled the audible bell, the server does not ring the system +bell, although it does generate a +<symbol>XkbBellNotify</symbol> +event. </para> <para> -You can call <emphasis> -XkbDeviceBell</emphasis> - without first initializing the keyboard extension. +You can call +<function>XkbDeviceBell</function> +without first initializing the keyboard extension. </para> <para> As a convenience function, Xkb provides a function to ring the bell on the -default keyboard: <emphasis> -XkbBell.</emphasis> +default keyboard: +<function>XkbBell</function>. </para> -<informaltable frame='none'> -<?dbfo keep-together="always" ?> -<tgroup cols='1' align='left' colsep='0' rowsep='0'> -<colspec colname='c1' colwidth='1.0*'/> -<tbody> - <row> - <entry role='functiondecl'> -Bool <emphasis> -XkbBell</emphasis> -(<emphasis> -display, window, percent, name</emphasis> -) - </entry> - </row> - <row> - <entry role='functionargdecl'> -Display * <emphasis> -display</emphasis> -; /* connection to the X server */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -Window<emphasis> - window</emphasis> -; /* event window, or None*/ - </entry> - </row> - <row> - <entry role='functionargdecl'> -int<emphasis> - percent</emphasis> -; /* relative volume, which can range from -100 to 100 inclusive */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -Atom<emphasis> - name</emphasis> -; /* a bell name, or <emphasis> -NULL</emphasis> - */ - </entry> -</row> -</tbody> -</tgroup> -</informaltable> +<indexterm significance="preferred" zone="XkbBell"><primary><function>XkbBell</function></primary></indexterm> +<funcsynopsis id="XkbBell"> + <funcprototype> + <funcdef>Bool <function>XkbBell</function></funcdef> +<!-- ( +<parameter>display, window, percent, name</parameter> +) --> + + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + <paramdef>int <parameter>percent</parameter></paramdef> + <paramdef>Atom <parameter>name</parameter></paramdef> + </funcprototype> +</funcsynopsis> +<variablelist> + <varlistentry> + <term> + <parameter>display</parameter> + </term> + <listitem> + <para> + connection to the X server + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>window</parameter> + </term> + <listitem> + <para> + event window, or None + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>percent</parameter> + </term> + <listitem> + <para> + relative volume, which can range from −100 to 100 inclusive + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>name</parameter> + </term> + <listitem> + <para> + a bell name, or <symbol>NULL</symbol> + </para> + </listitem> + </varlistentry> +</variablelist> <para> -If a compatible keyboard extension isn’t present in the X server, <emphasis> -XkbBell</emphasis> - calls <emphasis> -XBell </emphasis> -with the specified <emphasis> -display</emphasis> - and <emphasis> -percent</emphasis> -, and returns <emphasis> -False</emphasis> -. Otherwise, <emphasis> -XkbBell </emphasis> -calls <emphasis> -XkbDeviceBell</emphasis> - with the specified <emphasis> -display, window, percent, </emphasis> -and <emphasis> -name</emphasis> -, a <emphasis> -device_spec</emphasis> - of <emphasis> -XkbUseCoreKbd</emphasis> -, a <emphasis> -bell_class </emphasis> -of <emphasis> -XkbDfltXIClass</emphasis> -, and a <emphasis> -bell_id </emphasis> -of <emphasis> -XkbDfltXIId,</emphasis> - and returns <emphasis> -True</emphasis>. +If a compatible keyboard extension isn’t present in the X server, +<function>XkbBell</function> +calls +<function>XBell</function> +with the specified +<parameter>display</parameter> +and +<parameter>percent</parameter>, +and returns +<symbol>False</symbol>. +Otherwise, +<function>XkbBell</function> +calls +<function>XkbDeviceBell</function> +with the specified +<parameter>display</parameter>, +<parameter>window</parameter>, +<parameter>percent</parameter>, +and +<parameter>name</parameter>, +a +<structfield>device_spec</structfield> +of +<symbol>XkbUseCoreKbd</symbol>, +a +<structfield>bell_class</structfield> +of +<symbol>XkbDfltXIClass</symbol>, +and a +<structfield>bell_id</structfield> +of +<symbol>XkbDfltXIId</symbol>, +and returns +<symbol>True</symbol>. </para> <para> If you have disabled the audible bell, the server does not ring the system -bell, although it does generate a <emphasis> -XkbBellNotify</emphasis> - event. +bell, although it does generate a +<symbol>XkbBellNotify</symbol> +event. </para> <para> -You can call <emphasis> -XkbBell</emphasis> - without first initializing the keyboard extension. +You can call +<function>XkbBell</function> +without first initializing the keyboard extension. </para> </sect2> @@ -579,7 +615,7 @@ application starts. <para> For example, if an audio client listens for these types of bells, it can -produce a "whoosh" sound when it receives a named bell event to indicate a +produce a <quote>whoosh</quote> sound when it receives a named bell event to indicate a client just started. In this manner, applications can generate start-up feedback and not worry about producing annoying beeps if an audio server is not running. @@ -588,207 +624,237 @@ running. <para> To cause a bell event for an X input extension device or for the keyboard, -without ringing the corresponding bell, use <emphasis> -XkbDeviceBellEvent.</emphasis> +without ringing the corresponding bell, use +<function>XkbDeviceBellEvent</function>. </para> -<informaltable frame='none'> -<?dbfo keep-together="always" ?> -<tgroup cols='1' align='left' colsep='0' rowsep='0'> -<colspec colname='c1' colwidth='1.0*'/> -<tbody> - <row> - <entry role='functiondecl'> -Bool <emphasis> -XkbDeviceBellEvent</emphasis> -(<emphasis> -display, window, device_spec, bell_class, bell_id, percent, name</emphasis> -) - </entry> - </row> - <row> - <entry role='functionargdecl'> -Display * <emphasis> -display</emphasis> -; /* connection to the X server */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -Window <emphasis> -window</emphasis> -; /* event window, or None*/ - </entry> - </row> - <row> - <entry role='functionargdecl'> -unsigned int <emphasis> -device_spec</emphasis> -; /* device ID, or <emphasis> -XkbUseCoreKbd</emphasis> - */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -unsigned int <emphasis> -bell_class;</emphasis> - /* input extension bell class for the event */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -unsigned int <emphasis> -bell_id</emphasis> -; /* input extension bell ID for the event */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -int <emphasis> -percent</emphasis> -; /* volume for the bell, which can range from -100 to 100 inclusive */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -Atom <emphasis> -name</emphasis> -; /* a bell name, or <emphasis> -NULL</emphasis> - */ - </entry> -</row> -</tbody> -</tgroup> -</informaltable> +<indexterm significance="preferred" zone="XkbDeviceBellEvent"><primary><function>XkbDeviceBellEvent</function></primary></indexterm> +<funcsynopsis id="XkbDeviceBellEvent"> + <funcprototype> + <funcdef>Bool <function>XkbDeviceBellEvent</function></funcdef> +<!-- ( +<parameter>display, window, device_spec, bell_class, bell_id, percent, name</parameter> +) --> + + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> + <paramdef>unsigned int <parameter>bell_class</parameter></paramdef> + <paramdef>unsigned int <parameter>bell_id</parameter></paramdef> + <paramdef>int <parameter>percent</parameter></paramdef> + <paramdef>Atom <parameter>name</parameter></paramdef> + </funcprototype> +</funcsynopsis> +<variablelist> + <varlistentry> + <term> + <parameter>display</parameter> + </term> + <listitem> + <para> + connection to the X server + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>window</parameter> + </term> + <listitem> + <para> + event window, or None + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>device_spec</parameter> + </term> + <listitem> + <para> + device ID, or <symbol>XkbUseCoreKbd</symbol> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>bell_class</parameter> + </term> + <listitem> + <para> + input extension bell class for the event + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>bell_id</parameter> + </term> + <listitem> + <para> + input extension bell ID for the event + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>percent</parameter> + </term> + <listitem> + <para> + volume for the bell, which can range from −100 to 100 inclusive + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>name</parameter> + </term> + <listitem> + <para> + a bell name, or <symbol>NULL</symbol> + </para> + </listitem> + </varlistentry> +</variablelist> <para> -If a compatible keyboard extension isn’t present in the X server, <emphasis> -XkbDeviceBellEvent</emphasis> - immediately returns <emphasis> -False</emphasis> -. Otherwise, <emphasis> -XkbDeviceBellEvent</emphasis> - causes an <emphasis> -XkbBellNotify</emphasis> - event to be sent to all interested clients and returns <emphasis> -True</emphasis> -. Set <emphasis> -percent</emphasis> - to be the volume relative to the base volume for the keyboard as described for -<emphasis>XBell</emphasis>. +If a compatible keyboard extension isn’t present in the X server, +<function>XkbDeviceBellEvent</function> +immediately returns +<symbol>False</symbol>. +Otherwise, +<function>XkbDeviceBellEvent</function> +causes an +<symbol>XkbBellNotify</symbol> +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 +<function>XBell</function>. </para> <para> -In addition, <emphasis> -XkbDeviceBellEvent</emphasis> - may generate <emphasis> -Atom</emphasis> - protocol errors as well as <emphasis> -XkbBellNotify</emphasis> - events. You can call <emphasis> -XkbBell</emphasis> - without first initializing the keyboard extension. +In addition, +<function>XkbDeviceBellEvent</function> +may generate +<type>Atom</type> +protocol errors as well as +<symbol>XkbBellNotify</symbol> +events. You can call +<function>XkbBell</function> +without first initializing the keyboard extension. </para> <para> As a convenience function, Xkb provides a function to cause a bell event for -the keyboard without ringing the bell: <emphasis> -XkbBellEvent.</emphasis> +the keyboard without ringing the bell: +<function>XkbBellEvent</function>. </para> -<informaltable frame='none'> -<?dbfo keep-together="always" ?> -<tgroup cols='1' align='left' colsep='0' rowsep='0'> -<colspec colname='c1' colwidth='1.0*'/> -<tbody> - <row> - <entry role='functiondecl'> -Bool <emphasis> -XkbBellEvent</emphasis> -(<emphasis> -display, window, percent, name</emphasis> -) - </entry> - </row> - <row> - <entry role='functionargdecl'> -Display * <emphasis> -display</emphasis> -; /* connection to the X server */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -Window <emphasis> -window</emphasis> -; /* the event window, or None */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -int <emphasis> -percent</emphasis> -; /* relative volume, which can range from -100 to 100 inclusive */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -Atom <emphasis> -name</emphasis> -; /* a bell name, or <emphasis> -NULL</emphasis> - */ - </entry> -</row> -</tbody> -</tgroup> -</informaltable> +<indexterm significance="preferred" zone="XkbBellEvent"><primary><function>XkbBellEvent</function></primary></indexterm> +<funcsynopsis id="XkbBellEvent"> + <funcprototype> + <funcdef>Bool <function>XkbBellEvent</function></funcdef> +<!-- ( +<parameter>display, window, percent, name</parameter> +) --> + + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + <paramdef>int <parameter>percent</parameter></paramdef> + <paramdef>Atom <parameter>name</parameter></paramdef> + </funcprototype> +</funcsynopsis> +<variablelist> + <varlistentry> + <term> + <parameter>display</parameter> + </term> + <listitem> + <para> + connection to the X server + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>window</parameter> + </term> + <listitem> + <para> + the event window, or None + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>percent</parameter> + </term> + <listitem> + <para> + relative volume, which can range from −100 to 100 inclusive + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>name</parameter> + </term> + <listitem> + <para> + a bell name, or <symbol>NULL</symbol> + </para> + </listitem> + </varlistentry> +</variablelist> <para> -If a compatible keyboard extension isn’t present in the X server, <emphasis> -XkbBellEvent</emphasis> - immediately returns <emphasis> -False</emphasis> -. Otherwise, <emphasis> -XkbBellEvent </emphasis> -calls<emphasis> - XkbDeviceBellEvent</emphasis> - with the specified <emphasis> -display, window, percent, </emphasis> -and <emphasis> -name</emphasis> -, a <emphasis> -device_spec</emphasis> - of <emphasis> -XkbUseCoreKbd</emphasis> -, a <emphasis> -bell_class </emphasis> -of <emphasis> -XkbDfltXIClass</emphasis> -, and a <emphasis> -bell_id </emphasis> -of <emphasis> -XkbDfltXIId,</emphasis> - and returns what <emphasis> -XkbDeviceBellEvent</emphasis> - returns. +If a compatible keyboard extension isn’t present in the X server, +<function>XkbBellEvent</function> +immediately returns +<symbol>False</symbol>. +Otherwise, +<function>XkbBellEvent</function> +calls +<function>XkbDeviceBellEvent</function> +with the specified +<parameter>display</parameter>, +<parameter>window</parameter>, +<parameter>percent</parameter>, +and +<parameter>name</parameter>, +a +<structfield>device_spec</structfield> +of +<symbol>XkbUseCoreKbd</symbol>, +a +<structfield>bell_class</structfield> +of +<symbol>XkbDfltXIClass</symbol>, +and a +<structfield>bell_id</structfield> +of +<symbol>XkbDfltXIId</symbol>, +and returns what +<function>XkbDeviceBellEvent</function> +returns. </para> <para> -<emphasis>XkbBellEvent</emphasis> -generates a <emphasis>XkbBellNotify</emphasis> +<function>XkbBellEvent</function> +generates a <symbol>XkbBellNotify</symbol> event. </para> <para> -You can call <emphasis> -XkbBellEvent</emphasis> +You can call +<function>XkbBellEvent</function> without first initializing the keyboard extension. </para> @@ -798,192 +864,205 @@ without first initializing the keyboard extension. <para> To ring the bell on any keyboard, overriding user preference settings for -audible bells, use <emphasis>XkbForceDeviceBell</emphasis>. +audible bells, use <function>XkbForceDeviceBell</function>. </para> -<informaltable frame='none'> -<?dbfo keep-together="always" ?> -<tgroup cols='1' align='left' colsep='0' rowsep='0'> -<colspec colname='c1' colwidth='1.0*'/> -<tbody> - <row> - <entry role='functiondecl'> -Bool <emphasis> -XkbForceDeviceBell</emphasis> -(<emphasis> -display, window, device_spec, bell_class, bell_id, percent</emphasis> -) - </entry> - </row> - <row> - <entry role='functionargdecl'> -Display * <emphasis> -display</emphasis> -; /* connection to the X server */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -Window <emphasis> -window</emphasis> -; /* event window, or None */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -unsigned int <emphasis> -device_spec</emphasis> -; /* device ID, or <emphasis> -XkbUseCoreKbd</emphasis> - */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -unsigned int <emphasis> -bell_class</emphasis> -; /* input extension class of the bell to be rung */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -unsigned int <emphasis> -bell_id</emphasis> -; /* input extension ID of the bell to be rung */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -int <emphasis> -percent</emphasis> -; /* relative volume, which can range from -100 to 100 inclusive */ - </entry> -</row> -</tbody> -</tgroup> -</informaltable> +<indexterm significance="preferred" zone="XkbForceDeviceBell"><primary><function>XkbForceDeviceBell</function></primary></indexterm> +<funcsynopsis id="XkbForceDeviceBell"> + <funcprototype> + <funcdef>Bool <function>XkbForceDeviceBell</function></funcdef> +<!-- ( +<parameter>display, window, device_spec, bell_class, bell_id, percent</parameter> +) --> + + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> + <paramdef>unsigned int <parameter>bell_class</parameter></paramdef> + <paramdef>unsigned int <parameter>bell_id</parameter></paramdef> + <paramdef>int <parameter>percent</parameter></paramdef> + </funcprototype> +</funcsynopsis> +<variablelist> + <varlistentry> + <term> + <parameter>display</parameter> + </term> + <listitem> + <para> + connection to the X server + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>window</parameter> + </term> + <listitem> + <para> + event window, or None + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>device_spec</parameter> + </term> + <listitem> + <para> + device ID, or <symbol>XkbUseCoreKbd</symbol> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>bell_class</parameter> + </term> + <listitem> + <para> + input extension class of the bell to be rung + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>bell_id</parameter> + </term> + <listitem> + <para> + input extension ID of the bell to be rung + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>percent</parameter> + </term> + <listitem> + <para> + relative volume, which can range from −100 to 100 inclusive + </para> + </listitem> + </varlistentry> +</variablelist> <para> -If a compatible keyboard extension isn’t present in the X server, <emphasis> -XkbForceDeviceBell</emphasis> - immediately returns <emphasis> -False</emphasis> -. Otherwise, <emphasis> -XkbForceDeviceBell </emphasis> +If a compatible keyboard extension isn’t present in the X server, +<function>XkbForceDeviceBell</function> +immediately returns +<symbol>False</symbol>. +Otherwise, +<function>XkbForceDeviceBell</function> rings the bell as specified for the display and keyboard device and returns -<emphasis> -True</emphasis> -. Set <emphasis> -percent</emphasis> - to be the volume relative to the base volume for the keyboard as described for -<emphasis> -XBell</emphasis> -. There is no <emphasis> -name</emphasis> - parameter because <emphasis> -XkbForceDeviceBell </emphasis> -does not cause an <emphasis> -XkbBellNotify</emphasis> - event. +<symbol>True</symbol>. +Set +<parameter>percent</parameter> +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 +<function>XkbForceDeviceBell</function> +does not cause an +<symbol>XkbBellNotify</symbol> +event. </para> <para> -You can call <emphasis> -XkbBell</emphasis> - without first initializing the keyboard extension. +You can call +<function>XkbBell</function> +without first initializing the keyboard extension. </para> <para> To ring the bell on the default keyboard, overriding user preference settings -for audible bells, use <emphasis> -XkbForceBell</emphasis>. +for audible bells, use +<function>XkbForceBell</function>. </para> -<informaltable frame='none'> -<?dbfo keep-together="always" ?> -<tgroup cols='1' align='left' colsep='0' rowsep='0'> -<colspec colname='c1' colwidth='1.0*'/> -<tbody> - <row> - <entry role='functiondecl'> -Bool <emphasis> -XkbForceBell</emphasis> -(<emphasis> -display, percent)</emphasis> - </entry> - </row> - <row> - <entry role='functionargdecl'> -Display * <emphasis> -display</emphasis> -; /* connection to the X server */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -int <emphasis> -percent</emphasis> -; /* volume for the bell, which can range from -100 to 100 inclusive */ - </entry> -</row> -</tbody> -</tgroup> -</informaltable> +<indexterm significance="preferred" zone="XkbForceBell"><primary><function>XkbForceBell</function></primary></indexterm> +<funcsynopsis id="XkbForceBell"> + <funcprototype> + <funcdef>Bool <function>XkbForceBell</function></funcdef> +<!-- ( +<parameter>display, percent)</parameter> --> + + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>int <parameter>percent</parameter></paramdef> + </funcprototype> +</funcsynopsis> +<variablelist> + <varlistentry> + <term> + <parameter>display</parameter> + </term> + <listitem> + <para> + connection to the X server + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>percent</parameter> + </term> + <listitem> + <para> + volume for the bell, which can range from −100 to 100 inclusive + </para> + </listitem> + </varlistentry> +</variablelist> <para> -If a compatible keyboard extension isn’t present in the X server, <emphasis> -XkbForceBell</emphasis> - calls <emphasis> -XBell </emphasis> -with the specified <emphasis> -display</emphasis> - and <emphasis> -percent</emphasis> - and returns <emphasis> -False</emphasis> -. Otherwise, <emphasis> -XkbForceBell </emphasis> -calls <emphasis> -XkbForceDeviceBell</emphasis> - with the specified <emphasis> -display </emphasis> -and<emphasis> - percent</emphasis> -, <emphasis> -device_spec</emphasis> - =<emphasis> -XkbUseCoreKbd</emphasis> -, <emphasis> -bell_class </emphasis> -= <emphasis> -XkbDfltXIClass</emphasis> -, <emphasis> -bell_id </emphasis> -= <emphasis> -XkbDfltXIId,</emphasis> - <emphasis> -window</emphasis> - = None, and <emphasis> -name</emphasis> - = <emphasis> -NULL</emphasis> -, and returns what<emphasis> - XkbForceDeviceBell</emphasis> - returns. +If a compatible keyboard extension isn’t present in the X server, +<function>XkbForceBell</function> +calls +<function>XBell</function> +with the specified +<parameter>display</parameter> +and +<parameter>percent</parameter> +and returns +<symbol>False</symbol>. +Otherwise, +<function>XkbForceBell</function> +calls +<function>XkbForceDeviceBell</function> +with the specified +<parameter>display</parameter> +and +<parameter>percent</parameter>, +<structfield>device_spec</structfield> += +<symbol>XkbUseCoreKbd</symbol>, +<structfield>bell_class</structfield> += +<symbol>XkbDfltXIClass</symbol>, +<structfield>bell_id</structfield> += +<symbol>XkbDfltXIId</symbol>, +<structfield>window</structfield> += None, and +<structfield>name</structfield> += +<symbol>NULL</symbol>, +and returns what +<function>XkbForceDeviceBell</function> +returns. </para> <para> -<emphasis> -XkbForceBell </emphasis> -does not cause an <emphasis> -XkbBellNotify</emphasis> - event. +<function>XkbForceBell</function> +does not cause an +<symbol>XkbBellNotify</symbol> +event. </para> <para> -You can call <emphasis> -XkbBell</emphasis> - without first initializing the keyboard extension. +You can call +<function>XkbBell</function> +without first initializing the keyboard extension. </para> </sect2> @@ -992,76 +1071,75 @@ XkbBell</emphasis> <title>Detecting Bells</title> <para> -Xkb generates <emphasis> -XkbBellNotify</emphasis> - events for all bells except for those resulting from calls to <emphasis> -XkbForceDeviceBell</emphasis> - and <emphasis> -XkbForceBell</emphasis> -. To receive <emphasis> -XkbBellNotify</emphasis> - events under all possible conditions, pass <emphasis> -XkbBellNotifyMask</emphasis> - in both the <emphasis> -bits_to_change </emphasis> -and<emphasis> - values_for_bits</emphasis> - parameters to <emphasis> -XkbSelectEvents</emphasis> - (see section 4.3). <!-- xref --> +Xkb generates +<symbol>XkbBellNotify</symbol> +events for all bells except for those resulting from calls to +<function>XkbForceDeviceBell</function> +and +<function>XkbForceBell</function>. +To receive +<symbol>XkbBellNotify</symbol> +events under all possible conditions, pass +<symbol>XkbBellNotifyMask</symbol> +in both the +<parameter>bits_to_change</parameter> +and +<parameter>values_for_bits</parameter> +parameters to +<function>XkbSelectEvents</function> +(see <link linkend="Selecting_Xkb_Events">section 4.3</link>). </para> <para> -The <emphasis> -XkbBellNotify</emphasis> - event has no event details. It is either selected or it is not. However, you -can call <emphasis> -XkbSelectEventDetails</emphasis> - using <emphasis> -XkbBellNotify</emphasis> - as the <emphasis> -event_type</emphasis> - and specifying <emphasis> -XkbAllBellNotifyMask</emphasis> - in <emphasis> -bits_to_change</emphasis> - and <emphasis> -values_for_bits.</emphasis> - This has the same effect as a call to <emphasis> -XkbSelectEvents</emphasis>. +The +<symbol>XkbBellNotify</symbol> +event has no event details. It is either selected or it is not. However, you +can call +<function>XkbSelectEventDetails</function> +using +<symbol>XkbBellNotify</symbol> +as the +<structfield>event_type</structfield> +and specifying +<symbol>XkbAllBellEventsMask</symbol> +in +<parameter>bits_to_change</parameter> +and +<parameter>values_for_bits</parameter>. +This has the same effect as a call to +<function>XkbSelectEvents</function>. </para> <para> -The structure for the <emphasis> -XkbBellNotify</emphasis> - event type contains: -</para> +The structure for the +<symbol>XkbBellNotify</symbol> +event type contains: -<para><programlisting> +<programlisting> typedef struct _XkbBellNotify { - int type; /* Xkb extension base event code */ - unsigned long serial; /* X server serial number for event */ - Bool send_event; /* <emphasis> True</emphasis> => synthetically generated */ - Display * display; /* server connection where event generated */ - Time time; /* server time when event generated */ - int xkb_type; /* <emphasis> XkbBellNotify</emphasis> */ - unsigned int device; /* Xkb device ID, will not be <emphasis> XkbUseCoreKbd</emphasis> */ - 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; /* <emphasis> False</emphasis> -> the server did not produce a beep */ -} <emphasis>XkbBellNotifyEvent</emphasis>; + int type; /* Xkb extension base event code */ + unsigned long serial; /* X server serial number for event */ + Bool send_event; /* <symbol>True</symbol> ⇒ synthetically generated */ + Display * display; /* server connection where event generated */ + Time time; /* server time when event generated */ + int xkb_type; /* <symbol>XkbBellNotify</symbol> */ + unsigned int device; /* Xkb device ID, will not be <symbol>XkbUseCoreKbd</symbol> */ + 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; /* <symbol>False</symbol> → the server did not produce a beep */ +} <structname>XkbBellNotifyEvent</structname>; </programlisting></para> <para> If your application needs to generate visual bell feedback on the screen when -it receives a bell event, use the window ID in the <emphasis> -XkbBellNotifyEvent</emphasis> -, if present. +it receives a bell event, use the window ID in the +<structname>XkbBellNotifyEvent</structname>, +if present. </para> </sect1> |