Merge lp:~cimi/overlay-scrollbar/visual-connection into lp:overlay-scrollbar

[Andrea Cimitan]

Add a visual connection between pager and thumb when detached

[Ted Gould (ted)]

review: Approve

=== modified file 'os/os-pager.c'
--- os/os-pager.c	2011-04-27 00:44:09 +0000
+++ os/os-pager.c	2011-05-12 23:41:31 +0000
@@ -39,11 +39,14 @@
 
 struct _OsPagerPrivate {
   GdkWindow *pager_window;
+  GdkWindow *connection_window;
   GtkWidget *parent;
   GdkRectangle mask;
+  GdkRectangle connection_mask; /* in theory not needed, but easier to read. */
   GdkRectangle allocation;
   OsAnimation *animation;
   gboolean active;
+  gboolean detached;
   gboolean visible;
   gfloat weight;
   gint width;
@@ -57,6 +60,7 @@
 static void os_pager_change_state_cb (gfloat weight, gpointer user_data);
 static void os_pager_create (OsPager *pager);
 static void os_pager_draw (OsPager *pager);
+static void os_pager_draw_connection (OsPager *pager);
 static void os_pager_mask (OsPager *pager);
 static void os_pager_notify_gtk_theme_name_cb (GObject *object, GParamSpec* pspec, gpointer user_data);
 
@@ -85,7 +89,21 @@
 
   /* Instead reparenting,
    * which doesn't seem to work well,
-   * destroy the window. */
+   * destroy the two windows. */
+  if (priv->connection_window != NULL)
+    {
+      /* From the Gdk documentation:
+       * "Note that a window will not be destroyed
+       *  automatically when its reference count
+       *  reaches zero. You must call
+       *  gdk_window_destroy ()
+       *  yourself before that happens". */
+      gdk_window_destroy (priv->connection_window);
+
+      g_object_unref (priv->connection_window);
+      priv->connection_window = NULL;
+    }
+
   if (priv->pager_window != NULL)
     {
       /* From the Gdk documentation:
@@ -107,14 +125,30 @@
   attributes.visual = gtk_widget_get_visual (priv->parent);
   attributes.colormap = gtk_widget_get_colormap (priv->parent);
 
+  /* connection_window */
+  priv->connection_window = gdk_window_new (gtk_widget_get_window (priv->parent),
+                                            &attributes,
+                                            GDK_WA_VISUAL | GDK_WA_COLORMAP);
+
+  g_object_ref_sink (priv->connection_window);
+
+  gdk_window_set_transient_for (priv->connection_window,
+                                gtk_widget_get_window (priv->parent));
+
+  gdk_window_input_shape_combine_region (priv->connection_window,
+                                         gdk_region_new (),
+                                         0, 0);
+
+  /* pager_window */
   priv->pager_window = gdk_window_new (gtk_widget_get_window (priv->parent),
                                        &attributes,
                                        GDK_WA_VISUAL | GDK_WA_COLORMAP);
 
   g_object_ref_sink (priv->pager_window);
 
+  /* stay above the connection_window */
   gdk_window_set_transient_for (priv->pager_window,
-                                gtk_widget_get_window (priv->parent));
+                                priv->connection_window);
 
   gdk_window_input_shape_combine_region (priv->pager_window,
                                          gdk_region_new (),
@@ -137,10 +171,11 @@
   if (priv->parent == NULL)
     return;
 
+  os_pager_draw_connection (pager);
   os_pager_draw (pager);
 }
 
-/* Draw on the pager. */
+/* Draw on the pager_window. */
 static void
 os_pager_draw (OsPager *pager)
 {
@@ -179,7 +214,30 @@
   gdk_window_invalidate_rect (gtk_widget_get_window (priv->parent), &priv->allocation, TRUE);
 }
 
-/* Mask the pager. */
+/* Draw on the connection_window. */
+static void
+os_pager_draw_connection (OsPager *pager)
+{
+  GdkColor color;
+  OsPagerPrivate *priv;
+
+  priv = pager->priv;
+
+  /* 0.6 is taken from os_thumb_expose. */
+  color.red   = 65535 * 0.6;
+  color.green = 65535 * 0.6;
+  color.blue  = 65535 * 0.6;
+
+  gdk_colormap_alloc_color (gdk_drawable_get_colormap (priv->connection_window), &color, FALSE, TRUE);
+
+  gdk_window_set_background (priv->connection_window, &color);
+
+  gdk_window_clear (priv->connection_window);
+
+  gdk_window_invalidate_rect (gtk_widget_get_window (priv->parent), &priv->allocation, TRUE);
+}
+
+/* Mask the pager_window. */
 static void
 os_pager_mask (OsPager *pager)
 {
@@ -194,6 +252,21 @@
   gdk_window_clear (priv->pager_window);
 }
 
+/* Mask the connection_window. */
+static void
+os_pager_mask_connection (OsPager *pager)
+{
+  OsPagerPrivate *priv;
+
+  priv = pager->priv;
+
+  gdk_window_shape_combine_region (priv->connection_window,
+                                   gdk_region_rectangle (&priv->connection_mask),
+                                   0, 0);
+
+  gdk_window_clear (priv->connection_window);
+}
+
 static void
 os_pager_notify_gtk_theme_name_cb (GObject*    gobject,
                                    GParamSpec* pspec,
@@ -205,9 +278,12 @@
   pager = OS_PAGER (user_data);
   priv = pager->priv;
 
-  if (priv->parent == NULL || priv->pager_window == NULL)
+  if (priv->parent == NULL ||
+      priv->pager_window == NULL ||
+      priv->connection_window == NULL)
     return;
 
+  os_pager_draw_connection (pager);
   os_pager_draw (pager);
 }
 
@@ -249,9 +325,11 @@
   mask.width = 1;
   mask.height = 1;
 
+  priv->connection_mask = mask;
   priv->mask = mask;
 
   priv->active = FALSE;
+  priv->detached = FALSE;
   priv->visible = FALSE;
 
   priv->weight = 1.0f;
@@ -278,6 +356,20 @@
       priv->animation = NULL;
     }
 
