From ed89b140a1359dc97f420255813599954b5d334b Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Tue, 30 Nov 2010 09:49:41 -0500 Subject: specs: convert xkbproto from Framemaker to DocBook/XML Signed-off-by: Gaetan Nadon --- specs/ch15.xml | 232 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 232 insertions(+) create mode 100644 specs/ch15.xml (limited to 'specs/ch15.xml') diff --git a/specs/ch15.xml b/specs/ch15.xml new file mode 100644 index 0000000..fb9472f --- /dev/null +++ b/specs/ch15.xml @@ -0,0 +1,232 @@ + +Interactions Between XKB and the X Input Extension + + +All XKB interactions with the input extension are optional; implementors are +free to restrict the effects of the X Keyboard Extension to the core keyboard +device. The +XkbGetExtensionDeviceInfo + request reports whether or not an XKB implementation supports a particular +capability for input extension devices. + + + + +XKB recognizes the following interactions with the X Input Extension: + + + + + + + + + Name + Capability + + + + + XI_Keyboards + If set, applications can use all XKB requests and events with +extension keyboards. + + + XI_ButtonActions + If set, clients can assign key actions to buttons, even on input +extension devices that are not keyboards. + + + XI_IndicatorNames + If set, clients can assign names to indicators on non-keyboard +extension devices. + + + XI_IndicatorMaps + If set, clients can assign indicator maps to indicators on +non-keyboard extension devices. + + + XI_IndicatorState + If set, clients can change the state of device indicators using the + +XkbSetExtensionDeviceInfo + request. + + + + + + +Attempts to use an XKB feature with an extension device fail with a +Keyboard + error if the server does not support the +XkbXI_Keyboards + optional feature. If a capability particular capability other than +XkbXI_Keyboards + is not supported, attempts to use it fail silently. The replies for most +requests that can use one of the other optional features include a field to +report whether or not the request was successful, but such requests do not +cause an error condition. + + + + +Clients can also request an +XkbExtensionDeviceNotify + event. This event notifies interested clients of changes to any of the +supported XKB features for extension devices, or if a request from the client +that is receiving the event attempted to use an unsupported feature. + + + +Using XKB Functions with Input Extension Keyboards + + +All XKB requests and events include a device identifier which can refer to an +input extension +KeyClass + device, if the implementation allows XKB to control extension devices. If the +implementation does not support XKB manipulation of extension devices, the +device identifier is ignored but it must be either +0 + or +UseCoreKbd +. + + + + +Implementations which do not support the use of XKB functions with extension +keyboards must not set the +XkbXI_Keyboards + flag. Attempts to use XKB features on an extension keyboard with an +implementation that does not support this feature yield a +Keyboard + error. + + + + + +Pointer and Device Button Actions + + +The XKB extension optionally allows clients to assign any key action (see +See Key Actions) to core +pointer or input extension device buttons. This makes it possible to control +the keyboard or generate keyboard key events from extension devices or from the +core pointer. + + + + +XKB implementations are required to support actions for the buttons of the core +pointer device, but support for actions on extension devices is optional. +Implementations which do not support button actions for extension devices must +not set the +XkbXI_ButtonActions + flag. + + + + +Attempts to query or assign button actions with an implementation that does not +support this feature report failure in the request reply and might cause the +server to send an +XkbExtensionDeviceNotify + event to the client which issued the request that failed. Such requests never +cause an error condition. + + + + + +Indicator Maps for Extension Devices + + +The XKB extension allows applications to assign indicator maps to the +indicators of non-keyboard extension devices. If supported, maps can be +assigned to all extension device indicators, whether they are part of a +keyboard feedback or part of an indicator feedback. + + + + +Implementations which do not support indicator maps for extension devices must +not set the +XkbXI_IndicatorMaps + flag. + + + + +Attempts to query or assign indicator maps with an implementation that does not +support this feature report failure in the request reply and might cause the +server to send an +XkbExtensionDeviceNotify + event to the client which issued the request that failed. Such requests never +cause an error condition. + + + + +If this feature is supported, the maps for the default indicators on the core +keyboard device are visible both as extension indicators and as the core +indicators. Changes made with +XkbSetDeviceInfo + are visible via +XkbGetIndicatorMap + and changes made with +XkbSetIndicatorMap + are visible via +XkbGetDeviceInfo +. + + + + + +Indicator Names for Extension Devices + + +The XKB extension allows applications to assign symbolic names to the +indicators of non-keyboard extension devices. If supported, symbolic names can +be assigned to all extension device indicators, whether they are part of a +keyboard feedback or part of an indicator feedback. + + + + +Implementations which do not support indicator maps for extension devices must +not set the +XkbXI_IndicatorMaps + flag. + + + + +Attempts to query or assign indicator names with an implementation that does +not support this feature report failure in the request reply and might cause +the server to send an +XkbExtensionDeviceNotify + event to the client which issued the request that failed. Such requests never +cause an error condition. + + + + +If this feature is supported, the names for the default indicators on the core +keyboard device are visible both as extension indicators and as the core +indicators. Changes made with +XkbSetDeviceInfo + are visible via +XkbGetNames + and changes made with +XkbSetNames + are visible via +XkbGetDeviceInfo +. + + + -- cgit v1.2.3 From c336374f3bf34ce875b29001548470f8d824141e Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Wed, 2 Mar 2011 17:11:05 -0700 Subject: Fix bad link anchors. Fix broken links in kxproto. The old links hardcoded the output filename 'XKBproto.htm' and used anchors that didn't convert correctly. The new anchors are strings that use the same convention as other anchors in other docs. Fix links like: Compute State Field to be: Compute State Field Signed-off-by: Matt Dew Reviewed-by: Gaetan Nadon Reviewed-by: Alan Coopersmith --- specs/ch15.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'specs/ch15.xml') diff --git a/specs/ch15.xml b/specs/ch15.xml index fb9472f..7cca36a 100644 --- a/specs/ch15.xml +++ b/specs/ch15.xml @@ -113,7 +113,7 @@ Keyboard The XKB extension optionally allows clients to assign any key action (see -See Key Actions) to core +See Key Actions) to core pointer or input extension device buttons. This makes it possible to control the keyboard or generate keyboard key events from extension devices or from the core pointer. -- cgit v1.2.3 From b82c9b3f752c89d3328c0257d8a386024c9023ee Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Tue, 15 Mar 2011 23:30:15 -0600 Subject: Remove duplicate 'See see' text in docs - take 2 --- specs/ch15.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'specs/ch15.xml') diff --git a/specs/ch15.xml b/specs/ch15.xml index 7cca36a..6c56ad6 100644 --- a/specs/ch15.xml +++ b/specs/ch15.xml @@ -113,7 +113,7 @@ Keyboard The XKB extension optionally allows clients to assign any key action (see -See Key Actions) to core +Key Actions) to core pointer or input extension device buttons. This makes it possible to control the keyboard or generate keyboard key events from extension devices or from the core pointer. -- cgit v1.2.3 From cb49f95af605bd5019e194eeb656d8789d57756a Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Mon, 3 Oct 2011 18:06:16 -0600 Subject: 1 - fix the capitolization of the ID attriutes to match either the or <funcdef> string it goes with. 2 - fix any <linkend>'s that were affected by 1. 3 - any <function> in the docs that has an actual funcdef, will become an olink. Signed-off-by: Matt Dew <marcoz@osource.org> --- specs/ch15.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'specs/ch15.xml') diff --git a/specs/ch15.xml b/specs/ch15.xml index 6c56ad6..ec0ce72 100644 --- a/specs/ch15.xml +++ b/specs/ch15.xml @@ -1,4 +1,4 @@ -<chapter id='interactions_between_xkb_and_the_x_input_extension'> +<chapter id='Interactions_Between_XKB_and_the_X_Input_Extension'> <title>Interactions Between XKB and the X Input Extension @@ -79,7 +79,7 @@ supported XKB features for extension devices, or if a request from the client that is receiving the event attempted to use an unsupported feature. - + Using XKB Functions with Input Extension Keyboards @@ -108,12 +108,12 @@ Keyboard - + Pointer and Device Button Actions The XKB extension optionally allows clients to assign any key action (see -Key Actions) to core +Key Actions) to core pointer or input extension device buttons. This makes it possible to control the keyboard or generate keyboard key events from extension devices or from the core pointer. @@ -141,7 +141,7 @@ cause an error condition. - + Indicator Maps for Extension Devices @@ -186,7 +186,7 @@ XkbGetDeviceInfo - + Indicator Names for Extension Devices -- cgit v1.2.3 From b0f7912512091ea58dfaf8dffb2a658a6afeb96d Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Mon, 16 Jan 2012 15:38:49 -0700 Subject: informaltable cleanup On certain tables, add top and bottom borders to table header and a bottom border to the table. This matches what those tables in the old pdfs looked like. the prevents tables from splitting across pages. Useful for tiny tables. Converting the colwidth to a floating point, IE, 1* -> 1.0* cleans up these build errors: WARNING: table-layout="fixed" and column-width unspecified => falling back to proportional-column-width(1) Signed-off-by: Matt Dew --- specs/ch15.xml | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) (limited to 'specs/ch15.xml') diff --git a/specs/ch15.xml b/specs/ch15.xml index ec0ce72..d3e47d0 100644 --- a/specs/ch15.xml +++ b/specs/ch15.xml @@ -15,10 +15,11 @@ capability for input extension devices. XKB recognizes the following interactions with the X Input Extension: - - - - + + + + + Name @@ -26,27 +27,27 @@ XKB recognizes the following interactions with the X Input Extension: - + XI_Keyboards If set, applications can use all XKB requests and events with extension keyboards. - + XI_ButtonActions If set, clients can assign key actions to buttons, even on input extension devices that are not keyboards. - + XI_IndicatorNames If set, clients can assign names to indicators on non-keyboard extension devices. - + XI_IndicatorMaps If set, clients can assign indicator maps to indicators on non-keyboard extension devices. - + XI_IndicatorState If set, clients can change the state of device indicators using the -- cgit v1.2.3