mirror of
https://gitlab.freedesktop.org/xorg/lib/libx11.git
synced 2025-12-25 21:10:06 +01:00
specs/XKB: add some more indexterms by hand
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
This commit is contained in:
Alan Coopersmith
parent
5c3aa4c69e
commit
ac219bf152
20 changed files with 247 additions and 14 deletions
|
|
@ -359,6 +359,7 @@ directly manipulate the new capabilities.
|
|||
|
||||
<sect2 id='Error_Indications'>
|
||||
<title>Error Indications</title>
|
||||
<indexterm zone="Error_Indications"><primary>errors</primary></indexterm>
|
||||
|
||||
<para>
|
||||
Xkb functions that communicate with the X server check to be sure the Xkb
|
||||
|
|
|
|||
|
|
@ -53,6 +53,7 @@ keyboard geometry descriptions.
|
|||
</sect1>
|
||||
<sect1 id='Extension_Name'>
|
||||
<title>Extension Name</title>
|
||||
<indexterm significance="preferred" zone="Extension_Name"><primary><symbol>XkbName</symbol></primary></indexterm>
|
||||
<para>
|
||||
The name of the Xkb extension is given in
|
||||
<filename class="headerfile"><X11/extensions/Xkb.h></filename>:
|
||||
|
|
@ -193,6 +194,10 @@ calls to Xkb library functions made prior to initializing the Xkb extension
|
|||
cause
|
||||
<errorname>BadAccess</errorname>
|
||||
protocol errors.
|
||||
<indexterm zone="Initializing_the_Keyboard_Extension"><primary>errors</primary>
|
||||
<secondary><errorname>BadAccess</errorname></secondary></indexterm>
|
||||
<indexterm zone="Initializing_the_Keyboard_Extension">
|
||||
<primary><errorname>BadAccess</errorname></primary></indexterm>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
|
|
@ -562,6 +567,9 @@ use Xkb on a connection for which it is disabled.
|
|||
</sect1>
|
||||
<sect1 id='Protocol_Errors'>
|
||||
<title>Protocol Errors</title>
|
||||
<indexterm significance="preferred" zone="Protocol_Errors">
|
||||
<primary>errors</primary></indexterm>
|
||||
|
||||
<para>
|
||||
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
|
||||
|
|
@ -662,7 +670,11 @@ Device, Feedback Class, or Feedback ID invalid
|
|||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
<para id='BadKeyboard'>
|
||||
<indexterm zone="BadKeyboard"><primary>errors</primary>
|
||||
<secondary><errorname>BadKeyboard</errorname></secondary></indexterm>
|
||||
<indexterm zone="BadKeyboard">
|
||||
<primary><errorname>BadKeyboard</errorname></primary></indexterm>
|
||||
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
|
||||
|
|
@ -783,7 +795,8 @@ involve both a server connection (Display *
|
|||
structure passed as an argument.
|
||||
</para>
|
||||
|
||||
<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,
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
|
||||
<chapter id='Xkb_Events'>
|
||||
<title>Xkb Events</title>
|
||||
<indexterm zone="Xkb_Events"><primary>events</primary></indexterm>
|
||||
|
||||
<para>
|
||||
The primary way the X server communicates with clients is by sending X events
|
||||
|
|
@ -159,7 +160,11 @@ event.
|
|||
<sect1 id='Xkb_Event_Data_Structures'>
|
||||
<title>Xkb Event Data Structures</title>
|
||||
|
||||
<para>
|
||||
<para id='XkbAnyEvent'>
|
||||
<indexterm significance="preferred" zone="Xkb_Event_Data_Structures">
|
||||
<primary>events</primary><secondary><structname>XkbAnyEvent</structname></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Xkb_Event_Data_Structures">
|
||||
<primary><structname>XkbAnyEvent</structname></primary></indexterm>
|
||||
Xkb reports each event it generates in a unique structure holding the data
|
||||
values needed to describe the conditions the event is reporting. However, all
|
||||
Xkb events have certain things in common. These common features are contained
|
||||
|
|
@ -222,6 +227,10 @@ chapters where the events are described.
|
|||
</sect1>
|
||||
<sect1 id='Selecting_Xkb_Events'>
|
||||
<title>Selecting Xkb Events</title>
|
||||
<indexterm significance="preferred" zone="Selecting_Xkb_Events">
|
||||
<primary>events</primary><secondary>mask</secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Selecting_Xkb_Events">
|
||||
<primary>mask</primary><secondary>event</secondary></indexterm>
|
||||
|
||||
<para>
|
||||
Xkb events are selected using an event mask, much the same as normal core X
|
||||
|
|
@ -666,6 +675,10 @@ in <link linkend="Selecting_Xkb_Events">section 4.3</link>.
|
|||
</sect1>
|
||||
<sect1 id='Unified_Xkb_Event_Type'>
|
||||
<title>Unified Xkb Event Type</title>
|
||||
<indexterm significance="preferred" zone="Unified_Xkb_Event_Type">
|
||||
<primary>events</primary><secondary><structname>XkbEvent</structname></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Unified_Xkb_Event_Type">
|
||||
<primary><structname>XkbEvent</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The
|
||||
|
|
|
|||
|
|
@ -76,6 +76,8 @@ The Xkb extension provides support for
|
|||
<primary>keysym groups</primary></indexterm>
|
||||
<indexterm significance="preferred" zone="keysym_groups">
|
||||
<primary>group</primary><secondary>keysym</secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="keysym_groups">
|
||||
<primary>group</primary><secondary>ISO9995</secondary></indexterm>
|
||||
as defined by ISO9995:
|
||||
</para>
|
||||
|
||||
|
|
@ -346,6 +348,13 @@ The X11 protocol interpretation of modifiers does not include direct support for
|
|||
<sect2 id='Changing_Modifiers'>
|
||||
<title>Changing Modifiers</title>
|
||||
|
||||
<indexterm zone="Changing_Modifiers">
|
||||
<primary>real modifiers</primary></indexterm>
|
||||
<indexterm zone="Changing_Modifiers">
|
||||
<primary>modifiers</primary><secondary>real</secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Changing_Modifiers">
|
||||
<primary>mask</primary><secondary>real modifiers</secondary></indexterm>
|
||||
|
||||
<para>
|
||||
The functions in this section that change the use of modifiers use a mask in the parameter
|
||||
<structfield>affect</structfield>.
|
||||
|
|
@ -556,6 +565,11 @@ To latch and unlatch any of the eight real keyboard modifiers, use
|
|||
<sect2 id='Changing_Groups'>
|
||||
<title>Changing Groups</title>
|
||||
|
||||
<indexterm zone="Changing_Groups">
|
||||
<primary>keysym groups</primary></indexterm>
|
||||
<indexterm zone="Changing_Groups">
|
||||
<primary>group</primary><secondary>keysym</secondary></indexterm>
|
||||
|
||||
<para>
|
||||
Reference the keysym group indices with these symbolic constants:
|
||||
</para>
|
||||
|
|
@ -721,6 +735,9 @@ To latch the keysym group, use
|
|||
<sect1 id='Determining_Keyboard_State'>
|
||||
<title>Determining Keyboard State</title>
|
||||
|
||||
<indexterm significance="preferred" zone="Determining_Keyboard_State">
|
||||
<primary><structname>XkbStateRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Xkb keyboard state may be represented in an
|
||||
<structname>XkbStateRec</structname>
|
||||
|
|
@ -819,6 +836,11 @@ All group values are expressed as group indices in the range [0..3]. Modifiers a
|
|||
<sect1 id='Tracking_Keyboard_State'>
|
||||
<title>Tracking Keyboard State</title>
|
||||
|
||||
<indexterm significance="preferred" zone="Tracking_Keyboard_State">
|
||||
<primary>events</primary><secondary><symbol>XkbStateNotify</symbol></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Tracking_Keyboard_State">
|
||||
<primary><structname>XkbStateNotifyEvent</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The Xkb extension reports
|
||||
<symbol>XkbStateNotify</symbol>
|
||||
|
|
|
|||
|
|
@ -14,6 +14,9 @@ document that discuss the major Xkb components in detail.
|
|||
<sect1 id='The_XkbDescRec_Structure'>
|
||||
<title>The XkbDescRec Structure</title>
|
||||
|
||||
<indexterm significance="preferred" zone="The_XkbDescRec_Structure">
|
||||
<primary><structname>XkbDescRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The complete description of an Xkb keyboard is given by an
|
||||
<structname>XkbDescRec</structname>.
|
||||
|
|
|
|||
|
|
@ -113,6 +113,9 @@ These functions are discussed in <xref linkend="Symbolic_Names" />.
|
|||
<sect1 id='Modifier_Definitions'>
|
||||
<title>Modifier Definitions</title>
|
||||
|
||||
<indexterm significance="preferred" zone="Modifier_Definitions">
|
||||
<primary><structname>XkbModsRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
An Xkb
|
||||
<firstterm>modifier definition</firstterm>
|
||||
|
|
@ -374,6 +377,9 @@ virtual modifiers are bound.
|
|||
<sect1 id='Conventions'>
|
||||
<title>Conventions</title>
|
||||
|
||||
<indexterm significance="preferred" zone="Conventions">
|
||||
<primary>modifiers</primary><secondary>names</secondary></indexterm>
|
||||
|
||||
<para>
|
||||
The Xkb extension does not require any specific virtual modifier names.
|
||||
However, everyone benefits if the same names are used for common modifiers. The
|
||||
|
|
|
|||
|
|
@ -4,6 +4,9 @@
|
|||
<chapter id='Indicators'>
|
||||
<title>Indicators</title>
|
||||
|
||||
<indexterm significance="preferred" zone="Indicators">
|
||||
<primary>indicators</primary></indexterm>
|
||||
|
||||
<para>
|
||||
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
|
||||
|
|
@ -82,6 +85,9 @@ to inquire about and control most indicator properties and behaviors.
|
|||
<sect2 id='XkbIndicatorRec'>
|
||||
<title>XkbIndicatorRec</title>
|
||||
|
||||
<indexterm significance="preferred" zone="XkbIndicatorRec">
|
||||
<primary><structname>XkbIndicatorRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The description for all the Xkb indicators is held in the
|
||||
<structfield>indicators</structfield>
|
||||
|
|
@ -134,6 +140,9 @@ or if a new keyboard is attached and the X implementation notices,
|
|||
<sect2 id='XkbIndicatorMapRec'>
|
||||
<title>XkbIndicatorMapRec</title>
|
||||
|
||||
<indexterm significance="preferred" zone="XkbIndicatorMapRec">
|
||||
<primary><structname>XkbIndicatorMapRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
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
|
||||
|
|
@ -1589,9 +1598,12 @@ and
|
|||
|
||||
|
||||
</sect2>
|
||||
<sect2 id='The_XkbIndicatorChangesRec_Structure'>
|
||||
<sect2 id='XkbIndicatorChangesRec'>
|
||||
<title>The XkbIndicatorChangesRec Structure</title>
|
||||
|
||||
<indexterm significance="preferred" zone="XkbIndicatorChangesRec">
|
||||
<primary><structname>XkbIndicatorChangesRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The
|
||||
<structname>XkbIndicatorChangesRec</structname>
|
||||
|
|
@ -1719,6 +1731,16 @@ If any bits are set in the
|
|||
<sect1 id='Tracking_Changes_to_Indicator_State_or_Map'>
|
||||
<title>Tracking Changes to Indicator State or Map</title>
|
||||
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_Indicator_State_or_Map">
|
||||
<primary>events</primary><secondary><symbol>XkbIndicatorStateNotify</symbol></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_Indicator_State_or_Map">
|
||||
<primary><structname>XkbIndicatorStateNotifyEvent</structname></primary></indexterm>
|
||||
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_Indicator_State_or_Map">
|
||||
<primary>events</primary><secondary><symbol>XkbIndicatorMapNotify</symbol></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_Indicator_State_or_Map">
|
||||
<primary><structname>XkbIndicatorMapNotifyEvent</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Whenever an indicator changes state, the server sends
|
||||
<symbol>XkbIndicatorStateNotify</symbol>
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
|
||||
<chapter id='Bells'>
|
||||
<title>Bells</title>
|
||||
<indexterm zone="Bells"><primary>bell</primary></indexterm>
|
||||
|
||||
<para>
|
||||
The core X protocol allows only applications to explicitly sound the system
|
||||
|
|
|
|||
|
|
@ -4,6 +4,13 @@
|
|||
<chapter id='Keyboard_Controls'>
|
||||
<title>Keyboard Controls</title>
|
||||
|
||||
<indexterm significance="preferred" zone="Keyboard_Controls">
|
||||
<primary>controls</primary></indexterm>
|
||||
<indexterm significance="preferred" zone="Keyboard_Controls">
|
||||
<primary>server controls</primary></indexterm>
|
||||
<indexterm significance="preferred" zone="Keyboard_Controls">
|
||||
<primary>controls</primary><secondary>server</secondary></indexterm>
|
||||
|
||||
<para>
|
||||
The Xkb extension is composed of two parts: a server extension, and a
|
||||
client-side X library extension. This chapter discusses functions used to
|
||||
|
|
@ -637,6 +644,9 @@ sound is forced. See <link linkend="Audible_Bells">section 9.2</link>.
|
|||
<sect1 id='Controls_for_Repeat_Key_Behavior'>
|
||||
<title>Controls for Repeat Key Behavior</title>
|
||||
|
||||
<indexterm significance="preferred" zone="Controls_for_Repeat_Key_Behavior">
|
||||
<primary>auto-repeat</primary><secondary>controls</secondary></indexterm>
|
||||
|
||||
<para>
|
||||
The repeating behavior of keyboard keys is governed by three controls, the
|
||||
<emphasis>PerKeyRepeat</emphasis>
|
||||
|
|
@ -2022,6 +2032,11 @@ When any of the above feedbacks occur, Xkb may generate a
|
|||
<sect2 id='AccessXNotify_Events'>
|
||||
<title>AccessXNotify Events</title>
|
||||
|
||||
<indexterm significance="preferred" zone="AccessXNotify_Events">
|
||||
<primary>events</primary><secondary><symbol>XkbAccessXNotify</symbol></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="AccessXNotify_Events">
|
||||
<primary><structname>XkbAccessXNotifyEvent</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The server can generate
|
||||
<symbol>XkbAccessXNotify</symbol>
|
||||
|
|
@ -3430,6 +3445,9 @@ See <link linkend="Virtual_Modifier_Names_and_Masks">section 7.1</link> for a di
|
|||
<sect1 id='The_XkbControlsRec_Structure'>
|
||||
<title>The XkbControlsRec Structure</title>
|
||||
|
||||
<indexterm significance="preferred" zone="The_XkbControlsRec_Structure">
|
||||
<primary><structname>XkbControlsRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
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
|
||||
|
|
@ -4590,6 +4608,9 @@ also provided for this purpose
|
|||
<sect2 id='The_XkbControlsChangesRec_Structure'>
|
||||
<title>The XkbControlsChangesRec Structure</title>
|
||||
|
||||
<indexterm significance="preferred" zone="The_XkbControlsChangesRec_Structure">
|
||||
<primary><structname>XkbControlsChangesRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The
|
||||
<structname>XkbControlsChangesRec</structname>
|
||||
|
|
@ -4711,6 +4732,11 @@ to the server specified by
|
|||
<sect1 id='Tracking_Changes_to_Keyboard_Controls'>
|
||||
<title>Tracking Changes to Keyboard Controls</title>
|
||||
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_Keyboard_Controls">
|
||||
<primary>events</primary><secondary><symbol>XkbControlsNotify</symbol></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_Keyboard_Controls">
|
||||
<primary><structname>XkbControlsNotifyEvent</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Whenever a field in the controls structure changes in the server’s keyboard
|
||||
description, the server sends an
|
||||
|
|
|
|||
|
|
@ -44,6 +44,8 @@ Controls affecting event delivery
|
|||
<para>
|
||||
There are two types of string lookups performed by
|
||||
<function>XLookupString</function>.
|
||||
<indexterm significance="preferred" zone="X_Library_Controls">
|
||||
<primary><function>XLookupString</function></primary></indexterm>
|
||||
The first type involves translating a single keycode into a string; the
|
||||
controls in the first category affect this type of lookup. The second type
|
||||
involves translating a series of keysyms into a string; the controls in the
|
||||
|
|
@ -332,6 +334,11 @@ name is “<literal>ComposeFail</literal>”.
|
|||
<sect2 id='IgnoreNewKeyboards'>
|
||||
<title>IgnoreNewKeyboards</title>
|
||||
|
||||
<indexterm zone="IgnoreNewKeyboards">
|
||||
<primary>events</primary><secondary><symbol>NewKeyboardNotify</symbol></secondary></indexterm>
|
||||
<indexterm zone="IgnoreNewKeyboards">
|
||||
<primary>events</primary><secondary><symbol>MappingNotify</symbol></secondary></indexterm>
|
||||
|
||||
<para>
|
||||
When Xkb is initialized, it implicitly forces requests for
|
||||
<symbol>NewKeyboardNotify</symbol>
|
||||
|
|
|
|||
|
|
@ -44,6 +44,9 @@ by the core protocol.
|
|||
<sect2 id='Effects_of_Xkb_on_MappingNotify_Events'>
|
||||
<title>Effects of Xkb on MappingNotify Events</title>
|
||||
|
||||
<indexterm zone="Effects_of_Xkb_on_MappingNotify_Events">
|
||||
<primary>events</primary><secondary><symbol>MappingNotify</symbol></secondary></indexterm>
|
||||
|
||||
<para>
|
||||
When Xkb is missing or disabled, the X library tracks changes to the keyboard
|
||||
mapping using
|
||||
|
|
@ -140,9 +143,10 @@ clients.
|
|||
</para>
|
||||
|
||||
|
||||
<para>
|
||||
<para id='XKeycodeToKeysym'>
|
||||
The
|
||||
<function>XKeycodeToKeysym</function>
|
||||
<indexterm significance="preferred" zone="XKeycodeToKeysym"><primary><function>XKeycodeToKeysym</function></primary></indexterm>
|
||||
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
|
||||
|
|
@ -153,9 +157,10 @@ the differences.
|
|||
</para>
|
||||
|
||||
|
||||
<para>
|
||||
<para id='XKeysymToKeycode'>
|
||||
The
|
||||
<function>XKeysymToKeycode</function>
|
||||
<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
|
||||
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
|
||||
|
|
@ -164,18 +169,20 @@ symbols instead.
|
|||
</para>
|
||||
|
||||
|
||||
<para>
|
||||
<para id='XLookupKeysym'>
|
||||
The
|
||||
<function>XLookupKeysym</function>
|
||||
<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
|
||||
event. Whether or not Xkb is present, the column specifies an index into the
|
||||
core symbol mapping.
|
||||
</para>
|
||||
|
||||
|
||||
<para>
|
||||
<para id='XLookupString'>
|
||||
The
|
||||
<function>XLookupString</function>
|
||||
<indexterm significance="preferred" zone="XLookupString"><primary><function>XLookupString</function></primary></indexterm>
|
||||
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,
|
||||
|
|
@ -194,9 +201,10 @@ determine matching bindings.
|
|||
</para>
|
||||
|
||||
|
||||
<para>
|
||||
<para id='XRefreshKeyboardMapping'>
|
||||
The
|
||||
<function>XRefreshKeyboardMapping</function>
|
||||
<indexterm significance="preferred" zone="XRefreshKeyboardMapping"><primary><function>XRefreshKeyboardMapping</function></primary></indexterm>
|
||||
function updates the X library’s internal representation of the keyboard to
|
||||
reflect changes reported via
|
||||
<symbol>MappingNotify</symbol>
|
||||
|
|
@ -211,9 +219,10 @@ changed. If the implicit support has not noted any keyboard mapping changes,
|
|||
</para>
|
||||
|
||||
|
||||
<para>
|
||||
<para id='XRebindKeysym'>
|
||||
The
|
||||
<function>XRebindKeysym</function>
|
||||
<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
|
||||
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
|
||||
|
|
|
|||
|
|
@ -54,7 +54,9 @@ Objects should be drawn in order from highest priority (0) to lowest (255).
|
|||
</para>
|
||||
|
||||
|
||||
<para>
|
||||
<para id='XkbGeometryRec'>
|
||||
<indexterm significance="preferred" zone="XkbGeometryRec">
|
||||
<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:
|
||||
|
|
|
|||
|
|
@ -43,6 +43,11 @@ For detailed information on particular components of the keyboard map, refer to
|
|||
<sect1 id='Notation_and_Terminology'>
|
||||
<title>Notation and Terminology</title>
|
||||
|
||||
<indexterm significance="preferred" zone="Notation_and_Terminology">
|
||||
<primary>level</primary></indexterm>
|
||||
<indexterm significance="preferred" zone="Notation_and_Terminology">
|
||||
<primary>shift level</primary></indexterm>
|
||||
|
||||
<para>
|
||||
The graphic characters or control functions that may be accessed by one key are
|
||||
logically arranged in groups and levels, where
|
||||
|
|
@ -712,6 +717,8 @@ helper functions and provides a pointer to where they are defined.
|
|||
|
||||
<sect2 id='The_XkbMapChangesRec_Structure'>
|
||||
<title>The XkbMapChangesRec Structure</title>
|
||||
<indexterm significance="preferred" zone="The_XkbMapChangesRec_Structure">
|
||||
<primary><structname>XkbMapChangesRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Use the
|
||||
|
|
@ -982,6 +989,11 @@ and
|
|||
<sect1 id='Tracking_Changes_to_Map_Components'>
|
||||
<title>Tracking Changes to Map Components</title>
|
||||
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_Map_Components">
|
||||
<primary>events</primary><secondary><symbol>XkbMapNotify</symbol></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_Map_Components">
|
||||
<primary><structname>XkbMapNotifyEvent</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The Xkb extension reports
|
||||
<symbol>XkbMapNotify</symbol>
|
||||
|
|
|
|||
|
|
@ -4,6 +4,11 @@
|
|||
<chapter id='Xkb_Client_Keyboard_Mapping'>
|
||||
<title>Xkb Client Keyboard Mapping</title>
|
||||
|
||||
<indexterm zone="Xkb_Client_Keyboard_Mapping">
|
||||
<primary>client map</primary></indexterm>
|
||||
<indexterm zone="Xkb_Client_Keyboard_Mapping">
|
||||
<primary>map</primary><secondary>client</secondary></indexterm>
|
||||
|
||||
<para>
|
||||
The Xkb client map for a keyboard is the collection of information a client
|
||||
needs to interpret key events from the keyboard. It contains a global list of
|
||||
|
|
@ -32,6 +37,8 @@ Xkb Client Map</H5>
|
|||
|
||||
<sect1 id='The_XkbClientMapRec_Structure'>
|
||||
<title>The XkbClientMapRec Structure</title>
|
||||
<indexterm significance="preferred" zone="The_XkbClientMapRec_Structure">
|
||||
<primary><structname>XkbClientMapRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The
|
||||
|
|
@ -63,6 +70,10 @@ The following sections describe each of the elements of the
|
|||
</sect1>
|
||||
<sect1 id='Key_Types'>
|
||||
<title>Key Types</title>
|
||||
<indexterm significance="preferred" zone="Key_Types">
|
||||
<primary><structname>XkbKeyTypeRec</structname></primary></indexterm>
|
||||
<indexterm significance="preferred" zone="Key_Types">
|
||||
<primary><structname>XkbKTMapEntryRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Key types are used to determine the shift level of a key given the current
|
||||
|
|
@ -1191,6 +1202,8 @@ Otherwise,
|
|||
</sect1>
|
||||
<sect1 id='Key_Symbol_Map'>
|
||||
<title>Key Symbol Map</title>
|
||||
<indexterm significance="preferred" zone="Key_Symbol_Map">
|
||||
<primary><structname>XkbSymMapRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The entire list of key symbols for the keyboard mapping is held in the
|
||||
|
|
|
|||
|
|
@ -4,6 +4,11 @@
|
|||
<chapter id='Xkb_Server_Keyboard_Mapping'>
|
||||
<title>Xkb Server Keyboard Mapping</title>
|
||||
|
||||
<indexterm zone="Xkb_Server_Keyboard_Mapping">
|
||||
<primary>server map</primary></indexterm>
|
||||
<indexterm zone="Xkb_Server_Keyboard_Mapping">
|
||||
<primary>map</primary><secondary>server</secondary></indexterm>
|
||||
|
||||
<para>
|
||||
The
|
||||
<structfield>server</structfield>
|
||||
|
|
@ -30,7 +35,9 @@ to the Xkb server map.
|
|||
Server Map Relationships</H5>
|
||||
-->
|
||||
|
||||
<para>
|
||||
<para id='XkbServerMapRec'>
|
||||
<indexterm significance="preferred" zone="XkbServerMapRec">
|
||||
<primary><structname>XkbServerMapRec</structname></primary></indexterm>
|
||||
The Xkb server map contains the information the server needs to interpret key
|
||||
events and is of type
|
||||
<structname>XkbServerMapRec</structname>:
|
||||
|
|
@ -433,6 +440,8 @@ corresponding to
|
|||
|
||||
<sect2 id='The_XkbAction_Structure'>
|
||||
<title>The XkbAction Structure</title>
|
||||
<indexterm significance="preferred" zone="The_XkbAction_Structure">
|
||||
<primary><structname>XkbAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The description for an action is held in an
|
||||
|
|
@ -470,6 +479,8 @@ structures for each action in detail.
|
|||
</sect2>
|
||||
<sect2 id='The_XkbAnyAction_Structure'>
|
||||
<title>The XkbAnyAction Structure</title>
|
||||
<indexterm significance="preferred" zone="The_XkbAnyAction_Structure">
|
||||
<primary><structname>XkbAnyAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The
|
||||
|
|
@ -619,6 +630,8 @@ have an associated data structure.
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Changing_Modifiers_State'>
|
||||
<title>Actions for Changing Modifiers’ State</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Changing_Modifiers_State">
|
||||
<primary><structname>XkbModAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Actions associated with the
|
||||
|
|
@ -999,6 +1012,8 @@ type XkbAction, these macros may be used only with Actions of type
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Changing_Group_State'>
|
||||
<title>Actions for Changing Group State</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Changing_Group_State">
|
||||
<primary><structname>XkbGroupAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Actions associated with the
|
||||
|
|
@ -1294,6 +1309,8 @@ type XkbAction, these macros may only be used with Actions of type
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Moving_the_Pointer'>
|
||||
<title>Actions for Moving the Pointer</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Moving_the_Pointer">
|
||||
<primary><structname>XkbPtrAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Actions associated with the
|
||||
|
|
@ -1586,6 +1603,8 @@ convert between a signed integer and two signed 16-bit values in
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Simulating_Pointer_Button_Press_and_Release'>
|
||||
<title>Actions for Simulating Pointer Button Press and Release</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Simulating_Pointer_Button_Press_and_Release">
|
||||
<primary><structname>XkbPtrBtnAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Actions associated with the
|
||||
|
|
@ -1805,6 +1824,8 @@ the server only locks the pointer button.
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Changing_the_Pointer_Button_Simulated'>
|
||||
<title>Actions for Changing the Pointer Button Simulated</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Changing_the_Pointer_Button_Simulated">
|
||||
<primary><structname>XkbPtrDfltAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Actions associated with the
|
||||
|
|
@ -2000,6 +2021,8 @@ values in
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Locking_Modifiers_and_Group'>
|
||||
<title>Actions for Locking Modifiers and Group</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Locking_Modifiers_and_Group">
|
||||
<primary><structname>XkbISOAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Actions associated with the
|
||||
|
|
@ -2443,6 +2466,8 @@ If
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Changing_the_Active_Screen'>
|
||||
<title>Actions for Changing the Active Screen</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Changing_the_Active_Screen">
|
||||
<primary><structname>XkbSwitchScreenAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Actions associated with the
|
||||
|
|
@ -2613,6 +2638,8 @@ signed character value for screen numbers in
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Changing_Boolean_Controls_State'>
|
||||
<title>Actions for Changing Boolean Controls State</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Changing_Boolean_Controls_State">
|
||||
<primary><structname>XkbCtrlsAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Actions associated with the
|
||||
|
|
@ -2876,6 +2903,8 @@ macros, to convert between the two formats:
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Generating_Messages'>
|
||||
<title>Actions for Generating Messages</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Generating_Messages">
|
||||
<primary><structname>XkbMessageAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Actions associated with the
|
||||
|
|
@ -2971,6 +3000,10 @@ The
|
|||
|
||||
<sect3 id='Detecting_Key_Action_Messages'>
|
||||
<title>Detecting Key Action Messages</title>
|
||||
<indexterm significance="preferred" zone="Detecting_Key_Action_Messages">
|
||||
<primary>events</primary><secondary><symbol>XkbActionMessage</symbol></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Detecting_Key_Action_Messages">
|
||||
<primary><structname>XkbActionMessageEvent</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
To receive
|
||||
|
|
@ -3105,6 +3138,8 @@ The
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Generating_a_Different_Keycode'>
|
||||
<title>Actions for Generating a Different Keycode</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Generating_a_Different_Keycode">
|
||||
<primary><structname>XkbRedirectKeyAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Actions associated with the
|
||||
|
|
@ -3370,6 +3405,8 @@ provides the following convenience macros:
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Generating_DeviceButtonPress_and_DeviceButtonRelease'>
|
||||
<title>Actions for Generating DeviceButtonPress and DeviceButtonRelease</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Generating_DeviceButtonPress_and_DeviceButtonRelease">
|
||||
<primary><structname>XkbDeviceBtnAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Actions associated with
|
||||
|
|
@ -3552,6 +3589,8 @@ the server only locks the button.
|
|||
</sect2>
|
||||
<sect2 id='Actions_for_Simulating_Events_from_Device_Valuators'>
|
||||
<title>Actions for Simulating Events from Device Valuators</title>
|
||||
<indexterm significance="preferred" zone="Actions_for_Simulating_Events_from_Device_Valuators">
|
||||
<primary><structname>XkbDeviceValuatorAction</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
A
|
||||
|
|
@ -4014,6 +4053,8 @@ currently defined is:
|
|||
</sect2>
|
||||
<sect2 id='The_XkbBehavior_Structure'>
|
||||
<title>The XkbBehavior Structure</title>
|
||||
<indexterm significance="preferred" zone="The_XkbBehavior_Structure">
|
||||
<primary><structname>XkbBehavior</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The
|
||||
|
|
|
|||
|
|
@ -130,6 +130,8 @@ subsequent transformations have a particular result.
|
|||
|
||||
<sect1 id='The_XkbCompatMap_Structure'>
|
||||
<title>The XkbCompatMap Structure</title>
|
||||
<indexterm significance="preferred" zone="The_XkbCompatMap_Structure">
|
||||
<primary><structname>XkbCompatMapRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
All configurable aspects of mapping Xkb state and configuration to and from
|
||||
|
|
@ -413,6 +415,8 @@ using
|
|||
|
||||
<sect3 id='Symbol_Interpretations__the_XkbSymInterpretRec_Structure'>
|
||||
<title>Symbol Interpretations — the XkbSymInterpretRec Structure</title>
|
||||
<indexterm significance="preferred" zone="Symbol_Interpretations__the_XkbSymInterpretRec_Structure">
|
||||
<primary><structname>XkbSymInterpretRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Symbol interpretations are used to guide the X server when it modifies the Xkb
|
||||
|
|
@ -1512,6 +1516,10 @@ not much changes).
|
|||
</sect1>
|
||||
<sect1 id='Tracking_Changes_to_the_Compatibility_Map'>
|
||||
<title>Tracking Changes to the Compatibility Map</title>
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_the_Compatibility_Map">
|
||||
<primary>events</primary><secondary><symbol></symbol>XkbCompatMapNotify</secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_the_Compatibility_Map">
|
||||
<primary><structname>XkbCompatMapNotifyEvent</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The server automatically generates
|
||||
|
|
|
|||
|
|
@ -30,6 +30,12 @@ these symbolic names are grouped into the
|
|||
|
||||
<sect1 id='The_XkbNamesRec_Structure'>
|
||||
<title>The XkbNamesRec Structure</title>
|
||||
<indexterm significance="preferred" zone="The_XkbNamesRec_Structure">
|
||||
<primary><structname>XkbKeyNameRec</structname></primary></indexterm>
|
||||
<indexterm significance="preferred" zone="The_XkbNamesRec_Structure">
|
||||
<primary><structname>XkbKeyAliasRec</structname></primary></indexterm>
|
||||
<indexterm significance="preferred" zone="The_XkbNamesRec_Structure">
|
||||
<primary><structname>XkbNamesRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The names component of the keyboard description is defined as follows:
|
||||
|
|
@ -635,6 +641,8 @@ The specified types are illegal if
|
|||
|
||||
<sect3 id='The_XkbNameChangesRec_Structure'>
|
||||
<title>The XkbNameChangesRec Structure</title>
|
||||
<indexterm significance="preferred" zone="The_XkbNameChangesRec_Structure">
|
||||
<primary><structname>XkbNameChangesRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The
|
||||
|
|
@ -831,6 +839,10 @@ to the X server specified by
|
|||
</sect1>
|
||||
<sect1 id='Tracking_Name_Changes'>
|
||||
<title>Tracking Name Changes</title>
|
||||
<indexterm significance="preferred" zone="Tracking_Name_Changes">
|
||||
<primary>events</primary><secondary><symbol>XkbNamesNotify</symbol></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Tracking_Name_Changes">
|
||||
<primary><structname>XkbNamesNotifyEvent</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Whenever a symbolic name changes in the server’s keyboard description, the
|
||||
|
|
|
|||
|
|
@ -160,6 +160,10 @@ manner; all Xkb events report the full range of legal keycodes. No requested
|
|||
Xkb events are discarded, and no Xkb requests have their keycode range clamped.
|
||||
</para>
|
||||
|
||||
<indexterm significance="preferred" zone="Replacing_a_Keyboard_On_the_Fly">
|
||||
<primary>events</primary><secondary><symbol>XkbNewKeyboardNotify</symbol></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="Replacing_a_Keyboard_On_the_Fly">
|
||||
<primary><structname>XkbNewKeyboardNotifyEvent</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The structure for the
|
||||
|
|
|
|||
|
|
@ -287,7 +287,9 @@ because of the limit.
|
|||
</para>
|
||||
|
||||
|
||||
<para>
|
||||
<para id='XkbComponentNamesRec'>
|
||||
<indexterm significance="preferred" zone="XkbComponentNamesRec">
|
||||
<primary><structname>XkbComponentNamesRec</structname></primary></indexterm>
|
||||
The component name patterns used to describe the request are passed to
|
||||
<function>XkbListComponents</function>
|
||||
using an
|
||||
|
|
@ -311,7 +313,11 @@ typedef struct _XkbComponentNames {
|
|||
} <structname>XkbComponentNamesRec</structname>, *XkbComponentNamesPtr;
|
||||
</programlisting></para>
|
||||
|
||||
<para>
|
||||
<para id='XkbComponentListRec'>
|
||||
<indexterm significance="preferred" zone="XkbComponentListRec">
|
||||
<primary><structname>XkbComponentListRec</structname></primary></indexterm>
|
||||
<indexterm significance="preferred" zone="XkbComponentListRec">
|
||||
<primary><structname>XkbComponentNameRec</structname></primary></indexterm>
|
||||
<function>XkbListComponents</function>
|
||||
returns a pointer to an
|
||||
<structname>XkbComponentListRec</structname>:
|
||||
|
|
|
|||
|
|
@ -156,6 +156,10 @@ silently if Xkb access to those devices is not supported by the X server.
|
|||
|
||||
<sect1 id='XkbDeviceInfoRec'>
|
||||
<title>XkbDeviceInfoRec</title>
|
||||
<indexterm significance="preferred" zone="XkbDeviceInfoRec">
|
||||
<primary><structname>XkbDeviceInfoRec</structname></primary></indexterm>
|
||||
<indexterm significance="preferred" zone="XkbDeviceInfoRec">
|
||||
<primary><structname>XkbDeviceLedInfoRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Information about X Input Extension devices is transferred between a client
|
||||
|
|
@ -1694,6 +1698,10 @@ a <errorname>BadKeyboard</errorname>
|
|||
</sect1>
|
||||
<sect1 id='XkbExtensionDeviceNotify_Event'>
|
||||
<title>XkbExtensionDeviceNotify Event</title>
|
||||
<indexterm significance="preferred" zone="XkbExtensionDeviceNotify_Event">
|
||||
<primary>events</primary><secondary><symbol>XkbExtensionDeviceNotify</symbol></secondary></indexterm>
|
||||
<indexterm significance="preferred" zone="XkbExtensionDeviceNotify_Event">
|
||||
<primary><structname>XkbExtensionDeviceNotifyEvent</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
The Xkb extension generates
|
||||
|
|
@ -1791,6 +1799,10 @@ state or configuration.
|
|||
</sect1>
|
||||
<sect1 id='Tracking_Changes_to_Extension_Devices'>
|
||||
<title>Tracking Changes to Extension Devices</title>
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_Extension_Devices">
|
||||
<primary><structname>XkbDeviceChangesRec</structname></primary></indexterm>
|
||||
<indexterm significance="preferred" zone="Tracking_Changes_to_Extension_Devices">
|
||||
<primary><structname>XkbDeviceLedChangesRec</structname></primary></indexterm>
|
||||
|
||||
<para>
|
||||
Changes to an Xkb extension device may be tracked by listening to
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue