Rob Buis | 979e6a1 | 2017-10-02 17:39:48 +0000 | [diff] [blame] | 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <protocol name="keyboard_extension_unstable_v1"> |
| 3 | |
| 4 | <copyright> |
| 5 | Copyright 2017 The Chromium Authors. |
| 6 | |
| 7 | Permission is hereby granted, free of charge, to any person obtaining a |
| 8 | copy of this software and associated documentation files (the "Software"), |
| 9 | to deal in the Software without restriction, including without limitation |
| 10 | the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| 11 | and/or sell copies of the Software, and to permit persons to whom the |
| 12 | Software is furnished to do so, subject to the following conditions: |
| 13 | |
| 14 | The above copyright notice and this permission notice (including the next |
| 15 | paragraph) shall be included in all copies or substantial portions of the |
| 16 | Software. |
| 17 | |
| 18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 21 | THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| 23 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| 24 | DEALINGS IN THE SOFTWARE. |
| 25 | </copyright> |
| 26 | |
| 27 | <interface name="zcr_keyboard_extension_v1" version="1"> |
| 28 | <description summary="extends wl_keyboard with ack_key events"> |
| 29 | Allows a wl_keyboard to send ack_key requests for each key event of |
| 30 | the keyboard to the server. |
| 31 | |
| 32 | Warning! The protocol described in this file is experimental and |
| 33 | backward incompatible changes may be made. Backward compatible changes |
| 34 | may be added together with the corresponding uinterface version bump. |
| 35 | Backward incompatible changes are done by bumping the version number in |
| 36 | the protocol and uinterface names and resetting the interface version. |
| 37 | Once the protocol is to be declared stable, the 'z' prefix and the |
| 38 | version number in the protocol and interface names are removed and the |
| 39 | interface version number is reset. |
| 40 | </description> |
| 41 | |
| 42 | <enum name="error"> |
| 43 | <entry name="extended_keyboard_exists" value="0" |
| 44 | summary="the keyboard already has an extended_keyboard object associated"/> |
| 45 | </enum> |
| 46 | |
| 47 | <request name="get_extended_keyboard"> |
| 48 | <description summary="get extended_keyboard for a keyboard"> |
| 49 | Create extended_keyboard object. |
| 50 | See zcr_extended_keyboard interface for details. |
| 51 | If the given wl_keyboard object already has a extended_keyboard object |
| 52 | associated, the extended_keyboard_exists protocol error is raised. |
| 53 | </description> |
| 54 | <arg name="id" type="new_id" interface="zcr_extended_keyboard_v1"/> |
| 55 | <arg name="keyboard" type="object" interface="wl_keyboard"/> |
| 56 | </request> |
| 57 | </interface> |
| 58 | |
| 59 | <interface name="zcr_extended_keyboard_v1" version="1"> |
| 60 | <description summary="extension of wl_keyboard protocol"> |
| 61 | The zcr_extended_keyboard_v1 interface extends the wl_keyboard interface |
| 62 | with requests to notify whether sent key events are handled or not by |
| 63 | the client. |
| 64 | </description> |
| 65 | |
| 66 | <request name="destroy" type="destructor"> |
| 67 | <description summary="destroy extended_keyboard object"/> |
| 68 | </request> |
| 69 | |
| 70 | <enum name="handled_state"> |
| 71 | <description summary="whether a key event is handled by client or not"/> |
| 72 | <entry name="not_handled" value="0"/> |
| 73 | <entry name="handled" value="1"/> |
| 74 | </enum> |
| 75 | |
| 76 | <request name="ack_key"> |
| 77 | <description summary="acknowledge a key event"/> |
| 78 | <arg name="serial" type="uint"/> |
| 79 | <arg name="handled" type="uint" enum="handled_state"/> |
| 80 | </request> |
| 81 | </interface> |
| 82 | </protocol> |