summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@oracle.com>2014-07-19 23:53:48 -0700
committerAlan Coopersmith <alan.coopersmith@oracle.com>2014-07-19 23:55:38 -0700
commit9c0be82017f513e2eb63d59b095f1cf1955f2e2b (patch)
tree8ffbca219943f698545f62f347a81819b7b8be9b
parent75b0b10990f38d966c6fcc821bf15e58c5a90c91 (diff)
specs/XKB: Trim leading spaces off text lines
perl -i -p -e 's{/\*(\S)}{/* \1}g;' *.xml Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
-rw-r--r--specs/XKB/ch01.xml10
-rw-r--r--specs/XKB/ch02.xml158
-rw-r--r--specs/XKB/ch03.xml28
-rw-r--r--specs/XKB/ch04.xml126
-rw-r--r--specs/XKB/ch05.xml150
-rw-r--r--specs/XKB/ch06.xml58
-rw-r--r--specs/XKB/ch07.xml114
-rw-r--r--specs/XKB/ch08.xml514
-rw-r--r--specs/XKB/ch09.xml176
-rw-r--r--specs/XKB/ch10.xml1260
-rw-r--r--specs/XKB/ch11.xml112
-rw-r--r--specs/XKB/ch12.xml170
-rw-r--r--specs/XKB/ch13.xml406
-rw-r--r--specs/XKB/ch14.xml378
-rw-r--r--specs/XKB/ch15.xml598
-rw-r--r--specs/XKB/ch16.xml1174
-rw-r--r--specs/XKB/ch17.xml384
-rw-r--r--specs/XKB/ch18.xml206
-rw-r--r--specs/XKB/ch19.xml108
-rw-r--r--specs/XKB/ch20.xml166
-rw-r--r--specs/XKB/ch21.xml520
-rw-r--r--specs/XKB/ch22.xml46
-rw-r--r--specs/XKB/glossary.xml82
23 files changed, 3472 insertions, 3472 deletions
diff --git a/specs/XKB/ch01.xml b/specs/XKB/ch01.xml
index 0cce431f..79aed476 100644
--- a/specs/XKB/ch01.xml
+++ b/specs/XKB/ch01.xml
@@ -128,7 +128,7 @@ keyboard. Internally, the server maintains a
<firstterm>keyboard description</firstterm>
<indexterm significance="preferred" zone="keyboard_description">
<primary>keyboard description</primary></indexterm>
- that includes the keyboard state and configuration (mapping). By
+that includes the keyboard state and configuration (mapping). By
<quote>keyboard</quote> we
mean the logical keyboard device, which includes not only the physical keys,
but also potentially a set of up to 32 indicators (usually LEDs) and bells.
@@ -249,7 +249,7 @@ key is logically released. Consequently, at most one key in a radio group can
be logically depressed at one time. A radio group is defined by a radio group
index, an optional name, and by assigning each key in the radio group
<symbol>XkbKB_RadioGroup</symbol>
- behavior and the radio group index.
+behavior and the radio group index.
</para>
</sect2>
@@ -322,7 +322,7 @@ The Xkb extension adds a single protocol error,
<errorname>BadKeyboard</errorname>,
to the core protocol error set. See <link linkend="Protocol_Errors">section 2.6</link> for a discussion of the
<errorname>BadKeyboard</errorname>
- protocol error.
+protocol error.
</para>
@@ -369,9 +369,9 @@ and server versions are incompatible, these functions return an error
indication as shown in <link linkend="table1.1">Table 1.1</link>.
Because of this test,
<errorname>BadAccess</errorname>
- and
+and
<errorname>BadMatch</errorname>
- (due to incompatible versions) protocol errors should normally not be
+(due to incompatible versions) protocol errors should normally not be
generated.
</para>
diff --git a/specs/XKB/ch02.xml b/specs/XKB/ch02.xml
index a5790022..ca0616e6 100644
--- a/specs/XKB/ch02.xml
+++ b/specs/XKB/ch02.xml
@@ -26,7 +26,7 @@ functions.
<filename class="headerfile">XKBstr.h</filename> declares types and
constants for Xkb. It is included automatically from
<filename class="headerfile">&lt;X11/XKBlib.h&gt;</filename>;
- you should never need to reference it directly in your application code.
+you should never need to reference it directly in your application code.
</para>
</listitem>
<listitem>
@@ -37,7 +37,7 @@ constants for Xkb. It is included automatically from
<filename class="headerfile">XKB.h</filename>
defines constants for Xkb. It is included automatically from
<filename class="headerfile">&lt;X11/XKBstr.h&gt;</filename>;
- you should never need to reference it directly in your application code.
+you should never need to reference it directly in your application code.
</para>
</listitem>
<listitem>
@@ -66,11 +66,11 @@ The name of the Xkb extension is given in
<para>
Most extensions to the X protocol are initialized by calling
<function>XInitExtension</function>
- and passing the extension name. However, as explained in <link linkend="Initializing_the_Keyboard_Extension">section 2.4</link>, Xkb
+and passing the extension name. However, as explained in <link linkend="Initializing_the_Keyboard_Extension">section 2.4</link>, Xkb
requires a more complex initialization sequence, and a client program should
not call
<function>XInitExtension</function>
- directly.
+directly.
</para>
</sect1>
<sect1 id='Determining_Library_Compatibility'>
@@ -134,11 +134,11 @@ To determine the compatibility of a library at runtime, call
<para>
Pass the symbolic value
<symbol>XkbMajorVersion</symbol>
- in
+in
<parameter>lib_major_in_out</parameter>
- and
+and
<symbol>XkbMinorVersion</symbol>
- in
+in
<parameter>lib_minor_in_out</parameter>.
These arguments represent the version of the library used at compile time.
The
@@ -146,7 +146,7 @@ The
function backfills the major and minor version numbers of the library used at
run time in
<parameter>lib_major_in_out</parameter>
- and
+and
<parameter>lib_minor_in_out</parameter>.
If the versions of the compile time and run time libraries are compatible,
<function>XkbLibraryVersion</function>
@@ -161,7 +161,7 @@ In addition, in order to use the Xkb extension, you must ensure that the
extension is present in the server and that the server supports the version of
the extension expected by the client. Use
<function>XkbQueryExtension</function>
- to do this, as described in the next section.
+to do this, as described in the next section.
</para>
</sect1>
@@ -170,21 +170,21 @@ the extension expected by the client. Use
<para>
Call
<function>XkbQueryExtension</function>
- to check for the presence and compatibility of the extension in the server and
+to check for the presence and compatibility of the extension in the server and
to initialize the extension. Because of potential version mismatches, you
cannot use the generic extension mechanism functions
(<function>XQueryExtension</function>
and
<function>XInitExtension</function>)
- for checking for the presence of, and initializing the Xkb extension.
+for checking for the presence of, and initializing the Xkb extension.
</para>
<para>
You must call
<function>XkbQueryExtension</function>
- or
+or
<function>XkbOpenDisplay</function>
- before using any other Xkb library interfaces, unless such usage is explicitly
+before using any other Xkb library interfaces, unless such usage is explicitly
allowed in the interface description in this document. The exceptions are:
<function>XkbIgnoreExtension</function>,
<function>XkbLibraryVersion</function>,
@@ -193,7 +193,7 @@ functions if the extension is not present or is uninitialized. In general,
calls to Xkb library functions made prior to initializing the Xkb extension
cause
<errorname>BadAccess</errorname>
- protocol errors.
+protocol errors.
<indexterm zone="Initializing_the_Keyboard_Extension"><primary>errors</primary>
<secondary><errorname>BadAccess</errorname></secondary></indexterm>
<indexterm zone="Initializing_the_Keyboard_Extension">
@@ -202,7 +202,7 @@ cause
<para>
<function>XkbQueryExtension</function>
- both determines whether a compatible Xkb extension is present in the X server
+both determines whether a compatible Xkb extension is present in the X server
and initializes the extension when it is present.
</para>
@@ -288,19 +288,19 @@ and initializes the extension when it is present.
<para>
The
<function>XkbQueryExtension</function>
- function determines whether a compatible version of the X Keyboard Extension
+function determines whether a compatible version of the X Keyboard Extension
is present in the server. If a compatible extension is present,
<function>XkbQueryExtension</function>
- returns
+returns
<symbol>True</symbol>;
- otherwise, it returns
+otherwise, it returns
<symbol>False</symbol>.
</para>
<para>
If a compatible version of Xkb is present,
<function>XkbQueryExtension</function>
- initializes the extension. It backfills the major opcode for the keyboard
+initializes the extension. It backfills the major opcode for the keyboard
extension in
<parameter>opcode_rtrn</parameter>,
the base event code in
@@ -309,18 +309,18 @@ the base error code in
<parameter>error_rtrn</parameter>,
and the major and minor version numbers of the extension in
<parameter>major_in_out</parameter>
- and
+and
<parameter>minor_in_out</parameter>.
The major opcode is reported in the
<structfield>req_major</structfield>
- fields of some Xkb events. For a discussion of the base event code, see
+fields of some Xkb events. For a discussion of the base event code, see
<link linkend="Xkb_Event_Types">section 4.1</link>.
</para>
<para>
As a convenience, you can use the function
<function>XkbOpenDisplay</function>
- to perform these three tasks at once: open a connection to an X server, check
+to perform these three tasks at once: open a connection to an X server, check
for a compatible version of the Xkb extension in both the library and the
server, and initialize the extension for use.
</para>
@@ -410,34 +410,34 @@ reason_rtrn)</parameter> -->
is a convenience function that opens an X display connection and initializes
the X keyboard extension. In all cases, upon return
<parameter>reason_rtrn</parameter>
- contains a status value indicating success or the type of failure. If
+contains a status value indicating success or the type of failure. If
<parameter>major_in_out</parameter>
- and
+and
<parameter>minor_in_out</parameter>
- are not
+are not
<symbol>NULL</symbol>,
<function>XkbOpenDisplay</function>
- first calls
+first calls
<function>XkbLibraryVersion</function>
- to determine whether the client library is compatible, passing it the values
+to determine whether the client library is compatible, passing it the values
pointed to by
<parameter>major_in_out</parameter>
- and
+and
<parameter>minor_in_out</parameter>.
If the library is incompatible,
<function>XkbOpenDisplay</function>
- backfills
+backfills
<parameter>major_in_out</parameter>
- and
+and
<parameter>minor_in_out</parameter>
- with the major and minor extension versions of the library being used and
+with the major and minor extension versions of the library being used and
returns
<symbol>NULL</symbol>.
If the library is compatible,
<function>XkbOpenDisplay</function>
next calls
<function>XOpenDisplay</function>
- with the
+with the
<parameter>display_name</parameter>.
If this fails, the function returns
<symbol>NULL</symbol>.
@@ -445,10 +445,10 @@ If successful,
<function>XkbOpenDisplay</function>
calls
<function>XkbQueryExtension</function>
- and
+and
backfills the major and minor Xkb server extension version numbers in
<parameter>major_in_out</parameter>
- and
+and
<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,
@@ -467,7 +467,7 @@ The possible values for
<listitem>
<para>
<errorname>XkbOD_BadLibraryVersion</errorname>
- indicates
+indicates
<function>XkbLibraryVersion</function>
returned
<symbol>False</symbol>.
@@ -476,25 +476,25 @@ returned
<listitem>
<para>
<errorname>XkbOD_ConnectionRefused</errorname>
- indicates the display could not be opened.
+indicates the display could not be opened.
</para>
</listitem>
<listitem>
<para>
<errorname>XkbOD_BadServerVersion</errorname>
- indicates the library and the server have incompatible extension versions.
+indicates the library and the server have incompatible extension versions.
</para>
</listitem>
<listitem>
<para>
<errorname>XkbOD_NonXkbServer</errorname>
- indicates the extension is not present in the X server.
+indicates the extension is not present in the X server.
</para>
</listitem>
<listitem>
<para>
<errorname>XkbOD_Success</errorname>
- indicates that the function succeeded.
+indicates that the function succeeded.
</para>
</listitem>
</itemizedlist>
@@ -514,10 +514,10 @@ functionality.
<para>
Call
<function>XkbIgnoreExtension</function>
- to prevent core X library keyboard functions from using the X Keyboard
+to prevent core X library keyboard functions from using the X Keyboard
Extension. You must call
<function>XkbIgnoreExtension</function>
- before you open a server connection; Xkb does not provide a way to enable or
+before you open a server connection; Xkb does not provide a way to enable or
disable use of the extension once a connection is established.
</para>
@@ -547,7 +547,7 @@ disable use of the extension once a connection is established.
<para>
<function>XkbIgnoreExtension</function>
- tells the X library whether to use the X Keyboard Extension on any
+tells the X library whether to use the X Keyboard Extension on any
subsequently opened X display connections. If ignore is
<symbol>True</symbol>,
the library does not initialize the Xkb extension when it opens a new
@@ -556,12 +556,12 @@ with the client using only core protocol requests and events. If ignore is
<symbol>False</symbol>,
the library treats subsequent calls to
<function>XOpenDisplay</function>
- normally and uses Xkb extension requests, events, and state. Do not explicitly
+normally and uses Xkb extension requests, events, and state. Do not explicitly
use Xkb on a connection for which it is disabled.
<function>XkbIgnoreExtension</function>
- returns
+returns
<symbol>False</symbol>
- if it was unable to apply the ignore request.
+if it was unable to apply the ignore request.
</para>
</sect1>
@@ -574,9 +574,9 @@ use Xkb on a connection for which it is disabled.
Many of the Xkb extension library functions described in this document can
cause the X server to report an error, referred to in this document as a
<errorname>Bad<replaceable>Xxx</replaceable></errorname>
- protocol error, where
+protocol error, where
<replaceable>Xxx</replaceable>
- is some name. These errors are fielded in the normal manner, by the default
+is some name. These errors are fielded in the normal manner, by the default
Xlib error handler or one replacing it. Note that X protocol errors are not
necessarily reported immediately because of the buffering of X protocol
requests in Xlib and the server.
@@ -679,17 +679,17 @@ The Xkb extension adds a single protocol error,
<errorname>BadKeyboard</errorname>,
to the core protocol error set. This error code will be reported as the
<parameter>error_rtrn</parameter>
- when
+when
<function>XkbQueryExtension</function>
- is called. When a
+is called. When a
<errorname>BadKeyboard</errorname>
- error is reported in an
+error is reported in an
<structname>XErrorEvent</structname>,
additional information is reported in the
<structfield>resourceid</structfield>
- field. The most significant byte of the
+field. The most significant byte of the
<structfield>resource_id</structfield>
- is a further refinement of the error cause, as defined in
+is a further refinement of the error cause, as defined in
<link linkend="table2.2">Table 2.2</link>. The least
significant byte will contain the device, class, or feedback ID as indicated in
the table.
@@ -753,31 +753,31 @@ indicated ID
<para>
Where a connection to the server is passed as an argument (Display*) and an
<type>XkbDescPtr</type>
- is also passed as an argument, the Display* argument must match the
+is also passed as an argument, the Display* argument must match the
<structfield>dpy</structfield>
- field of the
+field of the
<structname>XkbDescRec</structname>
- pointed to by the
+pointed to by the
<type>XkbDescPtr</type>
- argument, or else the
+argument, or else the
<structfield>dpy</structfield>
- field of the
+field of the
<structname>XkbDescRec</structname>
- must be
+must be
<symbol>NULL</symbol>.
If they don’t match or the
<structfield>dpy</structfield>
- field is not
+field is not
<symbol>NULL</symbol>,
a
<errorname>BadMatch</errorname>
- error is returned (either in the return value or a backfilled
+error is returned (either in the return value or a backfilled
<type>Status</type>
- variable). Upon successful return, the
+variable). Upon successful return, the
<structfield>dpy</structfield>
- field of the
+field of the
<structname>XkbDescRec</structname>
- always contains the Display* value passed in.
+always contains the Display* value passed in.
</para>
<para>
@@ -786,51 +786,51 @@ Consequently, there can potentially be more than one input device connected to
the server. Most Xkb library calls that require communicating with the server
involve both a server connection (Display *
<structfield>dpy</structfield>)
- and a device identifier (unsigned int
+and a device identifier (unsigned int
<structfield>device_spec</structfield>).
- In some cases, the device identifier is implicit and is taken as the
+In some cases, the device identifier is implicit and is taken as the
<structfield>device_spec</structfield>
- field of an
+field of an
<structname>XkbDescRec</structname>
- structure passed as an argument.
+structure passed as an argument.
</para>
<para id='XkbUseCoreKbd'>
<indexterm significance="preferred" zone="XkbUseCoreKbd"><primary><symbol>XkbUseCoreKbd</symbol></primary></indexterm>
The device identifier can specify any X input extension device with a
<symbol>KeyClass</symbol>
- component, or it can specify the constant,
+component, or it can specify the constant,
<symbol>XkbUseCoreKbd</symbol>.
The use of
<symbol>XkbUseCoreKbd</symbol>
- allows applications to indicate the core keyboard without having to determine
+allows applications to indicate the core keyboard without having to determine
its device identifier.
</para>
<para>
Where an Xkb device identifier is passed as an argument and an
<type>XkbDescPtr</type>
- is also passed as an argument, if either the argument or the
+is also passed as an argument, if either the argument or the
<structname>XkbDescRec</structname>
<structfield>device_spec</structfield>
- field is
+field is
<symbol>XkbUseCoreKbd</symbol>,
and if the function returns successfully, the
<type>XkbDescPtr</type>
<structfield>device_spec</structfield>
- field will have been converted from
+field will have been converted from
<symbol>XkbUseCoreKbd</symbol>
- to a real Xkb device ID. If the function does not complete successfully, the
+to a real Xkb device ID. If the function does not complete successfully, the
<structfield>device_spec</structfield>
- field remains unchanged. Subsequently, the device id argument must match the
+field remains unchanged. Subsequently, the device id argument must match the
<structfield>device_spec</structfield>
- field of the
+field of the
<type>XkbDescPtr</type>
- argument. If they don’t match, a
+argument. If they don’t match, a
<errorname>BadMatch</errorname>
- error is returned (either in the return value or a backfilled
+error is returned (either in the return value or a backfilled
<type>Status</type>
- variable).
+variable).
</para>
<para>
@@ -841,7 +841,7 @@ support the input extension, the meaning of the identifier is undefined — the
only guarantee is that when you use
<symbol>XkbUseCoreKbd</symbol>,
<symbol>XkbUseCoreKbd</symbol>
- will work and the identifier returned by the server will refer to the core
+will work and the identifier returned by the server will refer to the core
keyboard device.
</para>
</sect1>
diff --git a/specs/XKB/ch03.xml b/specs/XKB/ch03.xml
index 2981e9a2..3aeb81b4 100644
--- a/specs/XKB/ch03.xml
+++ b/specs/XKB/ch03.xml
@@ -78,7 +78,7 @@ edit the data structure, use it. For example, increasing the width of a type
requires you to resize every key that uses that type. This is complicated and
ugly, which is why there’s an
<function>XkbResizeKeyType</function>
- function.
+function.
</para>
@@ -105,7 +105,7 @@ Call the allocator function with some arbitrary size, as a hint.
<para>
For those arrays that have an
<function>Xkb...Add...</function>
- function, call it each time you want to add new data to the array. The
+function, call it each time you want to add new data to the array. The
function expands the array if necessary.
</para>
</listitem>
@@ -121,9 +121,9 @@ XkbAllocGeomShapes(geom,4)
to say <quote>I’ll need space for four new shapes in this geometry.</quote>
This makes sure that
<structfield>sz_shapes</structfield>
- &minus;
+&minus;
<structfield>num_shapes</structfield>
- &gt;= 4, and resizes the shapes array if it isn’t. If this function
+&gt;= 4, and resizes the shapes array if it isn’t. If this function
succeeds, you are guaranteed to have space for the number of shapes you need.
</para>
@@ -132,12 +132,12 @@ succeeds, you are guaranteed to have space for the number of shapes you need.
When you call an editing function for a structure, you do not need to check for
space, because the function automatically checks the
<emphasis>sz_</emphasis>
- and
+and
<emphasis>num_</emphasis>
- fields of the array, resizes the array if necessary, adds the entry to the
+fields of the array, resizes the array if necessary, adds the entry to the
array, and then updates the
<emphasis>num_</emphasis>
- field.
+field.
</para>
@@ -161,7 +161,7 @@ description, Xkb provides separate special
<firstterm>changes</firstterm>
<indexterm significance="preferred" zone="Making_Changes_to_the_Servers_Keyboard_Description">
<primary>changes data structures</primary></indexterm>
- data structures for each major Xkb data structure. These data structures do
+data structures for each major Xkb data structure. These data structures do
not contain the actual changed values: they only indicate the changes that have
been made to the structures that actually describe the keyboard.
</para>
@@ -213,14 +213,14 @@ defined for all major Xkb components, and their names have the form
<function>XkbNote<replaceable>{Component}</replaceable>Changes</function>,
where
<replaceable>Component</replaceable>
- is the name of a major Xkb component such as
+is the name of a major Xkb component such as
<literal>Map</literal>
- or
+or
<literal>Names</literal>.
When you want to copy these changes from the server into a local copy of the
keyboard description, use the corresponding
<function>XkbGet<replaceable>{Component}</replaceable>Changes</function>
- function,
+function,
passing it the changes structure. The function then retrieves only the changed
structures from the server and copies the modified pieces into the local
keyboard description.
@@ -233,16 +233,16 @@ keyboard description.
<para>
For the same reasons you should not directly use
<function>malloc</function>
- to allocate Xkb data structures, you should not free Xkb data structures or
+to allocate Xkb data structures, you should not free Xkb data structures or
components directly using
<function>free</function>
- or
+or
<function>Xfree</function>.
Xkb provides functions to free the various data structures and their
components. Always use the free functions supplied by Xkb. There is no
guarantee that any particular field can be safely freed by
<function>free</function>
- or
+or
<function>Xfree</function>.
</para>
</sect1>
diff --git a/specs/XKB/ch04.xml b/specs/XKB/ch04.xml
index 745c5705..dee00b32 100644
--- a/specs/XKB/ch04.xml
+++ b/specs/XKB/ch04.xml
@@ -31,14 +31,14 @@ The X server reports the events defined by the Xkb extension to your client
application only if you have requested them. You may request Xkb events by
calling either
<function>XkbSelectEvents</function>
- or
+or
<function>XkbSelectEventDetails</function>.
<function>XkbSelectEvents</function>
- requests Xkb events by their event type and causes them to be reported to your
+requests Xkb events by their event type and causes them to be reported to your
client application under all circumstances. You can specify a finer granularity
for event reporting by using
<function>XkbSelectEventDetails</function>;
- in this case events are reported only when the specific detail conditions you
+in this case events are reported only when the specific detail conditions you
specify have been met.
</para>
@@ -49,17 +49,17 @@ specify have been met.
The Xkb Extension adds new event types to the X protocol definition. An Xkb
event type is defined by two fields in the X event data structure. One is the
<structfield>type</structfield>
- field, containing the
+field, containing the
<emphasis>base event code</emphasis>.
- This base event code is a value the X server assigns to each X extension at
+This base event code is a value the X server assigns to each X extension at
runtime and that identifies the extension that generated the event; thus, the
event code in the
<structfield>type</structfield>
- field identifies the event as an Xkb extension event, rather than an event
+field identifies the event as an Xkb extension event, rather than an event
from another extension or a core X protocol event. You can obtain the base
event code via a call to
<function>XkbQueryExtension</function>
- or
+or
<function>XkbOpenDisplay</function>.
The second field is the Xkb event type, which contains a value uniquely
identifying each different Xkb event type. Possible values are defined by
@@ -171,7 +171,7 @@ Xkb events have certain things in common. These common features are contained
in the same fields at the beginning of all Xkb event structures and are
described in the
<structname>XkbAnyEvent</structname>
- structure:
+structure:
<programlisting>
typedef struct {
@@ -188,22 +188,22 @@ typedef struct {
<para>
For any Xkb event, the
<structfield>type</structfield>
- field is set to the base event code for the Xkb extension, assigned by the
+field is set to the base event code for the Xkb extension, assigned by the
server to all Xkb extension events. The
<structfield>serial</structfield>,
<structfield>send_event</structfield>,
and
<structfield>display</structfield>
- fields are as described for all X11 events. The
+fields are as described for all X11 events. The
<structfield>time</structfield>
- field is set to the time when the event was generated and is expressed in
+field is set to the time when the event was generated and is expressed in
milliseconds. The
<structfield>xkb_type</structfield>
- field contains the minor extension event code, which is the extension event
+field contains the minor extension event code, which is the extension event
type, and is one of the values listed in
<link linkend="table4.1">Table 4.1</link>. The
<structfield>device</structfield>
- field contains the keyboard device identifier associated with the event. This
+field contains the keyboard device identifier associated with the event. This
is never
<symbol>XkbUseCoreKbd</symbol>,
even if the request that generated the event specified a device of
@@ -211,10 +211,10 @@ even if the request that generated the event specified a device of
If the request that generated the event specified
<symbol>XkbUseCoreKbd</symbol>,
<structfield>device</structfield>
- contains a value assigned by the server to specify the core keyboard. If the
+contains a value assigned by the server to specify the core keyboard. If the
request that generated the event specified an X input extension device,
<structfield>device</structfield>
- contains that same identifier.
+contains that same identifier.
</para>
@@ -258,15 +258,15 @@ same granularity.
<para>
Xkb provides two functions to select and deselect delivery of Xkb events.
<function>XkbSelectEvents</function>
- allows you to select or deselect delivery of more than one Xkb event type at
+allows you to select or deselect delivery of more than one Xkb event type at
once. Events selected using
<function>XkbSelectEvents</function>
- are delivered to your program under all circumstances that generate the
+are delivered to your program under all circumstances that generate the
events. To restrict delivery of an event to a subset of the conditions under
which it occurs, use
<function>XkbSelectEventDetails</function>.
<function>XkbSelectEventDetails</function>
- only allows you to change the selection conditions for a single event at a
+only allows you to change the selection conditions for a single event at a
time, but it provides a means of fine-tuning the conditions under which the
event is delivered.
</para>
@@ -344,21 +344,21 @@ This request changes the Xkb event selection mask for the keyboard specified by
<para>
Each Xkb event that can be selected is represented by a bit in the
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>
- masks. Only the event selection bits specified by the
+masks. Only the event selection bits specified by the
<parameter>bits_to_change</parameter>
- parameter are affected; any unspecified bits are left unchanged. To turn on
+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
<parameter>bits_to_change</parameter>
- parameter and set the corresponding bit in the
+parameter and set the corresponding bit in the
<parameter>values_for_bits</parameter>
- parameter. To turn off event selection for an event, set the bit for the event
+parameter. To turn off event selection for an event, set the bit for the event
in the
<parameter>bits_to_change</parameter>
- parameter and do not set the corresponding bit in the
+parameter and do not set the corresponding bit in the
<parameter>values_for_bits</parameter>
- parameter. The valid values for both of these parameters are an inclusive
+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
your client’s current event selection mask. Clients cannot set other
@@ -369,17 +369,17 @@ clients’ event selection masks.
<para>
If a bit is not set in the
<parameter>bits_to_change</parameter>
- parameter, but the corresponding bit is set in the
+parameter, but the corresponding bit is set in the
<parameter>values_for_bits</parameter>
- parameter, a
+parameter, a
<errorname>BadMatch</errorname>
- protocol error results. If an undefined bit is set in either the
+protocol error results. If an undefined bit is set in either the
<parameter>bits_to_change</parameter>
- or the
+or the
<parameter>values_for_bits</parameter>
- parameter, a
+parameter, a
<errorname>BadValue</errorname>
- protocol error results.
+protocol error results.
</para>
@@ -393,11 +393,11 @@ clear them via another call to
<para>
<function>XkbSelectEvents</function>
- returns
+returns
<symbol>False</symbol>
- if the Xkb extension has not been initialized and
+if the Xkb extension has not been initialized and
<symbol>True</symbol>
- otherwise.
+otherwise.
</para>
@@ -483,60 +483,60 @@ Xkb events with
<para>
While
<function>XkbSelectEvents</function>
- allows multiple events to be selected,
+allows multiple events to be selected,
<function>XkbSelectEventDetails</function>
- changes the selection criteria for a single type of Xkb event. The
+changes the selection criteria for a single type of Xkb event. The
interpretation of the
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>
- masks depends on the event type in question.
+masks depends on the event type in question.
</para>
<para>
<function>XkbSelectEventDetails</function>
- changes the Xkb event selection mask for the keyboard specified by
+changes the Xkb event selection mask for the keyboard specified by
<parameter>device_spec</parameter>
- and the Xkb event specified by
+and the Xkb event specified by
<parameter>event_type</parameter>.
To turn on event selection for an event detail, set the bit for the detail in
the
<parameter>bits_to_change</parameter>
- parameter and set the corresponding bit in the
+parameter and set the corresponding bit in the
<parameter>values_for_bits</parameter>
- parameter. To turn off event detail selection for a detail, set the bit for
+parameter. To turn off event detail selection for a detail, set the bit for
the detail in the
<parameter>bits_to_change</parameter>
- parameter and do not set the corresponding bit in the
+parameter and do not set the corresponding bit in the
<parameter>values_for_bits</parameter>
- parameter.
+parameter.
</para>
<para>
If an invalid event type is specified, a
<errorname>BadValue</errorname>
- protocol error results. If a bit is not set in the
+protocol error results. If a bit is not set in the
<parameter>bits_to_change</parameter>
- parameter, but the corresponding bit is set in the
+parameter, but the corresponding bit is set in the
<parameter>values_for_bits</parameter>
- parameter, a
+parameter, a
<errorname>BadMatch</errorname>
- protocol error results. If an undefined bit is set in either the
+protocol error results. If an undefined bit is set in either the
<parameter>bits_to_change</parameter>
- or the
+or the
<parameter>values_for_bits</parameter>
- parameter, a
+parameter, a
<errorname>BadValue</errorname>
- protocol error results.
+protocol error results.
</para>
<para>
For each type of Xkb event, the legal event details that you can specify in the
<function>XkbSelectEventDetails</function>
- request are listed in the chapters that describe each event in detail.
+request are listed in the chapters that describe each event in detail.
</para>
@@ -547,7 +547,7 @@ For each type of Xkb event, the legal event details that you can specify in the
The X server reports the events defined by Xkb to your client application only
if you have requested them via a call to
<function>XkbSelectEvents</function>
- or
+or
<function>XkbSelectEventDetails</function>.
Specify the event types in which you are interested in a mask, as described
in <link linkend="Selecting_Xkb_Events">section 4.3</link>.
@@ -556,9 +556,9 @@ in <link linkend="Selecting_Xkb_Events">section 4.3</link>.
<para>
<link linkend="table4.2">Table 4.2</link>
- lists the event mask constants that can be specified with the
+lists the event mask constants that can be specified with the
<function>XkbSelectEvents</function>
- request and the circumstances in which the mask should be specified.
+request and the circumstances in which the mask should be specified.
</para>
<table id='table4.2' frame='topbot'>
@@ -683,19 +683,19 @@ in <link linkend="Selecting_Xkb_Events">section 4.3</link>.
<para>
The
<structname>XkbEvent</structname>
- structure is a union of the individual structures declared for each Xkb event
+structure is a union of the individual structures declared for each Xkb event
type and for the core protocol
<structname>XEvent</structname>
- type. Given an
+type. Given an
<structname>XkbEvent</structname>
- structure, you may use the
+structure, you may use the
<structfield>type</structfield>
- field to determine if the event is an Xkb event
+field to determine if the event is an Xkb event
(<structfield>type</structfield>
- equals the Xkb base event code; see <link linkend="Initializing_the_Keyboard_Extension">section 2.4</link>). If the event is an Xkb
+equals the Xkb base event code; see <link linkend="Initializing_the_Keyboard_Extension">section 2.4</link>). If the event is an Xkb
event, you may then use the
<structfield>any.xkb_type</structfield>
- field to determine the type of Xkb event and thereafter access the
+field to determine the type of Xkb event and thereafter access the
event-dependent components using the union member corresponding to the
particular Xkb event type.
</para>
@@ -722,12 +722,12 @@ typedef union _XkbEvent {
<para>
This unified Xkb event type includes a normal
<structname>XEvent</structname>
- as used by the core protocol, so it is straightforward for applications that
+as used by the core protocol, so it is straightforward for applications that
use Xkb events to call the X library event functions without having to cast
every reference. For example, to get the next event, you can simply declare a
variable of type
<structname>XkbEvent</structname>
- and call:
+and call:
<programlisting>XNextEvent(dpy,&amp;xkbev.core);</programlisting>
</para>
diff --git a/specs/XKB/ch05.xml b/specs/XKB/ch05.xml
index c3190fcc..77d1995e 100644
--- a/specs/XKB/ch05.xml
+++ b/specs/XKB/ch05.xml
@@ -57,7 +57,7 @@ The
<firstterm>modifiers</firstterm>
<indexterm significance="preferred" zone="modifiers">
<primary>modifiers</primary></indexterm>
- are
+are
<symbol>Shift</symbol>,
<symbol>Lock</symbol>,
<symbol>Control</symbol>,
@@ -110,7 +110,7 @@ Changing to a different group changes the keyboard state to produce characters f
<para>
The
<firstterm>pointer buttons</firstterm>
- are
+are
<symbol>Button1</symbol>
&ndash;
<symbol>Button5</symbol>,
@@ -125,13 +125,13 @@ The
<primary>base group</primary></indexterm>
<indexterm significance="preferred" zone="base_group">
<primary>group</primary><secondary>base</secondary></indexterm>
- and
+and
<firstterm>base modifiers</firstterm>
<indexterm significance="preferred" zone="base_group">
<primary>base modifiers</primary></indexterm>
<indexterm significance="preferred" zone="base_group">
<primary>modifiers</primary><secondary>base</secondary></indexterm>
- represent keys that are physically or logically down. These
+represent keys that are physically or logically down. These
and the pointer buttons can be changed by keyboard activity and
not by Xkb requests. It is possible for a key to be logically
down, but not physically down, and neither latched nor locked.
@@ -151,7 +151,7 @@ The
<primary>effective modifiers</primary></indexterm>
<indexterm significance="preferred" zone="effective_modifiers">
<primary>modifiers</primary><secondary>effective</secondary></indexterm>
- are the bitwise union of the locked, latched, and the base modifiers.
+are the bitwise union of the locked, latched, and the base modifiers.
</para>
@@ -162,7 +162,7 @@ The
<primary>effective group</primary></indexterm>
<indexterm significance="preferred" zone="effective_group">
<primary>group</primary><secondary>effective</secondary></indexterm>
- is the arithmetic sum of the group indices of the latched group, locked group, and base group, which is then normalized by some function. The result is a meaningful group index.
+is the arithmetic sum of the group indices of the latched group, locked group, and base group, which is then normalized by some function. The result is a meaningful group index.
</para>
<simplelist type='vert' columns='1'>
@@ -192,17 +192,17 @@ There are two circumstances under which groups are normalized:
<listitem><para>
The global locked or effective group changes. In this case, the changed group is normalized into range according to the settings of the
<structfield>groups_wrap</structfield>
- field of the
+field of the
<structname>XkbControlsRec</structname>
- structure for the keyboard (see <link linkend="The_GroupsWrap_Control">section 10.7.1</link>).
+structure for the keyboard (see <link linkend="The_GroupsWrap_Control">section 10.7.1</link>).
</para></listitem>
<listitem><para>
The Xkb library is interpreting an event with an effective group that is legal for the keyboard as a whole, but not for the key in question. In this case, the group to use for this event only is determined using the
<structfield>group_info</structfield>
- field of the key symbol mapping
+field of the key symbol mapping
(<structname>XkbSymMapRec</structname>)
- for the event key.
+for the event key.
</para></listitem>
</orderedlist>
@@ -221,7 +221,7 @@ A client that does explicitly call Xkb functions is an
<firstterm>Xkb-aware</firstterm>
<indexterm significance="preferred" zone="Xkb-aware">
<primary>Xkb-aware client</primary></indexterm>
- client. The Xkb keyboard state includes information derived from the effective state and from two server parameters that can be set through the keyboard extension. The following components of keyboard state pertain to Xkb-capable and Xkb-aware clients:
+client. The Xkb keyboard state includes information derived from the effective state and from two server parameters that can be set through the keyboard extension. The following components of keyboard state pertain to Xkb-capable and Xkb-aware clients:
</para>
<itemizedlist>
@@ -244,17 +244,17 @@ The
<primary>lookup modifiers</primary></indexterm>
<indexterm significance="preferred" zone="lookup_state">
<primary>modifiers</primary><secondary>lookup</secondary></indexterm>
- and
+and
<firstterm>lookup group</firstterm>
<indexterm significance="preferred" zone="lookup_state">
<primary>lookup group</primary></indexterm>
<indexterm significance="preferred" zone="lookup_state">
<primary>group</primary><secondary>lookup</secondary></indexterm>
- are represented in the state field of core X events. The modifier state and keycode of a key event are used to determine the symbols associated with the event. For
+are represented in the state field of core X events. The modifier state and keycode of a key event are used to determine the symbols associated with the event. For
<symbol>KeyPress</symbol>
- and
+and
<symbol>KeyRelease</symbol>
- events, the lookup modifiers are computed as:
+events, the lookup modifiers are computed as:
<literallayout> ((base | latched | locked) &amp; ~<emphasis>server_internal_modifiers</emphasis>)</literallayout>
</para>
@@ -277,7 +277,7 @@ When an Xkb-capable or Xkb-aware client wishes to map a keycode to a keysym, it
<primary>lookup state</primary></indexterm>
<indexterm significance="preferred" zone="lookup_state">
<primary>state</primary><secondary>lookup</secondary></indexterm>
- — the lookup group and the lookup modifiers.
+— the lookup group and the lookup modifiers.
</para>
@@ -288,19 +288,19 @@ The
<primary>grab state</primary></indexterm>
<indexterm significance="preferred" zone="grab_state">
<primary>state</primary><secondary>grab</secondary></indexterm>
- is the state used when matching events to passive grabs. If the event activates a grab, the
+is the state used when matching events to passive grabs. If the event activates a grab, the
<firstterm>grab modifiers</firstterm>
<indexterm significance="preferred" zone="grab_state">
<primary>grab modifiers</primary></indexterm>
<indexterm significance="preferred" zone="grab_state">
<primary>modifiers</primary><secondary>grab</secondary></indexterm>
- and
+and
<firstterm>grab group</firstterm>
<indexterm significance="preferred" zone="grab_state">
<primary>grab group</primary></indexterm>
<indexterm significance="preferred" zone="grab_state">
<primary>group</primary><secondary>grab</secondary></indexterm>
- are represented in the state field of core X events; otherwise, the lookup state is used. The grab modifiers are computed as:
+are represented in the state field of core X events; otherwise, the lookup state is used. The grab modifiers are computed as:
<literallayout> (((base | latched | (locked &amp; ~ignore_locks)) &amp; ~server_internal_modifiers)</literallayout>
</para>
@@ -308,7 +308,7 @@ The
<para>
If the server’s
<emphasis>IgnoreGroupLock</emphasis>
- control (see <link linkend="The_IgnoreGroupLock_Control">section 10.7.3</link>) is not set, the grab group is the same as the effective group. Otherwise, the grab group is computed from the base group and latched group, ignoring the locked group.
+control (see <link linkend="The_IgnoreGroupLock_Control">section 10.7.3</link>) is not set, the grab group is the same as the effective group. Otherwise, the grab group is computed from the base group and latched group, ignoring the locked group.
</para>
@@ -462,20 +462,20 @@ 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
+sends a request to the server to lock the real modifiers selected by both
<parameter>affect</parameter>
- and
+and
<parameter>values</parameter>
- and to unlock the real modifiers selected by
+and to unlock the real modifiers selected by
<parameter>affect</parameter>
- but not selected by
+but not selected by
<parameter>values</parameter>.
<function>XkbLockModifiers</function>
- does not wait for a reply from the server. It returns
+does not wait for a reply from the server. It returns
<symbol>True</symbol>
- if the request was sent, and
+if the request was sent, and
<symbol>False</symbol>
- otherwise.
+otherwise.
</para>
@@ -544,20 +544,20 @@ 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
+sends a request to the server to latch the real modifiers selected by both
<parameter>affect</parameter>
- and
+and
<parameter>values</parameter>
- and to unlatch the real modifiers selected by
+and to unlatch the real modifiers selected by
<parameter>affect</parameter>
- but not selected by
+but not selected by
<parameter>values</parameter>.
<function>XkbLatchModifiers</function>
- does not wait for a reply from the server. It returns
+does not wait for a reply from the server. It returns
<symbol>True</symbol>
- if the request was sent, and
+if the request was sent, and
<symbol>False</symbol>
- otherwise.
+otherwise.
</para>
@@ -658,13 +658,13 @@ To lock the keysym group, use
<para>
<function>XkbLockGroup</function>
- sends a request to the server to lock the specified
+sends a request to the server to lock the specified
<parameter>group</parameter>
and does not wait for a reply. It returns
<symbol>True</symbol>
- if the request was sent and
+if the request was sent and
<symbol>False</symbol>
- otherwise.
+otherwise.
</para>
@@ -722,11 +722,11 @@ To latch the keysym group, use
<para>
<function>XkbLatchGroup</function>
- sends a request to the server to latch the specified group and does not wait for a reply. It returns
+sends a request to the server to latch the specified group and does not wait for a reply. It returns
<symbol>True</symbol>
- if the request was sent and
+if the request was sent and
<symbol>False</symbol>
- otherwise.
+otherwise.
</para>
@@ -741,7 +741,7 @@ To latch the keysym group, use
<para>
Xkb keyboard state may be represented in an
<structname>XkbStateRec</structname>
- structure:
+structure:
<programlisting>
typedef struct {
@@ -823,7 +823,7 @@ The
<function>XkbGetState</function>
function queries the server for the current keyboard state, waits for a reply, and then backfills
<parameter>state_return</parameter>
- with the results.
+with the results.
</para>
@@ -846,7 +846,7 @@ The Xkb extension reports
<symbol>XkbStateNotify</symbol>
events to clients wanting notification whenever the Xkb state changes. The changes reported include changes to any aspect of the keyboard state: when a modifier is set or unset, when the current group changes, or when a pointer button is pressed or released. As with all Xkb events,
<symbol>XkbStateNotify</symbol>
- events are reported to all interested clients without regard to the current keyboard input focus or grab state.
+events are reported to all interested clients without regard to the current keyboard input focus or grab state.
</para>
@@ -936,24 +936,24 @@ listed in <link linkend="table5.3">Table 5.3</link>.
<para>
To track changes in the keyboard state for a particular device, select to receive
<symbol>XkbStateNotify</symbol>
- events by calling either
+events by calling either
<function>XkbSelectEvents</function>
- or
+or
<function>XkbSelectEventDetails</function>
- (see <link linkend="Selecting_Xkb_Events">section 4.3</link>).
+(see <link linkend="Selecting_Xkb_Events">section 4.3</link>).
</para>
<para>
To receive
<symbol>XkbStateNotify</symbol>
- events under all possible conditions, use
+events under all possible conditions, use
<function>XkbSelectEvents</function>
- and pass
+and pass
<symbol>XkbStateNotifyMask</symbol>
- in both
+in both
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>.
</para>
@@ -961,24 +961,24 @@ To receive
<para>
To receive
<symbol>XkbStateNotify</symbol>
- events only under certain conditions, use
+events only under certain conditions, use
<function>XkbSelectEventDetails</function>
- using
+using
<symbol>XkbStateNotify</symbol>
- as the
+as the
<structfield>event_type</structfield>
- and specifying the desired state changes in
+and specifying the desired state changes in
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>
- using mask bits from <link linkend="table5.3">Table 5.3</link>.
+using mask bits from <link linkend="table5.3">Table 5.3</link>.
</para>
<para>
The structure for
<symbol>XkbStateNotify</symbol>
- events is:
+events is:
<programlisting>
typedef struct {
@@ -1019,32 +1019,32 @@ typedef struct {
<para>
When you receive an
<symbol>XkbStateNotify</symbol>
- event, the
+event, the
<structfield>changed</structfield>
- field indicates which elements of keyboard state have changed.
+field indicates which elements of keyboard state have changed.
This will be the bitwise inclusive OR of one or more of the
<symbol>XkbStateNotify</symbol>
- event detail masks shown in <link linkend="table5.3">Table 5.3</link>.
- All fields reported in the event are valid, but only those indicated in
+event detail masks shown in <link linkend="table5.3">Table 5.3</link>.
+All fields reported in the event are valid, but only those indicated in
<structfield>changed</structfield>
- have changed values.
+have changed values.
</para>
<para>
The
<structfield>group</structfield>
- field is the group index of the effective keysym group. The
+field is the group index of the effective keysym group. The
<structfield>base_group</structfield>,
<structfield>latched_group</structfield>,
and
<structfield>locked_group</structfield>
- fields are set to a group index value representing the base group,
+fields are set to a group index value representing the base group,
the latched group, and the locked group, respectively. The X
server can set the modifier and compatibility state fields to
a union of the core modifier mask bits; this union represents the
corresponding modifier states. The <structfield>ptr_buttons</structfield>
- field gives the state of the core pointer buttons as a
+field gives the state of the core pointer buttons as a
mask composed of an inclusive OR of zero or more of the
core pointer button masks.
</para>
@@ -1055,26 +1055,26 @@ Xkb state changes can occur either in response to keyboard
activity or under application control. If a key event
caused the state change, the
<structfield>keycode</structfield>
- field gives the keycode of the key event, and the
+field gives the keycode of the key event, and the
<structfield>event_type</structfield>
- field is set to either <symbol>KeyPress</symbol>
- or
+field is set to either <symbol>KeyPress</symbol>
+or
<symbol>KeyRelease</symbol>.
If a pointer button event caused the state change, the
<structfield>keycode</structfield>
- field is zero, and the <structfield>event_type</structfield>
- field is set to either <symbol>ButtonPress</symbol>
- or <symbol>ButtonRelease</symbol>.
+field is zero, and the <structfield>event_type</structfield>
+field is set to either <symbol>ButtonPress</symbol>
+or <symbol>ButtonRelease</symbol>.
Otherwise, the major and minor codes of the request that caused the
state change are given in the
<structfield>req_major</structfield>
- and
+and
<structfield>req_minor</structfield>
- fields, and the
+fields, and the
<structfield>keycode</structfield>
- field is zero. The
+field is zero. The
<structfield>req_major</structfield>
- value is the same as the major extension opcode.
+value is the same as the major extension opcode.
</para>
</sect1>
</chapter>
diff --git a/specs/XKB/ch06.xml b/specs/XKB/ch06.xml
index 48afc4c6..b3b58da2 100644
--- a/specs/XKB/ch06.xml
+++ b/specs/XKB/ch06.xml
@@ -22,7 +22,7 @@ The complete description of an Xkb keyboard is given by an
<structname>XkbDescRec</structname>.
The component structures in the
<structname>XkbDescRec</structname>
- represent the major Xkb components outlined in <link linkend="figure1.1">Figure 1.1</link>.
+represent the major Xkb components outlined in <link linkend="figure1.1">Figure 1.1</link>.
</para>
<para><programlisting>
@@ -45,19 +45,19 @@ typedef struct {
<para>
The
<parameter>display</parameter>
- field points to an X display structure. The
+field points to an X display structure. The
<structfield>flags</structfield>
- field is private to the library: modifying
+field is private to the library: modifying
<structfield>flags</structfield>
- may yield unpredictable results. The
+may yield unpredictable results. The
<parameter>device_spec</parameter>
- field specifies the device identifier of the keyboard input device, or
+field specifies the device identifier of the keyboard input device, or
<symbol>XkbUseCoreKbd</symbol>,
which specifies the core keyboard device. The
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- fields specify the least and greatest keycode that can be returned by the
+fields specify the least and greatest keycode that can be returned by the
keyboard.
</para>
@@ -122,7 +122,7 @@ calls to indicate that the structure should be manipulated in some manner, such
as allocating it or freeing it. These masks and their relationships to the
fields in the
<structname>XkbDescRec</structname>
- are shown in <link linkend="table6.2">Table 6.2</link>.
+are shown in <link linkend="table6.2">Table 6.2</link>.
</para>
<table id='table6.2' frame='topbot'>
@@ -191,7 +191,7 @@ fields in the
<para>
To retrieve one or more components of a keyboard device description, use
<function>XkbGetKeyboard</function>
- (see also
+(see also
<link linkend="XkbGetKeyboardByName"><function>XkbGetKeyboardByName</function></link>).
</para>
@@ -248,30 +248,30 @@ To retrieve one or more components of a keyboard device description, use
allocates and returns a pointer to a keyboard description. It queries the
server for those components specified in the
<parameter>which</parameter>
- parameter for device
+parameter for device
<parameter>device_spec</parameter>
- and copies the results to the
+and copies the results to the
<structname>XkbDescRec</structname>
- it allocated. The remaining fields in the keyboard description are set to
+it allocated. The remaining fields in the keyboard description are set to
<symbol>NULL</symbol>.
The valid masks for
<parameter>which</parameter>
- are those listed in <link linkend="table6.2">Table 6.2</link>.
+are those listed in <link linkend="table6.2">Table 6.2</link>.
</para>
<para>
<function>XkbGetKeyboard</function>
- can generate
+can generate
<errorname>BadAlloc</errorname>
- protocol errors.
+protocol errors.
</para>
<para>
To free the returned keyboard description, use
<function>XkbFreeKeyboard</function>
- (see <link linkend="Allocating_and_Freeing_a_Keyboard_Description">section 6.4</link>).
+(see <link linkend="Allocating_and_Freeing_a_Keyboard_Description">section 6.4</link>).
</para>
@@ -293,10 +293,10 @@ tracking changes to the keyboard description.
<para>
Applications seldom need to directly allocate a keyboard description; calling
<function>XkbGetKeyboard</function>
- usually suffices. In the event you need to create a keyboard description from
+usually suffices. In the event you need to create a keyboard description from
scratch, however, use
<function>XkbAllocKeyboard</function>
- rather than directly calling
+rather than directly calling
<function>malloc</function>
or
<function>Xmalloc</function>.
@@ -314,12 +314,12 @@ or
<para>
If
<function>XkbAllocKeyboard</function>
- fails to allocate the keyboard description, it returns
+fails to allocate the keyboard description, it returns
<symbol>NULL</symbol>.
Otherwise, it returns a pointer to an empty keyboard description structure.
The
<structfield>device_spec</structfield>
- field will have been initialized to
+field will have been initialized to
<symbol>XkbUseCoreKbd</symbol>.
You may then either fill in the structure components or use Xkb functions to
obtain values for the structure components from a keyboard device.
@@ -329,7 +329,7 @@ obtain values for the structure components from a keyboard device.
<para>
To destroy either an entire an
<structname>XkbDescRec</structname>
- or just some of its members, use
+or just some of its members, use
<function>XkbFreeKeyboard</function>.
</para>
@@ -382,24 +382,24 @@ To destroy either an entire an
<para>
<function>XkbFreeKeyboard</function>
- frees the components of
+frees the components of
<parameter>xkb</parameter>
- specified by
+specified by
<parameter>which</parameter>
- and sets the corresponding values to
+and sets the corresponding values to
<symbol>NULL</symbol>.
If
<parameter>free_all</parameter>
- is
+is
<symbol>True</symbol>,
<function>XkbFreeKeyboard</function>
- frees every non-
+frees every non-
<symbol>NULL</symbol>
- component of
+component of
<parameter>xkb</parameter>
- and then frees the
+and then frees the
<parameter>xkb</parameter>
- structure itself.
+structure itself.
</para>
</sect1>
diff --git a/specs/XKB/ch07.xml b/specs/XKB/ch07.xml
index b69ce854..cbb549ce 100644
--- a/specs/XKB/ch07.xml
+++ b/specs/XKB/ch07.xml
@@ -9,16 +9,16 @@ The core protocol specifies that certain keysyms, when bound to modifiers,
affect the rules of keycode to keysym interpretation for all keys; for example,
when the
<keysym>Num_Lock</keysym>
- keysym is bound to some modifier, that modifier is used to select between
+keysym is bound to some modifier, that modifier is used to select between
shifted and unshifted state for the numeric keypad keys. The core protocol does
not provide a convenient way to determine the mapping of modifier bits (in
particular
<symbol>Mod1</symbol>
- through
+through
<symbol>Mod5</symbol>)
- to keysyms such as
+to keysyms such as
<keysym>Num_Lock</keysym>
- and
+and
<keysym>Mode_switch</keysym>.
Using the core protocol only, a client application must retrieve and search
the modifier map to determine the keycodes bound to each modifier, and then
@@ -47,7 +47,7 @@ Each virtual modifier can be bound to any set of the real modifiers
<symbol>Shift</symbol>,
<symbol>Lock</symbol>,
<symbol>Control</symbol>,
- and
+and
<symbol>Mod1</symbol>
&ndash;
<symbol>Mod5</symbol>).
@@ -60,11 +60,11 @@ The separation of function from physical modifier bindings makes it easier to
specify more clearly the intent of a binding. X servers do not all assign
modifiers the same way — for example,
<keysym>Num_Lock</keysym>
- might be bound to
+might be bound to
<symbol>Mod2</symbol>
- for one vendor and to
+for one vendor and to
<symbol>Mod4</symbol>
- for another. This makes it cumbersome to automatically remap the keyboard to a
+for another. This makes it cumbersome to automatically remap the keyboard to a
desired configuration without some kind of prior knowledge about the keyboard
layout and bindings. With XKB, applications can use virtual modifiers to
specify the desired behavior, without regard for the actual physical bindings
@@ -77,17 +77,17 @@ in effect.
<para>
Virtual modifiers are named by converting their string name to an X
<type>Atom</type>
- and storing the Atom in the
+and storing the Atom in the
<structfield>names.vmods</structfield>
- array in an
+array in an
<structname>XkbDescRec</structname>
- structure (see <link linkend="The_XkbDescRec_Structure">section 6.1</link>). The position of a name Atom in the
+structure (see <link linkend="The_XkbDescRec_Structure">section 6.1</link>). The position of a name Atom in the
<structfield>names.vmods</structfield>
- array defines the bit position used to represent the virtual modifier and also
+array defines the bit position used to represent the virtual modifier and also
the index used when accessing virtual modifier information in arrays: the name
in the i-th (0 relative) entry of
<structfield>names.vmods</structfield>
- is the i-th virtual modifier, represented by the mask (1&lt;&lt;i). Throughout
+is the i-th virtual modifier, represented by the mask (1&lt;&lt;i). Throughout
Xkb, various functions have a parameter that is a mask representing virtual
modifier choices. In each case, the i-th bit (0 relative) of the mask
represents the i-th virtual modifier.
@@ -99,11 +99,11 @@ To set the name of a virtual modifier, use
<function>XkbSetNames</function>,
using
<symbol>XkbVirtualModNamesMask</symbol>
- in
+in
<parameter>which</parameter>
- and the name in the
+and the name in the
<parameter>xkb</parameter>
- argument; to retrieve indicator names, use
+argument; to retrieve indicator names, use
<function>XkbGetNames</function>.
These functions are discussed in <xref linkend="Symbolic_Names" />.
</para>
@@ -121,7 +121,7 @@ An Xkb
<firstterm>modifier definition</firstterm>
<indexterm significance="preferred" zone="grab_state">
<primary>modifier definition</primary></indexterm>
- enumerates a collection of real and virtual modifiers but does not in itself
+enumerates a collection of real and virtual modifiers but does not in itself
bind those modifiers to any particular key or to each other. Modifier
definitions are included in a number of structures in the keyboard description
to define the collection of modifiers that affect or are affected by some other
@@ -144,22 +144,22 @@ typedef struct _XkbMods {
An Xkb modifier definition consists of a set of bit masks corresponding to the
eight real modifiers
(<structfield>real_mods</structfield>);
- a similar set of bitmasks corresponding to the 16 named virtual modifiers
+a similar set of bitmasks corresponding to the 16 named virtual modifiers
(<structfield>vmods</structfield>);
- and an effective mask
+and an effective mask
(<structfield>mask</structfield>).
- The effective mask represents the set of all real modifiers that can
+The effective mask represents the set of all real modifiers that can
logically be set either by setting any of the real modifiers or by setting any
of the virtual modifiers in the definition.
<structfield>mask</structfield>
- is derived from the real and virtual modifiers and should never be explicitly
+is derived from the real and virtual modifiers and should never be explicitly
changed — it contains all of the real modifiers specified in the definition
(<structfield>real_mods</structfield>)
<emphasis>plus</emphasis>
- any real modifiers that are bound to the virtual modifiers specified in the
+any real modifiers that are bound to the virtual modifiers specified in the
definition
(<structfield>vmods</structfield>).
- The binding of the virtual modifiers to real modifiers is exterior to the
+The binding of the virtual modifiers to real modifiers is exterior to the
modifier definition. Xkb automatically recomputes the mask field of modifier
definitions as necessary. Whenever you access a modifier definition that has
been retrieved using an Xkb library function, the mask field will be correct
@@ -174,9 +174,9 @@ for the keyboard mapping of interest.
<para>
The binding of virtual modifiers to real modifiers is defined by the
<structfield>server.vmods</structfield>
- array in an
+array in an
<structname>XkbDescRec</structname>
- structure. Each entry contains the real modifier bits that are bound to the
+structure. Each entry contains the real modifier bits that are bound to the
virtual modifier corresponding to the entry. The overall relationship of fields
dealing with virtual modifiers in the server keyboard description are shown in
<link linkend="figure16.2">Figure 16.2</link>.
@@ -199,19 +199,19 @@ real modifiers bound to a virtual modifier always include all of the modifiers
bound to any of the keys that specify that virtual modifier in their virtual
modifier mapping. The
<structfield>server.vmodmap</structfield>
- array indicates which virtual modifiers are bound to each key; each entry is a
+array indicates which virtual modifiers are bound to each key; each entry is a
bitmask for the virtual modifier bits. The
<structfield>server.vmodmap</structfield>
- array is indexed by keycode.
+array is indexed by keycode.
</para>
<para>
The
<structfield>vmodmap</structfield>
- and
+and
<structfield>vmods</structfield>
- members of the server map are the <quote>master</quote> virtual modifier definitions. Xkb
+members of the server map are the <quote>master</quote> virtual modifier definitions. Xkb
automatically propagates any changes to these fields to all other fields that
use virtual modifier mappings (see <link linkend="Virtual_Modifier_Mapping">section 16.4</link>).
</para>
@@ -220,15 +220,15 @@ use virtual modifier mappings (see <link linkend="Virtual_Modifier_Mapping">sect
<para>
For example, if
<symbol>Mod3</symbol>
- is bound to the
+is bound to the
<keysym>Num_Lock</keysym>
- key by the core protocol modifier mapping, and the
+key by the core protocol modifier mapping, and the
<emphasis>NumLock</emphasis>
- virtual modifier is bound to they
+virtual modifier is bound to they
<keysym>Num_Lock</keysym>
- key by the virtual modifier mapping,
+key by the virtual modifier mapping,
<symbol>Mod3</symbol>
- is added to the set of modifiers associated with
+is added to the set of modifiers associated with
<emphasis>NumLock</emphasis>.
</para>
@@ -245,11 +245,11 @@ Use
<function>XkbGetMap</function>
(see <link linkend="Getting_Map_Components_from_the_Server">section 14.2</link>) to get the virtual modifiers from the server or use
<function>XkbGetVirtualMods</function>
- (see <link linkend="Obtaining_Virtual_Modifier_Bindings_from_the_Server">section 16.4.1</link>) to update a local copy of the virtual modifiers bindings
+(see <link linkend="Obtaining_Virtual_Modifier_Bindings_from_the_Server">section 16.4.1</link>) to update a local copy of the virtual modifiers bindings
from the server. To set the binding of a virtual modifier to a real modifier,
use
<function>XkbSetMap</function>
- (see
+(see
<link linkend="Changing_Map_Components_in_the_Server">section 14.3</link>).
</para>
@@ -308,33 +308,33 @@ To determine the mapping of virtual modifiers to core X protocol modifiers, use
<para>
If the keyboard description defined by
<parameter>xkb</parameter>
- includes bindings for virtual modifiers,
+includes bindings for virtual modifiers,
<function>XkbVirtualModsToReal</function>
- uses those bindings to determine the set of real modifiers that correspond to
+uses those bindings to determine the set of real modifiers that correspond to
the set of virtual modifiers specified in
<parameter>virtual_mask</parameter>.
The
<parameter>virtual_mask</parameter>
- parameter is a mask specifying the virtual modifiers to translate; the i-th
+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
<parameter>mask_rtrn</parameter>
- is non-
+is non-
<symbol>NULL</symbol>,
<function>XkbVirtualModsToReal</function>
- backfills it with the resulting real modifier mask. If the keyboard
+backfills it with the resulting real modifier mask. If the keyboard
description in
<parameter>xkb</parameter>
- does not include virtual modifier bindings,
+does not include virtual modifier bindings,
<function>XkbVirtualModsToReal</function>
- returns
+returns
<symbol>False</symbol>;
- otherwise, it returns
+otherwise, it returns
<symbol>True</symbol>.
</para>
<note><para>It is possible for a local (client-side) keyboard description (the
<parameter>xkb</parameter>
- parameter) to not contain any virtual modifier information (simply because the
+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>
@@ -362,12 +362,12 @@ are unbound. Consider this example:
<para>
If the
<emphasis>NumLock</emphasis>
- virtual modifier is not bound to any real modifiers, the effective masks for
+virtual modifier is not bound to any real modifiers, the effective masks for
these two cases are identical (that is, contain only
<symbol>Shift</symbol>).
- When it is essential to distinguish between
+When it is essential to distinguish between
<emphasis>OneThing</emphasis>
- and Another, Xkb considers only those modifier definitions for which all
+and Another, Xkb considers only those modifier definitions for which all
virtual modifiers are bound.
</para>
@@ -402,18 +402,18 @@ following names are suggested:
<para>
If the second (0-relative) entry in
<structfield>names.vmods</structfield>
- contains the Atom for "NumLock", then 0x4 (1&lt;&lt;2) is the virtual modifier
+contains the Atom for "NumLock", then 0x4 (1&lt;&lt;2) is the virtual modifier
bit for the
<emphasis>NumLock</emphasis>
- virtual modifier. If
+virtual modifier. If
<structfield>server.vmods</structfield>
[2] contains
<symbol>Mod3Mask</symbol>,
then the
<emphasis>NumLock</emphasis>
- virtual modifier is bound to the
+virtual modifier is bound to the
<symbol>Mod3</symbol>
- real modifier.
+real modifier.
</para>
@@ -430,9 +430,9 @@ A virtual modifier definition for this example would have:
<para>
Continuing the example, if the keyboard has a
<keysym>Num_Lock</keysym>
- keysym bound to the key with keycode 14, and the
+keysym bound to the key with keycode 14, and the
<emphasis>NumLock</emphasis>
- virtual modifier is bound to this key,
+virtual modifier is bound to this key,
<structfield>server.vmodmap[14]</structfield>
contains 0x4.
</para>
@@ -441,12 +441,12 @@ contains 0x4.
<para>
Finally, if the keyboard also used the real
<symbol>Mod1</symbol>
- modifier for numeric lock operations, the modifier definition below would
+modifier for numeric lock operations, the modifier definition below would
represent the situation where either the key bound to
<symbol>Mod1</symbol>
- or the
+or the
<emphasis>NumLock</emphasis>
- virtual modifier could be used for this purpose:
+virtual modifier could be used for this purpose:
</para>
<literallayout class='monospaced'>
diff --git a/specs/XKB/ch08.xml b/specs/XKB/ch08.xml
index a65d366a..3bb6be62 100644
--- a/specs/XKB/ch08.xml
+++ b/specs/XKB/ch08.xml
@@ -12,10 +12,10 @@ Although the core X implementation supports up to 32 LEDs on an input device,
it does not provide any linkage between the state of the LEDs and the logical
state of the input device. For example, most keyboards have a
<guilabel>CapsLock</guilabel>
- LED, but X does not provide a mechanism to make the LED automatically follow
+LED, but X does not provide a mechanism to make the LED automatically follow
the logical state of the
<keycap>CapsLock</keycap>
- key.
+key.
</para>
@@ -23,16 +23,16 @@ the logical state of the
Furthermore, the core X implementation does not provide clients with the
ability to determine what bits in the
<structfield>led_mask</structfield>
- field of the
+field of the
<structname>XKeyboardState</structname>
- map to the particular LEDs on the keyboard. For example, X does not provide a
+map to the particular LEDs on the keyboard. For example, X does not provide a
method for a client to determine what bit to set in the
<structfield>led_mask</structfield>
- field to turn on the
+field to turn on the
<guilabel>Scroll Lock</guilabel>
LED or whether the keyboard even has a
<guilabel>Scroll Lock</guilabel>
- LED.
+LED.
</para>
@@ -58,14 +58,14 @@ doesn’t use these symbolic names for anything; they are there only to help
make the keyboard description comprehensible to humans. To set the names of
specific indicators, use
<function>XkbSetNames</function>
- as discussed in <xref linkend="Symbolic_Names" />. Then set the map using
+as discussed in <xref linkend="Symbolic_Names" />. Then set the map using
<function>XkbSetMap</function>
- (see <link linkend="Changing_Map_Components_in_the_Server">section 14.3</link>)
- or
+(see <link linkend="Changing_Map_Components_in_the_Server">section 14.3</link>)
+or
<function>XkbSetNamedIndicator</function>
- (below). To retrieve indicator names, use
+(below). To retrieve indicator names, use
<function>XkbGetNames</function>
- (<xref linkend="Symbolic_Names" />).
+(<xref linkend="Symbolic_Names" />).
</para>
@@ -91,7 +91,7 @@ to inquire about and control most indicator properties and behaviors.
<para>
The description for all the Xkb indicators is held in the
<structfield>indicators</structfield>
- field of the complete keyboard description (see <xref linkend="Complete_Keyboard_Description" />), which is defined
+field of the complete keyboard description (see <xref linkend="Complete_Keyboard_Description" />), which is defined
as follows:
<programlisting>
@@ -106,7 +106,7 @@ typedef struct {
<para>
This structure contains the
<structfield>phys_indicators</structfield>
- field, which relates some information about the correspondence between
+field, which relates some information about the correspondence between
indicators and physical LEDs on the keyboard, and an array of indicator
<structfield>maps</structfield>,
one map per indicator.
@@ -115,7 +115,7 @@ one map per indicator.
<para>
The
<structfield>phys_indicators</structfield>
- field indicates which indicators are bound to physical LEDs on the keyboard;
+field indicates which indicators are bound to physical LEDs on the keyboard;
if a bit is set in
<structfield>phys_indicators</structfield>,
then the associated indicator has a physical LED associated with it. This
@@ -126,13 +126,13 @@ the state of
but most keyboards do not have an LED that indicates the current group.
Because
<structfield>phys_indicators</structfield>
- describes a physical characteristic of the keyboard, you cannot directly
+describes a physical characteristic of the keyboard, you cannot directly
change it under program control. However, if a client program loads a
completely new keyboard description via
<function>XkbGetKeyboardByName</function>,
or if a new keyboard is attached and the X implementation notices,
<structfield>phys_indicators</structfield>
- changes if the indicators for the new keyboard are different.
+changes if the indicators for the new keyboard are different.
</para>
@@ -148,9 +148,9 @@ Each indicator has its own set of attributes that specify whether clients can
explicitly set its state and whether it tracks the keyboard state. The
attributes of each indicator are held in the
<structfield>maps</structfield>
- array, which is an array of
+array, which is an array of
<structname>XkbIndicatorRec</structname>
- structures:
+structures:
<programlisting>
typedef struct {
@@ -189,7 +189,7 @@ indicator
The effect (if any) of attempts to explicitly change the state of the indicator
using the functions
<function>XkbSetControls</function>
- or
+or
<function>XChangeKeyboardControl</function>
</para>
@@ -207,10 +207,10 @@ relationship to the indicator map, see <link linkend="Effects_of_Explicit_Change
<para>
The
<structfield>flags</structfield>
- field specifies the conditions under which the indicator can be changed and
+field specifies the conditions under which the indicator can be changed and
the effects of changing the indicator. The valid values for
<structfield>flags</structfield>
- and their effects are shown in <link linkend="table8.1">Table 8.1</link>.
+and their effects are shown in <link linkend="table8.1">Table 8.1</link>.
</para>
<table id='table8.1' frame='topbot'>
@@ -253,62 +253,62 @@ state of the keyboard to change.</entry>
<para>
Note that if
<symbol>XkbIM_NoAutomatic</symbol>
- is not set, by default the indicator follows the keyboard state.
+is not set, by default the indicator follows the keyboard state.
</para>
<para>
If
<symbol>XkbIM_LEDDrivesKB</symbol>
- is set and
+is set and
<symbol>XkbIM_NoExplicit</symbol>
- is not, and if you call a function which updates the server’s image of the
+is not, and if you call a function which updates the server’s image of the
indicator map (such as
<function>XkbSetIndicatorMap</function>
- or
+or
<function>XkbSetNamedIndicator</function>),
- Xkb changes the keyboard state and controls to reflect the other fields of
+Xkb changes the keyboard state and controls to reflect the other fields of
the indicator map, as described in the remainder of this section. If you
attempt to explicitly change the value of an indicator for which
<symbol>XkbIM_LEDDrivesKB</symbol>
- is absent or for which
+is absent or for which
<symbol>XkbIM_NoExplicit</symbol>
- is present, keyboard state or controls are unaffected.
+is present, keyboard state or controls are unaffected.
</para>
<para>
For example, a keyboard designer may want to make the
<guilabel>CapsLock</guilabel>
- LED controllable only by the server, but allow the
+LED controllable only by the server, but allow the
<guilabel>Scroll Lock</guilabel>
- LED to be controlled by client applications. To do so, the keyboard designer
+LED to be controlled by client applications. To do so, the keyboard designer
could set the
<symbol>XkbIM_NoExplicit</symbol>
- flag for the
+flag for the
<guilabel>CapsLock</guilabel>
LED, but not set it for the
<guilabel>Scroll Lock</guilabel>
- LED. Or the keyboard designer may wish to allow the
+LED. Or the keyboard designer may wish to allow the
<guilabel>CapsLock</guilabel>
- LED to be controlled by both the server and client applications and also have
+LED to be controlled by both the server and client applications and also have
the server to automatically change the
<emphasis>CapsLock</emphasis>
modifier state whenever a client application changes the
<guilabel>CapsLock</guilabel>
- LED. To do so, the keyboard designer would not set the
+LED. To do so, the keyboard designer would not set the
<symbol>XkbIM_NoExplicit</symbol>
- flag, but would instead set the
+flag, but would instead set the
<symbol>XkbIM_LEDDrivesKB</symbol>
- flag.
+flag.
</para>
<para>
The remaining fields in the indicator map specify the conditions under which
Xkb automatically turns an indicator on or off (only if
<symbol>XkbIM_NoAutomatic</symbol>
- is not set). If these conditions match the keyboard state, Xkb turns the
+is not set). If these conditions match the keyboard state, Xkb turns the
indicator on. If the conditions do not match, Xkb turns the indicator off.
</para>
@@ -320,14 +320,14 @@ indicator on. If the conditions do not match, Xkb turns the indicator off.
<para>
The
<structfield>which_groups</structfield>
- and the
+and the
<structfield>groups</structfield>
- fields of an indicator map determine how the keyboard group state affects the
+fields of an indicator map determine how the keyboard group state affects the
corresponding indicator. The
<structfield>which_groups</structfield>
- field controls the interpretation of
+field controls the interpretation of
<structfield>groups</structfield>
- and may contain any one of the following values:
+and may contain any one of the following values:
<programlisting>
#define XkbIM_UseNone 0
@@ -357,11 +357,11 @@ inclusive OR of the following valid values:
<para>
If
<symbol>XkbIM_NoAutomatic</symbol>
- is not set (the keyboard drives the indicator), the effect of
+is not set (the keyboard drives the indicator), the effect of
<structfield>which_groups</structfield>
- and
+and
<structfield>groups</structfield>
- is shown in <link linkend="table8.2">Table 8.2</link>.
+is shown in <link linkend="table8.2">Table 8.2</link>.
</para>
<table id='table8.2' frame='topbot'>
@@ -383,7 +383,7 @@ Indicator</title>
<entry>
The
<structfield>groups</structfield>
- field and the current keyboard group state are ignored.
+field and the current keyboard group state are ignored.
</entry>
</row>
<row>
@@ -391,10 +391,10 @@ The
<entry>
If
<structfield>groups</structfield>
- is nonzero, the indicator is lit whenever the base keyboard group is nonzero.
+is nonzero, the indicator is lit whenever the base keyboard group is nonzero.
If
<structfield>groups</structfield>
- is zero, the indicator is lit whenever the base keyboard group is zero.
+is zero, the indicator is lit whenever the base keyboard group is zero.
</entry>
</row>
<row>
@@ -402,10 +402,10 @@ If
<entry>
If
<structfield>groups</structfield>
- is nonzero, the indicator is lit whenever the latched keyboard group is
+is nonzero, the indicator is lit whenever the latched keyboard group is
nonzero. If
<structfield>groups</structfield>
- is zero, the indicator is lit whenever the latched keyboard group is zero.
+is zero, the indicator is lit whenever the latched keyboard group is zero.
</entry>
</row>
<row>
@@ -413,7 +413,7 @@ nonzero. If
<entry>
The
<structfield>groups</structfield>
- field is interpreted as a mask. The indicator is lit when the current locked
+field is interpreted as a mask. The indicator is lit when the current locked
keyboard group matches one of the bits that are set in
<structfield>groups</structfield>.
</entry>
@@ -423,7 +423,7 @@ keyboard group matches one of the bits that are set in
<entry>
The
<structfield>groups</structfield>
- field is interpreted as a mask. The indicator is lit when the current
+field is interpreted as a mask. The indicator is lit when the current
effective keyboard group matches one of the bits that are set in
<structfield>groups</structfield>.
</entry>
@@ -435,11 +435,11 @@ effective keyboard group matches one of the bits that are set in
<para>
The effect of
<structfield>which_groups</structfield>
- and
+and
<structfield>groups</structfield>
- when you change an indicator for which
+when you change an indicator for which
<symbol>XkbIM_LEDDrivesKB</symbol>
- is set (the indicator drives the keyboard) is shown in
+is set (the indicator drives the keyboard) is shown in
<link linkend="table8.3">Table 8.3</link>. The <quote>New State</quote>
column refers to the new state to which you set the indicator.
</para>
@@ -476,12 +476,12 @@ Keyboard</title>
<entry>
The
<structfield>groups</structfield>
- field is treated as a group mask. The keyboard group latch is changed to the
+field is treated as a group mask. The keyboard group latch is changed to the
lowest numbered group specified in
<structfield>groups</structfield>;
- if
+if
<structfield>groups</structfield>
- is empty, the keyboard group latch is changed to zero.
+is empty, the keyboard group latch is changed to zero.
</entry>
</row>
<row>
@@ -490,12 +490,12 @@ lowest numbered group specified in
<entry>
The
<structfield>groups</structfield>
- field is treated as a group mask. If the indicator is explicitly extinguished,
+field is treated as a group mask. If the indicator is explicitly extinguished,
keyboard group latch is changed to the lowest numbered group not specified in
<structfield>groups</structfield>;
- if
+if
<structfield>groups</structfield>
- is zero, the keyboard group latch is set to the index of the highest legal
+is zero, the keyboard group latch is set to the index of the highest legal
keyboard group.
</entry>
</row>
@@ -505,7 +505,7 @@ keyboard group.
<entry>
If the
<structfield>groups</structfield>
- mask is empty, group is not changed; otherwise, the locked keyboard group is
+mask is empty, group is not changed; otherwise, the locked keyboard group is
changed to the lowest numbered group specified in
<structfield>groups</structfield>.
</entry>
@@ -517,11 +517,11 @@ changed to the lowest numbered group specified in
Locked keyboard group is changed to the lowest numbered group that is not
specified in the
<structfield>groups</structfield>
- mask, or to
+mask, or to
<emphasis>Group1</emphasis>
- if the
+if the
<structfield>groups</structfield>
- mask contains all keyboard groups.
+mask contains all keyboard groups.
</entry>
</row>
</tbody>
@@ -537,49 +537,49 @@ The
<structfield>mods</structfield>
field specifies what modifiers an indicator watches. The
<structfield>mods</structfield>
- field is an Xkb modifier definition,
+field is an Xkb modifier definition,
<structname>XkbModsRec</structname>,
as described in <link linkend="Modifier_Definitions">section 7.2</link>, which can specify both real and virtual
modifiers. The
<structfield>mods</structfield>
- field takes effect even if some or all of the virtual indicators specified in
+field takes effect even if some or all of the virtual indicators specified in
<structfield>mods</structfield>
- are unbound. To specify the mods field, in general, assign the modifiers of
+are unbound. To specify the mods field, in general, assign the modifiers of
interest to
<structfield>mods.real_mods</structfield>
- and the virtual modifiers of interest to
+and the virtual modifiers of interest to
<structfield>mods.vmods</structfield>.
You can disregard the
<structfield>mods.mask</structfield>
- field unless your application needs to interpret the indicator map directly
+field unless your application needs to interpret the indicator map directly
(that is, to simulate automatic indicator behavior on its own). Relatively few
applications need to do so, but if you find it necessary, you can either read
the indicator map back from the server after you update it (the server
automatically updates the mask field whenever any of the real or virtual
modifiers are changed in the modifier definition) or you can use
<function>XkbVirtualModsToReal</function>
- to determine the proper contents for the mask field, assuming that the
+to determine the proper contents for the mask field, assuming that the
<structname>XkbDescRec</structname>
- contains the virtual modifier definitions.
+contains the virtual modifier definitions.
</para>
<para>
<structfield>which_mods</structfield>
- specifies what criteria Xkb uses to determine a match with the corresponding
+specifies what criteria Xkb uses to determine a match with the corresponding
<structfield>mods</structfield>
- field by specifying one or more components of the Xkb keyboard state. If
+field by specifying one or more components of the Xkb keyboard state. If
<symbol>XkbIM_NoAutomatic</symbol>
- is not set (the keyboard drives the indicator), the indicator is lit whenever
+is not set (the keyboard drives the indicator), the indicator is lit whenever
any of the modifiers specified in the
<structfield>mask</structfield>
- field of the
+field of the
<structfield>mods</structfield>
- modifier definition are also set in any of the current keyboard state
+modifier definition are also set in any of the current keyboard state
components specified by
<structfield>which_mods</structfield>.
Remember that the
<structfield>mask</structfield>
- field is comprised of all of the real modifiers specified in the definition
+field is comprised of all of the real modifiers specified in the definition
plus any real modifiers that are bound to the virtual modifiers specified in
the definition. (See <xref linkend="Keyboard_State" /> for more information on the keyboard state and
<xref linkend="Virtual_Modifiers" /> for more information on virtual modifiers.) Use a bitwise inclusive
@@ -601,11 +601,11 @@ OR of the following values to compose a value for
<para>
If
<symbol>XkbIM_NoAutomatic</symbol>
- is not set (the keyboard drives the indicator), the effect of
+is not set (the keyboard drives the indicator), the effect of
<structfield>which_mods</structfield>
- and
+and
<structfield>mods</structfield>
- is shown in <link linkend="table8.4">Table 8.4</link>
+is shown in <link linkend="table8.4">Table 8.4</link>
</para>
<table id='table8.4' frame='topbot'>
@@ -631,13 +631,13 @@ ignored.</entry>
<entry>
The indicator is lit when any of the modifiers specified in the
<structfield>mask</structfield>
- field of
+field of
<structfield>mods</structfield>
- are on in the keyboard base state. If both
+are on in the keyboard base state. If both
<structfield>mods.real_mods</structfield>
- and
+and
<structfield>mods.vmods</structfield>
- are zero, the indicator is lit when the base keyboard state contains no
+are zero, the indicator is lit when the base keyboard state contains no
modifiers.
</entry>
</row>
@@ -646,13 +646,13 @@ modifiers.
<entry>
The indicator is lit when any of the modifiers specified in the
<structfield>mask</structfield>
- field of
+field of
<structfield>mods</structfield>
- are latched. If both
+are latched. If both
<structfield>mods.real_mods</structfield>
- and
+and
<structfield>mods.vmods</structfield>
- are zero, the indicator is lit when none of the modifier keys are latched.
+are zero, the indicator is lit when none of the modifier keys are latched.
</entry>
</row>
<row>
@@ -660,13 +660,13 @@ The indicator is lit when any of the modifiers specified in the
<entry>
The indicator is lit when any of the modifiers specified in the
<structfield>mask</structfield>
- field of
+field of
<structfield>mods</structfield>
- are locked. If both
+are locked. If both
<structfield>mods.real_mods</structfield>
- and
+and
<structfield>mods.vmods</structfield>
- are zero, the indicator is lit when none of the modifier keys are locked.
+are zero, the indicator is lit when none of the modifier keys are locked.
</entry>
</row>
<row>
@@ -674,13 +674,13 @@ The indicator is lit when any of the modifiers specified in the
<entry>
The indicator is lit when any of the modifiers specified in the
<structfield>mask</structfield>
- field of
+field of
<structfield>mods</structfield>
- are in the effective keyboard state. If both
+are in the effective keyboard state. If both
<structfield>mods.real_mods</structfield>
- and
+and
<structfield>mods.vmods</structfield>
- are zero, the indicator is lit when the effective keyboard state contains no
+are zero, the indicator is lit when the effective keyboard state contains no
modifiers.
</entry>
</row>
@@ -689,13 +689,13 @@ modifiers.
<entry>
The indicator is lit when any of the modifiers specified in the
<structfield>mask</structfield>
- field of
+field of
<structfield>mods</structfield>
- are in the keyboard compatibility state. If both
+are in the keyboard compatibility state. If both
<structfield>mods.real_mods</structfield>
- and
+and
<structfield>mods.vmods</structfield>
- are zero, the indicator is lit when the keyboard compatibility state contains
+are zero, the indicator is lit when the keyboard compatibility state contains
no modifiers.
</entry>
</row>
@@ -706,11 +706,11 @@ no modifiers.
<para>
The effect on the keyboard modifiers of
<structfield>which_mods</structfield>
- and
+and
<structfield>mods</structfield>
- when you change an indicator for which
+when you change an indicator for which
<symbol>XkbIM_LEDDrivesKB</symbol>
- is set (the indicator drives the keyboard) is shown in
+is set (the indicator drives the keyboard) is shown in
<link linkend="table8.5">Table 8.5</link>. The <quote>New State</quote>
column refers to the new state to which you set the indicator.
</para>
@@ -741,9 +741,9 @@ column refers to the new state to which you set the indicator.
<entry>
Any modifiers specified in the
<structfield>mask</structfield>
- field of
+field of
<structfield>mods</structfield>
- are added to the latched modifiers.
+are added to the latched modifiers.
</entry>
</row>
<row>
@@ -752,9 +752,9 @@ Any modifiers specified in the
<entry>
Any modifiers specified in the
<structfield>mask</structfield>
- field of
+field of
<structfield>mods</structfield>
- are removed from the latched modifiers.
+are removed from the latched modifiers.
</entry>
</row>
<row>
@@ -763,9 +763,9 @@ Any modifiers specified in the
<entry>
Any modifiers specified in the
<structfield>mask</structfield>
- field of
+field of
<structfield>mods</structfield>
- are added to the locked modifiers.
+are added to the locked modifiers.
</entry>
</row>
<row>
@@ -774,9 +774,9 @@ Any modifiers specified in the
<entry>
Any modifiers specified in the
<structfield>mask</structfield>
- field of
+field of
<structfield>mods</structfield>
- are removed from the locked modifiers.
+are removed from the locked modifiers.
</entry>
</row>
<row>
@@ -785,9 +785,9 @@ Any modifiers specified in the
<entry>
Any modifiers specified in the
<structfield>mask</structfield>
- field of
+field of
<structfield>mods</structfield>
- are removed from both the locked and latched modifiers.
+are removed from both the locked and latched modifiers.
</entry>
</row>
</tbody>
@@ -801,7 +801,7 @@ Any modifiers specified in the
<para>
The
<structfield>ctrls</structfield>
- field specifies what controls (see <xref linkend="Keyboard_Controls" />) the indicator watches and is
+field specifies what controls (see <xref linkend="Keyboard_Controls" />) the indicator watches and is
composed using the bitwise inclusive OR of the following values:
<programlisting>
@@ -823,7 +823,7 @@ composed using the bitwise inclusive OR of the following values:
<para>
Xkb lights the indicator whenever any of the boolean controls specified in
<structfield>ctrls</structfield>
- is enabled.
+is enabled.
</para>
@@ -841,10 +841,10 @@ is more suitable for applications concerned with interoperability, uses
indicator names. The correspondence between the indicator name and the bit
position in masks is as follows: one of the parameters returned from
<function>XkbGetNamedIndicator</function>
- is an index that is the bit position to use in any function call that requires
+is an index that 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
<structname>XkbIndicatorRec</structname>
- array of indicator maps.
+array of indicator maps.
</para>
@@ -908,25 +908,25 @@ current state of the keyboard indicators, use
<para>
<function>XkbGetIndicatorState</function>
- queries the
+queries the
<parameter>display</parameter>
- for the state of the indicators on the device specified by the
+for the state of the indicators on the device specified by the
<parameter>device_spec</parameter>.
For each indicator that is <quote>turned on</quote> on the device,
the associated bit is set in
<parameter>state_return</parameter>.
If a compatible version of the Xkb extension is not available in the server,
<function>XkbGetIndicatorState</function>
- returns a
+returns a
<errorname>BadMatch</errorname>
- error. Otherwise, it sends the request to the X server, places the state of
+error. Otherwise, it sends the request to the X server, places the state of
the indicators into
<parameter>state_return</parameter>,
- and returns
+and returns
<symbol>Success</symbol>.
Thus the value reported by
<function>XkbGetIndicatorState</function>
- is identical to the value reported by the core protocol.
+is identical to the value reported by the core protocol.
</para>
@@ -990,37 +990,37 @@ indicators, use
<para>
<function>XkbGetIndicatorMap</function>
- obtains the maps from the server for only those indicators specified by the
+obtains the maps from the server for only those indicators specified by the
<parameter>which</parameter>
- mask and copies the values into the keyboard description specified by
+mask and copies the values into the keyboard description specified by
<parameter>desc</parameter>.
If the
<structfield>indicators</structfield>
- field of the
+field of the
<parameter>desc</parameter>
- parameter is
+parameter is
<symbol>NULL</symbol>,
<function>XkbGetIndicatorMap</function>
- allocates and initializes it.
+allocates and initializes it.
</para>
<para>
<function>XkbGetIndicatorMap</function>
- can generate
+can generate
<errorname>BadAlloc</errorname>,
<errorname>BadLength</errorname>,
<errorname>BadMatch</errorname>,
and
<errorname>BadImplementation</errorname>
- errors.
+errors.
</para>
<para>
To free the indicator maps, use
<function>XkbFreeIndicatorMaps</function>
- (see <link linkend="Allocating_and_Freeing_Indicator_Maps">section 8.6</link>).
+(see <link linkend="Allocating_and_Freeing_Indicator_Maps">section 8.6</link>).
</para>
@@ -1031,21 +1031,21 @@ To free the indicator maps, use
<para>
Xkb also allows applications to refer to indicators by name. Use
<function>XkbGetNames</function>
- to get the indicator names (see <xref linkend="Symbolic_Names" />). Using names eliminates the need
+to get the indicator names (see <xref linkend="Symbolic_Names" />). Using names eliminates the need
for hard-coding bitmask values for particular keyboards. For example, instead
of using vendor-specific constants such as
<symbol>WSKBLed_ScrollLock</symbol>
- mask on Digital workstations or
+mask on Digital workstations or
<symbol>XLED_SCROLL_LOCK</symbol>
- on Sun workstations, you can instead use
+on Sun workstations, you can instead use
<function>XkbGetNamedIndicator</function>
- to look up information on the indicator named <quote>Scroll Lock.</quote>
+to look up information on the indicator named <quote>Scroll Lock.</quote>
</para>
<para>
Use
<function>XkbGetNamedIndicator</function>
- to look up the indicator map and other information for an indicator by name.
+to look up the indicator map and other information for an indicator by name.
</para>
<indexterm significance="preferred" zone="XkbGetNamedIndicator"><primary><function>XkbGetNamedIndicator</function></primary></indexterm>
@@ -1148,15 +1148,15 @@ Use
<para>
If the device specified by
<parameter>device_spec</parameter>
- has an indicator named
+has an indicator named
<parameter>name</parameter>,
<function>XkbGetNamedIndicator</function>
- returns
+returns
<symbol>True</symbol>
- and populates the rest of the parameters with information about the indicator.
+and populates the rest of the parameters with information about the indicator.
Otherwise,
<function>XkbGetNamedIndicator</function>
- returns
+returns
<symbol>False</symbol>.
</para>
@@ -1164,22 +1164,22 @@ Otherwise,
<para>
The
<parameter>ndx_rtrn</parameter>
- field returns the zero-based index of the named indicator. This index is the
+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
<structname>XkbIndicatorRec</structname>
- array of indicator maps.
+array of indicator maps.
<parameter>state_rtrn</parameter>
- returns the current state of the named indicator
+returns the current state of the named indicator
(<symbol>True</symbol>
- = on,
+= on,
<symbol>False</symbol>
- = off).
+= off).
<parameter>map_rtrn</parameter>
- returns the indicator map for the named indicator. In addition, if the
+returns the indicator map for the named indicator. In addition, if the
indicator is mapped to a physical LED, the
<parameter>real_rtrn</parameter>
- parameter is set to
+parameter is set to
<symbol>True</symbol>.
</para>
@@ -1187,17 +1187,17 @@ indicator is mapped to a physical LED, the
<para>
Each of the "<parameter>_rtrn</parameter>" arguments is optional; you can pass
<symbol>NULL</symbol>
- for any unneeded "<parameter>_rtrn</parameter>" arguments.
+for any unneeded "<parameter>_rtrn</parameter>" arguments.
</para>
<para>
<function>XkbGetNamedIndicator</function>
- can generate
+can generate
<errorname>BadAtom</errorname>
- and
+and
<errorname>BadImplementation</errorname>
- errors.
+errors.
</para>
@@ -1213,19 +1213,19 @@ so you can change it using a mask or a name.
<note><para>You cannot change the
<structfield>phys_indicators</structfield>
- field of the indicators structure. The only way to change the
+field of the indicators structure. The only way to change the
<structfield>phys_indicators</structfield>
- field is to change the keyboard map.</para></note>
+field is to change the keyboard map.</para></note>
<para>
There are two ways to make changes to indicator maps and state: either change a
local copy of the indicator maps and use
<function>XkbSetIndicatorMap</function>
- or
+or
<function>XkbSetNamedIndicator</function>,
or, to reduce network traffic, use an
<structname>XkbIndicatorChangesRec</structname>
- structure and use
+structure and use
<function>XkbChangeIndicators</function>.
</para>
@@ -1246,29 +1246,29 @@ are made.
<para>
If
<symbol>XkbIM_LEDDrivesKB</symbol>
- is set and
+is set and
<symbol>XkbIM_NoExplicit</symbol>
- is not, and if you call a function that updates the server’s image of the
+is not, and if you call a function that updates the server’s image of the
indicator map (such as
<function>XkbSetIndicatorMap</function>
- or
+or
<function>XkbSetNamedIndicator</function>),
- Xkb changes the keyboard state and controls to reflect the other fields of
+Xkb changes the keyboard state and controls to reflect the other fields of
the indicator map. If you attempt to explicitly change the value of an
indicator for which
<symbol>XkbIM_LEDDrivesKB</symbol>
- is absent or for which
+is absent or for which
<symbol>XkbIM_NoExplicit</symbol>
- is present, keyboard state or controls are unaffected.
+is present, keyboard state or controls are unaffected.
</para>
<para>
If neither
<symbol>XkbIM_NoAutomatic</symbol>
- nor
+nor
<symbol>XkbIM_NoExplicit</symbol>
- is set in an indicator map, Xkb honors any request to change the state of the
+is set in an indicator map, Xkb honors any request to change the state of the
indicator, but the new state might be immediately superseded by automatic
changes to the indicator state if the keyboard state or controls change.
</para>
@@ -1284,9 +1284,9 @@ controls simultaneously.
<para>
If you change an indicator for which both the
<symbol>XkbIM_LEDDrivesKB</symbol>
- and
+and
<symbol>XkbIM_NoAutomatic</symbol>
- flags are specified, Xkb applies the keyboard changes specified in the other
+flags are specified, Xkb applies the keyboard changes specified in the other
indicator map fields and changes the indicator to reflect the state that was
explicitly requested. The indicator remains in the new state until it is
explicitly changed again.
@@ -1296,33 +1296,33 @@ explicitly changed again.
<para>
If the
<symbol>XkbIM_NoAutomatic</symbol>
- flag is not set and
+flag is not set and
<symbol>XkbIM_LEDDrivesKB</symbol>
- is set, Xkb applies the changes specified in the other indicator map fields
+is set, Xkb applies the changes specified in the other indicator map fields
and sets the state of the indicator to the values specified by the indicator
map. Note that it is possible in this case for the indicator to end up in a
different state than the one that was explicitly requested. For example, Xkb
does not extinguish an indicator with
<structfield>which_mods</structfield>
- of
+of
<symbol>XkbIM_UseBase</symbol>
- and
+and
<structfield>mods</structfield>
- of
+of
<symbol>Shift</symbol>
- if, at the time Xkb processes the request to extinguish the indicator, one of
+if, at the time Xkb processes the request to extinguish the indicator, one of
the
<symbol>Shift</symbol>
- keys is physically depressed.
+keys is physically depressed.
</para>
<para>
If you explicitly light an indicator for which
<symbol>XkbIM_LEDDrivesKB</symbol>
- is set, Xkb enables all of the boolean controls specified in the
+is set, Xkb enables all of the boolean controls specified in the
<structfield>ctrls</structfield>
- field of its indicator map. Explicitly extinguishing such an indicator causes
+field of its indicator map. Explicitly extinguishing such an indicator causes
Xkb to disable all of the boolean controls specified in
<structfield>ctrls</structfield>.
</para>
@@ -1336,7 +1336,7 @@ Xkb to disable all of the boolean controls specified in
To update the maps for one or more indicators, first modify a local copy of the
keyboard description, then use
<function>XkbSetIndicatorMap</function>
- to download the changes to the server:
+to download the changes to the server:
</para>
<indexterm significance="preferred" zone="XkbSetIndicatorMap"><primary><function>XkbSetIndicatorMap</function></primary></indexterm>
@@ -1393,9 +1393,9 @@ bit set in the
<parameter>which</parameter>
parameter,
<function>XkbSetIndicatorMap</function>
- sends the corresponding indicator map from the
+sends the corresponding indicator map from the
<parameter>desc</parameter>
- parameter to the server.
+parameter to the server.
</para>
@@ -1405,7 +1405,7 @@ parameter,
<para>
<function>XkbSetNamedIndicator</function>
- can do several related things:
+can do several related things:
</para>
<itemizedlist>
@@ -1530,12 +1530,12 @@ Set the indicator map for the indicator
<para>
If a compatible version of the Xkb extension is not available in the server,
<function>XkbSetNamedIndicator</function>
- returns
+returns
<symbol>False</symbol>.
Otherwise, it sends a request to the X server to change the indicator
specified by
<parameter>name</parameter>
- and returns
+and returns
<symbol>True</symbol>.
</para>
@@ -1543,14 +1543,14 @@ specified by
<para>
If
<parameter>change_state</parameter>
- is
+is
<symbol>True</symbol>,
and the optional parameter,
<parameter>state</parameter>,
is not
<symbol>NULL</symbol>,
<function>XkbSetNamedIndicator</function>
- tells the server to change the state of the named indicator to the value
+tells the server to change the state of the named indicator to the value
specified by
<parameter>state</parameter>.
</para>
@@ -1559,11 +1559,11 @@ specified by
<para>
If an indicator with the name specified by
<parameter>name</parameter>
- does not already exist, the
+does not already exist, the
<parameter>create_new</parameter>
- parameter tells the server whether it should create a new named indicator. If
+parameter tells the server whether it should create a new named indicator. If
<parameter>create_new</parameter>
- is
+is
<symbol>True</symbol>,
the server finds the first indicator that doesn’t have a name and gives it
the name specified by
@@ -1577,23 +1577,23 @@ If the optional parameter,
is not
<symbol>NULL</symbol>,
<function>XkbSetNamedIndicator</function>
- tells the server to change the indicator’s map to the values specified
+tells the server to change the indicator’s map to the values specified
in <parameter>map</parameter>.
</para>
<para>
<function>XkbSetNamedIndicator</function>
- can generate
+can generate
<errorname>BadAtom</errorname>
- and
+and
<errorname>BadImplementation</errorname>
- errors. In addition, it can also generate
+errors. In addition, it can also generate
<symbol>XkbIndicatorStateNotify</symbol>
- (see <link linkend="Tracking_Changes_to_Indicator_State_or_Map">section 8.5</link>),
+(see <link linkend="Tracking_Changes_to_Indicator_State_or_Map">section 8.5</link>),
<symbol>XkbIndicatorMapNotify</symbol>,
and
<symbol>XkbNamesNotify</symbol>
- events (see <link linkend="Tracking_Name_Changes">section 18.5</link>).
+events (see <link linkend="Tracking_Name_Changes">section 18.5</link>).
</para>
@@ -1607,9 +1607,9 @@ and
<para>
The
<structname>XkbIndicatorChangesRec</structname>
- identifies small modifications to the indicator map. Use it with the function
+identifies small modifications to the indicator map. Use it with the function
<function>XkbChangeIndicators</function>
- to reduce the amount of traffic sent to the server.
+to reduce the amount of traffic sent to the server.
</para>
<para><programlisting>
@@ -1622,9 +1622,9 @@ typedef struct _XkbIndicatorChanges {
<para>
The
<structfield>state_changes</structfield>
- field is a mask that specifies the indicators that have changed state, and
+field is a mask that specifies the indicators that have changed state, and
<structfield>map_changes</structfield>
- is a mask that specifies the indicators whose maps have changed.
+is a mask that specifies the indicators whose maps have changed.
</para>
@@ -1693,36 +1693,36 @@ description, use
<para>
<function>XkbChangeIndicators</function>
- copies any maps specified by
+copies any maps specified by
<parameter>changes</parameter>
- from the keyboard description,
+from the keyboard description,
<parameter>xkb</parameter>,
to the server specified by
<parameter>dpy</parameter>.
If any bits are set in the
<structfield>state_changes</structfield>
- field of
+field of
<parameter>changes</parameter>,
<function>XkbChangeIndicators</function>
- also sets the state of those indicators to the values specified in the
+also sets the state of those indicators to the values specified in the
<parameter>state</parameter>
- mask. A 1 bit in
+mask. A 1 bit in
<parameter>state</parameter>
- turns the corresponding indicator on, a 0 bit turns it off.
+turns the corresponding indicator on, a 0 bit turns it off.
</para>
<para>
<function>XkbChangeIndicators</function>
- can generate
+can generate
<errorname>BadAtom</errorname>
- and
+and
<errorname>BadImplementation</errorname>
- errors. In addition, it can also generate
+errors. In addition, it can also generate
<symbol>XkbIndicatorStateNotify</symbol>
- and
+and
<symbol>XkbIndicatorMapNotify</symbol>
- events (see <link linkend="Tracking_Changes_to_Indicator_State_or_Map">section 8.5</link>).
+events (see <link linkend="Tracking_Changes_to_Indicator_State_or_Map">section 8.5</link>).
</para>
@@ -1744,29 +1744,29 @@ If any bits are set in the
<para>
Whenever an indicator changes state, the server sends
<symbol>XkbIndicatorStateNotify</symbol>
- events to all interested clients. Similarly, whenever an indicator’s map
+events to all interested clients. Similarly, whenever an indicator’s map
changes, the server sends
<symbol>XkbIndicatorMapNotify</symbol>
- events to all interested clients.
+events to all interested clients.
</para>
<para>
To receive
<symbol>XkbIndicatorStateNotify</symbol>
- events, use
+events, use
<function>XkbSelectEvents</function>
- (see <link linkend="Selecting_Xkb_Events">section 4.3</link>) with both the
+(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) with both the
<parameter>bits_to_change</parameter>
and
<parameter>values_for_bits</parameter>
- parameters containing
+parameters containing
<symbol>XkbIndicatorStateNotifyMask</symbol>.
To receive
<symbol>XkbIndicatorMapNotify</symbol>
- events, use
+events, use
<function>XkbSelectEvents</function>
- with
+with
<symbol>XkbIndicatorMapNotifyMask</symbol>.
</para>
@@ -1776,15 +1776,15 @@ To receive events for only specific indicators, use
<function>XkbSelectEventDetails</function>.
Set the
<structfield>event_type</structfield>
- parameter to
+parameter to
<symbol>XkbIndicatorStateNotify</symbol>
- or
+or
<symbol>XkbIndicatorMapNotify</symbol>,
and set both the
<parameter>bits_to_change</parameter>
and
<parameter>values_for_bits</parameter>
- detail parameters to a mask where each bit specifies one indicator, turning on
+detail parameters to a mask where each bit specifies one indicator, turning on
those bits that specify the indicators for which you want to receive events.
</para>
@@ -1808,41 +1808,41 @@ typedef struct _XkbIndicatorNotify {
<para>
<structfield>xkb_type</structfield>
- is either
+is either
<symbol>XkbIndicatorStateNotify</symbol>
- or
+or
<symbol>XkbIndicatorMapNotify</symbol>,
depending on whether the event is a
<symbol>XkbIndicatorStateNotify</symbol>
- event or
+event or
<symbol>XkbIndicatorMapNotify</symbol>,
- event.
+event.
</para>
<para>
The
<structfield>changed</structfield>
- parameter is a mask that is the bitwise inclusive OR of the indicators that
+parameter is a mask that is the bitwise inclusive OR of the indicators that
have changed. If the event is of type
<symbol>XkbIndicatorMapNotify</symbol>,
<structfield>changed</structfield>
- reports the maps that changed. If the event is of type
+reports the maps that changed. If the event is of type
<symbol>XkbIndicatorStateNotify</symbol>,
<structfield>changed</structfield>
- reports the indicators that have changed state.
+reports the indicators that have changed state.
<parameter>state</parameter>
- is a mask that specifies the current state of all indicators, whether they
+is a mask that specifies the current state of all indicators, whether they
have changed or not, for both
<symbol>XkbIndicatorStateNotify</symbol>
- and <symbol>XkbIndicatorMapNotify</symbol> events.
+and <symbol>XkbIndicatorMapNotify</symbol> events.
</para>
<para>
When your client application receives either a
<symbol>XkbIndicatorStateNotify</symbol>
- event or
+event or
<symbol>XkbIndicatorMapNotify</symbol>
- event, you can note the changes in a changes structure by calling
+event, you can note the changes in a changes structure by calling
<function>XkbNoteIndicatorChanges</function>.
</para>
@@ -1897,16 +1897,16 @@ When your client application receives either a
<para>
The
<parameter>wanted</parameter>
- parameter is the bitwise inclusive OR of
+parameter is the bitwise inclusive OR of
<symbol>XkbIndicatorMapMask</symbol>
- and
+and
<emphasis>XkbIndicatorStateMask</emphasis>.
<function>XkbNoteIndicatorChanges</function>
- copies any changes reported in
+copies any changes reported in
<parameter>new</parameter>
- and specified in
+and specified in
<parameter>wanted</parameter>
- into the changes record specified by
+into the changes record specified by
<parameter>old</parameter>.
</para>
@@ -1915,7 +1915,7 @@ The
To update a local copy of the keyboard description with the actual values, pass
the results of one or more calls to
<function>XkbNoteIndicatorChanges</function>
- to
+to
<function>XkbGetIndicatorChanges</function>:
</para>
@@ -1982,41 +1982,41 @@ the results of one or more calls to
<para>
<function>XkbGetIndicatorChanges</function>
- examines the
+examines the
<parameter>changes</parameter>
- parameter, pulls over the necessary information from the server, and copies
+parameter, pulls over the necessary information from the server, and copies
the results into the
<parameter>xkb</parameter>
- keyboard description. If any bits are set in the
+keyboard description. If any bits are set in the
<structfield>state_changes</structfield>
- field of
+field of
<parameter>changes</parameter>,
<function>XkbGetIndicatorChanges</function>
- also places the state of those indicators in
+also places the state of those indicators in
<parameter>state</parameter>.
If the
<structfield>indicators</structfield>
- field of
+field of
<parameter>xkb</parameter>
- is
+is
<symbol>NULL</symbol>,
<function>XkbGetIndicatorChanges</function>
- allocates and initializes it. To free the
+allocates and initializes it. To free the
<structfield>indicators</structfield>
- field, use
+field, use
<function>XkbFreeIndicatorMaps</function>
- (see <link linkend="Allocating_and_Freeing_Indicator_Maps">section 8.6</link>).
+(see <link linkend="Allocating_and_Freeing_Indicator_Maps">section 8.6</link>).
</para>
<para>
<function>XkbGetIndicatorChanges</function>
- can generate
+can generate
<errorname>BadAlloc</errorname>,
<errorname>BadImplementation</errorname>,
- and
+and
<errorname>BadMatch</errorname>
- errors.
+errors.
</para>
@@ -2027,7 +2027,7 @@ If the
<para>
Most applications do not need to directly allocate the
<structfield>indicators</structfield>
- member of the keyboard description record (the keyboard description record is
+member of the keyboard description record (the keyboard description record is
described in <xref linkend="Complete_Keyboard_Description" />). If the need arises, however, use
<function>XkbAllocIndicatorMaps</function>.
</para>
@@ -2059,29 +2059,29 @@ described in <xref linkend="Complete_Keyboard_Description" />). If the need aris
<para>
The
<parameter>xkb</parameter>
- parameter must point to a valid keyboard description. If it doesn’t,
+parameter must point to a valid keyboard description. If it doesn’t,
<function>XkbAllocIndicatorMaps</function>
- returns a
+returns a
<errorname>BadMatch</errorname>
- error. Otherwise,
+error. Otherwise,
<function>XkbAllocIndicatorMaps</function>
- allocates and initializes the
+allocates and initializes the
<structfield>indicators</structfield>
- member of the keyboard description record and returns
+member of the keyboard description record and returns
<symbol>Success</symbol>.
If
<function>XkbAllocIndicatorMaps</function>
- was unable to allocate the indicators record, it reports a
+was unable to allocate the indicators record, it reports a
<errorname>BadAlloc</errorname>
- error.
+error.
</para>
<para>
To free memory used by the
<structfield>indicators</structfield>
- member of an
+member of an
<structname>XkbDescRec</structname>
- structure, use
+structure, use
<function>XkbFreeIndicatorMaps</function>.
</para>
@@ -2111,7 +2111,7 @@ To free memory used by the
<para>
If the <structfield>indicators</structfield>
- member of the keyboard description record
+member of the keyboard description record
pointed to by <parameter>xkb</parameter>
is not <symbol>NULL</symbol>,
<function>XkbFreeIndicatorMaps</function>
diff --git a/specs/XKB/ch09.xml b/specs/XKB/ch09.xml
index dad70f24..0241880b 100644
--- a/specs/XKB/ch09.xml
+++ b/specs/XKB/ch09.xml
@@ -16,7 +16,7 @@ document, the
<primary>audible bell</primary></indexterm>
<indexterm significance="preferred" zone="Bells">
<primary>bell</primary><secondary>audible</secondary></indexterm>
- bell is defined to be the system bell, or the default keyboard bell, as
+bell is defined to be the system bell, or the default keyboard bell, as
opposed to any other audible sound generated elsewhere in the system.
</para>
@@ -24,7 +24,7 @@ opposed to any other audible sound generated elsewhere in the system.
<para>
You can ask to receive
<symbol>XkbBellNotify</symbol>
- events (see <link linkend="Detecting_Bells">section 9.4</link>) when any client rings any one of the following:
+events (see <link linkend="Detecting_Bells">section 9.4</link>) when any client rings any one of the following:
</para>
<itemizedlist>
@@ -37,9 +37,9 @@ The default bell
<para>
Any bell on an input device that can be specified by a
<structfield>bell_class</structfield>
- and
+and
<structfield>bell_id</structfield>
- pair
+pair
</para>
</listitem>
<listitem>
@@ -55,7 +55,7 @@ visual feedback, if any, that is associated with the name.)
<para>
You can also ask to receive
<symbol>XkbBellNotify</symbol>
- events when the server rings the default bell or if any client has requested
+events when the server rings the default bell or if any client has requested
events only (without the bell sounding) for any of the bell types previously
listed.
</para>
@@ -63,27 +63,27 @@ listed.
<para>
You can disable audible bells on a global basis (to set the
<emphasis>AudibleBell</emphasis>
- control, see <xref linkend="Keyboard_Controls" />). For example, a client that replaces the keyboard
+control, see <xref linkend="Keyboard_Controls" />). For example, a client that replaces the keyboard
bell with some other audible cue might want to turn off the
<emphasis>AudibleBell</emphasis>
- control to prevent the server from also generating a sound and avoid
+control to prevent the server from also generating a sound and avoid
cacophony. If you disable audible bells and request to receive
<symbol>XkbBellNotify</symbol>
- events, you can generate feedback different from the default bell.
+events, you can generate feedback different from the default bell.
</para>
<para>
You can, however, override the
<emphasis>AudibleBell</emphasis>
- control by calling one of the functions that force the ringing of a bell in
+control by calling one of the functions that force the ringing of a bell in
spite of the setting of the
<emphasis>AudibleBell</emphasis>
- control —
+control —
<function>XkbForceDeviceBell</function>
- or
+or
<function>XkbForceBell</function>
- (see <link linkend="Forcing_a_Server_Generated_Bell">section 9.3.3</link>). In this case the server does not generate a bell event.
+(see <link linkend="Forcing_a_Server_Generated_Bell">section 9.3.3</link>). In this case the server does not generate a bell event.
</para>
@@ -92,10 +92,10 @@ Just as some keyboards can produce keyclicks to indicate when a key is pressed
or repeating, Xkb can provide feedback for the controls by using special beep
codes. The
<emphasis>AccessXFeedback</emphasis>
- control is used to configure the specific types of operations that generate
+control is used to configure the specific types of operations that generate
feedback. See <link linkend="The_AccessXFeedback_Control">section 10.6.3</link> for a discussion on
<emphasis>AccessXFeedback</emphasis>
- control.
+control.
</para>
<para>
@@ -112,7 +112,7 @@ an Atom and then using this name when you call the functions listed in this
chapter. If an event is generated as a result, the name is then passed to all
other clients interested in receiving
<symbol>XkbBellNotify</symbol>
- events. Note that these are arbitrary names and that there is no binding to
+events. Note that these are arbitrary names and that there is no binding to
any sounds. Any sounds or other effects (such as visual bells on the screen)
must be generated by a client application upon receipt of the bell event
containing the name. There is no default name for the default keyboard bell.
@@ -122,7 +122,7 @@ These named bells are shown in <link linkend="table9.1">Table 9.1</link>;
the name is included
in any bell event sent to clients that have requested to receive
<symbol>XkbBellNotify</symbol>
- events.
+events.
</para>
<table id='table9.1' frame='topbot'>
@@ -212,9 +212,9 @@ bell. This is useful if you need to use an audio server instead of the system
beep. For example, when an audio client starts, it could disable the audible
bell (the system bell) and then listen for
<symbol>XkbBellNotify</symbol>
- events (see <link linkend="Detecting_Bells">section 9.4</link>). When it receives a
+events (see <link linkend="Detecting_Bells">section 9.4</link>). When it receives a
<symbol>XkbBellNotify</symbol>
- event, the audio client could then send a request to an audio server to play a
+event, the audio client could then send a request to an audio server to play a
sound.
</para>
@@ -222,19 +222,19 @@ sound.
<para>
You can control the audible bells feature by passing the
<symbol>XkbAudibleBellMask</symbol>
- to
+to
<function>XkbChangeEnabledControls</function>
- (see <link linkend="The_EnabledControls_Control">section 10.1.1</link>). If you set
+(see <link linkend="The_EnabledControls_Control">section 10.1.1</link>). If you set
<symbol>XkbAudibleBellMask</symbol>
- on, the server rings the system bell when a bell event occurs. This is the
+on, the server rings the system bell when a bell event occurs. This is the
default. If you set
<symbol>XkbAudibleBellMask</symbol>
- off and a bell event occurs, the server does not ring the system bell unless
+off and a bell event occurs, the server does not ring the system bell unless
you call
<function>XkbForceDeviceBell</function>
- or
+or
<function>XkbForceBell</function>
- (see <link linkend="Forcing_a_Server_Generated_Bell">section 9.3.3</link>).
+(see <link linkend="Forcing_a_Server_Generated_Bell">section 9.3.3</link>).
</para>
<para>
@@ -255,25 +255,25 @@ events.
The input extension has two types of feedbacks that can generate bells — bell
feedback and keyboard feedback. Some of the functions in this section have
<structfield>bell_class</structfield>
- and
+and
<structfield>bell_id</structfield>
- parameters; set them as follows: Set
+parameters; set them as follows: Set
<structfield>bell_class</structfield>
- to
+to
<symbol>BellFeedbackClass</symbol>
- or
+or
<symbol>KbdFeedbackClass</symbol>.
A device can have more than one feedback of each type; set
<structfield>bell_id</structfield>
- to the particular bell feedback of
+to the particular bell feedback of
<structfield>bell_class</structfield>
- type.
+type.
</para>
<para>
<link linkend="table9.2">Table 9.2</link> shows the conditions that cause
a bell to sound or an <structname>XkbBellNotifyEvent</structname>
- to be generated when a bell function is called.
+to be generated when a bell function is called.
</para>
<table id='table9.2' frame='topbot'>
@@ -446,18 +446,18 @@ To ring the bell on an X input extension device or the default keyboard, use
<para>
Set
<parameter>percent</parameter>
- to be the volume relative to the base volume for the keyboard as described for
+to be the volume relative to the base volume for the keyboard as described for
<function>XBell</function>.
</para>
<para>
Note that
<parameter>bell_class</parameter>
- and
+and
<parameter>bell_id</parameter>
- indicate the bell to physically ring.
+indicate the bell to physically ring.
<parameter>name</parameter>
- is simply an arbitrary moniker for the client application’s use.
+is simply an arbitrary moniker for the client application’s use.
</para>
<para>
@@ -466,13 +466,13 @@ To determine the current feedback settings of an extension input device, use
See <olink targetdoc='inputlib' targetptr='Controlling_Device_Feedback'>the
X input extension documentation</olink> for more information on
<function>XGetFeedbackControl</function>
- and related data structures.
+and related data structures.
</para>
<para>
If a compatible keyboard extension is not present in the X server,
<function>XkbDeviceBell</function>
- immediately returns
+immediately returns
<symbol>False</symbol>.
Otherwise,
<function>XkbDeviceBell</function>
@@ -481,13 +481,13 @@ rings the bell as specified for the display and keyboard device and returns
If you have disabled the audible bell, the server does not ring the system
bell, although it does generate a
<symbol>XkbBellNotify</symbol>
- event.
+event.
</para>
<para>
You can call
<function>XkbDeviceBell</function>
- without first initializing the keyboard extension.
+without first initializing the keyboard extension.
</para>
<para>
@@ -556,11 +556,11 @@ default keyboard:
<para>
If a compatible keyboard extension isn’t present in the X server,
<function>XkbBell</function>
- calls
+calls
<function>XBell</function>
with the specified
<parameter>display</parameter>
- and
+and
<parameter>percent</parameter>,
and returns
<symbol>False</symbol>.
@@ -568,7 +568,7 @@ Otherwise,
<function>XkbBell</function>
calls
<function>XkbDeviceBell</function>
- with the specified
+with the specified
<parameter>display</parameter>,
<parameter>window</parameter>,
<parameter>percent</parameter>,
@@ -576,7 +576,7 @@ and
<parameter>name</parameter>,
a
<structfield>device_spec</structfield>
- of
+of
<symbol>XkbUseCoreKbd</symbol>,
a
<structfield>bell_class</structfield>
@@ -586,7 +586,7 @@ and a
<structfield>bell_id</structfield>
of
<symbol>XkbDfltXIId</symbol>,
- and returns
+and returns
<symbol>True</symbol>.
</para>
@@ -594,13 +594,13 @@ of
If you have disabled the audible bell, the server does not ring the system
bell, although it does generate a
<symbol>XkbBellNotify</symbol>
- event.
+event.
</para>
<para>
You can call
<function>XkbBell</function>
- without first initializing the keyboard extension.
+without first initializing the keyboard extension.
</para>
</sect2>
@@ -721,17 +721,17 @@ without ringing the corresponding bell, use
<para>
If a compatible keyboard extension isn’t present in the X server,
<function>XkbDeviceBellEvent</function>
- immediately returns
+immediately returns
<symbol>False</symbol>.
Otherwise,
<function>XkbDeviceBellEvent</function>
- causes an
+causes an
<symbol>XkbBellNotify</symbol>
- event to be sent to all interested clients and returns
+event to be sent to all interested clients and returns
<symbol>True</symbol>.
Set
<parameter>percent</parameter>
- to be the volume relative to the base volume for the keyboard as described for
+to be the volume relative to the base volume for the keyboard as described for
<function>XBell</function>.
</para>
@@ -739,13 +739,13 @@ Set
<para>
In addition,
<function>XkbDeviceBellEvent</function>
- may generate
+may generate
<type>Atom</type>
- protocol errors as well as
+protocol errors as well as
<symbol>XkbBellNotify</symbol>
- events. You can call
+events. You can call
<function>XkbBell</function>
- without first initializing the keyboard extension.
+without first initializing the keyboard extension.
</para>
@@ -816,13 +816,13 @@ the keyboard without ringing the bell:
<para>
If a compatible keyboard extension isn’t present in the X server,
<function>XkbBellEvent</function>
- immediately returns
+immediately returns
<symbol>False</symbol>.
Otherwise,
<function>XkbBellEvent</function>
calls
<function>XkbDeviceBellEvent</function>
- with the specified
+with the specified
<parameter>display</parameter>,
<parameter>window</parameter>,
<parameter>percent</parameter>,
@@ -830,7 +830,7 @@ and
<parameter>name</parameter>,
a
<structfield>device_spec</structfield>
- of
+of
<symbol>XkbUseCoreKbd</symbol>,
a
<structfield>bell_class</structfield>
@@ -840,9 +840,9 @@ and a
<structfield>bell_id</structfield>
of
<symbol>XkbDfltXIId</symbol>,
- and returns what
+and returns what
<function>XkbDeviceBellEvent</function>
- returns.
+returns.
</para>
<para>
@@ -949,7 +949,7 @@ audible bells, use <function>XkbForceDeviceBell</function>.
<para>
If a compatible keyboard extension isn’t present in the X server,
<function>XkbForceDeviceBell</function>
- immediately returns
+immediately returns
<symbol>False</symbol>.
Otherwise,
<function>XkbForceDeviceBell</function>
@@ -957,21 +957,21 @@ rings the bell as specified for the display and keyboard device and returns
<symbol>True</symbol>.
Set
<parameter>percent</parameter>
- to be the volume relative to the base volume for the keyboard as described for
+to be the volume relative to the base volume for the keyboard as described for
<function>XBell</function>.
There is no
<structfield>name</structfield>
- parameter because
+parameter because
<function>XkbForceDeviceBell</function>
does not cause an
<symbol>XkbBellNotify</symbol>
- event.
+event.
</para>
<para>
You can call
<function>XkbBell</function>
- without first initializing the keyboard extension.
+without first initializing the keyboard extension.
</para>
<para>
@@ -1017,24 +1017,24 @@ for audible bells, use
<para>
If a compatible keyboard extension isn’t present in the X server,
<function>XkbForceBell</function>
- calls
+calls
<function>XBell</function>
with the specified
<parameter>display</parameter>
- and
+and
<parameter>percent</parameter>
- and returns
+and returns
<symbol>False</symbol>.
Otherwise,
<function>XkbForceBell</function>
calls
<function>XkbForceDeviceBell</function>
- with the specified
+with the specified
<parameter>display</parameter>
and
<parameter>percent</parameter>,
<structfield>device_spec</structfield>
- =
+=
<symbol>XkbUseCoreKbd</symbol>,
<structfield>bell_class</structfield>
=
@@ -1043,26 +1043,26 @@ and
=
<symbol>XkbDfltXIId</symbol>,
<structfield>window</structfield>
- = None, and
+= None, and
<structfield>name</structfield>
- =
+=
<symbol>NULL</symbol>,
and returns what
<function>XkbForceDeviceBell</function>
- returns.
+returns.
</para>
<para>
<function>XkbForceBell</function>
does not cause an
<symbol>XkbBellNotify</symbol>
- event.
+event.
</para>
<para>
You can call
<function>XkbBell</function>
- without first initializing the keyboard extension.
+without first initializing the keyboard extension.
</para>
</sect2>
@@ -1073,47 +1073,47 @@ You can call
<para>
Xkb generates
<symbol>XkbBellNotify</symbol>
- events for all bells except for those resulting from calls to
+events for all bells except for those resulting from calls to
<function>XkbForceDeviceBell</function>
- and
+and
<function>XkbForceBell</function>.
To receive
<symbol>XkbBellNotify</symbol>
- events under all possible conditions, pass
+events under all possible conditions, pass
<symbol>XkbBellNotifyMask</symbol>
- in both the
+in both the
<parameter>bits_to_change</parameter>
and
<parameter>values_for_bits</parameter>
- parameters to
+parameters to
<function>XkbSelectEvents</function>
- (see <link linkend="Selecting_Xkb_Events">section 4.3</link>).
+(see <link linkend="Selecting_Xkb_Events">section 4.3</link>).
</para>
<para>
The
<symbol>XkbBellNotify</symbol>
- event has no event details. It is either selected or it is not. However, you
+event has no event details. It is either selected or it is not. However, you
can call
<function>XkbSelectEventDetails</function>
- using
+using
<symbol>XkbBellNotify</symbol>
- as the
+as the
<structfield>event_type</structfield>
- and specifying
+and specifying
<symbol>XkbAllBellEventsMask</symbol>
- in
+in
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>.
- This has the same effect as a call to
+This has the same effect as a call to
<function>XkbSelectEvents</function>.
</para>
<para>
The structure for the
<symbol>XkbBellNotify</symbol>
- event type contains:
+event type contains:
<programlisting>
typedef struct _XkbBellNotify {
diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml
index d99c788a..72727f22 100644
--- a/specs/XKB/ch10.xml
+++ b/specs/XKB/ch10.xml
@@ -40,7 +40,7 @@ remaining controls, known as the
<primary>controls</primary><secondary>non-boolean</secondary></indexterm>
are always active. The
<structname>XkbControlsRec</structname>
- structure describes the current state of most of the global controls and the
+structure describes the current state of most of the global controls and the
attributes effecting the behavior of each of these Xkb features. This chapter
describes the Xkb controls and how to manipulate them.
</para>
@@ -52,7 +52,7 @@ describing how the control should work, and a state describing whether the
behavior as a whole is enabled or disabled. The attributes and state for most
of these controls are held in the
<structname>XkbControlsRec</structname>
- structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>).
+structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>).
</para>
@@ -60,13 +60,13 @@ of these controls are held in the
You can manipulate the Xkb controls individually, via convenience functions, or
as a whole. To treat them as a group, modify an
<structname>XkbControlsRec</structname>
- structure to describe all of the changes to be made, and then pass that
+structure to describe all of the changes to be made, and then pass that
structure and appropriate flags to an Xkb library function, or use a
<structname>XkbControlsChangesRec</structname>
- (see <link linkend="The_XkbControlsChangesRec_Structure">section 10.10.1</link>) to reduce network traffic. When using a convenience
+(see <link linkend="The_XkbControlsChangesRec_Structure">section 10.10.1</link>) to reduce network traffic. When using a convenience
function to manipulate one control individually, you do not use an
<structname>XkbControlsRec</structname>
- structure directly.
+structure directly.
</para>
@@ -213,7 +213,7 @@ The Xkb controls are grouped as shown in
The individual categories and controls are described first, together with
functions for manipulating them. A description of the
<structname>XkbControlsRec</structname>
- structure and the general functions for dealing with all of the controls at
+structure and the general functions for dealing with all of the controls at
once follow at the end of the chapter.
</para>
@@ -223,9 +223,9 @@ once follow at the end of the chapter.
<para>
Enable and disable the boolean controls under program control by using the
<emphasis>EnabledControls</emphasis>
- control; enable and disable them upon program exit by configuring the
+control; enable and disable them upon program exit by configuring the
<emphasis>AutoReset</emphasis>
- control.
+control.
</para>
@@ -235,12 +235,12 @@ Enable and disable the boolean controls under program control by using the
<para>
The
<emphasis>EnabledControls</emphasis>
- control is a bit mask where each bit that is turned on means the corresponding
+control is a bit mask where each bit that is turned on means the corresponding
control is enabled, and when turned off, disabled. It corresponds to the
<structfield>enabled_ctrls</structfield>
- field of an
+field of an
<structname>XkbControlsRec</structname>
- structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>). The bits describing which controls are turned on
+structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>). The bits describing which controls are turned on
or off are defined in <link linkend="table10.7">Table 10.7</link>.
</para>
@@ -248,9 +248,9 @@ or off are defined in <link linkend="table10.7">Table 10.7</link>.
<para>
Use
<function>XkbChangeEnabledControls</function>
- to manipulate the
+to manipulate the
<emphasis>EnabledControls</emphasis>
- control.
+control.
</para>
<indexterm significance="preferred" zone="XkbChangeEnabledControls"><primary><function>XkbChangeEnabledControls</function></primary></indexterm>
@@ -316,14 +316,14 @@ Use
<para>
The
<parameter>mask</parameter>
- parameter specifies the boolean controls to be enabled or disabled, and the
+parameter specifies the boolean controls to be enabled or disabled, and the
<parameter>values</parameter>
- mask specifies the new state for those controls. Valid values for both of
+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>,
using only those masks with <quote>ok</quote> in the
<structfield>enabled_ctrls</structfield>
- column.
+column.
</para>
@@ -331,9 +331,9 @@ using only those masks with <quote>ok</quote> in the
If the X server does not support a compatible version of Xkb or the Xkb
extension has not been properly initialized,
<function>XkbChangeEnabledControls</function>
- returns
+returns
<symbol>False</symbol>;
- otherwise, it sends the request to the X server and returns
+otherwise, it sends the request to the X server and returns
<symbol>True</symbol>.
</para>
@@ -341,22 +341,22 @@ extension has not been properly initialized,
<para>
Note that the
<emphasis>EnabledControls</emphasis>
- control only enables and disables controls; it does not configure them. Some
+control only enables and disables controls; it does not configure them. Some
controls, such as the
<emphasis>AudibleBell</emphasis>
- control, have no configuration attributes and are therefore manipulated solely
+control, have no configuration attributes and are therefore manipulated solely
by enabling and disabling them. Others, however, have additional attributes to
configure their behavior. For example, the
<emphasis>RepeatControl</emphasis>
- control uses
+control uses
<structfield>repeat_delay</structfield>
- and
+and
<structfield>repeat_interval</structfield>
- fields to describe the timing behavior of keys that repeat. The
+fields to describe the timing behavior of keys that repeat. The
<emphasis>RepeatControl</emphasis>
- behavior is turned on or off depending on the value of the
+behavior is turned on or off depending on the value of the
<symbol>XkbRepeatKeysMask</symbol>
- bit, but you must use other means, as described in this chapter, to configure
+bit, but you must use other means, as described in this chapter, to configure
its behavior in detail.
</para>
@@ -376,13 +376,13 @@ boolean controls specified in the
<primary>auto-reset mask</primary></indexterm>
<indexterm significance="preferred" zone="The_AutoReset_Control">
<primary>mask</primary><secondary>auto-reset</secondary></indexterm>
- are set to the corresponding value from the
+are set to the corresponding value from the
<firstterm>auto-reset values</firstterm>
- mask. This makes it possible for clients to "clean up after themselves"
+mask. This makes it possible for clients to "clean up after themselves"
automatically, even if abnormally terminated. The bits used in the masks
correspond to the
<emphasis>EnabledControls</emphasis>
- control bits.
+control bits.
</para>
@@ -390,12 +390,12 @@ correspond to the
For example, a client that replaces the keyboard bell with some other audible
cue might want to turn off the
<emphasis>AudibleBell</emphasis>
- control to prevent the server from also generating a sound and avoid
+control to prevent the server from also generating a sound and avoid
cacophony. If the client were to exit without resetting the
<emphasis>AudibleBell</emphasis>
control, the user would be left without any feedback at all. Setting
<emphasis>AudibleBell</emphasis>
- in both the auto-reset mask and auto-reset values guarantees that the audible
+in both the auto-reset mask and auto-reset values guarantees that the audible
bell will be turned back on when the client exits.
</para>
@@ -455,24 +455,24 @@ To get the current values of the auto-reset controls, use
<para>
<function>XkbGetAutoResetControls</function>
- backfills
+backfills
<parameter>auto_ctrls</parameter>
- and
+and
<parameter>auto_values</parameter>
- with the
+with the
<emphasis>AutoReset</emphasis>
- control attributes for this particular client. It returns
+control attributes for this particular client. It returns
<symbol>True</symbol>
- if successful, and
+if successful, and
<symbol>False</symbol>
- otherwise.
+otherwise.
</para>
<para>
To change the current values of the
<emphasis>AutoReset</emphasis>
- control attributes, use
+control attributes, use
<function>XkbSetAutoResetControls</function>.
</para>
@@ -551,7 +551,7 @@ corresponding bit in
<parameter>auto_values</parameter>
is on, the control is turned on when the client exits;
if zero, the control is turned off when the client exits.
- For any control selected by
+For any control selected by
<parameter>changes</parameter>,
if the corresponding bit is not set in
<parameter>auto_ctrls</parameter>,
@@ -598,14 +598,14 @@ are turned on when the client exits:
<para>
<function>XkbSetAutoResetControls</function>
- backfills
+backfills
<parameter>auto_ctrls</parameter>
- and
+and
<parameter>auto_values</parameter>
- with the auto-reset controls for this particular client. Note that all of the
+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
<parameter>changes</parameter>
- mask.
+mask.
</para>
@@ -617,7 +617,7 @@ bits are valid in the returned values, not just the ones selected in the
<para>
The X server’s generation of sounds is controlled by the
<emphasis>AudibleBell</emphasis>
- control. Configuration of different bell sounds is discussed in <xref linkend="Bells" />.
+control. Configuration of different bell sounds is discussed in <xref linkend="Bells" />.
</para>
@@ -627,12 +627,12 @@ The X server’s generation of sounds is controlled by the
<para>
The
<emphasis>AudibleBell</emphasis>
- control is a boolean control that has no attributes. As such, you may enable
+control is a boolean control that has no attributes. As such, you may enable
and disable it using either the
<emphasis>EnabledControls</emphasis>
- control or the
+control or the
<emphasis>AutoReset</emphasis>
- control discussed in <link linkend="The_EnabledControls_Control">section 10.1.1</link>. When enabled, protocol requests to
+control discussed in <link linkend="The_EnabledControls_Control">section 10.1.1</link>. When enabled, protocol requests to
generate a sound result in the X server actually producing a real sound; when
disabled, requests to the server to generate a sound are ignored unless the
sound is forced. See <link linkend="Audible_Bells">section 9.2</link>.
@@ -650,17 +650,17 @@ sound is forced. See <link linkend="Audible_Bells">section 9.2</link>.
<para>
The repeating behavior of keyboard keys is governed by three controls, the
<emphasis>PerKeyRepeat</emphasis>
- control, which is always active, and the
+control, which is always active, and the
<emphasis>RepeatKeys</emphasis>
- and
+and
<emphasis>DetectableAutorepeat</emphasis>
- controls, which are boolean controls that may be enabled and disabled.
+controls, which are boolean controls that may be enabled and disabled.
<emphasis>PerKeyRepeat</emphasis>
- determines which keys are allowed to repeat.
+determines which keys are allowed to repeat.
<emphasis>RepeatKeys</emphasis>
- governs the behavior of an individual key when it is repeating.
+governs the behavior of an individual key when it is repeating.
<emphasis>DetectableAutorepeat</emphasis>
- allows a client to detect when a key is repeating as a result of being held
+allows a client to detect when a key is repeating as a result of being held
down.
</para>
@@ -671,18 +671,18 @@ down.
<para>
The
<emphasis>PerKeyRepeat</emphasis>
- control is a bitmask long enough to contain a bit for each key on the device;
+control is a bitmask long enough to contain a bit for each key on the device;
it determines which individual keys are allowed to repeat. The Xkb
<emphasis>PerKeyRepeat</emphasis>
- control provides no functionality different from that available via the core X
+control provides no functionality different from that available via the core X
protocol. There are no convenience functions in Xkb for manipulating this
control. The
<emphasis>PerKeyRepeat</emphasis>
- control settings are carried in the
+control settings are carried in the
<structfield>per_key_repeat</structfield>
- field of an
+field of an
<structname>XkbControlsRec</structname>
- structure, discussed in <link linkend="The_XkbControlsRec_Structure">section 10.8</link>.
+structure, discussed in <link linkend="The_XkbControlsRec_Structure">section 10.8</link>.
</para>
@@ -694,12 +694,12 @@ control. The
The core protocol allows only control over whether or not the entire keyboard
or individual keys should auto-repeat when held down.
<emphasis>RepeatKeys</emphasis>
- is a boolean control that extends this capability by adding control over the
+is a boolean control that extends this capability by adding control over the
delay until a key begins to repeat and the rate at which it repeats.
<emphasis>RepeatKeys</emphasis>
- is coupled with the core auto-repeat control: when
+is coupled with the core auto-repeat control: when
<emphasis>RepeatKeys</emphasis>
- is enabled or disabled, the core auto-repeat is enabled or disabled and vice
+is enabled or disabled, the core auto-repeat is enabled or disabled and vice
versa.
</para>
@@ -719,7 +719,7 @@ operates does not automatically enable the control as a whole; see <link linkend
<para>
To get the current attributes of the
<emphasis>RepeatKeys</emphasis>
- control for a keyboard device, use
+control for a keyboard device, use
<function>XkbGetAutoRepeatRate</function>.
</para>
@@ -782,17 +782,17 @@ To get the current attributes of the
<para>
<function>XkbGetAutoRepeatRate</function>
- queries the server for the current values of the
+queries the server for the current values of the
<emphasis>RepeatControls</emphasis>
- control attributes, backfills
+control attributes, backfills
<parameter>timeout_rtrn</parameter>
- and
+and
<parameter>interval_rtrn</parameter>
- with them, and returns
+with them, and returns
<symbol>True</symbol>.
If a compatible version of the Xkb extension is not available in the server
<function>XkbGetAutoRepeatRate</function>
- returns
+returns
<symbol>False</symbol>.
</para>
@@ -862,29 +862,29 @@ To set the attributes of the RepeatKeys control for a keyboard device, use
<para>
<function>XkbSetAutoRepeatRate</function>
- sends a request to the X server to configure the
+sends a request to the X server to configure the
<emphasis>AutoRepeat</emphasis>
- control attributes to the values specified in
+control attributes to the values specified in
<parameter>timeout</parameter>
- and
+and
<parameter>interval</parameter>.
</para>
<para>
<function>XkbSetAutoRepeatRate</function>
- does not wait for a reply; it normally returns
+does not wait for a reply; it normally returns
<symbol>True</symbol>.
Specifying a zero value for either
<parameter>timeout</parameter>
- or
+or
<parameter>interval</parameter>
- causes the server to generate a
+causes the server to generate a
<errorname>BadValue</errorname>
- protocol error. If a compatible version of the Xkb extension is not available
+protocol error. If a compatible version of the Xkb extension is not available
in the server,
<function>XkbSetAutoRepeatRate</function>
- returns
+returns
<symbol>False</symbol>.
</para>
@@ -898,21 +898,21 @@ Auto-repeat is the generation of multiple key events by a keyboard when the
user presses a key and holds it down. Keyboard hardware and device-dependent X
server software often implement auto-repeat by generating multiple
<symbol>KeyPress</symbol>
- events with no intervening
+events with no intervening
<symbol>KeyRelease</symbol>
- event. The standard behavior of the X server is to generate a
+event. The standard behavior of the X server is to generate a
<symbol>KeyRelease</symbol>
- event for every
+event for every
<symbol>KeyPress</symbol>
- event. If the keyboard hardware and device-dependent software of the X server
+event. If the keyboard hardware and device-dependent software of the X server
implement auto-repeat by generating multiple
<symbol>KeyPress</symbol>
- events, the device-independent part of the X server by default synthetically
+events, the device-independent part of the X server by default synthetically
generates a
<symbol>KeyRelease</symbol>
- event after each
+event after each
<symbol>KeyPress</symbol>
- event. This provides predictable behavior for X clients, but does not allow
+event. This provides predictable behavior for X clients, but does not allow
those clients to detect the fact that a key is auto-repeating.
</para>
@@ -928,13 +928,13 @@ If a client requests and the server supports
<emphasis>DetectableAutorepeat</emphasis>,
Xkb generates
<symbol>KeyRelease</symbol>
- events only when the key is physically released. If
+events only when the key is physically released. If
<emphasis>DetectableAutorepeat</emphasis>
- is not supported or has not been requested, the server synthesizes a
+is not supported or has not been requested, the server synthesizes a
<symbol>KeyRelease</symbol>
- event for each repeating
+event for each repeating
<symbol>KeyPress</symbol>
- event it generates.
+event it generates.
</para>
@@ -942,25 +942,25 @@ Xkb generates
<emphasis>DetectableAutorepeat</emphasis>,
unlike the other controls in this chapter, is not contained in the
<structname>XkbControlsRec</structname>
- structure, nor can it be enabled or disabled via the
+structure, nor can it be enabled or disabled via the
<emphasis>EnabledControls</emphasis>
- control. Instead, query and set
+control. Instead, query and set
<emphasis>DetectableAutorepeat</emphasis>
- using
+using
<function>XkbGetDetectableAutorepeat</function>
- and
+and
<function>XkbSetDetectableAutorepeat</function>.
</para>
<para>
<emphasis>DetectableAutorepeat</emphasis>
- is a condition that applies to all keyboard devices for a client’s
+is a condition that applies to all keyboard devices for a client’s
connection to a given X server; it cannot be selectively set for some devices
and not for others. For this reason, none of the Xkb library functions
involving
<emphasis>DetectableAutorepeat</emphasis>
- involve a device specifier.
+involve a device specifier.
</para>
@@ -1010,29 +1010,29 @@ use
<para>
<function>XkbGetDetectableAutorepeat</function>
- queries the server for the current state of
+queries the server for the current state of
<emphasis>DetectableAutorepeat</emphasis>
- and waits for a reply. If
+and waits for a reply. If
<parameter>supported_rtrn</parameter>
- is not
+is not
<symbol>NULL</symbol>,
it backfills supported_rtrn with
<symbol>True</symbol>
- if the server supports
+if the server supports
<emphasis>DetectableAutorepeat</emphasis>,
and
<symbol>False</symbol>
- otherwise.
+otherwise.
<function>XkbGetDetectableAutorepeat</function>
- returns the current state of
+returns the current state of
<emphasis>DetectableAutorepeat</emphasis>
- for the requesting client:
+for the requesting client:
<symbol>True</symbol>
- if
+if
<emphasis>DetectableAutorepeat</emphasis>
- is set, and
+is set, and
<symbol>False</symbol>
- otherwise.
+otherwise.
</para>
@@ -1098,40 +1098,40 @@ they have requested otherwise.
<para>
<function>XkbSetDetectableAutorepeat</function>
- sends a request to the server to set
+sends a request to the server to set
<emphasis>DetectableAutorepeat</emphasis>
- on for the current client if
+on for the current client if
<parameter>detectable</parameter>
- is
+is
<symbol>True</symbol>,
and off it
<parameter>detectable</parameter>
- is
+is
<symbol>False</symbol>;
- it then waits for a reply. If
+it then waits for a reply. If
<parameter>supported_rtrn</parameter>
- is not
+is not
<symbol>NULL</symbol>,
<function>XkbSetDetectableAutorepeat</function>
- backfills
+backfills
<parameter>supported_rtrn</parameter>
- with
+with
<symbol>True</symbol>
- if the server supports
+if the server supports
<emphasis>DetectableAutorepeat</emphasis>,
and
<symbol>False</symbol>
- if it does not.
+if it does not.
<function>XkbSetDetectableAutorepeat</function>
- returns the current state of
+returns the current state of
<emphasis>DetectableAutorepeat</emphasis>
- for the requesting client:
+for the requesting client:
<symbol>True</symbol>
- if
+if
<emphasis>DetectableAutorepeat</emphasis>
- is set, and
+is set, and
<symbol>False</symbol>
- otherwise.
+otherwise.
</para>
@@ -1153,25 +1153,25 @@ keyboards.
<para>
Xkb includes direct support for two keyboard overlays, using the
<emphasis>Overlay1</emphasis>
- and
+and
<emphasis>Overlay2</emphasis>
- controls. When
+controls. When
<emphasis>Overlay1</emphasis>
- is enabled, all of the keys that are members of the first keyboard overlay
+is enabled, all of the keys that are members of the first keyboard overlay
generate an alternate keycode. When
<emphasis>Overlay2</emphasis>
- is enabled, all of the keys that are members of the second keyboard overlay
+is enabled, all of the keys that are members of the second keyboard overlay
generate an alternate keycode. The two overlays are mutually exclusive; any
particular key may be in at most one overlay.
<emphasis>Overlay1</emphasis>
- and
+and
<emphasis>Overlay2</emphasis>
- are boolean controls. As such, you may enable and disable them using either
+are boolean controls. As such, you may enable and disable them using either
the
<emphasis>EnabledControls</emphasis>
- control or the
+control or the
<emphasis>AutoReset</emphasis>
- control discussed in <link linkend="The_EnabledControls_Control">section 10.1.1</link>.
+control discussed in <link linkend="The_EnabledControls_Control">section 10.1.1</link>.
</para>
@@ -1179,9 +1179,9 @@ the
To specify the overlay to which a key belongs and the alternate keycode it
should generate when that overlay is enabled, assign it either the
<symbol>XkbKB_Overlay1</symbol>
- or
+or
<symbol>XkbKB_Overlay2</symbol>
- key behaviors, as described in <link linkend="Key_Behavior">section 16.2</link>.
+key behaviors, as described in <link linkend="Key_Behavior">section 16.2</link>.
</para>
@@ -1195,16 +1195,16 @@ X pointer device. This simulation includes both movement of the pointer itself
and press and release events associated with the buttons on the pointer. Two
controls affect this behavior: the
<emphasis>MouseKeys</emphasis>
- control determines whether or not simulation of the pointer device is active,
+control determines whether or not simulation of the pointer device is active,
as well as configuring the default button; the
<emphasis>MouseKeysAccel</emphasis>
- control determines the movement characteristics of the pointer when simulated
+control determines the movement characteristics of the pointer when simulated
via the keyboard. Both of them are boolean controls; as such, you may enable
and disable them using either the
<emphasis>EnabledControls</emphasis>
- control or the
+control or the
<emphasis>AutoReset</emphasis>
- control discussed in <link linkend="The_EnabledControls_Control">section 10.1.1</link>. The individual keys that simulate
+control discussed in <link linkend="The_EnabledControls_Control">section 10.1.1</link>. The individual keys that simulate
different aspects of the pointer device are determined by the keyboard mapping,
discussed in <xref linkend="Xkb_Server_Keyboard_Mapping" />.
</para>
@@ -1216,39 +1216,39 @@ discussed in <xref linkend="Xkb_Server_Keyboard_Mapping" />.
<para>
The
<emphasis>MouseKeys</emphasis>
- control allows a user to control all the mouse functions from the keyboard.
+control allows a user to control all the mouse functions from the keyboard.
When
<emphasis>MouseKeys</emphasis>
- are enabled, all keys with
+are enabled, all keys with
<emphasis>MouseKeys</emphasis>
- actions bound to them generate core pointer events instead of normal
+actions bound to them generate core pointer events instead of normal
<symbol>KeyPress</symbol>
- and
+and
<symbol>KeyRelease</symbol>
- events.
+events.
</para>
<para>
The
<emphasis>MouseKeys</emphasis>
- control has a single attribute,
+control has a single attribute,
<structfield>mk_dflt_btn</structfield>
- that specifies the core button number to be used by mouse keys actions that do
+that specifies the core button number to be used by mouse keys actions that do
not explicitly specify a button. There is no convenience function for getting
or setting the attribute; instead use
<function>XkbGetControls</function>
- and
+and
<function>XkbSetControls</function>
- (see <link linkend="Querying_Controls">section 10.9</link> and <link linkend="Changing_Controls">section 10.10</link>).
+(see <link linkend="Querying_Controls">section 10.9</link> and <link linkend="Changing_Controls">section 10.10</link>).
</para>
<note><para>
<emphasis>MouseKeys</emphasis>
- can also be turned on and off by pressing the key combination necessary to
+can also be turned on and off by pressing the key combination necessary to
produce an
<keysym>XK_Pointer_EnableKeys</keysym>
- keysym. The de facto default standard for this is
+keysym. The de facto default standard for this is
<keycombo><keycap>Shift</keycap><keycap>Alt</keycap><keycap>NumLock</keycap></keycombo>,
but this may vary depending on the keymap.</para></note>
@@ -1259,15 +1259,15 @@ but this may vary depending on the keymap.</para></note>
<para>
When the
<emphasis>MouseKeysAccel</emphasis>
- control is enabled, the effect of a key-activated pointer motion action
+control is enabled, the effect of a key-activated pointer motion action
changes as a key is held down. If the control is disabled, pressing a
mouse-pointer key yields one mouse event. When
<emphasis>MouseKeysAccel</emphasis>
- is enabled, mouse movement is defined by an initial distance specified in the
+is enabled, mouse movement is defined by an initial distance specified in the
<symbol>XkbSA_MovePtr</symbol>
- action and the following fields in the
+action and the following fields in the
<structname>XkbControlsRec</structname>
- structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>).
+structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>).
</para>
<table id='table10.2' frame='topbot'>
@@ -1312,20 +1312,20 @@ speed</entry>
<para>
There are no convenience functions to query or change the attributes of the
<emphasis>MouseKeysAccel</emphasis>
- control; instead use
+control; instead use
<function>XkbGetControls</function>
- and
+and
<function>XkbSetControls</function>
- (see <link linkend="Querying_Controls">section 10.9</link> and <link linkend="Changing_Controls">section 10.10</link>).
+(see <link linkend="Querying_Controls">section 10.9</link> and <link linkend="Changing_Controls">section 10.10</link>).
</para>
<para>
The effects of the attributes of the
<emphasis>MouseKeysAccel</emphasis>
- control depend on whether the
+control depend on whether the
<symbol>XkbSA_MovePtr</symbol>
- action (see <link linkend="Key_Actions">section 16.1</link>) specifies relative or absolute pointer motion.
+action (see <link linkend="Key_Actions">section 16.1</link>) specifies relative or absolute pointer motion.
</para>
<sect3 id='Absolute_Pointer_Motion'>
@@ -1334,11 +1334,11 @@ The effects of the attributes of the
<para>
If an
<symbol>XkbSA_MovePtr</symbol>
- action specifies an absolute position for one of the coordinates but still
+action specifies an absolute position for one of the coordinates but still
allows acceleration, all repeated events contain any absolute coordinates
specified in the action. For example, if the
<symbol>XkbSA_MovePtr</symbol>
- action specifies an absolute position for the X direction, but a relative
+action specifies an absolute position for the X direction, but a relative
motion for the Y direction, the pointer accelerates in the Y direction, but
stays at the same X position.
</para>
@@ -1351,22 +1351,22 @@ stays at the same X position.
<para>
If the
<symbol>XkbSA_MovePtr</symbol>
- action specifies relative motion, the initial event always moves the cursor
+action specifies relative motion, the initial event always moves the cursor
the distance specified in the action. After
<structfield>mk_delay</structfield>
- milliseconds, a second motion event is generated, and another occurs every
+milliseconds, a second motion event is generated, and another occurs every
<structfield>mk_interval</structfield>
- milliseconds until the user releases the key.
+milliseconds until the user releases the key.
</para>
<para>
Between the time of the second motion event and
<structfield>mk_time_to_max</structfield>
- intervals, the change in pointer distance per interval increases with each
+intervals, the change in pointer distance per interval increases with each
interval. After
<structfield>mk_time_to_max</structfield>
- intervals have elapsed, the change in pointer distance per interval remains
+intervals have elapsed, the change in pointer distance per interval remains
the same and is calculated by multiplying the original distance specified in
the action by
<structfield>mk_max_speed</structfield>.
@@ -1376,7 +1376,7 @@ the action by
<para>
For example, if the
<symbol>XkbSA_MovePtr</symbol>
- action specifies a relative motion in the X direction of 5,
+action specifies a relative motion in the X direction of 5,
<structfield>mk_delay</structfield>
=160,
<structfield>mk_interval</structfield>
@@ -1398,9 +1398,9 @@ pressed.
<para>
After 160 milliseconds
(<structfield>mk_delay</structfield>),
- and every 40 milliseconds thereafter
+and every 40 milliseconds thereafter
(<structfield>mk_interval</structfield>),
- the pointer moves in the X direction.
+the pointer moves in the X direction.
</para>
</listitem>
<listitem>
@@ -1408,7 +1408,7 @@ After 160 milliseconds
The distance in the X direction increases with each interval until 30 intervals
(
<structfield>mk_time_to_max</structfield>)
- have elapsed.
+have elapsed.
</para>
</listitem>
<listitem>
@@ -1416,7 +1416,7 @@ The distance in the X direction increases with each interval until 30 intervals
After 30 intervals, the pointer stops accelerating, and moves 150 pixels
(
<structfield>mk_max_speed</structfield>
- * the original distance) every interval thereafter, until the key is released.
+* the original distance) every interval thereafter, until the key is released.
</para>
</listitem>
</itemizedlist>
@@ -1424,58 +1424,58 @@ After 30 intervals, the pointer stops accelerating, and moves 150 pixels
<para>
The increase in pointer difference for each interval is a function of
<structfield>mk_curve</structfield>.
- Events after the first but before maximum acceleration has been achieved are
+Events after the first but before maximum acceleration has been achieved are
accelerated according to the formula:
</para>
<mediaobject>
- <imageobject> <imagedata format="SVG" fileref="XKBlib-3.svg"/>
- </imageobject>
- </mediaobject>
+<imageobject> <imagedata format="SVG" fileref="XKBlib-3.svg"/>
+</imageobject>
+</mediaobject>
<para>
Where
<emphasis>action_delta</emphasis>
- is the relative motion specified by the
+is the relative motion specified by the
<symbol>XkbSA_MovePtr</symbol>
- action,
+action,
<structfield>mk_max_speed</structfield>
and
<structfield>mk_time_to_max</structfield>
- are parameters to the
+are parameters to the
<emphasis>MouseKeysAccel</emphasis>
- control, and the curveFactor is computed using the
+control, and the curveFactor is computed using the
<emphasis>MouseKeysAccel</emphasis>
<structfield>mk_curve</structfield>
- parameter as follows:
+parameter as follows:
</para>
<mediaobject>
- <imageobject> <imagedata format="SVG" fileref="XKBlib-4.svg"/>
- </imageobject>
- </mediaobject>
+<imageobject> <imagedata format="SVG" fileref="XKBlib-4.svg"/>
+</imageobject>
+</mediaobject>
<para>
With the result that a
<structfield>mk_curve</structfield>
- of zero causes the distance moved to increase linearly from
+of zero causes the distance moved to increase linearly from
<emphasis>action_delta</emphasis>
- to <mediaobject>
- <imageobject> <imagedata format="SVG" fileref="XKBlib-5.svg"/>
- </imageobject>
- </mediaobject>.
+to <mediaobject>
+<imageobject> <imagedata format="SVG" fileref="XKBlib-5.svg"/>
+</imageobject>
+</mediaobject>.
A negative
<structfield>mk_curve</structfield>
- causes an initial sharp increase in acceleration that tapers off, and a
+causes an initial sharp increase in acceleration that tapers off, and a
positive curve yields a slower initial increase in acceleration followed by a
sharp increase as the number of pointer events generated by the action
approaches
<structfield>mk_time_to_max</structfield>.
The legal values for
<structfield>mk_curve</structfield>
- are between &minus;1000 and 1000.
+are between &minus;1000 and 1000.
</para>
@@ -1526,12 +1526,12 @@ Enabling or disabling the keyboard controls through a graphical user interface
may be impossible for people who need to use the controls. For example, a user
who needs
<emphasis>SlowKeys</emphasis>
- (see <link linkend="The_SlowKeys_Control">section 10.6.6</link>) may not even be able to start the graphical application,
+(see <link linkend="The_SlowKeys_Control">section 10.6.6</link>) may not even be able to start the graphical application,
let alone use it, if
<emphasis>SlowKeys</emphasis>
- is not enabled. To allow easier access to some of the controls, the
+is not enabled. To allow easier access to some of the controls, the
<emphasis>AccessXKeys</emphasis>
- control provides a set of special key sequences similar to those available in
+control provides a set of special key sequences similar to those available in
AccessDOS.
</para>
@@ -1539,7 +1539,7 @@ AccessDOS.
<para>
When the
<emphasis>AccessXKeys</emphasis>
- control is enabled, the user can turn controls on or off from the keyboard by
+control is enabled, the user can turn controls on or off from the keyboard by
entering the following standard key sequences:
</para>
@@ -1549,24 +1549,24 @@ entering the following standard key sequences:
Holding down a <keycap>Shift</keycap> key by itself for eight seconds
toggles the
<emphasis>SlowKeys</emphasis>
- control.
+control.
</para>
</listitem>
<listitem>
<para>
Pressing and releasing the left or right
<keycap>Shift</keycap>
- key five times in a row, without any intervening key events and with less than
+key five times in a row, without any intervening key events and with less than
30 seconds delay between consecutive presses, toggles the state of the
<emphasis>StickyKeys</emphasis>
- control.
+control.
</para>
</listitem>
<listitem>
<para>
Simultaneously operating two or more modifier keys deactivates the
<emphasis>StickyKeys</emphasis>
- control.
+control.
</para>
</listitem>
</itemizedlist>
@@ -1574,7 +1574,7 @@ Simultaneously operating two or more modifier keys deactivates the
<para>
When the
<emphasis>AccessXKeys</emphasis>
- control is disabled, Xkb does not look for the above special key sequences.
+control is disabled, Xkb does not look for the above special key sequences.
</para>
@@ -1582,7 +1582,7 @@ When the
Some of these key sequences optionally generate audible feedback of the change
in state, as described in <link linkend="The_AccessXFeedback_Control">section 10.6.3</link>, or
<symbol>XkbControlsNotify</symbol>
- events, described in <link linkend="Tracking_Changes_to_Keyboard_Controls">section 10.11</link>.
+events, described in <link linkend="Tracking_Changes_to_Keyboard_Controls">section 10.11</link>.
</para>
</sect2>
@@ -1592,38 +1592,38 @@ in state, as described in <link linkend="The_AccessXFeedback_Control">section 10
<para>
In environments where computers are shared, features such as
<emphasis>SlowKeys</emphasis>
- present a problem: if
+present a problem: if
<emphasis>SlowKeys</emphasis>
- is on, the keyboard can appear to be unresponsive because keys are not
+is on, the keyboard can appear to be unresponsive because keys are not
accepted until they are held for a certain period of time. To help solve this
problem, Xkb provides an
<emphasis>AccessXTimeout</emphasis>
- control to automatically change the enabled/disabled state of any boolean
+control to automatically change the enabled/disabled state of any boolean
controls and to change the value of the
<emphasis>AccessXKeys</emphasis>
- and
+and
<emphasis>AccessXFeedback</emphasis>
- control attributes if the keyboard is idle for a specified period of time.
+control attributes if the keyboard is idle for a specified period of time.
</para>
<para>
When a timeout as specified by
<emphasis>AccessXTimeout</emphasis>
- occurs and a control is consequently modified, Xkb generates an
+occurs and a control is consequently modified, Xkb generates an
<symbol>XkbControlsNotify</symbol>
- event. For more information on
+event. For more information on
<symbol>XkbControlsNotify</symbol>
- events, refer to <link linkend="Tracking_Changes_to_Keyboard_Controls">section 10.11</link>.
+events, refer to <link linkend="Tracking_Changes_to_Keyboard_Controls">section 10.11</link>.
</para>
<para>
Use
<function>XkbGetAccessXTimeout</function>
- to query the current
+to query the current
<emphasis>AccessXTimeout</emphasis>
- options for a keyboard device.
+options for a keyboard device.
</para>
<indexterm significance="preferred" zone="XkbGetAccessXTimeout"><primary><function>XkbGetAccessXTimeout</function></primary></indexterm>
@@ -1723,26 +1723,26 @@ Use
<para>
<function>XkbGetAccessXTimeout</function>
- sends a request to the X server to obtain the current values for the
+sends a request to the X server to obtain the current values for the
<emphasis>AccessXTimeout</emphasis>
- attributes, waits for a reply, and backfills the values into the appropriate
+attributes, waits for a reply, and backfills the values into the appropriate
arguments.
The parameters
<parameter>opts_mask_rtrn</parameter>
- and
+and
<parameter>opts_values_rtrn</parameter>
- are backfilled with the options to modify and the values for
+are backfilled with the options to modify and the values for
<structfield>ax_options</structfield>,
which is a field in the
<structname>XkbControlsRec</structname>
- structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>).
+structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>).
<function>XkbGetAccessXTimeout</function>
returns
<symbol>True</symbol>
- if successful; if a compatible version of the Xkb extension is not available
+if successful; if a compatible version of the Xkb extension is not available
in the server,
<function>XkbGetAccessXTimeout</function>
- returns
+returns
<symbol>False</symbol>.
</para>
@@ -1750,7 +1750,7 @@ in the server,
<para>
To configure the
<emphasis>AccessXTimeout</emphasis>
- options for a keyboard device, use
+options for a keyboard device, use
<function>XkbSetAccessXTimeout</function>.
</para>
@@ -1849,40 +1849,40 @@ opts_values</parameter>
<para>
<parameter>timeout</parameter>
- specifies the number of seconds the keyboard must be idle before the controls
+specifies the number of seconds the keyboard must be idle before the controls
are modified.
<parameter>ctrls_mask</parameter>
- specifies what controls are to be enabled or disabled, and
+specifies what controls are to be enabled or disabled, and
<parameter>ctrls_values</parameter>
- specifies whether those controls are to be enabled or disabled. The bit values
+specifies whether those controls are to be enabled or disabled. The bit values
correspond to those for enabling and disabling boolean controls
(see <link linkend="The_EnabledControls_Control">section 10.1.1</link>). The
<parameter>opts_mask</parameter>
- field specifies which attributes of the
+field specifies which attributes of the
<emphasis>AccessXKeys</emphasis>
- and
+and
<emphasis>AccessXFeedback</emphasis>
- controls are to be changed, and
+controls are to be changed, and
<parameter>opts_values</parameter>
- specifies the new values for those options. The bit values correspond to those
+specifies the new values for those options. The bit values correspond to those
for the
<structfield>ax_options</structfield>
- field of an
+field of an
<structname>XkbDescRec</structname>
- (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>).
+(see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>).
</para>
<para>
<function>XkbSetAccessXTimeout</function>
- sends a request to configure the
+sends a request to configure the
<emphasis>AccessXTimeout</emphasis>
- control to the server.
+control to the server.
It does not wait for a reply, and normally returns
<symbol>True</symbol>.
If a compatible version of the Xkb extension is not available in the server,
<function>XkbSetAccessXTimeout</function>
- returns
+returns
<symbol>False</symbol>.
</para>
@@ -1896,22 +1896,22 @@ Just as some keyboards can produce keyclicks to indicate when a key is pressed
or repeating, Xkb can provide feedback for the controls by using special beep
codes. Use the
<emphasis>AccessXFeedback</emphasis>
- control to configure the specific types of operations that generate feedback.
+control to configure the specific types of operations that generate feedback.
</para>
<para>
There is no convenience function for modifying the
<emphasis>AccessXFeedback</emphasis>
- control, although the feedback as a whole can be enabled or disabled just as
+control, although the feedback as a whole can be enabled or disabled just as
other boolean controls are (see <link linkend="Controls_that_Enable_and_Disable_Other_Controls">section 10.1</link>). Individual beep codes are turned
on or off by modifying the following bits in the
<structfield>ax_options</structfield>
- field of an
+field of an
<structname>XkbControlsRec</structname>
- structure and using
+structure and using
<function>XkbSetControls</function>
- (see <link linkend="Changing_Controls">section 10.10</link>):
+(see <link linkend="Changing_Controls">section 10.10</link>):
</para>
<table id='table10.3' frame='topbot'>
@@ -2015,16 +2015,16 @@ high-pitched beep followed by a low-pitched beep instead of a continuous
falling tone. Other implementations can only ring the bell with one fixed
pitch. In these cases, use the
<symbol>XkbAX_DumbBellFBMask</symbol>
- bit of
+bit of
<structfield>ax_options</structfield>
- to indicate that the bell can only ring with a fixed pitch.
+to indicate that the bell can only ring with a fixed pitch.
</para>
<para>
When any of the above feedbacks occur, Xkb may generate a
<symbol>XkbBellNotify</symbol>
- event (see <link linkend="Detecting_Bells">section 9.4</link>).
+event (see <link linkend="Detecting_Bells">section 9.4</link>).
</para>
@@ -2040,9 +2040,9 @@ When any of the above feedbacks occur, Xkb may generate a
<para>
The server can generate
<symbol>XkbAccessXNotify</symbol>
- events for some of the global keyboard controls. The structure for the
+events for some of the global keyboard controls. The structure for the
<symbol>XkbAccessXNotify</symbol>
- event type is as follows:
+event type is as follows:
<programlisting>
typedef struct {
@@ -2063,7 +2063,7 @@ typedef struct {
<para>
The
<structfield>detail</structfield>
- field describes what AccessX event just occurred and can be any of the values
+field describes what AccessX event just occurred and can be any of the values
in <link linkend="table10.4">Table 10.4</link>.
</para>
@@ -2117,20 +2117,20 @@ expired).</entry>
<para>
The
<structfield>keycode</structfield>
- field reports the keycode of the key for which the event occurred. If the
+field reports the keycode of the key for which the event occurred. If the
action is related to
<emphasis>SlowKeys</emphasis>,
the
<structfield>slowKeysDelay</structfield>
- field contains the current
+field contains the current
<emphasis>SlowKeys</emphasis>
- acceptance delay. If the action is related to
+acceptance delay. If the action is related to
<emphasis>BounceKeys</emphasis>,
the
<structfield>debounceDelay</structfield>
- field contains the current
+field contains the current
<emphasis>BounceKeys</emphasis>
- debounce delay.
+debounce delay.
</para>
<sect3 id='Selecting_for_AccessX_Events'>
@@ -2139,13 +2139,13 @@ the
<para>
To receive
<symbol>XkbAccessXNotify</symbol>
- events under all possible conditions, use
+events under all possible conditions, use
<function>XkbSelectEvents</function>
- (see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
+(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
<symbol>XkbAccessXNotifyMask</symbol>
- in both
+in both
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>.
</para>
@@ -2153,17 +2153,17 @@ To receive
<para>
To receive
<symbol>XkbStateNotify</symbol>
- events only under certain conditions, use
+events only under certain conditions, use
<function>XkbSelectEventDetails</function>
- using
+using
<symbol>XkbAccessXNotify</symbol>
- as the
+as the
<structfield>event_type</structfield>
- and specifying the desired state changes in
+and specifying the desired state changes in
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>
- using mask bits from <link linkend="table10.5">Table 10.5</link>.
+using mask bits from <link linkend="table10.5">Table 10.5</link>.
</para>
<table id='table10.5' frame='topbot'>
@@ -2236,20 +2236,20 @@ The
<emphasis>RepeatKeys</emphasis>,
and
<emphasis>MouseKeys</emphasis>
- controls do not generate specific events. Instead, the latching, unlatching,
+controls do not generate specific events. Instead, the latching, unlatching,
locking, or unlocking of modifiers using
<emphasis>StickyKeys</emphasis>
- generates
+generates
<symbol>XkbStateNotify</symbol>
- events as described in <link linkend="Tracking_Keyboard_State">section 5.4</link>. Repeating keys generate normal
+events as described in <link linkend="Tracking_Keyboard_State">section 5.4</link>. Repeating keys generate normal
<symbol>KeyPress</symbol>
- and
+and
<symbol>KeyRelease</symbol>
- events, though the auto-repeat can be detected using
+events, though the auto-repeat can be detected using
<emphasis>DetectableAutorepeat</emphasis>
- (see <link linkend="The_DetectableAutorepeat_Control">section 10.3.3</link>). Finally,
+(see <link linkend="The_DetectableAutorepeat_Control">section 10.3.3</link>). Finally,
<emphasis>MouseKeys</emphasis>
- generates pointer events identical to those of the core pointer device.
+generates pointer events identical to those of the core pointer device.
</para>
@@ -2262,7 +2262,7 @@ Some users may accidentally bump keys while moving a hand or typing stick
toward the key they want. Usually, the keys that are accidentally bumped are
just hit for a very short period of time. The
<emphasis>SlowKeys</emphasis>
- control helps filter these accidental bumps by telling the server to wait a
+control helps filter these accidental bumps by telling the server to wait a
specified period, called the
<firstterm>SlowKeys acceptance delay</firstterm>,
before delivering key events. If the key is released before this period
@@ -2271,23 +2271,23 @@ their way to the one they want without accidentally getting those characters.
Once they have reached the key they want, they can then hold the desired key
long enough for the computer to accept it.
<emphasis>SlowKeys</emphasis>
- is a boolean control with one configurable attribute.
+is a boolean control with one configurable attribute.
</para>
<para>
When the
<emphasis>SlowKeys</emphasis>
- control is active, the server reports the initial key press, subsequent
+control is active, the server reports the initial key press, subsequent
acceptance or rejection, and release of any key to interested clients by
sending an appropriate
<emphasis>AccessXNotify</emphasis>
- event (see <link linkend="AccessXNotify_Events">section 10.6.4</link>).
+event (see <link linkend="AccessXNotify_Events">section 10.6.4</link>).
</para>
<para>
To get the
<emphasis>SlowKeys</emphasis>
- acceptance delay for a keyboard device, use
+acceptance delay for a keyboard device, use
<function>XkbGetSlowKeysDelay</function>.
</para>
@@ -2343,18 +2343,18 @@ To get the
<function>XkbGetSlowKeysDelay</function>
requests the attributes of the
<emphasis>SlowKeys</emphasis>
- control from the server, waits for a reply and backfills
+control from the server, waits for a reply and backfills
<parameter>delay_rtrn</parameter>
with the
<emphasis>SlowKeys</emphasis>
- delay attribute.
+delay attribute.
<function>XkbGetSlowKeysDelay</function>
returns
<symbol>True</symbol>
- if successful; if a compatible version of the Xkb extension is not available
+if successful; if a compatible version of the Xkb extension is not available
in the server,
<function>XkbGetSlowKeysDelay</function>
- returns
+returns
<symbol>False</symbol>.
</para>
@@ -2362,7 +2362,7 @@ in the server,
<para>
To set the
<emphasis>SlowKeys</emphasis>
- acceptance delay for a keyboard device, use
+acceptance delay for a keyboard device, use
<function>XkbSetSlowKeysDelay</function>.
</para>
@@ -2417,23 +2417,23 @@ To set the
<para>
<function>XkbSetSlowKeysDelay</function>
- sends a request to configure the
+sends a request to configure the
<emphasis>SlowKeys</emphasis>
- control to the server.
+control to the server.
It does not wait for a reply, and normally returns
<symbol>True</symbol>.
Specifying a value of
<literal>0</literal>
- for the
+for the
<parameter>delay</parameter>
parameter causes
<function>XkbSetSlowKeysDelay</function>
- to generate a
+to generate a
<errorname>BadValue</errorname>
- protocol error. If a compatible version of the Xkb extension is not available
+protocol error. If a compatible version of the Xkb extension is not available
in the server
<function>XkbSetSlowKeysDelay</function>
- returns
+returns
<symbol>False</symbol>.
</para>
@@ -2446,31 +2446,31 @@ in the server
Some users may accidentally <quote>bounce</quote> on a key when they release it.
They press it once, then accidentally press it again after they release it. The
<emphasis>BounceKeys</emphasis>
- control temporarily disables a key after it has been pressed, effectively
+control temporarily disables a key after it has been pressed, effectively
<quote>debouncing</quote> the keyboard. The period of time the key is disabled
after it is released is known as the
<firstterm>BounceKeys delay</firstterm>.
<emphasis>BounceKeys</emphasis>
- is a boolean control.
+is a boolean control.
</para>
<para>
When the
<emphasis>BounceKeys</emphasis>
- control is active, the server reports acceptance or rejection of any key to
+control is active, the server reports acceptance or rejection of any key to
interested clients by sending an appropriate
<emphasis>AccessXNotify</emphasis>
- event (see <link linkend="AccessXNotify_Events">section 10.6.4</link>).
+event (see <link linkend="AccessXNotify_Events">section 10.6.4</link>).
</para>
<para>
Use
<function>XkbGetBounceKeysDelay</function>
- to query the current
+to query the current
<emphasis>BounceKeys</emphasis>
- delay for a keyboard device.
+delay for a keyboard device.
</para>
<indexterm significance="preferred" zone="XkbGetBounceKeysDelay"><primary><function>XkbGetBounceKeysDelay</function></primary></indexterm>
@@ -2525,18 +2525,18 @@ Use
<function>XkbGetBounceKeysDelay</function>
requests the attributes of the
<emphasis>BounceKeys</emphasis>
- control from the server, waits for a reply, and backfills
+control from the server, waits for a reply, and backfills
<parameter>delay_rtrn</parameter>
with the
<emphasis>BounceKeys</emphasis>
- delay attribute.
+delay attribute.
<function>XkbGetBounceKeysDelay</function>
returns
<symbol>True</symbol>
- if successful; if a compatible version of the Xkb extension is not available
+if successful; if a compatible version of the Xkb extension is not available
in the server
<function>XkbGetSlowKeysDelay</function>
- returns
+returns
<symbol>False</symbol>.
</para>
@@ -2544,7 +2544,7 @@ in the server
<para>
To set the
<emphasis>BounceKeys</emphasis>
- delay for a keyboard device, use
+delay for a keyboard device, use
<function>XkbSetBounceKeysDelay</function>.
</para>
@@ -2599,9 +2599,9 @@ To set the
<para>
<function>XkbSetBounceKeysDelay</function>
- sends a request to configure the
+sends a request to configure the
<emphasis>BounceKeys</emphasis>
- control to the server.
+control to the server.
It does not wait for a reply and normally returns
<symbol>True</symbol>.
Specifying a value of
@@ -2610,12 +2610,12 @@ for the
<parameter>delay</parameter>
parameter causes
<function>XkbSetBounceKeysDelay</function>
- to generate a
+to generate a
<errorname>BadValue</errorname>
- protocol error. If a compatible version of the Xkb extension is not available
+protocol error. If a compatible version of the Xkb extension is not available
in the server,
<function>XkbSetBounceKeysDelay</function>
- returns
+returns
<symbol>False</symbol>.
</para>
@@ -2627,29 +2627,29 @@ in the server,
Some people find it difficult or even impossible to press two keys at once. For
example, a one-fingered typist or someone using a mouth stick cannot press the
<keycap>Shift</keycap>
- and
+and
<keycap>1</keycap>
- keys at the same time. The
+keys at the same time. The
<emphasis>StickyKeys</emphasis>
- control solves this problem by changing the behavior of the modifier keys.
+control solves this problem by changing the behavior of the modifier keys.
With
<emphasis>StickyKeys</emphasis>,
the user can first press a modifier, release it, then press another key. For
example, to get an exclamation point on a PC-style keyboard, the user can press
the
<keycap>Shift</keycap>
- key, release it, and then press the
+key, release it, and then press the
<keycap>1</keycap>
- key.
+key.
</para>
<para>
<emphasis>StickyKeys</emphasis>
- also allows users to lock modifier keys without requiring special locking
+also allows users to lock modifier keys without requiring special locking
keys. When
<emphasis>StickyKeys</emphasis>
- is enabled, a modifier is latched when the user presses it just once. The user
+is enabled, a modifier is latched when the user presses it just once. The user
can press a modifier twice in a row to lock it, and then unlock it by pressing
it one more time.
</para>
@@ -2663,24 +2663,24 @@ nonmodifier key or a pointer button. For instance, to enter the sequence
<keycap>Control</keycap>
<keycap>Z</keycap>
</keycombo>
- the user could press and release the
+the user could press and release the
<keycap>Shift</keycap>
- key to latch it, then press and release the
+key to latch it, then press and release the
<keycap>Control</keycap>
- key to latch it, and finally press and release the
+key to latch it, and finally press and release the
<keycap>Z</keycap> key. Because the
<keycap>Control</keycap>
- key is a modifier key, pressing it does not unlatch the
+key is a modifier key, pressing it does not unlatch the
<keycap>Shift</keycap>
- key. Thus, after the user presses the
+key. Thus, after the user presses the
<keycap>Control</keycap>
- key, both the
+key, both the
<symbol>Shift</symbol>
- and
+and
<symbol>Control</symbol>
- modifiers are latched. When the user presses the
+modifiers are latched. When the user presses the
<keycap>Z</keycap>
- key, the effect is as though the user had pressed
+key, the effect is as though the user had pressed
<keycombo>
<keycap>Shift</keycap>
<keycap>Control</keycap>
@@ -2688,11 +2688,11 @@ nonmodifier key or a pointer button. For instance, to enter the sequence
</keycombo>.
In addition, because the
<keycap>Z</keycap>
- key is not a modifier key, the
+key is not a modifier key, the
<symbol>Shift</symbol>
- and
+and
<symbol>Control</symbol>
- modifiers are unlatched.
+modifiers are unlatched.
</para>
@@ -2703,9 +2703,9 @@ programmatically. For example, to enter the sequence ("XKB") on a keyboard
where ‘(’ is a shifted ‘9’, ‘)’ is a shifted ‘0’, and ‘"’
is a shifted single quote, the user could press and release the
<keycap>Shift</keycap>
- key twice to lock the
+key twice to lock the
<symbol>Shift</symbol>
- modifier. Then, when the user presses the
+modifier. Then, when the user presses the
<keycap>9</keycap>,
<keycap>'</keycap>,
<keycap>x</keycap>,
@@ -2714,17 +2714,17 @@ is a shifted single quote, the user could press and release the
<keycap>'</keycap>,
and
<keycap>0</keycap>
- keys in sequence, it generates ("XKB"). To unlock the
+keys in sequence, it generates ("XKB"). To unlock the
<symbol>Shift</symbol>
- modifier, the user can press and release the
+modifier, the user can press and release the
<keycap>Shift</keycap>
- key.
+key.
</para>
<para>
<emphasis>StickyKeys</emphasis>
- is a boolean control with two separate attributes that may be individually
+is a boolean control with two separate attributes that may be individually
configured: one to automatically disable it, and one to control the latching
behavior of modifier keys.
</para>
@@ -2735,34 +2735,34 @@ behavior of modifier keys.
<para>
The
<emphasis>StickyKeys</emphasis>
- control has two options that can be accessed via the
+control has two options that can be accessed via the
<structfield>ax_options</structfield>
- of an
+of an
<structname>XkbControlsRec</structname>
- structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>). The first option,
+structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>). The first option,
<emphasis>TwoKeys</emphasis>,
specifies whether
<emphasis>StickyKeys</emphasis>
- should automatically turn off when two keys are pressed at the same time. This
+should automatically turn off when two keys are pressed at the same time. This
feature is useful for shared computers so people who do not want them do not
need to turn
<emphasis>StickyKeys</emphasis>
- off if a previous user left
+off if a previous user left
<emphasis>StickyKeys</emphasis>
- on. The second option,
+on. The second option,
<emphasis>LatchToLock</emphasis>,
specifies whether or not
<emphasis>StickyKeys</emphasis>
- locks a modifier when pressed twice in a row.
+locks a modifier when pressed twice in a row.
</para>
<para>
Use
<function>XkbGetStickyKeysOptions</function>
- to query the current
+to query the current
<emphasis>StickyKeys</emphasis>
- attributes for a keyboard device.
+attributes for a keyboard device.
</para>
<indexterm significance="preferred" zone="XkbGetStickyKeysOptions"><primary><function>XkbGetStickyKeysOptions</function></primary></indexterm>
@@ -2817,13 +2817,13 @@ Use
<function>XkbGetStickyKeysOptions</function>
requests the attributes of the
<emphasis>StickyKeys</emphasis>
- control from the server, waits for a reply, and backfills
+control from the server, waits for a reply, and backfills
<parameter>options_rtrn</parameter>
with a mask indicating whether the individual
<emphasis>StickyKeys</emphasis>
- options are on or off. Valid bits in
+options are on or off. Valid bits in
<parameter>options_rtrn</parameter>
- are:
+are:
<simplelist type='vert' columns='1'>
<member><symbol>XkbAX_TwoKeysMask</symbol></member>
@@ -2835,10 +2835,10 @@ with a mask indicating whether the individual
<function>XkbGetStickyKeysOptions</function>
returns
<symbol>True</symbol>
- if successful; if a compatible version of the Xkb extension is not available
+if successful; if a compatible version of the Xkb extension is not available
in the server
<function>XkbGetStickyKeysOptions</function>
- returns
+returns
<symbol>False</symbol>.
</para>
@@ -2846,7 +2846,7 @@ in the server
<para>
To set the
<emphasis>StickyKeys</emphasis>
- attributes for a keyboard device, use
+attributes for a keyboard device, use
<function>XkbSetStickyKeysOptions</function>.
</para>
@@ -2911,16 +2911,16 @@ To set the
<para>
<function>XkbSetStickyKeysOptions</function>
- sends a request to configure the
+sends a request to configure the
<emphasis>StickyKeys</emphasis>
- control to the server.
+control to the server.
It does not wait for a reply and normally returns
<symbol>True</symbol>.
The valid bits to use for both the
<parameter>mask</parameter>
- and
+and
<parameter>values</parameter>
- parameters are:
+parameters are:
<simplelist type='vert' columns='1'>
<member><symbol>XkbAX_TwoKeysMask</symbol></member>
@@ -2929,9 +2929,9 @@ The valid bits to use for both the
</para>
<para>
- If a compatible version of the Xkb extension is not available in the server,
+If a compatible version of the Xkb extension is not available in the server,
<function>XkbSetStickyKeysOptions</function>
- returns
+returns
<symbol>False</symbol>.
</para>
@@ -2956,7 +2956,7 @@ and consumed in the server. These are:
<para>
<emphasis>IgnoreGroupLock</emphasis>
- is a boolean control; the rest are always active.
+is a boolean control; the rest are always active.
</para>
@@ -2964,14 +2964,14 @@ and consumed in the server. These are:
Without the modifier processing options provided by Xkb, passive grabs set via
translations in a client (for example,
<emphasis>Alt&lt;KeyPress&gt;space</emphasis>)
- do not trigger if any modifiers other than those specified by the translation
+do not trigger if any modifiers other than those specified by the translation
are set. This results in problems in the user interface when either
<emphasis>NumLock</emphasis>
- or a secondary keyboard group is active. The
+or a secondary keyboard group is active. The
<emphasis>IgnoreLockMods</emphasis>
- and
+and
<emphasis>IgnoreGroupLock</emphasis>
- controls make it possible to avoid this behavior without exhaustively
+controls make it possible to avoid this behavior without exhaustively
specifying a grab for every possible modifier combination.
</para>
@@ -2981,12 +2981,12 @@ specifying a grab for every possible modifier combination.
<para>
The
<emphasis>GroupsWrap</emphasis>
- control determines how illegal groups are handled on a global basis. There are
+control determines how illegal groups are handled on a global basis. There are
a number of valid keyboard sequences that can cause the effective group number
to go out of range. When this happens, the group must be normalized back to a
valid number. The
<emphasis>GroupsWrap</emphasis>
- control specifies how this is done.
+control specifies how this is done.
</para>
@@ -2995,7 +2995,7 @@ When dealing with group numbers, all computations are done using the group
index, which is the group number minus one. There are three different
algorithms; the
<emphasis>GroupsWrap</emphasis>
- control specifies which one is used:
+control specifies which one is used:
</para>
<itemizedlist>
@@ -3005,7 +3005,7 @@ algorithms; the
All invalid group numbers are converted to a valid group number by taking the
last four bits of the
<emphasis>GroupsWrap</emphasis>
- control and using them as the group index. If the result is still out of
+control and using them as the group index. If the result is still out of
range, Group one is used.
</para>
</listitem>
@@ -3031,17 +3031,17 @@ modulus applied to the group index.
<para>
There are no convenience functions for manipulating the
<emphasis>GroupsWrap</emphasis>
- control. Manipulate the
+control. Manipulate the
<emphasis>GroupsWrap</emphasis>
- control via the
+control via the
<structfield>groups_wrap</structfield>
- field in the
+field in the
<structname>XkbControlsRec</structname>
- structure, then use
+structure, then use
<function>XkbSetControls</function>
- and
+and
<function>XkbGetControls</function>
- (see <link linkend="Querying_Controls">section 10.9</link> and <link linkend="Changing_Controls">section 10.10</link>) to query and change this control.
+(see <link linkend="Querying_Controls">section 10.9</link> and <link linkend="Changing_Controls">section 10.10</link>) to query and change this control.
</para>
<note><para>See also <link linkend="Per_Key_Group_Information">section 15.3.2</link> or a discussion of the related field,
@@ -3062,12 +3062,12 @@ unanticipated side effects.
<para>
The
<emphasis>IgnoreLockMods</emphasis>
- control specifies modifiers that should be excluded from grab calculations.
+control specifies modifiers that should be excluded from grab calculations.
These modifiers are also not reported in any core events except
<symbol>KeyPress</symbol>
- and
+and
<symbol>KeyRelease</symbol>
- events that do not activate a passive grab and that do not occur while a grab
+events that do not activate a passive grab and that do not occur while a grab
is active.
</para>
@@ -3075,15 +3075,15 @@ is active.
<para>
Manipulate the
<emphasis>IgnoreLockMods</emphasis>
- control via the
+control via the
<structfield>ignore_lock</structfield>
- field in the
+field in the
<structname>XkbControlsRec</structname>
- structure, then use
+structure, then use
<function>XkbSetControls</function>
- and
+and
<function>XkbGetControls</function>
- (see <link linkend="Querying_Controls">section 10.9</link> and <link linkend="Changing_Controls">section 10.10</link>) to query and change this control. Alternatively,
+(see <link linkend="Querying_Controls">section 10.9</link> and <link linkend="Changing_Controls">section 10.10</link>) to query and change this control. Alternatively,
use
<function>XkbSetIgnoreLockMods</function>.
</para>
@@ -3177,32 +3177,32 @@ virtual_values</parameter>
<para>
<function>XkbSetIgnoreLockMods</function>
- sends a request to the server to change the server’s
+sends a request to the server to change the server’s
<emphasis>IgnoreLockMods</emphasis>
- control.
+control.
<parameter>affect_real</parameter>
- and
+and
<parameter>real_values</parameter>
- are masks of real modifier bits indicating which real modifiers are to be
+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
+control. Modifiers selected by both
<parameter>affect_real</parameter>
- and
+and
<parameter>real_values</parameter>
- are added to the server’s
+are added to the server’s
<emphasis>IgnoreLockMods</emphasis>
- control; those selected by
+control; those selected by
<parameter>affect_real</parameter>
- but not by
+but not by
<parameter>real_values</parameter>
- are removed from the server’s
+are removed from the server’s
<emphasis>IgnoreLockMods</emphasis>
- control. Valid values for
+control. Valid values for
<parameter>affect_real</parameter>
- and
+and
<parameter>real_values</parameter>
- consist of any combination of the eight core modifier bits:
+consist of any combination of the eight core modifier bits:
<symbol>ShiftMask</symbol>,
<symbol>LockMask</symbol>,
<symbol>ControlMask</symbol>,
@@ -3210,34 +3210,34 @@ added and removed from the server’s
&ndash;
<symbol>Mod5Mask</symbol>.
<parameter>affect_virtual</parameter>
- and
+and
<parameter>virtual_values</parameter>
- are masks of virtual modifier bits indicating which virtual modifiers are to
+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
+control. Modifiers selected by both
<parameter>affect_virtual</parameter>
- and
+and
<parameter>virtual_values</parameter>
- are added to the server’s
+are added to the server’s
<emphasis>IgnoreLockMods</emphasis>
- control; those selected by
+control; those selected by
<parameter>affect_virtual</parameter>
- but not by
+but not by
<parameter>virtual_values</parameter>
- are removed from the server’s
+are removed from the server’s
<emphasis>IgnoreLockMods</emphasis>
- control.
+control.
See <link linkend="Virtual_Modifier_Names_and_Masks">section 7.1</link> for a discussion of virtual modifier masks to use in
<parameter>affect_virtual</parameter>
- and
+and
<parameter>virtual_values</parameter>.
<function>XkbSetIgnoreLockMods</function>
- does not wait for a reply from the server. It returns
+does not wait for a reply from the server. It returns
<symbol>True</symbol>
- if the request was sent, and
+if the request was sent, and
<symbol>False</symbol>
- otherwise.
+otherwise.
</para>
</sect2>
@@ -3247,7 +3247,7 @@ See <link linkend="Virtual_Modifier_Names_and_Masks">section 7.1</link> for a di
<para>
The
<emphasis>IgnoreGroupLock</emphasis>
- control is a boolean control with no attributes. If enabled, it specifies that
+control is a boolean control with no attributes. If enabled, it specifies that
the locked state of the keyboard group should not be considered when activating
passive grabs.
</para>
@@ -3255,7 +3255,7 @@ passive grabs.
<para>
Because
<emphasis>IgnoreGroupLock</emphasis>
- is a boolean control with no attributes, use the general boolean controls
+is a boolean control with no attributes, use the general boolean controls
functions (see <link linkend="Controls_that_Enable_and_Disable_Other_Controls">section 10.1</link>) to change its state.
</para>
@@ -3268,16 +3268,16 @@ functions (see <link linkend="Controls_that_Enable_and_Disable_Other_Controls">s
The core protocol does not provide any means to prevent a modifier from being
reported in events sent to clients; Xkb, however makes this possible via the
<emphasis>InternalMods</emphasis>
- control. It specifies modifiers that should be consumed by the server and not
+control. It specifies modifiers that should be consumed by the server and not
reported to clients. When a key is pressed and a modifier that has its bit set
in the
<emphasis>InternalMods</emphasis>
- control is reported to the server, the server uses the modifier when
+control is reported to the server, the server uses the modifier when
determining the actions to apply for the key. The server then clears the bit,
so it is not actually reported to the client. In addition, modifiers specified
in the
<emphasis>InternalMods</emphasis>
- control are not used to determine grabs and are not used to calculate core
+control are not used to determine grabs and are not used to calculate core
protocol compatibility state.
</para>
@@ -3285,16 +3285,16 @@ protocol compatibility state.
<para>
Manipulate the
<emphasis>InternalMods</emphasis>
- control via the
+control via the
<structfield>internal</structfield>
- field in the
+field in the
<structname>XkbControlsRec</structname>
- structure, using
+structure, using
<function>XkbSetControls</function>
- and
+and
<function>XkbGetControls</function>
- (see <link linkend="Querying_Controls">section 10.9</link>
- and <link linkend="Changing_Controls">section 10.10</link>). Alternatively, use
+(see <link linkend="Querying_Controls">section 10.9</link>
+and <link linkend="Changing_Controls">section 10.10</link>). Alternatively, use
<function>XkbSetServerInternalMods</function>.
</para>
@@ -3387,26 +3387,26 @@ virtual_values</parameter>
<para>
<function>XkbSetServerInternalMods</function>
- sends a request to the server to change the internal modifiers consumed by the
+sends a request to the server to change the internal modifiers consumed by the
server.
<parameter>affect_real</parameter>
- and
+and
<parameter>real_values</parameter>
- are masks of real modifier bits indicating which real modifiers are to be
+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
<parameter>affect_real</parameter>
- and
+and
<parameter>real_values</parameter>
- are added to the server’s internal modifiers control; those selected by
+are added to the server’s internal modifiers control; those selected by
<parameter>affect_real</parameter>
- but not by
+but not by
<parameter>real_values</parameter>
- are removed from the server’s internal modifiers mask. Valid values for
+are removed from the server’s internal modifiers mask. Valid values for
<parameter>affect_real</parameter>
- and
+and
<parameter>real_values</parameter>
- consist of any combination of the eight core modifier bits:
+consist of any combination of the eight core modifier bits:
<symbol>ShiftMask</symbol>,
<symbol>LockMask</symbol>,
<symbol>ControlMask</symbol>,
@@ -3414,29 +3414,29 @@ selected by both
&ndash;
<symbol>Mod5Mask</symbol>.
<parameter>affect_virtual</parameter>
- and
+and
<parameter>virtual_values</parameter>
- are masks of virtual modifier bits indicating which virtual modifiers are to
+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
<parameter>affect_virtual</parameter>
- and
+and
<parameter>virtual_values</parameter>
- are added to the server’s internal modifiers control; those selected by
+are added to the server’s internal modifiers control; those selected by
<parameter>affect_virtual</parameter>
- but not by
+but not by
<parameter>virtual_values</parameter>
- are removed from the server’s internal modifiers control.
+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
<parameter>affect_virtual</parameter>
- and
+and
<parameter>virtual_values</parameter>.
<function>XkbSetServerInternalMods</function>
- does not wait for a reply from the server. It returns
+does not wait for a reply from the server. It returns
<symbol>True</symbol>
- if the request was sent and
+if the request was sent and
<symbol>False</symbol>
- otherwise.
+otherwise.
</para>
@@ -3453,12 +3453,12 @@ Many of the individual controls described in sections 10.1 through 10.7 may be
manipulated via convenience functions discussed in those sections. Some of
them, however, have no convenience functions. The
<structname>XkbControlsRec</structname>
- structure allows the manipulation of one or more of the controls in a single
+structure allows the manipulation of one or more of the controls in a single
operation and to track changes to any of them in conjunction with the
<function>XkbGetControls</function>
- and
+and
<function>XkbSetControls</function>
- functions. This is the only way to manipulate those controls that have no
+functions. This is the only way to manipulate those controls that have no
convenience functions.
</para>
@@ -3466,7 +3466,7 @@ convenience functions.
<para>
The
<structname>XkbControlsRec</structname>
- structure is defined as follows:
+structure is defined as follows:
<programlisting>
#define XkbMaxLegalKeyCode 255
@@ -3513,14 +3513,14 @@ typedef struct {
<para>
The general-purpose functions that work with the
<structname>XkbControlsRec</structname>
- structure use a mask to specify which controls are to be manipulated.
+structure use a mask to specify which controls are to be manipulated.
<link linkend="table10.6">Table 10.6</link>
lists these controls, the masks used to select them in the general
function calls
(<structfield>which</structfield>
- parameter), and the data fields in the
+parameter), and the data fields in the
<structname>XkbControlsRec</structname>
- structure that comprise each of the individual controls. Also listed are the
+structure that comprise each of the individual controls. Also listed are the
bit used to turn boolean controls on and off and the section where each control
is described in more detail.
</para>
@@ -3714,9 +3714,9 @@ controls for modification and to enable and disable the control. Note that the
same mask bit is used to specify general modifications to the parameters used
to configure the control
(<structfield>which</structfield>),
- and to enable and disable the control
+and to enable and disable the control
(<structfield>enabled_ctrls</structfield>).
- The anomalies in the table (no <quote>ok</quote> in column) are for controls that have no
+The anomalies in the table (no <quote>ok</quote> in column) are for controls that have no
configurable attributes; and for controls that are not boolean controls and
therefore cannot be enabled or disabled.
</para>
@@ -3871,7 +3871,7 @@ therefore cannot be enabled or disabled.
<para>
The individual fields of the
<structname>XkbControlsRec</structname>
- structure are defined as follows.
+structure are defined as follows.
</para>
<sect2>
@@ -3883,8 +3883,8 @@ The individual fields of the
<structfield>mk_dflt_btn</structfield> is an attribute of the
<emphasis>MouseKeys</emphasis>
control
- (see <link linkend="Controls_for_Using_the_Mouse_from_the_Keyboard">section 10.5</link>). It
- specifies the mouse button number to use for keyboard simulated mouse button
+(see <link linkend="Controls_for_Using_the_Mouse_from_the_Keyboard">section 10.5</link>). It
+specifies the mouse button number to use for keyboard simulated mouse button
operations. Its value should be one of the core symbols
<symbol>Button1</symbol>
&ndash;
@@ -3898,9 +3898,9 @@ operations. Its value should be one of the core symbols
<para>
<structfield>num_groups</structfield>
- is not a part of any control, but is reported in the
+is not a part of any control, but is reported in the
<structname>XkbControlsRec</structname>
- structure whenever any of its components are fetched from the server. It
+structure whenever any of its components are fetched from the server. It
reports the number of groups the particular keyboard configuration uses and is
computed automatically by the server whenever the keyboard mapping changes.
</para>
@@ -3912,12 +3912,12 @@ computed automatically by the server whenever the keyboard mapping changes.
<para>
<structfield>groups_wrap</structfield>
- is an attribute of the
+is an attribute of the
<emphasis>GroupsWrap</emphasis>
- control (see <link linkend="The_GroupsWrap_Control">section 10.7.1</link>). It specifies the handling of illegal groups on a
+control (see <link linkend="The_GroupsWrap_Control">section 10.7.1</link>). It specifies the handling of illegal groups on a
global basis. Valid values for
<structfield>groups_wrap</structfield>
- are shown in <link linkend="table10.8">Table 10.8</link>.
+are shown in <link linkend="table10.8">Table 10.8</link>.
</para>
<table id='table10.8' frame='topbot'>
@@ -3952,7 +3952,7 @@ global basis. Valid values for
<para>
When
<structfield>groups_wrap</structfield>
- is set to
+is set to
<symbol>XkbRedirectIntoRange</symbol>,
its four low-order bits specify the index of the group to use.
</para>
@@ -3964,9 +3964,9 @@ its four low-order bits specify the index of the group to use.
<para>
<structfield>internal</structfield>
- is an attribute of the
+is an attribute of the
<emphasis>InternalMods</emphasis>
- control (see <link linkend="The_InternalMods_Control">section 10.7.4</link>). It specifies modifiers to be consumed in the
+control (see <link linkend="The_InternalMods_Control">section 10.7.4</link>). It specifies modifiers to be consumed in the
server and not passed on to clients when events are reported. Valid values
consist of any combination of the eight core modifier bits:
<symbol>ShiftMask</symbol>,
@@ -3984,9 +3984,9 @@ consist of any combination of the eight core modifier bits:
<para>
<structfield>ignore_lock</structfield>
- is an attribute of the
+is an attribute of the
<emphasis>IgnoreLockMods</emphasis>
- control (see <link linkend="The_IgnoreLockMods_Control">section 10.7.2</link>). It specifies modifiers to be ignored in grab
+control (see <link linkend="The_IgnoreLockMods_Control">section 10.7.2</link>). It specifies modifiers to be ignored in grab
calculations. Valid values consist of any combination of the eight core
modifier bits:
<symbol>ShiftMask</symbol>,
@@ -4004,15 +4004,15 @@ modifier bits:
<para>
<structfield>enabled_ctrls</structfield>
- is an attribute of the
+is an attribute of the
<emphasis>EnabledControls</emphasis>
- control (see <link linkend="The_EnabledControls_Control">section 10.1.1</link>). It contains one bit per boolean control. Each
+control (see <link linkend="The_EnabledControls_Control">section 10.1.1</link>). It contains one bit per boolean control. Each
bit determines whether the corresponding control is enabled or disabled; a one
bit means the control is enabled. The mask bits used to enable these controls
are listed in <link linkend="table10.7">Table 10.7</link>,
using only those masks with <quote>ok</quote> in the
<structfield>enabled_ctrls</structfield>
- column.
+column.
</para>
@@ -4022,15 +4022,15 @@ using only those masks with <quote>ok</quote> in the
<para>
<structfield>repeat_delay</structfield>
- and
+and
<structfield>repeat_interval</structfield>
- are attributes of the
+are attributes of the
<emphasis>RepeatKeys</emphasis>
- control (see <link linkend="The_RepeatKeys_Control">section 10.3.2</link>).
+control (see <link linkend="The_RepeatKeys_Control">section 10.3.2</link>).
<structfield>repeat_delay</structfield>
- is the initial delay before a key begins repeating, in milliseconds;
+is the initial delay before a key begins repeating, in milliseconds;
<structfield>repeat_interval</structfield>
- is the delay between subsequent key events, in milliseconds.
+is the delay between subsequent key events, in milliseconds.
</para>
@@ -4040,11 +4040,11 @@ using only those masks with <quote>ok</quote> in the
<para>
<structfield>slow_keys_delay</structfield>
- is an attribute of the
+is an attribute of the
<emphasis>SlowKeys</emphasis>
- control (see <link linkend="The_SlowKeys_Control">section 10.6.6</link>). Its value specifies the
+control (see <link linkend="The_SlowKeys_Control">section 10.6.6</link>). Its value specifies the
<emphasis>SlowKeys</emphasis>
- acceptance delay period in milliseconds before a key press is accepted by the
+acceptance delay period in milliseconds before a key press is accepted by the
server.
</para>
@@ -4055,11 +4055,11 @@ server.
<para>
<structfield>debounce_delay</structfield>
- is an attribute of the
+is an attribute of the
<emphasis>BounceKeys</emphasis>
- control (see <link linkend="The_BounceKeys_Control">section 10.6.7</link>). Its value specifies the
+control (see <link linkend="The_BounceKeys_Control">section 10.6.7</link>). Its value specifies the
<emphasis>BounceKeys</emphasis>
- delay period in milliseconds for which the key is disabled after having been
+delay period in milliseconds for which the key is disabled after having been
pressed before another press of the same key is accepted by the server.
</para>
@@ -4075,9 +4075,9 @@ pressed before another press of the same key is accepted by the server.
<structfield>mk_max_speed</structfield>,
and
<structfield>mk_curve</structfield>
- are attributes of the
+are attributes of the
<emphasis>MouseKeysAccel</emphasis>
- control. Refer to <link linkend="The_MouseKeysAccel_Control">section 10.5.2</link> for a description of these fields and the
+control. Refer to <link linkend="The_MouseKeysAccel_Control">section 10.5.2</link> for a description of these fields and the
units involved.
</para>
@@ -4089,13 +4089,13 @@ units involved.
<para>
The
<structfield>ax_options</structfield>
- field contains attributes used to configure two different controls, the
+field contains attributes used to configure two different controls, the
<emphasis>StickyKeys</emphasis>
- control (see <link linkend="The_StickyKeys_Control">section 10.6.8</link>) and the
+control (see <link linkend="The_StickyKeys_Control">section 10.6.8</link>) and the
<emphasis>AccessXFeedback</emphasis>
- control (see <link linkend="The_AccessXFeedback_Control">section 10.6.3</link>). The
+control (see <link linkend="The_AccessXFeedback_Control">section 10.6.3</link>). The
<structfield>ax_options</structfield>
- field is a bitmask and may include any combination of the bits defined in
+field is a bitmask and may include any combination of the bits defined in
<link linkend="table10.9">Table 10.9</link>.
</para>
@@ -4187,20 +4187,20 @@ The
The fields pertaining to each control are relevant only when the control is
enabled
(<symbol>XkbAccessXFeedbackMask</symbol>
- or
+or
<symbol>XkbStickyKeysMask</symbol>
- bit is turned on in the
+bit is turned on in the
<structfield>enabled_ctrls</structfield>
- field).
+field).
</para>
<para>
Xkb provides a set of convenience macros for working with the
<structfield>ax_options</structfield>
- field of an
+field of an
<structname>XkbControlsRec</structname>
- structure:
+structure:
<programlisting>
#define <symbol>XkbAX_NeedOption</symbol>(c,w) ((c)-&gt;ax_options &amp; (w))
@@ -4209,14 +4209,14 @@ Xkb provides a set of convenience macros for working with the
<para>
The
<symbol>XkbAX_NeedOption</symbol>
- macro is useful for determining whether a particular AccessX option is enabled
+macro is useful for determining whether a particular AccessX option is enabled
or not. It accepts a pointer to an
<structname>XkbControlsRec</structname>
- structure and a valid mask bit from
+structure and a valid mask bit from
<link linkend="table10.9">Table 10.9</link>.
- If the specified mask bit in the
+If the specified mask bit in the
<structfield>ax_options</structfield>
- field of the controls structure is set, the macro returns the mask bit.
+field of the controls structure is set, the macro returns the mask bit.
Otherwise, it returns zero. Thus,
<programlisting>
@@ -4226,12 +4226,12 @@ Otherwise, it returns zero. Thus,
is nonzero if the latch to lock transition for latching keys is enabled, and
zero if it is disabled. Note that
<symbol>XkbAX_NeedOption</symbol>
- only determines whether or not the particular capability is configured to
+only determines whether or not the particular capability is configured to
operate; the
<symbol>XkbAccessXFeedbackMask</symbol>
- bit must also be turned on in
+bit must also be turned on in
<structfield>enabled_ctrls</structfield>
- for the capability to actually be functioning.
+for the capability to actually be functioning.
</para>
<para><programlisting>
@@ -4242,13 +4242,13 @@ operate; the
<para>
The
<symbol>XkbAX_AnyFeedback</symbol>
- macro accepts a pointer to an
+macro accepts a pointer to an
<structname>XkbControlsRec</structname>
- structure and tells whether the
+structure and tells whether the
<emphasis>AccessXFeedback</emphasis>
- control is enabled or not. If the
+control is enabled or not. If the
<emphasis>AccessXFeedback</emphasis>
- control is enabled, the macro returns
+control is enabled, the macro returns
<symbol>XkbAccessXFeedbackMask</symbol>.
Otherwise, it returns zero.
</para>
@@ -4261,14 +4261,14 @@ Otherwise, it returns zero.
<para>
The
<symbol>XkbAX_NeedFeedback</symbol>
- macro is useful for determining if both the
+macro is useful for determining if both the
<emphasis>AccessXFeedback</emphasis>
- control and a particular AccessX feedback option are enabled. The macro
+control and a particular AccessX feedback option are enabled. The macro
accepts a pointer to an
<structname>XkbControlsRec</structname>
- structure and a feedback option from the table above. If both the
+structure and a feedback option from the table above. If both the
<emphasis>AccessXFeedback</emphasis>
- control and the specified feedback option are enabled, the macro returns
+control and the specified feedback option are enabled, the macro returns
<symbol>True</symbol>.
Otherwise it returns
<symbol>False</symbol>.
@@ -4287,9 +4287,9 @@ id='ax_timeout_axt_opts_mask_axt_opts_values_axt_ctrls_mask_and_axt_ctrls_values
<structfield>axt_ctrls_mask</structfield>,
and
<structfield>axt_ctrls_values</structfield>
- are attributes of the
+are attributes of the
<emphasis>AccessXTimeout</emphasis>
- control. Refer to <link linkend="The_AccessXTimeout_Control">section 10.6.2</link> for a description of these fields and the
+control. Refer to <link linkend="The_AccessXTimeout_Control">section 10.6.2</link> for a description of these fields and the
units involved.
</para>
@@ -4301,25 +4301,25 @@ units involved.
<para>
The
<structfield>per_key_repeat</structfield>
- field mirrors the
+field mirrors the
<structfield>auto_repeats</structfield>
- field of the core protocol
+field of the core protocol
<structname>XKeyboardState</structname>
- structure: changing the
+structure: changing the
<structfield>auto_repeats</structfield>
- field automatically changes
+field automatically changes
<structfield>per_key_repeat</structfield>
- and vice versa. It is provided for convenience and to reduce protocol traffic.
+and vice versa. It is provided for convenience and to reduce protocol traffic.
For example, to obtain the individual repeat key behavior as well as the repeat
delay and rate, use
<function>XkbGetControls</function>.
If the
<structfield>per_key_repeat</structfield>
- were not in this structure, you would have to call both
+were not in this structure, you would have to call both
<function>XGetKeyboardControl</function>
- and
+and
<function>XkbGetControls</function>
- to get this information. The bits correspond to keycodes. The first seven keys
+to get this information. The bits correspond to keycodes. The first seven keys
(keycodes 1&ndash;7) are indicated in
<structfield>per_key_repeat</structfield>[0],
with bit position 0 (low order) corresponding to the fictitious keycode 0.
@@ -4337,7 +4337,7 @@ indicates that the key is a repeating key.
<para>
Use
<function>XkbGetControls</function>
- to find the current state of Xkb server controls.
+to find the current state of Xkb server controls.
</para>
<indexterm significance="preferred" zone="XkbGetControls"><primary><function>XkbGetControls</function></primary></indexterm>
@@ -4387,19 +4387,19 @@ Use
<para>
<function>XkbGetControls</function>
- queries the server for the requested control information, waits for a reply,
+queries the server for the requested control information, waits for a reply,
and then copies the server’s values for the requested information into the
<structfield>ctrls</structfield>
- structure of the
+structure of the
<parameter>xkb</parameter>
- argument. Only those components specified by the
+argument. Only those components specified by the
<parameter>which</parameter>
- parameter are copied. Valid values for
+parameter are copied. Valid values for
<parameter>which</parameter>
- are any combination of the masks listed in
+are any combination of the masks listed in
<link linkend="table10.7">Table 10.7</link> that have <quote>ok</quote> in the
<parameter>which</parameter>
- column.
+column.
</para>
@@ -4409,35 +4409,35 @@ If
is
<symbol>NULL</symbol>,
<function>XkbGetControls</function>
- allocates and initializes it before obtaining the values specified by
+allocates and initializes it before obtaining the values specified by
<parameter>which</parameter>.
If
<parameter>xkb</parameter>-&gt;<structfield>ctrls</structfield>
- is not
+is not
<symbol>NULL</symbol>,
<function>XkbGetControls</function>
- modifies only those portions of
+modifies only those portions of
<parameter>xkb</parameter>-&gt;<structfield>ctrls</structfield>
- corresponding to the values specified by
+corresponding to the values specified by
<parameter>which</parameter>.
</para>
<para>
<function>XkbGetControls</function>
- returns
+returns
<symbol>Success</symbol>
- if successful; otherwise, it returns
+if successful; otherwise, it returns
<errorname>BadAlloc</errorname>
- if it cannot obtain sufficient storage,
+if it cannot obtain sufficient storage,
<errorname>BadMatch</errorname>
- if
+if
<parameter>xkb</parameter>
- is
+is
<symbol>NULL</symbol>
- or
+or
<parameter>which</parameter>
- is empty, or
+is empty, or
<errorname>BadImplementation</errorname>.
</para>
@@ -4445,18 +4445,18 @@ If
<para>
To free the
<structfield>ctrls</structfield>
- member of a keyboard description, use
+member of a keyboard description, use
<function>XkbFreeControls</function>
- (see <link linkend="Allocating_and_Freeing_an_XkbControlsRec">section 10.12</link>)
+(see <link linkend="Allocating_and_Freeing_an_XkbControlsRec">section 10.12</link>)
</para>
<para>
The
<structfield>num_groups</structfield>
- field in the
+field in the
<structfield>ctrls</structfield>
- structure is always filled in by
+structure is always filled in by
<function>XkbGetControls</function>,
regardless of which bits are selected by
<parameter>which</parameter>.
@@ -4473,7 +4473,7 @@ keyboard description and call
<function>XkbSetControls</function>,
or, to reduce network traffic, use an
<structname>XkbControlsChangesRec</structname>
- structure and call
+structure and call
<function>XkbChangeControls</function>.
</para>
@@ -4481,9 +4481,9 @@ or, to reduce network traffic, use an
<para>
To change the state of one or more controls, first modify the
<structfield>ctrls</structfield>
- structure in a local copy of the keyboard description and then use
+structure in a local copy of the keyboard description and then use
<function>XkbSetControls</function>
- to copy those changes to the X server.
+to copy those changes to the X server.
</para>
<indexterm significance="preferred" zone="XkbSetControls"><primary><function>XkbSetControls</function></primary></indexterm>
@@ -4534,28 +4534,28 @@ To change the state of one or more controls, first modify the
<para>
For each bit that is set in the
<parameter>which</parameter>
- parameter,
+parameter,
<function>XkbSetControls</function>
- sends the corresponding values from the
+sends the corresponding values from the
<parameter>xkb</parameter>-&gt;<structfield>ctrls</structfield>
- field to the server. Valid values for
+field to the server. Valid values for
<parameter>which</parameter>
- are any combination of the masks listed in
+are any combination of the masks listed in
<link linkend="table10.7">Table 10.7</link> that have <quote>ok</quote> in the
<parameter>which</parameter>
- column.
+column.
</para>
<para>
If
<parameter>xkb</parameter>-&gt;<structfield>ctrls</structfield>
- is
+is
<symbol>NULL</symbol>,
the server does not support a compatible version of Xkb, or the Xkb extension
has not been properly initialized,
<function>XkbSetControls</function>
- returns
+returns
<symbol>False</symbol>.
Otherwise, it sends the request to the X server and returns
<symbol>True</symbol>.
@@ -4565,20 +4565,20 @@ Otherwise, it sends the request to the X server and returns
<para>
Note that changes to attributes of controls in the
<structname>XkbControlsRec</structname>
- structure are apparent only when the associated control is enabled, although
+structure are apparent only when the associated control is enabled, although
the corresponding values are still updated in the X server. For example, the
<structfield>repeat_delay</structfield>
- and
+and
<structfield>repeat_interval</structfield>
- fields are ignored unless the
+fields are ignored unless the
<emphasis>RepeatKeys</emphasis>
- control is enabled (that is, the X server’s equivalent of
+control is enabled (that is, the X server’s equivalent of
<structfield>xkb-&gt;ctrls</structfield>
- has
+has
<symbol>XkbRepeatKeysMask</symbol>
- set in
+set in
<structfield>enabled_ctrls</structfield>).
- It is permissible to modify the attributes of a control in one call to
+It is permissible to modify the attributes of a control in one call to
XkbSetControls and enable the control in a subsequent call. See <link linkend="The_EnabledControls_Control">section 10.1.1</link>
for more information on enabling and disabling controls.
</para>
@@ -4587,15 +4587,15 @@ for more information on enabling and disabling controls.
<para>
Note that the
<structfield>enabled_ctrls</structfield>
- field is itself a control — the
+field is itself a control — the
<emphasis>EnabledControls</emphasis>
- control. As such, to set a specific configuration of enabled and disabled
+control. As such, to set a specific configuration of enabled and disabled
boolean controls, you must set
<structfield>enabled_ctrls</structfield>
- to the appropriate bits to enable only the controls you want and disable all
+to the appropriate bits to enable only the controls you want and disable all
others, then specify the
<symbol>XkbControlsEnabledMask</symbol>
- in a call to
+in a call to
<function>XkbSetControls</function>.
Because this is somewhat awkward if all you want to do is enable and disable
controls, and not modify any of their attributes, a convenience function is
@@ -4614,17 +4614,17 @@ also provided for this purpose
<para>
The
<structname>XkbControlsChangesRec</structname>
- structure allows applications to track modifications to an
+structure allows applications to track modifications to an
<structname>XkbControlsRec</structname>
- structure and thereby reduce the amount of traffic sent to the server. The
+structure and thereby reduce the amount of traffic sent to the server. The
same
<structname>XkbControlsChangesRec</structname>
- structure may be used in several successive modifications to the same
+structure may be used in several successive modifications to the same
<structname>XkbControlsRec</structname>
- structure, then subsequently used to cause all of the changes, and only the
+structure, then subsequently used to cause all of the changes, and only the
changes, to be propagated to the server. The
<structname>XkbControlsChangesRec</structname>
- structure is defined as follows:
+structure is defined as follows:
<programlisting>
typedef struct _XkbControlsChanges {
@@ -4640,33 +4640,33 @@ typedef struct _XkbControlsChanges {
<para>
The
<structfield>changed_ctrls</structfield>
- field is a mask specifying which logical sets of data in the controls
+field is a mask specifying which logical sets of data in the controls
structure have been modified. In this context, modified means
<emphasis>set</emphasis>,
that is, if a value is set to the same value it previously contained, it has
still been modified, and is noted as changed. Valid values for
<structfield>changed_ctrls</structfield>
- are any combination of the masks listed in
+are any combination of the masks listed in
<link linkend="table10.7">Table 10.7</link> that have <quote>ok</quote> in the
<structfield>changed_ctrls</structfield>
- column. Setting a bit implies the corresponding data fields from the
+column. Setting a bit implies the corresponding data fields from the
<quote>Relevant XkbControlsRec Data Fields</quote> column in
<link linkend="table10.6">Table 10.6</link> have been modified. The
<structfield>enabled_ctrls_changes</structfield>
- field specifies which bits in the
+field specifies which bits in the
<structfield>enabled_ctrls</structfield>
- field have changed. If the number of keyboard groups has changed, the
+field have changed. If the number of keyboard groups has changed, the
<structfield>num_groups_changed</structfield>
- field is set to <symbol>True</symbol>.
+field is set to <symbol>True</symbol>.
</para>
<para>
If you have an Xkb description with controls that have been modified and an
<structname>XkbControlsChangesRec</structname>
- that describes the changes that have been made, the
+that describes the changes that have been made, the
<function>XkbChangeControls</function>
- function provides a flexible method for updating the controls in a server to
+function provides a flexible method for updating the controls in a server to
match those in the changed keyboard description.
</para>
@@ -4718,9 +4718,9 @@ match those in the changed keyboard description.
<para>
<function>XkbChangeControls</function>
- copies any controls fields specified by
+copies any controls fields specified by
<parameter>changes</parameter>
- from the keyboard description controls structure,
+from the keyboard description controls structure,
<parameter>xkb</parameter>-&gt;<structfield>ctrls</structfield>,
to the server specified by
<parameter>dpy</parameter>.
@@ -4741,15 +4741,15 @@ to the server specified by
Whenever a field in the controls structure changes in the server’s keyboard
description, the server sends an
<symbol>XkbControlsNotify</symbol>
- event to all interested clients.To receive
+event to all interested clients.To receive
<symbol>XkbControlsNotify</symbol>
- events under all possible conditions, use
+events under all possible conditions, use
<function>XkbSelectEvents</function>
- (see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
+(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
<symbol>XkbControlsNotifyMask</symbol>
- in both
+in both
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>.
</para>
@@ -4757,24 +4757,24 @@ description, the server sends an
<para>
To receive
<symbol>XkbControlsNotify</symbol>
- events only under certain conditions, use
+events only under certain conditions, use
<function>XkbSelectEventDetails</function>
- using
+using
<symbol>XkbControlsNotify</symbol>
- as the
+as the
<structfield>event_type</structfield>
- and specifying the desired state changes in
+and specifying the desired state changes in
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>
- using mask bits from <link linkend="table10.7">Table 10.7</link>.
+using mask bits from <link linkend="table10.7">Table 10.7</link>.
</para>
<para>
The structure for the
<symbol>XkbControlsNotify</symbol>
- event is defined as follows:
+event is defined as follows:
<programlisting>
typedef struct {
@@ -4802,29 +4802,29 @@ typedef struct {
<para>
The
<structfield>changed_ctrls</structfield>
- field specifies the controls components that have changed and consists of bits
+field specifies the controls components that have changed and consists of bits
taken from the masks defined in
<link linkend="table10.7">Table 10.7</link> with <quote>ok</quote> in the
<structfield>changed_ctrls</structfield>
- column.
+column.
</para>
<para>
The controls currently enabled in the server are reported in the
<structfield>enabled_ctrls</structfield>
- field. If any controls were just enabled or disabled (that is, the contents of
+field. If any controls were just enabled or disabled (that is, the contents of
the
<structfield>enabled_ctrls</structfield>
- field changed), they are flagged in the
+field changed), they are flagged in the
<structfield>enabled_ctrl_changes</structfield>
- field. The valid bits for these fields are the masks listed in
+field. The valid bits for these fields are the masks listed in
<link linkend="table10.7">Table 10.7</link> with
<quote>ok</quote> in the
<structfield>enabled_ctrls</structfield>
- column. The
+column. The
<structfield>num_groups</structfield>
- field reports the number of groups bound to the key belonging to the most
+field reports the number of groups bound to the key belonging to the most
number of groups and is automatically updated when the keyboard mapping changes.
</para>
@@ -4832,33 +4832,33 @@ number of groups and is automatically updated when the keyboard mapping changes.
<para>
If the change was caused by a request from a client, the
<structfield>keycode</structfield>
- and
+and
<structfield>event_type</structfield>
- fields are set to
+fields are set to
<emphasis>zero</emphasis>
and the
<structfield>req_major</structfield>
- and
+and
<structfield>req_minor</structfield>
- fields identify the request. The
+fields identify the request. The
<structfield>req_major</structfield>
- value is the same as the major extension opcode. Otherwise,
+value is the same as the major extension opcode. Otherwise,
<structfield>event_type</structfield>
- is set to the type of event that caused the change (one of
+is set to the type of event that caused the change (one of
<symbol>KeyPress</symbol>,
<symbol>KeyRelease</symbol>,
<symbol>DeviceKeyPress</symbol>,
<symbol>DeviceKeyRelease</symbol>,
<symbol>ButtonPress</symbol>
- or
+or
<symbol>ButtonRelease</symbol>),
- and
+and
<structfield>req_major</structfield>
- and
+and
<structfield>req_minor</structfield>
- are undefined. If
+are undefined. If
<structfield>event_type</structfield>
- is
+is
<symbol>KeyPress</symbol>,
<symbol>KeyRelease</symbol>,
<symbol>DeviceKeyPress</symbol>,
@@ -4866,21 +4866,21 @@ or
<symbol>DeviceKeyRelease</symbol>,
the
<structfield>keycode</structfield>
- field is set to the key that caused the change. If
+field is set to the key that caused the change. If
<structfield>event_type</structfield>
- is
+is
<symbol>ButtonPress</symbol>
- or
+or
<symbol>ButtonRelease</symbol>,
<structfield>keycode</structfield>
- contains the button number.
+contains the button number.
</para>
<para>
When a client receives an
<symbol>XkbControlsNotify</symbol>
- event, it can note the changes in a changes structure using
+event, it can note the changes in a changes structure using
<function>XkbNoteControlsChanges</function>.
</para>
@@ -4935,17 +4935,17 @@ When a client receives an
<para>
The
<parameter>wanted</parameter>
- parameter is a bitwise inclusive OR of bits taken from the set of masks
+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 <quote>ok</quote>
in the
<structfield>changed_ctrls</structfield>
- column.
+column.
<function>XkbNoteControlsChanges</function>
- copies any changes reported in
+copies any changes reported in
<parameter>new</parameter>
- and specified in
+and specified in
<parameter>wanted</parameter>
- into the changes record specified by
+into the changes record specified by
<parameter>changes</parameter>.
</para>
@@ -4953,7 +4953,7 @@ in the
<para>
Use
<function>XkbGetControlsChanges</function>
- to update a local copy of a keyboard description with the changes previously
+to update a local copy of a keyboard description with the changes previously
noted by one or more calls to
<function>XkbNoteControlsChanges</function>.
</para>
@@ -5009,36 +5009,36 @@ noted by one or more calls to
<para>
<function>XkbGetControlsChanges</function>
- examines the
+examines the
<parameter>changes</parameter>
- parameter, queries the server for the necessary information, and copies the
+parameter, queries the server for the necessary information, and copies the
results into the
<parameter>xkb</parameter>-&gt;<structfield>ctrls</structfield>
- keyboard description. If the
+keyboard description. If the
<structfield>ctrls</structfield>
- field of
+field of
<parameter>xkb</parameter>
- is
+is
<symbol>NULL</symbol>,
<function>XkbGetControlsChanges</function>
- allocates and initializes it. To free the
+allocates and initializes it. To free the
<structfield>ctrls</structfield>
- field, use
+field, use
<function>XkbFreeControls</function>
- (see <link linkend="Allocating_and_Freeing_an_XkbControlsRec">section 10.12</link>).
+(see <link linkend="Allocating_and_Freeing_an_XkbControlsRec">section 10.12</link>).
</para>
<para>
<function>XkbGetControlsChanges</function>
- returns
+returns
<symbol>Success</symbol>
- if successful and can generate
+if successful and can generate
<errorname>BadAlloc</errorname>,
<errorname>BadImplementation</errorname>,
- and
+and
<errorname>BadMatch</errorname>
- errors.
+errors.
</para>
@@ -5049,11 +5049,11 @@ results into the
<para>
The need to allocate an
<structname>XkbControlsRec</structname>
- structure seldom arises; Xkb creates one when an application calls
+structure seldom arises; Xkb creates one when an application calls
<function>XkbGetControls</function>
- or a related function. For those situations where there is not an
+or a related function. For those situations where there is not an
<structname>XkbControlsRec</structname>
- structure allocated in the
+structure allocated in the
<structname>XkbDescRec</structname>,
allocate one by calling
<function>XkbAllocControls</function>.
@@ -5096,40 +5096,40 @@ allocate one by calling
<para>
<function>XkbAllocControls</function>
- allocates the
+allocates the
<structfield>ctrls</structfield>
- field of the
+field of the
<parameter>xkb</parameter>
- parameter, initializes all fields to zero, and returns
+parameter, initializes all fields to zero, and returns
<symbol>Success</symbol>.
If the
<structfield>ctrls</structfield>
- field is not
+field is not
<symbol>NULL</symbol>,
<function>XkbAllocControls</function>
- simply returns
+simply returns
<symbol>Success</symbol>.
If
<parameter>xkb</parameter>
- is
+is
<symbol>NULL</symbol>,
<function>XkbAllocControls</function>
- reports a
+reports a
<errorname>BadMatch</errorname>
- error. If the
+error. If the
<structfield>ctrls</structfield>
- field could not be allocated, it reports a
+field could not be allocated, it reports a
<errorname>BadAlloc</errorname>
- error.
+error.
</para>
<para>
The
<parameter>which</parameter>
- mask specifies the individual fields of the
+mask specifies the individual fields of the
<structfield>ctrls</structfield>
- structure to be allocated and can contain any of the valid masks defined in
+structure to be allocated and can contain any of the valid masks defined in
<link linkend="table10.7">Table 10.7</link>.
Because none of the currently existing controls have any structures
associated with them, which is currently of little practical value in this call.
@@ -5139,7 +5139,7 @@ associated with them, which is currently of little practical value in this call.
<para>
To free memory used by the
<structfield>ctrls</structfield>
- member of an
+member of an
<structname>XkbDescRec</structname>
structure, use
<function>XkbFreeControls</function>:
@@ -5194,19 +5194,19 @@ structure, use
<para>
<function>XkbFreeControls</function>
- frees the specified components of the
+frees the specified components of the
<structfield>ctrls</structfield>
- field in the
+field in the
<parameter>xkb</parameter>
- keyboard description and sets the corresponding structure component values to
+keyboard description and sets the corresponding structure component values to
<symbol>NULL</symbol>
- or
+or
<emphasis>zero</emphasis>.
The
<parameter>which</parameter>
- mask specifies the fields of
+mask specifies the fields of
<structfield>ctrls</structfield>
- to be freed and can contain any of the controls components specified in
+to be freed and can contain any of the controls components specified in
<link linkend="table10.7">Table 10.7</link>.
</para>
@@ -5214,20 +5214,20 @@ The
<para>
If
<parameter>free_all</parameter>
- is
+is
<symbol>True</symbol>,
<function>XkbFreeControls</function>
- frees every non-
+frees every non-
<symbol>NULL</symbol>
- structure component in the controls, frees the
+structure component in the controls, frees the
<structname>XkbControlsRec</structname>
- structure referenced by the
+structure referenced by the
<structfield>ctrls</structfield>
- member of
+member of
<parameter>xkb</parameter>,
and sets
<structfield>ctrls</structfield>
- to
+to
<symbol>NULL</symbol>.
</para>
@@ -5252,7 +5252,7 @@ for more details.
<para>
To get the current values of the
<emphasis>per-client</emphasis>
- controls, use
+controls, use
<function>XkbGetPerClientControls</function>.
</para>
@@ -5294,22 +5294,22 @@ To get the current values of the
<para>
<function>XkbGetPerClientControls</function>
- backfills
+backfills
<parameter>ctrls</parameter>
- with the
+with the
<emphasis>per-client</emphasis>
control attributes for this particular client. It returns
<symbol>True</symbol>
- if successful, and
+if successful, and
<symbol>False</symbol>
- otherwise.
+otherwise.
</para>
<para>
To change the current values of the
<emphasis>per-client</emphasis>
- control attributes, use
+control attributes, use
<function>XkbSetPerClientControls</function>.
</para>
@@ -5374,9 +5374,9 @@ by OR-ing the values together. XkbSetPerClientControls backfills value with the
control attributes for this particular client.
It returns
<symbol>True</symbol>
- if successful, and
+if successful, and
<symbol>False</symbol>
- otherwise.
+otherwise.
</para>
</sect1>
diff --git a/specs/XKB/ch11.xml b/specs/XKB/ch11.xml
index d1881be7..6463878b 100644
--- a/specs/XKB/ch11.xml
+++ b/specs/XKB/ch11.xml
@@ -86,13 +86,13 @@ affecting simple string lookups are:
<para>
If the
<emphasis>ForceLatin1Lookup</emphasis>
- control is enabled,
+control is enabled,
<function>XLookupString</function>
- only returns strings using the Latin1 character set. If
+only returns strings using the Latin1 character set. If
<emphasis>ForceLatin1Lookup</emphasis>
- is not enabled,
+is not enabled,
<function>XLookupString</function>
- can return characters that are not in the Latin1 set. By default, this control
+can return characters that are not in the Latin1 set. By default, this control
is disabled, allowing characters outside of the Latin1 set to be returned.
</para>
@@ -104,7 +104,7 @@ is disabled, allowing characters outside of the Latin1 set to be returned.
<para>
Simple string lookups in
<function>XLookupString</function>
- involve two different translation phases. The first phase translates raw
+involve two different translation phases. The first phase translates raw
device keycodes to individual keysyms. The second phase attempts to map the
resulting keysym into a string of one or more characters. In the first phase,
some of the modifiers are normally used to determine the appropriate shift
@@ -115,59 +115,59 @@ level for a key.
<para>
The
<emphasis>ConsumeLookupMods</emphasis>
- control determines whether or not
+control determines whether or not
<function>XLookupString</function>
<emphasis>consumes</emphasis>
- the modifiers it uses during the first phase of processing (mapping a keycode
+the modifiers it uses during the first phase of processing (mapping a keycode
to a keysym). When a modifier is consumed, it is effectively removed from the
working copy of the keyboard state information
<function>XLookupString</function>
- is using and appears to be unset for the remainder of the processing.
+is using and appears to be unset for the remainder of the processing.
</para>
<para>
If the
<emphasis>ConsumeLookupMods</emphasis>
- control is enabled,
+control is enabled,
<function>XLookupString</function>
- does not use the modifiers used to translate the keycode of the event to a
+does not use the modifiers used to translate the keycode of the event to a
keysym when it is determining the string associated with a keysym. For example,
assume the keymap for the ‘A’ key only contains the shift modifier and the
<emphasis>ConsumeLookupMods</emphasis>
- control is enabled. If a user presses the
+control is enabled. If a user presses the
<keycap>Shift</keycap>
- key and the
+key and the
<keycap>A</keycap>
- key while the
+key while the
<keycap>Num_Lock</keycap>
- key is locked,
+key is locked,
<function>XLookupString</function>
- uses the
+uses the
<symbol>Shift</symbol>
- modifier when mapping the keycode for the ‘a’ key to the keysym for
+modifier when mapping the keycode for the ‘a’ key to the keysym for
‘A’; subsequently, it only uses the
<emphasis>NumLock</emphasis>
- modifier when determining the string associated with the keysym ‘A’.
+modifier when determining the string associated with the keysym ‘A’.
</para>
<para>
If the
<emphasis>ConsumeLookupMods</emphasis>
- control is not enabled,
+control is not enabled,
<function>XLookupString</function>
- uses all of the event modifiers to determine the string associated with a
+uses all of the event modifiers to determine the string associated with a
keysym. This behavior mirrors the behavior of
<function>XLookupString</function>
- in the core implementation.
+in the core implementation.
</para>
<para>
The
<emphasis>ConsumeLookupMods</emphasis>
- control is unset by default. For more information on modifier consumption,
+control is unset by default. For more information on modifier consumption,
refer to <xref linkend="Interpreting_Key_Events" />.
</para>
@@ -179,16 +179,16 @@ refer to <xref linkend="Interpreting_Key_Events" />.
<para>
The
<emphasis>AlwaysConsumeShiftAndLock</emphasis>
- control, if enabled, forces
+control, if enabled, forces
<function>XLookupString</function>
- to consume the
+to consume the
<symbol>Shift</symbol>
- and
+and
<symbol>Lock</symbol>
- modifiers when processing all keys, even if the definition for the key type
+modifiers when processing all keys, even if the definition for the key type
does not specify these modifiers. The
<emphasis>AlwaysConsumeShiftAndLock</emphasis>
- control is unset by default. See <link linkend="Key_Types">section 15.2</link> for a discussion of key types.
+control is unset by default. See <link linkend="Key_Types">section 15.2</link> for a discussion of key types.
</para>
@@ -200,10 +200,10 @@ does not specify these modifiers. The
<para>
The second type of string lookup performed by
<function>XLookupString</function>
- involves translating a series of keysyms into a string. Because these lookups
+involves translating a series of keysyms into a string. Because these lookups
can involve more than one key event, they require
<function>XLookupString</function>
- to retain some state information between successive calls. The process of
+to retain some state information between successive calls. The process of
mapping a series of keysyms to a string is known as
<firstterm>compose processing</firstterm>.
<indexterm significance="preferred" zone="Controls_Affecting_Compose_Processing">
@@ -239,19 +239,19 @@ valid translation to a string. If the subsequent key events do not have a valid
translation, some decision must be made about what to do with the key events
that were processed while attempting the compose. The
<emphasis>ConsumeKeysOnComposeFail</emphasis>
- control allows a client to specify what happens with the key events
+control allows a client to specify what happens with the key events
<function>XLookupString</function>
- has been considering when it reaches a dead end in a compose sequence.
+has been considering when it reaches a dead end in a compose sequence.
</para>
<para>
If the
<emphasis>ConsumeKeysOnComposeFail</emphasis>
- control is set, all keys associated with a failed compose sequence should be
+control is set, all keys associated with a failed compose sequence should be
consumed (discarded). If the
<emphasis>ConsumeKeysOnComposeFail</emphasis>
- control is not set, the key events associated with a failed compose sequence
+control is not set, the key events associated with a failed compose sequence
should be processed as a normal sequence of key events.
</para>
@@ -259,7 +259,7 @@ should be processed as a normal sequence of key events.
<para>
The
<emphasis>ConsumeKeysOnComposeFail</emphasis>
- control is disabled by default.
+control is disabled by default.
</para>
@@ -270,15 +270,15 @@ The
<para>
The
<emphasis>ComposeLED</emphasis>
- control allows a client to specify whether or not an indicator should be set
+control allows a client to specify whether or not an indicator should be set
and cleared to provide feedback when compose processing is in progress. The
control does not specify which indicator should be used; the mapping for this
is up to the individual implementation. If the
<emphasis>ComposeLED</emphasis>
- control is enabled, it specifies that an indicator should be set when a
+control is enabled, it specifies that an indicator should be set when a
compose sequence is in progress and cleared when one is not in progress. The
<emphasis>ComposeLED</emphasis>
- control is disabled by default.
+control is disabled by default.
</para>
@@ -286,7 +286,7 @@ compose sequence is in progress and cleared when one is not in progress. The
While the Xkb extension does not specify the type of type of indicator to be
used when the
<emphasis>ComposeLED</emphasis>
- control is implemented, a consistent convention between implementations is to
+control is implemented, a consistent convention between implementations is to
everyone’s benefit. If a named indicator is used for this purpose, the
recommended name is “<literal>Compose</literal>”.
Note that some implementations may use an unnamed, custom hardware LED for
@@ -301,18 +301,18 @@ this purpose.
<para>
The
<emphasis>BeepOnComposeFail</emphasis>
- control allows a client to specify whether or not a bell should be activated
+control allows a client to specify whether or not a bell should be activated
to provide feedback when a compose sequence fails. The control does not specify
the type of bell that should be used; the mapping for this is up to the
individual implementation. If the
<emphasis>BeepOnComposeFail</emphasis>
- control is enabled, it specifies that a bell should be activated when a
+control is enabled, it specifies that a bell should be activated when a
compose sequence fails. The
<emphasis>BeepOnComposeFail</emphasis>
- control is disabled by default. If implemented, the bell should be activated
+control is disabled by default. If implemented, the bell should be activated
using
<function>XkbBell</function>
- or
+or
<function>XkbDeviceBell</function>.
</para>
@@ -320,7 +320,7 @@ using
<para>
While the Xkb extension does not specify the type of bell to be used when the
<emphasis>BeepOnComposeFail</emphasis>
- control is implemented, a consistent convention between implementations is to
+control is implemented, a consistent convention between implementations is to
everyone’s benefit. If a named bell is used for this purpose, the recommended
name is “<literal>ComposeFail</literal>”.
</para>
@@ -342,15 +342,15 @@ name is “<literal>ComposeFail</literal>”.
<para>
When Xkb is initialized, it implicitly forces requests for
<symbol>NewKeyboardNotify</symbol>
- events. These events may be used by the Xkb library extension internally; they
+events. These events may be used by the Xkb library extension internally; they
are normally translated into core protocol
<symbol>MappingNotify</symbol>
- events before being passed to the client. While delivering the event to the
+events before being passed to the client. While delivering the event to the
client is appropriate in most cases, it is not appropriate for some clients
that maintain per-key data structures. This is because once the server has sent
a
<symbol>NewKeyboardNotify</symbol>
- event, it is free to send the client events for all keys in the new range and
+event, it is free to send the client events for all keys in the new range and
that range may be outside of the per-key data structures the client is
maintaining.
</para>
@@ -359,11 +359,11 @@ maintaining.
<para>
The
<emphasis>IgnoreNewKeyboards</emphasis>
- control, if enabled, prevents Xkb from mapping
+control, if enabled, prevents Xkb from mapping
<symbol>NewKeyboardNotify</symbol>
- events to core
+events to core
<symbol>MappingNotify</symbol>
- events and passing them to the client. The control is initially disabled.
+events and passing them to the client. The control is initially disabled.
</para>
@@ -461,7 +461,7 @@ implemented, use <function>XkbXlibControlsImplemented</function>.
<para>
<function>XkbXlibControlsImplemented</function>
- returns a bitmask indicating the controls actually implemented in the Xkb
+returns a bitmask indicating the controls actually implemented in the Xkb
library and is composed of an inclusive OR of bits from
<link linkend="table11.1">Table 11.1</link>.
</para>
@@ -502,7 +502,7 @@ To determine the current state of the Library Controls, use
<para>
<function>XkbGetXlibControls</function>
- returns the current state of the Library Controls as a bit mask that is an
+returns the current state of the Library Controls as a bit mask that is an
inclusive OR of the control masks from
<link linkend="table11.1">Table 11.1</link> for the controls that are
enabled. For the optional compose processing controls, the fact that a control
@@ -566,20 +566,20 @@ To change the state of the Library Controls, use
<para>
<function>XkbSetXlibControls</function>
- modifies the state of the controls selected by
+modifies the state of the controls selected by
<parameter>bits_to_change</parameter>;
- only the controls selected by
+only the controls selected by
<parameter>bits_to_change</parameter>
- are modified. If the bit corresponding to a control is on in
+are modified. If the bit corresponding to a control is on in
<parameter>bits_to_change</parameter>
- and also on in values_for_bits, the control is enabled. If the bit
+and also on in values_for_bits, the control is enabled. If the bit
corresponding to a control is on in
<parameter>bits_to_change</parameter>
- but off in
+but off in
<parameter>values_for_bits</parameter>,
the control is disabled.
<parameter>bits_to_change</parameter>
- should be an inclusive OR of bits from
+should be an inclusive OR of bits from
<link linkend="table11.1">Table 11.1</link>.
</para>
diff --git a/specs/XKB/ch12.xml b/specs/XKB/ch12.xml
index 9086fe78..fcfa8f9f 100644
--- a/specs/XKB/ch12.xml
+++ b/specs/XKB/ch12.xml
@@ -16,10 +16,10 @@ several core X library functions.
<para>
When support for Xkb is built into the X library, the
<function>XOpenDisplay</function>
- function looks for a compatible version of Xkb on the server. If it finds a
+function looks for a compatible version of Xkb on the server. If it finds a
compatible version, it initializes the extension and enables
<firstterm>implicit support</firstterm>
- for Xkb in a number of X library functions. This makes it possible for clients
+for Xkb in a number of X library functions. This makes it possible for clients
to take advantage of nearly all Xkb features without having to be rewritten or
even recompiled, if they are built with shared libraries. This implicit support
is invisible to most clients, but it can have side effects, so the extension
@@ -33,7 +33,7 @@ includes ways to control or disable it.
<para>
Because
<function>XOpenDisplay</function>
- initializes Xkb, some events contain an Xkb description of the keyboard state
+initializes Xkb, some events contain an Xkb description of the keyboard state
instead of that normally used by the core protocol. See <link linkend="Xkb_State_to_Core_Protocol_State_Transformation">section 17.1.1</link> for more
information about the differences between Xkb keyboard state and that reported
by the core protocol.
@@ -51,46 +51,46 @@ by the core protocol.
When Xkb is missing or disabled, the X library tracks changes to the keyboard
mapping using
<symbol>MappingNotify</symbol>
- events. Whenever the keyboard mapping is changed, the server sends all clients
+events. Whenever the keyboard mapping is changed, the server sends all clients
a
<symbol>MappingNotify</symbol>
- event to report the change. When a client receives a
+event to report the change. When a client receives a
<symbol>MappingNotify</symbol>
- event, it is supposed to call
+event, it is supposed to call
<function>XRefreshKeyboardMapping</function>
- to update the keyboard description used internally by the X library.
+to update the keyboard description used internally by the X library.
</para>
<para>
The X Keyboard Extension uses
<symbol>XkbMapNotify</symbol>
- and
+and
<symbol>XkbNewKeyboardNotify</symbol>
- events to track changes to the keyboard mapping. When an Xkb-aware client
+events to track changes to the keyboard mapping. When an Xkb-aware client
receives either event, it should call
<function>XkbRefreshKeyboardMapping</function>
- to update the keyboard description used internally by the X library. To avoid
+to update the keyboard description used internally by the X library. To avoid
duplicate events, the X server does not send core protocol
<symbol>MappingNotify</symbol>
- events to a client that has selected for
+events to a client that has selected for
<symbol>XkbMapNotify</symbol>
- events.
+events.
</para>
<para>
The implicit support for Xkb selects for
<symbol>XkbMapNotify</symbol>
- events. This means that clients that do not explicitly use Xkb but that are
+events. This means that clients that do not explicitly use Xkb but that are
using a version of the X library that has implicit support for Xkb do not
receive
<symbol>MappingNotify</symbol>
- events over the wire. Clients that were not written with Xkb in mind do not
+events over the wire. Clients that were not written with Xkb in mind do not
recognize or properly handle the new Xkb events, so the implicit support
converts them to
<symbol>MappingNotify</symbol>
- events that report approximately the same information, unless the client has
+events that report approximately the same information, unless the client has
explicitly selected for the Xkb version of the event.
</para>
@@ -100,18 +100,18 @@ An Xkb-capable X server does not send events from keys that fall outside the
legal range of keycodes expected by that client. Once the server sends a client
an
<symbol>XkbNewKeyboardNotify</symbol>
- event, it reports events from all keys because it assumes that any client that
+event, it reports events from all keys because it assumes that any client that
has received an
<symbol>XkbNewKeyboardNotify</symbol>
- event expects key events from the new range of keycodes. The implicit support
+event expects key events from the new range of keycodes. The implicit support
for Xkb asks for
<symbol>XkbNewKeyboardNotify</symbol>
- events, so the range of keycodes reported to the client might vary without the
+events, so the range of keycodes reported to the client might vary without the
client’s knowledge. Most clients don’t really care about the range of legal
keycodes, but some clients maintain information about each key and might have
problems with events that come from unexpected keys. Such clients can set the
<symbol>XkbLC_IgnoreNewKeyboards</symbol>
- library control (see <link linkend="IgnoreNewKeyboards">section 11.3.1</link>) to prevent the implicit support from
+library control (see <link linkend="IgnoreNewKeyboards">section 11.3.1</link>) to prevent the implicit support from
requesting notification of changes to the legal range of keycodes.
</para>
@@ -147,11 +147,11 @@ clients.
The
<olink targetdoc='libX11' targetptr='XKeycodeToKeysym'><function>XKeycodeToKeysym</function></olink>
<indexterm significance="preferred" zone="XKeycodeToKeysym"><primary><function>XKeycodeToKeysym</function></primary></indexterm>
- function reports the keysym associated with a particular index for a single
+function reports the keysym associated with a particular index for a single
key. The index specifies a column of symbols in the core keyboard mapping (that
is, as reported by the core protocol
<systemitem>GetKeyboardMapping</systemitem>
- request). The order of the symbols in the core mapping does not necessarily
+request). The order of the symbols in the core mapping does not necessarily
correspond to the order of the symbols used by Xkb; <link linkend="Xkb_Keyboard_Mapping_to_Core_Keyboard_Mapping_Transformations">section 17.1.3</link> describes
the differences.
</para>
@@ -161,7 +161,7 @@ the differences.
The
<olink targetdoc='libX11' targetptr='XKeysymToKeycode'><function>XKeysymToKeycode</function></olink>
<indexterm significance="preferred" zone="XKeysymToKeycode"><primary><function>XKeysymToKeycode</function></primary></indexterm>
- function reports a keycode to which a particular keysym is bound. When Xkb is
+function reports a keycode to which a particular keysym is bound. When Xkb is
missing or disabled, this function looks in each column of the core keyboard
mapping in turn and returns the lowest numbered key that matches in the lowest
numbered group. When Xkb is present, this function uses the Xkb ordering for
@@ -173,7 +173,7 @@ symbols instead.
The
<olink targetdoc='libX11' targetptr='XLookupKeysym'><function>XLookupKeysym</function></olink>
<indexterm significance="preferred" zone="XLookupKeysym"><primary><function>XLookupKeysym</function></primary></indexterm>
- function reports the symbol in a specific column of the key associated with an
+function reports the symbol in a specific column of the key associated with an
event. Whether or not Xkb is present, the column specifies an index into the
core symbol mapping.
</para>
@@ -183,20 +183,20 @@ core symbol mapping.
The
<olink targetdoc='libX11' targetptr='XLookupString'><function>XLookupString</function></olink>
<indexterm significance="preferred" zone="XLookupString"><primary><function>XLookupString</function></primary></indexterm>
- function reports the symbol and string associated with a key event, taking
+function reports the symbol and string associated with a key event, taking
into account the keycode and keyboard state as reported in the event. When Xkb
is disabled or missing,
<function>XLookupString</function>
- uses the rules specified by the core protocol and reports only ISO Latin-1
+uses the rules specified by the core protocol and reports only ISO Latin-1
characters. When Xkb is present,
<function>XLookupString</function>
- uses the explicit keyboard group, key types, and rules specified by Xkb. When
+uses the explicit keyboard group, key types, and rules specified by Xkb. When
Xkb is present,
<function>XLookupString</function>
- is allowed, but not required, to return strings in character sets other than
+is allowed, but not required, to return strings in character sets other than
ISO Latin-1, depending on the current locale. If any key bindings are defined,
<function>XLookupString</function>
- does not use any consumed modifiers (see <link linkend="ConsumeLookupMods">section 11.1.2</link> and <link linkend="Key_Types">section 15.2</link>) to
+does not use any consumed modifiers (see <link linkend="ConsumeLookupMods">section 11.1.2</link> and <link linkend="Key_Types">section 15.2</link>) to
determine matching bindings.
</para>
@@ -205,17 +205,17 @@ determine matching bindings.
The
<olink targetdoc='libX11' targetptr='XRefreshKeyboardMapping'><function>XRefreshKeyboardMapping</function></olink>
<indexterm significance="preferred" zone="XRefreshKeyboardMapping"><primary><function>XRefreshKeyboardMapping</function></primary></indexterm>
- function updates the X library’s internal representation of the keyboard to
+function updates the X library’s internal representation of the keyboard to
reflect changes reported via
<symbol>MappingNotify</symbol>
- events. When Xkb is missing or disabled, this function reloads the entire
+events. When Xkb is missing or disabled, this function reloads the entire
modifier map or keyboard mapping. When Xkb is present, the implicit Xkb support
keeps track of the changed components reported by each
<symbol>XkbMapNotify</symbol>
- event and updates only those pieces of the keyboard description that have
+event and updates only those pieces of the keyboard description that have
changed. If the implicit support has not noted any keyboard mapping changes,
<function>XRefreshKeyboardMapping</function>
- updates the entire keyboard description.
+updates the entire keyboard description.
</para>
@@ -223,13 +223,13 @@ changed. If the implicit support has not noted any keyboard mapping changes,
The
<olink targetdoc='libX11' targetptr='XRebindKeysym'><function>XRebindKeysym</function></olink>
<indexterm significance="preferred" zone="XRebindKeysym"><primary><function>XRebindKeysym</function></primary></indexterm>
- function associates a string with a keysym and a set of modifiers. Xkb does
+function associates a string with a keysym and a set of modifiers. Xkb does
not directly change this function, but it does affect the way that the state
reported in the event is compared to the state specified to
<function>XRebindKeysym</function>.
When Xkb is missing or disabled,
<function>XLookupString</function>
- returns the specified string if the modifiers in the event exactly match the
+returns the specified string if the modifiers in the event exactly match the
modifiers from this call. When Xkb is present, any modifiers used to determine
the keysym are consumed and are not used to look up the string.
</para>
@@ -304,16 +304,16 @@ level, use <function>XkbKeycodeToKeysym</function>.
<para>
<function>XkbKeycodeToKeysym</function>
- returns the keysym bound to a particular group and shift level for a
+returns the keysym bound to a particular group and shift level for a
particular key on the core keyboard. If
<parameter>kc</parameter>
- is not a legal keycode for the core keyboard, or if
+is not a legal keycode for the core keyboard, or if
<parameter>group</parameter>
- or
+or
<parameter>level</parameter>
- are out of range for the specified key,
+are out of range for the specified key,
<function>XkbKeycodeToKeysym</function>
- returns
+returns
<symbol>NoSymbol</symbol>.
</para>
@@ -363,14 +363,14 @@ use
<para>
<function>XkbKeysymToModifiers</function>
- finds the set of modifiers currently bound to the keysym
+finds the set of modifiers currently bound to the keysym
<parameter>ks</parameter>
- on the core keyboard. The value returned is the mask of modifiers bound to the
+on the core keyboard. The value returned is the mask of modifiers bound to the
keysym
<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
+returns zero; otherwise, it returns the inclusive OR of zero or more of the
following:
<symbol>ShiftMask</symbol>,
<symbol>ControlMask</symbol>,
@@ -379,7 +379,7 @@ following:
<symbol>Mod2Mask</symbol>,
<symbol>Mod3Mask</symbol>,
<symbol>Mod4Mask</symbol>,
- and
+and
<symbol>Mod5Mask</symbol>.
</para>
@@ -387,7 +387,7 @@ following:
<para>
Use
<function>XkbLookupKeySym</function>
- to find the symbol associated with a key for a particular state.
+to find the symbol associated with a key for a particular state.
</para>
@@ -465,40 +465,40 @@ Use
<para>
<function>XkbLookupKeySym</function>
- is the equivalent of the core
+is the equivalent of the core
<symbol>XLookupKeySym</symbol>
- function. For the core keyboard, given a keycode
+function. For the core keyboard, given a keycode
<parameter>key</parameter>
- and an Xkb state
+and an Xkb state
<parameter>state</parameter>,
<function>XkbLookupKeySym</function>
- returns the symbol associated with the key in
+returns the symbol associated with the key in
<parameter>sym_rtrn</parameter>
- and the list of modifiers that should still be applied in
+and the list of modifiers that should still be applied in
<parameter>mods_rtrn</parameter>.
The
<parameter>state</parameter>
- parameter is the state from a
+parameter is the state from a
<symbol>KeyPress</symbol>
- or
+or
<symbol>KeyRelease</symbol>
- event.
+event.
<function>XkbLookupKeySym</function>
- returns
+returns
<symbol>True</symbol>
- if it succeeds.
+if it succeeds.
</para>
<para>
Use
<function>XkbLookupKeyBinding</function>
- to find the string bound to a key by
+to find the string bound to a key by
<function>XRebindKeysym</function>.
<function>XkbLookupKeyBinding</function>
- is the equivalent of the core
+is the equivalent of the core
<function>XLookupString</function>
- function.
+function.
</para>
@@ -588,24 +588,24 @@ Use
<para>
<function>XRebindKeysym</function>
- binds an ASCII string to a specified keysym, so that the string and keysym are
+binds an ASCII string to a specified keysym, so that the string and keysym are
returned when the key is pressed and a specified list of modifiers are also
being held down.
<function>XkbLookupKeyBinding</function>
- returns in
+returns in
<parameter>buf</parameter>
- the string associated with the keysym
+the string associated with the keysym
<parameter>sym</parameter>
- and modifier state
+and modifier state
<parameter>state</parameter>.
<parameter>buf</parameter>
- is
+is
<symbol>NULL</symbol>
- terminated unless there’s an overflow. If the string returned is larger than
+terminated unless there’s an overflow. If the string returned is larger than
<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
+returns the number of bytes that it placed into
<parameter>buf</parameter>.
</para>
@@ -703,22 +703,22 @@ state, use
<para>
<function>XkbTranslateKeySym</function>
- applies the transformations specified in
+applies the transformations specified in
<parameter>mods</parameter>
- to the symbol specified by
+to the symbol specified by
<parameter>sym_inout</parameter>.
It returns in
<parameter>buf</parameter>
- the string, if any, associated with the keysym for the current locale. If the
+the string, if any, associated with the keysym for the current locale. If the
transformations in
<parameter>mods</parameter>
- changes the keysym,
+changes the keysym,
<parameter>sym_inout</parameter>
- is updated accordingly. If the string returned is larger than
+is updated accordingly. If the string returned is larger than
<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
+returns the number of bytes it placed into
<parameter>buf</parameter>.
</para>
@@ -754,27 +754,27 @@ To update the keyboard description that is internal to the X library, use
<para>
<function>XkbRefreshKeyboardMapping</function>
- is the Xkb equivalent of the core
+is the Xkb equivalent of the core
<function>XRefreshKeyboardMapping</function>
- function. It requests that the X server send the current key mapping
+function. It requests that the X server send the current key mapping
information to this client. A client usually invokes
<function>XkbRefreshKeyboardMapping</function>
- after receiving an
+after receiving an
<symbol>XkbMapNotify</symbol>
- event.
+event.
<function>XkbRefreshKeyboardMapping</function>
- returns
+returns
<symbol>Success</symbol>
- if it succeeds and
+if it succeeds and
<errorname>BadMatch</errorname>
- if the event is not an Xkb event.
+if the event is not an Xkb event.
</para>
<para>
The
<symbol>XkbMapNotify</symbol>
- event can be generated when some client calls
+event can be generated when some client calls
<function>XkbSetMap</function>,
<function>XkbChangeMap</function>,
<function>XkbGetKeyboardByName</function>,
@@ -858,9 +858,9 @@ To translate a keycode to a key symbol and modifiers, use
<para>
<parameter>mods_rtrn</parameter>
- is backfilled with the modifiers consumed by the translation process.
+is backfilled with the modifiers consumed by the translation process.
<parameter>mods</parameter>
- is a bitwise inclusive OR of the legal modifier masks:
+is a bitwise inclusive OR of the legal modifier masks:
<symbol>ShiftMask</symbol>,
<symbol>LockMask</symbol>,
<symbol>ControlMask</symbol>,
@@ -871,15 +871,15 @@ To translate a keycode to a key symbol and modifiers, use
<symbol>Mod5Mask</symbol>.
The
<emphasis>AlwaysConsumeShiftAndLock</emphasis>
- library control (see <link linkend="AlwaysConsumeShiftAndLock">section 11.1.3</link>), if enabled, causes
+library control (see <link linkend="AlwaysConsumeShiftAndLock">section 11.1.3</link>), if enabled, causes
<function>XkbTranslateKeyCode</function>
- to consume shift and lock.
+to consume shift and lock.
<function>XkbTranslateKeyCode</function>
- returns
+returns
<symbol>True</symbol>
- if the translation resulted in a keysym, and
+if the translation resulted in a keysym, and
<symbol>False</symbol>
- if it resulted in
+if it resulted in
<symbol>NoSymbol</symbol>.
</para>
</sect1>
diff --git a/specs/XKB/ch13.xml b/specs/XKB/ch13.xml
index aaa29408..654f9dfe 100644
--- a/specs/XKB/ch13.xml
+++ b/specs/XKB/ch13.xml
@@ -59,7 +59,7 @@ Objects should be drawn in order from highest priority (0) to lowest (255).
<primary><structname>XkbGeometryRec</structname></primary></indexterm>
The keyboard geometry’s top-level description is stored in a
<structname>XkbGeometryRec</structname>
- structure. This structure contains three types of information:
+structure. This structure contains three types of information:
</para>
<orderedlist>
@@ -99,11 +99,11 @@ as follows:
<para>
The top-level keyboard geometry description includes a list of up to
<symbol>XkbGeomMaxColors</symbol>
- (32)
+(32)
<firstterm>color names</firstterm>.
A color name is a string whose interpretation is not specified by Xkb. The
<structname>XkbColorRec</structname>
- structure provides a field for this name as well as a pixel field. The pixel
+structure provides a field for this name as well as a pixel field. The pixel
field is a convenient place for an application to store a pixel value or color
definition, if it needs to. All other geometry data structures refer to colors
using their indices in this global list.
@@ -135,7 +135,7 @@ a top label.
<para>
The top-level keyboard geometry description includes a list of
<firstterm>key aliases</firstterm>
- (see <xref linkend="Symbolic_Names" />). Key aliases allow the keyboard layout designer to assign
+(see <xref linkend="Symbolic_Names" />). Key aliases allow the keyboard layout designer to assign
multiple key names to a single key.
</para>
<note><para>Key aliases defined in the geometry component of a keyboard mapping
@@ -144,14 +144,14 @@ are stored in the
<structname>XkbNamesRec</structname>
(<structfield>xkb-&gt;names</structfield>).
- Therefore, consider the key aliases defined by the geometry before
+Therefore, consider the key aliases defined by the geometry before
considering key aliases supplied by the keycodes.</para></note>
</listitem>
<listitem>
<para>
The top-level keyboard geometry description includes a list of
<structfield>shapes</structfield>;
- other keyboard components refer to shapes by their index in this list. A
+other keyboard components refer to shapes by their index in this list. A
shape consists of an arbitrary name of type Atom and one or more closed-polygon
<structfield>outlines</structfield>.
All points in an outline are specified relative to the origin of its
@@ -159,13 +159,13 @@ enclosing shape, that is, whichever shape that contains this outline in its
list of outlines. One outline is the primary outline. The primary outline is by
default the first outline, or it can be optionally specified by the
<structfield>primary</structfield>
- field in the
+field in the
<structname>XkbShapeRec</structname>
- structure. A keyboard display application can generate a simpler but still
+structure. A keyboard display application can generate a simpler but still
accurate keyboard image by displaying only the primary outlines for each shape.
Nonrectangular keys must include a rectangular
<firstterm>approximation</firstterm>
- as one of the outlines associated with the shape. The approximation is not
+as one of the outlines associated with the shape. The approximation is not
normally displayed but can be used by very simple keyboard display applications
to generate a recognizable but degraded image of the keyboard.
</para>
@@ -175,7 +175,7 @@ to generate a recognizable but degraded image of the keyboard.
<para>
The
<structname>XkbGeometryRec</structname>
- top-level geometry description contains the following information that
+top-level geometry description contains the following information that
pertains to the keyboard as a whole:
</para>
@@ -184,16 +184,16 @@ pertains to the keyboard as a whole:
<para>
A
<firstterm>keyboard symbolic name</firstterm>
- of type Atom to help users identify the keyboard.
+of type Atom to help users identify the keyboard.
</para>
</listitem>
<listitem>
<para>
The
<structfield>width</structfield>
- and
+and
<structfield>height</structfield>
- of the keyboard, in mm/10. For nonrectangular keyboards, the width and height
+of the keyboard, in mm/10. For nonrectangular keyboards, the width and height
describe the smallest bounding box that encloses the outline of the keyboard.
</para>
</listitem>
@@ -201,7 +201,7 @@ describe the smallest bounding box that encloses the outline of the keyboard.
<para>
The
<firstterm>base color</firstterm>
- of the keyboard is the predominant color on the keyboard and is used as the
+of the keyboard is the predominant color on the keyboard and is used as the
default color for any components whose color is not explicitly specified.
</para>
</listitem>
@@ -209,14 +209,14 @@ default color for any components whose color is not explicitly specified.
<para>
The
<firstterm>label color</firstterm>
- is the color used to draw the labels on most of the keyboard keys.
+is the color used to draw the labels on most of the keyboard keys.
</para>
</listitem>
<listitem>
<para>
The
<firstterm>label font</firstterm>
- is a string that describes the font used to draw labels on most keys; label
+is a string that describes the font used to draw labels on most keys; label
fonts are arbitrary strings, because Xkb does not specify the format or name
space for font names.
</para>
@@ -226,14 +226,14 @@ space for font names.
<para>
The keyboard is subdivided into named
<structfield>sections</structfield>
- of related keys and doodads. The sections and doodads on the keyboard are
+of related keys and doodads. The sections and doodads on the keyboard are
listed in the
<structname>XkbGeometryRec</structname>
- top-level keyboard geometry description. A section is composed of keys that
+top-level keyboard geometry description. A section is composed of keys that
are physically together and logically related. <link linkend="figure13.2">Figure 13.2</link> shows a keyboard
that is divided into four sections. A
<structfield>doodad</structfield>
- describes some visible aspect of the keyboard that is not a key and is not a
+describes some visible aspect of the keyboard that is not a key and is not a
section.
</para>
@@ -258,7 +258,7 @@ A
<structfield>shape</structfield>,
used to draw keyboard components and stored in a
<structname>XkbShapeRec</structname>
- structure, has:
+structure, has:
</para>
<itemizedlist>
@@ -294,7 +294,7 @@ An
<firstterm>outline</firstterm>,
stored in a
<structname>XkbOutlineRec</structname>
- structure, is a list of one or more points that describes a single
+structure, is a list of one or more points that describes a single
closed-polygon, as follows:
</para>
@@ -323,7 +323,7 @@ with the first.
<para>
A nonzero value for the
<structfield>corner_radius</structfield>
- field specifies that the corners of the polygon should be drawn as circles
+field specifies that the corners of the polygon should be drawn as circles
with the specified radius.
</para>
</listitem>
@@ -341,13 +341,13 @@ a simple but still accurate keyboard image by displaying only the primary
outlines for each shape. The default primary outline is the first in a
shape’s list of outlines. If the
<structfield>primary</structfield>
- field of the
+field of the
<structname>XkbShapeRec</structname>
- structure is not
+structure is not
<symbol>NULL</symbol>,
it points to the primary outline. A rectangular
<firstterm>approximation</firstterm>
- must be included for nonrectangular keys as one of the outlines associated
+must be included for nonrectangular keys as one of the outlines associated
with the shape; the approximation is not normally displayed but can be used by
very simple keyboard display applications to generate a recognizable but
degraded image of the keyboard.
@@ -360,7 +360,7 @@ degraded image of the keyboard.
<para>
As previously noted, a keyboard is subdivided into
<structfield>sections</structfield>
- of related keys. Each section has its own coordinate system — if a section
+of related keys. Each section has its own coordinate system — if a section
is rotated, the coordinates of any components within the section are
interpreted relative to the edges that were on the top and left before
rotation. The components that make up a section, stored in a
@@ -423,7 +423,7 @@ Rows in a Section</H5>
<para>
An optional list of
<structfield>doodads</structfield>;
- any type of doodad can be enclosed within a section. Position and angle of
+any type of doodad can be enclosed within a section. Position and angle of
rotation are relative to the origin and angle of rotation of the sections that
contain them. Priority for doodads in a section is relative to the other
components of the section, not to the keyboard as a whole.
@@ -433,7 +433,7 @@ components of the section, not to the keyboard as a whole.
<para>
An optional
<firstterm>overlay</firstterm>
- with a name of type Atom and a list of overlay rows (described below).
+with a name of type Atom and a list of overlay rows (described below).
</para>
</listitem>
<listitem>
@@ -450,7 +450,7 @@ containing the entire section.
<para>
A row description
(<structname>XkbRowRec</structname>)
- consists of the coordinates of its origin relative to its enclosing section,
+consists of the coordinates of its origin relative to its enclosing section,
a flag indicating whether the row is horizontal or vertical, and a list of keys
in the row.
</para>
@@ -459,12 +459,12 @@ in the row.
<para>
A key description
(<structname>XkbKeyRec</structname>)
- consists of a key name, a shape, a key color, and a gap. The key name should
+consists of a key name, a shape, a key color, and a gap. The key name should
correspond to one of the keys named in the keyboard names description, the
shape specifies the appearance of the key, and the key color specifies the
color of the key (not the label on the key; the label color is stored in the
<structname>XkbGeometryRec</structname>).
- Keys are normally drawn immediately adjacent to one another from left to
+Keys are normally drawn immediately adjacent to one another from left to
right (or top to bottom) within a row. The gap field specifies the distance
between a key and its predecessor.
</para>
@@ -485,7 +485,7 @@ outline of the entire keyboard.
<para>
Each doodad’s origin is stored in fields named
<structfield>left</structfield>
- and
+and
<structfield>top</structfield>,
which are the coordinates of the doodad’s origin relative to its enclosing
object, whether it be a section or the top-level keyboard. The priority for
@@ -495,7 +495,7 @@ top-level geometry. The priority for doodads listed in a section are relative
to the other components of the section. Each doodad is stored in a structure
with a
<structfield>type</structfield>
- field, which specifies the type of doodad.
+field, which specifies the type of doodad.
</para>
<para>
@@ -507,10 +507,10 @@ Xkb supports five types of doodads:
<para>
An
<firstterm>indicator doodad</firstterm>
- describes one of the physical keyboard indicators. Indicator doodads specify
+describes one of the physical keyboard indicators. Indicator doodads specify
the shape of the indicator, the indicator color when it is lit
(<emphasis>on_color</emphasis>)
- and the indicator color when it is dark
+and the indicator color when it is dark
(<emphasis>off_color</emphasis>).
</para>
@@ -519,7 +519,7 @@ the shape of the indicator, the indicator color when it is lit
<para>
An
<firstterm>outline doodad</firstterm>
- describes some aspect of the keyboard to be drawn as one or more hollow,
+describes some aspect of the keyboard to be drawn as one or more hollow,
closed polygons. Outline doodads specify the shape, color, and angle of
rotation about the doodad origin at which they should be drawn.
</para>
@@ -528,7 +528,7 @@ rotation about the doodad origin at which they should be drawn.
<para>
A
<firstterm>solid doodad</firstterm>
- describes some aspect of the keyboard to be drawn as one or more filled
+describes some aspect of the keyboard to be drawn as one or more filled
polygons. Solid doodads specify the shape, color, and angle of rotation about
the doodad origin at which they should be drawn.
</para>
@@ -537,7 +537,7 @@ the doodad origin at which they should be drawn.
<para>
A
<firstterm>text doodad</firstterm>
- describes a text label somewhere on the keyboard. Text doodads specify the
+describes a text label somewhere on the keyboard. Text doodads specify the
label string, the font and color to use when drawing the label, and the angle
of rotation of the doodad about its origin.
</para>
@@ -561,7 +561,7 @@ specify the interpretation of logo names.
<para>
The structures these doodads are stored in and the values of the
<structfield>type</structfield>
- fields are shown in <link linkend="table13.1">Table 13.1</link>.
+fields are shown in <link linkend="table13.1">Table 13.1</link>.
</para>
<table id='table13.1' frame='topbot'>
@@ -647,7 +647,7 @@ An
<firstterm>overlay row</firstterm>
(<structname>XkbOverlayRowRec</structname>)
- contains a pointer to the row it overlays and a list of
+contains a pointer to the row it overlays and a list of
<firstterm>overlay keys</firstterm>.
</para>
@@ -655,7 +655,7 @@ An
<para>
Each overlay key definition
(<structname>XkbOverlayKeyRec</structname>)
- indicates a key that can yield multiple keycodes and consists of a field
+indicates a key that can yield multiple keycodes and consists of a field
named
<structfield>under</structfield>,
which specifies the primary name of the key and a field named
@@ -663,7 +663,7 @@ which specifies the primary name of the key and a field named
which specifies the name for the key when the overlay keycode is selected.
The key specified in
<structfield>under</structfield>
- must be a member of the section that contains the overlay key definition,
+must be a member of the section that contains the overlay key definition,
while the key specified in over must not be.
</para>
@@ -784,13 +784,13 @@ typedef struct _XkbGeometry { /* top-level keyboard geometry structure */
<para>
The
<structfield>doodads</structfield>
- array is only for doodads not contained in any of the
+array is only for doodads not contained in any of the
<structfield>sections</structfield>
- that has its own
+that has its own
<structfield>doodads</structfield>.
The key aliases contained in the
<structfield>key_aliases</structfield>
- array take precedence over any defined in the keycodes component of the
+array take precedence over any defined in the keycodes component of the
keyboard description.
</para>
@@ -858,9 +858,9 @@ typedef struct _XkbShape {
<para>
If
<structfield>approx</structfield>
- and/or
+and/or
<structfield>primary</structfield>
- is
+is
<symbol>NULL</symbol>,
the default value is used. The default primary outline is the first element
in the outlines array, as is the default approximating outline.
@@ -892,9 +892,9 @@ typedef struct _XkbRow { /* row in a section */
<para>
<structfield>top</structfield>
- and
+and
<structfield>left</structfield>
- are in
+are in
<emphasis>mm</emphasis>
/
<emphasis>10</emphasis>.
@@ -923,12 +923,12 @@ typedef struct _XkbOverlayRow {
<para>
<structfield>row_under</structfield>
- is an index into the array of
+is an index into the array of
<structfield>rows</structfield>
- in the section under this overlay. The section under this overlay row is the
+in the section under this overlay. The section under this overlay row is the
one pointed to by
<structfield>section_under</structfield>
- in this overlay row’s
+in this overlay row’s
<structname>XkbOverlayRec</structname>.
</para>
@@ -965,18 +965,18 @@ typedef struct _XkbSection {
<para>
<structfield>top</structfield>
- and
+and
<structfield>left</structfield>
- are the origin of the section, relative to the origin of the keyboard, in
+are the origin of the section, relative to the origin of the keyboard, in
<emphasis>mm</emphasis>
/
<emphasis>10</emphasis>.
<structfield>angle</structfield>
- is in
+is in
<emphasis>1</emphasis>
/
<emphasis>10</emphasis>
- degrees.
+degrees.
</para>
<sect2 id='DoodadRec_Structures'>
@@ -985,9 +985,9 @@ typedef struct _XkbSection {
<para>
The doodad arrays in the
<structname>XkbGeometryRec</structname>
- and the
+and the
<structname>XkbSectionRec</structname>
- may contain any of the doodad structures and types shown in
+may contain any of the doodad structures and types shown in
<link linkend="table13.1">Table 13.1</link>.
</para>
@@ -1009,26 +1009,26 @@ typedef union _XkbDoodad {
<para>
The
<structfield>top</structfield>
- and
+and
<structfield>left</structfield>
- coordinates of each doodad are the coordinates of the origin of the doodad
+coordinates of each doodad are the coordinates of the origin of the doodad
relative to the keyboard’s origin if the doodad is in the
<structname>XkbGeometryRec</structname>
- doodad array, and with respect to the section’s origin if the doodad is in a
+doodad array, and with respect to the section’s origin if the doodad is in a
<structname>XkbSectionRec</structname>
- doodad array. The
+doodad array. The
<structfield>color_ndx</structfield>
- or
+or
<structfield>on_color_ndx</structfield>
- and
+and
<structfield>off_color_ndx</structfield>
- fields are color indices into the
+fields are color indices into the
<structname>XkbGeometryRec</structname>’s
- color array and are the colors to draw the doodads with. Similarly, the
+color array and are the colors to draw the doodads with. Similarly, the
<structfield>shape_ndx</structfield>
- fields are indices into the
+fields are indices into the
<structname>XkbGeometryRec</structname>’s
- shape array.
+shape array.
</para>
<para><programlisting>
@@ -1155,16 +1155,16 @@ To load a keyboard geometry if you already have the keyboard description, use
<para>
<function>XkbGetGeometry</function>
- can return
+can return
<errorname>BadValue</errorname>,
<errorname>BadImplementation</errorname>,
<errorname>BadName</errorname>,
<errorname>BadAlloc</errorname>,
- or
+or
<errorname>BadLength</errorname>
- errors or
+errors or
<symbol>Success</symbol>
- if it succeeds.
+if it succeeds.
</para>
<para>
@@ -1224,11 +1224,11 @@ description from this database by name, use
<para>
<function>XkbGetNamedGeometry</function>
- can return
+can return
<errorname>BadName</errorname>
- if the
+if the
<parameter>name</parameter>
- cannot be found.
+cannot be found.
</para>
</sect1>
@@ -1304,31 +1304,31 @@ To determine the bounding box of the top surface of a shape, use
<para>
<function>XkbComputeShapeTop</function>
- returns a
+returns a
<structname>BoundsRec</structname>
- that contains two x and y coordinates. These coordinates describe the corners
+that contains two x and y coordinates. These coordinates describe the corners
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
<structfield>approx</structfield>
- field of
+field of
<parameter>shape</parameter>
- is not
+is not
<symbol>NULL</symbol>.
If
<structfield>approx</structfield>
- is
+is
<symbol>NULL</symbol>,
the top surface is defined as the last outline in the
<parameter>shape</parameter>’s
- array of outlines.
+array of outlines.
<function>XkbComputeShapeTop</function>
- returns
+returns
<symbol>False</symbol>
- if
+if
<parameter>shape</parameter>
- is
+is
<symbol>NULL</symbol>
- or if there are no outlines for the shape; otherwise, it returns
+or if there are no outlines for the shape; otherwise, it returns
<symbol>True</symbol>.
</para>
@@ -1336,9 +1336,9 @@ the top surface is defined as the last outline in the
<para>
A
<structname>ShapeRec</structname>
- contains a
+contains a
<structname>BoundsRec</structname>
- that describes the bounds of the shape. If you add or delete an outline to or
+that describes the bounds of the shape. If you add or delete an outline to or
from a shape, the bounding box must be updated. To update the bounding box of a
shape, use <function>XkbComputeShapeBounds</function>.
</para>
@@ -1370,27 +1370,27 @@ shape, use <function>XkbComputeShapeBounds</function>.
<para>
<function>XkbComputeShapeBounds</function>
- updates the
+updates the
<structname>BoundsRec</structname>
- contained in the
+contained in the
<parameter>shape</parameter>
- by examining all the outlines of the shape and setting the
+by examining all the outlines of the shape and setting the
<structname>BoundsRec</structname>
- to the minimum x and minimum y, and maximum x and maximum y values found in
+to the minimum x and minimum y, and maximum x and maximum y values found in
those outlines.
<function>XkbComputeShapeBounds</function>
- returns
+returns
<symbol>False</symbol>
- if
+if
<parameter>shape</parameter>
- is
+is
<symbol>NULL</symbol>
- or if there are no outlines for the shape; otherwise, it returns
+or if there are no outlines for the shape; otherwise, it returns
<symbol>True</symbol>.
</para>
<para>
- If you add or delete a key to or from a row, or if you update the shape of one
+If you add or delete a key to or from a row, or if you update the shape of one
of the keys in that row, you may need to update the bounding box of that row.
To update the bounding box of a row, use <function>XkbComputeRowBounds</function>.
</para>
@@ -1445,20 +1445,20 @@ To update the bounding box of a row, use <function>XkbComputeRowBounds</function
<para>
<function>XkbComputeRowBounds</function>
- checks the bounds of all keys in the
+checks the bounds of all keys in the
<parameter>row</parameter>
and updates the bounding box of the row if necessary.
<function>XkbComputeRowBounds</function>
- returns
+returns
<symbol>False</symbol>
- if any of the arguments is
+if any of the arguments is
<symbol>NULL</symbol>;
- otherwise, it returns
+otherwise, it returns
<symbol>True</symbol>.
</para>
<para>
- If you add or delete a row to or from a section, or if you change the geometry
+If you add or delete a row to or from a section, or if you change the geometry
of any of the rows in that section, you may need to update the bounding box for
that section. To update the bounding box of a section, use
<function>XkbComputeSectionBounds</function>.
@@ -1502,15 +1502,15 @@ that section. To update the bounding box of a section, use
<para>
<function>XkbComputeSectionBounds</function>
- examines all the rows of the
+examines all the rows of the
<parameter>section</parameter>
- and updates the bounding box of that section so that it contains all rows.
+and updates the bounding box of that section so that it contains all rows.
<function>XkbComputeSectionBounds</function>
- returns
+returns
<symbol>False</symbol>
- if any of the arguments is
+if any of the arguments is
<symbol>NULL</symbol>;
- otherwise, it returns
+otherwise, it returns
<symbol>True</symbol>.
</para>
@@ -1571,7 +1571,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,
+uses the primary name of the key,
<parameter>under</parameter>,
to look up the alternate name, which it returns.
</para>
@@ -1585,10 +1585,10 @@ to look up the alternate name, which it returns.
Xkb provides functions to add a single new element to the top-level keyboard
geometry. In each case the
<structfield>num_<replaceable>*</replaceable></structfield>
- fields of the corresponding structure is incremented by 1. These functions do
+fields of the corresponding structure is incremented by 1. These functions do
not change
<structfield>sz_<replaceable>*</replaceable></structfield>
- unless there is no more room in the array. Some of these functions fill in the
+unless there is no more room in the array. Some of these functions fill in the
values of the element’s structure from the arguments. For other functions,
you must explicitly write code to fill the structure’s elements.
</para>
@@ -1659,15 +1659,15 @@ To add one property to an existing keyboard geometry description, use
<para>
<function>XkbAddGeomProperty</function>
- adds one property with the specified
+adds one property with the specified
<parameter>name</parameter>
- and
+and
<parameter>value</parameter>
- to the keyboard geometry specified by geom.
+to the keyboard geometry specified by geom.
<function>XkbAddGeomProperty</function>
- returns
+returns
<symbol>NULL</symbol>
- if any of the parameters is empty or if it was not able to allocate space for
+if any of the parameters is empty or if it was not able to allocate space for
the property. To allocate space for an arbitrary number of properties, use the
XkbAllocGeomProps function.
</para>
@@ -1728,12 +1728,12 @@ To add one key alias to an existing keyboard geometry description, use
<para>
<function>XkbAddGeomKeyAlias</function>
- adds one key alias with the value alias to the geometry geom, and associates
+adds one key alias with the value alias to the geometry geom, and associates
it with the key whose real name is real.
<function>XkbAddGeomKeyAlias</function>
- returns
+returns
<symbol>NULL</symbol>
- if any of the parameters is empty or if it was not able to allocate space for
+if any of the parameters is empty or if it was not able to allocate space for
the alias. To allocate space for an arbitrary number of aliases, use the
XkbAllocGeomKeyAliases function.
</para>
@@ -1795,30 +1795,30 @@ To add one color name to an existing keyboard geometry description, use
<para>
<function>XkbAddGeomColor</function>
- adds the specified color
+adds the specified color
<structfield>name</structfield>
- and
+and
<parameter>pixel</parameter>
- to the specified geometry
+to the specified geometry
<parameter>geom</parameter>.
The top-level geometry description includes a list of up to
<emphasis>MaxColors</emphasis>
- (32)
+(32)
<emphasis>color names</emphasis>.
A color
<structfield>name</structfield>
- is a string whose interpretation is not specified by Xkb and neither is the
+is a string whose interpretation is not specified by Xkb and neither is the
<parameter>pixel</parameter>
- value’s interpretation. All other geometry data structures refer to colors
+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>
- returns
+returns
<symbol>NULL</symbol>
- if any of the parameters is empty or if it was not able to allocate space for
+if any of the parameters is empty or if it was not able to allocate space for
the color. To allocate space for an arbitrary number of colors to a geometry,
use the
<function>XkbAllocGeomColors</function>
- function.
+function.
</para>
<para>
@@ -1865,15 +1865,15 @@ To add one outline to an existing shape, use
<para>
An outline consists of an arbitrary number of points.
<function>XkbAddGeomOutline</function>
- adds an outline to the specified
+adds an outline to the specified
<parameter>shape</parameter>
- by reserving
+by reserving
<parameter>sz_points</parameter>
- points for it. The new outline is allocated and zeroed.
+points for it. The new outline is allocated and zeroed.
<function>XkbAddGeomOutline</function>
- returns
+returns
<symbol>NULL</symbol>
- if any of the parameters is empty or if it was not able to allocate space. To
+if any of the parameters is empty or if it was not able to allocate space. To
allocate space for an arbitrary number of outlines to a shape, use
XkbAllocGeomOutlines.
</para>
@@ -1937,17 +1937,17 @@ To add a shape to a keyboard geometry, use
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
+adds a shape to a geometry
<parameter>geom</parameter>
- by allocating space for
+by allocating space for
<parameter>sz_outlines</parameter>
- outlines for it and giving it the name specified by name. If a shape with name
+outlines for it and giving it the name specified by name. If a shape with name
<parameter>name</parameter>
- already exists in the geometry, a pointer to the existing shape is returned.
+already exists in the geometry, a pointer to the existing shape is returned.
<function>XkbAddGeomShape</function>
- returns
+returns
<symbol>NULL</symbol>
- if any of the parameters is empty or if it was not able to allocate space. To
+if any of the parameters is empty or if it was not able to allocate space. To
allocate space for an arbitrary number of geometry shapes, use
<function>XkbAllocGeomShapes</function>.
</para>
@@ -1986,15 +1986,15 @@ To add one key at the end of an existing row of keys, use
<para>
Keys are grouped into rows.
<function>XkbAddGeomKey</function>
- adds one key to the end of the specified
+adds one key to the end of the specified
<parameter>row</parameter>.
The key is allocated and zeroed.
<function>XkbAddGeomKey</function>
- returns
+returns
<symbol>NULL</symbol>
- if
+if
<parameter>row</parameter>
- is empty or if it was not able to allocate space for the key. To allocate
+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>
@@ -2080,7 +2080,7 @@ To add one section to an existing keyboard geometry, use
<para>
A keyboard geometry contains an arbitrary number of sections.
<function>XkbAddGeomSection</function>
- adds one section to an existing keyboard geometry
+adds one section to an existing keyboard geometry
<parameter>geom</parameter>.
The new section contains space for the number of rows, doodads, and overlays
specified by
@@ -2092,12 +2092,12 @@ The new section is allocated and zeroed and given the name specified by
<parameter>name</parameter>.
If a section with name
<parameter>name</parameter>
- already exists in the geometry, a pointer to the existing section is
+already exists in the geometry, a pointer to the existing section is
returned.
<function>XkbAddGeomSection</function>
- returns
+returns
<symbol>NULL</symbol>
- if any of the parameters is empty or if it was not able to allocate space for
+if any of the parameters is empty or if it was not able to allocate space for
the section. To allocate space for an arbitrary number of sections to a
geometry, use XkbAllocGeomSections.
</para>
@@ -2149,15 +2149,15 @@ To add a row to a section, use
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
+adds one row to the specified
<parameter>section</parameter>.
The newly created row contains space for the number of keys specified in
<parameter>sz_keys</parameter>.
They are allocated and zeroed, but otherwise uninitialized.
<function>XkbAddGeomRow</function>
- returns
+returns
<symbol>NULL</symbol>
- if any of the parameters is empty or if it was not able to allocate space for
+if any of the parameters is empty or if it was not able to allocate space for
the row. To allocate space for an arbitrary number of rows to a section, use
the XkbAllocGeomRows function.
</para>
@@ -2221,32 +2221,32 @@ geometry, use
<para>
A
<structfield>doodad</structfield>
- describes some visible aspect of the keyboard that is not a key and is not a
+describes some visible aspect of the keyboard that is not a key and is not a
section.
<function>XkbAddGeomDoodad</function>
- adds a doodad with name specified by name to the geometry
+adds a doodad with name specified by name to the geometry
<parameter>geom</parameter>
- if section is
+if section is
<symbol>NULL</symbol>
- or to the section of the geometry specified by section if
+or to the section of the geometry specified by section if
<parameter>section</parameter>
- is not
+is not
<symbol>NULL</symbol>.
<function>XkbAddGeomDoodad</function>
- returns
+returns
<symbol>NULL</symbol>
- if any of the parameters is empty or if it was not able to allocate space for
+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
<parameter>name</parameter>
- in the doodad array for the geometry (if
+in the doodad array for the geometry (if
<parameter>section</parameter>
- is
+is
<symbol>NULL</symbol>)
- or the section (if
+or the section (if
<parameter>section</parameter>
- is non-
+is non-
<symbol>NULL</symbol>),
- a pointer to that doodad is returned. To allocate space for an arbitrary
+a pointer to that doodad is returned. To allocate space for an arbitrary
number of doodads to a section, use the XkbAllocGeomSectionDoodads function. To
allocate space for an arbitrary number of doodads to a keyboard geometry, use
the XkbAllocGeomDoodads function.
@@ -2309,17 +2309,17 @@ To add one overlay to a section, use
<para>
<function>XkbAddGeomOverlay</function>
- adds an overlay with the specified name to the specified
+adds an overlay with the specified name to the specified
<parameter>section</parameter>.
The new overlay is created with space allocated for sz_rows rows. If an
overlay with name
<parameter>name</parameter>
- already exists in the section, a pointer to the existing overlay is
+already exists in the section, a pointer to the existing overlay is
returned.
<function>XkbAddGeomOverlay</function>
- returns
+returns
<symbol>NULL</symbol>
- if any of the parameters is empty or if it was not able to allocate space for
+if any of the parameters is empty or if it was not able to allocate space for
the overlay. To allocate space for an arbitrary number of overlays to a
section, use the XkbAllocGeomOverlay function.
</para>
@@ -2381,21 +2381,21 @@ To add a row to an existing overlay, use
<para>
<function>XkbAddGeomOverlayRow</function>
- adds one row to the
+adds one row to the
<parameter>overlay</parameter>.
The new row contains space for
<parameter>sz_keys</parameter>
- keys. If
+keys. If
<parameter>row_under</parameter>
- specifies a row that doesn’t exist on the underlying section,
+specifies a row that doesn’t exist on the underlying section,
<function>XkbAddGeomOverlayRow</function>
- returns
+returns
<symbol>NULL</symbol>
- and doesn’t change the overlay.
+and doesn’t change the overlay.
<function>XkbAddGeomOverlayRow</function>
- returns
+returns
<symbol>NULL</symbol>
- if any of the parameters is empty or if it was not able to allocate space for
+if any of the parameters is empty or if it was not able to allocate space for
the overlay.
</para>
@@ -2455,15 +2455,15 @@ To add a key to an existing overlay row, use
<para>
<function>XkbAddGeomOverlayKey</function>
- adds one key to the
+adds one key to the
<parameter>row</parameter>
- in the
+in the
<parameter>overlay</parameter>.
If there is no key named
<parameter>under</parameter>
- in the row of the underlying section,
+in the row of the underlying section,
<function>XkbAddGeomOverlayKey</function>
- returns
+returns
<symbol>NULL</symbol>.
</para>
@@ -2479,19 +2479,19 @@ Note that these functions merely allocate space for the new element(s), and it
is up to you to fill in the values explicitly in your code. These allocation
functions increase
<structfield>sz_<replaceable>*</replaceable></structfield>
- but never touch
+but never touch
<structfield>num_<replaceable>*</replaceable></structfield>
- (unless there is an allocation failure, in which case they reset both
+(unless there is an allocation failure, in which case they reset both
<structfield>sz_<replaceable>*</replaceable></structfield>
- and
+and
<structfield>num_<replaceable>*</replaceable></structfield>
- to zero). These functions return
+to zero). These functions return
<symbol>Success</symbol>
- if they succeed,
+if they succeed,
<errorname>BadAlloc</errorname>
- if they are not able to allocate space, or
+if they are not able to allocate space, or
<errorname>BadValue</errorname>
- if a parameter is not as expected.
+if a parameter is not as expected.
</para>
@@ -2538,9 +2538,9 @@ XkbAllocGeomOutlines.
<para>
<function>XkbAllocGeomOutlines</function>
- allocates space for
+allocates space for
<parameter>num_needed</parameter>
- outlines in the specified
+outlines in the specified
<parameter>shape</parameter>.
The outlines are not initialized.
</para>
@@ -2664,7 +2664,7 @@ XkbAllocGeomKeys.
<para>
<function>XkbAllocGeomKeys</function>
- allocates num_needed keys and adds them to the row. No initialization of the
+allocates num_needed keys and adds them to the row. No initialization of the
keys is done.
</para>
@@ -2787,7 +2787,7 @@ To allocate geometry properties, use
<para>
<function>XkbAllocGeomProps</function>
- allocates space for num_needed properties and adds them to the specified
+allocates space for num_needed properties and adds them to the specified
geometry
<parameter>geom</parameter>.
No initialization of the properties is done. A geometry property associates
@@ -2916,7 +2916,7 @@ To allocate geometry key aliases, use
<para>
<function>XkbAllocGeomKeyAliases</function>
- allocates space for num_needed key aliases and adds them to the specified
+allocates space for num_needed key aliases and adds them to the specified
geometry
<parameter>geom</parameter>.
A key alias is a pair of strings that associates an alternate name for a key
@@ -2995,10 +2995,10 @@ If free_all is
<symbol>True</symbol>,
all aliases in the top level of the specified geometry
<parameter>geom</parameter>
- are freed regardless of the value of first or count. Otherwise, count aliases
+are freed regardless of the value of first or count. Otherwise, count aliases
in
<parameter>geom</parameter>
- are freed beginning with the one specified by first.
+are freed beginning with the one specified by first.
</para>
@@ -3046,7 +3046,7 @@ To allocate geometry colors, use
<para>
<function>XkbAllocGeomColors</function>
- allocates space for num_needed colors and adds them to the specified geometry
+allocates space for num_needed colors and adds them to the specified geometry
<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
@@ -3172,9 +3172,9 @@ To allocate points in an outline, use
<para>
<function>XkbAllocGeomPoints</function>
- allocates space for
+allocates space for
<parameter>num_needed</parameter>
- points in the specified
+points in the specified
<parameter>outline</parameter>.
The points are not initialized.
</para>
@@ -3299,9 +3299,9 @@ To allocate space for an arbitrary number of geometry shapes, use
<para>
<function>XkbAllocGeomShapes</function>
- allocates space for
+allocates space for
<parameter>num_needed</parameter>
- shapes in the specified geometry
+shapes in the specified geometry
<parameter>geom</parameter>.
The shapes are not initialized.
</para>
@@ -3426,7 +3426,7 @@ To allocate geometry sections, use
<para>
<function>XkbAllocGeomSections</function>
- allocates num_needed sections and adds them to the geometry geom. No
+allocates num_needed sections and adds them to the geometry geom. No
initialization of the sections is done.
</para>
@@ -3550,7 +3550,7 @@ To allocate rows in a section, use
<para>
<function>XkbAllocGeomRows</function>
- allocates num_needed rows and adds them to the section. No initialization of
+allocates num_needed rows and adds them to the section. No initialization of
the rows is done.
</para>
@@ -3674,7 +3674,7 @@ To allocate overlays in a section, use
<para>
<function>XkbAllocGeomRows</function>
- allocates num_needed overlays and adds them to the section. No initialization
+allocates num_needed overlays and adds them to the section. No initialization
of the overlays is done.
</para>
@@ -3798,7 +3798,7 @@ To allocate rows in a overlay, use
<para>
<function>XkbAllocGeomOverlayRows</function>
- allocates num_needed rows and adds them to the overlay. No initialization of
+allocates num_needed rows and adds them to the overlay. No initialization of
the rows is done.
</para>
@@ -3922,7 +3922,7 @@ To allocate keys in an overlay row, use
<para>
<function>XkbAllocGeomOverlayKeys</function>
- allocates num_needed keys and adds them to the row. No initialization of the
+allocates num_needed keys and adds them to the row. No initialization of the
keys is done.
</para>
@@ -4046,7 +4046,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
+allocates num_needed doodads and adds them to the specified geometry
<parameter>geom</parameter>.
No initialization of the doodads is done.
</para>
@@ -4096,7 +4096,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
+allocates num_needed doodads and adds them to the specified
<parameter>section</parameter>.
No initialization of the doodads is done.
</para>
@@ -4159,7 +4159,7 @@ To free geometry doodads, use
<para>
If
<parameter>free_all</parameter>
- is
+is
<symbol>True</symbol>,
all doodads in the array are freed, regardless of the value of count.
Otherwise, count doodads are freed.
@@ -4210,7 +4210,7 @@ To allocate an entire geometry, use
<para>
<function>XkbAllocGeometry</function>
- allocates a keyboard geometry and adds it to the keyboard description
+allocates a keyboard geometry and adds it to the keyboard description
specified by xkb. The keyboard description should be obtained via the
XkbGetKeyboard or XkbAllockeyboard functions. The sizes parameter specifies the
number of elements to be reserved for the subcomponents of the keyboard
diff --git a/specs/XKB/ch14.xml b/specs/XKB/ch14.xml
index a92ae225..cb30105c 100644
--- a/specs/XKB/ch14.xml
+++ b/specs/XKB/ch14.xml
@@ -52,9 +52,9 @@ For detailed information on particular components of the keyboard map, refer to
The graphic characters or control functions that may be accessed by one key are
logically arranged in groups and levels, where
<structfield>group</structfield>
- and
+and
<structfield>level</structfield>
- are defined as in the ISO9995 standard:
+are defined as in the ISO9995 standard:
</para>
<variablelist>
@@ -96,12 +96,12 @@ Levels are numbered sequentially starting at one.
<note><para>Shift level is derived from the modifier state, but not necessarily
in the same way for all keys. For example, the
<symbol>Shift</symbol>
- modifier selects shift level 2 on most keys, but for keypad keys the modifier
+modifier selects shift level 2 on most keys, but for keypad keys the modifier
bound to
<keysym>Num_Lock</keysym>
- (that is, the
+(that is, the
<emphasis>NumLock</emphasis>
- virtual modifier) also selects shift level 2.</para></note>
+virtual modifier) also selects shift level 2.</para></note>
<para>
For example, consider the following key (the gray characters indicate symbols
@@ -142,25 +142,25 @@ The standard interpretation rules for the core X keymap only allow clients to
access keys such as the one shown in <link linkend="figure14.1">Figure 14.1</link>. That is, clients using the
standard interpretation rules can only access one of four keysyms for any given
<symbol>KeyPress</symbol>
- event — two different symbols in two different groups.
+event — two different symbols in two different groups.
</para>
<para>
In general, the
<symbol>Shift</symbol>
- modifier, the
+modifier, the
<symbol>Lock</symbol>
- modifier, and the modifier bound to the
+modifier, and the modifier bound to the
<keysym>Num_Lock</keysym>
- key are used to change between shift level 1 and shift level 2. To switch
+key are used to change between shift level 1 and shift level 2. To switch
between groups, the core implementation uses the modifier bound to the
<keysym>Mode_switch</keysym>
- key. When the
+key. When the
<keysym>Mode_switch</keysym>
- modifier is set, the keyboard is logically in Group 2. When the
+modifier is set, the keyboard is logically in Group 2. When the
<keysym>Mode_switch</keysym>
- modifier is not set, the keyboard is logically in Group 1.
+modifier is not set, the keyboard is logically in Group 1.
</para>
@@ -168,9 +168,9 @@ between groups, the core implementation uses the modifier bound to the
The core implementation does not clearly specify the behavior of keys. For
example, the locking behavior of the
<emphasis>CapsLock</emphasis>
- and
+and
<keysym>Num_Lock</keysym>
- keys depends on the vendor.
+keys depends on the vendor.
</para>
@@ -209,7 +209,7 @@ type and specifies the modifier combinations necessary to access each level.
<para>
For example, Xkb allows key types where the
<symbol>Control</symbol>
- modifier can be used to access the shift level two of a key. Key types are in
+modifier can be used to access the shift level two of a key. Key types are in
the client map component and are described in detail in <link linkend="Key_Types">section 15.2</link>.
</para>
@@ -232,35 +232,35 @@ server. The first function,
<function>XkbGetMap</function>,
allocates an
<structname>XkbDescRec</structname>
- structure, retrieves mapping components from the server, and stores them in
+structure, retrieves mapping components from the server, and stores them in
the
<structname>XkbDescRec</structname>
- structure it just allocated. The second function,
+structure it just allocated. The second function,
<function>XkbGetUpdatedMap</function>,
retrieves mapping components from the server and stores them in an
<structname>XkbDescRec</structname>
- structure that has previously been allocated.
+structure that has previously been allocated.
</para>
<para>
To allocate an
<structname>XkbDescRec</structname>
- structure and populate it with the server’s keyboard client map and server
+structure and populate it with the server’s keyboard client map and server
map, use
<function>XkbGetMap</function>.
<function>XkbGetMap</function>
is similar to
<function>XkbGetKeyboard</function>
- (see <link linkend="Obtaining_a_Keyboard_Description_from_the_Server">section 6.2</link>), but is used only for obtaining the address of an
+(see <link linkend="Obtaining_a_Keyboard_Description_from_the_Server">section 6.2</link>), but is used only for obtaining the address of an
<structname>XkbDescRec</structname>
- structure that is populated with keyboard mapping components. It allows finer
+structure that is populated with keyboard mapping components. It allows finer
control over which substructures of the keyboard mapping components are to be
populated.
<function>XkbGetKeyboard</function>
- always returns fully populated components, while
+always returns fully populated components, while
<function>XkbGetMap</function>
- can be instructed to return a partially populated component.
+can be instructed to return a partially populated component.
</para>
<indexterm significance="preferred" zone="XkbGetMap"><primary><function>XkbGetMap</function></primary></indexterm>
@@ -312,51 +312,51 @@ populated.
<para>
The
<parameter>which</parameter>
- mask is a bitwise inclusive OR of the masks defined in
+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
<parameter>which</parameter>
- are allocated and populated.
+are allocated and populated.
</para>
<para>
In addition to allocating and obtaining the server map and the client map,
<function>XkbGetMap</function>
- also sets the
+also sets the
<parameter>device_spec</parameter>,
the
<structfield>min_key_code</structfield>,
and
<structfield>max_key_code</structfield>
- fields of the keyboard description.
+fields of the keyboard description.
</para>
<para>
<function>XkbGetMap</function>
- is synchronous; it queries the server for the desired information, waits for a
+is synchronous; it queries the server for the desired information, waits for a
reply, and then returns. If successful,
<function>XkbGetMap</function>
- returns a pointer to the
+returns a pointer to the
<structname>XkbDescRec</structname>
- structure it allocated. If unsuccessful,
+structure it allocated. If unsuccessful,
<function>XkbGetMap</function>
- returns
+returns
<symbol>NULL</symbol>.
When unsuccessful, one of the following protocol errors is also generated:
<errorname>BadAlloc</errorname>
- (unable to allocate the
+(unable to allocate the
<structname>XkbDescRec</structname>
- structure),
+structure),
<errorname>BadValue</errorname>
- (some mask bits in
+(some mask bits in
<parameter>which</parameter>
- are undefined),
+are undefined),
or
<errorname>BadImplementation</errorname>
- (a compatible version of the Xkb extension is not available in the server). To
+(a compatible version of the Xkb extension is not available in the server). To
free the returned data, use
<function>XkbFreeClientMap</function>.
</para>
@@ -561,42 +561,42 @@ description, use <function>XkbGetUpdatedMap</function>.
<para>
The
<parameter>which</parameter>
- parameter is a bitwise inclusive OR of the masks in
+parameter is a bitwise inclusive OR of the masks in
<link linkend="table14.1">Table 14.1</link>.
If the needed components of the
<parameter>xkb</parameter>
- structure are not already allocated,
+structure are not already allocated,
<function>XkbGetUpdatedMap</function>
- allocates them.
+allocates them.
<function>XkbGetUpdatedMap</function>
- fetches the requested information for the device specified in the
+fetches the requested information for the device specified in the
<structname>XkbDescRec</structname>
- passed in the
+passed in the
<parameter>xkb</parameter>
- parameter.
+parameter.
</para>
<para>
<function>XkbGetUpdatedMap</function>
- is synchronous; it queries the server for the desired information, waits for a
+is synchronous; it queries the server for the desired information, waits for a
reply, and then returns. If successful,
<function>XkbGetUpdatedMap</function>
- returns
+returns
<symbol>Success</symbol>.
If unsuccessful,
<function>XkbGetUpdatedMap</function>
- returns one of the following:
+returns one of the following:
<errorname>BadAlloc</errorname>
- (unable to allocate a component in the
+(unable to allocate a component in the
<structname>XkbDescRec</structname>
- structure),
+structure),
<errorname>BadValue</errorname>
- (some mask bits in
+(some mask bits in
<parameter>which</parameter>
- are undefined),
+are undefined),
<errorname>BadImplementation</errorname>
- (a compatible version of the Xkb extension is not available in the server or
+(a compatible version of the Xkb extension is not available in the server or
the reply from the server was invalid).
</para>
@@ -608,10 +608,10 @@ the reply from the server was invalid).
There are two ways to make changes to map components: either change a local
copy of the keyboard map and call
<function>XkbSetMap</function>
- to send the modified map to the server, or, to reduce network traffic, use
+to send the modified map to the server, or, to reduce network traffic, use
an
<structname>XkbMapChangesRec</structname>
- structure and call <function>XkbChangeMap</function>.
+structure and call <function>XkbChangeMap</function>.
</para>
<indexterm significance="preferred" zone="XkbSetMap"><primary><function>XkbSetMap</function></primary></indexterm>
@@ -665,44 +665,44 @@ an
<para>
Use
<function>XkbSetMap</function>
- to send a complete new set of values for entire components (for example, all
+to send a complete new set of values for entire components (for example, all
symbols, all actions, and so on) to the server. The
<parameter>which</parameter>
- parameter specifies the components to be sent to the server, and is a bitwise
+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
<parameter>xkb</parameter>
- parameter is a pointer to an
+parameter is a pointer to an
<structname>XkbDescRec</structname>
- structure and contains the information to be copied to the server. For each
+structure and contains the information to be copied to the server. For each
bit set in the
<parameter>which</parameter>
- parameter,
+parameter,
<function>XkbSetMap</function>
- takes the corresponding structure values from the
+takes the corresponding structure values from the
<parameter>xkb</parameter>
- parameter and sends it to the server specified by
+parameter and sends it to the server specified by
<parameter>dpy</parameter>.
</para>
<para>
If any components specified by
<parameter>which</parameter>
- are not present in the
+are not present in the
<parameter>xkb</parameter>
- parameter,
+parameter,
<function>XkbSetMap</function>
- returns
+returns
<symbol>False</symbol>.
Otherwise, it sends the update request to the server and returns
<symbol>True</symbol>.
<function>XkbSetMap</function>
- can generate
+can generate
<errorname>BadAlloc</errorname>,
<errorname>BadLength</errorname>,
and
<errorname>BadValue</errorname>
- protocol errors.
+protocol errors.
</para>
@@ -723,7 +723,7 @@ helper functions and provides a pointer to where they are defined.
<para>
Use the
<structname>XkbMapChangesRec</structname>
- structure to identify and track partial modifications to the mapping
+structure to identify and track partial modifications to the mapping
components and to reduce the amount of traffic between the server and clients.
</para>
@@ -771,20 +771,20 @@ typedef struct _XkbMapChanges {
<para>
The
<structfield>changed</structfield>
- field identifies the map components that have changed in an
+field identifies the map components that have changed in an
<structname>XkbDescRec</structname>
- structure and may contain any of the bits in
+structure and may contain any of the bits in
<link linkend="table14.1">Table 14.1</link>, which are also shown
in <link linkend="table14.2">Table 14.2</link>. Every 1 bit in
<structfield>changed</structfield>
- also identifies which other fields in the
+also identifies which other fields in the
<structname>XkbMapChangesRec</structname>
- structure contain valid values, as indicated in
+structure contain valid values, as indicated in
<link linkend="table14.2">Table 14.2</link>. The
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- fields are for reference only; they are ignored on any requests sent to the
+fields are for reference only; they are ignored on any requests sent to the
server and are always updated by the server whenever it returns the data for an
<structname>XkbMapChangesRec</structname>.
</para>
@@ -895,9 +895,9 @@ To update only partial components of a keyboard description, modify the
appropriate fields in the server and map components of a local copy of the
keyboard description, then call
<function>XkbChangeMap</function>
- with an
+with an
<structname>XkbMapChangesRec</structname>
- structure indicating which components have changed.
+structure indicating which components have changed.
</para>
<indexterm significance="preferred" zone="XkbChangeMap"><primary><function>XkbChangeMap</function></primary></indexterm>
@@ -950,9 +950,9 @@ keyboard description, then call
<para>
<function>XkbChangeMap</function>
- copies any components specified by the
+copies any components specified by the
<parameter>changes</parameter>
- structure from the keyboard description,
+structure from the keyboard description,
<parameter>xkb</parameter>,
to the X server specified by
<parameter>dpy</parameter>.
@@ -962,11 +962,11 @@ to the X server specified by
<para>
If any components specified by
<parameter>changes</parameter>
- are not present in the
+are not present in the
<parameter>xkb</parameter>
- parameter,
+parameter,
<function>XkbChangeMap</function>
- returns
+returns
<symbol>False</symbol>.
Otherwise, it sends a request to the server and returns
<symbol>True</symbol>.
@@ -975,12 +975,12 @@ Otherwise, it sends a request to the server and returns
<para>
<function>XkbChangeMap</function>
- can generate
+can generate
<errorname>BadAlloc</errorname>,
<errorname>BadLength</errorname>,
and
<errorname>BadValue</errorname>
- protocol errors.
+protocol errors.
</para>
@@ -997,7 +997,7 @@ and
<para>
The Xkb extension reports
<symbol>XkbMapNotify</symbol>
- events to clients wanting notification whenever a map component of the Xkb
+events to clients wanting notification whenever a map component of the Xkb
description for a device changes. There are many different types of Xkb
keyboard map changes. Xkb uses an event detail mask to identify each type of
change. The event detail masks are identical to the masks listed in
@@ -1008,13 +1008,13 @@ change. The event detail masks are identical to the masks listed in
<para>
To receive
<symbol>XkbMapNotify</symbol>
- events under all possible conditions, use
+events under all possible conditions, use
<function>XkbSelectEvents</function>
- (see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
+(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
<symbol>XkbMapNotifyMask</symbol>
- in both
+in both
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>.
</para>
@@ -1022,24 +1022,24 @@ To receive
<para>
To receive
<symbol>XkbMapNotify</symbol>
- events only under certain conditions, use
+events only under certain conditions, use
<function>XkbSelectEventDetails</function>
- using
+using
<symbol>XkbMapNotify</symbol>
- as the
+as the
<structfield>event_type</structfield>
- and specifying the desired map changes in
+and specifying the desired map changes in
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>
- using mask bits from <link linkend="table14.1">Table 14.1</link>.
+using mask bits from <link linkend="table14.1">Table 14.1</link>.
</para>
<para>
The structure for
<symbol>XkbMapNotify</symbol>
- events is:
+events is:
<programlisting>
typedef struct {
@@ -1075,16 +1075,16 @@ typedef struct {
<para>
The
<structfield>changed</structfield>
- field specifies the map components that have changed and is the bitwise
+field specifies the map components that have changed and is the bitwise
inclusive OR of the mask bits defined in
<link linkend="table14.1">Table 14.1</link>. The other fields in this
event are interpreted as the like-named fields in an
<structname>XkbMapChangesRec</structname>
- (see <link linkend="The_XkbMapChangesRec_Structure">section 14.3.1</link>). The
+(see <link linkend="The_XkbMapChangesRec_Structure">section 14.3.1</link>). The
<structname>XkbMapNotifyEvent</structname>
- structure also has an additional
+structure also has an additional
<structfield>resized</structfield>
- field that is reserved for future use.
+field that is reserved for future use.
</para>
@@ -1095,7 +1095,7 @@ event are interpreted as the like-named fields in an
<para>
Calling
<function>XkbGetMap</function>
- (see <link linkend="Getting_Map_Components_from_the_Server">section 14.2</link>) should be sufficient for most applications to get client
+(see <link linkend="Getting_Map_Components_from_the_Server">section 14.2</link>) should be sufficient for most applications to get client
and server maps. As a result, most applications do not need to directly
allocate client and server maps.
</para>
@@ -1106,11 +1106,11 @@ If you change the number of key types or construct map components without
loading the necessary components from the X server, do not allocate any map
components directly using
<function>malloc</function>
- or
+or
<function>Xmalloc</function>.
Instead, use the Xkb allocators,
<function>XkbAllocClientMap</function>,
- and
+and
<function>XkbAllocServerMap</function>.
</para>
@@ -1118,11 +1118,11 @@ Instead, use the Xkb allocators,
<para>
Similarly, use the Xkb destructors,
<function>XkbFreeClientMap</function>,
- and
+and
<function>XkbFreeServerMap</function>
- instead of
+instead of
<function>free</function>
- or
+or
<function>Xfree</function>.
</para>
@@ -1183,13 +1183,13 @@ To allocate and initialize an empty client map description record, use
<para>
<function>XkbAllocClientMap</function>
- allocates and initializes an empty client map in the
+allocates and initializes an empty client map in the
<structfield>map</structfield>
- field of the keyboard description specified by
+field of the keyboard description specified by
<parameter>xkb</parameter>.
The
<parameter>which</parameter>
- parameter specifies the particular components of the client map structure to
+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>.
</para>
@@ -1214,11 +1214,11 @@ The
<parameter>type_count</parameter>
field specifies the number of entries to preallocate for the
<structfield>types</structfield>
- field of the client map. If the
+field of the client map. If the
<parameter>type_count</parameter>
field is less than
<symbol>XkbNumRequiredTypes</symbol>
- (see <link linkend="The_Canonical_Key_Types">section 15.2.1</link>), returns
+(see <link linkend="The_Canonical_Key_Types">section 15.2.1</link>), returns
<errorname>BadValue</errorname>.
</entry>
</row>
@@ -1227,20 +1227,20 @@ field is less than
<entry>
The
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- fields of the
+fields of the
<parameter>xkb</parameter>
- parameter are used to allocate the
+parameter are used to allocate the
<structfield>syms</structfield>
- and
+and
<structfield>key_sym_map</structfield>
- fields of the client map. The fields are allocated to contain the maximum
+fields of the client map. The fields are allocated to contain the maximum
number of entries necessary for
<structfield>max_key_code</structfield>
- &minus;
+&minus;
<structfield>min_key_code</structfield>
- + 1 keys.
++ 1 keys.
</entry>
</row>
<row>
@@ -1248,18 +1248,18 @@ number of entries necessary for
<entry>
The
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- fields of the
+fields of the
<parameter>xkb</parameter>
- parameter are used to allocate the
+parameter are used to allocate the
<structfield>modmap</structfield>
- field of the client map. The field is allocated to contain the maximum number
+field of the client map. The field is allocated to contain the maximum number
of entries necessary for
<structfield>max_key_code</structfield>
- &minus;
+&minus;
<structfield>min_key_code</structfield>
- + 1 keys.
++ 1 keys.
</entry>
</row>
</tbody>
@@ -1268,19 +1268,19 @@ of entries necessary for
<note><para>The
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- fields of the
+fields of the
<parameter>xkb</parameter>
- parameter must be legal values if the
+parameter must be legal values if the
<symbol>XkbKeySymsMask</symbol>
- or
+or
<symbol>XkbModifierMapMask</symbol>
- masks are set in the
+masks are set in the
<parameter>which</parameter>
- parameter. If they are not valid,
+parameter. If they are not valid,
<function>XkbAllocClientMap</function>
- returns
+returns
<errorname>BadValue</errorname>.
</para></note>
@@ -1289,34 +1289,34 @@ If the client map of the keyboard description is not
<symbol>NULL</symbol>,
and any fields are already allocated in the client map,
<function>XkbAllocClientMap</function>
- does not overwrite the existing values; it simply ignores that part of the
+does not overwrite the existing values; it simply ignores that part of the
request. The only exception is the
<structfield>types</structfield>
- array. If
+array. If
<parameter>type_count</parameter>
- is greater than the current
+is greater than the current
<structfield>num_types</structfield>
- field of the client map,
+field of the client map,
<function>XkbAllocClientMap</function>
- resizes the
+resizes the
<structfield>types</structfield>
- array and resets the
+array and resets the
<structfield>num_types</structfield>
- field accordingly.
+field accordingly.
</para>
<para>
If
<function>XkbAllocClientMap</function>
- is successful, it returns
+is successful, it returns
<symbol>Success</symbol>.
Otherwise, it can return either
<errorname>BadMatch</errorname>,
<errorname>BadAlloc</errorname>,
or
<errorname>BadValue</errorname>
- errors.
+errors.
</para>
@@ -1327,7 +1327,7 @@ or
<para>
To free memory used by the client map member of an
<structname>XkbDescRec</structname>
- structure, use
+structure, use
<function>XkbFreeClientMap</function>.
</para>
@@ -1380,17 +1380,17 @@ To free memory used by the client map member of an
<para>
<function>XkbFreeClientMap</function>
- frees the components of client map specified by
+frees the components of client map specified by
<parameter>which</parameter>
- in the
+in the
<structname>XkbDescRec</structname>
- structure specified by the
+structure specified by the
<parameter>xkb</parameter>
- parameter and sets the corresponding structure component values to
+parameter and sets the corresponding structure component values to
<symbol>NULL</symbol>.
The
<parameter>which</parameter>
- parameter specifies a combination of the client map masks shown in
+parameter specifies a combination of the client map masks shown in
<link linkend="table14.3">Table 14.3</link>.
</para>
@@ -1398,22 +1398,22 @@ The
<para>
If
<parameter>free_all</parameter>
- is
+is
<symbol>True</symbol>,
<parameter>which</parameter>
- is ignored;
+is ignored;
<function>XkbFreeClientMap</function>
- frees every non-
+frees every non-
<symbol>NULL</symbol>
- structure component in the client map, frees the
+structure component in the client map, frees the
<structname>XkbClientMapRec</structname>
- structure referenced by the
+structure referenced by the
<structfield>map</structfield>
- member of the
+member of the
<parameter>xkb</parameter>
- parameter, and sets the
+parameter, and sets the
<structfield>map</structfield>
- member to
+member to
<symbol>NULL</symbol>.
</para>
@@ -1475,13 +1475,13 @@ To allocate and initialize an empty server map description record, use
<para>
<function>XkbAllocServerMap</function>
- allocates and initializes an empty server map in the
+allocates and initializes an empty server map in the
<structfield>server</structfield>
- field of the keyboard description specified by
+field of the keyboard description specified by
<parameter>xkb</parameter>.
The
<parameter>which</parameter>
- parameter specifies the particular components of the server map structure to
+parameter specifies the particular components of the server map structure to
allocate, as specified in <link linkend="table14.4">Table 14.4</link>.
</para>
@@ -1503,11 +1503,11 @@ allocate, as specified in <link linkend="table14.4">Table 14.4</link>.
<entry>
The
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- fields of the
+fields of the
<parameter>xkb</parameter>
- parameter are used to allocate the
+parameter are used to allocate the
<structfield>explicit</structfield>
field of the server map.
</entry>
@@ -1517,17 +1517,17 @@ field of the server map.
<entry>
The
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- fields of the
+fields of the
<parameter>xkb</parameter>
- parameter are used to allocate the
+parameter are used to allocate the
<structfield>key_acts</structfield>
field of the server map. The
<parameter>count_acts</parameter>
- parameter is used to allocate the
+parameter is used to allocate the
<structfield>acts</structfield>
- field of the server map.
+field of the server map.
</entry>
</row>
<row>
@@ -1535,11 +1535,11 @@ field of the server map. The
<entry>
The
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- fields of the
+fields of the
<parameter>xkb</parameter>
- parameter are used to allocate the
+parameter are used to allocate the
<structfield>behaviors</structfield>
field of the server map.
</entry>
@@ -1549,9 +1549,9 @@ field of the server map.
<entry>
The
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- fields of the
+fields of the
<parameter>xkb</parameter>
parameter are used to allocate the
<structfield>vmodmap</structfield>
@@ -1564,22 +1564,22 @@ field of the server map.
<note><para>The
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- fields of the
+fields of the
<parameter>xkb</parameter>
- parameter must be legal values. If they are not valid,
+parameter must be legal values. If they are not valid,
<function>XkbAllocServerMap</function>
- returns
+returns
<errorname>BadValue</errorname>.
</para></note>
<para>
If the server map of the keyboard description is not
<symbol>NULL</symbol>
- and any fields are already allocated in the server map,
+and any fields are already allocated in the server map,
<function>XkbAllocServerMap</function>
- does not overwrite the existing values. The only exception is with the
+does not overwrite the existing values. The only exception is with the
<structfield>acts</structfield>
array. If the
<parameter>count_acts</parameter>
@@ -1587,7 +1587,7 @@ parameter is greater than the current
<structfield>num_acts</structfield>
field of the server map,
<function>XkbAllocServerMap</function>
- resizes the
+resizes the
<structfield>acts</structfield>
array and resets the
<structfield>num_acts</structfield>
@@ -1598,13 +1598,13 @@ field accordingly.
<para>
If
<function>XkbAllocServerMap</function>
- is successful, it returns
+is successful, it returns
<symbol>Success</symbol>.
Otherwise, it can return either
<errorname>BadMatch</errorname>
- or
+or
<errorname>BadAlloc</errorname>
- errors.
+errors.
</para>
@@ -1615,7 +1615,7 @@ Otherwise, it can return either
<para>
To free memory used by the server member of an
<structname>XkbDescRec</structname>
- structure, use
+structure, use
<function>XkbFreeServerMap</function>.
</para>
@@ -1669,34 +1669,34 @@ To free memory used by the server member of an
<para>
The
<function>XkbFreeServerMap</function>
- function frees the specified components of server map in the
+function frees the specified components of server map in the
<structname>XkbDescRec</structname>
- structure specified by the
+structure specified by the
<parameter>xkb</parameter>
- parameter and sets the corresponding structure component values to
+parameter and sets the corresponding structure component values to
<symbol>NULL</symbol>.
The
<parameter>which</parameter>
- parameter specifies a combination of the server map masks and is a bitwise
+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
<parameter>free_all</parameter>
- is
+is
<symbol>True</symbol>,
<parameter>which</parameter>
- is ignored and
+is ignored and
<function>XkbFreeServerMap</function>
- frees every non-
+frees every non-
<symbol>NULL</symbol>
- structure component in the server map, frees the
+structure component in the server map, frees the
<structname>XkbServerMapRec</structname>
- structure referenced by the
+structure referenced by the
<structfield>server</structfield>
- member of the
+member of the
<parameter>xkb</parameter>
- parameter, and sets the
+parameter, and sets the
<structfield>server</structfield>
- member to
+member to
<symbol>NULL</symbol>.
</para>
diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml
index 2956a2b8..a6f3f7c6 100644
--- a/specs/XKB/ch15.xml
+++ b/specs/XKB/ch15.xml
@@ -63,7 +63,7 @@ typedef struct { /* Client Map */
<para>
The following sections describe each of the elements of the
<structname>XkbClientMapRec</structname>
- structure in more detail.
+structure in more detail.
</para>
@@ -80,7 +80,7 @@ Key types are used to determine the shift level of a key given the current
state of the keyboard. The set of all possible key types for the Xkb keyboard
description are held in the
<structfield>types</structfield>
- field of the client map, whose total size is stored in
+field of the client map, whose total size is stored in
<structfield>size_types</structfield>,
and whose total number of valid entries is stored in
<structfield>num_types</structfield>.
@@ -115,125 +115,125 @@ typedef struct { /* Modifiers for a key type */
<para>
The
<structfield>mods</structfield>
- field of a key type is an
+field of a key type is an
<structname>XkbModsRec</structname>
- (see <link linkend="Modifier_Definitions">section 7.2</link>) specifying the modifiers the key type uses when calculating
+(see <link linkend="Modifier_Definitions">section 7.2</link>) specifying the modifiers the key type uses when calculating
the shift level, and can be composed of both the core modifiers and virtual
modifiers. To set the modifiers associated with a key type, modify the
<structfield>real_mods</structfield>
- and
+and
<structfield>vmods</structfield>
- fields of the
+fields of the
<structfield>mods</structfield>
<structname>XkbModsRec</structname>
- accordingly. The
+accordingly. The
<structfield>mask</structfield>
- field of the
+field of the
<structname>XkbModsRec</structname>
- is reserved for use by Xkb and is calculated from the
+is reserved for use by Xkb and is calculated from the
<structfield>real_mods</structfield>
- and
+and
<structfield>vmods</structfield>
- fields.
+fields.
</para>
<para>
The
<structfield>num_levels</structfield>
- field holds the total number of shift levels for the key type. Xkb uses
+field holds the total number of shift levels for the key type. Xkb uses
<structfield>num_levels</structfield>
- to ensure the array of symbols bound to a key is large enough. Do not modify
+to ensure the array of symbols bound to a key is large enough. Do not modify
<structfield>num_levels</structfield>
- directly to change the number if shift levels for a key type. Instead, use
+directly to change the number if shift levels for a key type. Instead, use
<function>XkbResizeKeyType</function>
- (see <link linkend="Changing_the_Number_of_Levels_in_a_Key_Type">section 15.2.3</link>).
+(see <link linkend="Changing_the_Number_of_Levels_in_a_Key_Type">section 15.2.3</link>).
</para>
<para>
The
<structfield>map</structfield>
- field is a vector of
+field is a vector of
<structname>XkbKTMapEntryRec</structname>
- structures, with
+structures, with
<structfield>map_count</structfield>
- entries, that specify the modifier combinations for each possible shift level.
+entries, that specify the modifier combinations for each possible shift level.
Each map entry contains an
<structfield>active</structfield>
- field, a
+field, a
<structfield>mods</structfield>
- field, and a
+field, and a
<structfield>level</structfield>
- field. The
+field. The
<structfield>active</structfield>
- field determines whether the modifier combination listed in the
+field determines whether the modifier combination listed in the
<structfield>mods</structfield>
- field should be considered when determining shift level. If
+field should be considered when determining shift level. If
<structfield>active</structfield>
- is
+is
<symbol>False</symbol>,
this
<structfield>map</structfield>
- entry is ignored. If
+entry is ignored. If
<structfield>active</structfield>
- is
+is
<symbol>True</symbol>,
the
<structfield>level</structfield>
- field of the
+field of the
<structfield>map</structfield>
entry specifies the shift level to use when the current modifier combination
matches the combination specified in the
<structfield>mods</structfield>
- field of the
+field of the
<structfield>map</structfield>
- entry.
+entry.
</para>
<para>
Any combination of modifiers not explicitly listed somewhere in the
<structfield>map</structfield>
- yields shift level one. In addition,
+yields shift level one. In addition,
<structfield>map</structfield>
- entries specifying unbound virtual modifiers are not considered.
+entries specifying unbound virtual modifiers are not considered.
</para>
<para>
Any modifiers specified in
<structfield>mods</structfield>
- are normally
+are normally
<emphasis>consumed</emphasis>
- by
+by
<function>XkbTranslateKeyCode</function>
- (see <link linkend="X_Library_Functions_Affected_by_Xkb">section 12.1.3</link>). For those rare occasions a modifier
+(see <link linkend="X_Library_Functions_Affected_by_Xkb">section 12.1.3</link>). For those rare occasions a modifier
<emphasis>should</emphasis>
- be considered despite having been used to look up a symbol, key types include
+be considered despite having been used to look up a symbol, key types include
an optional
<structfield>preserve</structfield>
- field. If a
+field. If a
<structfield>preserve</structfield>
- member of a key type is not
+member of a key type is not
<symbol>NULL</symbol>,
it represents a list of modifiers where each entry corresponds directly to
one of the key type’s
<structfield>map</structfield>.
Each entry lists the modifiers that should
<emphasis>not</emphasis>
- be consumed if the matching map entry is used to determine shift level.
+be consumed if the matching map entry is used to determine shift level.
</para>
<para>
Each shift level has a name and these names are held in the
<structfield>level_names</structfield>
- array, whose length is
+array, whose length is
<structfield>num_levels</structfield>.
The type itself also has a name, which is held in the
<structfield>name</structfield>
- field.
+field.
</para>
@@ -328,7 +328,7 @@ although this format is one possible example):
<para>
The
<structfield>name</structfield>
- of the example key type is "ALPHATHREE," and the modifiers it pays attention
+of the example key type is "ALPHATHREE," and the modifiers it pays attention
to are
<symbol>Shift</symbol>,
<symbol>Lock</symbol>,
@@ -342,60 +342,60 @@ of shift level two is "Caps," and the name of shift level three is "Level3."
<para>
Given the combination of the
<structfield>map</structfield>
- and
+and
<structfield>preserve</structfield>
- specifications, there are five
+specifications, there are five
<structfield>map</structfield>
- entries. The first map entry specifies that shift level one is to be used if
+entries. The first map entry specifies that shift level one is to be used if
no modifiers are set. The second entry specifies the
<symbol>Lock</symbol>
- modifier alone also yields shift level one. The third entry specifies the
+modifier alone also yields shift level one. The third entry specifies the
<symbol>Shift</symbol>
- modifier alone yields shift level two. The fourth and fifth entries specify
+modifier alone yields shift level two. The fourth and fifth entries specify
that the virtual
<emphasis>LevelThree</emphasis>
- modifier alone, or in combination with the
+modifier alone, or in combination with the
<symbol>Shift</symbol>
- modifier, yields shift level three.
+modifier, yields shift level three.
</para>
<note><para>Shift level three can be reached only if the virtual modifier
<emphasis>LevelThree</emphasis>
- is bound to a real modifier (see <link linkend="Virtual_Modifier_Mapping">section 16.4</link>). If
+is bound to a real modifier (see <link linkend="Virtual_Modifier_Mapping">section 16.4</link>). If
<emphasis>LevelThree</emphasis>
- is not bound to a real modifier, the
+is not bound to a real modifier, the
<structfield>map</structfield>
- entries associated with it are ignored.</para></note>
+entries associated with it are ignored.</para></note>
<para>
Because the
<symbol>Lock</symbol>
- modifier is to be preserved for further event processing, the
+modifier is to be preserved for further event processing, the
<structfield>preserve</structfield>
- list is not
+list is not
<symbol>NULL</symbol>
- and parallels the
+and parallels the
<structfield>map</structfield>
- list. All
+list. All
<structfield>preserve</structfield>
- entries, except for the one corresponding to the
+entries, except for the one corresponding to the
<structfield>map</structfield>
- entry that specifies the
+entry that specifies the
<symbol>Lock</symbol>
modifier, do not list any modifiers. For the
<structfield>map</structfield>
- entry that specifies the
+entry that specifies the
<symbol>Lock</symbol>
- modifier, the corresponding
+modifier, the corresponding
<structfield>preserve</structfield>
- list entry lists the
+list entry lists the
<symbol>Lock</symbol>
- modifier, meaning do not consume the
+modifier, meaning do not consume the
<symbol>Lock</symbol>
- modifier. In this particular case, the preserved modifier is passed to Xlib
+modifier. In this particular case, the preserved modifier is passed to Xlib
translation functions and causes them to notice that the
<symbol>Lock</symbol>
- modifier is set; consequently, the Xlib functions apply the appropriate
+modifier is set; consequently, the Xlib functions apply the appropriate
capitalization rules to the symbol. Because this preserve entry is set only for
a modifier that yields shift level one, the capitalization occurs only for
level-one symbols.
@@ -408,16 +408,16 @@ level-one symbols.
<para>
Xkb allows up to
<symbol>XkbMaxKeyTypes</symbol>
- (255) key types to be defined, but requires at least
+(255) key types to be defined, but requires at least
<symbol>XkbNumRequiredTypes</symbol>
- (4) predefined types to be in a key map. These predefined key types are
+(4) predefined types to be in a key map. These predefined key types are
referred to as the canonical key types and describe the types of keys available
on most keyboards. The definitions for the canonical key types are held in the
first
<symbol>XkbNumRequiredTypes</symbol>
- entries of the
+entries of the
<structfield>types</structfield>
- field of the client map and are indexed using the following constants:
+field of the client map and are indexed using the following constants:
<simplelist type='vert' columns='1'>
<member><symbol>XkbOneLevelIndex</symbol></member>
@@ -463,9 +463,9 @@ The TWO_LEVEL key type describes groups that consist of two symbols but are
neither alphabetic nor numeric keypad keys. The default TWO_LEVEL type uses
only the
<symbol>Shift</symbol>
- modifier. It returns shift level two if
+modifier. It returns shift level two if
<symbol>Shift</symbol>
- is set, and level one if it is not. A symbolic representation of this key type
+is set, and level one if it is not. A symbolic representation of this key type
could look like the following:
</para>
@@ -497,9 +497,9 @@ lowercase form of a symbol followed by the uppercase form of the same symbol.
The default ALPHABETIC type implements locale-sensitive <quote>Shift cancels
CapsLock</quote> behavior using both the
<symbol>Shift</symbol>
- and
+and
<symbol>Lock</symbol>
- modifiers as follows:
+modifiers as follows:
</para>
<itemizedlist>
@@ -507,25 +507,25 @@ CapsLock</quote> behavior using both the
<para>
If
<symbol>Shift</symbol>
- and
+and
<symbol>Lock</symbol>
- are both set, the default ALPHABETIC type yields level one.
+are both set, the default ALPHABETIC type yields level one.
</para>
</listitem>
<listitem>
<para>
If
<symbol>Shift</symbol>
- alone is set, it yields level two.
+alone is set, it yields level two.
</para>
</listitem>
<listitem>
<para>
If
<symbol>Lock</symbol>
- alone is set, it yields level one, but preserves the
+alone is set, it yields level one, but preserves the
<symbol>Lock</symbol>
- modifier so Xlib notices and applies the appropriate capitalization rules. The
+modifier so Xlib notices and applies the appropriate capitalization rules. The
Xlib functions are locale-sensitive and apply different capitalization rules
for different locales.
</para>
@@ -534,9 +534,9 @@ for different locales.
<para>
If neither
<symbol>Shift</symbol>
- nor
+nor
<symbol>Lock</symbol>
- is set, it yields level one.
+is set, it yields level one.
</para>
</listitem>
</itemizedlist>
@@ -576,7 +576,7 @@ reside at level two. The default KEYPAD key type implements
and the real modifier bound to the virtual modifier named
<quote>NumLock</quote>, known as the
<emphasis>NumLock</emphasis>
- modifier, as follows:
+modifier, as follows:
</para>
<itemizedlist>
@@ -584,32 +584,32 @@ and the real modifier bound to the virtual modifier named
<para>
If
<symbol>Shift</symbol>
- and
+and
<emphasis>NumLock</emphasis>
- are both set, the default KEYPAD type yields level one.
+are both set, the default KEYPAD type yields level one.
</para>
</listitem>
<listitem>
<para>
If
<symbol>Shift</symbol>
- alone is set, it yields level two.
+alone is set, it yields level two.
</para>
</listitem>
<listitem>
<para>
If
<emphasis>NumLock</emphasis>
- alone is set, it yields level two.
+alone is set, it yields level two.
</para>
</listitem>
<listitem>
<para>
If neither
<symbol>Shift</symbol>
- nor
+nor
<emphasis>NumLock</emphasis>
- is set, it yields level one.
+is set, it yields level one.
</para>
</listitem>
</itemizedlist>
@@ -697,13 +697,13 @@ default values, use
<para>
<function>XkbInitCanonicalKeyTypes</function>
- initializes the first
+initializes the first
<symbol>XkbNumRequiredTypes</symbol>
- key types of the keyboard specified by the
+key types of the keyboard specified by the
<parameter>xkb</parameter>
- parameter to their default values. The
+parameter to their default values. The
<parameter>which</parameter>
- parameter specifies what canonical key types to initialize and is a bitwise
+parameter specifies what canonical key types to initialize and is a bitwise
inclusive OR of the following masks:
<symbol>XkbOneLevelMask</symbol>,
<symbol>XkbTwoLevelMask</symbol>,
@@ -712,37 +712,37 @@ and
<symbol>XkbKeypadMask</symbol>.
Only those canonical types specified by the
<parameter>which</parameter>
- mask are initialized.
+mask are initialized.
</para>
<para>
If
<symbol>XkbKeypadMask</symbol>
- is set in the
+is set in the
<parameter>which</parameter>
- parameter,
+parameter,
<function>XkbInitCanonicalKeyTypes</function>
- looks up the
+looks up the
<emphasis>NumLock</emphasis>
- named virtual modifier to determine which virtual modifier to use when
+named virtual modifier to determine which virtual modifier to use when
initializing the KEYPAD key type. If the
<emphasis>NumLock</emphasis>
- virtual modifier does not exist,
+virtual modifier does not exist,
<function>XkbInitCanonicalKeyTypes</function>
- creates it.
+creates it.
</para>
<para>
<function>XkbInitCanonicalKeyTypes</function>
- normally returns Success. It returns
+normally returns Success. It returns
<errorname>BadAccess</errorname>
- if the Xkb extension has not been properly initialized, and
+if the Xkb extension has not been properly initialized, and
<errorname>BadAccess</errorname>
- if the
+if the
<parameter>xkb</parameter>
- parameter is not valid.
+parameter is not valid.
</para>
@@ -819,15 +819,15 @@ use
</variablelist>
<note><para>
<function>XkbGetKeyTypes</function>
- is used to obtain descriptions of the key types themselves, not the key types
+is used to obtain descriptions of the key types themselves, not the key types
bound to individual keys. To obtain the key types bound to an individual key,
refer to the
<structfield>key_sym_map</structfield>
- field of the client map (see <link linkend="Per_Key_Key_Type_Indices">section 15.3.1</link>).</para></note>
+field of the client map (see <link linkend="Per_Key_Key_Type_Indices">section 15.3.1</link>).</para></note>
<para>
<function>XkbGetKeyTypes</function>
- queries the server for the desired types, waits for a reply, and returns the
+queries the server for the desired types, waits for a reply, and returns the
desired types in the
<structfield>xkb-&gt;map-&gt;types</structfield>.
If successful, it returns Success.
@@ -836,15 +836,15 @@ If successful, it returns Success.
<para>
<function>XkbGetKeyTypes</function>
- returns
+returns
<errorname>BadAccess</errorname>
- if the Xkb extension has not been properly initialized and
+if the Xkb extension has not been properly initialized and
<errorname>BadValue</errorname>
- if the combination of
+if the combination of
<parameter>first</parameter>
- and
+and
<parameter>num</parameter>
- results in numbers out of valid range.
+results in numbers out of valid range.
</para>
@@ -932,20 +932,20 @@ To change the number of levels in a key type, use
<para>
<function>XkbResizeKeyType</function>
- changes the type specified by
+changes the type specified by
<parameter>xkb</parameter>-&gt;<structfield>map-&gt;types</structfield>
[
<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
+updates only the local copy of the types in
<parameter>xkb</parameter>;
- to update the server’s copy for the physical device, use
+to update the server’s copy for the physical device, use
<function>XkbSetMap</function>
- or
+or
<function>XkbChangeMap</function>
- after calling
+after calling
<function>XkbResizeKeyType</function>.
</para>
@@ -953,16 +953,16 @@ if necessary.
<para>
The
<parameter>map_count</parameter>
- parameter specifies the total number of map entries needed for the type, and
+parameter specifies the total number of map entries needed for the type, and
can be zero or greater. If
<parameter>map_count</parameter>
- is zero,
+is zero,
<function>XkbResizeKeyType</function>
- frees the existing
+frees the existing
<structfield>map</structfield>
- and
+and
<structfield>preserve</structfield>
- entries for the type if they exist and sets them to
+entries for the type if they exist and sets them to
<symbol>NULL</symbol>.
</para>
@@ -970,23 +970,23 @@ can be zero or greater. If
<para>
The
<parameter>want_preserve</parameter>
- parameter specifies whether a
+parameter specifies whether a
<structfield>preserve</structfield>
- list for the key should be created. If
+list for the key should be created. If
<parameter>want_preserve</parameter>
- is
+is
<symbol>True</symbol>,
the
<structfield>preserve</structfield>
- list with
+list with
<parameter>map_count</parameter>
- entries is allocated or reallocated if it already exists. Otherwise, if
+entries is allocated or reallocated if it already exists. Otherwise, if
<parameter>want_preserve</parameter>
- is
+is
<symbol>False</symbol>,
the
<structfield>preserve</structfield>
- field is freed if necessary and set to
+field is freed if necessary and set to
<symbol>NULL</symbol>.
</para>
@@ -994,7 +994,7 @@ the
<para>
The
<parameter>new_num_lvls</parameter>
- parameter specifies the new maximum number of shift levels for the type and is
+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.
</para>
@@ -1003,17 +1003,17 @@ the type.
<para>
If
<parameter>type_ndx</parameter>
- does not specify a legal type,
+does not specify a legal type,
<parameter>new_num_lvls</parameter>
- is less than 1, or the
+is less than 1, or the
<parameter>map_count</parameter>
- is less than zero,
+is less than zero,
<function>XkbResizeKeyType</function>
- returns
+returns
<errorname>BadValue</errorname>.
If
<function>XkbResizeKeyType</function>
- encounters any problems with allocation, it returns
+encounters any problems with allocation, it returns
<errorname>BadAlloc</errorname>.
Otherwise, it returns
<symbol>Success</symbol>.
@@ -1027,11 +1027,11 @@ Otherwise, it returns
<para>
Use
<function>XkbCopyKeyType</function>
- and
+and
<function>XkbCopyKeyTypes</function>
- to copy one or more
+to copy one or more
<structname>XkbKeyTypeRec</structname>
- structures.
+structures.
</para>
<indexterm significance="preferred" zone="XkbCopyKeyType"><primary><function>XkbCopyKeyType</function></primary></indexterm>
@@ -1072,39 +1072,39 @@ Use
<para>
<function>XkbCopyKeyType</function>
- copies the key type specified by
+copies the key type specified by
<parameter>from</parameter>
- to the key type specified by
+to the key type specified by
<parameter>into</parameter>.
Both must point to legal
<structname>XkbKeyTypeRec</structname>
- structures. Xkb assumes
+structures. Xkb assumes
<parameter>from</parameter>
- and
+and
<parameter>into</parameter>
- point to different places. As a result, overlaps can be fatal.
+point to different places. As a result, overlaps can be fatal.
<function>XkbCopyKeyType</function>
- frees any existing
+frees any existing
<structfield>map</structfield>,
<structfield>preserve</structfield>,
and
<structfield>level_names</structfield>
- in
+in
<parameter>into</parameter>
- prior to copying. If any allocation errors occur while copying
+prior to copying. If any allocation errors occur while copying
<parameter>from</parameter>
- to
+to
<parameter>into</parameter>,
<function>XkbCopyKeyType</function>
- returns
+returns
<errorname>BadAlloc</errorname>.
Otherwise,
<function>XkbCopyKeyType</function>
- copies
+copies
<parameter>from</parameter>
- to
+to
<parameter>into</parameter>
- and returns
+and returns
<symbol>Success</symbol>.
</para>
@@ -1159,41 +1159,41 @@ Otherwise,
<para>
<function>XkbCopyKeyTypes</function>
- copies
+copies
<parameter>num_types</parameter>
<structname>XkbKeyTypeRec</structname>
- structures from the array specified by
+structures from the array specified by
<parameter>from</parameter>
- into the array specified by
+into the array specified by
<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
<parameter>from</parameter>
- and
+and
<parameter>into</parameter>
- parameters in
+parameters in
<function>XkbCopyKeyType</function>
- apply to each entry of the
+apply to each entry of the
<parameter>from</parameter>
- and
+and
<parameter>into</parameter>
- arrays of
+arrays of
<function>XkbCopyKeyTypes</function>.
If any allocation errors occur while copying
<parameter>from</parameter>
- to
+to
<parameter>into</parameter>,
<function>XkbCopyKeyTypes</function>
- returns
+returns
<errorname>BadAlloc</errorname>.
Otherwise,
<function>XkbCopyKeyTypes</function>
- copies
+copies
<parameter>from</parameter>
- to
+to
<parameter>into</parameter>
- and returns
+and returns
<symbol>Success</symbol>.
</para>
@@ -1208,14 +1208,14 @@ Otherwise,
<para>
The entire list of key symbols for the keyboard mapping is held in the
<structfield>syms</structfield>
- field of the client map. Whereas the core keyboard mapping is a
+field of the client map. Whereas the core keyboard mapping is a
two-dimensional array of
<type>KeySym</type>s
- whose rows are indexed by keycode, the
+whose rows are indexed by keycode, the
<structfield>syms</structfield>
- field of Xkb is a linear list of
+field of Xkb is a linear list of
<type>KeySym</type>s
- that needs to be indexed uniquely for each key. This section describes the key
+that needs to be indexed uniquely for each key. This section describes the key
symbol map and the methods for determining the symbols bound to a key.
</para>
@@ -1223,45 +1223,45 @@ symbol map and the methods for determining the symbols bound to a key.
<para>
The reason the
<structfield>syms</structfield>
- field is a linear list of
+field is a linear list of
<type>KeySym</type>s
- is to reduce the memory consumption associated with a keymap; because Xkb
+is to reduce the memory consumption associated with a keymap; because Xkb
allows individual keys to have multiple shift levels and a different number of
groups per key, a single two-dimensional array of
<type>KeySym</type>s
- would potentially be very large and sparse. Instead, Xkb provides a small
+would potentially be very large and sparse. Instead, Xkb provides a small
two-dimensional array of
<type>KeySym</type>s
- for each key. To store all of these individual arrays, Xkb concatenates each
+for each key. To store all of these individual arrays, Xkb concatenates each
array together in the
<structfield>syms</structfield>
- field of the client map.
+field of the client map.
</para>
<para>
In order to determine which
<type>KeySym</type>s
- in the
+in the
<structfield>syms</structfield>
- field are associated with each keycode, the client map contains an array of
+field are associated with each keycode, the client map contains an array of
key symbol mappings, held in the
<structfield>key_sym_map</structfield>
- field. The
+field. The
<structfield>key_sym_map</structfield>
- field is an array of
+field is an array of
<structname>XkbSymMapRec</structname>
- structures indexed by keycode. The
+structures indexed by keycode. The
<structfield>key_sym_map</structfield>
- array has
+array has
<structfield>min_key_code</structfield>
- unused entries at the start to allow direct indexing using a keycode. All
+unused entries at the start to allow direct indexing using a keycode. All
keycodes falling between the minimum and maximum legal keycodes, inclusive,
have
<structfield>key_sym_map</structfield>
- arrays, whether or not any key actually yields that code. The
+arrays, whether or not any key actually yields that code. The
<structname>KeySymMapRec</structname>
- structure is defined as follows:
+structure is defined as follows:
<programlisting>
#define XkbNumKbdGroups 4
@@ -1289,9 +1289,9 @@ These fields are described in detail in the following sections.
<para>
The
<structfield>kt_index</structfield>
- array of the
+array of the
<structname>XkbSymMapRec</structname>
- structure contains the indices of the key types (see <link linkend="Key_Types">section 15.2</link>) for each
+structure contains the indices of the key types (see <link linkend="Key_Types">section 15.2</link>) for each
possible group of symbols associated with the key. To obtain the index of a key
type or the pointer to a key type, Xkb provides the following macros, to access
the key types:
@@ -1302,7 +1302,7 @@ hold key types for the maximum legal number of groups
(<symbol>XkbNumKbdGroups</symbol>,
currently four); if a key has fewer than
<symbol>XkbNumKbdGroups</symbol>
- groups, the extra key types are reported but ignored.</para></note>
+groups, the extra key types are reported but ignored.</para></note>
<indexterm significance="preferred" zone="XkbKeyTypeIndex"><primary><function>XkbKeyTypeIndex</function></primary></indexterm>
<funcsynopsis id="XkbKeyTypeIndex">
@@ -1352,15 +1352,15 @@ currently four); if a key has fewer than
<para>
<function>XkbKeyTypeIndex</function>
- computes an index into the
+computes an index into the
<structfield>types</structfield>
- vector of the client map in
+vector of the client map in
<parameter>xkb</parameter>
- from the given
+from the given
<parameter>keycode</parameter>
- and
+and
<parameter>group</parameter>
- index.
+index.
</para>
@@ -1412,15 +1412,15 @@ currently four); if a key has fewer than
<para>
<function>XkbKeyType</function>
- returns a pointer to the key type in the
+returns a pointer to the key type in the
<structfield>types</structfield>
- vector of the client map in
+vector of the client map in
<parameter>xkb</parameter>
- corresponding to the given
+corresponding to the given
<parameter>keycode</parameter>
- and
+and
<parameter>group</parameter>
- index.
+index.
</para>
@@ -1431,9 +1431,9 @@ currently four); if a key has fewer than
<para>
The
<structfield>group_info</structfield>
- field of an
+field of an
<structname>XkbSymMapRec</structname>
- is an encoded value containing the number of groups of symbols bound to the
+is an encoded value containing the number of groups of symbols bound to the
key as well as the specification of the treatment of out-of-range groups. It is
legal for a key to have zero groups, in which case it also has zero symbols and
all events from that key yield
@@ -1442,10 +1442,10 @@ To obtain the number of groups of symbols bound to the key, use
<function>XkbKeyNumGroups</function>.
To change the number of groups bound to a key, use
<function>XkbChangeTypesOfKey</function>
- (see <link linkend="Changing_the_Number_of_Groups_and_Types_Bound_to_a_Key">section 15.3.6</link>). To obtain a mask that determines the treatment of
+(see <link linkend="Changing_the_Number_of_Groups_and_Types_Bound_to_a_Key">section 15.3.6</link>). To obtain a mask that determines the treatment of
out-of-range groups, use
<function>XkbKeyGroupInfo</function>
- and
+and
<function>XkbOutOfRangeGroupInfo</function>.
</para>
@@ -1453,26 +1453,26 @@ out-of-range groups, use
<para>
The keyboard controls (see <xref linkend="Keyboard_Controls" />) contain a
<structfield>groups_wrap</structfield>
- field specifying the handling of illegal groups on a global basis. That is,
+field specifying the handling of illegal groups on a global basis. That is,
when the user performs an action causing the effective group to go out of the
legal range, the
<structfield>groups_wrap</structfield>
- field specifies how to normalize the effective keyboard group to a group that
+field specifies how to normalize the effective keyboard group to a group that
is legal for the keyboard as a whole, but there is no guarantee that the
normalized group will be within the range of legal groups for any individual
key. The per-key
<structfield>group_info</structfield>
- field specifies how a key treats a legal effective group if the key does not
+field specifies how a key treats a legal effective group if the key does not
have a type specified for the group of concern. For example, the
<keycap>Enter</keycap>
- key usually has just one group defined. If the user performs an action causing
+key usually has just one group defined. If the user performs an action causing
the global keyboard group to change to
<emphasis>Group2</emphasis>,
the
<structfield>group_info</structfield>
- field for the
+field for the
<keycap>Enter</keycap>
- key describes how to handle this situation.
+key describes how to handle this situation.
</para>
@@ -1481,9 +1481,9 @@ Out-of-range groups for individual keys are mapped to a legal group using the
same options as are used for the overall keyboard group. The particular type of
mapping used is controlled by the bits set in the
<structfield>group_info</structfield>
- flag, as shown in <link linkend="table15.2">Table 15.2</link>.
- See <link linkend="The_GroupsWrap_Control">section 10.7.1</link>
- for more details on the normalization methods in this table.
+flag, as shown in <link linkend="table15.2">Table 15.2</link>.
+See <link linkend="The_GroupsWrap_Control">section 10.7.1</link>
+for more details on the normalization methods in this table.
</para>
<table id='table15.2' frame='topbot'>
@@ -1556,7 +1556,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
+returns the number of groups of symbols bound to the key corresponding to
<parameter>keycode</parameter>.
</para>
@@ -1598,11 +1598,11 @@ Xkb provides the following macros to access group information:
<para>
<function>XkbKeyGroupInfo</function>
- returns the
+returns the
<structfield>group_info</structfield>
- field from the
+field from the
<structname>XkbSymMapRec</structname>
- structure associated with the key corresponding to
+structure associated with the key corresponding to
<parameter>keycode</parameter>.
</para>
@@ -1633,11 +1633,11 @@ Xkb provides the following macros to access group information:
<para>
<function>XkbOutOfRangeGroupInfo</function>
- returns only the out-of-range processing information from the
+returns only the out-of-range processing information from the
<structfield>group_info</structfield>
- field of an
+field of an
<structname>XkbSymMapRec</structname>
- structure.
+structure.
</para>
@@ -1667,11 +1667,11 @@ Xkb provides the following macros to access group information:
<para>
<function>XkbOutOfRangeGroupNumber</function>
- returns the out-of-range group number, represented as a group index, from the
+returns the out-of-range group number, represented as a group index, from the
<structfield>group_info</structfield>
- field of an
+field of an
<structname>XkbSymMapRec</structname>
- structure.
+structure.
</para>
@@ -1683,9 +1683,9 @@ Xkb provides the following macros to access group information:
The maximum number of shift levels for a type is also referred to as the width
of a key type. The
<structfield>width</structfield>
- field of the
+field of the
<structfield>key_sym_map</structfield>
- entry for a key contains the width of the widest type associated with the key.
+entry for a key contains the width of the widest type associated with the key.
The
<structfield>width</structfield>
field cannot be explicitly changed; it is updated automatically whenever the
@@ -1701,11 +1701,11 @@ symbols or set of types bound to a key are changed.
The key width and number of groups associated with a key are used to form a
small two-dimensional array of
<type>KeySym</type>s
- for a key. This array may be different sizes for different keys. The array for
+for a key. This array may be different sizes for different keys. The array for
a single key is stored as a linear list, in row-major order. The arrays for all
of the keys are stored in the
<structfield>syms</structfield>
- field of the client map. There is one row for each group associated with a key
+field of the client map. There is one row for each group associated with a key
and one column for each level. The index corresponding to a given group and
shift level is computed as:
</para>
@@ -1717,18 +1717,18 @@ shift level is computed as:
<para>
The
<structfield>offset</structfield>
- field of the
+field of the
<structfield>key_sym_map</structfield>
- entry for a key is used to access the beginning of the array.
+entry for a key is used to access the beginning of the array.
</para>
<para>
Xkb provides the following macros for accessing the
<structfield>width</structfield>
- and
+and
<structfield>offset</structfield>
- for individual keys, as well as macros for accessing the two-dimensional array
+for individual keys, as well as macros for accessing the two-dimensional array
of symbols bound to the key:
</para>
@@ -1769,7 +1769,7 @@ of symbols bound to the key:
<para>
<function>XkbKeyGroupsWidth</function>
- computes the maximum width associated with the key corresponding to
+computes the maximum width associated with the key corresponding to
<parameter>keycode</parameter>.
</para>
@@ -1822,9 +1822,9 @@ of symbols bound to the key:
<para>
<function>XkbKeyGroupWidth</function>
- computes the width of the type associated with the group
+computes the width of the type associated with the group
<parameter>grp</parameter>
- for the key corresponding to
+for the key corresponding to
<parameter>keycode</parameter>.
</para>
@@ -1866,7 +1866,7 @@ of symbols bound to the key:
<para>
<function>XkbKeySymsOffset</function>
- returns the offset of the two-dimensional array of keysyms for the key
+returns the offset of the two-dimensional array of keysyms for the key
corresponding to
<parameter>keycode</parameter>.
</para>
@@ -1909,7 +1909,7 @@ corresponding to
<para>
<function>XkbKeyNumSyms</function>
- returns the total number of keysyms for the key corresponding to
+returns the total number of keysyms for the key corresponding to
<parameter>keycode</parameter>.
</para>
@@ -1951,7 +1951,7 @@ corresponding to
<para>
<function>XkbKeySymsPtr</function>
- returns the pointer to the two-dimensional array of keysyms for the key
+returns the pointer to the two-dimensional array of keysyms for the key
corresponding to
<parameter>keycode</parameter>.
</para>
@@ -2016,13 +2016,13 @@ corresponding to
<para>
<function>XkbKeySymEntry</function>
- returns the
+returns the
<type>KeySym</type>
- corresponding to shift level
+corresponding to shift level
<parameter>shift</parameter>
- and group
+and group
<parameter>grp</parameter>
- from the two-dimensional array of keysyms for the key corresponding to
+from the two-dimensional array of keysyms for the key corresponding to
<parameter>keycode</parameter>
</para>
@@ -2099,32 +2099,32 @@ 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
+sends a request to the server to obtain the set of keysyms bound to
<parameter>num</parameter>
- keys starting with the key whose keycode is
+keys starting with the key whose keycode is
<parameter>first</parameter>.
It waits for a reply and returns the keysyms in the
<structfield>map.syms</structfield>
- field of
+field of
<parameter>xkb</parameter>.
If successful,
<function>XkbGetKeySyms</function>
- returns
+returns
<symbol>Success</symbol>.
The
<parameter>xkb</parameter>
- parameter must be a pointer to a valid Xkb keyboard description.
+parameter must be a pointer to a valid Xkb keyboard description.
</para>
<para>
If the client
<structfield>map</structfield>
- in the
+in the
<parameter>xkb</parameter>
- parameter has not been allocated,
+parameter has not been allocated,
<function>XkbGetKeySyms</function>
- allocates and initializes it before obtaining the symbols.
+allocates and initializes it before obtaining the symbols.
</para>
@@ -2132,18 +2132,18 @@ If the client
If a compatible version of Xkb is not available in the server or the Xkb
extension has not been properly initialized,
<function>XkbGetKeySyms</function>
- returns
+returns
<errorname>BadAccess</errorname>.
If
<parameter>num</parameter>
- is less than 1 or greater than
+is less than 1 or greater than
<symbol>XkbMaxKeyCount</symbol>,
<function>XkbGetKeySyms</function>
- returns
+returns
<errorname>BadValue</errorname>.
If any allocation errors occur,
<function>XkbGetKeySyms</function>
- returns
+returns
<errorname>BadAlloc</errorname>.
</para>
@@ -2244,35 +2244,35 @@ To change the number of groups and the types bound to a key, use
<para>
<function>XkbChangeTypesOfKey</function>
- reallocates the symbols and actions bound to the key, if necessary, and
+reallocates the symbols and actions bound to the key, if necessary, and
initializes any new symbols or actions to
<symbol>NoSymbol</symbol>
- or
+or
<emphasis>NoAction</emphasis>,
as appropriate. If the
<parameter>p_changes</parameter>
- parameter is not
+parameter is not
<symbol>NULL</symbol>,
<function>XkbChangeTypesOfKey</function>
- adds the
+adds the
<symbol>XkbKeySymsMask</symbol>
- to the
+to the
<structfield>changes</structfield>
- field of
+field of
<parameter>p_changes</parameter>
- and modifies the
+and modifies the
<structfield>first_key_sym</structfield>
- and
+and
<structfield>num_key_syms</structfield>
- fields of
+fields of
<parameter>p_changes</parameter>
- to include the
+to include the
<parameter>key</parameter>
- that was changed. See <link linkend="The_XkbMapChangesRec_Structure">section 14.3.1</link> for more information on the
+that was changed. See <link linkend="The_XkbMapChangesRec_Structure">section 14.3.1</link> for more information on the
<type>XkbMapChangesPtr</type>
- structure. If successful,
+structure. If successful,
<function>XkbChangeTypesOfKey</function>
- returns
+returns
<symbol>Success</symbol>.
</para>
@@ -2280,9 +2280,9 @@ as appropriate. If the
<para>
The
<parameter>n_groups</parameter>
- parameter specifies the new number of groups for the key. The
+parameter specifies the new number of groups for the key. The
<parameter>groups</parameter>
- parameter is a mask specifying the groups for which new types are supplied and
+parameter is a mask specifying the groups for which new types are supplied and
is a bitwise inclusive OR of the following masks:
<symbol>XkbGroup1Mask</symbol>,
<symbol>XkbGroup2Mask</symbol>,
@@ -2295,24 +2295,24 @@ and
<para>
The
<parameter>new_types_in</parameter>
- parameter is an integer array of length
+parameter is an integer array of length
<parameter>n_groups</parameter>.
Each entry represents the type to use for the associated group and is an
index into
<parameter>xkb</parameter>-&gt;<structfield>map-&gt;types</structfield>.
The
<parameter>new_types_in</parameter>
- array is indexed by group index; if
+array is indexed by group index; if
<parameter>n_groups</parameter>
- is four and
+is four and
<parameter>groups</parameter>
- only has
+only has
<symbol>XkbGroup1Mask</symbol>
- and
+and
<symbol>XkbGroup3Mask</symbol>
- set,
+set,
<parameter>new_types_in</parameter>
- looks like this:
+looks like this:
</para>
<literallayout>
@@ -2363,32 +2363,32 @@ groups:
<para>
If the Xkb extension has not been properly initialized,
<function>XkbChangeTypesOfKey</function>
- returns
+returns
<errorname>BadAccess</errorname>.
If the
<parameter>xkb</parameter>
- parameter it not valid (that is, it is
+parameter it not valid (that is, it is
<symbol>NULL</symbol>
- or it does not contain a valid client map),
+or it does not contain a valid client map),
<function>XkbChangeTypesOfKey</function>
- returns
+returns
<errorname>BadMatch</errorname>.
If the
<parameter>key</parameter>
- is not a valid keycode,
+is not a valid keycode,
<parameter>n_groups</parameter>
- is greater than
+is greater than
<symbol>XkbNumKbdGroups</symbol>,
or the
<parameter>groups</parameter>
- mask does not contain any of the valid group mask bits,
+mask does not contain any of the valid group mask bits,
<function>XkbChangeTypesOfKey</function>
- returns
+returns
<errorname>BadValue</errorname>.
If it is necessary to resize the key symbols or key actions arrays and any
allocation errors occur,
<function>XkbChangeTypesOfKey</function>
- returns
+returns
<errorname>BadAlloc</errorname>.
</para>
@@ -2452,34 +2452,34 @@ To change the number of symbols bound to a key, use
<para>
<function>XkbResizeKeySyms</function>
- reserves the space needed for
+reserves the space needed for
<parameter>needed</parameter>
- keysyms and returns a pointer to the beginning of the new array that holds the
+keysyms and returns a pointer to the beginning of the new array that holds the
keysyms. It adjusts the
<structfield>offset</structfield>
- field of the
+field of the
<structfield>key_sym_map</structfield>
- entry for the key if necessary and can also change the
+entry for the key if necessary and can also change the
<structfield>syms</structfield>,
<structfield>num_syms</structfield>,
and
<structfield>size_syms</structfield>
- fields of
+fields of
<structfield>xkb-&gt;map</structfield>
- if it is necessary to reallocate the
+if it is necessary to reallocate the
<structfield>syms</structfield>
- array.
+array.
<function>XkbResizeKeySyms</function>
- does not modify either the width or number of groups associated with the key.
+does not modify either the width or number of groups associated with the key.
</para>
<para>
If
<parameter>needed</parameter>
- is greater than the current number of keysyms for the key,
+is greater than the current number of keysyms for the key,
<function>XkbResizeKeySyms</function>
- initializes all new keysyms in the array to
+initializes all new keysyms in the array to
<symbol>NoSymbol</symbol>.
</para>
@@ -2488,17 +2488,17 @@ If
Because the number of symbols needed by a key is normally computed as width *
number of groups, and
<function>XkbResizeKeySyms</function>
- does not modify either the width or number of groups for the key, a
+does not modify either the width or number of groups for the key, a
discrepancy exists upon return from
<function>XkbResizeKeySyms</function>
- between the space allocated for the keysyms and the number required. The
+between the space allocated for the keysyms and the number required. The
unused entries in the list of symbols returned by
<function>XkbResizeKeySyms</function>
- are not preserved across future calls to any of the map editing functions, so
+are not preserved across future calls to any of the map editing functions, so
you must update the key symbol mapping (which updates the width and number of
groups for the key) before calling another allocator function. A call to
<function>XkbChangeTypesOfKey</function>
- will update the mapping.
+will update the mapping.
</para>
@@ -2506,7 +2506,7 @@ groups for the key) before calling another allocator function. A call to
If any allocation errors occur while resizing the number of symbols bound to
the key,
<function>XkbResizeKeySyms</function>
- returns
+returns
<symbol>NULL</symbol>.
</para>
@@ -2524,7 +2524,7 @@ a key.</para></note>
<para>
The
<structfield>modmap</structfield>
- entry of the client map is an array, indexed by keycode, specifying the real
+entry of the client map is an array, indexed by keycode, specifying the real
modifiers bound to a key. Each entry is a mask composed of a bitwise inclusive
OR of the legal real modifiers:
<symbol>ShiftMask</symbol>,
@@ -2538,7 +2538,7 @@ and
<symbol>Mod5Mask</symbol>.
If a bit is set in a
<structfield>modmap</structfield>
- entry, the corresponding key is bound to that modifier.
+entry, the corresponding key is bound to that modifier.
</para>
@@ -2621,14 +2621,14 @@ description, use
<para>
<function>XkbGetKeyModifierMap</function>
- sends a request to the server for the modifier mappings for
+sends a request to the server for the modifier mappings for
<parameter>num</parameter>
- keys starting with the key whose keycode is
+keys starting with the key whose keycode is
<parameter>first</parameter>.
It waits for a reply and places the results in the
<parameter>xkb</parameter>-&gt;map-&gt;modmap array. If successful,
<function>XkbGetKeyModifierMap</function>
- returns
+returns
<symbol>Success</symbol>.
</para>
@@ -2636,9 +2636,9 @@ It waits for a reply and places the results in the
<para>
If the map component of the
<parameter>xkb</parameter>
- parameter has not been allocated,
+parameter has not been allocated,
<function>XkbGetKeyModifierMap</function>
- allocates and initializes it.
+allocates and initializes it.
</para>
@@ -2646,11 +2646,11 @@ If the map component of the
If a compatible version of Xkb is not available in the server or the Xkb
extension has not been properly initialized,
<function>XkbGetKeySyms</function>
- returns
+returns
<errorname>BadAccess</errorname>.
If any allocation errors occur while obtaining the modifier map,
<function>XkbGetKeyModifierMap</function>
- returns
+returns
<errorname>BadAlloc</errorname>.
</para>
</sect2>
diff --git a/specs/XKB/ch16.xml b/specs/XKB/ch16.xml
index 554580de..3f5e42f0 100644
--- a/specs/XKB/ch16.xml
+++ b/specs/XKB/ch16.xml
@@ -12,7 +12,7 @@
<para>
The
<structfield>server</structfield>
- field of the complete Xkb keyboard description (see <link linkend="The_XkbDescRec_Structure">section 6.1</link>) is a pointer
+field of the complete Xkb keyboard description (see <link linkend="The_XkbDescRec_Structure">section 6.1</link>) is a pointer
to the Xkb server map.
</para>
@@ -68,16 +68,16 @@ The
<structfield>acts</structfield>,
and
<structfield>key_acts</structfield>
- fields specify the key actions, defined in <link linkend="Key_Actions">section 16.1</link>. The
+fields specify the key actions, defined in <link linkend="Key_Actions">section 16.1</link>. The
<structfield>behaviors</structfield>
- field describes the behavior for each key and is defined in <link linkend="Key_Behavior">section 16.2</link>. The
+field describes the behavior for each key and is defined in <link linkend="Key_Behavior">section 16.2</link>. The
<structfield>explicit</structfield>
- field describes the explicit components for a key and is defined in
+field describes the explicit components for a key and is defined in
<link linkend="Explicit_ComponentsAvoiding_Automatic_Remapping_by_the_Server">section 16.3</link>. The
<structfield>vmods</structfield>
- and the
+and the
<structfield>vmodmap</structfield>
- fields describe the virtual modifiers and the per-key virtual modifier mapping
+fields describe the virtual modifiers and the per-key virtual modifier mapping
and are defined in <link linkend="Virtual_Modifier_Mapping">section 16.4</link>.
</para>
@@ -89,9 +89,9 @@ A key action defines the effect key presses and releases have on the internal
state of the server. For example, the expected key action associated with
pressing the
<symbol>Shift</symbol>
- key is to set the
+key is to set the
<symbol>Shift</symbol>
- modifier. There is zero or one key action associated with each keysym bound to
+modifier. There is zero or one key action associated with each keysym bound to
each key.
</para>
@@ -99,12 +99,12 @@ each key.
<para>
Just as the entire list of key symbols for the keyboard mapping is held in the
<structfield>syms</structfield>
- field of the client map, the entire list of key actions for the keyboard
+field of the client map, the entire list of key actions for the keyboard
mapping is held in the
<structfield>acts</structfield>
- array of the server map. The total size of
+array of the server map. The total size of
<structfield>acts</structfield>
- is specified by
+is specified by
<structfield>size_acts</structfield>,
and the number of entries is specified by
<structfield>num_acts</structfield>.
@@ -114,44 +114,44 @@ and the number of entries is specified by
<para>
The
<structfield>key_acts</structfield>
- array, indexed by keycode, describes the actions associated with a key. The
+array, indexed by keycode, describes the actions associated with a key. The
<structfield>key_acts</structfield>
- array has
+array has
<structfield>min_key_code</structfield>
- unused entries at the start to allow direct indexing using a keycode. If a
+unused entries at the start to allow direct indexing using a keycode. If a
<structfield>key_acts</structfield>
- entry is
+entry is
<emphasis>zero</emphasis>,
it means the key does not have any actions associated with it. If an entry is
not
<emphasis>zero</emphasis>,
the entry represents an index into the
<structfield>acts</structfield>
- field of the server map, much as the
+field of the server map, much as the
<structfield>offset</structfield>
- field of a
+field of a
<structname>KeySymMapRec</structname>
- structure is an index into the
+structure is an index into the
<structfield>syms</structfield>
- field of the client map.
+field of the client map.
</para>
<para>
The reason the
<structfield>acts</structfield>
- field is a linear list of
+field is a linear list of
<structname>XkbAction</structname>s
- is to reduce the memory consumption associated with a keymap. Because Xkb
+is to reduce the memory consumption associated with a keymap. Because Xkb
allows individual keys to have multiple shift levels and a different number of
groups per key, a single two-dimensional array of
<type>KeySym</type>s
- would potentially be very large and sparse. Instead, Xkb provides a small
+would potentially be very large and sparse. Instead, Xkb provides a small
two-dimensional array of
<structname>XkbAction</structname>s
- for each key. To store all of these individual arrays, Xkb concatenates each
+for each key. To store all of these individual arrays, Xkb concatenates each
array together in the
<structfield>acts</structfield>
- field of the server map.
+field of the server map.
</para>
@@ -206,11 +206,11 @@ to key actions:
<para>
<function>XkbKeyHasActions</function>
- returns
+returns
<symbol>True</symbol>
- if the key corresponding to
+if the key corresponding to
<parameter>keycode</parameter>
- has any actions associated with it; otherwise, it returns
+has any actions associated with it; otherwise, it returns
<symbol>False</symbol>.
</para>
@@ -252,11 +252,11 @@ to key actions:
<para>
<function>XkbKeyNumActions</function>
- computes the number of actions associated with the key corresponding to
+computes the number of actions associated with the key corresponding to
<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>).
+(see <link linkend="Key_Width">section 15.3.3</link>).
</para>
@@ -297,12 +297,12 @@ This should be the same value as the result of
<para>
<function>XkbKeyActionsPtr</function>
- returns a pointer to the two-dimensional array of key actions associated with
+returns a pointer to the two-dimensional array of key actions associated with
the key corresponding to
<parameter>keycode</parameter>.
Use
<function>XkbKeyActionsPtr</function>
- only if the key actually has some actions associated with it, that is,
+only if the key actually has some actions associated with it, that is,
<function>XkbKeyNumActions</function>
(xkb, keycode) returns something greater than zero.
</para>
@@ -356,13 +356,13 @@ Use
<para>
<function>XkbKeyAction</function>
- returns the key action indexed by
+returns the key action indexed by
<parameter>idx</parameter>
- in the two-dimensional array of key actions associated with the key
+in the two-dimensional array of key actions associated with the key
corresponding to
<parameter>keycode</parameter>.
<parameter>idx</parameter>
- may be computed from the group and shift level of interest as follows:
+may be computed from the group and shift level of interest as follows:
</para>
<literallayout>
@@ -428,11 +428,11 @@ corresponding to
<para>
<function>XkbKeyActionEntry</function>
- returns the key action corresponding to group
+returns the key action corresponding to group
<parameter>grp</parameter>
- and shift level
+and shift level
<parameter>shift</parameter>
- from the two-dimensional table of key actions associated with the key
+from the two-dimensional table of key actions associated with the key
corresponding to
<parameter>keycode</parameter>.
</para>
@@ -446,7 +446,7 @@ corresponding to
<para>
The description for an action is held in an
<structname>XkbAction</structname>
- structure, which is a union of all possible Xkb action types:
+structure, which is a union of all possible Xkb action types:
<programlisting>
typedef union _XkbAction {
@@ -470,7 +470,7 @@ typedef union _XkbAction {
<para>
The
<structfield>type</structfield>
- field is provided for convenience and is the same as the type field in the
+field is provided for convenience and is the same as the type field in the
individual structures. The following sections describe the individual
structures for each action in detail.
</para>
@@ -485,7 +485,7 @@ structures for each action in detail.
<para>
The
<structname>XkbAnyAction</structname>
- structure is a convenience structure that refers to any of the actions:
+structure is a convenience structure that refers to any of the actions:
<programlisting>
#define XkbAnyActionDataSize 7
@@ -499,12 +499,12 @@ typedef struct _XkbAnyAction {
<para>
The
<structfield>data</structfield>
- field represents a structure for an action, and its interpretation depends on
+field represents a structure for an action, and its interpretation depends on
the
<structfield>type</structfield>
- field. The valid values for the
+field. The valid values for the
<structfield>type</structfield>
- field, and the data structures associated with them are shown in
+field, and the data structures associated with them are shown in
<link linkend="table16.1">Table 16.1</link>:
</para>
@@ -529,7 +529,7 @@ the
<entry><symbol>XkbSA_NoAction</symbol></entry>
<entry>
<symbol>XkbSA_NoAction</symbol>
- means the server does not perform an action for the key; this action does not
+means the server does not perform an action for the key; this action does not
have an associated data structure.
</entry>
<entry>any</entry>
@@ -636,7 +636,7 @@ have an associated data structure.
<para>
Actions associated with the
<structname>XkbModAction</structname>
- structure change the state of the modifiers when keys are pressed and released
+structure change the state of the modifiers when keys are pressed and released
(see <xref linkend="Virtual_Modifiers" /> for a discussion of modifiers):
<programlisting>
@@ -662,15 +662,15 @@ In the following description, the term
<primary>action modifiers</primary></indexterm>
<indexterm significance="preferred" zone="Actions_for_Changing_Modifiers_State">
<primary>modifiers</primary><secondary>action</secondary></indexterm>
- means the real modifier bits associated with this action. Depending on the
+means the real modifier bits associated with this action. Depending on the
value of
<structfield>flags</structfield>
- (see <link linkend="table16.3">Table 16.3</link>),
- these are designated either in the
+(see <link linkend="table16.3">Table 16.3</link>),
+these are designated either in the
<structfield>mask</structfield>
- field of the
+field of the
<structname>XkbModAction</structname>
- structure itself or the real modifiers bound to the key for which the action
+structure itself or the real modifiers bound to the key for which the action
is being used. In the latter case, this is the client
<structfield>map</structfield>-&gt;<structfield>modmap</structfield>
[
@@ -682,7 +682,7 @@ is being used. In the latter case, this is the client
<para>
The
<structfield>type</structfield>
- field can have any of the values shown in
+field can have any of the values shown in
<link linkend="table16.2">Table 16.2</link>.
</para>
@@ -718,9 +718,9 @@ provided no other key affecting the same modifiers is logically down.
<para>
If no other keys are physically depressed when this key is released, and
<symbol>XkbSA_ClearLocks</symbol>
- is set in the
+is set in the
<structfield>flags</structfield>
- field, the key release unlocks any action modifiers.
+field, the key release unlocks any action modifiers.
</para>
</listitem>
</itemizedlist>
@@ -734,7 +734,7 @@ If no other keys are physically depressed when this key is released, and
<para>
Key press and key release events have the same effect as for
<symbol>XkbSA_SetMods</symbol>;
- if no keys are physically depressed when this key is released, key release
+if no keys are physically depressed when this key is released, key release
events have the following additional effects:
</para>
</listitem>
@@ -742,16 +742,16 @@ events have the following additional effects:
<para>
Modifiers unlocked due to
<symbol>XkbSA_ClearLocks</symbol>
- have no further effect.
+have no further effect.
</para>
</listitem>
<listitem>
<para>
If
<symbol>XkbSA_LatchToLock</symbol>
- is set in the
+is set in the
<structfield>flags</structfield>
- field, a key release locks and then unlatches any remaining action modifiers
+field, a key release locks and then unlatches any remaining action modifiers
that are already latched.
</para>
</listitem>
@@ -759,9 +759,9 @@ that are already latched.
<para>
A key release latches any action modifiers not used by the
<symbol>XkbSA_ClearLocks</symbol>
- and
+and
<symbol>XkbSA_LatchToLock</symbol>
- flags.
+flags.
</para>
</listitem>
</itemizedlist>
@@ -775,9 +775,9 @@ A key release latches any action modifiers not used by the
<para>
A key press sets the base state of any action modifiers. If
<symbol>XkbSA_LockNoLock</symbol>
- is set in the
+is set in the
<structfield>flags</structfield>
- field, a key press also sets the locked state of any action modifiers.
+field, a key press also sets the locked state of any action modifiers.
</para>
</listitem>
<listitem>
@@ -785,9 +785,9 @@ A key press sets the base state of any action modifiers. If
A key release clears any action modifiers in the keyboard’s base modifiers,
provided no other key that affects the same modifiers is down. If
<symbol>XkbSA_LockNoUnlock</symbol>
- is not set in the
+is not set in the
<structfield>flags</structfield>
- field, and any of the action modifiers were locked before the corresponding
+field, and any of the action modifiers were locked before the corresponding
key press occurred, a key release unlocks them.
</para>
</listitem>
@@ -801,9 +801,9 @@ key press occurred, a key release unlocks them.
<para>
The
<structfield>flags</structfield>
- field is composed of the bitwise inclusive OR of the masks shown in
+field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.3">Table 16.3</link>.
- A general meaning is given in the table, but the exact meaning depends on
+A general meaning is given in the table, but the exact meaning depends on
the action <structfield>type</structfield>.
</para>
@@ -831,7 +831,7 @@ modifiers specified by the
<structfield>vmods1</structfield>,
and
<structfield>vmods2</structfield>
- fields.
+fields.
</entry>
</row>
<row>
@@ -872,9 +872,9 @@ the server only locks the action modifiers.
<para>
If
<symbol>XkbSA_UseModMapMods</symbol>
- is not set in the
+is not set in the
<structfield>flags</structfield>
- field, the
+field, the
<structfield>mask</structfield>,
<structfield>real_mods</structfield>,
<structfield>vmods1</structfield>,
@@ -896,22 +896,22 @@ The
<structfield>vmods1</structfield>,
and
<structfield>vmods2</structfield>
- fields represent the components of an Xkb modifier description
+fields represent the components of an Xkb modifier description
(see <link linkend="Modifier_Definitions">section 7.2</link>). While the
<structfield>mask</structfield>
- and
+and
<structfield>real_mods</structfield>
- fields correspond directly to the
+fields correspond directly to the
<structfield>mask</structfield>
- and
+and
<structfield>real_mods</structfield>
- fields of an Xkb modifier description, the
+fields of an Xkb modifier description, the
<structfield>vmods1</structfield>
- and
+and
<structfield>vmods2</structfield>
- fields are combined to correspond to the
+fields are combined to correspond to the
<structfield>vmods</structfield>
- field of an Xkb modifier description. Xkb provides the following macros, to
+field of an Xkb modifier description. Xkb provides the following macros, to
convert between the two formats:
</para>
@@ -941,15 +941,15 @@ convert between the two formats:
<para>
<function>XkbModActionVMods</function>
- returns the
+returns the
<structfield>vmods1</structfield>
- and
+and
<structfield>vmods2</structfield>
- fields of
+fields of
<parameter>act</parameter>
- converted to the
+converted to the
<structfield>vmods</structfield>
- format of an Xkb modifier description.
+format of an Xkb modifier description.
</para>
@@ -990,21 +990,21 @@ convert between the two formats:
<para>
<function>XkbSetModActionVMods</function>
- sets the
+sets the
<structfield>vmods1</structfield>
- and
+and
<structfield>vmods2</structfield>
- fields of
+fields of
<parameter>act</parameter>
- using the
+using the
<parameter>vmods</parameter>
- format of an Xkb modifier description.
+format of an Xkb modifier description.
</para>
<note><para>Despite the fact that the first parameter of these two macros is of
type XkbAction, these macros may be used only with Actions of type
<structname>XkbModAction</structname>
- and
+and
<structname>XkbISOAction</structname>.
</para></note>
@@ -1018,7 +1018,7 @@ type XkbAction, these macros may be used only with Actions of type
<para>
Actions associated with the
<structname>XkbGroupAction</structname>
- structure change the current group state when keys are pressed and released
+structure change the current group state when keys are pressed and released
(see <xref linkend="Keyboard_State" /> for a description of groups and keyboard state):
<programlisting>
@@ -1032,7 +1032,7 @@ typedef struct _XkbGroupAction {
<para>
The
<structfield>type</structfield>
- field can have any of the following values:
+field can have any of the following values:
</para>
<table id='table16.4' frame='topbot'>
@@ -1056,25 +1056,25 @@ The
<para>
If the
<symbol>XkbSA_GroupAbsolute</symbol>
- bit is set in the
+bit is set in the
<structfield>flags</structfield>
- field, key press events change the base keyboard group to the group specified
+field, key press events change the base keyboard group to the group specified
by the
<structfield>group_XXX</structfield>
- field. Otherwise, key press events change the base keyboard group by adding
+field. Otherwise, key press events change the base keyboard group by adding
the
<structfield>group_XXX</structfield>
- field to the base keyboard group. In either case, the resulting effective
+field to the base keyboard group. In either case, the resulting effective
keyboard group is brought back into range depending on the value of the
<structfield>groups_wrap</structfield>
- field of the controls structure (see <link linkend="The_GroupsWrap_Control">section 10.7.1</link>).
+field of the controls structure (see <link linkend="The_GroupsWrap_Control">section 10.7.1</link>).
</para>
</listitem>
<listitem>
<para>
If a key with an
<symbol>XkbSA_ISOLock</symbol>
- action (see <link linkend="Actions_for_Locking_Modifiers_and_Group">section 16.1.8</link>) is pressed while this key is down, the key release
+action (see <link linkend="Actions_for_Locking_Modifiers_and_Group">section 16.1.8</link>) is pressed while this key is down, the key release
of this key has no effect. Otherwise, the key release cancels the effects of
the key press.
</para>
@@ -1083,7 +1083,7 @@ the key press.
<para>
If the
<symbol>XkbSA_ClearLocks</symbol>
- bit is set in the flags field, and no keys are physically depressed when this
+bit is set in the flags field, and no keys are physically depressed when this
key is released, the key release also sets the locked keyboard group to
<emphasis>Group1</emphasis>.
</para>
@@ -1099,7 +1099,7 @@ key is released, the key release also sets the locked keyboard group to
<para>
Key press and key release events have the same effect as for
<symbol>XkbSA_SetGroup</symbol>;
- if no keys are physically depressed when this key is released, key release
+if no keys are physically depressed when this key is released, key release
events have the following additional effects.
</para>
</listitem>
@@ -1107,14 +1107,14 @@ events have the following additional effects.
<para>
If the
<symbol>XkbSA_LatchToLock</symbol>
- bit is set in the
+bit is set in the
<structfield>flags</structfield>
- field and the latched keyboard group index is nonzero, the key release adds
+field and the latched keyboard group index is nonzero, the key release adds
the delta applied by the corresponding key press to the locked keyboard group
and subtracts it from the latched keyboard group. The locked and effective
keyboard group are brought back into range according to the value of the
<structfield>groups_wrap</structfield>
- field of the controls structure.
+field of the controls structure.
</para>
</listitem>
<listitem>
@@ -1133,18 +1133,18 @@ Otherwise, the key press adds the key press delta to the latched keyboard group.
<para>
If the
<symbol>XkbSA_GroupAbsolute</symbol>
- is set in the
+is set in the
<structfield>flags</structfield>
- field, key press events set the locked keyboard group to the group specified
+field, key press events set the locked keyboard group to the group specified
by the
<structfield>group_XXX</structfield>
- field. Otherwise, key press events add the group specified by the
+field. Otherwise, key press events add the group specified by the
<structfield>group_XXX</structfield>
- field to the locked keyboard group. In either case, the resulting locked and
+field to the locked keyboard group. In either case, the resulting locked and
effective keyboard groups are brought back into range depending on the value of
the
<structfield>groups_wrap</structfield>
- field of the controls structure.
+field of the controls structure.
</para>
</listitem>
<listitem>
@@ -1162,9 +1162,9 @@ A key release has no effect.
<para>
The
<structfield>flags</structfield>
- field is composed of the bitwise inclusive OR of the masks shown in
+field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.5">Table 16.5</link>.
- A general meaning is given in the table, but the exact meaning depends on
+A general meaning is given in the table, but the exact meaning depends on
the action
<structfield>type</structfield>.
</para>
@@ -1188,7 +1188,7 @@ the action
If set and no keys are physically depressed when this key transition occurs,
the server sets the locked keyboard group to
<emphasis>Group1</emphasis>
- on a key release.
+on a key release.
</entry>
</row>
<row>
@@ -1204,7 +1204,7 @@ the server locks the action group if it is already latched.
<entry>
If set, the
<structfield>group_XXX</structfield>
- field represents an absolute group number. Otherwise, it represents a group
+field represents an absolute group number. Otherwise, it represents a group
delta to be added to the current group to determine the new group number.
</entry>
</row>
@@ -1215,7 +1215,7 @@ delta to be added to the current group to determine the new group number.
<para>
The
<structfield>group_XXX</structfield>
- field represents a signed character. Xkb provides the following macros to
+field represents a signed character. Xkb provides the following macros to
convert between a signed integer value and a signed character:
</para>
@@ -1245,11 +1245,11 @@ convert between a signed integer value and a signed character:
<para>
<function>XkbSAGroup</function>
- returns the
+returns the
<structfield>group_XXX</structfield>
- field of
+field of
<parameter>act</parameter>
- converted to a signed int.
+converted to a signed int.
</para>
@@ -1290,18 +1290,18 @@ convert between a signed integer value and a signed character:
<para>
<function>XkbSASetGroup</function>
- sets the
+sets the
<structfield>group_XXX</structfield>
- field of
+field of
<parameter>act</parameter>
- from the group index
+from the group index
<parameter>grp</parameter>.
</para>
<note><para>Despite the fact that the first parameter of these two macros is of
type XkbAction, these macros may only be used with Actions of type
<structname>XkbGroupAction</structname>
- and
+and
<structname>XkbISOAction</structname>.
</para></note>
@@ -1315,7 +1315,7 @@ type XkbAction, these macros may only be used with Actions of type
<para>
Actions associated with the
<structname>XkbPtrAction</structname>
- structure move the pointer when keys are pressed and released:
+structure move the pointer when keys are pressed and released:
<programlisting>
typedef struct _XkbPtrAction {
@@ -1331,38 +1331,38 @@ typedef struct _XkbPtrAction {
<para>
If the
<emphasis>MouseKeys</emphasis>
- control is not enabled (see <link linkend="The_MouseKeys_Control">section 10.5.1</link>),
+control is not enabled (see <link linkend="The_MouseKeys_Control">section 10.5.1</link>),
<symbol>KeyPress</symbol>
- and
+and
<symbol>KeyRelease</symbol>
- events are treated as though the action is
+events are treated as though the action is
<symbol>XkbSA_NoAction</symbol>.
</para>
<para>
If the
<emphasis>MouseKeys</emphasis>
- control is enabled, a server action of type
+control is enabled, a server action of type
<symbol>XkbSA_MovePtr</symbol>
- instructs the server to generate core pointer
+instructs the server to generate core pointer
<symbol>MotionNotify</symbol>
- events rather than the usual
+events rather than the usual
<symbol>KeyPress</symbol>
- event, and the corresponding
+event, and the corresponding
<symbol>KeyRelease</symbol>
- event disables any mouse keys timers that were created as a result of handling
+event disables any mouse keys timers that were created as a result of handling
the
<symbol>XkbSA_MovePtr</symbol>
- action.
+action.
</para>
<para>
The
<structfield>type</structfield>
- field of the
+field of the
<structname>XkbPtrAction</structname>
- structure is always
+structure is always
<symbol>XkbSA_MovePtr</symbol>.
</para>
@@ -1370,7 +1370,7 @@ The
<para>
The
<structfield>flags</structfield>
- field is a bitwise inclusive OR of the masks shown in
+field is a bitwise inclusive OR of the masks shown in
<link linkend="table16.6">Table 16.6</link>.
</para>
@@ -1392,9 +1392,9 @@ The
<entry>
If not set, and the
<emphasis>MouseKeysAccel</emphasis>
- control is enabled (see <link linkend="The_MouseKeysAccel_Control">section 10.5.2</link>), the
+control is enabled (see <link linkend="The_MouseKeysAccel_Control">section 10.5.2</link>), the
<symbol>KeyPress</symbol>
- initiates a mouse keys timer for this key; every time the timer expires, the
+initiates a mouse keys timer for this key; every time the timer expires, the
cursor moves.
</entry>
</row>
@@ -1420,15 +1420,15 @@ to the current pointer Y coordinate to determine the new pointer Y coordinate.
<para>
Each of the X and Y coordinates of the
<structname>XkbPtrAction</structname>
- structure is composed of two signed 16-bit values, that is, the X coordinate
+structure is composed of two signed 16-bit values, that is, the X coordinate
is composed of
<structfield>high_XXX</structfield>
- and
+and
<structfield>low_XXX</structfield>,
and similarly for the Y coordinate. Xkb provides the following macros, to
convert between a signed integer and two signed 16-bit values in
<structname>XkbPtrAction</structname>
- structures:
+structures:
</para>
<indexterm significance="preferred" zone="XkbPtrActionX"><primary><function>XkbPtrActionX</function></primary></indexterm>
@@ -1457,13 +1457,13 @@ convert between a signed integer and two signed 16-bit values in
<para>
<function>XkbPtrActionX</function>
- returns the
+returns the
<structfield>high_XXX</structfield>
- and
+and
<structfield>low_XXX</structfield>
- fields of
+fields of
<parameter>act</parameter>
- converted to a signed int.
+converted to a signed int.
</para>
@@ -1493,13 +1493,13 @@ convert between a signed integer and two signed 16-bit values in
<para>
<function>XkbPtrActionY</function>
- returns the
+returns the
<structfield>high_YYY</structfield>
- and
+and
<structfield>low_YYY</structfield>
- fields of
+fields of
<parameter>act</parameter>
- converted to a signed int.
+converted to a signed int.
</para>
@@ -1541,13 +1541,13 @@ convert between a signed integer and two signed 16-bit values in
<para>
<function>XkbSetPtrActionX</function>
- sets the
+sets the
<structfield>high_XXX</structfield>
- and
+and
<structfield>low_XXX</structfield>
- fields of
+fields of
<parameter>act</parameter>
- from the signed integer value
+from the signed integer value
<parameter>x</parameter>.
</para>
@@ -1589,13 +1589,13 @@ convert between a signed integer and two signed 16-bit values in
<para>
<function>XkbSetPtrActionX</function>
- sets the
+sets the
<structfield>high_YYY</structfield>
- and
+and
<structfield>low_YYY</structfield>
- fields of
+fields of
<parameter>act</parameter>
- from the signed integer value
+from the signed integer value
<parameter>y</parameter>.
</para>
@@ -1609,7 +1609,7 @@ convert between a signed integer and two signed 16-bit values in
<para>
Actions associated with the
<structname>XkbPtrBtnAction</structname>
- structure simulate the press and release of pointer buttons when keys are
+structure simulate the press and release of pointer buttons when keys are
pressed and released:
<programlisting>
@@ -1626,11 +1626,11 @@ typedef struct _XkbPtrBtnAction {
<para>
If the
<emphasis>MouseKeys</emphasis>
- (see <link linkend="The_MouseKeys_Control">section 10.5.1</link>) control is not enabled,
+(see <link linkend="The_MouseKeys_Control">section 10.5.1</link>) control is not enabled,
<symbol>KeyPress</symbol>
- and
+and
<symbol>KeyRelease</symbol>
- events are treated as though the action is
+events are treated as though the action is
<symbol>XkbSA_NoAction</symbol>.
</para>
@@ -1638,7 +1638,7 @@ If the
<para>
The
<structfield>type</structfield>
- field can have any one of the values shown in
+field can have any one of the values shown in
<link linkend="table16.7">Table 16.7</link>.
</para>
@@ -1663,16 +1663,16 @@ The
<para>
If
<symbol>XkbSA_UseDfltButton</symbol>
- is set in the
+is set in the
<structfield>flags</structfield>
- field, the event is generated for the pointer button specified by the
+field, the event is generated for the pointer button specified by the
<structfield>mk_dflt_btn</structfield>
- attribute of the
+attribute of the
<emphasis>MouseKeys</emphasis>
- control (see <link linkend="The_MouseKeys_Control">section 10.5.1</link>). Otherwise, the event is generated for the button
+control (see <link linkend="The_MouseKeys_Control">section 10.5.1</link>). Otherwise, the event is generated for the button
specified by the
<structfield>button</structfield>
- field.
+field.
</para>
</listitem>
<listitem>
@@ -1681,42 +1681,42 @@ If the mouse button specified for this action is logically down, the key press
and corresponding key release are ignored and have no effect. Otherwise, a key
press causes one or more core pointer button events instead of the usual
<symbol>KeyPress</symbol>
- event. If
+event. If
<structfield>count</structfield>
- is
+is
<emphasis>zero</emphasis>,
a key press generates a single
<symbol>ButtonPress</symbol>
- event; if
+event; if
<structfield>count</structfield>
- is greater than
+is greater than
<emphasis>zero</emphasis>,
a key press generates
<structfield>count</structfield>
- pairs of
+pairs of
<symbol>ButtonPress</symbol>
- and
+and
<symbol>ButtonRelease</symbol>
- events.
+events.
</para>
</listitem>
<listitem>
<para>
If
<structfield>count</structfield>
- is
+is
<emphasis>zero</emphasis>,
a key release generates a core pointer
<symbol>ButtonRelease</symbol>
- that matches the event generated by the corresponding
+that matches the event generated by the corresponding
<symbol>KeyPress</symbol>;
- if
+if
<structfield>count</structfield>
- is nonzero, a key release does not cause a
+is nonzero, a key release does not cause a
<symbol>ButtonRelease</symbol>
- event. A key release never generates a key
+event. A key release never generates a key
<symbol>KeyRelease</symbol>
- event.
+event.
</para>
</listitem>
</itemizedlist>
@@ -1730,31 +1730,31 @@ a key release generates a core pointer
<para>
If the button specified by the
<emphasis>MouseKeys</emphasis>
- default button
+default button
or
<structfield>button</structfield>
- is not locked, a key press causes a
+is not locked, a key press causes a
<symbol>ButtonPress</symbol>
- event instead of a
+event instead of a
<symbol>KeyPress</symbol>
- event and locks the button. If the button is already locked or if
+event and locks the button. If the button is already locked or if
<symbol>XkbSA_LockNoUnlock</symbol>
- is set in the
+is set in the
<structfield>flags</structfield>
- field, a key press is ignored and has no effect.
+field, a key press is ignored and has no effect.
</para>
</listitem>
<listitem>
<para>
If the corresponding key press was ignored, and if
<symbol>XkbSA_LockNoLock</symbol>
- is not set in the
+is not set in the
<structfield>flags</structfield>
- field, a key release generates a
+field, a key release generates a
<symbol>ButtonRelease</symbol>
- event instead of a
+event instead of a
<symbol>KeyRelease</symbol>
- event and unlocks the specified button. If the corresponding key press locked
+event and unlocks the specified button. If the corresponding key press locked
a button, the key release is ignored and has no effect.
</para>
</listitem>
@@ -1768,9 +1768,9 @@ a button, the key release is ignored and has no effect.
<para>
The
<structfield>flags</structfield>
- field is composed of the bitwise inclusive OR of the masks shown in
+field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.8">Table 16.8</link>.
- A general meaning is given in the table, but the exact meaning depends on
+A general meaning is given in the table, but the exact meaning depends on
the action
<structfield>type</structfield>:
</para>
@@ -1793,9 +1793,9 @@ the action
<entry>
If set, the action uses the pointer button specified by the
<structfield>mk_dflt_btn</structfield>
- attribute of the
+attribute of the
<emphasis>MouseKeys</emphasis>
- control (see <link linkend="The_MouseKeys_Control">section 10.5.1</link>). Otherwise, the action uses the pointer button
+control (see <link linkend="The_MouseKeys_Control">section 10.5.1</link>). Otherwise, the action uses the pointer button
specified by the
<structfield>button</structfield>
field.
@@ -1830,11 +1830,11 @@ the server only locks the pointer button.
<para>
Actions associated with the
<structname>XkbPtrDfltAction</structname>
- structure change the
+structure change the
<structfield>mk_dflt_btn</structfield>
- attribute of the
+attribute of the
<emphasis>MouseKeys</emphasis>
- control (see <link linkend="The_MouseKeys_Control">section 10.5.1</link>):
+control (see <link linkend="The_MouseKeys_Control">section 10.5.1</link>):
<programlisting>
typedef struct _XkbPtrDfltAction {
@@ -1848,26 +1848,26 @@ typedef struct _XkbPtrDfltAction {
<para>
If the
<emphasis>MouseKeys</emphasis>
- control is not enabled,
+control is not enabled,
<symbol>KeyPress</symbol>
- and
+and
<symbol>KeyRelease</symbol>
- events are treated as though the action is
+events are treated as though the action is
<symbol>XkbSA_NoAction</symbol>.
Otherwise, this action changes the
<structfield>mk_dflt_btn</structfield>
- attribute of the
+attribute of the
<emphasis>MouseKeys</emphasis>
- control.
+control.
</para>
<para>
The
<structfield>type</structfield>
- field of the
+field of the
<structname>XkbPtrDfltAction</structname>
- structure should always be
+structure should always be
<symbol>XkbSA_SetPtrDflt</symbol>.
</para>
@@ -1875,9 +1875,9 @@ The
<para>
The
<structfield>flags</structfield>
- field is composed of the bitwise inclusive OR of the values shown in
+field is composed of the bitwise inclusive OR of the values shown in
<link linkend="table16.9">Table 16.9</link>
- (currently there is only one value defined).
+(currently there is only one value defined).
</para>
<table id='table16.9' frame='topbot'>
@@ -1898,9 +1898,9 @@ The
<entry>
If set, the
<structfield>value</structfield>
- field represents an absolute pointer button. Otherwise, the
+field represents an absolute pointer button. Otherwise, the
<structfield>value</structfield>
- field represents the amount to be added to the current default button.
+field represents the amount to be added to the current default button.
</entry>
</row>
</tbody>
@@ -1910,32 +1910,32 @@ If set, the
<para>
The
<structfield>affect</structfield>
- field specifies what changes as a result of this action. The only valid value
+field specifies what changes as a result of this action. The only valid value
for the
<structfield>affect</structfield>
- field is <symbol>XkbSA_AffectDfltBtn</symbol>.
+field is <symbol>XkbSA_AffectDfltBtn</symbol>.
</para>
<para>
The
<structfield>valueXXX</structfield>
- field is a signed character that represents the new button value for the
+field is a signed character that represents the new button value for the
<structfield>mk_dflt_btn</structfield>
- attribute of the
+attribute of the
<emphasis>MouseKeys</emphasis>
- control (see <link linkend="The_MouseKeys_Control">section 10.5.1</link>). If
+control (see <link linkend="The_MouseKeys_Control">section 10.5.1</link>). If
<symbol>XkbSA_DfltBtnAbsolute</symbol>
- is set in
+is set in
<structfield>flags</structfield>,
<structfield>valueXXX</structfield>
- specifies the button to be used; otherwise,
+specifies the button to be used; otherwise,
<structfield>valueXXX</structfield>
- specifies the amount to be added to the current default button. In either
+specifies the amount to be added to the current default button. In either
case, illegal button choices are wrapped back around into range. Xkb provides
the following macros, to convert between the integer and signed character
values in
<structname>XkbPtrDfltAction</structname>
- structures:
+structures:
</para>
<indexterm significance="preferred" zone="XkbSAPtrDfltValue"><primary><function>XkbSAPtrDfltValue</function></primary></indexterm>
@@ -1964,11 +1964,11 @@ values in
<para>
<function>XkbSAPtrDfltValue</function>
- returns the
+returns the
<structfield>valueXXX</structfield>
- field of
+field of
<parameter>act</parameter>
- converted to a signed int.
+converted to a signed int.
</para>
@@ -2009,11 +2009,11 @@ values in
<para>
<function>XkbSASetPtrDfltValue</function>
- sets the
+sets the
<structfield>valueXXX</structfield>
- field of
+field of
<parameter>act</parameter>
- from
+from
<parameter>val</parameter>.
</para>
@@ -2027,23 +2027,23 @@ values in
<para>
Actions associated with the
<structname>XkbISOAction</structname>
- structure lock modifiers and the group according to the ISO9995 specification.
+structure lock modifiers and the group according to the ISO9995 specification.
</para>
<para>
Operated by itself, the
<structname>XkbISOAction</structname>
- is just a caps lock. Operated simultaneously with another modifier key, it
+is just a caps lock. Operated simultaneously with another modifier key, it
transforms the other key into a locking key. For example, press
<keysym>ISO_Lock</keysym>,
press and release
<keysym>Control_L</keysym>,
release
<keysym>ISO_Lock</keysym>
- ends up locking the
+ends up locking the
<symbol>Control</symbol>
- modifier.
+modifier.
</para>
@@ -2061,11 +2061,11 @@ The default behavior is to convert:
<para>
The
<emphasis>affects</emphasis>
- field allows you to turn those effects on or off individually. Set
+field allows you to turn those effects on or off individually. Set
<symbol>XkbSA_ISONoAffectMods</symbol>
- to disable the first,
+to disable the first,
<symbol>XkbSA_ISONoAffectGroup</symbol>
- to disable the second, and so forth.
+to disable the second, and so forth.
</para>
<para><programlisting>
@@ -2090,9 +2090,9 @@ typedef struct _XkbISOAction {
<para>
The
<structfield>type</structfield>
- field of the
+field of the
<structname>XkbISOAction</structname>
- structure should always be
+structure should always be
<symbol>XkbSA_ISOLock</symbol>.
</para>
@@ -2100,23 +2100,23 @@ The
<para>
The interpretation of the
<structfield>flags</structfield>
- field depends on whether the
+field depends on whether the
<symbol>XkbSA_ISODfltIsGroup</symbol>
- is set in the
+is set in the
<structfield>flags</structfield>
- field or not.
+field or not.
</para>
<para>
If the
<symbol>XkbSA_ISODfltIsGroup</symbol>
- is set in the
+is set in the
<structfield>flags</structfield>
- field, the action is used to change the group state. The remaining valid bits
+field, the action is used to change the group state. The remaining valid bits
of the
<structfield>flags</structfield>
- field are composed of a bitwise inclusive OR using the masks shown in
+field are composed of a bitwise inclusive OR using the masks shown in
<link linkend="table16.10">Table 16.10</link>.
</para>
@@ -2143,13 +2143,13 @@ remaining bits in this table to carry their interpretations.
<para>
A key press sets the base group as specified by the
<structfield>group_XXX</structfield>
- field and the
+field and the
<symbol>XkbSA_GroupAbsolute</symbol>
- bit of the
+bit of the
<structfield>flags</structfield>
- field (see section Note). If no other actions are transformed by the
+field (see section Note). If no other actions are transformed by the
<symbol>XkbSA_ISOLock</symbol>
- action, a key release locks the group. Otherwise, a key release clears group
+action, a key release locks the group. Otherwise, a key release clears group
set by the key press.
</para>
</entry>
@@ -2159,7 +2159,7 @@ set by the key press.
<entry>
If set, the
<structfield>group_XXX</structfield>
- field represents an absolute group number. Otherwise, it represents a group
+field represents an absolute group number. Otherwise, it represents a group
delta to be added to the current group to determine the new group number.
</entry>
</row>
@@ -2168,13 +2168,13 @@ delta to be added to the current group to determine the new group number.
<entry>
If not set, any
<symbol>XkbSA_SetMods</symbol>
- or
+or
<symbol>XkbSA_LatchMods</symbol>
- actions that occur simultaneously with the
+actions that occur simultaneously with the
<symbol>XkbSA_ISOLock</symbol>
- action are treated as
+action are treated as
<symbol>XkbSA_LockMods</symbol>
- actions instead.
+actions instead.
</entry>
</row>
<row>
@@ -2182,13 +2182,13 @@ If not set, any
<entry>
If not set, any
<symbol>XkbSA_SetGroup</symbol>
- or
+or
<symbol>XkbSA_LatchGroup</symbol>
- actions that occur simultaneously with the
+actions that occur simultaneously with the
<symbol>XkbSA_ISOLock</symbol>
- action are treated as
+action are treated as
<symbol>XkbSA_LockGroup</symbol>
- actions instead.
+actions instead.
</entry>
</row>
<row>
@@ -2196,11 +2196,11 @@ If not set, any
<entry>
If not set, any
<symbol>XkbSA_PtrBtn</symbol>
- actions that occur simultaneously with the
+actions that occur simultaneously with the
<symbol>XkbSA_ISOLock</symbol>
- action are treated as
+action are treated as
<symbol>XkbSA_LockPtrBtn</symbol>
- actions instead.
+actions instead.
</entry>
</row>
<row>
@@ -2208,11 +2208,11 @@ If not set, any
<entry>
If not set, any
<symbol>XkbSA_SetControls</symbol>
- actions that occur simultaneously with the
+actions that occur simultaneously with the
<symbol>XkbSA_ISOLock</symbol>
- action are treated as
+action are treated as
<symbol>XkbSA_LockControls</symbol>
- actions instead.
+actions instead.
</entry>
</row>
</tbody>
@@ -2222,12 +2222,12 @@ If not set, any
<para>
If the
<symbol>XkbSA_ISODfltIsGroup</symbol>
- is not set in the
+is not set in the
<structfield>flags</structfield>
- field, the action is used to change the modifier state and the remaining valid
+field, the action is used to change the modifier state and the remaining valid
bits of the
<structfield>flags</structfield>
- field are composed of a bitwise inclusive OR using the masks shown in
+field are composed of a bitwise inclusive OR using the masks shown in
<link linkend="table16.11">Table 16.11</link>.
</para>
@@ -2261,7 +2261,7 @@ and
<structfield>vmods2</structfield>
fields (see <link linkend="Actions_for_Changing_Modifiers_State">section 16.1.3</link>). If no other actions are transformed by the
<symbol>XkbSA_ISOLock</symbol>
- action, a key release locks the action modifiers. Otherwise, a key release
+action, a key release locks the action modifiers. Otherwise, a key release
clears the base modifiers set by the key press.
</para>
</entry>
@@ -2277,7 +2277,7 @@ modifiers specified by the
<structfield>vmods1</structfield>,
and
<structfield>vmods2</structfield>
- fields.
+fields.
</entry>
</row>
<row>
@@ -2293,13 +2293,13 @@ and
<entry>
If not set, any
<symbol>XkbSA_SetMods</symbol>
- or
+or
<symbol>XkbSA_LatchMods</symbol>
- actions that occur simultaneously with the
+actions that occur simultaneously with the
<symbol>XkbSA_ISOLock</symbol>
- action are treated as
+action are treated as
<symbol>XkbSA_LockMods</symbol>
- actions instead.
+actions instead.
</entry>
</row>
<row>
@@ -2307,13 +2307,13 @@ If not set, any
<entry>
If not set, any
<symbol>XkbSA_SetGroup</symbol>
- or
+or
<symbol>XkbSA_LatchGroup</symbol>
- actions that occur simultaneously with the
+actions that occur simultaneously with the
<symbol>XkbSA_ISOLock</symbol>
- action are treated as
+action are treated as
<symbol>XkbSA_LockGroup</symbol>
- actions instead.
+actions instead.
</entry>
</row>
<row>
@@ -2321,11 +2321,11 @@ If not set, any
<entry>
If not set, any
<symbol>XkbSA_PtrBtn</symbol>
- actions that occur simultaneously with the
+actions that occur simultaneously with the
<symbol>XkbSA_ISOLock</symbol>
- action are treated as
+action are treated as
<symbol>XkbSA_LockPtrBtn</symbol>
- actions instead.
+actions instead.
</entry>
</row>
<row>
@@ -2333,11 +2333,11 @@ If not set, any
<entry>
If not set, any
<symbol>XkbSA_SetControls</symbol>
- actions that occur simultaneously with the
+actions that occur simultaneously with the
<symbol>XkbSA_ISOLock</symbol>
- action are treated as
+action are treated as
<symbol>XkbSA_LockControls</symbol>
- actions instead.
+actions instead.
</entry>
</row>
</tbody>
@@ -2347,7 +2347,7 @@ If not set, any
<para>
The
<structfield>group_XXX</structfield>
- field represents a signed character. Xkb provides macros to convert between a
+field represents a signed character. Xkb provides macros to convert between a
signed integer value and a signed character as shown in section Note.
</para>
@@ -2359,22 +2359,22 @@ The
<structfield>vmods1</structfield>,
and
<structfield>vmods2</structfield>
- fields represent the components of an Xkb modifier description
- (see <link linkend="Modifier_Definitions">section 7.2</link>). While the
+fields represent the components of an Xkb modifier description
+(see <link linkend="Modifier_Definitions">section 7.2</link>). While the
<structfield>mask</structfield>
- and
+and
<structfield>real_mods</structfield>
- fields correspond directly to the
+fields correspond directly to the
<structfield>mask</structfield>
- and
+and
<structfield>real_mods</structfield>
- fields of an Xkb modifier description, the
+fields of an Xkb modifier description, the
<structfield>vmods1</structfield>
- and
+and
<structfield>vmods2</structfield>
- fields are combined to correspond to the
+fields are combined to correspond to the
<structfield>vmods</structfield>
- field of an Xkb modifier description. Xkb provides macros to convert between
+field of an Xkb modifier description. Xkb provides macros to convert between
the two formats as shown in <link linkend="Actions_for_Changing_Modifiers_State">section 16.1.3</link>.
</para>
@@ -2382,7 +2382,7 @@ the two formats as shown in <link linkend="Actions_for_Changing_Modifiers_State"
<para>
The
<structfield>affect</structfield>
- field is composed of a bitwise inclusive OR using the masks shown in
+field is composed of a bitwise inclusive OR using the masks shown in
<link linkend="table16.11">Table 16.11</link>.
</para>
@@ -2404,15 +2404,15 @@ The
<entry>
If
<symbol>XkbSA_ISONoAffectMods</symbol>
- is not set, any
+is not set, any
<emphasis>SA_SetMods</emphasis>
- or
+or
<emphasis>SA_LatchMods</emphasis>
- actions occurring simultaneously with the
+actions occurring simultaneously with the
<structname>XkbISOAction</structname>
- are treated as
+are treated as
<emphasis>SA_LockMods</emphasis>
- instead.
+instead.
</entry>
</row>
<row>
@@ -2420,15 +2420,15 @@ If
<entry>
If
<symbol>XkbSA_ISONoAffectGroup</symbol>
- is not set, any
+is not set, any
<emphasis>SA_SetGroup</emphasis>
- or
+or
<emphasis>SA_LatchGroup</emphasis>
- actions occurring simultaneously with the
+actions occurring simultaneously with the
<structname>XkbISOAction</structname>
- are treated as
+are treated as
<emphasis>SA_LockGroup</emphasis>
- instead.
+instead.
</entry>
</row>
<row>
@@ -2436,13 +2436,13 @@ If
<entry>
If
<symbol>XkbSA_ISONoAffectPtr</symbol>
- is not set, any
+is not set, any
<emphasis>SA_PtrBtn</emphasis>
- actions occurring simultaneously with the
+actions occurring simultaneously with the
<structname>XkbISOAction</structname>
- are treated as
+are treated as
<emphasis>SA_LockPtrBtn</emphasis>
- instead.
+instead.
</entry>
</row>
<row>
@@ -2450,13 +2450,13 @@ If
<entry>
If
<symbol>XkbSA_ISONoAffectCtrls</symbol>
- is not set, any
+is not set, any
<emphasis>SA_SetControls</emphasis>
- actions occurring simultaneously with the
+actions occurring simultaneously with the
<structname>XkbISOAction</structname>
- are treated as
+are treated as
<emphasis>SA_LockControls</emphasis>
- instead.
+instead.
</entry>
</row>
</tbody>
@@ -2472,7 +2472,7 @@ If
<para>
Actions associated with the
<structname>XkbSwitchScreenAction</structname>
- action structure change the active screen on a multiscreen display:
+action structure change the active screen on a multiscreen display:
</para>
<note><para>This action is optional. Servers are free to ignore the action or
@@ -2493,9 +2493,9 @@ typedef struct _XkbSwitchScreenAction {
<para>
The
<structfield>type</structfield>
- field of the
+field of the
<structname>XkbSwitchScreenAction</structname>
- structure should always be
+structure should always be
<symbol>XkbSA_SwitchScreen</symbol>.
</para>
@@ -2503,7 +2503,7 @@ The
<para>
The
<structfield>flags</structfield>
- field is composed of the bitwise inclusive OR of the masks shown in
+field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.13">Table 16.13</link>.
</para>
@@ -2525,7 +2525,7 @@ The
<entry>
If set, the
<structfield>screenXXX</structfield>
- field represents the index of the new screen. Otherwise, it represents an
+field represents the index of the new screen. Otherwise, it represents an
offset from the current screen to the new screen.
</entry>
</row>
@@ -2544,15 +2544,15 @@ shares the same physical display.
<para>
The
<structfield>screenXXX</structfield>
- field is a signed character value that represents either the relative or
+field is a signed character value that represents either the relative or
absolute screen index, depending on the state of the
<symbol>XkbSA_SwitchAbsolute</symbol>
- bit in the
+bit in the
<structfield>flags</structfield>
- field. Xkb provides the following macros to convert between the integer and
+field. Xkb provides the following macros to convert between the integer and
signed character value for screen numbers in
<structname>XkbSwitchScreenAction</structname>
- structures:
+structures:
</para>
<indexterm significance="preferred" zone="XkbSAScreen"><primary><function>XkbSAScreen</function></primary></indexterm>
@@ -2581,11 +2581,11 @@ signed character value for screen numbers in
<para>
<function>XkbSAScreen</function>
- returns the
+returns the
<structfield>screenXXX</structfield>
- field of
+field of
<parameter>act</parameter>
- converted to a signed int.
+converted to a signed int.
</para>
@@ -2626,11 +2626,11 @@ signed character value for screen numbers in
<para>
<function>XkbSASetScreen</function>
- sets the
+sets the
<structfield>screenXXX</structfield>
- field of
+field of
<parameter>act</parameter>
- from
+from
<parameter>s</parameter>.
</para>
@@ -2644,7 +2644,7 @@ signed character value for screen numbers in
<para>
Actions associated with the
<structname>XkbCtrlsAction</structname>
- structure change the state of the boolean controls (see <link linkend="Controls_that_Enable_and_Disable_Other_Controls">section 10.1</link>):
+structure change the state of the boolean controls (see <link linkend="Controls_that_Enable_and_Disable_Other_Controls">section 10.1</link>):
<programlisting>
typedef struct _XkbCtrlsAction {
@@ -2666,7 +2666,7 @@ typedef struct _XkbCtrlsAction {
<para>
The
<structfield>type</structfield>
- field can have any one of the values shown in
+field can have any one of the values shown in
<link linkend="table16.14">Table 16.14</link>.
</para>
@@ -2691,7 +2691,7 @@ The
<para>
A key press enables any boolean controls specified in the
<structfield>ctrls</structfield>
- fields that were not already enabled at the time of the key press.
+fields that were not already enabled at the time of the key press.
</para>
</listitem>
<listitem>
@@ -2703,7 +2703,7 @@ A key release disables any controls enabled by the key press.
<para>
This action can cause
<symbol>XkbControlsNotify</symbol>
- events (see <link linkend="Controls_that_Enable_and_Disable_Other_Controls">section 10.1</link>).
+events (see <link linkend="Controls_that_Enable_and_Disable_Other_Controls">section 10.1</link>).
</para>
</listitem>
</itemizedlist>
@@ -2717,29 +2717,29 @@ This action can cause
<para>
If the
<symbol>XkbSA_LockNoLock</symbol>
- bit is not set in the
+bit is not set in the
<structfield>flags</structfield>
- field, a key press enables any controls specified in the
+field, a key press enables any controls specified in the
<structfield>ctrls</structfield>
- fields that were not already enabled at the time of the key press.
+fields that were not already enabled at the time of the key press.
</para>
</listitem>
<listitem>
<para>
If the
<symbol>XkbSA_LockNoUnlock</symbol>
- bit is not set in the
+bit is not set in the
<structfield>flags</structfield>
- field, a key release disables any controls specified in the
+field, a key release disables any controls specified in the
<structfield>ctrls</structfield>
- fields that were not already disabled at the time of the key press.
+fields that were not already disabled at the time of the key press.
</para>
</listitem>
<listitem>
<para>
This action can cause
<symbol>XkbControlsNotify</symbol>
- events (see <link linkend="Controls_that_Enable_and_Disable_Other_Controls">section 10.1</link>).
+events (see <link linkend="Controls_that_Enable_and_Disable_Other_Controls">section 10.1</link>).
</para>
</listitem>
</itemizedlist>
@@ -2752,7 +2752,7 @@ This action can cause
<para>
The
<structfield>flags</structfield>
- field is composed of the bitwise inclusive OR of the masks shown in
+field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.15">Table 16.15</link>.
</para>
@@ -2792,15 +2792,15 @@ the server only enables controls.
<para>
The
<symbol>XkbSA_SetControls</symbol>
- action implements a key that enables a boolean control when pressed and
+action implements a key that enables a boolean control when pressed and
disables it when released. The
<symbol>XkbSA_LockControls</symbol>
- action is used to implement a key that toggles the state of a boolean control
+action is used to implement a key that toggles the state of a boolean control
each time it is pressed and released. The
<symbol>XkbSA_LockNoLock</symbol>
- and
+and
<symbol>XkbSA_LockNoUnlock</symbol>
- flags allow modifying the toggling behavior to only unlock or only lock the
+flags allow modifying the toggling behavior to only unlock or only lock the
boolean control.
</para>
@@ -2812,9 +2812,9 @@ The
<structfield>ctrls2</structfield>,
and
<structfield>ctrls3</structfield>
- fields represent the boolean controls in the
+fields represent the boolean controls in the
<structfield>enabled_ctrls</structfield>
- field of the controls structure (see <link linkend="Controls_that_Enable_and_Disable_Other_Controls">section 10.1</link>). Xkb provides the following
+field of the controls structure (see <link linkend="Controls_that_Enable_and_Disable_Other_Controls">section 10.1</link>). Xkb provides the following
macros, to convert between the two formats:
</para>
@@ -2844,11 +2844,11 @@ macros, to convert between the two formats:
<para>
<function>XkbActionCtrls</function>
- returns the
+returns the
<structfield>ctrls</structfield>
- fields of
+fields of
<parameter>act</parameter>
- converted to an unsigned int.
+converted to an unsigned int.
</para>
@@ -2889,13 +2889,13 @@ macros, to convert between the two formats:
<para>
<function>XkbSAActionSetCtrls</function>
- sets the
+sets the
<structfield>ctrls0</structfield>
- through
+through
<structfield>ctrls3</structfield>
- fields of
+fields of
<parameter>act</parameter>
- from
+from
<parameter>ctrls</parameter>.
</para>
@@ -2909,9 +2909,9 @@ macros, to convert between the two formats:
<para>
Actions associated with the
<structname>XkbMessageAction</structname>
- structure generate
+structure generate
<symbol>XkbActionMessage</symbol>
- events:
+events:
<programlisting>
#define XkbActionMessageLength 6
@@ -2927,9 +2927,9 @@ typedef struct _XkbMessageAction {
<para>
The
<structfield>type</structfield>
- field of the
+field of the
<structname>XkbMessageAction</structname>
- structure should always be
+structure should always be
<symbol>XkbSA_ActionMessage</symbol>.
</para>
@@ -2937,7 +2937,7 @@ The
<para>
The
<structfield>flags</structfield>
- field is composed of the bitwise inclusive OR of the masks shown in
+field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.16">Table 16.16</link>.
</para>
@@ -2959,9 +2959,9 @@ The
<entry>
If set, key press events generate an
<symbol>XkbActionMessage</symbol>
- event that reports the keycode, event type, and contents of the
+event that reports the keycode, event type, and contents of the
<structfield>message</structfield>
- field.
+field.
</entry>
</row>
<row>
@@ -2969,9 +2969,9 @@ If set, key press events generate an
<entry>
If set, key release events generate an
<symbol>XkbActionMessage</symbol>
- event that reports the keycode, event type, and contents of the
+event that reports the keycode, event type, and contents of the
<structfield>message</structfield>
- field.
+field.
</entry>
</row>
<row>
@@ -2979,11 +2979,11 @@ If set, key release events generate an
<entry>
If set, key press and key release events generate
<symbol>KeyPress</symbol>
- and
+and
<symbol>KeyRelease</symbol>
- events, regardless of whether they generate
+events, regardless of whether they generate
<symbol>XkbActionMessage</symbol>
- events.
+events.
</entry>
</row>
</tbody>
@@ -2993,9 +2993,9 @@ If set, key press and key release events generate
<para>
The
<structfield>message</structfield>
- field is an array of
+field is an array of
<symbol>XkbActionMessageLength</symbol>
- unsigned characters and may be set to anything the keymap designer wishes.
+unsigned characters and may be set to anything the keymap designer wishes.
</para>
<sect3 id='Detecting_Key_Action_Messages'>
@@ -3008,24 +3008,24 @@ The
<para>
To receive
<symbol>XkbActionMessage</symbol>
- events by calling either
+events by calling either
<function>XkbSelectEvents</function>
- or
+or
<function>XkbSelectEventDetails</function>
- (see <link linkend="Selecting_Xkb_Events">section 4.3</link>).
+(see <link linkend="Selecting_Xkb_Events">section 4.3</link>).
</para>
<para>
To receive
<symbol>XkbActionMessage</symbol>
- events under all possible conditions, use
+events under all possible conditions, use
<function>XkbSelectEvents</function>
- and pass
+and pass
<symbol>XkbActionMessageMask</symbol>
- in both
+in both
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>.
</para>
@@ -3033,19 +3033,19 @@ To receive
<para>
The
<symbol>XkbActionMessage</symbol>
- event has no event details. However, you can call
+event has no event details. However, you can call
<function>XkbSelectEventDetails</function>
- using
+using
<symbol>XkbActionMessage</symbol>
- as the
+as the
<structfield>event_type</structfield>
- and specifying
+and specifying
<symbol>XkbAllActionMessagesMask</symbol>
- in
+in
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>.
- This has the same effect as a call to
+This has the same effect as a call to
<function>XkbSelectEvents</function>.
</para>
@@ -3053,7 +3053,7 @@ The
<para>
The structure for the
<symbol>XkbActionMessage</symbol>
- event is defined as follows:
+event is defined as follows:
<programlisting>
typedef struct _XkbActionMessage {
@@ -3076,9 +3076,9 @@ typedef struct _XkbActionMessage {
<para>
The
<structfield>keycode</structfield>
- is the keycode of the key that was pressed or released. The
+is the keycode of the key that was pressed or released. The
<structfield>press</structfield>
- field specifies whether the event was the result of a key press or key
+field specifies whether the event was the result of a key press or key
release.
</para>
@@ -3086,47 +3086,47 @@ release.
<para>
The
<structfield>key_event_follows</structfield>
- specifies whether a
+specifies whether a
<symbol>KeyPress</symbol>
- (if
+(if
<structfield>press</structfield>
- is
+is
<symbol>True</symbol>)
- or
+or
<symbol>KeyRelease</symbol>
- (if
+(if
<structfield>press</structfield>
- is
+is
<symbol>False</symbol>)
- event is also sent to the client. As with all other Xkb events,
+event is also sent to the client. As with all other Xkb events,
<structname>XkbActionMessageEvent</structname>s
- are delivered to all clients requesting them, regardless of the current
+are delivered to all clients requesting them, regardless of the current
keyboard focus. However, the
<symbol>KeyPress</symbol>
- or
+or
<symbol>KeyRelease</symbol>
- event that conditionally follows an
+event that conditionally follows an
<structname>XkbActionMessageEvent</structname>
- is sent only to the client selected by the current keyboard focus.
+is sent only to the client selected by the current keyboard focus.
<structfield>key_event_follows</structfield>
- is
+is
<symbol>True</symbol>
- only for the client that is actually sent the following
+only for the client that is actually sent the following
<symbol>KeyPress</symbol>
- or
+or
<symbol>KeyRelease</symbol>
- event.
+event.
</para>
<para>
The
<structfield>message</structfield>
- field is set to the message specified in the action and is guaranteed to be
+field is set to the message specified in the action and is guaranteed to be
<symbol>NULL</symbol>
-terminated; the Xkb extension forces a
<symbol>NULL</symbol>
- into
+into
<structfield>message</structfield>
[
<symbol>XkbActionMessageLength</symbol>
@@ -3144,11 +3144,11 @@ The
<para>
Actions associated with the
<structname>XkbRedirectKeyAction</structname>
- structure generate
+structure generate
<symbol>KeyPress</symbol>
- and
+and
<symbol>KeyRelease</symbol>
- events containing a keycode different from the key that was pressed or
+events containing a keycode different from the key that was pressed or
released:
<programlisting>
@@ -3171,9 +3171,9 @@ typedef struct _XkbRedirectKeyAction {
<para>
The
<structfield>type</structfield>
- field for the
+field for the
<structname>XkbRedirectKeyAction</structname>
- structure should always be
+structure should always be
<symbol>XkbSA_RedirectKey</symbol>.
</para>
@@ -3181,23 +3181,23 @@ The
<para>
Key presses cause a
<symbol>KeyPress</symbol>
- event for the key specified by the
+event for the key specified by the
<structfield>new_key</structfield>
- field instead of the actual key. The state reported in this event reports the
+field instead of the actual key. The state reported in this event reports the
current effective modifiers changed as follows: any real modifiers selected by
the
<structfield>mods_mask</structfield>
- field are set to corresponding values from the
+field are set to corresponding values from the
<structfield>mods</structfield>
- field. Any real modifiers bound to the virtual modifiers specified by the
+field. Any real modifiers bound to the virtual modifiers specified by the
<structfield>vmods_mask0</structfield>
- and
+and
<structfield>vmods_mask1</structfield>
- fields are either set or cleared, depending on the corresponding values in the
+fields are either set or cleared, depending on the corresponding values in the
<structfield>vmods0</structfield>
- and
+and
<structfield>vmods1</structfield>
- fields. If the real and virtual modifier definitions specify conflicting
+fields. If the real and virtual modifier definitions specify conflicting
values for a single modifier, the real modifier definition has priority.
</para>
@@ -3205,9 +3205,9 @@ values for a single modifier, the real modifier definition has priority.
<para>
Key releases cause a
<symbol>KeyRelease</symbol>
- event for the key specified by the
+event for the key specified by the
<structfield>new_key</structfield>
- field instead of the actual key. The state for this event consists of the
+field instead of the actual key. The state for this event consists of the
effective keyboard modifiers at the time of the release, changed as described
previously.
</para>
@@ -3216,7 +3216,7 @@ previously.
<para>
The
<symbol>XkbSA_RedirectKey</symbol>
- action normally redirects to another key on the same device as the key that
+action normally redirects to another key on the same device as the key that
caused the event, unless that device does not belong to the input extension
<symbol>KeyClass</symbol>,
in which case this action causes an event on the core keyboard device. (The
@@ -3229,11 +3229,11 @@ input extension.)
<para>
The
<structfield>vmods_mask0</structfield>
- and
+and
<structfield>vmods_mask1</structfield>
- fields actually represent one
+fields actually represent one
<emphasis>vmods_mask</emphasis>
- value, as described in <xref linkend="Virtual_Modifiers" />. Xkb provides the following macros, to
+value, as described in <xref linkend="Virtual_Modifiers" />. Xkb provides the following macros, to
convert between the two formats:
</para>
@@ -3263,13 +3263,13 @@ convert between the two formats:
<para>
<function>XkbSARedirectVModsMask</function>
- returns the
+returns the
<structfield>vmods_mask0</structfield>
- and
+and
<structfield>vmods_mask1</structfield>
- fields of
+fields of
<parameter>act</parameter>
- converted to an unsigned int.
+converted to an unsigned int.
</para>
@@ -3310,13 +3310,13 @@ convert between the two formats:
<para>
<function>XkbSARedirectSetVModsMask</function>
- sets the
+sets the
<structfield>vmods_mask0</structfield>
- and
+and
<structfield>vmods_mask1</structfield>
- fields of
+fields of
<parameter>act</parameter>
- from
+from
<parameter>vm</parameter>.
</para>
@@ -3324,9 +3324,9 @@ convert between the two formats:
<para>
Similarly, the
<structfield>vmods0</structfield>
- and
+and
<structfield>vmods1</structfield>
- fields actually represent one
+fields actually represent one
<structfield>vmods</structfield>
value, as described in <xref linkend="Virtual_Modifiers" />. To convert between the two formats, Xkb
provides the following convenience macros:
@@ -3411,15 +3411,15 @@ provides the following convenience macros:
<para>
Actions associated with
<structname>XkbDeviceBtnAction</structname>
- structures generate
+structures generate
<symbol>DeviceButtonPress</symbol>
- and
+and
<symbol>DeviceButtonRelease</symbol>
- events instead of normal
+events instead of normal
<symbol>KeyPress</symbol>
- and
+and
<symbol>KeyRelease</symbol>
- events:
+events:
<programlisting>
typedef struct _XkbDeviceBtnAction {
@@ -3435,7 +3435,7 @@ typedef struct _XkbDeviceBtnAction {
<para>
The
<structfield>type</structfield>
- field can have any one of the values shown in
+field can have any one of the values shown in
<link linkend="table16.17">Table 16.17</link>.
</para>
@@ -3469,30 +3469,30 @@ specified by this action are illegal, this action behaves like
Otherwise, key presses cause one or more input extension device events instead
of the usual key press event. If the
<structfield>count</structfield>
- field is zero, a key press generates a single
+field is zero, a key press generates a single
<symbol>DeviceButtonPress</symbol>
- event. If count is greater than zero, a key press event generates
+event. If count is greater than zero, a key press event generates
<structfield>count</structfield>
- pairs of
+pairs of
<symbol>DeviceButtonPress</symbol>
- and
+and
<symbol>DeviceButtonRelease</symbol>
- events.
+events.
</para>
</listitem>
<listitem>
<para>
If
<structfield>count</structfield>
- is zero, a key release generates an input extension
+is zero, a key release generates an input extension
<symbol>DeviceButtonRelease</symbol>
- event that matches the event generated by the corresponding key press. If
+event that matches the event generated by the corresponding key press. If
<structfield>count</structfield>
- is nonzero, a key release does not cause a
+is nonzero, a key release does not cause a
<symbol>DeviceButtonRelease</symbol>
- event. Key releases never cause
+event. Key releases never cause
<symbol>KeyRelease</symbol>
- events.
+events.
</para>
</listitem>
</itemizedlist>
@@ -3512,30 +3512,30 @@ behaves like <symbol>XkbSA_NoAction</symbol>.
<para>
Otherwise, if the specified button is not locked and the
<symbol>XkbSA_LockNoLock</symbol>
- bit is not set in the
+bit is not set in the
<structfield>flags</structfield>
- field, a key press generates an input extension
+field, a key press generates an input extension
<symbol>DeviceButtonPress</symbol>
- event instead of a
+event instead of a
<symbol>KeyPress</symbol>
- event and locks the button. If the button is already locked or if
+event and locks the button. If the button is already locked or if
<symbol>XkbSA_LockNoLock</symbol>
- bit is set in the
+bit is set in the
<structfield>flags</structfield>
- field, the key press is ignored and has no effect.
+field, the key press is ignored and has no effect.
</para>
</listitem>
<listitem>
<para>
If the corresponding key press was ignored, and if the
<symbol>XkbSA_LockNoUnlock</symbol>
- bit is not set in the
+bit is not set in the
<structfield>flags</structfield>
- field, a key release generates an input extension
+field, a key release generates an input extension
<symbol>DeviceButtonRelease</symbol>
- event instead of a
+event instead of a
<symbol>KeyRelease</symbol>
- event and unlocks the button. If the corresponding key press locked a button,
+event and unlocks the button. If the corresponding key press locked a button,
the key release is ignored and has no effect.
</para>
</listitem>
@@ -3549,7 +3549,7 @@ the key release is ignored and has no effect.
<para>
The
<structfield>flags</structfield>
- field is composed of the bitwise inclusive OR of the masks shown in
+field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.18">Table 16.18</link>.
</para>
@@ -3597,10 +3597,10 @@ A
<firstterm>valuator</firstterm>
<indexterm significance="preferred" zone="Actions_for_Simulating_Events_from_Device_Valuators">
<primary>valuator</primary></indexterm>
- manipulates a range of values for some entity, like a mouse axis, a slider or
+manipulates a range of values for some entity, like a mouse axis, a slider or
a dial. Actions associated with
<structname>XkbDeviceValuatorAction</structname>
- structures are used to simulate events from one or two input extension device
+structures are used to simulate events from one or two input extension device
valuators.
</para>
@@ -3622,11 +3622,11 @@ typedef struct _XkbDeviceValuatorAction {
<para>
If
<structfield>device</structfield>
- is illegal or if neither
+is illegal or if neither
<structfield>v1_ndx</structfield>
- nor
+nor
<structfield>v2_ndx</structfield>
- specifies a legal valuator, this action behaves like
+specifies a legal valuator, this action behaves like
<symbol>XkbSA_NoAction</symbol>.
</para>
@@ -3634,23 +3634,23 @@ If
<para>
The low four bits of
<structfield>v1_what</structfield>
- and
+and
<structfield>v2_what</structfield>
- specify the corresponding scale value (denoted
+specify the corresponding scale value (denoted
<structfield>val&lt;n&gt;Scale</structfield>
- in <link linkend="table16.17">Table 16.17</link>), if needed.
- The high four bits of
+in <link linkend="table16.17">Table 16.17</link>), if needed.
+The high four bits of
<structfield>v1_what</structfield>
- and
+and
<structfield>v2_what</structfield>
- specify the operation to perform to set the values. The high four bits of
+specify the operation to perform to set the values. The high four bits of
<structfield>v1_what</structfield>
- and
+and
<structfield>v2_what</structfield>
- can have the values shown in <link linkend="table16.17">Table 16.17</link>;
- the use of
+can have the values shown in <link linkend="table16.17">Table 16.17</link>;
+the use of
<structfield>val&lt;n&gt;Scale</structfield>
- is shown in that table also.
+is shown in that table also.
</para>
<table id='table16.19' frame='topbot'>
@@ -3700,7 +3700,7 @@ The low four bits of
<entry><symbol>XkbSA_SetValAbsolute</symbol></entry>
<entry>
<structfield>v&lt;n&gt;_value</structfield>
- is set to (2 <structfield>val&lt;n&gt;Scale</structfield>).
+is set to (2 <structfield>val&lt;n&gt;Scale</structfield>).
</entry>
</row>
</tbody>
@@ -3710,12 +3710,12 @@ The low four bits of
<para>
Illegal values for
<symbol>XkbSA_SetValRelative</symbol>
- or
+or
<symbol>XkbSA_SetValAbsolute</symbol>
- are clamped into range. Note that all of these possibilities are legal for
+are clamped into range. Note that all of these possibilities are legal for
absolute valuators. For relative valuators, only
<symbol>XkbSA_SetValRelative</symbol>
- is permitted. Part of the input extension description of a device is the range
+is permitted. Part of the input extension description of a device is the range
of legal values for all absolute valuators, whence the maximum and minimum
legal values shown in <link linkend="table16.17">Table 16.17</link>.
</para>
@@ -3725,7 +3725,7 @@ legal values shown in <link linkend="table16.17">Table 16.17</link>.
The following two masks are provided as a convenience to select either portion
of
<structfield>v1_what</structfield>
- or
+or
<structfield>v2_what</structfield>:
<programlisting>
@@ -3736,9 +3736,9 @@ of
<para>
<structfield>v1_ndx</structfield>
- and
+and
<structfield>v2_ndx</structfield>
- specify valuators that actually exists. For example, most mice have two
+specify valuators that actually exists. For example, most mice have two
valuators (x and y axes) so the only legal values for a mouse would be 0 and 1.
For a dial box with eight dials, any value in the range 0..7 would be correct.
</para>
@@ -3751,7 +3751,7 @@ For a dial box with eight dials, any value in the range 0..7 would be correct.
<para>
To update the actions (the
<structfield>key_acts</structfield>
- array) for a subset of the keys in a keyboard description, use
+array) for a subset of the keys in a keyboard description, use
<function>XkbGetKeyActions</function>.
</para>
@@ -3817,32 +3817,32 @@ To update the actions (the
<para>
<function>XkbGetKeyActions</function>
- sends a request to the server to obtain the actions for
+sends a request to the server to obtain the actions for
<parameter>num</parameter>
- keys on the keyboard starting with key
+keys on the keyboard starting with key
<parameter>first</parameter>.
It waits for a reply and returns the actions in the
<structfield>server</structfield>-&gt;<structfield>key_acts</structfield>
- field of
+field of
<parameter>xkb</parameter>.
If successful,
<function>XkbGetKeyActions</function>
- returns
+returns
<symbol>Success</symbol>.
The
<parameter>xkb</parameter>
- parameter must be a pointer to a valid Xkb keyboard description.
+parameter must be a pointer to a valid Xkb keyboard description.
</para>
<para>
If the
<structfield>server</structfield>
- map in the
+map in the
<parameter>xkb</parameter>
- parameter has not been allocated,
+parameter has not been allocated,
<function>XkbGetKeyActions</function>
- allocates and initializes it before obtaining the actions.
+allocates and initializes it before obtaining the actions.
</para>
@@ -3850,18 +3850,18 @@ If the
If the server does not have a compatible version of Xkb, or the Xkb extension
has not been properly initialized,
<function>XkbGetKeyActions</function>
- returns
+returns
<errorname>BadAccess</errorname>.
If
<parameter>num</parameter>
- is less than 1 or greater than
+is less than 1 or greater than
<symbol>XkbMaxKeyCount</symbol>,
<function>XkbGetKeyActions</function>
- returns
+returns
<errorname>BadValue</errorname>.
If any allocation errors occur,
<function>XkbGetKeyActions</function>
- returns
+returns
<errorname>BadAlloc</errorname>.
</para>
@@ -3926,27 +3926,27 @@ To change the number of actions bound to a key, use
<para>
The
<parameter>xkb</parameter>
- parameter points to the keyboard description containing the
+parameter points to the keyboard description containing the
<parameter>key</parameter>
- whose number of actions is to be changed. The
+whose number of actions is to be changed. The
<parameter>key</parameter>
- parameter is the keycode of the key to change, and
+parameter is the keycode of the key to change, and
<parameter>needed</parameter>
- specifies the new number of actions required for the key.
+specifies the new number of actions required for the key.
</para>
<para>
<function>XkbResizeKeyActions</function>
- reserves the space needed for the actions and returns a pointer to the
+reserves the space needed for the actions and returns a pointer to the
beginning of the new array that holds the actions. It can change the
<structfield>acts</structfield>,
<structfield>num_acts</structfield>,
and
<structfield>size_acts</structfield>
- fields of
+fields of
<parameter>xkb</parameter>-&gt;<structfield>server</structfield>
- if it is necessary to reallocate the
+if it is necessary to reallocate the
<structfield>acts</structfield>
array.
</para>
@@ -3955,9 +3955,9 @@ array.
<para>
If
<parameter>needed</parameter>
- is greater than the current number of keysyms for the key,
+is greater than the current number of keysyms for the key,
<function>XkbResizeKeyActions</function>
- initializes all new actions in the array to
+initializes all new actions in the array to
<emphasis>NoAction</emphasis>.
</para>
@@ -3966,17 +3966,17 @@ If
Because the number of actions needed by a key is normally computed as width *
number of groups, and
<function>XkbResizeKeyActions</function>
- does not modify either the width or number of groups for the key, a
+does not modify either the width or number of groups for the key, a
discrepancy exists on return from
<function>XkbResizeKeyActions</function>
- between the space allocated for the actions and the number required. The
+between the space allocated for the actions and the number required. The
unused entries in the list of actions returned by
<function>XkbResizeKeyActions</function>
- are not preserved across future calls to any of the map editing functions, so
+are not preserved across future calls to any of the map editing functions, so
you must update the key actions (which updates the width and number of groups
for the key) before calling another allocator function. A call to
<function>XkbChangeTypesOfKey</function>
- updates these.
+updates these.
</para>
@@ -3984,7 +3984,7 @@ for the key) before calling another allocator function. A call to
If any allocation errors occur while resizing the number of actions bound to
the key,
<function>XkbResizeKeyActions</function>
- returns
+returns
<symbol>NULL</symbol>.
</para>
@@ -4003,7 +4003,7 @@ a key.</para></note>
Key behavior refers to the demeanor of a key. For example, the expected
behavior of the
<keycap>CapsLock</keycap>
- key is that it logically locks when pressed, and then logically unlocks when
+key is that it logically locks when pressed, and then logically unlocks when
pressed again.
</para>
@@ -4014,36 +4014,36 @@ pressed again.
<para>
Keys that belong to the same radio group have the
<symbol>XkbKB_RadioGroup</symbol>
- type in the
+type in the
<structfield>type</structfield>
- field and the radio group index specified in the
+field and the radio group index specified in the
<structfield>data</structfield>
- field in the
+field in the
<structname>XkbBehavior</structname>
- structure. If the radio group has a name in the
+structure. If the radio group has a name in the
<structname>XkbNamesRec</structname>
- structure, the radio group index is the index into the
+structure, the radio group index is the index into the
<structfield>radio_group</structfield>
- array in the
+array in the
<structname>XkbNamesRec</structname>
- structure. A radio group key when pressed stays logically down until another
+structure. A radio group key when pressed stays logically down until another
key in the radio group is pressed, when the first key becomes logically up and
the new key becomes logically down. Setting the
<symbol>XkbKB_RGAllowNone</symbol>
- bit in the behavior for all of the keys of the radio group means that pressing
+bit in the behavior for all of the keys of the radio group means that pressing
the logically down member of the radio group causes it to logically release, in
which case none of the keys of the radio group would be logically down. If
<symbol>XkbKB_RGAllowNone</symbol>
- is not set, there is no way to release the logically down member of the group.
+is not set, there is no way to release the logically down member of the group.
</para>
<para>
The low five bits of the
<structfield>data</structfield>
- field of the
+field of the
<structname>XkbBehavior</structname>
- structure are the group number, the high three bits are flags. The only flag
+structure are the group number, the high three bits are flags. The only flag
currently defined is:
<programlisting>
@@ -4059,11 +4059,11 @@ currently defined is:
<para>
The
<structfield>behaviors</structfield>
- field of the server map is an array of
+field of the server map is an array of
<structname>XkbBehavior</structname>
- structures, indexed by keycode, and contains the behavior for each key. The
+structures, indexed by keycode, and contains the behavior for each key. The
<structname>XkbBehavior</structname>
- structure is defined as follows:
+structure is defined as follows:
<programlisting>
typedef struct _XkbBehavior {
@@ -4076,9 +4076,9 @@ typedef struct _XkbBehavior {
<para>
The
<structfield>type</structfield>
- field specifies the Xkb behavior, and the value of the
+field specifies the Xkb behavior, and the value of the
<structfield>data</structfield>
- field depends on the
+field depends on the
<structfield>type</structfield>.
Xkb supports the key behaviors shown in
<link linkend="table16.20">Table 16.20</link>.
@@ -4102,7 +4102,7 @@ Xkb supports the key behaviors shown in
<entry>
Press and release events are processed normally. The
<structfield>data</structfield>
- field is unused.
+field is unused.
</entry>
</row>
<row>
@@ -4114,7 +4114,7 @@ corresponding release is ignored. If the key is logically down when pressed,
the key press is ignored but the corresponding release is processed normally.
The
<structfield>data</structfield>
- field is unused.
+field is unused.
</entry>
</row>
<row>
@@ -4124,7 +4124,7 @@ The
If another member of the radio group is logically down (all members of the
radio group have the same index, specified in
<structfield>data</structfield>)
- when a key is pressed, the server synthesizes a key release for the member
+when a key is pressed, the server synthesizes a key release for the member
that is logically down and then processes the new key press event normally.
</para>
<para>
@@ -4132,7 +4132,7 @@ If the key itself is logically down when pressed, the key press event is
ignored, but the processing of the corresponding key release depends on the
value of the
<symbol>XkbKB_RGAllowNone</symbol>
- bit in
+bit in
<structfield>flags</structfield>.
If it is set, the key release is processed normally; otherwise, the key
release is also ignored.
@@ -4147,12 +4147,12 @@ All other key release events are ignored.
<entry>
If the
<emphasis>Overlay1</emphasis>
- control is enabled (see <link linkend="Controls_for_Keyboard_Overlays_Overlay1_and_Overlay2_Controls">section 10.4</link>),
+control is enabled (see <link linkend="Controls_for_Keyboard_Overlays_Overlay1_and_Overlay2_Controls">section 10.4</link>),
<structfield>data</structfield>
- is interpreted as a keycode, and events from this key are reported as if they
+is interpreted as a keycode, and events from this key are reported as if they
came from
<structfield>data</structfield>’s
- keycode. Otherwise, press and release events are processed normally.
+keycode. Otherwise, press and release events are processed normally.
</entry>
</row>
<row>
@@ -4160,12 +4160,12 @@ came from
<entry>
If the
<emphasis>Overlay2</emphasis>
- control is enabled (see <link linkend="Controls_for_Keyboard_Overlays_Overlay1_and_Overlay2_Controls">section 10.4</link>),
+control is enabled (see <link linkend="Controls_for_Keyboard_Overlays_Overlay1_and_Overlay2_Controls">section 10.4</link>),
<structfield>data</structfield>
- is interpreted as a keycode, and events from this key are reported as if they
+is interpreted as a keycode, and events from this key are reported as if they
came from
<structfield>data</structfield>’s
- keycode. Otherwise, press and release events are processed normally.
+keycode. Otherwise, press and release events are processed normally.
</entry>
</row>
</tbody>
@@ -4175,13 +4175,13 @@ came from
<para>
Xkb also provides the mask,
<symbol>XkbKB_Permanent</symbol>
- to specify whether the key behavior type should be simulated by Xkb or whether
+to specify whether the key behavior type should be simulated by Xkb or whether
the key behavior describes an unalterable physical, electrical, or software
aspect of the keyboard. If the
<symbol>XkbKB_Permanent</symbol>
- bit is not set in the
+bit is not set in the
<structfield>type</structfield>
- field, Xkb simulates the behavior in software. Otherwise, Xkb relies upon the
+field, Xkb simulates the behavior in software. Otherwise, Xkb relies upon the
keyboard to implement the behavior.
</para>
@@ -4193,7 +4193,7 @@ keyboard to implement the behavior.
<para>
To obtain the behaviors (the
<structfield>behaviors</structfield>
- array) for a subset of the keys in a keyboard description from the server, use
+array) for a subset of the keys in a keyboard description from the server, use
<function>XkbGetKeyBehaviors</function>:
</para>
@@ -4260,17 +4260,17 @@ To obtain the behaviors (the
<para>
<function>XkbGetKeyBehaviors</function>
- sends a request to the server to obtain the behaviors for
+sends a request to the server to obtain the behaviors for
<parameter>num</parameter>
- keys on the keyboard starting with the key whose keycode is
+keys on the keyboard starting with the key whose keycode is
<parameter>first</parameter>.
It waits for a reply and returns the behaviors in the
<structfield>server</structfield>-&gt;<structfield>behaviors</structfield>
- field of
+field of
<parameter>xkb</parameter>.
If successful,
<function>XkbGetKeyBehaviors</function>
- returns
+returns
<symbol>Success</symbol>.
</para>
@@ -4278,11 +4278,11 @@ If successful,
<para>
If the
<structfield>server</structfield>
- map in the
+map in the
<parameter>xkb</parameter>
- parameter has not been allocated,
+parameter has not been allocated,
<function>XkbGetKeyBehaviors</function>
- allocates and initializes it before obtaining the actions.
+allocates and initializes it before obtaining the actions.
</para>
@@ -4290,18 +4290,18 @@ If the
If the server does not have a compatible version of Xkb, or the Xkb extension
has not been properly initialized,
<function>XkbGetKeyBehaviors</function>
- returns
+returns
<errorname>BadAccess</errorname>.
If
<parameter>num</parameter>
- is less than 1 or greater than
+is less than 1 or greater than
<symbol>XkbMaxKeyCount</symbol>,
<function>XkbGetKeyBehaviors</function>
- returns
+returns
<errorname>BadValue</errorname>.
If any allocation errors occur,
<function>XkbGetKeyBehaviors</function>
- returns
+returns
<errorname>BadAlloc</errorname>.
</para>
@@ -4331,7 +4331,7 @@ mapping.
<para>
The explicit components masks are held in the
<structfield>explicit</structfield>
- field of the server map, which is an array indexed by keycode. Each entry in
+field of the server map, which is an array indexed by keycode. Each entry in
this array is a mask that is a bitwise inclusive OR of the values shown in
<link linkend="table16.21">Table 16.21</link>.
</para>
@@ -4403,9 +4403,9 @@ specified in a symbol interpretation.</entry>
<entry>
Automatic assignment of the
<symbol>XkbKB_Lock</symbol>
- behavior to the key, if the
+behavior to the key, if the
<symbol>XkbSI_LockingKey</symbol>
- flag is set in a symbol interpretation.
+flag is set in a symbol interpretation.
</entry>
</row>
<row>
@@ -4427,7 +4427,7 @@ match the key.
<para>
To obtain the explicit components (the
<structfield>explicit</structfield>
- array) for a subset of the keys in a keyboard description, use
+array) for a subset of the keys in a keyboard description, use
<function>XkbGetKeyExplicitComponents</function>.
</para>
@@ -4493,32 +4493,32 @@ To obtain the explicit components (the
<para>
<function>XkbGetKeyExplicitComponents</function>
- sends a request to the server to obtain the explicit components for
+sends a request to the server to obtain the explicit components for
<parameter>num</parameter>
- keys on the keyboard starting with key
+keys on the keyboard starting with key
<parameter>first</parameter>.
It waits for a reply and returns the explicit components in the
<structfield>server</structfield>-&gt;<structfield>explicit</structfield>
- array of
+array of
<parameter>xkb</parameter>.
If successful,
<function>XkbGetKeyExplicitComponents</function>
- returns
+returns
<symbol>Success</symbol>.
The
<parameter>xkb</parameter>
- parameter must be a pointer to a valid Xkb keyboard description.
+parameter must be a pointer to a valid Xkb keyboard description.
</para>
<para>
If the
<structfield>server</structfield>
- map in the
+map in the
<parameter>xkb</parameter>
- parameter has not been allocated,
+parameter has not been allocated,
<function>XkbGetKeyExplicitComponents</function>
- allocates and initializes it before obtaining the actions.
+allocates and initializes it before obtaining the actions.
</para>
@@ -4526,18 +4526,18 @@ If the
If the server does not have a compatible version of Xkb, or the Xkb extension
has not been properly initialized,
<function>XkbGetKeyExplicitComponents</function>
- returns
+returns
<errorname>BadMatch</errorname>.
If
<parameter>num</parameter>
- is less than 1 or greater than
+is less than 1 or greater than
<symbol>XkbMaxKeyCount</symbol>,
<function>XkbGetKeyExplicitComponents</function>
- returns
+returns
<errorname>BadValue</errorname>.
If any allocation errors occur,
<function>XkbGetKeyExplicitComponents</function>
- returns
+returns
<errorname>BadAlloc</errorname>.
</para>
@@ -4550,12 +4550,12 @@ If any allocation errors occur,
<para>
The
<structfield>vmods</structfield>
- member of the server map is a fixed-length array containing
+member of the server map is a fixed-length array containing
<symbol>XkbNumVirtualMods</symbol>
- entries. Each entry corresponds to a virtual modifier and provides the binding
+entries. Each entry corresponds to a virtual modifier and provides the binding
of the virtual modifier to the real modifier bits. Each entry in the
<structfield>vmods</structfield>
- array is a bitwise inclusive OR of the legal modifier masks:
+array is a bitwise inclusive OR of the legal modifier masks:
</para>
<simplelist type='vert' columns='1'>
@@ -4572,12 +4572,12 @@ of the virtual modifier to the real modifier bits. Each entry in the
<para>
The
<structfield>vmodmap</structfield>
- member of the server map is similar to the
+member of the server map is similar to the
<structfield>modmap</structfield>
- array of the client map (see <link linkend="The_Per_Key_Modifier_Map">section 15.4</link>), but is used to define the virtual
+array of the client map (see <link linkend="The_Per_Key_Modifier_Map">section 15.4</link>), but is used to define the virtual
modifier mapping for each key. Like the
<structfield>modmap</structfield>
- member, it is indexed by keycode, and each entry is a mask representing the
+member, it is indexed by keycode, and each entry is a mask representing the
virtual modifiers bound to the corresponding key:
</para>
@@ -4586,23 +4586,23 @@ virtual modifiers bound to the corresponding key:
<para>
Each of the bits in a
<structfield>vmodmap</structfield>
- entry represents an index into the
+entry represents an index into the
<structfield>vmods</structfield>
- member. That is, bit 0 of a
+member. That is, bit 0 of a
<structfield>vmodmap</structfield>
- entry refers to index 0 of the
+entry refers to index 0 of the
<structfield>vmods</structfield>
- array, bit 1 refers to index 1, and so on.
+array, bit 1 refers to index 1, and so on.
</para>
</listitem>
<listitem>
<para>
If a bit is set in the
<structfield>vmodmap</structfield>
- entry for a key, that key is bound to the corresponding virtual modifier in
+entry for a key, that key is bound to the corresponding virtual modifier in
the
<structfield>vmods</structfield>
- array.
+array.
</para>
</listitem>
</itemizedlist>
@@ -4610,9 +4610,9 @@ the
<para>
The
<structfield>vmodmap</structfield>
- and
+and
<structfield>vmods</structfield>
- members of the server map are the <quote>master</quote> virtual modifier definitions. Xkb
+members of the server map are the <quote>master</quote> virtual modifier definitions. Xkb
automatically propagates any changes to these fields to all other fields that
use virtual modifier mappings.
</para>
@@ -4644,7 +4644,7 @@ Virtual Modifier Relationships</H5>
<para>
To obtain a subset of the virtual modifier bindings (the
<structfield>vmods</structfield>
- array) in a keyboard description, use
+array) in a keyboard description, use
<function>XkbGetVirtualMods</function>:
</para>
@@ -4699,24 +4699,24 @@ To obtain a subset of the virtual modifier bindings (the
<para>
<function>XkbGetVirtualMods</function>
- sends a request to the server to obtain the
+sends a request to the server to obtain the
<structfield>vmods</structfield>
- entries for the virtual modifiers specified in the mask,
+entries for the virtual modifiers specified in the mask,
<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
<parameter>which</parameter>,
<function>XkbGetVirtualMods</function>
- updates the corresponding virtual modifier definition in the
+updates the corresponding virtual modifier definition in the
<structfield>server-&gt;vmods</structfield>
- array of
+array of
<parameter>xkb</parameter>.
The
<parameter>xkb</parameter>
- parameter must be a pointer to a valid Xkb keyboard description. If
+parameter must be a pointer to a valid Xkb keyboard description. If
successful,
<function>XkbGetVirtualMods</function>
- returns
+returns
<symbol>Success</symbol>.
</para>
@@ -4724,11 +4724,11 @@ successful,
<para>
If the
<structfield>server</structfield>
- map has not been allocated in the
+map has not been allocated in the
<parameter>xkb</parameter>
- parameter,
+parameter,
<function>XkbGetVirtualMods</function>
- allocates and initializes it before obtaining the virtual modifier bindings.
+allocates and initializes it before obtaining the virtual modifier bindings.
</para>
@@ -4736,7 +4736,7 @@ If the
If the server does not have a compatible version of Xkb, or the Xkb extension
has not been properly initialized,
<function>XkbGetVirtualMods</function>
- returns
+returns
<errorname>BadMatch</errorname>.
Any errors in allocation cause
<function>XkbGetVirtualMods</function>
@@ -4752,7 +4752,7 @@ to return
<para>
To obtain the virtual modifier map (the
<structfield>vmodmap</structfield>
- array) for a subset of the keys in a keyboard description, use
+array) for a subset of the keys in a keyboard description, use
<function>XkbGetKeyVirtualModMap</function>:
</para>
@@ -4821,30 +4821,30 @@ To obtain the virtual modifier map (the
<function>XkbGetKeyVirtualModmap</function>
sends a request to the server to obtain the virtual modifier mappings for
<parameter>num</parameter>
- keys on the keyboard starting with key
+keys on the keyboard starting with key
<parameter>first</parameter>.
It waits for a reply and returns the virtual modifier mappings in the
<structfield>server</structfield>-&gt;<structfield>vmodmap</structfield>
- array of
+array of
<parameter>xkb</parameter>.
If successful,
<function>XkbGetKeyVirtualModMap</function>
- returns
+returns
<symbol>Success</symbol>.
The
<parameter>xkb</parameter>
- parameter must be a pointer to a valid Xkb keyboard description
+parameter must be a pointer to a valid Xkb keyboard description
</para>
<para>
If the
<structfield>server</structfield>
- map in the
+map in the
<parameter>xkb</parameter>
- parameter has not been allocated,
+parameter has not been allocated,
<function>XkbGetKeyVirtualModMap</function>
- allocates and initializes it before obtaining the virtual modifier mappings.
+allocates and initializes it before obtaining the virtual modifier mappings.
</para>
@@ -4852,18 +4852,18 @@ If the
If the server does not have a compatible version of Xkb, or the Xkb extension
has not been properly initialized,
<function>XkbGetKeyVirtualModMap</function>
- returns
+returns
<errorname>BadMatch</errorname>.
If
<parameter>num</parameter>
- is less than 1 or greater than
+is less than 1 or greater than
<symbol>XkbMaxKeyCount</symbol>,
<function>XkbGetKeyVirtualModMap</function>
- returns
+returns
<errorname>BadValue</errorname>.
If any allocation errors occur,
<function>XkbGetKeyVirtualModMap</function>
- returns
+returns
<errorname>BadAlloc</errorname>.
</para>
diff --git a/specs/XKB/ch17.xml b/specs/XKB/ch17.xml
index 6f9fa548..dcc2b214 100644
--- a/specs/XKB/ch17.xml
+++ b/specs/XKB/ch17.xml
@@ -46,12 +46,12 @@ maintains a core keyboard mapping that approximates the Xkb keyboard mapping.
The core keyboard mapping may be updated piecemeal, on a per-key basis. When
the server receives a core protocol
<systemitem>ChangeKeyboardMapping</systemitem>
- or
+or
<systemitem>SetModifierMapping</systemitem>
- request, it updates its core keyboard mapping, then uses the compatibility map
+request, it updates its core keyboard mapping, then uses the compatibility map
to update its Xkb keyboard mapping. When the server receives an
<function>XkbSetMap</function>
- request, it updates those portions of its Xkb keyboard mapping specified by
+request, it updates those portions of its Xkb keyboard mapping specified by
the request, then uses its compatibility map to update the corresponding parts
of its core keyboard map. Consequently, the server’s Xkb keyboard map and
also its core keyboard map may contain components that were set directly and
@@ -90,9 +90,9 @@ In addition, whenever the Xkb state is retrieved, the
<structfield>compat_grab_mods</structfield>,
and
<structfield>compat_lookup_mods</structfield>
- fields of the
+fields of the
<structname>XkbStateRec</structname>
- returned indicate the result of applying the compatibility map to the current
+returned indicate the result of applying the compatibility map to the current
Xkb state in the server.
</para>
</listitem>
@@ -102,9 +102,9 @@ Xkb state in the server.
After core protocol requests received by the server to change the keyboard
mapping
(<systemitem>ChangeKeyboardMapping</systemitem>
- and
+and
<systemitem>SetModifierMapping</systemitem>)
- have been applied to the server’s core keyboard map, the results must be
+have been applied to the server’s core keyboard map, the results must be
transformed to achieve an equivalent change of the Xkb keyboard mapping
maintained by the server.
</para>
@@ -115,7 +115,7 @@ maintained by the server.
After Xkb protocol requests received by the server to change the keyboard
mapping
(<function>XkbSetMap</function>)
- have been applied to the server’s Xkb keyboard map, the results are
+have been applied to the server’s Xkb keyboard map, the results are
transformed to achieve an approximately equivalent change to the core keyboard
mapping maintained by the server.
</para>
@@ -138,7 +138,7 @@ All configurable aspects of mapping Xkb state and configuration to and from
core protocol state and configuration are defined by a compatibility map,
contained in an
<structname>XkbCompatMapRec</structname>
- structure; plus a set of explicit override controls used to prevent particular
+structure; plus a set of explicit override controls used to prevent particular
components of type 2 (core-to-Xkb keyboard mapping) transformations from
automatically occurring. These explicit override controls are maintained in a
separate data structure discussed in <link linkend="Explicit_ComponentsAvoiding_Automatic_Remapping_by_the_Server">section 16.3</link>.
@@ -148,11 +148,11 @@ separate data structure discussed in <link linkend="Explicit_ComponentsAvoiding_
<para>
The
<structfield>compat</structfield>
- member of an Xkb keyboard description
+member of an Xkb keyboard description
(<structname>XkbDescRec</structname>)
- points to the
+points to the
<structname>XkbCompatMapRec</structname>
- structure:
+structure:
<programlisting>
typedef struct _XkbCompatMapRec {
@@ -190,32 +190,32 @@ As shown in <link linkend="figure17.3">Figure 17.3</link>, there are four
<primary>group compatibility map</primary></indexterm>
<indexterm significance="preferred" zone="Xkb_State_to_Core_Protocol_State_Transformation">
<primary>map</primary><secondary>group compatibility</secondary></indexterm>
- (contained in
+(contained in
<structfield>groups</structfield>
- [0..3]) in the
+[0..3]) in the
<structname>XkbCompatMapRec</structname>
- structure, one per possible Xkb group. Each group compatibility map is a
+structure, one per possible Xkb group. Each group compatibility map is a
modifier definition (see <link linkend="Modifier_Definitions">section 7.2</link> for a description of modifier
definitions). The
<structfield>mask</structfield>
- component of the definition specifies which real modifiers should be set in
+component of the definition specifies which real modifiers should be set in
the core protocol state field when the corresponding group is active. Because
only one group is active at any one time, only one of the four possible
transformations is ever applied at any one point in time. If the device
described by the
<structname>XkbDescRec</structname>
- does not support four groups, the extra groups fields are present, but
+does not support four groups, the extra groups fields are present, but
undefined.
</para>
<para>
Normally, the Xkb-aware server reports keyboard state in the
<structfield>state</structfield>
- member of events such as a
+member of events such as a
<symbol>KeyPress</symbol>
- event and
+event and
<symbol>ButtonPress</symbol>
- event, encoded as follows:
+event, encoded as follows:
</para>
<informaltable frame='topbot'>
@@ -306,7 +306,7 @@ For each changed key, determine the number of symbols in each of the groups
found in step 1a. There is one explicit override control associated with each
of the four possible groups for each Xkb key,
<emphasis>ExplicitKeyType1</emphasis>
- through
+through
<emphasis>ExplicitKeyType4</emphasis>.
If no explicit override control is set for a group, the number of symbols
used for that group from the core map is two. If the explicit override control
@@ -324,7 +324,7 @@ group on the key. If the total number of symbols required by the Xkb map for a
particular key needs more symbols than the core protocol map contains, the
additional symbols are taken to be
<symbol>NoSymbol</symbol>
- keysyms appended to the end of the core set. If the core map contains more
+keysyms appended to the end of the core set. If the core map contains more
symbols than are needed by the Xkb map, trailing symbols in the core map are
discarded. In the absence of an explicit override for group one or two, symbols
are assigned in order by group; the first symbols in the core map are assigned
@@ -380,7 +380,7 @@ the corresponding key definitions in the Xkb map.
Apply symbol interpretations to modify key operation. This phase is completely
skipped if the
<emphasis>ExplicitInterpret</emphasis>
- override control bit is set in the explicit controls mask for the Xkb key (see
+override control bit is set in the explicit controls mask for the Xkb key (see
<link linkend="Explicit_ComponentsAvoiding_Automatic_Remapping_by_the_Server">section 16.3</link>).
</para>
<orderedlist>
@@ -406,11 +406,11 @@ apply a default interpretation.
The symbol interpretations used in step 2 are configurable and may be specified
using
<structname>XkbSymInterpretRec</structname>
- structures referenced by the
+structures referenced by the
<structfield>sym_interpret</structfield>
- field of an
+field of an
<structname>XkbCompatMapRec</structname>
- (see <link linkend="figure17.3">Figure 17.3</link>).
+(see <link linkend="figure17.3">Figure 17.3</link>).
</para>
<sect3 id='Symbol_Interpretations__the_XkbSymInterpretRec_Structure'>
@@ -423,7 +423,7 @@ Symbol interpretations are used to guide the X server when it modifies the Xkb
keymap in step 2. An initial set of symbol interpretations is loaded by the
server when it starts. A client may add new ones using
<function>XkbSetCompatMap</function>
- (see <link linkend="Changing_the_Servers_Compatibility_Map">section 17.4</link>).
+(see <link linkend="Changing_the_Servers_Compatibility_Map">section 17.4</link>).
</para>
@@ -459,21 +459,21 @@ typedef struct {
<para>
If
<structfield>sym</structfield>
- is not
+is not
<symbol>NULL</symbol>,
it limits the symbol interpretation to keys on which that particular keysym
is selected by the modifiers matching the criteria specified by
<structfield>mods</structfield>
- and
+and
<structfield>match</structfield>.
If
<structfield>sym</structfield>
- is
+is
<symbol>NULL</symbol>,
the interpretation may be applied to any symbol selected on a key when the
modifiers match the criteria specified by
<structfield>mods</structfield>
- and
+and
<structfield>match</structfield>.
</para>
@@ -506,7 +506,7 @@ are to be interpreted.
<entry>(0)</entry>
<entry>
None of the bits that are on in <structfield>mods</structfield>
- can be set, but other bits can be.
+can be set, but other bits can be.
</entry>
</row>
<row>
@@ -515,7 +515,7 @@ None of the bits that are on in <structfield>mods</structfield>
<entry>
Zero or more of the bits that are on in
<structfield>mods</structfield>
- can be set, as well as others.
+can be set, as well as others.
</entry>
</row>
<row>
@@ -524,7 +524,7 @@ Zero or more of the bits that are on in
<entry>
One or more of the bits that are on in
<structfield>mods</structfield>
- can be set, as well as any others.
+can be set, as well as any others.
</entry>
</row>
<row>
@@ -533,7 +533,7 @@ One or more of the bits that are on in
<entry>
All of the bits that are on in
<structfield>mods</structfield>
- must be set, but others may be set as well.
+must be set, but others may be set as well.
</entry>
</row>
<row>
@@ -542,7 +542,7 @@ All of the bits that are on in
<entry>
All of the bits that are on in
<structfield>mods</structfield>
- must be set, and no other bits may be set.
+must be set, and no other bits may be set.
</entry>
</row>
</tbody>
@@ -552,19 +552,19 @@ All of the bits that are on in
<para>
In addition to the above bits,
<structfield>match</structfield>
- may contain the
+may contain the
<symbol>XkbSI_LevelOneOnly</symbol>
- bit, in which case the modifier match criteria specified by
+bit, in which case the modifier match criteria specified by
<structfield>mods</structfield>
- and
+and
<structfield>match</structfield>
- applies only if
+applies only if
<structfield>sym</structfield>
- is in level one of its group; otherwise,
+is in level one of its group; otherwise,
<structfield>mods</structfield>
- and
+and
<structfield>match</structfield>
- are ignored and the symbol matches a condition where no modifiers are set.
+are ignored and the symbol matches a condition where no modifiers are set.
</para>
<para><programlisting>
@@ -620,7 +620,7 @@ is applied to modify the Xkb map as follows.
<para>
The
<structfield>act</structfield>
- field specifies a single action to be bound to the symbol position; any key
+field specifies a single action to be bound to the symbol position; any key
event that selects the symbol causes the action to be taken. Valid actions are
defined in <link linkend="Key_Actions">section 16.1</link>.
</para>
@@ -629,23 +629,23 @@ defined in <link linkend="Key_Actions">section 16.1</link>.
<para>
If the Xkb keyboard map for the key does not have its
<emphasis>ExplicitVModMap</emphasis>
- control set, the
+control set, the
<symbol>XkbSI_LevelOneOnly</symbol>
- bit and symbol position are examined. If the
+bit and symbol position are examined. If the
<symbol>XkbSI_LevelOneOnly</symbol>
- bit is not set in
+bit is not set in
<structfield>match</structfield>
- or the symbol is in position G1L1, the
+or the symbol is in position G1L1, the
<structfield>virtual_mod</structfield>
- field is examined. If
+field is examined. If
<structfield>virtual_mod</structfield>
- is not
+is not
<symbol>XkbNoModifier</symbol>,
<structfield>virtual_mod</structfield>
- specifies a single virtual modifier to be added to the virtual modifier map
+specifies a single virtual modifier to be added to the virtual modifier map
for the key.
<structfield>virtual_mod</structfield>
- is specified as an index in the range [0..15].
+is specified as an index in the range [0..15].
</para>
@@ -663,11 +663,11 @@ field potentially specify additional behavior modifications:
<para>
If the Xkb keyboard map for the key does not have its
<emphasis>ExplicitAutoRepeat</emphasis>
- control set, its auto repeat behavior is set based on the value of the
+control set, its auto repeat behavior is set based on the value of the
<symbol>XkbSI_AutoRepeat</symbol>
- bit. If the
+bit. If the
<symbol>XkbSI_AutoRepeat</symbol>
- bit is set, the auto-repeat behavior of the key is turned on; otherwise, it is
+bit is set, the auto-repeat behavior of the key is turned on; otherwise, it is
turned off.
</para>
@@ -675,13 +675,13 @@ turned off.
<para>
If the Xkb keyboard map for the key does not have its
<emphasis>ExplicitBehavior</emphasis>
- control set, its locking behavior is set based on the value of the
+control set, its locking behavior is set based on the value of the
<symbol>XkbSI_LockingKey</symbol>
- bit. If
+bit. If
<symbol>XkbSI_LockingKey</symbol>
- is set, the key behavior is set to
+is set, the key behavior is set to
<emphasis>KB_Lock</emphasis>;
- otherwise, it is turned off (see <link linkend="Explicit_ComponentsAvoiding_Automatic_Remapping_by_the_Server">section 16.3</link>).
+otherwise, it is turned off (see <link linkend="Explicit_ComponentsAvoiding_Automatic_Remapping_by_the_Server">section 16.3</link>).
</para>
@@ -736,13 +736,13 @@ all of the real modifiers associated with any of the virtual modifiers bound to
the key. In addition, if any of the actions associated with the key affect any
component of the keyboard group, all of the modifiers in the
<structfield>mask</structfield>
- field of all of the group compatibility maps are added to the modifier mapping
+field of all of the group compatibility maps are added to the modifier mapping
as well. While an
<symbol>XkbSA_ISOLock</symbol>
- action can theoretically affect any modifier, if the Xkb mapping for a key
+action can theoretically affect any modifier, if the Xkb mapping for a key
specifies an
<symbol>XkbSA_ISOLock</symbol>
- action, only the modifiers or group that are set by default are added to the
+action, only the modifiers or group that are set by default are added to the
modifier mapping.
</para>
@@ -755,13 +755,13 @@ modifier mapping.
<para>
Use
<function>XkbGetCompatMap</function>
- to fetch any combination of the current compatibility map components from the
+to fetch any combination of the current compatibility map components from the
server. When another client modifies the compatibility map, you are notified if
you have selected for
<symbol>XkbCompatMapNotify</symbol>
- events (see <link linkend="Tracking_Changes_to_the_Compatibility_Map">section 17.5</link>).
+events (see <link linkend="Tracking_Changes_to_the_Compatibility_Map">section 17.5</link>).
<function>XkbGetCompatMap</function>
- is particularly useful when you receive an event of this type, as it allows
+is particularly useful when you receive an event of this type, as it allows
you to update your program’s version of the compatibility map to match the
modified version now in the server. If your program is dealing with multiple
servers and needs to configure them all in a similar manner, the updated
@@ -819,17 +819,17 @@ explicit override components of the server state.</para></note>
<para>
<function>XkbGetCompatMap</function>
- fetches the components of the compatibility map specified in
+fetches the components of the compatibility map specified in
<parameter>which</parameter>
- from the server specified by
+from the server specified by
<parameter>display</parameter>
- and places them in the
+and places them in the
<structfield>compat</structfield>
- structure of the keyboard description
+structure of the keyboard description
<parameter>xkb</parameter>.
Valid values for
<parameter>which</parameter>
- are an inclusive OR of the values shown in
+are an inclusive OR of the values shown in
<link linkend="table17.2">Table 17.2</link>.
</para>
@@ -870,40 +870,40 @@ Valid values for
<para>
If no compatibility map structure is allocated in
<parameter>xkb</parameter>
- upon entry,
+upon entry,
<function>XkbGetCompatMap</function>
- allocates one. If one already exists, its contents are overwritten with the
+allocates one. If one already exists, its contents are overwritten with the
returned results.
</para>
<para>
<function>XkbGetCompatMap</function>
- fetches compatibility map information for the device specified by the
+fetches compatibility map information for the device specified by the
<structfield>device_spec</structfield>
- field of
+field of
<parameter>xkb</parameter>.
Unless you have specifically modified this field, it is the default keyboard
device.
<function>XkbGetCompatMap</function>
- returns
+returns
<symbol>Success</symbol>
- if successful,
+if successful,
<errorname>BadAlloc</errorname>
- if it is unable to obtain necessary storage for either the return values or
+if it is unable to obtain necessary storage for either the return values or
work space,
<errorname>BadMatch</errorname>
- if the
+if the
<structfield>dpy</structfield>
- field of the
+field of the
<parameter>xkb</parameter>
- argument is non-
+argument is non-
<symbol>NULL</symbol>
- and does not match the
+and does not match the
<parameter>display</parameter>
- argument, and
+argument, and
<errorname>BadLength</errorname>
- under certain conditions caused by server or Xkb implementation errors.
+under certain conditions caused by server or Xkb implementation errors.
</para>
@@ -1012,44 +1012,44 @@ format mapping by calling the function
<para>
<function>XkbUpdateMapFromCore</function>
- interprets input argument information representing a keyboard map in core
+interprets input argument information representing a keyboard map in core
format to update the Xkb keyboard description passed in
<parameter>xkb</parameter>.
Only a portion of the Xkb map is updated — the portion corresponding to
keys with keycodes in the range
<parameter>first_key</parameter>
- through
+through
<parameter>first_key</parameter>
- +
++
<parameter>num_keys</parameter>
- - 1. If
+- 1. If
<function>XkbUpdateMapFromCore</function>
- is being called in response to a
+is being called in response to a
<symbol>MappingNotify</symbol>
event,
<parameter>first_key</parameter>
- and
+and
<parameter>num_keys</parameter>
- are reported in the
+are reported in the
<symbol>MappingNotify</symbol>
- event.
+event.
<parameter>core_keysyms</parameter>
- contains the keysyms corresponding to the keycode range being updated, in core
+contains the keysyms corresponding to the keycode range being updated, in core
keyboard description order.
<parameter>map_width</parameter>
- is the number of keysyms per key in
+is the number of keysyms per key in
<parameter>core_keysyms</parameter>.
Thus, the first
<parameter>map_width</parameter>
- entries in
+entries in
<parameter>core_keysyms</parameter>
- are for the key with keycode
+are for the key with keycode
<parameter>first_key</parameter>,
the next
<parameter>map_width</parameter>
- entries are for key
+entries are for key
<parameter>first_key</parameter>
- + 1, and so on.
++ 1, and so on.
</para>
@@ -1057,11 +1057,11 @@ the next
In addition to modifying the Xkb keyboard mapping in
<parameter>xkb</parameter>,
<function>XkbUpdateMapFromCore</function>
- backfills the changes structure whose address is passed in
+backfills the changes structure whose address is passed in
<parameter>changes</parameter>
- to indicate the modifications that were made. You may then use
+to indicate the modifications that were made. You may then use
<parameter>changes</parameter>
- in subsequent calls such as
+in subsequent calls such as
<function>XkbSetMap</function>,
to propagate the local modifications to a server.
</para>
@@ -1072,7 +1072,7 @@ When dealing with core keyboard mappings or descriptions, it is sometimes
necessary to determine the Xkb key types appropriate for the symbols bound to a
key in a core keyboard mapping. Use
<function>XkbKeyTypesForCoreSymbols</function>
- for this purpose:
+for this purpose:
</para>
@@ -1160,11 +1160,11 @@ key in a core keyboard mapping. Use
<para>
<function>XkbKeyTypesForCoreSymbols</function>
- expands the symbols in
+expands the symbols in
<parameter>core_syms</parameter>
- and types in
+and types in
<parameter>types_inout</parameter>
- according to the rules specified in section 12 of the core protocol, then
+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
@@ -1177,36 +1177,36 @@ which will be non-
<para>
A core keymap is a two-dimensional array of keysyms. It has
<parameter>map_width</parameter>
- columns and
+columns and
<structfield>max_key_code</structfield>
- rows.
+rows.
<function>XkbKeyTypesForCoreSymbols</function>
- takes a single row from a core keymap, determines the number of groups
+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,
<parameter>types_inout</parameter>
- has the types for each group, and
+has the types for each group, and
<parameter>xkb_syms_rtrn</parameter>
- has the symbols in Xkb order (that is, groups are contiguous, regardless of
+has the symbols in Xkb order (that is, groups are contiguous, regardless of
size).
</para>
<para>
<parameter>protected</parameter>
- contains the explicitly protected key types. There is one explicit override
+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
+through
<emphasis>ExplicitKeyType4</emphasis>;
<parameter>protected</parameter>
is an inclusive OR of these controls.
<parameter>map_width</parameter>
- is the width of the core keymap and is not dependent on any Xkb definitions.
+is the width of the core keymap and is not dependent on any Xkb definitions.
<parameter>types_inout</parameter>
- is an array of four type indices. On input,
+is an array of four type indices. On input,
<parameter>types_inout</parameter>
- contains the indices of any types already assigned to the key, in case they
+contains the indices of any types already assigned to the key, in case they
are explicitly protected from change.
</para>
@@ -1214,11 +1214,11 @@ are explicitly protected from change.
<para>
Upon return,
<parameter>types_inout</parameter>
- contains any automatically selected (that is, canonical) types plus any
+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
<parameter>types_inout</parameter>
- correspond to the four groups for the key in question.
+correspond to the four groups for the key in question.
</para>
@@ -1281,7 +1281,7 @@ semantics updated, use
<para>
<function>XkbApplyCompatMapToKey</function>
- essentially performs the operation described in <link linkend="Core_Keyboard_Mapping_to_Xkb_Keyboard_Mapping_Transformation">section 17.1.2</link> to a specific
+essentially performs the operation described in <link linkend="Core_Keyboard_Mapping_to_Xkb_Keyboard_Mapping_Transformation">section 17.1.2</link> to a specific
key. This updates the behavior, actions, repeat status, and virtual modifier
bindings of the key.
</para>
@@ -1297,17 +1297,17 @@ Xkb compatibility map, then call
<function>XkbSetCompatMap</function>.
You may allocate a new compatibility map for this purpose using
<function>XkbAllocCompatMap</function>
- (see <link linkend="Allocating_and_Freeing_the_Compatibility_Map">section 17.6</link>). You may also use a compatibility map from another server,
+(see <link linkend="Allocating_and_Freeing_the_Compatibility_Map">section 17.6</link>). You may also use a compatibility map from another server,
although you need to adjust the
<structfield>device_spec</structfield>
- field in the
+field in the
<structname>XkbDescRec</structname>
- accordingly. Note that symbol interpretations in a compatibility map
+accordingly. Note that symbol interpretations in a compatibility map
(
<structfield>sym_interpret</structfield>,
the vector of
<structname>XkbSymInterpretRec</structname>
- structures) are also allocated using this same function.
+structures) are also allocated using this same function.
</para>
<indexterm significance="preferred" zone="XkbSetCompatMap"><primary><function>XkbSetCompatMap</function></primary></indexterm>
@@ -1369,18 +1369,18 @@ the vector of
<para>
<function>XkbSetCompatMap</function>
- copies compatibility map information from the keyboard description in
+copies compatibility map information from the keyboard description in
<parameter>xkb</parameter>
- to the server specified in
+to the server specified in
<parameter>display</parameter>’s
- compatibility map for the device specified by the
+compatibility map for the device specified by the
<structfield>device_spec</structfield>
- field of
+field of
<parameter>xkb</parameter>.
Unless you have specifically modified this field, it is the default keyboard
device.
<parameter>which</parameter>
- specifies the compatibility map components to be set, and is an inclusive OR
+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>
@@ -1388,13 +1388,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
<parameter>update_actions</parameter>
- is
+is
<symbol>True</symbol>,
- the server applies the new compatibility map to its entire keyboard for the
+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
<parameter>update_actions</parameter>
- is
+is
<symbol>False</symbol>,
the new compatibility map is not used to generate any modifications to the
current device semantics, state, or core keyboard map. One reason for not
@@ -1402,22 +1402,22 @@ applying the compatibility map immediately would be if one server was being
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
+specifying
<parameter>which</parameter>
- as zero and
+as zero and
<parameter>update_actions</parameter>
- as
+as
<symbol>True</symbol>.
</para>
<para>
<function>XkbSetCompatMap</function>
- returns
+returns
<symbol>True</symbol>
- if successful and
+if successful and
<symbol>False</symbol>
- if unsuccessful. The server may report problems it encounters when processing
+if unsuccessful. The server may report problems it encounters when processing
the request subsequently via protocol errors.
</para>
@@ -1489,27 +1489,27 @@ use
<para>
<function>XkbAddSymInterpret</function>
- adds
+adds
<parameter>si</parameter>
- to the list of symbol interpretations in
+to the list of symbol interpretations in
<parameter>xkb</parameter>.
If
<parameter>updateMap</parameter>
- is
+is
<symbol>True</symbol>,
it (re)applies the compatibility map to all of the keys on the keyboard. If
<parameter>changes</parameter>
- is non-
+is non-
<symbol>NULL</symbol>,
it reports the parts of the keyboard that were affected (unless
<parameter>updateMap</parameter>
- is
+is
<symbol>True</symbol>,
not much changes).
<function>XkbAddSymInterpret</function>
- returns a pointer to the actual new symbol interpretation in the list or
+returns a pointer to the actual new symbol interpretation in the list or
<symbol>NULL</symbol>
- if it failed.
+if it failed.
</para>
@@ -1524,31 +1524,31 @@ not much changes).
<para>
The server automatically generates
<symbol>MappingNotify</symbol>
- events when the keyboard mapping changes. If you wish to be notified of
+events when the keyboard mapping changes. If you wish to be notified of
changes to the compatibility map, you should select for
<symbol>XkbCompatMapNotify</symbol>
- events. If you select for
+events. If you select for
<symbol>XkbMapNotify</symbol>
- events, you no longer receive the automatically generated
+events, you no longer receive the automatically generated
<symbol>MappingNotify</symbol>
- events. If you subsequently deselect
+events. If you subsequently deselect
<structname>XkbMapNotifyEvent</structname>
- delivery, you again receive
+delivery, you again receive
<symbol>MappingNotify</symbol>
- events.
+events.
</para>
<para>
To receive
<symbol>XkbCompatMapNotify</symbol>
- events under all possible conditions, use
+events under all possible conditions, use
<function>XkbSelectEvents</function>
- (see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
+(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
<symbol>XkbCompatMapNotifyMask</symbol>
- in both
+in both
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>.
</para>
@@ -1556,17 +1556,17 @@ To receive
<para>
To receive
<symbol>XkbCompatMapNotify</symbol>
- events only under certain conditions, use
+events only under certain conditions, use
<function>XkbSelectEventDetails</function>
- using
+using
<symbol>XkbCompatMapNotify</symbol>
- as the
+as the
<structfield>event_type</structfield>
- and specifying the desired map changes in
+and specifying the desired map changes in
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>
- using mask bits from <link linkend="table17.2">Table 17.2</link>.
+using mask bits from <link linkend="table17.2">Table 17.2</link>.
</para>
@@ -1579,7 +1579,7 @@ made by other clients.
<para>
The structure for the
<structname>XkbCompatMapNotifyEvent</structname>
- is:
+is:
<programlisting>
typedef struct {
@@ -1604,28 +1604,28 @@ typedef struct {
<para>
<structfield>changed_groups</structfield>
- is the number of group compatibility maps that have changed. If you are
+is the number of group compatibility maps that have changed. If you are
maintaining a corresponding copy of the compatibility map, or get a fresh copy
from the server using
<function>XkbGetCompatMap</function>,
<structfield>changed_groups</structfield>
- references
+references
<structfield>groups</structfield>
[0..
<structfield>changed_groups</structfield>
-1] in the
<structname>XkbCompatMapRec</structname>
- structure.
+structure.
</para>
<para>
<structfield>first_si</structfield>
- is the index of the first changed symbol interpretation,
+is the index of the first changed symbol interpretation,
<structfield>num_si</structfield>
- is the number of changed symbol interpretations, and
+is the number of changed symbol interpretations, and
<structfield>num_total_si</structfield>
- is the total number of valid symbol interpretations. If you are maintaining a
+is the total number of valid symbol interpretations. If you are maintaining a
corresponding copy of the compatibility map, or get a fresh copy from the
server using
<function>XkbGetCompatMap</function>,
@@ -1633,9 +1633,9 @@ server using
<structfield>num_si</structfield>,
and
<structfield>num_total_si</structfield>
- are appropriate for use with the
+are appropriate for use with the
<structfield>compat.sym_interpret</structfield>
- vector in this structure.
+vector in this structure.
</para>
@@ -1697,27 +1697,27 @@ compatibility map if you do not already have one available. To do so, use
<para>
<parameter>xkb</parameter>
- specifies the keyboard description for which compatibility maps are to be
+specifies the keyboard description for which compatibility maps are to be
allocated. The compatibility map is the
<structfield>compat</structfield>
- field in this structure.
+field in this structure.
</para>
<para>
<parameter>which</parameter>
- specifies the compatibility map components to be allocated (see
+specifies the compatibility map components to be allocated (see
<link linkend="XkbGetCompatMap"><function>XkbGetCompatMap</function></link>,
in <link linkend="Getting_Compatibility_Map_Components_From_the_Server">section 17.2</link>).
<parameter>which</parameter>
- is an inclusive OR of the bits shown in
+is an inclusive OR of the bits shown in
<link linkend="table17.2">Table 17.2</link>.
</para>
<para>
<parameter>num_si</parameter>
- specifies the total number of entries to allocate in the symbol interpretation
+specifies the total number of entries to allocate in the symbol interpretation
vector
(<structfield>xkb.compat.sym_interpret</structfield>).
@@ -1727,34 +1727,34 @@ vector
<para>
Note that symbol interpretations in a compatibility map (the
<structfield>sym_interpret</structfield>
- vector of
+vector of
<structname>XkbSymInterpretRec</structname>
- structures) are also allocated using this same function. To ensure that there
+structures) are also allocated using this same function. To ensure that there
is sufficient space in the symbol interpretation vector for entries to be
added, use
<function>XkbAllocCompatMap</function>
- specifying
+specifying
<parameter>which</parameter>
- as
+as
<emphasis>XkbSymInterpretMask</emphasis>
- and the number of free symbol interpretations needed in
+and the number of free symbol interpretations needed in
<parameter>num_si</parameter>.
</para>
<para>
<function>XkbAllocCompatMap</function>
- returns
+returns
<symbol>Success</symbol>
- if successful,
+if successful,
<errorname>BadMatch</errorname>
- if
+if
<parameter>xkb</parameter>
- is
+is
<symbol>NULL</symbol>,
or
<errorname>BadAlloc</errorname>
- if errors are encountered when attempting to allocate storage.
+if errors are encountered when attempting to allocate storage.
</para>
@@ -1813,33 +1813,33 @@ To free an entire compatibility map or selected portions of one, use
<para>
<parameter>which</parameter>
- specifies the compatibility map components to be freed (see
+specifies the compatibility map components to be freed (see
<link linkend="XkbGetCompatMap"><function>XkbGetCompatMap</function></link>,
in <link linkend="Getting_Compatibility_Map_Components_From_the_Server">section 17.2</link>).
<parameter>which</parameter>
- is an inclusive OR of the bits shown in
+is an inclusive OR of the bits shown in
<link linkend="table17.2">Table 17.2</link>
</para>
<para>
<parameter>free_map</parameter>
- indicates whether the
+indicates whether the
<structname>XkbCompatMapRec</structname>
- structure itself should be freed. If
+structure itself should be freed. If
<parameter>free_map</parameter>
- is
+is
<symbol>True</symbol>,
<parameter>which</parameter>
- is ignored, all non-
+is ignored, all non-
<symbol>NULL</symbol>
- compatibility map components are freed, and the
+compatibility map components are freed, and the
<structfield>compat</structfield>
- field in the
+field in the
<structname>XkbDescRec</structname>
- referenced by
+referenced by
<parameter>xkb</parameter>
- is set to
+is set to
<symbol>NULL</symbol>.
</para>
diff --git a/specs/XKB/ch18.xml b/specs/XKB/ch18.xml
index 55e63015..0f283ecf 100644
--- a/specs/XKB/ch18.xml
+++ b/specs/XKB/ch18.xml
@@ -13,9 +13,9 @@ the type of keyboard connected to the server and then examine keysyms and
modifier mappings to determine the effects of most modifiers (the
<symbol>Shift</symbol>,
<symbol>Lock</symbol>
- and
+and
<symbol>Control</symbol>
- modifiers are defined by the core protocol but no semantics are implied for
+modifiers are defined by the core protocol but no semantics are implied for
any other modifiers).
</para>
@@ -25,7 +25,7 @@ To make it easier for applications to present a keyboard to the user, Xkb
supports symbolic names for most components of the keyboard extension. Most of
these symbolic names are grouped into the
<structfield>names</structfield>
- component of the keyboard description.
+component of the keyboard description.
</para>
<sect1 id='The_XkbNamesRec_Structure'>
@@ -89,10 +89,10 @@ typedef struct _XkbNamesRec {
<para>
The
<structfield>keycodes</structfield>
- name identifies the range and meaning of the keycodes returned by the keyboard
+name identifies the range and meaning of the keycodes returned by the keyboard
in question. The
<structfield>geometry</structfield>
- name, on the other hand, identifies the physical location, size and shape of
+name, on the other hand, identifies the physical location, size and shape of
the various keys on the keyboard. As an example to distinguish between these
two names, consider function keys on PC-compatible keyboards. Function keys are
sometimes above the main keyboard and sometimes to the left of the main
@@ -107,33 +107,33 @@ keyboards with differing numbers of keys provided all keys have the same
semantics when present. For example, 101 and 102 key PC keyboards might use the
same name. In these cases, applications can use the keyboard
<structfield>geometry</structfield>
- name to determine which subset of the named keycodes is in use.</para></note>
+name to determine which subset of the named keycodes is in use.</para></note>
<para>
The
<structfield>symbols</structfield>
- name identifies the symbols logically bound to the keys. The symbols name is a
+name identifies the symbols logically bound to the keys. The symbols name is a
human or application-readable description of the intended locale or usage of
the keyboard with these symbols. The
<structfield>phys_symbols</structfield>
- name, on the other hand, identifies the symbols actually engraved on the
+name, on the other hand, identifies the symbols actually engraved on the
keyboard. Given this, the
<structfield>symbols</structfield>
- name and
+name and
<structfield>phys_symbols</structfield>
- names might be different. For example, the description for a keyboard that has
+names might be different. For example, the description for a keyboard that has
English US engravings, but that is using Swiss German symbols might have a
<structfield>phys_symbols</structfield>
- name of "en_US" and a
+name of "en_US" and a
<structfield>symbols</structfield>
- name of "de_CH."
+name of "de_CH."
</para>
<para>
The
<structfield>types</structfield>
- name provides some information about the set of key types (see <link linkend="Key_Types">section 15.2</link>)
+name provides some information about the set of key types (see <link linkend="Key_Types">section 15.2</link>)
that can be associated with the keyboard. In addition, each key type can have a
name, and each shift level of a type can have a name. Although these names are
stored in the map description with each of the types, they are accessed using
@@ -144,7 +144,7 @@ the same methods as the other symbolic names.
<para>
The
<structfield>compat</structfield>
- name provides some information about the rules used to bind actions to keys
+name provides some information about the rules used to bind actions to keys
that are changed using core protocol requests.
</para>
@@ -157,7 +157,7 @@ in the
<structfield>indicators</structfield>,
and
<structfield>groups</structfield>
- fixed-length arrays.
+fixed-length arrays.
</para>
@@ -165,13 +165,13 @@ and
Each key has a four-byte symbolic name. All of the symbolic key names are held
in the
<structfield>keys</structfield>
- array, and
+array, and
<structfield>num_keys</structfield>
- reports the number of entries that are in the keys array. For each key, the
+reports the number of entries that are in the keys array. For each key, the
key name links keys with similar functions or in similar positions on keyboards
that report different keycodes. For example, the
<keycap>F1</keycap>
- key may emit keycode 23 on one keyboard and keycode 86 on another. By naming
+key may emit keycode 23 on one keyboard and keycode 86 on another. By naming
this key "FK01" on both keyboards, the keyboard layout designer can reuse parts
of keyboard descriptions for different keyboards.
</para>
@@ -186,20 +186,20 @@ designer may wish to refer to the left arrow key on a PC keyboard using the
ISO9995-5 positional specification of A31 or using the functional specification
of LEFT. The
<structfield>key_aliases</structfield>
- field holds a variable-length array of real and alias key name pairs, and the
+field holds a variable-length array of real and alias key name pairs, and the
total number of entries in the
<structfield>key_aliases</structfield>
- array is held in
+array is held in
<structfield>num_key_aliases</structfield>.
For each real and alias key name pair, the
<structfield>real</structfield>
- field refers to the a name in the keys array, and the
+field refers to the a name in the keys array, and the
<structfield>alias</structfield>
- field refers to the alias for that key. Using the previous example, the
+field refers to the alias for that key. Using the previous example, the
keyboard designer may use the name A31 in the keys array, but also define the
name LEFT as an alias for A31 in the
<structfield>key_aliases</structfield>
- array.
+array.
</para>
<note><para>Key aliases defined in the geometry component of a keyboard mapping
@@ -208,7 +208,7 @@ database, which are stored in the
<structname>XkbNamesRec</structname>
(<structfield>xkb-&gt;names</structfield>).
- Therefore, consider the key aliases defined by the geometry before
+Therefore, consider the key aliases defined by the geometry before
considering key aliases supplied by the
<structname>XkbNamesRec</structname>.
</para></note>
@@ -228,9 +228,9 @@ held in the variable-length array
<structfield>radio_groups</structfield>,
and
<structfield>num_rg</structfield>
- tells how many elements are in the
+tells how many elements are in the
<structfield>radio_groups</structfield>
- array.
+array.
</para>
@@ -426,12 +426,12 @@ To obtain symbolic names from the server, use
<para>
<function>XkbGetNames</function>
- retrieves symbolic names for the components of the keyboard extension from the
+retrieves symbolic names for the components of the keyboard extension from the
X server. The
<parameter>which</parameter>
- parameter specifies the name components to be updated in the
+parameter specifies the name components to be updated in the
<parameter>xkb</parameter>
- parameter, and is the bitwise inclusive OR of the valid names mask bits
+parameter, and is the bitwise inclusive OR of the valid names mask bits
defined in <link linkend="table18.1">Table 18.1</link>.
</para>
@@ -439,25 +439,25 @@ defined in <link linkend="table18.1">Table 18.1</link>.
<para>
If the
<structfield>names</structfield>
- field of the keyboard description
+field of the keyboard description
<parameter>xkb</parameter>
- is
+is
<symbol>NULL</symbol>,
<function>XkbGetNames</function>
- allocates and initializes the
+allocates and initializes the
<structfield>names</structfield>
- component of the keyboard description before obtaining the values specified by
+component of the keyboard description before obtaining the values specified by
<parameter>which</parameter>.
If the
<structfield>names</structfield>
- field of
+field of
<parameter>xkb</parameter>
- is not
+is not
<symbol>NULL</symbol>,
<function>XkbGetNames</function>
- obtains the values specified by
+obtains the values specified by
<parameter>which</parameter>
- and copies them into the keyboard description
+and copies them into the keyboard description
<parameter>xkb</parameter>.
</para>
@@ -465,23 +465,23 @@ If the
<para>
If the
<structfield>map</structfield>
- component of the
+component of the
<parameter>xkb</parameter>
- parameter is
+parameter is
<symbol>NULL</symbol>,
<function>XkbGetNames</function>
- does not retrieve type or shift level names, even if
+does not retrieve type or shift level names, even if
<symbol>XkbKeyTypeNamesMask</symbol>
- or
+or
<symbol>XkbKTLevelNamesMask</symbol>
- are set in
+are set in
<parameter>which</parameter>.
</para>
<para>
<function>XkbGetNames</function>
- can return
+can return
<symbol>Success</symbol>,
or
<errorname>BadAlloc</errorname>,
@@ -489,14 +489,14 @@ or
<errorname>BadMatch</errorname>,
and
<errorname>BadImplementation</errorname>
- errors.
+errors.
</para>
<para>
To free symbolic names, use
<function>XkbFreeNames</function>
- (see <link linkend="Allocating_and_Freeing_Symbolic_Names">section 18.6</link>)
+(see <link linkend="Allocating_and_Freeing_Symbolic_Names">section 18.6</link>)
</para>
@@ -508,22 +508,22 @@ To free symbolic names, use
To change the symbolic names in the server, first modify a local copy of the
keyboard description and then use either
<function>XkbSetNames</function>,
- or, to save network traffic, use a
+or, to save network traffic, use a
<structname>XkbNameChangesRec</structname>
structure and call
<function>XkbChangeNames</function>
- to download the changes to the server.
+to download the changes to the server.
<function>XkbSetNames</function>
- and
+and
<function>XkbChangeNames</function>
- can generate
+can generate
<errorname>BadAlloc</errorname>,
<errorname>BadAtom</errorname>,
<errorname>BadLength</errorname>,
<errorname>BadMatch</errorname>,
- and
+and
<errorname>BadImplementation</errorname>
- errors.
+errors.
</para>
<indexterm significance="preferred" zone="XkbSetNames"><primary><function>XkbSetNames</function></primary></indexterm>
@@ -597,42 +597,42 @@ structure and call
<para>
Use
<function>XkbSetNames</function>
- to change many names at the same time. For each bit set in
+to change many names at the same time. For each bit set in
<parameter>which</parameter>,
<function>XkbSetNames</function>
- takes the corresponding value (or values in the case of arrays) from the
+takes the corresponding value (or values in the case of arrays) from the
keyboard description
<parameter>xkb</parameter>
- and sends it to the server.
+and sends it to the server.
</para>
<para>
The
<parameter>first_type</parameter>
- and
+and
<parameter>num_types</parameter>
- arguments are used only if
+arguments are used only if
<symbol>XkbKeyTypeNamesMask</symbol>
- or
+or
<symbol>XkbKTLevelNamesMask</symbol>
- is set in
+is set in
<parameter>which</parameter>
- and specify a subset of the types for which the corresponding names are to be
+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,
<function>XkbSetNames</function>
- returns
+returns
<symbol>False</symbol>
- and does not update any of the names specified in
+and does not update any of the names specified in
<parameter>which</parameter>.
The specified types are illegal if
<parameter>xkb</parameter>
- does not include a map component or if
+does not include a map component or if
<parameter>first_type</parameter>
- and
+and
<parameter>num_types</parameter>
- specify types that are not defined in the keyboard description.
+specify types that are not defined in the keyboard description.
</para>
@@ -647,7 +647,7 @@ The specified types are illegal if
<para>
The
<structname>XkbNameChangesRec</structname>
- allows applications to identify small modifications to the symbolic names and
+allows applications to identify small modifications to the symbolic names and
effectively reduces the amount of traffic sent to the server:
<programlisting>
@@ -678,7 +678,7 @@ typedef struct _XkbNameChanges {
<para>
The
<structfield>changed</structfield>
- field specifies the name components that have changed and is the bitwise
+field specifies the name components that have changed and is the bitwise
inclusive OR of the valid names mask bits defined in
<link linkend="table18.1">Table 18.1</link>. The rest of
the fields in the structure specify the ranges that have changed for the
@@ -766,11 +766,11 @@ various kinds of symbolic names, as shown in
<para>
<function>XkbChangeNames</function>
- provides a more flexible method for changing symbolic names than
+provides a more flexible method for changing symbolic names than
<function>XkbSetNames</function>
- and requires the use of an
+and requires the use of an
<structname>XkbNameChangesRec</structname>
- structure.
+structure.
</para>
<indexterm significance="preferred" zone="XkbChangeNames"><primary><function>XkbChangeNames</function></primary></indexterm>
@@ -821,16 +821,16 @@ various kinds of symbolic names, as shown in
<para>
<function>XkbChangeNames</function>
- copies any names specified by
+copies any names specified by
<parameter>changes</parameter>
- from the keyboard description,
+from the keyboard description,
<parameter>xkb</parameter>,
to the X server specified by
<parameter>dpy</parameter>.
<function>XkbChangeNames</function>
- aborts and returns
+aborts and returns
<symbol>False</symbol>
- if any illegal type names or type shift level names are specified by
+if any illegal type names or type shift level names are specified by
<parameter>changes</parameter>.
</para>
@@ -848,15 +848,15 @@ to the X server specified by
Whenever a symbolic name changes in the server’s keyboard description, the
server sends a
<symbol>XkbNamesNotify</symbol>
- event to all interested clients. To receive name notify events, use
+event to all interested clients. To receive name notify events, use
<function>XkbSelectEvents</function>
- (see <link linkend="Selecting_Xkb_Events">section 4.3</link>) with
+(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) with
<symbol>XkbNamesNotifyMask</symbol>
- in both the
+in both the
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>
- parameters.
+parameters.
</para>
@@ -865,13 +865,13 @@ To receive events for only specific names, use
<function>XkbSelectEventDetails</function>.
Set the
<structfield>event_type</structfield>
- parameter to
+parameter to
<symbol>XkbNamesNotify</symbol>,
and set both the
<parameter>bits_to_change</parameter>
and
<parameter>values_for_bits</parameter>
- detail parameter to a mask composed of a bitwise OR of masks in
+detail parameter to a mask composed of a bitwise OR of masks in
<link linkend="table18.1">Table 18.1</link>.
</para>
@@ -879,7 +879,7 @@ and
<para>
The structure for the
<symbol>XkbNamesNotify</symbol>
- event is defined as follows:
+event is defined as follows:
<programlisting>
typedef struct {
@@ -915,7 +915,7 @@ typedef struct {
<para>
The
<structfield>changed</structfield>
- field specifies the name components that have changed and is the bitwise
+field specifies the name components that have changed and is the bitwise
inclusive OR of the valid names mask bits defined in
<link linkend="table18.1">Table 18.1</link>. The other
fields in this event are interpreted as the like-named fields in an
@@ -926,7 +926,7 @@ fields in this event are interpreted as the like-named fields in an
<para>
When your application receives a
<symbol>XkbNamesNotify</symbol>
- event, you can note the changed names in a changes structure using
+event, you can note the changed names in a changes structure using
<function>XkbNoteNameChanges</function>.
</para>
@@ -981,14 +981,14 @@ When your application receives a
<para>
The
<parameter>wanted</parameter>
- parameter is the bitwise inclusive OR of the valid names mask bits shown in
+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
+copies any changes that are reported in
<parameter>new</parameter>
- and specified in
+and specified in
<parameter>wanted</parameter>
- into the changes record specified by
+into the changes record specified by
<parameter>old</parameter>.
</para>
@@ -997,7 +997,7 @@ The
To update the local copy of the keyboard description with the actual values,
pass to
<function>XkbGetNameChanges</function>
- the results of one or more calls to
+the results of one or more calls to
<function>XkbNoteNameChanges</function>.
</para>
@@ -1052,23 +1052,23 @@ pass to
<para>
<function>XkbGetNameChanges</function>
- examines the
+examines the
<parameter>changes</parameter>
- parameter, retrieves the necessary information from the server, and places the
+parameter, retrieves the necessary information from the server, and places the
results into the
<parameter>xkb</parameter>
- keyboard description.
+keyboard description.
</para>
<para>
<function>XkbGetNameChanges</function>
- can generate
+can generate
<errorname>BadAlloc</errorname>,
<errorname>BadImplementation</errorname>,
- and
+and
<errorname>BadMatch</errorname>
- errors.
+errors.
</para>
@@ -1080,9 +1080,9 @@ results into the
Most applications do not need to directly allocate symbolic names structures.
Do not allocate a names structure directly using
<function>malloc</function>
- or
+or
<function>Xmalloc</function>
- if your application changes the number of key aliases or radio groups or
+if your application changes the number of key aliases or radio groups or
constructs a symbolic names structure without loading the necessary components
from the X server. Instead use
<function>XkbAllocNames</function>.
@@ -1146,15 +1146,15 @@ from the X server. Instead use
<para>
<function>XkbAllocNames</function>
- can return
+can return
<errorname>BadAlloc</errorname>,
<errorname>BadMatch</errorname>,
- and
+and
<errorname>BadValue</errorname>
- errors.
+errors.
The
<parameter>which</parameter>
- parameter is the bitwise inclusive OR of the valid names mask bits defined in
+parameter is the bitwise inclusive OR of the valid names mask bits defined in
<link linkend="table18.1">Table 18.1</link>.
</para>
@@ -1162,11 +1162,11 @@ The
<para>
Do not free symbolic names structures directly using
<function>free</function>
- or
+or
<function>XFree</function>.
Use
<function>XkbFreeNames</function>
- instead.
+instead.
</para>
@@ -1219,7 +1219,7 @@ Use
<para>
The
<parameter>which</parameter>
- parameter is the bitwise inclusive OR of the valid names mask bits defined in
+parameter is the bitwise inclusive OR of the valid names mask bits defined in
<link linkend="table18.1">Table 18.1</link>.
</para>
</sect1>
diff --git a/specs/XKB/ch19.xml b/specs/XKB/ch19.xml
index 756c83a9..faa62a27 100644
--- a/specs/XKB/ch19.xml
+++ b/specs/XKB/ch19.xml
@@ -24,9 +24,9 @@ input extension keyboard device as the X keyboard, in which case the old X
keyboard device becomes inaccessible except via the input device extension. In
this case, core protocol
<symbol>MappingNotify</symbol>
- and input extension
+and input extension
<symbol>XChangeDeviceNotify</symbol>
- events are generated to notify all clients that a new keyboard with a new
+events are generated to notify all clients that a new keyboard with a new
keymap has been designated.
</para>
@@ -43,14 +43,14 @@ for the client.
<para>
Xkb provides an
<symbol>XkbNewKeyboardNotify</symbol>
- event that reports a change in keyboard geometry and/or the range of supported
+event that reports a change in keyboard geometry and/or the range of supported
keycodes. The server can generate an
<symbol>XkbNewKeyboardNotify</symbol>
- event when it detects a new keyboard or in response to an
+event when it detects a new keyboard or in response to an
<function>XkbGetKeyboardByName</function>
- request that loads a new keyboard description. Selecting for
+request that loads a new keyboard description. Selecting for
<symbol>XkbNewKeyboardNotify</symbol>
- events allows Xkb-aware clients to be notified whenever a keyboard change
+events allows Xkb-aware clients to be notified whenever a keyboard change
occurs that may affect the keymap.
</para>
@@ -58,11 +58,11 @@ occurs that may affect the keymap.
<para>
When a client requests
<symbol>XkbNewKeyboardNotify</symbol>
- events, the server compares the range of keycodes for the current keyboard to
+events, the server compares the range of keycodes for the current keyboard to
the range of keycodes that are valid for the client. If they are not the same,
the server immediately sends the client an
<symbol>XkbNewKeyboardNotify</symbol>
- event. Even if the <quote>new</quote> keyboard is not new to the server,
+event. Even if the <quote>new</quote> keyboard is not new to the server,
it is new to this particular client.
</para>
@@ -70,14 +70,14 @@ it is new to this particular client.
<para>
When the server sends an
<symbol>XkbNewKeyboardNotify</symbol>
- event to a client to inform it of a new keycode range, it resets the stored
+event to a client to inform it of a new keycode range, it resets the stored
range of legal keycodes for the client to the keycode range reported in the
event; it does not reset this range for the client if it does not sent an
<symbol>XkbNewKeyboardNotify</symbol>
- event to a client. Because Xkb-unaware clients and Xkb-aware clients that do
+event to a client. Because Xkb-unaware clients and Xkb-aware clients that do
not request
<symbol>XkbNewKeyboardNotify</symbol>
- events are never sent these events, the server’s notion of the legal keycode
+events are never sent these events, the server’s notion of the legal keycode
range never changes, and these clients never receive events from keys that fall
outside of their notion of the legal keycode range.
</para>
@@ -86,9 +86,9 @@ outside of their notion of the legal keycode range.
<para>
Clients that have not selected to receive
<symbol>XkbNewKeyboardNotify</symbol>
- events do, however, receive the
+events do, however, receive the
<symbol>XkbNewKeyboardNotify</symbol>
- event when a keyboard change occurs. Clients that have not selected to receive
+event when a keyboard change occurs. Clients that have not selected to receive
this event also receive numerous other events detailing the individual changes
that occur when a keyboard change occurs.
</para>
@@ -97,19 +97,19 @@ that occur when a keyboard change occurs.
<para>
Clients wishing to track changes in
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- must watch for both
+must watch for both
<symbol>XkbNewKeyboardNotify</symbol>
- and
+and
<symbol>XkbMapNotify</symbol>
- events, because a simple mapping change causes an
+events, because a simple mapping change causes an
<symbol>XkbMapNotify</symbol>
- event and may change the range of valid keycodes, but does not cause an
+event and may change the range of valid keycodes, but does not cause an
<symbol>XkbNewKeyboardNotify</symbol>
- event. If a client does not select for
+event. If a client does not select for
<symbol>XkbNewKeyboardNotify</symbol>
- events, the server restricts the range of keycodes reported to the client.
+events, the server restricts the range of keycodes reported to the client.
</para>
@@ -122,7 +122,7 @@ In addition to filtering out-of-range key events, Xkb:
<para>
Adjusts core protocol
<symbol>MappingNotify</symbol>
- events to refer only to keys that match the stored legal range.
+events to refer only to keys that match the stored legal range.
</para>
</listitem>
<listitem>
@@ -130,7 +130,7 @@ Adjusts core protocol
Reports keyboard mappings for keys that match the stored legal range to clients
that issue a core protocol
<systemitem>GetKeyboardMapping</systemitem>
- request.
+request.
</para>
</listitem>
<listitem>
@@ -138,16 +138,16 @@ that issue a core protocol
Reports modifier mappings only for keys that match the stored legal range to
clients that issue a core protocol
<systemitem>GetModifierMapping</systemitem>
- request.
+request.
</para>
</listitem>
<listitem>
<para>
Restricts the core protocol
<systemitem>ChangeKeyboardMapping</systemitem>
- and
+and
<systemitem>SetModifierMapping</systemitem>
- requests to keys that fall inside the stored legal range.
+requests to keys that fall inside the stored legal range.
</para>
</listitem>
</itemizedlist>
@@ -168,7 +168,7 @@ Xkb events are discarded, and no Xkb requests have their keycode range clamped.
<para>
The structure for the
<symbol>XkbNewKeyboardNotify</symbol>
- event is defined as follows:
+event is defined as follows:
<programlisting>
typedef struct _XkbNewKeyboardNotify {
@@ -193,23 +193,23 @@ typedef struct _XkbNewKeyboardNotify {
<para>
To receive name notify events, use
<function>XkbSelectEvents</function>
- (see <link linkend="Selecting_Xkb_Events">section 4.3</link>) with
+(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) with
<symbol>XkbNewKeyboardNotifyMask</symbol>
- in both the
+in both the
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>
- parameters. To receive events for only specific names, use
+parameters. To receive events for only specific names, use
<function>XkbSelectEventDetails</function>.
Set the
<structfield>event_type</structfield>
- parameter to
+parameter to
<symbol>XkbNewKeyboardNotify</symbol>,
and set both the
<parameter>bits_to_change</parameter>
and
<parameter>values_for_bits</parameter>
- detail parameter to a mask composed of a bitwise OR of masks in
+detail parameter to a mask composed of a bitwise OR of masks in
<link linkend="table19.1">Table 19.1</link>.
</para>
@@ -255,33 +255,33 @@ and
<para>
The
<structfield>req_major</structfield>
- and
+and
<structfield>req_minor</structfield>
- fields indicate what type of keyboard change has occurred.
+fields indicate what type of keyboard change has occurred.
</para>
<para>
If
<structfield>req_major</structfield>
- and
+and
<structfield>req_minor</structfield>
- are zero, the device change was not caused by a software request to the server
+are zero, the device change was not caused by a software request to the server
— a spontaneous change has occurred, such as hot-plugging a new device. In
this case,
<structfield>device</structfield>
- is the device identifier for the new, current X keyboard device, but no
+is the device identifier for the new, current X keyboard device, but no
implementation-independent guarantee can be made about
<structfield>old_device</structfield>.
<structfield>old_device</structfield>
- may be identical to
+may be identical to
<structfield>device</structfield>
- (an implementor is permitted to reuse the device specifier when the device
+(an implementor is permitted to reuse the device specifier when the device
changes); or it may be different. Note that
<structfield>req_major</structfield>
- and
+and
<structfield>req_minor</structfield>
- being zero do not necessarily mean that the physical keyboard device has
+being zero do not necessarily mean that the physical keyboard device has
changed; rather, they only imply a spontaneous change outside of software
control (some systems have keyboards that can change personality at the press
of a key).
@@ -291,40 +291,40 @@ of a key).
<para>
If the keyboard change is the result of an X Input Extension
<systemitem>ChangeKeyboardDevice</systemitem>
- request,
+request,
<structfield>req_major</structfield>
- contains the input extension major opcode, and
+contains the input extension major opcode, and
<structfield>req_minor</structfield>
- contains the input extension request number for
+contains the input extension request number for
<symbol>X_ChangeKeyboardDevice</symbol>.
In this case,
<structfield>device</structfield>
- and
+and
<structfield>old_device</structfield>
- are different, with
+are different, with
<structfield>device</structfield>
- being the identifier for the new, current X keyboard device, and
+being the identifier for the new, current X keyboard device, and
<structfield>old_device</structfield>
- being the identifier for the former device.
+being the identifier for the former device.
</para>
<para>
If the keyboard change is the result of an
<function>XkbGetKeyboardByName</function>
- function call, which generates an
+function call, which generates an
<symbol>X_kbGetKbdByName</symbol>
- request,
+request,
<structfield>req_major</structfield>
- contains the Xkb extension base event code (see <link linkend="Initializing_the_Keyboard_Extension">section 2.4</link>), and
+contains the Xkb extension base event code (see <link linkend="Initializing_the_Keyboard_Extension">section 2.4</link>), and
<structfield>req_minor</structfield>
- contains the event code for the Xkb extension request
+contains the event code for the Xkb extension request
<symbol>X_kbGetKbdByName</symbol>.
<structfield>device</structfield>
- contains the device identifier for the new device, but nothing definitive can
+contains the device identifier for the new device, but nothing definitive can
be said for
<structfield>old_device</structfield>;
- it may be identical to
+it may be identical to
<structfield>device</structfield>,
or it may be different, depending on the implementation.
</para>
diff --git a/specs/XKB/ch20.xml b/specs/XKB/ch20.xml
index 1f5c8f15..33501fb7 100644
--- a/specs/XKB/ch20.xml
+++ b/specs/XKB/ch20.xml
@@ -99,7 +99,7 @@ used to refer to either individual components or a keymap.
There may be multiple entries for each of the component types. An entry may be
either
<emphasis>complete</emphasis>
- or
+or
<emphasis>partial</emphasis>.
Partial entries describe only a piece of the corresponding keyboard component
and are designed to be combined with other entries of the same type to form a
@@ -113,7 +113,7 @@ useful on its own because it does not include those symbols that are the same
on both the ASCII and national layouts (such as function keys). On the other
hand, this partial map can be used to configure
<emphasis>any</emphasis>
- ASCII keyboard to use a national layout.
+ASCII keyboard to use a national layout.
</para>
<para>
@@ -128,15 +128,15 @@ later definitions override earlier ones.
<para>
Component names have the form “<replaceable>class(member)</replaceable>” where
<replaceable>class</replaceable>
- describes a subset of the available components for a particular type and the
+describes a subset of the available components for a particular type and the
optional
<replaceable>member</replaceable>
- identifies a specific component from that subset. For example, the name
+identifies a specific component from that subset. For example, the name
"atlantis(acme)" for a symbols component might specify the symbols used for the
atlantis national keyboard layout by the vendor "acme." Each class has an
optional
<emphasis>default</emphasis>
- member — references that specify a class but not a member refer to the
+member — references that specify a class but not a member refer to the
default member of the class, if one exists. Xkb places no constraints on the
interpretation of the class and member names used in component names.
</para>
@@ -144,9 +144,9 @@ interpretation of the class and member names used in component names.
<para>
The
<replaceable>class</replaceable>
- and
+and
<replaceable>member</replaceable>
- names are both specified using characters from the Latin-1 character set. Xkb
+names are both specified using characters from the Latin-1 character set. Xkb
implementations must accept all alphanumeric characters, minus (‘-’) and
underscore (‘_’) in class or member names, and must not accept parentheses,
plus, vertical bar, percent sign, asterisk, question mark, or white space. The
@@ -227,15 +227,15 @@ To obtain this list, use
<para>
<function>XkbListComponents</function>
- queries the server for a list of component names matching the patterns
+queries the server for a list of component names matching the patterns
specified in
<parameter>ptrns</parameter>.
It waits for a reply and returns the matching component names in an
<structname>XkbComponentListRec</structname>
- structure. When you are done using the structure, you should free it using
+structure. When you are done using the structure, you should free it using
<function>XkbFreeComponentList</function>.
<parameter>device_spec</parameter>
- indicates a particular device in which the caller is interested. A server is
+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.
</para>
@@ -243,14 +243,14 @@ that are relevant for that particular device.
<para>
<parameter>ptrns</parameter>
- is a pointer to an
+is a pointer to an
<structname>XkbComponentNamesRec</structname>,
described below. Each of the fields in
<parameter>ptrns</parameter>
- contains a pattern naming the components of interest. Each of the patterns is
+contains a pattern naming the components of interest. Each of the patterns is
composed of characters from the ISO
<emphasis>Latin1</emphasis>
- encoding, but can contain only parentheses, the wildcard characters
+encoding, but can contain only parentheses, the wildcard characters
‘<literal>?</literal>’ and ‘<literal>*</literal>’,
and characters permitted in a component class or member name
(see <link linkend="Component_Names">section 20.1</link>). A pattern may be
@@ -277,12 +277,12 @@ from the pattern.
<para>
<parameter>max_inout</parameter>
- is used to throttle the amount of data passed to and from the server. On
+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>,
<parameter>max_inout</parameter>
- contains the number of names that matched the request but were not returned
+contains the number of names that matched the request but were not returned
because of the limit.
</para>
@@ -292,15 +292,15 @@ because of the limit.
<primary><structname>XkbComponentNamesRec</structname></primary></indexterm>
The component name patterns used to describe the request are passed to
<function>XkbListComponents</function>
- using an
+using an
<structname>XkbComponentNamesRec</structname>
- structure. This structure has no special allocation constraints or
+structure. This structure has no special allocation constraints or
interrelationships with other structures; allocate and free this structure
using standard
<function>malloc</function>
- and
+and
<function>free</function>
- calls or their equivalent:
+calls or their equivalent:
<programlisting>
typedef struct _XkbComponentNames {
@@ -319,7 +319,7 @@ typedef struct _XkbComponentNames {
<indexterm significance="preferred" zone="XkbComponentListRec">
<primary><structname>XkbComponentNameRec</structname></primary></indexterm>
<function>XkbListComponents</function>
- returns a pointer to an
+returns a pointer to an
<structname>XkbComponentListRec</structname>:
<programlisting>
@@ -349,7 +349,7 @@ Note that the structure used to specify patterns on input is an
<structname>XkbComponentNamesRec</structname>,
and that used to hold the individual component names upon return is an
<structname>XkbComponentNameRec</structname>
- (no trailing ‘s’ in Name).
+(no trailing ‘s’ in Name).
</para>
@@ -393,9 +393,9 @@ A set of flags is associated with each component; these flags provide
additional hints about the component’s use. These hints are designated by bit
masks in the flags field of the
<structname>XkbComponentNameRec</structname>
- structures contained in the
+structures contained in the
<structname>XkbComponentListRec</structname>
- returned from
+returned from
<function>XkbListComponents</function>.
The least significant byte of the flags field has the same meaning for all
types of keyboard components; the interpretation of the most significant byte
@@ -405,7 +405,7 @@ The symbols hints in <link linkend="table20.2">Table 20.2</link>
apply only to partial symbols components
(those with
<symbol>XkbLC_Partial</symbol>
- also set); full symbols components are assumed to specify all of the pieces.
+also set); full symbols components are assumed to specify all of the pieces.
</para>
@@ -416,10 +416,10 @@ an exhaustive list of the kinds of keys that are affected. For example,
national keyboard layouts affect primarily alphanumeric keys, but many affect a
few modifier keys as well; such mappings should set only the
<symbol>XkbLC_AlphanumericKeys</symbol>
- hint. In general, symbols components should set only one of the four flags
+hint. In general, symbols components should set only one of the four flags
(
<symbol>XkbLC_AlternateGroup</symbol>
- may be combined with any of the other flags).
+may be combined with any of the other flags).
</para>
<table id='table20.2' frame='topbot'>
@@ -632,12 +632,12 @@ one, use
<para>
<parameter>names</parameter>
- contains a set of expressions describing the keyboard components the server
+contains a set of expressions describing the keyboard components the server
should use to build the new keyboard description.
<parameter>want</parameter>
- and
+and
<parameter>need</parameter>
- are bit fields describing the parts of the resulting keyboard description that
+are bit fields describing the parts of the resulting keyboard description that
should be present in the returned
<structname>XkbDescRec</structname>.
</para>
@@ -646,9 +646,9 @@ should be present in the returned
<para>
The individual fields in
<parameter>names</parameter>
- are
+are
<firstterm>component expressions</firstterm>
- composed of keyboard component names (no wildcarding as may be used in
+composed of keyboard component names (no wildcarding as may be used in
<function>XkbListComponents</function>),
the special component name symbol ‘<literal>%</literal>’,
and the special operator characters
@@ -662,7 +662,7 @@ A component expression is parsed left to right, as follows:
The special component name “<literal>computed</literal>”
may be used in
<structfield>keycodes</structfield>
- component expressions and refers to a component consisting of a set of
+component expressions and refers to a component consisting of a set of
keycodes computed automatically by the server as needed.
</para>
</listitem>
@@ -670,7 +670,7 @@ keycodes computed automatically by the server as needed.
<para>
The special component name “<literal>canonical</literal>” may be used in
<structfield>types</structfield>
- component expressions and refers to a partial component defining the four
+component expressions and refers to a partial component defining the four
standard key types:
<emphasis>ALPHABETIC</emphasis>,
<emphasis>ONE_LEVEL</emphasis>,
@@ -684,7 +684,7 @@ and
The special component name ‘<literal>%</literal>’
refers to the keyboard description for the device specified in
<parameter>device_spec</parameter>
- or the keymap names component. If a keymap names component is specified that
+or the keymap names component. If a keymap names component is specified that
does not begin with
‘<literal>+</literal>’ or ‘<literal>|</literal>’ and does not contain
‘<literal>%</literal>’, then ‘<literal>%</literal>’
@@ -696,18 +696,18 @@ Otherwise, it refers to the keyboard description for
<listitem>
<para>
The ‘<literal>+</literal>’
- operator specifies that the following component should
+operator specifies that the following component should
<emphasis>override</emphasis>
- the currently assembled description; any definitions that are present in both
+the currently assembled description; any definitions that are present in both
components are taken from the second.
</para>
</listitem>
<listitem>
<para>
The ‘<literal>|</literal>’
- operator specifies that the next specified component should
+operator specifies that the next specified component should
<emphasis>augment</emphasis>
- the currently assembled description; any definitions that are present in both
+the currently assembled description; any definitions that are present in both
components are taken from the first.
</para>
</listitem>
@@ -728,7 +728,7 @@ entire expression is invalid and is ignored.
<para>
For example, if
<structfield>names-&gt;symbols</structfield>
- contained the expression "+de", it specifies that the default member of the
+contained the expression "+de", it specifies that the default member of the
"de" class of symbols should be applied to the current keyboard mapping,
overriding any existing definitions (it could also be written "+de(default)").
</para>
@@ -740,12 +740,12 @@ Here is a slightly more involved example: the expression
ASCII keyboard supplied by the "acme" vendor. The new definition begins with
the symbols for the ASCII keyboard for Acme
(<literal>acme(ascii)</literal>),
- overrides them with definitions for the basic German keyboard
+overrides them with definitions for the basic German keyboard
(<literal>de(basic)</literal>),
- and then applies the definitions from the default iso9995-3 keyboard
+and then applies the definitions from the default iso9995-3 keyboard
(
<literal>iso9995-3</literal>)
- to any undefined keys or groups of keys (part three of the iso9995 standard
+to any undefined keys or groups of keys (part three of the iso9995 standard
defines a common set of bindings for the secondary group, but allows national
layouts to override those definitions where necessary).
</para>
@@ -757,9 +757,9 @@ ordering are.</para></note>
<para>
Note that the presence of a keymap
<parameter>names</parameter>
- component that does not contain
+component that does not contain
‘<literal>%</literal>’
- (either explicit or implied by virtue of an expression starting with an
+(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
<parameter>device_spec</parameter>.
@@ -774,40 +774,40 @@ independent of any actual device.
<para>
The server parses all non-
<symbol>NULL</symbol>
- fields in
+fields in
<parameter>names</parameter>
- and uses them to build a keyboard description. However, before parsing the
+and uses them to build a keyboard description. However, before parsing the
expressions in
<parameter>names</parameter>,
the server ORs the bits in
<parameter>want</parameter>
- and
+and
<parameter>need</parameter>
- together and examines the result in relationship to the expressions in
+together and examines the result in relationship to the expressions in
<parameter>names</parameter>.
<link linkend="table20.3">Table 20.3</link>
identifies the components that are required for each of the
possible bits in
<parameter>want</parameter>
- or
+or
<parameter>need</parameter>.
If a required component has not been specified in the
<parameter>names</parameter>
- structure (the corresponding field is
+structure (the corresponding field is
<symbol>NULL</symbol>),
- the server substitutes the expression
+the server substitutes the expression
“<literal>%</literal>”,
- resulting in the component values being taken from
+resulting in the component values being taken from
<parameter>device_spec</parameter>.
In addition, if
<parameter>load</parameter>
- is
+is
<symbol>True</symbol>,
the server modifies
<parameter>names</parameter>
- if necessary (again using a
+if necessary (again using a
“<literal>%</literal>”
- entry) to ensure all of the following fields are non-
+entry) to ensure all of the following fields are non-
<symbol>NULL</symbol>:
<structfield>types</structfield>,
@@ -888,28 +888,28 @@ and
<para>
<parameter>need</parameter>
- specifies a set of keyboard components that the server must be able to resolve
+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
+to succeed; if any of the components specified in
<parameter>need</parameter>
- cannot be successfully resolved,
+cannot be successfully resolved,
<function>XkbGetKeyboardByName</function>
- fails.
+fails.
</para>
<para>
<parameter>want</parameter>
- specifies a set of keyboard components that the server should attempt to
+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
+still succeeds. Bits specified in
<parameter>want</parameter>
- that are also specified in
+that are also specified in
<parameter>need</parameter>
- have no effect in the context of
+have no effect in the context of
<parameter>want</parameter>.
</para>
@@ -917,33 +917,33 @@ these components,
<para>
If
<parameter>load</parameter>
- is
+is
<symbol>True</symbol>,
the server updates its keyboard description for
<parameter>device_spec</parameter>
- to match the result of the keyboard description just built. If load is
+to match the result of the keyboard description just built. If load is
<symbol>False</symbol>,
the server’s description for device
<parameter>device_spec</parameter>
- is not updated. In all cases, the parts specified by
+is not updated. In all cases, the parts specified by
<parameter>want</parameter>
- and
+and
<parameter>need</parameter>
- from the just-built keyboard description are returned.
+from the just-built keyboard description are returned.
</para>
<para>
The
<parameter>names</parameter>
- structure in an
+structure in an
<structname>XkbDescRec</structname>
- keyboard description record (see <xref linkend="Symbolic_Names" />) contains one field for each of
+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
<parameter>names</parameter>
- structure are set to match the expressions used to build the component.
+structure are set to match the expressions used to build the component.
</para>
@@ -964,12 +964,12 @@ database of components and returning all or part of it is diagrammed in Figure
<para>
The information returned to the client in the
<structname>XkbDescRec</structname>
- is essentially the result of a series of calls to extract information from a
+is essentially the result of a series of calls to extract information from a
fictitious device whose description matches the one just built. The calls
corresponding to each of the mask bits are summarized in
<link linkend="table20.4">Table 20.4</link>, together with the
<structname>XkbDescRec</structname>
- components that are filled in.
+components that are filled in.
</para>
<table id='table20.4' frame='topbot'>
@@ -1055,23 +1055,23 @@ XkbGetNames(dpy, XkbKeyNamesMask | XkbKeyAliasesMask, Xkb)
<para>
There is no way to determine which components specified in
<parameter>want</parameter>
- (but not in
+(but not in
<parameter>need</parameter>)
- were actually fetched, other than breaking the call into successive calls to
+were actually fetched, other than breaking the call into successive calls to
<function>XkbGetKeyboardByName</function>
- and specifying individual components.
+and specifying individual components.
</para>
<para>
<function>XkbGetKeyboardByName</function>
- always sets
+always sets
<structfield>min_key_code</structfield>
- and
+and
<structfield>max_key_code</structfield>
- in the returned
+in the returned
<structname>XkbDescRec</structname>
- structure.
+structure.
</para>
@@ -1092,7 +1092,7 @@ If you simply want to obtain information about the current keyboard device,
rather than generating a new keyboard description from elements in the server
database, use
<function>XkbGetKeyboard</function>
- (see <link linkend="Obtaining_a_Keyboard_Description_from_the_Server">section 6.2</link>).
+(see <link linkend="Obtaining_a_Keyboard_Description_from_the_Server">section 6.2</link>).
</para>
<indexterm significance="preferred" zone="XkbGetKeyboard"><primary><function>XkbGetKeyboard</function></primary></indexterm>
@@ -1145,10 +1145,10 @@ database, use
<para>
<function>XkbGetKeyboard</function>
- is used to read the current description for one or more components of a
+is used to read the current description for one or more components of a
keyboard device. It calls
<function>XkbGetKeyboardByName</function>
- as follows:
+as follows:
</para>
diff --git a/specs/XKB/ch21.xml b/specs/XKB/ch21.xml
index ce9c889f..7d122d92 100644
--- a/specs/XKB/ch21.xml
+++ b/specs/XKB/ch21.xml
@@ -14,7 +14,7 @@ include, but are not limited to: mice, tablets, touchscreens, barcode readers,
button boxes, trackballs, identifier devices, data gloves, and eye trackers.
Xkb provides additional control over all X input extension devices, whether
they are <symbol>KeyClass</symbol>
- devices or not, as well as the core keyboard and pointer.
+devices or not, as well as the core keyboard and pointer.
</para>
@@ -63,14 +63,14 @@ the following additional access is provided:
<para>
If allowed, Xkb functionality for additional
<symbol>KeyClass</symbol>
- devices supported by the input extension is accessed via those same functions.
+devices supported by the input extension is accessed via those same functions.
</para>
</listitem>
<listitem>
<para>
If allowed, Xkb functionality for non-
<symbol>KeyClass</symbol>
- devices supported by the input extension is also accessed via the
+devices supported by the input extension is also accessed via the
XkbGetDeviceInfo and XkbSetDeviceInfo functions described in this chapter.
</para>
</listitem>
@@ -81,9 +81,9 @@ Each device has an X Input Extension device ID. Each device may have several
classes of feedback. For example, there are two types of feedbacks that can
generate bells: bell feedback and keyboard feedback
(<symbol>BellFeedbackClass</symbol>
- and
+and
<symbol>KbdFeedbackClass</symbol>).
- A device can have more than one feedback of each type; the feedback ID
+A device can have more than one feedback of each type; the feedback ID
identifies the particular feedback within its class.
</para>
@@ -128,17 +128,17 @@ input extension and Xkb, then the core keyboard, the core keyboard indicators,
and the core keyboard bells may each be addressed using an appropriate device
spec, class, and ID. The constant
<symbol>XkbDfltXIId</symbol>
- may be used as the device ID to specify the core keyboard indicators for the
+may be used as the device ID to specify the core keyboard indicators for the
core indicator feedback. The particular device ID corresponding to the core
keyboard feedback and the core indicator feedback may be obtained by calling
<function>XkbGetDeviceInfo</function>
- and specifying
+and specifying
<symbol>XkbUseCoreKbd</symbol>
- as the
+as the
<parameter>device_spec</parameter>;
- the values will be returned in
+the values will be returned in
<structfield>dflt_kbd_fb</structfield>
- and
+and
<structfield>dflt_led_fb</structfield>.
</para>
@@ -146,11 +146,11 @@ keyboard feedback and the core indicator feedback may be obtained by calling
<para>
If the server does not allow Xkb access to input extension
<symbol>KeyClass</symbol>
- devices, attempts to use Xkb requests with those devices fail with a
+devices, attempts to use Xkb requests with those devices fail with a
<errorname>BadKeyboard</errorname>
- error. Attempts to access non-
+error. Attempts to access non-
<symbol>KeyClass</symbol>
- input extension devices via XkbGetDeviceInfo and XkbSetDeviceInfo fail
+input extension devices via XkbGetDeviceInfo and XkbSetDeviceInfo fail
silently if Xkb access to those devices is not supported by the X server.
</para>
@@ -165,7 +165,7 @@ silently if Xkb access to those devices is not supported by the X server.
Information about X Input Extension devices is transferred between a client
program and the Xkb extension in an
<structname>XkbDeviceInfoRec</structname>
- structure:
+structure:
<programlisting>
typedef struct {
@@ -202,26 +202,26 @@ typedef struct {
<para>
The
<structfield>type</structfield>
- field is a registered symbolic name for a class of devices (for example,
+field is a registered symbolic name for a class of devices (for example,
"TABLET"). If a device is a keyboard (that is, is a member of
<symbol>KeyClass</symbol>),
- it has its own state, and
+it has its own state, and
<structfield>has_own_state</structfield>
- is
+is
<symbol>True</symbol>.
If
<structfield>has_own_state</structfield>
- is
+is
<symbol>False</symbol>,
the state of the core keyboard is used. The
<structfield>supported</structfield>
- and
+and
<structfield>unsupported</structfield>
- fields are masks where each bit indicates a capability. The meaning of the
+fields are masks where each bit indicates a capability. The meaning of the
mask bits is listed in <link linkend="table21.1">Table 21.1</link>,
together with the fields in the
<structname>XkbDeviceInfoRec</structname>
- structure that are associated with the capability represented by each bit. The
+structure that are associated with the capability represented by each bit. The
same bits are used to indicate the specific information desired in many of the
functions described subsequently in this section.
</para>
@@ -273,7 +273,7 @@ input extension devices.
<entry>
Clients can assign names to indicators on non-
<symbol>KeyClass</symbol>
- input extension devices.
+input extension devices.
</entry>
</row>
<row>
@@ -283,7 +283,7 @@ Clients can assign names to indicators on non-
<entry>
Clients can assign indicator maps to indicators on non-
<symbol>KeyClass</symbol>
- input extension devices.
+input extension devices.
</entry>
</row>
<row>
@@ -293,7 +293,7 @@ Clients can assign indicator maps to indicators on non-
<entry>
Clients can request the status of indicators on non-
<symbol>KeyClass</symbol>
- input extension devices.
+input extension devices.
</entry>
</row>
<row>
@@ -355,7 +355,7 @@ The
<structfield>supported</structfield>,
and
<structfield>unsupported</structfield>
- fields are always filled in when a valid reply is returned from the server
+fields are always filled in when a valid reply is returned from the server
involving an
<structname>XkbDeviceInfoRec</structname>.
All of the other fields are modified only if the particular function asks for
@@ -371,7 +371,7 @@ To determine whether the X server allows Xkb access to particular capabilities
of input devices other than the core X keyboard, or to determine the status of
indicator maps, indicator names or button actions on a non-
<symbol>KeyClass</symbol>
- extension device, use XkbGetDeviceInfo.
+extension device, use XkbGetDeviceInfo.
</para>
<indexterm significance="preferred" zone="XkbGetDeviceInfo"><primary><function>XkbGetDeviceInfo</function></primary></indexterm>
@@ -444,13 +444,13 @@ which, device_spec, ind_class, ind_id) -->
<para>
<function>XkbGetDeviceInfo</function>
- returns information about the input device specified by
+returns information about the input device specified by
<parameter>device_spec</parameter>.
Unlike the
<parameter>device_spec</parameter>
- parameter of most Xkb functions,
+parameter of most Xkb functions,
<parameter>device_spec</parameter>
- does not need to be a keyboard device. It must, however, indicate either the
+does not need to be a keyboard device. It must, however, indicate either the
core keyboard or a valid X Input Extension device.
</para>
@@ -463,18 +463,18 @@ 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>
and causes the returned
<structname>XkbDeviceInfoRec</structname>
- to contain values for the corresponding fields specified in the table.
+to contain values for the corresponding fields specified in the table.
</para>
<para>
The
<structname>XkbDeviceInfoRec</structname>
- returned by
+returned by
<function>XkbGetDeviceInfo</function>
- always has values for
+always has values for
<structfield>name</structfield>
- (may be a null string, ""),
+(may be a null string, ""),
<structfield>type</structfield>,
<structfield>supported</structfield>,
<structfield>unsupported</structfield>,
@@ -490,7 +490,7 @@ Other fields are filled in as specified by
<para>
Upon return, the
<structfield>supported</structfield>
- field will be set to the inclusive OR of zero or more bits from
+field will be set to the inclusive OR of zero or more bits from
<link linkend="table21.1">Table 21.1</link>;
each bit set indicates an optional Xkb extension device feature supported by
the server implementation, and a client may modify the associated behavior.
@@ -500,20 +500,20 @@ the server implementation, and a client may modify the associated behavior.
<para>
If the
<symbol>XkbXI_ButtonActionsMask</symbol>
- bit is set in
+bit is set in
<parameter>which</parameter>,
the
<structname>XkbDeviceInfoRec</structname>
- returned will have the button actions
+returned will have the button actions
(<structfield>btn_acts</structfield>
- field) filled in for all buttons.
+field) filled in for all buttons.
</para>
<para>
If
<parameter>which</parameter>
- includes one of the bits in <symbol>XkbXI_IndicatorsMask</symbol>,
+includes one of the bits in <symbol>XkbXI_IndicatorsMask</symbol>,
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
@@ -527,65 +527,65 @@ XListInputDevices request.
<para>
If any of the
<symbol>XkbXI_IndicatorsMask</symbol>
- bits are set in
+bits are set in
<parameter>which</parameter>,
the
<structname>XkbDeviceInfoRec</structname>
- returned will have filled in the portions of the
+returned will have filled in the portions of the
<structfield>leds</structfield>
- structure corresponding to the indicator feedback identified by
+structure corresponding to the indicator feedback identified by
<parameter>ind_class</parameter>
- and
+and
<parameter>ind_id</parameter>.
The
<structfield>leds</structfield>
- vector of the
+vector of the
<structname>XkbDeviceInfoRec</structname>
- is allocated if necessary and
+is allocated if necessary and
<structfield>sz_leds</structfield>
- and
+and
<structfield>num_leds</structfield>
- filled in. The
+filled in. The
<structfield>led_class</structfield>,
<structfield>led_id</structfield>
- and
+and
<structfield>phys_indicators</structfield>
- fields of the
+fields of the
<structfield>leds</structfield>
- entry corresponding to
+entry corresponding to
<parameter>ind_class</parameter>
- and
+and
<parameter>ind_id</parameter>
- are always filled in. If
+are always filled in. If
<parameter>which</parameter>
- contains
+contains
<symbol>XkbXI_IndicatorNamesMask</symbol>,
the
<structfield>names_present</structfield>
- and
+and
<structfield>names</structfield>
- fields of the
+fields of the
<structfield>leds</structfield>
- structure corresponding to
+structure corresponding to
<parameter>ind_class</parameter>
- and
+and
<parameter>ind_id</parameter>
- are returned.
+are returned.
If
<parameter>which</parameter>
- contains
+contains
<symbol>XkbXI_IndicatorStateMask</symbol>,
the corresponding
<structfield>state</structfield>
- field is updated. If
+field is updated. If
<parameter>which</parameter>
- contains
+contains
<symbol>XkbXI_IndicatorMapsMask</symbol>,
the
<structfield>maps_present</structfield>
- and
+and
<structfield>maps</structfield>
- fields are updated.
+fields are updated.
</para>
@@ -596,10 +596,10 @@ available via
These convenience functions mirror some of the mask bits. The functions all
take an
<type>XkbDeviceInfoPtr</type>
- as an input argument and operate on the X Input Extension device specified by
+as an input argument and operate on the X Input Extension device specified by
the
<parameter>device_spec</parameter>
- field of the structure. Only the parts of the structure indicated in the
+field of the structure. Only the parts of the structure indicated in the
function description are updated. The
<structname>XkbDeviceInfoRec</structname>
structure used in the function call can be obtained by calling
@@ -689,24 +689,24 @@ XkbGetDeviceButtonActions.
<para>
<function>XkbGetDeviceButtonActions</function>
- queries the server for the desired button information for the device indicated
+queries the server for the desired button information for the device indicated
by the
<structfield>device_spec</structfield>
- field of
+field of
<parameter>device_info</parameter>
- and waits for a reply. If successful,
+and waits for a reply. If successful,
<function>XkbGetDeviceButtonActions</function>
- backfills the button actions
+backfills the button actions
(<structfield>btn_acts</structfield>
- field of
+field of
<parameter>device_info</parameter>)
- for only the requested buttons, updates the
+for only the requested buttons, updates the
<structfield>name</structfield>,
<structfield>type</structfield>,
<structfield>supported</structfield>,
and
<structfield>unsupported</structfield>
- fields, and returns
+fields, and returns
<symbol>Success</symbol>.
</para>
@@ -714,20 +714,20 @@ and
<para>
<parameter>all_buttons</parameter>,
<parameter>first_button</parameter>
- and
+and
<parameter>num_buttons</parameter>
- specify the device buttons for which actions should be returned. Setting
+specify the device buttons for which actions should be returned. Setting
<parameter>all_buttons</parameter>
- to
+to
<symbol>True</symbol>
- requests actions for all device buttons; if
+requests actions for all device buttons; if
<parameter>all_buttons</parameter>
- is
+is
<symbol>False</symbol>,
<parameter>first_button</parameter>
- and
+and
<parameter>num_buttons</parameter>
- specify a range of buttons for which actions are requested.
+specify a range of buttons for which actions are requested.
</para>
@@ -737,19 +737,19 @@ extension has not been properly initialized, XkbGetDeviceButtonActions returns
<errorname>BadAccess</errorname>.
If allocation errors occur, a
<errorname>BadAlloc</errorname>
- status is returned. If the specified device
+status is returned. If the specified device
(<parameter>device_info</parameter>-&gt;<structfield>device_spec</structfield>)
- is invalid, a
+is invalid, a
<errorname>BadKeyboard</errorname>
- status is returned. If the device has no buttons, a
+status is returned. If the device has no buttons, a
<errorname>BadMatch</errorname>
- status is returned. If
+status is returned. If
<parameter>first_button</parameter>
- and
+and
<parameter>num_buttons</parameter>
- specify illegal buttons, a
+specify illegal buttons, a
<errorname>BadValue</errorname>
- status is returned.
+status is returned.
</para>
@@ -829,24 +829,24 @@ nfo, led_class, led_id, which) -->
<para>
<function>XkbGetDeviceLedInfo</function>
- queries the server for the desired LED information for the feedback specified
+queries the server for the desired LED information for the feedback specified
by
<parameter>led_class</parameter>
- and
+and
<parameter>led_id</parameter>
- for the X input extension device indicated by
+for the X input extension device indicated by
<structfield>device_spec</structfield>-&gt;<parameter>device_info</parameter>
- and waits for a reply. If successful,
+and waits for a reply. If successful,
<function>XkbGetDeviceLedInfo</function>
- backfills the relevant fields of
+backfills the relevant fields of
<parameter>device_info</parameter>
- as determined by
+as determined by
<parameter>which</parameter>
- with the results and returns
+with the results and returns
<symbol>Success</symbol>.
Valid values for
<parameter>which</parameter>
- are the inclusive OR of any of
+are the inclusive OR of any of
<symbol>XkbXI_IndicatorNamesMask</symbol>,
<symbol>XkbXI_IndicatorMapsMask</symbol>,
and
@@ -857,7 +857,7 @@ and
<para>
The fields of
<parameter>device_info</parameter>
- that are filled in when this request succeeds are
+that are filled in when this request succeeds are
<structfield>name</structfield>,
<structfield>type</structfield>,
<structfield>supported</structfield>,
@@ -865,63 +865,63 @@ and
<structfield>unsupported</structfield>,
and portions of the
<structfield>leds</structfield>
- structure corresponding to
+structure corresponding to
<parameter>led_class</parameter>
- and
+and
<parameter>led_id</parameter>
- as indicated by the bits set in
+as indicated by the bits set in
<parameter>which</parameter>.
The
<structfield>device_info-&gt;leds</structfield>
- vector is allocated if necessary and
+vector is allocated if necessary and
<structfield>sz_leds</structfield>
- and
+and
<structfield>num_leds</structfield>
- filled in. The
+filled in. The
<parameter>led_class</parameter>,
<parameter>led_id</parameter>
- and
+and
<structfield>phys_indicators</structfield>
- fields of the
+fields of the
<parameter>device_info</parameter>-&gt;<structfield>leds</structfield>
- entry corresponding to
+entry corresponding to
<parameter>led_class</parameter>
- and
+and
<parameter>led_id</parameter>
- are always filled in.
+are always filled in.
</para>
<para>
If
<parameter>which</parameter>
- contains
+contains
<symbol>XkbXI_IndicatorNamesMask</symbol>,
the
<structfield>names_present</structfield>
- and
+and
<structfield>names</structfield>
- fields of the
+fields of the
<parameter>device_info</parameter>-&gt;<structfield>leds</structfield>
- structure corresponding to
+structure corresponding to
<parameter>led_class</parameter>
- and
+and
<parameter>led_id</parameter>
- are updated, if
+are updated, if
<parameter>which</parameter>
- contains
+contains
<symbol>XkbXI_IndicatorStateMask</symbol>,
the corresponding
<structfield>state</structfield>
- field is updated, and if
+field is updated, and if
<parameter>which</parameter>
- contains
+contains
<symbol>XkbXI_IndicatorMapsMask</symbol>,
the
<structfield>maps_present</structfield>
- and
+and
<structfield>maps</structfield>
- fields are updated.
+fields are updated.
</para>
@@ -929,7 +929,7 @@ the
If a compatible version of Xkb is not available in the server or the Xkb
extension has not been properly initialized,
<function>XkbGetDeviceLedInfo</function>
- returns
+returns
<errorname>BadAccess</errorname>.
If allocation errors occur, a
<errorname>BadAlloc</errorname>
@@ -937,14 +937,14 @@ status is returned. If the device has no indicators, a
<errorname>BadMatch</errorname>
error is returned. If
<structfield>ledClass</structfield>
- or
+or
<structfield>ledID</structfield>
- have illegal values, a
+have illegal values, a
<errorname>BadValue</errorname>
- error is returned. If they have legal values but do not specify a feedback
+error is returned. If they have legal values but do not specify a feedback
that contains LEDs and is associated with the specified device, a
<errorname>BadMatch</errorname>
- error is returned.
+error is returned.
</para>
@@ -956,7 +956,7 @@ Structure</title>
<para>
To obtain an
<structname>XkbDeviceInfoRec</structname>
- structure, use XkbGetDeviceInfo or XkbAllocDeviceInfo.
+structure, use XkbGetDeviceInfo or XkbAllocDeviceInfo.
</para>
<indexterm significance="preferred" zone="XkbAllocDeviceInfo"><primary><function>XkbAllocDeviceInfo</function></primary></indexterm>
@@ -1005,25 +1005,25 @@ To obtain an
<para>
<function>XkbAllocDeviceInfo</function>
- allocates space for an
+allocates space for an
<structname>XkbDeviceInfoRec</structname>
- structure and initializes that structure’s
+structure and initializes that structure’s
<parameter>device_spec</parameter>
- field with the device ID specified by device_spec. If
+field with the device ID specified by device_spec. If
<parameter>n_buttons</parameter>
- is nonzero,
+is nonzero,
<parameter>n_buttons</parameter>
<structname>XkbAction</structname>s
- are linked into the
+are linked into the
<structname>XkbDeviceInfoRec</structname>
- structure and initialized to zero. If sz_leds is nonzero,
+structure and initialized to zero. If sz_leds is nonzero,
<parameter>sz_leds</parameter>
<structname>XkbDeviceLedInfoRec</structname>
- structures are also allocated and linked into the
+structures are also allocated and linked into the
<structname>XkbDeviceInfoRec</structname>
- structure. If you request
+structure. If you request
<structname>XkbDeviceLedInfoRec</structname>
- structures be allocated using this request, you must initialize them
+structures be allocated using this request, you must initialize them
explicitly.
</para>
@@ -1031,7 +1031,7 @@ explicitly.
<para>
To obtain an
<structname>XkbDeviceLedInfoRec</structname>
- structure, use XkbAllocDeviceLedInfo.
+structure, use XkbAllocDeviceLedInfo.
</para>
@@ -1070,18 +1070,18 @@ To obtain an
<para>
<function>XkbAllocDeviceLedInfo</function>
- allocates space for an
+allocates space for an
<structname>XkbDeviceLedInfoRec</structname>
- and places it in
+and places it in
<parameter>device_info</parameter>.
If num_needed is nonzero,
<parameter>num_needed</parameter>
<structname>XkbIndicatorMapRec</structname>
- structures are also allocated and linked into the
+structures are also allocated and linked into the
<structname>XkbDeviceLedInfoRec</structname>
- structure. If you request
+structure. If you request
<structname>XkbIndicatorMapRec</structname>
- structures be allocated using this request, you must initialize them
+structures be allocated using this request, you must initialize them
explicitly. All other fields are initialized to zero.
</para>
@@ -1089,7 +1089,7 @@ explicitly. All other fields are initialized to zero.
<para>
To initialize an
<structname>XkbDeviceLedInfoRec</structname>
- structure, use XkbAddDeviceLedInfo.
+structure, use XkbAddDeviceLedInfo.
</para>
@@ -1139,22 +1139,22 @@ To initialize an
<para>
<function>XkbAddDeviceLedInfo</function>
- first checks to see whether an entry matching
+first checks to see whether an entry matching
<parameter>led_class</parameter>
- and
+and
<parameter>led_id</parameter>
- already exists in the
+already exists in the
<structfield>device_info-&gt;leds</structfield>
- array. If it finds a matching entry, it returns a pointer to that entry.
+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
<parameter>device_info</parameter>-&gt;<structfield>leds</structfield>
- and extends it if there is not enough room. It then increments
+and extends it if there is not enough room. It then increments
<parameter>device_info</parameter>-&gt;<structfield>num_leds</structfield>
- and fills in the next available entry in
+and fills in the next available entry in
<parameter>device_info</parameter>-&gt;<structfield>leds</structfield>
- with
+with
<parameter>led_class</parameter>
- and
+and
<parameter>led_id</parameter>.
</para>
@@ -1162,20 +1162,20 @@ Otherwise, it checks to be sure there is at least one empty entry in
<para>
If successful,
<function>XkbAddDeviceLedInfo</function>
- returns a pointer to the
+returns a pointer to the
<structname>XkbDeviceLedInfoRec</structname>
- structure that was initialized. If unable to allocate sufficient storage, or
+structure that was initialized. If unable to allocate sufficient storage, or
if
<parameter>device_info</parameter>
- points to an invalid
+points to an invalid
<structname>XkbDeviceInfoRec</structname>
- structure, or if
+structure, or if
<parameter>led_class</parameter>
- or
+or
<parameter>led_id</parameter>
- are inappropriate,
+are inappropriate,
<function>XkbAddDeviceLedInfo</function>
- returns
+returns
<symbol>NULL</symbol>.
</para>
@@ -1183,7 +1183,7 @@ if
<para>
To allocate additional space for button actions in an
<structname>XkbDeviceInfoRec</structname>
- structure, use XkbResizeDeviceButtonActions.
+structure, use XkbResizeDeviceButtonActions.
</para>
@@ -1222,30 +1222,30 @@ To allocate additional space for button actions in an
<para>
<function>XkbResizeDeviceButtonActions</function>
- reallocates space, if necessary, to make sure there is room for a total of
+reallocates space, if necessary, to make sure there is room for a total of
<parameter>new_total</parameter>
- button actions in the
+button actions in the
<parameter>device_info</parameter>
- structure. Any new entries allocated are zeroed. If successful,
+structure. Any new entries allocated are zeroed. If successful,
<function>XkbResizeDeviceButtonActions</function>
- returns Success. If new_total is zero, all button actions are deleted,
+returns Success. If new_total is zero, all button actions are deleted,
<parameter>device_info</parameter>-&gt;<structfield>num_btns</structfield>
- is set to zero, and
+is set to zero, and
<parameter>device_info</parameter>-&gt;<structfield>btn_acts</structfield>
- is set to
+is set to
<symbol>NULL</symbol>.
If device_info is invalid or new_total is greater than 255,
<errorname>BadValue</errorname>
- is returned. If a memory allocation failure occurs, a
+is returned. If a memory allocation failure occurs, a
<errorname>BadAlloc</errorname>
- is returned.
+is returned.
</para>
<para>
To free an
<structname>XkbDeviceInfoRec</structname>
- structure, use XkbFreeDeviceInfo.
+structure, use XkbFreeDeviceInfo.
</para>
@@ -1298,44 +1298,44 @@ If free_all is
<symbol>True</symbol>,
the
<function>XkbFreeDeviceInfo</function>
- frees all components of
+frees all components of
<parameter>device_info</parameter>
- and the
+and the
<structname>XkbDeviceInfoRec</structname>
- structure pointed to by
+structure pointed to by
<parameter>device_info</parameter>
- itself. If free_all is
+itself. If free_all is
<symbol>False</symbol>,
the value of which determines which subcomponents are freed.
<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 <symbol>XkbXI_ButtonActionsMask</symbol>,
- all button actions associated with
+all button actions associated with
<parameter>device_info</parameter>
- are freed,
+are freed,
<parameter>device_info</parameter>-&gt;<structfield>btn_acts</structfield>
- is set to
+is set to
<symbol>NULL</symbol>,
and
<parameter>device_info</parameter>-&gt;<structfield>num_btns</structfield>
- is set to zero. If which contains all bits in
+is set to zero. If which contains all bits in
<symbol>XkbXI_IndicatorsMask</symbol>, all
<structname>XkbDeviceLedInfoRec</structname>
- structures associated with
+structures associated with
<parameter>device_info</parameter>
- are freed,
+are freed,
<parameter>device_info</parameter>-&gt;<structfield>leds</structfield>
- is set to
+is set to
<symbol>NULL</symbol>,
and
<parameter>device_info</parameter>-&gt;<structfield>sz_leds</structfield>
- and
+and
<parameter>device_info</parameter>-&gt;<structfield>num_leds</structfield>
- are set to zero. If which contains <symbol>XkbXI_IndicatorMapsMask</symbol>,
- all indicator maps associated with
+are set to zero. If which contains <symbol>XkbXI_IndicatorMapsMask</symbol>,
+all indicator maps associated with
<parameter>device_info</parameter>
- are cleared, but the number of LEDs and the leds structures themselves are
+are cleared, but the number of LEDs and the leds structures themselves are
preserved. If which contains <symbol>XkbXI_IndicatorNamesMask</symbol>,
all indicator names
associated with device_info are cleared, but the number of LEDs and the leds
@@ -1343,7 +1343,7 @@ structures themselves are preserved. If which contains
<symbol>XkbXI_IndicatorStateMask</symbol>,
the indicator state associated with the
<parameter>device_info</parameter>
- leds are set to zeros but the number of LEDs and the leds structures
+leds are set to zeros but the number of LEDs and the leds structures
themselves are preserved.
</para>
@@ -1373,11 +1373,11 @@ core pointer device, but support for actions on extension devices is optional.
Implementations that do not support button actions for extension devices must
not set the
<symbol>XkbXI_ButtonActionsMask</symbol>
- bit in the
+bit in the
<structfield>supported</structfield>
- field of an
+field of an
<structname>XkbDeviceInfoRec</structname>
- structure.
+structure.
</para>
@@ -1387,7 +1387,7 @@ implementation that does not support modification of those characteristics, no
protocol error is generated. Instead, the server reports a failure for the
request; it also sends an
<symbol>XkbExtensionDeviceNotify</symbol>
- event to the client that issued the request if the client has selected to
+event to the client that issued the request if the client has selected to
receive these events.
</para>
@@ -1396,11 +1396,11 @@ receive these events.
To change characteristics of an X Input Extension device in the server, first
modify a local copy of the device structure and then use either
<function>XkbSetDeviceInfo</function>,
- or, to save network traffic, use an
+or, to save network traffic, use an
<structname>XkbDeviceChangesRec</structname>
- structure (see <link linkend="Tracking_Changes_to_Extension_Devices">section 21.6</link>) and call
+structure (see <link linkend="Tracking_Changes_to_Extension_Devices">section 21.6</link>) and call
<function>XkbChangeDeviceInfo</function>
- to download the changes to the server.
+to download the changes to the server.
</para>
@@ -1457,19 +1457,19 @@ which, device_info) -->
<para>
<function>XkbSetDeviceInfo</function>
- sends a request to the server to modify the characteristics of the device
+sends a request to the server to modify the characteristics of the device
specified in the
<parameter>device_info</parameter>
- structure. The particular characteristics modified are identified by the bits
+structure. The particular characteristics modified are identified by the bits
set in
<parameter>which</parameter>
- and take their values from the relevant fields in
+and take their values from the relevant fields in
<parameter>device_info</parameter>
- (see <link linkend="table21.1">Table 21.1</link>).
+(see <link linkend="table21.1">Table 21.1</link>).
<function>XkbSetDeviceInfo</function>
- returns
+returns
<symbol>True</symbol>
- if the request was successfully sent to the server. If the X server
+if the request was successfully sent to the server. If the X server
implementation does not allow interaction between the X input extension and the
Xkb Extension, the function does nothing and returns
<symbol>False</symbol>.
@@ -1479,14 +1479,14 @@ Xkb Extension, the function does nothing and returns
<para>
The
<parameter>which</parameter>
- parameter specifies which aspects of the device should be changed and is a
+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:
<symbol>XkbXI_ButtonActionsMask</symbol>,
<symbol>XkbXI_IndicatorNamesMask</symbol>,
<symbol>XkbXI_IndicatorMapsMask</symbol>.
If the features requested to be manipulated in
<parameter>which</parameter>
- are valid for the device, but the server does not support assignment of one or
+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>
@@ -1494,43 +1494,43 @@ more of them, that particular portion of the request is ignored.
<para>
If the device specified in
<parameter>device_info</parameter>-&gt;<structfield>device_spec</structfield>
- does not contain buttons and a request affecting buttons is made, or the
+does not contain buttons and a request affecting buttons is made, or the
device does not contain indicators and a request affecting indicators is made,
a
<errorname>BadMatch</errorname>
- protocol error results.
+protocol error results.
</para>
<para>
If the
<symbol>XkbXI_ButtonActionsMask</symbol>
- bit is set in the supported mask returned by XkbGetDeviceInfo, the Xkb
+bit is set in the supported mask returned by XkbGetDeviceInfo, the Xkb
extension allows applications to assign key actions to buttons on input
extension devices other than the core keyboard device. If the
<symbol>XkbXI_ButtonActionsMask</symbol>
- is set in
+is set in
<parameter>which</parameter>,
the actions for all buttons specified in device_info are set to the
<structname>XkbAction</structname>s
- specified in
+specified in
<parameter>device_info</parameter>-&gt;<structfield>btn_acts</structfield>.
If the number of buttons requested to be updated is not valid for the device,
<function>XkbSetDeviceInfo</function>
- returns
+returns
<symbol>False</symbol>
- and a
+and a
<errorname>BadValue</errorname>
- protocol error results.
+protocol error results.
</para>
<para>
If the
<symbol>XkbXI_IndicatorMapsMask</symbol>
- and / or
+and / or
<symbol>XkbXI_IndicatorNamesMask</symbol>
- bit is set in the supported mask returned by XkbGetDeviceInfo, the Xkb
+bit is set in the supported mask returned by XkbGetDeviceInfo, the Xkb
extension allows applications to assign maps and / or names to the indicators
of nonkeyboard extension devices. If supported, maps and / or names can be
assigned to all extension device indicators, whether they are part of a
@@ -1541,36 +1541,36 @@ keyboard feedback or part of an indicator feedback.
<para>
If the
<symbol>XkbXI_IndicatorMapsMask</symbol>
- and / or
+and / or
<symbol>XkbXI_IndicatorNamesMask</symbol>
- flag is set in
+flag is set in
<parameter>which</parameter>,
the indicator maps and / or names for all
<parameter>device_info</parameter>-&gt;<structfield>num_leds</structfield>
- indicator devices specified in
+indicator devices specified in
<parameter>device_info</parameter>-&gt;<structfield>leds</structfield>
- are set to the maps and / or names specified in
+are set to the maps and / or names specified in
<parameter>device_info</parameter>-&gt;<structfield>leds</structfield>.
<parameter>device_info</parameter>-&gt;<structfield>leds</structfield>-&gt;<structfield>led_class</structfield>
- and
+and
<structfield>led_id</structfield>
- specify the input extension class and device ID for each indicator device to
+specify the input extension class and device ID for each indicator device to
modify; if they have invalid values, a
<errorname>BadValue</errorname>
- protocol error results and
+protocol error results and
<function>XkbSetDeviceInfo</function>
- returns
+returns
<symbol>False</symbol>.
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
+error results. If any of the values in
<parameter>device_info</parameter>-&gt;<structfield>leds-&gt;names</structfield>
- are not a valid Atom or
+are not a valid Atom or
<symbol>None</symbol>,
a
<errorname>BadAtom</errorname>
- protocol error results.
+protocol error results.
</para>
@@ -1648,13 +1648,13 @@ device, first_button, num_buttons, actions) -->
<para>
<function>XkbSetDeviceButtonActions</function>
- assigns actions to the buttons of the device specified in
+assigns actions to the buttons of the device specified in
device_info-&gt;<structfield>device_spec</structfield>.
Actions are assigned to
<parameter>num_buttons</parameter>
- buttons beginning with
+buttons beginning with
<parameter>first_button</parameter>
- and are taken from the actions specified in
+and are taken from the actions specified in
<parameter>device_info</parameter>-&gt;<structfield>btn_acts</structfield>.
</para>
@@ -1663,19 +1663,19 @@ Actions are assigned to
If the server does not support assignment of Xkb actions to extension device
buttons,
<function>XkbSetDeviceButtonActions</function>
- has no effect and returns
+has no effect and returns
<symbol>False</symbol>.
If the device has no buttons or if
<parameter>first_button</parameter>
- or
+or
<parameter>num_buttons</parameter>
- specify buttons outside of the valid range as determined by
+specify buttons outside of the valid range as determined by
<parameter>device_info</parameter>-&gt;<structfield>num_btns</structfield>,
the function has no effect and returns
<symbol>False</symbol>.
Otherwise,
<function>XkbSetDeviceButtonActions</function>
- sends a request to the server to change the actions for the specified buttons
+sends a request to the server to change the actions for the specified buttons
and returns
<symbol>True</symbol>.
</para>
@@ -1684,14 +1684,14 @@ and returns
<para>
If the actual request sent to the server involved illegal button numbers, a
<errorname>BadValue</errorname>
- protocol error is generated. If an invalid device identifier is specified in
+protocol error is generated. If an invalid device identifier is specified in
device_info-&gt;<structfield>device_spec</structfield>,
a <errorname>BadKeyboard</errorname>
- protocol error results. If the actual device specified in
+protocol error results. If the actual device specified in
<parameter>device_info</parameter>-&gt;<structfield>device_spec</structfield>
- does not contain buttons and a request affecting buttons is made, a
+does not contain buttons and a request affecting buttons is made, a
<errorname>BadMatch</errorname>
- protocol error is generated.
+protocol error is generated.
</para>
@@ -1706,7 +1706,7 @@ a <errorname>BadKeyboard</errorname>
<para>
The Xkb extension generates
<symbol>XkbExtensionDeviceNotify</symbol>
- events when the status of an input extension device changes or when an attempt
+events when the status of an input extension device changes or when an attempt
is made to use an Xkb feature that is not supported by a particular device.
</para>
@@ -1717,24 +1717,24 @@ delivered only to the client requesting the event.</para></note>
To track changes to the status of input extension devices or attempts to use
unsupported features of a device, select to receive
<symbol>XkbExtensionDeviceNotify</symbol>
- events by calling either
+events by calling either
<function>XkbSelectEvents</function>
- or
+or
<function>XkbSelectEventDetails</function>
- (see <link linkend="Selecting_Xkb_Events">section 4.3</link>).
+(see <link linkend="Selecting_Xkb_Events">section 4.3</link>).
</para>
<para>
To receive
<symbol>XkbExtensionDeviceNotify</symbol>
- events under all possible conditions, call
+events under all possible conditions, call
<function>XkbSelectEvents</function>
- and pass
+and pass
<symbol>XkbExtensionDeviceNotifyMask</symbol>
- in both
+in both
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>.
</para>
@@ -1742,19 +1742,19 @@ To receive
<para>
The
<symbol>XkbExtensionDeviceNotify</symbol>
- event has no event details. However, you can call
+event has no event details. However, you can call
<function>XkbSelectEventDetails</function>
- using
+using
<symbol>XkbExtensionDeviceNotify</symbol>
- as the
+as the
<structfield>event_type</structfield>
- and specifying
+and specifying
<symbol>XkbAllExtensionDeviceEventsMask</symbol>
- in
+in
<parameter>bits_to_change</parameter>
- and
+and
<parameter>values_for_bits</parameter>.
- This has the same effect as a call to
+This has the same effect as a call to
<function>XkbSelectEvents</function>.
</para>
@@ -1762,7 +1762,7 @@ The
<para>
The structure for
<symbol>XkbExtensionDeviceNotify</symbol>
- events is:
+events is:
<programlisting>
typedef struct {
@@ -1789,7 +1789,7 @@ typedef struct {
<para>
The
<symbol>XkbExtensionDeviceNotify</symbol>
- event has fields enabling it to report changes in the state (on/off) of all of
+event has fields enabling it to report changes in the state (on/off) of all of
the buttons for a device, but only for one LED feedback associated with a
device. You will get multiple events when more than one LED feedback changes
state or configuration.
@@ -1807,9 +1807,9 @@ state or configuration.
<para>
Changes to an Xkb extension device may be tracked by listening to
<symbol>XkbExtensionDeviceNotify</symbol>
- events and accumulating the changes in an
+events and accumulating the changes in an
<structname>XkbDeviceChangesRec</structname>
- structure. The changes noted in the structure may then be used in subsequent
+structure. The changes noted in the structure may then be used in subsequent
operations to update either a server configuration or a local copy of an Xkb
extension device configuration. The changes structure is defined as follows:
@@ -1836,7 +1836,7 @@ typedef struct _XkbDeviceLedChanges {
A local description of the configuration and state of a device may be kept in
an
<structname>XkbDeviceInfoRec</structname>
- structure. The actual state or configuration of the device may change because
+structure. The actual state or configuration of the device may change because
of XkbSetDeviceInfo and XkbSetButtonActions requests made by clients or by user
interaction with the device. The X server sends an XkbExtensionDeviceNotify
event to all interested clients when the state of any buttons or indicators or
@@ -1854,7 +1854,7 @@ server.
<para>
To note device changes reported in an
<symbol>XkbExtensionDeviceNotify</symbol>
- event, use XkbNoteDeviceChanges.
+event, use XkbNoteDeviceChanges.
</para>
<indexterm significance="preferred" zone="XkbNoteDeviceChanges"><primary><function>XkbNoteDeviceChanges</function></primary></indexterm>
@@ -1910,17 +1910,17 @@ 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
<structfield>reason</structfield>
- field of the event in
+field of the event in
<parameter>new</parameter>
- indicates the types of changes the event is reporting.
+indicates the types of changes the event is reporting.
<function>XkbNoteDeviceChanges</function>
- updates the
+updates the
<structname>XkbDeviceChangesRec</structname>
- specified by
+specified by
<parameter>old</parameter>
- with the changes that are both specified in
+with the changes that are both specified in
<parameter>wanted</parameter>
- and contained in
+and contained in
<parameter>new</parameter>-&gt;<structfield>reason</structfield>.
</para>
@@ -1929,7 +1929,7 @@ The
To update a local copy of the state and configuration of an X input extension
device with the changes previously noted in an
<structname>XkbDeviceChangesRec</structname>
- structure, use XkbGetDeviceInfoChanges.
+structure, use XkbGetDeviceInfoChanges.
</para>
@@ -1991,15 +1991,15 @@ changes) -->
The changes-&gt;changed field indicates which attributes of the device
specified in
<parameter>changes</parameter>-&gt;<structfield>device</structfield>
- have changed. The parameters describing the changes are contained in the other
+have changed. The parameters describing the changes are contained in the other
fields of
<parameter>changes</parameter>.
<function>XkbGetDeviceInfoChanges</function>
- uses that information to call XkbGetDeviceInfo to obtain the current status of
+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
<parameter>device_info</parameter>
- with the new information.
+with the new information.
</para>
@@ -2057,11 +2057,11 @@ XkbDeviceChangesRec, use XkbChangeDeviceInfo.
<para>
<function>XkbChangeDeviceInfo</function>
- updates the server’s description of the device specified in
+updates the server’s description of the device specified in
<parameter>device_info</parameter>-&gt;<structfield>device_spec</structfield>
- with the changes specified in
+with the changes specified in
<parameter>changes</parameter>
- and contained in
+and contained in
<parameter>device_info</parameter>.
The update is made by an XkbSetDeviceInfo request.
</para>
diff --git a/specs/XKB/ch22.xml b/specs/XKB/ch22.xml
index 5fe31531..4a3981af 100644
--- a/specs/XKB/ch22.xml
+++ b/specs/XKB/ch22.xml
@@ -125,64 +125,64 @@ To change the values of any of the debug controls, use
<para>
<function>XkbSetDebuggingFlags</function>
- modifies the debug output flags as specified by
+modifies the debug output flags as specified by
<parameter>mask</parameter>
- and
+and
<parameter>flags</parameter>,
modifies the debug controls flags as specified by
<parameter>ctrls_mask</parameter>
- and
+and
<parameter>ctrls</parameter>,
prints the message
<parameter>msg</parameter>,
and backfills
<parameter>ret_flags</parameter>
- and
+and
<parameter>ret_ctrls</parameter>
- with the resulting debug output and debug controls flags.
+with the resulting debug output and debug controls flags.
</para>
<para>
When bits are set in the debug output masks,
<parameter>mask</parameter>
- and
+and
<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
<parameter>mask</parameter>
- and
+and
<parameter>flags</parameter>
- is implementation-specific. To turn on a debug output selection, set the bit
+is implementation-specific. To turn on a debug output selection, set the bit
for the output in the
<parameter>mask</parameter>
- parameter and set the corresponding bit in the
+parameter and set the corresponding bit in the
<parameter>flags</parameter>
- parameter. To turn off event selection for an event, set the bit for the
+parameter. To turn off event selection for an event, set the bit for the
output in the
<parameter>mask</parameter>
- parameter and do not set the corresponding bit in the
+parameter and do not set the corresponding bit in the
<parameter>flags</parameter>
- parameter.
+parameter.
</para>
<para>
When bits are set in the debug controls masks,
<parameter>ctrls_mask</parameter>
- and
+and
<parameter>ctrls</parameter>,
Xkb modifies its behavior according to each controls bit.
<parameter>ctrls_mask</parameter>
- and
+and
<parameter>ctrls</parameter>
- are related in the same way that
+are related in the same way that
<parameter>mask</parameter>
- and
+and
<parameter>flags</parameter>
- are. The valid controls bits are defined in
+are. The valid controls bits are defined in
<link linkend="table22.1">Table 22.1</link>.
</para>
@@ -212,11 +212,11 @@ Xkb modifies its behavior according to each controls bit.
<para>
<function>XkbSetDebuggingFlags</function>
- returns
+returns
<symbol>True</symbol>
- if successful and
+if successful and
<symbol>False</symbol>
- otherwise. The only protocol error it may generate is
+otherwise. The only protocol error it may generate is
<errorname>BadAlloc</errorname>,
if for some reason it is unable to allocate storage.
</para>
@@ -224,17 +224,17 @@ if for some reason it is unable to allocate storage.
<para>
<function>XkbSetDebuggingFlags</function>
- is intended for developer use and may be disabled in production X servers. If
+is intended for developer use and may be disabled in production X servers. If
it is disabled,
<function>XkbSetDebuggingFlags</function>
- has no effect and does not generate any protocol errors.
+has no effect and does not generate any protocol errors.
</para>
<para>
The message in
<parameter>msg</parameter>
- is written immediately. The device to which it is written is implementation
+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.
</para>
diff --git a/specs/XKB/glossary.xml b/specs/XKB/glossary.xml
index 37fdfba2..1eb600c9 100644
--- a/specs/XKB/glossary.xml
+++ b/specs/XKB/glossary.xml
@@ -89,9 +89,9 @@ The canonical key types are predefined key types that describe the types of
keys available on most keyboards. The definitions for the canonical key types
are held in the first
<symbol>XkbNumRequiredTypes</symbol>
- entries of the
+entries of the
<structfield>types</structfield>
- field of the client map and are indexed using the following constants:
+field of the client map and are indexed using the following constants:
</para>
<itemizedlist>
<listitem>
@@ -132,7 +132,7 @@ The key mapping information needed to convert arbitrary keycodes to symbols.
<para>
The
<emphasis>compat</emphasis>
- name is a string that provides some information about the rules used to bind
+name is a string that provides some information about the rules used to bind
actions to keys that are changed using core protocol requests.
</para>
</glossdef>
@@ -191,10 +191,10 @@ Xkb normally consumes modifiers in determining the appropriate symbol for an
event, that is, the modifiers are not considered during any of the later stages
of event processing. For those rare occasions when a modifier
<emphasis>should</emphasis>
- be considered despite having been used to look up a symbol, key types include
+be considered despite having been used to look up a symbol, key types include
an optional
<structfield>preserve</structfield>
- field.
+field.
</para>
</glossdef>
</glossentry>
@@ -213,14 +213,14 @@ An event created from the core X server.
Detectable auto-repeat allows a client to detect an auto-repeating key. If a
client requests and the server supports detectable auto-repeat, Xkb generates
<symbol>KeyRelease</symbol>
- events only when the key is physically released. Thus the client receives a
+events only when the key is physically released. Thus the client receives a
number of
<symbol>KeyPress</symbol>
- events for that key without intervening
+events for that key without intervening
<symbol>KeyRelease</symbol>
- events until the key is finally released, when a
+events until the key is finally released, when a
<symbol>KeyRelease</symbol>
- event is received.
+event is received.
</para>
</glossdef>
</glossentry>
@@ -232,12 +232,12 @@ The effective group is the arithmetic sum of the locked, latched, and base
groups. The effective keyboard group is always brought back into range
depending on the value of the
<emphasis>GroupsWrap</emphasis>
- control for the keyboard. If an event occurs with an effective group that is
+control for the keyboard. If an event occurs with an effective group that is
legal for the keyboard as a whole, but not for the key in question, the group
<emphasis>for that event only</emphasis>
- is normalized using the algorithm specified by the
+is normalized using the algorithm specified by the
<structfield>group_info</structfield>
- member of the key symbol map
+member of the key symbol map
(<structname>XkbSymMapRec</structname>).
</para>
@@ -427,9 +427,9 @@ explicitly set its state and whether it tracks the keyboard state. The
indicator map is the collection of these attributes for each indicator and is
held in the
<structfield>maps</structfield>
- array, which is an array of
+array, which is an array of
<structname>XkbIndicatorRec</structname>
- structures.
+structures.
</para>
</glossdef>
</glossentry>
@@ -512,7 +512,7 @@ symbolic names section.
<para>
The
<structfield>behaviors</structfield>
- field of the server map is an array of
+field of the server map is an array of
<structname>XkbBehavior</structname>,
indexed by keycode, and contains the behavior for each key. The X server uses
key behavior to determine whether to process or filter out any given key event;
@@ -546,7 +546,7 @@ exactly one behavior.
A key symbol map describes the symbols bound to a key and the rules to be used
to interpret those symbols. It is an array of
<structname>XkbSymMapRec</structname>
- structures indexed by keycode.
+structures indexed by keycode.
</para>
</glossdef>
</glossentry>
@@ -558,13 +558,13 @@ Key types are used to determine the shift level of a key given the current
state of the keyboard. There is one key type for each group for a key. Key
types are defined using the
<structname>XkbKeyTypeRec</structname>
- and
+and
<structname>XkbKTMapEntryRec</structname>
- structures. Xkb allows up to
+structures. Xkb allows up to
<symbol>XkbMaxKeyTypes</symbol>
- (255) key types to be defined, but requires at least
+(255) key types to be defined, but requires at least
<symbol>XkbNumRequiredTypes</symbol>
- (4) predefined types to be in a key map.
+(4) predefined types to be in a key map.
</para>
</glossdef>
</glossentry>
@@ -590,7 +590,7 @@ components. They correspond to the
<structfield>compat</structfield>,
and
<structfield>types</structfield>
- symbolic names associated with a keyboard.
+symbolic names associated with a keyboard.
</para>
</glossdef>
</glossentry>
@@ -629,7 +629,7 @@ Keyboard geometry describes the physical appearance of the keyboard, including
the shape, location, and color of all keyboard keys or other visible keyboard
components such as indicators and is stored in a
<structname>XkbGeometryRec</structname>
- structure. The information contained in a keyboard geometry is sufficient to
+structure. The information contained in a keyboard geometry is sufficient to
allow a client program to draw an accurate two-dimensional image of the
keyboard.
</para>
@@ -642,7 +642,7 @@ keyboard.
The keyboard geometry name describes the physical location, size, and shape of
the various keys on the keyboard and is part of the
<structname>XkbNamesRec</structname>
- structure.
+structure.
</para>
</glossdef>
</glossentry>
@@ -673,7 +673,7 @@ the device.
The keycode name describes the range and meaning of the keycodes returned by
the keyboard and is part of the
<structname>XkbNamesRec</structname>
- structure.
+structure.
</para>
</glossdef>
</glossentry>
@@ -752,11 +752,11 @@ protocol eight modifiers
<symbol>Control</symbol>,
and
<symbol>Mod1</symbol>
- through
+through
<symbol>Mod5</symbol>),
- called the
+called the
<emphasis>real</emphasis>
- modifiers. In addition, Xkb extends modifier flexibility by providing a set of
+modifiers. In addition, Xkb extends modifier flexibility by providing a set of
sixteen named virtual modifiers, each of which can be bound to any set of the
eight real modifiers.
</para>
@@ -811,7 +811,7 @@ polygon, used in the geometry specification for a keyboard.
<para>
The physical indicator mask is a field in the
<structname>XkbIndicatorRec</structname>
- that indicates which indicators are bound to physical LEDs on the keyboard; if
+that indicates which indicators are bound to physical LEDs on the keyboard; if
a bit is set in
<structfield>phys_indicators</structfield>,
then the associated indicator has a physical LED associated with it. This
@@ -826,11 +826,11 @@ LEDs on the keyboard.
<para>
The
<structfield>symbols</structfield>
- keyboard name identifies the symbols logically bound to the keys. The symbols
+keyboard name identifies the symbols logically bound to the keys. The symbols
name is a human or application-readable description of the intended locale or
usage of the keyboard with these symbols. The
<structfield>phys_symbols</structfield>
- keyboard name, on the other hand, identifies the symbols actually engraved on
+keyboard name, on the other hand, identifies the symbols actually engraved on
the keyboard.
</para>
</glossdef>
@@ -843,12 +843,12 @@ Xkb normally consumes modifiers in determining the appropriate symbol for an
event, that is, the modifiers are not considered during any of the later stages
of event processing. For those rare occasions when a modifier
<emphasis>should</emphasis>
- be considered despite having been used to look up a symbol, key types include
+be considered despite having been used to look up a symbol, key types include
an optional
<structfield>preserve</structfield>
- field. If a modifier is present in the
+field. If a modifier is present in the
<structfield>preserve</structfield>
- list, it is a preserved modifier.
+list, it is a preserved modifier.
</para>
</glossdef>
</glossentry>
@@ -874,11 +874,11 @@ Xkb supports the eight core protocol modifiers
<symbol>Control</symbol>,
and
<symbol>Mod1</symbol>
- through
+through
<symbol>Mod5</symbol>);
- these are called the
+these are called the
<emphasis>real</emphasis>
- modifiers, as opposed to the set of sixteen named virtual modifiers that can
+modifiers, as opposed to the set of sixteen named virtual modifiers that can
be bound to any set of the eight real modifiers.
</para>
</glossdef>
@@ -907,11 +907,11 @@ produced when a key is actuated.
<para>
The
<structfield>symbols</structfield>
- keyboard name identifies the symbols logically bound to the keys. The symbols
+keyboard name identifies the symbols logically bound to the keys. The symbols
name is a human or application-readable description of the intended locale or
usage of the keyboard with these symbols. The
<structfield>phys_symbols</structfield>
- keyboard name, on the other hand, identifies the symbols actually engraved on
+keyboard name, on the other hand, identifies the symbols actually engraved on
the keyboard.
</para>
</glossdef>
@@ -923,7 +923,7 @@ the keyboard.
Xkb supports symbolic names for most components of the keyboard extension. Most
of these symbolic names are grouped into the
<structfield>names</structfield>
- component of the keyboard description.
+component of the keyboard description.
</para>
</glossdef>
</glossentry>
@@ -942,7 +942,7 @@ group, and button state information pertaining to the event.
<para>
The
<emphasis>types</emphasis>
- name provides some information about the set of key types that can be
+name provides some information about the set of key types that can be
associated with the keyboard. In addition, each key type can have a name, and
each shift level of a type can have a name.
</para>
@@ -967,7 +967,7 @@ of the real modifiers
(<symbol>Shift</symbol>,
<symbol>Lock</symbol>,
<symbol>Control</symbol>,
- and
+and
<symbol>Mod1</symbol>
&ndash;
<symbol>Mod5</symbol>).