diff --git a/specs/XKB/ch01.xml b/specs/XKB/ch01.xml index 03cc3d66..aee21680 100644 --- a/specs/XKB/ch01.xml +++ b/specs/XKB/ch01.xml @@ -352,7 +352,8 @@ Xkb functions that communicate with the X server check to be sure the Xkb extension has been properly initialized prior to doing any other operations. If the extension has not been properly initialized or the application, library, and server versions are incompatible, these functions return an error -indication as shown in Table 1.1. Because of this test, +indication as shown in Table 1.1. +Because of this test, BadAccess and BadMatch @@ -360,7 +361,7 @@ indication as shown in Table 1.1. Because of this test, generated. - +
Function Error Returns Due to Extension Problems @@ -397,7 +398,8 @@ applications may never actually need to communicate with the server; they simply use the Xkb library capabilities. The functions that do not communicate with the server return either a pointer to a structure, a Bool, or a Status. These functions check that the application has queried the Xkb library version -and return the values shown in Table 1.1 if it has not. +and return the values shown in Table 1.1 +if it has not. diff --git a/specs/XKB/ch02.xml b/specs/XKB/ch02.xml index dc93fac0..65a214e5 100644 --- a/specs/XKB/ch02.xml +++ b/specs/XKB/ch02.xml @@ -574,10 +574,11 @@ requests in Xlib and the server. -Table 2.1 lists the protocol errors that can be generated, and their causes. +Table 2.1 +lists the protocol errors that can be generated, and their causes. -
+
Xkb Protocol Errors @@ -675,12 +676,13 @@ additional information is reported in the resource_id field. The most significant byte of the resource_id - is a further refinement of the error cause, as defined in Table 2.2. The least + is a further refinement of the error cause, as defined in +Table 2.2. The least significant byte will contain the device, class, or feedback ID as indicated in the table. -
+
BadKeyboard Protocol Error resource_id Values diff --git a/specs/XKB/ch04.xml b/specs/XKB/ch04.xml index 7879db17..a0456129 100644 --- a/specs/XKB/ch04.xml +++ b/specs/XKB/ch04.xml @@ -65,14 +65,15 @@ constants declared in the header file -Table 4.1 lists the categories of events defined by Xkb and their associated +Table 4.1 +lists the categories of events defined by Xkb and their associated event types, as defined in Xkb.h. Each event is described in more detail in the section referenced for that event. -
+
Xkb Event Types @@ -307,7 +308,8 @@ and milliseconds. The xkb_type field contains the minor extension event code, which is the extension event -type, and is one of the values listed in Table 4.1. The +type, and is one of the values listed in +Table 4.1. The device field contains the keyboard device identifier associated with the event. This is never @@ -461,7 +463,8 @@ in the parameter and do not set the corresponding bit in the values_for_bits parameter. The valid values for both of these parameters are an inclusive -bitwise OR of the masks shown in Table 4.2. There is no interface to return +bitwise OR of the masks shown in Table 4.2. +There is no interface to return your client’s current event selection mask. Clients cannot set other clients’ event selection masks. @@ -656,12 +659,13 @@ in section 4.3. -Table 4.2 lists the event mask constants that can be specified with the +Table 4.2 + lists the event mask constants that can be specified with the XkbSelectEvents request and the circumstances in which the mask should be specified. -
+
XkbSelectEvents Mask Constants diff --git a/specs/XKB/ch05.xml b/specs/XKB/ch05.xml index 179803f3..681b8458 100644 --- a/specs/XKB/ch05.xml +++ b/specs/XKB/ch05.xml @@ -303,7 +303,7 @@ The functions in this section that change the use of modifiers use a mask in the It is a bitwise inclusive OR of the legal modifier masks: -
+
Real Modifier Masks @@ -511,7 +511,7 @@ To latch and unlatch any of the eight real keyboard modifiers, use Reference the keysym group indices with these symbolic constants: -
+
Symbolic Group Names @@ -780,10 +780,12 @@ events to clients wanting notification whenever the Xkb state changes. The chang -There are many different types of Xkb state changes. Xkb defines an event detail mask corresponding to each type of change. The event detail masks are listed in Table 5.3. +There are many different types of Xkb state changes. Xkb defines an event +detail mask corresponding to each type of change. The event detail masks are +listed in Table 5.3. -
+
XkbStateNotify Event Detail Masks @@ -898,7 +900,7 @@ To receive bits_to_change and values_for_bits - using mask bits from Table 5.3. + using mask bits from Table 5.3. @@ -949,8 +951,8 @@ When you receive an field indicates which elements of keyboard state have changed. This will be the bitwise inclusive OR of one or more of the XkbStateNotify - event detail masks shown in Table 5.3. All fields reported in -the event are valid, but only those indicated in + event detail masks shown in Table 5.3. + All fields reported in the event are valid, but only those indicated in changed have changed values. diff --git a/specs/XKB/ch06.xml b/specs/XKB/ch06.xml index 63bb7dfe..94d2df13 100644 --- a/specs/XKB/ch06.xml +++ b/specs/XKB/ch06.xml @@ -69,13 +69,14 @@ keyboard. The other fields specify structure components of the keyboard description and -are described in detail in other sections of this document. Table 6.1 +are described in detail in other sections of this document. +Table 6.1 identifies the subsequent sections of this document that discuss the individual components of the XkbDescRec. -
+
XkbDescRec Component References @@ -126,10 +127,10 @@ 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 XkbDescRec - are shown in Table 6.2. + are shown in Table 6.2. -
+
Mask Bits for XkbDescRec @@ -260,7 +261,7 @@ server for those components specified in the NULL. The valid masks for which - are those listed in Table 6.2. + are those listed in Table 6.2. diff --git a/specs/XKB/ch08.xml b/specs/XKB/ch08.xml index ea4f58d9..e37f218f 100644 --- a/specs/XKB/ch08.xml +++ b/specs/XKB/ch08.xml @@ -200,10 +200,10 @@ The field specifies the conditions under which the indicator can be changed and the effects of changing the indicator. The valid values for flags - and their effects are shown in Table 8.1. + and their effects are shown in Table 8.1. -
+
XkbIndicatorMapRec flags Field @@ -354,10 +354,10 @@ If which_groups and groups - is shown in Table 8.2. + is shown in Table 8.2. -
+
XkbIndicatorMapRec which_groups and groups, Keyboard Drives Indicator @@ -432,11 +432,12 @@ The effect of groups when you change an indicator for which XkbIM_LEDDrivesKB - is set (the indicator drives the keyboard) is shown in Table 8.3. The "New + is set (the indicator drives the keyboard) is shown in +Table 8.3. The "New State" column refers to the new state to which you set the indicator. -
+
XkbIndicatorMapRec which_groups and groups, Indicator Drives Keyboard @@ -598,10 +599,10 @@ If which_mods and mods - is shown in Table 8.4 + is shown in Table 8.4 -
+
XkbIndicatorMapRec which_mods and mods, Keyboard Drives Indicator @@ -703,11 +704,12 @@ The effect on the keyboard modifiers of mods when you change an indicator for which XkbIM_LEDDrivesKB - is set (the indicator drives the keyboard) is shown in Table 8.5. The "New + is set (the indicator drives the keyboard) is shown in +Table 8.5. The "New State" column refers to the new state to which you set the indicator. -
+
XkbIndicatorMapRec which_mods and mods, Indicator Drives Keyboard @@ -1232,7 +1234,9 @@ or, to reduce network traffic, use an This section discusses the effects of explicitly changing indicators depending -upon different settings in the indicator map. See Tables 8.3 and Table 8.5 for +upon different settings in the indicator map. See +Table 8.3 and +Table 8.5 for information on the effects of the indicator map fields when explicit changes are made. diff --git a/specs/XKB/ch09.xml b/specs/XKB/ch09.xml index e8536e01..bf381d79 100644 --- a/specs/XKB/ch09.xml +++ b/specs/XKB/ch09.xml @@ -109,13 +109,15 @@ 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. The server does generate some predefined bells for the AccessX controls (see -section 10.6.3). These named bells are shown in Table 9.1; the name is included +section 10.6.3). +These named bells are shown in Table 9.1; +the name is included in any bell event sent to clients that have requested to receive XkbBellNotify events. -
+
Predefined Bells @@ -261,12 +263,12 @@ A device can have more than one feedback of each type; set -Table 9.2 shows the conditions that cause a bell to sound or an -XkbBellNotifyEvent +Table 9.2 shows the conditions that cause +a bell to sound or an XkbBellNotifyEvent to be generated when a bell function is called. -
+
Bell Sounding and Bell Event Generating diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml index bc112885..1ef2341f 100644 --- a/specs/XKB/ch10.xml +++ b/specs/XKB/ch10.xml @@ -53,10 +53,11 @@ function to manipulate one control individually, you do not use an -The Xkb controls are grouped as shown in Table 10.1. +The Xkb controls are grouped as shown in +Table 10.1. -
+
Xkb Keyboard Controls @@ -222,7 +223,7 @@ control is enabled, and when turned off, disabled. It corresponds to the field of an XkbControlsRec structure (see section 10.8). The bits describing which controls are turned on -or off are defined in Table 10.7. +or off are defined in Table 10.7. @@ -301,7 +302,8 @@ The values 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 Table 10.7, using only those masks with "ok" in the +of mask bits in Table 10.7, +using only those masks with "ok" in the enabled_ctrls column. @@ -1245,7 +1247,7 @@ mouse-pointer key yields one mouse event. When structure (see section 10.8). -
+
MouseKeysAccel Fields @@ -1885,7 +1887,7 @@ on or off by modifying the following bits in the (see section 10.10): -
+
AccessXFeedback Masks @@ -2031,10 +2033,10 @@ typedef struct { The detail field describes what AccessX event just occurred and can be any of the values -in Table 10.4. +in Table 10.4. -
+
AccessXNotify Events @@ -2130,10 +2132,10 @@ To receive bits_to_change and values_for_bits - using mask bits from Table 10.5. + using mask bits from Table 10.5. -
+
AccessXNotify Event Details @@ -3476,8 +3478,9 @@ typedef struct { The general-purpose functions that work with the XkbControlsRec - structure use a mask to specify which controls are to be manipulated. Table -10.6 lists these controls, the masks used to select them in the general + structure use a mask to specify which controls are to be manipulated. +Table 10.6 +lists these controls, the masks used to select them in the general function calls ( which parameter), and the data fields in the @@ -3487,7 +3490,7 @@ bit used to turn boolean controls on and off and the section where each control is described in more detail. -
+
Xkb Controls @@ -3670,7 +3673,8 @@ is described in more detail.
-Table 10.7 shows the actual values for the individual mask bits used to select +Table 10.7 +shows the actual values for the individual mask bits used to select 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 ( @@ -3682,7 +3686,7 @@ configurable attributes; and for controls that are not boolean controls and therefore cannot be enabled or disabled. - +
Controls Mask Bits @@ -3878,10 +3882,10 @@ computed automatically by the server whenever the keyboard mapping changes. control (see section 10.7.1). It specifies the handling of illegal groups on a global basis. Valid values for groups_wrap - are shown in Table 10.8. + are shown in Table 10.8. -
+
GroupsWrap options (groups_wrap field) @@ -3970,7 +3974,8 @@ modifier bits: control (see section 10.1.1). 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 Table 10.7, using only those masks with "ok" in the +are listed in Table 10.7, +using only those masks with "ok" in the enabled_ctrls column. @@ -4056,10 +4061,10 @@ AccessXFeedback control (see section 10.6.3). The ax_options field is a bitmask and may include any combination of the bits defined in -Table 10.9. +Table 10.9. -
+
Access X Enable/Disable Bits (ax_options field) @@ -4174,8 +4179,9 @@ The macro is useful for determining whether a particular AccessX option is enabled or not. It accepts a pointer to an XkbControlsRec - structure and a valid mask bit from Table 10.9. If the specified mask bit in -the + structure and a valid mask bit from +Table 10.9. + If the specified mask bit in the ax_options field of the controls structure is set, the macro returns the mask bit. Otherwise, it returns zero. Thus, @@ -4361,7 +4367,8 @@ and then copies the server’s values for the requested information into the which parameter are copied. Valid values for which - are any combination of the masks listed in Table 10.7 that have "ok" in the + are any combination of the masks listed in +Table 10.7 that have "ok" in the which column. @@ -4512,7 +4519,8 @@ For each bit that is set in the ctrls field to the server. Valid values for which - are any combination of the masks listed in Table 10.7 that have "ok" in the + are any combination of the masks listed in +Table 10.7 that have "ok" in the which column. @@ -4615,10 +4623,12 @@ structure have been modified. In this context, modified means 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 changed_ctrls - are any combination of the masks listed in Table 10.7 that have "ok" in the + are any combination of the masks listed in +Table 10.7 that have "ok" in the changed_ctrls - column. Setting a bit implies the corresponding data fields from the "Relevant -XkbControlsRec Data Fields" column in Table 10.6 have been modified. The + column. Setting a bit implies the corresponding data fields from the +"Relevant XkbControlsRec Data Fields" column in +Table 10.6 have been modified. The enabled_ctrls_changes field specifies which bits in the enabled_ctrls @@ -4731,7 +4741,7 @@ To receive bits_to_change and values_for_bits - using mask bits from Table 10.7. + using mask bits from Table 10.7. @@ -4765,7 +4775,8 @@ typedef struct { The changed_ctrls field specifies the controls components that have changed and consists of bits -taken from the masks defined in Table 10.7 with "ok" in the +taken from the masks defined in +Table 10.7 with "ok" in the changed_ctrls column. @@ -4779,7 +4790,8 @@ the enabled_ctrls field changed), they are flagged in the enabled_ctrl_changes - field. The valid bits for these fields are the masks listed in Table 10.7 with + field. The valid bits for these fields are the masks listed in +Table 10.7 with "ok" in the enabled_ctrls column. The @@ -4896,7 +4908,7 @@ When a client receives an The wanted parameter is a bitwise inclusive OR of bits taken from the set of masks -specified in Table 10.7 with "ok" in the +specified in Table 10.7 with "ok" in the changed_ctrls column. XkbNoteControlsChanges @@ -5091,7 +5103,8 @@ The mask specifies the individual fields of the ctrls structure to be allocated and can contain any of the valid masks defined in -Table 10.7. Because none of the currently existing controls have any structures +Table 10.7. +Because none of the currently existing controls have any structures associated with them, which is currently of little practical value in this call. @@ -5166,8 +5179,8 @@ The which mask specifies the fields of ctrls - to be freed and can contain any of the controls components specified in Table -10.7. + to be freed and can contain any of the controls components specified in +Table 10.7. diff --git a/specs/XKB/ch11.xml b/specs/XKB/ch11.xml index 66927ec9..2fac8555 100644 --- a/specs/XKB/ch11.xml +++ b/specs/XKB/ch11.xml @@ -362,10 +362,10 @@ The The Library Controls are manipulated using functions that deal with bitmasks to indicate which controls to manipulate. The controls are identified by the masks -defined in Table 11.1. +defined in Table 11.1. -
+
Library Control Masks @@ -449,7 +449,8 @@ implemented, use XkbXlibControlsImplemented. XkbXlibControlsImplemented returns a bitmask indicating the controls actually implemented in the Xkb -library and is composed of an inclusive OR of bits from Table 11.1. +library and is composed of an inclusive OR of bits from +Table 11.1. @@ -489,7 +490,8 @@ To determine the current state of the Library Controls, use XkbGetXlibControls returns the current state of the Library Controls as a bit mask that is an -inclusive OR of the control masks from Table 11.1 for the controls that are +inclusive OR of the control masks from +Table 11.1 for the controls that are enabled. For the optional compose processing controls, the fact that a control is enabled does not imply that it is actually implemented. @@ -564,7 +566,8 @@ corresponding to a control is on in values_for_bits, the control is disabled. bits_to_change - should be an inclusive OR of bits from Table 11.1. + should be an inclusive OR of bits from +Table 11.1. diff --git a/specs/XKB/ch13.xml b/specs/XKB/ch13.xml index 0a1b576a..07e3c188 100644 --- a/specs/XKB/ch13.xml +++ b/specs/XKB/ch13.xml @@ -550,10 +550,10 @@ specify the interpretation of logo names. The structures these doodads are stored in and the values of the type - fields are shown in Table 13.1. + fields are shown in Table 13.1. -
+
Doodad Types @@ -955,7 +955,8 @@ The doodad arrays in the XkbGeometryRec and the XkbSectionRec - may contain any of the doodad structures and types shown in Table 13.1. + may contain any of the doodad structures and types shown in +Table 13.1. diff --git a/specs/XKB/ch14.xml b/specs/XKB/ch14.xml index 5dab015f..60df25e9 100644 --- a/specs/XKB/ch14.xml +++ b/specs/XKB/ch14.xml @@ -294,7 +294,8 @@ populated. The which - mask is a bitwise inclusive OR of the masks defined in Table 14.1. Only those + mask is a bitwise inclusive OR of the masks defined in +Table 14.1. Only those portions of the keyboard server map and the keyboard client maps that are specified in which @@ -346,11 +347,12 @@ free the returned data, use Xkb also provides convenience functions to get partial component definitions from the server. These functions are specified in the "convenience functions" -column in Table 14.1. Refer to the sections listed in the table for more +column in Table 14.1. +Refer to the sections listed in the table for more information on these functions. -
+
Xkb Mapping Component Masks and Convenience Functions @@ -541,8 +543,9 @@ description, use XkbGetUpdatedMap. The which - parameter is a bitwise inclusive OR of the masks in Table 14.1. If the needed -components of the + parameter is a bitwise inclusive OR of the masks in +Table 14.1. +If the needed components of the xkb structure are not already allocated, XkbGetUpdatedMap @@ -648,7 +651,8 @@ Use symbols, all actions, and so on) to the server. The which parameter specifies the components to be sent to the server, and is a bitwise -inclusive OR of the masks listed in Table 14.1. The +inclusive OR of the masks listed in +Table 14.1. The xkb parameter is a pointer to an XkbDescRec @@ -687,7 +691,8 @@ and Key types, symbol maps, and actions are all interrelated; changes in one require changes in the others. Xkb provides functions to make it easier to edit -these components and handle the interdependencies. Table 14.1 lists these +these components and handle the interdependencies. +Table 14.1 lists these helper functions and provides a pointer to where they are defined. @@ -748,12 +753,14 @@ The changed field identifies the map components that have changed in an XkbDescRec - structure and may contain any of the bits in Table 14.1, which are also shown -in Table 14.2. Every 1 bit in + structure and may contain any of the bits in +Table 14.1, which are also shown +in Table 14.2. Every 1 bit in changed also identifies which other fields in the XkbMapChangesRec - structure contain valid values, as indicated in Table 14.2. The + structure contain valid values, as indicated in +Table 14.2. The min_key_code and max_key_code @@ -762,7 +769,7 @@ server and are always updated by the server whenever it returns the data for an XkbMapChangesRec. -
+
XkbMapChangesRec Masks @@ -968,7 +975,8 @@ The Xkb extension reports 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 Table 14.1. +change. The event detail masks are identical to the masks listed in +Table 14.1. @@ -999,7 +1007,7 @@ To receive bits_to_change and values_for_bits - using mask bits from Table 14.1. + using mask bits from Table 14.1. @@ -1044,7 +1052,8 @@ typedef struct { The changed field specifies the map components that have changed and is the bitwise -inclusive OR of the mask bits defined in Table 14.1. The other fields in this +inclusive OR of the mask bits defined in +Table 14.1. The other fields in this event are interpreted as the like-named fields in an XkbMapChangesRec (see section 14.3.1). The @@ -1158,10 +1167,10 @@ The which 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 Table 14.3. +masks shown in Table 14.3. -
+
XkbAllocClientMap Masks @@ -1357,7 +1366,8 @@ To free memory used by the client map member of an NULL. The which - parameter specifies a combination of the client map masks shown in Table 14.3. + parameter specifies a combination of the client map masks shown in +Table 14.3. @@ -1448,10 +1458,10 @@ To allocate and initialize an empty server map description record, use The which parameter specifies the particular components of the server map structure to -allocate, as specified in Table 14.4. +allocate, as specified in Table 14.4. -
+
XkbAllocServerMap Masks @@ -1644,7 +1654,8 @@ The The which parameter specifies a combination of the server map masks and is a bitwise -inclusive OR of the masks listed in Table 14.4. If +inclusive OR of the masks listed in +Table 14.4. If free_all is True, diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml index 2e23c15c..20bafd68 100644 --- a/specs/XKB/ch15.xml +++ b/specs/XKB/ch15.xml @@ -233,7 +233,7 @@ keyboard mappings in the server database is not specified by the Xkb extension, although this format is one possible example): -
+
Example Key Type @@ -1469,11 +1469,12 @@ 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 group_info - flag, as shown in Table 15.2. See section 10.7.1 for more details on the -normalization methods in this table. + flag, as shown in Table 15.2. + See section 10.7.1 + for more details on the normalization methods in this table. -
+
group_info Range Normalization @@ -2316,7 +2317,7 @@ For convenience, Xkb provides the following constants to use as indices to the groups: -
+
Group Index Constants diff --git a/specs/XKB/ch16.xml b/specs/XKB/ch16.xml index 259d77b4..84889bae 100644 --- a/specs/XKB/ch16.xml +++ b/specs/XKB/ch16.xml @@ -492,10 +492,11 @@ the type field. The valid values for the type - field, and the data structures associated with them are shown in Table 16.1: + field, and the data structures associated with them are shown in +Table 16.1: -
+
Action Types @@ -642,7 +643,8 @@ In the following description, the term means the real modifier bits associated with this action. Depending on the value of flags - (see Table 16.3), these are designated either in the + (see Table 16.3), + these are designated either in the mask field of the XkbModAction @@ -660,10 +662,11 @@ is being used. In the latter case, this is the client The type - field can have any of the values shown in Table 16.2. + field can have any of the values shown in +Table 16.2. -
+
Modifier Action Types @@ -778,12 +781,13 @@ key press occurred, a key release unlocks them. The flags - field is composed of the bitwise inclusive OR of the masks shown in Table -16.3. A general meaning is given in the table, but the exact meaning depends on + field is composed of the bitwise inclusive OR of the masks shown in +Table 16.3. + A general meaning is given in the table, but the exact meaning depends on the action type. -
+
Modifier Action Flags @@ -1012,7 +1016,7 @@ The field can have any of the following values: -
+
Group Action Types @@ -1139,13 +1143,14 @@ A key release has no effect. The flags - field is composed of the bitwise inclusive OR of the masks shown in Table -16.5. A general meaning is given in the table, but the exact meaning depends on + field is composed of the bitwise inclusive OR of the masks shown in +Table 16.5. + A general meaning is given in the table, but the exact meaning depends on the action type. -
+
Group Action Flags @@ -1345,10 +1350,11 @@ The The flags - field is a bitwise inclusive OR of the masks shown in Table 16.6. + field is a bitwise inclusive OR of the masks shown in +Table 16.6. -
+
Pointer Action Types @@ -1609,10 +1615,11 @@ If the The type - field can have any one of the values shown in Table 16.7. + field can have any one of the values shown in +Table 16.7. -
+
Pointer Button Action Types @@ -1738,14 +1745,15 @@ a button, the key release is ignored and has no effect. The flags - field is composed of the bitwise inclusive OR of the masks shown in Table -16.8. A general meaning is given in the table, but the exact meaning depends on + field is composed of the bitwise inclusive OR of the masks shown in +Table 16.8. + A general meaning is given in the table, but the exact meaning depends on the action type. : -
+
Pointer Button Action Flags @@ -1844,11 +1852,12 @@ The The flags - field is composed of the bitwise inclusive OR of the values shown in Table -16.9 (currently there is only one value defined). + field is composed of the bitwise inclusive OR of the values shown in +Table 16.9 + (currently there is only one value defined). -
+
Pointer Default Flags @@ -2076,11 +2085,11 @@ If the field, the action is used to change the group state. The remaining valid bits of the flags - field are composed of a bitwise inclusive OR using the masks shown in Table -16.10. + field are composed of a bitwise inclusive OR using the masks shown in +Table 16.10. -
+
ISO Action Flags when XkbSA_ISODfltIsGroup is Set @@ -2187,11 +2196,11 @@ If the field, the action is used to change the modifier state and the remaining valid bits of the flags - field are composed of a bitwise inclusive OR using the masks shown in Table -16.11. + field are composed of a bitwise inclusive OR using the masks shown in +Table 16.11. -
+
ISO Action Flags when XkbSA_ISODfltIsGroup is Not Set @@ -2342,11 +2351,11 @@ the two formats as shown in The affect - field is composed of a bitwise inclusive OR using the masks shown in Table -16.11. + field is composed of a bitwise inclusive OR using the masks shown in +Table 16.11. -
+
ISO Action Affect Field Values @@ -2461,11 +2470,11 @@ The The flags - field is composed of the bitwise inclusive OR of the masks shown in Table -16.13. + field is composed of the bitwise inclusive OR of the masks shown in +Table 16.13. -
+
Switch Screen Action Flags @@ -2623,10 +2632,11 @@ typedef struct _XkbCtrlsAction { The type - field can have any one of the values shown in Table 16.14. + field can have any one of the values shown in +Table 16.14. -
+
Controls Action Types @@ -2708,11 +2718,11 @@ This action can cause The flags - field is composed of the bitwise inclusive OR of the masks shown in Table -16.15. + field is composed of the bitwise inclusive OR of the masks shown in +Table 16.15. -
+
Control Action Flags @@ -2892,11 +2902,11 @@ The The flags - field is composed of the bitwise inclusive OR of the masks shown in Table -16.16. + field is composed of the bitwise inclusive OR of the masks shown in +Table 16.16. -
+
Message Action Flags @@ -3379,10 +3389,11 @@ typedef struct _XkbDeviceBtnAction { The type - field can have any one of the values shown in Table 16.17. + field can have any one of the values shown in +Table 16.17. -
+
Device Button Action Types @@ -3492,11 +3503,11 @@ the key release is ignored and has no effect. The flags - field is composed of the bitwise inclusive OR of the masks shown in Table -16.18. + field is composed of the bitwise inclusive OR of the masks shown in +Table 16.18. -
+
Device Button Action Flags @@ -3575,7 +3586,8 @@ The low four bits of v2_what specify the corresponding scale value (denoted val<n>Scale - in Table 16.17), if needed. The high four bits of + in Table 16.17), if needed. + The high four bits of v1_what and v2_what @@ -3583,12 +3595,13 @@ The low four bits of v1_what and v2_what - can have the values shown in Table 16.17; the use of + can have the values shown in Table 16.17; + the use of val<n>Scale is shown in that table also. -
+
Device Valuator v<n>_what High Bits Values @@ -3652,7 +3665,7 @@ absolute valuators. For relative valuators, only XkbSA_SetValRelative 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 Table 16.17. +legal values shown in Table 16.17. @@ -4020,10 +4033,11 @@ The data field depends on the type. -Xkb supports the key behaviors shown in Table 16.20. +Xkb supports the key behaviors shown in +Table 16.20. -
+
Key Behaviors @@ -4274,10 +4288,10 @@ The explicit components masks are held in the explicit 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 -Table 16.21. +Table 16.21. -
+
Explicit Component Masks diff --git a/specs/XKB/ch17.xml b/specs/XKB/ch17.xml index c19a8e19..325d8900 100644 --- a/specs/XKB/ch17.xml +++ b/specs/XKB/ch17.xml @@ -464,12 +464,13 @@ modifiers match the criteria specified by match -must be one of the values shown in Table 17.1 and specifies how the real +must be one of the values shown in +Table 17.1 and specifies how the real modifiers specified in mods are to be interpreted. -
+
Symbol Interpretation Match Criteria @@ -814,10 +815,11 @@ explicit override components of the server state. xkb. Valid values for which - are an inclusive OR of the values shown in Table 17.2. + are an inclusive OR of the values shown in +Table 17.2. -
+
Compatibility Map Component Masks @@ -1366,7 +1368,7 @@ Unless you have specifically modified this field, it is the default keyboard device. which specifies the compatibility map components to be set, and is an inclusive OR -of the bits shown in Table 17.2. +of the bits shown in Table 17.2. @@ -1547,7 +1549,7 @@ To receive bits_to_change and values_for_bits - using mask bits from Table 17.2. + using mask bits from Table 17.2. @@ -1692,7 +1694,8 @@ allocated. The compatibility map is the XkbGetCompatMap, in section 17.2). which - is an inclusive OR of the bits shown in Table 17.2. + is an inclusive OR of the bits shown in +Table 17.2. @@ -1798,7 +1801,8 @@ To free an entire compatibility map or selected portions of one, use XkbGetCompatMap, in section 17.2). which - is an inclusive OR of the bits shown in Table 17.2 + is an inclusive OR of the bits shown in +Table 17.2 diff --git a/specs/XKB/ch18.xml b/specs/XKB/ch18.xml index 8b361dfc..a3c20e9f 100644 --- a/specs/XKB/ch18.xml +++ b/specs/XKB/ch18.xml @@ -231,10 +231,10 @@ and Xkb provides several functions that work with symbolic names. Each of these functions uses a mask to specify individual fields of the structures described above. These masks and their relationships to the fields in a keyboard -description are shown in Table 18.1. +description are shown in Table 18.1. -
+
Symbolic Names Masks @@ -421,7 +421,7 @@ X server. The parameter specifies the name components to be updated in the xkb parameter, and is the bitwise inclusive OR of the valid names mask bits -defined in Table 18.1. +defined in Table 18.1. @@ -670,12 +670,14 @@ typedef struct _XkbNameChanges { The changed field specifies the name components that have changed and is the bitwise -inclusive OR of the valid names mask bits defined in Table 18.1. The rest of +inclusive OR of the valid names mask bits defined in +Table 18.1. The rest of the fields in the structure specify the ranges that have changed for the -various kinds of symbolic names, as shown in Table 18.2. +various kinds of symbolic names, as shown in +Table 18.2. -
+
XkbNameChanges Fields @@ -856,7 +858,8 @@ and set both the bits_to_change and values_for_bits - detail parameter to a mask composed of a bitwise OR of masks in Table 18.1. + detail parameter to a mask composed of a bitwise OR of masks in +Table 18.1. @@ -904,7 +907,8 @@ that have changed */ The changed field specifies the name components that have changed and is the bitwise -inclusive OR of the valid names mask bits defined in Table 18.1. The other +inclusive OR of the valid names mask bits defined in +Table 18.1. The other fields in this event are interpreted as the like-named fields in an XkbNameChangesRec , as previously defined. @@ -969,7 +973,7 @@ When your application receives a X The wanted parameter is the bitwise inclusive OR of the valid names mask bits shown in -Table 18.1. +Table 18.1. XkbNoteNameChanges copies any changes that are reported in new @@ -1142,7 +1146,7 @@ from the X server. Instead use The which parameter is the bitwise inclusive OR of the valid names mask bits defined in -Table 18.1. +Table 18.1. @@ -1207,7 +1211,7 @@ Use The which parameter is the bitwise inclusive OR of the valid names mask bits defined in -Table 18.1. +Table 18.1. diff --git a/specs/XKB/ch19.xml b/specs/XKB/ch19.xml index 1c210695..7a2094ca 100644 --- a/specs/XKB/ch19.xml +++ b/specs/XKB/ch19.xml @@ -203,10 +203,11 @@ and set both the bits_to_change and values_for_bits - detail parameter to a mask composed of a bitwise OR of masks in Table 19.1. + detail parameter to a mask composed of a bitwise OR of masks in +Table 19.1. -
+
XkbNewKeyboardNotifyEvent Details diff --git a/specs/XKB/ch20.xml b/specs/XKB/ch20.xml index bf7548b7..58f2c33e 100644 --- a/specs/XKB/ch20.xml +++ b/specs/XKB/ch20.xml @@ -5,11 +5,11 @@ The X server maintains a database of keyboard components, identified by component type. The database contains all the information necessary to build a complete keyboard description for a particular device, as well as to assemble -partial descriptions. Table 20.1 identifies the component types and the type of -information they contain. +partial descriptions. Table 20.1 +identifies the component types and the type of information they contain. -
+
Server Database Keyboard Components @@ -115,7 +115,8 @@ hand, this partial map can be used to configure When a keyboard description is built, the components are processed in the order -in which they appear in Table 20.1; later definitions override earlier ones. +in which they appear in Table 20.1; +later definitions override earlier ones. @@ -400,8 +401,10 @@ masks in the flags field of the XkbListComponents. 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 -is dependent on the type of component. The flags bits are defined in Table -20.2. The symbols hints in Table 20.2 apply only to partial symbols components +is dependent on the type of component. The flags bits are defined in +Table 20.2. +The symbols hints in Table 20.2 +apply only to partial symbols components (those with XkbLC_Partial also set); full symbols components are assumed to specify all of the pieces. @@ -421,7 +424,7 @@ few modifier keys as well; such mappings should set only the may be combined with any of the other flags). -
+
XkbComponentNameRec Flags Bits @@ -795,7 +798,8 @@ the server ORs the bits in need together and examines the result in relationship to the expressions in names. -Table 20.3 identifies the components that are required for each of the +Table 20.3 +identifies the components that are required for each of the possible bits in want or @@ -826,7 +830,7 @@ and compat. -
+
Want and Need Mask Bits and Required Names Components @@ -973,13 +977,13 @@ The information returned to the client in the XkbDescRec 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 Table 20.4, together -with the +corresponding to each of the mask bits are summarized in +Table 20.4, together with the XkbDescRec components that are filled in. -
+
XkbDescRec Components Returned for Values of Want & Needs diff --git a/specs/XKB/ch21.xml b/specs/XKB/ch21.xml index f71d54ed..587bca82 100644 --- a/specs/XKB/ch21.xml +++ b/specs/XKB/ch21.xml @@ -216,14 +216,15 @@ the state of the core keyboard is used. The and unsupported fields are masks where each bit indicates a capability. The meaning of the -mask bits is listed in Table 21.1, together with the fields in the +mask bits is listed in Table 21.1, +together with the fields in the XkbDeviceInfoRec 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. -
+
XkbDeviceInfoRec Mask Bits @@ -457,7 +458,8 @@ The which parameter is a mask specifying optional information to be returned. It is an inclusive OR -of one or more of the values from Table 21.1 and causes the returned +of one or more of the values from Table 21.1 +and causes the returned XkbDeviceInfoRec to contain values for the corresponding fields specified in the table. @@ -486,7 +488,8 @@ Other fields are filled in as specified by Upon return, the supported - field will be set to the inclusive OR of zero or more bits from Table 21.1; + field will be set to the inclusive OR of zero or more bits from +Table 21.1; each bit set indicates an optional Xkb extension device feature supported by the server implementation, and a client may modify the associated behavior. @@ -1312,7 +1315,8 @@ the False, the value of which determines which subcomponents are freed. which -is an inclusive OR of one or more of the values from Table 21.1. If which +is an inclusive OR of one or more of the values from +Table 21.1. If which contains XkbXI_ButtonActionsMask, all button actions associated with device_info are freed, @@ -1474,7 +1478,7 @@ set in which and take their values from the relevant fields in device_info - (see Table 21.1). + (see Table 21.1). XkbSetDeviceInfo returns True @@ -1939,7 +1943,7 @@ To note device changes reported in an The wanted field specifies the changes that should be noted in old, and is composed of the bitwise inclusive OR of one or more of the masks from -Table 21.1. +Table 21.1. The reason field of the event in diff --git a/specs/XKB/ch22.xml b/specs/XKB/ch22.xml index 15c4822f..94f7d02b 100644 --- a/specs/XKB/ch22.xml +++ b/specs/XKB/ch22.xml @@ -179,10 +179,11 @@ Xkb modifies its behavior according to each controls bit. mask and flags - are. The valid controls bits are defined in Table 22.1. + are. The valid controls bits are defined in +Table 22.1. -
+
Debug Control Masks