Merge lp:~philip.scott/granite/editable-title into lp:~elementary-pantheon/granite/granite

[Felipe Escoto]

EditableTitle class added

Moves the EditableTitle class that is been used in Pantheon Photos and on the Printers Plug into it's own class here on granite.

It could also be used on Audience's Library view and I'm also planning on using it on Spice Up's future presentations browser

[Adam Bieńkowski (donadigo)]

* Use construct {} method of constructing the object.
* Use "construct set" for text property.
* There's no way of determining if the user is currently editing the label or not
* changed signal could probably have an additional parameter for something like "previous_title".
* Hm, reading the code it seems that every press on the widget will cause the editing to procced, maybe check if it's left click? Or is that intentional?

review: Needs Fixing (code)

[Danielle Foré (danrabbit)]

Please assign copyright to "elementary LLC" instead of "Granite Developers". I'm unsure that "Granite Developers" holds up as a valid legal entity to assign copyright to.

Don't forget to add an example to Granite-Demo ;)

review: Needs Fixing

[Rico Tzschichholz (ricotz)]

Assign "events" once or use add_events() to avoid mess ups

Unmerged revisions

1013. By Felipe Escoto on 2016-11-17

Add EditableTile.vala

=== modified file 'lib/CMakeLists.txt'
--- lib/CMakeLists.txt	2016-09-28 18:36:03 +0000
+++ lib/CMakeLists.txt	2016-11-17 03:28:11 +0000
@@ -27,6 +27,7 @@
     Widgets/ModeButton.vala
     Widgets/DatePicker.vala
     Widgets/Entries.vala
+    Widgets/EditableTitle.vala
     Widgets/TimePicker.vala
     Widgets/CollapsiblePaned.vala
     Widgets/StaticNotebook.vala

=== added file 'lib/Widgets/EditableTitle.vala'
--- lib/Widgets/EditableTitle.vala	1970-01-01 00:00:00 +0000
+++ lib/Widgets/EditableTitle.vala	2016-11-17 03:28:11 +0000
@@ -0,0 +1,143 @@
+/*-
+ * Copyright (c) 2016 Granite Developers (https://launchpad.net/granite)
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library 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
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Authored by: Corentin Noël <[e-mail]>
+ *              Felipe Escoto <[e-mail]>
+ */
+
+/**
+ * The EditableTitle is for making lables that can be edited with just a single click
+ */
+public class Granite.Widgets.EditableTitle : Gtk.EventBox {
+    /**
+     * Sent when the user changes the widget's content and stops editing it
+     */
+    public signal void changed (string new_title);
+
+    private Gtk.Label title;
+    private Gtk.Entry entry;
+    private Gtk.Stack stack;
+    private Gtk.Grid grid;
+
+    public string text {
+        get {
+            return title.label;
+        }
+
+        set {
+            title.label = value;
+        }
+    }
+
+    private bool editing {
+        set {
+            if (value) {
+                entry.text = title.label;
+                stack.set_visible_child (entry);
+                entry.grab_focus ();
+            } else {
+                if (entry.text.strip () != "" && title.label != entry.text) {
+                    title.label = entry.text;
+                    changed (entry.text);
+                }
+
+                stack.set_visible_child (grid);
+            }
+        }
+    }
+
+    /**
+     * Creates a new EditableTitle with the specified text
+     *
+     * @param text the initial text on the label
+     */
+    public EditableTitle (string text) {
+        valign = Gtk.Align.CENTER;
+        events |= Gdk.EventMask.ENTER_NOTIFY_MASK;
+        events |= Gdk.EventMask.LEAVE_NOTIFY_MASK;
+        events |= Gdk.EventMask.BUTTON_PRESS_MASK;
+
+        title = new Gtk.Label (text);
+        title.ellipsize = Pango.EllipsizeMode.END;
+        title.hexpand = true;
+        ((Gtk.Misc) title).xalign = 0;
+
+        var edit_button = new Gtk.Button ();
+        edit_button.image = new Gtk.Image.from_icon_name ("edit-symbolic", Gtk.IconSize.MENU);
+        edit_button.get_style_context ().add_class (Gtk.STYLE_CLASS_FLAT);
+        var button_revealer = new Gtk.Revealer ();
+        button_revealer.valign = Gtk.Align.CENTER;
+        button_revealer.transition_type = Gtk.RevealerTransitionType.CROSSFADE;
+        button_revealer.add (edit_button);
+
+        grid = new Gtk.Grid ();
+        grid.valign = Gtk.Align.CENTER;
+        grid.column_spacing = 12;
+        grid.add (title);
+        grid.add (button_revealer);
+
+        entry = new Gtk.Entry ();
+        entry.secondary_icon_name = "go-jump-symbolic";
+
+        stack = new Gtk.Stack ();
+        stack.transition_type = Gtk.StackTransitionType.CROSSFADE;
+        stack.add (grid);
+        stack.add (entry);
+        add (stack);
+
+        enter_notify_event.connect ((event) => {
+            if (event.detail != Gdk.NotifyType.INFERIOR) {
+                button_revealer.set_reveal_child (true);
+            }
+
+            return false;
+        });
+
+        leave_notify_event.connect ((event) => {
+            if (event.detail != Gdk.NotifyType.INFERIOR) {
+                button_revealer.set_reveal_child (false);
+            }
+
+            return false;
+        });
+
+        button_press_event.connect ((event) => {
+            editing = true;
+            return true;
+        });
+
+        edit_button.clicked.connect (() => {
+            editing = true;
+        });
+
+        entry.activate.connect (() => {
+            editing = false;
+        });
+
+        entry.focus_out_event.connect ((event) => {
+            editing = false;
+            return false;
+        });
+
+        entry.icon_release.connect ((p0, p1) => {
+            if (p0 == Gtk.EntryIconPosition.SECONDARY) {
+                editing = false;
+            }
+        });
+    }
+}