Merge lp:~lukas-kde/unity-api/liveCaption into lp:unity-api

[Lukáš Tinkl]

Notify about surface name changes

Notify about surface name changes, bump api version

Cf: https://bugs.launchpad.net/ubuntu/+source/unity-api/+bug/1497092

* Are there any related MPs required for this MP to build/function as expected? Please list.

No

* Did you perform an exploratory manual test run of your code change and any related functionality?

Yes

* Did you make sure that your branch does not contain spurious tags?

Yes

* If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?

Yes

* If you changed the UI, has there been a design review?

N/A

[lp:~lukas-kde/unity-api/liveCaption]

190. By Lukáš Tinkl on 2015-09-29

rebase on top of lp:~dandrader/unity-api/mousePointer

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:189
http://jenkins.qa.ubuntu.com/job/unity-api-ci/341/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-amd64-ci/29
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/30
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/30/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-i386-ci/29
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-amd64-ci/40
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/40
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/40/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-i386-ci/40

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-api-ci/341/rebuild

review: Approve (continuous-integration)

Unmerged revisions

=== modified file 'debian/changelog'
--- debian/changelog	2015-09-15 09:15:11 +0000
+++ debian/changelog	2015-09-29 14:28:01 +0000
@@ -1,3 +1,11 @@
+unity-api (7.101) UNRELEASED; urgency=medium
+
+  * unity/shell/application: Add Mir.cursorName
+  * unity/shell/application: Added MirMousePointerInterface.h
+  * unity/shell/application: Added MirPlatformCursor.h
+
+ -- Daniel d'Andrada <[e-mail]>  Tue, 01 Sep 2015 13:38:11 -0300
+
 unity-api (7.100+15.10.20150903-0ubuntu1) wily; urgency=medium
 
   [ Michal Sawicz ]

=== modified file 'include/unity/shell/application/CMakeLists.txt'
--- include/unity/shell/application/CMakeLists.txt	2015-08-19 13:18:09 +0000
+++ include/unity/shell/application/CMakeLists.txt	2015-09-29 14:28:01 +0000
@@ -7,7 +7,7 @@
 
 set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE)
 
-set(VERSION 8)
+set(VERSION 9)
 set(PKGCONFIG_NAME "unity-shell-application")
 set(PKGCONFIG_DESCRIPTION "Unity shell Application APIs")
 set(PKGCONFIG_REQUIRES "Qt5Core")

=== modified file 'include/unity/shell/application/Mir.h'
--- include/unity/shell/application/Mir.h	2015-08-19 13:18:09 +0000
+++ include/unity/shell/application/Mir.h	2015-09-29 14:28:01 +0000
@@ -20,15 +20,22 @@
 #include <QObject>
 
 /**
-    @brief Acting as a namespace to hold enums and such for use in QML
+    @brief Acting mostly as a namespace to hold enums and such for use in QML
  */
