fdo-mirrors/xorg-libx11
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/xorg/lib/libx11.git synced 2026-05-07 15:38:05 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

specs/XKB: Markup function args as <parameter> instead of <emphasis>

Browse source 
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
This commit is contained in:
Alan Coopersmith 2014-07-08 22:22:29 -07:00
parent 79ba58cceb
commit f10aa1e094
19 changed files with 1223 additions and 1223 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
specs/XKB/ch02.xml
View file

@ -96,8 +96,8 @@ To determine the compatibility of a library at runtime, call
<funcprototype>
<funcdef>Bool <function>XkbLibraryVersion</function></funcdef>
<!-- (
<emphasis>lib_major_in_out</emphasis>,
<emphasis>lib_minor_in_out</emphasis>
<parameter>lib_major_in_out</parameter>,
<parameter>lib_minor_in_out</parameter>
) -->
<paramdef>int *<parameter>lib_major_in_out</parameter></paramdef>
@ -131,19 +131,19 @@ To determine the compatibility of a library at runtime, call
Pass the symbolic value
<emphasis>XkbMajorVersion</emphasis>
in
<emphasis>lib_major_in_out</emphasis>
<parameter>lib_major_in_out</parameter>
and
<emphasis>XkbMinorVersion</emphasis>
in
<emphasis>lib_minor_in_out</emphasis>.
<parameter>lib_minor_in_out</parameter>.
These arguments represent the version of the library used at compile time.
The
<function>XkbLibraryVersion</function>
function backfills the major and minor version numbers of the library used at
run time in
<emphasis>lib_major_in_out</emphasis>
<parameter>lib_major_in_out</parameter>
and
<emphasis>lib_minor_in_out</emphasis>.
<parameter>lib_minor_in_out</parameter>.
If the versions of the compile time and run time libraries are compatible,
<function>XkbLibraryVersion</function>
returns
@ -203,7 +203,7 @@ and initializes the extension when it is present.
<funcprototype>
<funcdef>Bool <function>XkbQueryExtension</function></funcdef>
<!-- (
<emphasis>dpy, opcode_rtrn, event_rtrn, error_rtrn, major_in_out, minor_in_out</emphasis>
<parameter>dpy, opcode_rtrn, event_rtrn, error_rtrn, major_in_out, minor_in_out</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -294,15 +294,15 @@ If a compatible version of Xkb is present,
<function>XkbQueryExtension</function>
initializes the extension. It backfills the major opcode for the keyboard
extension in
<emphasis>opcode_rtrn</emphasis>,
<parameter>opcode_rtrn</parameter>,
the base event code in
<emphasis>event_rtrn</emphasis>,
<parameter>event_rtrn</parameter>,
the base error code in
<emphasis>error_rtrn</emphasis>,
<parameter>error_rtrn</parameter>,
and the major and minor version numbers of the extension in
<emphasis>major_in_out</emphasis>
<parameter>major_in_out</parameter>
and
<emphasis>minor_in_out</emphasis>.
<parameter>minor_in_out</parameter>.
The major opcode is reported in the
<emphasis>req_major</emphasis>
fields of some Xkb events. For a discussion of the base event code, see
@ -322,8 +322,8 @@ server, and initialize the extension for use.
<funcprototype>
<funcdef>Display *<function>XkbOpenDisplay</function></funcdef>
<!-- (
<emphasis>display_name, event_rtrn, error_rtrn, major_in_out, minor_in_out,
reason_rtrn)</emphasis> -->
<parameter>display_name, event_rtrn, error_rtrn, major_in_out, minor_in_out,
reason_rtrn)</parameter> -->
<paramdef>char *<parameter>display_name</parameter></paramdef>
<paramdef>int *<parameter>event_rtrn</parameter></paramdef>
@ -401,11 +401,11 @@ reason_rtrn)</emphasis> -->
<function>XkbOpenDisplay</function>
is a convenience function that opens an X display connection and initializes
the X keyboard extension. In all cases, upon return
<emphasis>reason_rtrn</emphasis>
<parameter>reason_rtrn</parameter>
contains a status value indicating success or the type of failure. If
<emphasis>major_in_out</emphasis>
<parameter>major_in_out</parameter>
and
<emphasis>minor_in_out</emphasis>
<parameter>minor_in_out</parameter>
are not
<emphasis>NULL</emphasis>,
<function>XkbOpenDisplay</function>
@ -413,15 +413,15 @@ the X keyboard extension. In all cases, upon return
<function>XkbLibraryVersion</function>
to determine whether the client library is compatible, passing it the values
pointed to by
<emphasis>major_in_out</emphasis>
<parameter>major_in_out</parameter>
and
<emphasis>minor_in_out</emphasis>.
<parameter>minor_in_out</parameter>.
If the library is incompatible,
<function>XkbOpenDisplay</function>
backfills
<emphasis>major_in_out</emphasis>
<parameter>major_in_out</parameter>
and
<emphasis>minor_in_out</emphasis>
<parameter>minor_in_out</parameter>
with the major and minor extension versions of the library being used and
returns
<emphasis>NULL</emphasis>.
@ -430,7 +430,7 @@ If the library is compatible,
next calls
<function>XOpenDisplay</function>
with the
<emphasis>display_name</emphasis>.
<parameter>display_name</parameter>.
If this fails, the function returns
<emphasis>NULL</emphasis>.
If successful,
@ -439,9 +439,9 @@ calls
<function>XkbQueryExtension</function>
and
backfills the major and minor Xkb server extension version numbers in
<emphasis>major_in_out</emphasis>
<parameter>major_in_out</parameter>
and
<emphasis>minor_in_out</emphasis>.
<parameter>minor_in_out</parameter>.
If the server extension version is not compatible with the library extension
version or if the server extension is not present,
<function>XkbOpenDisplay</function>
@ -452,7 +452,7 @@ When successful, the function returns the display connection.
<para>
The possible values for
<emphasis>reason_rtrn</emphasis> are:
<parameter>reason_rtrn</parameter> are:
</para>
<itemizedlist>
@ -518,7 +518,7 @@ disable use of the extension once a connection is established.
<funcprototype>
<funcdef>Bool <function>XkbIgnoreExtension</function></funcdef>
<!-- (
<emphasis>ignore</emphasis>
<parameter>ignore</parameter>
) -->
<paramdef>Bool <parameter>ignore</parameter></paramdef>

54
specs/XKB/ch04.xml
View file

