Add QML api for client side extension.

This makes it simple to use client-side extensions in QML. The only
thing that the user needs to do is register the extension class using
qmlRegisterType() and the use the extension in QML.

Also adds simple QML example which uses client-side extension.

Change-Id: I2db99861d97c7bca5cfdbf86ba3a8ccc50fb24b0
Reviewed-by: Giulio Camuffo <giulio.camuffo@kdab.com>

5 files changed, 208 insertions, 1 deletions

diff --git a/examples/wayland/custom-extension/custom-extension.pro b/examples/wayland/custom-extension/custom-extension.pro
index c44464a3d..1e56b79c4 100644
--- a/examples/wayland/custom-extension/custom-extension.pro
+++ b/examples/wayland/custom-extension/custom-extension.pro
@@ -1,6 +1,7 @@
 TEMPLATE=subdirs
 
-SUBDIRS += client
+SUBDIRS += client \
+    qmltestapp
 SUBDIRS += compositor
 SUBDIRS += testapp
 
diff --git a/examples/wayland/custom-extension/qmltestapp/main.cpp b/examples/wayland/custom-extension/qmltestapp/main.cpp
new file mode 100644
index 000000000..23e280ca4
--- /dev/null
+++ b/examples/wayland/custom-extension/qmltestapp/main.cpp
@@ -0,0 +1,59 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Erik Larsson.
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the examples 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$
+**
+****************************************************************************/
+
+#include <QGuiApplication>
+#include <QtQml/QQmlApplicationEngine>
+
+#include <QtQml/qqml.h>
+#include <QtQml/QQmlEngine>
+#include "../client/customextension.h"
+
+int main(int argc, char *argv[])
+{
+    QGuiApplication app(argc, argv);
+
+    qmlRegisterType<QtWaylandClient::CustomExtension>("com.theqtcompany.customextension", 1, 0, "CustomExtension");
+
+    QQmlApplicationEngine engine;
+    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
+
+    return app.exec();
+}
+
diff --git a/examples/wayland/custom-extension/qmltestapp/main.qml b/examples/wayland/custom-extension/qmltestapp/main.qml
new file mode 100644
index 000000000..10e413efc
--- /dev/null
+++ b/examples/wayland/custom-extension/qmltestapp/main.qml
@@ -0,0 +1,114 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Erik Larsson.
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the examples 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$
+**
+****************************************************************************/
+
+import QtQuick 2.0
+import QtQuick.Window 2.0
+import com.theqtcompany.customextension 1.0
+
+Window {
+    visible: true
+    Rectangle {
+        anchors.fill: parent
+        color: "#297A4A"
+    }
+
+    MouseArea {
+        anchors.fill: parent
+        onClicked: {
+            console.log("Clicked outside", mouseX)
+            if (extensionLoader.item && extensionLoader.item.active)
+                extensionLoader.item.sendRequest("Clicked outside", mouseX)
+        }
+    }
+
+    MouseArea {
+        anchors.centerIn: parent
+        width: 100; height: 100
+        onClicked: {
+            var obj = mapToItem(parent, mouse.x, mouse.y)
+            console.log("Clicked inside", obj.x)
+            if (extensionLoader.item && extensionLoader.item.active)
+                extensionLoader.item.sendRequest("Clicked inside", obj.x)
+        }
+
+        Rectangle {
+            anchors.fill: parent
+            color: "#34FD85"
+        }
+    }
+
+    MouseArea {
+        anchors.right: parent.right
+        anchors.bottom: parent.bottom
+        width: 150; height: 25
+
+        Rectangle {
+            anchors.fill: parent
+            color: "#010101"
+            Text {
+                anchors.centerIn: parent
+                color: "white"
+                text: extensionLoader.item ? "Unload client extension" : "Load client extension"
+            }
+        }
+        onClicked: {
+            extensionLoader.active = !extensionLoader.active
+        }
+    }
+
+    Component {
+        id: extensionComponent
+        CustomExtension {
+            id: customExtension
+            onActiveChanged: console.log("Custom extension is active?", active)
+        }
+    }
+
+    Loader {
+        id: extensionLoader
+        sourceComponent: extensionComponent
+    }
+
+    Connections {
+        target: extensionLoader.item
+        onEventReceived: console.log("Event received", text, value)
+    }
+}
+
diff --git a/examples/wayland/custom-extension/qmltestapp/qml.qrc b/examples/wayland/custom-extension/qmltestapp/qml.qrc
new file mode 100644
index 000000000..5f6483ac3
--- /dev/null
+++ b/examples/wayland/custom-extension/qmltestapp/qml.qrc
@@ -0,0 +1,5 @@
+<RCC>
+    <qresource prefix="/">
+        <file>main.qml</file>
+    </qresource>
+</RCC>
diff --git a/examples/wayland/custom-extension/qmltestapp/qmltestapp.pro b/examples/wayland/custom-extension/qmltestapp/qmltestapp.pro
new file mode 100644
index 000000000..786faeb0b
--- /dev/null
+++ b/examples/wayland/custom-extension/qmltestapp/qmltestapp.pro
@@ -0,0 +1,28 @@
+TEMPLATE = app
+
+QT += qml quick waylandclient-private
+
+CONFIG += c++11
+CONFIG += wayland-scanner
+CONFIG += link_pkgconfig
+
+WAYLANDCLIENTSOURCES += ../protocol/custom.xml
+
+!contains(QT_CONFIG, no-pkg-config) {
+    PKGCONFIG += wayland-client
+} else {
+    LIBS += -lwayland-client
+}
+
+SOURCES += main.cpp \
+    ../client/customextension.cpp
+
+HEADERS += \
+    ../client/customextension.h
+
+RESOURCES += qml.qrc
+
+target.path = $$[QT_INSTALL_EXAMPLES]/wayland/custom-extension/qmltestapp
+INSTALLS += target
+
+