Merge lp:~tpeeters/ubuntu-ui-toolkit/panel-open-close into lp:ubuntu-ui-toolkit

[Tim Peeters]

Add Panel.open() and Panel.close() functions so that applications can be adapted to use those instead of setting Panel.opened. The behavior of the panel was not changed, this will be done in a following MR.

Also note that applications with a Toolbar do not need to use Panel.open()/close()/opened directly, they can use the opened property of the Page.tools, so they should not be affected by the upcoming changes.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:743
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/611/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/2988
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-touch/552
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/468
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/468
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/468/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/2994
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/2994/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-saucy/2543
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/554
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/554/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/493
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/505

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/611/rebuild

review: Approve (continuous-integration)

[Tim Peeters (tpeeters)]

Ran tests on device like this:
https://docs.google.com/a/canonical.com/document/d/1cnBELUgsBCz9TMq-mR4VN4bwCKmDDXT9JxG-WFjzDFc/edit

Test results:
gallery-app: https://pastebin.canonical.com/96878/
webbrowser-app: https://pastebin.canonical.com/96881/
notes-app: https://pastebin.canonical.com/96883/

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:744
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/621/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/3157
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-touch/718
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/478
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/478
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/478/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/3163
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/3163/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-saucy/2652
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/720
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/720/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/589
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/600

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/621/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:745
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/624/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/3208
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-touch/756
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/481
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/481
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/481/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/3214
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/3214/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-saucy/2701
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/758
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/758/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/625
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/636

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/624/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:746
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/628/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/3217
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-touch/760
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/485
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/485
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/485/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/3223
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/3223/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-saucy/2707
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/762
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/762/artifact/work/output/*zip*/output.zip
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/628
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/639

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/628/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:747
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/631/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/3234
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-touch/777
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/488
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/488
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/488/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/3240
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/3240/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-saucy/2726
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/779
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/779/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/644
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/655

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/631/rebuild

review: Approve (continuous-integration)

[Tim Peeters (tpeeters)]

Results of autopilot run gallery_app on device with the gallery_app from this MR https://code.launchpad.net/~amanzi-team/gallery-app/gallery-app-actions-api/+merge/184533 (will be merged to gallery trunk soon): all PASSED

[Tim Peeters (tpeeters)]

Ran autopilot tests for webbrowser-app, all 36 tests PASSED.

[Tim Peeters (tpeeters)]

Autopilot tests for notes-app finished all 23 successfully.

[Tim Peeters (tpeeters)]

This MR was happroved before, but I set it back to "needs review" so I could run these tests again. I verified that they work fine with the pending touch image of 10 Sept, so now I'll happrove it again so we will have it in in the morning of 11 Sept.

review: Approve

=== modified file 'CHANGES'
--- CHANGES	2013-09-03 10:51:40 +0000
+++ CHANGES	2013-09-10 11:22:01 +0000
@@ -50,6 +50,9 @@
 * ADDED IN MainView: property bool anchorToKeyboard
 * CHANGED IN Tabs: property Component __headerContents TO property TabBar tabBar
 * CHANGED IN Header: property Component contents TO property Item contents
+* ADDED IN Panel: function open()
+* ADDED IN Panel: function closed()
+* DEPRECATED IN Panel: writable property opened. Will be made read-only.
 
 Compatibility Breaks
 ********************

=== modified file 'components.api'
--- components.api	2013-09-03 10:51:40 +0000
+++ components.api	2013-09-10 11:22:01 +0000
@@ -158,6 +158,8 @@
     default property list<Object> contents
     property int align
     property bool opened
+    function open()
+    function close()
     property bool locked
     property real hintSize
     property real triggerSize