+  if (priv->connection_window != NULL)
+    {
+      /* From the Gdk documentation:
+       * "Note that a window will not be destroyed
+       *  automatically when its reference count
+       *  reaches zero. You must call
+       *  gdk_window_destroy ()
+       *  yourself before that happens". */
+      gdk_window_destroy (priv->connection_window);
+
+      g_object_unref (priv->connection_window);
+      priv->connection_window = NULL;
+    }
+
   if (priv->pager_window != NULL)
     {
       /* From the Gdk documentation:
@@ -322,6 +414,34 @@
 }
 
 /**
+ * os_pager_connect:
+ * @pager: a #OsPager
+ * @mask: a #GdkRectangle with the position and dimension of the connection
+ *
+ * Moves and resizes connection.
+ **/
+void
+os_pager_connect (OsPager      *pager,
+                  GdkRectangle  mask)
+{
+  OsPagerPrivate *priv;
+
+  g_return_if_fail (OS_PAGER (pager));
+
+  priv = pager->priv;
+
+  if (!rectangle_changed (priv->connection_mask, mask))
+    return;
+
+  priv->connection_mask = mask;
+
+  if (priv->parent == NULL)
+    return;
+
+  os_pager_mask_connection (pager);
+}
+
+/**
  * os_pager_hide:
  * @pager: a #OsPager
  *
@@ -344,6 +464,7 @@
   /* if there's an animation currently running, stop it. */
   os_animation_stop (priv->animation);
 
+  gdk_window_hide (priv->connection_window);
   gdk_window_hide (priv->pager_window);
 }
 
