Unity 8

Merge lp:~azzar1/unity8/launcher-tooltips into lp:unity8

launcher-tooltips
Merge into trunk

Proposed by Andrea Azzarone on 2016-10-20

Status:	Superseded
Proposed branch:	lp:~azzar1/unity8/launcher-tooltips
Merge into:	lp:unity8
Prerequisite:	lp:~azzar1/unity8/remove-UbuntuShapeForItem
Diff against target:	333 lines (+242/-3) 5 files modified debian/control (+1/-0) qml/Launcher/LauncherDelegate.qml (+1/-0) qml/Launcher/LauncherPanel.qml (+79/-3) qml/Launcher/Tooltip.qml (+72/-0) tests/qmltests/Launcher/tst_Launcher.qml (+89/-0)
To merge this branch:	bzr merge lp:~azzar1/unity8/launcher-tooltips
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
Michael Zanetti (community)		2016-10-20	Approve on 2016-11-25
Unity8 CI Bot	continuous-integration	2016-10-20	Approve on 2016-11-24
Michał Sawicz			Needs Fixing on 2016-11-24
Albert Astals Cid (community)		2016-10-20	Abstain on 2016-11-24
Lukáš Tinkl		2016-10-20	Pending
Review via email: mp+308903@code.launchpad.net

This proposal has been superseded by a proposal from 2016-11-29.

Commit Message

Implement launcher tooltips.

Description of the Change

* Are there any related MPs required for this MP to build/function as expected?
Yes, lp:~azzar1/unity8/remove-UbuntuShapeForItem. But it has been merged in this branch and listed as a prerequiste.

* Did you perform an exploratory manual test run of your code change and any related functionality?
Yes

* If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
N/A

* If you changed the UI, has there been a design review?
Yes, alexm approved them

Unity8 CI Bot (unity8-ci-bot) wrote on 2016-10-20:

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-unity8-ci/2420/rebuild

review: Approve (continuous-integration)

Albert Astals Cid (aacid) wrote on 2016-10-24:

Looks good :)

Some minor stuff

Please mark
property var hoveredItem:
property int itemCenter:
as readonly.

Since you changed a == to === i'll ask you to change tooltipShape.hoveredItem == null too, or if you don't want the really really really equal maybe use !tooltipShape.hoveredItem ?

review: Needs Fixing

Andrea Azzarone (azzar1) wrote on 2016-10-25:

> Looks good :)
>
> Some minor stuff
>
> Please mark
> property var hoveredItem:
> property int itemCenter:
> as readonly.
>
> Since you changed a == to === i'll ask you to change tooltipShape.hoveredItem
> == null too, or if you don't want the really really really equal maybe use
> !tooltipShape.hoveredItem ?

Done.

Andrea Azzarone (azzar1) wrote on 2016-10-25:

Please note tha there are extra lines in the diff due to the fact the prerequisite branch is not in sync with the unified stages (I cannot update it because it's already in the silo).

Unity8 CI Bot (unity8-ci-bot) wrote on 2016-10-25:

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-unity8-ci/2437/rebuild

review: Needs Fixing (continuous-integration)

Albert Astals Cid (aacid) wrote on 2016-10-26:

* Did you perform an exploratory manual test run of the code change and any related functionality?
Yes

* Did CI run pass? If not, please explain why.
No, there's Launcher tests failing but not related to this (i.e. Launcher has been known to be unstable in the init in the past and this doesn't touch the init)

review: Approve

Albert Astals Cid (aacid) wrote on 2016-11-14:

Text conflict in tests/qmltests/Launcher/tst_Launcher.qml
1 conflicts encountered.

Note: Was top approved already.

review: Needs Fixing

Andrea Azzarone (azzar1) wrote on 2016-11-24:

> Text conflict in tests/qmltests/Launcher/tst_Launcher.qml
> 1 conflicts encountered.
>
> Note: Was top approved already.

Done.

Michael Zanetti (mzanetti) wrote on 2016-11-24:

ok, re-approving after merge

review: Approve

Albert Astals Cid (aacid) on 2016-11-24:

review: Abstain

Michał Sawicz (saviq) wrote on 2016-11-24:

