Merge lp:~unity-team/unity/collapsing-place-groups into lp:unity

[Neil J. Patel]

- Add an expandable bin actor that had three states, CLOSED (hidden), UNEXPANDED (open to a certian height) and EXPANDED (open to the height requested by children). It animates between the three states

- Add support for the auto-fade iconview property

- Adds incredibly lazy icon and text loading by deferring loading to the last possible point. Using the new api from the iconview, the DefaultRendererGroup will only request icons to load on the number of visible Tiles in the unexpanded state. When the user hovers over the group header (so they can click to open the group), the group will ask the rest of the tiles to load their icons. This speeds up the rendering time of places tremendously on netbooks.

- There are lot's of other fixes for places

**** YOU REQUIRE lp:~unity-team/clutk/icon-view-auto-fade-children FOR THIS TO WORK PROPERLY ****

[Neil J. Patel (njpatel)]

The clutk branch has been merged into trunk, so just grab lp:clutk to test this work

[Jay Taoko (jaytaoko)]

Tested and Approved!

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2010-07-07 09:12:51 +0000
+++ .bzrignore	2010-07-07 09:12:51 +0000
@@ -321,3 +321,4 @@
 tests/unit/test-io.c
 unity/unity-appinfo-manager.c
 unity/unity-io.c
+unity/unity-expanding-bin.c
 
