diff --git a/specs/XKB/ch02.xml b/specs/XKB/ch02.xml index 9b00d4df..4bef7572 100644 --- a/specs/XKB/ch02.xml +++ b/specs/XKB/ch02.xml @@ -92,39 +92,42 @@ version of the library, although this should not normally occur.) To determine the compatibility of a library at runtime, call XkbLibraryVersion. - - - - - - - -Bool -XkbLibraryVersion -( +XkbLibraryVersion + + + Bool XkbLibraryVersion + + + int *lib_major_in_out + int *lib_minor_in_out + + + + + + lib_major_in_out + + + + specifies and returns the major Xkb library version. + + + + + + lib_minor_in_out + + + + specifies and returns the minor Xkb library version. + + + + Pass the symbolic value @@ -201,65 +204,84 @@ XkbQueryExtension and initializes the extension when it is present. - - - - - - - -Bool -XkbQueryExtension -( +XkbQueryExtension + + + Bool XkbQueryExtension + + + Display *dpy + int *opcode_rtrn + int *event_rtrn + int *error_rtrn + int *major_in_out + int *minor_in_out + + + + + + dpy + + + + connection to the X server + + + + + + opcode_rtrn + + + + backfilled with the major extension opcode + + + + + + event_rtrn + + + + backfilled with the extension base event code + + + + + + error_rtrn + + + + backfilled with the extension base error code + + + + + + major_in_out + + + + compile time lib major version in, server major version out + + + + + + minor_in_out + + + + compile time lib min version in, server minor version out + + + + The @@ -304,66 +326,85 @@ for a compatible version of the Xkb extension in both the library and the server, and initialize the extension for use. - - - - - - - -Display * -XkbOpenDisplay -( +XkbOpenDisplay + + + Display *XkbOpenDisplay + + + char *display_name + int *event_rtrn + int *error_rtrn + int *major_in_out + int *minor_in_out + int *reason_rtrn + + + + + + display_name + + + + hardware display name, which determines the display and + communications domain to be used + + + + + + event_rtrn + + + + backfilled with the extension base event code + + + + + + error_rtrn + + + + backfilled with the extension base error code + + + + + + major_in_out + + + + compile time lib major version in, server major version out + + + + + + minor_in_out + + + + compile time lib minor version in, server minor version out + + + + + + reason_rtrn + + + + backfilled with a status code + + + + @@ -493,32 +534,29 @@ XkbIgnoreExtension disable use of the extension once a connection is established. - - - - - - - -Bool - XkbIgnoreExtension -( +XkbIgnoreExtension + + + Bool XkbIgnoreExtension + + + Bool ignore + + + + + + ignore + + + + True means ignore the extension + + + + diff --git a/specs/XKB/ch04.xml b/specs/XKB/ch04.xml index cce884ed..229a44d4 100644 --- a/specs/XKB/ch04.xml +++ b/specs/XKB/ch04.xml @@ -388,55 +388,62 @@ XkbSelectEvents . - - - - - - - -Bool -XkbSelectEvents -( +XkbSelectEvents + + + Bool XkbSelectEvents + + + Display *display + unsigned int device_spec + unsigned long int bits_to_change + unsigned long int values_for_bits + + + + + + display + + + + connection to the X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + bits_to_change + + + + determines events to be selected / deselected + + + + + + values_for_bits + + + + 1=>select, 0->deselect; for events in bits_to_change + + + + This request changes the Xkb event selection mask for the keyboard specified by @@ -518,64 +525,75 @@ XkbSelectEvents - - - - - - - -Bool -XkbSelectEventDetails -( +XkbSelectEventDetails + + + Bool XkbSelectEventDetails + + + Display *display + unsigned int device_spec + unsigned int event_type + unsigned long int bits_to_change + unsigned long int values_for_bits + + + + + + display + + + + connection to the X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + event_type + + + + Xkb event type of interest + + + + + + bits_to_change + + + + event selection details + + + + + + values_for_bits + + + + values for bits selected by bits_to_change + + + + While diff --git a/specs/XKB/ch05.xml b/specs/XKB/ch05.xml index 3a507aa3..87efbeb9 100644 --- a/specs/XKB/ch05.xml +++ b/specs/XKB/ch05.xml @@ -348,54 +348,62 @@ To lock and unlock any of the eight real keyboard modifiers, use XkbLockModifiers: - - - - - - - -Bool XkbLockModifiers -( +XkbLockModifiers + + + Bool XkbLockModifiers + + + Display *display + unsigned int device_spec + unsigned int affect + unsigned int values + + + + + + display + + + + connection to the X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + affect + + + + mask of real modifiers whose lock state is to change + + + + + + values + + + + 1 => lock, 0 => unlock; only for modifiers selected by affect + + + + @@ -424,54 +432,62 @@ XkbLatchModifiers: - - - - - - - -Bool -XkbLatchModifiers -(d +XkbLatchModifiers + + + Bool XkbLatchModifiers + + + Display *display + unsigned int device_spec + unsigned int affect + unsigned int values + + + + + + display + + + + connection to the X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + affect + + + + mask of modifiers whose latch state is to change + + + + + + values + + + + 1 => latch, 0 => unlatch; only for mods selected by affect + + + + @@ -538,46 +554,51 @@ To lock the keysym group, use XkbLockGroup. - - - - - - - -Bool -XkbLockGroup -( +XkbLockGroup + + + Bool XkbLockGroup + + + Display *display + unsigned int device_spec + unsigned int group + + + + + + display + + + + connection to the X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + group + + + + index of the keysym group to lock + + + + @@ -598,46 +619,51 @@ XkbLatchGroup. - - - - - - - -Bool -XkbLatchGroup -( +XkbLatchGroup + + + Bool XkbLatchGroup + + + Display *display + unsigned int device_spec + unsigned int group + + + + + + display + + + + connection to the X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + group + + + + index of the keysym group to latch + + + + @@ -687,50 +713,55 @@ To obtain the keyboard state, use XkbGetState. - - - - - - - -Status -XkbGetState -( +XkbGetState + + + Status XkbGetState + + + Display *display + unsigned int device_spec + XkbStatePtr state_return + + + + + + display + + + + connection to the X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + state_return + + + + backfilled with Xkb state + + + + The diff --git a/specs/XKB/ch06.xml b/specs/XKB/ch06.xml index 422e6d23..6e1d1b0e 100644 --- a/specs/XKB/ch06.xml +++ b/specs/XKB/ch06.xml @@ -203,46 +203,52 @@ XkbGetKeyboardbyName ). - - - - - - - -XkbDescPtr -XkbGetKeyboard -( +XkbGetKeyboard + + + XkbDescPtr XkbGetKeyboard + + + Display *display + unsigned int which + unsigned int device_spec + + + + + + display + + + + connection to X server + + + + + + which + + + + mask indicating components to return + + + + + + device_spec + + + + device for which to fetch description, or + XkbUseCoreKbd + + + + @@ -308,21 +314,14 @@ Xmalloc . - - - - - - - -XkbDescRec * -XkbAllocKeyboard -(void) - - - - - +XkbAllocKeyboard + + + XkbDescRec *XkbAllocKeyboard + + + + If @@ -347,48 +346,51 @@ XkbFreeKeyboard. - - - - - - - -void -XkbFreeKeyboard - +XkbFreeKeyboard + + + void XkbFreeKeyboard + + + XkbDescPtr xkb + unsigned int which + Bool free_all + + + + + + xkb + + + + keyboard description with components to free + + + + + + which + + + + mask selecting components to free + + + + + + free_all + + + + True => free all components and xkb + + + + diff --git a/specs/XKB/ch07.xml b/specs/XKB/ch07.xml index 35b45901..7df84b20 100644 --- a/specs/XKB/ch07.xml +++ b/specs/XKB/ch07.xml @@ -251,44 +251,51 @@ XkbVirtualModsToReal . - - - - - - - -Bool -XkbVirtualModsToReal -( +XkbVirtualModsToReal + + + Bool XkbVirtualModsToReal + + + XkbDescPtr xkb + unsigned int virtual_mask + unsigned int *mask_rtrn + + + + + + xkb + + + + keyboard description for input device + + + + + + virtual_mask + + + + virtual modifier mask to translate + + + + + + mask_rtrn + + + + backfilled with real modifiers + + + + If the keyboard description defined by diff --git a/specs/XKB/ch08.xml b/specs/XKB/ch08.xml index c6d60522..af1a527b 100644 --- a/specs/XKB/ch08.xml +++ b/specs/XKB/ch08.xml @@ -861,50 +861,55 @@ current state of the keyboard indicators, use XkbGetIndicatorState. - - - - - - - -Status -XkbGetIndicatorState -( +XkbGetIndicatorState + + + Status XkbGetIndicatorState + + + Display *display + unsigned int device_spec + unsigned int *state_return + + + + + + display + + + + connection to the X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + state_return + + + + backfilled with a mask of the indicator state + + + + @@ -942,48 +947,55 @@ indicators, use XkbGetIndicatorMap. - - - - - - - -Status -XkbGetIndicatorMap -( +XkbGetIndicatorMap + + + Status XkbGetIndicatorMap + + + Display *dpy + unsigned int which + XkbDescPtr desc + + + + + + dpy + + + + connection to the X server + + + + + + which + + + + mask of indicators for which maps should be returned + + + + + + desc + + + + keyboard description to be updated + + + + @@ -1052,16 +1064,11 @@ XkbGetNamedIndicator to look up the indicator map and other information for an indicator by name. - - - - - - - -Bool -XkbGetNamedIndicator -( +XkbGetNamedIndicator + + + Bool XkbGetNamedIndicator + + + Display *dpy + unsigned int device_spec + Atom name + int *ndx_rtrn + Bool *state_rtrn + XkbIndicatorMapPtr map_rtrn + Bool *real_rtrn + + + + + + dpy + + + + connection to the X server + + + + + + device_spec + + + + keyboard device ID, or XkbUseCoreKbd + + + + + + name + + + + name of the indicator to be retrieved + + + + + + ndx_rtrn + + + + backfilled with the index of the retrieved indicator + + + + + + state_rtrn + + + + backfilled with the current state of the retrieved indicator + + + + + + map_rtrn + + + + backfilled with the mapping for the retrieved indicator + + + + + + real_rtrn + + + + backfilled with True + if the named indicator is real (physical) + + + + If the device specified by @@ -1336,48 +1368,55 @@ XkbSetIndicatorMap to download the changes to the server: - - - - - - - -Bool - XkbSetIndicatorMap -( +XkbSetIndicatorMap + + + Bool XkbSetIndicatorMap + + + Display *dpy + unsigned int which + XkbDescPtr desc + + + + + + dpy + + + + connection to the X server + + + + + + which + + + + mask of indicators to change + + + + + + desc + + + + keyboard description from which the maps are taken + + + + For each @@ -1425,16 +1464,11 @@ Set the indicator map for the indicator - - - - - - - -Bool - XkbSetNamedIndicator -( +XkbSetNamedIndicator + + + BoolXkbSetNamedIndicator + + + Display *dpy + unsigned int device_spec + Atom name + Bool change_state + Bool state + Bool create_new + XkbIndicatorMapPtr map + + + + + + dpy + + + + connection to the X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + name + + + + name of the indicator to change + + + + + + change_state + + + + whether to change the indicator state or not + + + + + + state + + + + desired new state for the indicator + + + + + + create_new + + + + whether a new indicator with the specified name should be + created when necessary + + + + + + map + + + + new map for the indicator + + + + If a compatible version of the Xkb extension is not available in the server, @@ -1618,57 +1678,64 @@ XkbChangeIndicators . - - - - - - - -Bool -XkbChangeIndicators -( +XkbChangeIndicators + + + Bool XkbChangeIndicators + + + Display *dpy + XkbDescPtr xkb + XkbIndicatorChangesPtr changes + unsigned int state + + + + + + dpy + + + + connection to the X server + + + + + + xkb + + + + keyboard description from which names are to be taken. + + + + + + changes + + + + indicators to be updated on the server + + + + + + state + + + + new state of indicators listed in changes + -> + state_changes + + + + @@ -1824,48 +1891,55 @@ XkbIndicatorMapNotify XkbNoteIndicatorChanges. - - - - - - - -void -XkbNoteIndicatorChanges -( +XkbNoteIndicatorChanges + + + void XkbNoteIndicatorChanges + + + XkbIndicatorChangesPtr old + XkbIndicatorNotifyEvent *new + unsigned int wanted + + + + + + old + + + + XkbIndicatorChanges structure to be updated + + + + + + new + + + + event from which changes are to be copied + + + + + + wanted + + + + which changes are to be noted + + + + The @@ -1894,16 +1968,11 @@ XkbGetIndicatorChanges: - - - - - - - -Status -XkbGetIndicatorChanges -( +XkbGetIndicatorChanges + + + Status XkbGetIndicatorChanges + + + Display *dpy + XkbDescPtr xkb + XkbIndicatorChangesPtr changes + unsigned int *state + + + + + + dpy + + + + connection to the X server + + + + + + xkb + + + + keyboard description to hold the new values + + + + + + changes + + + + indicator maps/state to be obtained from the server + + + + + + state + + + + backfilled with the state of the indicators + + + + @@ -2003,30 +2088,29 @@ described in Chapter 6). If the need arises, however, use XkbAllocIndicatorMaps. - - - - - - - -Status -XkbAllocIndicatorMaps -( +XkbAllocIndicatorMaps + + + Status XkbAllocIndicatorMaps + + + XkbDescPtr xkb + + + + + + xkb + + + + keyboard description structure + + + + The @@ -2058,30 +2142,29 @@ XkbDescRec XkbFreeIndicatorMaps. - - - - - - - -void -XkbFreeIndicatorMaps -( +XkbFreeIndicatorMaps + + + void XkbFreeIndicatorMaps + + + XkbDescPtr xkb + + + + + + xkb + + + + keyboard description structure + + + + If the indicators diff --git a/specs/XKB/ch09.xml b/specs/XKB/ch09.xml index 3f14eed6..7af50086 100644 --- a/specs/XKB/ch09.xml +++ b/specs/XKB/ch09.xml @@ -345,76 +345,95 @@ To ring the bell on an X input extension device or the default keyboard, use XkbDeviceBell. - - - - - - - -Bool -XkbDeviceBell -( +XkbDeviceBell + + + Bool XkbDeviceBell + + + Display *display + Window window + unsigned int device_spec + unsigned int bell_class + unsigned int bell_id + int percent + Atom name + + + + + + display + + + + connection to the X server + + + + + + window + + + + window for which the bell is generated, or None + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + bell_class + + + + X input extension bell class of the bell to be rung + + + + + + bell_id + + + + X input extension bell ID of the bell to be rung + + + + + + percent + + + + bell volume, from -100 to 100 inclusive + + + + + + name + + + + a name for the bell, or NULL + + + + Set @@ -471,53 +490,62 @@ default keyboard: XkbBell. - - - - - - - -Bool -XkbBell -( +XkbBell + + + Bool XkbBell + + + Display *display + Window window + int percent + Atom name + + + + + + display + + + + connection to the X server + + + + + + window + + + + event window, or None + + + + + + percent + + + + relative volume, which can range from -100 to 100 inclusive + + + + + + name + + + + a bell name, or NULL + + + + If a compatible keyboard extension isn’t present in the X server, @@ -592,76 +620,95 @@ without ringing the corresponding bell, use XkbDeviceBellEvent. - - - - - - - -Bool -XkbDeviceBellEvent -( +XkbDeviceBellEvent + + + Bool XkbDeviceBellEvent + + + Display *display + Window window + unsigned int device_spec + unsigned int bell_class + unsigned int bell_id + int percent + Atom name + + + + + + display + + + + connection to the X server + + + + + + window + + + + event window, or None + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + bell_class + + + + input extension bell class for the event + + + + + + bell_id + + + + input extension bell ID for the event + + + + + + percent + + + + volume for the bell, which can range from -100 to 100 inclusive + + + + + + name + + + + a bell name, or NULL + + + + If a compatible keyboard extension isn’t present in the X server, @@ -701,53 +748,62 @@ XkbBellEvent. - - - - - - - -Bool -XkbBellEvent -( +XkbBellEvent + + + Bool XkbBellEvent + + + Display *display + Window window + int percent + Atom name + + + + + + display + + + + connection to the X server + + + + + + window + + + + the event window, or None + + + + + + percent + + + + relative volume, which can range from -100 to 100 inclusive + + + + + + name + + + + a bell name, or NULL + + + + If a compatible keyboard extension isn’t present in the X server, @@ -801,67 +857,84 @@ To ring the bell on any keyboard, overriding user preference settings for audible bells, use XkbForceDeviceBell. - - - - - - - -Bool -XkbForceDeviceBell -( +XkbForceDeviceBell + + + Bool XkbForceDeviceBell + + + Display *display + Window window + unsigned int device_spec + unsigned int bell_class + unsigned int bell_id + int percent + + + + + + display + + + + connection to the X server + + + + + + window + + + + event window, or None + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + bell_class + + + + input extension class of the bell to be rung + + + + + + bell_id + + + + input extension ID of the bell to be rung + + + + + + percent + + + + relative volume, which can range from -100 to 100 inclusive + + + + If a compatible keyboard extension isn’t present in the X server, @@ -899,36 +972,39 @@ for audible bells, use XkbForceBell. - - - - - - - -Bool -XkbForceBell -( -display, percent) - - - - -Display * -display -; /* connection to the X server */ - - - - -int -percent -; /* volume for the bell, which can range from -100 to 100 inclusive */ - - - - - +XkbForceBell + + + Bool XkbForceBell + + + Display *display + int percent + + + + + + display + + + + connection to the X server + + + + + + percent + + + + volume for the bell, which can range from -100 to 100 inclusive + + + + If a compatible keyboard extension isn’t present in the X server, diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml index b7f30693..27773b18 100644 --- a/specs/XKB/ch10.xml +++ b/specs/XKB/ch10.xml @@ -237,16 +237,11 @@ EnabledControls control. - - - - - - - -Bool -XkbChangeEnabledControls -( +XkbChangeEnabledControls + + + Bool XkbChangeEnabledControls + + + Display *dpy + unsigned int device_spec + unsigned int mask + unsigned int values + + + + + + dpy + + + + connection to X server + + + + + + device_spec + + + + keyboard device to modify + + + + + + mask + + + + 1 bit -> controls to enable / disable + + + + + + values + + + + 1 bit => enable, 0 bit => disable + + + + The @@ -379,50 +390,55 @@ XkbGetAutoResetControls . - - - - - - - -Bool -XkbGetAutoResetControls -( +XkbGetAutoResetControls + + + Bool XkbGetAutoResetControls + + + Display *dpy + unsigned int *auto_ctrls + unsigned int *auto_values + + + + + + dpy + + + + connection to X server + + + + + + auto_ctrls + + + + specifies which bits in auto_values are relevant + + + + + + auto_values + + + + 1 bit => corresponding control has auto-reset on + + + + @@ -449,16 +465,11 @@ XkbSetAutoResetControls. - - - - - - - -Bool -XkbSetAutoResetControls -( +XkbSetAutoResetControls + + + Bool XkbSetAutoResetControls + + + Display *dpy + unsigned int changes + unsigned int *auto_ctrls + unsigned int *auto_values + + + + + + dpy + + + + connection to X server + + + + + + changes + + + + controls for which to change auto-reset values + + + + + + auto_ctrls + + + + controls from changes that should auto reset + + + + + + auto_values + + + + 1 bit => auto-reset on + + + + @@ -713,53 +740,62 @@ XkbGetAutoRepeatRate . - - - - - - - -Bool -XkbGetAutoRepeatRate -( +XkbGetAutoRepeatRate + + + Bool XkbGetAutoRepeatRate + + + Display *display + unsigned int device_spec + unsigned int *timeout_rtrn + unsigned int *interval_rtrn + + + + + + display + + + + connection to X server + + + + + + device_spec + + + + desired device ID, or XkbUseCoreKbd + + + + + + timeout_rtrn + + + + backfilled with initial repeat delay, ms + + + + + + interval_rtrn + + + + backfilled with subsequent repeat delay, ms + + + + @@ -789,53 +825,62 @@ XkbSetAutoRepeatRate - - - - - - - -Bool -XkbSetAutoRepeatRate -( +XkbSetAutoRepeatRate + + + Bool XkbSetAutoRepeatRate + + + Display *display + unsigned int device_spec + unsigned int timeout + unsigned int interval + + + + + + display + + + + connection to X server + + + + + + device_spec + + + + device to configure, or XkbUseCoreKbd + + + + + + timeout + + + + initial delay, ms + + + + + + interval + + + + delay between repeats, ms + + + + @@ -952,41 +997,42 @@ XkbGetDetectableAutorepeat . - - - - - - - -Bool -XkbGetDetectableAutorepeat -( +XkbGetDetectableAutorepeat + + + Bool XkbGetDetectableAutorepeat + + + Display *display + Bool *supported_rtrn + + + + + + display + + + + connection to X server + + + + + + supported_rtrn + + + + backfilled True if + DetectableAutorepeat + supported + + + + @@ -1028,52 +1074,54 @@ they have requested otherwise. - - - - - - - -Bool -XkbSetDetectableAutorepeat -( +XkbSetDetectableAutorepeat + + + Bool XkbSetDetectableAutorepeat + + + Display *display + Bool detectable + Bool *supported_rtrn + + + + + + display + + + + connection to X server + + + + + + detectable + + + + True => set + DetectableAutorepeat + + + + + + supported_rtrn + + + + backfilled True if + DetectableAutorepeat + supported + + + + @@ -1610,16 +1658,11 @@ AccessXTimeout options for a keyboard device. - - - - - - - -Bool -XkbGetAccessXTimeout -( +XkbGetAccessXTimeout + + + Bool XkbGetAccessXTimeout + + + Display *display + unsigned int device_spec + unsigned short *timeout_rtrn + unsigned int *ctrls_mask_rtrn + unsigned int *ctrls_values_rtrn + unsigned short *opts_mask_rtrn + unsigned short *opts_values_rtrn + + + + + + display + + + + connection to X server + + + + + + device_spec + + + + device to query, or XkbUseCoreKbd + + + + + + timeout_rtrn + + + + delay until AccessXTimeout, seconds + + + + + + ctrls_mask_rtrn + + + + backfilled with controls to modify + + + + + + ctrls_values_rtrn + + + + backfilled with on/off status for controls + + + + + + opts_mask_rtrn + + + + backfilled with ax_options to modify + + + + + + opts_values_rtrn + + + + backfilled with values for ax_options + + + + @@ -1734,85 +1799,98 @@ XkbSetAccessXTimeout - - - - - - - -Bool -XkbSetAccessXTimeout -( +XkbSetAccessXTimeout + + + Bool XkbSetAccessXTimeout + + + Display *display + unsigned int device_spec + unsigned short timeout + unsigned int ctrls_mask + unsigned int ctrls_values + unsigned short opts_mask + unsigned short opts_values + + + + + + display + + + + connection to X server + + + + + + device_spec + + + + device to configure, or XkbUseCoreKbd + + + + + + timeout + + + + seconds idle until AccessXTimeout occurs + + + + + + ctrls_mask + + + + boolean controls to modify + + + + + + ctrls_values + + + + new bits for controls selected by ctrls_mask + + + + + + opts_mask + + + + ax_options to change + + + + + + opts_values + + + + new bits for ax_options selected by opts_mask + + + + @@ -2263,52 +2341,55 @@ XkbGetSlowKeysDelay . - - - - - - - -Bool -XkbGetSlowKeysDelay -( +XkbGetSlowKeysDelay + + + Bool XkbGetSlowKeysDelay + + + Display *display + unsigned int device_spec + unsigned int *delay_rtrn + + + + + + display + + + + connection to X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + delay_rtrn + + + + backfilled with SlowKeys delay, ms + + + + @@ -2341,52 +2422,55 @@ XkbSetSlowKeysDelay - - - - - - - -Bool -XkbSetSlowKeysDelay -( +XkbSetSlowKeysDelay + + + Bool XkbSetSlowKeysDelay + + + Display *display + unsigned int device_spec + unsigned int delay + + + + + + display + + + + connection to X server + + + + + + device_spec + + + + device to configure, or XkbUseCoreKbd + + + + + + delay + + + + SlowKeys delay, ms + + + + @@ -2450,50 +2534,55 @@ BounceKeys delay for a keyboard device. - - - - - - - -Bool -XkbGetBounceKeysDelay -( +XkbGetBounceKeysDelay + + + Bool XkbGetBounceKeysDelay + + + Display *display + unsigned int device_spec + unsigned int *delay_rtrn + + + + + + display + + + + connection to X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + delay_rtrn + + + + backfilled with bounce keys delay, ms + + + + @@ -2528,50 +2617,55 @@ XkbSetBounceKeysDelay - - - - - - - -Bool -XkbSetBounceKeysDelay -( +XkbSetBounceKeysDelay + + + Bool XkbSetBounceKeysDelay + + + Display *display + unsigned int device_spec + unsigned int delay + + + + + + display + + + + connection to X server + + + + + + device_spec + + + + device to configure, or XkbUseCoreKbd + + + + + + delay + + + + bounce keys delay, ms + + + + @@ -2752,50 +2846,55 @@ StickyKeys attributes for a keyboard device. - - - - - - - -Bool -XkbGetStickyKeysOptions -( +XkbGetStickyKeysOptions + + + Bool XkbGetStickyKeysOptions + + + Display *display + unsigned int device_spec + unsigned int *options_rtrn + + + + + + display + + + + connection to X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + options_rtrn + + + + backfilled with StickyKeys option mask + + + + @@ -2841,53 +2940,64 @@ XkbSetStickyKeysOptions - - - - - - - -Bool -XkbSetStickyKeysOptions -( +XkbSetStickyKeysOptions + + + Bool XkbSetStickyKeysOptions + + + Display *display + unsigned int device_spec + unsigned int mask + unsigned int values + + + + + + display + + + + connection to X server + + + + + + device_spec + + + + device to configure, or XkbUseCoreKbd + + + + + + mask + + + + selects StickyKeys attributes to modify + + + + + + values + + + + values for selected attributes + + + + @@ -3086,69 +3196,85 @@ to passive grabs, use XkbSetIgnoreLockMods. - - - - - - - -Bool -XkbSetIgnoreLockMods -( +XkbSetIgnoreLockMods + + + Bool XkbSetIgnoreLockMods + + + Display *display + unsigned int device_spec + unsigned int affect_real + unsigned int real_values + unsigned int affect_virtual + unsigned int virtual_values + + + + + + display + + + + connection to the X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + affect_real + + + + mask of real modifiers affected by this call + + + + + + real_values + + + + values for affected real modifiers (1=>set, 0=>unset) + + + + + + affect_virtual + + + + mask of virtual modifiers affected by this call + + + + + + virtual_values + + + + values for affected virtual modifiers (1=>set, 0=>unset) + + + + @@ -3288,69 +3414,85 @@ delivered to the client, use XkbSetServerInternalMods. - - - - - - - -Bool -XkbSetServerInternalMods -( +XkbSetServerInternalMods + + + Bool XkbSetServerInternalMods + + + Display *display + unsigned int device_spec + unsigned int affect_real + unsigned int real_values + unsigned int affect_virtual + unsigned int virtual_values + + + + + + display + + + + connection to the X server + + + + + + device_spec + + + + ‘device ID, or XkbUseCoreKbd + + + + + + affect_real + + + + mask of real modifiers affected by this call + + + + + + real_values + + + + values for affected real modifiers (1=>set, 0=>unset) + + + + + + affect_virtual + + + + mask of virtual modifiers affected by this call + + + + + + virtual_values + + + + values for affected virtual modifiers (1=>set, 0=>unset) + + + + @@ -4342,43 +4484,50 @@ XkbGetControls to find the current state of Xkb server controls. - - - - - - - -Status -XkbGetControls -( -display, which, xkb) - - - - -Display * - display -; /* connection to X server */ - - - - -unsigned long - which -; /* mask of controls requested */ - - - - -XkbDescPtr - xkb -; /* keyboard description for controls information*/ - - - - - +XkbGetControls + + + Status XkbGetControls + + + Display *display + unsigned long which + XkbDescPtr xkb + + + + + + display + + + + connection to X server + + + + + + which + + + + mask of controls requested + + + + + + xkb + + + + keyboard description for controls information + + + + @@ -4497,45 +4646,50 @@ XkbSetControls to copy those changes to the X server. - - - - - - - -Bool -XkbSetControls -( -display, which, xkb) - - - - -Display * - display -; /* connection to X server */ - - - - -unsigned long - which -; /* mask of controls to change */ - - - - -XkbDescPtr -xkb -; /* -ctrls - field contains new values to be set */ - - - - - +XkbSetControls + + + Bool XkbSetControls + + + Display *display + unsigned long which + XkbDescPtr xkb + + + + + + display + + + + connection to X server + + + + + + which + + + + mask of controls to change + + + + + + xkb + + + + ctrls field contains new values to be set + + + + For each bit that is set in the @@ -4680,48 +4834,51 @@ XkbChangeControls match those in the changed keyboard description. - - - - - - - -Bool -XkbChangeControls -( +XkbChangeControls + + + Bool XkbChangeControls + + + Display *dpy + XkbDescPtr xkb + XkbControlsChangesPtr changes + + + + + + dpy + + + + connection to X server + + + + + + xkb + + + + keyboard description with changed xkb->ctrls + + + + + + changes + + + + which parts of xkb->ctrls have changed + + + + @@ -4895,48 +5052,55 @@ XkbNoteControlsChanges . - - - - - - - -void -XkbNoteControlsChanges -( +XkbNoteControlsChanges + + + void XkbNoteControlsChanges + + + XkbControlsChangesPtr changes + XkbControlsNotifyEvent *new + unsigned int wanted + + + + + + changes + + + + records changes indicated by new + + + + + + new + + + + tells which things have changed + + + + + + wanted + + + + tells which parts of new to record in changes + + + + The @@ -4965,52 +5129,55 @@ XkbNoteControlsChanges. - - - - - - - -Status -XkbGetControlsChanges -( +XkbGetControlsChanges + + + Status XkbGetControlsChanges + + + Display *dpy + XkbDescPtr xkb + XkbNameChangesPtr changes + + + + + + dpy + + + + connection to X server + + + + + + xkb + + + + xkb->ctrls will be updated + + + + + + changes + + + + indicates which parts of xkb->ctrls to update + + + + @@ -5071,39 +5238,40 @@ XkbAllocControls . - - - - - - - -Status -XkbAllocControls -( +XkbAllocControls + + + Status XkbAllocControls + + + XkbDescPtr xkb + unsigned int which + + + + + + xkb + + + + Xkb description in which to allocate ctrls rec + + + + + + which + + + + mask of components of ctrls to allocate + + + + @@ -5159,48 +5327,51 @@ XkbFreeControls: - - - - - - - -void -XkbFreeControls -( +XkbFreeControls + + + void XkbFreeControls + + + XkbDescPtr xkb + unsigned int which + Bool free_all + + + + + + xkb + + + + Xkb description in which to free controls components + + + + + + which + + + + mask of components of ctrls to free + + + + + + free_all + + + + True => free everything + ctrls itself + + + + @@ -5263,39 +5434,42 @@ XkbGetPerClientControls . - - - - - - - -Bool -XkbGetPerClientControls -( +XkbGetPerClientControls + + + Bool XkbGetPerClientControls + + + Display *dpy + unsigned int *ctrls + + + + + + dpy + + + + connection to X server + + + + + + ctrls + + + + 1 bit => corresponding control is on + + + + @@ -5320,46 +5494,53 @@ XkbSetPerClientControls. - - - - - - - -Bool -XkbSetPerClientControls -( +XkbSetPerClientControls + + + Bool XkbSetPerClientControls + + + Display *dpy + unsigned int change + unsigned int *value + + + + + + dpy + + + + connection to X server + + + + + + change + + + + 1 bit => change control + + + + + + value + + + + 1 bit => control on + + + + diff --git a/specs/XKB/ch11.xml b/specs/XKB/ch11.xml index 52f08977..25d31144 100644 --- a/specs/XKB/ch11.xml +++ b/specs/XKB/ch11.xml @@ -427,30 +427,29 @@ To determine which Library Controls are actually implemented, use XkbXlibControlsImplemented. - - - - - - - -unsigned int -XkbXlibControlsImplemented -( +XkbXlibControlsImplemented + + + unsigned int XkbXlibControlsImplemented + + + Display *display + + + + + + display + + + + connection to X server + + + + @@ -470,30 +469,29 @@ XkbGetXlibControls . - - - - - - - -unsigned int -XkbGetXlibControls -( +XkbGetXlibControls + + + unsigned int XkbGetXlibControls + + + Display *display + + + + + + display + + + + connection to X server + + + + @@ -513,44 +511,51 @@ To change the state of the Library Controls, use XkbSetXlibControls. - - - - - - - -Bool -XkbSetXlibControls -( +XkbSetXlibControls + + + Bool XkbSetXlibControls + + + Display *display + unsigned long bits_to_change + unsigned long values_for_bits + + + + + + display + + + + connection to X server + + + + + + bits_to_change + + + + selects controls to be modified + + + + + + values_for_bits + + + + turns selected controls on (1) or off (0) + + + + diff --git a/specs/XKB/ch12.xml b/specs/XKB/ch12.xml index cfdc3089..9d6845b8 100644 --- a/specs/XKB/ch12.xml +++ b/specs/XKB/ch12.xml @@ -236,43 +236,62 @@ To find the keysym bound to a particular key at a specified group and shift level, use XkbKeycodeToKeysym. - - - - - - - -KeySym -XkbKeycodeToKeysym -( +XkbKeycodeToKeysym + + + KeySym XkbKeycodeToKeysym + + + Display *dpy + KeyCode kc + unsigned int group + unsigned int level + + + + + + dpy + + + + connection to X server + + + + + + kc + + + + key of interest + + + + + + group + + + + group of interest + + + + + + level + + + + shift level of interest + + + + @@ -300,39 +319,42 @@ XkbKeysymToModifiers - - - - - - - -unsigned int -XkbKeysymToModifiers -( +XkbKeysymToModifiers + + + unsigned int XkbKeysymToModifiers + + + Display *dpy + KeySym ks + + + + + + dpy + + + + connection to X server + + + + + + ks + + + + keysym of interest + + + + @@ -372,16 +394,11 @@ XkbLookupKeySym - - - - - - - -Bool -XkbLookupKeySym -( +XkbLookupKeySym + + + Bool XkbLookupKeySym + + + Display *dpy + KeyCode key + unsigned int state + unsigned int *mods_rtrn + KeySym *sym_rtrn + + + + + + dpy + + + + connection to X server + + + + + + key + + + + key for which symbols are to be found + + + + + + state + + + + state for which symbol should be found + + + + + + mods_rtrn + + + + backfilled with unconsumed modifiers + + + + + + sym_rtrn + + + + backfilled with symbol associated with key + state + + + + @@ -475,16 +512,11 @@ XLookupString - - - - - - - -int -XkbLookupKeyBinding -( +XkbLookupKeyBinding + + + int XkbLookupKeyBinding + + + Display *dpy + KeySym sym + unsigned int state + char *buf + int nbytes + int *extra_rtrn + + + + + + dpy + + + + connection to server + + + + + + sym + + + + symbol to be looked up + + + + + + state + + + + state for which string is to be looked up + + + + + + buf + + + + buffer into which returned string is written + + + + + + nbytes + + + + size of buffer in bytes + + + + + + extra_rtrn + + + + backfilled with number bytes overflow + + + + @@ -582,16 +638,11 @@ XkbTranslateKeySym - - - - - - - -int -XkbTranslateKeySym -( +XkbTranslateKeySym + + + int XkbTranslateKeySym + + + Display *dpy + KeySym *sym_inout + unsigned int mods + char *buf + int nbytes + int *extra_rtrn + + + + + + dpy + + + + connection to X server + + + + + + sym_inout + + + + symbol to be translated; result of translation + + + + + + mods + + + + modifiers to apply to sym_inout + + + + + + buf + + + + buffer into which returned string is written + + + + + + nbytes + + + + size of buffer in bytes + + + + + + extra_rtrn + + + + number of bytes overflow + + + + @@ -687,29 +760,28 @@ XkbRefreshKeyboardMapping - - - - - - - -Status -XkbRefreshKeyboardMapping -( -event) - - - - -XkbMapNotifyEvent * - event -; /* event initiating remapping */ - - - - - +XkbRefreshKeyboardMapping + + + Status XkbRefreshKeyboardMapping + + + XkbMapNotifyEvent *event + + + + + + event + + + + event initiating remapping + + + + @@ -752,59 +824,72 @@ XkbTranslateKeyCode - - - - - - - -Booll -XkbTranslateKeyCode -( -xkb, key, mods, mods_rtrn, keysym_rtrn) - - - - -XkbDescPtr -xkb -; /* keyboard description to use for translation */ - - - - -KeyCode -key -; /* keycode to translate */ - - - - -unsigned int -mods -; /* modifiers to apply when translating -key - */ - - - - -unsigned int * -mods_rtrn -; /* backfilled with unconsumed modifiers */ - - - - -KeySym * -keysym_rtrn -; /* keysym resulting from translation */ - - - - - +XkbTranslateKeyCode + + + Booll XkbTranslateKeyCode + + + XkbDescPtr xkb + KeyCode key + unsigned int mods + unsigned int *mods_rtrn + KeySym *keysym_rtrn + + + + + + xkb + + + + keyboard description to use for translation + + + + + + key + + + + keycode to translate + + + + + + mods + + + + modifiers to apply when translating key + + + + + + mods_rtrn + + + + backfilled with unconsumed modifiers + + + + + + keysym_rtrn + + + + keysym resulting from translation + + + + diff --git a/specs/XKB/ch13.xml b/specs/XKB/ch13.xml index ed6066d1..9a09e643 100644 --- a/specs/XKB/ch13.xml +++ b/specs/XKB/ch13.xml @@ -1093,40 +1093,43 @@ To load a keyboard geometry if you already have the keyboard description, use XkbGetGeometry. - - - - - - - -Status -XkbGetGeometry -( +XkbGetGeometry + + + Status XkbGetGeometry + + + Display *dpy + XkbDescPtr xkb + + + + + + dpy + + + + connection to the X server + + + + + + xkb + + + + keyboard description that contains the ID for the keyboard and into + which the geometry should be loaded + + + + @@ -1153,48 +1156,55 @@ description from this database by name, use XkbGetNamedGeometry. - - - - - - - -Status -XkbGetNamedGeometry -( +XkbGetNamedGeometry + + + Status XkbGetNamedGeometry + + + Display *dpy + XkbDescPtr xkb + Atom name + + + + + + dpy + + + + connection to the X server + + + + + + xkb + + + + keyboard description into which the geometry should be loaded + + + + + + name + + + + name of the geometry to be loaded + + + + @@ -1239,39 +1249,42 @@ To determine the bounding box of the top surface of a shape, use XkbComputeShapeTop. - - - - - - - -Bool -XkbComputeShapeTop -( +XkbComputeShapeTop + + + Bool XkbComputeShapeTop + + + XkbShapePtr shape + XkbBoundsPtr bounds_rtrn + + + + + + shape + + + + shape to be examined + + + + + + bounds_rtrn + + + + backfilled with the bounding box for the shape + + + + @@ -1317,30 +1330,29 @@ shape, use XkbComputeShapeBounds. - - - - - - - -Bool -XkbComputeShapeBounds -( +XkbComputeShapeBounds + + + Bool XkbComputeShapeBounds + + + XkbShapePtr shape + + + + + + shape + + + + shape to be examined + + + + @@ -1371,50 +1383,55 @@ of the keys in that row, you may need to update the bounding box of that row. To update the bounding box of a row, use XkbComputeRowBounds. - - - - - - - -Bool -XkbComputeRowBounds -( +XkbComputeRowBounds + + + Bool XkbComputeRowBounds + + + XkbGeometryPtr geom + XkbSectionPtr section + XkbRowPtr row + + + + + + geom + + + + geometry that contains the section + + + + + + section + + + + section that contains the row + + + + + + row + + + + row to be examined and updated + + + + @@ -1439,41 +1456,42 @@ that section. To update the bounding box of a section, use XkbComputeSectionBounds. - - - - - - - -Bool -XkbComputeSectionBounds -( +XkbComputeSectionBounds + + + Bool XkbComputeSectionBounds + + + XkbGeometryPtr geom + XkbSectionPtr section + + + + + + geom + + + + geometry that contains the section + + + + + + section + + + + section to be examined and updated + + + + @@ -1499,50 +1517,55 @@ by using the primary name for a key that is part of an overlay, use XkbFindOverlayForKey. - - - - - - - -char * -XkbFindOverlayForKey -( +XkbFindOverlayForKey + + + char *XkbFindOverlayForKey + + + XkbGeometryPtr geom + XkbSectionPtr section + char *under + + + + + + geom + + + + geometry that contains the section + + + + + + section + + + + section to be searched for matching keys + + + + + + under + + + + .primary name of the key to be considered + + + + @@ -1590,48 +1613,55 @@ XkbAddGeomProperty . - - - - - - - -XkbPropertyPtr -XkbAddGeomProperty -( +XkbAddGeomProperty + + + XkbPropertyPtr XkbAddGeomProperty + + + XkbGeometryPtr geom + char *name + char *value + + + + + + geom + + + + geometry to be updated + + + + + + name + + + + name of the new property + + + + + + value + + + + value for the new property + + + + @@ -1660,46 +1690,53 @@ XkbAddGeomKeyAlias - - - - - - - -XkbKeyAliasPtr -XkbAddGeomKeyAlias -( +XkbAddGeomKeyAlias + + + XkbKeyAliasPtr XkbAddGeomKeyAlias + + + XkbGeometryPtr geom + char *alias + char *real + + + + + + geom + + + + geometry to be updated + + + + + + alias + + + + alias to be added + + + + + + real + + + + real name to be bound to the new alias + + + + @@ -1723,48 +1760,55 @@ XkbAddGeomColor - - - - - - - -XkbColorPtr -XkbAddGeomColor -( +XkbAddGeomColor + + + XkbColorPtr XkbAddGeomColor + + + XkbGeometryPtr geom + char *spec + unsigned int pixel + + + + + + geom + + + + geometry to be updated + + + + + + spec + + + + color to be added + + + + + + pixel + + + + color to be added + + + + @@ -1802,39 +1846,42 @@ To add one outline to an existing shape, use XkbAddGeomOutline. - - - - - - - -XkbOutlinePtr -XkbAddGeomOutline -( +XkbAddGeomOutline + + + XkbOutlinePtr XkbAddGeomOutline + + + XkbShapePtr shape + int sz_points + + + + + + shape + + + + shape to be updated + + + + + + sz_points + + + + number of points to be reserved + + + + An outline consists of an arbitrary number of points. @@ -1860,48 +1907,55 @@ XkbAddGeomShape - - - - - - - -XkbShapePtr -XkbAddGeomShape -( +XkbAddGeomShape + + + XkbShapePtr XkbAddGeomShape + + + XkbGeometryPtr geom + Atom name + int sz_outlines + + + + + + geom + + + + geometry to be updated + + + + + + name + + + + name of the new shape + + + + + + sz_outlines + + + + number of outlines to be reserved + + + + A geometry contains an arbitrary number of shapes, each of which is made up of @@ -1933,30 +1987,29 @@ XkbAddGeomKey - - - - - - - -XkbKeyPtr -XkbAddGeomKey -( +XkbAddGeomKey + + + XkbKeyPtr XkbAddGeomKey + + + XkbRowPtr row + + + + + + row + + + + row to be updated + + + + Keys are grouped into rows. @@ -1981,16 +2034,11 @@ XkbAddGeomSection - - - - - - - -XkbSectionPtr -XkbAddGeomSection -( +XkbAddGeomSection + + + XkbSectionPtr XkbAddGeomSection + + + XkbGeometryPtr geom + Atom name + int sz_rows + int sz_doodads + int sz_overlays + + + + + + geom + + + + geometry to be updated + + + + + + name + + + + name of the new section + + + + + + sz_rows + + + + number of rows to reserve in the section + + + + + + sz_doodads + + + + number of doodads to reserve in the section + + + + + + sz_overlays + + + + number of overlays to reserve in the section + + + + A keyboard geometry contains an arbitrary number of sections. @@ -2077,39 +2145,42 @@ XkbAddGeomRow - - - - - - - -XkbRowPtr -XkbAddGeomRow -( +XkbAddGeomRow + + + XkbRowPtr XkbAddGeomRow + + + XkbSectionPtr section + int sz_keys + + + + + + section + + + + section to be updated + + + + + + sz_keys + + + + number of keys to be reserved + + + + One of the components of a keyboard geometry section is one or more rows of @@ -2138,48 +2209,55 @@ XkbAddGeomDoodad - - - - - - - -XkbDoodadPtr -XkbAddGeomDoodad -( +XkbAddGeomDoodad + + + XkbDoodadPtr XkbAddGeomDoodad + + + XkbGeometryPtr geom + XkbSectionPtr section + Atom name + + + + + + geom + + + + geometry to which the doodad is added + + + + + + section + + + + section, if any, to which the doodad is added + + + + + + name + + + + name of the new doodad + + + + A @@ -2224,48 +2302,55 @@ XkbAddGeomOverlay - - - - - - - -XkbOverlayPtr -XkbAddGeomOverlay -( +XkbAddGeomOverlay + + + XkbOverlayPtr XkbAddGeomOverlay + + + XkbSectionPtr section + Atom name + int sz_rows + + + + + + section + + + + section to which an overlay will be added + + + + + + name + + + + name of the overlay + + + + + + sz_rows + + + + number of rows to reserve in the overlay + + + + @@ -2293,48 +2378,54 @@ XkbAddGeomOverlayRow - - - - - - - -XkbOverlayRowPtr -XkbAddGeomOverlayRow -( +XkbAddGeomOverlayRow + + + XkbOverlayRowPtr XkbAddGeomOverlayRow + + + XkbOverlayPtr overlay + XkbRowPtr row_under + int sz_keys + + + + + + overlay + + + + overlay to be updated + + + + + + row_under + + + + row to be overlayed in the section overlay + overlays + + + + + + sz_keys + + + + number of keys to reserve in the row + + + + @@ -2365,46 +2456,53 @@ XkbAddGeomOverlayKey - - - - - - - -XkbOverlayKeyPtr -XkbAddGeomOverlayKey -( +XkbAddGeomOverlayKey + + + XkbOverlayKeyPtr XkbAddGeomOverlayKey + + + XkbOverlayPtr overlay + XkbRowPtr row + char *under + + + + + + overlay + + + + overlay to be updated + + + + + + row + + + + row in overlay to be updated + + + + + + under + + + + primary name of the key to be considered + + + + @@ -2464,39 +2562,42 @@ To allocate space for an arbitrary number of outlines to a shape, use XkbAllocGeomOutlines. - - - - - - - -Status -XkbAllocGeomOutlines -( +XkbAllocGeomOutlines + + + Status XkbAllocGeomOutlines + + + XkbShapePtr shape + int num_needed + + + + + + shape + + + + shape for which outlines should be allocated + + + + + + num_needed + + + + number of new outlines required + + + + @@ -2516,16 +2617,11 @@ XkbFreeGeomOutlines - - - - - - - -void -XkbFreeGeomOutlines -( +XkbFreeGeomOutlines + + + void XkbFreeGeomOutlines + + + XkbShapePtr shape + int first + int count + Bool free_all + + + + + + shape + + + + shape in which outlines should be freed + + + + + + first + + + + first outline to be freed + + + + + + count + + + + number of outlines to be freed + + + + + + free_all + + + + True => all outlines are freed + + + + If free_all is @@ -2584,39 +2694,42 @@ XkbAllocGeomKeys. - - - - - - - -Status -XkbAllocGeomKeys -( +XkbAllocGeomKeys + + + Status XkbAllocGeomKeys + + + XkbRowPtr row + int num_needed + + + + + + row + + + + row to which keys should be allocated + + + + + + num_needed + + + + number of new keys required + + + + @@ -2633,16 +2746,11 @@ XkbFreeGeomKeys - - - - - - - -void -XkbFreeGeomKeys -( +XkbFreeGeomKeys + + + void XkbFreeGeomKeys + + + XkbRowPtr row + int first + int count + Bool free_all + + + + + + row + + + + row in which keys should be freed + + + + + + first + + + + first key to be freed + + + + + + count + + + + number of keys to be freed + + + + + + free_all + + + + True => all keys are freed + + + + If free_all is @@ -2702,39 +2824,42 @@ XkbAllocGeomProps - - - - - - - -Status -XkbAllocGeomProps -( +XkbAllocGeomProps + + + Status XkbAllocGeomProps + + + XkbGeometryPtr geom + int num_needed + + + + + + geom + + + + geometry for which properties should be allocated + + + + + + num_needed + + + + number of new properties required + + + + @@ -2757,16 +2882,11 @@ XkbFreeGeomProperties - - - - - - - -void -XkbFreeGeomProperties -( +XkbFreeGeomProperties + + + void XkbFreeGeomProperties + + + XkbGeometryPtr geom + int first + int count + Bool free_all + + + + + + geom + + + + geometry in which properties should be freed + + + + + + first + + + + first property to be freed + + + + + + count + + + + number of properties to be freed + + + + + + free_all + + + + True => all properties are freed + + + + If free_all is @@ -2826,39 +2960,42 @@ XkbAllocGeomKeyAliases - - - - - - - -Status -XkbAllocGeomKeyAliases -( +XkbAllocGeomKeyAliases + + + Status XkbAllocGeomKeyAliases + + + XkbGeometryPtr geom + int num_needed + + + + + + geom + + + + geometry for which key aliases should be allocated + + + + + + num_needed + + + + number of new key aliases required + + + + @@ -2878,16 +3015,11 @@ XkbFreeGeomKeyAliases - - - - - - - -void -XkbFreeGeomKeyAliases -( +XkbFreeGeomKeyAliases + + + void XkbFreeGeomKeyAliases + + + XkbGeometryPtr geom + int first + int count + Bool free_all + + + + + + geom + + + + geometry in which key aliases should be freed + + + + + + first + + + + first key alias to be freed + + + + + + count + + + + number of key aliases to be freed + + + + + + free_all + + + + True => all key aliases are freed + + + + If free_all is @@ -2951,39 +3097,42 @@ XkbAllocGeomColors - - - - - - - -Status -XkbAllocGeomColors -( +XkbAllocGeomColors + + + Status XkbAllocGeomColors + + + XkbGeometryPtr geom + int num_needed + + + + + + geom + + + + geometry for which colors should be allocated + + + + + + num_needed + + + + number of new colors required. + + + + @@ -3004,16 +3153,11 @@ XkbFreeGeomColors - - - - - - - -void -XkbFreeGeomColors -( +XkbFreeGeomColors + + + void XkbFreeGeomColors + + + XkbGeometryPtr geom + int first + int count + Bool free_all + + + + + + geom + + + + geometry in which colors should be freed + + + + + + first + + + + first color to be freed + + + + + + count + + + + number of colors to be freed + + + + + + free_all + + + + True => all colors are freed + + + + If free_all is @@ -3073,39 +3231,42 @@ XkbAllocGeomPoints - - - - - - - -Status -XkbAllocGeomPoints -( +XkbAllocGeomPoints + + + Status XkbAllocGeomPoints + + + XkbOutlinePtr outline + int num_needed + + + + + + outline + + + + outline for which points should be allocated + + + + + + num_needed + + + + number of new points required + + + + @@ -3125,16 +3286,11 @@ XkbFreeGeomPoints - - - - - - - -void -XkbFreeGeomPoints -( +XkbFreeGeomPoints + + + void XkbFreeGeomPoints + + + XkbOutlinePtr outline + int first + int count + Bool free_all + + + + + + outline + + + + outline in which points should be freed + + + + + + first + + + + first point to be freed. + + + + + + count + + + + number of points to be freed + + + + + + free_all + + + + True => all points are freed + + + + If free_all is @@ -3195,39 +3365,42 @@ XkbAllocGeomShapes - - - - - - - -Status -XkbAllocGeomShapes -( +XkbAllocGeomShapes + + + Status XkbAllocGeomShapes + + + XkbGeometryPtr geom + int num_needed + + + + + + geom + + + + geometry for which shapes should be allocated + + + + + + num_needed + + + + number of new shapes required + + + + @@ -3247,16 +3420,11 @@ XkbFreeGeomShapes - - - - - - - -void -XkbFreeGeomShapes -( +XkbFreeGeomShapes + + + void XkbFreeGeomShapes + + + XkbGeometryPtr geom + int first + int count + Bool free_all + + + + + + geom + + + + geometry in which shapes should be freed + + + + + + first + + + + first shape to be freed + + + + + + count + + + + number of shapes to be freed + + + + + + free_all + + + + True => all shapes are freed + + + + If free_all is @@ -3317,39 +3499,42 @@ XkbAllocGeomSections - - - - - - - -Status -XkbAllocGeomSections -( +XkbAllocGeomSections + + + Status XkbAllocGeomSections + + + XkbGeometryPtr geom + int num_needed + + + + + + geom + + + + geometry for which sections should be allocated + + + + + + num_needed + + + + number of new sections required + + + + @@ -3366,16 +3551,11 @@ XkbFreeGeomSections - - - - - - - -void -XkbFreeGeomSections -( +XkbFreeGeomSections + + + void XkbFreeGeomSections + + + XkbGeometryPtr geom + int first + int count + Bool free_all + + + + + + geom + + + + geometry in which sections should be freed + + + + + + first + + + + first section to be freed. + + + + + + count + + + + number of sections to be freed + + + + + + free_all + + + + True => all sections are freed + + + + If free_all is @@ -3436,39 +3630,42 @@ XkbAllocGeomRows - - - - - - - -Status -XkbAllocGeomRows -( +XkbAllocGeomRows + + + Status XkbAllocGeomRows + + + XkbSectionPtr section + int num_needed + + + + + + section + + + + section for which rows should be allocated + + + + + + num_needed + + + + number of new rows required + + + + @@ -3485,16 +3682,11 @@ XkbFreeGeomRows - - - - - - - -void -XkbFreeGeomRows -( +XkbFreeGeomRows + + + void XkbFreeGeomRows + + + XkbSectionPtr section + int first + int count + Bool free_all + + + + + + section + + + + section in which rows should be freed + + + + + + first + + + + first row to be freed. + + + + + + count + + + + number of rows to be freed + + + + + + free_all + + + + True => all rows are freed + + + + If free_all is @@ -3555,39 +3761,42 @@ XkbAllocGeomOverlays - - - - - - - -Status -XkbAllocGeomOverlays -( +XkbAllocGeomOverlays + + + Status XkbAllocGeomOverlays + + + XkbSectionPtr section + int num_needed + + + + + + section + + + + section for which overlays should be allocated + + + + + + num_needed + + + + number of new overlays required + + + + @@ -3604,16 +3813,11 @@ XkbFreeGeomOverlays - - - - - - - -void -XkbFreeGeomOverlays -( +XkbFreeGeomOverlays + + + void XkbFreeGeomOverlays + + + XkbSectionPtr section + int first + int count + Bool free_all + + + + + + section + + + + section in which overlays should be freed + + + + + + first + + + + first overlay to be freed. + + + + + + count + + + + number of overlays to be freed + + + + + + free_all + + + + True => all overlays are freed + + + + If free_all is @@ -3674,39 +3892,42 @@ XkbAllocGeomOverlayRows - - - - - - - -Status -XkbAllocGeomOverlayRows -( +XkbAllocGeomOverlayRows + + + Status XkbAllocGeomOverlayRows + + + XkbSectionPtr overlay + int num_needed + + + + + + overlay + + + + section for which rows should be allocated + + + + + + num_needed + + + + number of new rows required + + + + @@ -3723,16 +3944,11 @@ XkbFreeGeomOverlayRows - - - - - - - -void -XkbFreeGeomOverlayRows -( +XkbFreeGeomOverlayRows + + + void XkbFreeGeomOverlayRows + + + XkbSectionPtr overlay + int first + int count + Bool free_all + + + + + + overlay + + + + section in which rows should be freed + + + + + + first + + + + first row to be freed. + + + + + + count + + + + number of rows to be freed + + + + + + free_all + + + + True => all rows are freed + + + + If free_all is @@ -3793,39 +4023,42 @@ XkbAllocGeomOverlayKeys - - - - - - - -Status -XkbAllocGeomOverlayKeys -( +XkbAllocGeomOverlayKeys + + + Status XkbAllocGeomOverlayKeys + + + XkbRowPtr row + int num_needed + + + + + + row + + + + section for which rows should be allocated + + + + + + num_needed + + + + number of new rows required + + + + @@ -3842,16 +4075,11 @@ XkbFreeGeomOverlayKeys - - - - - - - -void -XkbFreeGeomOverlayKeys -( +XkbFreeGeomOverlayKeys + + + void XkbFreeGeomOverlayKeys + + + XkbRowPtr row + int first + int count + Bool free_all + + + + + + row + + + + row in which keys should be freed + + + + + + first + + + + first key to be freed. + + + + + + count + + + + number of keys to be freed + + + + + + free_all + + + + True => all keys are freed + + + + If free_all is @@ -3912,39 +4154,42 @@ XkbAllocGeomDoodads - - - - - - - -Status -XkbAllocGeomDoodads -( +XkbAllocGeomDoodads + + + Status XkbAllocGeomDoodads + + + XkbGeometryPtr geom + int num_needed + + + + + + geom + + + + geometry for which doodads should be allocated + + + + + + num_needed + + + + number of new doodads required + + + + @@ -3962,39 +4207,42 @@ XkbAllocGeomSectionDoodads - - - - - - - -Status -XkbAllocGeomSectionDoodads -( +XkbAllocGeomSectionDoodads + + + Status XkbAllocGeomSectionDoodads + + + XkbSectionPtr section + int num_needed + + + + + + section + + + + section for which doodads should be allocated + + + + + + num_needed + + + + number of new doodads required + + + + @@ -4012,50 +4260,55 @@ XkbFreeGeomDoodads - - - - - - - -void -XkbFreeGeomDoodads -( +XkbFreeGeomDoodads + + + void XkbFreeGeomDoodads + + + XkbDoodadPtr doodads + int count + Bool free_all + + + + + + doodads + + + + doodads to be freed + + + + + + count + + + + number of doodads to be freed + + + + + + free_all + + + + True => all doodads are freed + + + + If @@ -4074,39 +4327,42 @@ XkbAllocGeometry - - - - - - - -Status -XkbAllocGeometry -( +XkbAllocGeometry + + + Status XkbAllocGeometry + + + XkbDescPtr xkb + XkbGeometrySizesPtr sizes + + + + + + xkb + + + + keyboard description for which geometry is to be allocated + + + + + + sizes + + + + initial sizes for all geometry components + + + + @@ -4127,50 +4383,55 @@ XkbFreeGeometry - - - - - - - -void -XkbFreeGeometry -( +XkbFreeGeometry + + + void XkbFreeGeometry + + + XkbGeometryPtr geom + unsigned int which + Bool free_all + + + + + + geom + + + + geometry to be freed + + + + + + which + + + + mask of geometry components to be freed + + + + + + free_all + + + + True => the entire geometry is freed. + + + + The values of which and free_all determine how much of the specified geometry diff --git a/specs/XKB/ch14.xml b/specs/XKB/ch14.xml index 1fcc7680..993751f9 100644 --- a/specs/XKB/ch14.xml +++ b/specs/XKB/ch14.xml @@ -248,46 +248,51 @@ XkbGetMap can be instructed to return a partially populated component. - - - - - - - -XkbDescPtr -XkbGetMap -( +XkbGetMap + + + XkbDescPtr XkbGetMap + + + Display *display + unsigned int which + unsigned int device_spec + + + + + + display + + + + connection to X server + + + + + + which + + + + mask selecting subcomponents to populate + + + + + + device_spec + + + + device_id, or XkbUseCoreKbd + + + + The @@ -497,44 +502,51 @@ description, use XkbGetUpdatedMap. - - - - - - - -Status -XkbGetUpdatedMap -( +XkbGetUpdatedMap + + + Status XkbGetUpdatedMap + + + Display *display + unsigned int which + XkbDescPtr xkb + + + + + + display + + + + connection to X server + + + + + + which + + + + mask selecting subcomponents to populate + + + + + + xkb + + + + keyboard description to be updated + + + + The @@ -592,48 +604,55 @@ an structure and call XkbChangeMap. - - - - - - - -Bool -XkbSetMap -( +XkbSetMap + + + Bool XkbSetMap + + + Display *dpy + unsigned int which + XkbDescPtr xkb + + + + + + dpy + + + + connection to X server + + + + + + which + + + + mask selecting subcomponents to update + + + + + + xkb + + + + description from which new values are taken + + + + Use @@ -871,48 +890,55 @@ XkbMapChangesRec structure indicating which components have changed. - - - - - - - -Bool -XkbChangeMap -( +XkbChangeMap + + + Bool XkbChangeMap + + + Display *dpy + XkbDescPtr xkb + XkbMapChangesPtr changes + + + + + + dpy + + + + connection to X server + + + + + + xkb + + + + description from which new values are taken + + + + + + changes + + + + identifies component parts to update + + + + @@ -1104,46 +1130,51 @@ To allocate and initialize an empty client map description record, use XkbAllocClientMap. - - - - - - - -Status -XkbAllocClientMap -( +XkbAllocClientMap + + + Status XkbAllocClientMap + + + XkbDescPtr xkb + unsigned int which + unsigned int type_count + + + + + + xkb + + + + keyboard description in which to allocate client map + + + + + + which + + + + mask selecting map components to allocate + + + + + + type_count + + + + value of num_types field in map to be allocated + + + + @@ -1297,46 +1328,52 @@ XkbDescRec XkbFreeClientMap. - - - - - - - -void -XkbFreeClientMap -( +XkbFreeClientMap + + + void XkbFreeClientMap + + + XkbDescPtr xkb + unsigned int which + Bool free_all + + + + + + xkb + + + + keyboard description containing client map to free + + + + + + which + + + + mask identifying components of map to free + + + + + + free_all + + + + True + => free all client components and map itself + + + + @@ -1389,46 +1426,51 @@ To allocate and initialize an empty server map description record, use XkbAllocServerMap. - - - - - - - -Status -XkbAllocServerMap -( +XkbAllocServerMap + + + Status XkbAllocServerMap + + + XkbDescPtr xkb + unsigned int which + unsigned int count_acts + + + + + + xkb + + + + keyboard description in which to allocate server map + + + + + + which + + + + mask selecting map components to allocate + + + + + + count_acts + + + + value of num_acts field in map to be allocated + + + + @@ -1578,46 +1620,52 @@ XkbDescRec XkbFreeServerMap. - - - - - - - -void -XkbFreeServerMap -( +XkbFreeServerMap + + + void XkbFreeServerMap + + + XkbDescPtr xkb + unsigned int which + Bool free_all + + + + + + xkb + + + + keyboard description containing server map to free + + + + + + which + + + + mask identifying components of map to free + + + + + + free_all + + + + True + => free all server map components and server itself + + + + The diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml index a98925ec..d86cc944 100644 --- a/specs/XKB/ch15.xml +++ b/specs/XKB/ch15.xml @@ -645,44 +645,51 @@ default values, use XkbInitCanonicalKeyTypes. - - - - - - - -Status -XkbInitCanonicalKeyTypes -( +XkbInitCanonicalKeyTypes + + + Status XkbInitCanonicalKeyTypes + + + XkbDescPtr xkb + unsigned int which + int keypadVMod + + + + + + xkb + + + + keyboard description containing client map to initialize + + + + + + which + + + + mask of types to initialize + + + + + + keypadVMod + + + + index of NumLock virtual modifier + + + + @@ -752,16 +759,11 @@ XkbGetKeyTypes . - - - - - - - -Status -XkbGetKeyTypes -( +XkbGetKeyTypes + + + Status XkbGetKeyTypes + + + Display *dpy + unsigned int first + unsigned int num + XkbDescPtr xkb + + + + + + dpy + + + + connection to X server + + + + + + first + + + + index to first type to get, 0 => 1st type + + + + + + num + + + + number of key types to be returned + + + + + + xkb + + + + keyboard description containing client map to update + + + + XkbGetKeyTypes is used to obtain descriptions of the key types themselves, not the key types @@ -846,16 +864,11 @@ XkbResizeKeyType . - - - - - - - -Status -XkbResizeKeyType -( +XkbResizeKeyType + + + Status XkbResizeKeyType + + + XkbDescPtr xkb + int type_ndx + int map_count + Bool want_preserve + int new_num_lvls + + + + + + xkb + + + + keyboard description containing client map to update + + + + + + type_ndx + + + + index in xkb->map->types of type to change + + + + + + map_count + + + + total # of map entries needed for the type + + + + + + want_preserve + + + + True + => list of preserved modifiers is necessary + + + + + + new_num_lvls + + + + new max # of levels for type + + + + @@ -1021,39 +1053,42 @@ XkbKeyTypeRec structures. - - - - - - - -Status -XkbCopyKeyType -( +XkbCopyKeyType + + + Status XkbCopyKeyType + + + XkbKeyTypePtr from + XkbKeyTypePtr into + + + + + + from + + + + pointer to XkbKeyTypeRec to be copied + + + + + + into + + + + pointer to XkbKeyTypeRec to be changed + + + + @@ -1098,48 +1133,55 @@ Success - - - - - - - -Status -XkbCopyKeyTypes -( +XkbCopyKeyTypes + + + Status XkbCopyKeyTypes + + + XkbKeyTypePtr from + XkbKeyTypePtr into + int num_types + + + + + + from + + + + pointer to array of XkbKeyTypeRecs to copy + + + + + + into + + + + pointer to array of XkbKeyTypeRecs to change + + + + + + num_types + + + + number of types to copy + + + + @@ -1291,44 +1333,51 @@ XkbNumKbdGroups XkbNumKbdGroups groups, the extra key types are reported but ignored. - - - - - - - -int -XkbKeyTypeIndex -( +XkbKeyTypeIndex + + + int XkbKeyTypeIndex + + + XkbDescPtr xkb + KeyCode keycode + int group + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + + + group + + + + group index + + + + @@ -1345,44 +1394,51 @@ group - - - - - - - -XkbKeyTypePtr -XkbKeyType -( +XkbKeyType + + + XkbKeyTypePtr XkbKeyType + + + XkbDescPtr xkb + KeyCode keycode + int group + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + + + group + + + + group index + + + + @@ -1494,37 +1550,40 @@ normalization methods in this table. Xkb provides the following macros to access group information: - - - - - - - -int -XkbKeyNumGroups -( +XkbKeyNumGroups + + + int XkbKeyNumGroups + + + XkbDescPtr xkb + KeyCode keycode + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + @@ -1536,37 +1595,40 @@ keycode - - - - - - - -unsigned char -XkbKeyGroupInfo -( +XkbKeyGroupInfo + + + unsigned char XkbKeyGroupInfo + + + XkbDescPtr xkb + KeyCode keycode + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + @@ -1581,32 +1643,29 @@ keycode - - - - - - - -unsigned char -XkbOutOfRangeGroupInfo -( +XkbOutOfRangeGroupInfo + + + unsigned char XkbOutOfRangeGroupInfo + + + unsigned char grp_inf + + + + + + grp_inf + + + + group_info field of XkbSymMapRec + + + + @@ -1619,32 +1678,29 @@ XkbSymMapRec - - - - - - - -unsigned char -XkbOutOfRangeGroupNumber -( +XkbOutOfRangeGroupNumber + + + unsigned char XkbOutOfRangeGroupNumber + + + unsigned char grp_inf + + + + + + grp_inf + + + + group_info field of XkbSymMapRec + + + + @@ -1715,37 +1771,40 @@ offset of symbols bound to the key: - - - - - - - -int -XkbKeyGroupsWidth -( +XkbKeyGroupsWidth + + + int XkbKeyGroupsWidth + + + XkbDescPtr xkb + KeyCode keycode + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + @@ -1756,44 +1815,51 @@ keycode - - - - - - - -int -XkbKeyGroupWidth -( +XkbKeyGroupWidth + + + int XkbKeyGroupWidth + + + XkbDescPtr xkb + KeyCode keycode + int grp + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + + + grp + + + + group of interest + + + + @@ -1806,37 +1872,40 @@ keycode - - - - - - - -int -XkbKeySymsOffset -( +XkbKeySymsOffset + + + int XkbKeySymsOffset + + + XkbDescPtr xkb + KeyCode keycode + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + @@ -1848,37 +1917,40 @@ keycode - - - - - - - -int -XkbKeyNumSyms -( +XkbKeyNumSyms + + + int XkbKeyNumSyms + + + XkbDescPtr xkb + KeyCode keycode + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + @@ -1889,37 +1961,40 @@ keycode - - - - - - - -KeySym * -XkbKeySymsPtr -( +XkbKeySymsPtr + + + KeySym *XkbKeySymsPtr + + + XkbDescPtr xkb + KeyCode keycode + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + @@ -1931,51 +2006,62 @@ keycode - - - - - - - -KeySym -XkbKeySymEntry -( +XkbKeySymEntry + + + KeySym XkbKeySymEntry + + + XkbDescPtr xkb + KeyCode keycode + int shift + int grp + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + + + shift + + + + shift level of interest + + + + + + grp + + + + group of interest + + + + @@ -2003,16 +2089,11 @@ XkbGetKeySyms : - - - - - - - -Status -XkbGetKeySyms -( +XkbGetKeySyms + + + Status XkbGetKeySyms + + + Display *dpy + unsigned int first + unsigned int num + XkbDescPtr xkb + + + + + + dpy + + + + connection to X server + + + + + + first + + + + keycode of first key to get + + + + + + num + + + + number of keycodes for which syms desired + + + + + + xkb + + + + Xkb description to be updated + + + + @@ -2120,16 +2217,11 @@ XkbChangeTypesOfKey - - - - - - - -Status -XkbChangeTypesOfKey -( +XkbChangeTypesOfKey + + + Status XkbChangeTypesOfKey + + + XkbDescPtr xkb + int key + int n_groups + unsigned int groups + int *new_types_in + XkbMapChangesPtr p_changes + + + + + + xkb + + + + keyboard description to be changed + + + + + + key + + + + keycode for key of interest + + + + + + n_groups + + + + new number of groups for key + + + + + + groups + + + + mask indicating groups to change + + + + + + new_types_in + + + + indices for new groups specified in groups + + + + + + p_changes + + + + notes changes made to xkb + + + + @@ -2364,48 +2476,55 @@ XkbResizeKeySyms . - - - - - - - -KeySym * -XkbResizeKeySyms -( +XkbResizeKeySyms + + + KeySym *XkbResizeKeySyms + + + XkbDescRec *xkb + int key + int needed + + + + + + xkb + + + + keyboard description to be changed + + + + + + key + + + + keycode for key to modify + + + + + + needed + + + + new number of keysyms required for key + + + + @@ -2530,16 +2649,11 @@ XkbGetKeyModifierMap . - - - - - - - -Status -XkbGetKeyModifierMap -( +XkbGetKeyModifierMap + + + Status XkbGetKeyModifierMap + + + Display *dpy + unsigned int first + unsigned int num + XkbDescPtr xkb + + + + + + dpy + + + + connection to X server + + + + + + first + + + + keycode of first key to get + + + + + + num + + + + number of keys for which information is desired + + + + + + xkb + + + + keyboard description to update + + + + diff --git a/specs/XKB/ch16.xml b/specs/XKB/ch16.xml index 2640ea2d..17c34011 100644 --- a/specs/XKB/ch16.xml +++ b/specs/XKB/ch16.xml @@ -163,37 +163,40 @@ Xkb provides the following macros, to simplify accessing information pertaining to key actions: - - - - - - - -Bool -XkbKeyHasActions -( +XkbKeyHasActions + + + Bool XkbKeyHasActions + + + XkbDescPtr xkb + KeyCode keycode + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + @@ -208,37 +211,40 @@ False - - - - - - - -int -XkbKeyNumActions -( +XkbKeyNumActions + + + int XkbKeyNumActions + + + XkbDescPtr xkb + KeyCode keycode + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + @@ -252,37 +258,40 @@ XkbKeyNumSyms - - - - - - - -XkbKeyActionPtr -XkbKeyActionsPtr -( +XkbKeyActionsPtr + + + XkbKeyActionPtr XkbKeyActionsPtr + + + XkbDescPtr xkb + KeyCode keycode + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + @@ -299,44 +308,51 @@ XkbKeyNumActions - - - - - - - -XkbAction -XkbKeyAction -( +XkbKeyAction + + + XkbAction XkbKeyAction + + + XkbDescPtr xkb + KeyCode keycode + int idx + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + + + idx + + + + index for group and shift level + + + + @@ -355,51 +371,62 @@ idx idx = group_index * key_width + shift_level - - - - - - - -XkbAction -XkbKeyActionEntry -( +XkbKeyActionEntry + + + XkbAction XkbKeyActionEntry + + + XkbDescPtr xkb + KeyCode keycode + int shift + int grp + + + + + + xkb + + + + Xkb description of interest + + + + + + keycode + + + + keycode of interest + + + + + + shift + + + + shift level within group + + + + + + grp + + + + group index for group of interest + + + + @@ -889,30 +916,29 @@ vmods convert between the two formats: - - - - - - - -unsigned short -XkbModActionVMods -( +XkbModActionVMods + + + unsigned short XkbModActionVMods + + + XkbAction act + + + + + + act + + + + action from which to extract virtual mods + + + + @@ -929,37 +955,40 @@ vmods - - - - - - - -void -XkbSetModActionVMods -( +XkbSetModActionVMods + + + void XkbSetModActionVMods + + + XkbAction act + unsigned short vmods + + + + + + act + + + + action in which to set vmods + + + + + + vmods + + + + virtual mods to set + + + + @@ -1196,30 +1225,29 @@ group_XXX convert between a signed integer value and a signed character: - - - - - - - -int -XkbSAGroup -( +XkbSAGroup + + + int XkbSAGroup + + + XkbAction act + + + + + + act + + + + action from which to extract group + + + + @@ -1232,39 +1260,40 @@ act - - - - - - - -void -XkbSASetGroup -( +XkbSASetGroup + + + void XkbSASetGroup + + + XkbAction act + int grp + + + + + + act + + + + action from which to set group + + + + + + grp + + + + group index to set in group_XXX + + + + @@ -1410,30 +1439,29 @@ XkbPtrAction structures: - - - - - - - -int -XkbPtrActionX -( +XkbPtrActionX + + + int XkbPtrActionX + + + XkbPtrAction act + + + + + + act + + + + action from which to extract X + + + + @@ -1448,30 +1476,29 @@ act - - - - - - - -int -XkbPtrActionY -( +XkbPtrActionY + + + int XkbPtrActionY + + + XkbPtrAction act + + + + + + act + + + + action from which to extract Y + + + + @@ -1486,39 +1513,42 @@ act - - - - - - - -void -XkbSetPtrActionX -( +XkbSetPtrActionX + + + void XkbSetPtrActionX + + + XkbPtrAction act + int x + + + + + + act + + + + action in which to set X + + + + + + x + + + + new value to set + + + + @@ -1535,37 +1565,40 @@ x - - - - - - - -void -XkbSetPtrActionY -( +XkbSetPtrActionY + + + void XkbSetPtrActionY + + + XkbPtrAction act + int y + + + + + + act + + + + action in which to set Y + + + + + + y + + + + new value to set + + + + @@ -1921,30 +1954,29 @@ XkbPtrDfltAction structures: - - - - - - - -int -XkbSAPtrDfltValue -( +XkbSAPtrDfltValue + + + int XkbSAPtrDfltValue + + + XkbAction act + + + + + + act + + + + action from which to extract group + + + + @@ -1957,41 +1989,40 @@ act - - - - - - - -void -XkbSASetPtrDfltValue -( +XkbSASetPtrDfltValue + + + void XkbSASetPtrDfltValue + + + XkbPtrDfltAction act + int val + + + + + + act + + + + action in which to set valueXXX + + + + + + val + + + + value to set in valueXXX + + + + @@ -2541,30 +2572,29 @@ XkbSwitchScreenAction structures: - - - - - - - -int -XkbSAScreen -( +XkbSAScreen + + + int XkbSAScreen + + + XkbSwitchScreenAction act + + + + + + act + + + + action from which to extract screen + + + + @@ -2577,41 +2607,40 @@ act - - - - - - - -void -XkbSASetScreen -( +XkbSASetScreen + + + void XkbSASetScreen + + + XkbSwitchScreenAction act + int s + + + + + + act + + + + action in which to set screenXXX + + + + + + s + + + + value to set in screenXXX + + + + @@ -2809,30 +2838,29 @@ enabled_ctrls macros, to convert between the two formats: - - - - - - - -unsigned int -XkbActionCtrls -( +XkbActionCtrls + + + unsigned int XkbActionCtrls + + + XkbCtrlsAction act + + + + + + act + + + + action from which to extract controls + + + + @@ -2845,37 +2873,40 @@ act - - - - - - - -void -XkbSAActionSetCtrls -( +XkbSAActionSetCtrls + + + void XkbSAActionSetCtrls + + + XkbCtrlsAction act + unsigned int ctrls + + + + + + act + + + + action in which to set ctrls0-ctrls3 + + + + + + ctrls + + + + value to set in ctrls0-ctrls3 + + + + @@ -3226,30 +3257,29 @@ vmods_mask convert between the two formats: - - - - - - - -unsigned int -XkbSARedirectVModsMask -( +XkbSARedirectVModsMask + + + unsigned int XkbSARedirectVModsMask + + + XkbRedirectKeyAction act + + + + + + act + + + + action from which to extract vmods + + + + @@ -3264,37 +3294,40 @@ act - - - - - - - -void -XkbSARedirectSetVModsMask -( +XkbSARedirectSetVModsMask + + + void XkbSARedirectSetVModsMask + + + XkbRedirectKeyAction act + unsigned int vm + + + + + + act + + + + action in which to set vmods + + + + + + vm + + + + new value for virtual modifier mask + + + + @@ -3323,30 +3356,29 @@ provides the following convenience macros: - - - - - - - -unsigned int -XkbSARedirectVMods -( +XkbSARedirectVMods + + + unsigned int XkbSARedirectVMods + + + XkbRedirectKeyAction act + + + + + + act + + + + action from which to extract vmods + + + + XkbSARedirectVModsMask returns the vmods0 @@ -3354,37 +3386,40 @@ act converted to an unsigned int. - - - - - - - -void -XkbSARedirectSetVMods -( +XkbSARedirectSetVMods + + + void XkbSARedirectSetVMods + + + XkbRedirectKeyAction act + unsigned int v + + + + + + act + + + + action in which to set vmods + + + + + + v + + + + new value for virtual modifiers + + + + XkbSARedirectSetVModsMask sets the vmods0 and vmods1 of act from v. @@ -3737,16 +3772,11 @@ XkbGetKeyActions . - - - - - - - -Status -XkbGetKeyActions -( +XkbGetKeyActions + + + Status XkbGetKeyActions + + + Display *dpy + unsigned int first + unsigned int num + XkbDescPtr xkb + + + + + + dpy + + + + connection to X server + + + + + + first + + + + keycode of first key of interest + + + + + + num + + + + number of keys desired + + + + + + xkb + + + + pointer to keyboard description where result is stored + + + + @@ -3855,48 +3901,55 @@ XkbResizeKeyAction . - - - - - - - -XkbAction * -XkbResizeKeyActions -( +XkbResizeKeyActions + + + XkbAction *XkbResizeKeyActions + + + XkbDescRec *xkb + int key + int needed + + + + + + xkb + + + + keyboard description to change + + + + + + key + + + + keycode of key to change + + + + + + needed + + + + new number of actions required + + + + The @@ -4181,16 +4234,11 @@ XkbGetKeyBehaviors : - - - - - - - -Status -XkbGetKeyBehaviors -( +XkbGetKeyBehaviors + + + Status XkbGetKeyBehaviors + + + Display *dpy + unsigned int first + unsigned int num + XkbDescPtr xkb + + + + + + dpy + + + + connection to server + + + + + + first + + + + keycode of first key to get + + + + + + num + + + + number of keys for which behaviors are desired + + + + + + xkb + + + + Xkb description to contain the result + + + + @@ -4412,16 +4476,11 @@ explicit XkbGetKeyExplicitComponents. - - - - - - - -Status -XkbGetKeyExplicitComponents -( +XkbGetKeyExplicitComponents + + + Status XkbGetKeyExplicitComponents + + + Display *dpy + unsigned int first + unsigned int num + XkbDescPtr xkb + + + + + + dpy + + + + connection to server + + + + + + first + + + + keycode of first key to fetch + + + + + + num + + + + number of keys for which to get explicit info + + + + + + xkb + + + + Xkb description in which to put results + + + + @@ -4625,48 +4700,55 @@ XkbGetVirtualMods : - - - - - - - -Status -XkbGetVirtualMods -( +XkbGetVirtualMods + + + Status XkbGetVirtualMods + + + Display *dpy + unsigned int which + XkbDescPtr xkb + + + + + + dpy + + + + connection to server + + + + + + which + + + + mask indicating virtual modifier bindings to get + + + + + + xkb + + + + Xkb description where results will be placed + + + + @@ -4731,16 +4813,11 @@ XkbGetKeyVirtualModMap : - - - - - - - -Status -XkbGetKeyVirtualModMap -( +XkbGetKeyVirtualModMap + + + Status XkbGetKeyVirtualModMap + + + Display *dpy + unsigned int first + unsigned int num + XkbDescPtr xkb + + + + + + dpy + + + + connection to server + + + + + + first + + + + keycode of first key to fetch + + + + + + num + + + + # keys for which virtual mod maps are desired + + + + + + xkb + + + + Xkb description where results will be placed + + + + diff --git a/specs/XKB/ch17.xml b/specs/XKB/ch17.xml index 32a1c8cb..828af541 100644 --- a/specs/XKB/ch17.xml +++ b/specs/XKB/ch17.xml @@ -760,44 +760,51 @@ compatibility map may be used to reconfigure other servers. To make a complete matching configuration you must also update the explicit override components of the server state. - - - - - - - -Status -XkbGetCompatMap -( +XkbGetCompatMap + + + Status XkbGetCompatMap + + + Display *display + unsigned int which + XkbDescRec *xkb + + + + + + display + + + + connection to server + + + + + + which + + + + mask of compatibility map components to fetch + + + + + + xkb + + + + keyboard description where results placed + + + + @@ -911,16 +918,11 @@ XkbUpdateMapFromCore . - - - - - - - -Bool -XkbUpdateMapFromCore -( +XkbUpdateMapFromCore + + + Bool XkbUpdateMapFromCore + + + XkbDescPtr xkb + KeyCode first_key + int num_keys + int map_width + KeySym *core_keysyms + XkbChangesPtr changes + + + + + + xkb + + + + keyboard description to update + + + + + + first_key + + + + keycode of first key description to update + + + + + + num_keys + + + + number of key descriptions to update + + + + + + map_width + + + + width of core protocol keymap + + + + + + core_keysyms + + + + symbols in core protocol keymap + + + + + + changes + + + + backfilled with changes made to Xkb + + + + @@ -1053,72 +1079,89 @@ XkbKeyTypesForCoreSymbols - - - - - - - -int -XkbKeyTypesForCoreSymbols -( +XkbKeyTypesForCoreSymbols + + + int XkbKeyTypesForCoreSymbols + + + XkbDescPtr xkb + int map_width + KeySym *core_syms + unsigned int protected + int *types_inout + KeySym *xkb_syms_rtrn + + + + + + xkb + + + + keyboard description in which to place symbols + + + + + + map_width + + + + width of core protocol keymap in xkb_syms_rtrn + + + + + + core_syms + + + + core protocol format array of KeySyms + + + + + + protected + + + + explicit key types + + + + + + types_inout + + + + backfilled with the canonical types bound to groups one and two + for the key + + + + + + xkb_syms_rtrn + + + + backfilled with symbols bound to the key in the Xkb mapping + + + + @@ -1200,48 +1243,55 @@ XkbApplyCompatMapToKey - - - - - - - -Bool -XkbApplyCompatMapToKey -( +XkbApplyCompatMapToKey + + + Bool XkbApplyCompatMapToKey + + + XkbDescPtr xkb + KeyCode key + XkbChangesPtr changes + + + + + + xkb + + + + keyboard description to be updated + + + + + + key + + + + key to be updated + + + + + + changes + + + + notes changes to the Xkb keyboard description + + + + @@ -1275,53 +1325,62 @@ XkbSymInterpretRec structures) are also allocated using this same function. - - - - - - - -Bool -XkbSetCompatMap -( +XkbSetCompatMap + + + Bool XkbSetCompatMap + + + Display *display + unsigned int which + XkbDescPtr xkb + Bool update_actions + + + + + + display + + + + connection to server + + + + + + which + + + + mask of compat map components to set + + + + + + xkb + + + + source for compat map components + + + + + + update_actions + + + + True => apply to server’s keyboard map + + + + @@ -1392,53 +1451,62 @@ XkbAddSymInterpret - - - - - - - -XkbSymInterpretPtr -XkbAddSymInterpret -( +XkbAddSymInterpret + + + XkbSymInterpretPtr XkbAddSymInterpret + + + XkbDescPtr xkb + XkbSymInterpretPtr si + Bool updateMap + XkbChangesPtr changes + + + + + + xkb + + + + keyboard description to be updated + + + + + + si + + + + symbol interpretation to be added + + + + + + updateMap + + + + True=>apply compatibility map to keys + + + + + + changes + + + + changes are put here + + + + @@ -1610,44 +1678,51 @@ XkbAllocCompatMap . - - - - - - - -Status -XkbAllocCompatMap -( +XkbAllocCompatMap + + + Status XkbAllocCompatMap + + + XkbDescPtr xkb + unsigned int which + unsigned int num_si + + + + + + xkb + + + + keyboard description in which to allocate compat map + + + + + + which + + + + mask of compatibility map components to allocate + + + + + + num_si + + + + number of symbol interpretations to allocate + + + + @@ -1723,48 +1798,52 @@ XkbFreeCompatMap - - - - - - - -void -XkbFreeCompatMap -( +XkbFreeCompatMap + + + void XkbFreeCompatMap + + + XkbDescPtr xkb + unsigned int which + Bool free_map + + + + + + xkb + + + + Xkb description in which to free compatibility map + + + + + + which + + + + mask of compatibility map components to free + + + + + + free_map + + + + True => free XkbCompatMap + structure itself + + + + diff --git a/specs/XKB/ch18.xml b/specs/XKB/ch18.xml index 806b09a4..969c7f63 100644 --- a/specs/XKB/ch18.xml +++ b/specs/XKB/ch18.xml @@ -371,44 +371,51 @@ XkbGetNames . - - - - - - - -Status -XkbGetNames -( +XkbGetNames + + + Status XkbGetNames + + + Display *dpy + unsigned int which + XkbDescPtr xkb + + + + + + dpy + + + + connection to the X server + + + + + + which + + + + mask of names or map components to be updated + + + + + + xkb + + + + keyboard description to be updated + + + + @@ -525,58 +532,73 @@ BadImplementation errors. - - - - - - - -Bool -XkbSetNames -( +XkbSetNames + + + Bool XkbSetNames + + + Display *dpy + unsigned int which + unsigned int first_type + unsigned int num_types + XkbDescPtr xkb + + + + + + dpy + + + + connection to the X server + + + + + + which + + + + mask of names or map components to be changed + + + + + + first_type + + + + first type whose name is to be changed + + + + + + num_types + + + + number of types for which names are to be changed + + + + + + xkb + + + + keyboard description from which names are to be taken + + + + Use @@ -759,44 +781,51 @@ XkbNameChangesRec structure. - - - - - - - -Bool -XkbChangeNames -( +XkbChangeNames + + + Bool XkbChangeNames + + + Display *dpy + XkbDescPtr xkb + XkbNameChangesPtr changes + + + + + + dpy + + + + connection to the X server + + + + + + xkb + + + + keyboard description from which names are to be taken + + + + + + changes + + + + names map components to be updated on the server + + + + @@ -911,50 +940,55 @@ XkbNoteNameChanges . - - - - - - - -void -XkbNoteNameChanges -( +XkbNoteNameChanges + + + void XkbNoteNameChanges + + + XkbNameChangesPtr old + XkbNamesNotifyEvent *new + unsigned int wanted + + + + + + old + + + + XkbNameChanges structure to be updated + + + + + + new + + + + event from which changes are to be copied + + + + + + wanted + + + + types of names for which changes are to be noted + + + + The @@ -982,48 +1016,55 @@ XkbNoteNameChanges - - - - - - - -Status -XkbGetNameChanges -( +XkbGetNameChanges + + + Status XkbGetNameChanges + + + Display *dpy + XkbDescPtr xkb + XkbNameChangesPtr changes + + + + + + dpy + + + + connection to the X server + + + + + + xkb + + + + keyboard description to which names are copied + + + + + + changes + + + + names components to be obtained from the server + + + + @@ -1067,50 +1108,61 @@ XkbAllocNames . - - - - - - - -Status -XkbAllocNames -( -xkb, which, num_rg, num_key_aliases) - - - - -XkbDescPtr -xkb; - /* keyboard description for which names are to be allocated */ - - - - -unsigned int -which; - /* mask of names to be allocated */ - - - - -int -num_rg; - /* total number of radio group names needed */ - - - - -int -num_key_aliases; - /* total number of key aliases needed */ - - - - - +XkbAllocNames + + + Status XkbAllocNames + + + XkbDescPtr xkb + unsigned int which + int num_rg + int num_key_aliases + + + + + + xkb + + + + keyboard description for which names are to be allocated + + + + + + which + + + + mask of names to be allocated + + + + + + num_rg + + + + total number of radio group names needed + + + + + + num_key_aliases + + + + total number of key aliases needed + + + + @@ -1141,45 +1193,51 @@ XkbFreeNames - - - - - - - -void -XkbFreeNames -( -xkb, which, free_map) - - - - -XkbDescPtr -xkb -; /* keyboard description for which names are to be freed */ - - - - -unsigned int -which -; /* mask of names components to be freed */ - - - - -Bool -free_map -; /* -True - => XkbNamesRec structure itself should be freed */ - - - - - +XkbFreeNames + + + void XkbFreeNames + + + XkbDescPtr xkb + unsigned int which + Bool free_map + + + + + + xkb + + + + keyboard description for which names are to be freed + + + + + + which + + + + mask of names components to be freed + + + + + + free_map + + + + True + => XkbNamesRec structure itself should be freed + + + + The diff --git a/specs/XKB/ch20.xml b/specs/XKB/ch20.xml index 6067b5b8..8e0903b7 100644 --- a/specs/XKB/ch20.xml +++ b/specs/XKB/ch20.xml @@ -164,16 +164,11 @@ XkbListComponents . - - - - - - - -XkbComponentListPtr - XkbListComponents -( +XkbListComponents + + + XkbComponentListPtr XkbListComponents + + + Display *dpy + unsigned int device_spec + XkbComponentNamesPtr ptrns + int *max_inout + + + + + + dpy + + + + connection to X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + ptrns + + + + namelist for components of interest + + + + + + max_inout + + + + max # returned names, # left over + + + + @@ -367,28 +376,27 @@ XkbFreeComponentList - - - - - - - -void -XkbFreeComponentList -(list) - - - - -XkbComponentListPtr list; /* pointer to -XkbComponentListRec - to free */ - - - - - +XkbFreeComponentList + + + void XkbFreeComponentList + + + XkbComponentListPtr list + + + + + + list + + + + pointer to XkbComponentListRec to free + + + + @@ -552,16 +560,11 @@ XkbGetKeyboardByName . - - - - - - - -XkbDescPtr -XkbGetKeyboardByName -( +XkbGetKeyboardByName + + + XkbDescPtr XkbGetKeyboardByName + + + Display *dpy + unsigned int device_spec + XkbComponentNamesPtr names + unsigned int want + unsigned int need + Bool load + + + + + + dpy + + + + connection to X server + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + names + + + + names of components to fetch + + + + + + want + + + + desired structures in returned record + + + + + + need + + + + mandatory structures in returned record + + + + + + load + + + + True => load into device_spec + + + + @@ -1119,50 +1140,55 @@ XkbGetKeyboard (see section 6.2). - - - - - - - -XkbDescPtr -XkbGetKeyboard -( +XkbGetKeyboard + + + XkbDescPtr XkbGetKeyboard + + + Display *dpy + unsigned int which + unsigned int device_spec + + + + + + dpy + + + + connection to X server + + + + + + which + + + + mask of components of XkbDescRec of interest + + + + + + device_spec + + + + device ID + + + + diff --git a/specs/XKB/ch21.xml b/specs/XKB/ch21.xml index 0a17dc35..4eaf64c6 100644 --- a/specs/XKB/ch21.xml +++ b/specs/XKB/ch21.xml @@ -376,59 +376,73 @@ KeyClass extension device, use XkbGetDeviceInfo. - - - - - - - -XkbDeviceInfoPtr -XkbGetDeviceInfo -( +XkbGetDeviceInfo + + + XkbDeviceInfoPtr XkbGetDeviceInfo + + + Display *dpy + unsigned int which + unsigned int device_spec + unsigned int ind_class + unsigned int ind_id + + + + + + dpy + + + + connection to X server + + + + + + which + + + + mask indicating information to return + + + + + + device_spec + + + + device ID, or XkbUseCoreKbd + + + + + + ind_class + + + + feedback class for indicator requests + + + + + + ind_id + + + + feedback ID for indicator requests + + + + @@ -614,57 +628,73 @@ XkbGetDeviceButtonActions. - - - - - - - -Status -XkbGetDeviceButtonActions -( +XkbGetDeviceButtonActions + + + Status XkbGetDeviceButtonActions + + + Display *dpy + XkbDeviceInfoPtr device_info + Bool all_buttons + unsigned int first_button + unsigned int num_buttons + + + + + + dpy + + + + connection to X server + + + + + + device_info + + + + structure to update with results + + + + + + all_buttons + + + + True => get information for all buttons + + + + + + first_button + + + + number of first button for which info is desired + + + + + + num_buttons + + + + number of buttons for which info is desired + + + + @@ -748,55 +778,73 @@ of an input extension device, use XkbGetDeviceLedInfo. - - - - - - - -Status -XkbGetDeviceLedInfo -( +XkbGetDeviceLedInfo + + + Status XkbGetDeviceLedInfo + + + Display *dpy + XkbDeviceInfoPtr device_info + unsigned int led_class + unsigned int led_id + unsigned int which + + + + + + dpy + + + + connection to X server + + + + + + device_info + + + + structure to update with results + + + + + + led_class + + + + LED feedback class assigned by input extension + + + + + + led_id + + + + LED feedback ID assigned by input extension + + + + + + which + + + + mask indicating desired information + + + + @@ -937,41 +985,49 @@ XkbDeviceInfoRec structure, use XkbGetDeviceInfo or XkbAllocDeviceInfo. - - - - - - - -XkbDeviceInfoPtr -XkbAllocDeviceInfo -(device_spec, n_buttons, sz_leds) - - - - -unsigned int device_spec; /* device ID with which -structure will be used */ - - - - -unsigned int -n_buttons -; /* number of button actions to allocate space for*/ - - - - -unsigned int -sz_leds -; /* number of LED feedbacks to allocate space for */ - - - - - +XkbAllocDeviceInfo + + + XkbDeviceInfoPtr XkbAllocDeviceInfo + + + unsigned int device_spec + unsigned int n_buttons + unsigned int sz_leds + + + + + + device_spec + + + + device ID with which structure will be used + + + + + + n_buttons + + + + number of button actions to allocate space for + + + + + + sz_leds + + + + number of LED feedbacks to allocate space for + + + + @@ -1008,35 +1064,38 @@ XkbDeviceLedInfoRec - - - - - - - -Status -XkbAllocDeviceLedInfo -(devi, num_needed) - - - - -XkbDeviceInfoPtr -device_info -; /* structure in which to allocate LED space */ - - - - -int -num_needed -; /* number of indicators to allocate space for */ - - - - - +XkbAllocDeviceLedInfo + + + Status XkbAllocDeviceLedInfo + + + XkbDeviceInfoPtr device_info + int num_needed + + + + + + device_info + + + + structure in which to allocate LED space + + + + + + num_needed + + + + number of indicators to allocate space for + + + + @@ -1065,41 +1124,49 @@ XkbDeviceLedInfoRec - - - - - - - -XkbDeviceLedInfoPtr -XkbAddDeviceLedInfo -(device_info, led_class, led_id) - - - - -XkbDeviceInfoPtr device_info; /* structure in which to -add LED info */ - - - - -unsigned int -led_class -; /* input extension class for LED device of interest */ - - - - -unsigned int -led_id -; /* input extension ID for LED device of interest */ - - - - - +XkbAddDeviceLedInfo + + + XkbDeviceLedInfoPtr XkbAddDeviceLedInfo + + + XkbDeviceInfoPtr device_info + unsigned int led_class + unsigned int led_id + + + + + + device_info + + + + structure in which to add LED info + + + + + + led_class + + + + input extension class for LED device of interest + + + + + + led_id + + + + input extension ID for LED device of interest + + + + @@ -1160,34 +1227,38 @@ XkbDeviceInfoRec - - - - - - - -Status -XkbResizeDeviceButtonActions -(device_info, new_total) - - - - -XkbDeviceInfoPtr device_info; /* structure in which to -allocate button actions */ - - - - -unsigned int -new_total -; /* new total number of button actions needed */ - - - - - +XkbResizeDeviceButtonActions + + + Status XkbResizeDeviceButtonActions + + + XkbDeviceInfoPtr device_info + unsigned int new_total + + + + + + device_info + + + + structure in which to allocate button actions + + + + + + new_total + + + + new total number of button actions needed + + + + @@ -1224,46 +1295,49 @@ XkbDeviceInfoRec - - - - - - - -void -XkbFreeDeviceInfo -(device_info, which, free_all) - - - - -XkbDeviceInfoPtr device_info; /* pointer to -XkbDeviceInfoRec - in which to free items */ - - - - -unsigned int -which -; /* mask of components of -device_info - to free */ - - - - -Bool -free_all -; /* -True - => free everything, including device_info */ - - - - - +XkbFreeDeviceInfo + + + void XkbFreeDeviceInfo + + + XkbDeviceInfoPtr device_info + unsigned int which + Bool free_all + + + + + + device_info + + + + pointer to XkbDeviceInfoRec in which to free items + + + + + + which + + + + mask of components of device_info to free + + + + + + free_all + + + + True => free everything, including device_info + + + + If free_all is @@ -1387,43 +1461,51 @@ To modify some or all of the characteristics of an X Input Extension device, use XkbSetDeviceInfo. - - - - - - - -Bool -XkbSetDeviceInfo -( +XkbSetDeviceInfo + + + Bool XkbSetDeviceInfo + + + Display *dpy + unsigned int which + XkbDeviceInfoPtr device_info + + + + + + dpy + + + + connection to X server + + + + + + which + + + + mask indicating characteristics to modify + + + + + + device_info + + + + structure defining the device and modifications + + + + @@ -1586,48 +1668,62 @@ XkbSetDeviceButtonActions. - - - - - - - -Bool -XkbSetDeviceButtonActions -( +XkbSetDeviceButtonActions + + + Bool XkbSetDeviceButtonActions + + + Display *dpy + XkbDeviceInfoPtr device_info + unsigned int first_button + unsigned int num_buttons + + + + + + dpy + + + + connection to X server + + + + + + device_info + + + + structure defining the device and modifications + + + + + + first_button + + + + number of first button to update, 0 relative + + + + + + num_buttons + + + + number of buttons to update + + + + @@ -1852,44 +1948,51 @@ XkbExtensionDeviceNotify event, use XkbNoteDeviceChanges. - - - - - - - -void -XkbNoteDeviceChanges - ( +XkbNoteDeviceChanges + + + void XkbNoteDeviceChanges + + + XkbDeviceChangesPtr old + XkbExtensionDeviceNotifyEvent *new + unsigned int wanted + + + + + + old + + + + structure tracking state changes + + + + + + new + + + + event indicating state changes + + + + + + wanted + + + + mask indicating changes to note + + + + The wanted field specifies the changes that should be noted in @@ -1932,45 +2035,53 @@ XkbGetDeviceInfoChanges. - - - - - - - -Status -XkbGetDeviceInfoChanges -( +XkbGetDeviceInfoChanges + + + Status XkbGetDeviceInfoChanges + + + Display *dpy + XkbDeviceInfoPtr device_info + XkbDeviceChangesPtr changes + + + + + + dpy + + + + connection to X server + + + + + + device_info + + + + structure to update with results + + + + + + changes + + + + contains notes of changes that have occurred + + + + The changes->changed field indicates which attributes of the device @@ -1997,46 +2108,51 @@ XkbDeviceChangesRec, use XkbChangeDeviceInfo. - - - - - - - -Bool -XkbChangeDeviceInfo - ( +XkbChangeDeviceInfo + + + Bool XkbChangeDeviceInfo + + + Display *dpy + XkbDeviceInfoPtr device_info + XkbDeviceChangesPtr changes + + + + + + dpy + + + + connection to X server + + + + + + device_info + + + + local copy of device state and configuration + + + + + + changes + + + + note specifying changes in device_info + + + + diff --git a/specs/XKB/ch22.xml b/specs/XKB/ch22.xml index 4dea7338..93403eb6 100644 --- a/specs/XKB/ch22.xml +++ b/specs/XKB/ch22.xml @@ -20,83 +20,106 @@ XkbSetDebuggingFlags . - - - - - - - -Bool -XkbSetDebuggingFlags -( +XkbSetDebuggingFlags + + + Bool XkbSetDebuggingFlags + + + Display *display + unsigned int mask + unsigned int flags + char *msg + unsigned int ctrls_mask + unsigned int ctrls + unsigned int *ret_flags + unsigned int *ret_ctrls + + + + + + display + + + + connection to X server + + + + + + mask + + + + mask selecting debug output flags to change + + + + + + flags + + + + values for debug output flags selected by mask + + + + + + msg + + + + message to print right now + + + + + + ctrls_mask + + + + mask selecting debug controls to change + + + + + + ctrls + + + + values for debug controls selected by ctrls_mask + + + + + + ret_flags + + + + resulting state of all debug output flags + + + + + + ret_ctrls + + + + resulting state of all debug controls + + + +