From f10aa1e09468bd28454d85ac8ab55d9dc7178029 Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Tue, 8 Jul 2014 22:22:29 -0700 Subject: [PATCH] specs/XKB: Markup function args as instead of Signed-off-by: Alan Coopersmith --- specs/XKB/ch02.xml | 52 +++---- specs/XKB/ch04.xml | 54 +++---- specs/XKB/ch05.xml | 34 ++--- specs/XKB/ch06.xml | 24 +-- specs/XKB/ch07.xml | 18 +-- specs/XKB/ch08.xml | 152 +++++++++--------- specs/XKB/ch09.xml | 40 ++--- specs/XKB/ch10.xml | 318 +++++++++++++++++++------------------- specs/XKB/ch11.xml | 18 +-- specs/XKB/ch12.xml | 94 ++++++------ specs/XKB/ch13.xml | 374 ++++++++++++++++++++++----------------------- specs/XKB/ch14.xml | 122 +++++++-------- specs/XKB/ch15.xml | 262 +++++++++++++++---------------- specs/XKB/ch16.xml | 232 ++++++++++++++-------------- specs/XKB/ch17.xml | 162 ++++++++++---------- specs/XKB/ch18.xml | 80 +++++----- specs/XKB/ch20.xml | 114 +++++++------- specs/XKB/ch21.xml | 250 +++++++++++++++--------------- specs/XKB/ch22.xml | 46 +++--- 19 files changed, 1223 insertions(+), 1223 deletions(-) diff --git a/specs/XKB/ch02.xml b/specs/XKB/ch02.xml index 4507714c..e1e43ab5 100644 --- a/specs/XKB/ch02.xml +++ b/specs/XKB/ch02.xml @@ -96,8 +96,8 @@ To determine the compatibility of a library at runtime, call Bool XkbLibraryVersion int *lib_major_in_out @@ -131,19 +131,19 @@ To determine the compatibility of a library at runtime, call Pass the symbolic value XkbMajorVersion in -lib_major_in_out +lib_major_in_out and XkbMinorVersion in -lib_minor_in_out. +lib_minor_in_out. These arguments represent the version of the library used at compile time. The XkbLibraryVersion function backfills the major and minor version numbers of the library used at run time in -lib_major_in_out +lib_major_in_out and -lib_minor_in_out. +lib_minor_in_out. If the versions of the compile time and run time libraries are compatible, XkbLibraryVersion returns @@ -203,7 +203,7 @@ and initializes the extension when it is present. Bool XkbQueryExtension Display *dpy @@ -294,15 +294,15 @@ If a compatible version of Xkb is present, XkbQueryExtension initializes the extension. It backfills the major opcode for the keyboard extension in -opcode_rtrn, +opcode_rtrn, the base event code in -event_rtrn, +event_rtrn, the base error code in -error_rtrn, +error_rtrn, and the major and minor version numbers of the extension in -major_in_out +major_in_out and -minor_in_out. +minor_in_out. The major opcode is reported in the req_major fields of some Xkb events. For a discussion of the base event code, see @@ -322,8 +322,8 @@ server, and initialize the extension for use. Display *XkbOpenDisplay +display_name, event_rtrn, error_rtrn, major_in_out, minor_in_out, +reason_rtrn) --> char *display_name int *event_rtrn @@ -401,11 +401,11 @@ reason_rtrn) --> XkbOpenDisplay is a convenience function that opens an X display connection and initializes the X keyboard extension. In all cases, upon return -reason_rtrn +reason_rtrn contains a status value indicating success or the type of failure. If -major_in_out +major_in_out and -minor_in_out +minor_in_out are not NULL, XkbOpenDisplay @@ -413,15 +413,15 @@ the X keyboard extension. In all cases, upon return XkbLibraryVersion to determine whether the client library is compatible, passing it the values pointed to by -major_in_out +major_in_out and -minor_in_out. +minor_in_out. If the library is incompatible, XkbOpenDisplay backfills -major_in_out +major_in_out and -minor_in_out +minor_in_out with the major and minor extension versions of the library being used and returns NULL. @@ -430,7 +430,7 @@ If the library is compatible, next calls XOpenDisplay with the -display_name. +display_name. If this fails, the function returns NULL. If successful, @@ -439,9 +439,9 @@ calls XkbQueryExtension and backfills the major and minor Xkb server extension version numbers in -major_in_out +major_in_out and -minor_in_out. +minor_in_out. If the server extension version is not compatible with the library extension version or if the server extension is not present, XkbOpenDisplay @@ -452,7 +452,7 @@ When successful, the function returns the display connection. The possible values for -reason_rtrn are: +reason_rtrn are: @@ -518,7 +518,7 @@ disable use of the extension once a connection is established. Bool XkbIgnoreExtension Bool ignore diff --git a/specs/XKB/ch04.xml b/specs/XKB/ch04.xml index 8e5d110a..3c5417ab 100644 --- a/specs/XKB/ch04.xml +++ b/specs/XKB/ch04.xml @@ -387,7 +387,7 @@ them delivered under all conditions, use Bool XkbSelectEvents Display *display @@ -441,27 +441,27 @@ them delivered under all conditions, use This request changes the Xkb event selection mask for the keyboard specified by -device_spec. +device_spec. Each Xkb event that can be selected is represented by a bit in the -bits_to_change +bits_to_change and -values_for_bits +values_for_bits masks. Only the event selection bits specified by the -bits_to_change +bits_to_change parameter are affected; any unspecified bits are left unchanged. To turn on event selection for an event, set the bit for the event in the -bits_to_change +bits_to_change parameter and set the corresponding bit in the -values_for_bits +values_for_bits parameter. To turn off event selection for an event, set the bit for the event in the -bits_to_change +bits_to_change parameter and do not set the corresponding bit in the -values_for_bits +values_for_bits parameter. The valid values for both of these parameters are an inclusive bitwise OR of the masks shown in Table 4.2. There is no interface to return @@ -472,15 +472,15 @@ clients’ event selection masks. If a bit is not set in the -bits_to_change +bits_to_change parameter, but the corresponding bit is set in the -values_for_bits +values_for_bits parameter, a BadMatch protocol error results. If an undefined bit is set in either the -bits_to_change +bits_to_change or the -values_for_bits +values_for_bits parameter, a BadValue protocol error results. @@ -520,8 +520,8 @@ Xkb events with Bool XkbSelectEventDetails Display *display @@ -591,9 +591,9 @@ While XkbSelectEventDetails changes the selection criteria for a single type of Xkb event. The interpretation of the -bits_to_change +bits_to_change and -values_for_bits +values_for_bits masks depends on the event type in question. @@ -601,19 +601,19 @@ interpretation of the XkbSelectEventDetails changes the Xkb event selection mask for the keyboard specified by -device_spec +device_spec and the Xkb event specified by -event_type. +event_type. To turn on event selection for an event detail, set the bit for the detail in the -bits_to_change +bits_to_change parameter and set the corresponding bit in the -values_for_bits +values_for_bits parameter. To turn off event detail selection for a detail, set the bit for the detail in the -bits_to_change +bits_to_change parameter and do not set the corresponding bit in the -values_for_bits +values_for_bits parameter. @@ -622,15 +622,15 @@ the detail in the If an invalid event type is specified, a BadValue protocol error results. If a bit is not set in the -bits_to_change +bits_to_change parameter, but the corresponding bit is set in the -values_for_bits +values_for_bits parameter, a BadMatch protocol error results. If an undefined bit is set in either the -bits_to_change +bits_to_change or the -values_for_bits +values_for_bits parameter, a BadValue protocol error results. diff --git a/specs/XKB/ch05.xml b/specs/XKB/ch05.xml index 3bbd1ebf..1330266a 100644 --- a/specs/XKB/ch05.xml +++ b/specs/XKB/ch05.xml @@ -352,7 +352,7 @@ To lock and unlock any of the eight real keyboard modifiers, use Bool XkbLockModifiers Display *display @@ -407,13 +407,13 @@ To lock and unlock any of the eight real keyboard modifiers, use XkbLockModifiers sends a request to the server to lock the real modifiers selected by both -affect +affect and -values +values and to unlock the real modifiers selected by -affect +affect but not selected by -values. +values. XkbLockModifiers does not wait for a reply from the server. It returns True @@ -434,7 +434,7 @@ To latch and unlatch any of the eight real keyboard modifiers, use Bool XkbLatchModifiers Display *display @@ -489,13 +489,13 @@ To latch and unlatch any of the eight real keyboard modifiers, use XkbLatchModifiers sends a request to the server to latch the real modifiers selected by both -affect +affect and -values +values and to unlatch the real modifiers selected by -affect +affect but not selected by -values. +values. XkbLatchModifiers does not wait for a reply from the server. It returns True @@ -554,7 +554,7 @@ To lock the keysym group, use Bool XkbLockGroup Display *display @@ -598,7 +598,7 @@ To lock the keysym group, use XkbLockGroup sends a request to the server to lock the specified -group +group and does not wait for a reply. It returns True if the request was sent and @@ -618,7 +618,7 @@ To latch the keysym group, use Bool XkbLatchGroup Display *display @@ -711,9 +711,9 @@ To obtain the keyboard state, use Status XkbGetState Display *display @@ -758,7 +758,7 @@ To obtain the keyboard state, use The XkbGetState function queries the server for the current keyboard state, waits for a reply, and then backfills -state_return +state_return with the results. diff --git a/specs/XKB/ch06.xml b/specs/XKB/ch06.xml index 8872ee8c..f1494292 100644 --- a/specs/XKB/ch06.xml +++ b/specs/XKB/ch06.xml @@ -49,13 +49,13 @@ keyboard */ The -display +display field points to an X display structure. The flags field is private to the library: modifying flags may yield unpredictable results. The -device_spec +device_spec field specifies the device identifier of the keyboard input device, or XkbUseCoreKeyboard, which specifies the core keyboard device. The @@ -206,7 +206,7 @@ To retrieve one or more components of a keyboard device description, use XkbDescPtr XkbGetKeyboard Display *display @@ -252,15 +252,15 @@ To retrieve one or more components of a keyboard device description, use XkbGetKeyboard allocates and returns a pointer to a keyboard description. It queries the server for those components specified in the -which +which parameter for device -device_spec +device_spec and copies the results to the XkbDescRec it allocated. The remaining fields in the keyboard description are set to NULL. The valid masks for -which +which are those listed in Table 6.2. @@ -344,7 +344,7 @@ To destroy either an entire an void XkbFreeKeyboard XkbDescPtr xkb @@ -388,22 +388,22 @@ To destroy either an entire an XkbFreeKeyboard frees the components of -xkb +xkb specified by -which +which and sets the corresponding values to NULL. If -free_all +free_all is True, XkbFreeKeyboard frees every non- NULL component of -xkb +xkb and then frees the -xkb +xkb structure itself. diff --git a/specs/XKB/ch07.xml b/specs/XKB/ch07.xml index 7fbb2bf3..26449c27 100644 --- a/specs/XKB/ch07.xml +++ b/specs/XKB/ch07.xml @@ -89,9 +89,9 @@ To set the name of a virtual modifier, use using XkbVirtualModNamesMask in -which +which and the name in the -xkb +xkb argument; to retrieve indicator names, use XkbGetNames. These functions are discussed in . @@ -250,7 +250,7 @@ To determine the mapping of virtual modifiers to core X protocol modifiers, use Bool XkbVirtualModsToReal XkbDescPtr xkb @@ -293,23 +293,23 @@ To determine the mapping of virtual modifiers to core X protocol modifiers, use If the keyboard description defined by -xkb +xkb includes bindings for virtual modifiers, XkbVirtualModsToReal uses those bindings to determine the set of real modifiers that correspond to the set of virtual modifiers specified in -virtual_mask. +virtual_mask. The -virtual_mask +virtual_mask parameter is a mask specifying the virtual modifiers to translate; the i-th bit (0 relative) of the mask represents the i-th virtual modifier. If -mask_rtrn +mask_rtrn is non- NULL, XkbVirtualModsToReal backfills it with the resulting real modifier mask. If the keyboard description in -xkb +xkb does not include virtual modifier bindings, XkbVirtualModsToReal returns @@ -319,7 +319,7 @@ description in It is possible for a local (client-side) keyboard description (the -xkb +xkb parameter) to not contain any virtual modifier information (simply because the client has not requested it) while the server’s corresponding definition may contain virtual modifier information. diff --git a/specs/XKB/ch08.xml b/specs/XKB/ch08.xml index 024273d5..d0f19488 100644 --- a/specs/XKB/ch08.xml +++ b/specs/XKB/ch08.xml @@ -858,9 +858,9 @@ current state of the keyboard indicators, use Status XkbGetIndicatorState Display *display @@ -904,19 +904,19 @@ current state of the keyboard indicators, use XkbGetIndicatorState queries the -display +display for the state of the indicators on the device specified by the -device_spec. +device_spec. For each indicator that is "turned on" on the device, the associated bit is set in -state_return. +state_return. If a compatible version of the Xkb extension is not available in the server, XkbGetIndicatorState returns a BadMatch error. Otherwise, it sends the request to the X server, places the state of the indicators into -state_return, +state_return, and returns Success. Thus the value reported by @@ -940,9 +940,9 @@ indicators, use Status XkbGetIndicatorMap Display *dpy @@ -986,13 +986,13 @@ indicators, use XkbGetIndicatorMap obtains the maps from the server for only those indicators specified by the -which +which mask and copies the values into the keyboard description specified by -desc. +desc. If the indicators field of the -desc +desc parameter is NULL, XkbGetIndicatorMap @@ -1048,13 +1048,13 @@ Use Bool XkbGetNamedIndicator Display *dpy @@ -1142,9 +1142,9 @@ Use If the device specified by -device_spec +device_spec has an indicator named -name, +name, XkbGetNamedIndicator returns True @@ -1158,22 +1158,22 @@ Otherwise, The -ndx_rtrn +ndx_rtrn field returns the zero-based index of the named indicator. This index is the bit position to use in any function call that requires a mask of indicator bits, as well as the indicator’s index into the XkbIndicatorRec array of indicator maps. -state_rtrn +state_rtrn returns the current state of the named indicator ( True = on, False = off). -map_rtrn +map_rtrn returns the indicator map for the named indicator. In addition, if the indicator is mapped to a physical LED, the -real_rtrn +real_rtrn parameter is set to True. @@ -1343,9 +1343,9 @@ keyboard description, then use Bool XkbSetIndicatorMap Display *dpy @@ -1389,11 +1389,11 @@ keyboard description, then use For each bit set in the -which +which parameter, XkbSetIndicatorMap sends the corresponding indicator map from the -desc +desc parameter to the server. @@ -1435,12 +1435,12 @@ Set the indicator map for the indicator BoolXkbSetNamedIndicator Display *dpy @@ -1533,7 +1533,7 @@ If a compatible version of the Xkb extension is not available in the server, False. Otherwise, it sends a request to the X server to change the indicator specified by -name +name and returns True. @@ -1541,43 +1541,43 @@ specified by If -change_state +change_state is True, and the optional parameter, -state, +state, is not NULL, XkbSetNamedIndicator tells the server to change the state of the named indicator to the value specified by -state. +state. If an indicator with the name specified by -name +name does not already exist, the -create_new +create_new parameter tells the server whether it should create a new named indicator. If -create_new +create_new is True, the server finds the first indicator that doesn’t have a name and gives it the name specified by -name. +name. If the optional parameter, -map, +map, is not NULL, XkbSetNamedIndicator tells the server to change the indicator’s map to the values specified -in map. +in map. @@ -1636,7 +1636,7 @@ description, use Bool XkbChangeIndicators Display *dpy @@ -1693,20 +1693,20 @@ description, use XkbChangeIndicators copies any maps specified by -changes +changes from the keyboard description, -xkb, +xkb, to the server specified by -dpy. +dpy. If any bits are set in the state_changes field of -changes, +changes, XkbChangeIndicators also sets the state of those indicators to the values specified in the -state +state mask. A 1 bit in -state +state turns the corresponding indicator on, a 0 bit turns it off. @@ -1820,7 +1820,7 @@ have changed. If the event is of type XkbIndicatorStateNotify, changed reports the indicators that have changed state. -state +state is a mask that specifies the current state of all indicators, whether they have changed or not, for both XkbIndicatorStateNotify @@ -1841,9 +1841,9 @@ When your client application receives either a void XkbNoteIndicatorChanges XkbIndicatorChangesPtr old @@ -1886,18 +1886,18 @@ When your client application receives either a The -wanted +wanted parameter is the bitwise inclusive OR of XkbIndicatorMapMask and XkbIndicatorStateMask. XkbNoteIndicatorChanges copies any changes reported in -new +new and specified in -wanted +wanted into the changes record specified by -old. +old. @@ -1915,10 +1915,10 @@ the results of one or more calls to Status XkbGetIndicatorChanges Display *dpy @@ -1973,21 +1973,21 @@ the results of one or more calls to XkbGetIndicatorChanges examines the -changes +changes parameter, pulls over the necessary information from the server, and copies the results into the -xkb +xkb keyboard description. If any bits are set in the state_changes field of -changes, +changes, XkbGetIndicatorChanges also places the state of those indicators in -state. +state. If the indicators field of -xkb +xkb is NULL, XkbGetIndicatorChanges @@ -2027,7 +2027,7 @@ described in ). If the need aris Status XkbAllocIndicatorMaps XkbDescPtr xkb @@ -2048,7 +2048,7 @@ described in ). If the need aris The -xkb +xkb parameter must point to a valid keyboard description. If it doesn’t, XkbAllocIndicatorMaps returns a @@ -2080,7 +2080,7 @@ To free memory used by the void XkbFreeIndicatorMaps XkbDescPtr xkb @@ -2102,12 +2102,12 @@ To free memory used by the If the indicators member of the keyboard description record -pointed to by xkb +pointed to by xkb is not NULL, XkbFreeIndicatorMaps frees the memory associated with the indicators -member of xkb. +member of xkb. diff --git a/specs/XKB/ch09.xml b/specs/XKB/ch09.xml index a933a3de..247ff2ba 100644 --- a/specs/XKB/ch09.xml +++ b/specs/XKB/ch09.xml @@ -350,7 +350,7 @@ To ring the bell on an X input extension device or the default keyboard, use Bool XkbDeviceBell Display *display @@ -437,18 +437,18 @@ To ring the bell on an X input extension device or the default keyboard, use Set -percent +percent to be the volume relative to the base volume for the keyboard as described for XBell. Note that -bell_class +bell_class and -bell_id +bell_id indicate the bell to physically ring. -name +name is simply an arbitrary moniker for the client application’s use. @@ -492,7 +492,7 @@ default keyboard: Bool XkbBell Display *display @@ -550,9 +550,9 @@ If a compatible keyboard extension isn’t present in the X server, calls XBell with the specified -display +display and -percent, +percent, and returns False. Otherwise, @@ -562,7 +562,7 @@ calls with the specified display, window, percent, and -name, +name, a device_spec of @@ -622,7 +622,7 @@ without ringing the corresponding bell, use Bool XkbDeviceBellEvent Display *display @@ -719,7 +719,7 @@ Otherwise, event to be sent to all interested clients and returns True. Set -percent +percent to be the volume relative to the base volume for the keyboard as described for XBell. @@ -750,7 +750,7 @@ the keyboard without ringing the bell: Bool XkbBellEvent Display *display @@ -814,7 +814,7 @@ calls with the specified display, window, percent, and -name, +name, a device_spec of @@ -859,7 +859,7 @@ audible bells, use XkbForceDeviceBell. Bool XkbForceDeviceBell Display *display @@ -943,7 +943,7 @@ Otherwise, rings the bell as specified for the display and keyboard device and returns True. Set -percent +percent to be the volume relative to the base volume for the keyboard as described for XBell. There is no @@ -972,7 +972,7 @@ for audible bells, use Bool XkbForceBell +display, percent) --> Display *display int percent @@ -1007,9 +1007,9 @@ If a compatible keyboard extension isn’t present in the X server, calls XBell with the specified -display +display and -percent +percent and returns False. Otherwise, @@ -1017,9 +1017,9 @@ Otherwise, calls XkbForceDeviceBell with the specified -display +display and -percent, +percent, device_spec = XkbUseCoreKbd, diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml index 837a8868..4bd6c560 100644 --- a/specs/XKB/ch10.xml +++ b/specs/XKB/ch10.xml @@ -240,10 +240,10 @@ Use Bool XkbChangeEnabledControls Display *dpy @@ -297,9 +297,9 @@ Use The -mask +mask parameter specifies the boolean controls to be enabled or disabled, and the -values +values mask specifies the new state for those controls. Valid values for both of these masks are composed of a bitwise inclusive OR of bits taken from the set of mask bits in Table 10.7, @@ -388,9 +388,9 @@ To get the current values of the auto-reset controls, use Bool XkbGetAutoResetControls Display *dpy @@ -434,9 +434,9 @@ To get the current values of the auto-reset controls, use XkbGetAutoResetControls backfills -auto_ctrls +auto_ctrls and -auto_values +auto_values with the AutoReset control attributes for this particular client. It returns @@ -460,10 +460,10 @@ To change the current values of the Bool XkbSetAutoResetControls Display *dpy @@ -581,12 +581,12 @@ XkbStickyKeysMask); XkbSetAutoResetControls backfills -auto_ctrls +auto_ctrls and -auto_values +auto_values with the auto-reset controls for this particular client. Note that all of the bits are valid in the returned values, not just the ones selected in the -changes +changes mask. @@ -707,7 +707,7 @@ To get the current attributes of the Bool XkbGetAutoRepeatRate Display *display @@ -764,9 +764,9 @@ To get the current attributes of the queries the server for the current values of the RepeatControls control attributes, backfills -timeout_rtrn +timeout_rtrn and -interval_rtrn +interval_rtrn with them, and returns True. If a compatible version of the Xkb extension is not available in the server @@ -787,7 +787,7 @@ To set the attributes of the RepeatKeys control for a keyboard device, use Bool XkbSetAutoRepeatRate Display *display @@ -844,9 +844,9 @@ To set the attributes of the RepeatKeys control for a keyboard device, use sends a request to the X server to configure the AutoRepeat control attributes to the values specified in -timeout +timeout and -interval. +interval. @@ -855,9 +855,9 @@ To set the attributes of the RepeatKeys control for a keyboard device, use does not wait for a reply; it normally returns True. Specifying a zero value for either -timeout +timeout or -interval +interval causes the server to generate a BadValue protocol error. If a compatible version of the Xkb extension is not available @@ -951,7 +951,7 @@ use Bool XkbGetDetectableAutorepeat Display *display @@ -988,7 +988,7 @@ use queries the server for the current state of DetectableAutorepeat and waits for a reply. If -supported_rtrn +supported_rtrn is not NULL, it backfills supported_rtrn with @@ -1027,7 +1027,7 @@ they have requested otherwise. Bool XkbSetDetectableAutorepeat Display *display @@ -1076,20 +1076,20 @@ they have requested otherwise. sends a request to the server to set DetectableAutorepeat on for the current client if -detectable +detectable is True, and off it -detectable +detectable is False ; it then waits for a reply. If -supported_rtrn +supported_rtrn is not NULL, XkbSetDetectableAutorepeat backfills -supported_rtrn +supported_rtrn with True if the server supports @@ -1605,12 +1605,12 @@ Use Bool XkbGetAccessXTimeout Display *display @@ -1702,9 +1702,9 @@ Use attributes, waits for a reply, and backfills the values into the appropriate arguments. The parameters -opts_mask_rtrn +opts_mask_rtrn and -opts_values_rtrn +opts_values_rtrn are backfilled with the options to modify and the values for ax_options, which is a field in the @@ -1734,9 +1734,9 @@ To configure the Bool XkbSetAccessXTimeout Display *display @@ -1822,22 +1822,22 @@ opts_values -timeout +timeout specifies the number of seconds the keyboard must be idle before the controls are modified. -ctrls_mask +ctrls_mask specifies what controls are to be enabled or disabled, and -ctrls_values +ctrls_values specifies whether those controls are to be enabled or disabled. The bit values correspond to those for enabling and disabling boolean controls (see section 10.1.1). The -opts_mask +opts_mask field specifies which attributes of the AccessXKeys and AccessXFeedback controls are to be changed, and -opts_values +opts_values specifies the new values for those options. The bit values correspond to those for the ax_options @@ -2266,9 +2266,9 @@ To get the Bool XkbGetSlowKeysDelay Display *display @@ -2314,7 +2314,7 @@ To get the requests the attributes of the SlowKeys control from the server, waits for a reply and backfills -delay_rtrn +delay_rtrn with the SlowKeys delay attribute. @@ -2342,9 +2342,9 @@ To set the Bool XkbSetSlowKeysDelay Display *display @@ -2395,7 +2395,7 @@ It does not wait for a reply, and normally returns Specifying a value of 0 for the -delay +delay parameter causes XkbSetSlowKeys to generate a @@ -2448,9 +2448,9 @@ Use Bool XkbGetBounceKeysDelay Display *display @@ -2496,7 +2496,7 @@ Use requests the attributes of the BounceKeys control from the server, waits for a reply, and backfills -delay_rtrn +delay_rtrn with the BounceKeys delay attribute. @@ -2524,9 +2524,9 @@ To set the Bool XkbSetBounceKeysDelay Display *display @@ -2577,7 +2577,7 @@ It does not wait for a reply and normally returns Specifying a value of zero for the -delay +delay parameter causes XkbSetBounceKeysDelay to generate a @@ -2739,9 +2739,9 @@ Use Bool XkbGetStickyKeysOptions Display *display @@ -2787,11 +2787,11 @@ Use requests the attributes of the StickyKeys control from the server, waits for a reply, and backfills -options_rtrn +options_rtrn with a mask indicating whether the individual StickyKeys options are on or off. Valid bits in -options_rtrn +options_rtrn are: @@ -2827,8 +2827,8 @@ To set the Bool XkbSetStickyKeysOptions Display *display @@ -2888,9 +2888,9 @@ To set the It does not wait for a reply and normally returns True. The valid bits to use for both the -mask +mask and -values +values parameters are: @@ -3075,8 +3075,8 @@ to passive grabs, use Bool XkbSetIgnoreLockMods Display *display @@ -3155,28 +3155,28 @@ virtual_values sends a request to the server to change the server’s IgnoreLockMods control. -affect_real +affect_real and -real_values +real_values are masks of real modifier bits indicating which real modifiers are to be added and removed from the server’s IgnoreLockMods control. Modifiers selected by both -affect_real +affect_real and -real_values +real_values are added to the server’s IgnoreLockMods control; those selected by -affect_real +affect_real but not by -real_values +real_values are removed from the server’s IgnoreLockMods control. Valid values for -affect_real +affect_real and -real_values +real_values consist of any combination of the eight core modifier bits: ShiftMask, LockMask, @@ -3184,29 +3184,29 @@ added and removed from the server’s Mod1Mask - Mod5Mask. -affect_virtual +affect_virtual and -virtual_values +virtual_values are masks of virtual modifier bits indicating which virtual modifiers are to be added and removed from the server’s IgnoreLockMods control. Modifiers selected by both -affect_virtual +affect_virtual and -virtual_values +virtual_values are added to the server’s IgnoreLockMods control; those selected by -affect_virtual +affect_virtual but not by -virtual_values +virtual_values are removed from the server’s IgnoreLockMods control. See section 7.1 for a discussion of virtual modifier masks to use in -affect_virtual +affect_virtual and -virtual_values. +virtual_values. XkbSetIgnoreLockMods does not wait for a reply from the server. It returns True @@ -3285,8 +3285,8 @@ delivered to the client, use Bool XkbSetServerInternalMods Display *display @@ -3364,23 +3364,23 @@ virtual_values XkbSetServerInternalMods sends a request to the server to change the internal modifiers consumed by the server. -affect_real +affect_real and -real_values +real_values are masks of real modifier bits indicating which real modifiers are to be added and removed from the server’s internal modifiers control. Modifiers selected by both -affect_real +affect_real and -real_values +real_values are added to the server’s internal modifiers control; those selected by -affect_real +affect_real but not by -real_values +real_values are removed from the server’s internal modifiers mask. Valid values for -affect_real +affect_real and -real_values +real_values consist of any combination of the eight core modifier bits: ShiftMask, LockMask, @@ -3388,24 +3388,24 @@ selected by both Mod1Mask - Mod5Mask. -affect_virtual +affect_virtual and -virtual_values +virtual_values are masks of virtual modifier bits indicating which virtual modifiers are to be added and removed from the server’s internal modifiers control. Modifiers selected by both -affect_virtual +affect_virtual and -virtual_values +virtual_values are added to the server’s internal modifiers control; those selected by -affect_virtual +affect_virtual but not by -virtual_values +virtual_values are removed from the server’s internal modifiers control. See section 7.1 for a discussion of virtual modifier masks to use in -affect_virtual +affect_virtual and -virtual_values. +virtual_values. XkbSetServerInternalMods does not wait for a reply from the server. It returns True @@ -4317,7 +4317,7 @@ Use Status XkbGetControls +display, which, xkb) --> Display *display unsigned long which @@ -4363,41 +4363,41 @@ Use and then copies the server’s values for the requested information into the ctrls structure of the -xkb +xkb argument. Only those components specified by the -which +which parameter are copied. Valid values for -which +which are any combination of the masks listed in Table 10.7 that have "ok" in the -which +which column. If -xkb +xkb -> ctrls is NULL, XkbGetControls allocates and initializes it before obtaining the values specified by -which. +which. If -xkb +xkb -> ctrls is not NULL, XkbGetControls modifies only those portions of -xkb +xkb -> ctrls corresponding to the values specified by -which. +which. @@ -4410,11 +4410,11 @@ If if it cannot obtain sufficient storage, BadMatch if -xkb +xkb is NULL or -which +which is empty, or BadImplementation. @@ -4437,7 +4437,7 @@ The structure is always filled in by XkbGetControls, regardless of which bits are selected by -which. +which. @@ -4469,7 +4469,7 @@ To change the state of one or more controls, first modify the Bool XkbSetControls +display, which, xkb) --> Display *display unsigned long which @@ -4511,25 +4511,25 @@ To change the state of one or more controls, first modify the For each bit that is set in the -which +which parameter, XkbSetControls sends the corresponding values from the -xkb +xkb -> ctrls field to the server. Valid values for -which +which are any combination of the masks listed in Table 10.7 that have "ok" in the -which +which column. If -xkb +xkb -> ctrls is @@ -4653,7 +4653,7 @@ match those in the changed keyboard description. Bool XkbChangeControls Display *dpy @@ -4697,13 +4697,13 @@ match those in the changed keyboard description. XkbChangeControls copies any controls fields specified by -changes +changes from the keyboard description controls structure, -xkb +xkb -> ctrls, to the server specified by -dpy. +dpy. @@ -4862,9 +4862,9 @@ When a client receives an void XkbNoteControlsChanges XkbControlsChangesPtr changes @@ -4907,16 +4907,16 @@ When a client receives an The -wanted +wanted parameter is a bitwise inclusive OR of bits taken from the set of masks specified in Table 10.7 with "ok" in the changed_ctrls column. XkbNoteControlsChanges copies any changes reported in -new +new and specified in -wanted +wanted into the changes record specified by old. @@ -4936,9 +4936,9 @@ noted by one or more calls to Status XkbGetControlsChanges Display *dpy @@ -4982,16 +4982,16 @@ noted by one or more calls to XkbGetControlsChanges examines the -changes +changes parameter, queries the server for the necessary information, and copies the results into the -xkb +xkb -> ctrls keyboard description. If the ctrls field of -xkb +xkb is NULL, XkbGetControlsChanges @@ -5038,7 +5038,7 @@ allocate one by calling Status XkbAllocControls XkbDescPtr xkb @@ -5073,7 +5073,7 @@ allocate one by calling allocates the ctrls field of the -xkb +xkb parameter, initializes all fields to zero, and returns Success. If the @@ -5084,7 +5084,7 @@ If the simply returns Success. If -xkb +xkb is NULL, XkbAllocControls @@ -5100,7 +5100,7 @@ If The -which +which mask specifies the individual fields of the ctrls structure to be allocated and can contain any of the valid masks defined in @@ -5125,7 +5125,7 @@ structure, use void XkbFreeControls XkbDescPtr xkb @@ -5171,13 +5171,13 @@ structure, use frees the specified components of the ctrls field in the -xkb +xkb keyboard description and sets the corresponding structure component values to NULL or zero. The -which +which mask specifies the fields of ctrls to be freed and can contain any of the controls components specified in @@ -5187,7 +5187,7 @@ The If -free_all +free_all is True, XkbFreeControls @@ -5198,7 +5198,7 @@ If structure referenced by the ctrls member of -xkb, +xkb, and sets ctrls to @@ -5235,8 +5235,8 @@ To get the current values of the Bool XkbGetPerClientControls Display *dpy @@ -5269,7 +5269,7 @@ To get the current values of the XkbGetPerClientControls backfills -ctrls +ctrls with the per-client control attributes for this particular client. It returns @@ -5293,8 +5293,8 @@ To change the current values of the Bool XkbSetPerClientControls Display *dpy diff --git a/specs/XKB/ch11.xml b/specs/XKB/ch11.xml index 2fac8555..0e8ce22e 100644 --- a/specs/XKB/ch11.xml +++ b/specs/XKB/ch11.xml @@ -427,7 +427,7 @@ implemented, use XkbXlibControlsImplemented. unsigned int XkbXlibControlsImplemented Display *display @@ -468,7 +468,7 @@ To determine the current state of the Library Controls, use unsigned int XkbGetXlibControls Display *display @@ -510,7 +510,7 @@ To change the state of the Library Controls, use Bool XkbSetXlibControls Display *display @@ -554,18 +554,18 @@ To change the state of the Library Controls, use XkbSetXlibControls modifies the state of the controls selected by -bits_to_change +bits_to_change ; only the controls selected by -bits_to_change +bits_to_change are modified. If the bit corresponding to a control is on in -bits_to_change +bits_to_change and also on in values_for_bits, the control is enabled. If the bit corresponding to a control is on in -bits_to_change +bits_to_change but off in -values_for_bits, +values_for_bits, the control is disabled. -bits_to_change +bits_to_change should be an inclusive OR of bits from Table 11.1. diff --git a/specs/XKB/ch12.xml b/specs/XKB/ch12.xml index 43a356a2..c459ec23 100644 --- a/specs/XKB/ch12.xml +++ b/specs/XKB/ch12.xml @@ -238,7 +238,7 @@ level, use XkbKeycodeToKeysym. KeySym XkbKeycodeToKeysym Display *dpy @@ -294,11 +294,11 @@ level, use XkbKeycodeToKeysym. XkbKeycodeToKeysym returns the keysym bound to a particular group and shift level for a particular key on the core keyboard. If -kc +kc is not a legal keycode for the core keyboard, or if -group +group or -level +level are out of range for the specified key, XkbKeycodeToKeysym returns @@ -318,8 +318,8 @@ use unsigned int XkbKeysymToModifiers Display *dpy @@ -352,10 +352,10 @@ use XkbKeysymToModifiers finds the set of modifiers currently bound to the keysym -ks +ks on the core keyboard. The value returned is the mask of modifiers bound to the keysym -ks. +ks. If no modifiers are bound to the keysym, XkbKeysymToModifiers returns zero; otherwise, it returns the inclusive OR of zero or more of the @@ -384,11 +384,11 @@ Use Bool XkbLookupKeySym Display *dpy @@ -456,16 +456,16 @@ Use is the equivalent of the core XLookupKeySym function. For the core keyboard, given a keycode -key +key and an Xkb state -state, +state, XkbLookupKeySym returns the symbol associated with the key in -sym_rtrn +sym_rtrn and the list of modifiers that should still be applied in -mods_rtrn. +mods_rtrn. The -state +state parameter is the state from a KeyPress or @@ -495,12 +495,12 @@ Use int XkbLookupKeyBinding Display *dpy @@ -581,20 +581,20 @@ returned when the key is pressed and a specified list of modifiers are also being held down. XkbLookupKeyBinding returns in -buf +buf the string associated with the keysym -sym +sym and modifier state -state. -buf +state. +buf is NULL terminated unless there’s an overflow. If the string returned is larger than -nbytes, +nbytes, a count of bytes that does not fit into the buffer is returned in extra_rtrn. XkbTranslateKeySym returns the number of bytes that it placed into -buf. +buf. @@ -610,12 +610,12 @@ state, use int XkbTranslateKeySym Display *dpy @@ -692,22 +692,22 @@ state, use XkbTranslateKeySym applies the transformations specified in -mods +mods to the symbol specified by -sym_inout. +sym_inout. It returns in -buf +buf the string, if any, associated with the keysym for the current locale. If the transformations in -mods +mods changes the keysym, -sym_inout +sym_inout is updated accordingly. If the string returned is larger than -nbytes, +nbytes, a count of bytes that does not fit into the buffer is returned in extra_rtrn. XkbTranslateKeySym returns the number of bytes it placed into -buf. +buf. @@ -722,7 +722,7 @@ To update the keyboard description that is internal to the X library, use Status XkbRefreshKeyboardMapping +event) --> XkbMapNotifyEvent *event @@ -782,7 +782,7 @@ To translate a keycode to a key symbol and modifiers, use Booll XkbTranslateKeyCode +xkb, key, mods, mods_rtrn, keysym_rtrn) --> XkbDescPtr xkb KeyCode key @@ -845,9 +845,9 @@ To translate a keycode to a key symbol and modifiers, use -mods_rtrn +mods_rtrn is backfilled with the modifiers consumed by the translation process. -mods +mods is a bitwise inclusive OR of the legal modifier masks: ShiftMask, LockMask, diff --git a/specs/XKB/ch13.xml b/specs/XKB/ch13.xml index 5eca4884..ce160608 100644 --- a/specs/XKB/ch13.xml +++ b/specs/XKB/ch13.xml @@ -1097,8 +1097,8 @@ To load a keyboard geometry if you already have the keyboard description, use Status XkbGetGeometry Display *dpy @@ -1155,9 +1155,9 @@ description from this database by name, use Status XkbGetNamedGeometry Display *dpy @@ -1203,7 +1203,7 @@ description from this database by name, use can return BadName if the -name +name cannot be found. @@ -1247,8 +1247,8 @@ To determine the bounding box of the top surface of a shape, use Bool XkbComputeShapeTop XkbShapePtr shape @@ -1287,7 +1287,7 @@ of a rectangle that contains the outline that describes the top surface of the shape. The top surface is defined to be the approximating outline if the approx field of -shape +shape is not NULL. If @@ -1295,13 +1295,13 @@ If is NULL, the top surface is defined as the last outline in the -shape +shape ’s array of outlines. XkbComputeShapeTop returns False if -shape +shape is NULL or if there are no outlines for the shape; otherwise, it returns @@ -1325,7 +1325,7 @@ shape, use XkbComputeShapeBounds. Bool XkbComputeShapeBounds XkbShapePtr shape @@ -1349,7 +1349,7 @@ shape, use XkbComputeShapeBounds. updates the BoundsRec contained in the -shape +shape by examining all the outlines of the shape and setting the BoundsRec to the minimum x and minimum y, and maximum x and maximum y values found in @@ -1358,7 +1358,7 @@ those outlines. returns False if -shape +shape is NULL or if there are no outlines for the shape; otherwise, it returns @@ -1376,9 +1376,9 @@ To update the bounding box of a row, use XkbComputeRowBounds Bool XkbComputeRowBounds XkbGeometryPtr geom @@ -1422,7 +1422,7 @@ To update the bounding box of a row, use XkbComputeRowBounds XkbComputeRowBounds checks the bounds of all keys in the -row +row and updates the bounding box of the row if necessary. XkbComputeRowBounds returns @@ -1445,8 +1445,8 @@ that section. To update the bounding box of a section, use Bool XkbComputeSectionBounds XkbGeometryPtr geom @@ -1479,7 +1479,7 @@ that section. To update the bounding box of a section, use XkbComputeSectionBounds examines all the rows of the -section +section and updates the bounding box of that section so that it contains all rows. XkbComputeSectionBounds returns @@ -1502,9 +1502,9 @@ by using the primary name for a key that is part of an overlay, use char *XkbFindOverlayForKey XkbGeometryPtr geom @@ -1548,7 +1548,7 @@ by using the primary name for a key that is part of an overlay, use XkbFindOverlayForKey uses the primary name of the key, -under, +under, to look up the alternate name, which it returns. @@ -1592,9 +1592,9 @@ To add one property to an existing keyboard geometry description, use XkbPropertyPtr XkbAddGeomProperty XkbGeometryPtr geom @@ -1638,9 +1638,9 @@ To add one property to an existing keyboard geometry description, use XkbAddGeomProperty adds one property with the specified -name +name and -value +value to the keyboard geometry specified by geom. XkbAddGeomProperty returns @@ -1662,8 +1662,8 @@ To add one key alias to an existing keyboard geometry description, use XkbKeyAliasPtr XkbAddGeomKeyAlias XkbGeometryPtr geom @@ -1728,9 +1728,9 @@ To add one color name to an existing keyboard geometry description, use XkbColorPtr XkbAddGeomColor XkbGeometryPtr geom @@ -1776,9 +1776,9 @@ To add one color name to an existing keyboard geometry description, use adds the specified color name and -pixel +pixel to the specified geometry -geom. +geom. The top-level geometry description includes a list of up to MaxColors (32) @@ -1786,7 +1786,7 @@ The top-level geometry description includes a list of up to A color name is a string whose interpretation is not specified by Xkb and neither is the -pixel +pixel value’s interpretation. All other geometry data structures refer to colors using their indices in this global list or pointers to colors in this list. XkbAddGeomColor @@ -1809,8 +1809,8 @@ To add one outline to an existing shape, use XkbOutlinePtr XkbAddGeomOutline XkbShapePtr shape @@ -1844,9 +1844,9 @@ To add one outline to an existing shape, use An outline consists of an arbitrary number of points. XkbAddGeomOutline adds an outline to the specified -shape +shape by reserving -sz_points +sz_points points for it. The new outline is allocated and zeroed. XkbAddGeomOutline returns @@ -1868,9 +1868,9 @@ To add a shape to a keyboard geometry, use XkbShapePtr XkbAddGeomShape XkbGeometryPtr geom @@ -1916,11 +1916,11 @@ A geometry contains an arbitrary number of shapes, each of which is made up of an arbitrary number of outlines. XkbAddGeomShape adds a shape to a geometry -geom +geom by allocating space for -sz_outlines +sz_outlines outlines for it and giving it the name specified by name. If a shape with name -name +name already exists in the geometry, a pointer to the existing shape is returned. XkbAddGeomShape returns @@ -1942,7 +1942,7 @@ To add one key at the end of an existing row of keys, use XkbKeyPtr XkbAddGeomKey XkbRowPtr row @@ -1965,13 +1965,13 @@ To add one key at the end of an existing row of keys, use Keys are grouped into rows. XkbAddGeomKey adds one key to the end of the specified -row. +row. The key is allocated and zeroed. XkbAddGeomKey returns NULL if -row +row is empty or if it was not able to allocate space for the key. To allocate space for an arbitrary number of keys to a row, use XkbAllocGeomKeys. @@ -1988,11 +1988,11 @@ To add one section to an existing keyboard geometry, use XkbSectionPtr XkbAddGeomSection XkbGeometryPtr geom @@ -2059,17 +2059,17 @@ To add one section to an existing keyboard geometry, use A keyboard geometry contains an arbitrary number of sections. XkbAddGeomSection adds one section to an existing keyboard geometry -geom. +geom. The new section contains space for the number of rows, doodads, and overlays specified by -sz_rows, -sz_doodads, +sz_rows, +sz_doodads, and -sz_overlays. +sz_overlays. The new section is allocated and zeroed and given the name specified by -name. +name. If a section with name -name +name already exists in the geometry, a pointer to the existing section is returned. XkbAddGeomSection @@ -2092,8 +2092,8 @@ To add a row to a section, use XkbRowPtr XkbAddGeomRow XkbSectionPtr section @@ -2128,9 +2128,9 @@ One of the components of a keyboard geometry section is one or more rows of keys. XkbAddGeomRow adds one row to the specified -section. +section. The newly created row contains space for the number of keys specified in -sz_keys. +sz_keys. They are allocated and zeroed, but otherwise uninitialized. XkbAddGeomRow returns @@ -2153,9 +2153,9 @@ geometry, use XkbDoodadPtr XkbAddGeomDoodad XkbGeometryPtr geom @@ -2203,11 +2203,11 @@ A section. XkbAddGeomDoodad adds a doodad with name specified by name to the geometry -geom +geom if section is NULL or to the section of the geometry specified by section if -section +section is not NULL. XkbAddGeomDoodad @@ -2215,13 +2215,13 @@ section. NULL if any of the parameters is empty or if it was not able to allocate space for the doodad. If there is already a doodad with the name -name +name in the doodad array for the geometry (if -section +section is NULL ) or the section (if -section +section is non- NULL ), a pointer to that doodad is returned. To allocate space for an arbitrary @@ -2242,9 +2242,9 @@ To add one overlay to a section, use XkbOverlayPtr XkbAddGeomOverlay XkbSectionPtr section @@ -2288,10 +2288,10 @@ To add one overlay to a section, use XkbAddGeomOverlay adds an overlay with the specified name to the specified -section. +section. The new overlay is created with space allocated for sz_rows rows. If an overlay with name -name +name already exists in the section, a pointer to the existing overlay is returned. XkbAddGeomOverlay @@ -2314,8 +2314,8 @@ To add a row to an existing overlay, use XkbOverlayRowPtr XkbAddGeomOverlayRow XkbOverlayPtr overlay @@ -2360,11 +2360,11 @@ To add a row to an existing overlay, use XkbAddGeomOverlayRow adds one row to the -overlay. +overlay. The new row contains space for -sz_keys +sz_keys keys. If -row_under +row_under specifies a row that doesn’t exist on the underlying section, XkbAddGeomOverlayRow returns @@ -2389,8 +2389,8 @@ To add a key to an existing overlay row, use XkbOverlayKeyPtr XkbAddGeomOverlayKey XkbOverlayPtr overlay @@ -2434,11 +2434,11 @@ To add a key to an existing overlay row, use XkbAddGeomOverlayKey adds one key to the -row +row in the -overlay. +overlay. If there is no key named -under +under in the row of the underlying section, XkbAddGeomOverlayKey returns @@ -2487,8 +2487,8 @@ XkbAllocGeomOutlines. Status XkbAllocGeomOutlines XkbShapePtr shape @@ -2521,9 +2521,9 @@ XkbAllocGeomOutlines. XkbAllocGeomOutlines allocates space for -num_needed +num_needed outlines in the specified -shape. +shape. The outlines are not initialized. @@ -2539,10 +2539,10 @@ To free geometry outlines, use void XkbFreeGeomOutlines XkbShapePtr shape @@ -2613,8 +2613,8 @@ XkbAllocGeomKeys. Status XkbAllocGeomKeys XkbRowPtr row @@ -2662,10 +2662,10 @@ To free geometry keys, use void XkbFreeGeomKeys XkbRowPtr row @@ -2736,8 +2736,8 @@ To allocate geometry properties, use Status XkbAllocGeomProps XkbGeometryPtr geom @@ -2771,7 +2771,7 @@ To allocate geometry properties, use XkbAllocGeomProps allocates space for num_needed properties and adds them to the specified geometry -geom. +geom. No initialization of the properties is done. A geometry property associates an arbitrary string with an equally arbitrary name. Geometry properties can be used to provide hints to programs that display images of keyboards, but they @@ -2791,10 +2791,10 @@ To free geometry properties, use void XkbFreeGeomProperties XkbGeometryPtr geom @@ -2865,8 +2865,8 @@ To allocate geometry key aliases, use Status XkbAllocGeomKeyAliases XkbGeometryPtr geom @@ -2900,7 +2900,7 @@ To allocate geometry key aliases, use XkbAllocGeomKeyAliases allocates space for num_needed key aliases and adds them to the specified geometry -geom. +geom. A key alias is a pair of strings that associates an alternate name for a key with the real name for that key. @@ -2917,10 +2917,10 @@ To free geometry key aliases, use void XkbFreeGeomKeyAliases XkbGeometryPtr geom @@ -2976,10 +2976,10 @@ To free geometry key aliases, use If free_all is True, all aliases in the top level of the specified geometry -geom +geom are freed regardless of the value of first or count. Otherwise, count aliases in -geom +geom are freed beginning with the one specified by first. @@ -2995,8 +2995,8 @@ To allocate geometry colors, use Status XkbAllocGeomColors XkbGeometryPtr geom @@ -3029,7 +3029,7 @@ To allocate geometry colors, use XkbAllocGeomColors allocates space for num_needed colors and adds them to the specified geometry -geom. +geom. A color name is a string whose interpretation is not specified by Xkb. All other geometry data structures refer to colors using their indices in this global list or pointers to colors in this list. @@ -3047,10 +3047,10 @@ To free geometry colors, use void XkbFreeGeomColors XkbGeometryPtr geom @@ -3121,8 +3121,8 @@ To allocate points in an outline, use Status XkbAllocGeomPoints XkbOutlinePtr outline @@ -3155,9 +3155,9 @@ To allocate points in an outline, use XkbAllocGeomPoints allocates space for -num_needed +num_needed points in the specified -outline. +outline. The points are not initialized. @@ -3173,10 +3173,10 @@ To free points in a outline, use void XkbFreeGeomPoints XkbOutlinePtr outline @@ -3248,8 +3248,8 @@ To allocate space for an arbitrary number of geometry shapes, use Status XkbAllocGeomShapes XkbGeometryPtr geom @@ -3282,9 +3282,9 @@ To allocate space for an arbitrary number of geometry shapes, use XkbAllocGeomShapes allocates space for -num_needed +num_needed shapes in the specified geometry -geom. +geom. The shapes are not initialized. @@ -3300,10 +3300,10 @@ To free geometry shapes, use void XkbFreeGeomShapes XkbGeometryPtr geom @@ -3375,8 +3375,8 @@ To allocate geometry sections, use Status XkbAllocGeomSections XkbGeometryPtr geom @@ -3424,10 +3424,10 @@ To free geometry sections, use void XkbFreeGeomSections XkbGeometryPtr geom @@ -3499,8 +3499,8 @@ To allocate rows in a section, use Status XkbAllocGeomRows XkbSectionPtr section @@ -3548,10 +3548,10 @@ To free rows in a section, use void XkbFreeGeomRows XkbSectionPtr section @@ -3623,8 +3623,8 @@ To allocate overlays in a section, use Status XkbAllocGeomOverlays XkbSectionPtr section @@ -3672,10 +3672,10 @@ To free rows in an section, use void XkbFreeGeomOverlays XkbSectionPtr section @@ -3747,8 +3747,8 @@ To allocate rows in a overlay, use Status XkbAllocGeomOverlayRows XkbSectionPtr overlay @@ -3796,10 +3796,10 @@ To free rows in an overlay, use void XkbFreeGeomOverlayRows XkbSectionPtr overlay @@ -3871,8 +3871,8 @@ To allocate keys in an overlay row, use Status XkbAllocGeomOverlayKeys XkbRowPtr row @@ -3920,10 +3920,10 @@ To free keys in an overlay row, use void XkbFreeGeomOverlayKeys XkbRowPtr row @@ -3995,8 +3995,8 @@ To allocate doodads that are global to a keyboard geometry, use Status XkbAllocGeomDoodads XkbGeometryPtr geom @@ -4029,7 +4029,7 @@ To allocate doodads that are global to a keyboard geometry, use XkbAllocGeomDoodads allocates num_needed doodads and adds them to the specified geometry -geom. +geom. No initialization of the doodads is done. @@ -4045,8 +4045,8 @@ To allocate doodads that are specific to a section, use Status XkbAllocGeomSectionDoodads XkbSectionPtr section @@ -4079,7 +4079,7 @@ To allocate doodads that are specific to a section, use XkbAllocGeomSectionDoodads allocates num_needed doodads and adds them to the specified -section. +section. No initialization of the doodads is done. @@ -4095,9 +4095,9 @@ To free geometry doodads, use void XkbFreeGeomDoodads XkbDoodadPtr doodads @@ -4140,7 +4140,7 @@ To free geometry doodads, use If -free_all +free_all is True, all doodads in the array are freed, regardless of the value of count. @@ -4159,8 +4159,8 @@ To allocate an entire geometry, use Status XkbAllocGeometry XkbDescPtr xkb @@ -4212,9 +4212,9 @@ To free an entire geometry, use void XkbFreeGeometry XkbGeometryPtr geom diff --git a/specs/XKB/ch14.xml b/specs/XKB/ch14.xml index b6b634e6..3117b338 100644 --- a/specs/XKB/ch14.xml +++ b/specs/XKB/ch14.xml @@ -252,7 +252,7 @@ populated. XkbDescPtr XkbGetMap Display *display @@ -295,12 +295,12 @@ populated. The -which +which mask is a bitwise inclusive OR of the masks defined in Table 14.1. Only those portions of the keyboard server map and the keyboard client maps that are specified in -which +which are allocated and populated. @@ -309,7 +309,7 @@ specified in In addition to allocating and obtaining the server map and the client map, XkbGetMap also sets the -device_spec, +device_spec, the min_key_code, and @@ -336,7 +336,7 @@ When unsuccessful, one of the following protocol errors is also generated: structure), BadValue (some mask bits in -which +which are undefined), or BadImplementation @@ -501,7 +501,7 @@ description, use XkbGetUpdatedMap. Status XkbGetUpdatedMap Display *display @@ -544,11 +544,11 @@ description, use XkbGetUpdatedMap. The -which +which parameter is a bitwise inclusive OR of the masks in Table 14.1. If the needed components of the -xkb +xkb structure are not already allocated, XkbGetUpdatedMap allocates them. @@ -556,7 +556,7 @@ If the needed components of the fetches the requested information for the device specified in the XkbDescRec passed in the -xkb +xkb parameter. @@ -577,7 +577,7 @@ If unsuccessful, structure), BadValue (some mask bits in -which +which are undefined), BadImplementation (a compatible version of the Xkb extension is not available in the server or @@ -603,9 +603,9 @@ an Bool XkbSetMap Display *dpy @@ -651,29 +651,29 @@ Use XkbSetMap to send a complete new set of values for entire components (for example, all symbols, all actions, and so on) to the server. The -which +which parameter specifies the components to be sent to the server, and is a bitwise inclusive OR of the masks listed in Table 14.1. The -xkb +xkb parameter is a pointer to an XkbDescRec structure and contains the information to be copied to the server. For each bit set in the -which +which parameter, XkbSetMap takes the corresponding structure values from the -xkb +xkb parameter and sends it to the server specified by -dpy. +dpy. If any components specified by -which +which are not present in the -xkb +xkb parameter, XkbSetMap returns @@ -887,9 +887,9 @@ keyboard description, then call Bool XkbChangeMap Display *dpy @@ -933,19 +933,19 @@ keyboard description, then call XkbChangeMap copies any components specified by the -changes +changes structure from the keyboard description, -xkb, +xkb, to the X server specified by -dpy. +dpy. If any components specified by -changes +changes are not present in the -xkb +xkb parameter, XkbChangeMap returns @@ -1118,7 +1118,7 @@ To allocate and initialize an empty client map description record, use Status XkbAllocClientMap XkbDescPtr xkb @@ -1164,9 +1164,9 @@ To allocate and initialize an empty client map description record, use allocates and initializes an empty client map in the map field of the keyboard description specified by -xkb. +xkb. The -which +which parameter specifies the particular components of the client map structure to allocate and is a mask composed by a bitwise inclusive OR of one or more of the masks shown in Table 14.3. @@ -1189,11 +1189,11 @@ masks shown in Table 14.3. XkbKeyTypesMask The -type_count +type_count field specifies the number of entries to preallocate for the types field of the client map. If the -type_count +type_count field is less than XkbNumRequiredTypes (see section 15.2.1), returns @@ -1208,7 +1208,7 @@ The and max_key_code fields of the -xkb +xkb parameter are used to allocate the syms and @@ -1229,7 +1229,7 @@ The and max_key_code fields of the -xkb +xkb parameter are used to allocate the modmap field of the client map. The field is allocated to contain the maximum number @@ -1249,13 +1249,13 @@ of entries necessary for and max_key_code fields of the -xkb +xkb parameter must be legal values if the XkbKeySymsMask or XkbModifierMapMask masks are set in the -which +which parameter. If they are not valid, XkbAllocClientMap returns @@ -1271,7 +1271,7 @@ and any fields are already allocated in the client map, request. The only exception is the types array. If -type_count +type_count is greater than the current num_types field of the client map, @@ -1314,7 +1314,7 @@ To free memory used by the client map member of an void XkbFreeClientMap XkbDescPtr xkb @@ -1359,15 +1359,15 @@ To free memory used by the client map member of an XkbFreeClientMap frees the components of client map specified by -which +which in the XkbDescRec structure specified by the -xkb +xkb parameter and sets the corresponding structure component values to NULL. The -which +which parameter specifies a combination of the client map masks shown in Table 14.3. @@ -1375,10 +1375,10 @@ The If -free_all +free_all is True, -which +which is ignored; XkbFreeClientMap frees every non- @@ -1388,7 +1388,7 @@ If structure referenced by the map member of the -xkb +xkb parameter, and sets the map member to @@ -1410,7 +1410,7 @@ To allocate and initialize an empty server map description record, use Status XkbAllocServerMap XkbDescPtr xkb @@ -1456,9 +1456,9 @@ To allocate and initialize an empty server map description record, use allocates and initializes an empty server map in the server field of the keyboard description specified by -xkb. +xkb. The -which +which parameter specifies the particular components of the server map structure to allocate, as specified in Table 14.4. @@ -1484,7 +1484,7 @@ The and max_key_code fields of the -xkb +xkb parameter are used to allocate the explicit field of the server map. @@ -1498,11 +1498,11 @@ The and max_key_code fields of the -xkb +xkb parameter are used to allocate the key_acts field of the server map. The -count_acts +count_acts parameter is used to allocate the acts field of the server map. @@ -1516,7 +1516,7 @@ The and max_key_code fields of the -xkb +xkb parameter are used to allocate the behaviors field of the server map. @@ -1530,7 +1530,7 @@ The and max_key_code fields of the -xkb +xkb parameter are used to allocate the vmodmap field of the server map. @@ -1545,7 +1545,7 @@ field of the server map. and max_key_code fields of the -xkb +xkb parameter must be legal values. If they are not valid, XkbAllocServerMap returns @@ -1560,7 +1560,7 @@ If the server map of the keyboard description is not does not overwrite the existing values. The only exception is with the acts array. If the -count_acts +count_acts parameter is greater than the current num_acts field of the server map, @@ -1602,7 +1602,7 @@ To free memory used by the server member of an void XkbFreeServerMap XkbDescPtr xkb @@ -1650,18 +1650,18 @@ The function frees the specified components of server map in the XkbDescRec structure specified by the -xkb +xkb parameter and sets the corresponding structure component values to NULL. The -which +which parameter specifies a combination of the server map masks and is a bitwise inclusive OR of the masks listed in Table 14.4. If -free_all +free_all is True, -which +which is ignored and XkbFreeServerMap frees every non- @@ -1671,7 +1671,7 @@ inclusive OR of the masks listed in structure referenced by the server member of the -xkb +xkb parameter, and sets the server member to diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml index 183d49d5..6077c327 100644 --- a/specs/XKB/ch15.xml +++ b/specs/XKB/ch15.xml @@ -644,7 +644,7 @@ default values, use Status XkbInitCanonicalKeyTypes XkbDescPtr xkb @@ -690,9 +690,9 @@ default values, use initializes the first XkbNumRequiredTypes key types of the keyboard specified by the -xkb +xkb parameter to their default values. The -which +which parameter specifies what canonical key types to initialize and is a bitwise inclusive OR of the following masks: XkbOneLevelMask, @@ -701,7 +701,7 @@ inclusive OR of the following masks: and XkbKeypadMask. Only those canonical types specified by the -which +which mask are initialized. @@ -710,7 +710,7 @@ Only those canonical types specified by the If XkbKeypadMask is set in the -which +which parameter, XkbInitCanonicalKeyTypes looks up the @@ -731,7 +731,7 @@ initializing the KEYPAD key type. If the if the Xkb extension has not been properly initialized, and BadAccess if the -xkb +xkb parameter is not valid. @@ -753,10 +753,10 @@ use Status XkbGetKeyTypes Display *dpy @@ -831,9 +831,9 @@ If successful, it returns Success. if the Xkb extension has not been properly initialized and BadValue if the combination of -first +first and -num +num results in numbers out of valid range. @@ -852,11 +852,11 @@ To change the number of levels in a key type, use Status XkbResizeKeyType XkbDescPtr xkb @@ -923,16 +923,16 @@ To change the number of levels in a key type, use XkbResizeKeyType changes the type specified by -xkb +xkb -> map->types [ -type_ndx +type_ndx ], and reallocates the symbols and actions bound to all keys that use the type, if necessary. XkbResizeKeyType updates only the local copy of the types in -xkb +xkb ; to update the server’s copy for the physical device, use XkbSetMap or @@ -944,10 +944,10 @@ if necessary. The -map_count +map_count parameter specifies the total number of map entries needed for the type, and can be zero or greater. If -map_count +map_count is zero, XkbResizeKeyType frees the existing @@ -961,19 +961,19 @@ can be zero or greater. If The -want_preserve +want_preserve parameter specifies whether a preserve list for the key should be created. If -want_preserve +want_preserve is True, the preserve list with -map_count +map_count entries is allocated or reallocated if it already exists. Otherwise, if -want_preserve +want_preserve is False, the @@ -985,7 +985,7 @@ the The -new_num_lvls +new_num_lvls parameter specifies the new maximum number of shift levels for the type and is used to calculate and resize the symbols and actions bound to all keys that use the type. @@ -994,11 +994,11 @@ the type. If -type_ndx +type_ndx does not specify a legal type, -new_num_lvls +new_num_lvls is less than 1, or the -map_count +map_count is less than zero, XkbResizeKeyType returns @@ -1031,8 +1031,8 @@ Use Status XkbCopyKeyType XkbKeyTypePtr from @@ -1065,15 +1065,15 @@ Use XkbCopyKeyType copies the key type specified by -from +from to the key type specified by -into. +into. Both must point to legal XkbKeyTypeRec structures. Xkb assumes -from +from and -into +into point to different places. As a result, overlaps can be fatal. XkbCopyKeyType frees any existing @@ -1082,20 +1082,20 @@ Both must point to legal and level_names in -into +into prior to copying. If any allocation errors occur while copying -from +from to -into, +into, XkbCopyKeyType returns BadAlloc. Otherwise, XkbCopyKeyType copies -from +from to -into +into and returns Success. @@ -1106,9 +1106,9 @@ Otherwise, Status XkbCopyKeyTypes XkbKeyTypePtr from @@ -1152,39 +1152,39 @@ Otherwise, XkbCopyKeyTypes copies -num_types +num_types XkbKeyTypeRec structures from the array specified by -from +from into the array specified by -into. +into. It is intended for copying between, rather than within, keyboard descriptions, so it doesn’t check for overlaps. The same rules that apply to the -from +from and -into +into parameters in XkbCopyKeyType apply to each entry of the -from +from and -into +into arrays of XkbCopyKeyTypes. If any allocation errors occur while copying -from +from to -into, +into, XkbCopyKeyTypes returns BadAlloc. Otherwise, XkbCopyKeyTypes copies -from +from to -into +into and returns Success. @@ -1299,7 +1299,7 @@ currently four); if a key has fewer than int XkbKeyTypeIndex XkbDescPtr xkb @@ -1345,11 +1345,11 @@ currently four); if a key has fewer than computes an index into the types vector of the client map in -xkb +xkb from the given -keycode +keycode and -group +group index. @@ -1359,7 +1359,7 @@ currently four); if a key has fewer than XkbKeyTypePtr XkbKeyType XkbDescPtr xkb @@ -1405,11 +1405,11 @@ currently four); if a key has fewer than returns a pointer to the key type in the types vector of the client map in -xkb +xkb corresponding to the given -keycode +keycode and -group +group index. @@ -1514,7 +1514,7 @@ Xkb provides the following macros to access group information: int XkbKeyNumGroups XkbDescPtr xkb @@ -1547,7 +1547,7 @@ Xkb provides the following macros to access group information: XkbKeyNumGroups returns the number of groups of symbols bound to the key corresponding to -keycode. +keycode. @@ -1556,7 +1556,7 @@ Xkb provides the following macros to access group information: unsigned char XkbKeyGroupInfo XkbDescPtr xkb @@ -1593,7 +1593,7 @@ Xkb provides the following macros to access group information: field from the XkbSymMapRec structure associated with the key corresponding to -keycode. +keycode. @@ -1602,7 +1602,7 @@ Xkb provides the following macros to access group information: unsigned char XkbOutOfRangeGroupInfo unsigned char grp_inf @@ -1636,7 +1636,7 @@ Xkb provides the following macros to access group information: unsigned char XkbOutOfRangeGroupNumber unsigned char grp_inf @@ -1727,7 +1727,7 @@ of symbols bound to the key: int XkbKeyGroupsWidth XkbDescPtr xkb @@ -1760,7 +1760,7 @@ of symbols bound to the key: XkbKeyGroupsWidth computes the maximum width associated with the key corresponding to -keycode. +keycode. @@ -1769,7 +1769,7 @@ of symbols bound to the key: int XkbKeyGroupWidth XkbDescPtr xkb @@ -1813,9 +1813,9 @@ of symbols bound to the key: XkbKeyGroupWidth computes the width of the type associated with the group -grp +grp for the key corresponding to -keycode. +keycode. @@ -1824,7 +1824,7 @@ of symbols bound to the key: int XkbKeySymsOffset XkbDescPtr xkb @@ -1858,7 +1858,7 @@ of symbols bound to the key: XkbKeySymsOffset returns the offset of the two-dimensional array of keysyms for the key corresponding to -keycode. +keycode. @@ -1867,7 +1867,7 @@ corresponding to int XkbKeyNumSyms XkbDescPtr xkb @@ -1900,7 +1900,7 @@ corresponding to XkbKeyNumSyms returns the total number of keysyms for the key corresponding to -keycode. +keycode. @@ -1909,7 +1909,7 @@ corresponding to KeySym *XkbKeySymsPtr XkbDescPtr xkb @@ -1943,7 +1943,7 @@ corresponding to XkbKeySymsPtr returns the pointer to the two-dimensional array of keysyms for the key corresponding to -keycode. +keycode. @@ -1952,7 +1952,7 @@ corresponding to KeySym XkbKeySymEntry XkbDescPtr xkb @@ -2009,11 +2009,11 @@ corresponding to returns the keysym corresponding to shift level -shift +shift and group -grp +grp from the two-dimensional array of keysyms for the key corresponding to -keycode +keycode @@ -2032,10 +2032,10 @@ To obtain the symbols for a subset of the keys in a keyboard description, use Status XkbGetKeySyms Display *dpy @@ -2090,19 +2090,19 @@ To obtain the symbols for a subset of the keys in a keyboard description, use XkbGetKeySyms sends a request to the server to obtain the set of keysyms bound to -num +num keys starting with the key whose keycode is -first. +first. It waits for a reply and returns the keysyms in the map.syms field of -xkb. +xkb. If successful, XkbGetKeySyms returns Success. The -xkb +xkb parameter must be a pointer to a valid Xkb keyboard description. @@ -2111,7 +2111,7 @@ The If the client map in the -xkb +xkb parameter has not been allocated, XkbGetKeySyms allocates and initializes it before obtaining the symbols. @@ -2125,7 +2125,7 @@ extension has not been properly initialized, returns BadAccess. If -num +num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeySyms @@ -2153,12 +2153,12 @@ To change the number of groups and the types bound to a key, use Status XkbChangeTypesOfKey XkbDescPtr xkb @@ -2240,7 +2240,7 @@ initializes any new symbols or actions to or NoAction, as appropriate. If the -p_changes +p_changes parameter is not NULL, XkbChangeTypesOfKey @@ -2249,15 +2249,15 @@ as appropriate. If the to the changes field of -p_changes +p_changes and modifies the first_key_sym and num_key_syms fields of -p_changes +p_changes to include the -key +key that was changed. See section 14.3.1 for more information on the XkbMapChangesPtr structure. If successful, @@ -2269,9 +2269,9 @@ as appropriate. If the The -n_groups +n_groups parameter specifies the new number of groups for the key. The -groups +groups parameter is a mask specifying the groups for which new types are supplied and is a bitwise inclusive OR of the following masks: XkbGroup1Mask, @@ -2284,26 +2284,26 @@ and The -new_types_in +new_types_in parameter is an integer array of length -n_groups. +n_groups. Each entry represents the type to use for the associated group and is an index into -xkb +xkb -> map->types. The -new_types_in +new_types_in array is indexed by group index; if -n_groups +n_groups is four and -groups +groups only has Group1Mask and Group3Mask set, -new_types_in +new_types_in looks like this: @@ -2358,7 +2358,7 @@ If the Xkb extension has not been properly initialized, returns BadAccess. If the -xkb +xkb parameter it not valid (that is, it is NULL or it does not contain a valid client map), @@ -2366,13 +2366,13 @@ If the returns BadMatch. If the -key +key is not a valid keycode, -n_groups +n_groups is greater than XkbNumKbdGroups, or the -groups +groups mask does not contain any of the valid group mask bits, XkbChangeTypesOfKey returns @@ -2399,9 +2399,9 @@ To change the number of symbols bound to a key, use KeySym *XkbResizeKeySyms XkbDescRec *xkb @@ -2445,7 +2445,7 @@ To change the number of symbols bound to a key, use XkbResizeKeySyms reserves the space needed for -needed +needed keysyms and returns a pointer to the beginning of the new array that holds the keysyms. It adjusts the offset @@ -2457,7 +2457,7 @@ keysyms. It adjusts the and size_syms fields of -xkb +xkb - >map if it is necessary to reallocate the @@ -2470,7 +2470,7 @@ and If -needed +needed is greater than the current number of keysyms for the key, XkbResizeKeySyms initializes all new keysyms in the array to @@ -2558,10 +2558,10 @@ description, use Status XkbGetKeyModifierMap Display *dpy @@ -2616,11 +2616,11 @@ description, use XkbGetKeyModifierMap sends a request to the server for the modifier mappings for -num +num keys starting with the key whose keycode is -first. +first. It waits for a reply and places the results in the -xkb +xkb ->map->modmap array. If successful, XkbGetKeyModifier returns @@ -2630,7 +2630,7 @@ It waits for a reply and places the results in the If the map component of the -xkb +xkb parameter has not been allocated, XkbGetKeyModifierMap allocates and initializes it. diff --git a/specs/XKB/ch16.xml b/specs/XKB/ch16.xml index f7631e51..eaa6887c 100644 --- a/specs/XKB/ch16.xml +++ b/specs/XKB/ch16.xml @@ -164,7 +164,7 @@ to key actions: Bool XkbKeyHasActions XkbDescPtr xkb @@ -199,7 +199,7 @@ to key actions: returns True if the key corresponding to -keycode +keycode has any actions associated with it; otherwise, it returns False. @@ -210,7 +210,7 @@ to key actions: int XkbKeyNumActions XkbDescPtr xkb @@ -243,7 +243,7 @@ to key actions: XkbKeyNumActions computes the number of actions associated with the key corresponding to -keycode. +keycode. This should be the same value as the result of XkbKeyNumSyms (see section 15.3.3). @@ -255,7 +255,7 @@ This should be the same value as the result of XkbKeyActionPtr XkbKeyActionsPtr XkbDescPtr xkb @@ -289,7 +289,7 @@ This should be the same value as the result of XkbKeyActionsPtr returns a pointer to the two-dimensional array of key actions associated with the key corresponding to -keycode. +keycode. Use XkbKeyActionsPtr only if the key actually has some actions associated with it, that is, @@ -303,7 +303,7 @@ Use XkbAction XkbKeyAction XkbDescPtr xkb @@ -347,11 +347,11 @@ Use XkbKeyAction returns the key action indexed by -idx +idx in the two-dimensional array of key actions associated with the key corresponding to -keycode. -idx +keycode. +idx may be computed from the group and shift level of interest as follows: @@ -364,7 +364,7 @@ corresponding to XkbAction XkbKeyActionEntry XkbDescPtr xkb @@ -419,12 +419,12 @@ corresponding to XkbKeyActionEntry returns the key action corresponding to group -grp +grp and shift level lvl from the two-dimensional table of key actions associated with the key corresponding to -keycode. +keycode. @@ -656,7 +656,7 @@ is being used. In the latter case, this is the client -> modmap [ -keycode +keycode ] field. @@ -868,7 +868,7 @@ and the modifiers bound to the key (client -> modmap [ -keycode +keycode ]) are used instead. @@ -904,7 +904,7 @@ convert between the two formats: unsigned short XkbModActionVMods XkbAction act @@ -930,7 +930,7 @@ convert between the two formats: and vmods2 fields of -act +act converted to the vmods format of an Xkb modifier description. @@ -942,7 +942,7 @@ convert between the two formats: void XkbSetModActionVMods XkbAction act @@ -979,9 +979,9 @@ convert between the two formats: and vmods2 fields of -act +act using the -vmods +vmods format of an Xkb modifier description. @@ -1207,7 +1207,7 @@ convert between a signed integer value and a signed character: int XkbSAGroup XkbAction act @@ -1231,7 +1231,7 @@ convert between a signed integer value and a signed character: returns the group_XXX field of -act +act converted to a signed int. @@ -1241,7 +1241,7 @@ convert between a signed integer value and a signed character: void XkbSASetGroup XkbAction act @@ -1276,9 +1276,9 @@ convert between a signed integer value and a signed character: sets the group_XXX field of -act +act from the group index -grp. +grp. Despite the fact that the first parameter of these two macros is of @@ -1418,7 +1418,7 @@ convert between a signed integer and two signed 16-bit values in int XkbPtrActionX XkbPtrAction act @@ -1444,7 +1444,7 @@ convert between a signed integer and two signed 16-bit values in and low_XXX fields of -act +act converted to a signed int. @@ -1454,7 +1454,7 @@ convert between a signed integer and two signed 16-bit values in int XkbPtrActionY XkbPtrAction act @@ -1480,7 +1480,7 @@ convert between a signed integer and two signed 16-bit values in and low_YYY fields of -act +act converted to a signed int. @@ -1490,8 +1490,8 @@ convert between a signed integer and two signed 16-bit values in void XkbSetPtrActionX XkbPtrAction act @@ -1528,9 +1528,9 @@ convert between a signed integer and two signed 16-bit values in and low_XXX fields of -act +act from the signed integer value -x. +x. @@ -1539,7 +1539,7 @@ convert between a signed integer and two signed 16-bit values in void XkbSetPtrActionY XkbPtrAction act @@ -1576,9 +1576,9 @@ convert between a signed integer and two signed 16-bit values in and low_YYY fields of -act +act from the signed integer value -y. +y. @@ -1922,7 +1922,7 @@ values in int XkbSAPtrDfltValue XkbAction act @@ -1946,7 +1946,7 @@ values in returns the valueXXX field of -act +act converted to a signed int. @@ -1956,7 +1956,7 @@ values in void XkbSASetPtrDfltValue XkbPtrDfltAction act @@ -1991,9 +1991,9 @@ values in sets the valueXXX field of -act +act from -val. +val. @@ -2529,7 +2529,7 @@ signed character value for screen numbers in int XkbSAScreen XkbSwitchScreenAction act @@ -2553,7 +2553,7 @@ signed character value for screen numbers in returns the screenXXX field of -act +act converted to a signed int. @@ -2563,7 +2563,7 @@ signed character value for screen numbers in void XkbSASetScreen XkbSwitchScreenAction act @@ -2598,9 +2598,9 @@ signed character value for screen numbers in sets the screenXXX field of -act +act from -s. +s. @@ -2791,7 +2791,7 @@ macros, to convert between the two formats: unsigned int XkbActionCtrls XkbCtrlsAction act @@ -2815,7 +2815,7 @@ macros, to convert between the two formats: returns the ctrls fields of -act +act converted to an unsigned int. @@ -2825,7 +2825,7 @@ macros, to convert between the two formats: void XkbSAActionSetCtrls XkbCtrlsAction act @@ -2862,9 +2862,9 @@ macros, to convert between the two formats: through ctrls3 fields of -act +act from -ctrls. +ctrls. @@ -3200,7 +3200,7 @@ convert between the two formats: unsigned int XkbSARedirectVModsMask XkbRedirectKeyAction act @@ -3226,7 +3226,7 @@ convert between the two formats: and vmods_mask1 fields of -act +act converted to an unsigned int. @@ -3236,7 +3236,7 @@ convert between the two formats: void XkbSARedirectSetVModsMask XkbRedirectKeyAction act @@ -3273,9 +3273,9 @@ convert between the two formats: and vmods_mask1 fields of -act +act from -vm. +vm. @@ -3296,7 +3296,7 @@ provides the following convenience macros: unsigned int XkbSARedirectVMods XkbRedirectKeyAction act @@ -3317,7 +3317,7 @@ provides the following convenience macros: XkbSARedirectVModsMask returns the vmods0 - and vmods1 fields of act + and vmods1 fields of act converted to an unsigned int. @@ -3326,7 +3326,7 @@ provides the following convenience macros: void XkbSARedirectSetVMods XkbRedirectKeyAction act @@ -3357,7 +3357,7 @@ provides the following convenience macros: XkbSARedirectSetVModsMask sets the vmods0 - and vmods1 of act from v. + and vmods1 of act from v. @@ -3711,10 +3711,10 @@ To update the actions (the Status XkbGetKeyActions Display *dpy @@ -3769,21 +3769,21 @@ To update the actions (the XkbGetKeyActions sends a request to the server to obtain the actions for -num +num keys on the keyboard starting with key -first. +first. It waits for a reply and returns the actions in the server -> key_acts field of -xkb. +xkb. If successful, XkbGetKeyActions returns Success. The -xkb +xkb parameter must be a pointer to a valid Xkb keyboard description. @@ -3792,7 +3792,7 @@ The If the server map in the -xkb +xkb parameter has not been allocated, XkbGetKeyActions allocates and initializes it before obtaining the actions. @@ -3806,7 +3806,7 @@ has not been properly initialized, returns BadAccess. If -num +num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyActions @@ -3833,9 +3833,9 @@ To change the number of actions bound to a key, use XkbAction *XkbResizeKeyActions XkbDescRec *xkb @@ -3878,13 +3878,13 @@ To change the number of actions bound to a key, use The -xkb +xkb parameter points to the keyboard description containing the -key +key whose number of actions is to be changed. The -key +key parameter is the keycode of the key to change, and -needed +needed specifies the new number of actions required for the key. @@ -3898,7 +3898,7 @@ beginning of the new array that holds the actions. It can change the and size_acts fields of -xkb +xkb -> server if it is necessary to reallocate the @@ -3909,7 +3909,7 @@ array. If -needed +needed is greater than the current number of keysyms for the key, XkbResizeKeyActions initializes all new actions in the array to @@ -4158,10 +4158,10 @@ To obtain the behaviors (the Status XkbGetKeyBehaviors Display *dpy @@ -4216,15 +4216,15 @@ To obtain the behaviors (the XkbGetKeyBehaviors sends a request to the server to obtain the behaviors for -num +num keys on the keyboard starting with the key whose keycode is -first. +first. It waits for a reply and returns the behaviors in the server -> behaviors field of -xkb. +xkb. If successful, XkbGetKeyBehaviors returns @@ -4236,7 +4236,7 @@ If successful, If the server map in the -xkb +xkb parameter has not been allocated, XkbGetKeyBehaviors allocates and initializes it before obtaining the actions. @@ -4250,7 +4250,7 @@ has not been properly initialized, returns BadAccess. If -num +num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyBehaviors @@ -4393,10 +4393,10 @@ To obtain the explicit components (the Status XkbGetKeyExplicitComponents Display *dpy @@ -4451,21 +4451,21 @@ To obtain the explicit components (the XkbGetKeyExplicitComponents sends a request to the server to obtain the explicit components for -num +num keys on the keyboard starting with key -first. +first. It waits for a reply and returns the explicit components in the server -> explicit array of -xkb. +xkb. If successful, XkbGetKeyExplicitComponents returns Success. The -xkb +xkb parameter must be a pointer to a valid Xkb keyboard description. @@ -4474,7 +4474,7 @@ The If the server map in the -xkb +xkb parameter has not been allocated, XkbGetKeyExplicitComponents allocates and initializes it before obtaining the actions. @@ -4488,7 +4488,7 @@ has not been properly initialized, returns BadMatch. If -num +num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyExplicitComponents @@ -4613,9 +4613,9 @@ To obtain a subset of the virtual modifier bindings (the Status XkbGetVirtualMods Display *dpy @@ -4661,17 +4661,17 @@ To obtain a subset of the virtual modifier bindings (the sends a request to the server to obtain the vmods entries for the virtual modifiers specified in the mask, -which, +which, and waits for a reply. See section 7.1 for a description of how to determine the virtual modifier mask. For each bit set in -which, +which, XkbGetVirtualMods updates the corresponding virtual modifier definition in the server->vmods array of -xkb. +xkb. The -xkb +xkb parameter must be a pointer to a valid Xkb keyboard description. If successful, XkbGetVirtualMods @@ -4684,7 +4684,7 @@ successful, If the server map has not been allocated in the -xkb +xkb parameter, XkbGetVirtualMods allocates and initializes it before obtaining the virtual modifier bindings. @@ -4721,10 +4721,10 @@ To obtain the virtual modifier map (the Status XkbGetKeyVirtualModMap Display *dpy @@ -4779,21 +4779,21 @@ To obtain the virtual modifier map (the XkbGetKeyVirutalModmap sends a request to the server to obtain the virtual modifier mappings for -num +num keys on the keyboard starting with key -first. +first. It waits for a reply and returns the virtual modifier mappings in the server -> vmodmap array of -xkb. +xkb. If successful, XkbGetKeyVirtualModMap returns Success. The -xkb +xkb parameter must be a pointer to a valid Xkb keyboard description @@ -4802,7 +4802,7 @@ The If the server map in the -xkb +xkb parameter has not been allocated, XkbGetKeyVirtualModMap allocates and initializes it before obtaining the virtual modifier mappings. @@ -4816,7 +4816,7 @@ has not been properly initialized, returns BadMatch. If -num +num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyVirtualModMap diff --git a/specs/XKB/ch17.xml b/specs/XKB/ch17.xml index d32d57d3..284a724e 100644 --- a/specs/XKB/ch17.xml +++ b/specs/XKB/ch17.xml @@ -768,7 +768,7 @@ explicit override components of the server state. Status XkbGetCompatMap Display *display @@ -812,15 +812,15 @@ explicit override components of the server state. XkbGetCompatMap fetches the components of the compatibility map specified in -which +which from the server specified by -display +display and places them in the compat structure of the keyboard description -xkb. +xkb. Valid values for -which +which are an inclusive OR of the values shown in Table 17.2. @@ -861,7 +861,7 @@ Valid values for If no compatibility map structure is allocated in -xkb +xkb upon entry, XkbGetCompatMap allocates one. If one already exists, its contents are overwritten with the @@ -874,7 +874,7 @@ returned results. fetches compatibility map information for the device specified by the device_spec field of -xkb. +xkb. Unless you have specifically modified this field, it is the default keyboard device. XkbGetCompatMap @@ -888,11 +888,11 @@ work space, if the dpy field of the -xkb +xkb argument is non- NULL and does not match the -display +display argument, and BadLength under certain conditions caused by server or Xkb implementation errors. @@ -923,12 +923,12 @@ format mapping by calling the function Bool XkbUpdateMapFromCore XkbDescPtr xkb @@ -1006,53 +1006,53 @@ format mapping by calling the function XkbUpdateMapFromCore interprets input argument information representing a keyboard map in core format to update the Xkb keyboard description passed in -xkb. +xkb. Only a portion of the Xkb map is updated — the portion corresponding to keys with keycodes in the range -first_key +first_key through -first_key +first_key + -num_keys +num_keys - 1. If XkbUpdateMapFromCore is being called in response to a MappingNotify event, -first_key +first_key and -num_keys +num_keys are reported in the MappingNotify event. -core_keysyms +core_keysyms contains the keysyms corresponding to the keycode range being updated, in core keyboard description order. -map_width +map_width is the number of keysyms per key in -core_keysyms. +core_keysyms. Thus, the first -map_width +map_width entries in -core_keysyms +core_keysyms are for the key with keycode -first_key, +first_key, the next -map_width +map_width entries are for key -first_key +first_key + 1, and so on. In addition to modifying the Xkb keyboard mapping in -xkb, +xkb, XkbUpdateMapFromCore backfills the changes structure whose address is passed in -changes +changes to indicate the modifications that were made. You may then use -changes +changes in subsequent calls such as XkbSetMap, to propagate the local modifications to a server. @@ -1073,9 +1073,9 @@ key in a core keyboard mapping. Use int XkbKeyTypesForCoreSymbols XkbDescPtr xkb @@ -1153,14 +1153,14 @@ key in a core keyboard mapping. Use XkbKeyTypesForCoreSymbols expands the symbols in -core_syms +core_syms and types in -types_inout +types_inout according to the rules specified in section 12 of the core protocol, then chooses canonical key types (canonical key types are defined in section 15.2.1) for groups 1 and 2 using the rules specified by the Xkb protocol and places them in -xkb_syms_rtrn, +xkb_syms_rtrn, which will be non- NULL. @@ -1168,7 +1168,7 @@ which will be non- A core keymap is a two-dimensional array of keysyms. It has -map_width +map_width columns and max_key_code rows. @@ -1176,28 +1176,28 @@ A core keymap is a two-dimensional array of keysyms. It has takes a single row from a core keymap, determines the number of groups associated with it, the type of each group, and the symbols bound to each group. The return value is the number of groups, -types_inout +types_inout has the types for each group, and -xkb_syms_rtrn +xkb_syms_rtrn has the symbols in Xkb order (that is, groups are contiguous, regardless of size). -protected +protected contains the explicitly protected key types. There is one explicit override control associated with each of the four possible groups for each Xkb key, ExplicitKeyType1 through ExplicitKeyType4; -protected +protected is an inclusive OR of these controls. -map_width +map_width is the width of the core keymap and is not dependent on any Xkb definitions. -types_inout +types_inout is an array of four type indices. On input, -types_inout +types_inout contains the indices of any types already assigned to the key, in case they are explicitly protected from change. @@ -1205,11 +1205,11 @@ are explicitly protected from change. Upon return, -types_inout +types_inout contains any automatically selected (that is, canonical) types plus any protected types. Canonical types are assigned to all four groups if there are enough symbols to do so. The four entries in -types_inout +types_inout correspond to the four groups for the key in question. @@ -1228,9 +1228,9 @@ semantics updated, use Bool XkbApplyCompatMapToKey XkbDescPtr xkb @@ -1307,7 +1307,7 @@ the vector of Bool XkbSetCompatMap Display *display @@ -1362,16 +1362,16 @@ the vector of XkbSetCompatMap copies compatibility map information from the keyboard description in -xkb +xkb to the server specified in -display +display ’s compatibility map for the device specified by the device_spec field of -xkb. +xkb. Unless you have specifically modified this field, it is the default keyboard device. -which +which specifies the compatibility map components to be set, and is an inclusive OR of the bits shown in Table 17.2. @@ -1379,13 +1379,13 @@ of the bits shown in Table 17.2. After updating its compatibility map for the specified device, if -update_actions +update_actions is 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 +update_actions is False, the new compatibility map is not used to generate any modifications to the @@ -1395,9 +1395,9 @@ configured to match another on a piecemeal basis; the map should not be applied until everything is updated. To force an update at a later time, use XkbSetCompatMap specifying -which +which as zero and -update_actions +update_actions as True. @@ -1427,7 +1427,7 @@ use XkbSymInterpretPtr XkbAddSymInterpret XkbDescPtr xkb @@ -1482,19 +1482,19 @@ use XkbAddSymInterpret adds -si +si to the list of symbol interpretations in -xkb. +xkb. If -updateMap +updateMap is True, it (re)applies the compatibility map to all of the keys on the keyboard. If -changes +changes is non- NULL, it reports the parts of the keyboard that were affected (unless -updateMap +updateMap is True, not much changes). @@ -1643,7 +1643,7 @@ compatibility map if you do not already have one available. To do so, use Status XkbAllocCompatMap XkbDescPtr xkb @@ -1685,7 +1685,7 @@ compatibility map if you do not already have one available. To do so, use -xkb +xkb specifies the keyboard description for which compatibility maps are to be allocated. The compatibility map is the compat @@ -1694,18 +1694,18 @@ allocated. The compatibility map is the -which +which specifies the compatibility map components to be allocated (see XkbGetCompatMap, in section 17.2). -which +which is an inclusive OR of the bits shown in Table 17.2. -num_si +num_si specifies the total number of entries to allocate in the symbol interpretation vector ( xkb.compat.sym_interpret @@ -1723,11 +1723,11 @@ is sufficient space in the symbol interpretation vector for entries to be added, use XkbAllocCompatMap specifying -which +which as XkbSymInterpretMask and the number of free symbol interpretations needed in -num_si. +num_si. @@ -1738,7 +1738,7 @@ added, use if successful, BadMatch if -xkb +xkb is NULL, or @@ -1758,7 +1758,7 @@ To free an entire compatibility map or selected portions of one, use void XkbFreeCompatMap XkbDescPtr xkb @@ -1801,25 +1801,25 @@ To free an entire compatibility map or selected portions of one, use -which +which specifies the compatibility map components to be freed (see XkbGetCompatMap, in section 17.2). -which +which is an inclusive OR of the bits shown in Table 17.2 -free_map +free_map indicates whether the XkbCompatMap structure itself should be freed. If -free_map +free_map is True, -which +which is ignored, all non- NULL compatibility map components are freed, and the @@ -1827,7 +1827,7 @@ in section field in the XkbDescRec referenced by -xkb +xkb is set to NULL. diff --git a/specs/XKB/ch18.xml b/specs/XKB/ch18.xml index b494fc2f..56f7b125 100644 --- a/specs/XKB/ch18.xml +++ b/specs/XKB/ch18.xml @@ -372,7 +372,7 @@ To obtain symbolic names from the server, use Status XkbGetNames Display *dpy @@ -417,9 +417,9 @@ To obtain symbolic names from the server, use XkbGetNames retrieves symbolic names for the components of the keyboard extension from the X server. The -which +which parameter specifies the name components to be updated in the -xkb +xkb parameter, and is the bitwise inclusive OR of the valid names mask bits defined in Table 18.1. @@ -429,23 +429,23 @@ defined in Table 18.1. If the names field of the keyboard description -xkb +xkb is NULL, XkbGetNames allocates and initializes the names component of the keyboard description before obtaining the values specified by -which. +which. If the names field of -xkb +xkb is not NULL, XkbGetNames obtains the values specified by -which +which and copies them into the keyboard description Xkb. @@ -455,7 +455,7 @@ If the If the map component of the -xkb +xkb parameter is NULL, XkbGetNames @@ -464,7 +464,7 @@ If the or XkbKTLevelNamesMask are set in -which. +which. @@ -520,7 +520,7 @@ structure and call Bool XkbSetNames Display *dpy @@ -587,26 +587,26 @@ structure and call Use XkbSetNames to change many names at the same time. For each bit set in -which, +which, XkbSetNames takes the corresponding value (or values in the case of arrays) from the keyboard description -xkb +xkb and sends it to the server. The -first_type +first_type and -num_types +num_types arguments are used only if XkbKeyTypeNamesMask or XkbKTLevelNamesMask is set in -which +which and specify a subset of the types for which the corresponding names are to be changed. If either or both of these mask bits are set but the specified types are illegal, @@ -614,13 +614,13 @@ are illegal, returns False and does not update any of the names specified in -which. +which. The specified types are illegal if -xkb +xkb does not include a map component or if -first_type +first_type and -num_types +num_types specify types that are not defined in the keyboard description. @@ -769,7 +769,7 @@ various kinds of symbolic names, as shown in Bool XkbChangeNames Display *dpy @@ -813,16 +813,16 @@ various kinds of symbolic names, as shown in XkbChangeNames copies any names specified by -changes +changes from the keyboard description, -xkb, +xkb, to the X server specified by -dpy. +dpy. XkbChangeNames aborts and returns False if any illegal type names or type shift level names are specified by -changes. +changes. @@ -926,9 +926,9 @@ When your application receives a X void XkbNoteNameChanges XkbNameChangesPtr old @@ -971,16 +971,16 @@ When your application receives a X The -wanted +wanted parameter is the bitwise inclusive OR of the valid names mask bits shown in Table 18.1. XkbNoteNameChanges copies any changes that are reported in -new +new and specified in -wanted +wanted into the changes record specified by -old. +old. @@ -998,9 +998,9 @@ pass to Status XkbGetNameChanges Display *dpy @@ -1044,10 +1044,10 @@ pass to XkbGetNameChanges examines the -changes +changes parameter, retrieves the necessary information from the server, and places the results into the -xkb +xkb keyboard description. @@ -1084,7 +1084,7 @@ from the X server. Instead use Status XkbAllocNames +xkb, which, num_rg, num_key_aliases) --> XkbDescPtr xkb unsigned int which @@ -1144,7 +1144,7 @@ from the X server. Instead use BadValue errors. The -which +which parameter is the bitwise inclusive OR of the valid names mask bits defined in Table 18.1. @@ -1166,7 +1166,7 @@ Use void XkbFreeNames +xkb, which, free_map) --> XkbDescPtr xkb unsigned int which @@ -1209,7 +1209,7 @@ Use The -which +which parameter is the bitwise inclusive OR of the valid names mask bits defined in Table 18.1. diff --git a/specs/XKB/ch20.xml b/specs/XKB/ch20.xml index f227d8e8..fa892d86 100644 --- a/specs/XKB/ch20.xml +++ b/specs/XKB/ch20.xml @@ -169,10 +169,10 @@ To obtain this list, use XkbComponentListPtr XkbListComponents Display *dpy @@ -228,12 +228,12 @@ To obtain this list, use XkbListComponents queries the server for a list of component names matching the patterns specified in -ptrns. +ptrns. It waits for a reply and returns the matching component names in an XkbComponentListRec structure. When you are done using the structure, you should free it using XkbFreeComponentList. -device_spec +device_spec indicates a particular device in which the caller is interested. A server is allowed (but not required) to restrict its reply to portions of the database that are relevant for that particular device. @@ -241,11 +241,11 @@ that are relevant for that particular device. -ptrns +ptrns is a pointer to an XkbComponentNamesRec, described below. Each of the fields in -ptrns +ptrns contains a pattern naming the components of interest. Each of the patterns is composed of characters from the ISO Latin1 @@ -279,12 +279,12 @@ from the pattern. -max_inout +max_inout is used to throttle the amount of data passed to and from the server. On input, it specifies the maximum number of names to be returned (the total number of names in all component categories). Upon return from XkbListComponents, -max_inout +max_inout contains the number of names that matched the request but were not returned because of the limit. @@ -553,12 +553,12 @@ one, use XkbDescPtr XkbGetKeyboardByName Display *dpy @@ -633,12 +633,12 @@ one, use -names +names contains a set of expressions describing the keyboard components the server should use to build the new keyboard description. -want +want and -need +need are bit fields describing the parts of the resulting keyboard description that should be present in the returned XkbDescRec. @@ -647,7 +647,7 @@ should be present in the returned The individual fields in -names +names are component expressions composed of keyboard component names (no wildcarding as may be used in @@ -691,7 +691,7 @@ and The special component name ‘ % ’ refers to the keyboard description for the device specified in -device_spec +device_spec or the keymap names component. If a keymap names component is specified that does not begin with ‘+’ or ‘|’ and does not contain ‘ % @@ -699,7 +699,7 @@ does not begin with ‘+’ or ‘|’ and does not contain ‘ % ’ refers to the description generated by the keymap names component. Otherwise, it refers to the keyboard description for -device_spec. +device_spec. @@ -768,13 +768,13 @@ ordering are. Note that the presence of a keymap -names +names component that does not contain ‘ % ’ (either explicit or implied by virtue of an expression starting with an operator) indicates a description that is independent of the keyboard description for the device specified in -device_spec. +device_spec. The same is true of requests in which the keymap names component is empty and all five other names components contain expressions void of references to ‘ @@ -788,36 +788,36 @@ independent of any actual device. The server parses all non- NULL fields in -names +names and uses them to build a keyboard description. However, before parsing the expressions in -names, +names, the server ORs the bits in -want +want and -need +need together and examines the result in relationship to the expressions in -names. +names. Table 20.3 identifies the components that are required for each of the possible bits in -want +want or -need. +need. If a required component has not been specified in the -names +names structure (the corresponding field is NULL ), the server substitutes the expression " % ", resulting in the component values being taken from -device_spec. +device_spec. In addition, if -load +load is True, the server modifies -names +names if necessary (again using a " % " entry) to ensure all of the following fields are non- @@ -900,12 +900,12 @@ and -need +need specifies a set of keyboard components that the server must be able to resolve in order for XkbGetKeyboardByName to succeed; if any of the components specified in -need +need cannot be successfully resolved, XkbGetKeyboardByName fails. @@ -913,49 +913,49 @@ in order for -want +want specifies a set of keyboard components that the server should attempt to resolve, but that are not mandatory. If the server is unable to resolve any of these components, XkbGetKeyboardByName still succeeds. Bits specified in -want +want that are also specified in -need +need have no effect in the context of -want. +want. If -load +load is True, the server updates its keyboard description for -device_spec +device_spec to match the result of the keyboard description just built. If load is False, the server’s description for device -device_spec +device_spec is not updated. In all cases, the parts specified by -want +want and -need +need from the just-built keyboard description are returned. The -names +names structure in an XkbDescRec keyboard description record (see ) contains one field for each of the five component types used to build a keyboard description. When a keyboard description is built from a set of database components, the corresponding fields in this -names +names structure are set to match the expressions used to build the component. @@ -1067,9 +1067,9 @@ XkbGetNames(dpy, XkbKeyNamesMask | XkbKeyAliasesMask, Xkb) There is no way to determine which components specified in -want +want (but not in -need +need ) were actually fetched, other than breaking the call into successive calls to XkbGetKeyboardByName and specifying individual components. @@ -1113,9 +1113,9 @@ database, use XkbDescPtr XkbGetKeyboard Display *dpy @@ -1168,11 +1168,11 @@ keyboard device. It calls XkbGetKeyboardByName ( -dpy, -device_spec, +dpy, +device_spec, NULL, -which, -which, +which, +which, False ). diff --git a/specs/XKB/ch21.xml b/specs/XKB/ch21.xml index 63d7add5..28d87ae1 100644 --- a/specs/XKB/ch21.xml +++ b/specs/XKB/ch21.xml @@ -132,7 +132,7 @@ keyboard feedback and the core indicator feedback may be obtained by calling and specifying XkbUseCoreKbd as the -device_spec +device_spec ; the values will be returned in dflt_kbd_id and @@ -376,7 +376,7 @@ indicator maps, indicator names or button actions on a non- XkbDeviceInfoPtr XkbGetDeviceInfo Display *dpy @@ -442,11 +442,11 @@ which, device_spec, ind_class, ind_id) --> XkbGetDeviceInfo returns information about the input device specified by -device_spec. +device_spec. Unlike the -device_spec +device_spec parameter of most Xkb functions, -device_spec +device_spec does not need to be a keyboard device. It must, however, indicate either the core keyboard or a valid X Input Extension device. @@ -454,7 +454,7 @@ core keyboard or a valid X Input Extension device. The -which +which parameter is a mask specifying optional information to be returned. It is an inclusive OR of one or more of the values from Table 21.1 @@ -480,7 +480,7 @@ The and dflt_kbd_fb. Other fields are filled in as specified by -which. +which. @@ -498,7 +498,7 @@ the server implementation, and a client may modify the associated behavior. If the XkbButtonActionsMask bit is set in -which, +which, the XkbDeviceInfoRec returned will have the button actions ( @@ -509,7 +509,7 @@ the If -which +which includes one of the bits in XkbXI_IndicatorsMask, the feedback class of the indicators must be specified in ind_class, and the feedback ID of the indicators must be specified in ind_id. If the request does not include any of @@ -523,15 +523,15 @@ XListInputDevices request. If any of the XkbXI_IndicatorsMask bits are set in -which, +which, the XkbDeviceInfoRec returned will have filled in the portions of the leds structure corresponding to the indicator feedback identified by -ind_class +ind_class and -ind_id. +ind_id. The leds vector of the @@ -548,11 +548,11 @@ The fields of the leds entry corresponding to -ind_class +ind_class and -ind_id +ind_id are always filled in. If -which +which contains XkbXI_IndicatorNamesMask, the @@ -562,18 +562,18 @@ the fields of the leds structure corresponding to -ind_class +ind_class and -ind_id +ind_id are returned. If -which +which contains XkbXI_IndicatorStateMask, the corresponding state field is updated. If -which +which contains XkbXI_IndicatorMapsMask, the @@ -593,7 +593,7 @@ take an XkbDeviceInfoPtr as an input argument and operate on the X Input Extension device specified by the -device_spec +device_spec field of the structure. Only the parts of the structure indicated in the function description are updated. The XkbDeviceInfo @@ -619,7 +619,7 @@ XkbGetDeviceButtonActions. Status XkbGetDeviceButtonActions Display *dpy @@ -688,13 +688,13 @@ XkbGetDeviceButtonActions. by the device_spec field of -device_info +device_info and waits for a reply. If successful, XkbGetDeviceButtonActions backfills the button actions ( btn_acts field of -device_info +device_info ) for only the requested buttons, updates the name, type, @@ -707,21 +707,21 @@ and -all_buttons, -first_button +all_buttons, +first_button and -num_buttons +num_buttons specify the device buttons for which actions should be returned. Setting -all_buttons +all_buttons to True requests actions for all device buttons; if -all_buttons +all_buttons is False, -first_button +first_button and -num_buttons +num_buttons specify a range of buttons for which actions are requested. @@ -733,7 +733,7 @@ extension has not been properly initialized, XkbGetDeviceButtonActions returns If allocation errors occur, a BadAlloc status is returned. If the specified device ( -device_info +device_info -> device_spec ) is invalid, a @@ -741,9 +741,9 @@ If allocation errors occur, a status is returned. If the device has no buttons, a BadMatch status is returned. If -first_button +first_button and -num_buttons +num_buttons specify illegal buttons, a BadValue status is returned. @@ -761,7 +761,7 @@ of an input extension device, use XkbGetDeviceLedInfo. Status XkbGetDeviceLedInfo Display *dpy @@ -828,23 +828,23 @@ nfo, led_class, led_id, which) --> XkbGetDeviceLedInfo queries the server for the desired LED information for the feedback specified by -led_class +led_class and -led_id +led_id for the X input extension device indicated by device_spec -> -device_info +device_info and waits for a reply. If successful, XkbGetDeviceLedInfo backfills the relevant fields of -device_info +device_info as determined by -which +which with the results and returns Success. Valid values for -which +which are the inclusive OR of any of XkbXI_IndicatorNamesMask, XkbXI_IndicatorMapsMask, @@ -855,7 +855,7 @@ and The fields of -device_info +device_info that are filled in when this request succeeds are name, type, supported, and @@ -863,11 +863,11 @@ and and portions of the leds structure corresponding to -led_class +led_class and -led_id +led_id as indicated by the bits set in -which. +which. The device_info->leds vector is allocated if necessary and @@ -875,25 +875,25 @@ The and num_leds filled in. The -led_class, -led_id +led_class, +led_id and phys_indicators fields of the -device_info +device_info -> leds entry corresponding to -led_class +led_class and -led_id +led_id are always filled in. If -which +which contains XkbXI_IndicatorNamesMask, the @@ -901,21 +901,21 @@ the and names fields of the -device_info +device_info -> leds structure corresponding to -led_class +led_class and -led_id +led_id are updated, if -which +which contains XkbXI_IndicatorStateMask, the corresponding state field is updated, and if -which +which contains XkbXI_IndicatorMapsMask, the @@ -1009,16 +1009,16 @@ To obtain an allocates space for an XkbDeviceInfoRec structure and initializes that structure’s -device_spec +device_spec field with the device ID specified by device_spec. If -n_buttons +n_buttons is nonzero, -n_buttons +n_buttons XkbActions are linked into the XkbDeviceInfoRec structure and initialized to zero. If sz_leds is nonzero, -sz_leds +sz_leds XkbDeviceLedInfoRec structures are also allocated and linked into the XkbDeviceInfoRec @@ -1074,9 +1074,9 @@ To obtain an allocates space for an XkbDeviceLedInfoRec and places it in -device_info. +device_info. If num_needed is nonzero, -num_needed +num_needed XkbIndicatorMapRec structures are also allocated and linked into the XkbDeviceLedInfoRec @@ -1141,28 +1141,28 @@ To initialize an XkbAddDeviceLedInfo first checks to see whether an entry matching -led_class +led_class and -led_id +led_id already exists in the device_info->leds array. If it finds a matching entry, it returns a pointer to that entry. Otherwise, it checks to be sure there is at least one empty entry in -device_info +device_info -> leds and extends it if there is not enough room. It then increments -device_info +device_info -> num_leds and fills in the next available entry in -device_info +device_info -> leds with -led_class +led_class and -led_id. +led_id. @@ -1173,13 +1173,13 @@ If successful, XkbDeviceLedInfoRec structure that was initialized. If unable to allocate sufficient storage, or if -device_info +device_info points to an invalid XkbDeviceInfoRec structure, or if -led_class +led_class or -led_id +led_id are inappropriate, XkbAddDeviceLedInfo returns @@ -1230,17 +1230,17 @@ To allocate additional space for button actions in an XkbResizeDeviceButton reallocates space, if necessary, to make sure there is room for a total of -new_total +new_total button actions in the -device_info +device_info structure. Any new entries allocated are zeroed. If successful, XkbResizeDeviceButton returns Success. If new_total is zero, all button actions are deleted, -device_info +device_info -> num_btns is set to zero, and -device_info +device_info -> btn_acts is set to @@ -1310,56 +1310,56 @@ If free_all is the XkbFreeDeviceInfo frees all components of -device_info +device_info and the XkbDeviceInfoRec structure pointed to by -device_info +device_info itself. If free_all is False, the value of which determines which subcomponents are freed. -which +which is an inclusive OR of one or more of the values from Table 21.1. If which contains XkbXI_ButtonActionsMask, all button actions associated with -device_info +device_info are freed, -device_info +device_info -> btn_acts is set to NULL, and -device_info +device_info -> num_btns is set to zero. If which contains all bits in XkbXI_IndicatorsMask, all XkbDeviceLedInfoRec structures associated with -device_info +device_info are freed, -device_info +device_info -> leds is set to NULL, and -device_info +device_info -> sz_leds and -device_info +device_info -> num_leds are set to zero. If which contains XkbXI_IndicatorMapsMask, all indicator maps associated with -device_info +device_info are cleared, but the number of LEDs and the leds structures themselves are preserved. If which contains XkbXI_IndicatorNamesMask, all indicator names associated with device_info are cleared, but the number of LEDs and the leds structures themselves are preserved. If which contains XkbXI_IndicatorStateMask, the indicator state associated with the -device_info +device_info leds are set to zeros but the number of LEDs and the leds structures themselves are preserved. @@ -1431,7 +1431,7 @@ use XkbSetDeviceInfo. Bool XkbSetDeviceInfo Display *dpy @@ -1476,12 +1476,12 @@ which, device_info) --> XkbSetDeviceInfo sends a request to the server to modify the characteristics of the device specified in the -device_info +device_info structure. The particular characteristics modified are identified by the bits set in -which +which and take their values from the relevant fields in -device_info +device_info (see Table 21.1). XkbSetDeviceInfo returns @@ -1495,14 +1495,14 @@ Xkb Extension, the function does nothing and returns The -which +which parameter specifies which aspects of the device should be changed and is a bitmask composed of an inclusive OR or one or more of the following bits: XkbXI_ButtonActionsMask, XkbXI_IndicatorNamesMask, XkbXI_IndicatorMapsMask. If the features requested to be manipulated in -which +which are valid for the device, but the server does not support assignment of one or more of them, that particular portion of the request is ignored. @@ -1510,7 +1510,7 @@ more of them, that particular portion of the request is ignored. If the device specified in -device_info +device_info -> device_spec does not contain buttons and a request affecting buttons is made, or the @@ -1529,11 +1529,11 @@ extension allows applications to assign key actions to buttons on input extension devices other than the core keyboard device. If the XkbXI_ButtonActionsMask is set in -which, +which, the actions for all buttons specified in device_info are set to the XkbAction s specified in -device_info +device_info -> btn_acts. If the number of buttons requested to be updated is not valid for the device, @@ -1565,20 +1565,20 @@ If the and / or XkbXI_IndicatorNamesMask flag is set in -which, +which, the indicator maps and / or names for all -device_info +device_info -> num_leds indicator devices specified in -device_info +device_info -> leds are set to the maps and / or names specified in -device_info +device_info -> leds. -device_info +device_info -> leds -> @@ -1596,7 +1596,7 @@ If they have legal values but do not specify a keyboard or indicator class feedback for the device in question, a BadMatch error results. If any of the values in -device_info +device_info -> leds -> @@ -1629,7 +1629,7 @@ XkbSetDeviceButtonActions. Bool XkbSetDeviceButtonActions Display *dpy @@ -1687,11 +1687,11 @@ device, first_button, num_buttons, actions) --> device_info-> device_spec. Actions are assigned to -num_buttons +num_buttons buttons beginning with -first_button +first_button and are taken from the actions specified in -device_info +device_info -> btn_acts. @@ -1704,11 +1704,11 @@ buttons, has no effect and returns False. If the device has no buttons or if -first_button +first_button or -num_buttons +num_buttons specify buttons outside of the valid range as determined by -device_info +device_info -> num_btns, the function has no effect and returns @@ -1729,7 +1729,7 @@ device_info-> device_spec, a BadKeyboard protocol error results. If the actual device specified in -device_info +device_info -> device_spec does not contain buttons and a request affecting buttons is made, a @@ -1903,7 +1903,7 @@ To note device changes reported in an void XkbNoteDeviceChanges XkbDeviceChangesPtr old @@ -1946,23 +1946,23 @@ To note device changes reported in an The wanted field specifies the changes that should be noted in -old, +old, and is composed of the bitwise inclusive OR of one or more of the masks from Table 21.1. The reason field of the event in -new +new indicates the types of changes the event is reporting. XkbNoteDeviceChanges updates the XkbDeviceChangesRec specified by -old +old with the changes that are both specified in -wanted +wanted and contained in -new +new -> reason. @@ -1988,8 +1988,8 @@ XkbGetDeviceInfoChanges. Status XkbGetDeviceInfoChanges Display *dpy @@ -2033,17 +2033,17 @@ changes) --> The changes->changed field indicates which attributes of the device specified in -changes +changes -> device have changed. The parameters describing the changes are contained in the other fields of -changes. +changes. XkbGetDeviceInfoChanges uses that information to call XkbGetDeviceInfo to obtain the current status of those attributes that have changed. It then updates the local description of the device in -device_info +device_info with the new information. @@ -2059,7 +2059,7 @@ XkbDeviceChangesRec, use XkbChangeDeviceInfo. Bool XkbChangeDeviceInfo Display *dpy @@ -2103,13 +2103,13 @@ XkbDeviceChangesRec, use XkbChangeDeviceInfo. XkbChangeDeviceInfo updates the server’s description of the device specified in -device_info +device_info -> device_spec with the changes specified in -changes +changes and contained in -device_info. +device_info. The update is made by an XkbSetDeviceInfo request. diff --git a/specs/XKB/ch22.xml b/specs/XKB/ch22.xml index 94f7d02b..8fab203c 100644 --- a/specs/XKB/ch22.xml +++ b/specs/XKB/ch22.xml @@ -24,7 +24,7 @@ To change the values of any of the debug controls, use Bool XkbSetDebuggingFlags Display *display @@ -123,62 +123,62 @@ To change the values of any of the debug controls, use XkbSetDebuggingFlags modifies the debug output flags as specified by -mask +mask and -flags, +flags, modifies the debug controls flags as specified by -ctrls_mask +ctrls_mask and -ctrls, +ctrls, prints the message -msg, +msg, and backfills -ret_flags +ret_flags and -ret_ctrls +ret_ctrls with the resulting debug output and debug controls flags. When bits are set in the debug output masks, -mask +mask and -flags, +flags, Xkb prints debug information corresponding to each bit at appropriate points during its processing. The device to which the output is written is implementation-dependent, but is normally the same device to which X server error messages are directed; thus the bits that can be set in -mask +mask and -flags +flags is implementation-specific. To turn on a debug output selection, set the bit for the output in the -mask +mask parameter and set the corresponding bit in the -flags +flags parameter. To turn off event selection for an event, set the bit for the output in the -mask +mask parameter and do not set the corresponding bit in the -flags +flags parameter. When bits are set in the debug controls masks, -ctrls_mask +ctrls_mask and -ctrls, +ctrls, Xkb modifies its behavior according to each controls bit. -ctrls_mask +ctrls_mask and -ctrls +ctrls are related in the same way that -mask +mask and -flags +flags are. The valid controls bits are defined in Table 22.1. @@ -230,7 +230,7 @@ it is disabled, The message in -msg +msg is written immediately. The device to which it is written is implementation dependent but is normally the same device where X server error messages are directed.