Merge lp:~tpeeters/ubuntu-ui-toolkit/10-Header-animate into lp:ubuntu-ui-toolkit/staging

[Tim Peeters]

Add animate property to cpp Header.

Add animate property to cpp Header. I added this property because the current behavior of the header is to always show without animating it in, after switching between apps.

[lp:~tpeeters/ubuntu-ui-toolkit/10-Header-animate]

1655. By Tim Peeters on 2015-09-25

document default value of animate

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1655
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/2312/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/1040/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/1042/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/1039/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/2312/rebuild

review: Needs Fixing (continuous-integration)

[lp:~tpeeters/ubuntu-ui-toolkit/10-Header-animate]

1656. By Tim Peeters on 2015-09-28

update unit tests

1657. By Tim Peeters on 2015-09-28

update components.api

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1657
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/2319/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/1047
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/1049
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/1049/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/1046

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/2319/rebuild

review: Approve (continuous-integration)

[Tim Peeters (tpeeters)]

Don't happrove this yet. We'll have a talk on Wednesday whether it is ever needed to disable animating of the header.

review: Needs Information

[Tim Peeters (tpeeters)]

If this bug is valid https://bugs.launchpad.net/ubuntu-ux/+bug/1500483 then we don't need the animate property.

[Tim Peeters (tpeeters)]

The header needs to animate when showing on app focus. MR for the current (old) Header here: https://code.launchpad.net/~tpeeters/ubuntu-ui-toolkit/11-animate-header-on-app-focus/+merge/272766

New header will have the same behavior.

review: Disapprove

Unmerged revisions

1657. By Tim Peeters on 2015-09-28

update components.api

1656. By Tim Peeters on 2015-09-28

update unit tests

1655. By Tim Peeters on 2015-09-25

document default value of animate

1654. By Tim Peeters on 2015-09-25

add animate property

=== modified file 'components.api'
--- components.api	2015-09-24 20:03:02 +0000
+++ components.api	2015-09-28 13:41:26 +0000
@@ -448,6 +448,7 @@
 Ubuntu.Components.ListItems.Header 1.3: Item
     property string text
 Ubuntu.Components.Header 1.3: StyledItem
+    property bool animate
     property bool exposed
     property Flickable flickable
     readonly property bool moving
 
=== modified file 'src/Ubuntu/Components/plugin/ucheader.cpp'
--- src/Ubuntu/Components/plugin/ucheader.cpp	2015-09-23 11:35:33 +0000
+++ src/Ubuntu/Components/plugin/ucheader.cpp	2015-09-28 13:41:26 +0000
@@ -87,6 +87,7 @@
     , m_previous_contentY(0)
     , m_exposed(true)
     , m_moving(false)
+    , m_animate(true)
 {
     m_showHideAnimation->setParent(this);
     m_showHideAnimation->setTargetObject(this);
@@ -202,7 +203,7 @@
             m_showHideAnimation->stop();
         }
     }
-    if (isComponentComplete()) {
+    if (m_animate && isComponentComplete()) {
         m_showHideAnimation->setFrom(y());
         m_showHideAnimation->setTo(0.0);
         m_showHideAnimation->start();
@@ -224,7 +225,7 @@
             m_showHideAnimation->stop();
         }
     }
