Merge lp:~stolowski/unity-2d/no-results-hint into lp:unity-2d

[Paweł Stołowski]

[dash] Implemented support for no-results-hint. Hint message is now displayed in the dash if there were no search results for user query.

[dash] Implemented support for no-results-hint. Hint message is now displayed in the dash if there were no search results for user query.

[Paweł Stołowski (stolowski)]

Here is a screenshot of no-progress-hint support in unity 2d: http://imgur.com/IxKCn

[Paweł Stołowski (stolowski)]

> Here is a screenshot of no-progress-hint support in unity 2d:
> http://imgur.com/IxKCn

I meant no-results-hint of course.

[Xi Zhu (xi.zhu)]

Hi, could you have a look at the font please? Is it in 17pt Ubuntu regular? It looks bolder than the mockup, and is the dimed "Filter results" missing on the top right corner? Thank you :)

[Paweł Stołowski (stolowski)]

Hi, are you sure it was 17pt on the mockup? I've set font to Ubuntu, size = 17 pixels, bold = false, but it still doesn't exactly match the mockup (but it's very close). And with size = 17pt it's bigger and bolder than mockup. Here is the new screenshot: http://i.imgur.com/X2e5D.png
'Filter results' in the top right corner is only visible on lenses other then 'Home'.

[Florian Boucault (fboucault)]

Please don't hardcode font sizes but use TextCustom.qml from common instead.
As for the font being bold it's a bug in Ubuntu: https://bugs.launchpad.net/ubuntu-font-family/+bug/744812

[Paweł Stołowski (stolowski)]

Changed to fontSize: "large" as suggested offline by Florian.

[Michal Hruby (mhr3)]

41 m_unityLens->search_finished.connect(sigc::mem_fun(this, &Lens::searchFinished));
42 m_unityLens->global_search_finished.connect(sigc::mem_fun(this, &Lens::globalSearchFinished));
43 + connect(this, SIGNAL(searchFinished(unity::dash::Lens::Hints const &)), SLOT(onSearchFinished(unity::dash::Lens::Hints const &)));
44 + connect(this, SIGNAL(globalSearchFinished(unity::dash::Lens::Hints const &)), SLOT(onSearchFinished(unity::dash::Lens::Hints const &)));

You probably don't need to connect to global_search_finished, since we have the HomeLens now which wraps around global searches (and emits standard search_finished), connecting to the global_search_finished is no longer relevant - moreover it will cause the callback to be called multiple times (for each lens doing global search) instead of just once when all the lenses finish searching.

[Gerry Boland (gerboland)]

Hi Pawel,
going for pixel perfection, can you move the text vertically to match the mock-up, see this comparison image I made:
http://ubuntuone.com/4m8iJRmwjae5fiXsJXsqf7

Comments:
+ UQ_DEBUG << "no-results-hint is" << m_noResultsHint;
is not really needed?

Also your test failed on me:
http://pastebin.ubuntu.com/900288/
because for some reason my Documents lens is not searching & always outputting the same data (so I can't test Home lens with zero results). Test looks fine, as I'm not sure how you can make that more robust.

review: Needs Fixing

[Gerry Boland (gerboland)]

Works great, thank you

review: Approve

[Unity Merger (unity-merger)]

No commit message specified.

=== modified file 'libunity-2d-private/src/lens.cpp'
--- libunity-2d-private/src/lens.cpp	2012-02-16 11:24:19 +0000
+++ libunity-2d-private/src/lens.cpp	2012-03-29 12:30:31 +0000
@@ -22,6 +22,7 @@
 
 // libunity-2d
 #include <debug_p.h>
+#include <unity2dtr.h>
 #include "application.h"
 #include "filters.h"
 
@@ -126,6 +127,11 @@
 {
     return m_globalSearchQuery;
 }
+    
+QString Lens::noResultsHint() const
+{
+    return m_noResultsHint;
+}
 
 void Lens::setViewType(const Lens::ViewType& viewType)
 {
@@ -159,6 +165,13 @@
         Q_EMIT globalSearchQueryChanged();
     }
 }
+    
+void Lens::setNoResultsHint(const QString& hint) {
+    if (hint != m_noResultsHint) {
+        m_noResultsHint = hint;
+        Q_EMIT noResultsHintChanged();
+    }
+}
 
 void Lens::activate(const QString& uri)
 {
@@ -263,6 +276,7 @@
     /* Signals forwarding */
     m_unityLens->search_finished.connect(sigc::mem_fun(this, &Lens::searchFinished));
     m_unityLens->global_search_finished.connect(sigc::mem_fun(this, &Lens::globalSearchFinished));
+    connect(this, SIGNAL(searchFinished(unity::dash::Lens::Hints const &)), SLOT(onSearchFinished(unity::dash::Lens::Hints const &)));
 
     /* FIXME: signal should be forwarded instead of calling the handler directly */
     m_unityLens->activated.connect(sigc::mem_fun(this, &Lens::onActivated));
@@ -321,5 +335,21 @@
 {
     Q_EMIT viewTypeChanged( (Lens::ViewType) viewType);
 }
+    
+void Lens::onSearchFinished(unity::dash::Lens::Hints const &hints)
+{
+    QString hint;
+
+    if (!m_unityLens->results()->count()) {
+        unity::dash::Lens::Hints::const_iterator it = hints.find("no-results-hint");
+        if (it != hints.end()) {
+            hint = QString::fromStdString(it->second.GetString());
+        } else {
+            hint = u2dTr("Sorry, there is nothing that matches your search.");
+        }
+    }
+
+    setNoResultsHint(hint);
+}
 
 #include "lens.moc"

=== modified file 'libunity-2d-private/src/lens.h'
--- libunity-2d-private/src/lens.h	2011-12-14 22:45:04 +0000
+++ libunity-2d-private/src/lens.h	2012-03-29 12:30:31 +0000
@@ -59,6 +59,7 @@
 
     Q_PROPERTY(QString searchQuery READ searchQuery WRITE setSearchQuery NOTIFY searchQueryChanged)
     Q_PROPERTY(QString globalSearchQuery READ globalSearchQuery WRITE setGlobalSearchQuery NOTIFY globalSearchQueryChanged)
+    Q_PROPERTY(QString noResultsHint READ noResultsHint WRITE setNoResultsHint NOTIFY noResultsHintChanged)
 
 public:
     explicit Lens(QObject *parent = 0);
@@ -88,11 +89,13 @@
     Filters* filters() const;
     QString searchQuery() const;
     QString globalSearchQuery() const;
+    QString noResultsHint() const;
 
     /* setters */
     void setViewType(const ViewType& viewType);
     void setSearchQuery(const QString& search_query);
     void setGlobalSearchQuery(const QString& search_query);
+    void setNoResultsHint(const QString& hint);
 
     Q_INVOKABLE void activate(const QString& uri);
     void setUnityLens(unity::dash::Lens::Ptr lens);
@@ -118,9 +121,11 @@
     void globalSearchFinished(unity::dash::Lens::Hints const&);
     void searchQueryChanged();
     void globalSearchQueryChanged();
+    void noResultsHintChanged();
 
 private Q_SLOTS:
     void synchronizeStates();
+    void onSearchFinished(unity::dash::Lens::Hints const &);
 
 private:
     void onResultsSwarmNameChanged(std::string);
@@ -140,6 +145,7 @@
     DeeListModel* m_categories;
     QString m_searchQuery;
     QString m_globalSearchQuery;
+    QString m_noResultsHint;
     Filters* m_filters;
 };
 

=== modified file 'shell/dash/LensView.qml'
--- shell/dash/LensView.qml	2012-03-13 20:29:15 +0000
+++ shell/dash/LensView.qml	2012-03-29 12:30:31 +0000
@@ -18,6 +18,7 @@
 
 import QtQuick 1.0
 import Unity2d 1.0
+import "../common"
 import "../common/utils.js" as Utils
 
 FocusScope {
@@ -66,6 +67,47 @@
         dash.activateUriWithLens(model, uri, mimetype)
     }
 
+    /* Optional 'No results...' hint for lens search results.
+     */
+    TextCustom {
+        id: noResultsText
+        objectName: "noResultsText"
+        fontSize: "large"
+        color: "white"
+        visible: lensView.model == undefined ? false : lensView.model.noResultsHint != ""
+        text: lensView.model != undefined ? lensView.model.noResultsHint : ""
+        anchors.centerIn: parent
+        anchors.verticalCenterOffset: -6
+
+        Connections {
+            target: lensView.model != undefined ? lensView.model : null
+            onSearchQueryChanged: {
+                if (noResultsText.visible) {
+                    hideNoResultHintAnimation.start()
+                }
+            }
+
+            onSearchFinished: {
+                hideNoResultHintAnimation.stop();
+                noResultsText.opacity = 1.0
+            }
+        }
+
+        Connections {
+            target: lensView != undefined ? lensView : null
+            onModelChanged: {
+                lensView.model.noResultsHint = "";
+            }
+        }
+
+        SequentialAnimation {
+            id: hideNoResultHintAnimation
+            PropertyAction { target: noResultsText; property: "opacity"; value: 1.0 }
+            PauseAnimation { duration: 150 }
+            NumberAnimation { target: noResultsText; property: "opacity"; from: 1.0; to: 0; duration: 150; easing.type: Easing.InOutQuad }
+        }
+    }
+
     ListViewWithScrollbar {
         id: results
 

=== modified file 'tests/dash/dash-tests.rb'
--- tests/dash/dash-tests.rb	2012-03-12 11:40:24 +0000
+++ tests/dash/dash-tests.rb	2012-03-29 12:30:31 +0000
@@ -7,6 +7,7 @@
  *
  * Authors:
  * - Albert Astals Cid <[e-mail]>
+ * - Pawel Stolowski <[e-mail]>
  *
  * 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
@@ -436,4 +437,55 @@
         @app.QDeclarativeLoader( { :objectName => "pageLoader" } )['activeFocus']
     }
   end
+
+  # Test case objectives:
+  #   * Check no-results-hint text is displayed in search yields no results
+  # Pre-conditions
+  # Test steps
+  #   * Invoke dash
+  #   * Verify there is no no-results-hint
+  #   * Type "qwqwqw" in the dash search entry
+  #   * Verify that the no-results-hint is displayed and its not empty
+  #   * Press Backspace 6 times to clear search entry
+  #   * Verify that hint is no longer visible
+  # Post-conditions
+  #   * None
+  # References
+  #   * https://bugs.launchpad.net/unity-2d/+bug/711199
+  test "Check no-results-hint is displayed on no search results" do
+    XDo::Keyboard.super
+  
+    verify_equal("true", TIMEOUT, 'There should be a Dash declarative view after pressing Super') {
+      @app.Dash()['active']
+    }
+
+    verify_not(TIMEOUT, 'There should be no noResultsText hint') {
+      @app.TextCustom( { :objectName => "noResultsText" } )
+    }
+
+    3.times {
+        XDo::Keyboard.q
+        XDo::Keyboard.w
+    }
+
+    hint = {}
+
+    verify(TIMEOUT, 'There should be noResultsText hint') {
+      hint = @app.TextCustom( { :objectName => "noResultsText" } )
+    }
+
+    verify_true(TIMEOUT, 'Hint should contain a message and be visible') {
+        hint['text'].length > 0 &&
+        hint['opacity'].to_f > 0.9 &&
+        hint['visible'] == "true"
+    }
+
+    6.times {
+        XDo::Keyboard.simulate("{BS}")
+    }
+
+    verify_not(TIMEOUT, 'There should be no noResultsText hint') {
+      @app.TextCustom( { :objectName => "noResultsText" } )
+    }
+  end
 end