1<?xml version="1.0" encoding="UTF-8"?> 2<protocol name="ivi_input"> 3 <copyright> 4 Copyright (c) 2015 Codethink Ltd 5 6 Permission is hereby granted, free of charge, to any person obtaining a copy 7 of this software and associated documentation files (the "Software"), to deal 8 in the Software without restriction, including without limitation the rights 9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 copies of the Software, and to permit persons to whom the Software is 11 furnished to do so, subject to the following conditions: 12 13 The above copyright notice and this permission notice shall be included in 14 all copies or substantial portions of the Software. 15 16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 22 THE SOFTWARE. 23 </copyright> 24 <interface name="ivi_input" version="1"> 25 <description summary="controller interface to the input system"> 26 This includes handling the existence of seats, seat capabilities, 27 seat acceptance and input focus. 28 </description> 29 <event name="seat_created"> 30 <description summary="A new seat has appeared"> 31 </description> 32 <arg name="name" type="string"/> 33 <arg name="capabilities" type="uint"/> 34 </event> 35 <event name="seat_capabilities"> 36 <description summary="A seat's capabilities have changed"> 37 </description> 38 <arg name="name" type="string"/> 39 <arg name="capabilities" type="uint"/> 40 </event> 41 <event name="seat_destroyed"> 42 <description summary="A seat is no longer available"> 43 </description> 44 <arg name="name" type="string"/> 45 </event> 46 <request name="set_input_focus"> 47 <description summary="set input focus for a given surface ID"> 48 Set input focus state of surface in ivi compositor. If the surface has input 49 focus, all non-graphical inputs (e.g. keyboard) are directed to the application 50 providing the content for this surface. 51 Multiple surfaces can have input focus at a time. 52 If argument enabled is ILM_TRUE, input focus for this surface is enabled. 53 If argument enabled is not ILM_TRUE, the input focus from this surface is removed. 54 </description> 55 56 <arg name="surface" type="uint"/> 57 <arg name="device" type="uint"/> 58 <arg name="enabled" type="int"/> 59 </request> 60 61 <event name="input_focus"> 62 <description summary="input focus of surface in ivi compositor has changed"> 63 The new input focus state is provided in argument enabled: 64 If enabled is ILM_TRUE, this surface now has input focus enabled. 65 If enabled is not ILM_TRUE, this surface no longer has input focus. 66 </description> 67 <arg name="surface" type="uint"/> 68 <arg name="device" type="uint"/> 69 <arg name="enabled" type="int"/> 70 </event> 71 72 <request name="set_input_acceptance"> 73 <description summary="set a surface's input acceptance for a seat"> 74 Set input acceptance of one seat for a surface. Surfaces may 75 accept input acceptance from multiple seats at once. 76 If argument 'accepted' is ILM_TRUE, the given seat's name will 77 be added to the list of accepted seats. 78 If argument 'accepted' is not ILM_TRUE, the given seat's name 79 will be removed from the list of accepted seats. 80 </description> 81 <arg name="surface" type="uint"/> 82 <arg name="seat" type="string"/> 83 <arg name="accepted" type="int"/> 84 </request> 85 86 <event name="input_acceptance"> 87 <description summary="input acceptance has changed"> 88 A surface has changed its input acceptance for a specific seat. 89 If argument 'accepted' is ILM_TRUE, the surface now accepts 90 the seat. 91 If argument 'accepted' is not ILM_TRUE, the surface no longer 92 accepts the seat. 93 </description> 94 <arg name="surface" type="uint"/> 95 <arg name="seat" type="string"/> 96 <arg name="accepted" type="int"/> 97 </event> 98 </interface> 99</protocol> 100