Merge lp:~dandrader/unity-api/mirSurface-15.04 into lp:~unity-team/unity-api/trunk-15.04

[Daniel d'Andrada]

Added MirSurface and MirSurfaceItem interfaces

[Gerry Boland (gerboland)]

LGTM

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2015-08-11 14:05:55 +0000
+++ debian/changelog	2015-08-19 14:04:26 +0000
@@ -1,3 +1,9 @@
+unity-api (7.100) UNRELEASED; urgency=medium
+
+  * Added MirSurface and MirSurfaceItem interfaces
+
+ -- Daniel d'Andrada <[e-mail]>  Wed, 19 Aug 2015 10:13:05 -0300
+
 unity-api (7.99+15.04.20150811-0ubuntu1) vivid; urgency=medium
 
   * New rebuild forced.

=== modified file 'include/unity/shell/application/CMakeLists.txt'
--- include/unity/shell/application/CMakeLists.txt	2015-06-19 12:02:05 +0000
+++ include/unity/shell/application/CMakeLists.txt	2015-08-19 14:04:26 +0000
@@ -7,7 +7,7 @@
 
 set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE)
 
-set(VERSION 7)
+set(VERSION 8)
 set(PKGCONFIG_NAME "unity-shell-application")
 set(PKGCONFIG_DESCRIPTION "Unity shell Application APIs")
 set(PKGCONFIG_REQUIRES "Qt5Core")

=== added file 'include/unity/shell/application/Mir.h'
--- include/unity/shell/application/Mir.h	1970-01-01 00:00:00 +0000
+++ include/unity/shell/application/Mir.h	2015-08-19 14:04:26 +0000
@@ -0,0 +1,76 @@
+/*
+ * Copyright (C) 2015 Canonical, Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef UNITY_SHELL_APPLICATION_MIR_H
+#define UNITY_SHELL_APPLICATION_MIR_H
+
+#include <QObject>
+
+/**
+    @brief Acting as a namespace to hold enums and such for use in QML
+ */
+class Mir
+{
+    Q_GADGET
+    Q_ENUMS(Type)
+    Q_ENUMS(State)
+    Q_ENUMS(OrientationAngle)
+
+public:
+    /**
+        @brief Surface type
+     */
+    enum Type {
+        UnknownType,
+        NormalType,
+        UtilityType,
+        DialogType,
+        GlossType,
+        FreeStyleType,
+        MenuType,
+        InputMethodType,
+        SatelliteType,
+        TipType,
+    };
+
+    /**
+        @brief Surface state
+     */
+    enum State {
+        UnknownState,
+        RestoredState,
+        MinimizedState,
+        MaximizedState,
+        VertMaximizedState,
+        FullscreenState,
+        HorizMaximizedState,
+        HiddenState,
+    };
+
+    /**
+        @brief Surface orientation angle
+     */
+    enum OrientationAngle {
+        Angle0 = 0,
+        Angle90 = 90,
+        Angle180 = 180,
+        Angle270 = 270
+    };
+};
+
+Q_DECLARE_METATYPE(Mir::OrientationAngle)
+
+#endif // UNITY_SHELL_APPLICATION_MIR_H

