Merge lp:~mhall119/ubuntu-docviewer-app/pdf-presentations into lp:ubuntu-docviewer-app

[Michael Hall]

Add a basic presentation mode to PDF docments.

Adds a basic presentation mode to PDF docments.

[Jenkins Bot (ubuntu-core-apps-jenkins-bot)]

FAILED: Continuous integration, rev:261
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/94/
Executed test runs:
    None: https://core-apps-jenkins.ubuntu.com/job/generic-update-mp/362/console

Click here to trigger a rebuild:
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/94/rebuild

review: Needs Fixing (continuous-integration)

[lp:~mhall119/ubuntu-docviewer-app/pdf-presentations]

263. By Michael Hall on 2016-01-13

Fix header content positioning to remove gap on the left

[Jenkins Bot (ubuntu-core-apps-jenkins-bot)]

FAILED: Continuous integration, rev:262
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/95/
Executed test runs:
    None: https://core-apps-jenkins.ubuntu.com/job/generic-update-mp/363/console

Click here to trigger a rebuild:
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/95/rebuild

review: Needs Fixing (continuous-integration)

[Jenkins Bot (ubuntu-core-apps-jenkins-bot)]

FAILED: Continuous integration, rev:263
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/97/
Executed test runs:
    None: https://core-apps-jenkins.ubuntu.com/job/generic-update-mp/366/console

Click here to trigger a rebuild:
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/97/rebuild

review: Needs Fixing (continuous-integration)

[Stefano Verzegnassi (verzegnassi-stefano)]

Hi Michael, I will have a look at your MP tomorrow (14th Jan).

Don't mind the Jenkins error for now, since Autopilot tests have ATM some issue with the new configuration ("lxml" module is missing).

[Stefano Verzegnassi (verzegnassi-stefano)]

I found a few things that require a fix:

  * I'd prefer to use the new PageHeader, instead of the "old" page.head property.
    e.g. http://paste.ubuntu.com/14495479/

  * We'd probably need to display the page number of the current page.[1] In the code I posted above, it would be a matter of adding the "subtitle" property in the ListItemLayout.

  * I'm not sure of the background color. Shouldn't it be black?[1]

  * If the night-mode is active, it affects also the presentation view. It should be disabled when the user plays a presentation.

  * I've seen some strange output from PdfViewDelegate. Connections to the pinch area should be disabled when the component is used from the presentation view (e.g. using a bool).

  * The ShaderEffectSource in PdfViewDelegate should be disabled when in presentation mode, otherwise a blurry render of the page is visible after resizing the window[2]

  * Just a cosmetic fix, I'd use the "slideshow" icon, instead of "media-playback-start".

---

I've pushed the patch for these things in a separate branch:
    https://code.launchpad.net/~verzegnassi-stefano/ubuntu-docviewer-app/pdf-presentations-mp-review

I have still some doubt about the mouse/touch gestures.
While the "double-click-to-show-header" gesture looks good to me, I'm not sure about the "swipe-to-go-prev/next" touch gesture.
I'd probably prefer to split the mouseArea into three parts, as done in some Google application:
    https://drive.google.com/open?id=0By4kAplbFcE6QmJlR1ZydlVCSDA
Anyway, this is not important at the moment; I'm okay with the current solution.

Overall, your MP looks good, and it's pretty similar to how I was thinking of doing this. Big thumb up and thank you very much!

======

[1] My design proposal: https://drive.google.com/open?id=0By4kAplbFcE6MDNJMjBmNklVY28
     Current design: https://drive.google.com/open?id=0By4kAplbFcE6QWF4cXVfQm9uR28

[2] screenshot - https://drive.google.com/open?id=0By4kAplbFcE6RXh6Q2NELWlJbjg

review: Needs Fixing

[lp:~mhall119/ubuntu-docviewer-app/pdf-presentations]

264. By Stefano Verzegnassi on 2016-01-14

Suggested fixes from Stefano

[Jenkins Bot (ubuntu-core-apps-jenkins-bot)]

FAILED: Continuous integration, rev:264
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/103/
Executed test runs:
    None: https://core-apps-jenkins.ubuntu.com/job/generic-update-mp/375/console

Click here to trigger a rebuild:
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/103/rebuild

review: Needs Fixing (continuous-integration)

[Stefano Verzegnassi (verzegnassi-stefano)]

LGTM!

Just a last question:
I saw you added a back action to Page.header.leadingActionBar.actions. Did you find some issue?

