diff --git a/specs/XKB/ch01.xml b/specs/XKB/ch01.xml index 913c344f..9fe5cf60 100644 --- a/specs/XKB/ch01.xml +++ b/specs/XKB/ch01.xml @@ -237,7 +237,7 @@ another key in the group is pressed, at which point the previously depressed 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 -XkbKB_RadioGroup +XkbKB_RadioGroup behavior and the radio group index. diff --git a/specs/XKB/ch02.xml b/specs/XKB/ch02.xml index 6a17924b..3313b2b2 100644 --- a/specs/XKB/ch02.xml +++ b/specs/XKB/ch02.xml @@ -129,11 +129,11 @@ To determine the compatibility of a library at runtime, call Pass the symbolic value -XkbMajorVersion +XkbMajorVersion in lib_major_in_out and -XkbMinorVersion +XkbMinorVersion in lib_minor_in_out. These arguments represent the version of the library used at compile time. @@ -784,9 +784,9 @@ involve both a server connection (Display * The device identifier can specify any X input extension device with a KeyClass component, or it can specify the constant, -XkbUseCoreKbd. +XkbUseCoreKbd. The use of -XkbUseCoreKbd +XkbUseCoreKbd allows applications to indicate the core keyboard without having to determine its device identifier. @@ -798,12 +798,12 @@ Where an Xkb device identifier is passed as an argument and an XkbDescRec device_spec field is -XkbUseCoreKbd, +XkbUseCoreKbd, and if the function returns successfully, the XkbDescPtr device_spec field will have been converted from -XkbUseCoreKbd +XkbUseCoreKbd to a real Xkb device ID. If the function does not complete successfully, the device_spec field remains unchanged. Subsequently, the device id argument must match the @@ -823,8 +823,8 @@ to use for the keyboard, that ID is the input extension identifier for the device if the server supports the X Input Extension. If the server does not support the input extension, the meaning of the identifier is undefined — the only guarantee is that when you use -XkbUseCoreKbd, -XkbUseCoreKbd +XkbUseCoreKbd, +XkbUseCoreKbd will work and the identifier returned by the server will refer to the core keyboard device. diff --git a/specs/XKB/ch04.xml b/specs/XKB/ch04.xml index 3c5417ab..b9ee1fa0 100644 --- a/specs/XKB/ch04.xml +++ b/specs/XKB/ch04.xml @@ -92,7 +92,7 @@ event. - XkbNewKeyboardNotify + XkbNewKeyboardNotify Keyboard geometry; keycode range change @@ -107,7 +107,7 @@ event. - XkbMapNotify + XkbMapNotify @@ -122,7 +122,7 @@ event. - XkbStateNotify + XkbStateNotify Keyboard state change @@ -136,7 +136,7 @@ event. - XkbControlsNotify + XkbControlsNotify Keyboard controls state change @@ -150,7 +150,7 @@ event. - XkbIndicatorStateNotify + XkbIndicatorStateNotify Keyboard indicators state change @@ -164,7 +164,7 @@ event. - XkbIndicatorMapNotify + XkbIndicatorMapNotify Keyboard indicators map change @@ -178,7 +178,7 @@ event. - XkbNamesNotify + XkbNamesNotify Keyboard name change @@ -192,7 +192,7 @@ event. - XkbCompatMapNotify + XkbCompatMapNotify Keyboard compatibility map change @@ -206,7 +206,7 @@ event. - XkbBellNotify + XkbBellNotify Keyboard bell generated @@ -220,7 +220,7 @@ event. - XkbActionMessage + XkbActionMessage Keyboard action message @@ -234,7 +234,7 @@ event. - XkbAccessXNotify + XkbAccessXNotify AccessX state change @@ -248,7 +248,7 @@ event. - XkbExtensionDeviceNotify + XkbExtensionDeviceNotify Extension device change @@ -288,7 +288,7 @@ generated */ Time time; /* server time when event generated */ int xkb_type; /* Xkb minor event code */ unsigned int device; /* Xkb device ID, will not be - XkbUseCoreKbd */ + XkbUseCoreKbd */ } XkbAnyEvent ; @@ -313,11 +313,11 @@ type, and is one of the values listed in device field contains the keyboard device identifier associated with the event. This is never -XkbUseCoreKbd, +XkbUseCoreKbd, even if the request that generated the event specified a device of -XkbUseCoreKbd. +XkbUseCoreKbd. If the request that generated the event specified -XkbUseCoreKbd, +XkbUseCoreKbd, device 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, @@ -413,7 +413,7 @@ them delivered under all conditions, use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -548,7 +548,7 @@ Xkb events with - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -682,91 +682,91 @@ in section 4.3. -XkbNewKeyboardNotifyMask +XkbNewKeyboardNotifyMask (1L<<0) Keyboard geometry change - XkbMapNotifyMask + XkbMapNotifyMask (1L<<1) Keyboard mapping change -XkbStateNotifyMask +XkbStateNotifyMask (1L<<2) Keyboard state change -XkbControlsNotifyMask +XkbControlsNotifyMask (1L<<3) Keyboard control change -XkbIndicatorStateNotifyMask +XkbIndicatorStateNotifyMask (1L<<4) Keyboard indicator state change -XkbIndicatorMapNotifyMask +XkbIndicatorMapNotifyMask (1L<<5) Keyboard indicator map change -XkbNamesNotifyMask +XkbNamesNotifyMask (1L<<6) Keyboard name change -XkbCompatMapNotifyMask +XkbCompatMapNotifyMask (1L<<7) Keyboard compat map change -XkbBellNotifyMask +XkbBellNotifyMask (1L<<8) Bell -XkbActionMessageMask +XkbActionMessageMask (1L<<9) Action message -XkbAccessXNotifyMask +XkbAccessXNotifyMask (1L<<10) AccessX features -XkbExtensionDeviceNotifyMask +XkbExtensionDeviceNotifyMask (1L<<11) Extension device -XkbAllEventsMask +XkbAllEventsMask (0xFFF) All Xkb events diff --git a/specs/XKB/ch05.xml b/specs/XKB/ch05.xml index 1330266a..4d55e18d 100644 --- a/specs/XKB/ch05.xml +++ b/specs/XKB/ch05.xml @@ -378,7 +378,7 @@ To lock and unlock any of the eight real keyboard modifiers, use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -460,7 +460,7 @@ To latch and unlatch any of the eight real keyboard modifiers, use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -579,7 +579,7 @@ To lock the keysym group, use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -643,7 +643,7 @@ To latch the keysym group, use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -738,7 +738,7 @@ To obtain the keyboard state, use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -774,9 +774,9 @@ All group values are expressed as group indices in the range [0..3]. Modifiers a The Xkb extension reports -XkbStateNotify +XkbStateNotify 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, -XkbStateNotify +XkbStateNotify events are reported to all interested clients without regard to the current keyboard input focus or grab state. @@ -866,7 +866,7 @@ listed in Table 5.3. To track changes in the keyboard state for a particular device, select to receive -XkbStateNotify +XkbStateNotify events by calling either XkbSelectEvents or @@ -877,11 +877,11 @@ To track changes in the keyboard state for a particular device, select to receiv To receive -XkbStateNotify +XkbStateNotify events under all possible conditions, use XkbSelectEvents and pass -XkbStateNotifyMask +XkbStateNotifyMask in both bits_to_change and @@ -891,11 +891,11 @@ To receive To receive -XkbStateNotify +XkbStateNotify events only under certain conditions, use XkbSelectEventDetails using -XkbStateNotify +XkbStateNotify as the event_type and specifying the desired state changes in @@ -908,7 +908,7 @@ To receive The structure for -XkbStateNotify +XkbStateNotify events is: @@ -919,8 +919,8 @@ typedef struct { Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ - int xkb_type; /* XkbStateNotify */ - int device; /* Xkb device ID, will not be XkbUseCoreKbd */ + int xkb_type; /* XkbStateNotify */ + int device; /* Xkb device ID, will not be XkbUseCoreKbd */ unsigned int changed; /* bits indicating what has changed */ int group; /* group index of effective group */ int base_group; /* group index of base group */ @@ -947,12 +947,12 @@ typedef struct { When you receive an -XkbStateNotify +XkbStateNotify event, the changed field indicates which elements of keyboard state have changed. This will be the bitwise inclusive OR of one or more of the -XkbStateNotify +XkbStateNotify event detail masks shown in Table 5.3. All fields reported in the event are valid, but only those indicated in changed diff --git a/specs/XKB/ch06.xml b/specs/XKB/ch06.xml index f2dd66cc..83d00a02 100644 --- a/specs/XKB/ch06.xml +++ b/specs/XKB/ch06.xml @@ -242,7 +242,7 @@ To retrieve one or more components of a keyboard device description, use device for which to fetch description, or -XkbUseCoreKbd +XkbUseCoreKbd @@ -325,7 +325,7 @@ Otherwise, it returns a pointer to an empty keyboard description structure. The device_spec field will have been initialized to -XkbUseCoreKbd. +XkbUseCoreKbd. You may then either fill in the structure components or use Xkb functions to obtain values for the structure components from a keyboard device. diff --git a/specs/XKB/ch07.xml b/specs/XKB/ch07.xml index 81536a21..3dc11ca0 100644 --- a/specs/XKB/ch07.xml +++ b/specs/XKB/ch07.xml @@ -87,7 +87,7 @@ represents the i-th virtual modifier. To set the name of a virtual modifier, use XkbSetNames, using -XkbVirtualModNamesMask +XkbVirtualModNamesMask in which and the name in the diff --git a/specs/XKB/ch08.xml b/specs/XKB/ch08.xml index a28ef4fd..a084fd6d 100644 --- a/specs/XKB/ch08.xml +++ b/specs/XKB/ch08.xml @@ -242,16 +242,16 @@ state of the keyboard to change. Note that if -XkbIM_NoAutomatic +XkbIM_NoAutomatic is not set, by default the indicator follows the keyboard state. If -XkbIM_LEDDrivesKB +XkbIM_LEDDrivesKB is set and -XkbIM_NoExplicit +XkbIM_NoExplicit is not, and if you call a function which updates the server’s image of the indicator map (such as XkbSetIndicatorMap @@ -260,9 +260,9 @@ indicator map (such as ), 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 -XkbIM_LEDDrivesKB +XkbIM_LEDDrivesKB is absent or for which -XkbIM_NoExplicit +XkbIM_NoExplicit is present, keyboard state or controls are unaffected. @@ -274,7 +274,7 @@ For example, a keyboard designer may want to make the Scroll Lock LED to be controlled by client applications. To do so, the keyboard designer could set the -XkbIM_NoExplicit +XkbIM_NoExplicit flag for the CapsLock @@ -289,16 +289,16 @@ the server to automatically change the modifier state whenever a client application changes the CapsLock LED. To do so, the keyboard designer would not set the -XkbIM_NoExplicit +XkbIM_NoExplicit flag, but would instead set the -XkbIM_LEDDrivesKB +XkbIM_LEDDrivesKB flag. The remaining fields in the indicator map specify the conditions under which Xkb automatically turns an indicator on or off (only if -XkbIM_NoAutomatic +XkbIM_NoAutomatic 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. @@ -349,7 +349,7 @@ inclusive OR of the following valid values: If -XkbIM_NoAutomatic +XkbIM_NoAutomatic is not set (the keyboard drives the indicator), the effect of which_groups and @@ -431,7 +431,7 @@ The effect of and groups when you change an indicator for which -XkbIM_LEDDrivesKB +XkbIM_LEDDrivesKB 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. @@ -561,7 +561,7 @@ modifiers are changed in the modifier definition) or you can use specifies what criteria Xkb uses to determine a match with the corresponding mods field by specifying one or more components of the Xkb keyboard state. If -XkbIM_NoAutomatic +XkbIM_NoAutomatic is not set (the keyboard drives the indicator), the indicator is lit whenever any of the modifiers specified in the mask @@ -594,7 +594,7 @@ OR of the following values to compose a value for If -XkbIM_NoAutomatic +XkbIM_NoAutomatic is not set (the keyboard drives the indicator), the effect of which_mods and @@ -703,7 +703,7 @@ The effect on the keyboard modifiers of and mods when you change an indicator for which -XkbIM_LEDDrivesKB +XkbIM_LEDDrivesKB 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. @@ -885,7 +885,7 @@ current state of the keyboard indicators, use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -1083,7 +1083,7 @@ Use - keyboard device ID, or XkbUseCoreKbd + keyboard device ID, or XkbUseCoreKbd @@ -1244,9 +1244,9 @@ are made. If -XkbIM_LEDDrivesKB +XkbIM_LEDDrivesKB is set and -XkbIM_NoExplicit +XkbIM_NoExplicit is not, and if you call a function that updates the server’s image of the indicator map (such as XkbSetIndicatorMap @@ -1255,18 +1255,18 @@ indicator map (such as ), 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 -XkbIM_LEDDrivesKB +XkbIM_LEDDrivesKB is absent or for which -XkbIM_NoExplicit +XkbIM_NoExplicit is present, keyboard state or controls are unaffected. If neither -XkbIM_NoAutomatic +XkbIM_NoAutomatic nor -XkbIM_NoExplicit +XkbIM_NoExplicit 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. @@ -1282,9 +1282,9 @@ controls simultaneously. If you change an indicator for which both the -XkbIM_LEDDrivesKB +XkbIM_LEDDrivesKB and -XkbIM_NoAutomatic +XkbIM_NoAutomatic 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 @@ -1294,9 +1294,9 @@ explicitly changed again. If the -XkbIM_NoAutomatic +XkbIM_NoAutomatic flag is not set and -XkbIM_LEDDrivesKB +XkbIM_LEDDrivesKB 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 @@ -1304,7 +1304,7 @@ different state than the one that was explicitly requested. For example, Xkb does not extinguish an indicator with which_mods of -XkbIM_UseBase +XkbIM_UseBase and mods of @@ -1318,7 +1318,7 @@ the If you explicitly light an indicator for which -XkbIM_LEDDrivesKB +XkbIM_LEDDrivesKB is set, Xkb enables all of the boolean controls specified in the ctrls field of its indicator map. Explicitly extinguishing such an indicator causes @@ -1469,7 +1469,7 @@ Set the indicator map for the indicator - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -1587,11 +1587,11 @@ in map. and BadImplementation errors. In addition, it can also generate -XkbIndicatorStateNotify +XkbIndicatorStateNotify (see section 8.5), -XkbIndicatorMapNotify, +XkbIndicatorMapNotify, and -XkbNamesNotify +XkbNamesNotify events (see section 18.5). @@ -1718,9 +1718,9 @@ s can generate and BadImplementation errors. In addition, it can also generate -XkbIndicatorStateNotify +XkbIndicatorStateNotify and -XkbIndicatorMapNotify +XkbIndicatorMapNotify events (see section 8.5). @@ -1732,17 +1732,17 @@ s can generate Whenever an indicator changes state, the server sends -XkbIndicatorStateNotify +XkbIndicatorStateNotify events to all interested clients. Similarly, whenever an indicator’s map changes, the server sends -XkbIndicatorMapNotify +XkbIndicatorMapNotify events to all interested clients. To receive -XkbIndicatorStateNotify +XkbIndicatorStateNotify events, use XkbSelectEvents (see section 4.3) with both the @@ -1750,13 +1750,13 @@ To receive and values_for_bits parameters containing -XkbIndicatorStateNotifyMask. +XkbIndicatorStateNotifyMask. To receive -XkbIndicatorMapNotify +XkbIndicatorMapNotify events, use XkbSelectEvents with -XkbIndicatorMapNotifyMask. +XkbIndicatorMapNotifyMask. @@ -1768,7 +1768,7 @@ Set the parameter to XkbIndicatorStateNotify or -XkbIndicatorMapNotify, +XkbIndicatorMapNotify, and set both the bits_to_change and @@ -1790,7 +1790,7 @@ typedef struct _XkbIndicatorNotify { Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ int xkb_type; /* specifies state or map notify */ - int device; /* Xkb device ID, will not be XkbUseCoreKbd */ + int device; /* Xkb device ID, will not be XkbUseCoreKbd */ unsigned int changed; /* mask of indicators with new state or map */ unsigned int state; /* current state of all indicators */ } XkbIndicatorNotifyEvent; @@ -1799,9 +1799,9 @@ typedef struct _XkbIndicatorNotify { xkb_type is either -XkbIndicatorStateNotify +XkbIndicatorStateNotify or -XkbIndicatorMapNotify, +XkbIndicatorMapNotify, depending on whether the event is a kbIndicatorStateNotify event or @@ -1814,24 +1814,24 @@ The changed parameter is a mask that is the bitwise inclusive OR of the indicators that have changed. If the event is of type -XkbIndicatorMapNotify, +XkbIndicatorMapNotify, changed reports the maps that changed. If the event is of type -XkbIndicatorStateNotify, +XkbIndicatorStateNotify, changed reports the indicators that have changed state. state is a mask that specifies the current state of all indicators, whether they have changed or not, for both -XkbIndicatorStateNotify +XkbIndicatorStateNotify and IndicatorMapNotify events. When your client application receives either a -XkbIndicatorStateNotify +XkbIndicatorStateNotify event or -XkbIndicatorMapNotify +XkbIndicatorMapNotify event, you can note the changes in a changes structure by calling XkbNoteIndicatorChanges. @@ -1888,7 +1888,7 @@ When your client application receives either a The wanted parameter is the bitwise inclusive OR of -XkbIndicatorMapMask +XkbIndicatorMapMask and XkbIndicatorStateMask. XkbNoteIndicatorChanges diff --git a/specs/XKB/ch09.xml b/specs/XKB/ch09.xml index df10b3cc..f21cc91f 100644 --- a/specs/XKB/ch09.xml +++ b/specs/XKB/ch09.xml @@ -15,7 +15,7 @@ opposed to any other audible sound generated elsewhere in the system. You can ask to receive -XkbBellNotify +XkbBellNotify events (see section 9.4) when any client rings any one of the following: @@ -46,7 +46,7 @@ visual feedback, if any, that is associated with the name.) You can also ask to receive -XkbBellNotify +XkbBellNotify 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. @@ -60,7 +60,7 @@ bell with some other audible cue might want to turn off the AudibleBell control to prevent the server from also generating a sound and avoid cacophony. If you disable audible bells and request to receive -XkbBellNotify +XkbBellNotify events, you can generate feedback different from the default bell. @@ -103,7 +103,7 @@ You can associate a name to an act of ringing a bell by converting the name to 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 -XkbBellNotify +XkbBellNotify 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 @@ -113,7 +113,7 @@ The server does generate some predefined bells for the AccessX controls (see 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 +XkbBellNotify events. @@ -203,9 +203,9 @@ Using Xkb you can generate bell events that do not necessarily ring the system 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 -XkbBellNotify +XkbBellNotify events (see section 9.4). When it receives a -XkbBellNotify +XkbBellNotify event, the audio client could then send a request to an audio server to play a sound. @@ -213,14 +213,14 @@ sound. You can control the audible bells feature by passing the -XkbAudibleBellMask +XkbAudibleBellMask to XkbChangeEnabledControls (see section 10.1.1). If you set -XkbAudibleBellMask +XkbAudibleBellMask on, the server rings the system bell when a bell event occurs. This is the default. If you set -XkbAudibleBellMask +XkbAudibleBellMask off and a bell event occurs, the server does not ring the system bell unless you call XkbForceDeviceBell @@ -389,7 +389,7 @@ To ring the bell on an X input extension device or the default keyboard, use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -471,7 +471,7 @@ rings the bell as specified for the display and keyboard device and returns True. If you have disabled the audible bell, the server does not ring the system bell, although it does generate a -XkbBellNotify +XkbBellNotify event. @@ -566,15 +566,15 @@ and a device_spec of -XkbUseCoreKbd, +XkbUseCoreKbd, a bell_class of -XkbDfltXIClass, +XkbDfltXIClass, and a bell_id of -XkbDfltXIId, +XkbDfltXIId, and returns True. @@ -582,7 +582,7 @@ of If you have disabled the audible bell, the server does not ring the system bell, although it does generate a -XkbBellNotify +XkbBellNotify event. @@ -661,7 +661,7 @@ without ringing the corresponding bell, use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -715,7 +715,7 @@ If a compatible keyboard extension isn’t present in the X server, Otherwise, XkbDeviceBellEvent causes an -XkbBellNotify +XkbBellNotify event to be sent to all interested clients and returns True. Set @@ -731,7 +731,7 @@ In addition, may generate Atom protocol errors as well as -XkbBellNotify +XkbBellNotify events. You can call XkbBell without first initializing the keyboard extension. @@ -818,15 +818,15 @@ and a device_spec of -XkbUseCoreKbd, +XkbUseCoreKbd, a bell_class of -XkbDfltXIClass, +XkbDfltXIClass, and a bell_id of -XkbDfltXIId, +XkbDfltXIId, and returns what XkbDeviceBellEvent returns. @@ -834,7 +834,7 @@ of XkbBellEvent -generates a XkbBellNotify +generates a XkbBellNotify event. @@ -897,7 +897,7 @@ audible bells, use XkbForceDeviceBell. - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -951,7 +951,7 @@ There is no parameter because XkbForceDeviceBell does not cause an -XkbBellNotify +XkbBellNotify event. @@ -1022,13 +1022,13 @@ and percent, device_spec = -XkbUseCoreKbd, +XkbUseCoreKbd, bell_class = -XkbDfltXIClass, +XkbDfltXIClass, bell_id = -XkbDfltXIId, +XkbDfltXIId, window = None, and name @@ -1042,7 +1042,7 @@ and returns what XkbForceBell does not cause an -XkbBellNotify +XkbBellNotify event. @@ -1059,15 +1059,15 @@ You can call Xkb generates -XkbBellNotify +XkbBellNotify events for all bells except for those resulting from calls to XkbForceDeviceBell and XkbForceBell. To receive -XkbBellNotify +XkbBellNotify events under all possible conditions, pass -XkbBellNotifyMask +XkbBellNotifyMask in both the bits_to_change and @@ -1079,12 +1079,12 @@ and The -XkbBellNotify +XkbBellNotify event has no event details. It is either selected or it is not. However, you can call XkbSelectEventDetails using -XkbBellNotify +XkbBellNotify as the event_type and specifying @@ -1099,7 +1099,7 @@ can call The structure for the -XkbBellNotify +XkbBellNotify event type contains: @@ -1110,8 +1110,8 @@ typedef struct _XkbBellNotify { Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ - int xkb_type; /* XkbBellNotify */ - unsigned int device; /* Xkb device ID, will not be XkbUseCoreKbd */ + int xkb_type; /* XkbBellNotify */ + unsigned int device; /* Xkb device ID, will not be XkbUseCoreKbd */ int percent; /* requested volume as % of max */ int pitch; /* requested pitch in Hz */ int duration; /* requested duration in microseconds */ diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml index ddcf2a82..827d588d 100644 --- a/specs/XKB/ch10.xml +++ b/specs/XKB/ch10.xml @@ -337,7 +337,7 @@ configure their behavior. For example, the fields to describe the timing behavior of keys that repeat. The RepeatControl behavior is turned on or off depending on the value of the -XkbRepeatKeysMask +XkbRepeatKeysMask bit, but you must use other means, as described in this chapter, to configure its behavior in detail. @@ -733,7 +733,7 @@ To get the current attributes of the - desired device ID, or XkbUseCoreKbd + desired device ID, or XkbUseCoreKbd @@ -813,7 +813,7 @@ To set the attributes of the RepeatKeys control for a keyboard device, use - device to configure, or XkbUseCoreKbd + device to configure, or XkbUseCoreKbd @@ -1153,9 +1153,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 -XkbKB_Overlay1 +XkbKB_Overlay1 or -XkbKB_Overlay2 +XkbKB_Overlay2 key behaviors, as described in section 16.2. @@ -1239,7 +1239,7 @@ changes as a key is held down. If the control is disabled, pressing a mouse-pointer key yields one mouse event. When MouseKeysAccel is enabled, mouse movement is defined by an initial distance specified in the -XkbSA_MovePtr +XkbSA_MovePtr action and the following fields in the XkbControlsRec structure (see section 10.8). @@ -1299,7 +1299,7 @@ There are no convenience functions to query or change the attributes of the The effects of the attributes of the MouseKeysAccel control depend on whether the -XkbSA_MovePtr +XkbSA_MovePtr action (see section 16.1) specifies relative or absolute pointer motion. @@ -1308,11 +1308,11 @@ The effects of the attributes of the If an -XkbSA_MovePtr +XkbSA_MovePtr 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 -XkbSA_MovePtr +XkbSA_MovePtr 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. @@ -1325,7 +1325,7 @@ stays at the same X position. If the -XkbSA_MovePtr +XkbSA_MovePtr action specifies relative motion, the initial event always moves the cursor the distance specified in the action. After mk_delay @@ -1350,7 +1350,7 @@ the action by For example, if the -XkbSA_MovePtr +XkbSA_MovePtr action specifies a relative motion in the X direction of 5, mk_delay =160, @@ -1413,7 +1413,7 @@ accelerated according to the formula: Where action_delta is the relative motion specified by the -XkbSA_MovePtr +XkbSA_MovePtr action, mk_max_speed and @@ -1555,7 +1555,7 @@ When the Some of these key sequences optionally generate audible feedback of the change in state, as described in section 10.6.3, or -XkbControlsNotify +XkbControlsNotify events, described in section 10.11. @@ -1585,9 +1585,9 @@ controls and to change the value of the When a timeout as specified by AccessXTimeout occurs and a control is consequently modified, Xkb generates an -XkbControlsNotify +XkbControlsNotify event. For more information on -XkbControlsNotify +XkbControlsNotify events, refer to section 10.11. @@ -1639,7 +1639,7 @@ Use - device to query, or XkbUseCoreKbd + device to query, or XkbUseCoreKbd @@ -1765,7 +1765,7 @@ opts_values - device to configure, or XkbUseCoreKbd + device to configure, or XkbUseCoreKbd @@ -1988,7 +1988,7 @@ beeps instead of falling and rising tones; for example, they can generate a 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 -XkbAX_DumbBellFBMask +XkbAX_DumbBellFBMask bit of ax_options to indicate that the bell can only ring with a fixed pitch. @@ -1997,7 +1997,7 @@ pitch. In these cases, use the When any of the above feedbacks occur, Xkb may generate a -XkbBellNotify +XkbBellNotify event (see section 9.4). @@ -2008,9 +2008,9 @@ When any of the above feedbacks occur, Xkb may generate a The server can generate -XkbAccessXNotify +XkbAccessXNotify events for some of the global keyboard controls. The structure for the -XkbAccessXNotify +XkbAccessXNotify event type is as follows: @@ -2021,8 +2021,8 @@ typedef struct { Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ - int xkb_type; /* XkbAccessXNotify */ - int device; /* Xkb device ID, will not be XkbUseCoreKbd */ + int xkb_type; /* XkbAccessXNotify */ + int device; /* Xkb device ID, will not be XkbUseCoreKbd */ int detail; /* XkbAXN_* */ KeyCode keycode; /* key of event */ int slowKeysDelay; /* current SlowKeys delay */ @@ -2108,7 +2108,7 @@ the To receive -XkbAccessXNotify +XkbAccessXNotify events under all possible conditions, use XkbSelectEvents (see section 4.3) and pass @@ -2122,11 +2122,11 @@ To receive To receive -XkbStateNotify +XkbStateNotify events only under certain conditions, use XkbSelectEventDetails using -XkbAccessXNotify +XkbAccessXNotify as the event_type and specifying the desired state changes in @@ -2210,7 +2210,7 @@ and locking, or unlocking of modifiers using StickyKeys generates -XkbStateNotify +XkbStateNotify events as described in section 5.4. Repeating keys generate normal KeyPress and @@ -2293,7 +2293,7 @@ To get the - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -2369,7 +2369,7 @@ To set the - device to configure, or XkbUseCoreKbd + device to configure, or XkbUseCoreKbd @@ -2475,7 +2475,7 @@ Use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -2551,7 +2551,7 @@ To set the - device to configure, or XkbUseCoreKbd + device to configure, or XkbUseCoreKbd @@ -2766,7 +2766,7 @@ Use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -2797,8 +2797,8 @@ with a mask indicating whether the individual - XkbAX_TwoKeysMask - XkbAX_LatchToLockMask + XkbAX_TwoKeysMask + XkbAX_LatchToLockMask @@ -2896,8 +2896,8 @@ The valid bits to use for both the - XkbAX_TwoKeysMask - XkbAX_LatchToLockMask + XkbAX_TwoKeysMask + XkbAX_LatchToLockMask @@ -3104,7 +3104,7 @@ virtual_values - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -3314,7 +3314,7 @@ virtual_values - ‘device ID, or XkbUseCoreKbd + ‘device ID, or XkbUseCoreKbd @@ -3919,7 +3919,7 @@ global basis. Valid values for When groups_wrap is set to -XkbRedirectIntoRange, +XkbRedirectIntoRange, its four low-order bits specify the index of the group to use. @@ -4152,9 +4152,9 @@ The The fields pertaining to each control are relevant only when the control is enabled ( -XkbAccessXFeedbackMask +XkbAccessXFeedbackMask or -XkbStickyKeysMask +XkbStickyKeysMask bit is turned on in the enabled_cntrls field). @@ -4170,13 +4170,13 @@ Xkb provides a set of convenience macros for working with the -#define XkbAX_NeedOption +#define XkbAX_NeedOption (c,w) ((c)->ax_options&(w)) The -XkbAX_NeedOption +XkbAX_NeedOption macro is useful for determining whether a particular AccessX option is enabled or not. It accepts a pointer to an XkbControlsRec @@ -4197,17 +4197,17 @@ XkbAX_NeedOption(ctlrec, XkbAX_LatchToLockMask) is nonzero if the latch to lock transition for latching keys is enabled, and zero if it is disabled. Note that -XkbAX_NeedOption +XkbAX_NeedOption only determines whether or not the particular capability is configured to operate; the -XkbAccessXFeedbackMask +XkbAccessXFeedbackMask bit must also be turned on in enabled_ctrls for the capability to actually be functioning. -#define XkbAX_AnyFeedback +#define XkbAX_AnyFeedback (c) ((c)->enabled_ctrls&XkbAccessXFeedbackMask) @@ -4221,18 +4221,18 @@ The control is enabled or not. If the AccessXFeedback control is enabled, the macro returns -XkbAccessXFeedbackMask. +XkbAccessXFeedbackMask. Otherwise, it returns zero. -#define XkbAX_NeedFeedback +#define XkbAX_NeedFeedback (c,w) (XkbAX_AnyFeedback(c)&&XkbAX_NeedOption(c,w)) The -XkbAX_NeedFeedback +XkbAX_NeedFeedback macro is useful for determining if both the AccessXFeedback control and a particular AccessX feedback option are enabled. The macro @@ -4576,7 +4576,7 @@ boolean controls, you must set enabled_ctrls to the appropriate bits to enable only the controls you want and disable all others, then specify the -XkbControlsEnabledMask +XkbControlsEnabledMask in a call to XkbSetControls. Because this is somewhat awkward if all you want to do is enable and disable @@ -4715,13 +4715,13 @@ to the server specified by Whenever a field in the controls structure changes in the server’s keyboard description, the server sends an -XkbControlsNotify +XkbControlsNotify event to all interested clients.To receive -XkbControlsNotify +XkbControlsNotify events under all possible conditions, use XkbSelectEvents (see section 4.3) and pass -XkbControlsNotifyMask +XkbControlsNotifyMask in both bits_to_change and @@ -4731,11 +4731,11 @@ description, the server sends an To receive -XkbControlsNotify +XkbControlsNotify events only under certain conditions, use XkbSelectEventDetails using -XkbControlsNotify +XkbControlsNotify as the event_type and specifying the desired state changes in @@ -4748,7 +4748,7 @@ To receive The structure for the -XkbControlsNotify +XkbControlsNotify event is defined as follows: @@ -4759,8 +4759,8 @@ typedef struct { Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ - int xkb_type; /* XkbCompatMapNotify */ - int device; /* Xkb device ID, will not be XkbUseCoreKbd */ + int xkb_type; /* XkbCompatMapNotify */ + int device; /* Xkb device ID, will not be XkbUseCoreKbd */ unsigned int changed_ctrls; /* bits indicating which controls data have changed*/ unsigned int enabled_ctrls; /* controls currently enabled in server */ unsigned int enabled_ctrl_changes; /* bits indicating enabled/disabled controls */ @@ -4852,7 +4852,7 @@ the When a client receives an -XkbControlsNotify +XkbControlsNotify event, it can note the changes in a changes structure using XkbNoteControlsChanges. diff --git a/specs/XKB/ch12.xml b/specs/XKB/ch12.xml index 4b8e0be8..d3534efd 100644 --- a/specs/XKB/ch12.xml +++ b/specs/XKB/ch12.xml @@ -58,9 +58,9 @@ a The X Keyboard Extension uses -XkbMapNotify +XkbMapNotify and -XkbNewKeyboardNotify +XkbNewKeyboardNotify events to track changes to the keyboard mapping. When an Xkb-aware client receives either event, it should call XkbRefreshKeyboardMapping @@ -68,14 +68,14 @@ receives either event, it should call duplicate events, the X server does not send core protocol MappingNotify events to a client that has selected for -XkbMapNotify +XkbMapNotify events. The implicit support for Xkb selects for -XkbMapNotify +XkbMapNotify 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 @@ -93,18 +93,18 @@ explicitly selected for the Xkb version of the event. 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 -XkbNewKeyboardNotify +XkbNewKeyboardNotify event, it reports events from all keys because it assumes that any client that has receieved an -XkbNewKeyboardNotify +XkbNewKeyboardNotify event expects key events from the new range of keycodes. The implicit support for Xkb asks for -XkbNewKeyboardNotify +XkbNewKeyboardNotify 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 -XkbLC_IgnoreNewKeyboards +XkbLC_IgnoreNewKeyboards library control (see section 11.3.1) to prevent the implicit support from requesting notification of changes to the legal range of keycodes. @@ -200,7 +200,7 @@ reflect changes reported via 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 -XkbMapNotify +XkbMapNotify event and updates only those pieces of the keyboard description that have changed. If the implicit support has not noted any keyboard mapping changes, XRefreshKeyboardMapping @@ -748,7 +748,7 @@ To update the keyboard description that is internal to the X library, use information to this client. A client usually invokes XkbRefreshKeyboardMapping after receiving an -XkbMapNotify +XkbMapNotify event. XkbRefreshKeyboardMapping returns @@ -761,7 +761,7 @@ information to this client. A client usually invokes The -XkbMapNotify +XkbMapNotify event can be generated when some client calls XkbSetMap, XkbChangeMap, diff --git a/specs/XKB/ch13.xml b/specs/XKB/ch13.xml index 531e3817..f05185d3 100644 --- a/specs/XKB/ch13.xml +++ b/specs/XKB/ch13.xml @@ -581,7 +581,7 @@ The structures these doodads are stored in and the values of the XkbIndicatorDoodadRec -XkbIndicatorDoodad +XkbIndicatorDoodad @@ -592,7 +592,7 @@ The structures these doodads are stored in and the values of the XkbShapeDoodadRec -XkbOutlineDoodad +XkbOutlineDoodad @@ -603,7 +603,7 @@ The structures these doodads are stored in and the values of the XkbShapeDoodadRec -XkbSolidDoodad +XkbSolidDoodad @@ -614,7 +614,7 @@ The structures these doodads are stored in and the values of the XkbTextDoodadRec -XkbTextDoodad +XkbTextDoodad @@ -625,7 +625,7 @@ The structures these doodads are stored in and the values of the XkbLogoDoodadRec -XkbLogoDoodad +XkbLogoDoodad @@ -1013,8 +1013,8 @@ relative to the keyboard’s origin if the doodad is in the typedef struct _XkbShapeDoodad { Atom name; /* doodad name */ - unsigned char type; /* XkbOutlineDoodad - or XkbSolidDoodad */ + unsigned char type; /* XkbOutlineDoodad + or XkbSolidDoodad */ unsigned char priority; /* drawing priority, 0=>highest, 255=>lowest */ short top; /* top coordinate, in mm/10 */ @@ -1028,7 +1028,7 @@ typedef struct _XkbShapeDoodad { typedef struct _XkbTextDoodad { Atom name; /* doodad name */ - unsigned char type; /* XkbTextDoodad */ + unsigned char type; /* XkbTextDoodad */ unsigned char priority; /* drawing priority, 0=>highest, 255=>lowest */ short top; /* top coordinate, in mm/10 */ @@ -1045,7 +1045,7 @@ typedef struct _XkbTextDoodad { typedef struct _XkbIndicatorDoodad { Atom name; /* doodad name */ - unsigned char type; /* XkbIndicatorDoodad */ + unsigned char type; /* XkbIndicatorDoodad */ unsigned char priority; /* drawing priority, 0=>highest, 255=>lowest */ short top; /* top coordinate, in mm/10 */ short left; /* left coordinate, in mm/10 */ @@ -1059,7 +1059,7 @@ typedef struct _XkbIndicatorDoodad { typedef struct _XkbLogoDoodad { Atom name; /* doodad name */ - unsigned char type; /* XkbLogoDoodad */ + unsigned char type; /* XkbLogoDoodad */ unsigned char priority; /* drawing priority, 0=>highest, 255=>lowest */ short top; /* top coordinate, in mm/10 */ short left; /* left coordinate, in mm/10 */ diff --git a/specs/XKB/ch14.xml b/specs/XKB/ch14.xml index 0d9f499c..f9cc9c13 100644 --- a/specs/XKB/ch14.xml +++ b/specs/XKB/ch14.xml @@ -287,7 +287,7 @@ populated. - device_id, or XkbUseCoreKbd + device_id, or XkbUseCoreKbd @@ -376,7 +376,7 @@ information on these functions. - XkbKeyTypesMask + XkbKeyTypesMask (1<<0) client @@ -393,7 +393,7 @@ information on these functions. 15.2 - XkbKeySymsMask + XkbKeySymsMask (1<<1) client @@ -410,7 +410,7 @@ information on these functions. 15.3 - XkbModifierMapMask + XkbModifierMapMask (1<<2) client modmap @@ -418,7 +418,7 @@ information on these functions. 15.4 - XkbExplicitComponentsMask + XkbExplicitComponentsMask (1<<3) server explicit @@ -426,7 +426,7 @@ information on these functions. 16.3 - XkbKeyActionsMask + XkbKeyActionsMask (1<<4) server @@ -442,7 +442,7 @@ information on these functions. 16.1 - XkbKeyBehaviorsMask + XkbKeyBehaviorsMask (1<<5) server behaviors @@ -450,7 +450,7 @@ information on these functions. 16.2 - XkbVirtualModsMask + XkbVirtualModsMask (1<<6) server vmods @@ -458,7 +458,7 @@ information on these functions. 16.4 - XkbVirtualModMapMask + XkbVirtualModMapMask (1<<7) server vmodmap @@ -787,7 +787,7 @@ server and are always updated by the server whenever it returns the data for an - XkbKeyTypesMask + XkbKeyTypesMask first_type, num_types @@ -798,7 +798,7 @@ server and are always updated by the server whenever it returns the data for an - XkbKeySymsMask + XkbKeySymsMask first_key_sym, num_key_syms @@ -809,7 +809,7 @@ server and are always updated by the server whenever it returns the data for an - XkbModifierMapMask + XkbModifierMapMask first_modmap_key, num_modmap_keys @@ -820,7 +820,7 @@ server and are always updated by the server whenever it returns the data for an - XkbExplicitComponentsMask + XkbExplicitComponentsMask first_key_explicit, num_key_explicit @@ -831,7 +831,7 @@ server and are always updated by the server whenever it returns the data for an - XkbKeyActionsMask + XkbKeyActionsMask first_key_act, num_key_acts @@ -842,7 +842,7 @@ server and are always updated by the server whenever it returns the data for an - XkbKeyBehaviorsMask + XkbKeyBehaviorsMask first_key_behavior, num_key_behaviors @@ -858,7 +858,7 @@ server and are always updated by the server whenever it returns the data for an server->vmods[*] - XkbVirtualModMapMask + XkbVirtualModMapMask first_vmodmap_key, num_vmodmap_keys @@ -973,7 +973,7 @@ and The Xkb extension reports -XkbMapNotify +XkbMapNotify 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 @@ -984,11 +984,11 @@ change. The event detail masks are identical to the masks listed in To receive -XkbMapNotify +XkbMapNotify events under all possible conditions, use XkbSelectEvents (see section 4.3) and pass -XkbMapNotifyMask +XkbMapNotifyMask in both bits_to_change and @@ -998,11 +998,11 @@ To receive To receive -XkbMapNotify +XkbMapNotify events only under certain conditions, use XkbSelectEventDetails using -XkbMapNotify +XkbMapNotify as the event_type and specifying the desired map changes in @@ -1015,7 +1015,7 @@ To receive The structure for -XkbMapNotify +XkbMapNotify events is: @@ -1026,8 +1026,8 @@ typedef struct { Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ - int xkb_type; /* XkbMapNotify */ - int device; /* Xkb device ID, will not be XkbUseCoreKbd */ + int xkb_type; /* XkbMapNotify */ + int device; /* Xkb device ID, will not be XkbUseCoreKbd */ unsigned int changed; /* identifies valid fields in rest of event */ unsigned int resized; /* reserved */ int first_type; /* index of first key type modified */ @@ -1195,7 +1195,7 @@ field specifies the number of entries to preallocate for the field of the client map. If the type_count field is less than -XkbNumRequiredTypes +XkbNumRequiredTypes (see section 15.2.1), returns BadValue. @@ -1251,9 +1251,9 @@ of entries necessary for fields of the xkb parameter must be legal values if the -XkbKeySymsMask +XkbKeySymsMask or -XkbModifierMapMask +XkbModifierMapMask masks are set in the which parameter. If they are not valid, diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml index ba963eb1..12205ac2 100644 --- a/specs/XKB/ch15.xml +++ b/specs/XKB/ch15.xml @@ -398,24 +398,24 @@ level-one symbols. Xkb allows up to -XkbMaxKeyTypes +XkbMaxKeyTypes (255) key types to be defined, but requires at least -XkbNumRequiredTypes +XkbNumRequiredTypes (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 -XkbNumRequiredTypes +XkbNumRequiredTypes entries of the types field of the client map and are indexed using the following constants: - XkbOneLevelIndex - XkbTwoLevelIndex - XkbAlphabeticIndex - XkbKeypadIndex + XkbOneLevelIndex + XkbTwoLevelIndex + XkbAlphabeticIndex + XkbKeypadIndex @@ -440,7 +440,7 @@ type "ONE_LEVEL" { The description of the ONE_LEVEL key type is stored in the types [ -XkbOneLevelIndex +XkbOneLevelIndex ] entry of the client key map. @@ -473,7 +473,7 @@ type "TWO_LEVEL" { The description of the TWO_LEVEL key type is stored in the types [ -XkbTwoLevelIndex +XkbTwoLevelIndex ] entry of the client key map. @@ -550,7 +550,7 @@ type "ALPHABETIC" { The description of the ALPHABETIC key type is stored in the types [ -XkbAlphabeticIndex +XkbAlphabeticIndex ] entry of the client key map. @@ -624,7 +624,7 @@ type "KEYPAD" { The description of the KEYPAD key type is stored in the types [ -XkbKeypadIndex +XkbKeypadIndex ] entry of the client key map. @@ -688,18 +688,18 @@ default values, use XkbInitCanonicalKeyTypes initializes the first -XkbNumRequiredTypes +XkbNumRequiredTypes key types of the keyboard specified by the xkb parameter to their default values. The which parameter specifies what canonical key types to initialize and is a bitwise inclusive OR of the following masks: -XkbOneLevelMask, -XkbTwoLevelMask, -XkbAlphabeticMask, +XkbOneLevelMask, +XkbTwoLevelMask, +XkbAlphabeticMask, and -XkbKeypadMask. +XkbKeypadMask. Only those canonical types specified by the which mask are initialized. @@ -708,7 +708,7 @@ Only those canonical types specified by the If -XkbKeypadMask +XkbKeypadMask is set in the which parameter, @@ -1289,9 +1289,9 @@ the key types: The array of key types is of fixed width and is large enough to hold key types for the maximum legal number of groups ( -XkbNumKbdGroups, +XkbNumKbdGroups, currently four); if a key has fewer than -XkbNumKbdGroups +XkbNumKbdGroups groups, the extra key types are reported but ignored. XkbKeyTypeIndex @@ -2127,7 +2127,7 @@ extension has not been properly initialized, If num is less than 1 or greater than -XkbMaxKeyCount, +XkbMaxKeyCount, XkbGetKeySyms returns BadValue. @@ -2245,7 +2245,7 @@ as appropriate. If the NULL, XkbChangeTypesOfKey adds the -XkbKeySymsMask +XkbKeySymsMask to the changes field of @@ -2274,11 +2274,11 @@ The groups parameter is a mask specifying the groups for which new types are supplied and is a bitwise inclusive OR of the following masks: -XkbGroup1Mask, -XkbGroup2Mask, -XkbGroup3Mask, +XkbGroup1Mask, +XkbGroup2Mask, +XkbGroup3Mask, and -XkbGroup4Mask. +XkbGroup4Mask. @@ -2370,7 +2370,7 @@ If the is not a valid keycode, n_groups is greater than -XkbNumKbdGroups, +XkbNumKbdGroups, or the groups mask does not contain any of the valid group mask bits, diff --git a/specs/XKB/ch16.xml b/specs/XKB/ch16.xml index 463e4100..90ba8a19 100644 --- a/specs/XKB/ch16.xml +++ b/specs/XKB/ch16.xml @@ -516,9 +516,9 @@ the - XkbSA_NoAction + XkbSA_NoAction -XkbSA_NoAction +XkbSA_NoAction means the server does not perform an action for the key; this action does not have an associated data structure. @@ -527,9 +527,9 @@ have an associated data structure. -XkbSA_SetMods -XkbSA_LatchMods -XkbSA_LockMods +XkbSA_SetMods +XkbSA_LatchMods +XkbSA_LockMods XkbModAction mods @@ -537,16 +537,16 @@ have an associated data structure. -XkbSA_SetGroup -XkbSA_LatchGroup -XkbSA_LockGroup +XkbSA_SetGroup +XkbSA_LatchGroup +XkbSA_LockGroup XkbGroupAction group 16.1.4 - XkbSA_MovePtr + XkbSA_MovePtr XkbPtrAction ptr 16.1.5 @@ -554,53 +554,53 @@ have an associated data structure. XKbSA_PtrBtn -XkbSA_LockPtrBtn +XkbSA_LockPtrBtn XkbPtrBtnActionbtn 16.1.6 - XkbSA_SetPtrDflt + XkbSA_SetPtrDflt XkbPtrDfltAction dflt 16.1.7 - XkbSA_ISOLock + XkbSA_ISOLock XkbISOAction iso 16.1.8 - XkbSA_SwitchScreen + XkbSA_SwitchScreen XkbSwitchScreenAction screen 16.1.9 -XkbSA_SetControls -XkbSA_LockControls +XkbSA_SetControls +XkbSA_LockControls XkbCtrlsAction ctrls 16.1.10 - XkbSA_ActionMessage + XkbSA_ActionMessage XkbMessgeAction msg 16.1.11 - XkbSA_RedirectKey + XkbSA_RedirectKey XkbRedirectKeyAction redirect 16.1.12 -XkbSA_DeviceBtn +XkbSA_DeviceBtn XKbSA_LockDeviceBtn XkbDeviceBtnAction @@ -608,7 +608,7 @@ have an associated data structure. 16.1.13 - XkbSA_DeviceValuator + XkbSA_DeviceValuator XkbDeviceValuatorAction devval 16.1.14 @@ -682,7 +682,7 @@ The - XkbSA_SetMods + XkbSA_SetMods @@ -699,7 +699,7 @@ provided no other key affecting the same modifiers is logically down. If no other keys are physically depressed when this key is released, and -XkbSA_ClearLocks +XkbSA_ClearLocks is set in the flags field, the key release unlocks any action modifiers. @@ -709,13 +709,13 @@ If no other keys are physically depressed when this key is released, and - XkbSA_LatchMods + XkbSA_LatchMods Key press and key release events have the same effect as for -XkbSA_SetMods +XkbSA_SetMods ; if no keys are physically depressed when this key is released, key release events have the following additional effects: @@ -723,14 +723,14 @@ events have the following additional effects: Modifiers unlocked due to -XkbSA_ClearLocks +XkbSA_ClearLocks have no further effect. If -XkbSA_LatchToLock +XkbSA_LatchToLock is set in the flags field, a key release locks and then unlatches any remaining action modifiers @@ -740,9 +740,9 @@ that are already latched. A key release latches any action modifiers not used by the -XkbSA_ClearLocks +XkbSA_ClearLocks and -XkbSA_LatchToLock +XkbSA_LatchToLock flags. @@ -750,13 +750,13 @@ A key release latches any action modifiers not used by the - XkbSA_LockMods + XkbSA_LockMods A key press sets the base state of any action modifiers. If -XkbSA_LockNoLock +XkbSA_LockNoLock is set in the flags field, a key press also sets the locked state of any action modifiers. @@ -766,7 +766,7 @@ 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 -XkbSA_LockNoUnlock +XkbSA_LockNoUnlock is not set in the flags field, and any of the action modifiers were locked before the corresponding @@ -803,7 +803,7 @@ the action type. - XkbSA_UseModMapMods + XkbSA_UseModMapMods If set, the action modifiers are determined by the modifiers bound by the modifier mapping of the key. Otherwise, the action modifiers are set to the @@ -817,33 +817,33 @@ and - XkbSA_ClearLocks + XkbSA_ClearLocks If set and no keys are physically depressed when this key transition occurs, the server unlocks any action modifiers. - XkbSA_LatchToLock + XkbSA_LatchToLock If set, and the action type is -XkbSA_LatchMods, +XkbSA_LatchMods, the server locks the action modifiers if they are already latched. - XkbSA_LockNoLock + XkbSA_LockNoLock If set, and the action type is -XkbSA_LockMods, +XkbSA_LockMods, the server only unlocks the action modifiers. - XkbSA_LockNoUnlock + XkbSA_LockNoUnlock If set, and the action is -XkbSA_LockMods, +XkbSA_LockMods, the server only locks the action modifiers. @@ -853,7 +853,7 @@ the server only locks the action modifiers. If -XkbSA_UseModMapMods +XkbSA_UseModMapMods is not set in the flags field, the @@ -1032,13 +1032,13 @@ The - XkbSA_SetGroup + XkbSA_SetGroup If the -XkbSA_GroupAbsolute +XkbSA_GroupAbsolute bit is set in the flags field, key press events change the base keyboard group to the group specified @@ -1056,7 +1056,7 @@ keyboard group is brought back into range depending on the value of the If a key with an -XkbSA_ISOLock +XkbSA_ISOLock action (see section 16.1.8) 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. @@ -1065,7 +1065,7 @@ the key press. If the -XkbSA_ClearLocks +XkbSA_ClearLocks 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 Group1. @@ -1075,13 +1075,13 @@ key is released, the key release also sets the locked keyboard group to - XkbSA_LatchGroup + XkbSA_LatchGroup Key press and key release events have the same effect as for -XkbSA_SetGroup +XkbSA_SetGroup ; if no keys are physically depressed when this key is released, key release events have the following additional effects. @@ -1089,7 +1089,7 @@ events have the following additional effects. If the -XkbSA_LatchToLock +XkbSA_LatchToLock bit is set in the flags field and the latched keyboard group index is nonzero, the key release adds @@ -1109,13 +1109,13 @@ Otherwise, the key press adds the key press delta to the latched keyboard group. - XkbSA_LockGroup + XkbSA_LockGroup If the -XkbSA_GroupAbsolute +XkbSA_GroupAbsolute is set in the flags field, key press events set the locked keyboard group to the group specified @@ -1166,7 +1166,7 @@ the action - XkbSA_ClearLocks + XkbSA_ClearLocks If set and no keys are physically depressed when this key transition occurs, the server sets the locked keyboard group to @@ -1175,7 +1175,7 @@ the server sets the locked keyboard group to - XkbSA_LatchToLock + XkbSA_LatchToLock If set, and the action type is SA_LatchGroup, @@ -1183,7 +1183,7 @@ the server locks the action group if it is already latched. - XkbSA_GroupAbsolute + XkbSA_GroupAbsolute If set, the group_XXX @@ -1301,7 +1301,7 @@ Actions associated with the typedef struct _XkbPtrAction { - unsigned char type; /* XkbSA_MovePtr */ + unsigned char type; /* XkbSA_MovePtr */ unsigned char flags; /* determines type of pointer motion */ unsigned char high_XXX; /* x coordinate, high bits*/ unsigned char low_XXX; /* y coordinate, low bits */ @@ -1318,14 +1318,14 @@ If the and KeyRelease events are treated as though the action is -XkbSA_NoAction. +XkbSA_NoAction. If the MouseKeys control is enabled, a server action of type -XkbSA_MovePtr +XkbSA_MovePtr instructs the server to generate core pointer MotionNotify events rather than the usual @@ -1334,7 +1334,7 @@ If the KeyRelease event disables any mouse keys timers that were created as a result of handling the -XkbSA_MovePtr +XkbSA_MovePtr action. @@ -1345,7 +1345,7 @@ The field of the XkbPtrAction structure is always -XkbSA_MovePtr. +XkbSA_MovePtr. @@ -1370,7 +1370,7 @@ The - XkbSA_NoAcceleration + XkbSA_NoAcceleration If not set, and the MouseKeysAccel @@ -1381,14 +1381,14 @@ cursor moves. - XkbSA_MoveAbsoluteX + XkbSA_MoveAbsoluteX If set, the X portion of the structure specifies the new pointer X coordinate. Otherwise, the X portion is added to the current pointer X coordinate to determine the new pointer X coordinate. - XkbSA_MoveAbsoluteY + XkbSA_MoveAbsoluteY If set, the Y portion of the structure specifies the new pointer Y coordinate. Otherwise, the Y portion is added @@ -1610,7 +1610,7 @@ If the and KeyRelease events are treated as though the action is -XkbSA_NoAction. +XkbSA_NoAction. @@ -1635,13 +1635,13 @@ The - XkbSA_PtrBtn + XkbSA_PtrBtn If -XkbSA_UseDfltButton +XkbSA_UseDfltButton is set in the flags field, the event is generated for the pointer button specified by the @@ -1702,7 +1702,7 @@ a key release generates a core pointer - XkbSA_LockPtrBtn + XkbSA_LockPtrBtn @@ -1717,7 +1717,7 @@ or event instead of a KeyPress event and locks the button. If the button is already locked or if -XkbSA_LockNoUnlock +XkbSA_LockNoUnlock is set in the flags field, a key press is ignored and has no effect. @@ -1726,7 +1726,7 @@ or If the corresponding key press was ignored, and if -XkbSA_LockNoLock +XkbSA_LockNoLock is not set in the flags field, a key release generates a @@ -1769,7 +1769,7 @@ the action - XkbSA_UseDfltButton + XkbSA_UseDfltButton If set, the action uses the pointer button specified by the mk_dflt_btn @@ -1782,18 +1782,18 @@ field. - XkbSA_LockNoLock + XkbSA_LockNoLock If set, and the action type is -XkbSA_LockPtrBtn, +XkbSA_LockPtrBtn, the server only unlocks the pointer button. - XkbSA_LockNoUnlock + XkbSA_LockNoUnlock If set, and the action type is -XkbSA_LockPtrBtn, +XkbSA_LockPtrBtn, the server only locks the pointer button. @@ -1817,9 +1817,9 @@ Actions associated with the typedef struct _XkbPtrDfltAction { - unsigned char type; /* XkbSA_SetPtrDflt */ + unsigned char type; /* XkbSA_SetPtrDflt */ unsigned char flags; /* controls the pointer button number */ - unsigned char affect; /* XkbSA_AffectDfltBtn */ + unsigned char affect; /* XkbSA_AffectDfltBtn */ char valueXXX; /* new default button member */ } XkbPtrDfltAction; @@ -1832,7 +1832,7 @@ If the and KeyRelease events are treated as though the action is -XkbSA_NoAction. +XkbSA_NoAction. Otherwise, this action changes the mk_dflt_btn attribute of the @@ -1847,7 +1847,7 @@ The field of the XkbPtrDfltAction structure should always be -XkbSA_SetPtrDflt. +XkbSA_SetPtrDflt. @@ -1873,7 +1873,7 @@ The - XkbSA_DfltBtnAbsolute + XkbSA_DfltBtnAbsolute If set, the value @@ -1892,7 +1892,7 @@ The field specifies what changes as a result of this action. The only valid value for the affect - field is XkbSA_AffectDfltBtn. + field is XkbSA_AffectDfltBtn. @@ -1903,7 +1903,7 @@ The attribute of the MouseKeys control (see section 10.5.1). If -XkbSA_DfltBtnAbsolute +XkbSA_DfltBtnAbsolute is set in flags, valueXXX @@ -2039,15 +2039,15 @@ The default behavior is to convert: The affects field allows you to turn those effects on or off individually. Set -XkbSA_ISONoAffectMods +XkbSA_ISONoAffectMods to disable the first, -XkbSA_ISONoAffectGroup +XkbSA_ISONoAffectGroup to disable the second, and so forth. typedef struct _XkbISOAction { - unsigned char type; /* XkbSA_ISOLock */ + unsigned char type; /* XkbSA_ISOLock */ unsigned char flags; /* controls changes to group or modifier state */ unsigned char mask; /* same as mask field of a modifier description */ unsigned char real_mods; /* same as real_mods field of a modifier description */ @@ -2064,7 +2064,7 @@ The field of the XkbISOAction structure should always be -XkbSA_ISOLock. +XkbSA_ISOLock. @@ -2072,7 +2072,7 @@ The The interpretation of the flags field depends on whether the -XkbSA_ISODfltIsGroup +XkbSA_ISODfltIsGroup is set in the flags field or not. @@ -2081,7 +2081,7 @@ The interpretation of the If the -XkbSA_ISODfltIsGroup +XkbSA_ISODfltIsGroup is set in the flags field, the action is used to change the group state. The remaining valid bits @@ -2105,7 +2105,7 @@ of the - XkbSA_ISODfltIsGroup + XkbSA_ISODfltIsGroup If set, the action is used to change the base group state. Must be set for the @@ -2115,7 +2115,7 @@ remaining bits in this table to carry their interpretations. A key press sets the base group as specified by the group_XXX field and the -XkbSA_GroupAbsolute +XkbSA_GroupAbsolute bit of the flags field (see section Note). If no other actions are transformed by the @@ -2126,7 +2126,7 @@ set by the key press. - XkbSA_GroupAbsolute + XkbSA_GroupAbsolute If set, the group_XXX @@ -2135,54 +2135,54 @@ delta to be added to the current group to determine the new group number. - XkbSA_ISONoAffectMods + XkbSA_ISONoAffectMods If not set, any -XkbSA_SetMods +XkbSA_SetMods or -XkbSA_LatchMods +XkbSA_LatchMods actions that occur simultaneously with the -XkbSA_ISOLock +XkbSA_ISOLock action are treated as XkbSA_LockMod actions instead. - XkbSA_ISONoAffectGroup + XkbSA_ISONoAffectGroup If not set, any -XkbSA_SetGroup +XkbSA_SetGroup or -XkbSA_LatchGroup +XkbSA_LatchGroup actions that occur simultaneously with the -XkbSA_ISOLock +XkbSA_ISOLock action are treated as -XkbSA_LockGroup +XkbSA_LockGroup actions instead. - XkbSA_ISONoAffectPtr + XkbSA_ISONoAffectPtr If not set, any -XkbSA_PtrBtn +XkbSA_PtrBtn actions that occur simultaneously with the -XkbSA_ISOLock +XkbSA_ISOLock action are treated as -XkbSA_LockPtrBtn +XkbSA_LockPtrBtn actions instead. - XkbSA_ISONoAffectCtrls + XkbSA_ISONoAffectCtrls If not set, any -XkbSA_SetControls +XkbSA_SetControls actions that occur simultaneously with the -XkbSA_ISOLock +XkbSA_ISOLock action are treated as -XkbSA_LockControls +XkbSA_LockControls actions instead. @@ -2192,7 +2192,7 @@ If not set, any If the -XkbSA_ISODfltIsGroup +XkbSA_ISODfltIsGroup is not set in the flags field, the action is used to change the modifier state and the remaining valid @@ -2216,7 +2216,7 @@ bits of the - XkbSA_ISODfltIsGroup + XkbSA_ISODfltIsGroup If not set, action is used to change the base modifier state. Must not be set @@ -2238,7 +2238,7 @@ clears the base modifiers set by the key press. - XkbSA_UseModMapMods + XkbSA_UseModMapMods If set, the action modifiers are determined by the modifiers bound by the modifier mapping of the key. Otherwise, the action modifiers are set to the @@ -2252,62 +2252,62 @@ and - XkbSA_LockNoLock + XkbSA_LockNoLock If set, the server only unlocks the action modifiers. - XkbSA_LockNoUnlock + XkbSA_LockNoUnlock If set, the server only locks the action modifiers. - XkbSA_ISONoAffectMods + XkbSA_ISONoAffectMods If not set, any -XkbSA_SetMods +XkbSA_SetMods or -XkbSA_LatchMods +XkbSA_LatchMods actions that occur simultaneously with the -XkbSA_ISOLock +XkbSA_ISOLock action are treated as XkbSA_LockMod actions instead. - XkbSA_ISONoAffectGroup + XkbSA_ISONoAffectGroup If not set, any -XkbSA_SetGroup +XkbSA_SetGroup or -XkbSA_LatchGroup +XkbSA_LatchGroup actions that occur simultaneously with the -XkbSA_ISOLock +XkbSA_ISOLock action are treated as -XkbSA_LockGroup +XkbSA_LockGroup actions instead. - XkbSA_ISONoAffectPtr + XkbSA_ISONoAffectPtr If not set, any -XkbSA_PtrBtn +XkbSA_PtrBtn actions that occur simultaneously with the -XkbSA_ISOLock +XkbSA_ISOLock action are treated as -XkbSA_LockPtrBtn +XkbSA_LockPtrBtn actions instead. - XkbSA_ISONoAffectCtrls + XkbSA_ISONoAffectCtrls If not set, any -XkbSA_SetControls +XkbSA_SetControls actions that occur simultaneously with the -XkbSA_ISOLock +XkbSA_ISOLock action are treated as -XkbSA_LockControls +XkbSA_LockControls actions instead. @@ -2374,7 +2374,7 @@ The XkbSA_ISODNoAffectMods If -XkbSA_ISONoAffectMods +XkbSA_ISONoAffectMods is not set, any SA_SetMods or @@ -2387,10 +2387,10 @@ If - XkbSA_ISONoAffectGroup + XkbSA_ISONoAffectGroup If -XkbSA_ISONoAffectGroup +XkbSA_ISONoAffectGroup is not set, any SA_SetGroup or @@ -2403,10 +2403,10 @@ If - XkbSA_ISONoAffectPtr + XkbSA_ISONoAffectPtr If -XkbSA_ISONoAffectPtr +XkbSA_ISONoAffectPtr is not set, any SA_PtrBtn actions occurring simultaneously with the @@ -2417,10 +2417,10 @@ If - XkbSA_ISONoAffectCtrls + XkbSA_ISONoAffectCtrls If -XkbSA_ISONoAffectCtrls +XkbSA_ISONoAffectCtrls is not set, any SA_SetControls actions occurring simultaneously with the @@ -2447,13 +2447,13 @@ Actions associated with the This action is optional. Servers are free to ignore the action or any of its flags if they do not support the requested behavior. If the action is ignored, it behaves like -XkbSA_NoAction. +XkbSA_NoAction. Otherwise, key press and key release events do not generate an event. typedef struct _XkbSwitchScreenAction { - unsigned char type; /* XkbSA_SwitchScreen */ + unsigned char type; /* XkbSA_SwitchScreen */ unsigned char flags; /* controls screen switching */ char screenXXX; /* screen number or delta */ } XkbSwitchScreenAction; @@ -2465,7 +2465,7 @@ The field of the XkbSwitchScreenAction structure should always be -XkbSA_SwitchScreen. +XkbSA_SwitchScreen. @@ -2490,7 +2490,7 @@ The - XkbSA_SwitchAbsolute + XkbSA_SwitchAbsolute If set, the screenXXX @@ -2499,7 +2499,7 @@ offset from the current screen to the new screen. - XkbSA_SwitchApplication + XkbSA_SwitchApplication If not set, the action should switch to another screen on the same server. Otherwise, it should switch to another X server or application that @@ -2515,7 +2515,7 @@ The screenXXX field is a signed character value that represents either the relative or absolute screen index, depending on the state of the -XkbSA_SwitchAbsolute +XkbSA_SwitchAbsolute bit in the flags field. Xkb provides the following macros to convert between the integer and @@ -2616,8 +2616,8 @@ Actions associated with the typedef struct _XkbCtrlsAction { - unsigned char type; /* XkbSA_SetControls, - XkbSA_LockControls */ + unsigned char type; /* XkbSA_SetControls, + XkbSA_LockControls */ unsigned char flags; /* with type, controls enabling and disabling of controls */ unsigned char ctrls3; /* ctrls0 through @@ -2652,7 +2652,7 @@ The - XkbSA_SetControls + XkbSA_SetControls @@ -2670,7 +2670,7 @@ A key release disables any controls enabled by the key press. This action can cause -XkbControlsNotify +XkbControlsNotify events (see section 10.1). @@ -2678,13 +2678,13 @@ This action can cause - XkbSA_LockControls + XkbSA_LockControls If the -XkbSA_LockNoLock +XkbSA_LockNoLock bit is not set in the flags field, a key press enables any controls specified in the @@ -2695,7 +2695,7 @@ If the If the -XkbSA_LockNoUnlock +XkbSA_LockNoUnlock bit is not set in the flags field, a key release disables any controls specified in the @@ -2706,7 +2706,7 @@ If the This action can cause -XkbControlsNotify +XkbControlsNotify events (see section 10.1). @@ -2738,18 +2738,18 @@ The - XkbSA_LockNoLock + XkbSA_LockNoLock If set, and the action type is -XkbSA_LockControls, +XkbSA_LockControls, the server only disables controls. - XkbSA_LockNoUnlock + XkbSA_LockNoUnlock If set, and the action type is -XkbSA_LockControls, +XkbSA_LockControls, the server only enables controls. @@ -2759,15 +2759,15 @@ the server only enables controls. The -XkbSA_SetControls +XkbSA_SetControls action implements a key that enables a boolean control when pressed and disables it when released. The -XkbSA_LockControls +XkbSA_LockControls action is used to implement a key that toggles the state of a boolean control each time it is pressed and released. The -XkbSA_LockNoLock +XkbSA_LockNoLock and -XkbSA_LockNoUnlock +XkbSA_LockNoUnlock flags allow modifying the toggling behavior to only unlock or only lock the boolean control. @@ -2876,7 +2876,7 @@ macros, to convert between the two formats: Actions associated with the XkbMessageAction structure generate -XkbActionMessage +XkbActionMessage events: @@ -2885,7 +2885,7 @@ Actions associated with the typedef struct _XkbMessageAction { - unsigned char type; /* XkbSA_ActionMessage */ + unsigned char type; /* XkbSA_ActionMessage */ unsigned char flags; /* controls event generation via key presses and releases */ unsigned char message[XkbActionMessageLength]; /* message */ } XkbMessageAction; @@ -2897,7 +2897,7 @@ The field of the XkbMessageAction structure should always be -XkbSA_ActionMessage. +XkbSA_ActionMessage. @@ -2922,34 +2922,34 @@ The - XkbSA_MessageOnPress + XkbSA_MessageOnPress If set, key press events generate an -XkbActionMessage +XkbActionMessage event that reports the keycode, event type, and contents of the message field. - XkbSA_MessageOnRelease + XkbSA_MessageOnRelease If set, key release events generate an -XkbActionMessage +XkbActionMessage event that reports the keycode, event type, and contents of the message field. - XkbSA_MessageGenKeyEvent + XkbSA_MessageGenKeyEvent If set, key press and key release events generate KeyPress and KeyRelease events, regardless of whether they generate -XkbActionMessage +XkbActionMessage events. @@ -2961,7 +2961,7 @@ If set, key press and key release events generate The message field is an array of -XkbActionMessageLength +XkbActionMessageLength unsigned characters and may be set to anything the keymap designer wishes. @@ -2970,7 +2970,7 @@ The To receive -XkbActionMessage +XkbActionMessage events by calling either XkbSelectEvents or @@ -2981,11 +2981,11 @@ To receive To receive -XkbActionMessage +XkbActionMessage events under all possible conditions, use XkbSelectEvents and pass -XkbActionMessageMask +XkbActionMessageMask in both bits_to_change and @@ -2995,11 +2995,11 @@ To receive The -XkbActionMessage +XkbActionMessage event has no event details. However, you can call XkbSelectEventDetails using -XkbActionMessage +XkbActionMessage as the event_type and specifying @@ -3015,7 +3015,7 @@ The The structure for the -XkbActionMessage +XkbActionMessage event is defined as follows: @@ -3026,8 +3026,8 @@ typedef struct _XkbActionMessage { Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ - int xkb_type; /* XkbActionMessage */ - int device; /* Xkb device ID, will not be XkbUseCoreKbd */ + int xkb_type; /* XkbActionMessage */ + int device; /* Xkb device ID, will not be XkbUseCoreKbd */ KeyCode keycode; /* keycode of key triggering event */ Bool press; /* True => key press, False => release */ @@ -3092,7 +3092,7 @@ The into message [ -XkbActionMessageLength +XkbActionMessageLength ]. @@ -3115,7 +3115,7 @@ released: typedef struct _XkbRedirectKeyAction { - unsigned char type; /* XkbSA_RedirectKey */ + unsigned char type; /* XkbSA_RedirectKey */ unsigned char new_key; /* keycode to be put in event */ unsigned char mods_mask; /* mask of real mods to be reset */ unsigned char mods; /* mask of real mods to take values from */ @@ -3132,7 +3132,7 @@ The field for the XkbRedirectKeyAction structure should always be -XkbSA_RedirectKey. +XkbSA_RedirectKey. @@ -3173,7 +3173,7 @@ previously. The -XkbSA_RedirectKey +XkbSA_RedirectKey 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 KeyClass, @@ -3409,7 +3409,7 @@ The - XkbSA_DeviceBtn + XkbSA_DeviceBtn @@ -3417,7 +3417,7 @@ The If the button specified by this action is logically down, the key press and corresponding release are ignored and have no effect. If the device or button specified by this action are illegal, this action behaves like -XkbSA_NoAction. +XkbSA_NoAction. @@ -3455,19 +3455,19 @@ If - XkbSA_LockDeviceBtn + XkbSA_LockDeviceBtn If the device or button specified by this action are illegal, this action -behaves like XkbSA_NoAction. +behaves like XkbSA_NoAction. Otherwise, if the specified button is not locked and the -XkbSA_LockNoLock +XkbSA_LockNoLock bit is not set in the flags field, a key press generates an input extension @@ -3475,7 +3475,7 @@ Otherwise, if the specified button is not locked and the event instead of a KeyPress event and locks the button. If the button is already locked or if -XkbSA_LockNoLock +XkbSA_LockNoLock bit is set in the flags field, the key press is ignored and has no effect. @@ -3484,7 +3484,7 @@ Otherwise, if the specified button is not locked and the If the corresponding key press was ignored, and if the -XkbSA_LockNoUnlock +XkbSA_LockNoUnlock bit is not set in the flags field, a key release generates an input extension @@ -3523,18 +3523,18 @@ The - XkbSA_LockNoLock + XkbSA_LockNoLock If set, and the action type is -XkbSA_LockDeviceBtn, +XkbSA_LockDeviceBtn, the server only unlocks the button. - XkbSA_LockNoUnlock + XkbSA_LockNoUnlock If set, and the action type is -XkbSA_LockDeviceBtn, +XkbSA_LockDeviceBtn, the server only locks the button. @@ -3558,7 +3558,7 @@ valuators. typedef struct _XkbDeviceValuatorAction { - unsigned char type; /*XkbSA_DeviceValuator */ + unsigned char type; /*XkbSA_DeviceValuator */ unsigned char device; /* device ID */ unsigned char v1_what; /* determines how valuator is to behave for valuator 1 */ unsigned char v1_ndx; /* specifies a real valuator */ @@ -3577,7 +3577,7 @@ If nor v2_ndx specifies a legal valuator, this action behaves like -XkbSA_NoAction. +XkbSA_NoAction. @@ -3617,29 +3617,29 @@ The low four bits of - XkbSA_IgnoreVal + XkbSA_IgnoreVal No action - XkbSA_SetValMin + XkbSA_SetValMin v<n>_value is set to its minimum legal value. - XkbSA_SetValCenter + XkbSA_SetValCenter v<n>_valueis centered (to (max-min)/2). - XkbSA_SetValMax + XkbSA_SetValMax v<n>_value is set to its maximum legal value. - XkbSA_SetValRelative + XkbSA_SetValRelative v<n>_value * (2 val<n>Scale) is added to @@ -3647,7 +3647,7 @@ The low four bits of - XkbSA_SetValAbsolute + XkbSA_SetValAbsolute v<n>_value is set to (2 val<n>Scale). @@ -3659,12 +3659,12 @@ The low four bits of Illegal values for -XkbSA_SetValRelative +XkbSA_SetValRelative or -XkbSA_SetValAbsolute +XkbSA_SetValAbsolute are clamped into range. Note that all of these possibilities are legal for absolute valuators. For relative valuators, only -XkbSA_SetValRelative +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. @@ -3808,7 +3808,7 @@ has not been properly initialized, If num is less than 1 or greater than -XkbMaxKeyCount, +XkbMaxKeyCount, XkbGetKeyActions returns BadValue. @@ -3968,7 +3968,7 @@ pressed again. Keys that belong to the same radio group have the -XkbKB_RadioGroup +XkbKB_RadioGroup type in the type field and the radio group index specified in the @@ -3984,11 +3984,11 @@ Keys that belong to the same radio group have the 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 -XkbKB_RGAllowNone +XkbKB_RGAllowNone 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 -XkbKB_RGAllowNone +XkbKB_RGAllowNone is not set, there is no way to release the logically down member of the group. @@ -4023,7 +4023,7 @@ The typedef struct _XkbBehavior { unsigned char type; /* behavior type + optional - XkbKB_Permanent bit */ + XkbKB_Permanent bit */ unsigned char data; } XkbBehavior; @@ -4053,7 +4053,7 @@ Xkb supports the key behaviors shown in - XkbKB_Default + XkbKB_Default Press and release events are processed normally. The data @@ -4061,7 +4061,7 @@ Press and release events are processed normally. The - XkbKB_Lock + XkbKB_Lock If a key is logically up (that is, the corresponding bit of the core key map is cleared) when it is pressed, the key press is processed normally and the @@ -4073,7 +4073,7 @@ The - XkbKB_RadioGroup + XkbKB_RadioGroup If another member of the radio group is logically down (all members of the @@ -4098,7 +4098,7 @@ All other key release events are ignored. - XkbKB_Overlay1 + XkbKB_Overlay1 If the Overlay1 @@ -4111,7 +4111,7 @@ came from - XkbKB_Overlay2 + XkbKB_Overlay2 If the Overlay2 @@ -4129,11 +4129,11 @@ came from Xkb also provides the mask, -XkbKB_Permanent +XkbKB_Permanent 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 -XkbKB_Permanent +XkbKB_Permanent bit is not set in the type field, Xkb simulates the behavior in software. Otherwise, Xkb relies upon the @@ -4252,7 +4252,7 @@ has not been properly initialized, If num is less than 1 or greater than -XkbMaxKeyCount, +XkbMaxKeyCount, XkbGetKeyBehaviors returns BadValue. @@ -4359,9 +4359,9 @@ specified in a symbol interpretation. (1<<6) Automatic assignment of the -XkbKB_Lock +XkbKB_Lock behavior to the key, if the -XkbSI_LockingKey +XkbSI_LockingKey flag is set in a symbol interpretation. @@ -4490,7 +4490,7 @@ has not been properly initialized, If num is less than 1 or greater than -XkbMaxKeyCount, +XkbMaxKeyCount, XkbGetKeyExplicitComponents returns BadValue. @@ -4510,7 +4510,7 @@ If any allocation errors occur, The vmods member of the server map is a fixed-length array containing -XkbNumVirtualMods +XkbNumVirtualMods 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 vmods @@ -4818,7 +4818,7 @@ has not been properly initialized, If num is less than 1 or greater than -XkbMaxKeyCount, +XkbMaxKeyCount, XkbGetKeyVirtualModMap returns BadValue. diff --git a/specs/XKB/ch17.xml b/specs/XKB/ch17.xml index 3e774892..f98b25b2 100644 --- a/specs/XKB/ch17.xml +++ b/specs/XKB/ch17.xml @@ -426,7 +426,7 @@ processing may be modified for the particular key involved: Virtual modifier map Auto repeat - Key behavior (may be set to XkbKB_Lock) + Key behavior (may be set to XkbKB_Lock) Key action (see section 16.1) @@ -492,7 +492,7 @@ are to be interpreted. - XkbSI_NoneOf + XkbSI_NoneOf (0) None of the bits that are on in mods @@ -500,7 +500,7 @@ None of the bits that are on in mods - XkbSI_AnyOfOrNone + XkbSI_AnyOfOrNone (1) Zero or more of the bits that are on in @@ -509,7 +509,7 @@ Zero or more of the bits that are on in - XkbSI_AnyOf + XkbSI_AnyOf (2) One or more of the bits that are on in @@ -518,7 +518,7 @@ One or more of the bits that are on in - XkbSI_AllOf + XkbSI_AllOf (3) All of the bits that are on in @@ -527,7 +527,7 @@ All of the bits that are on in - XkbSI_Exactly + XkbSI_Exactly (4) All of the bits that are on in @@ -543,7 +543,7 @@ All of the bits that are on in In addition to the above bits, match may contain the -XkbSI_LevelOneOnly +XkbSI_LevelOneOnly bit, in which case the modifier match criteria specified by mods and @@ -579,11 +579,11 @@ interpretation where: flags = - XkbSI_AutoRepeat + XkbSI_AutoRepeat match = - XkbSI_AnyOfOrNone + XkbSI_AnyOfOrNone mods = @@ -591,7 +591,7 @@ interpretation where: virtual_mod = - XkbNoModifier + XkbNoModifier @@ -620,9 +620,9 @@ defined in section 16.1. If the Xkb keyboard map for the key does not have its ExplicitVModMap control set, the -XkbSI_LevelOneOnly +XkbSI_LevelOneOnly bit and symbol position are examined. If the -XkbSI_LevelOneOnly +XkbSI_LevelOneOnly bit is not set in match or the symbol is in position G1L1, the @@ -630,7 +630,7 @@ If the Xkb keyboard map for the key does not have its field is examined. If virtual_mod is not -XkbNoModifier, +XkbNoModifier, virtual_mod specifies a single virtual modifier to be added to the virtual modifier map for the key. @@ -656,9 +656,9 @@ field potentially specify additional behavior modifications: If the Xkb keyboard map for the key does not have its ExplicitAutoRepeat control set, its auto repeat behavior is set based on the value of the -XkbSI_AutoRepeat +XkbSI_AutoRepeat bit. If the -XkbSI_AutoRepeat +XkbSI_AutoRepeat bit is set, the auto-repeat behavior of the key is turned on; otherwise, it is turned off. @@ -668,9 +668,9 @@ turned off. If the Xkb keyboard map for the key does not have its ExplicitBehavior control set, its locking behavior is set based on the value of the -XkbSI_LockingKey +XkbSI_LockingKey bit. If -XkbSI_LockingKey +XkbSI_LockingKey is set, the key behavior is set to KB_Lock ; otherwise, it is turned off (see section 16.3). @@ -730,10 +730,10 @@ component of the keyboard group, all of the modifiers in the mask field of all of the group compatibility maps are added to the modifier mapping as well. While an -XkbSA_ISOLock +XkbSA_ISOLock action can theoretically affect any modifier, if the Xkb mapping for a key specifies an -XkbSA_ISOLock +XkbSA_ISOLock action, only the modifiers or group that are set by default are added to the modifier mapping. @@ -750,7 +750,7 @@ Use 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 -XkbCompatMapNotify +XkbCompatMapNotify events (see section 17.5). XkbGetCompatMap is particularly useful when you receive an event of this type, as it allows @@ -841,17 +841,17 @@ Valid values for - XkbSymInterpMask + XkbSymInterpMask (1<<0) Symbol interpretations - XkbGroupCompatMask + XkbGroupCompatMask (1<<1) Group maps - XkbAllCompatMask + XkbAllCompatMask (0x3) All compatibility map components @@ -1514,9 +1514,9 @@ The server automatically generates MappingNotify events when the keyboard mapping changes. If you wish to be notified of changes to the compatibility map, you should select for -XkbCompatMapNotify +XkbCompatMapNotify events. If you select for -XkbMapNotify +XkbMapNotify events, you no longer receive the automatically generated MappingNotify events. If you subsequently deselect @@ -1529,11 +1529,11 @@ changes to the compatibility map, you should select for To receive -XkbCompatMapNotify +XkbCompatMapNotify events under all possible conditions, use XkbSelectEvents (see section 4.3) and pass -XkbCompatMapNotifyMask +XkbCompatMapNotifyMask in both bits_to_change and @@ -1543,11 +1543,11 @@ To receive To receive -XkbCompatMapNotify +XkbCompatMapNotify events only under certain conditions, use XkbSelectEventDetails using -XkbCompatMapNotify +XkbCompatMapNotify as the event_type and specifying the desired map changes in @@ -1578,9 +1578,9 @@ typedef struct { synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ - int xkb_type; /* XkbCompatMapNotify */ + int xkb_type; /* XkbCompatMapNotify */ int device; /* Xkb device ID, will not be - XkbUseCoreKbd */ + XkbUseCoreKbd */ unsigned int changed_groups;/* number of group maps changed */ int first_si; /* index to 1st changed symbol interpretation */ diff --git a/specs/XKB/ch18.xml b/specs/XKB/ch18.xml index 2687c06b..e1a506f0 100644 --- a/specs/XKB/ch18.xml +++ b/specs/XKB/ch18.xml @@ -460,9 +460,9 @@ If the NULL, XkbGetNames does not retrieve type or shift level names, even if -XkbKeyTypeNamesMask +XkbKeyTypeNamesMask or -XkbKTLevelNamesMask +XkbKTLevelNamesMask are set in which. @@ -602,9 +602,9 @@ The and num_types arguments are used only if -XkbKeyTypeNamesMask +XkbKeyTypeNamesMask or -XkbKTLevelNamesMask +XkbKTLevelNamesMask is set in which and specify a subset of the types for which the corresponding names are to be @@ -834,11 +834,11 @@ to the X server specified by Whenever a symbolic name changes in the server’s keyboard description, the server sends a -XkbNamesNotify +XkbNamesNotify event to all interested clients. To receive name notify events, use XkbSelectEvents (see section 4.3) with -XkbNamesNotifyMask +XkbNamesNotifyMask in both the bits_to_change and @@ -853,7 +853,7 @@ To receive events for only specific names, use Set the event_type parameter to -XkbNamesNotify, +XkbNamesNotify, and set both the bits_to_change and @@ -865,7 +865,7 @@ and The structure for the -XkbNamesNotify +XkbNamesNotify event is defined as follows: @@ -879,9 +879,9 @@ typedef struct { Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ - int xkb_type; /* XkbNamesNotify */ + int xkb_type; /* XkbNamesNotify */ int device; /* Xkb device ID, will not be - XkbUseCoreKbd */ + XkbUseCoreKbd */ unsigned int changed; /* mask of name components that have changed */ int first_type; /* first key type with a new name */ diff --git a/specs/XKB/ch19.xml b/specs/XKB/ch19.xml index 0813c8ef..248087eb 100644 --- a/specs/XKB/ch19.xml +++ b/specs/XKB/ch19.xml @@ -38,14 +38,14 @@ for the client. Xkb provides an -XkbNewKeyboardNotify +XkbNewKeyboardNotify event that reports a change in keyboard geometry and/or the range of supported keycodes. The server can generate an -XkbNewKeyboardNotify +XkbNewKeyboardNotify event when it detects a new keyboard or in response to an XkbGetKeyboardByName request that loads a new keyboard description. Selecting for -XkbNewKeyboardNotify +XkbNewKeyboardNotify events allows Xkb-aware clients to be notified whenever a keyboard change occurs that may affect the keymap. @@ -53,11 +53,11 @@ occurs that may affect the keymap. When a client requests -XkbNewKeyboardNotify +XkbNewKeyboardNotify 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 -XkbNewKeyboardNotify +XkbNewKeyboardNotify event. Even if the "new" keyboard is not new to the server, it is new to this particular client. @@ -65,14 +65,14 @@ particular client. When the server sends an -XkbNewKeyboardNotify +XkbNewKeyboardNotify 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 -XkbNewKeyboardNotify +XkbNewKeyboardNotify event to a client. Because Xkb-unaware clients and Xkb-aware clients that do not request -XkbNewKeyboardNotify +XkbNewKeyboardNotify 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. @@ -81,9 +81,9 @@ outside of their notion of the legal keycode range. Clients that have not selected to receive -XkbNewKeyboardNotify +XkbNewKeyboardNotify events do, however, receive the -XkbNewKeyboardNotify +XkbNewKeyboardNotify 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. @@ -96,15 +96,15 @@ Clients wishing to track changes in and max_key_code must watch for both -XkbNewKeyboardNotify +XkbNewKeyboardNotify and -XkbMapNotify +XkbMapNotify events, because a simple mapping change causes an -XkbMapNotify +XkbMapNotify event and may change the range of valid keycodes, but does not cause an -XkbNewKeyboardNotify +XkbNewKeyboardNotify event. If a client does not select for -XkbNewKeyboardNotify +XkbNewKeyboardNotify events, the server restricts the range of keycodes reported to the client. @@ -159,7 +159,7 @@ Xkb events are discarded, and no Xkb requests have their keycode range clamped. The structure for the -XkbNewKeyboardNotify +XkbNewKeyboardNotify event is defined as follows: @@ -171,7 +171,7 @@ typedef struct _XkbNewKeyboardNotify { => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ - int xkb_type; /* XkbNewKeyboardNotify */ + int xkb_type; /* XkbNewKeyboardNotify */ int device; /* device ID of new keyboard */ int old_device; /* device ID of old keyboard */ int min_key_code; /* min keycode of new keyboard */ @@ -188,7 +188,7 @@ typedef struct _XkbNewKeyboardNotify { To receive name notify events, use XkbSelectEvents (see section 4.3) with -XkbNewKeyboardNotifyMask +XkbNewKeyboardNotifyMask in both the bits_to_change and @@ -198,7 +198,7 @@ To receive name notify events, use Set the event_type parameter to -XkbNewKeyboardNotify, +XkbNewKeyboardNotify, and set both the bits_to_change and @@ -223,12 +223,12 @@ and - XkbNKN_KeycodesMask + XkbNKN_KeycodesMask (1L<<0) Notification of keycode range changes wanted - XkbNKN_GeometryMask + XkbNKN_GeometryMask (1L<<1) Notification of geometry changes wanted @@ -307,13 +307,13 @@ In this case, If the keyboard change is the result of an XkbGetKeyboardByName function call, which generates an -X_kbGetKbdByName +X_kbGetKbdByName request, req_major contains the Xkb extension base event code (see section 2.4), and req_minor contains the event code for the Xkb extension request -X_kbGetKbdByName. +X_kbGetKbdByName. device contains the device identifier for the new device, but nothing definitive can be said for diff --git a/specs/XKB/ch20.xml b/specs/XKB/ch20.xml index 75e95d09..e74dac66 100644 --- a/specs/XKB/ch20.xml +++ b/specs/XKB/ch20.xml @@ -198,7 +198,7 @@ To obtain this list, use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -406,7 +406,7 @@ is dependent on the type of component. The flags bits are defined in The symbols hints in Table 20.2 apply only to partial symbols components (those with -XkbLC_Partial +XkbLC_Partial also set); full symbols components are assumed to specify all of the pieces. @@ -417,10 +417,10 @@ describe the primary intent of the component designer and should not be simply 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 -XkbLC_AlphanumericKeys +XkbLC_AlphanumericKeys hint. In general, symbols components should set only one of the four flags ( -XkbLC_AlternateGroup +XkbLC_AlternateGroup may be combined with any of the other flags). @@ -443,19 +443,19 @@ few modifier keys as well; such mappings should set only the All Components - XkbLC_Hidden + XkbLC_Hidden Do not present to user (1L<<0) - XkbLC_Default + XkbLC_Default Default member of class (1L<<1) - XkbLC_Partial + XkbLC_Partial Partial component (1L<<2) @@ -485,31 +485,31 @@ few modifier keys as well; such mappings should set only the Symbols - XkbLC_AlphanumericKeys + XkbLC_AlphanumericKeys Bindings primarily for alphanumeric keyboard section (1L<<8) - XkbLC_ModifierKeys + XkbLC_ModifierKeys Bindings primarily for modifier keys (1L<<9) - XkbLC_KeypadKeys + XkbLC_KeypadKeys Bindings primarily for numeric keypad keys (1L<<10) - XkbLC_FunctionKeys + XkbLC_FunctionKeys Bindings primarily for function keys (1L<<11) - XkbLC_AlternateGroup + XkbLC_AlternateGroup Bindings for an alternate group (1L<<12) @@ -586,7 +586,7 @@ one, use - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd diff --git a/specs/XKB/ch21.xml b/specs/XKB/ch21.xml index fe22ce46..41f31e31 100644 --- a/specs/XKB/ch21.xml +++ b/specs/XKB/ch21.xml @@ -130,7 +130,7 @@ core indicator feedback. The particular device ID corresponding to the core keyboard feedback and the core indicator feedback may be obtained by calling XkbGetDeviceInfo and specifying -XkbUseCoreKbd +XkbUseCoreKbd as the device_spec ; the values will be returned in @@ -413,7 +413,7 @@ which, device_spec, ind_class, ind_id) --> - device ID, or XkbUseCoreKbd + device ID, or XkbUseCoreKbd @@ -521,7 +521,7 @@ XListInputDevices request. If any of the -XkbXI_IndicatorsMask +XkbXI_IndicatorsMask bits are set in which, the @@ -554,7 +554,7 @@ The are always filled in. If which contains -XkbXI_IndicatorNamesMask, +XkbXI_IndicatorNamesMask, the names_present and @@ -569,13 +569,13 @@ the If which contains -XkbXI_IndicatorStateMask, +XkbXI_IndicatorStateMask, the corresponding state field is updated. If which contains -XkbXI_IndicatorMapsMask, +XkbXI_IndicatorMapsMask, the maps_present and @@ -846,10 +846,10 @@ by Valid values for which are the inclusive OR of any of -XkbXI_IndicatorNamesMask, -XkbXI_IndicatorMapsMask, +XkbXI_IndicatorNamesMask, +XkbXI_IndicatorMapsMask, and -XkbXI_IndicatorStateMask. +XkbXI_IndicatorStateMask. @@ -895,7 +895,7 @@ The If which contains -XkbXI_IndicatorNamesMask, +XkbXI_IndicatorNamesMask, the names_present and @@ -911,13 +911,13 @@ the are updated, if which contains -XkbXI_IndicatorStateMask, +XkbXI_IndicatorStateMask, the corresponding state field is updated, and if which contains -XkbXI_IndicatorMapsMask, +XkbXI_IndicatorMapsMask, the maps_present and @@ -1389,7 +1389,7 @@ Xkb implementations are required to support key actions for the buttons of the 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 -XkbXI_ButtonActionsMask +XkbXI_ButtonActionsMask bit in the supported field of an @@ -1403,7 +1403,7 @@ If a client attempts to modify valid characteristics of a device using an 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 -XkbExtensionDeviceNotify +XkbExtensionDeviceNotify event to the client that issued the request if the client has selected to receive these events. @@ -1498,9 +1498,9 @@ The which 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: -XkbXI_ButtonActionsMask, -XkbXI_IndicatorNamesMask, -XkbXI_IndicatorMapsMask. +XkbXI_ButtonActionsMask, +XkbXI_IndicatorNamesMask, +XkbXI_IndicatorMapsMask. If the features requested to be manipulated in which are valid for the device, but the server does not support assignment of one or @@ -1523,11 +1523,11 @@ a If the -XkbXI_ButtonActionsMask +XkbXI_ButtonActionsMask 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 -XkbXI_ButtonActionsMask +XkbXI_ButtonActionsMask is set in which, the actions for all buttons specified in device_info are set to the @@ -1550,7 +1550,7 @@ If the number of buttons requested to be updated is not valid for the device, If the XkbXI_IndicatorMaps and / or -XkbXI_IndicatorNamesMask +XkbXI_IndicatorNamesMask 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 @@ -1561,9 +1561,9 @@ keyboard feedback or part of an indicator feedback. If the -XkbXI_IndicatorMapsMask +XkbXI_IndicatorMapsMask and / or -XkbXI_IndicatorNamesMask +XkbXI_IndicatorNamesMask flag is set in which, the indicator maps and / or names for all @@ -1744,7 +1744,7 @@ a BadKeyboard The Xkb extension generates -XkbExtensionDeviceNotify +XkbExtensionDeviceNotify 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. @@ -1755,7 +1755,7 @@ delivered only to the client requesting the event. To track changes to the status of input extension devices or attempts to use unsupported features of a device, select to receive -XkbExtensionDeviceNotify +XkbExtensionDeviceNotify events by calling either XkbSelectEvents or @@ -1766,11 +1766,11 @@ unsupported features of a device, select to receive To receive -XkbExtensionDeviceNotify +XkbExtensionDeviceNotify events under all possible conditions, call XkbSelectEvents and pass -XkbExtensionDeviceNotifyMask +XkbExtensionDeviceNotifyMask in both bits_to_change and @@ -1780,11 +1780,11 @@ To receive The -XkbExtensionDeviceNotify +XkbExtensionDeviceNotify event has no event details. However, you can call XkbSelectEventDetails using -XkbExtensionDeviceNotify +XkbExtensionDeviceNotify as the event_type and specifying @@ -1800,7 +1800,7 @@ The The structure for -XkbExtensionDeviceNotify +XkbExtensionDeviceNotify events is: @@ -1814,7 +1814,7 @@ typedef struct { Time time; /* server time when event generated */ int xkb_type; /* XkbExtensionDeviceNotifyEvent */ int device; /* Xkb device ID, will not be - XkbUseCoreKbd */ + XkbUseCoreKbd */ unsigned int reason; /* reason for the event */ unsigned int supported; /* mask of supported features */ unsigned int unsupported; /* unsupported features this client @@ -1830,7 +1830,7 @@ typedef struct { The -XkbExtensionDeviceNotify +XkbExtensionDeviceNotify 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 @@ -1894,7 +1894,7 @@ server. To note device changes reported in an -XkbExtensionDeviceNotify +XkbExtensionDeviceNotify event, use XkbNoteDeviceChanges. diff --git a/specs/XKB/glossary.xml b/specs/XKB/glossary.xml index d8f0ec0a..d8c7d07c 100644 --- a/specs/XKB/glossary.xml +++ b/specs/XKB/glossary.xml @@ -85,7 +85,7 @@ upon client program exit. 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 -XkbNumRequiredTypes +XkbNumRequiredTypes entries of the types field of the client map and are indexed using the following constants: @@ -93,22 +93,22 @@ are held in the first -XkbOneLevelIndex +XkbOneLevelIndex -XkbTwoLevelIndex +XkbTwoLevelIndex -XkbAlphabeticIndex +XkbAlphabeticIndex -XkbKeypadIndex +XkbKeypadIndex @@ -557,9 +557,9 @@ types are defined using the and XkbKTMapEntryRec structures. Xkb allows up to -XkbMaxKeyTypes +XkbMaxKeyTypes (255) key types to be defined, but requires at least -XkbNumRequiredTypes +XkbNumRequiredTypes (4) predefined types to be in a key map.