-class Mir
+class Mir : public QObject
 {
-    Q_GADGET
+    Q_OBJECT
     Q_ENUMS(Type)
     Q_ENUMS(State)
     Q_ENUMS(OrientationAngle)
 
+    /**
+        @brief Name of the mouse cursor to be used. Follows the X Cursor naming convention.
+
+        Eg.: "left_ptr" is a left-sided pointer arrow
+     */
+    Q_PROPERTY(QString cursorName READ cursorName WRITE setCursorName NOTIFY cursorNameChanged)
+
 public:
     /**
         @brief Surface type
@@ -69,6 +76,16 @@
         Angle180 = 180,
         Angle270 = 270
     };
+
+    /// @cond
+    virtual void setCursorName(const QString &cursorName) = 0;
+    virtual QString cursorName() const = 0;
+    /// @endcond
+
+Q_SIGNALS:
+    /// @cond
+    void cursorNameChanged(const QString &cursorName);
+    /// @endcond
 };
 
 Q_DECLARE_METATYPE(Mir::OrientationAngle)

=== added file 'include/unity/shell/application/MirMousePointerInterface.h'
--- include/unity/shell/application/MirMousePointerInterface.h	1970-01-01 00:00:00 +0000
+++ include/unity/shell/application/MirMousePointerInterface.h	2015-09-29 14:28:01 +0000
@@ -0,0 +1,99 @@
+/*
+ * Copyright (C) 2015 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License version 3, as published by
+ * the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+ * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef MIR_MOUSE_POINTER_INTERFACE_H
+#define MIR_MOUSE_POINTER_INTERFACE_H
+
+#include <QQuickItem>
+
+/**
+ * @brief The QML mouse pointer
+ *
+ * FIXME: Get this out of unity-api
+ *
+ * This QML item drives the position of the Mir mouse pointer on the scene
+ */
+class MirMousePointerInterface : public QQuickItem {
+    Q_OBJECT
+
+    /**
+     * @brief Name of the cursor
+     * Defines the look of the mouse pointer along with themeName
+     */
+    Q_PROPERTY(QString cursorName READ cursorName NOTIFY cursorNameChanged)
+
+    /**
+     * @brief Name of the cursor theme
+     * Defines the look of the mouse pointer along with cursorName
+     * Its default value is "default".
+     */
+    Q_PROPERTY(QString themeName READ themeName NOTIFY themeNameChanged)
+
+    /**
+     * @brief X coordinate of the cursor hotspot
+     * Is value depends on the current cursor name and theme
+     */
+    Q_PROPERTY(qreal hotspotX READ hotspotX NOTIFY hotspotXChanged)
+
+    /**
+     * @brief Y coordinate of the cursor hotspot
+     * Is value depends on the current cursor name and theme
+     */
+    Q_PROPERTY(qreal hotspotY READ hotspotY NOTIFY hotspotYChanged)
+public:
+    /**
+     * @brief The constructor
+     */
+    MirMousePointerInterface(QQuickItem *parent = nullptr) : QQuickItem(parent) {}
+
+    /// @cond
+    virtual void setCursorName(const QString &cursorName) = 0;
+    virtual QString cursorName() const = 0;
+
+    virtual void setThemeName(const QString &themeName) = 0;
+    virtual QString themeName() const = 0;
+
+    virtual qreal hotspotX() const = 0;
+    virtual qreal hotspotY() const = 0;
+    /// @endcond
+
+Q_SIGNALS:
+    /// @cond
+    void cursorNameChanged(QString name);
+    void themeNameChanged(QString name);
+    void hotspotXChanged(qreal value);
+    void hotspotYChanged(qreal value);
+    /// @endcond
+
+public Q_SLOTS:
+    /**
+     * @brief Handler for Mir mouse events
+     * The implementation should respond to Mir mouse events by moving itself along its parent
+     * area.
+     * This is called by Mir's platform cursor.
+     *
+     * Note that we get only relative mouse movement, since the mouse pointer position is defined
+     * by this very item. Ie., it's up to this class to decide whether or not it (the mouse pointer)
+     * should move (and how much) due to movement in a mouse device.
+     *
+     * @param movement Movement vector
+     */
+    virtual void handleMouseEvent(ulong timestamp, QPointF movement, Qt::MouseButton buttons,
+            Qt::KeyboardModifiers modifiers) = 0;
+
+};
+
+#endif // MIR_MOUSE_POINTER_INTERFACE_H

=== added file 'include/unity/shell/application/MirPlatformCursor.h'
--- include/unity/shell/application/MirPlatformCursor.h	1970-01-01 00:00:00 +0000
+++ include/unity/shell/application/MirPlatformCursor.h	2015-09-29 14:28:01 +0000
@@ -0,0 +1,38 @@
+/*
+ * 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 MIR_PLATFORM_CURSOR_H
+#define MIR_PLATFORM_CURSOR_H
+
+#include <qpa/qplatformcursor.h>
+
+class MirMousePointerInterface;
+
+/**
+ * @brief Cursor interface for Mir platform
+ *
+ * FIXME: Get this out of unity-api
+ */
+class MirPlatformCursor : public QPlatformCursor
+{
+public:
+    /**
+     * @brief Set the QML mouse pointer that this platform cursor will talk to
+     */
+    virtual void setMousePointer(MirMousePointerInterface *mousePointer) = 0;
+};
+
+#endif // MIR_PLATFORM_CURSOR_H

=== modified file 'include/unity/shell/application/MirSurfaceInterface.h'
--- include/unity/shell/application/MirSurfaceInterface.h	2015-08-19 13:18:09 +0000
+++ include/unity/shell/application/MirSurfaceInterface.h	2015-09-29 14:28:01 +0000
@@ -47,7 +47,7 @@
     /**
      * @brief Name of the surface, given by the client application
      */
-    Q_PROPERTY(QString name READ name CONSTANT)
+    Q_PROPERTY(QString name READ name NOTIFY nameChanged)
 
     /**
      * @brief Size of the current surface buffer, in pixels.
@@ -102,6 +102,7 @@
     void stateChanged(Mir::State value);
     void orientationAngleChanged(Mir::OrientationAngle value);
     void sizeChanged(const QSize &value);
+    void nameChanged(const QString &name);
     /// @endcond
 };
 

=== modified file 'include/unity/shell/application/MirSurfaceItemInterface.h'
--- include/unity/shell/application/MirSurfaceItemInterface.h	2015-08-19 13:18:09 +0000
+++ include/unity/shell/application/MirSurfaceItemInterface.h	2015-09-29 14:28:01 +0000
@@ -59,7 +59,7 @@
     /**
      * @brief Name of the given surface or an empty string if no surface is set
      */
-    Q_PROPERTY(QString name READ name CONSTANT)
+    Q_PROPERTY(QString name READ name NOTIFY nameChanged)
 
     /**
      * @brief True if the item has a surface and that surface has a mir client bound to it.
@@ -141,6 +141,7 @@
     void consumesInputChanged(bool value);
     void surfaceWidthChanged(int value);
     void surfaceHeightChanged(int value);
+    void nameChanged(const QString &name);
     /// @endcond
 };