docs: remove XkbGetStickyKeysOptions & XkbSetStickyKeysOptions

These functions were documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>

1 files changed, 6 insertions, 175 deletions

diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml
index 19d15e02..01f5adce 100644
--- a/specs/XKB/ch10.xml
+++ b/specs/XKB/ch10.xml
@@ -2215,183 +2215,14 @@ specifies whether or not
 locks a modifier when pressed twice in a row.
 </para>
 
-
-<para>
-Use
-<function>XkbGetStickyKeysOptions</function>
-to query the current
-<emphasis>StickyKeys</emphasis>
-attributes for a keyboard device.
-</para>
-
-<indexterm significance="preferred" zone="XkbGetStickyKeysOptions"><primary><function>XkbGetStickyKeysOptions</function></primary></indexterm>
-<funcsynopsis id="XkbGetStickyKeysOptions">
-  <funcprototype>
-    <funcdef>Bool <function>XkbGetStickyKeysOptions</function></funcdef>
-<!-- (
-<parameter>display</parameter>,
-<parameter>device_spec</parameter>,
-<parameter>options_rtrn</parameter>
-) -->
-
-    <paramdef>Display *<parameter>display</parameter></paramdef>
-    <paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
-    <paramdef>unsigned int *<parameter>options_rtrn</parameter></paramdef>
-  </funcprototype>
-</funcsynopsis>
-<variablelist>
-  <varlistentry>
-    <term>
-      <parameter>display</parameter>
-    </term>
-    <listitem>
-      <para>
-        connection to 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>options_rtrn</parameter>
-    </term>
-    <listitem>
-      <para>
-        backfilled with StickyKeys option mask
-      </para>
-    </listitem>
-  </varlistentry>
-</variablelist>
-
-<para>
-<function>XkbGetStickyKeysOptions</function>
-requests the attributes of the
-<emphasis>StickyKeys</emphasis>
-control from the server, waits for a reply, and backfills
-<parameter>options_rtrn</parameter>
-with a mask indicating whether the individual
-<emphasis>StickyKeys</emphasis>
-options are on or off. Valid bits in
-<parameter>options_rtrn</parameter>
-are:
-
-  <simplelist type='vert' columns='1'>
-    <member><symbol>XkbAX_TwoKeysMask</symbol></member>
-    <member><symbol>XkbAX_LatchToLockMask</symbol></member>
-  </simplelist>
-</para>
-
 <para>
-<function>XkbGetStickyKeysOptions</function>
-returns
-<symbol>True</symbol>
-if successful; if a compatible version of the Xkb extension is not available
-in the server
-<function>XkbGetStickyKeysOptions</function>
-returns
-<symbol>False</symbol>.
-</para>
-
-
-<para>
-To set the
-<emphasis>StickyKeys</emphasis>
-attributes for a keyboard device, use
-<function>XkbSetStickyKeysOptions</function>.
-</para>
-
-
-<indexterm significance="preferred" zone="XkbSetStickyKeysOptions"><primary><function>XkbSetStickyKeysOptions</function></primary></indexterm>
-<funcsynopsis id="XkbSetStickyKeysOptions">
-  <funcprototype>
-    <funcdef>Bool <function>XkbSetStickyKeysOptions</function></funcdef>
-<!-- (
-<parameter>display</parameter>,
-<parameter>device_spec, mask, values</parameter>
-) -->
-
-    <paramdef>Display *<parameter>display</parameter></paramdef>
-    <paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
-    <paramdef>unsigned int <parameter>mask</parameter></paramdef>
-    <paramdef>unsigned int <parameter>values</parameter></paramdef>
-  </funcprototype>
-</funcsynopsis>
-<variablelist>
-  <varlistentry>
-    <term>
-      <parameter>display</parameter>
-    </term>
-    <listitem>
-      <para>
-        connection to X server
-      </para>
-    </listitem>
-  </varlistentry>
-  <varlistentry>
-    <term>
-      <parameter>device_spec</parameter>
-    </term>
-    <listitem>
-      <para>
-        device to configure, or XkbUseCoreKbd
-      </para>
-    </listitem>
-  </varlistentry>
-  <varlistentry>
-    <term>
-      <parameter>mask</parameter>
-    </term>
-    <listitem>
-      <para>
-        selects StickyKeys attributes to modify
-      </para>
-    </listitem>
-  </varlistentry>
-  <varlistentry>
-    <term>
-      <parameter>values</parameter>
-    </term>
-    <listitem>
-      <para>
-        values for selected attributes
-      </para>
-    </listitem>
-  </varlistentry>
-</variablelist>
-
-<para>
-<function>XkbSetStickyKeysOptions</function>
-sends a request to configure the
+There are no convenience functions in Xkb for manipulating this control. The
 <emphasis>StickyKeys</emphasis>
-control to the server.
-It does not wait for a reply and normally returns
-<symbol>True</symbol>.
-The valid bits to use for both the
-<parameter>mask</parameter>
-and
-<parameter>values</parameter>
-parameters are:
-
-  <simplelist type='vert' columns='1'>
-    <member><symbol>XkbAX_TwoKeysMask</symbol></member>
-    <member><symbol>XkbAX_LatchToLockMask</symbol></member>
-  </simplelist>
-</para>
-
-<para>
-If a compatible version of the Xkb extension is not available in the server,
-<function>XkbSetStickyKeysOptions</function>
-returns
-<symbol>False</symbol>.
+control settings are carried in the
+<structfield>ax_options</structfield>
+field of an
+<structname>XkbControlsRec</structname>
+structure, discussed in <link linkend="The_XkbControlsRec_Structure">section 10.8</link>.
 </para>
 
 </sect3>