diff options
Diffstat (limited to 'libX11/specs/XKB/ch11.xml')
| -rw-r--r-- | libX11/specs/XKB/ch11.xml | 586 |
1 files changed, 299 insertions, 287 deletions
diff --git a/libX11/specs/XKB/ch11.xml b/libX11/specs/XKB/ch11.xml index 52f089775..6463878b6 100644 --- a/libX11/specs/XKB/ch11.xml +++ b/libX11/specs/XKB/ch11.xml @@ -1,13 +1,20 @@ +<?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='X_Library_Controls'> <title>X Library Controls</title> <para> The Xkb extension is composed of two parts: a server extension, and a -client-side X library extension. Chapter 10 discusses functions used to modify +client-side X library extension. <xref linkend="Keyboard_Controls" /> discusses functions used to modify controls affecting the behavior of the server portion of the Xkb extension. This chapter discusses functions used to modify controls that affect only the behavior of the client portion of the extension; these controls are known as -Library Controls. +<firstterm>Library Controls</firstterm>. +<indexterm significance="preferred" zone="X_Library_Controls"> +<primary>library controls</primary></indexterm> +<indexterm significance="preferred" zone="X_Library_Controls"> +<primary>controls</primary><secondary>library</secondary></indexterm> </para> @@ -35,9 +42,11 @@ Controls affecting event delivery </itemizedlist> <para> -There are two types of string lookups performed by <emphasis> -XLookupString</emphasis> -. The first type involves translating a single keycode into a string; the +There are two types of string lookups performed by +<function>XLookupString</function>. +<indexterm significance="preferred" zone="X_Library_Controls"> +<primary><function>XLookupString</function></primary></indexterm> +The first type involves translating a single keycode into a string; the controls in the first category affect this type of lookup. The second type involves translating a series of keysyms into a string; the controls in the second category affect this type of lookup. @@ -57,33 +66,33 @@ enabled may be missing. <title>Controls Affecting Keycode-to-String Translation</title> <para> -The first type of string lookups, which are here called <emphasis> -simple string lookups</emphasis> -, involves translating a single keycode into a string. Because these simple +The first type of string lookups, which are here called +<firstterm>simple string lookups</firstterm>, +involves translating a single keycode into a string. Because these simple lookups involve only a single keycode, all of the information needed to do the translation is contained in the keyboard state in a single event. The controls affecting simple string lookups are: -</para> -<para><programlisting> - <emphasis>ForceLatin1Lookup</emphasis> - <emphasis>ConsumeLookupMods</emphasis> - <emphasis>LevelOneUsesShiftAndLock</emphasis> -</programlisting></para> + <simplelist type='vert' columns='1'> + <member><emphasis>ForceLatin1Lookup</emphasis></member> + <member><emphasis>ConsumeLookupMods</emphasis></member> + <member><emphasis>LevelOneUsesShiftAndLock</emphasis></member> + </simplelist> +</para> <sect2 id='ForceLatin1Lookup'> <title>ForceLatin1Lookup</title> <para> -If the <emphasis> -ForceLatin1Lookup</emphasis> - control is enabled, <emphasis> -XLookupString</emphasis> - only returns strings using the Latin1 character set. If <emphasis> -ForceLatin1Lookup</emphasis> - is not enabled, <emphasis> -XLookupString</emphasis> - can return characters that are not in the Latin1 set. By default, this control +If the +<emphasis>ForceLatin1Lookup</emphasis> +control is enabled, +<function>XLookupString</function> +only returns strings using the Latin1 character set. If +<emphasis>ForceLatin1Lookup</emphasis> +is not enabled, +<function>XLookupString</function> +can return characters that are not in the Latin1 set. By default, this control is disabled, allowing characters outside of the Latin1 set to be returned. </para> @@ -93,9 +102,9 @@ is disabled, allowing characters outside of the Latin1 set to be returned. <title>ConsumeLookupMods</title> <para> -Simple string lookups in <emphasis> -XLookupString</emphasis> - involve two different translation phases. The first phase translates raw +Simple string lookups in +<function>XLookupString</function> +involve two different translation phases. The first phase translates raw device keycodes to individual keysyms. The second phase attempts to map the resulting keysym into a string of one or more characters. In the first phase, some of the modifiers are normally used to determine the appropriate shift @@ -104,64 +113,62 @@ level for a key. <para> -The <emphasis> -ConsumeLookupMods</emphasis> - control determines whether or not <emphasis> -XLookupString</emphasis> - <emphasis> -consumes</emphasis> - the modifiers it uses during the first phase of processing (mapping a keycode +The +<emphasis>ConsumeLookupMods</emphasis> +control determines whether or not +<function>XLookupString</function> +<emphasis>consumes</emphasis> +the modifiers it uses during the first phase of processing (mapping a keycode to a keysym). When a modifier is consumed, it is effectively removed from the -working copy of the keyboard state information <emphasis> -XLookupString</emphasis> - is using and appears to be unset for the remainder of the processing. +working copy of the keyboard state information +<function>XLookupString</function> +is using and appears to be unset for the remainder of the processing. </para> <para> -If the <emphasis> -ConsumeLookupMods</emphasis> - control is enabled, <emphasis> -XLookupString</emphasis> - does not use the modifiers used to translate the keycode of the event to a +If the +<emphasis>ConsumeLookupMods</emphasis> +control is enabled, +<function>XLookupString</function> +does not use the modifiers used to translate the keycode of the event to a keysym when it is determining the string associated with a keysym. For example, assume the keymap for the ‘A’ key only contains the shift modifier and the -<emphasis> -ConsumeLookupMods</emphasis> - control is enabled. If a user presses the <emphasis> -Shift</emphasis> - key and the <emphasis> -A</emphasis> - key while the <emphasis> -Num_Lock</emphasis> - key is locked, <emphasis> -XLookupString</emphasis> - uses the <emphasis> -Shift</emphasis> - modifier when mapping the keycode for the ‘a’ key to the keysym for -‘A’; subsequently, it only uses the <emphasis> -NumLock</emphasis> - modifier when determining the string associated with the keysym ‘A’. +<emphasis>ConsumeLookupMods</emphasis> +control is enabled. If a user presses the +<keycap>Shift</keycap> +key and the +<keycap>A</keycap> +key while the +<keycap>Num_Lock</keycap> +key is locked, +<function>XLookupString</function> +uses the +<symbol>Shift</symbol> +modifier when mapping the keycode for the ‘a’ key to the keysym for +‘A’; subsequently, it only uses the +<emphasis>NumLock</emphasis> +modifier when determining the string associated with the keysym ‘A’. </para> <para> -If the <emphasis> -ConsumeLookupMods</emphasis> - control is not enabled, <emphasis> -XLookupString</emphasis> - uses all of the event modifiers to determine the string associated with a -keysym. This behavior mirrors the behavior of <emphasis> -XLookupString</emphasis> - in the core implementation. +If the +<emphasis>ConsumeLookupMods</emphasis> +control is not enabled, +<function>XLookupString</function> +uses all of the event modifiers to determine the string associated with a +keysym. This behavior mirrors the behavior of +<function>XLookupString</function> +in the core implementation. </para> <para> -The <emphasis> -ConsumeLookupMods</emphasis> - control is unset by default. For more information on modifier consumption, -refer to Chapter 12. +The +<emphasis>ConsumeLookupMods</emphasis> +control is unset by default. For more information on modifier consumption, +refer to <xref linkend="Interpreting_Key_Events" />. </para> @@ -170,18 +177,18 @@ refer to Chapter 12. <title>AlwaysConsumeShiftAndLock</title> <para> -The <emphasis> -AlwaysConsumeShiftAndLock</emphasis> - control, if enabled, forces <emphasis> -XLookupString</emphasis> - to consume the <emphasis> -Shift</emphasis> - and <emphasis> -Lock</emphasis> - modifiers when processing all keys, even if the definition for the key type -does not specify these modifiers. The <emphasis> -AlwaysConsumeShiftAndLock</emphasis> - control is unset by default. See section 15.2 for a discussion of key types. +The +<emphasis>AlwaysConsumeShiftAndLock</emphasis> +control, if enabled, forces +<function>XLookupString</function> +to consume the +<symbol>Shift</symbol> +and +<symbol>Lock</symbol> +modifiers when processing all keys, even if the definition for the key type +does not specify these modifiers. The +<emphasis>AlwaysConsumeShiftAndLock</emphasis> +control is unset by default. See <link linkend="Key_Types">section 15.2</link> for a discussion of key types. </para> @@ -191,23 +198,25 @@ AlwaysConsumeShiftAndLock</emphasis> <title>Controls Affecting Compose Processing</title> <para> -The second type of string lookup performed by <emphasis> -XLookupString</emphasis> - involves translating a series of keysyms into a string. Because these lookups -can involve more than one key event, they require <emphasis> -XLookupString</emphasis> - to retain some state information between successive calls. The process of -mapping a series of keysyms to a string is known as <emphasis> -compose processing</emphasis> -. The controls affecting compose processing are: +The second type of string lookup performed by +<function>XLookupString</function> +involves translating a series of keysyms into a string. Because these lookups +can involve more than one key event, they require +<function>XLookupString</function> +to retain some state information between successive calls. The process of +mapping a series of keysyms to a string is known as +<firstterm>compose processing</firstterm>. +<indexterm significance="preferred" zone="Controls_Affecting_Compose_Processing"> +<primary>compose processing</primary></indexterm> +The controls affecting compose processing are: + + <simplelist type='vert' columns='1'> + <member><emphasis>ConsumeKeysOnComposeFail</emphasis></member> + <member><emphasis>ComposeLED</emphasis></member> + <member><emphasis>BeepOnComposeFail</emphasis></member> + </simplelist> </para> -<para><programlisting> -<emphasis>ConsumeKeysOnComposeFail</emphasis> -<emphasis>ComposeLED</emphasis> -<emphasis>BeepOnComposeFail</emphasis> -</programlisting></para> - <para> Because different vendors have historically used different algorithms to implement compose processing, and these algorithms may be incompatible with the @@ -221,36 +230,36 @@ the compose processing controls is optional in an Xkb implementation. <para> Some compose processing algorithms signal the start of a compose sequence by a -key event meaning "start compose". +key event meaning <quote>start compose</quote>. <footnote><para> Another possibility is to have the compose processing simply be the result of a finite state acceptor; a compose sequence would never fail for a properly written finite state acceptor. </para></footnote> The subsequent key events should normally result in a valid composition yielding a valid translation to a string. If the subsequent key events do not have a valid translation, some decision must be made about what to do with the key events -that were processed while attempting the compose. The <emphasis> -ConsumeKeysOnComposeFail</emphasis> - control allows a client to specify what happens with the key events <emphasis> -XLookupString</emphasis> - has been considering when it reaches a dead end in a compose sequence. +that were processed while attempting the compose. The +<emphasis>ConsumeKeysOnComposeFail</emphasis> +control allows a client to specify what happens with the key events +<function>XLookupString</function> +has been considering when it reaches a dead end in a compose sequence. </para> <para> -If the <emphasis> -ConsumeKeysOnComposeFail</emphasis> - control is set, all keys associated with a failed compose sequence should be -consumed (discarded). If the <emphasis> -ConsumeKeysOnComposeFail</emphasis> - control is not set, the key events associated with a failed compose sequence +If the +<emphasis>ConsumeKeysOnComposeFail</emphasis> +control is set, all keys associated with a failed compose sequence should be +consumed (discarded). If the +<emphasis>ConsumeKeysOnComposeFail</emphasis> +control is not set, the key events associated with a failed compose sequence should be processed as a normal sequence of key events. </para> <para> -The <emphasis> -ConsumeKeysOnComposeFail</emphasis> - control is disabled by default. +The +<emphasis>ConsumeKeysOnComposeFail</emphasis> +control is disabled by default. </para> @@ -259,30 +268,28 @@ ConsumeKeysOnComposeFail</emphasis> <title>ComposeLED</title> <para> -The <emphasis> -ComposeLED</emphasis> - control allows a client to specify whether or not an indicator should be set +The +<emphasis>ComposeLED</emphasis> +control allows a client to specify whether or not an indicator should be set and cleared to provide feedback when compose processing is in progress. The control does not specify which indicator should be used; the mapping for this -is up to the individual implementation. If the <emphasis> -ComposeLED</emphasis> - control is enabled, it specifies that an indicator should be set when a +is up to the individual implementation. If the +<emphasis>ComposeLED</emphasis> +control is enabled, it specifies that an indicator should be set when a compose sequence is in progress and cleared when one is not in progress. The -<emphasis> -ComposeLED</emphasis> - control is disabled by default. +<emphasis>ComposeLED</emphasis> +control is disabled by default. </para> <para> While the Xkb extension does not specify the type of type of indicator to be -used when the <emphasis> -ComposeLED</emphasis> - control is implemented, a consistent convention between implementations is to +used when the +<emphasis>ComposeLED</emphasis> +control is implemented, a consistent convention between implementations is to everyone’s benefit. If a named indicator is used for this purpose, the -recommended name is "<emphasis> -Compose</emphasis> -". Note that some implementations may use an unnamed, custom hardware LED for +recommended name is “<literal>Compose</literal>”. +Note that some implementations may use an unnamed, custom hardware LED for this purpose. </para> @@ -292,34 +299,30 @@ this purpose. <title>BeepOnComposeFail</title> <para> -The <emphasis> -BeepOnComposeFail</emphasis> - control allows a client to specify whether or not a bell should be activated +The +<emphasis>BeepOnComposeFail</emphasis> +control allows a client to specify whether or not a bell should be activated to provide feedback when a compose sequence fails. The control does not specify the type of bell that should be used; the mapping for this is up to the -individual implementation. If the <emphasis> -BeepOnComposeFail</emphasis> - control is enabled, it specifies that a bell should be activated when a -compose sequence fails. The <emphasis> -BeepOnComposeFail</emphasis> - control is disabled by default. If implemented, the bell should be activated -using <emphasis> -XkbBell</emphasis> - or <emphasis> -XkbDeviceBell</emphasis> -. +individual implementation. If the +<emphasis>BeepOnComposeFail</emphasis> +control is enabled, it specifies that a bell should be activated when a +compose sequence fails. The +<emphasis>BeepOnComposeFail</emphasis> +control is disabled by default. If implemented, the bell should be activated +using +<function>XkbBell</function> +or +<function>XkbDeviceBell</function>. </para> <para> While the Xkb extension does not specify the type of bell to be used when the -<emphasis> -BeepOnComposeFail</emphasis> - control is implemented, a consistent convention between implementations is to +<emphasis>BeepOnComposeFail</emphasis> +control is implemented, a consistent convention between implementations is to everyone’s benefit. If a named bell is used for this purpose, the recommended -name is "<emphasis> -ComposeFail</emphasis> -". +name is “<literal>ComposeFail</literal>”. </para> @@ -331,31 +334,36 @@ ComposeFail</emphasis> <sect2 id='IgnoreNewKeyboards'> <title>IgnoreNewKeyboards</title> +<indexterm zone="IgnoreNewKeyboards"> +<primary>events</primary><secondary><symbol>NewKeyboardNotify</symbol></secondary></indexterm> +<indexterm zone="IgnoreNewKeyboards"> +<primary>events</primary><secondary><symbol>MappingNotify</symbol></secondary></indexterm> + <para> -When Xkb is initialized, it implicitly forces requests for <emphasis> -NewKeyboardNotify</emphasis> - events. These events may be used by the Xkb library extension internally; they -are normally translated into core protocol <emphasis> -MappingNotify</emphasis> - events before being passed to the client. While delivering the event to the +When Xkb is initialized, it implicitly forces requests for +<symbol>NewKeyboardNotify</symbol> +events. These events may be used by the Xkb library extension internally; they +are normally translated into core protocol +<symbol>MappingNotify</symbol> +events before being passed to the client. While delivering the event to the client is appropriate in most cases, it is not appropriate for some clients that maintain per-key data structures. This is because once the server has sent -a <emphasis> -NewKeyboardNotify</emphasis> - event, it is free to send the client events for all keys in the new range and +a +<symbol>NewKeyboardNotify</symbol> +event, it is free to send the client events for all keys in the new range and that range may be outside of the per-key data structures the client is maintaining. </para> <para> -The <emphasis> -IgnoreNewKeyboards</emphasis> - control, if enabled, prevents Xkb from mapping <emphasis> -NewKeyboardNotify</emphasis> - events to core <emphasis> -MappingNotify</emphasis> - events and passing them to the client. The control is initially disabled. +The +<emphasis>IgnoreNewKeyboards</emphasis> +control, if enabled, prevents Xkb from mapping +<symbol>NewKeyboardNotify</symbol> +events to core +<symbol>MappingNotify</symbol> +events and passing them to the client. The control is initially disabled. </para> @@ -367,10 +375,10 @@ MappingNotify</emphasis> <para> The Library Controls are manipulated using functions that deal with bitmasks to indicate which controls to manipulate. The controls are identified by the masks -defined in Table 11.1. <!-- xref --> +defined in <link linkend="table11.1">Table 11.1</link>. </para> -<table frame='topbot'> +<table id='table11.1' frame='topbot'> <title>Library Control Masks</title> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> @@ -384,35 +392,35 @@ defined in Table 11.1. <!-- xref --> </thead> <tbody> <row> - <entry>XkbLC_ForceLatin1Lookup</entry> + <entry><symbol>XkbLC_ForceLatin1Lookup</symbol></entry> <entry>(1 << 0)</entry> </row> <row> - <entry>XkbLC_ConsumeLookupMods</entry> + <entry><symbol>XkbLC_ConsumeLookupMods</symbol></entry> <entry>(1 << 1)</entry> </row> <row> - <entry>XkbLC_AlwaysConsumeShiftAndLock</entry> + <entry><symbol>XkbLC_AlwaysConsumeShiftAndLock</symbol></entry> <entry>(1 << 2)</entry> </row> <row> - <entry>XkbLC_IgnoreNewKeyboards</entry> + <entry><symbol>XkbLC_IgnoreNewKeyboards</symbol></entry> <entry>(1 << 3)</entry> </row> <row> - <entry>XkbLC_ConsumeKeysOnComposeFail</entry> + <entry><symbol>XkbLC_ConsumeKeysOnComposeFail</symbol></entry> <entry>(1 << 29)</entry> </row> <row> - <entry>XkbLC_ComposeLED</entry> + <entry><symbol>XkbLC_ComposeLED</symbol></entry> <entry>(1 << 30)</entry> </row> <row> - <entry>XkbLC_BeepOnComposeFail</entry> + <entry><symbol>XkbLC_BeepOnComposeFail</symbol></entry> <entry>(1 << 31)</entry> </row> <row> - <entry>XkbLC_AllControls</entry> + <entry><symbol>XkbLC_AllControls</symbol></entry> <entry>(0xc0000007)</entry> </row> </tbody> @@ -424,39 +432,38 @@ defined in Table 11.1. <!-- xref --> <para> To determine which Library Controls are actually -implemented, use <emphasis>XkbXlibControlsImplemented</emphasis>. +implemented, use <function>XkbXlibControlsImplemented</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'> -unsigned int <emphasis> -XkbXlibControlsImplemented</emphasis> -(<emphasis> -display</emphasis> -) - </entry> - </row> - <row> - <entry role='functionargdecl'> -Display *<emphasis> - display</emphasis> -; /* connection to X server */ - </entry> -</row> -</tbody> -</tgroup> -</informaltable> +<indexterm significance="preferred" zone="XkbXlibControlsImplemented"><primary><function>XkbXlibControlsImplemented</function></primary></indexterm> +<funcsynopsis id="XkbXlibControlsImplemented"> + <funcprototype> + <funcdef>unsigned int <function>XkbXlibControlsImplemented</function></funcdef> +<!-- ( +<parameter>display</parameter> +) --> + + <paramdef>Display *<parameter>display</parameter></paramdef> + </funcprototype> +</funcsynopsis> +<variablelist> + <varlistentry> + <term> + <parameter>display</parameter> + </term> + <listitem> + <para> + connection to X server + </para> + </listitem> + </varlistentry> +</variablelist> <para> -<emphasis> -XkbXlibControlsImplemented</emphasis> - returns a bitmask indicating the controls actually implemented in the Xkb -library and is composed of an inclusive OR of bits from Table 11.1. +<function>XkbXlibControlsImplemented</function> +returns a bitmask indicating the controls actually implemented in the Xkb +library and is composed of an inclusive OR of bits from +<link linkend="table11.1">Table 11.1</link>. </para> @@ -465,41 +472,39 @@ library and is composed of an inclusive OR of bits from Table 11.1. <title>Determining the State of the Library Controls</title> <para> -To determine the current state of the Library Controls, use <emphasis> -XkbGetXlibControls</emphasis> -. +To determine the current state of the Library Controls, use +<function>XkbGetXlibControls</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'> -unsigned int <emphasis> -XkbGetXlibControls</emphasis> -(<emphasis> -display</emphasis> -) - </entry> - </row> - <row> - <entry role='functionargdecl'> -Display *<emphasis> - display</emphasis> -; /* connection to X server */ - </entry> -</row> -</tbody> -</tgroup> -</informaltable> +<indexterm significance="preferred" zone="XkbGetXlibControls"><primary><function>XkbGetXlibControls</function></primary></indexterm> +<funcsynopsis id="XkbGetXlibControls"> + <funcprototype> + <funcdef>unsigned int <function>XkbGetXlibControls</function></funcdef> +<!-- ( +<parameter>display</parameter> +) --> + + <paramdef>Display *<parameter>display</parameter></paramdef> + </funcprototype> +</funcsynopsis> +<variablelist> + <varlistentry> + <term> + <parameter>display</parameter> + </term> + <listitem> + <para> + connection to X server + </para> + </listitem> + </varlistentry> +</variablelist> <para> -<emphasis> -XkbGetXlibControls</emphasis> - returns the current state of the Library Controls as a bit mask that is an -inclusive OR of the control masks from Table 11.1 for the controls that are +<function>XkbGetXlibControls</function> +returns the current state of the Library Controls as a bit mask that is an +inclusive OR of the control masks from +<link linkend="table11.1">Table 11.1</link> for the controls that are enabled. For the optional compose processing controls, the fact that a control is enabled does not imply that it is actually implemented. </para> @@ -510,65 +515,72 @@ is enabled does not imply that it is actually implemented. <para> To change the state of the Library Controls, use -<emphasis>XkbSetXlibControls</emphasis>. +<function>XkbSetXlibControls</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> -XkbSetXlibControls</emphasis> -(<emphasis> -display, bits_to_change, values_for_bits</emphasis> -) - </entry> - </row> - <row> - <entry role='functionargdecl'> -Display *<emphasis> - display</emphasis> -; /* connection to X server */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -unsigned long <emphasis> -bits_to_change</emphasis> -; /* selects controls to be modified */ - </entry> - </row> - <row> - <entry role='functionargdecl'> -unsigned long <emphasis> -values_for_bits</emphasis> -; /* turns selected controls on (1) or off (0) */ - </entry> -</row> -</tbody> -</tgroup> -</informaltable> +<indexterm significance="preferred" zone="XkbSetXlibControls"><primary><function>XkbSetXlibControls</function></primary></indexterm> +<funcsynopsis id="XkbSetXlibControls"> + <funcprototype> + <funcdef>Bool <function>XkbSetXlibControls</function></funcdef> +<!-- ( +<parameter>display, bits_to_change, values_for_bits</parameter> +) --> + + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>unsigned long <parameter>bits_to_change</parameter></paramdef> + <paramdef>unsigned long <parameter>values_for_bits</parameter></paramdef> + </funcprototype> +</funcsynopsis> +<variablelist> + <varlistentry> + <term> + <parameter>display</parameter> + </term> + <listitem> + <para> + connection to X server + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>bits_to_change</parameter> + </term> + <listitem> + <para> + selects controls to be modified + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>values_for_bits</parameter> + </term> + <listitem> + <para> + turns selected controls on (1) or off (0) + </para> + </listitem> + </varlistentry> +</variablelist> <para> -<emphasis> -XkbSetXlibControls</emphasis> - modifies the state of the controls selected by <emphasis> -bits_to_change</emphasis> -; only the controls selected by <emphasis> -bits_to_change</emphasis> - are modified. If the bit corresponding to a control is on in <emphasis> -bits_to_change</emphasis> - and also on in values_for_bits, the control is enabled. If the bit -corresponding to a control is on in <emphasis> -bits_to_change</emphasis> - but off in <emphasis> -values_for_bits</emphasis> -, the control is disabled. <emphasis> -bits_to_change</emphasis> - should be an inclusive OR of bits from Table 11.1. +<function>XkbSetXlibControls</function> +modifies the state of the controls selected by +<parameter>bits_to_change</parameter>; +only the controls selected by +<parameter>bits_to_change</parameter> +are modified. If the bit corresponding to a control is on in +<parameter>bits_to_change</parameter> +and also on in values_for_bits, the control is enabled. If the bit +corresponding to a control is on in +<parameter>bits_to_change</parameter> +but off in +<parameter>values_for_bits</parameter>, +the control is disabled. +<parameter>bits_to_change</parameter> +should be an inclusive OR of bits from +<link linkend="table11.1">Table 11.1</link>. </para> </sect2> |