=== modified file 'unity-private/places/places-default-renderer-group.vala'
--- unity-private/places/places-default-renderer-group.vala	2010-07-07 09:12:51 +0000
+++ unity-private/places/places-default-renderer-group.vala	2010-07-07 09:12:51 +0000
@@ -19,9 +19,9 @@
 
 namespace Unity.Places
 {
-  public class DefaultRendererGroup : Ctk.Box
+  public class DefaultRendererGroup : ExpandingBin
   {
-    static const float PADDING = 0.0f;
+    static const float PADDING = 24.0f;
     static const int   SPACING = 0;
 
     public uint      group_id       { get; construct; }
@@ -30,12 +30,17 @@
     public string    icon_hint      { get; construct; }
     public Dee.Model results        { get; construct; }
 
+    private Ctk.VBox      vbox;
     private Ctk.HBox      title_box;
     private Ctk.Image     icon;
     private Ctk.Text      text;
     private Ctk.Image     expander;
     private Ctk.IconView  renderer;
 
+    /* Some caching to speed up lookups */
+    private uint          n_results = 0;
+    private bool          dirty = false;
+
     public DefaultRendererGroup (uint      group_id,
                                  string    group_renderer,
                                  string    display_name,
@@ -51,17 +56,22 @@
 
     construct
     {
-      padding = { PADDING, PADDING, PADDING , PADDING};
-      orientation = Ctk.Orientation.VERTICAL;
-      spacing = SPACING;
-      homogeneous = false;
+      padding = { 0.0f, 0.0f, PADDING , 0.0f};
       hide ();
 
-      title_box = new Ctk.HBox (8);
-      pack (title_box, false, false);
+      vbox = new Ctk.VBox (SPACING);
+      vbox.spacing = SPACING;
+      vbox.homogeneous = false;
+      add_actor (vbox);
+      vbox.show ();
+
+      title_box = new Ctk.HBox (5);
+      vbox.pack (title_box, false, false);
       title_box.show ();
+      title_box.reactive = true;
 
-      icon = new Ctk.Image (24);
+      icon = new Ctk.Image (22);
+      icon.set_from_filename (PKGDATADIR + "/favourites.png");
       title_box.pack (icon, false, false);
       icon.show ();
 
@@ -69,20 +79,53 @@
       title_box.pack (text, true, true);
       text.show ();
 
-      expander = new Ctk.Image (24);
+      expander = new Ctk.Image (22);
+      expander.set_from_filename (PKGDATADIR + "/maximize_up.png");
+      expander.opacity = 0;
       title_box.pack (expander, false, true);
       expander.show ();
 
-      var sep = new Clutter.Rectangle.with_color ({ 255, 255, 255, 255 });
-      sep.set_height (1);
-      pack (sep, false, false);
-      sep.show ();
+      var rect = new Clutter.Rectangle.with_color ({ 255, 255, 255, 255 });
+      rect.height = 1;
+      vbox.pack (rect, false, false);
+      rect.show ();
+
+      title_box.button_release_event.connect (() => {
+        if (n_results <= renderer.get_n_cols ())
+          return true;
+
+        if (bin_state == ExpandingBinState.UNEXPANDED)
+          {
+            bin_state = ExpandingBinState.EXPANDED;
+            expander.set_from_filename (PKGDATADIR + "/minimize_up.png");
+          }
+        else
+          {
+            bin_state = ExpandingBinState.UNEXPANDED;
+            expander.set_from_filename (PKGDATADIR + "/maximize_up.png");
+          }
+        return true;
+      });
+      title_box.motion_event.connect (() => {
+        if (dirty)
+          {
+            var children = renderer.get_children ();
+            foreach (Clutter.Actor child in children)
+              {
+                Tile tile = child as Tile;
+                tile.about_to_show ();
+              }
+              dirty = false;
+          }
+      });
 
       renderer = new Ctk.IconView ();
       renderer.padding = { 12.0f, 0.0f, 0.0f, 0.0f };
       renderer.spacing = 24;
-      pack (renderer, true, true);
+      vbox.pack (renderer, true, true);
       renderer.show ();
+      renderer.set ("auto-fade-children", true);
+      renderer.notify["n-cols"].connect (on_n_cols_changed);
 
       unowned Dee.ModelIter iter = results.get_first_iter ();
       while (!results.is_last (iter))
@@ -97,21 +140,22 @@
       results.row_removed.connect (on_result_removed);
     }
 
-    private override void get_preferred_height (float for_width,
-                                           out float min_height,
-                                           out float nat_height)
+    private override void allocate (Clutter.ActorBox        box,
+                                    Clutter.AllocationFlags flags)
     {
+      base.allocate (box, flags);
+
+      /* Update the unexpanded height if necessary */
+      /* FIXME: Can we please add some nice methods to CluTK which allow
+       * doing something like $clutk_container.get_nth_child (), and so
+       * bypass the stupid get_children stuff. In any case, cache the result
+       */
       var children = renderer.get_children ();
-      if (children.length () > 0)
-        {
-          base.get_preferred_height (for_width, out min_height, out nat_height);
-          show ();
-        }
-      else
-        {
-          min_height = 0;
-          nat_height = 0;
-          hide ();
+      var child = children.nth_data (0) as Clutter.Actor;
+      if (child is Clutter.Actor &&
+          child.height != unexpanded_height)
+        {
+          unexpanded_height = title_box.height + 1.0f + child.height;
         }
     }
 
@@ -132,7 +176,15 @@
       renderer.add_actor (button);
       button.show ();
 
-      show ();
+      add_to_n_results (1);
+
+      if (bin_state == ExpandingBinState.CLOSED)
+        {
+          bin_state = ExpandingBinState.UNEXPANDED;
+          show ();
+        }
+
+      dirty = true;
     }
 
     private void on_result_removed (Dee.ModelIter iter)
@@ -148,18 +200,62 @@
           if (tile.iter == iter)
             {
               actor.destroy ();
+              add_to_n_results (-1);
               break;
             }
         }
 
-      if (children.length () <= 1)
-        hide ();
+      if (n_results < 1)
+        {
+          bin_state = ExpandingBinState.CLOSED;
+        }
     }
 
     private bool interesting (Dee.ModelIter iter)
     {
       return (results.get_uint (iter, 2) == group_id);
     }
+
+    private void add_to_n_results (int i)
+    {
+      n_results += i;
+
+      if (n_results > renderer.get_n_cols ())
+        {
+          expander.animate (Clutter.AnimationMode.EASE_IN_SINE, 200,
+                            "opacity", 255);
+        }
+      else
+        {
+          expander.animate (Clutter.AnimationMode.EASE_IN_SINE, 200,
+                            "opacity", 0);
+        }
+    }
+
+    private void on_n_cols_changed ()
+    {
+      var n_cols = renderer.get_n_cols ();
+
+      if (bin_state == ExpandingBinState.UNEXPANDED)
+        {
+          var children = renderer.get_children ();
+          int i = 0;
+
+          foreach (Clutter.Actor child in children)
+            {
+              Tile tile = child as Tile;
+              if (i < n_cols)
+                {
+                  tile.about_to_show ();
+                  i++;
+                }
+              else
+                break;
+            }
+        }
+
+      add_to_n_results (0);
+    }
   }
 
   public class Tile : Ctk.Button
