Merge lp:~dandrader/unity-api/splash into lp:unity-api

[Daniel d'Andrada]

ApplicationInfoInterface: add splash screen data

Goes along with:
https://code.launchpad.net/~dandrader/unity8/real_header_splashscreen/+merge/233286
https://code.launchpad.net/~dandrader/qtmir/parse_splash_from_desktop_file/+merge/233287

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:156
http://jenkins.qa.ubuntu.com/job/unity-api-ci/263/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-amd64-ci/98
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/98
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/98/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-i386-ci/98

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

review: Approve (continuous-integration)

[Gerry Boland (gerboland)]

You should test for the added properties in test/qmltest/unity/shell/application/tst_Application.qml

review: Needs Fixing

[Gerry Boland (gerboland)]

+ * The header will display the splashTitle, if defined, or the application
+ * name otherwise.

The documentation is weak. We offer 2 kinds of splash screens for applications:
1. a splash with a gradient background and image
2. a splash faking a MainView with header text set - so in theory once the app starts up, this splash and the app's first frame are identical.

splashShowHeader is the switch to select between these. Can you pad out the docs with examples of both types?

review: Needs Fixing

[Daniel d'Andrada (dandrader)]

> You should test for the added properties in
> test/qmltest/unity/shell/application/tst_Application.qml

Done.

[Daniel d'Andrada (dandrader)]

> + * The header will display the splashTitle, if defined, or the application
> + * name otherwise.
>
> The documentation is weak. We offer 2 kinds of splash screens for
> applications:
> 1. a splash with a gradient background and image
> 2. a splash faking a MainView with header text set - so in theory once the app
> starts up, this splash and the app's first frame are identical.
>
> splashShowHeader is the switch to select between these. Can you pad out the
> docs with examples of both types?

Documentation improved.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:159
http://jenkins.qa.ubuntu.com/job/unity-api-ci/264/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-amd64-ci/99/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/99/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-i386-ci/99/console

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:160
http://jenkins.qa.ubuntu.com/job/unity-api-ci/265/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-amd64-ci/100/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/100/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-i386-ci/100/console

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:160
http://jenkins.qa.ubuntu.com/job/unity-api-ci/266/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-amd64-ci/101/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/101/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-i386-ci/101/console

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:161
http://jenkins.qa.ubuntu.com/job/unity-api-ci/267/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-amd64-ci/102/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/102/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-i386-ci/102/console

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:162
http://jenkins.qa.ubuntu.com/job/unity-api-ci/268/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-amd64-ci/103
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/103
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/103/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-i386-ci/103

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

review: Approve (continuous-integration)

[Gerry Boland (gerboland)]

LGTM

review: Approve

[Michael Zanetti (mzanetti)]

Need to bump changelog and depends in unity8 or unity8 it won't build in the ppa

review: Needs Fixing

[lp:~dandrader/unity-api/splash]

163. By Daniel d'Andrada on 2014-09-22

Updated changelog

164. By Daniel d'Andrada on 2014-09-22

Merge trunk

[Michael Zanetti (mzanetti)]

ack.

review: Abstain

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:164
http://jenkins.qa.ubuntu.com/job/unity-api-ci/271/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-amd64-ci/106
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/106
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/106/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-i386-ci/106

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

review: Approve (continuous-integration)

=== modified file 'debian/changelog'
--- debian/changelog	2014-09-18 16:42:26 +0000
+++ debian/changelog	2014-09-22 10:27:10 +0000
@@ -1,3 +1,9 @@
+unity-api (7.91) UNRELEASED; urgency=medium
+
+  * Added splash screen data do ApplicationInfoInterface
+
+ -- Daniel d'Andrada <[e-mail]>  Mon, 22 Sep 2014 07:22:26 -0300
+
 unity-api (7.90+14.10.20140918-0ubuntu1) utopic; urgency=medium
 
   [ Michael Zanetti ]

=== modified file 'include/unity/shell/application/ApplicationInfoInterface.h'
--- include/unity/shell/application/ApplicationInfoInterface.h	2014-08-13 18:05:37 +0000
+++ include/unity/shell/application/ApplicationInfoInterface.h	2014-09-22 10:27:10 +0000
@@ -24,6 +24,7 @@
 
 #include <QtCore/QObject>
 #include <QtCore/QUrl>
+#include <QColor>
 
 namespace unity
 {
@@ -97,6 +98,84 @@
      */
     Q_PROPERTY(bool focused READ focused NOTIFY focusedChanged)
 
+    /**
+     * @brief Splash screen title
+     *
+     * @see splashShowHeader
+     * Title of the splash screen, to be displayed on its header.
+     *
+     * A splash screen is shown while the application is loading,
+     * before it has drawn its first frame.
+     */
+    Q_PROPERTY(QString splashTitle READ splashTitle CONSTANT)
+
+    /**
+     * @brief Splash image
+     *
+     * Url of the splash image to be shown while the application is loading,
+     * before it has drawn its first frame.
+     *
+     * The splash image is centered on the splash screen and displayed in
+     * its actual size (ie, it's not stretched or shrinked and aspect ratio
+     * is kept).
+     */
+    Q_PROPERTY(QUrl splashImage READ splashImage CONSTANT)
+
+    /**
+     * @brief Whether an application header should be shown on the splash screen
+     *
+     * We offer 2 kinds of splash screens for applications:
+     * 1. A splash with a gradient background and image
+     * 2. A splash faking a MainView with header text set. So it is possible to
+     *    arrange things so that once the app starts up, this splash and the app's
+     *    first frame are identical.
+     *
+     * This property is the switch to select between these.
+     *
+     * The header will display the splashTitle, if defined, or the application
+     * name otherwise.
+     *
+     * @see name, splashTitle
+     */
+    Q_PROPERTY(bool splashShowHeader READ splashShowHeader CONSTANT)
+
+    /**
+     * @brief Background color of the splash screen
+     *
+     * Any color that is not fully opaque (having an alpha value of less than
+     * 1.0) is ignored and the default background color will be used instead.
+     *
+     * A splash screen is shown while the application is loading,
+     * before it has drawn its first frame.
+     */
+    Q_PROPERTY(QColor splashColor READ splashColor CONSTANT)
+
+    /**
+     * @brief Color of the splash screen header
+     *
+     * Any color that is not fully opaque (having an alpha value of less than
+     * 1.0) is ignored and the splashColor will be used instead.
+     *
+     * A splash screen is shown while the application is loading,
+     * before it has drawn its first frame.
+     *
+     * @see splashColor
+     */
+    Q_PROPERTY(QColor splashColorHeader READ splashColorHeader CONSTANT)
+
+    /**
+     * @brief Color of the splash screen footer
+     *
+     * Any color that is not fully opaque (having an alpha value of less than
+     * 1.0) is ignored and the splashColor will be used instead.
+     *
+     * A splash screen is shown while the application is loading,
+     * before it has drawn its first frame.
+     *
+     * @see splashColor
+     */
+    Q_PROPERTY(QColor splashColorFooter READ splashColorFooter CONSTANT)
+
 protected:
     /// @cond
     ApplicationInfoInterface(const QString &appId, QObject* parent = 0): QObject(parent) { Q_UNUSED(appId) }
@@ -145,6 +224,12 @@
     virtual Stage stage() const = 0;
     virtual State state() const = 0;
     virtual bool focused() const = 0;
+    virtual QString splashTitle() const = 0;
+    virtual QUrl splashImage() const = 0;
+    virtual bool splashShowHeader() const = 0;
+    virtual QColor splashColor() const = 0;
+    virtual QColor splashColorHeader() const = 0;
+    virtual QColor splashColorFooter() const = 0;
     /// @endcond
 
 Q_SIGNALS:

=== modified file 'include/unity/shell/application/CMakeLists.txt'
--- include/unity/shell/application/CMakeLists.txt	2014-08-11 13:39:14 +0000
+++ include/unity/shell/application/CMakeLists.txt	2014-09-22 10:27:10 +0000
@@ -7,7 +7,7 @@
 
 set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE)
 
-set(VERSION 3)
+set(VERSION 4)
 set(PKGCONFIG_NAME "unity-shell-application")
 set(PKGCONFIG_DESCRIPTION "Unity shell Application APIs")
 set(PKGCONFIG_REQUIRES "Qt5Core")

=== modified file 'test/qmltest/mocks/plugins/Unity/Application/CMakeLists.txt'
--- test/qmltest/mocks/plugins/Unity/Application/CMakeLists.txt	2013-08-29 12:54:56 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/CMakeLists.txt	2014-09-22 10:27:10 +0000
@@ -7,6 +7,7 @@
 set(CMAKE_AUTOMOC ON)
 
 find_package(Qt5Core REQUIRED)
+find_package(Qt5Gui REQUIRED)
 find_package(Qt5Quick REQUIRED)
 find_package(Qt5Qml REQUIRED)
 
@@ -19,7 +20,7 @@
 
 add_library(ApplicationMocks SHARED ${ApplicationMocks_SOURCES})
 
-qt5_use_modules(ApplicationMocks Core)
+qt5_use_modules(ApplicationMocks Core Gui)
 
 set(TestApplicationPlugin_SOURCES
     TestApplicationPlugin.cpp
@@ -27,7 +28,7 @@
 
 add_library(TestApplicationPlugin MODULE ${TestApplicationPlugin_SOURCES})
 
-qt5_use_modules(TestApplicationPlugin Core Quick)
+qt5_use_modules(TestApplicationPlugin Core Gui Quick)
 
 target_link_libraries(TestApplicationPlugin ApplicationMocks)
 

=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp	2014-08-13 18:05:37 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp	2014-09-22 10:27:10 +0000
@@ -95,3 +95,33 @@
         Q_EMIT focusedChanged(focused);
     }
 }
+
+QString MockApplicationInfo::splashTitle() const
+{
+    return "Foo Bar";
+}
+
+QUrl MockApplicationInfo::splashImage() const
+{
+    return QUrl();
+}
+
+bool MockApplicationInfo::splashShowHeader() const
+{
+    return true;
+}
+
+QColor MockApplicationInfo::splashColor() const
+{
+    return QColor(0,0,0,0);
+}
+
+QColor MockApplicationInfo::splashColorHeader() const
+{
+    return QColor(0,0,0,0);
+}
+
+QColor MockApplicationInfo::splashColorFooter() const
+{
+    return QColor(0,0,0,0);
+}

=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h	2014-08-13 18:05:37 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h	2014-09-22 10:27:10 +0000
@@ -46,6 +46,13 @@
     bool focused() const;
     void setFocused(bool focused);
 
+    QString splashTitle() const override;
+    QUrl splashImage() const override;
+    bool splashShowHeader() const override;
+    QColor splashColor() const override;
+    QColor splashColorHeader() const override;
+    QColor splashColorFooter() const override;
+
 private:
     QString m_appId;
     QString m_name;

=== modified file 'test/qmltest/mocks/plugins/Unity/Launcher/CMakeLists.txt'
--- test/qmltest/mocks/plugins/Unity/Launcher/CMakeLists.txt	2013-09-11 15:28:22 +0000
+++ test/qmltest/mocks/plugins/Unity/Launcher/CMakeLists.txt	2014-09-22 10:27:10 +0000
@@ -27,7 +27,7 @@
 
 add_library(LauncherMocks SHARED ${LauncherMocks_SOURCES})
 
-qt5_use_modules(LauncherMocks Core)
+qt5_use_modules(LauncherMocks Core Gui)
 
 set(TestLauncherPlugin_SOURCES
     TestLauncherPlugin.cpp

=== modified file 'test/qmltest/modules/TestUtil/CMakeLists.txt'
--- test/qmltest/modules/TestUtil/CMakeLists.txt	2013-05-16 06:36:37 +0000
+++ test/qmltest/modules/TestUtil/CMakeLists.txt	2014-09-22 10:27:10 +0000
@@ -18,12 +18,12 @@
 qt5_use_modules(TestUtilQml Core Quick)
 
 # copy qmldir file into build directory for shadow builds
-file(GLOB QML_JS_FILES *.js *.qml)
-
-file(COPY qmldir ${QML_JS_FILES}
-    DESTINATION ${CMAKE_CURRENT_BINARY_DIR}
-    )
-
+file(GLOB QML_JS_FILES qmldir *.js *.qml)
+add_custom_target(TestUtil-qmlfiles ALL
+                    COMMAND cp ${QML_JS_FILES} ${CMAKE_CURRENT_BINARY_DIR}
+                    DEPENDS ${QML_JS_FILES}
+                    SOURCES ${QML_JS_FILES}
+)
 
 # tests
 include(QmlTest)

=== modified file 'test/qmltest/modules/TestUtil/TestUtil.cpp'
--- test/qmltest/modules/TestUtil/TestUtil.cpp	2013-06-26 23:47:34 +0000
+++ test/qmltest/modules/TestUtil/TestUtil.cpp	2014-09-22 10:27:10 +0000
@@ -17,6 +17,8 @@
 
 #include <TestUtil.h>
 
+#include <QQmlProperty>
+
 TestUtil::TestUtil(QObject *parent)
     : QObject(parent)
 {
@@ -44,3 +46,16 @@
     }
     return result;
 }
+
+bool TestUtil::objectHasPropertyOfType(QObject *qmlObject, const QString &propertyName,
+                                       const QString &expectedPropertyTypeName)
+{
+    if (!qmlObject) return false;
+
+    QQmlProperty property(qmlObject, propertyName);
+
+    if (!property.isValid()) return false;
+    if (!property.isProperty()) return false;
+    return QString(property.propertyTypeName()) == expectedPropertyTypeName;
+
+}

=== modified file 'test/qmltest/modules/TestUtil/TestUtil.h'
--- test/qmltest/modules/TestUtil/TestUtil.h	2013-06-26 23:47:34 +0000
+++ test/qmltest/modules/TestUtil/TestUtil.h	2014-09-22 10:27:10 +0000
@@ -30,6 +30,10 @@
     ~TestUtil();
 
     Q_INVOKABLE bool isInstanceOf(QObject*, QString);
+
+    Q_INVOKABLE bool objectHasPropertyOfType(QObject *qmlObject,
+                                             const QString &propertyName,
+                                             const QString &propertyTypeName);
 };
 
 QML_DECLARE_TYPE(TestUtil)

=== modified file 'test/qmltest/modules/TestUtil/Verifier.qml'
--- test/qmltest/modules/TestUtil/Verifier.qml	2013-06-04 14:50:08 +0000
+++ test/qmltest/modules/TestUtil/Verifier.qml	2014-09-22 10:27:10 +0000
@@ -78,7 +78,17 @@
             fail(msg);
         }
 
