From b7f00ce5bcb0c00696bb82503ab548e14f04d17d Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Sun, 6 Jul 2014 20:40:18 -0700 Subject: specs/XKB: Apply to semantic tag transformations from Xlib spec Signed-off-by: Alan Coopersmith --- specs/XKB/ch01.xml | 10 +- specs/XKB/ch02.xml | 44 ++++---- specs/XKB/ch04.xml | 20 ++-- specs/XKB/ch05.xml | 44 ++++---- specs/XKB/ch06.xml | 6 +- specs/XKB/ch07.xml | 38 +++---- specs/XKB/ch08.xml | 64 ++++++------ specs/XKB/ch09.xml | 36 +++---- specs/XKB/ch10.xml | 278 ++++++++++++++++++++++++------------------------- specs/XKB/ch11.xml | 40 +++---- specs/XKB/ch12.xml | 116 ++++++++++----------- specs/XKB/ch13.xml | 96 ++++++++--------- specs/XKB/ch14.xml | 74 ++++++------- specs/XKB/ch15.xml | 128 +++++++++++------------ specs/XKB/ch16.xml | 156 +++++++++++++-------------- specs/XKB/ch17.xml | 56 +++++----- specs/XKB/ch18.xml | 48 ++++----- specs/XKB/ch19.xml | 4 +- specs/XKB/ch20.xml | 12 +-- specs/XKB/ch21.xml | 62 +++++------ specs/XKB/ch22.xml | 6 +- specs/XKB/glossary.xml | 38 +++---- 22 files changed, 688 insertions(+), 688 deletions(-) (limited to 'specs') diff --git a/specs/XKB/ch01.xml b/specs/XKB/ch01.xml index 3093d5b1..3095830d 100644 --- a/specs/XKB/ch01.xml +++ b/specs/XKB/ch01.xml @@ -11,9 +11,9 @@ cumbersome in the core X protocol. The core X protocol specifies the ways that the -Shift, -Control, and -Lock +Shift, +Control, and +Lock modifiers and the modifiers bound to the Mode_switch or Num_Lock @@ -353,9 +353,9 @@ extension has been properly initialized prior to doing any other operations. If the extension has not been properly initialized or the application, library, and server versions are incompatible, these functions return an error indication as shown in Table 1.1. Because of this test, -BadAccess +BadAccess and -BadMatch +BadMatch (due to incompatible versions) protocol errors should normally not be generated. diff --git a/specs/XKB/ch02.xml b/specs/XKB/ch02.xml index 8c0eaabb..d0f97604 100644 --- a/specs/XKB/ch02.xml +++ b/specs/XKB/ch02.xml @@ -61,11 +61,11 @@ The name of the Xkb extension is given in Most extensions to the X protocol are initialized by calling -XInitExtension +XInitExtension and passing the extension name. However, as explained in section 2.4, Xkb requires a more complex initialization sequence, and a client program should not call -XInitExtension +XInitExtension directly. @@ -147,9 +147,9 @@ run time in If the versions of the compile time and run time libraries are compatible, XkbLibraryVersion returns -True, +True, otherwise, it returns -False. +False. @@ -169,9 +169,9 @@ Call to check for the presence and compatibility of the extension in the server and to initialize the extension. Because of potential version mismatches, you cannot use the generic extension mechanism functions ( -XQueryExtension +XQueryExtension and -XInitExtension +XInitExtension ) for checking for the presence of, and initializing the Xkb extension. @@ -188,7 +188,7 @@ and a handful of audible-bell functions. You should not use any other Xkb functions if the extension is not present or is uninitialized. In general, calls to Xkb library functions made prior to initializing the Xkb extension cause -BadAccess +BadAccess protocol errors. @@ -284,9 +284,9 @@ The is present in the server. If a compatible extension is present, XkbQueryExtension returns -True +True ; otherwise, it returns -False. +False. @@ -430,7 +430,7 @@ returns If the library is compatible, XkbOpenDisplay next calls -XOpenDisplay +XOpenDisplay with the display_name. If this fails, the function returns @@ -464,7 +464,7 @@ The possible values for indicates XkbLibraryVersion returned -False. +False. @@ -533,7 +533,7 @@ disable use of the extension once a connection is established. - True means ignore the extension + True means ignore the extension @@ -543,18 +543,18 @@ disable use of the extension once a connection is established. XkbIgnoreExtension tells the X library whether to use the X Keyboard Extension on any subsequently opened X display connections. If ignore is -True, +True, the library does not initialize the Xkb extension when it opens a new display. This forces the X server to use compatibility mode and communicate with the client using only core protocol requests and events. If ignore is -False, +False, the library treats subsequent calls to -XOpenDisplay +XOpenDisplay normally and uses Xkb extension requests, events, and state. Do not explicitly use Xkb on a connection for which it is disabled. XkbIgnoreExtension returns -False +False if it was unable to apply the ignore request. @@ -644,7 +644,7 @@ An argument is out of range A name is neither a valid Atom or -None +None @@ -670,7 +670,7 @@ to the core protocol error set. This error code will be reported as the is called. When a BadKeyboard error is reported in an -XErrorEvent, +XErrorEvent, additional information is reported in the resource_id field. The most significant byte of the @@ -755,9 +755,9 @@ If they don’t match or the field is not NULL, a -BadMatch +BadMatch error is returned (either in the return value or a backfilled -Status +Status variable). Upon successful return, the dpy field of the @@ -811,9 +811,9 @@ and if the function returns successfully, the field of the XkbDescPtr argument. If they don’t match, a -BadMatch +BadMatch error is returned (either in the return value or a backfilled -Status +Status variable). diff --git a/specs/XKB/ch04.xml b/specs/XKB/ch04.xml index 2ca7b5b3..31c65bdc 100644 --- a/specs/XKB/ch04.xml +++ b/specs/XKB/ch04.xml @@ -281,7 +281,7 @@ described in the typedef struct { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ - Bool send_event; /* True => synthetically generated */ + Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ @@ -473,13 +473,13 @@ If a bit is not set in the parameter, but the corresponding bit is set in the values_for_bits parameter, a -BadMatch +BadMatch protocol error results. If an undefined bit is set in either the bits_to_change or the values_for_bits parameter, a -BadValue +BadValue protocol error results. @@ -495,9 +495,9 @@ clear them via another call to XkbSelectEvents returns -False +False if the Xkb extension has not been initilialized and -True +True otherwise. @@ -617,19 +617,19 @@ the detail in the If an invalid event type is specified, a -BadValue +BadValue protocol error results. If a bit is not set in the bits_to_change parameter, but the corresponding bit is set in the values_for_bits parameter, a -BadMatch +BadMatch protocol error results. If an undefined bit is set in either the bits_to_change or the values_for_bits parameter, a -BadValue +BadValue protocol error results. @@ -781,7 +781,7 @@ The XkbEvent structure is a union of the individual structures declared for each Xkb event type and for the core protocol -XEvent +XEvent type. Given an XkbEvent structure, you may use the @@ -817,7 +817,7 @@ typedef union _XkbEvent { This unified Xkb event type includes a normal -XEvent +XEvent as used by the core protocol, so it is straightforward for applications that use Xkb events to call the X library event functions without having to cast every reference. For example, to get the next event, you can simply declare a diff --git a/specs/XKB/ch05.xml b/specs/XKB/ch05.xml index d9e809b7..8d6fabbb 100644 --- a/specs/XKB/ch05.xml +++ b/specs/XKB/ch05.xml @@ -51,13 +51,13 @@ The state of the core pointer buttons The modifiers are -Shift, -Lock, -Control, +Shift, +Lock, +Control, and -Mod1 +Mod1 - -Mod5, +Mod5, as defined by the core protocol. A modifier can be thought of as a toggle that is either set or unset. All modifiers are initially unset. When a modifier is locked, it is set and remains set for all future key events, until it is explicitly unset. A latched modifier is set, but automatically unsets after the next key event that does not change the keyboard state. Locked and latched modifier state can be changed by keyboard activity or via Xkb extension library functions. @@ -99,9 +99,9 @@ Changing to a different group changes the keyboard state to produce characters f The pointer buttons are -Button1 +Button1 - -Button5, +Button5, as defined by the core protocol. @@ -210,9 +210,9 @@ The and lookup group are represented in the state field of core X events. The modifier state and keycode of a key event are used to determine the symbols associated with the event. For -KeyPress +KeyPress and -KeyRelease +KeyRelease events, the lookup modifiers are computed as: @@ -414,9 +414,9 @@ To lock and unlock any of the eight real keyboard modifiers, use values. XkbLockModifiers does not wait for a reply from the server. It returns -True +True if the request was sent, and -False +False otherwise. @@ -496,9 +496,9 @@ To latch and unlatch any of the eight real keyboard modifiers, use values. XkbLatchModifiers does not wait for a reply from the server. It returns -True +True if the request was sent, and -False +False otherwise. @@ -598,9 +598,9 @@ To lock the keysym group, use sends a request to the server to lock the specified group and does not wait for a reply. It returns -True +True if the request was sent and -False +False otherwise. @@ -660,9 +660,9 @@ To latch the keysym group, use XkbLatchGroup sends a request to the server to latch the specified group and does not wait for a reply. It returns -True +True if the request was sent and -False +False otherwise. @@ -912,7 +912,7 @@ The structure for typedef struct { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ - Bool send_event; /* True => synthetically generated */ + Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ int xkb_type; /* XkbStateNotify */ @@ -982,14 +982,14 @@ caused the state change, the keycode field gives the keycode of the key event, and the event_type - field is set to either KeyPress + field is set to either KeyPress or -KeyRelease. +KeyRelease. If a pointer button event caused the state change, the keycode field is zero, and the event_type - field is set to either ButtonPress - or ButtonRelease. + field is set to either ButtonPress + or ButtonRelease. Otherwise, the major and minor codes of the request that caused the state change are given in the req_major diff --git a/specs/XKB/ch06.xml b/specs/XKB/ch06.xml index b2ad5965..e6f6c4ee 100644 --- a/specs/XKB/ch06.xml +++ b/specs/XKB/ch06.xml @@ -267,7 +267,7 @@ The valid masks for XkbGetKeyboard can generate -BadAlloc +BadAlloc protocol errors. @@ -378,7 +378,7 @@ To destroy either an entire an - True => free all components and xkb + True => free all components and xkb @@ -395,7 +395,7 @@ To destroy either an entire an If free_all is -True, +True, XkbFreeKeyboard frees every non- NULL diff --git a/specs/XKB/ch07.xml b/specs/XKB/ch07.xml index aeec2592..4b1ae095 100644 --- a/specs/XKB/ch07.xml +++ b/specs/XKB/ch07.xml @@ -10,9 +10,9 @@ when the shifted and unshifted state for the numeric keypad keys. The core protocol does not provide a convenient way to determine the mapping of modifier bits (in particular -Mod1 +Mod1 through -Mod5 +Mod5 ) to keysyms such as Num_Lock and @@ -33,13 +33,13 @@ Xkb provides a set of sixteen named virtual modifiers. Each virtual modifier can be bound to any set of the real modifiers ( -Shift, -Lock, -Control, +Shift, +Lock, +Control, and -Mod1 +Mod1 - -Mod5 +Mod5 ). @@ -50,9 +50,9 @@ specify more clearly the intent of a binding. X servers do not all assign modifiers the same way — for example, Num_Lock might be bound to -Mod2 +Mod2 for one vendor and to -Mod4 +Mod4 for another. This makes it cumbersome to automatically remap the keyboard to a desired configuration without some kind of prior knowledge about the keyboard layout and bindings. With XKB, applications can use virtual modifiers to @@ -65,7 +65,7 @@ in effect. Virtual modifiers are named by converting their string name to an X -Atom +Atom and storing the Atom in the names.vmods array in an @@ -203,7 +203,7 @@ use virtual modifier mappings (see section 16.4). For example, if -Mod3 +Mod3 is bound to the Num_Lock key by the core protocol modifier mapping, and the @@ -211,7 +211,7 @@ For example, if virtual modifier is bound to they Num_Lock key by the virtual modifier mapping, -Mod3 +Mod3 is added to the set of modifiers associated with NumLock. @@ -312,9 +312,9 @@ description in does not include virtual modifier bindings, XkbVirtualModsToReal returns -False +False ; otherwise, it returns -True. +True. It is possible for a local (client-side) keyboard description (the @@ -352,7 +352,7 @@ If the NumLock virtual modifier is not bound to any real modifiers, the effective masks for these two cases are identical (that is, contain only -Shift +Shift ). When it is essential to distinguish between OneThing and Another, Xkb considers only those modifier definitions for which all @@ -393,11 +393,11 @@ bit for the virtual modifier. If server.vmods [2] contains -Mod3Mask, +Mod3Mask, then the NumLock virtual modifier is bound to the -Mod3 +Mod3 real modifier. @@ -425,10 +425,10 @@ Continuing the example, if the keyboard has a Finally, if the keyboard also used the real -Mod1 +Mod1 modifier for numeric lock operations, the modifier definition below would represent the situation where either the key bound to -Mod1 +Mod1 or the NumLock virtual modifier could be used for this purpose: diff --git a/specs/XKB/ch08.xml b/specs/XKB/ch08.xml index ffcff0a8..dded5bff 100644 --- a/specs/XKB/ch08.xml +++ b/specs/XKB/ch08.xml @@ -18,7 +18,7 @@ Furthermore, the core X implementation does not provide clients with the ability to determine what bits in the led_mask field of the -XKeyboardState +XKeyboardState map to the particular LEDs on the keyboard. For example, X does not provide a method for a client to determine what bit to set in the led_mask @@ -179,7 +179,7 @@ The effect (if any) of attempts to explicitly change the state of the indicator using the functions XkbSetControls or -XChangeKeyboardControl +XChangeKeyboardControl @@ -910,12 +910,12 @@ set in If a compatible version of the Xkb extension is not available in the server, XkbGetIndicatorState returns a -BadMatch +BadMatch error. Otherwise, it sends the request to the X server, places the state of the indicators into state_return, and returns -Success. +Success. Thus the value reported by XkbGetIndicatorState is identical to the value reported by the core protocol. @@ -1000,11 +1000,11 @@ If the XkbGetIndicatorMap can generate -BadAlloc, -BadLength, -BadMatch, +BadAlloc, +BadLength, +BadMatch, and -BadImplementation +BadImplementation errors. @@ -1130,7 +1130,7 @@ Use - backfilled with True + backfilled with True if the named indicator is real (physical) @@ -1144,12 +1144,12 @@ If the device specified by name, XkbGetNamedIndicator returns -True +True and populates the rest of the parameters with information about the indicator. Otherwise, XkbGetNamedIndicator returns -False. +False. @@ -1163,16 +1163,16 @@ bits, as well as the indicator’s index into the array of indicator maps. state_rtrn returns the current state of the named indicator ( -True +True = on, -False +False = off). map_rtrn returns the indicator map for the named indicator. In addition, if the indicator is mapped to a physical LED, the real_rtrn parameter is set to -True. +True. @@ -1190,9 +1190,9 @@ Each of the " XkbGetNamedIndicator can generate -BadAtom +BadAtom and -BadImplementation +BadImplementation errors. @@ -1303,10 +1303,10 @@ does not extinguish an indicator with and mods of -Shift +Shift if, at the time Xkb processes the request to extinguish the indicator, one of the -Shift +Shift keys is physically depressed. @@ -1525,12 +1525,12 @@ Set the indicator map for the indicator If a compatible version of the Xkb extension is not available in the server, XkbSetNamedIndicator returns -False. +False. Otherwise, it sends a request to the X server to change the indicator specified by name and returns -True. +True. @@ -1538,7 +1538,7 @@ specified by If change_state is -True, +True, and the optional parameter, state, is not @@ -1558,7 +1558,7 @@ If an indicator with the name specified by parameter tells the server whether it should create a new named indicator. If create_new is -True, +True, the server finds the first indicator that doesn’t have a name and gives it the name specified by name. @@ -1578,9 +1578,9 @@ in map. XkbSetNamedIndicator can generate -BadAtom +BadAtom and -BadImplementation +BadImplementation errors. In addition, it can also generate XkbIndicatorStateNotify (see section 8.5), @@ -1709,9 +1709,9 @@ If any bits are set in the XkbChangeIndicator s can generate -BadAtom +BadAtom and -BadImplementation +BadImplementation errors. In addition, it can also generate XkbIndicatorStateNotify and @@ -1781,7 +1781,7 @@ Both types of indicator events use the same structure: typedef struct _XkbIndicatorNotify { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ - Bool send_event; /* True => synthetically generated */ + Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ int xkb_type; /* specifies state or map notify */ @@ -1997,10 +1997,10 @@ If the XkbGetIndicatorChanges can generate -BadAlloc, -BadImplementation, +BadAlloc, +BadImplementation, and -BadMatch +BadMatch errors. @@ -2047,13 +2047,13 @@ The parameter must point to a valid keyboard description. If it doesn’t, XkbAllocIndicatorMaps returns a -BadMatch +BadMatch error. Otherwise, XkbAllocIndicatorMaps allocates and initializes the indicators member of the keyboard description record and returns -Success. +Success. If XkbAllocIndicatorMaps was unable to allocate the indicators record, it reports a Bad diff --git a/specs/XKB/ch09.xml b/specs/XKB/ch09.xml index c16800ff..594aeeca 100644 --- a/specs/XKB/ch09.xml +++ b/specs/XKB/ch09.xml @@ -437,7 +437,7 @@ To ring the bell on an X input extension device or the default keyboard, use Set percent to be the volume relative to the base volume for the keyboard as described for -XBell. +XBell. @@ -462,11 +462,11 @@ See the X input extension documentation for more information on If a compatible keyboard extension is not present in the X server, XkbDeviceBell immediately returns -False. +False. Otherwise, XkbDeviceBell rings the bell as specified for the display and keyboard device and returns -True. +True. If you have disabled the audible bell, the server does not ring the system bell, although it does generate a XkbBellNotify @@ -546,13 +546,13 @@ default keyboard: If a compatible keyboard extension isn’t present in the X server, XkbBell calls -XBell +XBell with the specified display and percent, and returns -False. +False. Otherwise, XkbBell calls @@ -574,7 +574,7 @@ and a of XkbDfltXIId, and returns -True. +True. @@ -709,17 +709,17 @@ without ringing the corresponding bell, use If a compatible keyboard extension isn’t present in the X server, XkbDeviceBellEvent immediately returns -False. +False. Otherwise, XkbDeviceBellEvent causes an XkbBellNotify event to be sent to all interested clients and returns -True. +True. Set percent to be the volume relative to the base volume for the keyboard as described for -XBell. +XBell. @@ -727,7 +727,7 @@ Set In addition, XkbDeviceBellEvent may generate -Atom +Atom protocol errors as well as XkbBellNotify events. You can call @@ -804,7 +804,7 @@ the keyboard without ringing the bell: If a compatible keyboard extension isn’t present in the X server, XkbBellEvent immediately returns -False. +False. Otherwise, XkbBellEvent calls @@ -935,15 +935,15 @@ audible bells, use XkbForceDeviceBell. If a compatible keyboard extension isn’t present in the X server, XkbForceDeviceBell immediately returns -False. +False. Otherwise, XkbForceDeviceBell rings the bell as specified for the display and keyboard device and returns -True. +True. Set percent to be the volume relative to the base volume for the keyboard as described for -XBell. +XBell. There is no name parameter because @@ -1003,13 +1003,13 @@ for audible bells, use If a compatible keyboard extension isn’t present in the X server, XkbForceBell calls -XBell +XBell with the specified display and percent and returns -False. +False. Otherwise, XkbForceBell calls @@ -1105,7 +1105,7 @@ The structure for the typedef struct _XkbBellNotify { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ - Bool send_event; /* True => synthetically generated */ + Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ int xkb_type; /* XkbBellNotify */ @@ -1117,7 +1117,7 @@ typedef struct _XkbBellNotify { unsigned int bell_id; /* X input extension feedback ID */ Atom name; /* "name" of requested bell */ Window window; /* window associated with event */ - Bool event_only; /* False -> the server did not produce a beep */ + Bool event_only; /* False -> the server did not produce a beep */ } XkbBellNotifyEvent; diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml index 02ee88a9..8531b23c 100644 --- a/specs/XKB/ch10.xml +++ b/specs/XKB/ch10.xml @@ -312,9 +312,9 @@ If the X server does not support a compatible version of Xkb or the Xkb extension has not been properly initialized, XkbChangeEnabledControls returns -False +False ; otherwise, it sends the request to the X server and returns -True. +True. @@ -438,9 +438,9 @@ To get the current values of the auto-reset controls, use with the AutoReset control attributes for this particular client. It returns -True +True if successful, and -False +False otherwise. @@ -768,11 +768,11 @@ To get the current attributes of the and interval_rtrn with them, and returns -True. +True. If a compatible version of the Xkb extension is not available in the server XkbGetAutoRepeatRate returns -False. +False. @@ -853,18 +853,18 @@ To set the attributes of the RepeatKeys control for a keyboard device, use XkbSetAutoRepeatRate does not wait for a reply; it normally returns -True. +True. Specifying a zero value for either timeout or interval causes the server to generate a -BadValue +BadValue protocol error. If a compatible version of the Xkb extension is not available in the server, XkbSetAutoRepeatRate returns -False. +False. @@ -876,21 +876,21 @@ in the server, Auto-repeat is the generation of multiple key events by a keyboard when the user presses a key and holds it down. Keyboard hardware and device-dependent X server software often implement auto-repeat by generating multiple -KeyPress +KeyPress events with no intervening -KeyRelease +KeyRelease event. The standard behavior of the X server is to generate a -KeyRelease +KeyRelease event for every -KeyPress +KeyPress event. If the keyboard hardware and device-dependent software of the X server implement auto-repeat by generating multiple -KeyPress +KeyPress events, the device-independent part of the X server by default synthetically generates a -KeyRelease +KeyRelease event after each -KeyPress +KeyPress event. This provides predictable behavior for X clients, but does not allow those clients to detect the fact that a key is auto-repeating. @@ -902,13 +902,13 @@ Xkb allows clients to request If a client requests and the server supports DetectableAutorepeat, Xkb generates -KeyRelease +KeyRelease events only when the key is physically released. If DetectableAutorepeat is not supported or has not been requested, the server synthesizes a -KeyRelease +KeyRelease event for each repeating -KeyPress +KeyPress event it generates. @@ -975,7 +975,7 @@ use - backfilled True if + backfilled True if DetectableAutorepeat supported @@ -992,21 +992,21 @@ use is not NULL, it backfills supported_rtrn with -True +True if the server supports DetectableAutorepeat, and -False +False otherwise. XkbGetDetectableAutorepeat returns the current state of DetectableAutorepeat for the requesting client: -True +True if DetectableAutorepeat is set, and -False +False otherwise. @@ -1052,7 +1052,7 @@ they have requested otherwise. - True => set + True => set DetectableAutorepeat @@ -1063,7 +1063,7 @@ they have requested otherwise. - backfilled True if + backfilled True if DetectableAutorepeat supported @@ -1078,11 +1078,11 @@ they have requested otherwise. on for the current client if detectable is -True, +True, and off it detectable is -False +False ; it then waits for a reply. If supported_rtrn is not @@ -1091,21 +1091,21 @@ and off it backfills supported_rtrn with -True +True if the server supports DetectableAutorepeat, and -False +False if it does not. XkbSetDetectableAutorepeat returns the current state of DetectableAutorepeat for the requesting client: -True +True if DetectableAutorepeat is set, and -False +False otherwise. @@ -1197,9 +1197,9 @@ When are enabled, all keys with MouseKeys actions bound to them generate core pointer events instead of normal -KeyPress +KeyPress and -KeyRelease +KeyRelease events. @@ -1526,7 +1526,7 @@ Holding down a shift key by itself for eight seconds toggles the Pressing and releasing the left or right -Shift +Shift key five times in a row, without any intervening key events and with less than 30 seconds delay between consecutive presses, toggles the state of the StickyKeys @@ -1709,12 +1709,12 @@ which is a field in the structure (see section 10.8). XkbGetAccessXTimeout returns -True +True if successful; if a compatible version of the Xkb extension is not available in the server, XkbGetAccessXTimeout returns -False. +False. @@ -1850,11 +1850,11 @@ for the AccessXTimeout control to the server. It does not wait for a reply, and normally returns -True. +True. If a compatible version of the Xkb extension is not available in the server, XkbSetAccessXTimeout returns -False. +False. @@ -2015,7 +2015,7 @@ The server can generate typedef struct { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ - Bool send_event; /* True => synthetically generated */ + Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ int xkb_type; /* XkbAccessXNotify */ @@ -2208,10 +2208,10 @@ locking, or unlocking of modifiers using StickyKeys generates XkbStateNotify - events as described in section 5.4. Repeating keys generate normal -KeyPress + events as described in section 5.4. Repeating keys generate normal +KeyPress and -KeyRelease +KeyRelease events, though the auto-repeat can be detected using DetectableAutorepeat (see section 10.3.3). Finally, @@ -2317,12 +2317,12 @@ with the delay attribute. XkbGetSlowKeysDelay returns -True +True if successful; if a compatible version of the Xkb extension is not available in the server, XkbGetSlowKeysDelay returns -False. +False. @@ -2388,7 +2388,7 @@ To set the SlowKeys control to the server. It does not wait for a reply, and normally returns -True. +True. Specifying a value of 0 for the @@ -2396,12 +2396,12 @@ Specifying a value of parameter causes XkbSetSlowKeys to generate a -BadValue +BadValue protocol error. If a compatible version of the Xkb extension is not available in the server XkbSetSlowKeysDelay returns -False. +False. @@ -2499,12 +2499,12 @@ with the delay attribute. XkbGetBounceKeysDelay returns -True +True if successful; if a compatible version of the Xkb extension is not available in the server XkbGetSlowKeysDelay returns -False. +False. @@ -2570,7 +2570,7 @@ To set the BounceKeys control to the server. It does not wait for a reply and normally returns -True. +True. Specifying a value of zero for the @@ -2578,12 +2578,12 @@ for the parameter causes XkbSetBounceKeysDelay to generate a -BadValue +BadValue protocol error. If a compatible version of the Xkb extension is not available in the server, XkbSetBounceKeysDelay returns -False. +False. @@ -2593,7 +2593,7 @@ in the server, Some people find it difficult or even impossible to press two keys at once. For example, a one-fingered typist or someone using a mouth stick cannot press the -Shift +Shift and 1 keys at the same time. The @@ -2604,7 +2604,7 @@ With the user can first press a modifier, release it, then press another key. For example, to get an exclamation point on a PC-style keyboard, the user can press the -Shift +Shift key, release it, and then press the 1 key. @@ -2625,39 +2625,39 @@ it one more time. When a modifier is latched, it becomes unlatched when the user presses a nonmodifier key or a pointer button. For instance, to enter the sequence -Shift +Shift + -Control +Control + Z the user could press and release the -Shift +Shift key to latch it, then press and release the -Control +Control key to latch it, and finally press and release the Z key. Because the -Control +Control key is a modifier key, pressing it does not unlatch the -Shift +Shift key. Thus, after the user presses the -Control +Control key, both the -Shift +Shift and -Control +Control modifiers are latched. When the user presses the Z key, the effect is as though the user had pressed -Shift +Shift + -Control +Control + Z. In addition, because the Z key is not a modifier key, the -Shift +Shift and -Control +Control modifiers are unlatched. @@ -2668,9 +2668,9 @@ button the user presses until the user unlocks it or it is unlocked programmatically. For example, to enter the sequence ("XKB") on a keyboard where ‘(’ is a shifted ‘9’, ‘)’ is a shifted ‘0’, and ‘"’ is a shifted single quote, the user could press and release the -Shift +Shift key twice to lock the -Shift +Shift modifier. Then, when the user presses the 9, ‘, @@ -2681,9 +2681,9 @@ is a shifted single quote, the user could press and release the and 0 keys in sequence, it generates ("XKB"). To unlock the -Shift +Shift modifier, the user can press and release the -Shift +Shift key. @@ -2802,12 +2802,12 @@ with a mask indicating whether the individual XkbGetStickyKeysOptions returns -True +True if successful; if a compatible version of the Xkb extension is not available in the server XkbGetStickyKeysOptions returns -False. +False. @@ -2883,7 +2883,7 @@ To set the StickyKeys control to the server. It does not wait for a reply and normally returns -True. +True. The valid bits to use for both the mask and @@ -2902,7 +2902,7 @@ The valid bits to use for both the If a compatible version of the Xkb extension is not available in the server, XkbSetStickyKeysOptions returns -False. +False. @@ -3036,9 +3036,9 @@ The IgnoreLockMods control specifies modifiers that should be excluded from grab calculations. These modifiers are also not reported in any core events except -KeyPress +KeyPress and -KeyRelease +KeyRelease events that do not activate a passive grab and that do not occur while a grab is active. @@ -3175,12 +3175,12 @@ added and removed from the server’s and real_values consist of any combination of the eight core modifier bits: -ShiftMask, -LockMask, -ControlMask, -Mod1Mask +ShiftMask, +LockMask, +ControlMask, +Mod1Mask - -Mod5Mask. +Mod5Mask. affect_virtual and virtual_values @@ -3206,9 +3206,9 @@ affect_virtual virtual_values. XkbSetIgnoreLockMods does not wait for a reply from the server. It returns -True +True if the request was sent, and -False +False otherwise. @@ -3378,12 +3378,12 @@ selected by both and real_values consist of any combination of the eight core modifier bits: -ShiftMask, -LockMask, -ControlMask, -Mod1Mask +ShiftMask, +LockMask, +ControlMask, +Mod1Mask - -Mod5Mask. +Mod5Mask. affect_virtual and virtual_values @@ -3404,9 +3404,9 @@ affect_virtual virtual_values. XkbSetServerInternalMods does not wait for a reply from the server. It returns -True +True if the request was sent and -False +False otherwise. @@ -3847,9 +3847,9 @@ The individual fields of the ). It specifies the mouse button number to use for keyboard simulated mouse button operations. Its value should be one of the core symbols -Button1 +Button1 - -Button5. +Button5. @@ -3930,12 +3930,12 @@ its four low-order bits specify the index of the group to use. control (see section 10.7.4). It specifies modifiers to be consumed in the server and not passed on to clients when events are reported. Valid values consist of any combination of the eight core modifier bits: -ShiftMask, -LockMask, -ControlMask, -Mod1Mask +ShiftMask, +LockMask, +ControlMask, +Mod1Mask - -Mod5Mask. +Mod5Mask. @@ -3950,12 +3950,12 @@ consist of any combination of the eight core modifier bits: control (see section 10.7.2). It specifies modifiers to be ignored in grab calculations. Valid values consist of any combination of the eight core modifier bits: -ShiftMask, -LockMask, -ControlMask, -Mod1Mask +ShiftMask, +LockMask, +ControlMask, +Mod1Mask - -Mod5Mask. +Mod5Mask. @@ -4234,9 +4234,9 @@ accepts a pointer to an structure and a feedback option from the table above. If both the AccessXFeedback control and the specified feedback option are enabled, the macro returns -True. +True. Otherwise it returns -False. +False. @@ -4269,7 +4269,7 @@ The field mirrors the auto_repeats field of the core protocol -XKeyboardState +XKeyboardState structure: changing the auto_repeats field automatically changes @@ -4281,7 +4281,7 @@ delay and rate, use If the per_key_repeat were not in this structure, you would have to call both -XGetKeyboardControl +XGetKeyboardControl and XkbGetControls to get this information. The bits correspond to keycodes. The first seven keys @@ -4396,11 +4396,11 @@ If XkbGetControls returns -Success +Success if successful; otherwise, it returns -BadAlloc +BadAlloc if it cannot obtain sufficient storage, -BadMatch +BadMatch if xkb is @@ -4408,7 +4408,7 @@ If or which is empty, or -BadImplementation. +BadImplementation. @@ -4529,9 +4529,9 @@ the server does not support a compatible version of Xkb, or the Xkb extension has not been properly initialized, XkbSetControls returns -False. +False. Otherwise, it sends the request to the X server and returns -True. +True. @@ -4601,7 +4601,7 @@ changes, to be propagated to the server. The typedef struct _XkbControlsChanges { unsigned int changed_ctrls; /* bits indicating changed control data */ unsigned int enabled_ctrls_changes; /* bits indicating enabled/disabled controls */ - Bool num_groups_changed; /* True if + Bool num_groups_changed; /* True if number of keyboard groups changed */ } XkbControlsChangesRec,*XkbControlsChangesPtr; @@ -4624,7 +4624,7 @@ XkbControlsRec Data Fields" column in Table 10.6 have been modified. The enabled_ctrls field have changed. If the number of keyboard groups has changed, the num_groups_changed - field is set to True. + field is set to True. @@ -4745,7 +4745,7 @@ The structure for the typedef struct { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ - Bool send_event; /* True => synthetically generated */ + Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ int xkb_type; /* XkbCompatMapNotify */ @@ -4805,13 +4805,13 @@ and the value is the same as the major extension opcode. Otherwise, event_type is set to the type of event that caused the change (one of -KeyPress, -KeyRelease, +KeyPress, +KeyRelease, DeviceKeyPress, DeviceKeyRelease, -ButtonPress +ButtonPress or -ButtonRelease +ButtonRelease ), and req_major and @@ -4819,8 +4819,8 @@ and the are undefined. If event_type is -KeyPress, -KeyRelease, +KeyPress, +KeyRelease, DeviceKeyPress, or DeviceKeyRelease, @@ -4829,9 +4829,9 @@ the field is set to the key that caused the change. If event_type is -ButtonPress +ButtonPress or -ButtonRelease, +ButtonRelease, keycode contains the button number. @@ -4993,12 +4993,12 @@ results into the XkbGetControlsChanges returns -Success +Success if successful and can generate -BadAlloc, -BadImplementation, +BadAlloc, +BadImplementation, and -BadMatch +BadMatch errors. @@ -5062,25 +5062,25 @@ allocate one by calling field of the xkb parameter, initializes all fields to zero, and returns -Success. +Success. If the ctrls field is not NULL, XkbAllocControls simply returns -Success. +Success. If xkb is NULL, XkbAllocControls reports a -BadMatch +BadMatch error. If the ctrls field could not be allocated, it reports a -BadAlloc +BadAlloc error. @@ -5146,7 +5146,7 @@ structure, use - True => free everything + ctrls itself + True => free everything + ctrls itself @@ -5175,7 +5175,7 @@ The If free_all is -True, +True, XkbFreeControls frees every non- NULL @@ -5252,9 +5252,9 @@ To get the current values of the with the per-client control attributes for this particular client. It returns -True +True if successful, and -False +False otherwise. @@ -5325,9 +5325,9 @@ by OR-ing the values together. XkbSetPerClientControls backfills value with the per-client control attributes for this particular client. It returns -True +True if successful, and -False +False otherwise. diff --git a/specs/XKB/ch11.xml b/specs/XKB/ch11.xml index 8c71814b..6021ff9b 100644 --- a/specs/XKB/ch11.xml +++ b/specs/XKB/ch11.xml @@ -36,7 +36,7 @@ Controls affecting event delivery There are two types of string lookups performed by -XLookupString. +XLookupString. The first type involves translating a single keycode into a string; the controls in the first category affect this type of lookup. The second type involves translating a series of keysyms into a string; the controls in the @@ -78,11 +78,11 @@ affecting simple string lookups are: If the ForceLatin1Lookup control is enabled, -XLookupString +XLookupString only returns strings using the Latin1 character set. If ForceLatin1Lookup is not enabled, -XLookupString +XLookupString can return characters that are not in the Latin1 set. By default, this control is disabled, allowing characters outside of the Latin1 set to be returned. @@ -94,7 +94,7 @@ is disabled, allowing characters outside of the Latin1 set to be returned. Simple string lookups in -XLookupString +XLookupString involve two different translation phases. The first phase translates raw device keycodes to individual keysyms. The second phase attempts to map the resulting keysym into a string of one or more characters. In the first phase, @@ -107,12 +107,12 @@ level for a key. The ConsumeLookupMods control determines whether or not -XLookupString +XLookupString consumes the modifiers it uses during the first phase of processing (mapping a keycode to a keysym). When a modifier is consumed, it is effectively removed from the working copy of the keyboard state information -XLookupString +XLookupString is using and appears to be unset for the remainder of the processing. @@ -121,21 +121,21 @@ working copy of the keyboard state information If the ConsumeLookupMods control is enabled, -XLookupString +XLookupString does not use the modifiers used to translate the keycode of the event to a keysym when it is determining the string associated with a keysym. For example, assume the keymap for the ‘A’ key only contains the shift modifier and the ConsumeLookupMods control is enabled. If a user presses the -Shift +Shift key and the A key while the Num_Lock key is locked, -XLookupString +XLookupString uses the -Shift +Shift modifier when mapping the keycode for the ‘a’ key to the keysym for ‘A’; subsequently, it only uses the NumLock @@ -147,10 +147,10 @@ assume the keymap for the ‘A’ key only contains the shift modifier and the If the ConsumeLookupMods control is not enabled, -XLookupString +XLookupString uses all of the event modifiers to determine the string associated with a keysym. This behavior mirrors the behavior of -XLookupString +XLookupString in the core implementation. @@ -171,11 +171,11 @@ refer to Chapter 12. The AlwaysConsumeShiftAndLock control, if enabled, forces -XLookupString +XLookupString to consume the -Shift +Shift and -Lock +Lock modifiers when processing all keys, even if the definition for the key type does not specify these modifiers. The AlwaysConsumeShiftAndLock @@ -190,10 +190,10 @@ does not specify these modifiers. The The second type of string lookup performed by -XLookupString +XLookupString involves translating a series of keysyms into a string. Because these lookups can involve more than one key event, they require -XLookupString +XLookupString to retain some state information between successive calls. The process of mapping a series of keysyms to a string is known as compose processing. @@ -229,7 +229,7 @@ translation, some decision must be made about what to do with the key events that were processed while attempting the compose. The ConsumeKeysOnComposeFail control allows a client to specify what happens with the key events -XLookupString +XLookupString has been considering when it reaches a dead end in a compose sequence. @@ -331,7 +331,7 @@ When Xkb is initialized, it implicitly forces requests for NewKeyboardNotify events. These events may be used by the Xkb library extension internally; they are normally translated into core protocol -MappingNotify +MappingNotify events before being passed to the client. While delivering the event to the client is appropriate in most cases, it is not appropriate for some clients that maintain per-key data structures. This is because once the server has sent @@ -349,7 +349,7 @@ The control, if enabled, prevents Xkb from mapping NewKeyboardNotify events to core -MappingNotify +MappingNotify events and passing them to the client. The control is initially disabled. diff --git a/specs/XKB/ch12.xml b/specs/XKB/ch12.xml index 95dcf820..3506cbea 100644 --- a/specs/XKB/ch12.xml +++ b/specs/XKB/ch12.xml @@ -12,7 +12,7 @@ several core X library functions. When support for Xkb is built into the X library, the -XOpenDisplay +XOpenDisplay function looks for a compatible version of Xkb on the server. If it finds a compatible version, it initializes the extension and enables implicit support @@ -29,7 +29,7 @@ includes ways to control or disable it. Because -XOpenDisplay +XOpenDisplay initializes Xkb, some events contain an Xkb description of the keyboard state instead of that normally used by the core protocol. See section 17.1.1 for more information about the differences between Xkb keyboard state and that reported @@ -44,14 +44,14 @@ by the core protocol. When Xkb is missing or disabled, the X library tracks changes to the keyboard mapping using -MappingNotify +MappingNotify events. Whenever the keyboard mapping is changed, the server sends all clients a -MappingNotify +MappingNotify event to report the change. When a client receives a -MappingNotify +MappingNotify event, it is supposed to call -XRefreshKeyboardMapping +XRefreshKeyboardMapping to update the keyboard description used internally by the X library. @@ -66,7 +66,7 @@ receives either event, it should call XkbRefreshKeyboardMapping to update the keyboard description used internally by the X library. To avoid duplicate events, the X server does not send core protocol -MappingNotify +MappingNotify events to a client that has selected for XkbMapNotify events. @@ -79,11 +79,11 @@ The implicit support for Xkb selects for 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 -MappingNotify +MappingNotify events over the wire. Clients that were not written with Xkb in mind do not recognize or properly handle the new Xkb events, so the implicit support converts them to -MappingNotify +MappingNotify events that report approximately the same information, unless the client has explicitly selected for the Xkb version of the event. @@ -119,12 +119,12 @@ The following X library functions are modified by Xkb: - XKeycodeToKeysym - XKeysymToKeycode - XLookupKeysym - XLookupString - XRefreshKeyboardMapping - XRebindKeysym + XKeycodeToKeysym + XKeysymToKeycode + XLookupKeysym + XLookupString + XRefreshKeyboardMapping + XRebindKeysym @@ -139,7 +139,7 @@ clients. The -XKeycodeToKeysym +XKeycodeToKeysym function reports the keysym associated with a particular index for a single key. The index specifies a column of symbols in the core keyboard mapping (that is, as reported by the core protocol @@ -152,7 +152,7 @@ the differences. The -XKeysymToKeycode +XKeysymToKeycode function reports a keycode to which a particular keysym is bound. When Xkb is missing or disabled, this function looks in each column of the core keyboard mapping in turn and returns the lowest numbered key that matches in the lowest @@ -163,7 +163,7 @@ symbols instead. The -XLookupKeysym +XLookupKeysym function reports the symbol in a specific column of the key associated with an event. Whether or not Xkb is present, the column specifies an index into the core symbol mapping. @@ -172,20 +172,20 @@ core symbol mapping. The -XLookupString +XLookupString function reports the symbol and string associated with a key event, taking into account the keycode and keyboard state as reported in the event. When Xkb is disabled or missing, -XLookupString +XLookupString uses the rules specified by the core protocol and reports only ISO Latin-1 characters. When Xkb is present, -XLookupString +XLookupString uses the explicit keyboard group, key types, and rules specified by Xkb. When Xkb is present, -XLookupString +XLookupString is allowed, but not required, to return strings in character sets other than ISO Latin-1, depending on the current locale. If any key bindings are defined, -XLookupString +XLookupString does not use any consumed modifiers (see sections 11.1.2 and 15.2) to determine matching bindings. @@ -193,30 +193,30 @@ determine matching bindings. The -XRefreshKeyboardMapping +XRefreshKeyboardMapping function updates the X library’s internal representation of the keyboard to reflect changes reported via -MappingNotify +MappingNotify 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 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 +XRefreshKeyboardMapping updates the entire keyboard description. The -XRebindKeysym +XRebindKeysym function associates a string with a keysym and a set of modifiers. Xkb does not directly change this function, but it does affect the way that the state reported in the event is compared to the state specified to -XRebindKeysym. +XRebindKeysym. When Xkb is missing or disabled, -XLookupString +XLookupString returns the specified string if the modifiers in the event exactly match the modifiers from this call. When Xkb is present, any modifiers used to determine the keysym are consumed and are not used to look up the string. @@ -302,7 +302,7 @@ particular key on the core keyboard. If are out of range for the specified key, XkbKeycodeToKeysym returns -NoSymbol. +NoSymbol. @@ -360,15 +360,15 @@ If no modifiers are bound to the keysym, XkbKeysymToModifiers returns zero; otherwise, it returns the inclusive OR of zero or more of the following: -ShiftMask, -ControlMask, -LockMask, -Mod1Mask, -Mod2Mask, -Mod3Mask, -Mod4Mask, +ShiftMask, +ControlMask, +LockMask, +Mod1Mask, +Mod2Mask, +Mod3Mask, +Mod4Mask, and -Mod5Mask. +Mod5Mask. @@ -454,7 +454,7 @@ Use XkbLookupKeySym is the equivalent of the core -XLookupKeySym +XLookupKeySym function. For the core keyboard, given a keycode key and an Xkb state @@ -467,13 +467,13 @@ Use The state parameter is the state from a -KeyPress +KeyPress or -KeyRelease +KeyRelease event. XkbLookupKeySym returns -True +True if it succeeds. @@ -485,7 +485,7 @@ Use XRebindKeySym. XkbLookupKeyBinding is the equivalent of the core -XLookupString +XLookupString function. @@ -575,7 +575,7 @@ Use -XRebindKeysym +XRebindKeysym binds an ASCII string to a specified keysym, so that the string and keysym are returned when the key is pressed and a specified list of modifiers are also being held down. @@ -743,7 +743,7 @@ To update the keyboard description that is internal to the X library, use XkbRefreshKeyboardMapping is the Xkb equivalent of the core -XRefreshKeyboardMapping +XRefreshKeyboardMapping function. It requests that the X server send the current key mapping information to this client. A client usually invokes XkbRefreshKeyboardMapping @@ -752,9 +752,9 @@ information to this client. A client usually invokes event. XkbRefreshKeyboardMapping returns -Success +Success if it succeeds and -BadMatch +BadMatch if the event is not an Xkb event. @@ -849,14 +849,14 @@ To translate a keycode to a key symbol and modifiers, use is backfilled with the modifiers consumed by the translation process. mods is a bitwise inclusive OR of the legal modifier masks: -ShiftMask, -LockMask, -ControlMask, -Mod1Mask, -Mod2Mask, -Mod3Mask, -Mod4Mask, -Mod5Mask. +ShiftMask, +LockMask, +ControlMask, +Mod1Mask, +Mod2Mask, +Mod3Mask, +Mod4Mask, +Mod5Mask. The AlwaysConsumeShiftAndLock library control (see section 11.1.3), if enabled, causes @@ -864,11 +864,11 @@ The to consume shift and lock. XkbTranslateKeyCode returns -True +True if the translation resulted in a keysym, and -False +False if it resulted in -NoSymbol. +NoSymbol. diff --git a/specs/XKB/ch13.xml b/specs/XKB/ch13.xml index e6a8c639..4f3b16b9 100644 --- a/specs/XKB/ch13.xml +++ b/specs/XKB/ch13.xml @@ -854,8 +854,8 @@ typedef struct _XkbRow { /* row in a section */ short left; /* left coordinate of row origin, relative to section’s origin */ unsigned short num_keys; /* number of keys in the keys array */ unsigned short sz_keys; /* size of the keys array */ - int vertical; /* True =>vertical row, - False =>horizontal row */ + int vertical; /* True =>vertical row, + False =>horizontal row */ XkbKeyPtr keys; /* array of keys in the row*/ XkbBoundsRec bounds; /* bounding box for the row */ } XkbRowRec, *XkbRowPtr; @@ -1119,14 +1119,14 @@ To load a keyboard geometry if you already have the keyboard description, use XkbGetGeometry can return -BadValue, -BadImplementation, -BadName, -BadAlloc, +BadValue, +BadImplementation, +BadName, +BadAlloc, or -BadLength +BadLength errors or -Success +Success if it succeeds. @@ -1188,7 +1188,7 @@ description from this database by name, use XkbGetNamedGeometry can return -BadName +BadName if the name cannot be found. @@ -1284,13 +1284,13 @@ the top surface is defined as the last outline in the ’s array of outlines. XkbComputeShapeTop returns -False +False if shape is NULL or if there are no outlines for the shape; otherwise, it returns -True. +True. @@ -1341,13 +1341,13 @@ shape, use XkbComputeShapeBounds. those outlines. XkbComputeShapeBounds returns -False +False if shape is NULL or if there are no outlines for the shape; otherwise, it returns -True. +True. @@ -1411,11 +1411,11 @@ To update the bounding box of a row, use XkbComputeRowBoundsXkbComputeRowBounds returns -False +False if any of the arguments is NULL ; otherwise, it returns -True. +True. @@ -1468,11 +1468,11 @@ that section. To update the bounding box of a section, use and updates the bounding box of that section so that it contains all rows. XkbComputeSectionBounds returns -False +False if any of the arguments is NULL ; otherwise, it returns -True. +True. @@ -2453,11 +2453,11 @@ functions increase num_ * to zero). These functions return -Success +Success if they succeed, -BadAlloc +BadAlloc if they are not able to allocate space, or -BadValue +BadValue if a parameter is not as expected. @@ -2573,7 +2573,7 @@ To free geometry outlines, use - True => all outlines are freed + True => all outlines are freed @@ -2581,7 +2581,7 @@ To free geometry outlines, use If free_all is -True, +True, all outlines are freed regardless of the value of first or count. Otherwise, count outlines are freed beginning with the one specified by first. @@ -2696,7 +2696,7 @@ To free geometry keys, use - True => all keys are freed + True => all keys are freed @@ -2704,7 +2704,7 @@ To free geometry keys, use If free_all is -True, +True, all keys are freed regardless of the value of first or count. Otherwise, count keys are freed beginning with the one specified by first. @@ -2825,7 +2825,7 @@ To free geometry properties, use - True => all properties are freed + True => all properties are freed @@ -2833,7 +2833,7 @@ To free geometry properties, use If free_all is -True, +True, all properties are freed regardless of the value of first or count. Otherwise, count properties are freed beginning with the one specified by first. @@ -2951,7 +2951,7 @@ To free geometry key aliases, use - True => all key aliases are freed + True => all key aliases are freed @@ -2959,7 +2959,7 @@ To free geometry key aliases, use If free_all is -True, +True, all aliases in the top level of the specified geometry geom are freed regardless of the value of first or count. Otherwise, count aliases @@ -3081,7 +3081,7 @@ To free geometry colors, use - True => all colors are freed + True => all colors are freed @@ -3089,7 +3089,7 @@ To free geometry colors, use If free_all is -True, +True, all colors are freed regardless of the value of first or count. Otherwise, count colors are freed beginning with the one specified by first. @@ -3207,7 +3207,7 @@ To free points in a outline, use - True => all points are freed + True => all points are freed @@ -3215,7 +3215,7 @@ To free points in a outline, use If free_all is -True, +True, all points are freed regardless of the value of first and count. Otherwise, the number of points specified by count are freed, beginning with the point specified by first in the specified outline. @@ -3334,7 +3334,7 @@ To free geometry shapes, use - True => all shapes are freed + True => all shapes are freed @@ -3342,7 +3342,7 @@ To free geometry shapes, use If free_all is -True, +True, all shapes in the geometry are freed regardless of the values of first and count. Otherwise, count shapes are freed, beginning with the shape specified by first. @@ -3458,7 +3458,7 @@ To free geometry sections, use - True => all sections are freed + True => all sections are freed @@ -3466,7 +3466,7 @@ To free geometry sections, use If free_all is -True, +True, all sections are freed regardless of the value of first and count. Otherwise, the number of sections specified by count are freed, beginning with the section specified by first in the specified geometry. @@ -3582,7 +3582,7 @@ To free rows in a section, use - True => all rows are freed + True => all rows are freed @@ -3590,7 +3590,7 @@ To free rows in a section, use If free_all is -True, +True, all rows are freed regardless of the value of first and count. Otherwise, the number of rows specified by count are freed, beginning with the row specified by first in the specified section. @@ -3706,7 +3706,7 @@ To free rows in an section, use - True => all overlays are freed + True => all overlays are freed @@ -3714,7 +3714,7 @@ To free rows in an section, use If free_all is -True, +True, all overlays are freed regardless of the value of first and count. Otherwise, the number of overlays specified by count are freed, beginning with the overlay specified by first in the specified section. @@ -3830,7 +3830,7 @@ To free rows in an overlay, use - True => all rows are freed + True => all rows are freed @@ -3838,7 +3838,7 @@ To free rows in an overlay, use If free_all is -True, +True, all rows are freed regardless of the value of first and count. Otherwise, the number of rows specified by count are freed, beginning with the row specified by first in the specified overlay. @@ -3954,7 +3954,7 @@ To free keys in an overlay row, use - True => all keys are freed + True => all keys are freed @@ -3962,7 +3962,7 @@ To free keys in an overlay row, use If free_all is -True, +True, all keys are freed regardless of the value of first and count. Otherwise, the number of keys specified by count are freed, beginning with the key specified by first in the specified row. @@ -4117,7 +4117,7 @@ To free geometry doodads, use - True => all doodads are freed + True => all doodads are freed @@ -4127,7 +4127,7 @@ To free geometry doodads, use If free_all is -True, +True, all doodads in the array are freed, regardless of the value of count. Otherwise, count doodads are freed. @@ -4234,7 +4234,7 @@ To free an entire geometry, use - True => the entire geometry is freed. + True => the entire geometry is freed. @@ -4256,7 +4256,7 @@ is freed. The valid values for which are: If free_all is -True, +True, the entire geometry is freed regardless of the value of which. Otherwise, the portions of the geometry specified by which are freed. diff --git a/specs/XKB/ch14.xml b/specs/XKB/ch14.xml index 2e769a4d..bdb912d5 100644 --- a/specs/XKB/ch14.xml +++ b/specs/XKB/ch14.xml @@ -79,7 +79,7 @@ starting at one. Shift level is derived from the modifier state, but not necessarily in the same way for all keys. For example, the -Shift +Shift modifier selects shift level 2 on most keys, but for keypad keys the modifier bound to Num_Lock @@ -123,16 +123,16 @@ and the symbol for shift level two is The standard interpretation rules for the core X keymap only allow clients to access keys such as the one shown in Figure 14.1. That is, clients using the standard interpretation rules can only access one of four keysyms for any given -KeyPress +KeyPress event — two different symbols in two different groups. In general, the -Shift +Shift modifier, the -Lock +Lock modifier, and the modifier bound to the Num_Lock key are used to change between shift level 1 and shift level 2. To switch @@ -190,7 +190,7 @@ type and specifies the modifier combinations necessary to access each level. For example, Xkb allows key types where the -Control +Control modifier can be used to access the shift level two of a key. Key types are in the client map component and are described in detail in section 15.2. @@ -327,16 +327,16 @@ XkbGetMap returns NULL. When unsuccessful, one of the following protocol errors is also generated: -BadAlloc +BadAlloc (unable to allocate the XkbDescRec structure), -BadValue +BadValue (some mask bits in which are undefined), or -BadImplementation +BadImplementation (a compatible version of the Xkb extension is not available in the server). To free the returned data, use XkbFreeClientMap. @@ -562,19 +562,19 @@ components of the reply, and then returns. If successful, XkbGetUpdatedMap returns -Success. +Success. If unsuccessful, XkbGetUpdatedMap returns one of the following: -BadAlloc +BadAlloc (unable to allocate a component in the XkbDescRec structure), -BadValue +BadValue (some mask bits in which are undefined), -BadImplementation +BadImplementation (a compatible version of the Xkb extension is not available in the server or the reply from the server was invalid). @@ -671,15 +671,15 @@ If any components specified by parameter, XkbSetMap returns -False. +False. Otherwise, it sends the update request to the server and returns -True. +True. XkbSetMap can generate -BadAlloc, -BadLength, +BadAlloc, +BadLength, and -BadValue +BadValue protocol errors. @@ -940,19 +940,19 @@ If any components specified by parameter, XkbChangeMap returns -False. +False. Otherwise, it sends a request to the server and returns -True. +True. XkbChangeMap can generate -BadAlloc, -BadLength, +BadAlloc, +BadLength, and -BadValue +BadValue protocol errors. @@ -1013,7 +1013,7 @@ The structure for typedef struct { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ - Bool send_event; /* True => synthetically generated */ + Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ int xkb_type; /* XkbMapNotify */ @@ -1186,7 +1186,7 @@ field specifies the number of entries to preallocate for the field is less than XkbNumRequiredTypes (see section 15.2.1), returns -BadValue. +BadValue. @@ -1248,7 +1248,7 @@ of entries necessary for parameter. If they are not valid, XkbAllocClientMap returns -BadValue. +BadValue. @@ -1277,12 +1277,12 @@ request. The only exception is the If XkbAllocClientMap is successful, it returns -Success. +Success. Otherwise, it can return either -BadMatch, -BadAlloc, +BadMatch, +BadAlloc, or -BadValue +BadValue errors. @@ -1338,7 +1338,7 @@ To free memory used by the client map member of an - True + True => free all client components and map itself @@ -1365,7 +1365,7 @@ The If free_all is -True, +True, which is ignored; XkbFreeClientMap @@ -1537,7 +1537,7 @@ field of the server map. parameter must be legal values. If they are not valid, XkbAllocServerMap returns -BadValue. +BadValue. @@ -1565,11 +1565,11 @@ field accordingly. If XkbAllocServerMap is successful, it returns -Success. +Success. Otherwise, it can return either -BadMatch +BadMatch or -BadAlloc +BadAlloc errors. @@ -1625,7 +1625,7 @@ To free memory used by the server member of an - True + True => free all server map components and server itself @@ -1647,7 +1647,7 @@ The inclusive OR of the masks listed in Table 14.4. If free_all is -True, +True, which is ignored and XkbFreeServerMap diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml index 9a1245d9..5f93bade 100644 --- a/specs/XKB/ch15.xml +++ b/specs/XKB/ch15.xml @@ -93,7 +93,7 @@ typedef struct { /* Key Type */ typedef struct { /* Modifiers for a key type */ - Bool active; /* True => entry + Bool active; /* True => entry active when determining shift level */ unsigned char level; /* shift level if modifiers match mods */ XkbModsRec mods; /* mods needed for this level to be @@ -161,13 +161,13 @@ Each map entry contains an field should be considered when determining shift level. If active is -False, +False, this map entry is ignored. If active is -True, +True, the level field of the @@ -319,8 +319,8 @@ The name of the example key type is "ALPHATHREE," and the modifiers it pays attention to are -Shift, -Lock, +Shift, +Lock, and the virtual modifier LevelThree. There are three shift levels. The name of shift level one is "Base," the name @@ -337,14 +337,14 @@ Given the combination of the map entries. The first map entry specifies that shift level one is to be used if no modifiers are set. The second entry specifies the -Lock +Lock modifier alone also yields shift level one. The third entry specifies the -Shift +Shift modifier alone yields shift level two. The fourth and fifth entries specify that the virtual LevelThree modifier alone, or in combination with the -Shift +Shift modifier, yields shift level three. @@ -358,7 +358,7 @@ that the virtual Because the -Lock +Lock modifier is to be preserved for further event processing, the preserve list is not @@ -370,20 +370,20 @@ Because the entries, except for the one corresponding to the map entry that specifies the -Lock +Lock modifier, do not list any modifiers. For the map entry that specifies the -Lock +Lock modifier, the corresponding preserve list entry lists the -Lock +Lock modifier, meaning do not consume the -Lock +Lock modifier. In this particular case, the preserved modifier is passed to Xlib translation functions and causes them to notice that the -Lock +Lock modifier is set; consequently, the Xlib functions apply the appropriate capitalization rules to the symbol. Because this preserve entry is set only for a modifier that yields shift level one, the capitalization occurs only for @@ -451,9 +451,9 @@ The description of the ONE_LEVEL key type is stored in the The TWO_LEVEL key type describes groups that consist of two symbols but are neither alphabetic nor numeric keypad keys. The default TWO_LEVEL type uses only the -Shift +Shift modifier. It returns shift level two if -Shift +Shift is set, and level one if it is not. A symbolic representation of this key type could look like the following: @@ -485,9 +485,9 @@ The ALPHABETIC key type describes groups consisting of two symbols: the lowercase form of a symbol followed by the uppercase form of the same symbol. The default ALPHABETIC type implements locale-sensitive "Shift cancels CapsLock" behavior using both the -Shift +Shift and -Lock +Lock modifiers as follows: @@ -495,25 +495,25 @@ CapsLock" behavior using both the If -Shift +Shift and -Lock +Lock are both set, the default ALPHABETIC type yields level one. If -Shift +Shift alone is set, it yields level two. If -Lock +Lock alone is set, it yields level one, but preserves the -Lock +Lock modifier so Xlib notices and applies the appropriate capitalization rules. The Xlib functions are locale-sensitive and apply different capitalization rules for different locales. @@ -522,9 +522,9 @@ for different locales. If neither -Shift +Shift nor -Lock +Lock is set, it yields level one. @@ -571,7 +571,7 @@ virtual modifier named "NumLock," known as the If -Shift +Shift and NumLock are both set, the default KEYPAD type yields level one. @@ -580,7 +580,7 @@ If If -Shift +Shift alone is set, it yields level two. @@ -594,7 +594,7 @@ If If neither -Shift +Shift nor NumLock is set, it yields level one. @@ -725,9 +725,9 @@ initializing the KEYPAD key type. If the XkbInitCanonicalKeyTypes normally returns Success. It returns -BadAccess +BadAccess if the Xkb extension has not been properly initialized, and -BadAccess +BadAccess if the xkb parameter is not valid. @@ -825,9 +825,9 @@ If successful, it returns Success. XkbGetKeyTypes returns -BadAccess +BadAccess if the Xkb extension has not been properly initialized and -BadValue +BadValue if the combination of first and @@ -901,7 +901,7 @@ To change the number of levels in a key type, use - True + True => list of preserved modifiers is necessary @@ -965,7 +965,7 @@ The list for the key should be created. If want_preserve is -True, +True, the preserve list with @@ -973,7 +973,7 @@ the entries is allocated or reallocated if it already exists. Otherwise, if want_preserve is -False, +False, the preserve field is freed if necessary and set to @@ -1000,13 +1000,13 @@ If is less than zero, XkbResizeKeyType returns -BadValue. +BadValue. If XkbResizeKeyType encounters any problems with allocation, it returns -BadAlloc. +BadAlloc. Otherwise, it returns -Success. +Success. @@ -1087,7 +1087,7 @@ and into, XkbCopyKeyType returns -BadAlloc. +BadAlloc. Otherwise, XkbCopyKeyType copies @@ -1095,7 +1095,7 @@ Otherwise, to into and returns -Success. +Success. @@ -1176,7 +1176,7 @@ If any allocation errors occur while copying into, XkbCopyKeyTypes returns -BadAlloc. +BadAlloc. Otherwise, XkbCopyKeyTypes copies @@ -1184,7 +1184,7 @@ Otherwise, to into and returns -Success. +Success. @@ -1425,7 +1425,7 @@ The key as well as the specification of the treatment of out-of-range groups. It is legal for a key to have zero groups, in which case it also has zero symbols and all events from that key yield -NoSymbol. +NoSymbol. To obtain the number of groups of symbols bound to the key, use XkbKeyNumGroups. To change the number of groups bound to a key, use @@ -2097,7 +2097,7 @@ It waits for a reply and returns the keysyms in the If successful, XkbGetKeySyms returns -Success. +Success. The xkb parameter must be a pointer to a valid Xkb keyboard description. @@ -2120,18 +2120,18 @@ If a compatible version of Xkb is not available in the server or the Xkb extension has not been properly initialized, XkbGetKeySyms returns -BadAccess. +BadAccess. If num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeySyms returns -BadValue. +BadValue. If any allocation errors occur, XkbGetKeySyms returns -BadAlloc. +BadAlloc. @@ -2233,7 +2233,7 @@ To change the number of groups and the types bound to a key, use XkbChangeTypesOfKey reallocates the symbols and actions bound to the key, if necessary, and initializes any new symbols or actions to -NoSymbol +NoSymbol or NoAction, as appropriate. If the @@ -2260,7 +2260,7 @@ as appropriate. If the structure. If successful, XkbChangeTypesOfKey returns -Success. +Success. @@ -2353,7 +2353,7 @@ groups: If the Xkb extension has not been properly initialized, XkbChangeTypesOfKey returns -BadAccess. +BadAccess. If the xkb parameter it not valid (that is, it is @@ -2373,12 +2373,12 @@ or the mask does not contain any of the valid group mask bits, XkbChangeTypesOfKey returns -BadValue. +BadValue. If it is necessary to resize the key symbols or key actions arrays and any allocation errors occur, XkbChangeTypesOfKey returns -BadAlloc. +BadAlloc. @@ -2471,7 +2471,7 @@ If is greater than the current number of keysyms for the key, XkbResizeKeySyms initializes all new keysyms in the array to -NoSymbol. +NoSymbol. @@ -2518,15 +2518,15 @@ The entry of the client map is an array, indexed by keycode, specifying the real modifiers bound to a key. Each entry is a mask composed of a bitwise inclusive OR of the legal real modifiers: -ShiftMask, -LockMask, -ControlMask, -Mod1Mask, -Mod2Mask, -Mod3Mask, -Mod4Mask, +ShiftMask, +LockMask, +ControlMask, +Mod1Mask, +Mod2Mask, +Mod3Mask, +Mod4Mask, and -Mod5Mask. +Mod5Mask. If a bit is set in a modmap entry, the corresponding key is bound to that modifier. @@ -2621,7 +2621,7 @@ It waits for a reply and places the results in the ->map->modmap array. If successful, XkbGetKeyModifier returns -Success. +Success. @@ -2639,11 +2639,11 @@ If a compatible version of Xkb is not available in the server or the Xkb extension has not been properly initialized, XkbGetKeySyms returns -BadAccess. +BadAccess. If any allocation errors occur while obtaining the modifier map, XkbGetKeyModifierMap returns -BadAlloc. +BadAlloc. diff --git a/specs/XKB/ch16.xml b/specs/XKB/ch16.xml index 8209368f..c70eb7c7 100644 --- a/specs/XKB/ch16.xml +++ b/specs/XKB/ch16.xml @@ -76,9 +76,9 @@ and are defined in section 16.4. A key action defines the effect key presses and releases have on the internal state of the server. For example, the expected key action associated with pressing the -Shift +Shift key is to set the -Shift +Shift modifier. There is zero or one key action associated with each keysym bound to each key. @@ -195,11 +195,11 @@ to key actions: XkbKeyHasActions returns -True +True if the key corresponding to keycode has any actions associated with it; otherwise, it returns -False. +False. @@ -1307,9 +1307,9 @@ typedef struct _XkbPtrAction { If the MouseKeys control is not enabled (see section 10.5.1), -KeyPress +KeyPress and -KeyRelease +KeyRelease events are treated as though the action is XkbSA_NoAction. @@ -1320,11 +1320,11 @@ If the control is enabled, a server action of type XkbSA_MovePtr instructs the server to generate core pointer -MotionNotify +MotionNotify events rather than the usual -KeyPress +KeyPress event, and the corresponding -KeyRelease +KeyRelease event disables any mouse keys timers that were created as a result of handling the XkbSA_MovePtr @@ -1367,7 +1367,7 @@ The If not set, and the MouseKeysAccel control is enabled (see section 10.5.2), the -KeyPress +KeyPress initiates a mouse keys timer for this key; every time the timer expires, the cursor moves. @@ -1598,9 +1598,9 @@ typedef struct _XkbPtrBtnAction { If the MouseKeys (see section 10.5.1) control is not enabled, -KeyPress +KeyPress and -KeyRelease +KeyRelease events are treated as though the action is XkbSA_NoAction. @@ -1650,13 +1650,13 @@ specified by the If the mouse button specified for this action is logically down, the key press and corresponding key release are ignored and have no effect. Otherwise, a key press causes one or more core pointer button events instead of the usual -KeyPress +KeyPress event. If count is zero, a key press generates a single -ButtonPress +ButtonPress event; if count is greater than @@ -1664,9 +1664,9 @@ a key press generates a single a key press generates count pairs of -ButtonPress +ButtonPress and -ButtonRelease +ButtonRelease events. @@ -1677,15 +1677,15 @@ If is zero, a key release generates a core pointer -ButtonRelease +ButtonRelease that matches the event generated by the corresponding -KeyPress +KeyPress ; if count is nonzero, a key release does not cause a -ButtonRelease +ButtonRelease event. A key release never generates a key -KeyRelease +KeyRelease event. @@ -1704,9 +1704,9 @@ If the button specified by the or button is not locked, a key press causes a -ButtonPress +ButtonPress event instead of a -KeyPress +KeyPress event and locks the button. If the button is already locked or if XkbSA_LockNoUnlock is set in the @@ -1721,9 +1721,9 @@ If the corresponding key press was ignored, and if is not set in the flags field, a key release generates a -ButtonRelease +ButtonRelease event instead of a -KeyRelease +KeyRelease event and unlocks the specified button. If the corresponding key press locked a button, the key release is ignored and has no effect. @@ -1818,9 +1818,9 @@ typedef struct _XkbPtrDfltAction { If the MouseKeys control is not enabled, -KeyPress +KeyPress and -KeyRelease +KeyRelease events are treated as though the action is XkbSA_NoAction. Otherwise, this action changes the @@ -2008,7 +2008,7 @@ press and release release ISO_Lock ends up locking the -Control +Control modifier. @@ -2933,9 +2933,9 @@ If set, key release events generate an XkbSA_MessageGenKeyEvent If set, key press and key release events generate -KeyPress +KeyPress and -KeyRelease +KeyRelease events, regardless of whether they generate XkbActionMessage events. @@ -3011,15 +3011,15 @@ The structure for the typedef struct _XkbActionMessage { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ - Bool send_event; /* True => synthetically generated */ + 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 */ KeyCode keycode; /* keycode of key triggering event */ - Bool press; /* True => key press, - False => release */ - Bool key_event_follows; /* True => KeyPress/KeyRelease follows */ + Bool press; /* True => key press, + False => release */ + Bool key_event_follows; /* True => KeyPress/KeyRelease follows */ char message[XkbActionMessageLength+1]; /* message text */ } XkbActionMessageEvent; @@ -3038,34 +3038,34 @@ release. The key_event_follows specifies whether a -KeyPress +KeyPress (if press is -True +True ) or -KeyRelease +KeyRelease (if press is -False +False ) event is also sent to the client. As with all other Xkb events, XkbActionMessageEvent s are delivered to all clients requesting them, regardless of the current keyboard focus. However, the -KeyPress +KeyPress or -KeyRelease +KeyRelease event that conditionally follows an XkbActionMessageEvent is sent only to the client selected by the current keyboard focus. key_event_follows is -True +True only for the client that is actually sent the following -KeyPress +KeyPress or -KeyRelease +KeyRelease event. @@ -3094,9 +3094,9 @@ The Actions associated with the XkbRedirectKeyAction structure generate -KeyPress +KeyPress and -KeyRelease +KeyRelease events containing a keycode different from the key that was pressed or released: @@ -3126,7 +3126,7 @@ The Key presses cause a -KeyPress +KeyPress event for the key specified by the new_key field instead of the actual key. The state reported in this event reports the @@ -3150,7 +3150,7 @@ values for a single modifier, the real modifier definition has priority. Key releases cause a -KeyRelease +KeyRelease event for the key specified by the new_key field instead of the actual key. The state for this event consists of the @@ -3360,9 +3360,9 @@ Actions associated with and DeviceButtonRelease events instead of normal -KeyPress +KeyPress and -KeyRelease +KeyRelease events: @@ -3434,7 +3434,7 @@ If is nonzero, a key release does not cause a DeviceButtonRelease event. Key releases never cause -KeyRelease +KeyRelease events. @@ -3460,7 +3460,7 @@ Otherwise, if the specified button is not locked and the field, a key press generates an input extension DeviceButtonPress event instead of a -KeyPress +KeyPress event and locks the button. If the button is already locked or if XkbSA_LockNoLock bit is set in the @@ -3477,7 +3477,7 @@ If the corresponding key press was ignored, and if the field, a key release generates an input extension DeviceButtonRelease event instead of a -KeyRelease +KeyRelease event and unlocks the button. If the corresponding key press locked a button, the key release is ignored and has no effect. @@ -3766,7 +3766,7 @@ It waits for a reply and returns the actions in the If successful, XkbGetKeyActions returns -Success. +Success. The xkb parameter must be a pointer to a valid Xkb keyboard description. @@ -3789,18 +3789,18 @@ If the server does not have a compatible version of Xkb, or the Xkb extension has not been properly initialized, XkbGetKeyActions returns -BadAccess. +BadAccess. If num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyActions returns -BadValue. +BadValue. If any allocation errors occur, XkbGetKeyActions returns -BadAlloc. +BadAlloc. @@ -4212,7 +4212,7 @@ It waits for a reply and returns the behaviors in the If successful, XkbGetKeyBehaviors returns -Success. +Success. @@ -4232,18 +4232,18 @@ If the server does not have a compatible version of Xkb, or the Xkb extension has not been properly initialized, XkbGetKeyBehaviors returns -BadAccess. +BadAccess. If num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyBehaviors returns -BadValue. +BadValue. If any allocation errors occur, XkbGetKeyBehaviors returns -BadAlloc. +BadAlloc. @@ -4447,7 +4447,7 @@ It waits for a reply and returns the explicit components in the If successful, XkbGetKeyExplicitComponents returns -Success. +Success. The xkb parameter must be a pointer to a valid Xkb keyboard description. @@ -4470,18 +4470,18 @@ If the server does not have a compatible version of Xkb, or the Xkb extension has not been properly initialized, XkbGetKeyExplicitComponents returns -BadMatch. +BadMatch. If num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyExplicitComponents returns -BadValue. +BadValue. If any allocation errors occur, XkbGetKeyExplicitComponents returns -BadAlloc. +BadAlloc. @@ -4502,14 +4502,14 @@ of the virtual modifier to the real modifier bits. Each entry in the - ShiftMask - LockMask - ControlMask - Mod1Mask - Mod2Mask - Mod3Mask - Mod4Mask - Mod5Mask + ShiftMask + LockMask + ControlMask + Mod1Mask + Mod2Mask + Mod3Mask + Mod4Mask + Mod5Mask @@ -4658,7 +4658,7 @@ The successful, XkbGetVirtualMods returns -Success. +Success. @@ -4678,11 +4678,11 @@ If the server does not have a compatible version of Xkb, or the Xkb extension has not been properly initialized, XkbGetVirtualMods returns -BadMatch. +BadMatch. Any errors in allocation cause XkbGetVirtualMods to return -BadAlloc. +BadAlloc. @@ -4773,7 +4773,7 @@ It waits for a reply and returns the virtual modifier mappings in the If successful, XkbGetKeyVirtualModMap returns -Success. +Success. The xkb parameter must be a pointer to a valid Xkb keyboard description @@ -4796,18 +4796,18 @@ If the server does not have a compatible version of Xkb, or the Xkb extension has not been properly initialized, XkbGetKeyVirtualModMap returns -BadMatch. +BadMatch. If num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyVirtualModMap returns -BadValue. +BadValue. If any allocation errors occur, XkbGetKeyVirtualModMap returns -BadAlloc. +BadAlloc. diff --git a/specs/XKB/ch17.xml b/specs/XKB/ch17.xml index 0ae49bf0..69f7418c 100644 --- a/specs/XKB/ch17.xml +++ b/specs/XKB/ch17.xml @@ -198,9 +198,9 @@ undefined. Normally, the Xkb-aware server reports keyboard state in the state member of events such as a -KeyPress +KeyPress event and -ButtonPress +ButtonPress event, encoded as follows: @@ -309,7 +309,7 @@ For each changed key, assign the symbols in the core map to the appropriate group on the key. If the total number of symbols required by the Xkb map for a particular key needs more symbols than the core protocol map contains, the additional symbols are taken to be -NoSymbol +NoSymbol keysyms appended to the end of the core set. If the core map contains more symbols than are needed by the Xkb map, trailing symbols in the core map are discarded. In the absence of an explicit override for group one or two, symbols @@ -871,12 +871,12 @@ Unless you have specifically modified this field, it is the default keyboard device. XkbGetCompatMap returns -Success +Success if successful, -BadAlloc +BadAlloc if it is unable to obtain necessary storage for either the return values or work space, -BadMatch +BadMatch if the dpy field of the @@ -886,7 +886,7 @@ work space, and does not match the display argument, and -BadLength +BadLength under certain conditions caused by server or Xkb implementation errors. @@ -900,7 +900,7 @@ Xkb provides several functions that make it easier to apply the compatibility map to configure a client-side Xkb keyboard mapping, given a core protocol representation of part or all of a keyboard mapping. Obtain a core protocol representation of a keyboard mapping from an actual server (by using -XGetKeyboardMapping, +XGetKeyboardMapping, for example), a data file, or some other source. @@ -1009,14 +1009,14 @@ keys with keycodes in the range - 1. If XkbUpdateMapFromCore is being called in response to a -MappingNotify +MappingNotify event, first_key and num_keys are reported in the -MappingNotify +MappingNotify event. core_keysyms contains the keysyms corresponding to the keycode range being updated, in core @@ -1346,7 +1346,7 @@ the vector of - True => apply to server’s keyboard map + True => apply to server’s keyboard map @@ -1374,13 +1374,13 @@ of the bits shown in Table 17.2. After updating its compatibility map for the specified device, if update_actions is -True, +True, the server applies the new compatibility map to its entire keyboard for the device to generate a new set of key semantics, compatibility state, and a new core keyboard map. If update_actions is -False, +False, the new compatibility map is not used to generate any modifications to the current device semantics, state, or core keyboard map. One reason for not applying the compatibility map immediately would be if one server was being @@ -1392,16 +1392,16 @@ until everything is updated. To force an update at a later time, use as zero and update_actions as -True. +True. XkbSetCompatMap returns -True +True if successful and -False +False if unsuccessful. The server may report problems it encounters when processing the request subsequently via protocol errors. @@ -1456,7 +1456,7 @@ use - True=>apply compatibility map to keys + True=>apply compatibility map to keys @@ -1481,7 +1481,7 @@ use If updateMap is -True, +True, it (re)applies the compatibility map to all of the keys on the keyboard. If changes is non- @@ -1489,7 +1489,7 @@ it (re)applies the compatibility map to all of the keys on the keyboard. If it reports the parts of the keyboard that were affected (unless updateMap is -True, +True, not much changes). XkbAddSymInterpret returns a pointer to the actual new symbol interpretation in the list or @@ -1504,18 +1504,18 @@ not much changes). The server automatically generates -MappingNotify +MappingNotify events when the keyboard mapping changes. If you wish to be notified of changes to the compatibility map, you should select for XkbCompatMapNotify events. If you select for XkbMapNotify events, you no longer receive the automatically generated -MappingNotify +MappingNotify events. If you subsequently deselect XkbMapNotifyEvent delivery, you again receive -MappingNotify +MappingNotify events. @@ -1567,7 +1567,7 @@ The structure for the typedef struct { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ - Bool send_event; /* True => + Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ @@ -1726,15 +1726,15 @@ added, use XkbAllocCompatMap returns -Success +Success if successful, -BadMatch +BadMatch if xkb is NULL, or -BadAlloc +BadAlloc if errors are encountered when attempting to allocate storage. @@ -1785,7 +1785,7 @@ To free an entire compatibility map or selected portions of one, use - True => free XkbCompatMap + True => free XkbCompatMap structure itself @@ -1809,7 +1809,7 @@ in section 17.2). structure itself should be freed. If free_map is -True, +True, which is ignored, all non- NULL diff --git a/specs/XKB/ch18.xml b/specs/XKB/ch18.xml index 6ffd1b52..2b3078c6 100644 --- a/specs/XKB/ch18.xml +++ b/specs/XKB/ch18.xml @@ -8,10 +8,10 @@ application that presents the keyboard to a user in an easy-to-understand way. Such applications have to examine the vendor string and keycodes to determine the type of keyboard connected to the server and then examine keysyms and modifier mappings to determine the effects of most modifiers (the -Shift, -Lock +Shift, +Lock and -Control +Control modifiers are defined by the core protocol but no semantics are implied for any other modifiers). @@ -471,13 +471,13 @@ If the XkbGetNames can return -Success, +Success, or -BadAlloc, -BadLength, -BadMatch, +BadAlloc, +BadLength, +BadMatch, and -BadImplementation +BadImplementation errors. @@ -506,12 +506,12 @@ structure and call and XkbChangeNames can generate -BadAlloc, -BadAtom, -BadLength, -BadMatch, +BadAlloc, +BadAtom, +BadLength, +BadMatch, and -BadImplementation +BadImplementation errors. @@ -612,7 +612,7 @@ changed. If either or both of these mask bits are set but the specified types are illegal, XkbSetNames returns -False +False and does not update any of the names specified in which. The specified types are illegal if @@ -818,7 +818,7 @@ to the X server specified by dpy. XkbChangeNames aborts and returns -False +False if any illegal type names or type shift level names are specified by changes. @@ -871,7 +871,7 @@ typedef struct { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ - Bool send_event; /* True + Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ @@ -1051,10 +1051,10 @@ results into the XkbGetNamesChanges can generate -BadAlloc, -BadImplementation, +BadAlloc, +BadImplementation, and -BadMatch +BadMatch errors. @@ -1134,10 +1134,10 @@ from the X server. Instead use XkbAllocNames can return -BadAlloc, -BadMatch, +BadAlloc, +BadMatch, and -BadValue +BadValue errors. The which @@ -1150,7 +1150,7 @@ Table 18.1. Do not free symbolic names structures directly using free or -XFree. +XFree. Use XkbFreeNames instead. @@ -1196,7 +1196,7 @@ Use - True + True => XkbNamesRec structure itself should be freed diff --git a/specs/XKB/ch19.xml b/specs/XKB/ch19.xml index 1b7c0bbe..37ed405a 100644 --- a/specs/XKB/ch19.xml +++ b/specs/XKB/ch19.xml @@ -117,7 +117,7 @@ In addition to filtering out-of-range key events, Xkb: Adjusts core protocol -MappingNotify +MappingNotify events to refer only to keys that match the stored legal range. @@ -167,7 +167,7 @@ The structure for the typedef struct _XkbNewKeyboardNotify { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event*/ - Bool send_event; /* True + Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ diff --git a/specs/XKB/ch20.xml b/specs/XKB/ch20.xml index 3dbc8b8e..d4a3e39a 100644 --- a/specs/XKB/ch20.xml +++ b/specs/XKB/ch20.xml @@ -623,7 +623,7 @@ one, use - True => load into device_spec + True => load into device_spec @@ -811,7 +811,7 @@ If a required component has not been specified in the In addition, if load is -True, +True, the server modifies names if necessary (again using a " @@ -927,11 +927,11 @@ these components, If load is -True, +True, the server updates its keyboard description for device_spec to match the result of the keyboard description just built. If load is -False, +False, the server’s description for device device_spec is not updated. In all cases, the parts specified by @@ -1088,7 +1088,7 @@ is synchronous; it sends the request to the server to build a new keyboard description and waits for the reply. If successful, the return value is non-NULL. XkbGetKeyboardByName -generates a BadMatch +generates a BadMatch protocol error if errors are encountered when building the keyboard description. @@ -1167,7 +1167,7 @@ keyboard device. It calls NULL, which, which, -False +False ). diff --git a/specs/XKB/ch21.xml b/specs/XKB/ch21.xml index 9904da07..302ab21b 100644 --- a/specs/XKB/ch21.xml +++ b/specs/XKB/ch21.xml @@ -167,7 +167,7 @@ typedef struct { char * name; /* name for device */ Atom type; /* name for class of devices */ unsigned short device_spec; /* device of interest */ - Bool has_own_state; /* True =>this + Bool has_own_state; /* True =>this device has its own state */ unsigned short supported; /* bits indicating supported capabilities */ unsigned short unsupported; /* bits indicating unsupported capabilities */ @@ -206,11 +206,11 @@ The ), it has its own state, and has_own_state is -True. +True. If has_own_state is -False, +False, the state of the core keyboard is used. The supported and @@ -654,7 +654,7 @@ XkbGetDeviceButtonActions. - True => get information for all buttons + True => get information for all buttons @@ -700,7 +700,7 @@ by the and unsupported fields, and returns -Success. +Success. @@ -712,11 +712,11 @@ and specify the device buttons for which actions should be returned. Setting all_buttons to -True +True requests actions for all device buttons; if all_buttons is -False, +False, first_button and num_buttons @@ -727,9 +727,9 @@ and If a compatible version of Xkb is not available in the server or the Xkb extension has not been properly initialized, XkbGetDeviceButtonActions returns -BadAccess. +BadAccess. If allocation errors occur, a -BadAlloc +BadAlloc status is returned. If the specified device ( device_info -> @@ -839,7 +839,7 @@ by as determined by which with the results and returns -Success. +Success. Valid values for which are the inclusive OR of any of @@ -928,7 +928,7 @@ If a compatible version of Xkb is not available in the server or the Xkb extension has not been properly initialized, XkbGetDeviceLedInfo returns -BadAccess. +BadAccess. If allocation errors occur, a BadAlloc status is returned. If the device has no indicators, a BadMatch error is returned. If ledClass @@ -1241,7 +1241,7 @@ To allocate additional space for button actions in an NULL. If device_info is invalid or new_total is greater than 255, BadValue is returned. If a memory allocation failure occurs, a -BadAlloc +BadAlloc is returned. @@ -1291,7 +1291,7 @@ To free an - True => free everything, including device_info + True => free everything, including device_info @@ -1299,7 +1299,7 @@ To free an If free_all is -True, +True, the XkbFreeDeviceInfo frees all components of @@ -1309,7 +1309,7 @@ the structure pointed to by device_info itself. If free_all is -False, +False, the value of which determines which subcomponents are freed. which is an inclusive OR of one or more of the values from Table 21.1. If which @@ -1477,11 +1477,11 @@ set in (see Table 21.1). XkbSetDeviceInfo returns -True +True if the request was successfully sent to the server. If the X server implementation does not allow interaction between the X input extension and the Xkb Extension, the function does nothing and returns -False. +False. @@ -1508,7 +1508,7 @@ If the device specified in does not contain buttons and a request affecting buttons is made, or the device does not contain indicators and a request affecting indicators is made, a -BadMatch +BadMatch protocol error results. @@ -1531,9 +1531,9 @@ s specified in If the number of buttons requested to be updated is not valid for the device, XkbSetDeviceInfo returns -False +False and a -BadValue +BadValue protocol error results. @@ -1579,14 +1579,14 @@ the indicator maps and / or names for all led_id specify the input extension class and device ID for each indicator device to modify; if they have invalid values, a -BadValue +BadValue protocol error results and XkbSetDeviceInfo returns -False. +False. If they have legal values but do not specify a keyboard or indicator class feedback for the device in question, a -BadMatch +BadMatch error results. If any of the values in device_info -> @@ -1594,9 +1594,9 @@ feedback for the device in question, a -> names are not a valid Atom or -None, +None, a -BadAtom +BadAtom protocol error results. @@ -1694,7 +1694,7 @@ If the server does not support assignment of Xkb actions to extension device buttons, XkbSetDeviceButtonActions has no effect and returns -False. +False. If the device has no buttons or if first_button or @@ -1704,18 +1704,18 @@ If the device has no buttons or if -> num_btns, the function has no effect and returns -False. +False. Otherwise, XkbSetDeviceButtonActions sends a request to the server to change the actions for the specified buttons and returns -True. +True. If the actual request sent to the server involved illegal button numbers, a -BadValue +BadValue protocol error is generated. If an invalid device identifier is specified in device_info-> device_spec, @@ -1724,7 +1724,7 @@ a BadKeyboard protocol error results. If the actual device specified in -> device_spec does not contain buttons and a request affecting buttons is made, a -BadMatch +BadMatch protocol error is generated. @@ -1799,7 +1799,7 @@ The structure for typedef struct { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ - Bool send_event; /* True + Bool send_event; /* True => synthetically generated*/ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ diff --git a/specs/XKB/ch22.xml b/specs/XKB/ch22.xml index 6b77a5c4..15c4822f 100644 --- a/specs/XKB/ch22.xml +++ b/specs/XKB/ch22.xml @@ -209,11 +209,11 @@ Xkb modifies its behavior according to each controls bit. XkbSetDebuggingFlags returns -True +True if successful and -False +False otherwise. The only protocol error it may generate is -BadAlloc, +BadAlloc, if for some reason it is unable to allocate storage. diff --git a/specs/XKB/glossary.xml b/specs/XKB/glossary.xml index 85c4e8fb..d8f0ec0a 100644 --- a/specs/XKB/glossary.xml +++ b/specs/XKB/glossary.xml @@ -209,14 +209,14 @@ An event created from the core X server. Detectable auto-repeat allows a client to detect an auto-repeating key. If a client requests and the server supports detectable auto-repeat, Xkb generates -KeyRelease +KeyRelease events only when the key is physically released. Thus the client receives a number of -KeyPress +KeyPress events for that key without intervening -KeyRelease +KeyRelease events until the key is finally released, when a -KeyRelease +KeyRelease event is received. @@ -740,13 +740,13 @@ to a keysym. A modifier is a logical condition that is either set or unset. The modifiers control the Shift Level selected when a key event occurs. Xkb supports the core protocol eight modifiers ( -Shift, -Lock, -Control, +Shift, +Lock, +Control, and -Mod1 +Mod1 through -Mod5 +Mod5 ), called the real modifiers. In addition, Xkb extends modifier flexibility by providing a set of @@ -862,13 +862,13 @@ be logically depressed at one time. Xkb supports the eight core protocol modifiers ( -Shift, -Lock, -Control, +Shift, +Lock, +Control, and -Mod1 +Mod1 through -Mod5 +Mod5 ); these are called the real modifiers, as opposed to the set of sixteen named virtual modifiers that can @@ -957,13 +957,13 @@ slider, or a dial. Xkb provides a set of sixteen named virtual modifiers that can be bound to any set of the eight real modifiers. Each virtual modifier can be bound to any set of the real modifiers ( -Shift, -Lock, -Control, +Shift, +Lock, +Control, and -Mod1 +Mod1 - -Mod5 +Mod5 ). -- cgit v1.2.1