replace ::cast_dynamic() with relevant ActionManager::get_*_action() calls
[ardour.git] / gtk2_ardour / floating_text_entry.cc
index a78f4a8200e232e1bf860305f84d8f3409931f8b..e22e77982c493916495eea39c658ba7100d75906 100644 (file)
 /*
-    Copyright (C) 2014 Paul Davis
+  Copyright (C) 2014 Paul Davis
 
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
 
-    This program 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 General Public License for more details.
+  This program 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 General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
 */
 
 #include "pbd/stacktrace.h"
+#include "public_editor.h"
+
 
 #include "floating_text_entry.h"
 #include "gtkmm2ext/doi.h"
 #include "gtkmm2ext/utils.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
-FloatingTextEntry::FloatingTextEntry (const std::string& initial_contents)
-       : ArdourWindow ("")
-        , entry_changed (false)
+FloatingTextEntry::FloatingTextEntry (Gtk::Window* parent, const std::string& initial_contents)
+       : Gtk::Window ()
+       , entry_changed (false)
 {
-        set_name (X_("FloatingTextEntry"));
+       //set_name (X_("FloatingTextEntry"));
        set_position (Gtk::WIN_POS_MOUSE);
-        set_border_width (0);
+       set_border_width (0);
+       set_type_hint(Gdk::WINDOW_TYPE_HINT_POPUP_MENU);
+       set_resizable (false);
+
+       if (!initial_contents.empty()) {
+               entry.set_text (initial_contents);
+       }
+
+       entry.show ();
+       _connections.push_back (entry.signal_changed().connect (sigc::mem_fun (*this, &FloatingTextEntry::changed)));
+       _connections.push_back (entry.signal_activate().connect (sigc::mem_fun (*this, &FloatingTextEntry::activated)));
+       _connections.push_back (entry.signal_key_press_event().connect (sigc::mem_fun (*this, &FloatingTextEntry::key_press), false));
+       _connections.push_back (entry.signal_key_release_event().connect (sigc::mem_fun (*this, &FloatingTextEntry::key_release), false));
+       _connections.push_back (entry.signal_button_press_event().connect (sigc::mem_fun (*this, &FloatingTextEntry::button_press)));
 
-        if (!initial_contents.empty()) {
-                entry.set_text (initial_contents);
-        }
+       entry.select_region (0, -1);
 
-        entry.show ();
-        entry.signal_changed().connect (sigc::mem_fun (*this, &FloatingTextEntry::changed));
-        entry.signal_activate().connect (sigc::mem_fun (*this, &FloatingTextEntry::activated));
-        entry.signal_key_press_event().connect (sigc::mem_fun (*this, &FloatingTextEntry::key_press));
-        entry.signal_button_press_event().connect (sigc::mem_fun (*this, &FloatingTextEntry::button_press));
+       if (parent) {
+               set_transient_for (*parent);
+       }
 
-        add (entry);
+       add (entry);
 }
 
 void
 FloatingTextEntry::changed ()
 {
-        entry_changed = true;
+       entry_changed = true;
 }
 
 void
 FloatingTextEntry::on_realize ()
 {
-        ArdourWindow::on_realize ();
-        get_window()->set_decorations (Gdk::WMDecoration (0));
-        entry.add_modal_grab ();
+       Gtk::Window::on_realize ();
+       get_window()->set_decorations (Gdk::WMDecoration (0));
+       set_keep_above (true);
+       entry.add_modal_grab ();
 }
 
 bool
-FloatingTextEntry::button_press (GdkEventButton* ev)
+FloatingTextEntry::entry_focus_out (GdkEventFocus* ev)
 {
-        if (Gtkmm2ext::event_inside_widget_window (*this, (GdkEvent*) ev)) {
-                return true;
-        }
+       entry.remove_modal_grab ();
+       if (entry_changed) {
+               disconect_signals ();
+               use_text (entry.get_text (), 0); /* EMIT SIGNAL */
+       }
+
+       idle_delete_self ();
+       return false;
+}
 
