xref: /xsrc/external/mit/libX11/dist/specs/XKB/ch05.xml

<?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='Keyboard_State'>
<title>Keyboard State</title>

<para>
Keyboard state encompasses all of the transitory information necessary to map a physical key press or release to an appropriate event. The Xkb keyboard state consists of primitive components and additional derived components that are maintained for efficiency reasons. <link linkend="figure5.1">Figure 5.1</link> shows the components of Xkb keyboard state and their relationships.
</para>

<figure id='figure5.1'>
  <title>Xkb State</title>
  <mediaobject>
  <!-- <title>Keyboard State Description</title> -->
   <imageobject> <imagedata format="SVG" fileref="XKBlib-2.svg"/>
   </imageobject>
  </mediaobject>
</figure>


<sect1 id='Keyboard_State_Description'>
<title>Keyboard State Description</title>
<para>
The Xkb keyboard state is comprised of the state of all keyboard modifiers, the keyboard group, and the state of the pointer buttons. These are grouped into the following components:
</para>

<itemizedlist>
<listitem>
  <para>
The locked group and locked modifiers
  </para>
</listitem>
<listitem>
  <para>
The latched group and latched modifiers
  </para>
</listitem>
<listitem>
  <para>
The base group and base modifiers
  </para>
</listitem>
<listitem>
  <para>
The effective group and effective modifiers
  </para>
</listitem>
<listitem>
  <para>
The state of the core pointer buttons
  </para>
</listitem>
</itemizedlist>

<para id='modifiers'>
The
<firstterm>modifiers</firstterm>
<indexterm significance="preferred" zone="modifiers">
<primary>modifiers</primary></indexterm>
are
<symbol>Shift</symbol>,
<symbol>Lock</symbol>,
<symbol>Control</symbol>,
and
<symbol>Mod1</symbol>
&ndash;
<symbol>Mod5</symbol>,
as defined by the core protocol. A modifier can be thought of as a toggle that is either set or unset. All modifiers are initially unset. When a modifier is locked, it is set and remains set for all future key events, until it is explicitly unset. A latched modifier is set, but automatically unsets after the next key event that does not change the keyboard state. Locked and latched modifier state can be changed by keyboard activity or via Xkb extension library functions.
</para>


<para id='keysym_groups'>
The Xkb extension provides support for
<firstterm>keysym groups</firstterm>,
<indexterm significance="preferred" zone="keysym_groups">
<primary>keysym groups</primary></indexterm>
<indexterm significance="preferred" zone="keysym_groups">
<primary>group</primary><secondary>keysym</secondary></indexterm>
<indexterm significance="preferred" zone="keysym_groups">
<primary>group</primary><secondary>ISO9995</secondary></indexterm>
as defined by ISO9995:
</para>


<variablelist>
  <varlistentry>
    <term>Group</term>
    <listitem>
      <para>
A logical state of a keyboard providing access to a collection of characters.
A group usually contains a set of characters that logically belong together
and that may be arranged on several shift levels within that group.
      </para>
    </listitem>
  </varlistentry>
</variablelist>



<para>
The Xkb extension supports up to four keysym groups. Groups are named beginning with one and indexed beginning with zero. All group states are indicated using the group index. At any point in time, there is zero or one locked group, zero or one latched group, and one base group. When a group is locked, it supersedes any previous locked group and remains the locked group for all future key events, until a new group is locked. A latched group applies only to the next key event that does not change the keyboard state. The locked and latched group can be changed by keyboard activity or via Xkb extension library functions.
</para>


<para>
Changing to a different group changes the keyboard state to produce characters from a different group. Groups are typically used to switch between keysyms of different languages and locales.
</para>


<para>
The
<firstterm>pointer buttons</firstterm>
are
<symbol>Button1</symbol>
&ndash;
<symbol>Button5</symbol>,
as defined by the core protocol.
</para>