@@ -419,6 +540,41 @@
 }
 
 /**
+ * os_pager_set_detached:
+ * @pager: a #OsPager
+ * @detached: whether the pager is detached or not
+ *
+ * Changes the detached state of @pager.
+ **/
+void
+os_pager_set_detached (OsPager *pager,
+                       gboolean detached)
+{
+  OsPagerPrivate *priv;
+
+  g_return_if_fail (OS_PAGER (pager));
+
+  priv = pager->priv;
+
+  if (priv->detached != detached)
+    {
+      priv->detached = detached;
+
+      if (priv->parent == NULL)
+        return;
+
+      if (priv->detached)
+        {
+          gdk_window_show (priv->connection_window);
+
+          gdk_window_clear (priv->connection_window);
+        }
+      else
+        gdk_window_hide (priv->connection_window);
+    }
+}
+
+/**
  * os_pager_set_parent:
  * @pager: a #OsPager
  * @parent: a #GtkWidget
@@ -453,9 +609,16 @@
       priv->weight = 1.0f;
 
       os_pager_create (pager);
+      os_pager_draw_connection (pager);
       os_pager_draw (pager);
       os_pager_mask (pager);
 
+      gdk_window_move_resize (priv->connection_window,
+                              priv->allocation.x,
+                              priv->allocation.y,
+                              priv->allocation.width,
+                              priv->allocation.height);
+
       gdk_window_move_resize (priv->pager_window,
                               priv->allocation.x,
                               priv->allocation.y,
@@ -521,6 +684,12 @@
   if (priv->parent == NULL)
     return;
 
+  gdk_window_move_resize (priv->connection_window,
+                          rectangle.x,
+                          rectangle.y,
+                          rectangle.width,
+                          rectangle.height);
+
   gdk_window_move_resize (priv->pager_window,
                           rectangle.x,
                           rectangle.y,

=== modified file 'os/os-private.h'
--- os/os-private.h	2011-05-06 15:46:50 +0000
+++ os/os-private.h	2011-05-12 23:41:31 +0000
@@ -208,12 +208,18 @@
 
 void     os_pager_hide          (OsPager *overlay);
 
+void     os_pager_connect       (OsPager     *overlay,
+                                 GdkRectangle mask);
+
 void     os_pager_move_resize   (OsPager     *overlay,
                                  GdkRectangle mask);
 
 void     os_pager_set_active    (OsPager *overlay,
                                  gboolean active);
 
+void     os_pager_set_detached  (OsPager *overlay,
+                                 gboolean detached);
+
 void     os_pager_set_parent    (OsPager   *pager,
                                  GtkWidget *parent);
 

=== modified file 'os/os-scrollbar.c'
--- os/os-scrollbar.c	2011-05-08 14:06:01 +0000
+++ os/os-scrollbar.c	2011-05-12 23:41:31 +0000
@@ -494,10 +494,8 @@
                                    gpointer user_data)
 {
   OsScrollbar *scrollbar;
-  OsScrollbarPrivate *priv;
 
   scrollbar = OS_SCROLLBAR (object);
-  priv = scrollbar->priv;
 
   os_scrollbar_swap_adjustment (scrollbar, gtk_range_get_adjustment (GTK_RANGE (object)));
 }
@@ -854,14 +852,12 @@
 {
   Display *display;
   OsScrollbar *scrollbar;
-  OsScrollbarPrivate *priv;
   XWindowChanges changes;
   guint32 xid, xid_parent;
   unsigned int value_mask = CWSibling | CWStackMode;
   int res;
 
   scrollbar = OS_SCROLLBAR (user_data);
-  priv = scrollbar->priv;
 
   xid = GDK_WINDOW_XID (gtk_widget_get_window (widget));
   xid_parent = GDK_WINDOW_XID (gtk_widget_get_window (GTK_WIDGET (scrollbar)));
@@ -1027,6 +1023,8 @@
   scrollbar = OS_SCROLLBAR (user_data);
   priv = scrollbar->priv;
 
+  priv->value_changed_event = TRUE;
+
   delta = os_scrollbar_get_wheel_delta (scrollbar, event->direction);
 
   gtk_adjustment_set_value (priv->adjustment,
@@ -1051,6 +1049,8 @@
   priv->button_press_event = FALSE;
   priv->motion_notify_event = FALSE;
   priv->enter_notify_event = FALSE;
+
+  os_pager_set_detached (OS_PAGER (priv->pager), FALSE);
 }
 
 /* Move the pager to the right position. */
