1<?xml version="1.0" encoding="UTF-8"?> 2<protocol name="keyboard_configuration_unstable_v1"> 3 4 <copyright> 5 Copyright 2016 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_configuration_v1" version="2"> 28 <description summary="extends wl_keyboard with events for device configuration change"> 29 Allows a wl_keyboard to notify device configuration change events of 30 the keyboard to the client. 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="device_configuration_exists" value="0" 44 summary="the keyboard already has a device configuration object associated"/> 45 </enum> 46 47 <request name="get_keyboard_device_configuration"> 48 <description summary="get keyboard_device_configuration interface for a keyboard"> 49 Create keyboard_device_configuration object. 50 See zcr_keyboard_device_configuration interface for details. 51 If the given wl_keyboard object already has a device configuration 52 object associated, the keyboard_device_configuration_exists protocol 53 error is raised. 54 </description> 55 <arg name="id" type="new_id" interface="zcr_keyboard_device_configuration_v1"/> 56 <arg name="keyboard" type="object" interface="wl_keyboard"/> 57 </request> 58 </interface> 59 60 <interface name="zcr_keyboard_device_configuration_v1" version="2"> 61 <description summary="extension of wl_keyboard protocol"> 62 The zcr_keyboard_device_configuration_v1 interface extends the wl_keyboard 63 interface with events to describe device configuration of a keyboard. 64 </description> 65 66 <request name="destroy" type="destructor"> 67 <description summary="destroy keyboard_device_configuration object"/> 68 </request> 69 70 <enum name="keyboard_type"> 71 <description summary="keyboard types"/> 72 <entry name="physical" value="0" summary="Physical keyboard"/> 73 <entry name="virtual" value="1" summary="Virtual keyboard"/> 74 </enum> 75 76 <event name="type_change"> 77 <description summary="keyboard type changed"> 78 Notification that the user is switching to new keyboard type. 79 80 If this event is not received, the cleint has to assume a physical 81 keyboard is in use. 82 </description> 83 <arg name="type" type="uint" enum="keyboard_type" summary="new device type"/> 84 </event> 85 86 <!-- Version 2 additions --> 87 88 <event name="layout_change" since="2"> 89 <description summary="keyboard layout changed"> 90 Notification that the user is switching to a new keyboard layout. 91 This is an alternative to keymap event in wl_keyboard interface. The 92 client responds to one of them, and the other is ignored. 93 </description> 94 <arg name="name" type="string" summary="XKB layout name e.g. us(dvorak)"/> 95 </event> 96 </interface> 97 98</protocol> 99