<para id='base_group'>
The
<firstterm>base group</firstterm>
<indexterm significance="preferred" zone="base_group">
<primary>base group</primary></indexterm>
<indexterm significance="preferred" zone="base_group">
<primary>group</primary><secondary>base</secondary></indexterm>
and
<firstterm>base modifiers</firstterm>
<indexterm significance="preferred" zone="base_group">
<primary>base modifiers</primary></indexterm>
<indexterm significance="preferred" zone="base_group">
<primary>modifiers</primary><secondary>base</secondary></indexterm>
represent keys that are physically or logically down. These
and the pointer buttons can be changed by keyboard activity and
not by Xkb requests. It is possible for a key to be logically
down, but not physically down, and neither latched nor locked.
<footnote><para>
Keys may be logically down when they are physically up because
of their electrical properties or because of the keyboard extension
in the X server having filtered the key release, for esoteric reasons.
</para></footnote>

</para>


<para id='effective_modifiers'>
The
<firstterm>effective modifiers</firstterm>
<indexterm significance="preferred" zone="effective_modifiers">
<primary>effective modifiers</primary></indexterm>
<indexterm significance="preferred" zone="effective_modifiers">
<primary>modifiers</primary><secondary>effective</secondary></indexterm>
are the bitwise union of the locked, latched, and the base modifiers.
</para>


<para id='effective_group'>
The
<firstterm>effective group</firstterm>
<indexterm significance="preferred" zone="effective_group">
<primary>effective group</primary></indexterm>
<indexterm significance="preferred" zone="effective_group">
<primary>group</primary><secondary>effective</secondary></indexterm>
is the arithmetic sum of the group indices of the latched group, locked group, and base group, which is then normalized by some function. The result is a meaningful group index.
</para>

<simplelist type='vert' columns='1'>
<member>
n = number of keyboard groups, 1&lt;= n &lt;= 4
</member>

<member>
0 &lt;= any of locked, latched, or base group &lt; n
</member>

<member>
effective group = f(locked group + latched group + base group)
</member>
</simplelist>

<para>
The function f ensures that the effective group is within range. The precise function is specified for the keyboard and can be retrieved through the keyboard description. It may wrap around, clamp down, or default. Few applications will actually examine the effective group, and far fewer still will examine the locked, latched, and base groups.
</para>


<para>
There are two circumstances under which groups are normalized:
</para>

<orderedlist>
  <listitem><para>
The global locked or effective group changes. In this case, the changed group is normalized into range according to the settings of the
<structfield>groups_wrap</structfield>
field of the
<structname>XkbControlsRec</structname>
structure for the keyboard (see <link linkend="The_GroupsWrap_Control">section 10.7.1</link>).
  </para></listitem>
  <listitem><para>

The Xkb library is interpreting an event with an effective group that is legal for the keyboard as a whole, but not for the key in question. In this case, the group to use for this event only is determined using the
<structfield>group_info</structfield>
field of the key symbol mapping
(<structname>XkbSymMapRec</structname>)
for the event key.
  </para></listitem>
</orderedlist>

<para>
Each nonmodifier key on a keyboard has zero or more symbols, or keysyms, associated with it. These are the logical symbols that the key can generate when it is pressed. The set of all possible keysyms for a keyboard is divided into groups. Each key is associated with zero or more groups; each group contains one or more symbols. When a key is pressed, the determination of which symbol for the key is selected is based on the effective group and the shift level, which is determined by which modifiers are set.
</para>


<para id='Xkb-aware'>
A client that does not explicitly call Xkb functions, but that otherwise makes use of an X library containing the Xkb extension, will have keyboard state represented in bits 0 &ndash; 14 of the state field of events that report modifier and button state. Such a client is said to be
<firstterm>Xkb-capable</firstterm>.
<indexterm significance="preferred" zone="Xkb-aware">
<primary>Xkb-capable client</primary></indexterm>

A client that does explicitly call Xkb functions is an
<firstterm>Xkb-aware</firstterm>
<indexterm significance="preferred" zone="Xkb-aware">
<primary>Xkb-aware client</primary></indexterm>
client. The Xkb keyboard state includes information derived from the effective state and from two server parameters that can be set through the keyboard extension. The following components of keyboard state pertain to Xkb-capable and Xkb-aware clients:
</para>

<itemizedlist>
<listitem>
  <para>
lookup state: lookup group and lookup modifiers
  </para>
</listitem>
<listitem>
  <para>
grab state: grab group and grab modifiers
  </para>