@@ -1169,7 +1169,10 @@
     {
       /* if we're dragging the thumb, it can't be detached. */
       if (priv->motion_notify_event)
-        os_thumb_set_detached (OS_THUMB (priv->thumb), FALSE);
+        {
+          os_pager_set_detached (OS_PAGER (priv->pager), FALSE);
+          os_thumb_set_detached (OS_THUMB (priv->thumb), FALSE);
+        }
       else
         {
           gint x_pos, y_pos;
@@ -1177,19 +1180,73 @@
 
           if (priv->orientation == GTK_ORIENTATION_VERTICAL)
             {
-              if ((priv->win_y + priv->overlay.y > y_pos + priv->slider.height) ||
-                  (priv->win_y + priv->overlay.y + priv->overlay.height < y_pos))
-                os_thumb_set_detached (OS_THUMB (priv->thumb), TRUE);
-              else
-                os_thumb_set_detached (OS_THUMB (priv->thumb), FALSE);
+              if (priv->win_y + priv->overlay.y > y_pos + priv->slider.height)
+                {
+                  GdkRectangle mask;
+
+                  mask.x = 0;
+                  mask.y = y_pos + priv->slider.height / 2 - priv->win_y;
+                  mask.width = DEFAULT_PAGER_WIDTH;
+                  mask.height = priv->overlay.y - mask.y;
+
+                  os_pager_connect (OS_PAGER (priv->pager), mask);
+                  os_pager_set_detached (OS_PAGER (priv->pager), TRUE);
+
+                  os_thumb_set_detached (OS_THUMB (priv->thumb), TRUE);
+                }
+              else if (priv->win_y + priv->overlay.y + priv->overlay.height < y_pos)
+                {
+                  GdkRectangle mask;
+
+                  mask.x = 0;
+                  mask.y = priv->overlay.y + priv->overlay.height;
+                  mask.width = DEFAULT_PAGER_WIDTH;
+                  mask.height = y_pos + priv->slider.height / 2 - priv->win_y - mask.y;
+
+                  os_pager_connect (OS_PAGER (priv->pager), mask);
+                  os_pager_set_detached (OS_PAGER (priv->pager), TRUE);
+
+                  os_thumb_set_detached (OS_THUMB (priv->thumb), TRUE);
+                }
+              else 
+                {
+                  os_pager_set_detached (OS_PAGER (priv->pager), FALSE);
+                  os_thumb_set_detached (OS_THUMB (priv->thumb), FALSE);
+                }
             }
           else
             {
-              if ((priv->win_x + priv->overlay.x > x_pos + priv->slider.width) ||
-                  (priv->win_x + priv->overlay.x + priv->overlay.width < x_pos))
-                os_thumb_set_detached (OS_THUMB (priv->thumb), TRUE);
+              if (priv->win_x + priv->overlay.x > x_pos + priv->slider.width)
+                {
+                  GdkRectangle mask;
+
+                  mask.x = x_pos + priv->slider.width / 2 - priv->win_x;
+                  mask.y = 0;
+                  mask.width = priv->overlay.x - mask.x;
+                  mask.height = DEFAULT_PAGER_WIDTH;
+
+                  os_pager_connect (OS_PAGER (priv->pager), mask);
+                  os_pager_set_detached (OS_PAGER (priv->pager), TRUE);
+
+                  os_thumb_set_detached (OS_THUMB (priv->thumb), TRUE);
+                }
+              else if (priv->win_x + priv->overlay.x + priv->overlay.width < x_pos)
+                {
+                  GdkRectangle mask;
+
+                  mask.x = priv->overlay.y + priv->overlay.height;
+                  mask.y = 0;
+                  mask.width = x_pos + priv->slider.width / 2 - priv->win_x - mask.x;
+                  mask.height = DEFAULT_PAGER_WIDTH;
+
+                  os_pager_connect (OS_PAGER (priv->pager), mask);
+                  os_pager_set_detached (OS_PAGER (priv->pager), TRUE);                
+                }
               else
-                os_thumb_set_detached (OS_THUMB (priv->thumb), FALSE);
+                {
+                  os_pager_set_detached (OS_PAGER (priv->pager), FALSE);
+                  os_thumb_set_detached (OS_THUMB (priv->thumb), FALSE);
+                }
             }
         }
     }
