Merge lp:~verzegnassi-stefano/ubuntu-docviewer-app/add-empty-state into lp:ubuntu-docviewer-app/trunk

[Stefano Verzegnassi]

Added Empty State in Welcome screen

- An Empty State item is shown when DocViewer is loaded with no specified document.
ContentHub source picker has been moved in a different page.

- Removed Ubuntu.Components Arguments[1] from ubuntu-docviewer-app.qml. The current release of the app uses two argument parsers, which is not an ideal scenario. This MP solves this issue.

- In the current release, when an user runs ubuntu-docviewer-app with no arguments, a warning is shown in CMD. That's because we use "defaultArgument" property of QML Arguments.
For some reason, the application works anyway, but it looks more a workaround based on an issue in UITK (music-app has a similar issue[2]).

- Removed "tablet" and "phone" arguments from main.cpp.
They came from reminders-app, but we don't use it.

- Removed "QML import directory" argument.

NOTES:
- EmptyState.qml comes from ubuntu-clock-app
- The code included in ContentHubPicker.qml is the code removed from WelcomePage.qml

[1]: http://developer.ubuntu.com/api/qml/sdk-14.10/Ubuntu.Components.Arguments/
[2] line 125-126: http://bazaar.launchpad.net/~music-app-dev/music-app/remix/view/head:/music-app.qml

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

PASSED: Continuous integration, rev:49
http://91.189.93.70:8080/job/ubuntu-docviewer-app-ci/112/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-vivid/704
        deb: http://91.189.93.70:8080/job/generic-mediumtests-vivid/704/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-docviewer-app-vivid-amd64-ci/15

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-docviewer-app-ci/112/rebuild

review: Approve (continuous-integration)

[Nekhelesh Ramananthan (nik90)]

Thanks for the MP. IMHO, I would recommend that a MP fixes/adds only one thing to make it easier to spot regressions if any. In this MP I notice the arguments being changed and empty state. I have reviewed the empty state code and it looks and works as expected.

I haven't reviewed the arguments code since I am not too familiar with it and am actually looking for a implementation that I can copy to the clock app as well. So I would recommend you find another person to review that part of this MP or move that to a separate MP in itself.

review: Approve (empty state code)

[Stefano Verzegnassi (verzegnassi-stefano)]

Ok, thank you again!
The issue was that I wasn't able to add the Empty State code if I hadn't changed the arguments code. For some strange reason, adding an image on the Page used to make the application instable...

[Andrew Hayzen (ahayzen)]

The args code looks OK and I've tested it locally on my machine to ensure that passing an arg loads that document.

review: Approve (argument code)

=== modified file 'src/app/main.cpp'
--- src/app/main.cpp	2014-10-31 16:25:17 +0000
+++ src/app/main.cpp	2015-01-16 17:05:43 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright: 2013 - 2014 Canonical, Ltd
+ * Copyright: 2013 - 2015 Canonical, Ltd
  *
  * This file is part of docviewer
  *
@@ -19,6 +19,7 @@
  * Authors: Michael Zanetti <[e-mail]>
  *          Riccardo Padovani <[e-mail]>
  *          David Planella <[e-mail]>
+ *          Stefano Verzegnassi <[e-mail]>
  */
 
 #include <QtGui/QGuiApplication>
@@ -44,24 +45,20 @@
 
     QStringList args = a.arguments();
     if (args.contains("-h") || args.contains("--help")) {
-        qDebug() << "usage: " + args.at(0) + " [-p|--phone] [-t|--tablet] [-h|--help] [-I <path>]";
-        qDebug() << "    -p|--phone    If running on Desktop, start in a phone sized window.";
-        qDebug() << "    -t|--tablet   If running on Desktop, start in a tablet sized window.";
+        qDebug() << "usage: " + args.at(0) + " [-h|--help] <path>";
         qDebug() << "    -h|--help     Print this help.";
-        qDebug() << "    -I <path>     Give a path for an additional QML import directory. May be used multiple times.";
+        qDebug() << "    <path>        Path of the document to load.";
         return 0;
     }
 