=== modified file 'modules/Ubuntu/Components/Panel.qml'
--- modules/Ubuntu/Components/Panel.qml	2013-09-03 10:51:40 +0000
+++ modules/Ubuntu/Components/Panel.qml	2013-09-10 11:22:01 +0000
@@ -178,8 +178,36 @@
     property bool opened: false
     /*! \internal */
     onOpenedChanged: {
-        if (opened) state = "spread";
-        else state = "";
+        if (internal.openedChangedWarning) {
+            console.log("DEPRECATED use of Panel.opened property. This property will be made read-only,
+                please use the opened property of the Page tools or use Panel.open() and Panel.close().");
+        }
+
+        if (opened) {
+            panel.open();
+        } else {
+            panel.close();
+        }
+
+        internal.openedChangedWarning = true;
+    }
+
+    /*!
+      Open the panel
+     */
+    function open() {
+        internal.openedChangedWarning = false;
+        panel.state = "spread";
+        opened = true;
+    }
+
+    /*!
+      Close the panel
+     */
+    function close() {
+        internal.openedChangedWarning = false;
+        panel.state = "";
+        opened = false;
     }
 
     /*!
@@ -288,6 +316,9 @@
     QtObject {
         id: internal
 
+        // FIXME: Remove when opened property is made readonly
+        property bool openedChangedWarning: true
+
         /*!
           The duration in milliseconds of sliding in or out transitions when opening, closing, and showing the hint.
           Default value: 250
@@ -332,11 +363,18 @@
             if (bottomBarVisibilityCommunicator.forceHidden) {
                 internal.savedLocked = panel.locked;
                 internal.savedOpened = panel.opened;
-                panel.opened = false;
+                panel.close();
                 panel.locked = true;
             } else { // don't force hidden
                 panel.locked = internal.savedLocked;
-                if (internal.savedLocked) panel.opened = internal.savedOpened;
+
+                if (internal.savedLocked) {
+                    if (internal.savedOpened) {
+                        panel.open();
+                    } else {
+                        panel.close();
+                    }
+                }
                 // if the panel was locked, do not slide it back in
                 // until the user performs an edge swipe.
             }
@@ -350,9 +388,9 @@
         } else if (state == "moving" && internal.previousState == "spread") {
             internal.movingDelta = draggingArea.initialPosition;
         } else if (state == "spread") {
-            panel.opened = true;
+            panel.open();
         } else if (state == "") {
-            panel.opened = false;
+            panel.close();
         }
         internal.previousState = state;
     }
@@ -363,7 +401,7 @@
             mouse.accepted = false;
             // the mouse click may cause an update
             //  of locked by the clicked Item behind
-            if (!panel.locked) panel.opened = false;
+            if (!panel.locked) panel.close();
         }
         propagateComposedEvents: true
         visible: panel.locked == false && panel.state == "spread"

=== modified file 'modules/Ubuntu/Components/Toolbar.qml'
--- modules/Ubuntu/Components/Toolbar.qml	2013-09-03 10:51:40 +0000
+++ modules/Ubuntu/Components/Toolbar.qml	2013-09-10 11:22:01 +0000
@@ -46,12 +46,12 @@
                 && tools.opened && tools.locked) {
             // toolbar is locked in visible state.
             internal.updateVisibleTools();
-            opened = true;
+            toolbar.open();
         } else if (!opened && !animating) {
             // toolbar is closed
             internal.updateVisibleTools();
         } else {
-            opened = false;
+            toolbar.close()
             // internal.visibleTools will be updated
             // when the hide animation is finished
         }
@@ -72,7 +72,13 @@
     Connections {
         target: tools
         ignoreUnknownSignals: true
-        onOpenedChanged: toolbar.opened = tools.opened;
+        onOpenedChanged: {
+            if (tools.opened) {
+                toolbar.open();
+            } else {
+                toolbar.close();
+            }
+        }
         onLockedChanged: toolbar.locked = tools.locked;
     }
 

=== modified file 'tests/unit_x11/tst_components/tst_panel.qml'
--- tests/unit_x11/tst_components/tst_panel.qml	2013-09-03 10:51:40 +0000
+++ tests/unit_x11/tst_components/tst_panel.qml	2013-09-10 11:22:01 +0000
@@ -58,9 +58,9 @@
         }
 
         function test_opened() {
-            panel.opened = true;
+            panel.open();
             compare(panel.opened, true, "Can set opened");
-            panel.opened = false;
+            panel.close();
             compare(panel.opened, false, "Can unset opened");
         }
 
@@ -241,7 +241,7 @@
             }
 
             function test_clickToDeactivate() {
-                panel.opened = true;
+                panel.open();
                 compare(panel.opened && panel.align === Qt.AlignBottom, true, "Panel is opened and bottom-aligned");
                 mouseClick(root, root.width / 2, 5, Qt.LeftButton);
                 compare(panel.opened, false, "Panel is deactivated by clicking in the view outside of the panel");