diff options
author | Alan Coopersmith <alan.coopersmith@oracle.com> | 2023-08-20 14:04:15 -0700 |
---|---|---|
committer | Alan Coopersmith <alan.coopersmith@oracle.com> | 2023-08-20 14:04:15 -0700 |
commit | caab7321d2ec14ee776ec329ed2facf0816a3136 (patch) | |
tree | 6b8802db6949eb70a34b36c405214d44f4bb70d1 /specs | |
parent | 843e89bd2467a58cb454705a09d095726b96d93f (diff) |
docs: remove XkbGetAccessXTimeout & XkbSetAccessXTimeout
These functions were documented but never implemented.
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Diffstat (limited to 'specs')
-rw-r--r-- | specs/XKB/ch10.xml | 271 |
1 files changed, 9 insertions, 262 deletions
diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml index cf98543a..d34ce258 100644 --- a/specs/XKB/ch10.xml +++ b/specs/XKB/ch10.xml @@ -1617,275 +1617,22 @@ event. For more information on events, refer to <link linkend="Tracking_Changes_to_Keyboard_Controls">section 10.11</link>. </para> - -<para> -Use -<function>XkbGetAccessXTimeout</function> -to query the current -<emphasis>AccessXTimeout</emphasis> -options for a keyboard device. -</para> - -<indexterm significance="preferred" zone="XkbGetAccessXTimeout"><primary><function>XkbGetAccessXTimeout</function></primary></indexterm> -<funcsynopsis id="XkbGetAccessXTimeout"> - <funcprototype> - <funcdef>Bool <function>XkbGetAccessXTimeout</function></funcdef> -<!-- ( -<parameter>display</parameter>, -<parameter>device_spec</parameter>, -<parameter>timeout_rtrn</parameter>, -<parameter>ctrls_mask_rtrn</parameter>, -<parameter>ctrls_values_rtrn</parameter>, -<parameter>options_mask_rtrn, options_values_rtrn</parameter> -) --> - - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> - <paramdef>unsigned short *<parameter>timeout_rtrn</parameter></paramdef> - <paramdef>unsigned int *<parameter>ctrls_mask_rtrn</parameter></paramdef> - <paramdef>unsigned int *<parameter>ctrls_values_rtrn</parameter></paramdef> - <paramdef>unsigned short *<parameter>opts_mask_rtrn</parameter></paramdef> - <paramdef>unsigned short *<parameter>opts_values_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 to query, or <symbol>XkbUseCoreKbd</symbol> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>timeout_rtrn</parameter> - </term> - <listitem> - <para> - delay until AccessXTimeout, seconds - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>ctrls_mask_rtrn</parameter> - </term> - <listitem> - <para> - backfilled with controls to modify - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>ctrls_values_rtrn</parameter> - </term> - <listitem> - <para> - backfilled with on/off status for controls - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>opts_mask_rtrn</parameter> - </term> - <listitem> - <para> - backfilled with <structfield>ax_options</structfield> to modify - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>opts_values_rtrn</parameter> - </term> - <listitem> - <para> - backfilled with values for <structfield>ax_options</structfield> - </para> - </listitem> - </varlistentry> -</variablelist> - <para> -<function>XkbGetAccessXTimeout</function> -sends a request to the X server to obtain the current values for the +There are no convenience functions in Xkb for manipulating this control. The <emphasis>AccessXTimeout</emphasis> -attributes, waits for a reply, and backfills the values into the appropriate -arguments. -The parameters -<parameter>opts_mask_rtrn</parameter> +control settings are carried in the +<structfield>ax_timeout</structfield>, +<structfield>axt_opts_mask</structfield>, +<structfield>axt_opts_values</structfield>, +<structfield>axt_ctrls_mask</structfield>, and -<parameter>opts_values_rtrn</parameter> -are backfilled with the options to modify and the values for -<structfield>ax_options</structfield>, -which is a field in the +<structfield>axt_ctrls_values</structfield> +fields of an <structname>XkbControlsRec</structname> -structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>). -<function>XkbGetAccessXTimeout</function> -returns -<symbol>True</symbol> -if successful; if a compatible version of the Xkb extension is not available -in the server, -<function>XkbGetAccessXTimeout</function> -returns -<symbol>False</symbol>. -</para> - - -<para> -To configure the -<emphasis>AccessXTimeout</emphasis> -options for a keyboard device, use -<function>XkbSetAccessXTimeout</function>. -</para> - - -<indexterm significance="preferred" zone="XkbSetAccessXTimeout"><primary><function>XkbSetAccessXTimeout</function></primary></indexterm> -<funcsynopsis id="XkbSetAccessXTimeout"> - <funcprototype> - <funcdef>Bool <function>XkbSetAccessXTimeout</function></funcdef> -<!-- ( -<parameter>display</parameter>, -<parameter>device_spec, timeout, ctrls_mask, ctrls_values, opts_mask, -opts_values</parameter> -) --> - - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> - <paramdef>unsigned short <parameter>timeout</parameter></paramdef> - <paramdef>unsigned int <parameter>ctrls_mask</parameter></paramdef> - <paramdef>unsigned int <parameter>ctrls_values</parameter></paramdef> - <paramdef>unsigned short <parameter>opts_mask</parameter></paramdef> - <paramdef>unsigned short <parameter>opts_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 <symbol>XkbUseCoreKbd</symbol> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>timeout</parameter> - </term> - <listitem> - <para> - seconds idle until AccessXTimeout occurs - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>ctrls_mask</parameter> - </term> - <listitem> - <para> - boolean controls to modify - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>ctrls_values</parameter> - </term> - <listitem> - <para> - new bits for controls selected by <parameter>ctrls_mask</parameter> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>opts_mask</parameter> - </term> - <listitem> - <para> - <structfield>ax_options</structfield> to change - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>opts_values</parameter> - </term> - <listitem> - <para> - new bits for <structfield>ax_options</structfield> selected by <parameter>opts_mask</parameter> - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<parameter>timeout</parameter> -specifies the number of seconds the keyboard must be idle before the controls -are modified. -<parameter>ctrls_mask</parameter> -specifies what controls are to be enabled or disabled, and -<parameter>ctrls_values</parameter> -specifies whether those controls are to be enabled or disabled. The bit values -correspond to those for enabling and disabling boolean controls -(see <link linkend="The_EnabledControls_Control">section 10.1.1</link>). The -<parameter>opts_mask</parameter> -field specifies which attributes of the -<emphasis>AccessXKeys</emphasis> -and -<emphasis>AccessXFeedback</emphasis> -controls are to be changed, and -<parameter>opts_values</parameter> -specifies the new values for those options. The bit values correspond to those -for the -<structfield>ax_options</structfield> -field of an -<structname>XkbDescRec</structname> -(see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>). +structure, discussed in <link linkend="The_XkbControlsRec_Structure">section 10.8</link>. </para> -<para> -<function>XkbSetAccessXTimeout</function> -sends a request to configure the -<emphasis>AccessXTimeout</emphasis> -control to the server. -It does not wait for a reply, and normally returns -<symbol>True</symbol>. -If a compatible version of the Xkb extension is not available in the server, -<function>XkbSetAccessXTimeout</function> -returns -<symbol>False</symbol>. -</para> - </sect2> <sect2 id='The_AccessXFeedback_Control'> |