=== added file 'include/unity/shell/application/MirSurfaceInterface.h'
--- include/unity/shell/application/MirSurfaceInterface.h	1970-01-01 00:00:00 +0000
+++ include/unity/shell/application/MirSurfaceInterface.h	2015-08-19 14:04:26 +0000
@@ -0,0 +1,114 @@
+/*
+ * Copyright (C) 2015 Canonical, Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef UNITY_SHELL_APPLICATION_MIRSURFACE_H
+#define UNITY_SHELL_APPLICATION_MIRSURFACE_H
+
+#include <QObject>
+#include <QSize>
+
+#include "Mir.h"
+
+namespace unity
+{
+namespace shell
+{
+namespace application
+{
+
+/**
+   @brief Holds a Mir surface. Pretty much an opaque class.
+
+   All surface manipulation is done by giving it to a MirSurfaceItem and then
+   using MirSurfaceItem's properties.
+ */
+class MirSurfaceInterface : public QObject
+{
+    Q_OBJECT
+
+    /**
+     * @brief The surface type
+     */
+    Q_PROPERTY(Mir::Type type READ type NOTIFY typeChanged)
+
+    /**
+     * @brief Name of the surface, given by the client application
+     */
+    Q_PROPERTY(QString name READ name CONSTANT)
+
+    /**
+     * @brief Size of the current surface buffer, in pixels.
+     */
+    Q_PROPERTY(QSize size READ size NOTIFY sizeChanged)
+
+    /**
+     * @brief State of the surface
+     */
+    Q_PROPERTY(Mir::State state READ state WRITE setState NOTIFY stateChanged)
+
+    /**
+     * @brief True if it has a mir client bound to it.
+     * A "zombie" (live == false) surface never becomes alive again.
+     */
+    Q_PROPERTY(bool live READ live NOTIFY liveChanged)
+
+    /**
+     * @brief Orientation angle of the surface
+     *
+     * How many degrees, clockwise, the UI in the surface has to rotate to match shell's UI orientation
+     */
+    Q_PROPERTY(Mir::OrientationAngle orientationAngle READ orientationAngle WRITE setOrientationAngle
+               NOTIFY orientationAngleChanged DESIGNABLE false)
+
+public:
+    /// @cond
+    MirSurfaceInterface(QObject *parent = nullptr) : QObject(parent) {}
+    virtual ~MirSurfaceInterface() {}
+
+    virtual Mir::Type type() const = 0;
+
+    virtual QString name() const = 0;
+
+    virtual QSize size() const = 0;
+    virtual void resize(int width, int height) = 0;
+    virtual void resize(const QSize &size) = 0;
+
+    virtual Mir::State state() const = 0;
+    virtual void setState(Mir::State qmlState) = 0;
+
+    virtual bool live() const = 0;
+
+    virtual Mir::OrientationAngle orientationAngle() const = 0;
+    virtual void setOrientationAngle(Mir::OrientationAngle angle) = 0;
+    /// @endcond
+
+Q_SIGNALS:
+    /// @cond
+    void typeChanged(Mir::Type value);
+    void liveChanged(bool value);
+    void stateChanged(Mir::State value);
+    void orientationAngleChanged(Mir::OrientationAngle value);
+    void sizeChanged(const QSize &value);
+    /// @endcond
+};
+
+} // namespace application
+} // namespace shell
+} // namespace unity
+
+Q_DECLARE_METATYPE(unity::shell::application::MirSurfaceInterface*)
+
+#endif // UNITY_SHELL_APPLICATION_MIRSURFACE_H