-    for (int i = 0; i < args.count(); i++) {
-        if (args.at(i) == "-I" && args.count() > i + 1) {
-            QString addedPath = args.at(i+1);
-            if (addedPath.startsWith('.')) {
-                addedPath = addedPath.right(addedPath.length() - 1);
-                addedPath.prepend(QDir::currentPath());
-            }
-            importPathList.append(addedPath);
+    // Check if the path of the document has been specified.
+    QString docPath;
+    for (int i = 1; i < args.count(); i++) {
+        if (args.at(i) != "-h" && args.at(i) != "--h") {
+            docPath = args.at(i);
         }
     }
+    view.engine()->rootContext()->setContextProperty("documentPath", docPath);
 
     if (args.contains(QLatin1String("-testability")) || getenv("QT_LOAD_TESTABILITY")) {
         QLibrary testLib(QLatin1String("qttestability"));
@@ -78,19 +75,6 @@
         }
     }
 
-    view.engine()->rootContext()->setContextProperty("tablet", QVariant(false));
-    view.engine()->rootContext()->setContextProperty("phone", QVariant(false));
-    if (args.contains("-t") || args.contains("--tablet")) {
-        qDebug() << "running in tablet mode";
-        view.engine()->rootContext()->setContextProperty("tablet", QVariant(true));
-    } else if (args.contains("-p") || args.contains("--phone")){
-        qDebug() << "running in phone mode";
-        view.engine()->rootContext()->setContextProperty("phone", QVariant(true));
-    } else if (qgetenv("QT_QPA_PLATFORM") != "ubuntumirclient") {
-        // Default to tablet size on X11
-        view.engine()->rootContext()->setContextProperty("tablet", QVariant(true));
-    }
-
     view.engine()->setImportPathList(importPathList);
 
     QString qmlfile;

=== added file 'src/app/qml/ContentHubPicker.qml'
--- src/app/qml/ContentHubPicker.qml	1970-01-01 00:00:00 +0000
+++ src/app/qml/ContentHubPicker.qml	2015-01-16 17:05:43 +0000
@@ -0,0 +1,55 @@
+import QtQuick 2.0
+import Ubuntu.Components 1.1
+import Ubuntu.Content 1.1
+
+Page {
+    id: picker
+    title: i18n.tr("Open with...")
+
+    property var activeTransfer
+
+    head.sections.model: [i18n.tr("Documents"), i18n.tr("Pictures"), i18n.tr("Other")]
+    head.backAction: Action {
+        iconName: "back"
+        text: i18n.tr("Back")
+        onTriggered: pageStack.pop()
+    }
+
+    ContentPeerPicker {
+        // Do not show ContentPeerPicker header, since we need head.sections.
+        showTitle: false
+
+        contentType: {
+            switch (picker.head.sections.selectedIndex) {
+            case 0:
+                return ContentType.Documents
+            case 1:
+                return ContentType.Pictures
+            case 2:
+                return ContentType.Unknown
+            }
+        }
+        handler: ContentHandler.Source
+
+        onPeerSelected: picker.activeTransfer = peer.request();
+    }
+
+    ContentTransferHint {
+        id: transferHint
+        anchors.fill: parent
+        activeTransfer: picker.activeTransfer
+    }
+
+    Connections {
+        target: picker.activeTransfer ? picker.activeTransfer : null
+        onStateChanged: {
+            if (picker.activeTransfer.state === ContentTransfer.Charged) {
+                // Close ContentHubPicker page.
+                pageStack.pop();
+
+                file.path = picker.activeTransfer.items[0].url.toString().replace("file://", "")
+                console.log("[CONTENT-HUB] Content imported!")
+            }
+        }
+    }
+}

=== added file 'src/app/qml/EmptyState.qml'
--- src/app/qml/EmptyState.qml	1970-01-01 00:00:00 +0000
+++ src/app/qml/EmptyState.qml	2015-01-16 17:05:43 +0000
@@ -0,0 +1,59 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This file is part of Ubuntu Clock App
+ *
+ * Ubuntu Clock App is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * Ubuntu Clock App 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/>.
+ */
+
+import QtQuick 2.3
+import Ubuntu.Components 1.1
+
+/*
+ Component which displays an empty state (approved by design). It offers an
+ icon, title and subtitle to describe the empty state.
+*/
+
+Item {
+    id: emptyState
+
+    // Public APIs
+    property alias iconName: emptyIcon.name
+    property alias title: emptyLabel.text
+    property alias subTitle: emptySublabel.text
+
+    height: childrenRect.height
+
+    Icon {
+        id: emptyIcon
+        anchors.horizontalCenter: parent.horizontalCenter
+        height: units.gu(10)
+        width: height
+        color: "#BBBBBB"
+    }
+
+    Label {
+        id: emptyLabel
+        anchors.top: emptyIcon.bottom
+        anchors.topMargin: units.gu(5)
+        anchors.horizontalCenter: parent.horizontalCenter
+        fontSize: "large"
+        font.bold: true
+    }
+
+    Label {
+        id: emptySublabel
+        anchors.top: emptyLabel.bottom
+        anchors.horizontalCenter: parent.horizontalCenter
+    }
+}

=== modified file 'src/app/qml/WelcomePage.qml'
--- src/app/qml/WelcomePage.qml	2014-11-08 08:02:44 +0000
+++ src/app/qml/WelcomePage.qml	2015-01-16 17:05:43 +0000
@@ -1,51 +1,26 @@
 import QtQuick 2.0
 import Ubuntu.Components 1.1
-import Ubuntu.Content 1.1
 
 Page {
-    id: picker
-
-    property var activeTransfer
-
-    ContentTransferHint {
-        id: transferHint
-        anchors.fill: parent
-        activeTransfer: picker.activeTransfer
-    }
-
-    title: i18n.tr("Open with...")
-    head.sections.model: [i18n.tr("Documents"), i18n.tr("Pictures"), i18n.tr("Other")]
-    head.backAction: Action {
-        iconName: "close"
-        text: i18n.tr("Close")
-        onTriggered: Qt.quit()
-    }
-
-    ContentPeerPicker {
-        showTitle: false
-
-        contentType: {
-            switch (picker.head.sections.selectedIndex) {
-            case 0:
-                return ContentType.Documents
-            case 1:
-                return ContentType.Pictures
-            case 2:
-                return ContentType.Unknown
-            }
-        }
-        handler: ContentHandler.Source
-
-        onPeerSelected: picker.activeTransfer = peer.request();
-    }
-
-    Connections {
-        target: picker.activeTransfer ? picker.activeTransfer : null
-        onStateChanged: {
-            if (picker.activeTransfer.state === ContentTransfer.Charged) {
-                file.path = picker.activeTransfer.items[0].url.toString().replace("file://", "")
-                console.log("[CONTENT-HUB] Content imported!")
-            }
-        }
+    id: welcomePage
+
+    title: i18n.tr("Document Viewer")
+    head.actions: [ openAction ]
+
+    EmptyState {
+        title: i18n.tr("No opened documents")
+        subTitle: i18n.tr("Tap the + icon to open a document")
+
+        iconName: "edit-copy"
+
+        anchors.centerIn: parent
+    }
+
+    Action {
+        id: openAction
+        text: i18n.tr("Open a file...")
+        iconName: "add"
+
+        onTriggered: pageStack.push(Qt.resolvedUrl("ContentHubPicker.qml"))
     }
 }

=== modified file 'src/app/qml/ubuntu-docviewer-app.qml'
--- src/app/qml/ubuntu-docviewer-app.qml	2014-11-04 18:54:38 +0000
+++ src/app/qml/ubuntu-docviewer-app.qml	2015-01-16 17:05:43 +0000
@@ -15,15 +15,6 @@
     width: units.gu(50)
     height: units.gu(75)
 
-    Arguments {
-        id: args
-
-        // It returns "expected argument" message when not specified a path.
-        // It works anyway, but it may be worth to use Argument{} in future
-        defaultArgument.help: "Path of the document"
-        defaultArgument.valueNames: ["path"]
-    }
-
     File {
         objectName: "fileObject"
         id: file
@@ -33,18 +24,21 @@
     }
 
     Component.onCompleted: {
-        // Check if a value has been specified for "path" argument
-        if (args.defaultArgument.at(0)) {
-            // If so, send the path to the File plugin
-            console.log("Path argument is:", args.defaultArgument.at(0))      
-            file.path = args.defaultArgument.at(0)
+        // Check if a value has been specified for "documentPath" argument.
+        // The value for the argument is parsed in main.cpp.
+
+        if (documentPath) {
+            // If so, send the path to the File plugin and load the document.
+            console.log("Path argument is:", documentPath);
+            file.path = documentPath;
         } else {
-            // Otherwise, push a welcome screen in the stack
-            pageStack.push(Qt.resolvedUrl("WelcomePage.qml"))
+            // Otherwise, push a welcome screen in the stack.
+            pageStack.push(Qt.resolvedUrl("WelcomePage.qml"));
         }
     }
 
     // Content Importer
+    // Used when user asks to open a document from ContentHub.
     Loader {
         id: contentHubLoader