gtk2_ardour/floating_text_entry.cc

   1 /*
   2   Copyright (C) 2014 Paul Davis
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8
   9   This program is distributed in the hope that it will be useful,
  10   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12   GNU General Public License for more details.
  13
  14   You should have received a copy of the GNU General Public License
  15   along with this program; if not, write to the Free Software
  16   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "pbd/stacktrace.h"
  21 #include "public_editor.h"
  22
  23
  24 #include "floating_text_entry.h"
  25 #include "gtkmm2ext/doi.h"
  26 #include "gtkmm2ext/utils.h"
  27
  28 #include "pbd/i18n.h"
  29
  30 FloatingTextEntry::FloatingTextEntry (Gtk::Window* parent, const std::string& initial_contents)
  31         : Gtk::Window (Gtk::WINDOW_POPUP)
  32         , entry_changed (false)
  33         , by_popup_menu (false)
  34 {
  35         //set_name (X_("FloatingTextEntry"));
  36         set_position (Gtk::WIN_POS_MOUSE);
  37         set_border_width (0);
  38
  39         if (!initial_contents.empty()) {
  40                 entry.set_text (initial_contents);
  41         }
  42
  43         entry.show ();
  44         entry.signal_changed().connect (sigc::mem_fun (*this, &FloatingTextEntry::changed));
  45         entry.signal_activate().connect (sigc::mem_fun (*this, &FloatingTextEntry::activated));
  46         entry.signal_key_press_event().connect (sigc::mem_fun (*this, &FloatingTextEntry::key_press), false);
  47         entry.signal_key_release_event().connect (sigc::mem_fun (*this, &FloatingTextEntry::key_release), false);
  48         entry.signal_button_press_event().connect (sigc::mem_fun (*this, &FloatingTextEntry::button_press));
  49         entry.signal_populate_popup().connect (sigc::mem_fun (*this, &FloatingTextEntry::populate_popup));
  50
  51         entry.select_region (0, -1);
  52
  53         if (parent) {
  54                 parent->signal_focus_out_event().connect (sigc::mem_fun (*this, &FloatingTextEntry::entry_focus_out));
  55         }
  56
  57         add (entry);
  58 }
  59
  60 void
  61 FloatingTextEntry::populate_popup (Gtk::Menu *)
  62 {
  63         by_popup_menu = true;
  64 }
  65
  66 void
  67 FloatingTextEntry::changed ()
  68 {
  69         entry_changed = true;
  70 }
  71
  72 void
  73 FloatingTextEntry::on_realize ()
  74 {
  75         Gtk::Window::on_realize ();
  76         get_window()->set_decorations (Gdk::WMDecoration (0));
  77         entry.add_modal_grab ();
  78 }
  79
  80 bool
  81 FloatingTextEntry::entry_focus_out (GdkEventFocus* ev)
  82 {
  83         if (by_popup_menu) {
  84                 by_popup_menu = false;
  85                 return false;
  86         }
  87
  88         entry.remove_modal_grab ();
  89         if (entry_changed) {
  90                 use_text (entry.get_text (), 0);
  91         }
  92
  93         delete_when_idle ( this);
  94         return false;
  95 }
  96
  97 bool
  98 FloatingTextEntry::button_press (GdkEventButton* ev)
  99 {
 100         if (Gtkmm2ext::event_inside_widget_window (*this, (GdkEvent*) ev)) {
 101                 return true;
 102         }
 103
 104         /* Clicked outside widget window - edit is done */
 105         entry.remove_modal_grab ();
 106
 107         /* arrange re-propagation of the event once we go idle */
 108         Glib::signal_idle().connect (sigc::bind_return (sigc::bind (sigc::ptr_fun (gtk_main_do_event), gdk_event_copy ((GdkEvent*) ev)), false));
 109
 110         if (entry_changed) {
 111                 use_text (entry.get_text (), 0);
 112         }
 113
 114         delete_when_idle ( this);
 115
 116         return false;
 117 }
 118
 119 void
 120 FloatingTextEntry::activated ()
 121 {
 122         use_text (entry.get_text(), 0); // EMIT SIGNAL
 123         delete_when_idle (this);
 124 }
 125
 126 bool
 127 FloatingTextEntry::key_press (GdkEventKey* ev)
 128 {
 129         /* steal escape, tabs from GTK */
 130
 131         switch (ev->keyval) {
 132         case GDK_Escape:
 133         case GDK_ISO_Left_Tab:
 134         case GDK_Tab:
 135                 return true;
 136         }
 137         return false;
 138 }
 139
 140 bool
 141 FloatingTextEntry::key_release (GdkEventKey* ev)
 142 {
 143         switch (ev->keyval) {
 144         case GDK_Escape:
 145                 /* cancel edit */
 146                 delete_when_idle (this);
 147                 return true;
 148
 149         case GDK_ISO_Left_Tab:
 150                 /* Shift+Tab Keys Pressed. Note that for Shift+Tab, GDK actually
 151                  * generates a different ev->keyval, rather than setting
 152                  * ev->state.
 153                  */
 154                 use_text (entry.get_text(), -1); // EMIT SIGNAL, move to prev
 155                 delete_when_idle (this);
 156                 return true;
 157
 158         case GDK_Tab:
 159                 use_text (entry.get_text(), 1); // EMIT SIGNAL, move to next
 160                 delete_when_idle (this);
 161                 return true;
 162         default:
 163                 break;
 164         }
 165
 166         return false;
 167 }
 168
 169
 170 void
 171 FloatingTextEntry::on_hide ()
 172 {
 173         entry.remove_modal_grab ();
 174
 175         /* No hide button is shown (no decoration on the window),
 176            so being hidden is equivalent to the Escape key or any other
 177            method of cancelling the edit.
 178         */
 179
 180         delete_when_idle (this);
 181         Gtk::Window::on_hide ();
 182 }