Merge lp:~elementary-dev-community/granite/fix-1084911 into lp:~elementary-pantheon/granite/granite

[Julián Unrrein]

Added the Overlay Bar widget (from Pantheon Files), fixing bug #1084911.

Move Files' Overlay Bar to Granite.

Please refer to the source documentation to see details.

This branch also moves code from the GPLv3 to the LGPLv3, and as such, it needs to be approved by the copyright holder - ammonkey.

I also developed Files and Midori branches where this widget is used, to help testing:
lp:~elementary-dev-community/pantheon-files/granite-overlaybar
lp:~junrrein/midori/granite-overlaybar

And also, the example from source documentation:
lp:~junrrein/junk/granite-overlaybar-example

[David Gomes (davidgomes)]

Line 59 mis-indentation.

review: Needs Fixing

[lp:~elementary-dev-community/granite/fix-1084911]

610. By Julián Unrrein on 2013-08-16

Replace tabs with spaces.

611. By Julián Unrrein on 2013-08-16

Correct spelling mistakes.

[Julián Unrrein (junrrein)]

Applied David's suggestions.

[lp:~elementary-dev-community/granite/fix-1084911]

612. By David Gomes on 2013-08-18

demo: Added OverlayBar example to granite demo.

[David Gomes (davidgomes)]

I approve it.

I added junrrein as reviewer, he can review the code I wrote for the demo.

Finally, also added Daniel as a reviewer so he can review the place where I put the OverlayBar in the demo design-wise.

review: Approve

[Julián Unrrein (junrrein)]

It turns out it's not necessary to pack a Gtk.Overlay inside a Gtk.Box before using it.

Therefore remove diff lines 33-34 and 111-112. Update diff line 36 to "return overlay", and line 114 to "this.add (overlay)".

review: Needs Fixing

[lp:~elementary-dev-community/granite/fix-1084911]

613. By David Gomes on 2013-08-19

Fixed the overlay in a box issue.

614. By Julián Unrrein on 2013-08-19

Use a label instead of an icon view in the overlay bar examples.

[Julián Unrrein (junrrein)]

Looks good to me.

In the example and in granite-demo, I replaced the icon view with a label: "Try to touch the Overlay Bar!".

Now waiting for Dan's review.

review: Approve

[David Gomes (davidgomes)]

I love cooperation.

review: Approve

[Danielle Foré (danrabbit)]

Yay overlaybar. Works here

review: Approve

=== modified file 'demo/main.vala'
--- demo/main.vala	2013-07-20 12:04:09 +0000
+++ demo/main.vala	2013-08-19 23:11:47 +0000
@@ -191,7 +191,7 @@
         var pageone = new Gtk.Label ("Page 1");
 
         staticnotebook.append_page (new Gtk.Label ("Page 1"), pageone);
