Add overview-compositor example

Change-Id: Id6243dbe9d1c5f872006264938c735bc2a779517
Reviewed-by: Pier Luigi Fiorini <pierluigi.fiorini@liri.io>

6 files changed, 252 insertions, 0 deletions

diff --git a/examples/wayland/overview-compositor/.gitignore b/examples/wayland/overview-compositor/.gitignore
new file mode 100644
index 000000000..e4b9e3403
--- /dev/null
+++ b/examples/wayland/overview-compositor/.gitignore
@@ -0,0 +1 @@
+overview-compositor
diff --git a/examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc b/examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc
new file mode 100644
index 000000000..0462c39ae
--- /dev/null
+++ b/examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc
@@ -0,0 +1,33 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ * \title Qt Wayland Compositor Examples - Overview Compositor
+ * \example overview-compositor
+ * \brief Overview Compositor shows how to switch between clients in a grid
+ * \ingroup qtwaylandcompositor-examples
+ */
diff --git a/examples/wayland/overview-compositor/main.cpp b/examples/wayland/overview-compositor/main.cpp
new file mode 100644
index 000000000..435b4e3f1
--- /dev/null
+++ b/examples/wayland/overview-compositor/main.cpp
@@ -0,0 +1,65 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 The Qt Company Ltd.
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the examples of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** BSD License Usage
+** Alternatively, 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 <QtCore/QUrl>
+#include <QtCore/QDebug>
+
+#include <QtGui/QGuiApplication>
+
+#include <QtQml/QQmlApplicationEngine>
+
+int main(int argc, char *argv[])
+{
+    QGuiApplication app(argc, argv);
+
+    QQmlApplicationEngine appEngine(QUrl("qrc:///main.qml"));
+
+    return app.exec();
+}
diff --git a/examples/wayland/overview-compositor/main.qml b/examples/wayland/overview-compositor/main.qml
new file mode 100644
index 000000000..6e5cec985
--- /dev/null
+++ b/examples/wayland/overview-compositor/main.qml
@@ -0,0 +1,134 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 The Qt Company Ltd.
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the examples of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** BSD License Usage
+** Alternatively, 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.7
+import QtWayland.Compositor 1.0
+import QtQuick.Window 2.0
+import QtQuick.Controls 2.0
+
+WaylandCompositor {
+    WaylandOutput {
+        sizeFollowsWindow: true
+        window: Window {
+            id: win
+            visible: true
+            width: 1280
+            height: 720
+            Grid {
+                id: grid
+                anchors.fill: parent
+                columns: Math.ceil(Math.sqrt(shellSurfaces.count))
+                property bool overview: true
+                property int selected: 0
+                property int selectedColumn: selected % columns
+                property int selectedRow: selected / columns
+
+                transform: [
+                    Scale {
+                        xScale: grid.overview ? (1.0/grid.columns) : 1
+                        yScale: grid.overview ? (1.0/grid.columns) : 1
+                        Behavior on xScale { PropertyAnimation { easing.type: Easing.InOutQuad; duration: 200 } }
+                        Behavior on yScale { PropertyAnimation { easing.type: Easing.InOutQuad; duration: 200 } }
+                    },
+                    Translate {
+                        x: grid.overview ? 0 : win.width * -grid.selectedColumn
+                        y: grid.overview ? 0 : win.height * -grid.selectedRow
+                        Behavior on x { PropertyAnimation { easing.type: Easing.InOutQuad; duration: 200 } }
+                        Behavior on y { PropertyAnimation { easing.type: Easing.InOutQuad; duration: 200 } }
+                    }
+                ]
+
+                Repeater {
+                    model: shellSurfaces
+                    Item {
+                        width: win.width
+                        height: win.height
+                        WaylandQuickItem {
+                            anchors.fill: parent
+                            sizeFollowsSurface: false
+                            surface: modelData.surface
+                            onSurfaceDestroyed: shellSurfaces.remove(index)
+                        }
+                        MouseArea {
+                            enabled: grid.overview
+                            anchors.fill: parent
+                            onClicked: {
+                                grid.selected = index;
+                                grid.overview = false;
+                            }
+                        }
+                    }
+                }
+            }
+
+            Button {
+                anchors.horizontalCenter: parent.horizontalCenter
+                anchors.bottom: parent.bottom
+                text: "Toggle overview";
+                onClicked: grid.overview = !grid.overview
+            }
+
+            Shortcut { sequence: "space"; onActivated: grid.overview = !grid.overview }
+            Shortcut { sequence: "right"; onActivated: grid.selected = Math.min(grid.selected+1, shellSurfaces.count-1) }
+            Shortcut { sequence: "left"; onActivated: grid.selected = Math.max(grid.selected-1, 0) }
+            Shortcut { sequence: "up"; onActivated: grid.selected = Math.max(grid.selected-grid.columns, 0) }
+            Shortcut { sequence: "down"; onActivated: grid.selected = Math.min(grid.selected+grid.columns, shellSurfaces.count-1) }
+        }
+    }
+
+    ListModel { id: shellSurfaces }
+
+    WlShell {
+        onWlShellSurfaceCreated: {
+            shellSurfaces.append({shellSurface: shellSurface});
+            shellSurface.sendConfigure(Qt.size(win.width, win.height), WlShellSurface.NoneEdge);
+        }
+    }
+}
diff --git a/examples/wayland/overview-compositor/overview-compositor.pro b/examples/wayland/overview-compositor/overview-compositor.pro
new file mode 100644
index 000000000..213d8d01f
--- /dev/null
+++ b/examples/wayland/overview-compositor/overview-compositor.pro
@@ -0,0 +1,14 @@
+QT += gui qml
+
+SOURCES += \
+    main.cpp
+
+OTHER_FILES = \
+    main.qml
+
+RESOURCES += overview-compositor.qrc
+
+target.path = $$[QT_INSTALL_EXAMPLES]/wayland/overview-compositor
+sources.files = $$SOURCES $$HEADERS $$RESOURCES $$FORMS overview-compositor.pro
+sources.path = $$[QT_INSTALL_EXAMPLES]/wayland/overview-compositor
+INSTALLS += target sources
diff --git a/examples/wayland/overview-compositor/overview-compositor.qrc b/examples/wayland/overview-compositor/overview-compositor.qrc
new file mode 100644
index 000000000..5f6483ac3
--- /dev/null
+++ b/examples/wayland/overview-compositor/overview-compositor.qrc
@@ -0,0 +1,5 @@
+<RCC>
+    <qresource prefix="/">
+        <file>main.qml</file>
+    </qresource>
+</RCC>