summaryrefslogtreecommitdiffstats
path: root/src/extensions/qt-key-unstable-v1.xml
blob: 0f8d8284c7b979de0e17868c70ac0aeefba3546f (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
<protocol name="qt_key_unstable_v1">

    <copyright>
 Copyright (C) 2018 The Qt Company Ltd.
 Contact: http://www.qt.io/licensing/

 This file is part of the plugins of the Qt Toolkit.

 $QT_BEGIN_LICENSE:BSD$
 You may use this file under the terms of the BSD license as follows:

 "Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
 met:
   * Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in
     the documentation and/or other materials provided with the
     distribution.
   * Neither the name of The Qt Company Ltd nor the names of its
     contributors may be used to endorse or promote products derived
     from this software without specific prior written permission.


 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."

 $QT_END_LICENSE$
    </copyright>

    <interface name="zqt_key_v1" version="1">
        <description summary="send serialized QKeyEvents">
            This protocol is independent of the Wayland seat concept. Its
            intention is to let a QKeyEvent be transferred from a Qt compositor
            to a Qt client without losing or adding false information by going
            through wl_seat and wl_keyboard.

            Note: This protocol is considered private to Qt. We will do our
            best to bump version numbers when we make backwards compatible
            changes, bump the protocol name and interface suffixes when we make
            backwards incompatible changes, but we provide no guarantees. We
            may also remove the protocol without warning. Implement this at
            your own risk.
        </description>
        <event name="key">
            <description summary="send key event">
                The key event notifies the client that a QKeyEvent has occurred on
                the server side.
            </description>
            <arg name="surface" type="object" interface="wl_surface"/>
            <arg name="time" type="uint"/>
            <arg name="type" type="uint"/>
            <arg name="key" type="uint"/>
            <arg name="modifiers" type="uint"/>
            <arg name="nativeScanCode" type="uint"/>
            <arg name="nativeVirtualKey" type="uint"/>
            <arg name="nativeModifiers" type="uint"/>
            <arg name="text" type="string"/>
            <arg name="autorepeat" type="uint"/>
            <arg name="count" type="uint"/>
        </event>
    </interface>
</protocol>