Replace qtkey-extension with qt-key-unstable-v1

- Remove the "dummy" request, which seems to be just leftover test code.
- Rename the event from "qtkey" to "key". We've already prefixed the
  global interface, no need to also prefix the event.
- Prefix the global with `zqt_` and suffix it with "_v1". If we make
  backwards incompatible changes, we should bump the suffix, rename the
  xml-file and reset the version number.
- Add some documentation to the xml file.
- Add notice about (lack of) compatibility guarantees.
- Four spaces for indentation

Task-number: QTBUG-68423
Change-Id: I78f0eaff4cac22f27318ba32c83c83feb2de857a
Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>

1 files changed, 32 insertions, 22 deletions

diff --git a/src/extensions/qtkey-extension.xml b/src/extensions/qt-key-unstable-v1.xml
index 34cf24797..0f8d8284c 100644
--- a/src/extensions/qtkey-extension.xml
+++ b/src/extensions/qt-key-unstable-v1.xml
@@ -1,7 +1,7 @@
-<protocol name="qtkey_extension">
+<protocol name="qt_key_unstable_v1">
 
     <copyright>
- Copyright (C) 2015 The Qt Company Ltd.
+ Copyright (C) 2018 The Qt Company Ltd.
  Contact: http://www.qt.io/licensing/
 
  This file is part of the plugins of the Qt Toolkit.
@@ -38,26 +38,36 @@
  $QT_END_LICENSE$
     </copyright>
 
-    <interface name="qt_key_extension" version="2">
-        <event name="qtkey">
-          <description summary="qtkey event">
-             Serialized QKeyEvent
-          </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 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.
 
-        <request name="dummy">
-        </request>
+            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>