-        staticnotebook.append_page (new Gtk.Label ("Page 2"), new Gtk.Label ("Page 2"));
+        staticnotebook.append_page (get_overlay_bar_widget (), new Gtk.Label ("Overlay Bar"));
         staticnotebook.append_page (new Gtk.Label ("Page 3"), new Gtk.Label ("Page 3"));
 
         staticnotebook.page_changed.connect (() => {
@@ -377,7 +377,6 @@
     }
 
     private Granite.Widgets.DynamicNotebook create_dynamic_notebook () {
-
         int i = 3;
 
         var dynamic_notebook = new Granite.Widgets.DynamicNotebook ();
@@ -436,6 +435,17 @@
         return dynamic_notebook;
     }
 
+    private Gtk.Widget get_overlay_bar_widget () {
+        // OverlayBar (inside StaticNotebook)
+        var overlay = new Gtk.Overlay ();
+        overlay.add (new Gtk.Label ("Try to touch the Overlay Bar!"));
+
+        var overlay_bar = new Granite.Widgets.OverlayBar (overlay);
+        overlay_bar.status = "Overlay Bar Example";
+
+        return overlay;
+    }
+
     public static int main (string[] args) {
         new Granite.Demo ().run (args);
         Gtk.main ();

=== modified file 'lib/CMakeLists.txt'
--- lib/CMakeLists.txt	2013-06-08 20:38:28 +0000
+++ lib/CMakeLists.txt	2013-08-19 23:11:47 +0000
@@ -44,6 +44,7 @@
     Widgets/CellRendererExpander.vala
     Widgets/CellRendererBadge.vala
     Widgets/ThinPaned.vala
+    Widgets/OverlayBar.vala
 )
 
 set (C_SOURCES

=== added file 'lib/Widgets/OverlayBar.vala'
--- lib/Widgets/OverlayBar.vala	1970-01-01 00:00:00 +0000
+++ lib/Widgets/OverlayBar.vala	2013-08-19 23:11:47 +0000
@@ -0,0 +1,203 @@
+/***
+    Copyright (C) 2012 ammonkey <[e-mail]>
+    Copyright (C) 2013 Julián Unrrein <[e-mail]>
+
+    This program or library is free software; you can redistribute it
+    and/or modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 3 of the License, or (at your option) any later version.
+
+    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 for more details.
+
+    You should have received a copy of the GNU Lesser General
+    Public License along with this library; if not, write to the
+    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301 USA.
+***/
+
+/**
+ * A floating status bar that displays a single line of text.
+ *
+ * This widget is intended to be used as an overlay for a {@link Gtk.Overlay} and is placed in the
+ * bottom-right corner by default. You can change its position like you would do for any overlay
+ * widget used in a {@link Gtk.Overlay}.
+ *
+ * The Overlay Bar displays a single line of text that can be changed using the "status" property.
+ *
+ * This widget tries to avoid getting in front of the content being displayed inside the {@link Gtk.Overlay}
+ * by moving itself horizontally to the opposite side from the current one when the mouse pointer enters
+ * the widget.
+ *
+ * For this widget to function correctly, the event {@link Gdk.EventMask.ENTER_NOTIFY_MASK} must be set
+ * for the parent {@link Gtk.Overlay}. Overlay Bar's constructor takes care of this automatically,
+ * but you have to be careful not to unset the event for the {@link Gtk.Overlay} at a later stage.
+ *
+ * ''Example'' <<BR>>
+ *
+ * public class OverlayBarExample : Gtk.Window {{{
+ *
+ *     public OverlayBarExample () {{{
+ *         this.title = "Overlay Bar Example";
+ *         this.window_position = Gtk.WindowPosition.CENTER;
+ *         this.set_default_size (400, 300);
+ *
+ *         var overlay = new Gtk.Overlay ();
+ *         overlay.add (new Gtk.Label ("Try to touch the Overlay Bar!"));
+ *
+ *         var overlaybar = new Granite.Widgets.OverlayBar (overlay);
+ *         overlaybar.status = "Overlay Bar Example";
+ *
+ *         this.add (overlay);
+ *     }}}
+ *
+ *     public static int main (string[] args) {{{
+ *         Gtk.init (ref args);
+ *
+ *         var window = new OverlayBarExample ();
+ *         window.destroy.connect (Gtk.main_quit);
+ *         window.show_all ();
+ *
+ *         Gtk.main ();
+ *         return 0;
+ *     }}}
+ * }}}
+ *
+ * valac --pkg gtk+-3.0 --pkg granite OverlayBarExample.vala
+ *
+ * @see Gtk.Overlay
+ */
+public class Granite.Widgets.OverlayBar : Gtk.EventBox {
+
+    private const string FALLBACK_THEME = """
+   .granite-overlay-bar {
+       background-color: @bg_color;
+       border-radius: 3px;
+       padding: 3px 6px;
+       margin: 3px;
+       border-style: solid;
+       border-width: 1px;
+       border-color: darker (@bg_color);
+   }""";
+
+    private Gtk.Label status_label;
+
+    /**
+     * Status text displayed inside the Overlay Bar.
+     */
+    public string status {
+        set {
+           status_label.label = value;
+        }
+
+        get {
+            return status_label.label;
+        }
+    }
+
+    /**
+     * Create a new Overlay Bar, and add it to the {@link Gtk.Overlay}.
+     */
+    public OverlayBar (Gtk.Overlay overlay) {
+        visible_window = false;
+
+        status_label = new Gtk.Label (null);
+        status_label.set_ellipsize (Pango.EllipsizeMode.END);
+        add (status_label);
+        status_label.show ();
+
+        set_halign (Gtk.Align.END);
+        set_valign (Gtk.Align.END);
+
+        set_default_style ();
+
+        var ctx = get_style_context ();
+        ctx.changed.connect (update_spacing);
+        ctx.changed.connect_after (queue_resize);
+
+        update_spacing ();
+
+        overlay.add_events (Gdk.EventMask.ENTER_NOTIFY_MASK);
+        overlay.add_overlay (this);
+    }
+
+    public override void parent_set (Gtk.Widget? old_parent) {
+        Gtk.Widget parent = get_parent ();
+
+        if (old_parent != null)
+            old_parent.enter_notify_event.disconnect (enter_notify_callback);
+        if (parent != null)
+            parent.enter_notify_event.connect (enter_notify_callback);
+    }
+
+    public override bool draw (Cairo.Context cr) {
+        var ctx = get_style_context ();
+        ctx.render_background (cr, 0, 0, get_allocated_width (), get_allocated_height ());
+        ctx.render_frame (cr, 0, 0, get_allocated_width (), get_allocated_height ());
+        return base.draw (cr);
+    }
+
+    public override Gtk.SizeRequestMode get_request_mode () {
+        return Gtk.SizeRequestMode.HEIGHT_FOR_WIDTH;
+    }
+
+    public override void get_preferred_width (out int minimum_width, out int natural_width) {
+        Gtk.Requisition label_min_size, label_natural_size;
+        status_label.get_preferred_size (out label_min_size, out label_natural_size);
+
+        var ctx = get_style_context ();
+        var state = ctx.get_state ();
+        var border = ctx.get_border (state);
+
+        int extra_allocation = border.left + border.right;
+        minimum_width = extra_allocation + label_min_size.width;
+        natural_width = extra_allocation + label_natural_size.width;
+    }
+
+    public override void get_preferred_height_for_width (int width, out int minimum_height,
+                                                         out int natural_height) {
+        Gtk.Requisition label_min_size, label_natural_size;
+        status_label.get_preferred_size (out label_min_size, out label_natural_size);
+
+        var ctx = get_style_context ();
+        var state = ctx.get_state ();
+        var border = ctx.get_border (state);
+
+        int extra_allocation = border.top + border.bottom;
+        minimum_height = extra_allocation + label_min_size.height;
+        natural_height = extra_allocation + label_natural_size.height;
+    }
+
+    private void update_spacing () {
+        var ctx = get_style_context ();
+        var state = ctx.get_state ();
+
+        var padding = ctx.get_padding (state);
+        status_label.margin_top = padding.top;
+        status_label.margin_bottom = padding.bottom;
+        status_label.margin_left = padding.left;
+        status_label.margin_right = padding.right;
+
+        var margin = ctx.get_margin (state);
+        margin_top = margin.top;
+        margin_bottom = margin.bottom;
+        margin_left = margin.left;
+        margin_right = margin.right;
+    }
+
+    private void set_default_style () {
+        int priority = Gtk.STYLE_PROVIDER_PRIORITY_FALLBACK;
+        Granite.Widgets.Utils.set_theming (this, FALLBACK_THEME, "granite-overlay-bar", priority);
+    }
+
+    private bool enter_notify_callback (Gdk.EventCrossing event) {
+        if (get_halign () == Gtk.Align.START)
+            set_halign (Gtk.Align.END);
+        else
+            set_halign (Gtk.Align.START);
+
+        return false;
+    }
+}