summaryrefslogtreecommitdiff
path: root/protocol/ivi-input.xml
blob: f8ca77e8d31f51a4b7c322863ebd40e33b06259f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="ivi_input">
    <copyright>
    Copyright (c) 2015 Codethink Ltd

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.
    </copyright>
    <interface name="ivi_input" version="1">
        <description summary="controller interface to the input system">
            This includes handling the existence of seats, seat capabilities,
            seat acceptance and input focus.
        </description>
        <event name="seat_created">
            <description summary="A new seat has appeared">
            </description>
            <arg name="name" type="string"/>
            <arg name="capabilities" type="uint"/>
        </event>
        <event name="seat_capabilities">
            <description summary="A seat's capabilities have changed">
            </description>
            <arg name="name" type="string"/>
            <arg name="capabilities" type="uint"/>
        </event>
        <event name="seat_destroyed">
            <description summary="A seat is no longer available">
            </description>
            <arg name="name" type="string"/>
        </event>
        <request name="set_input_focus">
            <description summary="set input focus for a given surface ID">
                Set input focus state of surface in ivi compositor. If the surface has input
                focus, all non-graphical inputs (e.g. keyboard) are directed to the application
                providing the content for this surface.
                Multiple surfaces can have input focus at a time.
                If argument enabled is ILM_TRUE, input focus for this surface is enabled.
                If argument enabled is not ILM_TRUE, the input focus from this surface is removed.
            </description>

            <arg name="surface" type="uint"/>
            <arg name="device" type="uint"/>
            <arg name="enabled" type="int"/>
        </request>

        <event name="input_focus">
            <description summary="input focus of surface in ivi compositor has changed">
                The new input focus state is provided in argument enabled:
                If enabled is ILM_TRUE, this surface now has input focus enabled.
                If enabled is not ILM_TRUE, this surface no longer has input focus.
            </description>
            <arg name="surface" type="uint"/>
            <arg name="device" type="uint"/>
            <arg name="enabled" type="int"/>
        </event>

        <request name="set_input_acceptance">
            <description summary="set a surface's input acceptance for a seat">
                Set input acceptance of one seat for a surface. Surfaces may
                accept input acceptance from multiple seats at once.
                If argument 'accepted' is ILM_TRUE, the given seat's name will
                be added to the list of accepted seats.
                If argument 'accepted' is not ILM_TRUE, the given seat's name
                will be removed from the list of accepted seats.
            </description>
            <arg name="surface" type="uint"/>
            <arg name="seat" type="string"/>
            <arg name="accepted" type="int"/>
        </request>

        <event name="input_acceptance">
            <description summary="input acceptance has changed">
                A surface has changed its input acceptance for a specific seat.
                If argument 'accepted' is ILM_TRUE, the surface now accepts
                the seat.
                If argument 'accepted' is not ILM_TRUE, the surface no longer
                accepts the seat.
            </description>
            <arg name="surface" type="uint"/>
            <arg name="seat" type="string"/>
            <arg name="accepted" type="int"/>
        </event>
    </interface>
</protocol>