@ -387,7 +387,7 @@ them delivered under all conditions, use
<funcprototype>
<funcdef>Bool <function>XkbSelectEvents</function></funcdef>
<!-- (
<emphasis>display, device_spec, bits_to_change, values_for_bits</emphasis>
<parameter>display, device_spec, bits_to_change, values_for_bits</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -441,27 +441,27 @@ them delivered under all conditions, use
<para>
This request changes the Xkb event selection mask for the keyboard specified by
<emphasis>device_spec</emphasis>.
<parameter>device_spec</parameter>.
</para>
<para>
Each Xkb event that can be selected is represented by a bit in the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
masks. Only the event selection bits specified by the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
parameter are affected; any unspecified bits are left unchanged. To turn on
event selection for an event, set the bit for the event in the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
parameter and set the corresponding bit in the
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameter. To turn off event selection for an event, set the bit for the event
in the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
parameter and do not set the corresponding bit in the
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameter. The valid values for both of these parameters are an inclusive
bitwise OR of the masks shown in <link linkend="table4.2">Table 4.2</link>.
There is no interface to return
@ -472,15 +472,15 @@ clients’ event selection masks.
<para>
If a bit is not set in the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
parameter, but the corresponding bit is set in the
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameter, a
<errorname>BadMatch</errorname>
protocol error results. If an undefined bit is set in either the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
or the
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameter, a
<errorname>BadValue</errorname>
protocol error results.
@ -520,8 +520,8 @@ Xkb events with
<funcprototype>
<funcdef>Bool <function>XkbSelectEventDetails</function></funcdef>
<!-- (
<emphasis>display, device_spec, event_type, bits_to_change</emphasis>,
<emphasis>values_for_bits</emphasis>
<parameter>display, device_spec, event_type, bits_to_change</parameter>,
<parameter>values_for_bits</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -591,9 +591,9 @@ While
<function>XkbSelectEventDetails</function>
changes the selection criteria for a single type of Xkb event. The
interpretation of the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
masks depends on the event type in question.
</para>
@ -601,19 +601,19 @@ interpretation of the
<para>
<function>XkbSelectEventDetails</function>
changes the Xkb event selection mask for the keyboard specified by
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
and the Xkb event specified by
<emphasis>event_type</emphasis>.
<parameter>event_type</parameter>.
To turn on event selection for an event detail, set the bit for the detail in
the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
parameter and set the corresponding bit in the
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameter. To turn off event detail selection for a detail, set the bit for
the detail in the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
parameter and do not set the corresponding bit in the
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameter.
</para>
@ -622,15 +622,15 @@ the detail in the
If an invalid event type is specified, a
<errorname>BadValue</errorname>
protocol error results. If a bit is not set in the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
parameter, but the corresponding bit is set in the
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameter, a
<errorname>BadMatch</errorname>
protocol error results. If an undefined bit is set in either the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
or the
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameter, a
<errorname>BadValue</errorname>
protocol error results.

34
specs/XKB/ch05.xml
View file

@ -352,7 +352,7 @@ To lock and unlock any of the eight real keyboard modifiers, use
<funcprototype>
<funcdef>Bool <function>XkbLockModifiers</function></funcdef>
<!-- (
<emphasis>display, device_spec, affect, values</emphasis>
<parameter>display, device_spec, affect, values</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -407,13 +407,13 @@ To lock and unlock any of the eight real keyboard modifiers, use
<para>
<function>XkbLockModifiers</function>
sends a request to the server to lock the real modifiers selected by both
<emphasis>affect</emphasis>
<parameter>affect</parameter>
and
<emphasis>values</emphasis>
<parameter>values</parameter>
and to unlock the real modifiers selected by
<emphasis>affect</emphasis>
<parameter>affect</parameter>
but not selected by
<emphasis>values</emphasis>.
<parameter>values</parameter>.
<function>XkbLockModifiers</function>
does not wait for a reply from the server. It returns
<symbol>True</symbol>
@ -434,7 +434,7 @@ To latch and unlatch any of the eight real keyboard modifiers, use
<funcprototype>
<funcdef>Bool <function>XkbLatchModifiers</function></funcdef>
<!-- (d
<emphasis>isplay, device_spec, affect, values</emphasis>
<parameter>isplay, device_spec, affect, values</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -489,13 +489,13 @@ To latch and unlatch any of the eight real keyboard modifiers, use
<para>
<function>XkbLatchModifiers</function>
sends a request to the server to latch the real modifiers selected by both
<emphasis>affect</emphasis>
<parameter>affect</parameter>
and
<emphasis>values</emphasis>
<parameter>values</parameter>
and to unlatch the real modifiers selected by
<emphasis>affect</emphasis>
<parameter>affect</parameter>
but not selected by
<emphasis>values</emphasis>.
<parameter>values</parameter>.
<function>XkbLatchModifiers</function>
does not wait for a reply from the server. It returns
<symbol>True</symbol>
@ -554,7 +554,7 @@ To lock the keysym group, use
<funcprototype>
<funcdef>Bool <function>XkbLockGroup</function></funcdef>
<!-- (
<emphasis>display, device_spec, group</emphasis>
<parameter>display, device_spec, group</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -598,7 +598,7 @@ To lock the keysym group, use
<para>
<function>XkbLockGroup</function>
sends a request to the server to lock the specified
<emphasis>group </emphasis>
<parameter>group</parameter>
and does not wait for a reply. It returns
<symbol>True</symbol>
if the request was sent and
@ -618,7 +618,7 @@ To latch the keysym group, use
<funcprototype>
<funcdef>Bool <function>XkbLatchGroup</function></funcdef>
<!-- (
<emphasis>display, device_spec, group</emphasis>
<parameter>display, device_spec, group</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -711,9 +711,9 @@ To obtain the keyboard state, use
<funcprototype>
<funcdef>Status <function>XkbGetState</function></funcdef>
<!-- (
<emphasis>display</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>state_return</emphasis>
<parameter>display</parameter>,
<parameter>device_spec</parameter>,
<parameter>state_return</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -758,7 +758,7 @@ To obtain the keyboard state, use
The
<function>XkbGetState</function>
function queries the server for the current keyboard state, waits for a reply, and then backfills
<emphasis>state_return</emphasis>
<parameter>state_return</parameter>
with the results.
</para>

24
specs/XKB/ch06.xml
View file

@ -49,13 +49,13 @@ keyboard */
<para>
The
<emphasis>display</emphasis>
<parameter>display</parameter>
field points to an X display structure. The
<emphasis>flags</emphasis>
field is private to the library: modifying
<emphasis>flags</emphasis>
may yield unpredictable results. The
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
field specifies the device identifier of the keyboard input device, or
<emphasis>XkbUseCoreKeyboard</emphasis>,
which specifies the core keyboard device. The
@ -206,7 +206,7 @@ To retrieve one or more components of a keyboard device description, use
<funcprototype>
<funcdef>XkbDescPtr <function>XkbGetKeyboard</function></funcdef>
<!-- (
<emphasis>display, which, device_spec</emphasis>
<parameter>display, which, device_spec</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -252,15 +252,15 @@ To retrieve one or more components of a keyboard device description, use
<function>XkbGetKeyboard</function>
allocates and returns a pointer to a keyboard description. It queries the
server for those components specified in the
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter for device
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
and copies the results to the
<emphasis>XkbDescRec</emphasis>
it allocated. The remaining fields in the keyboard description are set to
<emphasis>NULL</emphasis>.
The valid masks for
<emphasis>which</emphasis>
<parameter>which</parameter>
are those listed in <link linkend="table6.2">Table 6.2</link>.
</para>
@ -344,7 +344,7 @@ To destroy either an entire an
<funcprototype>
<funcdef>void <function>XkbFreeKeyboard</function></funcdef>
<!--
<emphasis>(xkb, which, free_all</emphasis>
<parameter>(xkb, which, free_all</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -388,22 +388,22 @@ To destroy either an entire an
<para>
<function>XkbFreeKeyboard</function>
frees the components of
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
specified by
<emphasis>which</emphasis>
<parameter>which</parameter>
and sets the corresponding values to
<emphasis>NULL</emphasis>.
If
<emphasis>free_all</emphasis>
<parameter>free_all</parameter>
is
<symbol>True</symbol>,
<function>XkbFreeKeyboard</function>
frees every non-
<emphasis>NULL</emphasis>
component of
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
and then frees the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
structure itself.
</para>

18
specs/XKB/ch07.xml
View file

@ -89,9 +89,9 @@ To set the name of a virtual modifier, use
using
<emphasis>XkbVirtualModNamesMask</emphasis>
in
<emphasis>which</emphasis>
<parameter>which</parameter>
and the name in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
argument; to retrieve indicator names, use
<function>XkbGetNames</function>.
These functions are discussed in <xref linkend="Symbolic_Names" />.
@ -250,7 +250,7 @@ To determine the mapping of virtual modifiers to core X protocol modifiers, use
<funcprototype>
<funcdef>Bool <function>XkbVirtualModsToReal</function></funcdef>
<!-- (
<emphasis>xkb, virtual_mask, mask_rtrn</emphasis>
<parameter>xkb, virtual_mask, mask_rtrn</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -293,23 +293,23 @@ To determine the mapping of virtual modifiers to core X protocol modifiers, use
<para>
If the keyboard description defined by
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
includes bindings for virtual modifiers,
<function>XkbVirtualModsToReal</function>
uses those bindings to determine the set of real modifiers that correspond to
the set of virtual modifiers specified in
<emphasis>virtual_mask</emphasis>.
<parameter>virtual_mask</parameter>.
The
<emphasis>virtual_mask</emphasis>
<parameter>virtual_mask</parameter>
parameter is a mask specifying the virtual modifiers to translate; the i-th
bit (0 relative) of the mask represents the i-th virtual modifier. If
<emphasis>mask_rtrn</emphasis>
<parameter>mask_rtrn</parameter>
is non-
<emphasis>NULL</emphasis>,
<function>XkbVirtualModsToReal</function>
backfills it with the resulting real modifier mask. If the keyboard
description in
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
does not include virtual modifier bindings,
<function>XkbVirtualModsToReal</function>
returns
@ -319,7 +319,7 @@ description in
</para>
<note><para>It is possible for a local (client-side) keyboard description (the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter) to not contain any virtual modifier information (simply because the
client has not requested it) while the server’s corresponding definition may
contain virtual modifier information. </para></note>

152
specs/XKB/ch08.xml
View file

@ -858,9 +858,9 @@ current state of the keyboard indicators, use
<funcprototype>
<funcdef>Status <function>XkbGetIndicatorState</function></funcdef>
<!-- (
<emphasis>display</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>state_return</emphasis>
<parameter>display</parameter>,
<parameter>device_spec</parameter>,
<parameter>state_return</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -904,19 +904,19 @@ current state of the keyboard indicators, use
<para>
<function>XkbGetIndicatorState</function>
queries the
<emphasis>display</emphasis>
<parameter>display</parameter>
for the state of the indicators on the device specified by the
<emphasis>device_spec</emphasis>.
<parameter>device_spec</parameter>.
For each indicator that is "turned on" on the device, the associated bit is
set in
<emphasis>state_return</emphasis>.
<parameter>state_return</parameter>.
If a compatible version of the Xkb extension is not available in the server,
<function>XkbGetIndicatorState</function>
returns a
<errorname>BadMatch</errorname>
error. Otherwise, it sends the request to the X server, places the state of
the indicators into
<emphasis>state_return</emphasis>,
<parameter>state_return</parameter>,
and returns
<symbol>Success</symbol>.
Thus the value reported by
@ -940,9 +940,9 @@ indicators, use
<funcprototype>
<funcdef>Status <function>XkbGetIndicatorMap</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>which</emphasis>,
<emphasis>desc</emphasis>
<parameter>dpy</parameter>,
<parameter>which</parameter>,
<parameter>desc</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -986,13 +986,13 @@ indicators, use
<para>
<function>XkbGetIndicatorMap</function>
obtains the maps from the server for only those indicators specified by the
<emphasis>which</emphasis>
<parameter>which</parameter>
mask and copies the values into the keyboard description specified by
<emphasis>desc</emphasis>.
<parameter>desc</parameter>.
If the
<emphasis>indicators</emphasis>
field of the
<emphasis>desc</emphasis>
<parameter>desc</parameter>
parameter is
<emphasis>NULL</emphasis>,
<function>XkbGetIndicatorMap</function>
@ -1048,13 +1048,13 @@ Use
<funcprototype>
<funcdef>Bool <function>XkbGetNamedIndicator</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>dev_spec</emphasis>,
<emphasis>name</emphasis>,
<emphasis>ndx_rtrn</emphasis>,
<emphasis>state_rtrn</emphasis>,
<emphasis>map_rtrn</emphasis>,
<emphasis>real_rtrn</emphasis>
<parameter>dpy</parameter>,
<parameter>dev_spec</parameter>,
<parameter>name</parameter>,
<parameter>ndx_rtrn</parameter>,
<parameter>state_rtrn</parameter>,
<parameter>map_rtrn</parameter>,
<parameter>real_rtrn</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -1142,9 +1142,9 @@ Use
<para>
If the device specified by
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
has an indicator named
<emphasis>name</emphasis>,
<parameter>name</parameter>,
<function>XkbGetNamedIndicator</function>
returns
<symbol>True</symbol>
@ -1158,22 +1158,22 @@ Otherwise,
<para>
The
<emphasis>ndx_rtrn</emphasis>
<parameter>ndx_rtrn</parameter>
field returns the zero-based index of the named indicator. This index is the
bit position to use in any function call that requires a mask of indicator
bits, as well as the indicator’s index into the
<emphasis>XkbIndicatorRec</emphasis>
array of indicator maps.
<emphasis>state_rtrn</emphasis>
<parameter>state_rtrn</parameter>
returns the current state of the named indicator (
<symbol>True</symbol>
= on,
<symbol>False</symbol>
= off).
<emphasis>map_rtrn</emphasis>
<parameter>map_rtrn</parameter>
returns the indicator map for the named indicator. In addition, if the
indicator is mapped to a physical LED, the
<emphasis>real_rtrn</emphasis>
<parameter>real_rtrn</parameter>
parameter is set to
<symbol>True</symbol>.
</para>
@ -1343,9 +1343,9 @@ keyboard description, then use
<funcprototype>
<funcdef>Bool <function>XkbSetIndicatorMap</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>which</emphasis>,
<emphasis>desc</emphasis>
<parameter>dpy</parameter>,
<parameter>which</parameter>,
<parameter>desc</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -1389,11 +1389,11 @@ keyboard description, then use
<para>
For each
bit set in the
<emphasis>which </emphasis>
<parameter>which</parameter>
parameter,
<function>XkbSetIndicatorMap</function>
sends the corresponding indicator map from the
<emphasis>desc</emphasis>
<parameter>desc</parameter>
parameter to the server.
</para>
@ -1435,12 +1435,12 @@ Set the indicator map for the indicator
<funcprototype>
<funcdef>Bool<function>XkbSetNamedIndicator</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>name</emphasis>,
<emphasis>change_state, state</emphasis>,
<emphasis>create_new</emphasis>,
<emphasis>map</emphasis>
<parameter>dpy</parameter>,
<parameter>device_spec</parameter>,
<parameter>name</parameter>,
<parameter>change_state, state</parameter>,
<parameter>create_new</parameter>,
<parameter>map</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -1533,7 +1533,7 @@ If a compatible version of the Xkb extension is not available in the server,
<symbol>False</symbol>.
Otherwise, it sends a request to the X server to change the indicator
specified by
<emphasis>name</emphasis>
<parameter>name</parameter>
and returns
<symbol>True</symbol>.
</para>
@ -1541,43 +1541,43 @@ specified by
<para>
If
<emphasis>change_state</emphasis>
<parameter>change_state</parameter>
is
<symbol>True</symbol>,
and the optional parameter,
<emphasis>state</emphasis>,
<parameter>state</parameter>,
is not
<emphasis>NULL</emphasis>,
<function>XkbSetNamedIndicator</function>
tells the server to change the state of the named indicator to the value
specified by
<emphasis>state</emphasis>.
<parameter>state</parameter>.
</para>
<para>
If an indicator with the name specified by
<emphasis>name</emphasis>
<parameter>name</parameter>
does not already exist, the
<emphasis>create_new</emphasis>
<parameter>create_new</parameter>
parameter tells the server whether it should create a new named indicator. If
<emphasis>create_new</emphasis>
<parameter>create_new</parameter>
is
<symbol>True</symbol>,
the server finds the first indicator that doesn’t have a name and gives it
the name specified by
<emphasis>name</emphasis>.
<parameter>name</parameter>.
</para>
<para>
If the optional parameter,
<emphasis>map</emphasis>,
<parameter>map</parameter>,
is not
<emphasis>NULL</emphasis>,
<function>XkbSetNamedIndicator</function>
tells the server to change the indicator’s map to the values specified
in <emphasis>map</emphasis>.
in <parameter>map</parameter>.
</para>
<para>
@ -1636,7 +1636,7 @@ description, use
<funcprototype>
<funcdef>Bool <function>XkbChangeIndicators</function></funcdef>
<!-- (
<emphasis>dpy, xkb, changes, state</emphasis>
<parameter>dpy, xkb, changes, state</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -1693,20 +1693,20 @@ description, use
<para>
<function>XkbChangeIndicators</function>
copies any maps specified by
<emphasis>changes</emphasis>
<parameter>changes</parameter>
from the keyboard description,
<emphasis>xkb</emphasis>,
<parameter>xkb</parameter>,
to the server specified by
<emphasis>dpy</emphasis>.
<parameter>dpy</parameter>.
If any bits are set in the
<emphasis>state_changes</emphasis>
field of
<emphasis>changes</emphasis>,
<parameter>changes</parameter>,
<function>XkbChangeIndicators</function>
also sets the state of those indicators to the values specified in the
<emphasis>state</emphasis>
<parameter>state</parameter>
mask. A 1 bit in
<emphasis>state</emphasis>
<parameter>state</parameter>
turns the corresponding indicator on, a 0 bit turns it off.
</para>
@ -1820,7 +1820,7 @@ have changed. If the event is of type
<emphasis>XkbIndicatorStateNotify</emphasis>,
<emphasis>changed</emphasis>
reports the indicators that have changed state.
<emphasis>state</emphasis>
<parameter>state</parameter>
is a mask that specifies the current state of all indicators, whether they
have changed or not, for both
<emphasis>XkbIndicatorStateNotify</emphasis>
@ -1841,9 +1841,9 @@ When your client application receives either a
<funcprototype>
<funcdef>void <function>XkbNoteIndicatorChanges</function></funcdef>
<!-- (
<emphasis>old</emphasis>,
<emphasis>new</emphasis>,
<emphasis>wanted</emphasis>
<parameter>old</parameter>,
<parameter>new</parameter>,
<parameter>wanted</parameter>
) -->
<paramdef>XkbIndicatorChangesPtr <parameter>old</parameter></paramdef>
@ -1886,18 +1886,18 @@ When your client application receives either a
<para>
The
<emphasis>wanted</emphasis>
<parameter>wanted</parameter>
parameter is the bitwise inclusive OR of
<emphasis>XkbIndicatorMapMask</emphasis>
and
<emphasis>XkbIndicatorStateMask</emphasis>.
<function>XkbNoteIndicatorChanges</function>
copies any changes reported in
<emphasis>new</emphasis>
<parameter>new</parameter>
and specified in
<emphasis>wanted</emphasis>
<parameter>wanted</parameter>
into the changes record specified by
<emphasis>old</emphasis>.
<parameter>old</parameter>.
</para>
@ -1915,10 +1915,10 @@ the results of one or more calls to
<funcprototype>
<funcdef>Status <function>XkbGetIndicatorChanges</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>xkb</emphasis>,
<emphasis>changes</emphasis>,
<emphasis>state</emphasis>
<parameter>dpy</parameter>,
<parameter>xkb</parameter>,
<parameter>changes</parameter>,
<parameter>state</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -1973,21 +1973,21 @@ the results of one or more calls to
<para>
<function>XkbGetIndicatorChanges</function>
examines the
<emphasis>changes</emphasis>
<parameter>changes</parameter>
parameter, pulls over the necessary information from the server, and copies
the results into the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
keyboard description. If any bits are set in the
<emphasis>state_changes</emphasis>
field of
<emphasis>changes</emphasis>,
<parameter>changes</parameter>,
<function>XkbGetIndicatorChanges</function>
also places the state of those indicators in
<emphasis>state</emphasis>.
<parameter>state</parameter>.
If the
<emphasis>indicators</emphasis>
field of
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
is
<emphasis>NULL</emphasis>,
<function>XkbGetIndicatorChanges</function>
@ -2027,7 +2027,7 @@ described in <xref linkend="Complete_Keyboard_Description" />). If the need aris
<funcprototype>
<funcdef>Status <function>XkbAllocIndicatorMaps</function></funcdef>
<!-- (
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -2048,7 +2048,7 @@ described in <xref linkend="Complete_Keyboard_Description" />). If the need aris
<para>
The
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter must point to a valid keyboard description. If it doesn’t,
<function>XkbAllocIndicatorMaps</function>
returns a
@ -2080,7 +2080,7 @@ To free memory used by the
<funcprototype>
<funcdef>void <function>XkbFreeIndicatorMaps</function></funcdef>
<!-- (
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -2102,12 +2102,12 @@ To free memory used by the
<para>
If the <emphasis>indicators</emphasis>
member of the keyboard description record
pointed to by <emphasis>xkb</emphasis>
pointed to by <parameter>xkb</parameter>
is not <emphasis>NULL</emphasis>,
<function>XkbFreeIndicatorMaps</function>
frees the memory associated with
the <emphasis>indicators</emphasis>
member of <emphasis>xkb</emphasis>.
member of <parameter>xkb</parameter>.
</para>
</sect1>

40
specs/XKB/ch09.xml
View file

@ -350,7 +350,7 @@ To ring the bell on an X input extension device or the default keyboard, use
<funcprototype>
<funcdef>Bool <function>XkbDeviceBell</function></funcdef>
<!-- (
<emphasis>display, window, device_id, bell_class, bell_id, percent, name</emphasis>
<parameter>display, window, device_id, bell_class, bell_id, percent, name</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -437,18 +437,18 @@ To ring the bell on an X input extension device or the default keyboard, use
<para>
Set
<emphasis>percent</emphasis>
<parameter>percent</parameter>
to be the volume relative to the base volume for the keyboard as described for
<function>XBell</function>.
</para>
<para>
Note that
<emphasis>bell_class</emphasis>
<parameter>bell_class</parameter>
and
<emphasis>bell_id</emphasis>
<parameter>bell_id</parameter>
indicate the bell to physically ring.
<emphasis>name</emphasis>
<parameter>name</parameter>
is simply an arbitrary moniker for the client application’s use.
</para>
@ -492,7 +492,7 @@ default keyboard:
<funcprototype>
<funcdef>Bool <function>XkbBell</function></funcdef>
<!-- (
<emphasis>display, window, percent, name</emphasis>
<parameter>display, window, percent, name</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -550,9 +550,9 @@ If a compatible keyboard extension isn’t present in the X server,
calls
<function>XBell</function>
with the specified
<emphasis>display</emphasis>
<parameter>display</parameter>
and
<emphasis>percent</emphasis>,
<parameter>percent</parameter>,
and returns
<symbol>False</symbol>.
Otherwise,
@ -562,7 +562,7 @@ calls
with the specified
<emphasis>display, window, percent</emphasis>,
and
<emphasis>name</emphasis>,
<parameter>name</parameter>,
a
<emphasis>device_spec</emphasis>
of
@ -622,7 +622,7 @@ without ringing the corresponding bell, use
<funcprototype>
<funcdef>Bool <function>XkbDeviceBellEvent</function></funcdef>
<!-- (
<emphasis>display, window, device_spec, bell_class, bell_id, percent, name</emphasis>
<parameter>display, window, device_spec, bell_class, bell_id, percent, name</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -719,7 +719,7 @@ Otherwise,
event to be sent to all interested clients and returns
<symbol>True</symbol>.
Set
<emphasis>percent</emphasis>
<parameter>percent</parameter>
to be the volume relative to the base volume for the keyboard as described for
<function>XBell</function>.
</para>
@ -750,7 +750,7 @@ the keyboard without ringing the bell:
<funcprototype>
<funcdef>Bool <function>XkbBellEvent</function></funcdef>
<!-- (
<emphasis>display, window, percent, name</emphasis>
<parameter>display, window, percent, name</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -814,7 +814,7 @@ calls
with the specified
<emphasis>display, window, percent</emphasis>,
and
<emphasis>name</emphasis>,
<parameter>name</parameter>,
a
<emphasis>device_spec</emphasis>
of
@ -859,7 +859,7 @@ audible bells, use <function>XkbForceDeviceBell</function>.
<funcprototype>
<funcdef>Bool <function>XkbForceDeviceBell</function></funcdef>
<!-- (
<emphasis>display, window, device_spec, bell_class, bell_id, percent</emphasis>
<parameter>display, window, device_spec, bell_class, bell_id, percent</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -943,7 +943,7 @@ Otherwise,
rings the bell as specified for the display and keyboard device and returns
<symbol>True</symbol>.
Set
<emphasis>percent</emphasis>
<parameter>percent</parameter>
to be the volume relative to the base volume for the keyboard as described for
<function>XBell</function>.
There is no
@ -972,7 +972,7 @@ for audible bells, use
<funcprototype>
<funcdef>Bool <function>XkbForceBell</function></funcdef>
<!-- (
<emphasis>display, percent)</emphasis> -->
<parameter>display, percent)</parameter> -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>int <parameter>percent</parameter></paramdef>
@ -1007,9 +1007,9 @@ If a compatible keyboard extension isn’t present in the X server,
calls
<function>XBell</function>
with the specified
<emphasis>display</emphasis>
<parameter>display</parameter>
and
<emphasis>percent</emphasis>
<parameter>percent</parameter>
and returns
<symbol>False</symbol>.
Otherwise,
@ -1017,9 +1017,9 @@ Otherwise,
calls
<function>XkbForceDeviceBell</function>
with the specified
<emphasis>display </emphasis>
<parameter>display</parameter>
and
<emphasis>percent</emphasis>,
<parameter>percent</parameter>,
<emphasis>device_spec</emphasis>
=
<emphasis>XkbUseCoreKbd</emphasis>,

318
specs/XKB/ch10.xml
View file

@ -240,10 +240,10 @@ Use
<funcprototype>
<funcdef>Bool <function>XkbChangeEnabledControls</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>mask</emphasis>,
<emphasis>values</emphasis>
<parameter>dpy</parameter>,
<parameter>device_spec</parameter>,
<parameter>mask</parameter>,
<parameter>values</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -297,9 +297,9 @@ Use
<para>
The
<emphasis>mask</emphasis>
<parameter>mask</parameter>
parameter specifies the boolean controls to be enabled or disabled, and the
<emphasis>values</emphasis>
<parameter>values</parameter>
mask specifies the new state for those controls. Valid values for both of
these masks are composed of a bitwise inclusive OR of bits taken from the set
of mask bits in <link linkend="table10.7">Table 10.7</link>,
@ -388,9 +388,9 @@ To get the current values of the auto-reset controls, use
<funcprototype>
<funcdef>Bool <function>XkbGetAutoResetControls</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>auto_ctrls</emphasis>,
<emphasis>auto_values</emphasis>
<parameter>dpy</parameter>,
<parameter>auto_ctrls</parameter>,
<parameter>auto_values</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -434,9 +434,9 @@ To get the current values of the auto-reset controls, use
<para>
<function>XkbGetAutoResetControls</function>
backfills
<emphasis>auto_ctrls</emphasis>
<parameter>auto_ctrls</parameter>
and
<emphasis>auto_values</emphasis>
<parameter>auto_values</parameter>
with the
<emphasis>AutoReset</emphasis>
control attributes for this particular client. It returns
@ -460,10 +460,10 @@ To change the current values of the
<funcprototype>
<funcdef>Bool <function>XkbSetAutoResetControls</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>changes</emphasis>,
<emphasis>auto_ctrls</emphasis>,
<emphasis>auto_values</emphasis>
<parameter>dpy</parameter>,
<parameter>changes</parameter>,
<parameter>auto_ctrls</parameter>,
<parameter>auto_values</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -581,12 +581,12 @@ XkbStickyKeysMask);
<para>
<function>XkbSetAutoResetControls</function>
backfills
<emphasis>auto_ctrls</emphasis>
<parameter>auto_ctrls</parameter>
and
<emphasis>auto_values</emphasis>
<parameter>auto_values</parameter>
with the auto-reset controls for this particular client. Note that all of the
bits are valid in the returned values, not just the ones selected in the
<emphasis>changes</emphasis>
<parameter>changes</parameter>
mask.
</para>
@ -707,7 +707,7 @@ To get the current attributes of the
<funcprototype>
<funcdef>Bool <function>XkbGetAutoRepeatRate</function></funcdef>
<!-- (
<emphasis>display, device_spec, timeout_rtrn, interval_rtrn</emphasis>
<parameter>display, device_spec, timeout_rtrn, interval_rtrn</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -764,9 +764,9 @@ To get the current attributes of the
queries the server for the current values of the
<emphasis>RepeatControls</emphasis>
control attributes, backfills
<emphasis>timeout_rtrn</emphasis>
<parameter>timeout_rtrn</parameter>
and
<emphasis>interval_rtrn</emphasis>
<parameter>interval_rtrn</parameter>
with them, and returns
<symbol>True</symbol>.
If a compatible version of the Xkb extension is not available in the server
@ -787,7 +787,7 @@ To set the attributes of the RepeatKeys control for a keyboard device, use
<funcprototype>
<funcdef>Bool <function>XkbSetAutoRepeatRate</function></funcdef>
<!-- (
<emphasis>display, device_spec, timeout, interval</emphasis>
<parameter>display, device_spec, timeout, interval</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -844,9 +844,9 @@ To set the attributes of the RepeatKeys control for a keyboard device, use
sends a request to the X server to configure the
<emphasis>AutoRepeat</emphasis>
control attributes to the values specified in
<emphasis>timeout</emphasis>
<parameter>timeout</parameter>
and
<emphasis>interval</emphasis>.
<parameter>interval</parameter>.
</para>
@ -855,9 +855,9 @@ To set the attributes of the RepeatKeys control for a keyboard device, use
does not wait for a reply; it normally returns
<symbol>True</symbol>.
Specifying a zero value for either
<emphasis>timeout</emphasis>
<parameter>timeout</parameter>
or
<emphasis>interval</emphasis>
<parameter>interval</parameter>
causes the server to generate a
<errorname>BadValue</errorname>
protocol error. If a compatible version of the Xkb extension is not available
@ -951,7 +951,7 @@ use
<funcprototype>
<funcdef>Bool <function>XkbGetDetectableAutorepeat</function></funcdef>
<!-- (
<emphasis>display, supported_rtrn</emphasis>
<parameter>display, supported_rtrn</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -988,7 +988,7 @@ use
queries the server for the current state of
<emphasis>DetectableAutorepeat</emphasis>
and waits for a reply. If
<emphasis>supported_rtrn</emphasis>
<parameter>supported_rtrn</parameter>
is not
<emphasis>NULL</emphasis>,
it backfills supported_rtrn with
@ -1027,7 +1027,7 @@ they have requested otherwise.
<funcprototype>
<funcdef>Bool <function>XkbSetDetectableAutorepeat</function></funcdef>
<!-- (
<emphasis>display, detectable, supported_rtrn</emphasis>
<parameter>display, detectable, supported_rtrn</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -1076,20 +1076,20 @@ they have requested otherwise.
sends a request to the server to set
<emphasis>DetectableAutorepeat</emphasis>
on for the current client if
<emphasis>detectable</emphasis>
<parameter>detectable</parameter>
is
<symbol>True</symbol>,
and off it
<emphasis>detectable</emphasis>
<parameter>detectable</parameter>
is
<symbol>False</symbol>
; it then waits for a reply. If
<emphasis>supported_rtrn</emphasis>
<parameter>supported_rtrn</parameter>
is not
<emphasis>NULL</emphasis>,
<function>XkbSetDetectableAutorepeat</function>
backfills
<emphasis>supported_rtrn</emphasis>
<parameter>supported_rtrn</parameter>
with
<symbol>True</symbol>
if the server supports
@ -1605,12 +1605,12 @@ Use
<funcprototype>
<funcdef>Bool <function>XkbGetAccessXTimeout</function></funcdef>
<!-- (
<emphasis>display</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>timeout_rtrn</emphasis>,
<emphasis>ctrls_mask_rtrn</emphasis>,
<emphasis>ctrls_values_rtrn</emphasis>,
<emphasis>options_mask_rtrn, options_values_rtrn</emphasis>
<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>
@ -1702,9 +1702,9 @@ Use
attributes, waits for a reply, and backfills the values into the appropriate
arguments.
The parameters
<emphasis>opts_mask_rtrn</emphasis>
<parameter>opts_mask_rtrn</parameter>
and
<emphasis>opts_values_rtrn</emphasis>
<parameter>opts_values_rtrn</parameter>
are backfilled with the options to modify and the values for
<emphasis>ax_options</emphasis>,
which is a field in the
@ -1734,9 +1734,9 @@ To configure the
<funcprototype>
<funcdef>Bool <function>XkbSetAccessXTimeout</function></funcdef>
<!-- (
<emphasis>display</emphasis>,
<emphasis>device_spec, timeout, ctrls_mask, ctrls_values, opts_mask,
opts_values</emphasis>
<parameter>display</parameter>,
<parameter>device_spec, timeout, ctrls_mask, ctrls_values, opts_mask,
opts_values</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -1822,22 +1822,22 @@ opts_values</emphasis>
</variablelist>
<para>
<emphasis>timeout</emphasis>
<parameter>timeout</parameter>
specifies the number of seconds the keyboard must be idle before the controls
are modified.
<emphasis>ctrls_mask</emphasis>
<parameter>ctrls_mask</parameter>
specifies what controls are to be enabled or disabled, and
<emphasis>ctrls_values</emphasis>
<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
<emphasis>opts_mask</emphasis>
<parameter>opts_mask</parameter>
field specifies which attributes of the
<emphasis>AccessXKeys</emphasis>
and
<emphasis>AccessXFeedback</emphasis>
controls are to be changed, and
<emphasis>opts_values</emphasis>
<parameter>opts_values</parameter>
specifies the new values for those options. The bit values correspond to those
for the
<emphasis>ax_options</emphasis>
@ -2266,9 +2266,9 @@ To get the
<funcprototype>
<funcdef>Bool <function>XkbGetSlowKeysDelay</function></funcdef>
<!-- (
<emphasis>display</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>delay_rtrn</emphasis>
<parameter>display</parameter>,
<parameter>device_spec</parameter>,
<parameter>delay_rtrn</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -2314,7 +2314,7 @@ To get the
requests the attributes of the
<emphasis>SlowKeys</emphasis>
control from the server, waits for a reply and backfills
<emphasis>delay_rtrn </emphasis>
<parameter>delay_rtrn</parameter>
with the
<emphasis>SlowKeys</emphasis>
delay attribute.
@ -2342,9 +2342,9 @@ To set the
<funcprototype>
<funcdef>Bool <function>XkbSetSlowKeysDelay</function></funcdef>
<!-- (
<emphasis>display</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>delay</emphasis>
<parameter>display</parameter>,
<parameter>device_spec</parameter>,
<parameter>delay</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -2395,7 +2395,7 @@ It does not wait for a reply, and normally returns
Specifying a value of
<emphasis>0</emphasis>
for the
<emphasis>delay </emphasis>
<parameter>delay</parameter>
parameter causes
<emphasis>XkbSetSlowKeys</emphasis>
to generate a
@ -2448,9 +2448,9 @@ Use
<funcprototype>
<funcdef>Bool <function>XkbGetBounceKeysDelay</function></funcdef>
<!-- (
<emphasis>display</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>delay_rtrn</emphasis>
<parameter>display</parameter>,
<parameter>device_spec</parameter>,
<parameter>delay_rtrn</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -2496,7 +2496,7 @@ Use
requests the attributes of the
<emphasis>BounceKeys</emphasis>
control from the server, waits for a reply, and backfills
<emphasis>delay_rtrn </emphasis>
<parameter>delay_rtrn</parameter>
with the
<emphasis>BounceKeys</emphasis>
delay attribute.
@ -2524,9 +2524,9 @@ To set the
<funcprototype>
<funcdef>Bool <function>XkbSetBounceKeysDelay</function></funcdef>
<!-- (
<emphasis>display</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>delay</emphasis>
<parameter>display</parameter>,
<parameter>device_spec</parameter>,
<parameter>delay</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -2577,7 +2577,7 @@ It does not wait for a reply and normally returns
Specifying a value of
<emphasis>zero</emphasis>
for the
<emphasis>delay </emphasis>
<parameter>delay</parameter>
parameter causes
<function>XkbSetBounceKeysDelay</function>
to generate a
@ -2739,9 +2739,9 @@ Use
<funcprototype>
<funcdef>Bool <function>XkbGetStickyKeysOptions</function></funcdef>
<!-- (
<emphasis>display</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>options_rtrn</emphasis>
<parameter>display</parameter>,
<parameter>device_spec</parameter>,
<parameter>options_rtrn</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -2787,11 +2787,11 @@ Use
requests the attributes of the
<emphasis>StickyKeys</emphasis>
control from the server, waits for a reply, and backfills
<emphasis>options_rtrn </emphasis>
<parameter>options_rtrn</parameter>
with a mask indicating whether the individual
<emphasis>StickyKeys</emphasis>
options are on or off. Valid bits in
<emphasis>options_rtrn</emphasis>
<parameter>options_rtrn</parameter>
are:
</para>
@ -2827,8 +2827,8 @@ To set the
<funcprototype>
<funcdef>Bool <function>XkbSetStickyKeysOptions</function></funcdef>
<!-- (
<emphasis>display</emphasis>,
<emphasis>device_spec, mask, values</emphasis>
<parameter>display</parameter>,
<parameter>device_spec, mask, values</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -2888,9 +2888,9 @@ To set the
It does not wait for a reply and normally returns
<symbol>True</symbol>.
The valid bits to use for both the
<emphasis>mask</emphasis>
<parameter>mask</parameter>
and
<emphasis>values</emphasis>
<parameter>values</parameter>
parameters are:
</para>
@ -3075,8 +3075,8 @@ to passive grabs, use
<funcprototype>
<funcdef>Bool <function>XkbSetIgnoreLockMods</function></funcdef>
<!-- (
<emphasis>display, device_spec, affect_real, real_values, affect_virtual,
virtual_values</emphasis>
<parameter>display, device_spec, affect_real, real_values, affect_virtual,
virtual_values</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -3155,28 +3155,28 @@ virtual_values</emphasis>
sends a request to the server to change the server’s
<emphasis>IgnoreLockMods</emphasis>
control.
<emphasis>affect_real</emphasis>
<parameter>affect_real</parameter>
and
<emphasis>real_values</emphasis>
<parameter>real_values</parameter>
are masks of real modifier bits indicating which real modifiers are to be
added and removed from the server’s
<emphasis>IgnoreLockMods</emphasis>
control. Modifiers selected by both
<emphasis>affect_real</emphasis>
<parameter>affect_real</parameter>
and
<emphasis>real_values</emphasis>
<parameter>real_values</parameter>
are added to the server’s
<emphasis>IgnoreLockMods</emphasis>
control; those selected by
<emphasis>affect_real</emphasis>
<parameter>affect_real</parameter>
but not by
<emphasis>real_values</emphasis>
<parameter>real_values</parameter>
are removed from the server’s
<emphasis>IgnoreLockMods</emphasis>
control. Valid values for
<emphasis>affect_real</emphasis>
<parameter>affect_real</parameter>
and
<emphasis>real_values</emphasis>
<parameter>real_values</parameter>
consist of any combination of the eight core modifier bits:
<symbol>ShiftMask</symbol>,
<symbol>LockMask</symbol>,
@ -3184,29 +3184,29 @@ added and removed from the server’s
<symbol>Mod1Mask</symbol>
-
<symbol>Mod5Mask</symbol>.
<emphasis>affect_virtual</emphasis>
<parameter>affect_virtual</parameter>
and
<emphasis>virtual_values</emphasis>
<parameter>virtual_values</parameter>
are masks of virtual modifier bits indicating which virtual modifiers are to
be added and removed from the server’s
<emphasis>IgnoreLockMods</emphasis>
control. Modifiers selected by both
<emphasis>affect_virtual</emphasis>
<parameter>affect_virtual</parameter>
and
<emphasis>virtual_values</emphasis>
<parameter>virtual_values</parameter>
are added to the server’s
<emphasis>IgnoreLockMods</emphasis>
control; those selected by
<emphasis>affect_virtual</emphasis>
<parameter>affect_virtual</parameter>
but not by
<emphasis>virtual_values</emphasis>
<parameter>virtual_values</parameter>
are removed from the server’s
<emphasis>IgnoreLockMods</emphasis>
control.
See <link linkend="Virtual_Modifier_Names_and_Masks">section 7.1</link> for a discussion of virtual modifier masks to use in
<emphasis>affect_virtual</emphasis>
<parameter>affect_virtual</parameter>
and
<emphasis>virtual_values</emphasis>.
<parameter>virtual_values</parameter>.
<function>XkbSetIgnoreLockMods</function>
does not wait for a reply from the server. It returns
<symbol>True</symbol>
@ -3285,8 +3285,8 @@ delivered to the client, use
<funcprototype>
<funcdef>Bool <function>XkbSetServerInternalMods</function></funcdef>
<!-- (
<emphasis>display, device_spec, affect_real, real_values, affect_virtual,
virtual_values</emphasis>
<parameter>display, device_spec, affect_real, real_values, affect_virtual,
virtual_values</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -3364,23 +3364,23 @@ virtual_values</emphasis>
<function>XkbSetServerInternalMods</function>
sends a request to the server to change the internal modifiers consumed by the
server.
<emphasis>affect_real</emphasis>
<parameter>affect_real</parameter>
and
<emphasis>real_values</emphasis>
<parameter>real_values</parameter>
are masks of real modifier bits indicating which real modifiers are to be
added and removed from the server’s internal modifiers control. Modifiers
selected by both
<emphasis>affect_real</emphasis>
<parameter>affect_real</parameter>
and
<emphasis>real_values</emphasis>
<parameter>real_values</parameter>
are added to the server’s internal modifiers control; those selected by
<emphasis>affect_real</emphasis>
<parameter>affect_real</parameter>
but not by
<emphasis>real_values</emphasis>
<parameter>real_values</parameter>
are removed from the server’s internal modifiers mask. Valid values for
<emphasis>affect_real</emphasis>
<parameter>affect_real</parameter>
and
<emphasis>real_values</emphasis>
<parameter>real_values</parameter>
consist of any combination of the eight core modifier bits:
<symbol>ShiftMask</symbol>,
<symbol>LockMask</symbol>,
@ -3388,24 +3388,24 @@ selected by both
<symbol>Mod1Mask</symbol>
-
<symbol>Mod5Mask</symbol>.
<emphasis>affect_virtual</emphasis>
<parameter>affect_virtual</parameter>
and
<emphasis>virtual_values</emphasis>
<parameter>virtual_values</parameter>
are masks of virtual modifier bits indicating which virtual modifiers are to
be added and removed from the server’s internal modifiers control. Modifiers
selected by both
<emphasis>affect_virtual</emphasis>
<parameter>affect_virtual</parameter>
and
<emphasis>virtual_values</emphasis>
<parameter>virtual_values</parameter>
are added to the server’s internal modifiers control; those selected by
<emphasis>affect_virtual</emphasis>
<parameter>affect_virtual</parameter>
but not by
<emphasis>virtual_values</emphasis>
<parameter>virtual_values</parameter>
are removed from the server’s internal modifiers control.
See <link linkend="Virtual_Modifier_Names_and_Masks">section 7.1</link> for a discussion of virtual modifier masks to use in
<emphasis>affect_virtual</emphasis>
<parameter>affect_virtual</parameter>
and
<emphasis>virtual_values</emphasis>.
<parameter>virtual_values</parameter>.
<function>XkbSetServerInternalMods</function>
does not wait for a reply from the server. It returns
<symbol>True</symbol>
@ -4317,7 +4317,7 @@ Use
<funcprototype>
<funcdef>Status <function>XkbGetControls</function></funcdef>
<!-- (
<emphasis>display, which, xkb)</emphasis> -->
<parameter>display, which, xkb)</parameter> -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned long <parameter>which</parameter></paramdef>
@ -4363,41 +4363,41 @@ Use
and then copies the server’s values for the requested information into the
<emphasis>ctrls</emphasis>
structure of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
argument. Only those components specified by the
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter are copied. Valid values for
<emphasis>which</emphasis>
<parameter>which</parameter>
are any combination of the masks listed in
<link linkend="table10.7">Table 10.7</link> that have "ok" in the
<emphasis>which</emphasis>
<parameter>which</parameter>
column.
</para>
<para>
If
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-&gt;
<emphasis>ctrls</emphasis>
is
<emphasis>NULL</emphasis>,
<function>XkbGetControls</function>
allocates and initializes it before obtaining the values specified by
<emphasis>which</emphasis>.
<parameter>which</parameter>.
If
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-&gt;
<emphasis>ctrls</emphasis>
is not
<emphasis>NULL</emphasis>,
<function>XkbGetControls</function>
modifies only those portions of
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-&gt;
<emphasis>ctrls</emphasis>
corresponding to the values specified by
<emphasis>which</emphasis>.
<parameter>which</parameter>.
</para>
@ -4410,11 +4410,11 @@ If
if it cannot obtain sufficient storage,
<errorname>BadMatch</errorname>
if
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
is
<emphasis>NULL</emphasis>
or
<emphasis>which</emphasis>
<parameter>which</parameter>
is empty, or
<errorname>BadImplementation</errorname>.
</para>
@ -4437,7 +4437,7 @@ The
structure is always filled in by
<function>XkbGetControls</function>,
regardless of which bits are selected by
<emphasis>which</emphasis>.
<parameter>which</parameter>.
</para>
@ -4469,7 +4469,7 @@ To change the state of one or more controls, first modify the
<funcprototype>
<funcdef>Bool <function>XkbSetControls</function></funcdef>
<!-- (
<emphasis>display, which, xkb)</emphasis> -->
<parameter>display, which, xkb)</parameter> -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned long <parameter>which</parameter></paramdef>
@ -4511,25 +4511,25 @@ To change the state of one or more controls, first modify the
<para>
For each bit that is set in the
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter,
<function>XkbSetControls</function>
sends the corresponding values from the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-&gt;
<emphasis>ctrls</emphasis>
field to the server. Valid values for
<emphasis>which</emphasis>
<parameter>which</parameter>
are any combination of the masks listed in
<link linkend="table10.7">Table 10.7</link> that have "ok" in the
<emphasis>which</emphasis>
<parameter>which</parameter>
column.
</para>
<para>
If
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-&gt;
<emphasis>ctrls</emphasis>
is
@ -4653,7 +4653,7 @@ match those in the changed keyboard description.
<funcprototype>
<funcdef>Bool <function>XkbChangeControls</function></funcdef>
<!-- (
<emphasis>dpy, xkb, changes</emphasis>
<parameter>dpy, xkb, changes</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -4697,13 +4697,13 @@ match those in the changed keyboard description.
<para>
<function>XkbChangeControls</function>
copies any controls fields specified by
<emphasis>changes</emphasis>
<parameter>changes</parameter>
from the keyboard description controls structure,
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-&gt;
<emphasis>ctrls</emphasis>,
to the server specified by
<emphasis>dpy</emphasis>.
<parameter>dpy</parameter>.
</para>
@ -4862,9 +4862,9 @@ When a client receives an
<funcprototype>
<funcdef>void <function>XkbNoteControlsChanges</function></funcdef>
<!-- (
<emphasis>changes</emphasis>,
<emphasis>new</emphasis>,
<emphasis>wanted</emphasis>
<parameter>changes</parameter>,
<parameter>new</parameter>,
<parameter>wanted</parameter>
) -->
<paramdef>XkbControlsChangesPtr <parameter>changes</parameter></paramdef>
@ -4907,16 +4907,16 @@ When a client receives an
<para>
The
<emphasis>wanted</emphasis>
<parameter>wanted</parameter>
parameter is a bitwise inclusive OR of bits taken from the set of masks
specified in <link linkend="table10.7">Table 10.7</link> with "ok" in the
<emphasis>changed_ctrls</emphasis>
column.
<function>XkbNoteControlsChanges</function>
copies any changes reported in
<emphasis>new</emphasis>
<parameter>new</parameter>
and specified in
<emphasis>wanted</emphasis>
<parameter>wanted</parameter>
into the changes record specified by
<emphasis>old</emphasis>.
</para>
@ -4936,9 +4936,9 @@ noted by one or more calls to
<funcprototype>
<funcdef>Status <function>XkbGetControlsChanges</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>xkb</emphasis>,
<emphasis>changes</emphasis>
<parameter>dpy</parameter>,
<parameter>xkb</parameter>,
<parameter>changes</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -4982,16 +4982,16 @@ noted by one or more calls to
<para>
<function>XkbGetControlsChanges</function>
examines the
<emphasis>changes</emphasis>
<parameter>changes</parameter>
parameter, queries the server for the necessary information, and copies the
results into the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-&gt;
<emphasis>ctrls</emphasis>
keyboard description. If the
<emphasis>ctrls</emphasis>
field of
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
is
<emphasis>NULL</emphasis>,
<function>XkbGetControlsChanges</function>
@ -5038,7 +5038,7 @@ allocate one by calling
<funcprototype>
<funcdef>Status <function>XkbAllocControls</function></funcdef>
<!-- (
<emphasis>xkb, which</emphasis>
<parameter>xkb, which</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -5073,7 +5073,7 @@ allocate one by calling
allocates the
<emphasis>ctrls</emphasis>
field of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter, initializes all fields to zero, and returns
<symbol>Success</symbol>.
If the
@ -5084,7 +5084,7 @@ If the
simply returns
<symbol>Success</symbol>.
If
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
is
<emphasis>NULL</emphasis>,
<function>XkbAllocControls</function>
@ -5100,7 +5100,7 @@ If
<para>
The
<emphasis>which</emphasis>
<parameter>which</parameter>
mask specifies the individual fields of the
<emphasis>ctrls</emphasis>
structure to be allocated and can contain any of the valid masks defined in
@ -5125,7 +5125,7 @@ structure, use
<funcprototype>
<funcdef>void <function>XkbFreeControls</function></funcdef>
<!-- (
<emphasis>xkb, which, free_all</emphasis>
<parameter>xkb, which, free_all</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -5171,13 +5171,13 @@ structure, use
frees the specified components of the
<emphasis>ctrls</emphasis>
field in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
keyboard description and sets the corresponding structure component values to
<emphasis>NULL</emphasis>
or
<emphasis>zero</emphasis>.
The
<emphasis>which</emphasis>
<parameter>which</parameter>
mask specifies the fields of
<emphasis>ctrls</emphasis>
to be freed and can contain any of the controls components specified in
@ -5187,7 +5187,7 @@ The
<para>
If
<emphasis>free_all</emphasis>
<parameter>free_all</parameter>
is
<symbol>True</symbol>,
<function>XkbFreeControls</function>
@ -5198,7 +5198,7 @@ If
structure referenced by the
<emphasis>ctrls</emphasis>
member of
<emphasis>xkb</emphasis>,
<parameter>xkb</parameter>,
and sets
<emphasis>ctrls</emphasis>
to
@ -5235,8 +5235,8 @@ To get the current values of the
<funcprototype>
<funcdef>Bool <function>XkbGetPerClientControls</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>ctrls</emphasis>
<parameter>dpy</parameter>,
<parameter>ctrls</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -5269,7 +5269,7 @@ To get the current values of the
<para>
<function>XkbGetPerClientControls</function>
backfills
<emphasis>ctrls</emphasis>
<parameter>ctrls</parameter>
with the
<emphasis>per-client</emphasis>
control attributes for this particular client. It returns
@ -5293,8 +5293,8 @@ To change the current values of the
<funcprototype>
<funcdef>Bool <function>XkbSetPerClientControls</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>ctrls</emphasis>
<parameter>dpy</parameter>,
<parameter>ctrls</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>

18
specs/XKB/ch11.xml
View file

@ -427,7 +427,7 @@ implemented, use <function>XkbXlibControlsImplemented</function>.
<funcprototype>
<funcdef>unsigned int <function>XkbXlibControlsImplemented</function></funcdef>
<!-- (
<emphasis>display</emphasis>
<parameter>display</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -468,7 +468,7 @@ To determine the current state of the Library Controls, use
<funcprototype>
<funcdef>unsigned int <function>XkbGetXlibControls</function></funcdef>
<!-- (
<emphasis>display</emphasis>
<parameter>display</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -510,7 +510,7 @@ To change the state of the Library Controls, use
<funcprototype>
<funcdef>Bool <function>XkbSetXlibControls</function></funcdef>
<!-- (
<emphasis>display, bits_to_change, values_for_bits</emphasis>
<parameter>display, bits_to_change, values_for_bits</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -554,18 +554,18 @@ To change the state of the Library Controls, use
<para>
<function>XkbSetXlibControls</function>
modifies the state of the controls selected by
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
; only the controls selected by
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
are modified. If the bit corresponding to a control is on in
<emphasis>bits_to_change</emphasis>
<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
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
but off in
<emphasis>values_for_bits</emphasis>,
<parameter>values_for_bits</parameter>,
the control is disabled.
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
should be an inclusive OR of bits from
<link linkend="table11.1">Table 11.1</link>.
</para>

94
specs/XKB/ch12.xml
View file

@ -238,7 +238,7 @@ level, use <function>XkbKeycodeToKeysym</function>.
<funcprototype>
<funcdef>KeySym <function>XkbKeycodeToKeysym</function></funcdef>
<!-- (
<emphasis>dpy, kc, group, level</emphasis>
<parameter>dpy, kc, group, level</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -294,11 +294,11 @@ level, use <function>XkbKeycodeToKeysym</function>.
<function>XkbKeycodeToKeysym</function>
returns the keysym bound to a particular group and shift level for a
particular key on the core keyboard. If
<emphasis>kc</emphasis>
<parameter>kc</parameter>
is not a legal keycode for the core keyboard, or if
<emphasis>group</emphasis>
<parameter>group</parameter>
or
<emphasis>level</emphasis>
<parameter>level</parameter>
are out of range for the specified key,
<function>XkbKeycodeToKeysym</function>
returns
@ -318,8 +318,8 @@ use
<funcprototype>
<funcdef>unsigned int <function>XkbKeysymToModifiers</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>ks</emphasis>
<parameter>dpy</parameter>,
<parameter>ks</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -352,10 +352,10 @@ use
<para>
<function>XkbKeysymToModifiers</function>
finds the set of modifiers currently bound to the keysym
<emphasis>ks</emphasis>
<parameter>ks</parameter>
on the core keyboard. The value returned is the mask of modifiers bound to the
keysym
<emphasis>ks</emphasis>.
<parameter>ks</parameter>.
If no modifiers are bound to the keysym,
<function>XkbKeysymToModifiers</function>
returns zero; otherwise, it returns the inclusive OR of zero or more of the
@ -384,11 +384,11 @@ Use
<funcprototype>
<funcdef>Bool <function>XkbLookupKeySym</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>key</emphasis>,
<emphasis>state</emphasis>,
<emphasis>mods_rtrn</emphasis>,
<emphasis>sym_rtrn</emphasis>
<parameter>dpy</parameter>,
<parameter>key</parameter>,
<parameter>state</parameter>,
<parameter>mods_rtrn</parameter>,
<parameter>sym_rtrn</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -456,16 +456,16 @@ Use
is the equivalent of the core
<symbol>XLookupKeySym</symbol>
function. For the core keyboard, given a keycode
<emphasis>key</emphasis>
<parameter>key</parameter>
and an Xkb state
<emphasis>state</emphasis>,
<parameter>state</parameter>,
<function>XkbLookupKeySym</function>
returns the symbol associated with the key in
<emphasis>sym_rtrn</emphasis>
<parameter>sym_rtrn</parameter>
and the list of modifiers that should still be applied in
<emphasis>mods_rtrn</emphasis>.
<parameter>mods_rtrn</parameter>.
The
<emphasis>state</emphasis>
<parameter>state</parameter>
parameter is the state from a
<symbol>KeyPress</symbol>
or
@ -495,12 +495,12 @@ Use
<funcprototype>
<funcdef>int <function>XkbLookupKeyBinding</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>sym</emphasis>,
<emphasis>state</emphasis>,
<emphasis>buf</emphasis>,
<emphasis>nbytes</emphasis>,
<emphasis>extra_rtrn</emphasis>
<parameter>dpy</parameter>,
<parameter>sym</parameter>,
<parameter>state</parameter>,
<parameter>buf</parameter>,
<parameter>nbytes</parameter>,
<parameter>extra_rtrn</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -581,20 +581,20 @@ returned when the key is pressed and a specified list of modifiers are also
being held down.
<function>XkbLookupKeyBinding</function>
returns in
<emphasis>buf</emphasis>
<parameter>buf</parameter>
the string associated with the keysym
<emphasis>sym</emphasis>
<parameter>sym</parameter>
and modifier state
<emphasis>state</emphasis>.
<emphasis>buf</emphasis>
<parameter>state</parameter>.
<parameter>buf</parameter>
is
<emphasis>NULL</emphasis>
terminated unless there’s an overflow. If the string returned is larger than
<emphasis>nbytes</emphasis>,
<parameter>nbytes</parameter>,
a count of bytes that does not fit into the buffer is returned in extra_rtrn.
<function>XkbTranslateKeySym</function>
returns the number of bytes that it placed into
<emphasis>buf</emphasis>.
<parameter>buf</parameter>.
</para>
@ -610,12 +610,12 @@ state, use
<funcprototype>
<funcdef>int <function>XkbTranslateKeySym</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>sym_inout</emphasis>,
<emphasis>mods</emphasis>,
<emphasis>buf</emphasis>,
<emphasis>nbytes</emphasis>,
<emphasis>extra_rtrn</emphasis>
<parameter>dpy</parameter>,
<parameter>sym_inout</parameter>,
<parameter>mods</parameter>,
<parameter>buf</parameter>,
<parameter>nbytes</parameter>,
<parameter>extra_rtrn</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -692,22 +692,22 @@ state, use
<para>
<function>XkbTranslateKeySym</function>
applies the transformations specified in
<emphasis>mods</emphasis>
<parameter>mods</parameter>
to the symbol specified by
<emphasis>sym_inout</emphasis>.
<parameter>sym_inout</parameter>.
It returns in
<emphasis>buf</emphasis>
<parameter>buf</parameter>
the string, if any, associated with the keysym for the current locale. If the
transformations in
<emphasis>mods</emphasis>
<parameter>mods</parameter>
changes the keysym,
<emphasis>sym_inout</emphasis>
<parameter>sym_inout</parameter>
is updated accordingly. If the string returned is larger than
<emphasis>nbytes</emphasis>,
<parameter>nbytes</parameter>,
a count of bytes that does not fit into the buffer is returned in extra_rtrn.
<function>XkbTranslateKeySym</function>
returns the number of bytes it placed into
<emphasis>buf</emphasis>.
<parameter>buf</parameter>.
</para>
@ -722,7 +722,7 @@ To update the keyboard description that is internal to the X library, use
<funcprototype>
<funcdef>Status <function>XkbRefreshKeyboardMapping</function></funcdef>
<!-- (
<emphasis>event)</emphasis> -->
<parameter>event)</parameter> -->
<paramdef>XkbMapNotifyEvent *<parameter>event</parameter></paramdef>
</funcprototype>
@ -782,7 +782,7 @@ To translate a keycode to a key symbol and modifiers, use
<funcprototype>
<funcdef>Booll <function>XkbTranslateKeyCode</function></funcdef>
<!-- (
<emphasis>xkb, key, mods, mods_rtrn, keysym_rtrn)</emphasis> -->
<parameter>xkb, key, mods, mods_rtrn, keysym_rtrn)</parameter> -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>KeyCode <parameter>key</parameter></paramdef>
@ -845,9 +845,9 @@ To translate a keycode to a key symbol and modifiers, use
</variablelist>
<para>
<emphasis>mods_rtrn</emphasis>
<parameter>mods_rtrn</parameter>
is backfilled with the modifiers consumed by the translation process.
<emphasis>mods</emphasis>
<parameter>mods</parameter>
is a bitwise inclusive OR of the legal modifier masks:
<symbol>ShiftMask</symbol>,
<symbol>LockMask</symbol>,

374
specs/XKB/ch13.xml
View file

@ -1097,8 +1097,8 @@ To load a keyboard geometry if you already have the keyboard description, use
<funcprototype>
<funcdef>Status <function>XkbGetGeometry</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>xkb</emphasis>
<parameter>dpy</parameter>,
<parameter>xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -1155,9 +1155,9 @@ description from this database by name, use
<funcprototype>
<funcdef>Status <function>XkbGetNamedGeometry</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>xkb</emphasis>,
<emphasis>name</emphasis>
<parameter>dpy</parameter>,
<parameter>xkb</parameter>,
<parameter>name</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -1203,7 +1203,7 @@ description from this database by name, use
can return
<errorname>BadName</errorname>
if the
<emphasis>name</emphasis>
<parameter>name</parameter>
cannot be found.
</para>
@ -1247,8 +1247,8 @@ To determine the bounding box of the top surface of a shape, use
<funcprototype>
<funcdef>Bool <function>XkbComputeShapeTop</function></funcdef>
<!-- (
<emphasis>shape</emphasis>,
<emphasis>bounds_rtrn</emphasis>
<parameter>shape</parameter>,
<parameter>bounds_rtrn</parameter>
) -->
<paramdef>XkbShapePtr <parameter>shape</parameter></paramdef>
@ -1287,7 +1287,7 @@ of a rectangle that contains the outline that describes the top surface of the
shape. The top surface is defined to be the approximating outline if the
<emphasis>approx</emphasis>
field of
<emphasis>shape</emphasis>
<parameter>shape</parameter>
is not
<emphasis>NULL</emphasis>.
If
@ -1295,13 +1295,13 @@ If
is
<emphasis>NULL</emphasis>,
the top surface is defined as the last outline in the
<emphasis>shape</emphasis>
<parameter>shape</parameter>
’s array of outlines.
<function>XkbComputeShapeTop</function>
returns
<symbol>False</symbol>
if
<emphasis>shape</emphasis>
<parameter>shape</parameter>
is
<emphasis>NULL</emphasis>
or if there are no outlines for the shape; otherwise, it returns
@ -1325,7 +1325,7 @@ shape, use <function>XkbComputeShapeBounds</function>.
<funcprototype>
<funcdef>Bool <function>XkbComputeShapeBounds</function></funcdef>
<!-- (
<emphasis>shape</emphasis>
<parameter>shape</parameter>
) -->
<paramdef>XkbShapePtr <parameter>shape</parameter></paramdef>
@ -1349,7 +1349,7 @@ shape, use <function>XkbComputeShapeBounds</function>.
updates the
<emphasis>BoundsRec</emphasis>
contained in the
<emphasis>shape</emphasis>
<parameter>shape</parameter>
by examining all the outlines of the shape and setting the
<emphasis>BoundsRec</emphasis>
to the minimum x and minimum y, and maximum x and maximum y values found in
@ -1358,7 +1358,7 @@ those outlines.
returns
<symbol>False</symbol>
if
<emphasis>shape</emphasis>
<parameter>shape</parameter>
is
<emphasis>NULL</emphasis>
or if there are no outlines for the shape; otherwise, it returns
@ -1376,9 +1376,9 @@ To update the bounding box of a row, use <function>XkbComputeRowBounds</function
<funcprototype>
<funcdef>Bool <function>XkbComputeRowBounds</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>section</emphasis>,
<emphasis>row</emphasis>
<parameter>geom</parameter>,
<parameter>section</parameter>,
<parameter>row</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -1422,7 +1422,7 @@ To update the bounding box of a row, use <function>XkbComputeRowBounds</function
<para>
<function>XkbComputeRowBounds</function>
checks the bounds of all keys in the
<emphasis>row </emphasis>
<parameter>row</parameter>
and updates the bounding box of the row if necessary.
<function>XkbComputeRowBounds</function>
returns
@ -1445,8 +1445,8 @@ that section. To update the bounding box of a section, use
<funcprototype>
<funcdef>Bool <function>XkbComputeSectionBounds</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>section</emphasis>
<parameter>geom</parameter>,
<parameter>section</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -1479,7 +1479,7 @@ that section. To update the bounding box of a section, use
<para>
<function>XkbComputeSectionBounds</function>
examines all the rows of the
<emphasis>section</emphasis>
<parameter>section</parameter>
and updates the bounding box of that section so that it contains all rows.
<function>XkbComputeSectionBounds</function>
returns
@ -1502,9 +1502,9 @@ by using the primary name for a key that is part of an overlay, use
<funcprototype>
<funcdef>char *<function>XkbFindOverlayForKey</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>section</emphasis>,
<emphasis>under</emphasis>
<parameter>geom</parameter>,
<parameter>section</parameter>,
<parameter>under</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -1548,7 +1548,7 @@ by using the primary name for a key that is part of an overlay, use
<para>
<function>XkbFindOverlayForKey</function>
uses the primary name of the key,
<emphasis>under</emphasis>,
<parameter>under</parameter>,
to look up the alternate name, which it returns.
</para>
@ -1592,9 +1592,9 @@ To add one property to an existing keyboard geometry description, use
<funcprototype>
<funcdef>XkbPropertyPtr <function>XkbAddGeomProperty</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>name</emphasis>,
<emphasis>value</emphasis>
<parameter>geom</parameter>,
<parameter>name</parameter>,
<parameter>value</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -1638,9 +1638,9 @@ To add one property to an existing keyboard geometry description, use
<para>
<function>XkbAddGeomProperty</function>
adds one property with the specified
<emphasis>name</emphasis>
<parameter>name</parameter>
and
<emphasis>value</emphasis>
<parameter>value</parameter>
to the keyboard geometry specified by geom.
<function>XkbAddGeomProperty</function>
returns
@ -1662,8 +1662,8 @@ To add one key alias to an existing keyboard geometry description, use
<funcprototype>
<funcdef>XkbKeyAliasPtr <function>XkbAddGeomKeyAlias</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>alias, real</emphasis>
<parameter>geom</parameter>,
<parameter>alias, real</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -1728,9 +1728,9 @@ To add one color name to an existing keyboard geometry description, use
<funcprototype>
<funcdef>XkbColorPtr <function>XkbAddGeomColor</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>spec</emphasis>,
<emphasis>pixel</emphasis>
<parameter>geom</parameter>,
<parameter>spec</parameter>,
<parameter>pixel</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -1776,9 +1776,9 @@ To add one color name to an existing keyboard geometry description, use
adds the specified color
<emphasis>name</emphasis>
and
<emphasis>pixel</emphasis>
<parameter>pixel</parameter>
to the specified geometry
<emphasis>geom</emphasis>.
<parameter>geom</parameter>.
The top-level geometry description includes a list of up to
<emphasis>MaxColors</emphasis>
(32)
@ -1786,7 +1786,7 @@ The top-level geometry description includes a list of up to
A color
<emphasis>name</emphasis>
is a string whose interpretation is not specified by Xkb and neither is the
<emphasis>pixel</emphasis>
<parameter>pixel</parameter>
value’s interpretation. All other geometry data structures refer to colors
using their indices in this global list or pointers to colors in this list.
<function>XkbAddGeomColor</function>
@ -1809,8 +1809,8 @@ To add one outline to an existing shape, use
<funcprototype>
<funcdef>XkbOutlinePtr <function>XkbAddGeomOutline</function></funcdef>
<!-- (
<emphasis>shape</emphasis>,
<emphasis>sz_points</emphasis>
<parameter>shape</parameter>,
<parameter>sz_points</parameter>
) -->
<paramdef>XkbShapePtr <parameter>shape</parameter></paramdef>
@ -1844,9 +1844,9 @@ To add one outline to an existing shape, use
An outline consists of an arbitrary number of points.
<function>XkbAddGeomOutline</function>
adds an outline to the specified
<emphasis>shape</emphasis>
<parameter>shape</parameter>
by reserving
<emphasis>sz_points</emphasis>
<parameter>sz_points</parameter>
points for it. The new outline is allocated and zeroed.
<function>XkbAddGeomOutline</function>
returns
@ -1868,9 +1868,9 @@ To add a shape to a keyboard geometry, use
<funcprototype>
<funcdef>XkbShapePtr <function>XkbAddGeomShape</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>name</emphasis>,
<emphasis>sz_outlines</emphasis>
<parameter>geom</parameter>,
<parameter>name</parameter>,
<parameter>sz_outlines</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -1916,11 +1916,11 @@ A geometry contains an arbitrary number of shapes, each of which is made up of
an arbitrary number of outlines.
<function>XkbAddGeomShape</function>
adds a shape to a geometry
<emphasis>geom</emphasis>
<parameter>geom</parameter>
by allocating space for
<emphasis>sz_outlines</emphasis>
<parameter>sz_outlines</parameter>
outlines for it and giving it the name specified by name. If a shape with name
<emphasis>name</emphasis>
<parameter>name</parameter>
already exists in the geometry, a pointer to the existing shape is returned.
<function>XkbAddGeomShape</function>
returns
@ -1942,7 +1942,7 @@ To add one key at the end of an existing row of keys, use
<funcprototype>
<funcdef>XkbKeyPtr <function>XkbAddGeomKey</function></funcdef>
<!-- (
<emphasis>row</emphasis>
<parameter>row</parameter>
) -->
<paramdef>XkbRowPtr <parameter>row</parameter></paramdef>
@ -1965,13 +1965,13 @@ To add one key at the end of an existing row of keys, use
Keys are grouped into rows.
<function>XkbAddGeomKey</function>
adds one key to the end of the specified
<emphasis>row</emphasis>.
<parameter>row</parameter>.
The key is allocated and zeroed.
<function>XkbAddGeomKey</function>
returns
<emphasis>NULL</emphasis>
if
<emphasis>row</emphasis>
<parameter>row</parameter>
is empty or if it was not able to allocate space for the key. To allocate
space for an arbitrary number of keys to a row, use XkbAllocGeomKeys.
</para>
@ -1988,11 +1988,11 @@ To add one section to an existing keyboard geometry, use
<funcprototype>
<funcdef>XkbSectionPtr <function>XkbAddGeomSection</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>name</emphasis>,
<emphasis>sz_rows</emphasis>,
<emphasis>sz_doodads</emphasis>,
<emphasis>sz_overlays</emphasis>
<parameter>geom</parameter>,
<parameter>name</parameter>,
<parameter>sz_rows</parameter>,
<parameter>sz_doodads</parameter>,
<parameter>sz_overlays</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -2059,17 +2059,17 @@ To add one section to an existing keyboard geometry, use
A keyboard geometry contains an arbitrary number of sections.
<function>XkbAddGeomSection</function>
adds one section to an existing keyboard geometry
<emphasis>geom</emphasis>.
<parameter>geom</parameter>.
The new section contains space for the number of rows, doodads, and overlays
specified by
<emphasis>sz_rows</emphasis>,
<emphasis>sz_doodads</emphasis>,
<parameter>sz_rows</parameter>,
<parameter>sz_doodads</parameter>,
and
<emphasis>sz_overlays</emphasis>.
<parameter>sz_overlays</parameter>.
The new section is allocated and zeroed and given the name specified by
<emphasis>name</emphasis>.
<parameter>name</parameter>.
If a section with name
<emphasis>name</emphasis>
<parameter>name</parameter>
already exists in the geometry, a pointer to the existing section is
returned.
<function>XkbAddGeomSection</function>
@ -2092,8 +2092,8 @@ To add a row to a section, use
<funcprototype>
<funcdef>XkbRowPtr <function>XkbAddGeomRow</function></funcdef>
<!-- (
<emphasis>section</emphasis>,
<emphasis>sz_keys</emphasis>
<parameter>section</parameter>,
<parameter>sz_keys</parameter>
) -->
<paramdef>XkbSectionPtr <parameter>section</parameter></paramdef>
@ -2128,9 +2128,9 @@ One of the components of a keyboard geometry section is one or more rows of
keys.
<function>XkbAddGeomRow</function>
adds one row to the specified
<emphasis>section</emphasis>.
<parameter>section</parameter>.
The newly created row contains space for the number of keys specified in
<emphasis>sz_keys</emphasis>.
<parameter>sz_keys</parameter>.
They are allocated and zeroed, but otherwise uninitialized.
<function>XkbAddGeomRow</function>
returns
@ -2153,9 +2153,9 @@ geometry, use
<funcprototype>
<funcdef>XkbDoodadPtr <function>XkbAddGeomDoodad</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>section</emphasis>,
<emphasis>name</emphasis>
<parameter>geom</parameter>,
<parameter>section</parameter>,
<parameter>name</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -2203,11 +2203,11 @@ A
section.
<function>XkbAddGeomDoodad</function>
adds a doodad with name specified by name to the geometry
<emphasis>geom</emphasis>
<parameter>geom</parameter>
if section is
<emphasis>NULL</emphasis>
or to the section of the geometry specified by section if
<emphasis>section</emphasis>
<parameter>section</parameter>
is not
<emphasis>NULL</emphasis>.
<function>XkbAddGeomDoodad</function>
@ -2215,13 +2215,13 @@ section.
<emphasis>NULL</emphasis>
if any of the parameters is empty or if it was not able to allocate space for
the doodad. If there is already a doodad with the name
<emphasis>name</emphasis>
<parameter>name</parameter>
in the doodad array for the geometry (if
<emphasis>section</emphasis>
<parameter>section</parameter>
is
<emphasis>NULL</emphasis>
) or the section (if
<emphasis>section</emphasis>
<parameter>section</parameter>
is non-
<emphasis>NULL</emphasis>
), a pointer to that doodad is returned. To allocate space for an arbitrary
@ -2242,9 +2242,9 @@ To add one overlay to a section, use
<funcprototype>
<funcdef>XkbOverlayPtr <function>XkbAddGeomOverlay</function></funcdef>
<!-- (
<emphasis>section</emphasis>,
<emphasis>name</emphasis>,
<emphasis>sz_rows</emphasis>
<parameter>section</parameter>,
<parameter>name</parameter>,
<parameter>sz_rows</parameter>
) -->
<paramdef>XkbSectionPtr <parameter>section</parameter></paramdef>
@ -2288,10 +2288,10 @@ To add one overlay to a section, use
<para>
<function>XkbAddGeomOverlay</function>
adds an overlay with the specified name to the specified
<emphasis>section</emphasis>.
<parameter>section</parameter>.
The new overlay is created with space allocated for sz_rows rows. If an
overlay with name
<emphasis>name</emphasis>
<parameter>name</parameter>
already exists in the section, a pointer to the existing overlay is
returned.
<function>XkbAddGeomOverlay</function>
@ -2314,8 +2314,8 @@ To add a row to an existing overlay, use
<funcprototype>
<funcdef>XkbOverlayRowPtr <function>XkbAddGeomOverlayRow</function></funcdef>
<!-- (
<emphasis>overlay</emphasis>,
<emphasis>row_under, sz_keys</emphasis>
<parameter>overlay</parameter>,
<parameter>row_under, sz_keys</parameter>
) -->
<paramdef>XkbOverlayPtr <parameter>overlay</parameter></paramdef>
@ -2360,11 +2360,11 @@ To add a row to an existing overlay, use
<para>
<function>XkbAddGeomOverlayRow</function>
adds one row to the
<emphasis>overlay</emphasis>.
<parameter>overlay</parameter>.
The new row contains space for
<emphasis>sz_keys</emphasis>
<parameter>sz_keys</parameter>
keys. If
<emphasis>row_under</emphasis>
<parameter>row_under</parameter>
specifies a row that doesn’t exist on the underlying section,
<function>XkbAddGeomOverlayRow</function>
returns
@ -2389,8 +2389,8 @@ To add a key to an existing overlay row, use
<funcprototype>
<funcdef>XkbOverlayKeyPtr <function>XkbAddGeomOverlayKey</function></funcdef>
<!-- (
<emphasis>overlay</emphasis>,
<emphasis>row, under</emphasis>
<parameter>overlay</parameter>,
<parameter>row, under</parameter>
) -->
<paramdef>XkbOverlayPtr <parameter>overlay</parameter></paramdef>
@ -2434,11 +2434,11 @@ To add a key to an existing overlay row, use
<para>
<function>XkbAddGeomOverlayKey</function>
adds one key to the
<emphasis>row</emphasis>
<parameter>row</parameter>
in the
<emphasis>overlay</emphasis>.
<parameter>overlay</parameter>.
If there is no key named
<emphasis>under</emphasis>
<parameter>under</parameter>
in the row of the underlying section,
<function>XkbAddGeomOverlayKey</function>
returns
@ -2487,8 +2487,8 @@ XkbAllocGeomOutlines.
<funcprototype>
<funcdef>Status <function>XkbAllocGeomOutlines</function></funcdef>
<!-- (
<emphasis>shape</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>shape</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbShapePtr <parameter>shape</parameter></paramdef>
@ -2521,9 +2521,9 @@ XkbAllocGeomOutlines.
<para>
<function>XkbAllocGeomOutlines</function>
allocates space for
<emphasis>num_needed</emphasis>
<parameter>num_needed</parameter>
outlines in the specified
<emphasis>shape</emphasis>.
<parameter>shape</parameter>.
The outlines are not initialized.
</para>
@ -2539,10 +2539,10 @@ To free geometry outlines, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomOutlines</function></funcdef>
<!-- (
<emphasis>shape</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>shape</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbShapePtr <parameter>shape</parameter></paramdef>
@ -2613,8 +2613,8 @@ XkbAllocGeomKeys.
<funcprototype>
<funcdef>Status <function>XkbAllocGeomKeys</function></funcdef>
<!-- (
<emphasis>row</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>row</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbRowPtr <parameter>row</parameter></paramdef>
@ -2662,10 +2662,10 @@ To free geometry keys, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomKeys</function></funcdef>
<!-- (
<emphasis>row</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>row</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbRowPtr <parameter>row</parameter></paramdef>
@ -2736,8 +2736,8 @@ To allocate geometry properties, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomProps</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>geom</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -2771,7 +2771,7 @@ To allocate geometry properties, use
<function>XkbAllocGeomProps</function>
allocates space for num_needed properties and adds them to the specified
geometry
<emphasis>geom</emphasis>.
<parameter>geom</parameter>.
No initialization of the properties is done. A geometry property associates
an arbitrary string with an equally arbitrary name. Geometry properties can be
used to provide hints to programs that display images of keyboards, but they
@ -2791,10 +2791,10 @@ To free geometry properties, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomProperties</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>geom</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -2865,8 +2865,8 @@ To allocate geometry key aliases, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomKeyAliases</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>geom</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -2900,7 +2900,7 @@ To allocate geometry key aliases, use
<function>XkbAllocGeomKeyAliases</function>
allocates space for num_needed key aliases and adds them to the specified
geometry
<emphasis>geom</emphasis>.
<parameter>geom</parameter>.
A key alias is a pair of strings that associates an alternate name for a key
with the real name for that key.
</para>
@ -2917,10 +2917,10 @@ To free geometry key aliases, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomKeyAliases</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>geom</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -2976,10 +2976,10 @@ To free geometry key aliases, use
If free_all is
<symbol>True</symbol>,
all aliases in the top level of the specified geometry
<emphasis>geom</emphasis>
<parameter>geom</parameter>
are freed regardless of the value of first or count. Otherwise, count aliases
in
<emphasis>geom</emphasis>
<parameter>geom</parameter>
are freed beginning with the one specified by first.
</para>
@ -2995,8 +2995,8 @@ To allocate geometry colors, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomColors</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>geom</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -3029,7 +3029,7 @@ To allocate geometry colors, use
<para>
<function>XkbAllocGeomColors</function>
allocates space for num_needed colors and adds them to the specified geometry
<emphasis>geom</emphasis>.
<parameter>geom</parameter>.
A color name is a string whose interpretation is not specified by Xkb. All
other geometry data structures refer to colors using their indices in this
global list or pointers to colors in this list.
@ -3047,10 +3047,10 @@ To free geometry colors, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomColors</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>geom</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -3121,8 +3121,8 @@ To allocate points in an outline, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomPoints</function></funcdef>
<!-- (
<emphasis>outline</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>outline</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbOutlinePtr <parameter>outline</parameter></paramdef>
@ -3155,9 +3155,9 @@ To allocate points in an outline, use
<para>
<function>XkbAllocGeomPoints</function>
allocates space for
<emphasis>num_needed</emphasis>
<parameter>num_needed</parameter>
points in the specified
<emphasis>outline</emphasis>.
<parameter>outline</parameter>.
The points are not initialized.
</para>
@ -3173,10 +3173,10 @@ To free points in a outline, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomPoints</function></funcdef>
<!-- (
<emphasis>outline</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>outline</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbOutlinePtr <parameter>outline</parameter></paramdef>
@ -3248,8 +3248,8 @@ To allocate space for an arbitrary number of geometry shapes, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomShapes</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>geom</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -3282,9 +3282,9 @@ To allocate space for an arbitrary number of geometry shapes, use
<para>
<function>XkbAllocGeomShapes</function>
allocates space for
<emphasis>num_needed</emphasis>
<parameter>num_needed</parameter>
shapes in the specified geometry
<emphasis>geom</emphasis>.
<parameter>geom</parameter>.
The shapes are not initialized.
</para>
@ -3300,10 +3300,10 @@ To free geometry shapes, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomShapes</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>f ree_all</emphasis>
<parameter>geom</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>f ree_all</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -3375,8 +3375,8 @@ To allocate geometry sections, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomSections</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>geom</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -3424,10 +3424,10 @@ To free geometry sections, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomSections</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>geom</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -3499,8 +3499,8 @@ To allocate rows in a section, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomRows</function></funcdef>
<!-- (
<emphasis>section</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>section</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbSectionPtr <parameter>section</parameter></paramdef>
@ -3548,10 +3548,10 @@ To free rows in a section, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomRows</function></funcdef>
<!-- (
<emphasis>section</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>section</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbSectionPtr <parameter>section</parameter></paramdef>
@ -3623,8 +3623,8 @@ To allocate overlays in a section, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomOverlays</function></funcdef>
<!-- (
<emphasis>section</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>section</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbSectionPtr <parameter>section</parameter></paramdef>
@ -3672,10 +3672,10 @@ To free rows in an section, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomOverlays</function></funcdef>
<!-- (
<emphasis>section</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>section</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbSectionPtr <parameter>section</parameter></paramdef>
@ -3747,8 +3747,8 @@ To allocate rows in a overlay, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomOverlayRows</function></funcdef>
<!-- (
<emphasis>overlay</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>overlay</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbSectionPtr <parameter>overlay</parameter></paramdef>
@ -3796,10 +3796,10 @@ To free rows in an overlay, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomOverlayRows</function></funcdef>
<!-- (
<emphasis>overlay</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>overlay</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbSectionPtr <parameter>overlay</parameter></paramdef>
@ -3871,8 +3871,8 @@ To allocate keys in an overlay row, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomOverlayKeys</function></funcdef>
<!-- (
<emphasis>row</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>row</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbRowPtr <parameter>row</parameter></paramdef>
@ -3920,10 +3920,10 @@ To free keys in an overlay row, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomOverlayKeys</function></funcdef>
<!-- (
<emphasis>row</emphasis>,
<emphasis>first</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>row</parameter>,
<parameter>first</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbRowPtr <parameter>row</parameter></paramdef>
@ -3995,8 +3995,8 @@ To allocate doodads that are global to a keyboard geometry, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomDoodads</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>geom</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>
@ -4029,7 +4029,7 @@ To allocate doodads that are global to a keyboard geometry, use
<para>
<function>XkbAllocGeomDoodads</function>
allocates num_needed doodads and adds them to the specified geometry
<emphasis>geom</emphasis>.
<parameter>geom</parameter>.
No initialization of the doodads is done.
</para>
@ -4045,8 +4045,8 @@ To allocate doodads that are specific to a section, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeomSectionDoodads</function></funcdef>
<!-- (
<emphasis>section</emphasis>,
<emphasis>num_needed</emphasis>
<parameter>section</parameter>,
<parameter>num_needed</parameter>
) -->
<paramdef>XkbSectionPtr <parameter>section</parameter></paramdef>
@ -4079,7 +4079,7 @@ To allocate doodads that are specific to a section, use
<para>
<function>XkbAllocGeomSectionDoodads</function>
allocates num_needed doodads and adds them to the specified
<emphasis>section</emphasis>.
<parameter>section</parameter>.
No initialization of the doodads is done.
</para>
@ -4095,9 +4095,9 @@ To free geometry doodads, use
<funcprototype>
<funcdef>void <function>XkbFreeGeomDoodads</function></funcdef>
<!-- (
<emphasis>doodads</emphasis>,
<emphasis>count</emphasis>,
<emphasis>free_all</emphasis>
<parameter>doodads</parameter>,
<parameter>count</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbDoodadPtr <parameter>doodads</parameter></paramdef>
@ -4140,7 +4140,7 @@ To free geometry doodads, use
<para>
If
<emphasis>free_all</emphasis>
<parameter>free_all</parameter>
is
<symbol>True</symbol>,
all doodads in the array are freed, regardless of the value of count.
@ -4159,8 +4159,8 @@ To allocate an entire geometry, use
<funcprototype>
<funcdef>Status <function>XkbAllocGeometry</function></funcdef>
<!-- (
<emphasis>xkb</emphasis>,
<emphasis>sizes</emphasis>
<parameter>xkb</parameter>,
<parameter>sizes</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -4212,9 +4212,9 @@ To free an entire geometry, use
<funcprototype>
<funcdef>void <function>XkbFreeGeometry</function></funcdef>
<!-- (
<emphasis>geom</emphasis>,
<emphasis>which</emphasis>,
<emphasis>free_all</emphasis>
<parameter>geom</parameter>,
<parameter>which</parameter>,
<parameter>free_all</parameter>
) -->
<paramdef>XkbGeometryPtr <parameter>geom</parameter></paramdef>

122
specs/XKB/ch14.xml
View file

@ -252,7 +252,7 @@ populated.
<funcprototype>
<funcdef>XkbDescPtr <function>XkbGetMap</function></funcdef>
<!-- (
<emphasis>display, which, device_spec</emphasis>
<parameter>display, which, device_spec</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -295,12 +295,12 @@ populated.
<para>
The
<emphasis>which</emphasis>
<parameter>which</parameter>
mask is a bitwise inclusive OR of the masks defined in
<link linkend="table14.1">Table 14.1</link>. Only those
portions of the keyboard server map and the keyboard client maps that are
specified in
<emphasis>which</emphasis>
<parameter>which</parameter>
are allocated and populated.
</para>
@ -309,7 +309,7 @@ specified in
In addition to allocating and obtaining the server map and the client map,
<function>XkbGetMap</function>
also sets the
<emphasis>device_spec</emphasis>,
<parameter>device_spec</parameter>,
the
<emphasis>min_key_code</emphasis>,
and
@ -336,7 +336,7 @@ When unsuccessful, one of the following protocol errors is also generated:
structure),
<errorname>BadValue</errorname>
(some mask bits in
<emphasis>which</emphasis>
<parameter>which</parameter>
are undefined),
or
<errorname>BadImplementation</errorname>
@ -501,7 +501,7 @@ description, use <function>XkbGetUpdatedMap</function>.
<funcprototype>
<funcdef>Status <function>XkbGetUpdatedMap</function></funcdef>
<!-- (
<emphasis>display, which, xkb</emphasis>
<parameter>display, which, xkb</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -544,11 +544,11 @@ description, use <function>XkbGetUpdatedMap</function>.
<para>
The
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter is a bitwise inclusive OR of the masks in
<link linkend="table14.1">Table 14.1</link>.
If the needed components of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
structure are not already allocated,
<function>XkbGetUpdatedMap</function>
allocates them.
@ -556,7 +556,7 @@ If the needed components of the
fetches the requested information for the device specified in the
<emphasis>XkbDescRec</emphasis>
passed in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter.
</para>
@ -577,7 +577,7 @@ If unsuccessful,
structure),
<errorname>BadValue</errorname>
(some mask bits in
<emphasis>which</emphasis>
<parameter>which</parameter>
are undefined),
<errorname>BadImplementation</errorname>
(a compatible version of the Xkb extension is not available in the server or
@ -603,9 +603,9 @@ an
<funcprototype>
<funcdef>Bool <function>XkbSetMap</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>which</emphasis>,
<emphasis>xkb</emphasis>
<parameter>dpy</parameter>,
<parameter>which</parameter>,
<parameter>xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -651,29 +651,29 @@ Use
<function>XkbSetMap</function>
to send a complete new set of values for entire components (for example, all
symbols, all actions, and so on) to the server. The
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter specifies the components to be sent to the server, and is a bitwise
inclusive OR of the masks listed in
<link linkend="table14.1">Table 14.1</link>. The
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter is a pointer to an
<emphasis>XkbDescRec</emphasis>
structure and contains the information to be copied to the server. For each
bit set in the
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter,
<function>XkbSetMap</function>
takes the corresponding structure values from the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter and sends it to the server specified by
<emphasis>dpy</emphasis>.
<parameter>dpy</parameter>.
</para>
<para>
If any components specified by
<emphasis>which</emphasis>
<parameter>which</parameter>
are not present in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter,
<function>XkbSetMap</function>
returns
@ -887,9 +887,9 @@ keyboard description, then call
<funcprototype>
<funcdef>Bool <function>XkbChangeMap</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>xkb</emphasis>,
<emphasis>changes</emphasis>
<parameter>dpy</parameter>,
<parameter>xkb</parameter>,
<parameter>changes</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -933,19 +933,19 @@ keyboard description, then call
<para>
<function>XkbChangeMap</function>
copies any components specified by the
<emphasis>changes</emphasis>
<parameter>changes</parameter>
structure from the keyboard description,
<emphasis>xkb</emphasis>,
<parameter>xkb</parameter>,
to the X server specified by
<emphasis>dpy</emphasis>.
<parameter>dpy</parameter>.
</para>
<para>
If any components specified by
<emphasis>changes</emphasis>
<parameter>changes</parameter>
are not present in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter,
<function>XkbChangeMap</function>
returns
@ -1118,7 +1118,7 @@ To allocate and initialize an empty client map description record, use
<funcprototype>
<funcdef>Status <function>XkbAllocClientMap</function></funcdef>
<!-- (
<emphasis>xkb, which, type_count</emphasis>
<parameter>xkb, which, type_count</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1164,9 +1164,9 @@ To allocate and initialize an empty client map description record, use
allocates and initializes an empty client map in the
<emphasis>map</emphasis>
field of the keyboard description specified by
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
The
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter specifies the particular components of the client map structure to
allocate and is a mask composed by a bitwise inclusive OR of one or more of the
masks shown in <link linkend="table14.3">Table 14.3</link>.
@ -1189,11 +1189,11 @@ masks shown in <link linkend="table14.3">Table 14.3</link>.
<entry>XkbKeyTypesMask</entry>
<entry>
The
<emphasis>type_count </emphasis>
<parameter>type_count</parameter>
field specifies the number of entries to preallocate for the
<emphasis>types</emphasis>
field of the client map. If the
<emphasis>type_count </emphasis>
<parameter>type_count</parameter>
field is less than
<emphasis>XkbNumRequiredTypes</emphasis>
(see <link linkend="The_Canonical_Key_Types">section 15.2.1</link>), returns
@ -1208,7 +1208,7 @@ The
and
<emphasis>max_key_code</emphasis>
fields of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter are used to allocate the
<emphasis>syms</emphasis>
and
@ -1229,7 +1229,7 @@ The
and
<emphasis>max_key_code</emphasis>
fields of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter are used to allocate the
<emphasis>modmap</emphasis>
field of the client map. The field is allocated to contain the maximum number
@ -1249,13 +1249,13 @@ of entries necessary for
and
<emphasis>max_key_code</emphasis>
fields of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter must be legal values if the
<emphasis>XkbKeySymsMask</emphasis>
or
<emphasis>XkbModifierMapMask</emphasis>
masks are set in the
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter. If they are not valid,
<function>XkbAllocClientMap</function>
returns
@ -1271,7 +1271,7 @@ and any fields are already allocated in the client map,
request. The only exception is the
<emphasis>types</emphasis>
array. If
<emphasis>type_count</emphasis>
<parameter>type_count</parameter>
is greater than the current
<emphasis>num_types</emphasis>
field of the client map,
@ -1314,7 +1314,7 @@ To free memory used by the client map member of an
<funcprototype>
<funcdef>void <function>XkbFreeClientMap</function></funcdef>
<!-- (
<emphasis>xkb, which, free_all</emphasis>
<parameter>xkb, which, free_all</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1359,15 +1359,15 @@ To free memory used by the client map member of an
<para>
<function>XkbFreeClientMap</function>
frees the components of client map specified by
<emphasis>which</emphasis>
<parameter>which</parameter>
in the
<emphasis>XkbDescRec</emphasis>
structure specified by the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter and sets the corresponding structure component values to
<emphasis>NULL</emphasis>.
The
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter specifies a combination of the client map masks shown in
<link linkend="table14.3">Table 14.3</link>.
</para>
@ -1375,10 +1375,10 @@ The
<para>
If
<emphasis>free_all</emphasis>
<parameter>free_all</parameter>
is
<symbol>True</symbol>,
<emphasis>which</emphasis>
<parameter>which</parameter>
is ignored;
<function>XkbFreeClientMap</function>
frees every non-
@ -1388,7 +1388,7 @@ If
structure referenced by the
<emphasis>map</emphasis>
member of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter, and sets the
<emphasis>map</emphasis>
member to
@ -1410,7 +1410,7 @@ To allocate and initialize an empty server map description record, use
<funcprototype>
<funcdef>Status <function>XkbAllocServerMap</function></funcdef>
<!-- (
<emphasis>xkb, which, count_acts</emphasis>
<parameter>xkb, which, count_acts</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1456,9 +1456,9 @@ To allocate and initialize an empty server map description record, use
allocates and initializes an empty server map in the
<emphasis>server</emphasis>
field of the keyboard description specified by
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
The
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter specifies the particular components of the server map structure to
allocate, as specified in <link linkend="table14.4">Table 14.4</link>.
</para>
@ -1484,7 +1484,7 @@ The
and
<emphasis>max_key_code</emphasis>
fields of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter are used to allocate the
<emphasis>explicit</emphasis>
field of the server map.
@ -1498,11 +1498,11 @@ The
and
<emphasis>max_key_code</emphasis>
fields of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter are used to allocate the
<emphasis>key_acts</emphasis>
field of the server map. The
<emphasis>count_acts</emphasis>
<parameter>count_acts</parameter>
parameter is used to allocate the
<emphasis>acts</emphasis>
field of the server map.
@ -1516,7 +1516,7 @@ The
and
<emphasis>max_key_code</emphasis>
fields of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter are used to allocate the
<emphasis>behaviors</emphasis>
field of the server map.
@ -1530,7 +1530,7 @@ The
and
<emphasis>max_key_code</emphasis>
fields of the
<emphasis>xkb </emphasis>
<parameter>xkb</parameter>
parameter are used to allocate the
<emphasis>vmodmap</emphasis>
field of the server map.
@ -1545,7 +1545,7 @@ field of the server map.
and
<emphasis>max_key_code</emphasis>
fields of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter must be legal values. If they are not valid,
<function>XkbAllocServerMap</function>
returns
@ -1560,7 +1560,7 @@ If the server map of the keyboard description is not
does not overwrite the existing values. The only exception is with the
<emphasis>acts</emphasis>
array. If the
<emphasis>count_acts </emphasis>
<parameter>count_acts</parameter>
parameter is greater than the current
<emphasis>num_acts</emphasis>
field of the server map,
@ -1602,7 +1602,7 @@ To free memory used by the server member of an
<funcprototype>
<funcdef>void <function>XkbFreeServerMap</function></funcdef>
<!-- (
<emphasis>xkb, which, free_all</emphasis>
<parameter>xkb, which, free_all</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1650,18 +1650,18 @@ The
function frees the specified components of server map in the
<emphasis>XkbDescRec</emphasis>
structure specified by the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter and sets the corresponding structure component values to
<emphasis>NULL</emphasis>.
The
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter specifies a combination of the server map masks and is a bitwise
inclusive OR of the masks listed in
<link linkend="table14.4">Table 14.4</link>. If
<emphasis>free_all</emphasis>
<parameter>free_all</parameter>
is
<symbol>True</symbol>,
<emphasis>which</emphasis>
<parameter>which</parameter>
is ignored and
<function>XkbFreeServerMap</function>
frees every non-
@ -1671,7 +1671,7 @@ inclusive OR of the masks listed in
structure referenced by the
<emphasis>server</emphasis>
member of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter, and sets the
<emphasis>server</emphasis>
member to

262
specs/XKB/ch15.xml
View file

@ -644,7 +644,7 @@ default values, use
<funcprototype>
<funcdef>Status <function>XkbInitCanonicalKeyTypes</function></funcdef>
<!-- (
<emphasis>xkb, which, keypadVMod</emphasis>
<parameter>xkb, which, keypadVMod</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -690,9 +690,9 @@ default values, use
initializes the first
<emphasis>XkbNumRequiredTypes</emphasis>
key types of the keyboard specified by the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter to their default values. The
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter specifies what canonical key types to initialize and is a bitwise
inclusive OR of the following masks:
<emphasis>XkbOneLevelMask</emphasis>,
@ -701,7 +701,7 @@ inclusive OR of the following masks:
and
<emphasis>XkbKeypadMask</emphasis>.
Only those canonical types specified by the
<emphasis>which</emphasis>
<parameter>which</parameter>
mask are initialized.
</para>
@ -710,7 +710,7 @@ Only those canonical types specified by the
If
<emphasis>XkbKeypadMask</emphasis>
is set in the
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter,
<function>XkbInitCanonicalKeyTypes</function>
looks up the
@ -731,7 +731,7 @@ initializing the KEYPAD key type. If the
if the Xkb extension has not been properly initialized, and
<errorname>BadAccess</errorname>
if the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter is not valid.
</para>
@ -753,10 +753,10 @@ use
<funcprototype>
<funcdef>Status <function>XkbGetKeyTypes</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>first</emphasis>,
<emphasis>num</emphasis>,
<emphasis>xkb</emphasis>
<parameter>dpy</parameter>,
<parameter>first</parameter>,
<parameter>num</parameter>,
<parameter>xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -831,9 +831,9 @@ If successful, it returns Success.
if the Xkb extension has not been properly initialized and
<errorname>BadValue</errorname>
if the combination of
<emphasis>first</emphasis>
<parameter>first</parameter>
and
<emphasis>num</emphasis>
<parameter>num</parameter>
results in numbers out of valid range.
</para>
@ -852,11 +852,11 @@ To change the number of levels in a key type, use
<funcprototype>
<funcdef>Status <function>XkbResizeKeyType</function></funcdef>
<!-- (
<emphasis>xkb</emphasis>,
<emphasis>type_ndx</emphasis>,
<emphasis>map_count</emphasis>,
<emphasis>want_preserve</emphasis>,
<emphasis>new_num_lvls</emphasis>
<parameter>xkb</parameter>,
<parameter>type_ndx</parameter>,
<parameter>map_count</parameter>,
<parameter>want_preserve</parameter>,
<parameter>new_num_lvls</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -923,16 +923,16 @@ To change the number of levels in a key type, use
<para>
<function>XkbResizeKeyType</function>
changes the type specified by
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-&gt;
<emphasis>map-&gt;types</emphasis>
[
<emphasis>type_ndx</emphasis>
<parameter>type_ndx</parameter>
], and reallocates the symbols and actions bound to all keys that use the type,
if necessary.
<function>XkbResizeKeyType</function>
updates only the local copy of the types in
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
; to update the server’s copy for the physical device, use
<function>XkbSetMap</function>
or
@ -944,10 +944,10 @@ if necessary.
<para>
The
<emphasis>map_count</emphasis>
<parameter>map_count</parameter>
parameter specifies the total number of map entries needed for the type, and
can be zero or greater. If
<emphasis>map_count</emphasis>
<parameter>map_count</parameter>
is zero,
<function>XkbResizeKeyType</function>
frees the existing
@ -961,19 +961,19 @@ can be zero or greater. If
<para>
The
<emphasis>want_preserve</emphasis>
<parameter>want_preserve</parameter>
parameter specifies whether a
<emphasis>preserve</emphasis>
list for the key should be created. If
<emphasis>want_preserve</emphasis>
<parameter>want_preserve</parameter>
is
<symbol>True</symbol>,
the
<emphasis>preserve</emphasis>
list with
<emphasis>map_count</emphasis>
<parameter>map_count</parameter>
entries is allocated or reallocated if it already exists. Otherwise, if
<emphasis>want_preserve</emphasis>
<parameter>want_preserve</parameter>
is
<symbol>False</symbol>,
the
@ -985,7 +985,7 @@ the
<para>
The
<emphasis>new_num_lvls</emphasis>
<parameter>new_num_lvls</parameter>
parameter specifies the new maximum number of shift levels for the type and is
used to calculate and resize the symbols and actions bound to all keys that use
the type.
@ -994,11 +994,11 @@ the type.
<para>
If
<emphasis>type_ndx</emphasis>
<parameter>type_ndx</parameter>
does not specify a legal type,
<emphasis>new_num_lvls</emphasis>
<parameter>new_num_lvls</parameter>
is less than 1, or the
<emphasis>map_count</emphasis>
<parameter>map_count</parameter>
is less than zero,
<function>XkbResizeKeyType</function>
returns
@ -1031,8 +1031,8 @@ Use
<funcprototype>
<funcdef>Status <function>XkbCopyKeyType</function></funcdef>
<!-- (
<emphasis>from</emphasis>,
<emphasis>into</emphasis>
<parameter>from</parameter>,
<parameter>into</parameter>
) -->
<paramdef>XkbKeyTypePtr <parameter>from</parameter></paramdef>
@ -1065,15 +1065,15 @@ Use
<para>
<function>XkbCopyKeyType</function>
copies the key type specified by
<emphasis>from</emphasis>
<parameter>from</parameter>
to the key type specified by
<emphasis>into</emphasis>.
<parameter>into</parameter>.
Both must point to legal
<emphasis>XkbKeyTypeRec</emphasis>
structures. Xkb assumes
<emphasis>from</emphasis>
<parameter>from</parameter>
and
<emphasis>into</emphasis>
<parameter>into</parameter>
point to different places. As a result, overlaps can be fatal.
<function>XkbCopyKeyType</function>
frees any existing
@ -1082,20 +1082,20 @@ Both must point to legal
and
<emphasis>level_names</emphasis>
in
<emphasis>into</emphasis>
<parameter>into</parameter>
prior to copying. If any allocation errors occur while copying
<emphasis>from</emphasis>
<parameter>from</parameter>
to
<emphasis>into</emphasis>,
<parameter>into</parameter>,
<function>XkbCopyKeyType</function>
returns
<errorname>BadAlloc</errorname>.
Otherwise,
<function>XkbCopyKeyType</function>
copies
<emphasis>from</emphasis>
<parameter>from</parameter>
to
<emphasis>into</emphasis>
<parameter>into</parameter>
and returns
<symbol>Success</symbol>.
</para>
@ -1106,9 +1106,9 @@ Otherwise,
<funcprototype>
<funcdef>Status <function>XkbCopyKeyTypes</function></funcdef>
<!-- (
<emphasis>from</emphasis>,
<emphasis>into</emphasis>,
<emphasis>num_types</emphasis>
<parameter>from</parameter>,
<parameter>into</parameter>,
<parameter>num_types</parameter>
) -->
<paramdef>XkbKeyTypePtr <parameter>from</parameter></paramdef>
@ -1152,39 +1152,39 @@ Otherwise,
<para>
<function>XkbCopyKeyTypes</function>
copies
<emphasis>num_types</emphasis>
<parameter>num_types</parameter>
<emphasis>XkbKeyTypeRec</emphasis>
structures from the array specified by
<emphasis>from</emphasis>
<parameter>from</parameter>
into the array specified by
<emphasis>into</emphasis>.
<parameter>into</parameter>.
It is intended for copying between, rather than within, keyboard
descriptions, so it doesn’t check for overlaps. The same rules that apply to
the
<emphasis>from</emphasis>
<parameter>from</parameter>
and
<emphasis>into</emphasis>
<parameter>into</parameter>
parameters in
<function>XkbCopyKeyType</function>
apply to each entry of the
<emphasis>from</emphasis>
<parameter>from</parameter>
and
<emphasis>into</emphasis>
<parameter>into</parameter>
arrays of
<function>XkbCopyKeyTypes</function>.
If any allocation errors occur while copying
<emphasis>from</emphasis>
<parameter>from</parameter>
to
<emphasis>into</emphasis>,
<parameter>into</parameter>,
<function>XkbCopyKeyTypes</function>
returns
<errorname>BadAlloc</errorname>.
Otherwise,
<function>XkbCopyKeyTypes</function>
copies
<emphasis>from</emphasis>
<parameter>from</parameter>
to
<emphasis>into</emphasis>
<parameter>into</parameter>
and returns
<symbol>Success</symbol>.
</para>
@ -1299,7 +1299,7 @@ currently four); if a key has fewer than
<funcprototype>
<funcdef>int <function>XkbKeyTypeIndex</function></funcdef>
<!-- (
<emphasis>xkb, keycode, group</emphasis>
<parameter>xkb, keycode, group</parameter>
) /* macro*/ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1345,11 +1345,11 @@ currently four); if a key has fewer than
computes an index into the
<emphasis>types</emphasis>
vector of the client map in
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
from the given
<emphasis>keycode</emphasis>
<parameter>keycode</parameter>
and
<emphasis>group</emphasis>
<parameter>group</parameter>
index.
</para>
@ -1359,7 +1359,7 @@ currently four); if a key has fewer than
<funcprototype>
<funcdef>XkbKeyTypePtr <function>XkbKeyType</function></funcdef>
<!-- (
<emphasis>xkb, keycode, group</emphasis>
<parameter>xkb, keycode, group</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1405,11 +1405,11 @@ currently four); if a key has fewer than
returns a pointer to the key type in the
<emphasis>types</emphasis>
vector of the client map in
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
corresponding to the given
<emphasis>keycode</emphasis>
<parameter>keycode</parameter>
and
<emphasis>group</emphasis>
<parameter>group</parameter>
index.
</para>
@ -1514,7 +1514,7 @@ Xkb provides the following macros to access group information:
<funcprototype>
<funcdef>int <function>XkbKeyNumGroups</function></funcdef>
<!-- (
<emphasis>xkb, keycode</emphasis>
<parameter>xkb, keycode</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1547,7 +1547,7 @@ Xkb provides the following macros to access group information:
<para>
<function>XkbKeyNumGroups</function>
returns the number of groups of symbols bound to the key corresponding to
<emphasis>keycode</emphasis>.
<parameter>keycode</parameter>.
</para>
@ -1556,7 +1556,7 @@ Xkb provides the following macros to access group information:
<funcprototype>
<funcdef>unsigned char <function>XkbKeyGroupInfo</function></funcdef>
<!-- (
<emphasis>xkb, keycode</emphasis>
<parameter>xkb, keycode</parameter>
) /*macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1593,7 +1593,7 @@ Xkb provides the following macros to access group information:
field from the
<emphasis>XkbSymMapRec</emphasis>
structure associated with the key corresponding to
<emphasis>keycode</emphasis>.
<parameter>keycode</parameter>.
</para>
@ -1602,7 +1602,7 @@ Xkb provides the following macros to access group information:
<funcprototype>
<funcdef>unsigned char <function>XkbOutOfRangeGroupInfo</function></funcdef>
<!-- (
<emphasis>grp_inf</emphasis>
<parameter>grp_inf</parameter>
) /* macro */ -->
<paramdef>unsigned char <parameter>grp_inf</parameter></paramdef>
@ -1636,7 +1636,7 @@ Xkb provides the following macros to access group information:
<funcprototype>
<funcdef>unsigned char <function>XkbOutOfRangeGroupNumber</function></funcdef>
<!-- (
<emphasis>grp_inf</emphasis>
<parameter>grp_inf</parameter>
) /* macro */ -->
<paramdef>unsigned char <parameter>grp_inf</parameter></paramdef>
@ -1727,7 +1727,7 @@ of symbols bound to the key:
<funcprototype>
<funcdef>int <function>XkbKeyGroupsWidth</function></funcdef>
<!-- (
<emphasis>xkb, keycode</emphasis>
<parameter>xkb, keycode</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1760,7 +1760,7 @@ of symbols bound to the key:
<para>
<function>XkbKeyGroupsWidth</function>
computes the maximum width associated with the key corresponding to
<emphasis>keycode</emphasis>.
<parameter>keycode</parameter>.
</para>
@ -1769,7 +1769,7 @@ of symbols bound to the key:
<funcprototype>
<funcdef>int <function>XkbKeyGroupWidth</function></funcdef>
<!-- (
<emphasis>xkb, keycode, grp</emphasis>
<parameter>xkb, keycode, grp</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1813,9 +1813,9 @@ of symbols bound to the key:
<para>
<function>XkbKeyGroupWidth</function>
computes the width of the type associated with the group
<emphasis>grp</emphasis>
<parameter>grp</parameter>
for the key corresponding to
<emphasis>keycode</emphasis>.
<parameter>keycode</parameter>.
</para>
@ -1824,7 +1824,7 @@ of symbols bound to the key:
<funcprototype>
<funcdef>int <function>XkbKeySymsOffset</function></funcdef>
<!-- (
<emphasis>xkb, keycode</emphasis>
<parameter>xkb, keycode</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1858,7 +1858,7 @@ of symbols bound to the key:
<function>XkbKeySymsOffset</function>
returns the offset of the two-dimensional array of keysyms for the key
corresponding to
<emphasis>keycode</emphasis>.
<parameter>keycode</parameter>.
</para>
@ -1867,7 +1867,7 @@ corresponding to
<funcprototype>
<funcdef>int <function>XkbKeyNumSyms</function></funcdef>
<!-- (
<emphasis>xkb, keycode</emphasis>
<parameter>xkb, keycode</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1900,7 +1900,7 @@ corresponding to
<para>
<function>XkbKeyNumSyms</function>
returns the total number of keysyms for the key corresponding to
<emphasis>keycode</emphasis>.
<parameter>keycode</parameter>.
</para>
@ -1909,7 +1909,7 @@ corresponding to
<funcprototype>
<funcdef>KeySym *<function>XkbKeySymsPtr</function></funcdef>
<!-- (
<emphasis>xkb, keycode</emphasis>
<parameter>xkb, keycode</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1943,7 +1943,7 @@ corresponding to
<function>XkbKeySymsPtr</function>
returns the pointer to the two-dimensional array of keysyms for the key
corresponding to
<emphasis>keycode</emphasis>.
<parameter>keycode</parameter>.
</para>
@ -1952,7 +1952,7 @@ corresponding to
<funcprototype>
<funcdef>KeySym <function>XkbKeySymEntry</function></funcdef>
<!-- (
<emphasis>xkb, keycode, shift, grp</emphasis>
<parameter>xkb, keycode, shift, grp</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -2009,11 +2009,11 @@ corresponding to
returns the
<emphasis>keysym</emphasis>
corresponding to shift level
<emphasis>shift</emphasis>
<parameter>shift</parameter>
and group
<emphasis>grp</emphasis>
<parameter>grp</parameter>
from the two-dimensional array of keysyms for the key corresponding to
<emphasis>keycode</emphasis>
<parameter>keycode</parameter>
</para>
@ -2032,10 +2032,10 @@ To obtain the symbols for a subset of the keys in a keyboard description, use
<funcprototype>
<funcdef>Status <function>XkbGetKeySyms</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>first</emphasis>,
<emphasis>num</emphasis>,
<emphasis>xkb</emphasis>
<parameter>dpy</parameter>,
<parameter>first</parameter>,
<parameter>num</parameter>,
<parameter>xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -2090,19 +2090,19 @@ To obtain the symbols for a subset of the keys in a keyboard description, use
<para>
<function>XkbGetKeySyms</function>
sends a request to the server to obtain the set of keysyms bound to
<emphasis>num</emphasis>
<parameter>num</parameter>
keys starting with the key whose keycode is
<emphasis>first</emphasis>.
<parameter>first</parameter>.
It waits for a reply and returns the keysyms in the
<emphasis>map.syms</emphasis>
field of
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
If successful,
<function>XkbGetKeySyms</function>
returns
<symbol>Success</symbol>.
The
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter must be a pointer to a valid Xkb keyboard description.
</para>
@ -2111,7 +2111,7 @@ The
If the client
<emphasis>map</emphasis>
in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter has not been allocated,
<function>XkbGetKeySyms</function>
allocates and initializes it before obtaining the symbols.
@ -2125,7 +2125,7 @@ extension has not been properly initialized,
returns
<errorname>BadAccess</errorname>.
If
<emphasis>num</emphasis>
<parameter>num</parameter>
is less than 1 or greater than
<emphasis>XkbMaxKeyCount</emphasis>,
<function>XkbGetKeySyms</function>
@ -2153,12 +2153,12 @@ To change the number of groups and the types bound to a key, use
<funcprototype>
<funcdef>Status <function>XkbChangeTypesOfKey</function></funcdef>
<!-- (
<emphasis>xkb</emphasis>,
<emphasis>key</emphasis>,
<emphasis>n_groups</emphasis>,
<emphasis>groups</emphasis>,
<emphasis>new_types_in</emphasis>,
<emphasis>p_changes</emphasis>
<parameter>xkb</parameter>,
<parameter>key</parameter>,
<parameter>n_groups</parameter>,
<parameter>groups</parameter>,
<parameter>new_types_in</parameter>,
<parameter>p_changes</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -2240,7 +2240,7 @@ initializes any new symbols or actions to
or
<emphasis>NoAction</emphasis>,
as appropriate. If the
<emphasis>p_changes</emphasis>
<parameter>p_changes</parameter>
parameter is not
<emphasis>NULL</emphasis>,
<function>XkbChangeTypesOfKey</function>
@ -2249,15 +2249,15 @@ as appropriate. If the
to the
<emphasis>changes</emphasis>
field of
<emphasis>p_changes</emphasis>
<parameter>p_changes</parameter>
and modifies the
<emphasis>first_key_sym</emphasis>
and
<emphasis>num_key_syms</emphasis>
fields of
<emphasis>p_changes</emphasis>
<parameter>p_changes</parameter>
to include the
<emphasis>key</emphasis>
<parameter>key</parameter>
that was changed. See <link linkend="The_XkbMapChangesRec_Structure">section 14.3.1</link> for more information on the
<emphasis>XkbMapChangesPtr</emphasis>
structure. If successful,
@ -2269,9 +2269,9 @@ as appropriate. If the
<para>
The
<emphasis>n_groups</emphasis>
<parameter>n_groups</parameter>
parameter specifies the new number of groups for the key. The
<emphasis>groups</emphasis>
<parameter>groups</parameter>
parameter is a mask specifying the groups for which new types are supplied and
is a bitwise inclusive OR of the following masks:
<emphasis>XkbGroup1Mask</emphasis>,
@ -2284,26 +2284,26 @@ and
<para>
The
<emphasis>new_types_in</emphasis>
<parameter>new_types_in</parameter>
parameter is an integer array of length
<emphasis>n_groups</emphasis>.
<parameter>n_groups</parameter>.
Each entry represents the type to use for the associated group and is an
index into
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-&gt;
<emphasis>map-&gt;types</emphasis>.
The
<emphasis>new_types_in</emphasis>
<parameter>new_types_in</parameter>
array is indexed by group index; if
<emphasis>n_groups</emphasis>
<parameter>n_groups</parameter>
is four and
<emphasis>groups</emphasis>
<parameter>groups</parameter>
only has
<emphasis>Group1Mask</emphasis>
and
<emphasis>Group3Mask</emphasis>
set,
<emphasis>new_types_in</emphasis>
<parameter>new_types_in</parameter>
looks like this:
</para>
@ -2358,7 +2358,7 @@ If the Xkb extension has not been properly initialized,
returns
<errorname>BadAccess</errorname>.
If the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter it not valid (that is, it is
<emphasis>NULL</emphasis>
or it does not contain a valid client map),
@ -2366,13 +2366,13 @@ If the
returns
<errorname>BadMatch</errorname>.
If the
<emphasis>key</emphasis>
<parameter>key</parameter>
is not a valid keycode,
<emphasis>n_groups</emphasis>
<parameter>n_groups</parameter>
is greater than
<emphasis>XkbNumKbdGroups</emphasis>,
or the
<emphasis>groups</emphasis>
<parameter>groups</parameter>
mask does not contain any of the valid group mask bits,
<function>XkbChangeTypesOfKey</function>
returns
@ -2399,9 +2399,9 @@ To change the number of symbols bound to a key, use
<funcprototype>
<funcdef>KeySym *<function>XkbResizeKeySyms</function></funcdef>
<!-- (
<emphasis>xkb</emphasis>,
<emphasis>key</emphasis>,
<emphasis>needed</emphasis>
<parameter>xkb</parameter>,
<parameter>key</parameter>,
<parameter>needed</parameter>
) -->
<paramdef>XkbDescRec *<parameter>xkb</parameter></paramdef>
@ -2445,7 +2445,7 @@ To change the number of symbols bound to a key, use
<para>
<function>XkbResizeKeySyms</function>
reserves the space needed for
<emphasis>needed</emphasis>
<parameter>needed</parameter>
keysyms and returns a pointer to the beginning of the new array that holds the
keysyms. It adjusts the
<emphasis>offset</emphasis>
@ -2457,7 +2457,7 @@ keysyms. It adjusts the
and
<emphasis>size_syms</emphasis>
fields of
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-
<emphasis>&gt;map</emphasis>
if it is necessary to reallocate the
@ -2470,7 +2470,7 @@ and
<para>
If
<emphasis>needed</emphasis>
<parameter>needed</parameter>
is greater than the current number of keysyms for the key,
<function>XkbResizeKeySyms</function>
initializes all new keysyms in the array to
@ -2558,10 +2558,10 @@ description, use
<funcprototype>
<funcdef>Status <function>XkbGetKeyModifierMap</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>first</emphasis>,
<emphasis>num</emphasis>,
<emphasis>xkb</emphasis>
<parameter>dpy</parameter>,
<parameter>first</parameter>,
<parameter>num</parameter>,
<parameter>xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -2616,11 +2616,11 @@ description, use
<para>
<function>XkbGetKeyModifierMap</function>
sends a request to the server for the modifier mappings for
<emphasis>num</emphasis>
<parameter>num</parameter>
keys starting with the key whose keycode is
<emphasis>first</emphasis>.
<parameter>first</parameter>.
It waits for a reply and places the results in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-&gt;map-&gt;modmap array. If successful,
<emphasis>XkbGetKeyModifier</emphasis>
returns
@ -2630,7 +2630,7 @@ It waits for a reply and places the results in the
<para>
If the map component of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter has not been allocated,
<function>XkbGetKeyModifierMap</function>
allocates and initializes it.

232
specs/XKB/ch16.xml
View file

@ -164,7 +164,7 @@ to key actions:
<funcprototype>
<funcdef>Bool <function>XkbKeyHasActions</function></funcdef>
<!-- (
<emphasis>xkb, keycode</emphasis>
<parameter>xkb, keycode</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -199,7 +199,7 @@ to key actions:
returns
<symbol>True</symbol>
if the key corresponding to
<emphasis>keycode</emphasis>
<parameter>keycode</parameter>
has any actions associated with it; otherwise, it returns
<symbol>False</symbol>.
</para>
@ -210,7 +210,7 @@ to key actions:
<funcprototype>
<funcdef>int <function>XkbKeyNumActions</function></funcdef>
<!-- (
<emphasis>xkb, keycode</emphasis>
<parameter>xkb, keycode</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -243,7 +243,7 @@ to key actions:
<para>
<function>XkbKeyNumActions</function>
computes the number of actions associated with the key corresponding to
<emphasis>keycode</emphasis>.
<parameter>keycode</parameter>.
This should be the same value as the result of
<function>XkbKeyNumSyms</function>
(see <link linkend="Key_Width">section 15.3.3</link>).
@ -255,7 +255,7 @@ This should be the same value as the result of
<funcprototype>
<funcdef>XkbKeyActionPtr <function>XkbKeyActionsPtr</function></funcdef>
<!-- (
<emphasis>xkb, keycode</emphasis>
<parameter>xkb, keycode</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -289,7 +289,7 @@ This should be the same value as the result of
<function>XkbKeyActionsPtr</function>
returns a pointer to the two-dimensional array of key actions associated with
the key corresponding to
<emphasis>keycode</emphasis>.
<parameter>keycode</parameter>.
Use
<function>XkbKeyActionsPtr</function>
only if the key actually has some actions associated with it, that is,
@ -303,7 +303,7 @@ Use
<funcprototype>
<funcdef>XkbAction <function>XkbKeyAction</function></funcdef>
<!-- (
<emphasis>xkb, keycode, idx</emphasis>
<parameter>xkb, keycode, idx</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -347,11 +347,11 @@ Use
<para>
<function>XkbKeyAction</function>
returns the key action indexed by
<emphasis>idx</emphasis>
<parameter>idx</parameter>
in the two-dimensional array of key actions associated with the key
corresponding to
<emphasis>keycode</emphasis>.
<emphasis>idx</emphasis>
<parameter>keycode</parameter>.
<parameter>idx</parameter>
may be computed from the group and shift level of interest as follows:
</para>
@ -364,7 +364,7 @@ corresponding to
<funcprototype>
<funcdef>XkbAction <function>XkbKeyActionEntry</function></funcdef>
<!-- (
<emphasis>xkb, keycode, shift, grp</emphasis>
<parameter>xkb, keycode, shift, grp</parameter>
) /* macro */ -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -419,12 +419,12 @@ corresponding to
<para>
<function>XkbKeyActionEntry</function>
returns the key action corresponding to group
<emphasis>grp</emphasis>
<parameter>grp</parameter>
and shift level
<emphasis>lvl</emphasis>
from the two-dimensional table of key actions associated with the key
corresponding to
<emphasis>keycode</emphasis>.
<parameter>keycode</parameter>.
</para>
@ -656,7 +656,7 @@ is being used. In the latter case, this is the client
-&gt;
<emphasis>modmap</emphasis>
[
<emphasis>keycode</emphasis>
<parameter>keycode</parameter>
] field.
</para>
@ -868,7 +868,7 @@ and the modifiers bound to the key (client
-&gt;
<emphasis>modmap</emphasis>
[
<emphasis>keycode</emphasis>
<parameter>keycode</parameter>
]) are used instead.
</para>
@ -904,7 +904,7 @@ convert between the two formats:
<funcprototype>
<funcdef>unsigned short <function>XkbModActionVMods</function></funcdef>
<!-- (
<emphasis>act</emphasis>
<parameter>act</parameter>
) /* macro */ -->
<paramdef>XkbAction <parameter>act</parameter></paramdef>
@ -930,7 +930,7 @@ convert between the two formats:
and
<emphasis>vmods2</emphasis>
fields of
<emphasis>act</emphasis>
<parameter>act</parameter>
converted to the
<emphasis>vmods</emphasis>
format of an Xkb modifier description.
@ -942,7 +942,7 @@ convert between the two formats:
<funcprototype>
<funcdef>void <function>XkbSetModActionVMods</function></funcdef>
<!-- (
<emphasis>act, vmods</emphasis>
<parameter>act, vmods</parameter>
) /* macro */ -->
<paramdef>XkbAction <parameter>act</parameter></paramdef>
@ -979,9 +979,9 @@ convert between the two formats:
and
<emphasis>vmods2</emphasis>
fields of
<emphasis>act</emphasis>
<parameter>act</parameter>
using the
<emphasis>vmods</emphasis>
<parameter>vmods</parameter>
format of an Xkb modifier description.
</para>
@ -1207,7 +1207,7 @@ convert between a signed integer value and a signed character:
<funcprototype>
<funcdef>int <function>XkbSAGroup</function></funcdef>
<!-- (
<emphasis>act</emphasis>
<parameter>act</parameter>
) /* macro */ -->
<paramdef>XkbAction <parameter>act</parameter></paramdef>
@ -1231,7 +1231,7 @@ convert between a signed integer value and a signed character:
returns the
<emphasis>group_XXX</emphasis>
field of
<emphasis>act</emphasis>
<parameter>act</parameter>
converted to a signed int.
</para>
@ -1241,7 +1241,7 @@ convert between a signed integer value and a signed character:
<funcprototype>
<funcdef>void <function>XkbSASetGroup</function></funcdef>
<!-- (
<emphasis>act, grp</emphasis>
<parameter>act, grp</parameter>
) /* macro */ -->
<paramdef>XkbAction <parameter>act</parameter></paramdef>
@ -1276,9 +1276,9 @@ convert between a signed integer value and a signed character:
sets the
<emphasis>group_XXX</emphasis>
field of
<emphasis>act</emphasis>
<parameter>act</parameter>
from the group index
<emphasis>grp</emphasis>.
<parameter>grp</parameter>.
</para>
<note><para>Despite the fact that the first parameter of these two macros is of
@ -1418,7 +1418,7 @@ convert between a signed integer and two signed 16-bit values in
<funcprototype>
<funcdef>int <function>XkbPtrActionX</function></funcdef>
<!-- (
<emphasis>act</emphasis>
<parameter>act</parameter>
) /* macro */ -->
<paramdef>XkbPtrAction <parameter>act</parameter></paramdef>
@ -1444,7 +1444,7 @@ convert between a signed integer and two signed 16-bit values in
and
<emphasis>low_XXX</emphasis>
fields of
<emphasis>act</emphasis>
<parameter>act</parameter>
converted to a signed int.
</para>
@ -1454,7 +1454,7 @@ convert between a signed integer and two signed 16-bit values in
<funcprototype>
<funcdef>int <function>XkbPtrActionY</function></funcdef>
<!-- (
<emphasis>act</emphasis>
<parameter>act</parameter>
) /* macro */ -->
<paramdef>XkbPtrAction <parameter>act</parameter></paramdef>
@ -1480,7 +1480,7 @@ convert between a signed integer and two signed 16-bit values in
and
<emphasis>low_YYY</emphasis>
fields of
<emphasis>act</emphasis>
<parameter>act</parameter>
converted to a signed int.
</para>
@ -1490,8 +1490,8 @@ convert between a signed integer and two signed 16-bit values in
<funcprototype>
<funcdef>void <function>XkbSetPtrActionX</function></funcdef>
<!-- (
<emphasis>act</emphasis>,
<emphasis>x</emphasis>
<parameter>act</parameter>,
<parameter>x</parameter>
) /* macro */ -->
<paramdef>XkbPtrAction <parameter>act</parameter></paramdef>
@ -1528,9 +1528,9 @@ convert between a signed integer and two signed 16-bit values in
and
<emphasis>low_XXX</emphasis>
fields of
<emphasis>act</emphasis>
<parameter>act</parameter>
from the signed integer value
<emphasis>x</emphasis>.
<parameter>x</parameter>.
</para>
@ -1539,7 +1539,7 @@ convert between a signed integer and two signed 16-bit values in
<funcprototype>
<funcdef>void <function>XkbSetPtrActionY</function></funcdef>
<!-- (
<emphasis>act, y</emphasis>
<parameter>act, y</parameter>
) /* macro */ -->
<paramdef>XkbPtrAction <parameter>act</parameter></paramdef>
@ -1576,9 +1576,9 @@ convert between a signed integer and two signed 16-bit values in
and
<emphasis>low_YYY</emphasis>
fields of
<emphasis>act</emphasis>
<parameter>act</parameter>
from the signed integer value
<emphasis>y</emphasis>.
<parameter>y</parameter>.
</para>
@ -1922,7 +1922,7 @@ values in
<funcprototype>
<funcdef>int <function>XkbSAPtrDfltValue</function></funcdef>
<!-- (
<emphasis>act</emphasis>
<parameter>act</parameter>
) /* macro */ -->
<paramdef>XkbAction <parameter>act</parameter></paramdef>
@ -1946,7 +1946,7 @@ values in
returns the
<emphasis>valueXXX</emphasis>
field of
<emphasis>act</emphasis>
<parameter>act</parameter>
converted to a signed int.
</para>
@ -1956,7 +1956,7 @@ values in
<funcprototype>
<funcdef>void <function>XkbSASetPtrDfltValue</function></funcdef>
<!-- (
<emphasis>act, val</emphasis>
<parameter>act, val</parameter>
) /* macro */ -->
<paramdef>XkbPtrDfltAction <parameter>act</parameter></paramdef>
@ -1991,9 +1991,9 @@ values in
sets the
<emphasis>valueXXX</emphasis>
field of
<emphasis>act</emphasis>
<parameter>act</parameter>
from
<emphasis>val</emphasis>.
<parameter>val</parameter>.
</para>
@ -2529,7 +2529,7 @@ signed character value for screen numbers in
<funcprototype>
<funcdef>int <function>XkbSAScreen</function></funcdef>
<!-- (
<emphasis>act</emphasis>
<parameter>act</parameter>
) /* macro */ -->
<paramdef>XkbSwitchScreenAction <parameter>act</parameter></paramdef>
@ -2553,7 +2553,7 @@ signed character value for screen numbers in
returns the
<emphasis>screenXXX</emphasis>
field of
<emphasis>act</emphasis>
<parameter>act</parameter>
converted to a signed int.
</para>
@ -2563,7 +2563,7 @@ signed character value for screen numbers in
<funcprototype>
<funcdef>void <function>XkbSASetScreen</function></funcdef>
<!-- (
<emphasis>act, s</emphasis>
<parameter>act, s</parameter>
) /* macro */ -->
<paramdef>XkbSwitchScreenAction <parameter>act</parameter></paramdef>
@ -2598,9 +2598,9 @@ signed character value for screen numbers in
sets the
<emphasis>screenXXX</emphasis>
field of
<emphasis>act</emphasis>
<parameter>act</parameter>
from
<emphasis>s</emphasis>.
<parameter>s</parameter>.
</para>
@ -2791,7 +2791,7 @@ macros, to convert between the two formats:
<funcprototype>
<funcdef>unsigned int <function>XkbActionCtrls</function></funcdef>
<!-- (
<emphasis>act</emphasis>
<parameter>act</parameter>
) /* macro */ -->
<paramdef>XkbCtrlsAction <parameter>act</parameter></paramdef>
@ -2815,7 +2815,7 @@ macros, to convert between the two formats:
returns the
<emphasis>ctrls</emphasis>
fields of
<emphasis>act</emphasis>
<parameter>act</parameter>
converted to an unsigned int.
</para>
@ -2825,7 +2825,7 @@ macros, to convert between the two formats:
<funcprototype>
<funcdef>void <function>XkbSAActionSetCtrls</function></funcdef>
<!-- (
<emphasis>act, ctrls</emphasis>
<parameter>act, ctrls</parameter>
) /* macro */ -->
<paramdef>XkbCtrlsAction <parameter>act</parameter></paramdef>
@ -2862,9 +2862,9 @@ macros, to convert between the two formats:
through
<emphasis>ctrls3</emphasis>
fields of
<emphasis>act</emphasis>
<parameter>act</parameter>
from
<emphasis>ctrls</emphasis>.
<parameter>ctrls</parameter>.
</para>
@ -3200,7 +3200,7 @@ convert between the two formats:
<funcprototype>
<funcdef>unsigned int <function>XkbSARedirectVModsMask</function></funcdef>
<!-- (
<emphasis>act</emphasis>
<parameter>act</parameter>
) /* macro */ -->
<paramdef>XkbRedirectKeyAction <parameter>act</parameter></paramdef>
@ -3226,7 +3226,7 @@ convert between the two formats:
and
<emphasis>vmods_mask1</emphasis>
fields of
<emphasis>act</emphasis>
<parameter>act</parameter>
converted to an unsigned int.
</para>
@ -3236,7 +3236,7 @@ convert between the two formats:
<funcprototype>
<funcdef>void <function>XkbSARedirectSetVModsMask</function></funcdef>
<!-- (
<emphasis>act, vm</emphasis>
<parameter>act, vm</parameter>
) /* macro */ -->
<paramdef>XkbRedirectKeyAction <parameter>act</parameter></paramdef>
@ -3273,9 +3273,9 @@ convert between the two formats:
and
<emphasis>vmods_mask1</emphasis>
fields of
<emphasis>act</emphasis>
<parameter>act</parameter>
from
<emphasis>vm</emphasis>.
<parameter>vm</parameter>.
</para>
@ -3296,7 +3296,7 @@ provides the following convenience macros:
<funcprototype>
<funcdef>unsigned int <function>XkbSARedirectVMods</function></funcdef>
<!-- (
<emphasis>act</emphasis>
<parameter>act</parameter>
) /* macro */ -->
<paramdef>XkbRedirectKeyAction <parameter>act</parameter></paramdef>
@ -3317,7 +3317,7 @@ provides the following convenience macros:
<literallayout>
<function>XkbSARedirectVModsMask</function> returns the <emphasis>vmods0</emphasis>
and <emphasis>vmods1</emphasis> fields of <emphasis>act</emphasis>
and <emphasis>vmods1</emphasis> fields of <parameter>act</parameter>
converted to an unsigned int.
</literallayout>
@ -3326,7 +3326,7 @@ provides the following convenience macros:
<funcprototype>
<funcdef>void <function>XkbSARedirectSetVMods</function></funcdef>
<!-- (
<emphasis>act, vm</emphasis>
<parameter>act, vm</parameter>
) /* macro */ -->
<paramdef>XkbRedirectKeyAction <parameter>act</parameter></paramdef>
@ -3357,7 +3357,7 @@ provides the following convenience macros:
</variablelist>
<literallayout>
<function>XkbSARedirectSetVModsMask</function> sets the <emphasis>vmods0</emphasis>
and <emphasis>vmods1</emphasis> of <emphasis>act</emphasis> from <emphasis>v</emphasis>.
and <emphasis>vmods1</emphasis> of <parameter>act</parameter> from <parameter>v</parameter>.
</literallayout>
</sect2>
@ -3711,10 +3711,10 @@ To update the actions (the
<funcprototype>
<funcdef>Status <function>XkbGetKeyActions</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>first</emphasis>,
<emphasis>num</emphasis>,
<emphasis>xkb</emphasis>
<parameter>dpy</parameter>,
<parameter>first</parameter>,
<parameter>num</parameter>,
<parameter>xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -3769,21 +3769,21 @@ To update the actions (the
<para>
<function>XkbGetKeyActions</function>
sends a request to the server to obtain the actions for
<emphasis>num</emphasis>
<parameter>num</parameter>
keys on the keyboard starting with key
<emphasis>first</emphasis>.
<parameter>first</parameter>.
It waits for a reply and returns the actions in the
<emphasis>server</emphasis>
-&gt;
<emphasis>key_acts</emphasis>
field of
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
If successful,
<function>XkbGetKeyActions</function>
returns
<symbol>Success</symbol>.
The
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter must be a pointer to a valid Xkb keyboard description.
</para>
@ -3792,7 +3792,7 @@ The
If the
<emphasis>server</emphasis>
map in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter has not been allocated,
<function>XkbGetKeyActions</function>
allocates and initializes it before obtaining the actions.
@ -3806,7 +3806,7 @@ has not been properly initialized,
returns
<errorname>BadAccess</errorname>.
If
<emphasis>num</emphasis>
<parameter>num</parameter>
is less than 1 or greater than
<emphasis>XkbMaxKeyCount</emphasis>,
<function>XkbGetKeyActions</function>
@ -3833,9 +3833,9 @@ To change the number of actions bound to a key, use
<funcprototype>
<funcdef>XkbAction *<function>XkbResizeKeyActions</function></funcdef>
<!-- (
<emphasis>xkb</emphasis>,
<emphasis>key</emphasis>,
<emphasis>needed</emphasis>
<parameter>xkb</parameter>,
<parameter>key</parameter>,
<parameter>needed</parameter>
) -->
<paramdef>XkbDescRec *<parameter>xkb</parameter></paramdef>
@ -3878,13 +3878,13 @@ To change the number of actions bound to a key, use
<para>
The
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter points to the keyboard description containing the
<emphasis>key</emphasis>
<parameter>key</parameter>
whose number of actions is to be changed. The
<emphasis>key</emphasis>
<parameter>key</parameter>
parameter is the keycode of the key to change, and
<emphasis>needed</emphasis>
<parameter>needed</parameter>
specifies the new number of actions required for the key.
</para>
@ -3898,7 +3898,7 @@ beginning of the new array that holds the actions. It can change the
and
<emphasis>size_acts</emphasis>
fields of
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
-&gt;
<emphasis>server</emphasis>
if it is necessary to reallocate the
@ -3909,7 +3909,7 @@ array.
<para>
If
<emphasis>needed</emphasis>
<parameter>needed</parameter>
is greater than the current number of keysyms for the key,
<function>XkbResizeKeyActions</function>
initializes all new actions in the array to
@ -4158,10 +4158,10 @@ To obtain the behaviors (the
<funcprototype>
<funcdef>Status <function>XkbGetKeyBehaviors</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>first</emphasis>,
<emphasis>num</emphasis>,
<emphasis>xkb</emphasis>
<parameter>dpy</parameter>,
<parameter>first</parameter>,
<parameter>num</parameter>,
<parameter>xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -4216,15 +4216,15 @@ To obtain the behaviors (the
<para>
<function>XkbGetKeyBehaviors</function>
sends a request to the server to obtain the behaviors for
<emphasis>num</emphasis>
<parameter>num</parameter>
keys on the keyboard starting with the key whose keycode is
<emphasis>first</emphasis>.
<parameter>first</parameter>.
It waits for a reply and returns the behaviors in the
<emphasis>server</emphasis>
-&gt;
<emphasis>behaviors</emphasis>
field of
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
If successful,
<function>XkbGetKeyBehaviors</function>
returns
@ -4236,7 +4236,7 @@ If successful,
If the
<emphasis>server</emphasis>
map in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter has not been allocated,
<function>XkbGetKeyBehaviors</function>
allocates and initializes it before obtaining the actions.
@ -4250,7 +4250,7 @@ has not been properly initialized,
returns
<errorname>BadAccess</errorname>.
If
<emphasis>num</emphasis>
<parameter>num</parameter>
is less than 1 or greater than
<emphasis>XkbMaxKeyCount</emphasis>,
<function>XkbGetKeyBehaviors</function>
@ -4393,10 +4393,10 @@ To obtain the explicit components (the
<funcprototype>
<funcdef>Status <function>XkbGetKeyExplicitComponents</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>first</emphasis>,
<emphasis>num</emphasis>,
<emphasis>xkb</emphasis>
<parameter>dpy</parameter>,
<parameter>first</parameter>,
<parameter>num</parameter>,
<parameter>xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -4451,21 +4451,21 @@ To obtain the explicit components (the
<para>
<function>XkbGetKeyExplicitComponents</function>
sends a request to the server to obtain the explicit components for
<emphasis>num</emphasis>
<parameter>num</parameter>
keys on the keyboard starting with key
<emphasis>first</emphasis>.
<parameter>first</parameter>.
It waits for a reply and returns the explicit components in the
<emphasis>server</emphasis>
-&gt;
<emphasis>explicit</emphasis>
array of
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
If successful,
<function>XkbGetKeyExplicitComponents</function>
returns
<symbol>Success</symbol>.
The
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter must be a pointer to a valid Xkb keyboard description.
</para>
@ -4474,7 +4474,7 @@ The
If the
<emphasis>server</emphasis>
map in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter has not been allocated,
<function>XkbGetKeyExplicitComponents</function>
allocates and initializes it before obtaining the actions.
@ -4488,7 +4488,7 @@ has not been properly initialized,
returns
<errorname>BadMatch</errorname>.
If
<emphasis>num</emphasis>
<parameter>num</parameter>
is less than 1 or greater than
<emphasis>XkbMaxKeyCount</emphasis>,
<function>XkbGetKeyExplicitComponents</function>
@ -4613,9 +4613,9 @@ To obtain a subset of the virtual modifier bindings (the
<funcprototype>
<funcdef>Status <function>XkbGetVirtualMods</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>which</emphasis>,
<emphasis>xkb</emphasis>
<parameter>dpy</parameter>,
<parameter>which</parameter>,
<parameter>xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -4661,17 +4661,17 @@ To obtain a subset of the virtual modifier bindings (the
sends a request to the server to obtain the
<emphasis>vmods</emphasis>
entries for the virtual modifiers specified in the mask,
<emphasis>which</emphasis>,
<parameter>which</parameter>,
and waits for a reply. See <link linkend="Virtual_Modifier_Names_and_Masks">section 7.1</link> for a description of how to determine
the virtual modifier mask. For each bit set in
<emphasis>which</emphasis>,
<parameter>which</parameter>,
<function>XkbGetVirtualMods</function>
updates the corresponding virtual modifier definition in the
<emphasis>server-&gt;vmods</emphasis>
array of
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
The
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter must be a pointer to a valid Xkb keyboard description. If
successful,
<function>XkbGetVirtualMods</function>
@ -4684,7 +4684,7 @@ successful,
If the
<emphasis>server</emphasis>
map has not been allocated in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter,
<function>XkbGetVirtualMods</function>
allocates and initializes it before obtaining the virtual modifier bindings.
@ -4721,10 +4721,10 @@ To obtain the virtual modifier map (the
<funcprototype>
<funcdef>Status <function>XkbGetKeyVirtualModMap</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>first</emphasis>,
<emphasis>num</emphasis>,
<emphasis>xkb</emphasis>
<parameter>dpy</parameter>,
<parameter>first</parameter>,
<parameter>num</parameter>,
<parameter>xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -4779,21 +4779,21 @@ To obtain the virtual modifier map (the
<para>
<emphasis>XkbGetKeyVirutalModmap</emphasis>
sends a request to the server to obtain the virtual modifier mappings for
<emphasis>num</emphasis>
<parameter>num</parameter>
keys on the keyboard starting with key
<emphasis>first</emphasis>.
<parameter>first</parameter>.
It waits for a reply and returns the virtual modifier mappings in the
<emphasis>server</emphasis>
-&gt;
<emphasis>vmodmap</emphasis>
array of
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
If successful,
<function>XkbGetKeyVirtualModMap</function>
returns
<symbol>Success</symbol>.
The
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter must be a pointer to a valid Xkb keyboard description
</para>
@ -4802,7 +4802,7 @@ The
If the
<emphasis>server</emphasis>
map in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter has not been allocated,
<function>XkbGetKeyVirtualModMap</function>
allocates and initializes it before obtaining the virtual modifier mappings.
@ -4816,7 +4816,7 @@ has not been properly initialized,
returns
<errorname>BadMatch</errorname>.
If
<emphasis>num</emphasis>
<parameter>num</parameter>
is less than 1 or greater than
<emphasis>XkbMaxKeyCount</emphasis>,
<function>XkbGetKeyVirtualModMap</function>

162
specs/XKB/ch17.xml
View file

@ -768,7 +768,7 @@ explicit override components of the server state.</para></note>
<funcprototype>
<funcdef>Status <function>XkbGetCompatMap</function></funcdef>
<!-- (
<emphasis>display, which, xkb</emphasis>
<parameter>display, which, xkb</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -812,15 +812,15 @@ explicit override components of the server state.</para></note>
<para>
<function>XkbGetCompatMap</function>
fetches the components of the compatibility map specified in
<emphasis>which</emphasis>
<parameter>which</parameter>
from the server specified by
<emphasis>display</emphasis>
<parameter>display</parameter>
and places them in the
<emphasis>compat</emphasis>
structure of the keyboard description
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
Valid values for
<emphasis>which</emphasis>
<parameter>which</parameter>
are an inclusive OR of the values shown in
<link linkend="table17.2">Table 17.2</link>.
</para>
@ -861,7 +861,7 @@ Valid values for
<para>
If no compatibility map structure is allocated in
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
upon entry,
<function>XkbGetCompatMap</function>
allocates one. If one already exists, its contents are overwritten with the
@ -874,7 +874,7 @@ returned results.
fetches compatibility map information for the device specified by the
<emphasis>device_spec</emphasis>
field of
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
Unless you have specifically modified this field, it is the default keyboard
device.
<function>XkbGetCompatMap</function>
@ -888,11 +888,11 @@ work space,
if the
<emphasis>dpy</emphasis>
field of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
argument is non-
<emphasis>NULL</emphasis>
and does not match the
<emphasis>display</emphasis>
<parameter>display</parameter>
argument, and
<errorname>BadLength</errorname>
under certain conditions caused by server or Xkb implementation errors.
@ -923,12 +923,12 @@ format mapping by calling the function
<funcprototype>
<funcdef>Bool <function>XkbUpdateMapFromCore</function></funcdef>
<!-- (
<emphasis>xkb</emphasis>,
<emphasis>first_key</emphasis>,
<emphasis>num_keys</emphasis>,
<emphasis>map_width</emphasis>,
<emphasis>core_keysyms</emphasis>,
<emphasis>changes</emphasis>
<parameter>xkb</parameter>,
<parameter>first_key</parameter>,
<parameter>num_keys</parameter>,
<parameter>map_width</parameter>,
<parameter>core_keysyms</parameter>,
<parameter>changes</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1006,53 +1006,53 @@ format mapping by calling the function
<function>XkbUpdateMapFromCore</function>
interprets input argument information representing a keyboard map in core
format to update the Xkb keyboard description passed in
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
Only a portion of the Xkb map is updated — the portion corresponding to
keys with keycodes in the range
<emphasis>first_key</emphasis>
<parameter>first_key</parameter>
through
<emphasis>first_key</emphasis>
<parameter>first_key</parameter>
+
<emphasis>num_keys</emphasis>
<parameter>num_keys</parameter>
- 1. If
<function>XkbUpdateMapFromCore</function>
is being called in response to a
<symbol>MappingNotify</symbol>
event,
<emphasis>first_key</emphasis>
<parameter>first_key</parameter>
and
<emphasis>num_keys</emphasis>
<parameter>num_keys</parameter>
are reported in the
<symbol>MappingNotify</symbol>
event.
<emphasis>core_keysyms</emphasis>
<parameter>core_keysyms</parameter>
contains the keysyms corresponding to the keycode range being updated, in core
keyboard description order.
<emphasis>map_width</emphasis>
<parameter>map_width</parameter>
is the number of keysyms per key in
<emphasis>core_keysyms</emphasis>.
<parameter>core_keysyms</parameter>.
Thus, the first
<emphasis>map_width</emphasis>
<parameter>map_width</parameter>
entries in
<emphasis>core_keysyms</emphasis>
<parameter>core_keysyms</parameter>
are for the key with keycode
<emphasis>first_key</emphasis>,
<parameter>first_key</parameter>,
the next
<emphasis>map_width</emphasis>
<parameter>map_width</parameter>
entries are for key
<emphasis>first_key</emphasis>
<parameter>first_key</parameter>
+ 1, and so on.
</para>
<para>
In addition to modifying the Xkb keyboard mapping in
<emphasis>xkb</emphasis>,
<parameter>xkb</parameter>,
<function>XkbUpdateMapFromCore</function>
backfills the changes structure whose address is passed in
<emphasis>changes</emphasis>
<parameter>changes</parameter>
to indicate the modifications that were made. You may then use
<emphasis>changes</emphasis>
<parameter>changes</parameter>
in subsequent calls such as
<function>XkbSetMap</function>,
to propagate the local modifications to a server.
@ -1073,9 +1073,9 @@ key in a core keyboard mapping. Use
<funcprototype>
<funcdef>int <function>XkbKeyTypesForCoreSymbols</function></funcdef>
<!-- (
<emphasis>map_width</emphasis>,
<emphasis>core_syms</emphasis>,
<emphasis>protected, types_inout, xkb_syms_rtrn</emphasis>
<parameter>map_width</parameter>,
<parameter>core_syms</parameter>,
<parameter>protected, types_inout, xkb_syms_rtrn</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1153,14 +1153,14 @@ key in a core keyboard mapping. Use
<para>
<function>XkbKeyTypesForCoreSymbols</function>
expands the symbols in
<emphasis>core_syms</emphasis>
<parameter>core_syms</parameter>
and types in
<emphasis>types_inout</emphasis>
<parameter>types_inout</parameter>
according to the rules specified in section 12 of the core protocol, then
chooses canonical key types (canonical key types are defined in <link linkend="The_Canonical_Key_Types">section 15.2.1</link>)
for groups 1 and 2 using the rules specified by the Xkb protocol and places
them in
<emphasis>xkb_syms_rtrn</emphasis>,
<parameter>xkb_syms_rtrn</parameter>,
which will be non-
<emphasis>NULL</emphasis>.
</para>
@ -1168,7 +1168,7 @@ which will be non-
<para>
A core keymap is a two-dimensional array of keysyms. It has
<emphasis>map_width</emphasis>
<parameter>map_width</parameter>
columns and
<emphasis>max_key_code</emphasis>
rows.
@ -1176,28 +1176,28 @@ A core keymap is a two-dimensional array of keysyms. It has
takes a single row from a core keymap, determines the number of groups
associated with it, the type of each group, and the symbols bound to each
group. The return value is the number of groups,
<emphasis>types_inout</emphasis>
<parameter>types_inout</parameter>
has the types for each group, and
<emphasis>xkb_syms_rtrn</emphasis>
<parameter>xkb_syms_rtrn</parameter>
has the symbols in Xkb order (that is, groups are contiguous, regardless of
size).
</para>
<para>
<emphasis>protected</emphasis>
<parameter>protected</parameter>
contains the explicitly protected key types. There is one explicit override
control associated with each of the four possible groups for each Xkb key,
<emphasis>ExplicitKeyType1</emphasis>
through
<emphasis>ExplicitKeyType4</emphasis>;
<emphasis>protected</emphasis>
<parameter>protected</parameter>
is an inclusive OR of these controls.
<emphasis>map_width</emphasis>
<parameter>map_width</parameter>
is the width of the core keymap and is not dependent on any Xkb definitions.
<emphasis>types_inout</emphasis>
<parameter>types_inout</parameter>
is an array of four type indices. On input,
<emphasis>types_inout</emphasis>
<parameter>types_inout</parameter>
contains the indices of any types already assigned to the key, in case they
are explicitly protected from change.
</para>
@ -1205,11 +1205,11 @@ are explicitly protected from change.
<para>
Upon return,
<emphasis>types_inout</emphasis>
<parameter>types_inout</parameter>
contains any automatically selected (that is, canonical) types plus any
protected types. Canonical types are assigned to all four groups if there are
enough symbols to do so. The four entries in
<emphasis>types_inout</emphasis>
<parameter>types_inout</parameter>
correspond to the four groups for the key in question.
</para>
@ -1228,9 +1228,9 @@ semantics updated, use
<funcprototype>
<funcdef>Bool <function>XkbApplyCompatMapToKey</function></funcdef>
<!-- (
<emphasis>xkb</emphasis>,
<emphasis>key</emphasis>,
<emphasis>changes</emphasis>
<parameter>xkb</parameter>,
<parameter>key</parameter>,
<parameter>changes</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1307,7 +1307,7 @@ the vector of
<funcprototype>
<funcdef>Bool <function>XkbSetCompatMap</function></funcdef>
<!-- (
<emphasis>display, which, xkb, update_actions</emphasis>
<parameter>display, which, xkb, update_actions</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -1362,16 +1362,16 @@ the vector of
<para>
<function>XkbSetCompatMap</function>
copies compatibility map information from the keyboard description in
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
to the server specified in
<emphasis>display</emphasis>
<parameter>display</parameter>
’s compatibility map for the device specified by the
<emphasis>device_spec</emphasis>
field of
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
Unless you have specifically modified this field, it is the default keyboard
device.
<emphasis>which</emphasis>
<parameter>which</parameter>
specifies the compatibility map components to be set, and is an inclusive OR
of the bits shown in <link linkend="table17.2">Table 17.2</link>.
</para>
@ -1379,13 +1379,13 @@ of the bits shown in <link linkend="table17.2">Table 17.2</link>.
<para>
After updating its compatibility map for the specified device, if
<emphasis>update_actions</emphasis>
<parameter>update_actions</parameter>
is
<symbol>True</symbol>,
the server applies the new compatibility map to its entire keyboard for the
device to generate a new set of key semantics, compatibility state, and a new
core keyboard map. If
<emphasis>update_actions</emphasis>
<parameter>update_actions</parameter>
is
<symbol>False</symbol>,
the new compatibility map is not used to generate any modifications to the
@ -1395,9 +1395,9 @@ configured to match another on a piecemeal basis; the map should not be applied
until everything is updated. To force an update at a later time, use
<function>XkbSetCompatMap</function>
specifying
<emphasis>which</emphasis>
<parameter>which</parameter>
as zero and
<emphasis>update_actions</emphasis>
<parameter>update_actions</parameter>
as
<symbol>True</symbol>.
</para>
@ -1427,7 +1427,7 @@ use
<funcprototype>
<funcdef>XkbSymInterpretPtr <function>XkbAddSymInterpret</function></funcdef>
<!-- (
<emphasis>xkb, si, updateMap, changes</emphasis>
<parameter>xkb, si, updateMap, changes</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1482,19 +1482,19 @@ use
<para>
<function>XkbAddSymInterpret</function>
adds
<emphasis>si</emphasis>
<parameter>si</parameter>
to the list of symbol interpretations in
<emphasis>xkb</emphasis>.
<parameter>xkb</parameter>.
If
<emphasis>updateMap</emphasis>
<parameter>updateMap</parameter>
is
<symbol>True</symbol>,
it (re)applies the compatibility map to all of the keys on the keyboard. If
<emphasis>changes</emphasis>
<parameter>changes</parameter>
is non-
<emphasis>NULL</emphasis>,
it reports the parts of the keyboard that were affected (unless
<emphasis>updateMap</emphasis>
<parameter>updateMap</parameter>
is
<symbol>True</symbol>,
not much changes).
@ -1643,7 +1643,7 @@ compatibility map if you do not already have one available. To do so, use
<funcprototype>
<funcdef>Status <function>XkbAllocCompatMap</function></funcdef>
<!-- (
<emphasis>xkb, which, num_si</emphasis>
<parameter>xkb, which, num_si</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1685,7 +1685,7 @@ compatibility map if you do not already have one available. To do so, use
</variablelist>
<para>
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
specifies the keyboard description for which compatibility maps are to be
allocated. The compatibility map is the
<emphasis>compat</emphasis>
@ -1694,18 +1694,18 @@ allocated. The compatibility map is the
<para>
<emphasis>which</emphasis>
<parameter>which</parameter>
specifies the compatibility map components to be allocated (see
<function>XkbGetCompatMap</function>,
in <link linkend="Getting_Compatibility_Map_Components_From_the_Server">section 17.2</link>).
<emphasis>which</emphasis>
<parameter>which</parameter>
is an inclusive OR of the bits shown in
<link linkend="table17.2">Table 17.2</link>.
</para>
<para>
<emphasis>num_si</emphasis>
<parameter>num_si</parameter>
specifies the total number of entries to allocate in the symbol interpretation
vector (
<emphasis>xkb.compat.sym_interpret</emphasis>
@ -1723,11 +1723,11 @@ is sufficient space in the symbol interpretation vector for entries to be
added, use
<function>XkbAllocCompatMap</function>
specifying
<emphasis>which</emphasis>
<parameter>which</parameter>
as
<emphasis>XkbSymInterpretMask</emphasis>
and the number of free symbol interpretations needed in
<emphasis>num_si</emphasis>.
<parameter>num_si</parameter>.
</para>
@ -1738,7 +1738,7 @@ added, use
if successful,
<errorname>BadMatch</errorname>
if
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
is
<emphasis>NULL</emphasis>,
or
@ -1758,7 +1758,7 @@ To free an entire compatibility map or selected portions of one, use
<funcprototype>
<funcdef>void <function>XkbFreeCompatMap</function></funcdef>
<!-- (
<emphasis>xkb, which, free_map</emphasis>
<parameter>xkb, which, free_map</parameter>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
@ -1801,25 +1801,25 @@ To free an entire compatibility map or selected portions of one, use
</variablelist>
<para>
<emphasis>which</emphasis>
<parameter>which</parameter>
specifies the compatibility map components to be freed (see
<function>XkbGetCompatMap</function>,
in <link linkend="Getting_Compatibility_Map_Components_From_the_Server">section 17.2</link>).
<emphasis>which</emphasis>
<parameter>which</parameter>
is an inclusive OR of the bits shown in
<link linkend="table17.2">Table 17.2</link>
</para>
<para>
<emphasis>free_map</emphasis>
<parameter>free_map</parameter>
indicates whether the
<emphasis>XkbCompatMap</emphasis>
structure itself should be freed. If
<emphasis>free_map</emphasis>
<parameter>free_map</parameter>
is
<symbol>True</symbol>,
<emphasis>which</emphasis>
<parameter>which</parameter>
is ignored, all non-
<emphasis>NULL</emphasis>
compatibility map components are freed, and the
@ -1827,7 +1827,7 @@ in <link linkend="Getting_Compatibility_Map_Components_From_the_Server">section
field in the
<emphasis>XkbDescRec</emphasis>
referenced by
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
is set to
<emphasis>NULL</emphasis>.
</para>

80
specs/XKB/ch18.xml
View file

@ -372,7 +372,7 @@ To obtain symbolic names from the server, use
<funcprototype>
<funcdef>Status <function>XkbGetNames</function></funcdef>
<!-- (
<emphasis>dpy, which, Xkb</emphasis>
<parameter>dpy, which, Xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -417,9 +417,9 @@ To obtain symbolic names from the server, use
<function>XkbGetNames</function>
retrieves symbolic names for the components of the keyboard extension from the
X server. The
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter specifies the name components to be updated in the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter, and is the bitwise inclusive OR of the valid names mask bits
defined in <link linkend="table18.1">Table 18.1</link>.
</para>
@ -429,23 +429,23 @@ defined in <link linkend="table18.1">Table 18.1</link>.
If the
<emphasis>names</emphasis>
field of the keyboard description
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
is
<emphasis>NULL</emphasis>,
<function>XkbGetNames</function>
allocates and initializes the
<emphasis>names</emphasis>
component of the keyboard description before obtaining the values specified by
<emphasis>which</emphasis>.
<parameter>which</parameter>.
If the
<emphasis>names</emphasis>
field of
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
is not
<emphasis>NULL</emphasis>,
<function>XkbGetNames</function>
obtains the values specified by
<emphasis>which</emphasis>
<parameter>which</parameter>
and copies them into the keyboard description
<emphasis>Xkb</emphasis>.
</para>
@ -455,7 +455,7 @@ If the
If the
<emphasis>map</emphasis>
component of the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
parameter is
<emphasis>NULL</emphasis>,
<function>XkbGetNames</function>
@ -464,7 +464,7 @@ If the
or
<emphasis>XkbKTLevelNamesMask</emphasis>
are set in
<emphasis>which</emphasis>.
<parameter>which</parameter>.
</para>
@ -520,7 +520,7 @@ structure and call
<funcprototype>
<funcdef>Bool <function>XkbSetNames</function></funcdef>
<!-- (
<emphasis>dpy, which, first_type, num_types, xkb</emphasis>
<parameter>dpy, which, first_type, num_types, xkb</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -587,26 +587,26 @@ structure and call
Use
<function>XkbSetNames</function>
to change many names at the same time. For each bit set in
<emphasis>which</emphasis>,
<parameter>which</parameter>,
<function>XkbSetNames</function>
takes the corresponding value (or values in the case of arrays) from the
keyboard description
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
and sends it to the server.
</para>
<para>
The
<emphasis>first_type</emphasis>
<parameter>first_type</parameter>
and
<emphasis>num_types</emphasis>
<parameter>num_types</parameter>
arguments are used only if
<emphasis>XkbKeyTypeNamesMask</emphasis>
or
<emphasis>XkbKTLevelNamesMask</emphasis>
is set in
<emphasis>which</emphasis>
<parameter>which</parameter>
and specify a subset of the types for which the corresponding names are to be
changed. If either or both of these mask bits are set but the specified types
are illegal,
@ -614,13 +614,13 @@ are illegal,
returns
<symbol>False</symbol>
and does not update any of the names specified in
<emphasis>which</emphasis>.
<parameter>which</parameter>.
The specified types are illegal if
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
does not include a map component or if
<emphasis>first_type</emphasis>
<parameter>first_type</parameter>
and
<emphasis>num_types</emphasis>
<parameter>num_types</parameter>
specify types that are not defined in the keyboard description.
</para>
@ -769,7 +769,7 @@ various kinds of symbolic names, as shown in
<funcprototype>
<funcdef>Bool <function>XkbChangeNames</function></funcdef>
<!-- (
<emphasis>dpy, xkb, changes</emphasis>
<parameter>dpy, xkb, changes</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -813,16 +813,16 @@ various kinds of symbolic names, as shown in
<para>
<function>XkbChangeNames</function>
copies any names specified by
<emphasis>changes</emphasis>
<parameter>changes</parameter>
from the keyboard description,
<emphasis>xkb</emphasis>,
<parameter>xkb</parameter>,
to the X server specified by
<emphasis>dpy</emphasis>.
<parameter>dpy</parameter>.
<function>XkbChangeNames</function>
aborts and returns
<symbol>False</symbol>
if any illegal type names or type shift level names are specified by
<emphasis>changes</emphasis>.
<parameter>changes</parameter>.
</para>
</sect3>
@ -926,9 +926,9 @@ When your application receives a X
<funcprototype>
<funcdef>void <function>XkbNoteNameChanges</function></funcdef>
<!-- (
<emphasis>old</emphasis>,
<emphasis>new</emphasis>,
<emphasis>wanted</emphasis>
<parameter>old</parameter>,
<parameter>new</parameter>,
<parameter>wanted</parameter>
) -->
<paramdef>XkbNameChangesPtr <parameter>old</parameter></paramdef>
@ -971,16 +971,16 @@ When your application receives a X
<para>
The
<emphasis>wanted</emphasis>
<parameter>wanted</parameter>
parameter is the bitwise inclusive OR of the valid names mask bits shown in
<link linkend="table18.1">Table 18.1</link>.
<function>XkbNoteNameChanges</function>
copies any changes that are reported in
<emphasis>new</emphasis>
<parameter>new</parameter>
and specified in
<emphasis>wanted</emphasis>
<parameter>wanted</parameter>
into the changes record specified by
<emphasis>old</emphasis>.
<parameter>old</parameter>.
</para>
@ -998,9 +998,9 @@ pass to
<funcprototype>
<funcdef>Status <function>XkbGetNameChanges</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>xkb</emphasis>,
<emphasis>changes</emphasis>
<parameter>dpy</parameter>,
<parameter>xkb</parameter>,
<parameter>changes</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -1044,10 +1044,10 @@ pass to
<para>
<function>XkbGetNameChanges</function>
examines the
<emphasis>changes</emphasis>
<parameter>changes</parameter>
parameter, retrieves the necessary information from the server, and places the
results into the
<emphasis>xkb</emphasis>
<parameter>xkb</parameter>
keyboard description.
</para>
@ -1084,7 +1084,7 @@ from the X server. Instead use
<funcprototype>
<funcdef>Status <function>XkbAllocNames</function></funcdef>
<!-- (
<emphasis>xkb, which, num_rg, num_key_aliases)</emphasis> -->
<parameter>xkb, which, num_rg, num_key_aliases)</parameter> -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
@ -1144,7 +1144,7 @@ from the X server. Instead use
<errorname>BadValue</errorname>
errors.
The
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter is the bitwise inclusive OR of the valid names mask bits defined in
<link linkend="table18.1">Table 18.1</link>.
</para>
@ -1166,7 +1166,7 @@ Use
<funcprototype>
<funcdef>void <function>XkbFreeNames</function></funcdef>
<!-- (
<emphasis>xkb, which, free_map)</emphasis> -->
<parameter>xkb, which, free_map)</parameter> -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
@ -1209,7 +1209,7 @@ Use
<para>
The
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter is the bitwise inclusive OR of the valid names mask bits defined in
<link linkend="table18.1">Table 18.1</link>.
</para>

114
specs/XKB/ch20.xml
View file

@ -169,10 +169,10 @@ To obtain this list, use
<funcprototype>
<funcdef>XkbComponentListPtr <function>XkbListComponents</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>ptrns</emphasis>,
<emphasis>max_inout</emphasis>
<parameter>dpy</parameter>,
<parameter>device_spec</parameter>,
<parameter>ptrns</parameter>,
<parameter>max_inout</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -228,12 +228,12 @@ To obtain this list, use
<function>XkbListComponents</function>
queries the server for a list of component names matching the patterns
specified in
<emphasis>ptrns</emphasis>.
<parameter>ptrns</parameter>.
It waits for a reply and returns the matching component names in an
<emphasis>XkbComponentListRec</emphasis>
structure. When you are done using the structure, you should free it using
<function>XkbFreeComponentList</function>.
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
indicates a particular device in which the caller is interested. A server is
allowed (but not required) to restrict its reply to portions of the database
that are relevant for that particular device.
@ -241,11 +241,11 @@ that are relevant for that particular device.
<para>
<emphasis>ptrns</emphasis>
<parameter>ptrns</parameter>
is a pointer to an
<emphasis>XkbComponentNamesRec</emphasis>,
described below. Each of the fields in
<emphasis>ptrns</emphasis>
<parameter>ptrns</parameter>
contains a pattern naming the components of interest. Each of the patterns is
composed of characters from the ISO
<emphasis>Latin1</emphasis>
@ -279,12 +279,12 @@ from the pattern.
<para>
<emphasis>max_inout</emphasis>
<parameter>max_inout</parameter>
is used to throttle the amount of data passed to and from the server. On
input, it specifies the maximum number of names to be returned (the total
number of names in all component categories). Upon return from
<function>XkbListComponents</function>,
<emphasis>max_inout</emphasis>
<parameter>max_inout</parameter>
contains the number of names that matched the request but were not returned
because of the limit.
</para>
@ -553,12 +553,12 @@ one, use
<funcprototype>
<funcdef>XkbDescPtr <function>XkbGetKeyboardByName</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>device_spec</emphasis>,
<emphasis>names</emphasis>,
<emphasis>want</emphasis>,
<emphasis>need</emphasis>,
<emphasis>load</emphasis>
<parameter>dpy</parameter>,
<parameter>device_spec</parameter>,
<parameter>names</parameter>,
<parameter>want</parameter>,
<parameter>need</parameter>,
<parameter>load</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -633,12 +633,12 @@ one, use
</variablelist>
<para>
<emphasis>names</emphasis>
<parameter>names</parameter>
contains a set of expressions describing the keyboard components the server
should use to build the new keyboard description.
<emphasis>want</emphasis>
<parameter>want</parameter>
and
<emphasis>need</emphasis>
<parameter>need</parameter>
are bit fields describing the parts of the resulting keyboard description that
should be present in the returned
<emphasis>XkbDescRec</emphasis>.
@ -647,7 +647,7 @@ should be present in the returned
<para>
The individual fields in
<emphasis>names</emphasis>
<parameter>names</parameter>
are
<emphasis>component expressions</emphasis>
composed of keyboard component names (no wildcarding as may be used in
@ -691,7 +691,7 @@ and
The special component name ‘
<emphasis>%</emphasis>
’ refers to the keyboard description for the device specified in
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
or the keymap names component. If a keymap names component is specified that
does not begin with ‘+’ or ‘|’ and does not contain ‘
<emphasis>%</emphasis>
@ -699,7 +699,7 @@ does not begin with ‘+’ or ‘|’ and does not contain ‘
<emphasis>%</emphasis>
’ refers to the description generated by the keymap names component.
Otherwise, it refers to the keyboard description for
<emphasis>device_spec</emphasis>.
<parameter>device_spec</parameter>.
</para>
</listitem>
<listitem>
@ -768,13 +768,13 @@ ordering are.</para></note>
<para>
Note that the presence of a keymap
<emphasis>names</emphasis>
<parameter>names</parameter>
component that does not contain ‘
<emphasis>%</emphasis>
’ (either explicit or implied by virtue of an expression starting with an
operator) indicates a description that is independent of the keyboard
description for the device specified in
<emphasis>device_spec</emphasis>.
<parameter>device_spec</parameter>.
The same is true of requests in which the keymap names component is empty and
all five other names components contain expressions void of references to
‘
@ -788,36 +788,36 @@ independent of any actual device.
The server parses all non-
<emphasis>NULL</emphasis>
fields in
<emphasis>names</emphasis>
<parameter>names</parameter>
and uses them to build a keyboard description. However, before parsing the
expressions in
<emphasis>names</emphasis>,
<parameter>names</parameter>,
the server ORs the bits in
<emphasis>want</emphasis>
<parameter>want</parameter>
and
<emphasis>need</emphasis>
<parameter>need</parameter>
together and examines the result in relationship to the expressions in
<emphasis>names</emphasis>.
<parameter>names</parameter>.
<link linkend="table20.3">Table 20.3</link>
identifies the components that are required for each of the
possible bits in
<emphasis>want</emphasis>
<parameter>want</parameter>
or
<emphasis>need</emphasis>.
<parameter>need</parameter>.
If a required component has not been specified in the
<emphasis>names</emphasis>
<parameter>names</parameter>
structure (the corresponding field is
<emphasis>NULL</emphasis>
), the server substitutes the expression "
<emphasis>%</emphasis>
", resulting in the component values being taken from
<emphasis>device_spec</emphasis>.
<parameter>device_spec</parameter>.
In addition, if
<emphasis>load</emphasis>
<parameter>load</parameter>
is
<symbol>True</symbol>,
the server modifies
<emphasis>names</emphasis>
<parameter>names</parameter>
if necessary (again using a "
<emphasis>%</emphasis>
" entry) to ensure all of the following fields are non-
@ -900,12 +900,12 @@ and
</table>
<para>
<emphasis>need</emphasis>
<parameter>need</parameter>
specifies a set of keyboard components that the server must be able to resolve
in order for
<function>XkbGetKeyboardByName</function>
to succeed; if any of the components specified in
<emphasis>need</emphasis>
<parameter>need</parameter>
cannot be successfully resolved,
<function>XkbGetKeyboardByName</function>
fails.
@ -913,49 +913,49 @@ in order for
<para>
<emphasis>want</emphasis>
<parameter>want</parameter>
specifies a set of keyboard components that the server should attempt to
resolve, but that are not mandatory. If the server is unable to resolve any of
these components,
<function>XkbGetKeyboardByName</function>
still succeeds. Bits specified in
<emphasis>want</emphasis>
<parameter>want</parameter>
that are also specified in
<emphasis>need</emphasis>
<parameter>need</parameter>
have no effect in the context of
<emphasis>want</emphasis>.
<parameter>want</parameter>.
</para>
<para>
If
<emphasis>load</emphasis>
<parameter>load</parameter>
is
<symbol>True</symbol>,
the server updates its keyboard description for
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
to match the result of the keyboard description just built. If load is
<symbol>False</symbol>,
the server’s description for device
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
is not updated. In all cases, the parts specified by
<emphasis>want</emphasis>
<parameter>want</parameter>
and
<emphasis>need</emphasis>
<parameter>need</parameter>
from the just-built keyboard description are returned.
</para>
<para>
The
<emphasis>names</emphasis>
<parameter>names</parameter>
structure in an
<emphasis>XkbDescRec</emphasis>
keyboard description record (see <xref linkend="Symbolic_Names" />) contains one field for each of
the five component types used to build a keyboard description. When a keyboard
description is built from a set of database components, the corresponding
fields in this
<emphasis>names</emphasis>
<parameter>names</parameter>
structure are set to match the expressions used to build the component.
</para>
@ -1067,9 +1067,9 @@ XkbGetNames(dpy, XkbKeyNamesMask | XkbKeyAliasesMask, Xkb)
<para>
There is no way to determine which components specified in
<emphasis>want</emphasis>
<parameter>want</parameter>
(but not in
<emphasis>need</emphasis>
<parameter>need</parameter>
) were actually fetched, other than breaking the call into successive calls to
<function>XkbGetKeyboardByName</function>
and specifying individual components.
@ -1113,9 +1113,9 @@ database, use
<funcprototype>
<funcdef>XkbDescPtr <function>XkbGetKeyboard</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>which</emphasis>,
<emphasis>device_spec</emphasis>
<parameter>dpy</parameter>,
<parameter>which</parameter>,
<parameter>device_spec</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -1168,11 +1168,11 @@ keyboard device. It calls
<para>
<function>XkbGetKeyboardByName</function>
(
<emphasis>dpy</emphasis>,
<emphasis>device_spec</emphasis>,
<parameter>dpy</parameter>,
<parameter>device_spec</parameter>,
<emphasis>NULL</emphasis>,
<emphasis>which</emphasis>,
<emphasis>which</emphasis>,
<parameter>which</parameter>,
<parameter>which</parameter>,
<symbol>False</symbol>
).
</para>

250
specs/XKB/ch21.xml
View file

@ -132,7 +132,7 @@ keyboard feedback and the core indicator feedback may be obtained by calling
and specifying
<emphasis>XkbUseCoreKbd</emphasis>
as the
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
; the values will be returned in
<emphasis>dflt_kbd_id</emphasis>
and
@ -376,7 +376,7 @@ indicator maps, indicator names or button actions on a non-
<funcprototype>
<funcdef>XkbDeviceInfoPtr <function>XkbGetDeviceInfo</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<parameter>dpy</parameter>,
which, device_spec, ind_class, ind_id) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -442,11 +442,11 @@ which, device_spec, ind_class, ind_id) -->
<para>
<function>XkbGetDeviceInfo</function>
returns information about the input device specified by
<emphasis>device_spec</emphasis>.
<parameter>device_spec</parameter>.
Unlike the
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
parameter of most Xkb functions,
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
does not need to be a keyboard device. It must, however, indicate either the
core keyboard or a valid X Input Extension device.
</para>
@ -454,7 +454,7 @@ core keyboard or a valid X Input Extension device.
<para>
The
<emphasis>which </emphasis>
<parameter>which</parameter>
parameter
is a mask specifying optional information to be returned. It is an inclusive OR
of one or more of the values from <link linkend="table21.1">Table 21.1</link>
@ -480,7 +480,7 @@ The
and
<emphasis>dflt_kbd_fb</emphasis>.
Other fields are filled in as specified by
<emphasis>which</emphasis>.
<parameter>which</parameter>.
</para>
@ -498,7 +498,7 @@ the server implementation, and a client may modify the associated behavior.
If the
<emphasis>XkbButtonActionsMask</emphasis>
bit is set in
<emphasis>which</emphasis>,
<parameter>which</parameter>,
the
<emphasis>XkbDeviceInfoRec</emphasis>
returned will have the button actions (
@ -509,7 +509,7 @@ the
<para>
If
<emphasis>which</emphasis>
<parameter>which</parameter>
includes one of the bits in XkbXI_IndicatorsMask, the feedback class of the
indicators must be specified in ind_class, and the feedback ID of the
indicators must be specified in ind_id. If the request does not include any of
@ -523,15 +523,15 @@ XListInputDevices request.
If any of the
<emphasis>XkbXI_IndicatorsMask</emphasis>
bits are set in
<emphasis>which</emphasis>,
<parameter>which</parameter>,
the
<emphasis>XkbDeviceInfoRec</emphasis>
returned will have filled in the portions of the
<emphasis>leds</emphasis>
structure corresponding to the indicator feedback identified by
<emphasis>ind_class</emphasis>
<parameter>ind_class</parameter>
and
<emphasis>ind_id</emphasis>.
<parameter>ind_id</parameter>.
The
<emphasis>leds</emphasis>
vector of the
@ -548,11 +548,11 @@ The
fields of the
<emphasis>leds</emphasis>
entry corresponding to
<emphasis>ind_class</emphasis>
<parameter>ind_class</parameter>
and
<emphasis>ind_id</emphasis>
<parameter>ind_id</parameter>
are always filled in. If
<emphasis>which</emphasis>
<parameter>which</parameter>
contains
<emphasis>XkbXI_IndicatorNamesMask</emphasis>,
the
@ -562,18 +562,18 @@ the
fields of the
<emphasis>leds</emphasis>
structure corresponding to
<emphasis>ind_class</emphasis>
<parameter>ind_class</parameter>
and
<emphasis>ind_id</emphasis>
<parameter>ind_id</parameter>
are returned.
If
<emphasis>which</emphasis>
<parameter>which</parameter>
contains
<emphasis>XkbXI_IndicatorStateMask</emphasis>,
the corresponding
<emphasis>state</emphasis>
field is updated. If
<emphasis>which</emphasis>
<parameter>which</parameter>
contains
<emphasis>XkbXI_IndicatorMapsMask</emphasis>,
the
@ -593,7 +593,7 @@ take an
<emphasis>XkbDeviceInfoPtr</emphasis>
as an input argument and operate on the X Input Extension device specified by
the
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
field of the structure. Only the parts of the structure indicated in the
function description are updated. The
<emphasis>XkbDeviceInfo</emphasis>
@ -619,7 +619,7 @@ XkbGetDeviceButtonActions.
<funcprototype>
<funcdef>Status <function>XkbGetDeviceButtonActions</function></funcdef>
<!-- (
<emphasis>dpy, device_info, all_buttons, first_button, num_buttons</emphasis>
<parameter>dpy, device_info, all_buttons, first_button, num_buttons</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -688,13 +688,13 @@ XkbGetDeviceButtonActions.
by the
<emphasis>device_spec</emphasis>
field of
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
and waits for a reply. If successful,
<function>XkbGetDeviceButtonActions</function>
backfills the button actions (
<emphasis>btn_acts</emphasis>
field of
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
) for only the requested buttons, updates the
<emphasis>name</emphasis>,
<emphasis>type</emphasis>,
@ -707,21 +707,21 @@ and
<para>
<emphasis>all_buttons</emphasis>,
<emphasis>first_button</emphasis>
<parameter>all_buttons</parameter>,
<parameter>first_button</parameter>
and
<emphasis>num_buttons</emphasis>
<parameter>num_buttons</parameter>
specify the device buttons for which actions should be returned. Setting
<emphasis>all_buttons</emphasis>
<parameter>all_buttons</parameter>
to
<symbol>True</symbol>
requests actions for all device buttons; if
<emphasis>all_buttons</emphasis>
<parameter>all_buttons</parameter>
is
<symbol>False</symbol>,
<emphasis>first_button</emphasis>
<parameter>first_button</parameter>
and
<emphasis>num_buttons</emphasis>
<parameter>num_buttons</parameter>
specify a range of buttons for which actions are requested.
</para>
@ -733,7 +733,7 @@ extension has not been properly initialized, XkbGetDeviceButtonActions returns
If allocation errors occur, a
<errorname>BadAlloc</errorname>
status is returned. If the specified device (
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>device_spec</emphasis>
) is invalid, a
@ -741,9 +741,9 @@ If allocation errors occur, a
status is returned. If the device has no buttons, a
<errorname>BadMatch</errorname>
status is returned. If
<emphasis>first_button</emphasis>
<parameter>first_button</parameter>
and
<emphasis>num_buttons</emphasis>
<parameter>num_buttons</parameter>
specify illegal buttons, a
<errorname>BadValue</errorname>
status is returned.
@ -761,7 +761,7 @@ of an input extension device, use XkbGetDeviceLedInfo.
<funcprototype>
<funcdef>Status <function>XkbGetDeviceLedInfo</function></funcdef>
<!-- (
<emphasis>dpy, device_i</emphasis>
<parameter>dpy, device_i</parameter>
nfo, led_class, led_id, which) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -828,23 +828,23 @@ nfo, led_class, led_id, which) -->
<function>XkbGetDeviceLedInfo</function>
queries the server for the desired LED information for the feedback specified
by
<emphasis>led_class</emphasis>
<parameter>led_class</parameter>
and
<emphasis>led_id</emphasis>
<parameter>led_id</parameter>
for the X input extension device indicated by
<emphasis>device_spec</emphasis>
-&gt;
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
and waits for a reply. If successful,
<function>XkbGetDeviceLedInfo</function>
backfills the relevant fields of
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
as determined by
<emphasis>which</emphasis>
<parameter>which</parameter>
with the results and returns
<symbol>Success</symbol>.
Valid values for
<emphasis>which</emphasis>
<parameter>which</parameter>
are the inclusive OR of any of
<emphasis>XkbXI_IndicatorNamesMask</emphasis>,
<emphasis>XkbXI_IndicatorMapsMask</emphasis>,
@ -855,7 +855,7 @@ and
<para>
The fields of
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
that are filled in when this request succeeds are
<emphasis>name, type, supported</emphasis>,
and
@ -863,11 +863,11 @@ and
and portions of the
<emphasis>leds</emphasis>
structure corresponding to
<emphasis>led_class</emphasis>
<parameter>led_class</parameter>
and
<emphasis>led_id</emphasis>
<parameter>led_id</parameter>
as indicated by the bits set in
<emphasis>which</emphasis>.
<parameter>which</parameter>.
The
<emphasis>device_info-&gt;leds</emphasis>
vector is allocated if necessary and
@ -875,25 +875,25 @@ The
and
<emphasis>num_leds</emphasis>
filled in. The
<emphasis>led_class</emphasis>,
<emphasis>led_id</emphasis>
<parameter>led_class</parameter>,
<parameter>led_id</parameter>
and
<emphasis>phys_indicators</emphasis>
fields of the
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>leds</emphasis>
entry corresponding to
<emphasis>led_class</emphasis>
<parameter>led_class</parameter>
and
<emphasis>led_id</emphasis>
<parameter>led_id</parameter>
are always filled in.
</para>
<para>
If
<emphasis>which</emphasis>
<parameter>which</parameter>
contains
<emphasis>XkbXI_IndicatorNamesMask</emphasis>,
the
@ -901,21 +901,21 @@ the
and
<emphasis>names</emphasis>
fields of the
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>leds</emphasis>
structure corresponding to
<emphasis>led_class</emphasis>
<parameter>led_class</parameter>
and
<emphasis>led_id</emphasis>
<parameter>led_id</parameter>
are updated, if
<emphasis>which</emphasis>
<parameter>which</parameter>
contains
<emphasis>XkbXI_IndicatorStateMask</emphasis>,
the corresponding
<emphasis>state</emphasis>
field is updated, and if
<emphasis>which</emphasis>
<parameter>which</parameter>
contains
<emphasis>XkbXI_IndicatorMapsMask</emphasis>,
the
@ -1009,16 +1009,16 @@ To obtain an
allocates space for an
<emphasis>XkbDeviceInfoRec</emphasis>
structure and initializes that structure’s
<emphasis>device_spec</emphasis>
<parameter>device_spec</parameter>
field with the device ID specified by device_spec. If
<emphasis>n_buttons</emphasis>
<parameter>n_buttons</parameter>
is nonzero,
<emphasis>n_buttons</emphasis>
<parameter>n_buttons</parameter>
<emphasis>XkbActions</emphasis>
are linked into the
<emphasis>XkbDeviceInfoRec</emphasis>
structure and initialized to zero. If sz_leds is nonzero,
<emphasis>sz_leds</emphasis>
<parameter>sz_leds</parameter>
<emphasis>XkbDeviceLedInfoRec</emphasis>
structures are also allocated and linked into the
<emphasis>XkbDeviceInfoRec</emphasis>
@ -1074,9 +1074,9 @@ To obtain an
allocates space for an
<emphasis>XkbDeviceLedInfoRec</emphasis>
and places it in
<emphasis>device_info</emphasis>.
<parameter>device_info</parameter>.
If num_needed is nonzero,
<emphasis>num_needed</emphasis>
<parameter>num_needed</parameter>
<emphasis>XkbIndicatorMapRec</emphasis>
structures are also allocated and linked into the
<emphasis>XkbDeviceLedInfoRec</emphasis>
@ -1141,28 +1141,28 @@ To initialize an
<para>
<function>XkbAddDeviceLedInfo</function>
first checks to see whether an entry matching
<emphasis>led_class</emphasis>
<parameter>led_class</parameter>
and
<emphasis>led_id</emphasis>
<parameter>led_id</parameter>
already exists in the
<emphasis>device_info-&gt;leds</emphasis>
array. If it finds a matching entry, it returns a pointer to that entry.
Otherwise, it checks to be sure there is at least one empty entry in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>leds</emphasis>
and extends it if there is not enough room. It then increments
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>num_leds</emphasis>
and fills in the next available entry in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>leds</emphasis>
with
<emphasis>led_class</emphasis>
<parameter>led_class</parameter>
and
<emphasis>led_id</emphasis>.
<parameter>led_id</parameter>.
</para>
@ -1173,13 +1173,13 @@ If successful,
<emphasis>XkbDeviceLedInfoRec</emphasis>
structure that was initialized. If unable to allocate sufficient storage, or
if
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
points to an invalid
<emphasis>XkbDeviceInfoRec</emphasis>
structure, or if
<emphasis>led_class</emphasis>
<parameter>led_class</parameter>
or
<emphasis>led_id</emphasis>
<parameter>led_id</parameter>
are inappropriate,
<function>XkbAddDeviceLedInfo</function>
returns
@ -1230,17 +1230,17 @@ To allocate additional space for button actions in an
<para>
<emphasis>XkbResizeDeviceButton</emphasis>
reallocates space, if necessary, to make sure there is room for a total of
<emphasis>new_total</emphasis>
<parameter>new_total</parameter>
button actions in the
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
structure. Any new entries allocated are zeroed. If successful,
<emphasis>XkbResizeDeviceButton</emphasis>
returns Success. If new_total is zero, all button actions are deleted,
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>num_btns</emphasis>
is set to zero, and
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>btn_acts</emphasis>
is set to
@ -1310,56 +1310,56 @@ If free_all is
the
<function>XkbFreeDeviceInfo</function>
frees all components of
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
and the
<emphasis>XkbDeviceInfoRec</emphasis>
structure pointed to by
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
itself. If free_all is
<symbol>False</symbol>,
the value of which determines which subcomponents are freed.
<emphasis>which </emphasis>
<parameter>which</parameter>
is an inclusive OR of one or more of the values from
<link linkend="table21.1">Table 21.1</link>. If which
contains XkbXI_ButtonActionsMask, all button actions associated with
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
are freed,
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>btn_acts</emphasis>
is set to
<emphasis>NULL</emphasis>,
and
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>num_btns</emphasis>
is set to zero. If which contains all bits in XkbXI_IndicatorsMask, all
<emphasis>XkbDeviceLedInfoRec</emphasis>
structures associated with
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
are freed,
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>leds</emphasis>
is set to
<emphasis>NULL</emphasis>,
and
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>sz_leds</emphasis>
and
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>num_leds</emphasis>
are set to zero. If which contains XkbXI_IndicatorMapsMask, all indicator maps
associated with
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
are cleared, but the number of LEDs and the leds structures themselves are
preserved. If which contains XkbXI_IndicatorNamesMask, all indicator names
associated with device_info are cleared, but the number of LEDs and the leds
structures themselves are preserved. If which contains
XkbXI_IndicatorStateMask, the indicator state associated with the
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
leds are set to zeros but the number of LEDs and the leds structures
themselves are preserved.
</para>
@ -1431,7 +1431,7 @@ use XkbSetDeviceInfo.
<funcprototype>
<funcdef>Bool <function>XkbSetDeviceInfo</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<parameter>dpy</parameter>,
which, device_info) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -1476,12 +1476,12 @@ which, device_info) -->
<function>XkbSetDeviceInfo</function>
sends a request to the server to modify the characteristics of the device
specified in the
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
structure. The particular characteristics modified are identified by the bits
set in
<emphasis>which</emphasis>
<parameter>which</parameter>
and take their values from the relevant fields in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
(see <link linkend="table21.1">Table 21.1</link>).
<function>XkbSetDeviceInfo</function>
returns
@ -1495,14 +1495,14 @@ Xkb Extension, the function does nothing and returns
<para>
The
<emphasis>which</emphasis>
<parameter>which</parameter>
parameter specifies which aspects of the device should be changed and is a
bitmask composed of an inclusive OR or one or more of the following bits:
<emphasis>XkbXI_ButtonActionsMask</emphasis>,
<emphasis>XkbXI_IndicatorNamesMask</emphasis>,
<emphasis>XkbXI_IndicatorMapsMask</emphasis>.
If the features requested to be manipulated in
<emphasis>which</emphasis>
<parameter>which</parameter>
are valid for the device, but the server does not support assignment of one or
more of them, that particular portion of the request is ignored.
</para>
@ -1510,7 +1510,7 @@ more of them, that particular portion of the request is ignored.
<para>
If the device specified in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>device_spec</emphasis>
does not contain buttons and a request affecting buttons is made, or the
@ -1529,11 +1529,11 @@ extension allows applications to assign key actions to buttons on input
extension devices other than the core keyboard device. If the
<emphasis>XkbXI_ButtonActionsMask</emphasis>
is set in
<emphasis>which</emphasis>,
<parameter>which</parameter>,
the actions for all buttons specified in device_info are set to the
<emphasis>XkbAction</emphasis>
s specified in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>btn_acts</emphasis>.
If the number of buttons requested to be updated is not valid for the device,
@ -1565,20 +1565,20 @@ If the
and / or
<emphasis>XkbXI_IndicatorNamesMask</emphasis>
flag is set in
<emphasis>which</emphasis>,
<parameter>which</parameter>,
the indicator maps and / or names for all
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>num_leds</emphasis>
indicator devices specified in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>leds</emphasis>
are set to the maps and / or names specified in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>leds</emphasis>.
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>leds</emphasis>
-&gt;
@ -1596,7 +1596,7 @@ If they have legal values but do not specify a keyboard or indicator class
feedback for the device in question, a
<errorname>BadMatch</errorname>
error results. If any of the values in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>leds</emphasis>
<emphasis>-&gt;</emphasis>
@ -1629,7 +1629,7 @@ XkbSetDeviceButtonActions.
<funcprototype>
<funcdef>Bool <function>XkbSetDeviceButtonActions</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<parameter>dpy</parameter>,
device, first_button, num_buttons, actions) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -1687,11 +1687,11 @@ device, first_button, num_buttons, actions) -->
device_info-&gt;
<emphasis>device_spec</emphasis>.
Actions are assigned to
<emphasis>num_buttons</emphasis>
<parameter>num_buttons</parameter>
buttons beginning with
<emphasis>first_button</emphasis>
<parameter>first_button</parameter>
and are taken from the actions specified in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>btn_acts</emphasis>.
</para>
@ -1704,11 +1704,11 @@ buttons,
has no effect and returns
<symbol>False</symbol>.
If the device has no buttons or if
<emphasis>first_button</emphasis>
<parameter>first_button</parameter>
or
<emphasis>num_buttons</emphasis>
<parameter>num_buttons</parameter>
specify buttons outside of the valid range as determined by
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>num_btns</emphasis>,
the function has no effect and returns
@ -1729,7 +1729,7 @@ device_info-&gt;
<emphasis>device_spec</emphasis>,
a <errorname>BadKeyboard</errorname>
protocol error results. If the actual device specified in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>device_spec</emphasis>
does not contain buttons and a request affecting buttons is made, a
@ -1903,7 +1903,7 @@ To note device changes reported in an
<funcprototype>
<funcdef>void <function>XkbNoteDeviceChanges</function></funcdef>
<!-- (
<emphasis>old, new, wanted</emphasis>
<parameter>old, new, wanted</parameter>
) -->
<paramdef>XkbDeviceChangesPtr <parameter>old</parameter></paramdef>
@ -1946,23 +1946,23 @@ To note device changes reported in an
<para>
The wanted field specifies the changes that should be noted in
<emphasis>old</emphasis>,
<parameter>old</parameter>,
and is composed of the bitwise inclusive OR of one or more of the masks from
<link linkend="table21.1">Table 21.1</link>.
The
<emphasis>reason</emphasis>
field of the event in
<emphasis>new</emphasis>
<parameter>new</parameter>
indicates the types of changes the event is reporting.
<function>XkbNoteDeviceChanges</function>
updates the
<emphasis>XkbDeviceChangesRec</emphasis>
specified by
<emphasis>old</emphasis>
<parameter>old</parameter>
with the changes that are both specified in
<emphasis>wanted</emphasis>
<parameter>wanted</parameter>
and contained in
<emphasis>new</emphasis>
<parameter>new</parameter>
-&gt;
<emphasis>reason</emphasis>.
</para>
@ -1988,8 +1988,8 @@ XkbGetDeviceInfoChanges.
<funcprototype>
<funcdef>Status <function>XkbGetDeviceInfoChanges</function></funcdef>
<!-- (
<emphasis>dpy</emphasis>,
<emphasis>device_info</emphasis>,
<parameter>dpy</parameter>,
<parameter>device_info</parameter>,
changes) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -2033,17 +2033,17 @@ changes) -->
<para>
The changes-&gt;changed field indicates which attributes of the device
specified in
<emphasis>changes</emphasis>
<parameter>changes</parameter>
-&gt;
<emphasis>device</emphasis>
have changed. The parameters describing the changes are contained in the other
fields of
<emphasis>changes</emphasis>.
<parameter>changes</parameter>.
<function>XkbGetDeviceInfoChanges</function>
uses that information to call XkbGetDeviceInfo to obtain the current status of
those attributes that have changed. It then updates the local description of
the device in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
with the new information.
</para>
@ -2059,7 +2059,7 @@ XkbDeviceChangesRec, use XkbChangeDeviceInfo.
<funcprototype>
<funcdef>Bool <function>XkbChangeDeviceInfo</function></funcdef>
<!-- (
<emphasis>dpy, device_info, changes</emphasis>
<parameter>dpy, device_info, changes</parameter>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
@ -2103,13 +2103,13 @@ XkbDeviceChangesRec, use XkbChangeDeviceInfo.
<para>
<function>XkbChangeDeviceInfo</function>
updates the server’s description of the device specified in
<emphasis>device_info</emphasis>
<parameter>device_info</parameter>
-&gt;
<emphasis>device_spec</emphasis>
with the changes specified in
<emphasis>changes</emphasis>
<parameter>changes</parameter>
and contained in
<emphasis>device_info</emphasis>.
<parameter>device_info</parameter>.
The update is made by an XkbSetDeviceInfo request.
</para>

46
specs/XKB/ch22.xml
View file

@ -24,7 +24,7 @@ To change the values of any of the debug controls, use
<funcprototype>
<funcdef>Bool <function>XkbSetDebuggingFlags</function></funcdef>
<!-- (
<emphasis>display, mask, flags, msg, ctrls_mask, ctrls, ret_flags, ret_ctrls</emphasis>
<parameter>display, mask, flags, msg, ctrls_mask, ctrls, ret_flags, ret_ctrls</parameter>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
@ -123,62 +123,62 @@ To change the values of any of the debug controls, use
<para>
<function>XkbSetDebuggingFlags</function>
modifies the debug output flags as specified by
<emphasis>mask</emphasis>
<parameter>mask</parameter>
and
<emphasis>flags</emphasis>,
<parameter>flags</parameter>,
modifies the debug controls flags as specified by
<emphasis>ctrls_mask</emphasis>
<parameter>ctrls_mask</parameter>
and
<emphasis>ctrls</emphasis>,
<parameter>ctrls</parameter>,
prints the message
<emphasis>msg</emphasis>,
<parameter>msg</parameter>,
and backfills
<emphasis>ret_flags</emphasis>
<parameter>ret_flags</parameter>
and
<emphasis>ret_ctrls</emphasis>
<parameter>ret_ctrls</parameter>
with the resulting debug output and debug controls flags.
</para>
<para>
When bits are set in the debug output masks,
<emphasis>mask</emphasis>
<parameter>mask</parameter>
and
<emphasis>flags</emphasis>,
<parameter>flags</parameter>,
Xkb prints debug information corresponding to each bit at appropriate points
during its processing. The device to which the output is written is
implementation-dependent, but is normally the same device to which X server
error messages are directed; thus the bits that can be set in
<emphasis>mask</emphasis>
<parameter>mask</parameter>
and
<emphasis>flags</emphasis>
<parameter>flags</parameter>
is implementation-specific. To turn on a debug output selection, set the bit
for the output in the
<emphasis>mask</emphasis>
<parameter>mask</parameter>
parameter and set the corresponding bit in the
<emphasis>flags</emphasis>
<parameter>flags</parameter>
parameter. To turn off event selection for an event, set the bit for the
output in the
<emphasis>mask</emphasis>
<parameter>mask</parameter>
parameter and do not set the corresponding bit in the
<emphasis>flags</emphasis>
<parameter>flags</parameter>
parameter.
</para>
<para>
When bits are set in the debug controls masks,
<emphasis>ctrls_mask</emphasis>
<parameter>ctrls_mask</parameter>
and
<emphasis>ctrls</emphasis>,
<parameter>ctrls</parameter>,
Xkb modifies its behavior according to each controls bit.
<emphasis>ctrls_mask</emphasis>
<parameter>ctrls_mask</parameter>
and
<emphasis>ctrls</emphasis>
<parameter>ctrls</parameter>
are related in the same way that
<emphasis>mask</emphasis>
<parameter>mask</parameter>
and
<emphasis>flags</emphasis>
<parameter>flags</parameter>
are. The valid controls bits are defined in
<link linkend="table22.1">Table 22.1</link>.
</para>
@ -230,7 +230,7 @@ it is disabled,
<para>
The message in
<emphasis>msg</emphasis>
<parameter>msg</parameter>
is written immediately. The device to which it is written is implementation
dependent but is normally the same device where X server error messages are
directed.