diff options
author | Alan Coopersmith <alan.coopersmith@oracle.com> | 2023-08-20 15:01:09 -0700 |
---|---|---|
committer | Alan Coopersmith <alan.coopersmith@oracle.com> | 2023-08-20 15:27:48 -0700 |
commit | 7b16c55063ba4eb258bf91c170e378c1e2d398bd (patch) | |
tree | 917f9e4256d2ac55007e710b4fe685d1712225b8 | |
parent | 41a157dfeefe943f5a79948e4f9ef93473144fd8 (diff) |
docs: remove XkbKeySymsOffset
This function was documented but never implemented.
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
-rw-r--r-- | man/xkb/Makefile.am | 1 | ||||
-rw-r--r-- | man/xkb/XkbKeySymsOffset.man | 66 | ||||
-rw-r--r-- | specs/XKB/ch15.xml | 45 |
3 files changed, 0 insertions, 112 deletions
diff --git a/man/xkb/Makefile.am b/man/xkb/Makefile.am index ac4b3ae4..043d2aed 100644 --- a/man/xkb/Makefile.am +++ b/man/xkb/Makefile.am @@ -126,7 +126,6 @@ libman_PRE = \ XkbKeyNumGroups.man \ XkbKeyNumSyms.man \ XkbKeySymEntry.man \ - XkbKeySymsOffset.man \ XkbKeySymsPtr.man \ XkbKeyType.man \ XkbKeyTypeIndex.man \ diff --git a/man/xkb/XkbKeySymsOffset.man b/man/xkb/XkbKeySymsOffset.man deleted file mode 100644 index 174fb4d7..00000000 --- a/man/xkb/XkbKeySymsOffset.man +++ /dev/null @@ -1,66 +0,0 @@ -'\" t -.\" Copyright (c) 1999, Oracle and/or its affiliates. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbKeySymsOffset __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbKeySymsOffset \- Returns the offset of the two-dimensional array of keysyms -for the key corresponding to -.I keycode -.SH SYNOPSIS -.HP -.B int XkbKeySymsOffset -.BI "(\^XkbDescPtr " "xkb" "\^," -.BI "KeyCode " "keycode" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I xkb -Xkb description of interest -.TP -.I keycode -keycode of interest -.SH DESCRIPTION -.LP -The key width and number of groups associated with a key are used to form a -small two-dimensional array of KeySyms for a key. This array may be different -sizes for different keys. The array for a single key is stored as a linear list, -in row-major order. The arrays for all of the keys are stored in the -.I syms -field of the client map. There is one row for each group associated with a key -and one column for each level. The index corresponding to a given group and -shift level is computed as: -.nf - - idx = group_index * key_width + shift_level - -.fi -The -.I offset -field of the -.I key_sym_map -entry for a key is used to access the beginning of the array. - -.I XkbKeySymsOffset -returns the offset of the two-dimensional array of keysyms for the key -corresponding to -.I keycode. diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml index a6f3f7c6..c7a5a96a 100644 --- a/specs/XKB/ch15.xml +++ b/specs/XKB/ch15.xml @@ -1726,8 +1726,6 @@ entry for a key is used to access the beginning of the array. <para> Xkb provides the following macros for accessing the <structfield>width</structfield> -and -<structfield>offset</structfield> for individual keys, as well as macros for accessing the two-dimensional array of symbols bound to the key: </para> @@ -1829,49 +1827,6 @@ for the key corresponding to </para> -<indexterm significance="preferred" zone="XkbKeySymsOffset"><primary><function>XkbKeySymsOffset</function></primary></indexterm> -<funcsynopsis id="XkbKeySymsOffset"> - <funcprototype> - <funcdef>int <function>XkbKeySymsOffset</function></funcdef> -<!-- ( -<parameter>xkb, keycode</parameter> -) /* macro */ --> - - <paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef> - <paramdef>KeyCode <parameter>keycode</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>xkb</parameter> - </term> - <listitem> - <para> - Xkb description of interest - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>keycode</parameter> - </term> - <listitem> - <para> - keycode of interest - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbKeySymsOffset</function> -returns the offset of the two-dimensional array of keysyms for the key -corresponding to -<parameter>keycode</parameter>. -</para> - - <indexterm significance="preferred" zone="XkbKeyNumSyms"><primary><function>XkbKeyNumSyms</function></primary></indexterm> <funcsynopsis id="XkbKeyNumSyms"> <funcprototype> |