@@ -175,6 +271,8 @@
     public string? mimetype     { get; construct; }
     public string? comment      { get; construct; }
 
+    private bool shown = false;
+
     public Tile (Dee.ModelIter iter,
                  string        uri,
                  string?       icon_hint,
@@ -193,11 +291,17 @@
 
     construct
     {
-      set_label (display_name);
-
       unowned Ctk.Text text = get_text ();
       text.ellipsize = Pango.EllipsizeMode.END;
-
+    }
+
+    public void about_to_show ()
+    {
+      if (shown)
+        return;
+      shown = true;
+
+      set_label (display_name);
       set_icon ();
     }
 
@@ -226,7 +330,6 @@
           try {
             var appinfos = AppInfoManager.get_instance ();
             info = yield appinfos.lookup_async (id);
-            debug ("Foo: %s", info.get_name());
           } catch (Error ee) {
             warning ("Unable to read .desktop file '%s': %s", uri, ee.message);
             return;
@@ -236,7 +339,6 @@
             {
               try {
                 info.launch (null,null);
-                debug ("Launched");
               } catch (Error e) {
                 warning ("Unable to launch desktop file %s: %s\n",
                          id,
 
=== modified file 'unity-private/places/places-default-renderer.vala'
--- unity-private/places/places-default-renderer.vala	2010-07-01 13:50:01 +0000
+++ unity-private/places/places-default-renderer.vala	2010-07-07 09:12:51 +0000
@@ -22,7 +22,7 @@
   public class DefaultRenderer : Ctk.ScrollView, Unity.Place.Renderer
   {
     static const float PADDING = 12.0f;
-    static const int   SPACING = 12;
+    static const int   SPACING = 0;
 
     private Ctk.VBox box;
     private Dee.Model groups_model;
 
=== modified file 'unity-private/places/places-place-search-bar.vala'
--- unity-private/places/places-place-search-bar.vala	2010-06-24 07:43:05 +0000
+++ unity-private/places/places-place-search-bar.vala	2010-07-07 09:12:51 +0000
@@ -62,6 +62,11 @@
       bg.show ();
     }
 
+    public void reset ()
+    {
+      entry.reset ();
+    }
+
     private override void allocate (Clutter.ActorBox        box,
                                     Clutter.AllocationFlags flags)
     {
@@ -94,7 +99,7 @@
       nat_height = nheight + SPACING * 3;
     }
 
-    private void on_search_text_changed (string text)
+    private void on_search_text_changed (string? text)
     {
       if (active_entry is PlaceEntry)
         {
 
=== modified file 'unity-private/places/places-place-search-entry.vala'
--- unity-private/places/places-place-search-entry.vala	2010-07-01 14:22:01 +0000
+++ unity-private/places/places-place-search-entry.vala	2010-07-07 09:12:51 +0000
@@ -23,7 +23,7 @@
   {
     static const string SEARCH_ICON_FILE = PKGDATADIR + "/search_icon.png";
     static const float  PADDING = 1.0f;
-    static const int    LIVE_SEARCH_TIMEOUT = 300; /* Milliseconds */
+    static const int    LIVE_SEARCH_TIMEOUT = 200; /* Milliseconds */
     const Clutter.Color nofocus_color = { 0xff, 0xff, 0xff, 0xbb };
     const Clutter.Color focus_color   = { 0xff, 0xff, 0xff, 0xff };
 
@@ -32,9 +32,9 @@
     public ThemeImage right_icon;
 
     private uint live_search_timeout = 0;
-    private string _static_text = "Search";
+    private string _static_text = _("Search");
 
-    public signal void text_changed (string text);
+    public signal void text_changed (string? text);
 
     public PlaceSearchEntry ()
     {
@@ -89,7 +89,7 @@
         Source.remove (live_search_timeout);
 
       live_search_timeout = Timeout.add (LIVE_SEARCH_TIMEOUT, () => {
-        text_changed (text.text);
+        text_changed (text.text == _static_text ? "" : text.text);
         live_search_timeout = 0;
 
         return false;
@@ -99,21 +99,24 @@
     private void on_key_focus_in ()
     {
       if (text.text == _static_text)
-        {
           text.set_text ("");
-          text.cursor_visible = true;
-          text.set_selection (0, -1);
-          text.color = focus_color;
-        }
+
+      text.cursor_visible = true;
+      text.color = focus_color;
     }
 
     private void on_key_focus_out ()
     {
 
       text.cursor_visible = false;
+      text.color = nofocus_color;
+    }
+
+    public void reset ()
+    {
+      text.cursor_visible = false;
+      text.color = nofocus_color;
       text.text = _static_text;
-      text.color = nofocus_color;
-
     }
   }
 }
 
=== modified file 'unity-private/places/places-view.vala'
--- unity-private/places/places-view.vala	2010-07-01 13:50:01 +0000
+++ unity-private/places/places-view.vala	2010-07-07 09:12:51 +0000
@@ -52,7 +52,10 @@
     public void about_to_show ()
     {
       if (_model is PlaceFileModel)
-        return;
+        {
+          search_bar.reset ();
+          return;
+        }
 
       _model = new PlaceFileModel () as PlaceModel;
 
 
=== modified file 'unity-private/testing/test-window.vala'
--- unity-private/testing/test-window.vala	2010-07-07 09:12:51 +0000
+++ unity-private/testing/test-window.vala	2010-07-07 09:12:51 +0000
@@ -300,12 +300,14 @@
         {
           this.showing_places = false;
           this.panel.set_indicator_mode (true);
+          this.background.opacity = 160;
           this.places.opacity = 255;
         }
       else
         {
           this.showing_places = true;
           this.panel.set_indicator_mode (false);
+          this.background.opacity = 255;
           this.places.opacity = 0;
         }
 
@@ -318,6 +320,7 @@
         {
           showing_places = true;
           panel.set_indicator_mode (false);
+          background.opacity = 255;
           places.opacity = 0;
         }
     }
 
=== modified file 'unity/Makefile.am'
--- unity/Makefile.am	2010-07-01 15:22:49 +0000
+++ unity/Makefile.am	2010-07-07 09:12:51 +0000
@@ -70,6 +70,7 @@
   theme.vala \
   unity-appinfo-manager.vala \
   unity-cairo-canvas.vala \
+  unity-expanding-bin.vala \
   unity-favorites.vala \
   unity-io.vala \
   unity-pixbuf-cache.vala \
 
=== added file 'unity/unity-expanding-bin.vala'
--- unity/unity-expanding-bin.vala	1970-01-01 00:00:00 +0000
+++ unity/unity-expanding-bin.vala	2010-07-07 09:12:51 +0000
@@ -0,0 +1,179 @@
+/*
+ * Copyright (C) 2010 Canonical, Ltd.
+ *
+ * This library is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License
+ * version 3.0 as published by the Free Software Foundation.
+ *
+ * This library 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 Lesser General Public License version 3.0 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see
+  <http://www.gnu.org/licenses/>.
+ *
+ * Authored by Neil Jagdish Patel <[e-mail]>
+ */
+
+using GLib;
+
+namespace Unity
+{
+  public enum ExpandingBinState
+  {
+    CLOSED,
+    UNEXPANDED,
+    EXPANDED
+  }
+
+  public class ExpandingBin : Ctk.Bin
+  {
+    public static const int ANIMATION_TIME = 200;
+    /*
+     * Properties
+     */
+    public float size_factor {
+      get { return _size_factor; }
+      set { _size_factor = value; queue_relayout (); }
+    }
+
+    public ExpandingBinState bin_state {
+      get { return _state; }
+      set { _change_state (value); }
+    }
+
+    public float unexpanded_height {
+      get { return _unexpanded_height; }
+      set {
+        if (_unexpanded_height != value)
+          {
+            _unexpanded_height = value;
+
+            if (_state == ExpandingBinState.UNEXPANDED)
+              {
+                _state = ExpandingBinState.CLOSED;
+                _change_state (ExpandingBinState.UNEXPANDED);
+              }
+          }
+      }
+    }
+
+    private float             _size_factor = 0.0f;
+    private ExpandingBinState _state = ExpandingBinState.CLOSED;
+    private ExpandingBinState _old_state = ExpandingBinState.CLOSED;
+    private float             _unexpanded_height = 100.0f;
+    private float             _expanded_height   = 0.0f;
+    private float             _target_height     = 0.0f;
+
+    private float last_height;
+    private float last_width;
+
+    /*
+     * Construction
+     */
+    public ExpandingBin ()
+    {
+      Object ();
+    }
+
+    construct
+    {
+    }
+
+    /*
+     * Private Methods
+     */
+    private override void allocate (Clutter.ActorBox        box,
+                                    Clutter.AllocationFlags flags)
+    {
+      float x = padding.left;
+      float y = padding.top;
+      float width = Math.floorf (box.x2 - box.x1) - padding.left - padding.right;
+      Clutter.ActorBox child_box = Clutter.ActorBox ();
+      child_box.x1 = x;
+      child_box.x2 = x + width;
+      child_box.y1 = y;
+      child_box.y2 = y + last_height + ((_target_height - last_height) * _size_factor);
+
+      base.allocate (box, flags);
+      get_child ().allocate (child_box, flags);
+
+      last_height = child_box.y2 - child_box.y1;
+      last_width = child_box.x2 - child_box.x1;
+    }
+
+    private override void get_preferred_height (float     for_width,
+                                                out float min_height,
+                                                out float nat_height)
+    {
+      var vpadding = padding.top + padding.bottom;
+
+      get_child ().get_preferred_height (last_width, null, out _expanded_height);
+      if (_state == ExpandingBinState.CLOSED)
+        {
+          _target_height = 0.0f;
+        }
+      else if (_state == ExpandingBinState.UNEXPANDED)
+        {
+          _target_height = _unexpanded_height + vpadding;
+        }
+      else
+        {
+          _target_height = _expanded_height + vpadding;
+        }
+
+      min_height = last_height + ((_target_height - last_height) *_size_factor);
+      nat_height = last_height + ((_target_height - last_height) *_size_factor);
+    }
+
+    private void _change_state (ExpandingBinState new_state)
+    {
+      if (_state == new_state)
+        return;
+
+      _old_state = _state;
+      _state = new_state;
+
+      _size_factor = 0.0f;
+      switch (_state)
+        {
+        case ExpandingBinState.CLOSED:
+          var anim = animate (Clutter.AnimationMode.EASE_OUT_SINE, ANIMATION_TIME,
+                   "size_factor", 1.0f,
+                   "opacity", 0);
+          _target_height = 0.0f;
+
+          anim.completed.connect (() => {
+            if (_state == ExpandingBinState.CLOSED)
+              hide ();
+          });
+          break;
+
+        case ExpandingBinState.UNEXPANDED:
+          animate (_old_state == ExpandingBinState.CLOSED ? Clutter.AnimationMode.EASE_IN_SINE
+                                                         : Clutter.AnimationMode.EASE_OUT_SINE,
+                   ANIMATION_TIME,
+                   "size_factor", 1.0f,
+                   "opacity", 255);
+          _target_height = _unexpanded_height;
+          show ();
+          break;
+
+        case ExpandingBinState.EXPANDED:
+          animate (Clutter.AnimationMode.EASE_IN_SINE, ANIMATION_TIME,
+                   "size_factor", 1.0f,
+                   "opacity", 255);
+          get_child ().get_preferred_height (width, null, out _expanded_height);
+          _target_height = _expanded_height;
+          show ();
+          break;
+
+        default:
+          warning ("ExpandingBinState %d not supported", _state);
+          break;
+        }
+    }
+  }
+}
 
=== modified file 'unity/unity-pixbuf-cache.vala'
--- unity/unity-pixbuf-cache.vala	2010-07-01 14:02:24 +0000
+++ unity/unity-pixbuf-cache.vala	2010-07-07 09:12:51 +0000
@@ -157,36 +157,50 @@
 
       if (ret == null)
         {
-          try {
-            unowned GLib.Icon icon = GLib.Icon.new_for_string (gicon_as_string);
-            var info = theme.lookup_by_gicon (icon, size, 0);
-            if (info != null)
-              ret = info.load_icon ();
-
-            if (ret == null)
-              {
-                /* There is some funkiness in some programs where they install
-                 * their icon to /usr/share/icons/hicolor/apps/, but they
-                 * name the Icon= key as `foo.$extension` which breaks loading
-                 * So we can try and work around that here.
-                 */
-                if (gicon_as_string.has_suffix (".png")
-                    || gicon_as_string.has_suffix (".xpm")
-                    || gicon_as_string.has_suffix (".gir")
-                    || gicon_as_string.has_suffix (".jpg"))
+          if (gicon_as_string[0] == '/')
+            {
+              try {
+                ret = new Gdk.Pixbuf.from_file (gicon_as_string);
+              } catch (Error err) {
+                message (@"Unable to load $gicon_as_string as file: %s",
+                         err.message);
+              }
+            }
+
+          if (ret == null)
+            {
+              try {
+                unowned GLib.Icon icon = GLib.Icon.new_for_string (gicon_as_string);
+                var info = theme.lookup_by_gicon (icon, size, 0);
+                if (info != null)
+                  ret = info.load_icon ();
+
+                if (ret == null)
                   {
-                    string real_name = gicon_as_string[0:gicon_as_string.length-4];
-                    ret = theme.load_icon (real_name, size, 0);
+                    /* There is some funkiness in some programs where they install
+                     * their icon to /usr/share/icons/hicolor/apps/, but they
+                     * name the Icon= key as `foo.$extension` which breaks loading
+                     * So we can try and work around that here.
+                     */
+                    if (gicon_as_string.has_suffix (".png")
+                        || gicon_as_string.has_suffix (".xpm")
+                        || gicon_as_string.has_suffix (".gir")
+                        || gicon_as_string.has_suffix (".jpg"))
+                      {
+                        string real_name = gicon_as_string[0:gicon_as_string.length-4];
+                        ret = theme.load_icon (real_name, size, 0);
+                      }
                   }
-              }
-
-            if (ret is Pixbuf)
-              {
-                cache[key] = ret;
-              }
-          } catch (Error e) {
-            warning (@"Unable to load icon $gicon_as_string: '%s'", e.message);
-          }
+
+              } catch (Error e) {
+                warning (@"Unable to load icon $gicon_as_string: '%s'", e.message);
+              }
+            }
+
+          if (ret is Pixbuf)
+            {
+              cache[key] = ret;
+            }
         }
 
       if (ret is Pixbuf)
 
=== modified file 'vapi/clutk-0.3.vapi'
--- vapi/clutk-0.3.vapi	2010-03-25 13:26:16 +0000
+++ vapi/clutk-0.3.vapi	2010-07-07 09:12:51 +0000
@@ -162,8 +162,14 @@
 	public class IconView : Ctk.Actor, Clutter.Scriptable, Ctk.Focusable, Clutter.Container {
 		[CCode (type = "ClutterActor*", has_construct_function = false)]
 		public IconView ();
+		public uint get_n_cols ();
+		public uint get_n_rows ();
 		public int get_spacing ();
 		public void set_spacing (int spacing);
+		[NoAccessorMethod]
+		public bool auto_fade_children { get; set construct; }
+		public uint n_cols { get; }
+		public uint n_rows { get; }
 		public int spacing { get; set construct; }
 	}
 	[CCode (cheader_filename = "clutk/clutk.h")]