Merge lp:~victored/granite/thin-paned-gtk-3-13 into lp:~elementary-pantheon/granite/granite

[Victor Martinez]

Disable ThinPaned's features with Gtk 3.13, to make it act like a normal GtkPaned.

The style class "thin-paned" will also be present in ThinPaned with Gtk 3.13+

GTK+ 3.13 supports defining overlay pane separator handles from the theme, and ThinPaned will be deprecated in favor of that.

As it seems we're still unsure whether we will be shipping GTK+ 3.12 or 3.14 in Freya, I've added a runtime check to ThinPaned to make the same Granite binary work with both versions.

Basically what this does is disabling ThinPaned's overlay GdkWindow, handle-drawing code, and event handling, so it doesn't override the behavior provided by GtkPaned in GTK+ 3.13.

Notice that ThinPaned adds the style class "thin-paned" with GTK+ 3.13, which can be used as follows:

/* this will match the entire GtkPaned widget */
.thin-paned {
    -GtkPaned-handle-size: 1px;
    border-width: 0;

    /*
     the handle's margins are applied to the entire paned and not the
     pane-separator class, as that one is only used for drawing purposes
    */

    /* additional invisible pixels to add above pane separator for vertically-stacked panes */
    margin-top: 3px;

    /* additional invisible pixels to add below pane separator for vertically-stacked panes */
    margin-bottom: 2px;

    /* additional invisible pixels to add on left side of the pane separator for horizontally-stacked panes */
    margin-left: 2px; /* avoid conflicting with scrollbar */

    /* additional invisible pixels to add on right side of the pane separator for horizontally-stacked panes */
    margin-right: 4px;

    /* optionally, we could simply use 'margin' */
    margin: 3px;
}

/* theme pane separator */
.thin-paned.pane-separator {
   background-color: black;
   border-width: 0;
}

[Victor Martinez (victored)]

This branch is no longer relevant, as it seems we'll simply wait for the release of GTK+ 3.14.

Let's do a clean deprecation when the time comes.

review: Disapprove

Unmerged revisions

742. By Victor Martinez on 2014-06-22

Add runtime check for GTK+ 3.13 or newer, and make ThinPaned behave as a normal GtkPaned with a style class called "thin-paned".

ThinPaned behaves as usual with Gtk 3.12 or older.

=== modified file 'lib/Widgets/ThinPaned.vala'
--- lib/Widgets/ThinPaned.vala	2014-04-04 03:47:51 +0000
+++ lib/Widgets/ThinPaned.vala	2014-06-22 17:48:43 +0000
@@ -52,6 +52,7 @@
 
     private Gdk.Window overlay_handle;
     private bool in_resize = false;