</listitem>
</itemizedlist>

<para id='lookup_state'>
The
<firstterm>lookup modifiers</firstterm>
<indexterm significance="preferred" zone="lookup_state">
<primary>lookup modifiers</primary></indexterm>
<indexterm significance="preferred" zone="lookup_state">
<primary>modifiers</primary><secondary>lookup</secondary></indexterm>
and
<firstterm>lookup group</firstterm>
<indexterm significance="preferred" zone="lookup_state">
<primary>lookup group</primary></indexterm>
<indexterm significance="preferred" zone="lookup_state">
<primary>group</primary><secondary>lookup</secondary></indexterm>
are represented in the state field of core X events. The modifier state and keycode of a key event are used to determine the symbols associated with the event. For
<symbol>KeyPress</symbol>
and
<symbol>KeyRelease</symbol>
events, the lookup modifiers are computed as:

<literallayout>   ((base | latched | locked) &amp; ~<emphasis>server_internal_modifiers</emphasis>)</literallayout>
</para>

<para>
Otherwise the lookup modifiers are computed as:

<literallayout>   (((base | latched | (locked &amp; ~<emphasis>ignore_locks</emphasis>)) &amp; ~<emphasis>server_internal_modifiers</emphasis>)</literallayout>
</para>

<para>
The lookup group is the same as the effective group.
</para>


<para>
When an Xkb-capable or Xkb-aware client wishes to map a keycode to a keysym, it should use the
<firstterm>lookup state</firstterm>
<indexterm significance="preferred" zone="lookup_state">
<primary>lookup state</primary></indexterm>
<indexterm significance="preferred" zone="lookup_state">
<primary>state</primary><secondary>lookup</secondary></indexterm>
— the lookup group and the lookup modifiers.
</para>


<para id='grab_state'>
The
<firstterm>grab state</firstterm>
<indexterm significance="preferred" zone="grab_state">
<primary>grab state</primary></indexterm>
<indexterm significance="preferred" zone="grab_state">
<primary>state</primary><secondary>grab</secondary></indexterm>
is the state used when matching events to passive grabs. If the event activates a grab, the
<firstterm>grab modifiers</firstterm>
<indexterm significance="preferred" zone="grab_state">
<primary>grab modifiers</primary></indexterm>
<indexterm significance="preferred" zone="grab_state">
<primary>modifiers</primary><secondary>grab</secondary></indexterm>
and
<firstterm>grab group</firstterm>
<indexterm significance="preferred" zone="grab_state">
<primary>grab group</primary></indexterm>
<indexterm significance="preferred" zone="grab_state">
<primary>group</primary><secondary>grab</secondary></indexterm>
are represented in the state field of core X events; otherwise, the lookup state is used. The grab modifiers are computed as:

<literallayout>   (((base | latched | (locked &amp; ~ignore_locks)) &amp; ~server_internal_modifiers)</literallayout>
</para>

<para>
If the server’s
<emphasis>IgnoreGroupLock</emphasis>
control (see <link linkend="The_IgnoreGroupLock_Control">section 10.7.3</link>) is not set, the grab group is the same as the effective group. Otherwise, the grab group is computed from the base group and latched group, ignoring the locked group.
</para>


<para>
The final three components of Xkb state are applicable to clients that are not linked with an Xlib containing the X keyboard extension library and therefore are not aware of the keyboard extension
(<emphasis>Xkb-unaware</emphasis>
clients):
</para>

<itemizedlist>
<listitem>
  <para>
The compatibility modifier state
  </para>
</listitem>
<listitem>
  <para>
The compatibility lookup modifier state
  </para>
</listitem>
<listitem>
  <para>
The compatibility grab modifier state
  </para>
</listitem>
</itemizedlist>

<para>
The X11 protocol interpretation of modifiers does not include direct support for multiple groups. When an Xkb-extended X server connects to an Xkb-unaware client, the compatibility states remap the keyboard group into a core modifier whenever possible. The compatibility state corresponds to the effective modifier and effective group state, with the group remapped to a modifier. The compatibility lookup and grab states correspond to the lookup and grab states, respectively, with the group remapped to a modifier. The compatibility lookup state is reported in events that do not trigger passive grabs; otherwise, the compatibility grab state is reported.
</para>


</sect1>
<sect1 id='Changing_the_Keyboard_State'>
<title>Changing the Keyboard State</title>

<sect2 id='Changing_Modifiers'>
<title>Changing Modifiers</title>

<indexterm zone="Changing_Modifiers">
<primary>real modifiers</primary></indexterm>
<indexterm zone="Changing_Modifiers">
<primary>modifiers</primary><secondary>real</secondary></indexterm>
<indexterm significance="preferred" zone="Changing_Modifiers">
<primary>mask</primary><secondary>real modifiers</secondary></indexterm>

<para>
The functions in this section that change the use of modifiers use a mask in the parameter
<structfield>affect</structfield>.
It is a bitwise inclusive OR of the legal modifier masks:
</para>

<table id='table5.1' frame='none'>
<title>Real Modifier Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
  <row>
    <entry>Mask</entry>
  </row>
  <row>
    <entry>ShiftMask</entry>
  </row>
  <row>
    <entry>LockMask</entry>
  </row>
  <row>
    <entry>ControlMask</entry>
  </row>
  <row>
    <entry>Mod1Mask</entry>
  </row>
  <row>
    <entry>Mod2Mask</entry>
  </row>
  <row>
    <entry>Mod3Mask</entry>
  </row>
  <row>
    <entry>Mod4Mask</entry>
  </row>
  <row>
    <entry>Mod5Mask</entry>
  </row>
</tbody>
</tgroup>
</table>

<para>
To lock and unlock any of the eight real keyboard modifiers, use
<function>XkbLockModifiers</function>:
</para>

<indexterm significance="preferred" zone="XkbLockModifiers"><primary><function>XkbLockModifiers</function></primary></indexterm>
<funcsynopsis id="XkbLockModifiers">
  <funcprototype>
    <funcdef>Bool <function>XkbLockModifiers</function></funcdef>
<!-- (
<parameter>display, device_spec, affect, values</parameter>
) -->

    <paramdef>Display *<parameter>display</parameter></paramdef>
    <paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
    <paramdef>unsigned int <parameter>affect</parameter></paramdef>
    <paramdef>unsigned int <parameter>values</parameter></paramdef>
  </funcprototype>
</funcsynopsis>
<variablelist>
  <varlistentry>
    <term>
      <parameter>display</parameter>
    </term>
    <listitem>
      <para>
        connection to the X server
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>device_spec</parameter>
    </term>
    <listitem>
      <para>
        device ID, or <symbol>XkbUseCoreKbd</symbol>
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>affect</parameter>
    </term>
    <listitem>
      <para>
        mask of real modifiers whose lock state is to change
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>values</parameter>
    </term>
    <listitem>
      <para>
        1 &rArr; lock, 0 &rArr; unlock; only for modifiers selected by <parameter>affect</parameter>
      </para>
    </listitem>
  </varlistentry>
</variablelist>

<para>
<function>XkbLockModifiers</function>
sends a request to the server to lock the real modifiers selected by both
<parameter>affect</parameter>
and
<parameter>values</parameter>
and to unlock the real modifiers selected by
<parameter>affect</parameter>
but not selected by
<parameter>values</parameter>.
<function>XkbLockModifiers</function>
does not wait for a reply from the server. It returns
<symbol>True</symbol>
if the request was sent, and
<symbol>False</symbol>
otherwise.
</para>


<para>
To latch and unlatch any of the eight real keyboard modifiers, use
<function>XkbLatchModifiers</function>:
</para>


<indexterm significance="preferred" zone="XkbLatchModifiers"><primary><function>XkbLatchModifiers</function></primary></indexterm>
<funcsynopsis id="XkbLatchModifiers">
  <funcprototype>
    <funcdef>Bool <function>XkbLatchModifiers</function></funcdef>
<!-- (
<parameter>display, device_spec, affect, values</parameter>
) -->

    <paramdef>Display *<parameter>display</parameter></paramdef>
    <paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
    <paramdef>unsigned int <parameter>affect</parameter></paramdef>
    <paramdef>unsigned int <parameter>values</parameter></paramdef>
  </funcprototype>
</funcsynopsis>
<variablelist>
  <varlistentry>
    <term>
      <parameter>display</parameter>
    </term>
    <listitem>
      <para>
        connection to the X server
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>device_spec</parameter>
    </term>
    <listitem>
      <para>
        device ID, or <symbol>XkbUseCoreKbd</symbol>
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>affect</parameter>
    </term>
    <listitem>
      <para>
        mask of modifiers whose latch state is to change
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>values</parameter>
    </term>
    <listitem>
      <para>
        1 &rArr; latch, 0 &rArr; unlatch; only for mods selected by <parameter>affect</parameter>
      </para>
    </listitem>
  </varlistentry>
</variablelist>

<para>
<function>XkbLatchModifiers</function>
sends a request to the server to latch the real modifiers selected by both
<parameter>affect</parameter>
and
<parameter>values</parameter>
and to unlatch the real modifiers selected by
<parameter>affect</parameter>
but not selected by
<parameter>values</parameter>.
<function>XkbLatchModifiers</function>
does not wait for a reply from the server. It returns
<symbol>True</symbol>
if the request was sent, and
<symbol>False</symbol>
otherwise.
</para>


</sect2>
<sect2 id='Changing_Groups'>
<title>Changing Groups</title>

<indexterm zone="Changing_Groups">
<primary>keysym groups</primary></indexterm>
<indexterm zone="Changing_Groups">
<primary>group</primary><secondary>keysym</secondary></indexterm>

<para>
Reference the keysym group indices with these symbolic constants:
</para>

<table id='table5.2' frame='topbot'>
<title>Symbolic Group Names</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<colspec colname='c2' colwidth='2.0*'/>
<tbody>
  <row rowsep='1'>
    <entry>Symbolic Name</entry>
    <entry>Value</entry>
  </row>
  <row>
    <entry><symbol>XkbGroup1Index</symbol></entry>
    <entry>0</entry>
  </row>
  <row>
    <entry><symbol>XkbGroup2Index</symbol></entry>
    <entry>1</entry>
  </row>
  <row>
    <entry><symbol>XkbGroup3Index</symbol></entry>
    <entry>2</entry>
  </row>
  <row>
    <entry><symbol>XkbGroup4Index</symbol></entry>
    <entry>3</entry>
  </row>
</tbody>
</tgroup>
</table>

<para>
To lock the keysym group, use
<function>XkbLockGroup</function>.
</para>

<indexterm significance="preferred" zone="XkbLockGroup"><primary><function>XkbLockGroup</function></primary></indexterm>
<funcsynopsis id="XkbLockGroup">
  <funcprototype>
    <funcdef>Bool <function>XkbLockGroup</function></funcdef>
<!-- (
<parameter>display, device_spec, group</parameter>
) -->

    <paramdef>Display *<parameter>display</parameter></paramdef>
    <paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
    <paramdef>unsigned int <parameter>group</parameter></paramdef>
  </funcprototype>
</funcsynopsis>
<variablelist>
  <varlistentry>
    <term>
      <parameter>display</parameter>
    </term>
    <listitem>
      <para>
        connection to the X server
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>device_spec</parameter>
    </term>
    <listitem>
      <para>
        device ID, or <symbol>XkbUseCoreKbd</symbol>
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>group</parameter>
    </term>
    <listitem>
      <para>
        index of the keysym group to lock
      </para>
    </listitem>
  </varlistentry>
</variablelist>

<para>
<function>XkbLockGroup</function>
sends a request to the server to lock the specified
<parameter>group</parameter>
and does not wait for a reply. It returns
<symbol>True</symbol>
if the request was sent and
<symbol>False</symbol>
otherwise.
</para>


<para>
To latch the keysym group, use
<function>XkbLatchGroup</function>.
</para>


<indexterm significance="preferred" zone="XkbLatchGroup"><primary><function>XkbLatchGroup</function></primary></indexterm>
<funcsynopsis id="XkbLatchGroup">
  <funcprototype>
    <funcdef>Bool <function>XkbLatchGroup</function></funcdef>
<!-- (
<parameter>display, device_spec, group</parameter>
) -->

    <paramdef>Display *<parameter>display</parameter></paramdef>
    <paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
    <paramdef>unsigned int <parameter>group</parameter></paramdef>
  </funcprototype>
</funcsynopsis>
<variablelist>
  <varlistentry>
    <term>
      <parameter>display</parameter>
    </term>
    <listitem>
      <para>
        connection to the X server
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>device_spec</parameter>
    </term>
    <listitem>
      <para>
        device ID, or <symbol>XkbUseCoreKbd</symbol>
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>group</parameter>
    </term>
    <listitem>
      <para>
        index of the keysym group to latch
      </para>
    </listitem>
  </varlistentry>
</variablelist>

<para>
<function>XkbLatchGroup</function>
sends a request to the server to latch the specified group and does not wait for a reply. It returns
<symbol>True</symbol>
if the request was sent and
<symbol>False</symbol>
otherwise.
</para>


</sect2>
</sect1>
<sect1 id='Determining_Keyboard_State'>
<title>Determining Keyboard State</title>

<indexterm significance="preferred" zone="Determining_Keyboard_State">
<primary><structname>XkbStateRec</structname></primary></indexterm>

<para>
Xkb keyboard state may be represented in an
<structname>XkbStateRec</structname>
structure:

<programlisting>
typedef struct {
    unsigned char      group;                /* effective group index */
    unsigned char      base_group;           /* base group index */
    unsigned char      latched_group;        /* latched group index */
    unsigned char      locked_group;         /* locked group index */
    unsigned char      mods;                 /* effective modifiers */
    unsigned char      base_mods;            /* base modifiers */
    unsigned char      latched_mods;         /* latched modifiers */
    unsigned char      locked_mods;          /* locked modifiers */
    unsigned char      compat_state;         /* effective group &rArr; modifiers */
    unsigned char      grab_mods;            /* modifiers used for grabs */
    unsigned char      compat_grab_mods;     /* mods used for compatibility
                                                mode grabs */
    unsigned char      lookup_mods;          /* mods used to lookup symbols */
    unsigned char      compat_lookup_mods;   /* mods used for compatibility
                                                lookup */
    unsigned short     ptr_buttons;          /* 1 bit &rArr; corresponding
                                                pointer btn is down */
} <structname>XkbStateRec</structname>, *XkbStatePtr;
</programlisting></para>

<para>
To obtain the keyboard state, use
<function>XkbGetState</function>.
</para>

<indexterm significance="preferred" zone="XkbGetState"><primary><function>XkbGetState</function></primary></indexterm>
<funcsynopsis id="XkbGetState">
  <funcprototype>
    <funcdef>Status <function>XkbGetState</function></funcdef>
<!-- (
<parameter>display</parameter>,
<parameter>device_spec</parameter>,
<parameter>state_return</parameter>
) -->

    <paramdef>Display *<parameter>display</parameter></paramdef>
    <paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
    <paramdef>XkbStatePtr <parameter>state_return</parameter></paramdef>
  </funcprototype>
</funcsynopsis>
<variablelist>
  <varlistentry>
    <term>
      <parameter>display</parameter>
    </term>
    <listitem>
      <para>
        connection to the X server
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>device_spec</parameter>
    </term>
    <listitem>
      <para>
        device ID, or <symbol>XkbUseCoreKbd</symbol>
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <parameter>state_return</parameter>
    </term>
    <listitem>
      <para>
        backfilled with Xkb state
      </para>
    </listitem>
  </varlistentry>
</variablelist>

<para>
The
<function>XkbGetState</function>
function queries the server for the current keyboard state, waits for a reply, and then backfills
<parameter>state_return</parameter>
with the results.
</para>


<para>
All group values are expressed as group indices in the range [0..3]. Modifiers and the compatibility modifier state values are expressed as the bitwise union of the core X11 modifier masks. The pointer button state is reported as in the core X11 protocol.
</para>


</sect1>
<sect1 id='Tracking_Keyboard_State'>
<title>Tracking Keyboard State</title>

<indexterm significance="preferred" zone="Tracking_Keyboard_State">
<primary>events</primary><secondary><symbol>XkbStateNotify</symbol></secondary></indexterm>
<indexterm significance="preferred" zone="Tracking_Keyboard_State">
<primary><structname>XkbStateNotifyEvent</structname></primary></indexterm>

<para>
The Xkb extension reports
<symbol>XkbStateNotify</symbol>
events to clients wanting notification whenever the Xkb state changes. The changes reported include changes to any aspect of the keyboard state: when a modifier is set or unset, when the current group changes, or when a pointer button is pressed or released. As with all Xkb events,
<symbol>XkbStateNotify</symbol>
events are reported to all interested clients without regard to the current keyboard input focus or grab state.
</para>


<para>
There are many different types of Xkb state changes. Xkb defines an event
detail mask corresponding to each type of change. The event detail masks are
listed in <link linkend="table5.3">Table 5.3</link>.
</para>

<table id='table5.3' frame='topbot'>
<title>XkbStateNotify Event Detail Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<colspec colname='c2' colwidth='1.0*'/>
<thead>
  <row rowsep='1'>
    <entry>Mask</entry>
    <entry>Value</entry>
  </row>
</thead>
<tbody>
  <row>
    <entry><symbol>XkbModifierStateMask</symbol></entry>
    <entry>(1L &lt;&lt; 0)</entry>
  </row>
  <row>
    <entry><symbol>XkbModifierBaseMask</symbol></entry>
    <entry>(1L &lt;&lt; 1)</entry>
  </row>
  <row>
    <entry><symbol>XkbModifierLatchMask</symbol></entry>
    <entry>(1L &lt;&lt; 2)</entry>
  </row>
  <row>
    <entry><symbol>XkbModifierLockMask</symbol></entry>
    <entry>(1L &lt;&lt; 3)</entry>
  </row>
  <row>
    <entry><symbol>XkbGroupStateMask</symbol></entry>
    <entry>(1L &lt;&lt; 4)</entry>
  </row>
  <row>
    <entry><symbol>XkbGroupBaseMask</symbol></entry>
    <entry>(1L &lt;&lt; 5)</entry>
  </row>
  <row>
    <entry><symbol>XkbGroupLatchMask</symbol></entry>
    <entry>(1L &lt;&lt; 6)</entry>
  </row>
  <row>
    <entry><symbol>XkbGroupLockMask</symbol></entry>
    <entry>(1L &lt;&lt; 7)</entry>
  </row>
  <row>
    <entry><symbol>XkbCompatStateMask</symbol></entry>
    <entry>(1L &lt;&lt; 8)</entry>
  </row>
  <row>
    <entry><symbol>XkbGrabModsMask</symbol></entry>
    <entry>(1L &lt;&lt; 9)</entry>
  </row>
  <row>
    <entry><symbol>XkbCompatGrabModsMask</symbol></entry>
    <entry>(1L &lt;&lt; 10)</entry>
  </row>
  <row>
    <entry><symbol>XkbLookupModsMask</symbol></entry>
    <entry>(1L &lt;&lt; 11)</entry>
  </row>
  <row>
    <entry><symbol>XkbCompatLookupModsMask</symbol></entry>
    <entry>(1L &lt;&lt; 12)</entry>
  </row>
  <row>
    <entry><symbol>XkbPointerButtonMask</symbol></entry>
    <entry>(1L &lt;&lt; 13)</entry>
  </row>
  <row>
    <entry><symbol>XkbAllStateComponentsMask</symbol></entry>
    <entry>(0x3fff)</entry>
  </row>
</tbody>
</tgroup>
</table>

<para>
To track changes in the keyboard state for a particular device, select to receive
<symbol>XkbStateNotify</symbol>
events by calling either
<function>XkbSelectEvents</function>
or
<function>XkbSelectEventDetails</function>
(see <link linkend="Selecting_Xkb_Events">section 4.3</link>).
</para>


<para>
To receive
<symbol>XkbStateNotify</symbol>
events under all possible conditions, use
<function>XkbSelectEvents</function>
and pass
<symbol>XkbStateNotifyMask</symbol>
in both
<parameter>bits_to_change</parameter>
and
<parameter>values_for_bits</parameter>.
</para>


<para>
To receive
<symbol>XkbStateNotify</symbol>
events only under certain conditions, use
<function>XkbSelectEventDetails</function>
using
<symbol>XkbStateNotify</symbol>
as the
<structfield>event_type</structfield>
and specifying the desired state changes in
<parameter>bits_to_change</parameter>
and
<parameter>values_for_bits</parameter>
using mask bits from <link linkend="table5.3">Table 5.3</link>.
</para>


<para>
The structure for
<symbol>XkbStateNotify</symbol>
events is:

<programlisting>
typedef struct {
    int            type;            /* Xkb extension base event code */
    unsigned long  serial;          /* X server serial number for event */
    Bool           send_event;      /* <symbol>True</symbol> &rArr; synthetically generated */
    Display *      display;         /* server connection where event generated */
    Time           time;            /* server time when event generated */
    int            xkb_type;        /* <symbol>XkbStateNotify</symbol> */
    int            device;          /* Xkb device ID,
                                       will not be <symbol>XkbUseCoreKbd</symbol> */
    unsigned int   changed;         /* bits indicating what has changed */
    int            group;           /* group index of effective group */
    int            base_group;      /* group index of base group */
    int            latched_group;   /* group index of latched group */
    int            locked_group;    /* group index of locked group */
    unsigned int   mods;            /* effective modifiers */
    unsigned int   base_mods;       /* base modifiers */
    unsigned int   latched_mods;    /* latched modifiers */
    unsigned int   locked_mods;     /* locked modifiers */
    int            compat_state;    /* computed compatibility state */
    unsigned char  grab_mods;       /* modifiers used for grabs */
    unsigned char  compat_grab_mods; /* modifiers used for compatibility grabs */
    unsigned char  lookup_mods;     /* modifiers used to lookup symbols */
    unsigned char  compat_lookup_mods; /* mods used for compatibility look up */
    int            ptr_buttons;     /* core pointer buttons */
    KeyCode        keycode;         /* keycode causing event,
                                       0 if programmatic */
    char           event_type;      /* core event if <structfield>req_major</structfield> or <structfield>req_minor</structfield>
                                       non zero */
    char           req_major;       /* major request code if program trigger,
                                       else 0 */
    char           req_minor;       /* minor request code if program trigger,
                                       else 0 */
} <structname>XkbStateNotifyEvent</structname>;
</programlisting></para>

<para>
When you receive an
<symbol>XkbStateNotify</symbol>
event, the
<structfield>changed</structfield>
field indicates which elements of keyboard state have changed.
This will be the bitwise inclusive OR of one or more of the
<symbol>XkbStateNotify</symbol>
event detail masks shown in <link linkend="table5.3">Table 5.3</link>.
All fields reported in the event are valid, but only those indicated in
<structfield>changed</structfield>
have changed values.
</para>


<para>
The
<structfield>group</structfield>
field is the group index of the effective keysym group. The
<structfield>base_group</structfield>,
<structfield>latched_group</structfield>,
and
<structfield>locked_group</structfield>
fields are set to a group index value representing the base group,
the latched group, and the locked group, respectively. The X
server can set the modifier and compatibility state fields to
a union of the core modifier mask bits; this union represents the
corresponding modifier states. The <structfield>ptr_buttons</structfield>
field gives the state of the core pointer buttons as a
mask composed of an inclusive OR of zero or more of the
core pointer button masks.
</para>


<para>
Xkb state changes can occur either in response to keyboard
activity or under application control. If a key event
caused the state change, the
<structfield>keycode</structfield>
field gives the keycode of the key event, and the
<structfield>event_type</structfield>
field is set to either <symbol>KeyPress</symbol>
or
<symbol>KeyRelease</symbol>.
If a pointer button event caused the state change, the
<structfield>keycode</structfield>
field is zero, and the <structfield>event_type</structfield>
field is set to either <symbol>ButtonPress</symbol>
or <symbol>ButtonRelease</symbol>.
Otherwise, the major and minor codes of the request that caused the
state change are given in the
<structfield>req_major</structfield>
and
<structfield>req_minor</structfield>
fields, and the
<structfield>keycode</structfield>
field is zero. The
<structfield>req_major</structfield>
value is the same as the major extension opcode.
</para>
</sect1>
</chapter>