-        verifyType(object[member], type, msg);
+        if (type === "url") {
+            if (!Util.objectHasPropertyOfType(object, member, "QUrl")) {
+                fail(msg);
+            }
+        } else if (type === "color") {
+            if (!Util.objectHasPropertyOfType(object, member, "QColor")) {
+                fail(msg);
+            }
+        } else {
+            verifyType(object[member], type, msg);
+        }
     }
 
     /* verify that the object is registered */

=== modified file 'test/qmltest/unity/shell/application/tst_Application.qml'
--- test/qmltest/unity/shell/application/tst_Application.qml	2014-08-18 12:41:43 +0000
+++ test/qmltest/unity/shell/application/tst_Application.qml	2014-09-22 10:27:10 +0000
@@ -143,6 +143,12 @@
                 { tag: "ApplicationInfo.properties[stage]", property: "stage", type: "number" },
                 { tag: "ApplicationInfo.properties[state]", property: "state", type: "number" },
                 { tag: "ApplicationInfo.properties[focused]", property: "focused", type: "boolean" },
+                { tag: "ApplicationInfo.properties[splashTitle]", constant: "splashTitle", type: "string" },
+                { tag: "ApplicationInfo.properties[splashImage]", constant: "splashImage", type: "url" },
+                { tag: "ApplicationInfo.properties[splashShowHeader]", constant: "splashShowHeader", type: "boolean"},
+                { tag: "ApplicationInfo.properties[splashColor]", constant: "splashColor", type: "color"},
+                { tag: "ApplicationInfo.properties[splashColorHeader]", constant: "splashColorHeader", type: "color"},
+                { tag: "ApplicationInfo.properties[splashColorFooter]", constant: "splashColorFooter", type: "color"},
             ];
         }