tests/qmltests/Launcher/tst_Launcher.qml:1482:1: Expected token `}'

review: Needs Fixing

lp:~azzar1/unity8/launcher-tooltips updated on 2016-11-24

2634. By Andrea Azzarone on 2016-11-24: Fix broken test.

Unity8 CI Bot (unity8-ci-bot) wrote on 2016-11-24:

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-unity8-ci/2559/rebuild

review: Needs Fixing (continuous-integration)

Unity8 CI Bot (unity8-ci-bot) wrote on 2016-11-24:

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-unity8-ci/2565/rebuild

review: Approve (continuous-integration)

Michael Zanetti (mzanetti) wrote on 2016-11-25:

wheee! ci is green now :)

review: Approve

Unmerged revisions

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Andrea Azzarone

Mohammad Rakibul Hasan

Unity Team

 === modified file 'debian/control'
 --- debian/control	2016-11-16 10:44:00 +0000
 +++ debian/control	2016-11-24 16:06:51 +0000
@@ -49,6 +49,7 @@
                 python3-all:any,
                 python3-setuptools,
                 qml-module-qt-labs-folderlistmodel,
++               qml-module-qtqml-statemachine,
                 qml-module-qtmultimedia (>= 5.4.1-1ubuntu19~overlay2),
                 qml-module-qtquick-layouts,
                 qml-module-qtquick-xmllistmodel,
 === modified file 'qml/Launcher/LauncherDelegate.qml'
 --- qml/Launcher/LauncherDelegate.qml	2016-06-03 11:13:46 +0000
 +++ qml/Launcher/LauncherDelegate.qml	2016-11-24 16:06:51 +0000
@@ -22,6 +22,7 @@
      property int itemIndex: 0
      property string iconName
++    property string name
      property int count: 0
      property bool countVisible: false
      property int progress: -1
 === modified file 'qml/Launcher/LauncherPanel.qml'
 --- qml/Launcher/LauncherPanel.qml	2016-11-09 15:02:55 +0000
 +++ qml/Launcher/LauncherPanel.qml	2016-11-24 16:06:51 +0000
@@ -15,6 +15,7 @@
   */
  import QtQuick 2.4
++import QtQml.StateMachine 1.0 as DSM
  import Ubuntu.Components 1.3
  import Unity.Launcher 0.1
  import Ubuntu.Components.Popups 1.3
@@ -31,7 +32,7 @@
      property bool dragging: false
      property bool moving: launcherListView.moving || launcherListView.flicking
      property bool preventHiding: moving || dndArea.draggedIndex >= 0 || quickList.state === "open" || dndArea.pressed
--                                 || mouseEventEater.containsMouse || dashItem.hovered
++                                 || dndArea.containsMouse || dashItem.hovered
      property int highlightIndex: -2
      property bool shortcutHintsShown: false
@@ -40,7 +41,7 @@
      signal kbdNavigationCancelled()
      onXChanged: {
--        if (quickList.state == "open") {
++        if (quickList.state === "open") {
              quickList.state = ""
+         }
+     }
@@ -69,7 +70,6 @@
          id: mouseEventEater
          anchors.fill: parent
          acceptedButtons: Qt.AllButtons
--        hoverEnabled: true
          onWheel: wheel.accepted = true;
+     }
@@ -225,6 +225,7 @@
                          // the right app when running autopilot tests for
                          // multiple apps.
                          readonly property string appId: model.appId
++                        name: model.name
                          itemIndex: index
                          itemHeight: launcherListView.itemHeight
                          itemWidth: launcherListView.itemWidth
@@ -399,6 +400,7 @@
                          id: dndArea
                          objectName: "dndArea"
                          acceptedButtons: Qt.LeftButton | Qt.RightButton
++                        hoverEnabled: true
                          anchors {
                              fill: parent
                              topMargin: launcherListView.topMargin
@@ -828,4 +830,78 @@
+             }
+         }
+     }
++
++    Tooltip {
++        id: tooltipShape
++        objectName: "tooltipShape"
++
++        visible: tooltipShownState.active
++        rotation: root.rotation
++        y: itemCenter - (height / 2)
++
++        anchors {
++            left: root.inverted ? undefined : parent.right
++            right: root.inverted ? parent.left : undefined
++            margins: units.gu(1)
++        }
++
++        readonly property var hoveredItem: dndArea.containsMouse ? launcherListView.itemAt(dndArea.mouseX, dndArea.mouseY + launcherListView.realContentY) : null
++        readonly property int itemCenter: !hoveredItem ? 0 : root.mapFromItem(hoveredItem, 0, 0).y + (hoveredItem.height / 2) + hoveredItem.offset
++
++        text: !hoveredItem ? "" : hoveredItem.name
++    }
++
++    DSM.StateMachine {
++        id: tooltipStateMachine
++        initialState: tooltipHiddenState
++        running: true
++
++        DSM.State {
++            id: tooltipHiddenState
++
++            DSM.SignalTransition {
++                targetState: tooltipShownState
++                signal: tooltipShape.hoveredItemChanged
++                // !dndArea.pressed allows us to filter out touch input events
++                guard: tooltipShape.hoveredItem !== null && !dndArea.pressed && !root.moving
++            }
++        }
++
++        DSM.State {
++            id: tooltipShownState
++
++            DSM.SignalTransition {
++                targetState: tooltipHiddenState
++                signal: tooltipShape.hoveredItemChanged
++                guard: tooltipShape.hoveredItem === null
++            }
++
++            DSM.SignalTransition {
++                targetState: tooltipDismissedState
++                signal: dndArea.onPressed
++            }
++
++            DSM.SignalTransition {
++                targetState: tooltipDismissedState
++                signal: quickList.stateChanged
++                guard: quickList.state === "open"
++            }
++        }
++
++        DSM.State {
++            id: tooltipDismissedState
++
++            DSM.SignalTransition {
++                targetState: tooltipHiddenState
++                signal: dndArea.positionChanged
++                guard: quickList.state != "open" && !dndArea.pressed && !dndArea.moving
++            }
++
++            DSM.SignalTransition {
++                targetState: tooltipHiddenState
++                signal: dndArea.exited
++                guard: quickList.state != "open"
++            }
++        }
++    }
+ }
 === added file 'qml/Launcher/Tooltip.qml'
 --- qml/Launcher/Tooltip.qml	1970-01-01 00:00:00 +0000
 +++ qml/Launcher/Tooltip.qml	2016-11-24 16:06:51 +0000
@@ -0,0 +1,72 @@
++/*
++ * Copyright (C) 2016 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
++
++UbuntuShape {
++    id: root
++
++    // This property holds the delay (milliseconds) after which the tool tip is shown.
++    // A tooltip with a negative delay is shown immediately. The default value is 500 ms.
++    property int delay:  500
++
++    // This property holds the text shown on the tool tip.
++    property alias text: label.text
++
++    aspect: UbuntuShape.Flat
++    color: theme.palette.normal.background
++    width: label.implicitWidth + units.gu(4)
++    height: label.implicitHeight + units.gu(2)
++    opacity: 0
++
++    Image {
++        anchors {
++            right: parent.left
++            rightMargin: -units.dp(4)
++            verticalCenter: parent.verticalCenter
++        }
++        source: "graphics/quicklist_tooltip.png"
++        rotation: 90
++    }
++
++    Label {
++        id: label
++        anchors.centerIn: parent
++        color: theme.palette.normal.backgroundText
++    }
++
++    states: [
++        State {
++            name: "visible"
++            when: root.visible
++            PropertyChanges {
++                target: root
++                opacity: 0.95
++            }
++        }
++    ]
++
++    transitions: [
++        Transition {
++            from: ""; to: "visible"
++            SequentialAnimation {
++                PauseAnimation { duration: root.delay }
++                UbuntuNumberAnimation { target: root; property: "opacity"; duration: UbuntuAnimation.BriskDuration }
++            }
++        }
++    ]
++}
 \ No newline at end of file
 === modified file 'tests/qmltests/Launcher/tst_Launcher.qml'
 --- tests/qmltests/Launcher/tst_Launcher.qml	2016-11-16 10:44:13 +0000
 +++ tests/qmltests/Launcher/tst_Launcher.qml	2016-11-24 16:06:51 +0000
@@ -1369,6 +1369,95 @@
              tryCompare(clickThroughSpy, "count", 0);
+         }
++        function test_tooltip() {
++            launcher.lockedVisible = true;
++            revealByEdgePush();
++
++            var item = findChild(launcher, "launcherDelegate0");
++            var tooltipShape = findChild(launcher, "tooltipShape");
++
++            // Initial state
++            tryCompare(tooltipShape, "visible", false);
++            tryCompare(tooltipShape, "opacity", .0);
++
++            // Move the mouse on the launcher icon
++            mouseMove(item, item.width / 2, item.height / 2, 10);
++            mouseMove(item, item.width / 2 + 1, item.height / 2, 10);
++            tryCompare(tooltipShape, "visible", true);
++            tryCompare(tooltipShape, "opacity", .95);
++
++            // Move the mouse away
++            mouseMove(root, root.width, root.height / 2, 10);
++            tryCompare(tooltipShape, "visible", false);
++            tryCompare(tooltipShape, "opacity", .0);
++        }
++
++        function test_quicklist_dismisses_tooltip() {
++            launcher.lockedVisible = true;
++            revealByEdgePush();
++
++            var item = findChild(launcher, "launcherDelegate0");
++            var tooltipShape = findChild(launcher, "tooltipShape");
++            var quickListShape = findChild(launcher, "quickListShape");
++
++            // Initial state
++            tryCompare(tooltipShape, "visible", false);
++            tryCompare(tooltipShape, "opacity", .0);
++
++            // Move the mouse on the launcher icon
++            mouseMove(item, item.width / 2, item.height / 2, 10);
++            mouseMove(item, item.width / 2 + 1, item.height / 2, 10);
++            tryCompare(tooltipShape, "visible", true);
++            tryCompare(tooltipShape, "opacity", .95);
++
++            // Right click to show the quicklist
++            mouseClick(item, item.width / 2, item.height / 2, Qt.RightButton);
++            tryCompare(quickListShape, "visible", true);
++            tryCompare(tooltipShape, "visible", false);
++            tryCompare(tooltipShape, "opacity", .0);
++
++            // Left click hides the quicklist, tooltip is still dismissed
++            mouseClick(item, item.width / 2, item.height / 2, Qt.LefftButton);
++            tryCompare(quickListShape, "visible", false);
++            tryCompare(tooltipShape, "visible", false);
++            tryCompare(tooltipShape, "opacity", .0);
++
++            // Mouse motion should should show tooltip again
++            mouseMove(item, item.width / 2, item.height / 2, 10);
++            mouseMove(item, item.width / 2 + 1, item.height / 2, 10);
++            tryCompare(tooltipShape, "visible", true);
++            tryCompare(tooltipShape, "opacity", .95);
++        }
++
++        function test_click_dismisses_tooltip() {
++            launcher.lockedVisible = true;
++            revealByEdgePush();
++
++            var item = findChild(launcher, "launcherDelegate0");
++            var tooltipShape = findChild(launcher, "tooltipShape");
++
++            // Initial state
++            tryCompare(tooltipShape, "visible", false);
++            tryCompare(tooltipShape, "opacity", .0);
++
++            // Move the mouse on the launcher icon
++            mouseMove(item, item.width / 2, item.height / 2, 10);
++            mouseMove(item, item.width / 2 + 1, item.height / 2, 10);
++            tryCompare(tooltipShape, "visible", true);
++            tryCompare(tooltipShape, "opacity", .95);
++
++            // Left click should dismiss the tooltip
++            mouseClick(item, item.width / 2 + 1, item.height / 2, Qt.LeftButton);
++            tryCompare(tooltipShape, "visible", false);
++            tryCompare(tooltipShape, "opacity", .0);
++
++            // Mouse motion should should show tooltip again
++            mouseMove(item, item.width / 2, item.height / 2, 10);
++            mouseMove(item, item.width / 2 + 1, item.height / 2, 10);
++            tryCompare(tooltipShape, "visible", true);
++            tryCompare(tooltipShape, "opacity", .95);
++        }
++
          function test_launcherEnabledSetting() {
              launcher.available = true;