@@ -1431,6 +1488,7 @@
                       os_scrollbar_move_thumb (scrollbar, priv->win_x, priv->win_y + priv->slider.y);
                     }
 
+                  os_pager_set_detached (OS_PAGER (priv->pager), FALSE);
                   os_thumb_set_detached (OS_THUMB (priv->thumb), FALSE);
                   gtk_widget_show (GTK_WIDGET (priv->thumb));
                 }
@@ -1471,6 +1529,7 @@
                       os_scrollbar_move_thumb (scrollbar, priv->win_x + priv->slider.x, priv->win_y);
                     }
 
+                  os_pager_set_detached (OS_PAGER (priv->pager), FALSE);
                   os_thumb_set_detached (OS_THUMB (priv->thumb), FALSE);
                   gtk_widget_show (GTK_WIDGET (priv->thumb));
                 }

=== modified file 'os/os-thumb.c'
--- os/os-thumb.c	2011-05-08 14:06:01 +0000
+++ os/os-thumb.c	2011-05-12 23:41:31 +0000
@@ -138,12 +138,9 @@
                       gpointer user_data)
 {
   OsThumb *thumb;
-  OsThumbPrivate *priv;
 
   thumb = OS_THUMB (user_data);
 
-  priv = thumb->priv;
-
   if (weight < 1.0f)
     gtk_window_set_opacity (GTK_WINDOW (thumb), fabs (weight - 1.0f));
   else
@@ -379,7 +376,6 @@
                  GdkEventExpose *event)
 {
   GtkAllocation allocation;
-  GtkStateType state_type_down, state_type_up;
   GtkStyle *style;
   OsThumb *thumb;
   OsThumbPrivate *priv;
@@ -393,9 +389,6 @@
   thumb = OS_THUMB (widget);
   priv = thumb->priv;
 
-  state_type_down = GTK_STATE_NORMAL;
-  state_type_up = GTK_STATE_NORMAL;
-
   gtk_widget_get_allocation (widget, &allocation);
 
   x = 0;
@@ -445,7 +438,6 @@
       if ((priv->orientation == GTK_ORIENTATION_VERTICAL && (priv->pointer_y < height / 2)) ||
           (priv->orientation == GTK_ORIENTATION_HORIZONTAL && (priv->pointer_x < width / 2)))
         {
-          state_type_up = GTK_STATE_ACTIVE;
           cairo_pattern_add_color_stop_rgba (pat, 0.0, 0.8, 0.8, 0.8, 0.8);
           cairo_pattern_add_color_stop_rgba (pat, 0.49, 1.0, 1.0, 1.0, 0.0);
           cairo_pattern_add_color_stop_rgba (pat, 0.49, 0.8, 0.8, 0.8, 0.5);
@@ -453,7 +445,6 @@
         }
       else
         {
-          state_type_down = GTK_STATE_ACTIVE;
           cairo_pattern_add_color_stop_rgba (pat, 0.0, 1.0, 1.0, 1.0, 0.8);
           cairo_pattern_add_color_stop_rgba (pat, 0.49, 1.0, 1.0, 1.0, 0.0);
           cairo_pattern_add_color_stop_rgba (pat, 0.49, 0.8, 0.8, 0.8, 0.5);