In theory, PageStack automatically appends the action when the page is pushed into the stack (at least, that's what I see on rc-proposed and my vivid+overlay desktop).

review: Approve

[Michael Hall (mhall119)]

In theory it does, but in practice it wasn't. I think it might be because the new PageHeader is looking for an AdaptivePageLayout rather than a PageStack. Whatever caused it to not appear, this would force it back.

[Jenkins Bot (ubuntu-core-apps-jenkins-bot)]

FAILED: Continuous integration, rev:264
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/104/
Executed test runs:
    None: https://core-apps-jenkins.ubuntu.com/job/generic-update-mp/376/console

Click here to trigger a rebuild:
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/104/rebuild

review: Needs Fixing (continuous-integration)

[Jenkins Bot (ubuntu-core-apps-jenkins-bot)]

FAILED: Continuous integration, rev:264
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/109/
Executed test runs:
    None: https://core-apps-jenkins.ubuntu.com/job/generic-update-mp/383/console

Click here to trigger a rebuild:
https://core-apps-jenkins.ubuntu.com/job/run-ap-tests-ci/109/rebuild

review: Needs Fixing (continuous-integration)

[Jenkins Bot (ubuntu-core-apps-jenkins-bot)]

review: Approve (continuous-integration)

=== modified file 'po/com.ubuntu.docviewer.pot'
--- po/com.ubuntu.docviewer.pot	2015-12-27 12:10:06 +0000
+++ po/com.ubuntu.docviewer.pot	2016-01-14 13:48:25 +0000
@@ -8,7 +8,7 @@
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2015-12-27 13:06+0100\n"
+"POT-Creation-Date: 2016-01-14 08:46-0500\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[e-mail]>\n"
@@ -42,7 +42,7 @@
 
 #: ../src/app/qml/common/DetailsPage.qml:26
 #: ../src/app/qml/loView/LOViewDefaultHeader.qml:107
-#: ../src/app/qml/pdfView/PdfViewDefaultHeader.qml:83
+#: ../src/app/qml/pdfView/PdfViewDefaultHeader.qml:90
 #: ../src/app/qml/textView/TextViewDefaultHeader.qml:69
 msgid "Details"
 msgstr ""
@@ -189,33 +189,33 @@
 
 #. TRANSLATORS: %1 refers to a time formatted as Locale.ShortFormat (e.g. hh:mm). It depends on system settings.
 #. http://qt-project.org/doc/qt-4.8/qlocale.html#FormatType-enum
-#: ../src/app/qml/documentPage/DocumentListDelegate.qml:100
+#: ../src/app/qml/documentPage/DocumentListDelegate.qml:103
 #, qt-format
 msgid "Today, %1"
 msgstr ""
 
 #. TRANSLATORS: %1 refers to a time formatted as Locale.ShortFormat (e.g. hh:mm). It depends on system settings.
 #. http://qt-project.org/doc/qt-4.8/qlocale.html#FormatType-enum
-#: ../src/app/qml/documentPage/DocumentListDelegate.qml:105
+#: ../src/app/qml/documentPage/DocumentListDelegate.qml:108
 #, qt-format
 msgid "Yesterday, %1"
 msgstr ""
 
 #. TRANSLATORS: this is a datetime formatting string,
 #. see http://qt-project.org/doc/qt-5/qml-qtqml-date.html#details for valid expressions.
-#: ../src/app/qml/documentPage/DocumentListDelegate.qml:112
-#: ../src/app/qml/documentPage/DocumentListDelegate.qml:131
+#: ../src/app/qml/documentPage/DocumentListDelegate.qml:115
+#: ../src/app/qml/documentPage/DocumentListDelegate.qml:134
 msgid "yyyy/MM/dd hh:mm"
 msgstr ""
 
 #. TRANSLATORS: this is a datetime formatting string,
 #. see http://qt-project.org/doc/qt-5/qml-qtqml-date.html#details for valid expressions.
-#: ../src/app/qml/documentPage/DocumentListDelegate.qml:125
+#: ../src/app/qml/documentPage/DocumentListDelegate.qml:128
 msgid "dddd, hh:mm"
 msgstr ""
 
 #: ../src/app/qml/documentPage/DocumentPage.qml:23
-#: /tmp/ubuntu-docviewer-app-build/po/com.ubuntu.docviewer.desktop.in.in.h:3
+#: /home/mhall/projects/Ubuntu/coreapps/ubuntu-docviewer-app-build/po/com.ubuntu.docviewer.desktop.in.in.h:3
 msgid "Documents"
 msgstr ""
 
@@ -342,13 +342,13 @@
 msgstr ""
 
 #: ../src/app/qml/loView/LOViewDefaultHeader.qml:100
-#: ../src/app/qml/pdfView/PdfViewDefaultHeader.qml:77
+#: ../src/app/qml/pdfView/PdfViewDefaultHeader.qml:84
 #: ../src/app/qml/textView/TextViewDefaultHeader.qml:63
 msgid "Disable night mode"
 msgstr ""
 
 #: ../src/app/qml/loView/LOViewDefaultHeader.qml:100
-#: ../src/app/qml/pdfView/PdfViewDefaultHeader.qml:77
+#: ../src/app/qml/pdfView/PdfViewDefaultHeader.qml:84
 #: ../src/app/qml/textView/TextViewDefaultHeader.qml:63
 msgid "Enable night mode"
 msgstr ""
@@ -403,6 +403,7 @@
 
 #. TRANSLATORS: the first argument (%1) refers to the page currently shown on the screen,
 #. while the second one (%2) refers to the total pages count.
+#: ../src/app/qml/pdfView/PdfPresentation.qml:51
 #: ../src/app/qml/pdfView/PdfView.qml:35
 #, qt-format
 msgid "Page %1 of %2"
@@ -412,6 +413,10 @@
 msgid "Go to page..."
 msgstr ""
 
+#: ../src/app/qml/pdfView/PdfViewDefaultHeader.qml:78
+msgid "Presentation"
+msgstr ""
+
 #: ../src/app/qml/pdfView/PdfViewGotoDialog.qml:26
 msgid "Go to page"
 msgstr ""
@@ -439,10 +444,10 @@
 msgid "copy %1"
 msgstr ""
 
-#: /tmp/ubuntu-docviewer-app-build/po/com.ubuntu.docviewer.desktop.in.in.h:1
+#: /home/mhall/projects/Ubuntu/coreapps/ubuntu-docviewer-app-build/po/com.ubuntu.docviewer.desktop.in.in.h:1
 msgid "Document Viewer"
 msgstr ""
 
-#: /tmp/ubuntu-docviewer-app-build/po/com.ubuntu.docviewer.desktop.in.in.h:2
+#: /home/mhall/projects/Ubuntu/coreapps/ubuntu-docviewer-app-build/po/com.ubuntu.docviewer.desktop.in.in.h:2
 msgid "documents;viewer;pdf;reader;"
 msgstr ""

=== added file 'src/app/qml/pdfView/PdfPresentation.qml'
--- src/app/qml/pdfView/PdfPresentation.qml	1970-01-01 00:00:00 +0000
+++ src/app/qml/pdfView/PdfPresentation.qml	2016-01-14 13:48:25 +0000
@@ -0,0 +1,106 @@
+/*
+ * Copyright (C) 2013-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/>.
+ */
+
+import QtQuick 2.4
+import Ubuntu.Components 1.3
+import DocumentViewer 1.0
+import DocumentViewer.PDF 1.0 as PDF
+
+Page {
+    id: pdfPage
+    property var poppler
+    property bool isPresentation: true
+    anchors.fill: parent
+    title: DocumentViewer.getFileBaseNameFromPath(poppler.path)
+    focus: true
+
+    header: PageHeader {
+        visible: false
+        leadingActionBar.actions: [
+            Action {
+                iconName: "back"
+                text: "Back"
+                onTriggered: pageStack.pop()
+            }
+        ]
+        contents: ListItemLayout {
+            anchors.centerIn: parent
+            title {
+                font.weight: Font.DemiBold
+                textSize: Label.Large
+                text: pdfPage.title
+                color: pdfPage.header.__styleInstance.foregroundColor
+            }
+            subtitle {
+                textSize: Label.Medium
+                // TRANSLATORS: the first argument (%1) refers to the page currently shown on the screen,
+                // while the second one (%2) refers to the total pages count.
+                text: i18n.tr("Page %1 of %2").arg(pdfView.currentIndex + 1).arg(pdfView.count)
+                color: pdfPage.header.__styleInstance.foregroundColor
+            }
+        }
+
+        StyleHints {
+            backgroundColor: "#BF000000"
+            foregroundColor: "white"
+        }
+    }
+
+    ListView {
+        id: pdfView
+        anchors.fill: parent
+        focus: true
+
+        orientation: Qt.Horizontal;
+        snapMode: ListView.SnapOneItem
+        highlightRangeMode: ListView.StrictlyEnforceRange
+        highlightFollowsCurrentItem: true
+        highlightMoveDuration: 0
+        boundsBehavior: Flickable.StopAtBounds
+        cacheBuffer: width
+
+        model: poppler
+        delegate: PdfViewDelegate {
+            presentationMode: true
+            width: pdfPage.width
+            height: pdfPage.height
+            color: "black"
+            Component.onDestruction: window.releaseResources()
+        }
+        Component.onCompleted: pdfPage.forceActiveFocus()
+
+        MouseArea {
+            anchors.fill: parent
+            onDoubleClicked: pdfPage.header.visible = !pdfPage.header.visible
+        }
+    }
+
+    Keys.onPressed: {
+        if (event.key == Qt.Key_Escape) { pageStack.pop(); return; }
+        if (event.key == Qt.Key_Home) { pdfView.positionViewAtBeginning(); return; }
+        if (event.key == Qt.Key_End) { pdfView.positionViewAtEnd(); return; }
+
+        if (event.key == Qt.Key_Right || event.key == Qt.Key_PageDown) {
+            pdfView.incrementCurrentIndex();
+            return;
+        }
+        if (event.key == Qt.Key_Left || event.key == Qt.Key_PageUp) {
+            pdfView.decrementCurrentIndex();
+            return;
+        }
+    }
+}
+

=== modified file 'src/app/qml/pdfView/PdfView.qml'
--- src/app/qml/pdfView/PdfView.qml	2015-12-26 18:27:13 +0000
+++ src/app/qml/pdfView/PdfView.qml	2016-01-14 13:48:25 +0000
@@ -42,6 +42,9 @@
     // Reset night mode shader settings when closing the page
     // Component.onDestruction: mainView.nightModeEnabled = false
 
+    Keys.onPressed: {
+        if (event.key == Qt.Key_F5) { pageStack.push(Qt.resolvedUrl("./PdfPresentation.qml"), {'poppler': poppler}); }
+    }
     Rectangle {
         // Since UITK 1.3, the MainView background is white.
         // We need to set a different color, otherwise pages

=== modified file 'src/app/qml/pdfView/PdfViewDefaultHeader.qml'
--- src/app/qml/pdfView/PdfViewDefaultHeader.qml	2015-11-13 21:19:46 +0000
+++ src/app/qml/pdfView/PdfViewDefaultHeader.qml	2016-01-14 13:48:25 +0000
@@ -73,6 +73,13 @@
         },
 
         Action {
+            objectName:"presentationmode"
+            iconName: "slideshow"
+            text: i18n.tr("Presentation")
+            onTriggered: pageStack.push(Qt.resolvedUrl("./PdfPresentation.qml"), {'poppler': poppler})
+        },
+
+        Action {
             iconName: "night-mode"
             text: mainView.nightModeEnabled ? i18n.tr("Disable night mode") : i18n.tr("Enable night mode")
             onTriggered: mainView.nightModeEnabled = !mainView.nightModeEnabled

=== modified file 'src/app/qml/pdfView/PdfViewDelegate.qml'
--- src/app/qml/pdfView/PdfViewDelegate.qml	2015-10-19 13:00:11 +0000
+++ src/app/qml/pdfView/PdfViewDelegate.qml	2016-01-14 13:48:25 +0000
@@ -21,6 +21,7 @@
 
     property int index: model.index
     property bool _previewFetched: false
+    property bool presentationMode: false
 
     property alias status: pageImg.status
 
@@ -47,8 +48,12 @@
 
         source: "image://poppler" + (index % poppler.providersNumber) + "/page/" + index;
         sourceSize.width: pdfPage.width
+        fillMode: Image.PreserveAspectFit
 
         onStatusChanged: {
+            if (presentationMode)
+                return;
+
             // This is supposed to run the first time PdfViewDelegate gets the page rendering.
             if (!_previewFetched) {
                 if (status == Image.Ready) {
@@ -82,7 +87,7 @@
     // Because of this, we have multiple callings to ImageProvider while zooming.
     // Just avoid it.
     Connections {
-        target: pinchy
+        target: !presentationMode ? pinchy : null
 
         onPinchStarted: _zoomTimer.stop();
         onPinchUpdated: {

=== modified file 'src/app/qml/ubuntu-docviewer-app.qml'
--- src/app/qml/ubuntu-docviewer-app.qml	2015-11-30 12:12:10 +0000
+++ src/app/qml/ubuntu-docviewer-app.qml	2016-01-14 13:48:25 +0000
@@ -204,5 +204,5 @@
 
     property bool nightModeEnabled: false
     layer.effect: NightModeShader {}
-    layer.enabled: nightModeEnabled && (pageStack.depth > 1)
+    layer.enabled: nightModeEnabled && (pageStack.depth > 1) && !pageStack.currentPage.isPresentation
 }