-    if (isComponentComplete()) {
+    if (m_animate && isComponentComplete()) {
         m_showHideAnimation->setFrom(y());
         m_showHideAnimation->setTo(-1.0*height());
         m_showHideAnimation->start();
@@ -277,6 +278,32 @@
     return m_moving;
 }
 
+/*!
+ * \qmlproperty bool Header::animate
+ * Enable or disable animating of the header when exposing or hiding it
+ * either by setting the \l exposed property, or when the user finishes
+ * interaction with the \l flickable. Default value: true.
+ */
+void UCHeader::setAnimate(bool animate) {
+    if (m_animate == animate) {
+        return;
+    }
+
+    m_animate = animate;
+    if (!m_animate && m_moving) {
+        m_showHideAnimation->stop();
+        // _q_showHideAnimationRunningChanged() will update m_moving.
+
+        // Finish showing/hiding:
+        if (m_exposed) {
+            show();
+        } else {
+            hide();
+        }
+    }
+    Q_EMIT animateChanged();
+}
+
 // Called when moving due to user interaction with the flickable, or by
 // setting m_flickable.contentY programatically.
 void UCHeader::_q_scrolledContents() {
 
=== modified file 'src/Ubuntu/Components/plugin/ucheader.h'
--- src/Ubuntu/Components/plugin/ucheader.h	2015-09-22 18:24:27 +0000
+++ src/Ubuntu/Components/plugin/ucheader.h	2015-09-28 13:41:26 +0000
@@ -31,6 +31,7 @@
     Q_PROPERTY(QQuickFlickable* flickable READ flickable WRITE setFlickable NOTIFY flickableChanged FINAL)
     Q_PROPERTY(bool exposed MEMBER m_exposed WRITE setExposed NOTIFY exposedChanged FINAL)
     Q_PROPERTY(bool moving READ moving NOTIFY movingChanged FINAL)
+    Q_PROPERTY(bool animate MEMBER m_animate WRITE setAnimate NOTIFY animateChanged FINAL)
 
 public:
     explicit UCHeader(QQuickItem *parent = 0);
@@ -40,11 +41,13 @@
     void setFlickable(QQuickFlickable* flickable);
     void setExposed(bool exposed);
     bool moving();
+    void setAnimate(bool animate);
 
 Q_SIGNALS:
     void flickableChanged();
     void exposedChanged();
     void movingChanged();
+    void animateChanged();
 
 protected:
     void show();
@@ -66,6 +69,7 @@
     qreal m_previous_contentY;
     bool m_exposed:1;
     bool m_moving:1;
+    bool m_animate:1;
 
     // used to set the easing and duration of m_showHideAnimation
     static UCUbuntuAnimation *s_ubuntuAnimation;
 
=== modified file 'tests/unit_x11/tst_components/tst_header.qml'
--- tests/unit_x11/tst_components/tst_header.qml	2015-09-22 14:13:36 +0000
+++ tests/unit_x11/tst_components/tst_header.qml	2015-09-28 13:41:26 +0000
@@ -82,9 +82,15 @@
             Label {
                 text: "header exposed"
             }
-            Item {
-                width: 1
-                height: 1
+            Switch {
+                id: animateSwitch
+                checked: header.animate
+                function trigger() {
+                    header.animate = !header.animate;
+                }
+            }
+            Label {
+                text: "animate header"
             }
         }
         Button {
@@ -163,6 +169,7 @@
             // note: moving may be true briefly due to header height changes, but
             //  it does not change in the initialization after wait_for_exposed() above.
             compare(header.moving, false, "Header moving initially.");
+            compare(header.animate, true, "Header does not animate by default.");
         }
 
         function init() {
@@ -268,9 +275,11 @@
 
         function test_set_exposed_to_hide_and_show() {
             header.exposed = false;
-            wait_for_exposed(false, "Cannot hide header by setting visible to false.");
+            tryCompare(header, "moving", true, 1000, "Header does not start moving after setting exposed to false.");
+            wait_for_exposed(false, "Cannot hide header by setting exposed to false.");
             header.exposed = true;
-            wait_for_exposed(true, "Cannot show header by setting visible to true.");
+            tryCompare(header, "moving", true, 1000, "Header does not start moving after setting exposed to true.");
+            wait_for_exposed(true, "Cannot show header by setting exposed to true.");
 
             // change the value of exposed twice quickly:
             header.exposed = false;
@@ -350,5 +359,22 @@
 
             header.flickable = flickable;
         }
+
+        function test_animate_off() {
+            header.animate = false;
+            compare(header.animate, false, "Cannot disable header animation.");
+            compare(header.moving, false, "Disabling animate sets moving.");
+            header.exposed = false;
+            compare(header.moving, false, "Header moves while animate is off.");
+            compare(header.exposed, false, "Header exposed is not unset instantly with animate off.");
+            compare(header.y, -header.height, "Header is not instantly hidden by setting exposed to false with animate off.");
+
+            header.exposed = true;
+            compare(header.moving, false, "Header moves after exposing it with animate off.");
+            compare(header.exposed, true, "Header exposed is not set instantly with animate off.");
+            compare(header.y, 0, "Header is not instantly shown by setting exposed with animate off.");
+
+            header.animate = true;
+        }
     }
 }