=== added file 'include/unity/shell/application/MirSurfaceItemInterface.h'
--- include/unity/shell/application/MirSurfaceItemInterface.h	1970-01-01 00:00:00 +0000
+++ include/unity/shell/application/MirSurfaceItemInterface.h	2015-08-19 14:04:26 +0000
@@ -0,0 +1,151 @@
+/*
+ * Copyright (C) 2015 Canonical, Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef UNITY_SHELL_APPLICATION_MIRSURFACEITEM_H
+#define UNITY_SHELL_APPLICATION_MIRSURFACEITEM_H
+
+#include "Mir.h"
+
+#include <QQuickItem>
+
+namespace unity
+{
+namespace shell
+{
+namespace application
+{
+
+class MirSurfaceInterface;
+
+/**
+   @brief Renders a MirSurface in a QML scene and forwards the input events it receives to it.
+
+   You can have multiple MirSurfaceItems displaying the same MirSurface. But care must
+   be taken that only one of them feeds the MirSurface with input events and also only
+   one resizes it.
+ */
+class MirSurfaceItemInterface : public QQuickItem
+{
+    Q_OBJECT
+
+    /**
+     * @brief The surface to be displayed
+     */
+    Q_PROPERTY(unity::shell::application::MirSurfaceInterface* surface READ surface WRITE setSurface NOTIFY surfaceChanged)
+
+    /**
+     * @brief Type of the given surface or Mir.UnknownType if no surface is set
+     */
+    Q_PROPERTY(Mir::Type type READ type NOTIFY typeChanged)
+
+    /**
+     * @brief State of the given surface or Mir.UnknownState if no surface is set
+     */
+    Q_PROPERTY(Mir::State surfaceState READ surfaceState WRITE setSurfaceState NOTIFY surfaceStateChanged)
+
+    /**
+     * @brief Name of the given surface or an empty string if no surface is set
+     */
+    Q_PROPERTY(QString name READ name CONSTANT)
+
+    /**
+     * @brief True if the item has a surface and that surface has a mir client bound to it.
+     * A "zombie" (live == false) surface never becomes alive again.
+     */
+    Q_PROPERTY(bool live READ live NOTIFY liveChanged)
+
+    /**
+     * @brief  Orientation angle of the given surface
+     *
+     * How many degrees, clockwise, the UI in the surface has to rotate to match shell's UI orientation
+     */
+    Q_PROPERTY(Mir::OrientationAngle orientationAngle READ orientationAngle WRITE setOrientationAngle
+               NOTIFY orientationAngleChanged DESIGNABLE false)
+
+
+    /**
+     * @brief Whether the item will forward activeFocus, touch events, mouse events and key events to its surface.
+     * It's false by default.
+     * Only one item should have this property enabled for a given surface.
+     */
+    Q_PROPERTY(bool consumesInput READ consumesInput
+                                  WRITE setConsumesInput
+                                  NOTIFY consumesInputChanged)
+
+    /**
+     * @brief The desired width for the contained MirSurface.
+     * It's ignored if set to zero or a negative number
+     * The default value is zero
+     */
+    Q_PROPERTY(int surfaceWidth READ surfaceWidth
+                                WRITE setSurfaceWidth
+                                NOTIFY surfaceWidthChanged)
+
+    /**
+     * @brief The desired height for the contained MirSurface.
+     * It's ignored if set to zero or a negative number
+     * The default value is zero
+     */
+    Q_PROPERTY(int surfaceHeight READ surfaceHeight
+                                WRITE setSurfaceHeight
+                                NOTIFY surfaceHeightChanged)
+
+public:
+    /// @cond
+    MirSurfaceItemInterface(QQuickItem *parent = 0) : QQuickItem(parent) {}
+    virtual ~MirSurfaceItemInterface() {}
+
+    virtual Mir::Type type() const = 0;
+    virtual QString name() const = 0;
+    virtual bool live() const = 0;
+
+    virtual Mir::State surfaceState() const = 0;
+    virtual void setSurfaceState(Mir::State) = 0;
+
+    virtual Mir::OrientationAngle orientationAngle() const = 0;
+    virtual void setOrientationAngle(Mir::OrientationAngle angle) = 0;
+
+    virtual MirSurfaceInterface* surface() const = 0;
+    virtual void setSurface(MirSurfaceInterface*) = 0;
+
+    virtual bool consumesInput() const = 0;
+    virtual void setConsumesInput(bool value) = 0;
+
+    virtual int surfaceWidth() const = 0;
+    virtual void setSurfaceWidth(int value) = 0;
+
+    virtual int surfaceHeight() const = 0;
+    virtual void setSurfaceHeight(int value) = 0;
+    /// @endcond
+
+Q_SIGNALS:
+    /// @cond
+    void typeChanged(Mir::Type);
+    void surfaceStateChanged(Mir::State);
+    void liveChanged(bool live);
+    void orientationAngleChanged(Mir::OrientationAngle angle);
+    void surfaceChanged(MirSurfaceInterface*);
+    void consumesInputChanged(bool value);
+    void surfaceWidthChanged(int value);
+    void surfaceHeightChanged(int value);
+    /// @endcond
+};
+
+} // namespace application
+} // namespace shell
+} // namespace unity
+
+#endif // UNITY_SHELL_APPLICATION_MIRSURFACEITEM_H