+    private bool use_legacy_gdk_window;
 
     static construct {
         install_style_property (new ParamSpecInt (STYLE_PROP_OVERLAY_HANDLE_SIZE,
@@ -63,17 +64,30 @@
 
     public ThinPaned (Gtk.Orientation orientation = Gtk.Orientation.HORIZONTAL) {
         this.orientation = orientation;
-        Utils.set_theming (this, DEFAULT_STYLESHEET, null, Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION);
-        Utils.set_theming (this, FALLBACK_STYLESHEET, null, Gtk.STYLE_PROVIDER_PRIORITY_THEME);
+
+        // GtkPaned is already capable of showing an overlay handle since version 3.13,
+        // so we disable ThinPaned's features at runtime when this version is detected,
+        // at least until our widget is properly deprecated.
+        use_legacy_gdk_window = (Gtk.get_minor_version () < 13);
+
+        if (use_legacy_gdk_window) {
+            Utils.set_theming (this, DEFAULT_STYLESHEET, null, Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION);
+            Utils.set_theming (this, FALLBACK_STYLESHEET, null, Gtk.STYLE_PROVIDER_PRIORITY_THEME);
+        } else {
+            get_style_context ().add_class (StyleClass.THIN_PANED);
+        }
     }
 
     public unowned Gdk.Window get_overlay_handle_window () {
-        return overlay_handle;
+        return use_legacy_gdk_window ? overlay_handle : get_handle_window ();
     }
 
     public override void realize () {
         base.realize ();
 
+        if (!use_legacy_gdk_window)
+            return;
+
         // Create invisible overlay handle
         var attributes = Gdk.WindowAttr ();
 
@@ -105,27 +119,34 @@
 
     public override void unrealize () {
         base.unrealize ();
-        overlay_handle.set_user_data (null);
-        overlay_handle.destroy ();
-        overlay_handle = null;
+
+        if (use_legacy_gdk_window) {
+            overlay_handle.set_user_data (null);
+            overlay_handle.destroy ();
+            overlay_handle = null;
+        }
     }
 
     public override void map () {
         base.map ();
-        overlay_handle.show ();
+
+        if (use_legacy_gdk_window)
+            overlay_handle.show ();
     }
 
     public override void unmap () {
         base.unmap ();
-        overlay_handle.hide ();
+
+        if (use_legacy_gdk_window)
+            overlay_handle.hide ();
     }
 
     public override bool draw (Cairo.Context ctx) {
-        base.draw (ctx);
+        bool rv = base.draw (ctx);
 
         // if the overlay handle is not visible, don't draw a pane separator.
-        if (!overlay_handle.is_visible ())
-            return false;
+        if (!use_legacy_gdk_window || !overlay_handle.is_visible ())
+            return rv;
 
         Gtk.Allocation allocation;
         get_allocation (out allocation);
@@ -171,7 +192,9 @@
 
     public override void size_allocate (Gtk.Allocation allocation) {
         base.size_allocate (allocation);
-        update_overlay_handle ();
+
+        if (use_legacy_gdk_window)
+            update_overlay_handle ();
     }
 
     private void update_overlay_handle () {
@@ -212,7 +235,7 @@
     public override void state_flags_changed (Gtk.StateFlags previous_state) {
         base.state_flags_changed (previous_state);
 
-        if (get_realized ()) {
+        if (use_legacy_gdk_window && get_realized ()) {
             var default_handle_cursor = get_handle_window ().get_cursor ();
             if (overlay_handle.get_cursor () != default_handle_cursor)
                 overlay_handle.set_cursor (default_handle_cursor);
@@ -220,7 +243,7 @@
     }
 
     public override bool motion_notify_event (Gdk.EventMotion event) {
-        if (!in_resize)
+        if (!use_legacy_gdk_window || !in_resize)
             return base.motion_notify_event (event);
 
         var device = event.device ?? Gtk.get_current_event_device ();
@@ -257,7 +280,8 @@
     }
 
     public override bool button_press_event (Gdk.EventButton event) {
-        if (!in_resize && event.button == Gdk.BUTTON_PRIMARY && event.window == overlay_handle) {
+        if (use_legacy_gdk_window && !in_resize && event.button == Gdk.BUTTON_PRIMARY
+            && event.window == overlay_handle) {
             in_resize = true;
             Gtk.grab_add (this);
             return true;
@@ -267,7 +291,7 @@
     }
 
     public override bool button_release_event (Gdk.EventButton event) {
-        if (event.window == overlay_handle) {
+        if (use_legacy_gdk_window && event.window == overlay_handle) {
             in_resize = false;
             Gtk.grab_remove (this);
             return true;
@@ -277,7 +301,9 @@
     }
 
     public override bool grab_broken_event (Gdk.EventGrabBroken event) {
-        in_resize = false;
+        if (use_legacy_gdk_window)
+            in_resize = false;
+
         return base.grab_broken_event (event);
     }
-}
+}
 \ No newline at end of file
 
=== modified file 'lib/style-classes.vala'
--- lib/style-classes.vala	2014-04-18 19:35:30 +0000
+++ lib/style-classes.vala	2014-06-22 17:48:43 +0000
@@ -28,6 +28,7 @@
     public const string POPOVER = "popover";
     public const string POPOVER_BG = "popover_bg";
     public const string HELP_BUTTON = "help_button";
+    public const string THIN_PANED = "thin-paned";
     public const string THIN_PANE_SEPARATOR = "sidebar-pane-separator";
     public const string OVERLAY_BAR = "overlay-bar";
 
@@ -35,4 +36,4 @@
     public const string H1_TEXT = "h1";
     public const string H2_TEXT = "h2";
     public const string H3_TEXT = "h3";
-}
+}
 \ No newline at end of file