-        /* Clicked outside widget window - edit is done */
+bool
+FloatingTextEntry::button_press (GdkEventButton* ev)
+{
+       if (Gtkmm2ext::event_inside_widget_window (*this, (GdkEvent*) ev)) {
+               return true;
+       }
 
-        entry.remove_modal_grab ();
+       /* Clicked outside widget window - edit is done */
+       entry.remove_modal_grab ();
 
-        /* arrange re-propagation of the event once we go idle */
+       /* arrange re-propagation of the event once we go idle */
+       Glib::signal_idle().connect (sigc::bind_return (sigc::bind (sigc::ptr_fun (gtk_main_do_event), gdk_event_copy ((GdkEvent*) ev)), false));
 
-        Glib::signal_idle().connect (sigc::bind_return (sigc::bind (sigc::ptr_fun (gtk_main_do_event), gdk_event_copy ((GdkEvent*) ev)), false));
+       if (entry_changed) {
+               disconect_signals ();
+               use_text (entry.get_text (), 0); /* EMIT SIGNAL */
+       }
 
-        if (entry_changed) {
-                use_text (entry.get_text ());
-        }
-        
-        delete_when_idle ( this);
+       idle_delete_self ();
 
-        return false;
+       return false;
 }
 
 void
 FloatingTextEntry::activated ()
 {
-        use_text (entry.get_text()); // EMIT SIGNAL
-        delete_when_idle (this);
+       disconect_signals ();
+       use_text (entry.get_text(), 0); // EMIT SIGNAL
+       idle_delete_self ();
 }
 
 bool
 FloatingTextEntry::key_press (GdkEventKey* ev)
 {
-        switch (ev->keyval) {
-        case GDK_Escape:
-                delete_when_idle (this);
-                return true;
-                break;
-        default:
-                break;
-        }
-        return false;
+       /* steal escape, tabs from GTK */
+
+       switch (ev->keyval) {
+       case GDK_Escape:
+       case GDK_ISO_Left_Tab:
+       case GDK_Tab:
+               return true;
+       }
+       return false;
 }
 
+bool
+FloatingTextEntry::key_release (GdkEventKey* ev)
+{
+       switch (ev->keyval) {
+       case GDK_Escape:
+               /* cancel edit */
+               idle_delete_self ();
+               return true;
+
+       case GDK_ISO_Left_Tab:
+               /* Shift+Tab Keys Pressed. Note that for Shift+Tab, GDK actually
+                * generates a different ev->keyval, rather than setting
+                * ev->state.
+                */
+               disconect_signals ();
+               use_text (entry.get_text(), -1); // EMIT SIGNAL, move to prev
+               idle_delete_self ();
+               return true;
+
+       case GDK_Tab:
+               disconect_signals ();
+               use_text (entry.get_text(), 1); // EMIT SIGNAL, move to next
+               idle_delete_self ();
+               return true;
+       default:
+               break;
+       }
+
+       return false;
+}
+
+
 void
 FloatingTextEntry::on_hide ()
 {
-        entry.remove_modal_grab ();
+       entry.remove_modal_grab ();
+
+       /* No hide button is shown (no decoration on the window),
+        * so being hidden is equivalent to the Escape key or any other
+        * method of cancelling the edit.
+        *
+        * This is also used during disconect_signals() before calling
+        * use_text (). see note below.
+        *
+        * If signals are already disconnected, idle-delete must be
+        * in progress already.
+        */
+       if (!_connections.empty ()) {
+               idle_delete_self ();
+       }
+       Gtk::Window::on_hide ();
+}
 
-        /* No hide button is shown (no decoration on the window), 
-           so being hidden is equivalent to the Escape key or any other 
-           method of cancelling the edit.
-        */
+void
+FloatingTextEntry::disconect_signals ()
+{
+       for (std::list<sigc::connection>::iterator i = _connections.begin(); i != _connections.end(); ++i) {
+               i->disconnect ();
+       }
+        _connections.clear ();
+       /* the entry is floating on-top, emitting use_text()
+        * may result in another dialog being shown (cannot rename track)
+        * which would
+        *  - be stacked below the floating text entry
+        *  - return focus to the entry when closedA
+        * so we hide the entry here.
+        */
+       hide ();
+}
 
-        delete_when_idle (this);
-        ArdourWindow::on_hide ();
+void
+FloatingTextEntry::idle_delete_self ()
+{
+       disconect_signals ();
+       delete_when_idle (this);
 }