Merge lp:~macslow/unity-api/set-progress-api into lp:unity-api

[Mirco Müller]

Added setProgress-API to LauncherModelInterface to allow applications to change the progress-overlay-bar of a launcher-icon/item.

Added setProgress-API to LauncherModelInterface to allow applications to change the progress-overlay-bar of a launcher-icon/item.

Set lp:~macslow/unity-api/launcher-icon-wobble as prerequisite, thus the API additions spread across this branch and "launcher-icon-wobble" merge in order and there are no API-version-related dependency problems as we move along.

This is is a prerequisite for lp:~macslow/unity8/use-set-progress-api.

[Lukáš Tinkl (lukas-kde)]

* 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?

N/A

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

N/A

* Did you have a look at the warnings when running tests? Can they be reduced?

Yes

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:175
http://jenkins.qa.ubuntu.com/job/unity-api-ci/306/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-amd64-ci/5
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/5
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/5/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-i386-ci/5

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:176
http://jenkins.qa.ubuntu.com/job/unity-api-ci/310/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-amd64-ci/9
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/9
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/9/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-i386-ci/9

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:177
http://jenkins.qa.ubuntu.com/job/unity-api-ci/311/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-amd64-ci/10
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/10
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/10/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-i386-ci/10

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

review: Approve (continuous-integration)

[Michael Zanetti (mzanetti)]

Hmm... I don't think we need this change, do we? The Progress is supposed to be set from D-Bus only.

review: Needs Information

[Mirco Müller (macslow)]

I assumed it had to have a hook in unity-api too.

[Mirco Müller (macslow)]

Set "Rejected" for now, since we do not really need to expose it via the Unity-API. It will only be needed via DBus.

Unmerged revisions

177. By Mirco Müller on 2015-06-23

Bumped PkgConfig again to not collide with another API-change pending in another branch.

176. By Mirco Müller on 2015-06-23

Bumped ChangeLog and PkgConfig.

175. By Mirco Müller on 2015-06-19

Added LauncherModel::setProgress() API and related test.

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-03-10 09:48:43 +0000
+++ CMakeLists.txt	2015-06-23 14:58:45 +0000
@@ -131,7 +131,7 @@
 # API version
 set(UNITY_API_MAJOR 0)
 set(UNITY_API_MINOR 1)
-set(UNITY_API_MICRO 4)
+set(UNITY_API_MICRO 6)
 set(UNITY_API_VERSION "${UNITY_API_MAJOR}.${UNITY_API_MINOR}.${UNITY_API_MICRO}")
 
 # API library

=== modified file 'debian/changelog'
--- debian/changelog	2015-06-11 09:11:57 +0000
+++ debian/changelog	2015-06-23 14:58:45 +0000
@@ -1,3 +1,9 @@
+unity-api (7.98+15.10.20150611-0ubuntu2) UNRELEASED; urgency=medium
+
+  * added setProgress API to LauncherModel interface
+
+ -- Mirco Müller (MacSlow) <[e-mail]>  Tue, 23 Jun 2015 15:55:37 +0200
+
 unity-api (7.97+15.10.20150611-0ubuntu1) wily; urgency=medium
 
   [ Daniel d'Andrada ]

=== modified file 'include/unity/shell/launcher/CMakeLists.txt'
--- include/unity/shell/launcher/CMakeLists.txt	2015-02-11 13:41:19 +0000
+++ include/unity/shell/launcher/CMakeLists.txt	2015-06-23 14:58:45 +0000
@@ -7,7 +7,7 @@
 
 set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE)
 
-set(VERSION 6)
+set(VERSION 8)
 set(PKGCONFIG_NAME "unity-shell-launcher")
 set(PKGCONFIG_DESCRIPTION "Unity shell Launcher APIs")
 set(PKGCONFIG_REQUIRES "Qt5Core")

=== modified file 'include/unity/shell/launcher/LauncherModelInterface.h'
--- include/unity/shell/launcher/LauncherModelInterface.h	2015-02-09 17:17:08 +0000
+++ include/unity/shell/launcher/LauncherModelInterface.h	2015-06-23 14:58:45 +0000
@@ -138,6 +138,19 @@
      */
     Q_INVOKABLE virtual void requestRemove(const QString &appId) = 0;
 
+    /**
+     * @brief Pass a progress-value to an item of the model.
+     *
+     * A progress-value >= 0 will result in a progress-bar-like element to be displayed
+     * for an item to inform the user of a time-consuming operation going on (e.g. a
+     * lengthy calculation or a i/o-heavy task).
+     *
+     * Note: A progress-value <= -1 is interpreted as no value set.
+     *
+     * @param appId The appId of the item to set the progress-value for.
+     * @param progress The progress-value itself.
+     */
+    Q_INVOKABLE virtual void setProgress(const QString &appId, int progress) = 0;
 
     /**
       * @brief Trigger an action from the QuickList

=== modified file 'test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherModel.cpp'
--- test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherModel.cpp	2015-02-09 17:17:08 +0000
+++ test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherModel.cpp	2015-06-23 14:58:45 +0000
@@ -125,6 +125,12 @@
     Q_UNUSED(actionIndex)
 }
 
+void MockLauncherModel::setProgress(const QString &appId, int progress)
+{
+    Q_UNUSED(appId)
+    Q_UNUSED(progress)
+}
+
 void MockLauncherModel::setUser(const QString &user)
 {
     Q_UNUSED(user)

=== modified file 'test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherModel.h'
--- test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherModel.h	2015-02-09 17:17:08 +0000
+++ test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherModel.h	2015-06-23 14:58:45 +0000
@@ -44,6 +44,7 @@
     Q_INVOKABLE void pin(const QString &appId, int index = -1);
     Q_INVOKABLE void requestRemove(const QString &appId);
     Q_INVOKABLE void quickListActionInvoked(const QString &appId, int actionIndex);
+    Q_INVOKABLE void setProgress(const QString &appId, int progress);
     Q_INVOKABLE void setUser(const QString &user);
 
     unity::shell::application::ApplicationManagerInterface *applicationManager() const;

=== modified file 'test/qmltest/unity/shell/launcher/tst_Launcher.qml'
--- test/qmltest/unity/shell/launcher/tst_Launcher.qml	2015-02-09 17:17:08 +0000
+++ test/qmltest/unity/shell/launcher/tst_Launcher.qml	2015-06-23 14:58:45 +0000
@@ -108,6 +108,7 @@
                 { tag: "Model.methods[pin]", method: "pin" },
                 { tag: "Model.methods[requestRemove]", method: "requestRemove" },
                 { tag: "Model.methods[quickListActionInvoked]", method: "quickListActionInvoked" },
+                { tag: "Model.methods[setProgress]", method: "setProgress" },
                 { tag: "Model.methods[setUser]", method: "setUser" },
             ];
         }